2 * QEMU NE2000 emulation
4 * Copyright (c) 2003-2004 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 /* debug NE2000 card */
27 //#define DEBUG_NE2000
29 #define MAX_ETH_FRAME_SIZE 1514
31 #define E8390_CMD 0x00 /* The command register (for all pages) */
32 /* Page 0 register offsets. */
33 #define EN0_CLDALO 0x01 /* Low byte of current local dma addr RD */
34 #define EN0_STARTPG 0x01 /* Starting page of ring bfr WR */
35 #define EN0_CLDAHI 0x02 /* High byte of current local dma addr RD */
36 #define EN0_STOPPG 0x02 /* Ending page +1 of ring bfr WR */
37 #define EN0_BOUNDARY 0x03 /* Boundary page of ring bfr RD WR */
38 #define EN0_TSR 0x04 /* Transmit status reg RD */
39 #define EN0_TPSR 0x04 /* Transmit starting page WR */
40 #define EN0_NCR 0x05 /* Number of collision reg RD */
41 #define EN0_TCNTLO 0x05 /* Low byte of tx byte count WR */
42 #define EN0_FIFO 0x06 /* FIFO RD */
43 #define EN0_TCNTHI 0x06 /* High byte of tx byte count WR */
44 #define EN0_ISR 0x07 /* Interrupt status reg RD WR */
45 #define EN0_CRDALO 0x08 /* low byte of current remote dma address RD */
46 #define EN0_RSARLO 0x08 /* Remote start address reg 0 */
47 #define EN0_CRDAHI 0x09 /* high byte, current remote dma address RD */
48 #define EN0_RSARHI 0x09 /* Remote start address reg 1 */
49 #define EN0_RCNTLO 0x0a /* Remote byte count reg WR */
50 #define EN0_RTL8029ID0 0x0a /* Realtek ID byte #1 RD */
51 #define EN0_RCNTHI 0x0b /* Remote byte count reg WR */
52 #define EN0_RTL8029ID1 0x0b /* Realtek ID byte #2 RD */
53 #define EN0_RSR 0x0c /* rx status reg RD */
54 #define EN0_RXCR 0x0c /* RX configuration reg WR */
55 #define EN0_TXCR 0x0d /* TX configuration reg WR */
56 #define EN0_COUNTER0 0x0d /* Rcv alignment error counter RD */
57 #define EN0_DCFG 0x0e /* Data configuration reg WR */
58 #define EN0_COUNTER1 0x0e /* Rcv CRC error counter RD */
59 #define EN0_IMR 0x0f /* Interrupt mask reg WR */
60 #define EN0_COUNTER2 0x0f /* Rcv missed frame error counter RD */
63 #define EN1_CURPAG 0x17
66 #define EN2_STARTPG 0x21 /* Starting page of ring bfr RD */
67 #define EN2_STOPPG 0x22 /* Ending page +1 of ring bfr RD */
69 #define EN3_CONFIG0 0x33
70 #define EN3_CONFIG1 0x34
71 #define EN3_CONFIG2 0x35
72 #define EN3_CONFIG3 0x36
74 /* Register accessed at EN_CMD, the 8390 base addr. */
75 #define E8390_STOP 0x01 /* Stop and reset the chip */
76 #define E8390_START 0x02 /* Start the chip, clear reset */
77 #define E8390_TRANS 0x04 /* Transmit a frame */
78 #define E8390_RREAD 0x08 /* Remote read */
79 #define E8390_RWRITE 0x10 /* Remote write */
80 #define E8390_NODMA 0x20 /* Remote DMA */
81 #define E8390_PAGE0 0x00 /* Select page chip registers */
82 #define E8390_PAGE1 0x40 /* using the two high-order bits */
83 #define E8390_PAGE2 0x80 /* Page 3 is invalid. */
85 /* Bits in EN0_ISR - Interrupt status register */
86 #define ENISR_RX 0x01 /* Receiver, no error */
87 #define ENISR_TX 0x02 /* Transmitter, no error */
88 #define ENISR_RX_ERR 0x04 /* Receiver, with error */
89 #define ENISR_TX_ERR 0x08 /* Transmitter, with error */
90 #define ENISR_OVER 0x10 /* Receiver overwrote the ring */
91 #define ENISR_COUNTERS 0x20 /* Counters need emptying */
92 #define ENISR_RDC 0x40 /* remote dma complete */
93 #define ENISR_RESET 0x80 /* Reset completed */
94 #define ENISR_ALL 0x3f /* Interrupts we will enable */
96 /* Bits in received packet status byte and EN0_RSR*/
97 #define ENRSR_RXOK 0x01 /* Received a good packet */
98 #define ENRSR_CRC 0x02 /* CRC error */
99 #define ENRSR_FAE 0x04 /* frame alignment error */
100 #define ENRSR_FO 0x08 /* FIFO overrun */
101 #define ENRSR_MPA 0x10 /* missed pkt */
102 #define ENRSR_PHY 0x20 /* physical/multicast address */
103 #define ENRSR_DIS 0x40 /* receiver disable. set in monitor mode */
104 #define ENRSR_DEF 0x80 /* deferring */
106 /* Transmitted packet status, EN0_TSR. */
107 #define ENTSR_PTX 0x01 /* Packet transmitted without error */
108 #define ENTSR_ND 0x02 /* The transmit wasn't deferred. */
109 #define ENTSR_COL 0x04 /* The transmit collided at least once. */
110 #define ENTSR_ABT 0x08 /* The transmit collided 16 times, and was deferred. */
111 #define ENTSR_CRS 0x10 /* The carrier sense was lost. */
112 #define ENTSR_FU 0x20 /* A "FIFO underrun" occurred during transmit. */
113 #define ENTSR_CDH 0x40 /* The collision detect "heartbeat" signal was lost. */
114 #define ENTSR_OWC 0x80 /* There was an out-of-window collision. */
116 #define NE2000_PMEM_SIZE (32*1024)
117 #define NE2000_PMEM_START (16*1024)
118 #define NE2000_PMEM_END (NE2000_PMEM_SIZE+NE2000_PMEM_START)
119 #define NE2000_MEM_SIZE NE2000_PMEM_END
121 typedef struct NE2000State {
136 uint8_t phys[6]; /* mac address */
138 uint8_t mult[8]; /* multicast mask array */
143 uint8_t mem[NE2000_MEM_SIZE];
146 static void ne2000_reset(NE2000State *s)
150 s->isr = ENISR_RESET;
151 memcpy(s->mem, s->macaddr, 6);
155 /* duplicate prom data */
156 for(i = 15;i >= 0; i--) {
157 s->mem[2 * i] = s->mem[i];
158 s->mem[2 * i + 1] = s->mem[i];
162 static void ne2000_update_irq(NE2000State *s)
165 isr = (s->isr & s->imr) & 0x7f;
166 #if defined(DEBUG_NE2000)
167 printf("NE2000: Set IRQ to %d (%02x %02x)\n",
168 isr ? 1 : 0, s->isr, s->imr);
170 qemu_set_irq(s->irq, (isr != 0));
173 #define POLYNOMIAL 0x04c11db6
177 static int compute_mcast_idx(const uint8_t *ep)
184 for (i = 0; i < 6; i++) {
186 for (j = 0; j < 8; j++) {
187 carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
191 crc = ((crc ^ POLYNOMIAL) | carry);
197 static int ne2000_buffer_full(NE2000State *s)
199 int avail, index, boundary;
201 index = s->curpag << 8;
202 boundary = s->boundary << 8;
203 if (index < boundary)
204 avail = boundary - index;
206 avail = (s->stop - s->start) - (index - boundary);
207 if (avail < (MAX_ETH_FRAME_SIZE + 4))
212 static int ne2000_can_receive(void *opaque)
214 NE2000State *s = opaque;
216 if (s->cmd & E8390_STOP)
218 return !ne2000_buffer_full(s);
221 #define MIN_BUF_SIZE 60
223 static void ne2000_receive(void *opaque, const uint8_t *buf, int size)
225 NE2000State *s = opaque;
227 int total_len, next, avail, len, index, mcast_idx;
229 static const uint8_t broadcast_macaddr[6] =
230 { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
232 #if defined(DEBUG_NE2000)
233 printf("NE2000: received len=%d\n", size);
236 if (s->cmd & E8390_STOP || ne2000_buffer_full(s))
239 /* XXX: check this */
240 if (s->rxcr & 0x10) {
241 /* promiscuous: receive all */
243 if (!memcmp(buf, broadcast_macaddr, 6)) {
244 /* broadcast address */
245 if (!(s->rxcr & 0x04))
247 } else if (buf[0] & 0x01) {
249 if (!(s->rxcr & 0x08))
251 mcast_idx = compute_mcast_idx(buf);
252 if (!(s->mult[mcast_idx >> 3] & (1 << (mcast_idx & 7))))
254 } else if (s->mem[0] == buf[0] &&
255 s->mem[2] == buf[1] &&
256 s->mem[4] == buf[2] &&
257 s->mem[6] == buf[3] &&
258 s->mem[8] == buf[4] &&
259 s->mem[10] == buf[5]) {
267 /* if too small buffer, then expand it */
268 if (size < MIN_BUF_SIZE) {
269 memcpy(buf1, buf, size);
270 memset(buf1 + size, 0, MIN_BUF_SIZE - size);
275 index = s->curpag << 8;
276 /* 4 bytes for header */
277 total_len = size + 4;
278 /* address for next packet (4 bytes for CRC) */
279 next = index + ((total_len + 4 + 255) & ~0xff);
281 next -= (s->stop - s->start);
282 /* prepare packet header */
284 s->rsr = ENRSR_RXOK; /* receive status */
285 /* XXX: check this */
291 p[3] = total_len >> 8;
294 /* write packet data */
296 avail = s->stop - index;
300 memcpy(s->mem + index, buf, len);
303 if (index == s->stop)
307 s->curpag = next >> 8;
309 /* now we can signal we have received something */
311 ne2000_update_irq(s);
314 static void ne2000_ioport_write(void *opaque, uint32_t addr, uint32_t val)
316 NE2000State *s = opaque;
317 int offset, page, index;
321 printf("NE2000: write addr=0x%x val=0x%02x\n", addr, val);
323 if (addr == E8390_CMD) {
324 /* control register */
326 if (!(val & E8390_STOP)) { /* START bit makes no sense on RTL8029... */
327 s->isr &= ~ENISR_RESET;
328 /* test specific case: zero length transfert */
329 if ((val & (E8390_RREAD | E8390_RWRITE)) &&
332 ne2000_update_irq(s);
334 if (val & E8390_TRANS) {
335 index = (s->tpsr << 8);
336 /* XXX: next 2 lines are a hack to make netware 3.11 work */
337 if (index >= NE2000_PMEM_END)
338 index -= NE2000_PMEM_SIZE;
339 /* fail safe: check range on the transmitted length */
340 if (index + s->tcnt <= NE2000_PMEM_END) {
341 qemu_send_packet(s->vc, s->mem + index, s->tcnt);
343 /* signal end of transfert */
346 s->cmd &= ~E8390_TRANS;
347 ne2000_update_irq(s);
352 offset = addr | (page << 4);
365 ne2000_update_irq(s);
371 s->tcnt = (s->tcnt & 0xff00) | val;
374 s->tcnt = (s->tcnt & 0x00ff) | (val << 8);
377 s->rsar = (s->rsar & 0xff00) | val;
380 s->rsar = (s->rsar & 0x00ff) | (val << 8);
383 s->rcnt = (s->rcnt & 0xff00) | val;
386 s->rcnt = (s->rcnt & 0x00ff) | (val << 8);
395 s->isr &= ~(val & 0x7f);
396 ne2000_update_irq(s);
398 case EN1_PHYS ... EN1_PHYS + 5:
399 s->phys[offset - EN1_PHYS] = val;
404 case EN1_MULT ... EN1_MULT + 7:
405 s->mult[offset - EN1_MULT] = val;
411 static uint32_t ne2000_ioport_read(void *opaque, uint32_t addr)
413 NE2000State *s = opaque;
414 int offset, page, ret;
417 if (addr == E8390_CMD) {
421 offset = addr | (page << 4);
433 ret = s->rsar & 0x00ff;
438 case EN1_PHYS ... EN1_PHYS + 5:
439 ret = s->phys[offset - EN1_PHYS];
444 case EN1_MULT ... EN1_MULT + 7:
445 ret = s->mult[offset - EN1_MULT];
463 ret = 0; /* 10baseT media */
466 ret = 0x40; /* 10baseT active */
469 ret = 0x40; /* Full duplex */
477 printf("NE2000: read addr=0x%x val=%02x\n", addr, ret);
482 static inline void ne2000_mem_writeb(NE2000State *s, uint32_t addr,
486 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
491 static inline void ne2000_mem_writew(NE2000State *s, uint32_t addr,
494 addr &= ~1; /* XXX: check exact behaviour if not even */
496 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
497 *(uint16_t *)(s->mem + addr) = cpu_to_le16(val);
501 static inline void ne2000_mem_writel(NE2000State *s, uint32_t addr,
504 addr &= ~1; /* XXX: check exact behaviour if not even */
506 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
507 cpu_to_le32wu((uint32_t *)(s->mem + addr), val);
511 static inline uint32_t ne2000_mem_readb(NE2000State *s, uint32_t addr)
514 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
521 static inline uint32_t ne2000_mem_readw(NE2000State *s, uint32_t addr)
523 addr &= ~1; /* XXX: check exact behaviour if not even */
525 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
526 return le16_to_cpu(*(uint16_t *)(s->mem + addr));
532 static inline uint32_t ne2000_mem_readl(NE2000State *s, uint32_t addr)
534 addr &= ~1; /* XXX: check exact behaviour if not even */
536 (addr >= NE2000_PMEM_START && addr < NE2000_MEM_SIZE)) {
537 return le32_to_cpupu((uint32_t *)(s->mem + addr));
543 static inline void ne2000_dma_update(NE2000State *s, int len)
547 /* XXX: check what to do if rsar > stop */
548 if (s->rsar == s->stop)
551 if (s->rcnt <= len) {
553 /* signal end of transfert */
555 ne2000_update_irq(s);
561 static void ne2000_asic_ioport_write(void *opaque, uint32_t addr, uint32_t val)
563 NE2000State *s = opaque;
566 printf("NE2000: asic write val=0x%04x\n", val);
570 if (s->dcfg & 0x01) {
572 ne2000_mem_writew(s, s->rsar, val);
573 ne2000_dma_update(s, 2);
576 ne2000_mem_writeb(s, s->rsar, val);
577 ne2000_dma_update(s, 1);
581 static uint32_t ne2000_asic_ioport_read(void *opaque, uint32_t addr)
583 NE2000State *s = opaque;
586 if (s->dcfg & 0x01) {
588 ret = ne2000_mem_readw(s, s->rsar);
589 ne2000_dma_update(s, 2);
592 ret = ne2000_mem_readb(s, s->rsar);
593 ne2000_dma_update(s, 1);
596 printf("NE2000: asic read val=0x%04x\n", ret);
601 static void ne2000_asic_ioport_writel(void *opaque, uint32_t addr, uint32_t val)
603 NE2000State *s = opaque;
606 printf("NE2000: asic writel val=0x%04x\n", val);
611 ne2000_mem_writel(s, s->rsar, val);
612 ne2000_dma_update(s, 4);
615 static uint32_t ne2000_asic_ioport_readl(void *opaque, uint32_t addr)
617 NE2000State *s = opaque;
621 ret = ne2000_mem_readl(s, s->rsar);
622 ne2000_dma_update(s, 4);
624 printf("NE2000: asic readl val=0x%04x\n", ret);
629 static void ne2000_reset_ioport_write(void *opaque, uint32_t addr, uint32_t val)
631 /* nothing to do (end of reset pulse) */
634 static uint32_t ne2000_reset_ioport_read(void *opaque, uint32_t addr)
636 NE2000State *s = opaque;
641 static void ne2000_save(QEMUFile* f,void* opaque)
643 NE2000State* s=(NE2000State*)opaque;
647 pci_device_save(s->pci_dev, f);
649 qemu_put_8s(f, &s->rxcr);
651 qemu_put_8s(f, &s->cmd);
652 qemu_put_be32s(f, &s->start);
653 qemu_put_be32s(f, &s->stop);
654 qemu_put_8s(f, &s->boundary);
655 qemu_put_8s(f, &s->tsr);
656 qemu_put_8s(f, &s->tpsr);
657 qemu_put_be16s(f, &s->tcnt);
658 qemu_put_be16s(f, &s->rcnt);
659 qemu_put_be32s(f, &s->rsar);
660 qemu_put_8s(f, &s->rsr);
661 qemu_put_8s(f, &s->isr);
662 qemu_put_8s(f, &s->dcfg);
663 qemu_put_8s(f, &s->imr);
664 qemu_put_buffer(f, s->phys, 6);
665 qemu_put_8s(f, &s->curpag);
666 qemu_put_buffer(f, s->mult, 8);
668 qemu_put_be32s(f, &tmp); /* ignored, was irq */
669 qemu_put_buffer(f, s->mem, NE2000_MEM_SIZE);
672 static int ne2000_load(QEMUFile* f,void* opaque,int version_id)
674 NE2000State* s=(NE2000State*)opaque;
681 if (s->pci_dev && version_id >= 3) {
682 ret = pci_device_load(s->pci_dev, f);
687 if (version_id >= 2) {
688 qemu_get_8s(f, &s->rxcr);
693 qemu_get_8s(f, &s->cmd);
694 qemu_get_be32s(f, &s->start);
695 qemu_get_be32s(f, &s->stop);
696 qemu_get_8s(f, &s->boundary);
697 qemu_get_8s(f, &s->tsr);
698 qemu_get_8s(f, &s->tpsr);
699 qemu_get_be16s(f, &s->tcnt);
700 qemu_get_be16s(f, &s->rcnt);
701 qemu_get_be32s(f, &s->rsar);
702 qemu_get_8s(f, &s->rsr);
703 qemu_get_8s(f, &s->isr);
704 qemu_get_8s(f, &s->dcfg);
705 qemu_get_8s(f, &s->imr);
706 qemu_get_buffer(f, s->phys, 6);
707 qemu_get_8s(f, &s->curpag);
708 qemu_get_buffer(f, s->mult, 8);
709 qemu_get_be32s(f, &tmp); /* ignored */
710 qemu_get_buffer(f, s->mem, NE2000_MEM_SIZE);
715 void isa_ne2000_init(int base, qemu_irq irq, NICInfo *nd)
719 s = qemu_mallocz(sizeof(NE2000State));
723 register_ioport_write(base, 16, 1, ne2000_ioport_write, s);
724 register_ioport_read(base, 16, 1, ne2000_ioport_read, s);
726 register_ioport_write(base + 0x10, 1, 1, ne2000_asic_ioport_write, s);
727 register_ioport_read(base + 0x10, 1, 1, ne2000_asic_ioport_read, s);
728 register_ioport_write(base + 0x10, 2, 2, ne2000_asic_ioport_write, s);
729 register_ioport_read(base + 0x10, 2, 2, ne2000_asic_ioport_read, s);
731 register_ioport_write(base + 0x1f, 1, 1, ne2000_reset_ioport_write, s);
732 register_ioport_read(base + 0x1f, 1, 1, ne2000_reset_ioport_read, s);
734 memcpy(s->macaddr, nd->macaddr, 6);
738 s->vc = qemu_new_vlan_client(nd->vlan, ne2000_receive,
739 ne2000_can_receive, s);
741 snprintf(s->vc->info_str, sizeof(s->vc->info_str),
742 "ne2000 macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
750 register_savevm("ne2000", 0, 2, ne2000_save, ne2000_load, s);
753 /***********************************************************/
754 /* PCI NE2000 definitions */
756 typedef struct PCINE2000State {
761 static void ne2000_map(PCIDevice *pci_dev, int region_num,
762 uint32_t addr, uint32_t size, int type)
764 PCINE2000State *d = (PCINE2000State *)pci_dev;
765 NE2000State *s = &d->ne2000;
767 register_ioport_write(addr, 16, 1, ne2000_ioport_write, s);
768 register_ioport_read(addr, 16, 1, ne2000_ioport_read, s);
770 register_ioport_write(addr + 0x10, 1, 1, ne2000_asic_ioport_write, s);
771 register_ioport_read(addr + 0x10, 1, 1, ne2000_asic_ioport_read, s);
772 register_ioport_write(addr + 0x10, 2, 2, ne2000_asic_ioport_write, s);
773 register_ioport_read(addr + 0x10, 2, 2, ne2000_asic_ioport_read, s);
774 register_ioport_write(addr + 0x10, 4, 4, ne2000_asic_ioport_writel, s);
775 register_ioport_read(addr + 0x10, 4, 4, ne2000_asic_ioport_readl, s);
777 register_ioport_write(addr + 0x1f, 1, 1, ne2000_reset_ioport_write, s);
778 register_ioport_read(addr + 0x1f, 1, 1, ne2000_reset_ioport_read, s);
781 void pci_ne2000_init(PCIBus *bus, NICInfo *nd, int devfn)
787 d = (PCINE2000State *)pci_register_device(bus,
788 "NE2000", sizeof(PCINE2000State),
791 pci_conf = d->dev.config;
792 pci_conf[0x00] = 0xec; // Realtek 8029
793 pci_conf[0x01] = 0x10;
794 pci_conf[0x02] = 0x29;
795 pci_conf[0x03] = 0x80;
796 pci_conf[0x0a] = 0x00; // ethernet network controller
797 pci_conf[0x0b] = 0x02;
798 pci_conf[0x0e] = 0x00; // header_type
799 pci_conf[0x3d] = 1; // interrupt pin 0
801 pci_register_io_region(&d->dev, 0, 0x100,
802 PCI_ADDRESS_SPACE_IO, ne2000_map);
804 s->irq = d->dev.irq[0];
805 s->pci_dev = (PCIDevice *)d;
806 memcpy(s->macaddr, nd->macaddr, 6);
808 s->vc = qemu_new_vlan_client(nd->vlan, ne2000_receive,
809 ne2000_can_receive, s);
811 snprintf(s->vc->info_str, sizeof(s->vc->info_str),
812 "ne2000 pci macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
820 /* XXX: instance number ? */
821 register_savevm("ne2000", 0, 3, ne2000_save, ne2000_load, s);