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
);
190 /* Flush the TX FIFO. */
191 static void smc91c111_do_tx(smc91c111_state
*s
)
199 if ((s
->tcr
& TCR_TXEN
) == 0)
201 if (s
->tx_fifo_len
== 0)
203 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
204 packetnum
= s
->tx_fifo
[i
];
205 p
= &s
->data
[packetnum
][0];
206 /* Set status word. */
210 len
|= ((int)*(p
++)) << 8;
212 control
= p
[len
+ 1];
215 /* ??? This overwrites the data following the buffer.
216 Don't know what real hardware does. */
217 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
218 memset(p
+ len
, 0, 64 - len
);
225 /* The card is supposed to append the CRC to the frame.
226 However none of the other network traffic has the CRC
227 appended. Suspect this is low level ethernet detail we
228 don't need to worry about. */
229 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
233 crc
= crc32(~0, p
, len
);
234 memcpy(p
+ len
, &crc
, 4);
239 if (s
->ctr
& CTR_AUTO_RELEASE
)
241 smc91c111_release_packet(s
, packetnum
);
242 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
243 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
244 qemu_send_packet(qemu_get_queue(s
->nic
), p
, len
);
250 /* Add a packet to the TX FIFO. */
251 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
253 if (s
->tx_fifo_len
== NUM_PACKETS
)
255 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
259 static void smc91c111_reset(DeviceState
*dev
)
261 smc91c111_state
*s
= SMC91C111(dev
);
265 s
->tx_fifo_done_len
= 0;
276 s
->int_level
= INT_TX_EMPTY
;
281 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
282 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
284 static void smc91c111_writeb(void *opaque
, hwaddr offset
,
287 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
289 offset
= offset
& 0xf;
303 SET_HIGH(tcr
, value
);
309 SET_HIGH(rcr
, value
);
310 if (s
->rcr
& RCR_SOFT_RST
) {
311 smc91c111_reset(DEVICE(s
));
314 case 10: case 11: /* RPCR */
317 case 12: case 13: /* Reserved */
330 case 2: case 3: /* BASE */
331 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
332 /* Not implemented. */
334 case 10: /* Genral Purpose */
338 SET_HIGH(gpr
, value
);
340 case 12: /* Control */
342 fprintf(stderr
, "smc91c111:EEPROM store not implemented\n");
344 fprintf(stderr
, "smc91c111:EEPROM reload not implemented\n");
349 SET_HIGH(ctr
, value
);
356 case 0: /* MMU Command */
357 switch (value
>> 5) {
360 case 1: /* Allocate for TX. */
362 s
->int_level
&= ~INT_ALLOC
;
364 smc91c111_tx_alloc(s
);
366 case 2: /* Reset MMU. */
369 s
->tx_fifo_done_len
= 0;
373 case 3: /* Remove from RX FIFO. */
374 smc91c111_pop_rx_fifo(s
);
376 case 4: /* Remove from RX FIFO and release. */
377 if (s
->rx_fifo_len
> 0) {
378 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
380 smc91c111_pop_rx_fifo(s
);
382 case 5: /* Release. */
383 smc91c111_release_packet(s
, s
->packet_num
);
385 case 6: /* Add to TX FIFO. */
386 smc91c111_queue_tx(s
, s
->packet_num
);
388 case 7: /* Reset TX FIFO. */
390 s
->tx_fifo_done_len
= 0;
397 case 2: /* Packet Number Register */
398 s
->packet_num
= value
;
400 case 3: case 4: case 5:
401 /* Should be readonly, but linux writes to them anyway. Ignore. */
403 case 6: /* Pointer */
407 SET_HIGH(ptr
, value
);
409 case 8: case 9: case 10: case 11: /* Data */
419 if (s
->ptr
& 0x4000) {
420 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
424 s
->data
[n
][p
] = value
;
427 case 12: /* Interrupt ACK. */
428 s
->int_level
&= ~(value
& 0xd6);
430 smc91c111_pop_tx_fifo_done(s
);
433 case 13: /* Interrupt mask. */
442 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
443 /* Multicast table. */
444 /* Not implemented. */
446 case 8: case 9: /* Management Interface. */
447 /* Not implemented. */
449 case 12: /* Early receive. */
450 s
->ercv
= value
& 0x1f;
458 hw_error("smc91c111_write: Bad reg %d:%x\n", s
->bank
, (int)offset
);
461 static uint32_t smc91c111_readb(void *opaque
, hwaddr offset
)
463 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
465 offset
= offset
& 0xf;
475 return s
->tcr
& 0xff;
478 case 2: /* EPH Status */
483 return s
->rcr
& 0xff;
486 case 6: /* Counter */
488 /* Not implemented. */
490 case 8: /* Memory size. */
492 case 9: /* Free memory available. */
497 for (i
= 0; i
< NUM_PACKETS
; i
++) {
498 if (s
->allocated
& (1 << i
))
503 case 10: case 11: /* RPCR */
504 /* Not implemented. */
506 case 12: case 13: /* Reserved */
517 case 2: case 3: /* BASE */
518 /* Not implemented. */
520 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
521 return s
->conf
.macaddr
.a
[offset
- 4];
522 case 10: /* General Purpose */
523 return s
->gpr
& 0xff;
526 case 12: /* Control */
527 return s
->ctr
& 0xff;
535 case 0: case 1: /* MMUCR Busy bit. */
537 case 2: /* Packet Number. */
538 return s
->packet_num
;
539 case 3: /* Allocation Result. */
541 case 4: /* TX FIFO */
542 if (s
->tx_fifo_done_len
== 0)
545 return s
->tx_fifo_done
[0];
546 case 5: /* RX FIFO */
547 if (s
->rx_fifo_len
== 0)
550 return s
->rx_fifo
[0];
551 case 6: /* Pointer */
552 return s
->ptr
& 0xff;
554 return (s
->ptr
>> 8) & 0xf7;
555 case 8: case 9: case 10: case 11: /* Data */
565 if (s
->ptr
& 0x4000) {
566 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
570 return s
->data
[n
][p
];
572 case 12: /* Interrupt status. */
574 case 13: /* Interrupt mask. */
581 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
582 /* Multicast table. */
583 /* Not implemented. */
585 case 8: /* Management Interface. */
586 /* Not implemented. */
590 case 10: /* Revision. */
601 hw_error("smc91c111_read: Bad reg %d:%x\n", s
->bank
, (int)offset
);
605 static void smc91c111_writew(void *opaque
, hwaddr offset
,
608 smc91c111_writeb(opaque
, offset
, value
& 0xff);
609 smc91c111_writeb(opaque
, offset
+ 1, value
>> 8);
612 static void smc91c111_writel(void *opaque
, hwaddr offset
,
615 /* 32-bit writes to offset 0xc only actually write to the bank select
616 register (offset 0xe) */
618 smc91c111_writew(opaque
, offset
, value
& 0xffff);
619 smc91c111_writew(opaque
, offset
+ 2, value
>> 16);
622 static uint32_t smc91c111_readw(void *opaque
, hwaddr offset
)
625 val
= smc91c111_readb(opaque
, offset
);
626 val
|= smc91c111_readb(opaque
, offset
+ 1) << 8;
630 static uint32_t smc91c111_readl(void *opaque
, hwaddr offset
)
633 val
= smc91c111_readw(opaque
, offset
);
634 val
|= smc91c111_readw(opaque
, offset
+ 2) << 16;
638 static int smc91c111_can_receive(NetClientState
*nc
)
640 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
642 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
644 if (s
->allocated
== (1 << NUM_PACKETS
) - 1)
649 static ssize_t
smc91c111_receive(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
651 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
658 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
660 /* Short packets are padded with zeros. Receiving a packet
661 < 64 bytes long is considered an error condition. */
665 packetsize
= (size
& ~1);
667 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
670 /* TODO: Flag overrun and receive errors. */
671 if (packetsize
> 2048)
673 packetnum
= smc91c111_allocate_packet(s
);
674 if (packetnum
== 0x80)
676 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
678 p
= &s
->data
[packetnum
][0];
679 /* ??? Multicast packets? */
682 status
|= RS_TOOLONG
;
684 status
|= RS_ODDFRAME
;
685 *(p
++) = status
& 0xff;
686 *(p
++) = status
>> 8;
687 *(p
++) = packetsize
& 0xff;
688 *(p
++) = packetsize
>> 8;
689 memcpy(p
, buf
, size
& ~1);
691 /* Pad short packets. */
696 *(p
++) = buf
[size
- 1];
702 /* It's not clear if the CRC should go before or after the last byte in
703 odd sized packets. Linux disables the CRC, so that's no help.
704 The pictures in the documentation show the CRC aligned on a 16-bit
705 boundary before the last odd byte, so that's what we do. */
707 crc
= crc32(~0, buf
, size
);
708 *(p
++) = crc
& 0xff; crc
>>= 8;
709 *(p
++) = crc
& 0xff; crc
>>= 8;
710 *(p
++) = crc
& 0xff; crc
>>= 8;
714 *(p
++) = buf
[size
- 1];
720 /* TODO: Raise early RX interrupt? */
721 s
->int_level
|= INT_RCV
;
727 static const MemoryRegionOps smc91c111_mem_ops
= {
728 /* The special case for 32 bit writes to 0xc means we can't just
729 * set .impl.min/max_access_size to 1, unfortunately
732 .read
= { smc91c111_readb
, smc91c111_readw
, smc91c111_readl
, },
733 .write
= { smc91c111_writeb
, smc91c111_writew
, smc91c111_writel
, },
735 .endianness
= DEVICE_NATIVE_ENDIAN
,
738 static void smc91c111_cleanup(NetClientState
*nc
)
740 smc91c111_state
*s
= qemu_get_nic_opaque(nc
);
745 static NetClientInfo net_smc91c111_info
= {
746 .type
= NET_CLIENT_OPTIONS_KIND_NIC
,
747 .size
= sizeof(NICState
),
748 .can_receive
= smc91c111_can_receive
,
749 .receive
= smc91c111_receive
,
750 .cleanup
= smc91c111_cleanup
,
753 static int smc91c111_init1(SysBusDevice
*sbd
)
755 DeviceState
*dev
= DEVICE(sbd
);
756 smc91c111_state
*s
= SMC91C111(dev
);
758 memory_region_init_io(&s
->mmio
, OBJECT(s
), &smc91c111_mem_ops
, s
,
759 "smc91c111-mmio", 16);
760 sysbus_init_mmio(sbd
, &s
->mmio
);
761 sysbus_init_irq(sbd
, &s
->irq
);
762 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
763 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
764 object_get_typename(OBJECT(dev
)), dev
->id
, s
);
765 qemu_format_nic_info_str(qemu_get_queue(s
->nic
), s
->conf
.macaddr
.a
);
766 /* ??? Save/restore. */
770 static Property smc91c111_properties
[] = {
771 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
772 DEFINE_PROP_END_OF_LIST(),
775 static void smc91c111_class_init(ObjectClass
*klass
, void *data
)
777 DeviceClass
*dc
= DEVICE_CLASS(klass
);
778 SysBusDeviceClass
*k
= SYS_BUS_DEVICE_CLASS(klass
);
780 k
->init
= smc91c111_init1
;
781 dc
->reset
= smc91c111_reset
;
782 dc
->vmsd
= &vmstate_smc91c111
;
783 dc
->props
= smc91c111_properties
;
786 static const TypeInfo smc91c111_info
= {
787 .name
= TYPE_SMC91C111
,
788 .parent
= TYPE_SYS_BUS_DEVICE
,
789 .instance_size
= sizeof(smc91c111_state
),
790 .class_init
= smc91c111_class_init
,
793 static void smc91c111_register_types(void)
795 type_register_static(&smc91c111_info
);
798 /* Legacy helper function. Should go away when machine config files are
800 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
805 qemu_check_nic_model(nd
, "smc91c111");
806 dev
= qdev_create(NULL
, TYPE_SMC91C111
);
807 qdev_set_nic_properties(dev
, nd
);
808 qdev_init_nofail(dev
);
809 s
= SYS_BUS_DEVICE(dev
);
810 sysbus_mmio_map(s
, 0, base
);
811 sysbus_connect_irq(s
, 0, irq
);
814 type_init(smc91c111_register_types
)