2 * i.MX Fast Ethernet Controller emulation.
6 * Based on Coldfire Fast Ethernet Controller emulation.
8 * Copyright (c) 2007 CodeSourcery.
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, see <http://www.gnu.org/licenses/>.
24 #include "hw/net/imx_fec.h"
25 #include "sysemu/dma.h"
31 #define DEBUG_IMX_FEC 0
34 #define FEC_PRINTF(fmt, args...) \
36 if (DEBUG_IMX_FEC) { \
37 fprintf(stderr, "[%s]%s: " fmt , TYPE_IMX_FEC, \
43 #define DEBUG_IMX_PHY 0
46 #define PHY_PRINTF(fmt, args...) \
48 if (DEBUG_IMX_PHY) { \
49 fprintf(stderr, "[%s.phy]%s: " fmt , TYPE_IMX_FEC, \
54 static const VMStateDescription vmstate_imx_fec = {
57 .minimum_version_id = 1,
58 .fields = (VMStateField[]) {
59 VMSTATE_UINT32(irq_state, IMXFECState),
60 VMSTATE_UINT32(eir, IMXFECState),
61 VMSTATE_UINT32(eimr, IMXFECState),
62 VMSTATE_UINT32(rx_enabled, IMXFECState),
63 VMSTATE_UINT32(rx_descriptor, IMXFECState),
64 VMSTATE_UINT32(tx_descriptor, IMXFECState),
65 VMSTATE_UINT32(ecr, IMXFECState),
66 VMSTATE_UINT32(mmfr, IMXFECState),
67 VMSTATE_UINT32(mscr, IMXFECState),
68 VMSTATE_UINT32(mibc, IMXFECState),
69 VMSTATE_UINT32(rcr, IMXFECState),
70 VMSTATE_UINT32(tcr, IMXFECState),
71 VMSTATE_UINT32(tfwr, IMXFECState),
72 VMSTATE_UINT32(frsr, IMXFECState),
73 VMSTATE_UINT32(erdsr, IMXFECState),
74 VMSTATE_UINT32(etdsr, IMXFECState),
75 VMSTATE_UINT32(emrbr, IMXFECState),
76 VMSTATE_UINT32(miigsk_cfgr, IMXFECState),
77 VMSTATE_UINT32(miigsk_enr, IMXFECState),
79 VMSTATE_UINT32(phy_status, IMXFECState),
80 VMSTATE_UINT32(phy_control, IMXFECState),
81 VMSTATE_UINT32(phy_advertise, IMXFECState),
82 VMSTATE_UINT32(phy_int, IMXFECState),
83 VMSTATE_UINT32(phy_int_mask, IMXFECState),
88 #define PHY_INT_ENERGYON (1 << 7)
89 #define PHY_INT_AUTONEG_COMPLETE (1 << 6)
90 #define PHY_INT_FAULT (1 << 5)
91 #define PHY_INT_DOWN (1 << 4)
92 #define PHY_INT_AUTONEG_LP (1 << 3)
93 #define PHY_INT_PARFAULT (1 << 2)
94 #define PHY_INT_AUTONEG_PAGE (1 << 1)
96 static void imx_fec_update(IMXFECState *s);
99 * The MII phy could raise a GPIO to the processor which in turn
100 * could be handled as an interrpt by the OS.
101 * For now we don't handle any GPIO/interrupt line, so the OS will
102 * have to poll for the PHY status.
104 static void phy_update_irq(IMXFECState *s)
109 static void phy_update_link(IMXFECState *s)
111 /* Autonegotiation status mirrors link status. */
112 if (qemu_get_queue(s->nic)->link_down) {
113 PHY_PRINTF("link is down\n");
114 s->phy_status &= ~0x0024;
115 s->phy_int |= PHY_INT_DOWN;
117 PHY_PRINTF("link is up\n");
118 s->phy_status |= 0x0024;
119 s->phy_int |= PHY_INT_ENERGYON;
120 s->phy_int |= PHY_INT_AUTONEG_COMPLETE;
125 static void imx_fec_set_link(NetClientState *nc)
127 phy_update_link(IMX_FEC(qemu_get_nic_opaque(nc)));
130 static void phy_reset(IMXFECState *s)
132 s->phy_status = 0x7809;
133 s->phy_control = 0x3000;
134 s->phy_advertise = 0x01e1;
140 static uint32_t do_phy_read(IMXFECState *s, int reg)
145 /* we only advertise one phy */
150 case 0: /* Basic Control */
151 val = s->phy_control;
153 case 1: /* Basic Status */
162 case 4: /* Auto-neg advertisement */
163 val = s->phy_advertise;
165 case 5: /* Auto-neg Link Partner Ability */
168 case 6: /* Auto-neg Expansion */
171 case 29: /* Interrupt source. */
176 case 30: /* Interrupt mask */
177 val = s->phy_int_mask;
183 qemu_log_mask(LOG_UNIMP, "[%s.phy]%s: reg %d not implemented\n",
184 TYPE_IMX_FEC, __func__, reg);
188 qemu_log_mask(LOG_GUEST_ERROR, "[%s.phy]%s: Bad address at offset %d\n",
189 TYPE_IMX_FEC, __func__, reg);
194 PHY_PRINTF("read 0x%04x @ %d\n", val, reg);
199 static void do_phy_write(IMXFECState *s, int reg, uint32_t val)
201 PHY_PRINTF("write 0x%04x @ %d\n", val, reg);
204 /* we only advertise one phy */
209 case 0: /* Basic Control */
213 s->phy_control = val & 0x7980;
214 /* Complete autonegotiation immediately. */
216 s->phy_status |= 0x0020;
220 case 4: /* Auto-neg advertisement */
221 s->phy_advertise = (val & 0x2d7f) | 0x80;
223 case 30: /* Interrupt mask */
224 s->phy_int_mask = val & 0xff;
231 qemu_log_mask(LOG_UNIMP, "[%s.phy)%s: reg %d not implemented\n",
232 TYPE_IMX_FEC, __func__, reg);
235 qemu_log_mask(LOG_GUEST_ERROR, "[%s.phy]%s: Bad address at offset %d\n",
236 TYPE_IMX_FEC, __func__, reg);
241 static void imx_fec_read_bd(IMXFECBufDesc *bd, dma_addr_t addr)
243 dma_memory_read(&address_space_memory, addr, bd, sizeof(*bd));
246 static void imx_fec_write_bd(IMXFECBufDesc *bd, dma_addr_t addr)
248 dma_memory_write(&address_space_memory, addr, bd, sizeof(*bd));
251 static void imx_fec_update(IMXFECState *s)
256 active = s->eir & s->eimr;
257 changed = active ^ s->irq_state;
259 qemu_set_irq(s->irq, active);
261 s->irq_state = active;
264 static void imx_fec_do_tx(IMXFECState *s)
267 uint8_t frame[FEC_MAX_FRAME_SIZE];
268 uint8_t *ptr = frame;
269 uint32_t addr = s->tx_descriptor;
275 imx_fec_read_bd(&bd, addr);
276 FEC_PRINTF("tx_bd %x flags %04x len %d data %08x\n",
277 addr, bd.flags, bd.length, bd.data);
278 if ((bd.flags & FEC_BD_R) == 0) {
279 /* Run out of descriptors to transmit. */
283 if (frame_size + len > FEC_MAX_FRAME_SIZE) {
284 len = FEC_MAX_FRAME_SIZE - frame_size;
285 s->eir |= FEC_INT_BABT;
287 dma_memory_read(&address_space_memory, bd.data, ptr, len);
290 if (bd.flags & FEC_BD_L) {
291 /* Last buffer in frame. */
292 qemu_send_packet(qemu_get_queue(s->nic), frame, len);
295 s->eir |= FEC_INT_TXF;
297 s->eir |= FEC_INT_TXB;
298 bd.flags &= ~FEC_BD_R;
299 /* Write back the modified descriptor. */
300 imx_fec_write_bd(&bd, addr);
301 /* Advance to the next descriptor. */
302 if ((bd.flags & FEC_BD_W) != 0) {
309 s->tx_descriptor = addr;
314 static void imx_fec_enable_rx(IMXFECState *s)
319 imx_fec_read_bd(&bd, s->rx_descriptor);
321 tmp = ((bd.flags & FEC_BD_E) != 0);
324 FEC_PRINTF("RX buffer full\n");
325 } else if (!s->rx_enabled) {
326 qemu_flush_queued_packets(qemu_get_queue(s->nic));
332 static void imx_fec_reset(DeviceState *d)
334 IMXFECState *s = IMX_FEC(d);
342 s->mibc = 0xc0000000;
350 /* We also reset the PHY */
354 static uint64_t imx_fec_read(void *opaque, hwaddr addr, unsigned size)
356 IMXFECState *s = IMX_FEC(opaque);
358 FEC_PRINTF("reading from @ 0x%" HWADDR_PRIx "\n", addr);
360 switch (addr & 0x3ff) {
366 return s->rx_enabled ? (1 << 24) : 0; /* RDAR */
376 return s->mibc; /* MIBC */
381 case 0x0e4: /* PALR */
382 return (s->conf.macaddr.a[0] << 24)
383 | (s->conf.macaddr.a[1] << 16)
384 | (s->conf.macaddr.a[2] << 8)
385 | s->conf.macaddr.a[3];
387 case 0x0e8: /* PAUR */
388 return (s->conf.macaddr.a[4] << 24)
389 | (s->conf.macaddr.a[5] << 16)
392 return 0x10000; /* OPD */
414 return s->miigsk_cfgr;
416 return s->miigsk_enr;
418 qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad address at offset 0x%"
419 HWADDR_PRIx "\n", TYPE_IMX_FEC, __func__, addr);
424 static void imx_fec_write(void *opaque, hwaddr addr,
425 uint64_t value, unsigned size)
427 IMXFECState *s = IMX_FEC(opaque);
429 FEC_PRINTF("writing 0x%08x @ 0x%" HWADDR_PRIx "\n", (int)value, addr);
431 switch (addr & 0x3ff) {
432 case 0x004: /* EIR */
435 case 0x008: /* EIMR */
438 case 0x010: /* RDAR */
439 if ((s->ecr & FEC_EN) && !s->rx_enabled) {
440 imx_fec_enable_rx(s);
443 case 0x014: /* TDAR */
444 if (s->ecr & FEC_EN) {
448 case 0x024: /* ECR */
450 if (value & FEC_RESET) {
451 imx_fec_reset(DEVICE(s));
453 if ((s->ecr & FEC_EN) == 0) {
457 case 0x040: /* MMFR */
458 /* store the value */
460 if (extract32(value, 28, 1)) {
461 do_phy_write(s, extract32(value, 18, 9), extract32(value, 0, 16));
463 s->mmfr = do_phy_read(s, extract32(value, 18, 9));
465 /* raise the interrupt as the PHY operation is done */
466 s->eir |= FEC_INT_MII;
468 case 0x044: /* MSCR */
469 s->mscr = value & 0xfe;
471 case 0x064: /* MIBC */
472 /* TODO: Implement MIB. */
473 s->mibc = (value & 0x80000000) ? 0xc0000000 : 0;
475 case 0x084: /* RCR */
476 s->rcr = value & 0x07ff003f;
477 /* TODO: Implement LOOP mode. */
479 case 0x0c4: /* TCR */
480 /* We transmit immediately, so raise GRA immediately. */
483 s->eir |= FEC_INT_GRA;
486 case 0x0e4: /* PALR */
487 s->conf.macaddr.a[0] = value >> 24;
488 s->conf.macaddr.a[1] = value >> 16;
489 s->conf.macaddr.a[2] = value >> 8;
490 s->conf.macaddr.a[3] = value;
492 case 0x0e8: /* PAUR */
493 s->conf.macaddr.a[4] = value >> 24;
494 s->conf.macaddr.a[5] = value >> 16;
496 case 0x0ec: /* OPDR */
498 case 0x118: /* IAUR */
499 case 0x11c: /* IALR */
500 case 0x120: /* GAUR */
501 case 0x124: /* GALR */
502 /* TODO: implement MAC hash filtering. */
504 case 0x144: /* TFWR */
507 case 0x14c: /* FRBR */
508 /* FRBR writes ignored. */
510 case 0x150: /* FRSR */
511 s->frsr = (value & 0x3fc) | 0x400;
513 case 0x180: /* ERDSR */
514 s->erdsr = value & ~3;
515 s->rx_descriptor = s->erdsr;
517 case 0x184: /* ETDSR */
518 s->etdsr = value & ~3;
519 s->tx_descriptor = s->etdsr;
521 case 0x188: /* EMRBR */
522 s->emrbr = value & 0x7f0;
524 case 0x300: /* MIIGSK_CFGR */
525 s->miigsk_cfgr = value & 0x53;
527 case 0x308: /* MIIGSK_ENR */
528 s->miigsk_enr = (value & 0x2) ? 0x6 : 0;
531 qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Bad address at offset 0x%"
532 HWADDR_PRIx "\n", TYPE_IMX_FEC, __func__, addr);
539 static int imx_fec_can_receive(NetClientState *nc)
541 IMXFECState *s = IMX_FEC(qemu_get_nic_opaque(nc));
543 return s->rx_enabled;
546 static ssize_t imx_fec_receive(NetClientState *nc, const uint8_t *buf,
549 IMXFECState *s = IMX_FEC(qemu_get_nic_opaque(nc));
556 unsigned int buf_len;
559 FEC_PRINTF("len %d\n", (int)size);
561 if (!s->rx_enabled) {
562 qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Unexpected packet\n",
563 TYPE_IMX_FEC, __func__);
567 /* 4 bytes for the CRC. */
569 crc = cpu_to_be32(crc32(~0, buf, size));
570 crc_ptr = (uint8_t *) &crc;
572 /* Huge frames are truncted. */
573 if (size > FEC_MAX_FRAME_SIZE) {
574 size = FEC_MAX_FRAME_SIZE;
575 flags |= FEC_BD_TR | FEC_BD_LG;
578 /* Frames larger than the user limit just set error flags. */
579 if (size > (s->rcr >> 16)) {
583 addr = s->rx_descriptor;
585 imx_fec_read_bd(&bd, addr);
586 if ((bd.flags & FEC_BD_E) == 0) {
587 /* No descriptors available. Bail out. */
589 * FIXME: This is wrong. We should probably either
590 * save the remainder for when more RX buffers are
591 * available, or flag an error.
593 qemu_log_mask(LOG_GUEST_ERROR, "[%s]%s: Lost end of frame\n",
594 TYPE_IMX_FEC, __func__);
597 buf_len = (size <= s->emrbr) ? size : s->emrbr;
601 FEC_PRINTF("rx_bd 0x%x length %d\n", addr, bd.length);
603 /* The last 4 bytes are the CRC. */
608 dma_memory_write(&address_space_memory, buf_addr, buf, buf_len);
611 dma_memory_write(&address_space_memory, buf_addr + buf_len,
615 bd.flags &= ~FEC_BD_E;
617 /* Last buffer in frame. */
618 bd.flags |= flags | FEC_BD_L;
619 FEC_PRINTF("rx frame flags %04x\n", bd.flags);
620 s->eir |= FEC_INT_RXF;
622 s->eir |= FEC_INT_RXB;
624 imx_fec_write_bd(&bd, addr);
625 /* Advance to the next descriptor. */
626 if ((bd.flags & FEC_BD_W) != 0) {
632 s->rx_descriptor = addr;
633 imx_fec_enable_rx(s);
638 static const MemoryRegionOps imx_fec_ops = {
639 .read = imx_fec_read,
640 .write = imx_fec_write,
641 .valid.min_access_size = 4,
642 .valid.max_access_size = 4,
643 .endianness = DEVICE_NATIVE_ENDIAN,
646 static void imx_fec_cleanup(NetClientState *nc)
648 IMXFECState *s = IMX_FEC(qemu_get_nic_opaque(nc));
653 static NetClientInfo net_imx_fec_info = {
654 .type = NET_CLIENT_OPTIONS_KIND_NIC,
655 .size = sizeof(NICState),
656 .can_receive = imx_fec_can_receive,
657 .receive = imx_fec_receive,
658 .cleanup = imx_fec_cleanup,
659 .link_status_changed = imx_fec_set_link,
663 static void imx_fec_realize(DeviceState *dev, Error **errp)
665 IMXFECState *s = IMX_FEC(dev);
666 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
668 memory_region_init_io(&s->iomem, OBJECT(dev), &imx_fec_ops, s,
669 TYPE_IMX_FEC, 0x400);
670 sysbus_init_mmio(sbd, &s->iomem);
671 sysbus_init_irq(sbd, &s->irq);
672 qemu_macaddr_default_if_unset(&s->conf.macaddr);
674 s->conf.peers.ncs[0] = nd_table[0].netdev;
676 s->nic = qemu_new_nic(&net_imx_fec_info, &s->conf,
677 object_get_typename(OBJECT(dev)), DEVICE(dev)->id,
679 qemu_format_nic_info_str(qemu_get_queue(s->nic), s->conf.macaddr.a);
682 static Property imx_fec_properties[] = {
683 DEFINE_NIC_PROPERTIES(IMXFECState, conf),
684 DEFINE_PROP_END_OF_LIST(),
687 static void imx_fec_class_init(ObjectClass *klass, void *data)
689 DeviceClass *dc = DEVICE_CLASS(klass);
691 dc->vmsd = &vmstate_imx_fec;
692 dc->reset = imx_fec_reset;
693 dc->props = imx_fec_properties;
694 dc->realize = imx_fec_realize;
697 static const TypeInfo imx_fec_info = {
698 .name = TYPE_IMX_FEC,
699 .parent = TYPE_SYS_BUS_DEVICE,
700 .instance_size = sizeof(IMXFECState),
701 .class_init = imx_fec_class_init,
704 static void imx_fec_register_types(void)
706 type_register_static(&imx_fec_info);
709 type_init(imx_fec_register_types)