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 "qemu/osdep.h"
11 #include "hw/sysbus.h"
12 #include "migration/vmstate.h"
15 #include "hw/net/smc91c111.h"
16 #include "hw/qdev-properties.h"
17 #include "qapi/error.h"
19 #include "qemu/module.h"
22 #include "qom/object.h"
24 /* Number of 2k memory pages available. */
27 #define TYPE_SMC91C111 "smc91c111"
28 typedef struct smc91c111_state smc91c111_state
;
29 DECLARE_INSTANCE_CHECKER(smc91c111_state
, SMC91C111
,
32 struct smc91c111_state
{
33 SysBusDevice parent_obj
;
48 /* Bitmask of allocated packets. */
51 int tx_fifo
[NUM_PACKETS
];
53 int rx_fifo
[NUM_PACKETS
];
55 int tx_fifo_done
[NUM_PACKETS
];
56 /* Packet buffer memory. */
57 uint8_t data
[NUM_PACKETS
][2048];
63 static const VMStateDescription vmstate_smc91c111
= {
66 .minimum_version_id
= 1,
67 .fields
= (VMStateField
[]) {
68 VMSTATE_UINT16(tcr
, smc91c111_state
),
69 VMSTATE_UINT16(rcr
, smc91c111_state
),
70 VMSTATE_UINT16(cr
, smc91c111_state
),
71 VMSTATE_UINT16(ctr
, smc91c111_state
),
72 VMSTATE_UINT16(gpr
, smc91c111_state
),
73 VMSTATE_UINT16(ptr
, smc91c111_state
),
74 VMSTATE_UINT16(ercv
, smc91c111_state
),
75 VMSTATE_INT32(bank
, smc91c111_state
),
76 VMSTATE_INT32(packet_num
, smc91c111_state
),
77 VMSTATE_INT32(tx_alloc
, smc91c111_state
),
78 VMSTATE_INT32(allocated
, smc91c111_state
),
79 VMSTATE_INT32(tx_fifo_len
, smc91c111_state
),
80 VMSTATE_INT32_ARRAY(tx_fifo
, smc91c111_state
, NUM_PACKETS
),
81 VMSTATE_INT32(rx_fifo_len
, smc91c111_state
),
82 VMSTATE_INT32_ARRAY(rx_fifo
, smc91c111_state
, NUM_PACKETS
),
83 VMSTATE_INT32(tx_fifo_done_len
, smc91c111_state
),
84 VMSTATE_INT32_ARRAY(tx_fifo_done
, smc91c111_state
, NUM_PACKETS
),
85 VMSTATE_BUFFER_UNSAFE(data
, smc91c111_state
, 0, NUM_PACKETS
* 2048),
86 VMSTATE_UINT8(int_level
, smc91c111_state
),
87 VMSTATE_UINT8(int_mask
, smc91c111_state
),
92 #define RCR_SOFT_RST 0x8000
93 #define RCR_STRIP_CRC 0x0200
94 #define RCR_RXEN 0x0100
96 #define TCR_EPH_LOOP 0x2000
97 #define TCR_NOCRC 0x0100
98 #define TCR_PAD_EN 0x0080
99 #define TCR_FORCOL 0x0004
100 #define TCR_LOOP 0x0002
101 #define TCR_TXEN 0x0001
104 #define INT_ERCV 0x40
106 #define INT_RX_OVRN 0x10
107 #define INT_ALLOC 0x08
108 #define INT_TX_EMPTY 0x04
112 #define CTR_AUTO_RELEASE 0x0800
113 #define CTR_RELOAD 0x0002
114 #define CTR_STORE 0x0001
116 #define RS_ALGNERR 0x8000
117 #define RS_BRODCAST 0x4000
118 #define RS_BADCRC 0x2000
119 #define RS_ODDFRAME 0x1000
120 #define RS_TOOLONG 0x0800
121 #define RS_TOOSHORT 0x0400
122 #define RS_MULTICAST 0x0001
124 /* Update interrupt status. */
125 static void smc91c111_update(smc91c111_state
*s
)
129 if (s
->tx_fifo_len
== 0)
130 s
->int_level
|= INT_TX_EMPTY
;
131 if (s
->tx_fifo_done_len
!= 0)
132 s
->int_level
|= INT_TX
;
133 level
= (s
->int_level
& s
->int_mask
) != 0;
134 qemu_set_irq(s
->irq
, level
);
137 static bool smc91c111_can_receive(smc91c111_state
*s
)
139 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
)) {
142 if (s
->allocated
== (1 << NUM_PACKETS
) - 1 ||
143 s
->rx_fifo_len
== NUM_PACKETS
) {
149 static inline void smc91c111_flush_queued_packets(smc91c111_state
*s
)
151 if (smc91c111_can_receive(s
)) {
152 qemu_flush_queued_packets(qemu_get_queue(s
->nic
));
156 /* Try to allocate a packet. Returns 0x80 on failure. */
157 static int smc91c111_allocate_packet(smc91c111_state
*s
)
160 if (s
->allocated
== (1 << NUM_PACKETS
) - 1) {
164 for (i
= 0; i
< NUM_PACKETS
; i
++) {
165 if ((s
->allocated
& (1 << i
)) == 0)
168 s
->allocated
|= 1 << i
;
173 /* Process a pending TX allocate. */
174 static void smc91c111_tx_alloc(smc91c111_state
*s
)
176 s
->tx_alloc
= smc91c111_allocate_packet(s
);
177 if (s
->tx_alloc
== 0x80)
179 s
->int_level
|= INT_ALLOC
;
183 /* Remove and item from the RX FIFO. */
184 static void smc91c111_pop_rx_fifo(smc91c111_state
*s
)
189 if (s
->rx_fifo_len
) {
190 for (i
= 0; i
< s
->rx_fifo_len
; i
++)
191 s
->rx_fifo
[i
] = s
->rx_fifo
[i
+ 1];
192 s
->int_level
|= INT_RCV
;
194 s
->int_level
&= ~INT_RCV
;
196 smc91c111_flush_queued_packets(s
);
200 /* Remove an item from the TX completion FIFO. */
201 static void smc91c111_pop_tx_fifo_done(smc91c111_state
*s
)
205 if (s
->tx_fifo_done_len
== 0)
207 s
->tx_fifo_done_len
--;
208 for (i
= 0; i
< s
->tx_fifo_done_len
; i
++)
209 s
->tx_fifo_done
[i
] = s
->tx_fifo_done
[i
+ 1];
212 /* Release the memory allocated to a packet. */
213 static void smc91c111_release_packet(smc91c111_state
*s
, int packet
)
215 s
->allocated
&= ~(1 << packet
);
216 if (s
->tx_alloc
== 0x80)
217 smc91c111_tx_alloc(s
);
218 smc91c111_flush_queued_packets(s
);
221 /* Flush the TX FIFO. */
222 static void smc91c111_do_tx(smc91c111_state
*s
)
230 if ((s
->tcr
& TCR_TXEN
) == 0)
232 if (s
->tx_fifo_len
== 0)
234 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
235 packetnum
= s
->tx_fifo
[i
];
236 p
= &s
->data
[packetnum
][0];
237 /* Set status word. */
241 len
|= ((int)*(p
++)) << 8;
243 control
= p
[len
+ 1];
246 /* ??? This overwrites the data following the buffer.
247 Don't know what real hardware does. */
248 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
249 memset(p
+ len
, 0, 64 - len
);
256 /* The card is supposed to append the CRC to the frame.
257 However none of the other network traffic has the CRC
258 appended. Suspect this is low level ethernet detail we
259 don't need to worry about. */
260 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
264 crc
= crc32(~0, p
, len
);
265 memcpy(p
+ len
, &crc
, 4);
270 if (s
->ctr
& CTR_AUTO_RELEASE
)
272 smc91c111_release_packet(s
, packetnum
);
273 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
274 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
275 qemu_send_packet(qemu_get_queue(s
->nic
), p
, len
);
281 /* Add a packet to the TX FIFO. */
282 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
284 if (s
->tx_fifo_len
== NUM_PACKETS
)
286 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
290 static void smc91c111_reset(DeviceState
*dev
)
292 smc91c111_state
*s
= SMC91C111(dev
);
296 s
->tx_fifo_done_len
= 0;
307 s
->int_level
= INT_TX_EMPTY
;
312 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
313 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
315 static void smc91c111_writeb(void *opaque
, hwaddr offset
,
318 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
320 offset
= offset
& 0xf;
334 SET_HIGH(tcr
, value
);
340 SET_HIGH(rcr
, value
);
341 if (s
->rcr
& RCR_SOFT_RST
) {
342 smc91c111_reset(DEVICE(s
));
344 smc91c111_flush_queued_packets(s
);
346 case 10: case 11: /* RPCR */
349 case 12: case 13: /* Reserved */
362 case 2: case 3: /* BASE */
363 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
364 /* Not implemented. */
366 case 10: /* Genral Purpose */
370 SET_HIGH(gpr
, value
);
372 case 12: /* Control */
374 qemu_log_mask(LOG_UNIMP
,
375 "smc91c111: EEPROM store not implemented\n");
378 qemu_log_mask(LOG_UNIMP
,
379 "smc91c111: EEPROM reload not implemented\n");
385 SET_HIGH(ctr
, value
);
392 case 0: /* MMU Command */
393 switch (value
>> 5) {
396 case 1: /* Allocate for TX. */
398 s
->int_level
&= ~INT_ALLOC
;
400 smc91c111_tx_alloc(s
);
402 case 2: /* Reset MMU. */
405 s
->tx_fifo_done_len
= 0;
409 case 3: /* Remove from RX FIFO. */
410 smc91c111_pop_rx_fifo(s
);
412 case 4: /* Remove from RX FIFO and release. */
413 if (s
->rx_fifo_len
> 0) {
414 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
416 smc91c111_pop_rx_fifo(s
);
418 case 5: /* Release. */
419 smc91c111_release_packet(s
, s
->packet_num
);
421 case 6: /* Add to TX FIFO. */
422 smc91c111_queue_tx(s
, s
->packet_num
);
424 case 7: /* Reset TX FIFO. */
426 s
->tx_fifo_done_len
= 0;
433 case 2: /* Packet Number Register */
434 s
->packet_num
= value
;
436 case 3: case 4: case 5:
437 /* Should be readonly, but linux writes to them anyway. Ignore. */
439 case 6: /* Pointer */
443 SET_HIGH(ptr
, value
);
445 case 8: case 9: case 10: case 11: /* Data */
455 if (s
->ptr
& 0x4000) {
456 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
460 s
->data
[n
][p
] = value
;
463 case 12: /* Interrupt ACK. */
464 s
->int_level
&= ~(value
& 0xd6);
466 smc91c111_pop_tx_fifo_done(s
);
469 case 13: /* Interrupt mask. */
478 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
479 /* Multicast table. */
480 /* Not implemented. */
482 case 8: case 9: /* Management Interface. */
483 /* Not implemented. */
485 case 12: /* Early receive. */
486 s
->ercv
= value
& 0x1f;
494 qemu_log_mask(LOG_GUEST_ERROR
, "smc91c111_write(bank:%d) Illegal register"
495 " 0x%" HWADDR_PRIx
" = 0x%x\n",
496 s
->bank
, offset
, value
);
499 static uint32_t smc91c111_readb(void *opaque
, hwaddr offset
)
501 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
503 offset
= offset
& 0xf;
513 return s
->tcr
& 0xff;
516 case 2: /* EPH Status */
521 return s
->rcr
& 0xff;
524 case 6: /* Counter */
526 /* Not implemented. */
528 case 8: /* Memory size. */
530 case 9: /* Free memory available. */
535 for (i
= 0; i
< NUM_PACKETS
; i
++) {
536 if (s
->allocated
& (1 << i
))
541 case 10: case 11: /* RPCR */
542 /* Not implemented. */
544 case 12: case 13: /* Reserved */
555 case 2: case 3: /* BASE */
556 /* Not implemented. */
558 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
559 return s
->conf
.macaddr
.a
[offset
- 4];
560 case 10: /* General Purpose */
561 return s
->gpr
& 0xff;
564 case 12: /* Control */
565 return s
->ctr
& 0xff;
573 case 0: case 1: /* MMUCR Busy bit. */
575 case 2: /* Packet Number. */
576 return s
->packet_num
;
577 case 3: /* Allocation Result. */
579 case 4: /* TX FIFO */
580 if (s
->tx_fifo_done_len
== 0)
583 return s
->tx_fifo_done
[0];
584 case 5: /* RX FIFO */
585 if (s
->rx_fifo_len
== 0)
588 return s
->rx_fifo
[0];
589 case 6: /* Pointer */
590 return s
->ptr
& 0xff;
592 return (s
->ptr
>> 8) & 0xf7;
593 case 8: case 9: case 10: case 11: /* Data */
603 if (s
->ptr
& 0x4000) {
604 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
608 return s
->data
[n
][p
];
610 case 12: /* Interrupt status. */
612 case 13: /* Interrupt mask. */
619 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
620 /* Multicast table. */
621 /* Not implemented. */
623 case 8: /* Management Interface. */
624 /* Not implemented. */
628 case 10: /* Revision. */
639 qemu_log_mask(LOG_GUEST_ERROR
, "smc91c111_read(bank:%d) Illegal register"
640 " 0x%" HWADDR_PRIx
"\n",
645 static uint64_t smc91c111_readfn(void *opaque
, hwaddr addr
, unsigned size
)
650 for (i
= 0; i
< size
; i
++) {
651 val
|= smc91c111_readb(opaque
, addr
+ i
) << (i
* 8);
656 static void smc91c111_writefn(void *opaque
, hwaddr addr
,
657 uint64_t value
, unsigned size
)
661 /* 32-bit writes to offset 0xc only actually write to the bank select
662 * register (offset 0xe), so skip the first two bytes we would write.
664 if (addr
== 0xc && size
== 4) {
668 for (; i
< size
; i
++) {
669 smc91c111_writeb(opaque
, addr
+ i
,
670 extract32(value
, i
* 8, 8));
674 static bool smc91c111_can_receive_nc(NetClientState
*nc
)
676 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
678 return smc91c111_can_receive(s
);
681 static ssize_t
smc91c111_receive(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
683 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
690 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
692 /* Short packets are padded with zeros. Receiving a packet
693 < 64 bytes long is considered an error condition. */
697 packetsize
= (size
& ~1);
699 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
702 /* TODO: Flag overrun and receive errors. */
703 if (packetsize
> 2048)
705 packetnum
= smc91c111_allocate_packet(s
);
706 if (packetnum
== 0x80)
708 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
710 p
= &s
->data
[packetnum
][0];
711 /* ??? Multicast packets? */
714 status
|= RS_TOOLONG
;
716 status
|= RS_ODDFRAME
;
717 *(p
++) = status
& 0xff;
718 *(p
++) = status
>> 8;
719 *(p
++) = packetsize
& 0xff;
720 *(p
++) = packetsize
>> 8;
721 memcpy(p
, buf
, size
& ~1);
723 /* Pad short packets. */
728 *(p
++) = buf
[size
- 1];
734 /* It's not clear if the CRC should go before or after the last byte in
735 odd sized packets. Linux disables the CRC, so that's no help.
736 The pictures in the documentation show the CRC aligned on a 16-bit
737 boundary before the last odd byte, so that's what we do. */
739 crc
= crc32(~0, buf
, size
);
740 *(p
++) = crc
& 0xff; crc
>>= 8;
741 *(p
++) = crc
& 0xff; crc
>>= 8;
742 *(p
++) = crc
& 0xff; crc
>>= 8;
746 *(p
++) = buf
[size
- 1];
752 /* TODO: Raise early RX interrupt? */
753 s
->int_level
|= INT_RCV
;
759 static const MemoryRegionOps smc91c111_mem_ops
= {
760 /* The special case for 32 bit writes to 0xc means we can't just
761 * set .impl.min/max_access_size to 1, unfortunately
763 .read
= smc91c111_readfn
,
764 .write
= smc91c111_writefn
,
765 .valid
.min_access_size
= 1,
766 .valid
.max_access_size
= 4,
767 .endianness
= DEVICE_NATIVE_ENDIAN
,
770 static NetClientInfo net_smc91c111_info
= {
771 .type
= NET_CLIENT_DRIVER_NIC
,
772 .size
= sizeof(NICState
),
773 .can_receive
= smc91c111_can_receive_nc
,
774 .receive
= smc91c111_receive
,
777 static void smc91c111_realize(DeviceState
*dev
, Error
**errp
)
779 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
780 smc91c111_state
*s
= SMC91C111(dev
);
782 memory_region_init_io(&s
->mmio
, OBJECT(s
), &smc91c111_mem_ops
, s
,
783 "smc91c111-mmio", 16);
784 sysbus_init_mmio(sbd
, &s
->mmio
);
785 sysbus_init_irq(sbd
, &s
->irq
);
786 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
787 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
788 object_get_typename(OBJECT(dev
)), dev
->id
, s
);
789 qemu_format_nic_info_str(qemu_get_queue(s
->nic
), s
->conf
.macaddr
.a
);
790 /* ??? Save/restore. */
793 static Property smc91c111_properties
[] = {
794 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
795 DEFINE_PROP_END_OF_LIST(),
798 static void smc91c111_class_init(ObjectClass
*klass
, void *data
)
800 DeviceClass
*dc
= DEVICE_CLASS(klass
);
802 dc
->realize
= smc91c111_realize
;
803 dc
->reset
= smc91c111_reset
;
804 dc
->vmsd
= &vmstate_smc91c111
;
805 device_class_set_props(dc
, smc91c111_properties
);
808 static const TypeInfo smc91c111_info
= {
809 .name
= TYPE_SMC91C111
,
810 .parent
= TYPE_SYS_BUS_DEVICE
,
811 .instance_size
= sizeof(smc91c111_state
),
812 .class_init
= smc91c111_class_init
,
815 static void smc91c111_register_types(void)
817 type_register_static(&smc91c111_info
);
820 /* Legacy helper function. Should go away when machine config files are
822 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
827 qemu_check_nic_model(nd
, "smc91c111");
828 dev
= qdev_new(TYPE_SMC91C111
);
829 qdev_set_nic_properties(dev
, nd
);
830 s
= SYS_BUS_DEVICE(dev
);
831 sysbus_realize_and_unref(s
, &error_fatal
);
832 sysbus_mmio_map(s
, 0, base
);
833 sysbus_connect_irq(s
, 0, irq
);
836 type_init(smc91c111_register_types
)