2 * SMSC 91C111 Ethernet interface emulation
4 * Copyright (c) 2005 CodeSourcery, LLC.
5 * Written by Paul Brook
7 * This code is licensed under the GPL
10 #include "hw/sysbus.h"
12 #include "hw/devices.h"
16 /* Number of 2k memory pages available. */
19 #define TYPE_SMC91C111 "smc91c111"
20 #define SMC91C111(obj) OBJECT_CHECK(smc91c111_state, (obj), TYPE_SMC91C111)
23 SysBusDevice parent_obj
;
38 /* Bitmask of allocated packets. */
41 int tx_fifo
[NUM_PACKETS
];
43 int rx_fifo
[NUM_PACKETS
];
45 int tx_fifo_done
[NUM_PACKETS
];
46 /* Packet buffer memory. */
47 uint8_t data
[NUM_PACKETS
][2048];
53 static const VMStateDescription vmstate_smc91c111
= {
56 .minimum_version_id
= 1,
57 .fields
= (VMStateField
[]) {
58 VMSTATE_UINT16(tcr
, smc91c111_state
),
59 VMSTATE_UINT16(rcr
, smc91c111_state
),
60 VMSTATE_UINT16(cr
, smc91c111_state
),
61 VMSTATE_UINT16(ctr
, smc91c111_state
),
62 VMSTATE_UINT16(gpr
, smc91c111_state
),
63 VMSTATE_UINT16(ptr
, smc91c111_state
),
64 VMSTATE_UINT16(ercv
, smc91c111_state
),
65 VMSTATE_INT32(bank
, smc91c111_state
),
66 VMSTATE_INT32(packet_num
, smc91c111_state
),
67 VMSTATE_INT32(tx_alloc
, smc91c111_state
),
68 VMSTATE_INT32(allocated
, smc91c111_state
),
69 VMSTATE_INT32(tx_fifo_len
, smc91c111_state
),
70 VMSTATE_INT32_ARRAY(tx_fifo
, smc91c111_state
, NUM_PACKETS
),
71 VMSTATE_INT32(rx_fifo_len
, smc91c111_state
),
72 VMSTATE_INT32_ARRAY(rx_fifo
, smc91c111_state
, NUM_PACKETS
),
73 VMSTATE_INT32(tx_fifo_done_len
, smc91c111_state
),
74 VMSTATE_INT32_ARRAY(tx_fifo_done
, smc91c111_state
, NUM_PACKETS
),
75 VMSTATE_BUFFER_UNSAFE(data
, smc91c111_state
, 0, NUM_PACKETS
* 2048),
76 VMSTATE_UINT8(int_level
, smc91c111_state
),
77 VMSTATE_UINT8(int_mask
, smc91c111_state
),
82 #define RCR_SOFT_RST 0x8000
83 #define RCR_STRIP_CRC 0x0200
84 #define RCR_RXEN 0x0100
86 #define TCR_EPH_LOOP 0x2000
87 #define TCR_NOCRC 0x0100
88 #define TCR_PAD_EN 0x0080
89 #define TCR_FORCOL 0x0004
90 #define TCR_LOOP 0x0002
91 #define TCR_TXEN 0x0001
96 #define INT_RX_OVRN 0x10
97 #define INT_ALLOC 0x08
98 #define INT_TX_EMPTY 0x04
102 #define CTR_AUTO_RELEASE 0x0800
103 #define CTR_RELOAD 0x0002
104 #define CTR_STORE 0x0001
106 #define RS_ALGNERR 0x8000
107 #define RS_BRODCAST 0x4000
108 #define RS_BADCRC 0x2000
109 #define RS_ODDFRAME 0x1000
110 #define RS_TOOLONG 0x0800
111 #define RS_TOOSHORT 0x0400
112 #define RS_MULTICAST 0x0001
114 /* Update interrupt status. */
115 static void smc91c111_update(smc91c111_state
*s
)
119 if (s
->tx_fifo_len
== 0)
120 s
->int_level
|= INT_TX_EMPTY
;
121 if (s
->tx_fifo_done_len
!= 0)
122 s
->int_level
|= INT_TX
;
123 level
= (s
->int_level
& s
->int_mask
) != 0;
124 qemu_set_irq(s
->irq
, level
);
127 /* Try to allocate a packet. Returns 0x80 on failure. */
128 static int smc91c111_allocate_packet(smc91c111_state
*s
)
131 if (s
->allocated
== (1 << NUM_PACKETS
) - 1) {
135 for (i
= 0; i
< NUM_PACKETS
; i
++) {
136 if ((s
->allocated
& (1 << i
)) == 0)
139 s
->allocated
|= 1 << i
;
144 /* Process a pending TX allocate. */
145 static void smc91c111_tx_alloc(smc91c111_state
*s
)
147 s
->tx_alloc
= smc91c111_allocate_packet(s
);
148 if (s
->tx_alloc
== 0x80)
150 s
->int_level
|= INT_ALLOC
;
154 /* Remove and item from the RX FIFO. */
155 static void smc91c111_pop_rx_fifo(smc91c111_state
*s
)
160 if (s
->rx_fifo_len
) {
161 for (i
= 0; i
< s
->rx_fifo_len
; i
++)
162 s
->rx_fifo
[i
] = s
->rx_fifo
[i
+ 1];
163 s
->int_level
|= INT_RCV
;
165 s
->int_level
&= ~INT_RCV
;
170 /* Remove an item from the TX completion FIFO. */
171 static void smc91c111_pop_tx_fifo_done(smc91c111_state
*s
)
175 if (s
->tx_fifo_done_len
== 0)
177 s
->tx_fifo_done_len
--;
178 for (i
= 0; i
< s
->tx_fifo_done_len
; i
++)
179 s
->tx_fifo_done
[i
] = s
->tx_fifo_done
[i
+ 1];
182 /* Release the memory allocated to a packet. */
183 static void smc91c111_release_packet(smc91c111_state
*s
, int packet
)
185 s
->allocated
&= ~(1 << packet
);
186 if (s
->tx_alloc
== 0x80)
187 smc91c111_tx_alloc(s
);
188 qemu_flush_queued_packets(qemu_get_queue(s
->nic
));
191 /* Flush the TX FIFO. */
192 static void smc91c111_do_tx(smc91c111_state
*s
)
200 if ((s
->tcr
& TCR_TXEN
) == 0)
202 if (s
->tx_fifo_len
== 0)
204 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
205 packetnum
= s
->tx_fifo
[i
];
206 p
= &s
->data
[packetnum
][0];
207 /* Set status word. */
211 len
|= ((int)*(p
++)) << 8;
213 control
= p
[len
+ 1];
216 /* ??? This overwrites the data following the buffer.
217 Don't know what real hardware does. */
218 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
219 memset(p
+ len
, 0, 64 - len
);
226 /* The card is supposed to append the CRC to the frame.
227 However none of the other network traffic has the CRC
228 appended. Suspect this is low level ethernet detail we
229 don't need to worry about. */
230 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
234 crc
= crc32(~0, p
, len
);
235 memcpy(p
+ len
, &crc
, 4);
240 if (s
->ctr
& CTR_AUTO_RELEASE
)
242 smc91c111_release_packet(s
, packetnum
);
243 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
244 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
245 qemu_send_packet(qemu_get_queue(s
->nic
), p
, len
);
251 /* Add a packet to the TX FIFO. */
252 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
254 if (s
->tx_fifo_len
== NUM_PACKETS
)
256 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
260 static void smc91c111_reset(DeviceState
*dev
)
262 smc91c111_state
*s
= SMC91C111(dev
);
266 s
->tx_fifo_done_len
= 0;
277 s
->int_level
= INT_TX_EMPTY
;
282 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
283 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
285 static void smc91c111_writeb(void *opaque
, hwaddr offset
,
288 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
290 offset
= offset
& 0xf;
304 SET_HIGH(tcr
, value
);
310 SET_HIGH(rcr
, value
);
311 if (s
->rcr
& RCR_SOFT_RST
) {
312 smc91c111_reset(DEVICE(s
));
315 case 10: case 11: /* RPCR */
318 case 12: case 13: /* Reserved */
331 case 2: case 3: /* BASE */
332 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
333 /* Not implemented. */
335 case 10: /* Genral Purpose */
339 SET_HIGH(gpr
, value
);
341 case 12: /* Control */
343 fprintf(stderr
, "smc91c111:EEPROM store not implemented\n");
345 fprintf(stderr
, "smc91c111:EEPROM reload not implemented\n");
350 SET_HIGH(ctr
, value
);
357 case 0: /* MMU Command */
358 switch (value
>> 5) {
361 case 1: /* Allocate for TX. */
363 s
->int_level
&= ~INT_ALLOC
;
365 smc91c111_tx_alloc(s
);
367 case 2: /* Reset MMU. */
370 s
->tx_fifo_done_len
= 0;
374 case 3: /* Remove from RX FIFO. */
375 smc91c111_pop_rx_fifo(s
);
377 case 4: /* Remove from RX FIFO and release. */
378 if (s
->rx_fifo_len
> 0) {
379 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
381 smc91c111_pop_rx_fifo(s
);
383 case 5: /* Release. */
384 smc91c111_release_packet(s
, s
->packet_num
);
386 case 6: /* Add to TX FIFO. */
387 smc91c111_queue_tx(s
, s
->packet_num
);
389 case 7: /* Reset TX FIFO. */
391 s
->tx_fifo_done_len
= 0;
398 case 2: /* Packet Number Register */
399 s
->packet_num
= value
;
401 case 3: case 4: case 5:
402 /* Should be readonly, but linux writes to them anyway. Ignore. */
404 case 6: /* Pointer */
408 SET_HIGH(ptr
, value
);
410 case 8: case 9: case 10: case 11: /* Data */
420 if (s
->ptr
& 0x4000) {
421 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
425 s
->data
[n
][p
] = value
;
428 case 12: /* Interrupt ACK. */
429 s
->int_level
&= ~(value
& 0xd6);
431 smc91c111_pop_tx_fifo_done(s
);
434 case 13: /* Interrupt mask. */
443 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
444 /* Multicast table. */
445 /* Not implemented. */
447 case 8: case 9: /* Management Interface. */
448 /* Not implemented. */
450 case 12: /* Early receive. */
451 s
->ercv
= value
& 0x1f;
459 hw_error("smc91c111_write: Bad reg %d:%x\n", s
->bank
, (int)offset
);
462 static uint32_t smc91c111_readb(void *opaque
, hwaddr offset
)
464 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
466 offset
= offset
& 0xf;
476 return s
->tcr
& 0xff;
479 case 2: /* EPH Status */
484 return s
->rcr
& 0xff;
487 case 6: /* Counter */
489 /* Not implemented. */
491 case 8: /* Memory size. */
493 case 9: /* Free memory available. */
498 for (i
= 0; i
< NUM_PACKETS
; i
++) {
499 if (s
->allocated
& (1 << i
))
504 case 10: case 11: /* RPCR */
505 /* Not implemented. */
507 case 12: case 13: /* Reserved */
518 case 2: case 3: /* BASE */
519 /* Not implemented. */
521 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
522 return s
->conf
.macaddr
.a
[offset
- 4];
523 case 10: /* General Purpose */
524 return s
->gpr
& 0xff;
527 case 12: /* Control */
528 return s
->ctr
& 0xff;
536 case 0: case 1: /* MMUCR Busy bit. */
538 case 2: /* Packet Number. */
539 return s
->packet_num
;
540 case 3: /* Allocation Result. */
542 case 4: /* TX FIFO */
543 if (s
->tx_fifo_done_len
== 0)
546 return s
->tx_fifo_done
[0];
547 case 5: /* RX FIFO */
548 if (s
->rx_fifo_len
== 0)
551 return s
->rx_fifo
[0];
552 case 6: /* Pointer */
553 return s
->ptr
& 0xff;
555 return (s
->ptr
>> 8) & 0xf7;
556 case 8: case 9: case 10: case 11: /* Data */
566 if (s
->ptr
& 0x4000) {
567 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
571 return s
->data
[n
][p
];
573 case 12: /* Interrupt status. */
575 case 13: /* Interrupt mask. */
582 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
583 /* Multicast table. */
584 /* Not implemented. */
586 case 8: /* Management Interface. */
587 /* Not implemented. */
591 case 10: /* Revision. */
602 hw_error("smc91c111_read: Bad reg %d:%x\n", s
->bank
, (int)offset
);
606 static void smc91c111_writew(void *opaque
, hwaddr offset
,
609 smc91c111_writeb(opaque
, offset
, value
& 0xff);
610 smc91c111_writeb(opaque
, offset
+ 1, value
>> 8);
613 static void smc91c111_writel(void *opaque
, hwaddr offset
,
616 /* 32-bit writes to offset 0xc only actually write to the bank select
617 register (offset 0xe) */
619 smc91c111_writew(opaque
, offset
, value
& 0xffff);
620 smc91c111_writew(opaque
, offset
+ 2, value
>> 16);
623 static uint32_t smc91c111_readw(void *opaque
, hwaddr offset
)
626 val
= smc91c111_readb(opaque
, offset
);
627 val
|= smc91c111_readb(opaque
, offset
+ 1) << 8;
631 static uint32_t smc91c111_readl(void *opaque
, hwaddr offset
)
634 val
= smc91c111_readw(opaque
, offset
);
635 val
|= smc91c111_readw(opaque
, offset
+ 2) << 16;
639 static int smc91c111_can_receive(NetClientState
*nc
)
641 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
643 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
645 if (s
->allocated
== (1 << NUM_PACKETS
) - 1)
650 static ssize_t
smc91c111_receive(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
652 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
659 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
661 /* Short packets are padded with zeros. Receiving a packet
662 < 64 bytes long is considered an error condition. */
666 packetsize
= (size
& ~1);
668 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
671 /* TODO: Flag overrun and receive errors. */
672 if (packetsize
> 2048)
674 packetnum
= smc91c111_allocate_packet(s
);
675 if (packetnum
== 0x80)
677 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
679 p
= &s
->data
[packetnum
][0];
680 /* ??? Multicast packets? */
683 status
|= RS_TOOLONG
;
685 status
|= RS_ODDFRAME
;
686 *(p
++) = status
& 0xff;
687 *(p
++) = status
>> 8;
688 *(p
++) = packetsize
& 0xff;
689 *(p
++) = packetsize
>> 8;
690 memcpy(p
, buf
, size
& ~1);
692 /* Pad short packets. */
697 *(p
++) = buf
[size
- 1];
703 /* It's not clear if the CRC should go before or after the last byte in
704 odd sized packets. Linux disables the CRC, so that's no help.
705 The pictures in the documentation show the CRC aligned on a 16-bit
706 boundary before the last odd byte, so that's what we do. */
708 crc
= crc32(~0, buf
, size
);
709 *(p
++) = crc
& 0xff; crc
>>= 8;
710 *(p
++) = crc
& 0xff; crc
>>= 8;
711 *(p
++) = crc
& 0xff; crc
>>= 8;
715 *(p
++) = buf
[size
- 1];
721 /* TODO: Raise early RX interrupt? */
722 s
->int_level
|= INT_RCV
;
728 static const MemoryRegionOps smc91c111_mem_ops
= {
729 /* The special case for 32 bit writes to 0xc means we can't just
730 * set .impl.min/max_access_size to 1, unfortunately
733 .read
= { smc91c111_readb
, smc91c111_readw
, smc91c111_readl
, },
734 .write
= { smc91c111_writeb
, smc91c111_writew
, smc91c111_writel
, },
736 .endianness
= DEVICE_NATIVE_ENDIAN
,
739 static NetClientInfo net_smc91c111_info
= {
740 .type
= NET_CLIENT_OPTIONS_KIND_NIC
,
741 .size
= sizeof(NICState
),
742 .can_receive
= smc91c111_can_receive
,
743 .receive
= smc91c111_receive
,
746 static int smc91c111_init1(SysBusDevice
*sbd
)
748 DeviceState
*dev
= DEVICE(sbd
);
749 smc91c111_state
*s
= SMC91C111(dev
);
751 memory_region_init_io(&s
->mmio
, OBJECT(s
), &smc91c111_mem_ops
, s
,
752 "smc91c111-mmio", 16);
753 sysbus_init_mmio(sbd
, &s
->mmio
);
754 sysbus_init_irq(sbd
, &s
->irq
);
755 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
756 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
757 object_get_typename(OBJECT(dev
)), dev
->id
, s
);
758 qemu_format_nic_info_str(qemu_get_queue(s
->nic
), s
->conf
.macaddr
.a
);
759 /* ??? Save/restore. */
763 static Property smc91c111_properties
[] = {
764 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
765 DEFINE_PROP_END_OF_LIST(),
768 static void smc91c111_class_init(ObjectClass
*klass
, void *data
)
770 DeviceClass
*dc
= DEVICE_CLASS(klass
);
771 SysBusDeviceClass
*k
= SYS_BUS_DEVICE_CLASS(klass
);
773 k
->init
= smc91c111_init1
;
774 dc
->reset
= smc91c111_reset
;
775 dc
->vmsd
= &vmstate_smc91c111
;
776 dc
->props
= smc91c111_properties
;
779 static const TypeInfo smc91c111_info
= {
780 .name
= TYPE_SMC91C111
,
781 .parent
= TYPE_SYS_BUS_DEVICE
,
782 .instance_size
= sizeof(smc91c111_state
),
783 .class_init
= smc91c111_class_init
,
786 static void smc91c111_register_types(void)
788 type_register_static(&smc91c111_info
);
791 /* Legacy helper function. Should go away when machine config files are
793 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
798 qemu_check_nic_model(nd
, "smc91c111");
799 dev
= qdev_create(NULL
, TYPE_SMC91C111
);
800 qdev_set_nic_properties(dev
, nd
);
801 qdev_init_nofail(dev
);
802 s
= SYS_BUS_DEVICE(dev
);
803 sysbus_mmio_map(s
, 0, base
);
804 sysbus_connect_irq(s
, 0, irq
);
807 type_init(smc91c111_register_types
)