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 #define RCR_SOFT_RST 0x8000
50 #define RCR_STRIP_CRC 0x0200
51 #define RCR_RXEN 0x0100
53 #define TCR_EPH_LOOP 0x2000
54 #define TCR_NOCRC 0x0100
55 #define TCR_PAD_EN 0x0080
56 #define TCR_FORCOL 0x0004
57 #define TCR_LOOP 0x0002
58 #define TCR_TXEN 0x0001
63 #define INT_RX_OVRN 0x10
64 #define INT_ALLOC 0x08
65 #define INT_TX_EMPTY 0x04
69 #define CTR_AUTO_RELEASE 0x0800
70 #define CTR_RELOAD 0x0002
71 #define CTR_STORE 0x0001
73 #define RS_ALGNERR 0x8000
74 #define RS_BRODCAST 0x4000
75 #define RS_BADCRC 0x2000
76 #define RS_ODDFRAME 0x1000
77 #define RS_TOOLONG 0x0800
78 #define RS_TOOSHORT 0x0400
79 #define RS_MULTICAST 0x0001
81 /* Update interrupt status. */
82 static void smc91c111_update(smc91c111_state
*s
)
86 if (s
->tx_fifo_len
== 0)
87 s
->int_level
|= INT_TX_EMPTY
;
88 if (s
->tx_fifo_done_len
!= 0)
89 s
->int_level
|= INT_TX
;
90 level
= (s
->int_level
& s
->int_mask
) != 0;
91 qemu_set_irq(s
->irq
, level
);
94 /* Try to allocate a packet. Returns 0x80 on failure. */
95 static int smc91c111_allocate_packet(smc91c111_state
*s
)
98 if (s
->allocated
== (1 << NUM_PACKETS
) - 1) {
102 for (i
= 0; i
< NUM_PACKETS
; i
++) {
103 if ((s
->allocated
& (1 << i
)) == 0)
106 s
->allocated
|= 1 << i
;
111 /* Process a pending TX allocate. */
112 static void smc91c111_tx_alloc(smc91c111_state
*s
)
114 s
->tx_alloc
= smc91c111_allocate_packet(s
);
115 if (s
->tx_alloc
== 0x80)
117 s
->int_level
|= INT_ALLOC
;
121 /* Remove and item from the RX FIFO. */
122 static void smc91c111_pop_rx_fifo(smc91c111_state
*s
)
127 if (s
->rx_fifo_len
) {
128 for (i
= 0; i
< s
->rx_fifo_len
; i
++)
129 s
->rx_fifo
[i
] = s
->rx_fifo
[i
+ 1];
130 s
->int_level
|= INT_RCV
;
132 s
->int_level
&= ~INT_RCV
;
137 /* Remove an item from the TX completion FIFO. */
138 static void smc91c111_pop_tx_fifo_done(smc91c111_state
*s
)
142 if (s
->tx_fifo_done_len
== 0)
144 s
->tx_fifo_done_len
--;
145 for (i
= 0; i
< s
->tx_fifo_done_len
; i
++)
146 s
->tx_fifo_done
[i
] = s
->tx_fifo_done
[i
+ 1];
149 /* Release the memory allocated to a packet. */
150 static void smc91c111_release_packet(smc91c111_state
*s
, int packet
)
152 s
->allocated
&= ~(1 << packet
);
153 if (s
->tx_alloc
== 0x80)
154 smc91c111_tx_alloc(s
);
157 /* Flush the TX FIFO. */
158 static void smc91c111_do_tx(smc91c111_state
*s
)
167 if ((s
->tcr
& TCR_TXEN
) == 0)
169 if (s
->tx_fifo_len
== 0)
171 for (i
= 0; i
< s
->tx_fifo_len
; i
++) {
172 packetnum
= s
->tx_fifo
[i
];
173 p
= &s
->data
[packetnum
][0];
174 /* Set status word. */
178 len
|= ((int)*(p
++)) << 8;
180 control
= p
[len
+ 1];
183 /* ??? This overwrites the data following the buffer.
184 Don't know what real hardware does. */
185 if (len
< 64 && (s
->tcr
& TCR_PAD_EN
)) {
186 memset(p
+ len
, 0, 64 - len
);
190 /* The card is supposed to append the CRC to the frame. However
191 none of the other network traffic has the CRC appended.
192 Suspect this is low level ethernet detail we don't need to worry
194 add_crc
= (control
& 0x10) || (s
->tcr
& TCR_NOCRC
) == 0;
198 crc
= crc32(~0, p
, len
);
199 memcpy(p
+ len
, &crc
, 4);
205 if (s
->ctr
& CTR_AUTO_RELEASE
)
207 smc91c111_release_packet(s
, packetnum
);
208 else if (s
->tx_fifo_done_len
< NUM_PACKETS
)
209 s
->tx_fifo_done
[s
->tx_fifo_done_len
++] = packetnum
;
210 qemu_send_packet(&s
->nic
->nc
, p
, len
);
216 /* Add a packet to the TX FIFO. */
217 static void smc91c111_queue_tx(smc91c111_state
*s
, int packet
)
219 if (s
->tx_fifo_len
== NUM_PACKETS
)
221 s
->tx_fifo
[s
->tx_fifo_len
++] = packet
;
225 static void smc91c111_reset(smc91c111_state
*s
)
229 s
->tx_fifo_done_len
= 0;
240 s
->int_level
= INT_TX_EMPTY
;
245 #define SET_LOW(name, val) s->name = (s->name & 0xff00) | val
246 #define SET_HIGH(name, val) s->name = (s->name & 0xff) | (val << 8)
248 static void smc91c111_writeb(void *opaque
, target_phys_addr_t offset
,
251 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
253 offset
= offset
& 0xf;
267 SET_HIGH(tcr
, value
);
273 SET_HIGH(rcr
, value
);
274 if (s
->rcr
& RCR_SOFT_RST
)
277 case 10: case 11: /* RPCR */
280 case 12: case 13: /* Reserved */
293 case 2: case 3: /* BASE */
294 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
295 /* Not implemented. */
297 case 10: /* Genral Purpose */
301 SET_HIGH(gpr
, value
);
303 case 12: /* Control */
305 fprintf(stderr
, "smc91c111:EEPROM store not implemented\n");
307 fprintf(stderr
, "smc91c111:EEPROM reload not implemented\n");
312 SET_HIGH(ctr
, value
);
319 case 0: /* MMU Command */
320 switch (value
>> 5) {
323 case 1: /* Allocate for TX. */
325 s
->int_level
&= ~INT_ALLOC
;
327 smc91c111_tx_alloc(s
);
329 case 2: /* Reset MMU. */
332 s
->tx_fifo_done_len
= 0;
336 case 3: /* Remove from RX FIFO. */
337 smc91c111_pop_rx_fifo(s
);
339 case 4: /* Remove from RX FIFO and release. */
340 if (s
->rx_fifo_len
> 0) {
341 smc91c111_release_packet(s
, s
->rx_fifo
[0]);
343 smc91c111_pop_rx_fifo(s
);
345 case 5: /* Release. */
346 smc91c111_release_packet(s
, s
->packet_num
);
348 case 6: /* Add to TX FIFO. */
349 smc91c111_queue_tx(s
, s
->packet_num
);
351 case 7: /* Reset TX FIFO. */
353 s
->tx_fifo_done_len
= 0;
360 case 2: /* Packet Number Register */
361 s
->packet_num
= value
;
363 case 3: case 4: case 5:
364 /* Should be readonly, but linux writes to them anyway. Ignore. */
366 case 6: /* Pointer */
370 SET_HIGH(ptr
, value
);
372 case 8: case 9: case 10: case 11: /* Data */
382 if (s
->ptr
& 0x4000) {
383 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x7ff);
387 s
->data
[n
][p
] = value
;
390 case 12: /* Interrupt ACK. */
391 s
->int_level
&= ~(value
& 0xd6);
393 smc91c111_pop_tx_fifo_done(s
);
396 case 13: /* Interrupt mask. */
405 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
406 /* Multicast table. */
407 /* Not implemented. */
409 case 8: case 9: /* Management Interface. */
410 /* Not implemented. */
412 case 12: /* Early receive. */
413 s
->ercv
= value
& 0x1f;
420 hw_error("smc91c111_write: Bad reg %d:%x\n", s
->bank
, (int)offset
);
423 static uint32_t smc91c111_readb(void *opaque
, target_phys_addr_t offset
)
425 smc91c111_state
*s
= (smc91c111_state
*)opaque
;
427 offset
= offset
& 0xf;
437 return s
->tcr
& 0xff;
440 case 2: /* EPH Status */
445 return s
->rcr
& 0xff;
448 case 6: /* Counter */
450 /* Not implemented. */
452 case 8: /* Memory size. */
454 case 9: /* Free memory available. */
459 for (i
= 0; i
< NUM_PACKETS
; i
++) {
460 if (s
->allocated
& (1 << i
))
465 case 10: case 11: /* RPCR */
466 /* Not implemented. */
468 case 12: case 13: /* Reserved */
479 case 2: case 3: /* BASE */
480 /* Not implemented. */
482 case 4: case 5: case 6: case 7: case 8: case 9: /* IA */
483 return s
->conf
.macaddr
.a
[offset
- 4];
484 case 10: /* General Purpose */
485 return s
->gpr
& 0xff;
488 case 12: /* Control */
489 return s
->ctr
& 0xff;
497 case 0: case 1: /* MMUCR Busy bit. */
499 case 2: /* Packet Number. */
500 return s
->packet_num
;
501 case 3: /* Allocation Result. */
503 case 4: /* TX FIFO */
504 if (s
->tx_fifo_done_len
== 0)
507 return s
->tx_fifo_done
[0];
508 case 5: /* RX FIFO */
509 if (s
->rx_fifo_len
== 0)
512 return s
->rx_fifo
[0];
513 case 6: /* Pointer */
514 return s
->ptr
& 0xff;
516 return (s
->ptr
>> 8) & 0xf7;
517 case 8: case 9: case 10: case 11: /* Data */
527 if (s
->ptr
& 0x4000) {
528 s
->ptr
= (s
->ptr
& 0xf800) | ((s
->ptr
+ 1) & 0x07ff);
532 return s
->data
[n
][p
];
534 case 12: /* Interrupt status. */
536 case 13: /* Interrupt mask. */
543 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7:
544 /* Multicast table. */
545 /* Not implemented. */
547 case 8: /* Management Interface. */
548 /* Not implemented. */
552 case 10: /* Revision. */
563 hw_error("smc91c111_read: Bad reg %d:%x\n", s
->bank
, (int)offset
);
567 static void smc91c111_writew(void *opaque
, target_phys_addr_t offset
,
570 smc91c111_writeb(opaque
, offset
, value
& 0xff);
571 smc91c111_writeb(opaque
, offset
+ 1, value
>> 8);
574 static void smc91c111_writel(void *opaque
, target_phys_addr_t offset
,
577 /* 32-bit writes to offset 0xc only actually write to the bank select
578 register (offset 0xe) */
580 smc91c111_writew(opaque
, offset
, value
& 0xffff);
581 smc91c111_writew(opaque
, offset
+ 2, value
>> 16);
584 static uint32_t smc91c111_readw(void *opaque
, target_phys_addr_t offset
)
587 val
= smc91c111_readb(opaque
, offset
);
588 val
|= smc91c111_readb(opaque
, offset
+ 1) << 8;
592 static uint32_t smc91c111_readl(void *opaque
, target_phys_addr_t offset
)
595 val
= smc91c111_readw(opaque
, offset
);
596 val
|= smc91c111_readw(opaque
, offset
+ 2) << 16;
600 static int smc91c111_can_receive(VLANClientState
*nc
)
602 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
604 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
606 if (s
->allocated
== (1 << NUM_PACKETS
) - 1)
611 static ssize_t
smc91c111_receive(VLANClientState
*nc
, const uint8_t *buf
, size_t size
)
613 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
620 if ((s
->rcr
& RCR_RXEN
) == 0 || (s
->rcr
& RCR_SOFT_RST
))
622 /* Short packets are padded with zeros. Receiving a packet
623 < 64 bytes long is considered an error condition. */
627 packetsize
= (size
& ~1);
629 crc
= (s
->rcr
& RCR_STRIP_CRC
) == 0;
632 /* TODO: Flag overrun and receive errors. */
633 if (packetsize
> 2048)
635 packetnum
= smc91c111_allocate_packet(s
);
636 if (packetnum
== 0x80)
638 s
->rx_fifo
[s
->rx_fifo_len
++] = packetnum
;
640 p
= &s
->data
[packetnum
][0];
641 /* ??? Multicast packets? */
644 status
|= RS_TOOLONG
;
646 status
|= RS_ODDFRAME
;
647 *(p
++) = status
& 0xff;
648 *(p
++) = status
>> 8;
649 *(p
++) = packetsize
& 0xff;
650 *(p
++) = packetsize
>> 8;
651 memcpy(p
, buf
, size
& ~1);
653 /* Pad short packets. */
658 *(p
++) = buf
[size
- 1];
664 /* It's not clear if the CRC should go before or after the last byte in
665 odd sized packets. Linux disables the CRC, so that's no help.
666 The pictures in the documentation show the CRC aligned on a 16-bit
667 boundary before the last odd byte, so that's what we do. */
669 crc
= crc32(~0, buf
, size
);
670 *(p
++) = crc
& 0xff; crc
>>= 8;
671 *(p
++) = crc
& 0xff; crc
>>= 8;
672 *(p
++) = crc
& 0xff; crc
>>= 8;
673 *(p
++) = crc
& 0xff; crc
>>= 8;
676 *(p
++) = buf
[size
- 1];
682 /* TODO: Raise early RX interrupt? */
683 s
->int_level
|= INT_RCV
;
689 static CPUReadMemoryFunc
* const smc91c111_readfn
[] = {
695 static CPUWriteMemoryFunc
* const smc91c111_writefn
[] = {
701 static void smc91c111_cleanup(VLANClientState
*nc
)
703 smc91c111_state
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
708 static NetClientInfo net_smc91c111_info
= {
709 .type
= NET_CLIENT_TYPE_NIC
,
710 .size
= sizeof(NICState
),
711 .can_receive
= smc91c111_can_receive
,
712 .receive
= smc91c111_receive
,
713 .cleanup
= smc91c111_cleanup
,
716 static int smc91c111_init1(SysBusDevice
*dev
)
718 smc91c111_state
*s
= FROM_SYSBUS(smc91c111_state
, dev
);
720 s
->mmio_index
= cpu_register_io_memory(smc91c111_readfn
,
721 smc91c111_writefn
, s
);
722 sysbus_init_mmio(dev
, 16, s
->mmio_index
);
723 sysbus_init_irq(dev
, &s
->irq
);
724 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
728 s
->nic
= qemu_new_nic(&net_smc91c111_info
, &s
->conf
,
729 dev
->qdev
.info
->name
, dev
->qdev
.id
, s
);
730 qemu_format_nic_info_str(&s
->nic
->nc
, s
->conf
.macaddr
.a
);
731 /* ??? Save/restore. */
735 static SysBusDeviceInfo smc91c111_info
= {
736 .init
= smc91c111_init1
,
737 .qdev
.name
= "smc91c111",
738 .qdev
.size
= sizeof(smc91c111_state
),
739 .qdev
.props
= (Property
[]) {
740 DEFINE_NIC_PROPERTIES(smc91c111_state
, conf
),
741 DEFINE_PROP_END_OF_LIST(),
745 static void smc91c111_register_devices(void)
747 sysbus_register_withprop(&smc91c111_info
);
750 /* Legacy helper function. Should go away when machine config files are
752 void smc91c111_init(NICInfo
*nd
, uint32_t base
, qemu_irq irq
)
757 qemu_check_nic_model(nd
, "smc91c111");
758 dev
= qdev_create(NULL
, "smc91c111");
759 qdev_set_nic_properties(dev
, nd
);
760 qdev_init_nofail(dev
);
761 s
= sysbus_from_qdev(dev
);
762 sysbus_mmio_map(s
, 0, base
);
763 sysbus_connect_irq(s
, 0, irq
);
766 device_init(smc91c111_register_devices
)