2 * QEMU model of Xilinx AXI-Ethernet.
4 * Copyright (c) 2011 Edgar E. Iglesias.
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
28 #include "net/checksum.h"
34 /* Advertisement control register. */
35 #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */
36 #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */
37 #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */
38 #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */
45 unsigned int (*read
)(struct PHY
*phy
, unsigned int req
);
46 void (*write
)(struct PHY
*phy
, unsigned int req
,
50 static unsigned int tdk_read(struct PHY
*phy
, unsigned int req
)
63 /* Speeds and modes. */
64 r
|= (1 << 13) | (1 << 14);
65 r
|= (1 << 11) | (1 << 12);
66 r
|= (1 << 5); /* Autoneg complete. */
67 r
|= (1 << 3); /* Autoneg able. */
68 r
|= (1 << 2); /* link. */
69 r
|= (1 << 1); /* link. */
72 /* Link partner ability.
73 We are kind; always agree with whatever best mode
74 the guest advertises. */
75 r
= 1 << 14; /* Success. */
76 /* Copy advertised modes. */
77 r
|= phy
->regs
[4] & (15 << 5);
78 /* Autoneg support. */
82 /* Marvel PHY on many xilinx boards. */
83 r
= 0x8000; /* 1000Mb */
87 /* Diagnostics reg. */
95 /* Are we advertising 100 half or 100 duplex ? */
96 speed_100
= !!(phy
->regs
[4] & ADVERTISE_100HALF
);
97 speed_100
|= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
99 /* Are we advertising 10 duplex or 100 duplex ? */
100 duplex
= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
101 duplex
|= !!(phy
->regs
[4] & ADVERTISE_10FULL
);
102 r
= (speed_100
<< 10) | (duplex
<< 11);
107 r
= phy
->regs
[regnum
];
110 DPHY(qemu_log("\n%s %x = reg[%d]\n", __func__
, r
, regnum
));
115 tdk_write(struct PHY
*phy
, unsigned int req
, unsigned int data
)
120 DPHY(qemu_log("%s reg[%d] = %x\n", __func__
, regnum
, data
));
123 phy
->regs
[regnum
] = data
;
129 tdk_init(struct PHY
*phy
)
131 phy
->regs
[0] = 0x3100;
133 phy
->regs
[2] = 0x0300;
134 phy
->regs
[3] = 0xe400;
135 /* Autonegotiation advertisement reg. */
136 phy
->regs
[4] = 0x01E1;
139 phy
->read
= tdk_read
;
140 phy
->write
= tdk_write
;
166 struct PHY
*devs
[32];
170 mdio_attach(struct MDIOBus
*bus
, struct PHY
*phy
, unsigned int addr
)
172 bus
->devs
[addr
& 0x1f] = phy
;
175 #ifdef USE_THIS_DEAD_CODE
177 mdio_detach(struct MDIOBus
*bus
, struct PHY
*phy
, unsigned int addr
)
179 bus
->devs
[addr
& 0x1f] = NULL
;
183 static uint16_t mdio_read_req(struct MDIOBus
*bus
, unsigned int addr
,
189 phy
= bus
->devs
[addr
];
190 if (phy
&& phy
->read
) {
191 data
= phy
->read(phy
, reg
);
195 DPHY(qemu_log("%s addr=%d reg=%d data=%x\n", __func__
, addr
, reg
, data
));
199 static void mdio_write_req(struct MDIOBus
*bus
, unsigned int addr
,
200 unsigned int reg
, uint16_t data
)
204 DPHY(qemu_log("%s addr=%d reg=%d data=%x\n", __func__
, addr
, reg
, data
));
205 phy
= bus
->devs
[addr
];
206 if (phy
&& phy
->write
) {
207 phy
->write(phy
, reg
, data
);
213 #define R_RAF (0x000 / 4)
215 RAF_MCAST_REJ
= (1 << 1),
216 RAF_BCAST_REJ
= (1 << 2),
217 RAF_EMCF_EN
= (1 << 12),
218 RAF_NEWFUNC_EN
= (1 << 11)
221 #define R_IS (0x00C / 4)
223 IS_HARD_ACCESS_COMPLETE
= 1,
224 IS_AUTONEG
= (1 << 1),
225 IS_RX_COMPLETE
= (1 << 2),
226 IS_RX_REJECT
= (1 << 3),
227 IS_TX_COMPLETE
= (1 << 5),
228 IS_RX_DCM_LOCK
= (1 << 6),
229 IS_MGM_RDY
= (1 << 7),
230 IS_PHY_RST_DONE
= (1 << 8),
233 #define R_IP (0x010 / 4)
234 #define R_IE (0x014 / 4)
235 #define R_UAWL (0x020 / 4)
236 #define R_UAWU (0x024 / 4)
237 #define R_PPST (0x030 / 4)
239 PPST_LINKSTATUS
= (1 << 0),
240 PPST_PHY_LINKSTATUS
= (1 << 7),
243 #define R_STATS_RX_BYTESL (0x200 / 4)
244 #define R_STATS_RX_BYTESH (0x204 / 4)
245 #define R_STATS_TX_BYTESL (0x208 / 4)
246 #define R_STATS_TX_BYTESH (0x20C / 4)
247 #define R_STATS_RXL (0x290 / 4)
248 #define R_STATS_RXH (0x294 / 4)
249 #define R_STATS_RX_BCASTL (0x2a0 / 4)
250 #define R_STATS_RX_BCASTH (0x2a4 / 4)
251 #define R_STATS_RX_MCASTL (0x2a8 / 4)
252 #define R_STATS_RX_MCASTH (0x2ac / 4)
254 #define R_RCW0 (0x400 / 4)
255 #define R_RCW1 (0x404 / 4)
257 RCW1_VLAN
= (1 << 27),
259 RCW1_FCS
= (1 << 29),
260 RCW1_JUM
= (1 << 30),
261 RCW1_RST
= (1 << 31),
264 #define R_TC (0x408 / 4)
273 #define R_EMMC (0x410 / 4)
275 EMMC_LINKSPEED_10MB
= (0 << 30),
276 EMMC_LINKSPEED_100MB
= (1 << 30),
277 EMMC_LINKSPEED_1000MB
= (2 << 30),
280 #define R_PHYC (0x414 / 4)
282 #define R_MC (0x500 / 4)
283 #define MC_EN (1 << 6)
285 #define R_MCR (0x504 / 4)
286 #define R_MWD (0x508 / 4)
287 #define R_MRD (0x50c / 4)
288 #define R_MIS (0x600 / 4)
289 #define R_MIP (0x620 / 4)
290 #define R_MIE (0x640 / 4)
291 #define R_MIC (0x640 / 4)
293 #define R_UAW0 (0x700 / 4)
294 #define R_UAW1 (0x704 / 4)
295 #define R_FMI (0x708 / 4)
296 #define R_AF0 (0x710 / 4)
297 #define R_AF1 (0x714 / 4)
298 #define R_MAX (0x34 / 4)
300 /* Indirect registers. */
302 struct MDIOBus mdio_bus
;
308 struct XilinxAXIEnet
{
343 /* Receive configuration words. */
345 /* Transmit config. */
350 /* Unicast Address Word. */
352 /* Unicast address filter used with extended mcast. */
356 uint32_t regs
[R_MAX
];
358 /* Multicast filter addrs. */
359 uint32_t maddr
[4][2];
360 /* 32K x 1 lookup filter. */
361 uint32_t ext_mtable
[1024];
367 static void axienet_rx_reset(struct XilinxAXIEnet
*s
)
369 s
->rcw
[1] = RCW1_JUM
| RCW1_FCS
| RCW1_RX
| RCW1_VLAN
;
372 static void axienet_tx_reset(struct XilinxAXIEnet
*s
)
374 s
->tc
= TC_JUM
| TC_TX
| TC_VLAN
;
377 static inline int axienet_rx_resetting(struct XilinxAXIEnet
*s
)
379 return s
->rcw
[1] & RCW1_RST
;
382 static inline int axienet_rx_enabled(struct XilinxAXIEnet
*s
)
384 return s
->rcw
[1] & RCW1_RX
;
387 static inline int axienet_extmcf_enabled(struct XilinxAXIEnet
*s
)
389 return !!(s
->regs
[R_RAF
] & RAF_EMCF_EN
);
392 static inline int axienet_newfunc_enabled(struct XilinxAXIEnet
*s
)
394 return !!(s
->regs
[R_RAF
] & RAF_NEWFUNC_EN
);
397 static void axienet_reset(struct XilinxAXIEnet
*s
)
402 s
->regs
[R_PPST
] = PPST_LINKSTATUS
| PPST_PHY_LINKSTATUS
;
403 s
->regs
[R_IS
] = IS_AUTONEG
| IS_RX_DCM_LOCK
| IS_MGM_RDY
| IS_PHY_RST_DONE
;
405 s
->emmc
= EMMC_LINKSPEED_100MB
;
408 static void enet_update_irq(struct XilinxAXIEnet
*s
)
410 s
->regs
[R_IP
] = s
->regs
[R_IS
] & s
->regs
[R_IE
];
411 qemu_set_irq(s
->irq
, !!s
->regs
[R_IP
]);
414 static uint64_t enet_read(void *opaque
, hwaddr addr
, unsigned size
)
416 struct XilinxAXIEnet
*s
= opaque
;
423 r
= s
->rcw
[addr
& 1];
439 r
= s
->mii
.regs
[addr
& 3] | (1 << 7); /* Always ready. */
442 case R_STATS_RX_BYTESL
:
443 case R_STATS_RX_BYTESH
:
444 r
= s
->stats
.rx_bytes
>> (32 * (addr
& 1));
447 case R_STATS_TX_BYTESL
:
448 case R_STATS_TX_BYTESH
:
449 r
= s
->stats
.tx_bytes
>> (32 * (addr
& 1));
454 r
= s
->stats
.rx
>> (32 * (addr
& 1));
456 case R_STATS_RX_BCASTL
:
457 case R_STATS_RX_BCASTH
:
458 r
= s
->stats
.rx_bcast
>> (32 * (addr
& 1));
460 case R_STATS_RX_MCASTL
:
461 case R_STATS_RX_MCASTH
:
462 r
= s
->stats
.rx_mcast
>> (32 * (addr
& 1));
468 r
= s
->mii
.regs
[addr
& 3];
473 r
= s
->uaw
[addr
& 1];
478 r
= s
->ext_uaw
[addr
& 1];
487 r
= s
->maddr
[s
->fmi
& 3][addr
& 1];
490 case 0x8000 ... 0x83ff:
491 r
= s
->ext_mtable
[addr
- 0x8000];
495 if (addr
< ARRAY_SIZE(s
->regs
)) {
498 DENET(qemu_log("%s addr=" TARGET_FMT_plx
" v=%x\n",
499 __func__
, addr
* 4, r
));
505 static void enet_write(void *opaque
, hwaddr addr
,
506 uint64_t value
, unsigned size
)
508 struct XilinxAXIEnet
*s
= opaque
;
509 struct TEMAC
*t
= &s
->TEMAC
;
515 s
->rcw
[addr
& 1] = value
;
516 if ((addr
& 1) && value
& RCW1_RST
) {
523 if (value
& TC_RST
) {
537 value
&= ((1 < 7) - 1);
539 /* Enable the MII. */
541 unsigned int miiclkdiv
= value
& ((1 << 6) - 1);
543 qemu_log("AXIENET: MDIO enabled but MDIOCLK is zero!\n");
550 unsigned int phyaddr
= (value
>> 24) & 0x1f;
551 unsigned int regaddr
= (value
>> 16) & 0x1f;
552 unsigned int op
= (value
>> 14) & 3;
553 unsigned int initiate
= (value
>> 11) & 1;
557 mdio_write_req(&t
->mdio_bus
, phyaddr
, regaddr
, s
->mii
.mwd
);
558 } else if (op
== 2) {
559 s
->mii
.mrd
= mdio_read_req(&t
->mdio_bus
, phyaddr
, regaddr
);
561 qemu_log("AXIENET: invalid MDIOBus OP=%d\n", op
);
570 s
->mii
.regs
[addr
& 3] = value
;
576 s
->uaw
[addr
& 1] = value
;
581 s
->ext_uaw
[addr
& 1] = value
;
590 s
->maddr
[s
->fmi
& 3][addr
& 1] = value
;
594 s
->regs
[addr
] &= ~value
;
597 case 0x8000 ... 0x83ff:
598 s
->ext_mtable
[addr
- 0x8000] = value
;
602 DENET(qemu_log("%s addr=" TARGET_FMT_plx
" v=%x\n",
603 __func__
, addr
* 4, (unsigned)value
));
604 if (addr
< ARRAY_SIZE(s
->regs
)) {
605 s
->regs
[addr
] = value
;
612 static const MemoryRegionOps enet_ops
= {
615 .endianness
= DEVICE_LITTLE_ENDIAN
,
618 static int eth_can_rx(NetClientState
*nc
)
620 struct XilinxAXIEnet
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
623 return !axienet_rx_resetting(s
) && axienet_rx_enabled(s
);
626 static int enet_match_addr(const uint8_t *buf
, uint32_t f0
, uint32_t f1
)
630 if (memcmp(buf
, &f0
, 4)) {
634 if (buf
[4] != (f1
& 0xff) || buf
[5] != ((f1
>> 8) & 0xff)) {
641 static ssize_t
eth_rx(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
643 struct XilinxAXIEnet
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
644 static const unsigned char sa_bcast
[6] = {0xff, 0xff, 0xff,
646 static const unsigned char sa_ipmcast
[3] = {0x01, 0x00, 0x52};
647 uint32_t app
[6] = {0};
648 int promisc
= s
->fmi
& (1 << 31);
649 int unicast
, broadcast
, multicast
, ip_multicast
= 0;
654 DENET(qemu_log("%s: %zd bytes\n", __func__
, size
));
656 unicast
= ~buf
[0] & 0x1;
657 broadcast
= memcmp(buf
, sa_bcast
, 6) == 0;
658 multicast
= !unicast
&& !broadcast
;
659 if (multicast
&& (memcmp(sa_ipmcast
, buf
, sizeof sa_ipmcast
) == 0)) {
663 /* Jumbo or vlan sizes ? */
664 if (!(s
->rcw
[1] & RCW1_JUM
)) {
665 if (size
> 1518 && size
<= 1522 && !(s
->rcw
[1] & RCW1_VLAN
)) {
670 /* Basic Address filters. If you want to use the extended filters
671 you'll generally have to place the ethernet mac into promiscuous mode
672 to avoid the basic filtering from dropping most frames. */
675 if (!enet_match_addr(buf
, s
->uaw
[0], s
->uaw
[1])) {
681 if (s
->regs
[R_RAF
] & RAF_BCAST_REJ
) {
688 if (s
->regs
[R_RAF
] & RAF_MCAST_REJ
) {
692 for (i
= 0; i
< 4; i
++) {
693 if (enet_match_addr(buf
, s
->maddr
[i
][0], s
->maddr
[i
][1])) {
706 /* Extended mcast filtering enabled? */
707 if (axienet_newfunc_enabled(s
) && axienet_extmcf_enabled(s
)) {
709 if (!enet_match_addr(buf
, s
->ext_uaw
[0], s
->ext_uaw
[1])) {
715 if (s
->regs
[R_RAF
] & RAF_BCAST_REJ
) {
722 if (!memcmp(buf
, sa_ipmcast
, 3)) {
726 idx
= (buf
[4] & 0x7f) << 8;
729 bit
= 1 << (idx
& 0x1f);
732 if (!(s
->ext_mtable
[idx
] & bit
)) {
740 s
->regs
[R_IS
] |= IS_RX_REJECT
;
745 if (size
> (s
->c_rxmem
- 4)) {
746 size
= s
->c_rxmem
- 4;
749 memcpy(s
->rxmem
, buf
, size
);
750 memset(s
->rxmem
+ size
, 0, 4); /* Clear the FCS. */
752 if (s
->rcw
[1] & RCW1_FCS
) {
753 size
+= 4; /* fcs is inband. */
757 csum32
= net_checksum_add(size
- 14, (uint8_t *)s
->rxmem
+ 14);
759 csum32
= (csum32
& 0xffff) + (csum32
>> 16);
760 /* And twice to get rid of possible carries. */
761 csum16
= (csum32
& 0xffff) + (csum32
>> 16);
763 app
[4] = size
& 0xffff;
765 s
->stats
.rx_bytes
+= size
;
769 app
[2] |= 1 | (ip_multicast
<< 1);
770 } else if (broadcast
) {
778 stream_push(s
->tx_dev
, (void *)s
->rxmem
, size
, app
);
780 s
->regs
[R_IS
] |= IS_RX_COMPLETE
;
785 static void eth_cleanup(NetClientState
*nc
)
788 struct XilinxAXIEnet
*s
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
794 axienet_stream_push(StreamSlave
*obj
, uint8_t *buf
, size_t size
, uint32_t *hdr
)
796 struct XilinxAXIEnet
*s
= FROM_SYSBUS(typeof(*s
), SYS_BUS_DEVICE(obj
));
799 if (!(s
->tc
& TC_TX
)) {
803 /* Jumbo or vlan sizes ? */
804 if (!(s
->tc
& TC_JUM
)) {
805 if (size
> 1518 && size
<= 1522 && !(s
->tc
& TC_VLAN
)) {
811 unsigned int start_off
= hdr
[1] >> 16;
812 unsigned int write_off
= hdr
[1] & 0xffff;
816 tmp_csum
= net_checksum_add(size
- start_off
,
817 (uint8_t *)buf
+ start_off
);
818 /* Accumulate the seed. */
819 tmp_csum
+= hdr
[2] & 0xffff;
821 /* Fold the 32bit partial checksum. */
822 csum
= net_checksum_finish(tmp_csum
);
825 buf
[write_off
] = csum
>> 8;
826 buf
[write_off
+ 1] = csum
& 0xff;
829 qemu_send_packet(&s
->nic
->nc
, buf
, size
);
831 s
->stats
.tx_bytes
+= size
;
832 s
->regs
[R_IS
] |= IS_TX_COMPLETE
;
836 static NetClientInfo net_xilinx_enet_info
= {
837 .type
= NET_CLIENT_OPTIONS_KIND_NIC
,
838 .size
= sizeof(NICState
),
839 .can_receive
= eth_can_rx
,
841 .cleanup
= eth_cleanup
,
844 static int xilinx_enet_init(SysBusDevice
*dev
)
846 struct XilinxAXIEnet
*s
= FROM_SYSBUS(typeof(*s
), dev
);
848 sysbus_init_irq(dev
, &s
->irq
);
850 memory_region_init_io(&s
->iomem
, &enet_ops
, s
, "enet", 0x40000);
851 sysbus_init_mmio(dev
, &s
->iomem
);
853 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
854 s
->nic
= qemu_new_nic(&net_xilinx_enet_info
, &s
->conf
,
855 object_get_typename(OBJECT(dev
)), dev
->qdev
.id
, s
);
856 qemu_format_nic_info_str(&s
->nic
->nc
, s
->conf
.macaddr
.a
);
858 tdk_init(&s
->TEMAC
.phy
);
859 mdio_attach(&s
->TEMAC
.mdio_bus
, &s
->TEMAC
.phy
, s
->c_phyaddr
);
863 s
->rxmem
= g_malloc(s
->c_rxmem
);
869 static void xilinx_enet_initfn(Object
*obj
)
871 struct XilinxAXIEnet
*s
= FROM_SYSBUS(typeof(*s
), SYS_BUS_DEVICE(obj
));
873 object_property_add_link(obj
, "axistream-connected", TYPE_STREAM_SLAVE
,
874 (Object
**) &s
->tx_dev
, NULL
);
877 static Property xilinx_enet_properties
[] = {
878 DEFINE_PROP_UINT32("phyaddr", struct XilinxAXIEnet
, c_phyaddr
, 7),
879 DEFINE_PROP_UINT32("rxmem", struct XilinxAXIEnet
, c_rxmem
, 0x1000),
880 DEFINE_PROP_UINT32("txmem", struct XilinxAXIEnet
, c_txmem
, 0x1000),
881 DEFINE_NIC_PROPERTIES(struct XilinxAXIEnet
, conf
),
882 DEFINE_PROP_END_OF_LIST(),
885 static void xilinx_enet_class_init(ObjectClass
*klass
, void *data
)
887 DeviceClass
*dc
= DEVICE_CLASS(klass
);
888 SysBusDeviceClass
*k
= SYS_BUS_DEVICE_CLASS(klass
);
889 StreamSlaveClass
*ssc
= STREAM_SLAVE_CLASS(klass
);
891 k
->init
= xilinx_enet_init
;
892 dc
->props
= xilinx_enet_properties
;
893 ssc
->push
= axienet_stream_push
;
896 static const TypeInfo xilinx_enet_info
= {
897 .name
= "xlnx.axi-ethernet",
898 .parent
= TYPE_SYS_BUS_DEVICE
,
899 .instance_size
= sizeof(struct XilinxAXIEnet
),
900 .class_init
= xilinx_enet_class_init
,
901 .instance_init
= xilinx_enet_initfn
,
902 .interfaces
= (InterfaceInfo
[]) {
903 { TYPE_STREAM_SLAVE
},
908 static void xilinx_enet_register_types(void)
910 type_register_static(&xilinx_enet_info
);
913 type_init(xilinx_enet_register_types
)