2 * SMSC 91C111 Ethernet interface emulation
4 * Copyright (c) 2005 CodeSourcery, LLC.
5 * Written by Paul Brook
7 * This code is licenced under the GPL
16 /* Number of 2k memory pages available. */
34 /* Bitmask of allocated packets. */
37 int tx_fifo
[NUM_PACKETS
];
39 int rx_fifo
[NUM_PACKETS
];
41 int tx_fifo_done
[NUM_PACKETS
];
42 /* Packet buffer memory. */
43 uint8_t data
[NUM_PACKETS
][2048];
49 static const VMStateDescription vmstate_smc91c111
= {
52 .minimum_version_id
= 1,
53 .fields
= (VMStateField
[]) {
54 VMSTATE_UINT16(tcr
, smc91c111_state
),
55 VMSTATE_UINT16(rcr
, smc91c111_state
),
56 VMSTATE_UINT16(cr
, smc91c111_state
),
57 VMSTATE_UINT16(ctr
, smc91c111_state
),
58 VMSTATE_UINT16(gpr
, smc91c111_state
),
59 VMSTATE_UINT16(ptr
, smc91c111_state
),
60 VMSTATE_UINT16(ercv
, smc91c111_state
),
61 VMSTATE_INT32(bank
, smc91c111_state
),
62 VMSTATE_INT32(packet_num
, smc91c111_state
),
63 VMSTATE_INT32(tx_alloc
, smc91c111_state
),
64 VMSTATE_INT32(allocated
, smc91c111_state
),
65 VMSTATE_INT32(tx_fifo_len
, smc91c111_state
),
66 VMSTATE_INT32_ARRAY(tx_fifo
, smc91c111_state
, NUM_PACKETS
),
67 VMSTATE_INT32(rx_fifo_len
, smc91c111_state
),
68 VMSTATE_INT32_ARRAY(rx_fifo
, smc91c111_state
, NUM_PACKETS
),
69 VMSTATE_INT32(tx_fifo_done_len
, smc91c111_state
),
70 VMSTATE_INT32_ARRAY(tx_fifo_done
, smc91c111_state
, NUM_PACKETS
),
71 VMSTATE_BUFFER_UNSAFE(data
, smc91c111_state
, 0, NUM_PACKETS
* 2048),
72 VMSTATE_UINT8(int_level
, smc91c111_state
),
73 VMSTATE_UINT8(int_mask
, smc91c111_state
),
78 #define RCR_SOFT_RST 0x8000
79 #define RCR_STRIP_CRC 0x0200
80 #define RCR_RXEN 0x0100
82 #define TCR_EPH_LOOP 0x2000
83 #define TCR_NOCRC 0x0100
84 #define TCR_PAD_EN 0x0080
85 #define TCR_FORCOL 0x0004
86 #define TCR_LOOP 0x0002
87 #define TCR_TXEN 0x0001
92 #define INT_RX_OVRN 0x10
93 #define INT_ALLOC 0x08
94 #define INT_TX_EMPTY 0x04
98 #define CTR_AUTO_RELEASE 0x0800
99 #define CTR_RELOAD 0x0002
100 #define CTR_STORE 0x0001
102 #define RS_ALGNERR 0x8000
103 #define RS_BRODCAST 0x4000
104 #define RS_BADCRC 0x2000
105 #define RS_ODDFRAME 0x1000
106 #define RS_TOOLONG 0x0800
107 #define RS_TOOSHORT 0x0400
108 #define RS_MULTICAST 0x0001
110 /* Update interrupt status. */
111 static void smc91c111_update(smc91c111_state
*s
)
115 if (s
->tx_fifo_len
== 0)
116 s
->int_level
|= INT_TX_EMPTY
;
117 if (s
->tx_fifo_done_len
!= 0)
118 s
->int_level
|= INT_TX
;
119 level
= (s
->int_level
& s
->int_mask
) != 0;
120 qemu_set_irq(s
->irq
, level
);
123 /* Try to allocate a packet. Returns 0x80 on failure. */
124 static int smc91c111_allocate_packet(smc91c111_state
*s
)
127 if (s
->allocated
== (1 << NUM_PACKETS
) - 1) {
131 for (i
= 0; i
< NUM_PACKETS
; i
++) {
132 if ((s
->allocated
& (1 << i
)) == 0)
135 s
->allocated
|= 1 << i
;
140 /* Process a pending TX allocate. */
141 static void smc91c111_tx_alloc(smc91c111_state
*s
)
143 s
->tx_alloc
= smc91c111_allocate_packet(s
);
144 if (s
->tx_alloc
== 0x80)
146 s
->int_level
|= INT_ALLOC
;
150 /* Remove and item from the RX FIFO. */
151 static void smc91c111_pop_rx_fifo(smc91c111_state
*s
)
156 if (s
->rx_fifo_len
) {
157 for (i
= 0; i
< s
->rx_fifo_len
; i
++)
158 s
->rx_fifo
[i
] = s
->rx_fifo
[i
+ 1];
159 s
->int_level
|= INT_RCV
;
161 s
->int_level
&= ~INT_RCV
;
166 /* Remove an item from the TX completion FIFO. */
167 static void smc91c111_pop_tx_fifo_done(smc91c111_state
*s
)
171 if (s
->tx_fifo_done_len
== 0)
173 s
->tx_fifo_done_len
--;
174 for (i
= 0; i
< s
->tx_fifo_done_len
; i
++)
175 s
->tx_fifo_done
[i
] = s
->tx_fifo_done
[i
+ 1];
178 /* Release the memory allocated to a packet. */
179 static void smc91c111_release_packet(smc91c111_state
*s
, int packet
)
181 s
->allocated
&= ~(1 << packet
);
182 if (s
->tx_alloc
== 0x80)
183 smc91c111_tx_alloc(s
);
186 /* Flush the TX FIFO. */
187 static void smc91c111_do_tx(smc91c111_state
*s
)
195 if ((s
->tcr
& TCR_TXEN
) == 0)
197 if (s
->tx_fifo_len
== 0)
199 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
200 packetnum
= s
->tx_fifo
[i
];
201 p
= &s
->data
[packetnum
][0];
202 /* Set status word. */
206 len
|= ((int)*(p
++)) << 8;
208 control
= p
[len
+ 1];
211 /* ??? This overwrites the data following the buffer.
212 Don't know what real hardware does. */
213 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
214 memset(p
+ len
, 0, 64 - len
);
221 /* The card is supposed to append the CRC to the frame.
222 However none of the other network traffic has the CRC
223 appended. Suspect this is low level ethernet detail we
224 don't need to worry about. */
225 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
229 crc
= crc32(~0, p
, len
);
230 memcpy(p
+ len
, &crc
, 4);
235 if (s
->ctr
& CTR_AUTO_RELEASE
)
237 smc91c111_release_packet(s
, packetnum
);
238 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
239 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
240 qemu_send_packet(&s
->nic
->nc
, p
, len
);
246 /* Add a packet to the TX FIFO. */
247 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
249 if (s
->tx_fifo_len
== NUM_PACKETS
)
251 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
255 static void smc91c111_reset(smc91c111_state
*s
)
259 s
->tx_fifo_done_len
= 0;
270 s
->int_level
= INT_TX_EMPTY
;
275 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
276 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
278 static void smc91c111_writeb(void *opaque
, target_phys_addr_t offset
,
281 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
283 offset
= offset
& 0xf;
297 SET_HIGH(tcr
, value
);
303 SET_HIGH(rcr
, value
);
304 if (s
->rcr
& RCR_SOFT_RST
)
307 case 10: case 11: /* RPCR */
310 case 12: case 13: /* Reserved */
323 case 2: case 3: /* BASE */
324 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
325 /* Not implemented. */
327 case 10: /* Genral Purpose */
331 SET_HIGH(gpr
, value
);
333 case 12: /* Control */
335 fprintf(stderr
, "smc91c111:EEPROM store not implemented\n");
337 fprintf(stderr
, "smc91c111:EEPROM reload not implemented\n");
342 SET_HIGH(ctr
, value
);
349 case 0: /* MMU Command */
350 switch (value
>> 5) {
353 case 1: /* Allocate for TX. */
355 s
->int_level
&= ~INT_ALLOC
;
357 smc91c111_tx_alloc(s
);
359 case 2: /* Reset MMU. */
362 s
->tx_fifo_done_len
= 0;
366 case 3: /* Remove from RX FIFO. */
367 smc91c111_pop_rx_fifo(s
);
369 case 4: /* Remove from RX FIFO and release. */
370 if (s
->rx_fifo_len
> 0) {
371 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
373 smc91c111_pop_rx_fifo(s
);
375 case 5: /* Release. */
376 smc91c111_release_packet(s
, s
->packet_num
);
378 case 6: /* Add to TX FIFO. */
379 smc91c111_queue_tx(s
, s
->packet_num
);
381 case 7: /* Reset TX FIFO. */
383 s
->tx_fifo_done_len
= 0;
390 case 2: /* Packet Number Register */
391 s
->packet_num
= value
;
393 case 3: case 4: case 5:
394 /* Should be readonly, but linux writes to them anyway. Ignore. */
396 case 6: /* Pointer */
400 SET_HIGH(ptr
, value
);
402 case 8: case 9: case 10: case 11: /* Data */
412 if (s
->ptr
& 0x4000) {
413 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
417 s
->data
[n
][p
] = value
;
420 case 12: /* Interrupt ACK. */
421 s
->int_level
&= ~(value
& 0xd6);
423 smc91c111_pop_tx_fifo_done(s
);
426 case 13: /* Interrupt mask. */
435 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
436 /* Multicast table. */
437 /* Not implemented. */
439 case 8: case 9: /* Management Interface. */
440 /* Not implemented. */
442 case 12: /* Early receive. */
443 s
->ercv
= value
& 0x1f;
450 hw_error("smc91c111_write: Bad reg %d:%x\n", s
->bank
, (int)offset
);
453 static uint32_t smc91c111_readb(void *opaque
, target_phys_addr_t offset
)
455 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
457 offset
= offset
& 0xf;
467 return s
->tcr
& 0xff;
470 case 2: /* EPH Status */
475 return s
->rcr
& 0xff;
478 case 6: /* Counter */
480 /* Not implemented. */
482 case 8: /* Memory size. */
484 case 9: /* Free memory available. */
489 for (i
= 0; i
< NUM_PACKETS
; i
++) {
490 if (s
->allocated
& (1 << i
))
495 case 10: case 11: /* RPCR */
496 /* Not implemented. */
498 case 12: case 13: /* Reserved */
509 case 2: case 3: /* BASE */
510 /* Not implemented. */
512 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
513 return s
->conf
.macaddr
.a
[offset
- 4];
514 case 10: /* General Purpose */
515 return s
->gpr
& 0xff;
518 case 12: /* Control */
519 return s
->ctr
& 0xff;
527 case 0: case 1: /* MMUCR Busy bit. */
529 case 2: /* Packet Number. */
530 return s
->packet_num
;
531 case 3: /* Allocation Result. */
533 case 4: /* TX FIFO */
534 if (s
->tx_fifo_done_len
== 0)
537 return s
->tx_fifo_done
[0];
538 case 5: /* RX FIFO */
539 if (s
->rx_fifo_len
== 0)
542 return s
->rx_fifo
[0];
543 case 6: /* Pointer */
544 return s
->ptr
& 0xff;
546 return (s
->ptr
>> 8) & 0xf7;
547 case 8: case 9: case 10: case 11: /* Data */
557 if (s
->ptr
& 0x4000) {
558 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
562 return s
->data
[n
][p
];
564 case 12: /* Interrupt status. */
566 case 13: /* Interrupt mask. */
573 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
574 /* Multicast table. */
575 /* Not implemented. */
577 case 8: /* Management Interface. */
578 /* Not implemented. */
582 case 10: /* Revision. */
593 hw_error("smc91c111_read: Bad reg %d:%x\n", s
->bank
, (int)offset
);
597 static void smc91c111_writew(void *opaque
, target_phys_addr_t offset
,
600 smc91c111_writeb(opaque
, offset
, value
& 0xff);
601 smc91c111_writeb(opaque
, offset
+ 1, value
>> 8);
604 static void smc91c111_writel(void *opaque
, target_phys_addr_t offset
,
607 /* 32-bit writes to offset 0xc only actually write to the bank select
608 register (offset 0xe) */
610 smc91c111_writew(opaque
, offset
, value
& 0xffff);
611 smc91c111_writew(opaque
, offset
+ 2, value
>> 16);
614 static uint32_t smc91c111_readw(void *opaque
, target_phys_addr_t offset
)
617 val
= smc91c111_readb(opaque
, offset
);
618 val
|= smc91c111_readb(opaque
, offset
+ 1) << 8;
622 static uint32_t smc91c111_readl(void *opaque
, target_phys_addr_t offset
)
625 val
= smc91c111_readw(opaque
, offset
);
626 val
|= smc91c111_readw(opaque
, offset
+ 2) << 16;
630 static int smc91c111_can_receive(VLANClientState
*nc
)
632 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
634 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
636 if (s
->allocated
== (1 << NUM_PACKETS
) - 1)
641 static ssize_t
smc91c111_receive(VLANClientState
*nc
, const uint8_t *buf
, size_t size
)
643 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
650 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
652 /* Short packets are padded with zeros. Receiving a packet
653 < 64 bytes long is considered an error condition. */
657 packetsize
= (size
& ~1);
659 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
662 /* TODO: Flag overrun and receive errors. */
663 if (packetsize
> 2048)
665 packetnum
= smc91c111_allocate_packet(s
);
666 if (packetnum
== 0x80)
668 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
670 p
= &s
->data
[packetnum
][0];
671 /* ??? Multicast packets? */
674 status
|= RS_TOOLONG
;
676 status
|= RS_ODDFRAME
;
677 *(p
++) = status
& 0xff;
678 *(p
++) = status
>> 8;
679 *(p
++) = packetsize
& 0xff;
680 *(p
++) = packetsize
>> 8;
681 memcpy(p
, buf
, size
& ~1);
683 /* Pad short packets. */
688 *(p
++) = buf
[size
- 1];
694 /* It's not clear if the CRC should go before or after the last byte in
695 odd sized packets. Linux disables the CRC, so that's no help.
696 The pictures in the documentation show the CRC aligned on a 16-bit
697 boundary before the last odd byte, so that's what we do. */
699 crc
= crc32(~0, buf
, size
);
700 *(p
++) = crc
& 0xff; crc
>>= 8;
701 *(p
++) = crc
& 0xff; crc
>>= 8;
702 *(p
++) = crc
& 0xff; crc
>>= 8;
706 *(p
++) = buf
[size
- 1];
712 /* TODO: Raise early RX interrupt? */
713 s
->int_level
|= INT_RCV
;
719 static CPUReadMemoryFunc
* const smc91c111_readfn
[] = {
725 static CPUWriteMemoryFunc
* const smc91c111_writefn
[] = {
731 static void smc91c111_cleanup(VLANClientState
*nc
)
733 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
738 static NetClientInfo net_smc91c111_info
= {
739 .type
= NET_CLIENT_TYPE_NIC
,
740 .size
= sizeof(NICState
),
741 .can_receive
= smc91c111_can_receive
,
742 .receive
= smc91c111_receive
,
743 .cleanup
= smc91c111_cleanup
,
746 static int smc91c111_init1(SysBusDevice
*dev
)
748 smc91c111_state
*s
= FROM_SYSBUS(smc91c111_state
, dev
);
750 s
->mmio_index
= cpu_register_io_memory(smc91c111_readfn
,
751 smc91c111_writefn
, s
,
752 DEVICE_NATIVE_ENDIAN
);
753 sysbus_init_mmio(dev
, 16, s
->mmio_index
);
754 sysbus_init_irq(dev
, &s
->irq
);
755 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
759 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
760 dev
->qdev
.info
->name
, dev
->qdev
.id
, s
);
761 qemu_format_nic_info_str(&s
->nic
->nc
, s
->conf
.macaddr
.a
);
762 /* ??? Save/restore. */
766 static SysBusDeviceInfo smc91c111_info
= {
767 .init
= smc91c111_init1
,
768 .qdev
.name
= "smc91c111",
769 .qdev
.size
= sizeof(smc91c111_state
),
770 .qdev
.vmsd
= &vmstate_smc91c111
,
771 .qdev
.props
= (Property
[]) {
772 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
773 DEFINE_PROP_END_OF_LIST(),
777 static void smc91c111_register_devices(void)
779 sysbus_register_withprop(&smc91c111_info
);
782 /* Legacy helper function. Should go away when machine config files are
784 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
789 qemu_check_nic_model(nd
, "smc91c111");
790 dev
= qdev_create(NULL
, "smc91c111");
791 qdev_set_nic_properties(dev
, nd
);
792 qdev_init_nofail(dev
);
793 s
= sysbus_from_qdev(dev
);
794 sysbus_mmio_map(s
, 0, base
);
795 sysbus_connect_irq(s
, 0, irq
);
798 device_init(smc91c111_register_devices
)