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 OBJECT_DECLARE_SIMPLE_TYPE(smc91c111_state
, SMC91C111
)
30 struct smc91c111_state
{
31 SysBusDevice parent_obj
;
46 /* Bitmask of allocated packets. */
49 int tx_fifo
[NUM_PACKETS
];
51 int rx_fifo
[NUM_PACKETS
];
53 int tx_fifo_done
[NUM_PACKETS
];
54 /* Packet buffer memory. */
55 uint8_t data
[NUM_PACKETS
][2048];
61 static const VMStateDescription vmstate_smc91c111
= {
64 .minimum_version_id
= 1,
65 .fields
= (VMStateField
[]) {
66 VMSTATE_UINT16(tcr
, smc91c111_state
),
67 VMSTATE_UINT16(rcr
, smc91c111_state
),
68 VMSTATE_UINT16(cr
, smc91c111_state
),
69 VMSTATE_UINT16(ctr
, smc91c111_state
),
70 VMSTATE_UINT16(gpr
, smc91c111_state
),
71 VMSTATE_UINT16(ptr
, smc91c111_state
),
72 VMSTATE_UINT16(ercv
, smc91c111_state
),
73 VMSTATE_INT32(bank
, smc91c111_state
),
74 VMSTATE_INT32(packet_num
, smc91c111_state
),
75 VMSTATE_INT32(tx_alloc
, smc91c111_state
),
76 VMSTATE_INT32(allocated
, smc91c111_state
),
77 VMSTATE_INT32(tx_fifo_len
, smc91c111_state
),
78 VMSTATE_INT32_ARRAY(tx_fifo
, smc91c111_state
, NUM_PACKETS
),
79 VMSTATE_INT32(rx_fifo_len
, smc91c111_state
),
80 VMSTATE_INT32_ARRAY(rx_fifo
, smc91c111_state
, NUM_PACKETS
),
81 VMSTATE_INT32(tx_fifo_done_len
, smc91c111_state
),
82 VMSTATE_INT32_ARRAY(tx_fifo_done
, smc91c111_state
, NUM_PACKETS
),
83 VMSTATE_BUFFER_UNSAFE(data
, smc91c111_state
, 0, NUM_PACKETS
* 2048),
84 VMSTATE_UINT8(int_level
, smc91c111_state
),
85 VMSTATE_UINT8(int_mask
, smc91c111_state
),
90 #define RCR_SOFT_RST 0x8000
91 #define RCR_STRIP_CRC 0x0200
92 #define RCR_RXEN 0x0100
94 #define TCR_EPH_LOOP 0x2000
95 #define TCR_NOCRC 0x0100
96 #define TCR_PAD_EN 0x0080
97 #define TCR_FORCOL 0x0004
98 #define TCR_LOOP 0x0002
99 #define TCR_TXEN 0x0001
102 #define INT_ERCV 0x40
104 #define INT_RX_OVRN 0x10
105 #define INT_ALLOC 0x08
106 #define INT_TX_EMPTY 0x04
110 #define CTR_AUTO_RELEASE 0x0800
111 #define CTR_RELOAD 0x0002
112 #define CTR_STORE 0x0001
114 #define RS_ALGNERR 0x8000
115 #define RS_BRODCAST 0x4000
116 #define RS_BADCRC 0x2000
117 #define RS_ODDFRAME 0x1000
118 #define RS_TOOLONG 0x0800
119 #define RS_TOOSHORT 0x0400
120 #define RS_MULTICAST 0x0001
122 /* Update interrupt status. */
123 static void smc91c111_update(smc91c111_state
*s
)
127 if (s
->tx_fifo_len
== 0)
128 s
->int_level
|= INT_TX_EMPTY
;
129 if (s
->tx_fifo_done_len
!= 0)
130 s
->int_level
|= INT_TX
;
131 level
= (s
->int_level
& s
->int_mask
) != 0;
132 qemu_set_irq(s
->irq
, level
);
135 static bool smc91c111_can_receive(smc91c111_state
*s
)
137 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
)) {
140 if (s
->allocated
== (1 << NUM_PACKETS
) - 1 ||
141 s
->rx_fifo_len
== NUM_PACKETS
) {
147 static inline void smc91c111_flush_queued_packets(smc91c111_state
*s
)
149 if (smc91c111_can_receive(s
)) {
150 qemu_flush_queued_packets(qemu_get_queue(s
->nic
));
154 /* Try to allocate a packet. Returns 0x80 on failure. */
155 static int smc91c111_allocate_packet(smc91c111_state
*s
)
158 if (s
->allocated
== (1 << NUM_PACKETS
) - 1) {
162 for (i
= 0; i
< NUM_PACKETS
; i
++) {
163 if ((s
->allocated
& (1 << i
)) == 0)
166 s
->allocated
|= 1 << i
;
171 /* Process a pending TX allocate. */
172 static void smc91c111_tx_alloc(smc91c111_state
*s
)
174 s
->tx_alloc
= smc91c111_allocate_packet(s
);
175 if (s
->tx_alloc
== 0x80)
177 s
->int_level
|= INT_ALLOC
;
181 /* Remove and item from the RX FIFO. */
182 static void smc91c111_pop_rx_fifo(smc91c111_state
*s
)
187 if (s
->rx_fifo_len
) {
188 for (i
= 0; i
< s
->rx_fifo_len
; i
++)
189 s
->rx_fifo
[i
] = s
->rx_fifo
[i
+ 1];
190 s
->int_level
|= INT_RCV
;
192 s
->int_level
&= ~INT_RCV
;
194 smc91c111_flush_queued_packets(s
);
198 /* Remove an item from the TX completion FIFO. */
199 static void smc91c111_pop_tx_fifo_done(smc91c111_state
*s
)
203 if (s
->tx_fifo_done_len
== 0)
205 s
->tx_fifo_done_len
--;
206 for (i
= 0; i
< s
->tx_fifo_done_len
; i
++)
207 s
->tx_fifo_done
[i
] = s
->tx_fifo_done
[i
+ 1];
210 /* Release the memory allocated to a packet. */
211 static void smc91c111_release_packet(smc91c111_state
*s
, int packet
)
213 s
->allocated
&= ~(1 << packet
);
214 if (s
->tx_alloc
== 0x80)
215 smc91c111_tx_alloc(s
);
216 smc91c111_flush_queued_packets(s
);
219 /* Flush the TX FIFO. */
220 static void smc91c111_do_tx(smc91c111_state
*s
)
228 if ((s
->tcr
& TCR_TXEN
) == 0)
230 if (s
->tx_fifo_len
== 0)
232 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
233 packetnum
= s
->tx_fifo
[i
];
234 p
= &s
->data
[packetnum
][0];
235 /* Set status word. */
239 len
|= ((int)*(p
++)) << 8;
241 control
= p
[len
+ 1];
244 /* ??? This overwrites the data following the buffer.
245 Don't know what real hardware does. */
246 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
247 memset(p
+ len
, 0, 64 - len
);
254 /* The card is supposed to append the CRC to the frame.
255 However none of the other network traffic has the CRC
256 appended. Suspect this is low level ethernet detail we
257 don't need to worry about. */
258 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
262 crc
= crc32(~0, p
, len
);
263 memcpy(p
+ len
, &crc
, 4);
268 if (s
->ctr
& CTR_AUTO_RELEASE
)
270 smc91c111_release_packet(s
, packetnum
);
271 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
272 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
273 qemu_send_packet(qemu_get_queue(s
->nic
), p
, len
);
279 /* Add a packet to the TX FIFO. */
280 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
282 if (s
->tx_fifo_len
== NUM_PACKETS
)
284 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
288 static void smc91c111_reset(DeviceState
*dev
)
290 smc91c111_state
*s
= SMC91C111(dev
);
294 s
->tx_fifo_done_len
= 0;
305 s
->int_level
= INT_TX_EMPTY
;
310 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
311 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
313 static void smc91c111_writeb(void *opaque
, hwaddr offset
,
316 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
318 offset
= offset
& 0xf;
332 SET_HIGH(tcr
, value
);
338 SET_HIGH(rcr
, value
);
339 if (s
->rcr
& RCR_SOFT_RST
) {
340 smc91c111_reset(DEVICE(s
));
342 smc91c111_flush_queued_packets(s
);
344 case 10: case 11: /* RPCR */
347 case 12: case 13: /* Reserved */
360 case 2: case 3: /* BASE */
361 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
362 /* Not implemented. */
364 case 10: /* Genral Purpose */
368 SET_HIGH(gpr
, value
);
370 case 12: /* Control */
372 qemu_log_mask(LOG_UNIMP
,
373 "smc91c111: EEPROM store not implemented\n");
376 qemu_log_mask(LOG_UNIMP
,
377 "smc91c111: EEPROM reload not implemented\n");
383 SET_HIGH(ctr
, value
);
390 case 0: /* MMU Command */
391 switch (value
>> 5) {
394 case 1: /* Allocate for TX. */
396 s
->int_level
&= ~INT_ALLOC
;
398 smc91c111_tx_alloc(s
);
400 case 2: /* Reset MMU. */
403 s
->tx_fifo_done_len
= 0;
407 case 3: /* Remove from RX FIFO. */
408 smc91c111_pop_rx_fifo(s
);
410 case 4: /* Remove from RX FIFO and release. */
411 if (s
->rx_fifo_len
> 0) {
412 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
414 smc91c111_pop_rx_fifo(s
);
416 case 5: /* Release. */
417 smc91c111_release_packet(s
, s
->packet_num
);
419 case 6: /* Add to TX FIFO. */
420 smc91c111_queue_tx(s
, s
->packet_num
);
422 case 7: /* Reset TX FIFO. */
424 s
->tx_fifo_done_len
= 0;
431 case 2: /* Packet Number Register */
432 s
->packet_num
= value
;
434 case 3: case 4: case 5:
435 /* Should be readonly, but linux writes to them anyway. Ignore. */
437 case 6: /* Pointer */
441 SET_HIGH(ptr
, value
);
443 case 8: case 9: case 10: case 11: /* Data */
453 if (s
->ptr
& 0x4000) {
454 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
458 s
->data
[n
][p
] = value
;
461 case 12: /* Interrupt ACK. */
462 s
->int_level
&= ~(value
& 0xd6);
464 smc91c111_pop_tx_fifo_done(s
);
467 case 13: /* Interrupt mask. */
476 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
477 /* Multicast table. */
478 /* Not implemented. */
480 case 8: case 9: /* Management Interface. */
481 /* Not implemented. */
483 case 12: /* Early receive. */
484 s
->ercv
= value
& 0x1f;
492 qemu_log_mask(LOG_GUEST_ERROR
, "smc91c111_write(bank:%d) Illegal register"
493 " 0x%" HWADDR_PRIx
" = 0x%x\n",
494 s
->bank
, offset
, value
);
497 static uint32_t smc91c111_readb(void *opaque
, hwaddr offset
)
499 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
501 offset
= offset
& 0xf;
511 return s
->tcr
& 0xff;
514 case 2: /* EPH Status */
519 return s
->rcr
& 0xff;
522 case 6: /* Counter */
524 /* Not implemented. */
526 case 8: /* Memory size. */
528 case 9: /* Free memory available. */
533 for (i
= 0; i
< NUM_PACKETS
; i
++) {
534 if (s
->allocated
& (1 << i
))
539 case 10: case 11: /* RPCR */
540 /* Not implemented. */
542 case 12: case 13: /* Reserved */
553 case 2: case 3: /* BASE */
554 /* Not implemented. */
556 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
557 return s
->conf
.macaddr
.a
[offset
- 4];
558 case 10: /* General Purpose */
559 return s
->gpr
& 0xff;
562 case 12: /* Control */
563 return s
->ctr
& 0xff;
571 case 0: case 1: /* MMUCR Busy bit. */
573 case 2: /* Packet Number. */
574 return s
->packet_num
;
575 case 3: /* Allocation Result. */
577 case 4: /* TX FIFO */
578 if (s
->tx_fifo_done_len
== 0)
581 return s
->tx_fifo_done
[0];
582 case 5: /* RX FIFO */
583 if (s
->rx_fifo_len
== 0)
586 return s
->rx_fifo
[0];
587 case 6: /* Pointer */
588 return s
->ptr
& 0xff;
590 return (s
->ptr
>> 8) & 0xf7;
591 case 8: case 9: case 10: case 11: /* Data */
601 if (s
->ptr
& 0x4000) {
602 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
606 return s
->data
[n
][p
];
608 case 12: /* Interrupt status. */
610 case 13: /* Interrupt mask. */
617 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
618 /* Multicast table. */
619 /* Not implemented. */
621 case 8: /* Management Interface. */
622 /* Not implemented. */
626 case 10: /* Revision. */
637 qemu_log_mask(LOG_GUEST_ERROR
, "smc91c111_read(bank:%d) Illegal register"
638 " 0x%" HWADDR_PRIx
"\n",
643 static uint64_t smc91c111_readfn(void *opaque
, hwaddr addr
, unsigned size
)
648 for (i
= 0; i
< size
; i
++) {
649 val
|= smc91c111_readb(opaque
, addr
+ i
) << (i
* 8);
654 static void smc91c111_writefn(void *opaque
, hwaddr addr
,
655 uint64_t value
, unsigned size
)
659 /* 32-bit writes to offset 0xc only actually write to the bank select
660 * register (offset 0xe), so skip the first two bytes we would write.
662 if (addr
== 0xc && size
== 4) {
666 for (; i
< size
; i
++) {
667 smc91c111_writeb(opaque
, addr
+ i
,
668 extract32(value
, i
* 8, 8));
672 static bool smc91c111_can_receive_nc(NetClientState
*nc
)
674 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
676 return smc91c111_can_receive(s
);
679 static ssize_t
smc91c111_receive(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
681 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
688 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
690 /* Short packets are padded with zeros. Receiving a packet
691 < 64 bytes long is considered an error condition. */
695 packetsize
= (size
& ~1);
697 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
700 /* TODO: Flag overrun and receive errors. */
701 if (packetsize
> 2048)
703 packetnum
= smc91c111_allocate_packet(s
);
704 if (packetnum
== 0x80)
706 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
708 p
= &s
->data
[packetnum
][0];
709 /* ??? Multicast packets? */
712 status
|= RS_TOOLONG
;
714 status
|= RS_ODDFRAME
;
715 *(p
++) = status
& 0xff;
716 *(p
++) = status
>> 8;
717 *(p
++) = packetsize
& 0xff;
718 *(p
++) = packetsize
>> 8;
719 memcpy(p
, buf
, size
& ~1);
721 /* Pad short packets. */
726 *(p
++) = buf
[size
- 1];
732 /* It's not clear if the CRC should go before or after the last byte in
733 odd sized packets. Linux disables the CRC, so that's no help.
734 The pictures in the documentation show the CRC aligned on a 16-bit
735 boundary before the last odd byte, so that's what we do. */
737 crc
= crc32(~0, buf
, size
);
738 *(p
++) = crc
& 0xff; crc
>>= 8;
739 *(p
++) = crc
& 0xff; crc
>>= 8;
740 *(p
++) = crc
& 0xff; crc
>>= 8;
744 *(p
++) = buf
[size
- 1];
750 /* TODO: Raise early RX interrupt? */
751 s
->int_level
|= INT_RCV
;
757 static const MemoryRegionOps smc91c111_mem_ops
= {
758 /* The special case for 32 bit writes to 0xc means we can't just
759 * set .impl.min/max_access_size to 1, unfortunately
761 .read
= smc91c111_readfn
,
762 .write
= smc91c111_writefn
,
763 .valid
.min_access_size
= 1,
764 .valid
.max_access_size
= 4,
765 .endianness
= DEVICE_NATIVE_ENDIAN
,
768 static NetClientInfo net_smc91c111_info
= {
769 .type
= NET_CLIENT_DRIVER_NIC
,
770 .size
= sizeof(NICState
),
771 .can_receive
= smc91c111_can_receive_nc
,
772 .receive
= smc91c111_receive
,
775 static void smc91c111_realize(DeviceState
*dev
, Error
**errp
)
777 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
778 smc91c111_state
*s
= SMC91C111(dev
);
780 memory_region_init_io(&s
->mmio
, OBJECT(s
), &smc91c111_mem_ops
, s
,
781 "smc91c111-mmio", 16);
782 sysbus_init_mmio(sbd
, &s
->mmio
);
783 sysbus_init_irq(sbd
, &s
->irq
);
784 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
785 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
786 object_get_typename(OBJECT(dev
)), dev
->id
, s
);
787 qemu_format_nic_info_str(qemu_get_queue(s
->nic
), s
->conf
.macaddr
.a
);
788 /* ??? Save/restore. */
791 static Property smc91c111_properties
[] = {
792 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
793 DEFINE_PROP_END_OF_LIST(),
796 static void smc91c111_class_init(ObjectClass
*klass
, void *data
)
798 DeviceClass
*dc
= DEVICE_CLASS(klass
);
800 dc
->realize
= smc91c111_realize
;
801 dc
->reset
= smc91c111_reset
;
802 dc
->vmsd
= &vmstate_smc91c111
;
803 device_class_set_props(dc
, smc91c111_properties
);
806 static const TypeInfo smc91c111_info
= {
807 .name
= TYPE_SMC91C111
,
808 .parent
= TYPE_SYS_BUS_DEVICE
,
809 .instance_size
= sizeof(smc91c111_state
),
810 .class_init
= smc91c111_class_init
,
813 static void smc91c111_register_types(void)
815 type_register_static(&smc91c111_info
);
818 /* Legacy helper function. Should go away when machine config files are
820 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
825 qemu_check_nic_model(nd
, "smc91c111");
826 dev
= qdev_new(TYPE_SMC91C111
);
827 qdev_set_nic_properties(dev
, nd
);
828 s
= SYS_BUS_DEVICE(dev
);
829 sysbus_realize_and_unref(s
, &error_fatal
);
830 sysbus_mmio_map(s
, 0, base
);
831 sysbus_connect_irq(s
, 0, irq
);
834 type_init(smc91c111_register_types
)