2 * QEMU ETRAX Ethernet Controller.
4 * Copyright (c) 2008 Edgar E. Iglesias, Axis Communications AB.
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
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "hw/sysbus.h"
29 #include "hw/cris/etraxfs.h"
30 #include "qemu/error-report.h"
31 #include "qemu/module.h"
33 #include "qom/object.h"
37 /* Advertisement control register. */
38 #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */
39 #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */
40 #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */
41 #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */
44 * The MDIO extensions in the TDK PHY model were reversed engineered from the
45 * linux driver (PHYID and Diagnostics reg).
46 * TODO: Add friendly names for the register nums.
54 unsigned int (*read
)(struct qemu_phy
*phy
, unsigned int req
);
55 void (*write
)(struct qemu_phy
*phy
, unsigned int req
, unsigned int data
);
58 static unsigned int tdk_read(struct qemu_phy
*phy
, unsigned int req
)
71 /* Speeds and modes. */
72 r
|= (1 << 13) | (1 << 14);
73 r
|= (1 << 11) | (1 << 12);
74 r
|= (1 << 5); /* Autoneg complete. */
75 r
|= (1 << 3); /* Autoneg able. */
76 r
|= (1 << 2); /* link. */
79 /* Link partner ability.
80 We are kind; always agree with whatever best mode
81 the guest advertises. */
82 r
= 1 << 14; /* Success. */
83 /* Copy advertised modes. */
84 r
|= phy
->regs
[4] & (15 << 5);
85 /* Autoneg support. */
90 /* Diagnostics reg. */
98 /* Are we advertising 100 half or 100 duplex ? */
99 speed_100
= !!(phy
->regs
[4] & ADVERTISE_100HALF
);
100 speed_100
|= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
102 /* Are we advertising 10 duplex or 100 duplex ? */
103 duplex
= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
104 duplex
|= !!(phy
->regs
[4] & ADVERTISE_10FULL
);
105 r
= (speed_100
<< 10) | (duplex
<< 11);
110 r
= phy
->regs
[regnum
];
113 trace_mdio_phy_read(regnum
, r
);
118 tdk_write(struct qemu_phy
*phy
, unsigned int req
, unsigned int data
)
123 trace_mdio_phy_write(regnum
, data
);
126 phy
->regs
[regnum
] = data
;
132 tdk_reset(struct qemu_phy
*phy
)
134 phy
->regs
[0] = 0x3100;
136 phy
->regs
[2] = 0x0300;
137 phy
->regs
[3] = 0xe400;
138 /* Autonegotiation advertisement reg. */
139 phy
->regs
[4] = 0x01E1;
167 struct qemu_phy
*devs
[32];
171 mdio_attach(struct qemu_mdio
*bus
, struct qemu_phy
*phy
, unsigned int addr
)
173 bus
->devs
[addr
& 0x1f] = phy
;
176 #ifdef USE_THIS_DEAD_CODE
178 mdio_detach(struct qemu_mdio
*bus
, struct qemu_phy
*phy
, unsigned int addr
)
180 bus
->devs
[addr
& 0x1f] = NULL
;
184 static void mdio_read_req(struct qemu_mdio
*bus
)
186 struct qemu_phy
*phy
;
188 phy
= bus
->devs
[bus
->addr
];
189 if (phy
&& phy
->read
) {
190 bus
->data
= phy
->read(phy
, bus
->req
);
196 static void mdio_write_req(struct qemu_mdio
*bus
)
198 struct qemu_phy
*phy
;
200 phy
= bus
->devs
[bus
->addr
];
201 if (phy
&& phy
->write
) {
202 phy
->write(phy
, bus
->req
, bus
->data
);
206 static void mdio_cycle(struct qemu_mdio
*bus
)
210 trace_mdio_bitbang(bus
->mdc
, bus
->mdio
, bus
->state
, bus
->cnt
, bus
->drive
);
213 printf("%d", bus
->mdio
);
216 switch (bus
->state
) {
219 if (bus
->cnt
>= (32 * 2) && !bus
->mdio
) {
228 if (bus
->mdio
!= 1) {
229 printf("WARNING: no SOF\n");
231 if (bus
->cnt
== 1*2) {
241 bus
->opc
|= bus
->mdio
& 1;
242 if (bus
->cnt
== 2*2) {
252 bus
->addr
|= bus
->mdio
& 1;
254 if (bus
->cnt
== 5*2) {
264 bus
->req
|= bus
->mdio
& 1;
265 if (bus
->cnt
== 5*2) {
267 bus
->state
= TURNAROUND
;
272 if (bus
->mdc
&& bus
->cnt
== 2*2) {
279 bus
->mdio
= bus
->data
& 1;
287 bus
->mdio
= !!(bus
->data
& (1 << 15));
293 bus
->data
|= bus
->mdio
;
295 if (bus
->cnt
== 16 * 2) {
297 bus
->state
= PREAMBLE
;
310 /* ETRAX-FS Ethernet MAC block starts here. */
312 #define RW_MA0_LO 0x00
313 #define RW_MA0_HI 0x01
314 #define RW_MA1_LO 0x02
315 #define RW_MA1_HI 0x03
316 #define RW_GA_LO 0x04
317 #define RW_GA_HI 0x05
318 #define RW_GEN_CTRL 0x06
319 #define RW_REC_CTRL 0x07
320 #define RW_TR_CTRL 0x08
321 #define RW_CLR_ERR 0x09
322 #define RW_MGM_CTRL 0x0a
324 #define FS_ETH_MAX_REGS 0x17
326 #define TYPE_ETRAX_FS_ETH "etraxfs-eth"
327 typedef struct ETRAXFSEthState ETRAXFSEthState
;
328 DECLARE_INSTANCE_CHECKER(ETRAXFSEthState
, ETRAX_FS_ETH
,
331 struct ETRAXFSEthState
{
332 SysBusDevice parent_obj
;
338 /* Two addrs in the filter. */
339 uint8_t macaddr
[2][6];
340 uint32_t regs
[FS_ETH_MAX_REGS
];
342 struct etraxfs_dma_client
*dma_out
;
343 struct etraxfs_dma_client
*dma_in
;
346 struct qemu_mdio mdio_bus
;
347 unsigned int phyaddr
;
354 static void eth_validate_duplex(ETRAXFSEthState
*eth
)
356 struct qemu_phy
*phy
;
357 unsigned int phy_duplex
;
358 unsigned int mac_duplex
;
361 phy
= eth
->mdio_bus
.devs
[eth
->phyaddr
];
362 phy_duplex
= !!(phy
->read(phy
, 18) & (1 << 11));
363 mac_duplex
= !!(eth
->regs
[RW_REC_CTRL
] & 128);
365 if (mac_duplex
!= phy_duplex
) {
369 if (eth
->regs
[RW_GEN_CTRL
] & 1) {
370 if (new_mm
!= eth
->duplex_mismatch
) {
372 printf("HW: WARNING ETH duplex mismatch MAC=%d PHY=%d\n",
373 mac_duplex
, phy_duplex
);
375 printf("HW: ETH duplex ok.\n");
378 eth
->duplex_mismatch
= new_mm
;
383 eth_read(void *opaque
, hwaddr addr
, unsigned int size
)
385 ETRAXFSEthState
*eth
= opaque
;
392 r
= eth
->mdio_bus
.mdio
& 1;
396 D(printf("%s %x\n", __func__
, addr
* 4));
402 static void eth_update_ma(ETRAXFSEthState
*eth
, int ma
)
414 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
];
415 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 8;
416 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 16;
417 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 24;
418 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
+ 1];
419 eth
->macaddr
[ma
][i
] = eth
->regs
[reg
+ 1] >> 8;
421 D(printf("set mac%d=%x.%x.%x.%x.%x.%x\n", ma
,
422 eth
->macaddr
[ma
][0], eth
->macaddr
[ma
][1],
423 eth
->macaddr
[ma
][2], eth
->macaddr
[ma
][3],
424 eth
->macaddr
[ma
][4], eth
->macaddr
[ma
][5]));
428 eth_write(void *opaque
, hwaddr addr
,
429 uint64_t val64
, unsigned int size
)
431 ETRAXFSEthState
*eth
= opaque
;
432 uint32_t value
= val64
;
438 eth
->regs
[addr
] = value
;
439 eth_update_ma(eth
, 0);
443 eth
->regs
[addr
] = value
;
444 eth_update_ma(eth
, 1);
448 /* Attach an MDIO/PHY abstraction. */
450 eth
->mdio_bus
.mdio
= value
& 1;
452 if (eth
->mdio_bus
.mdc
!= (value
& 4)) {
453 mdio_cycle(ð
->mdio_bus
);
454 eth_validate_duplex(eth
);
456 eth
->mdio_bus
.mdc
= !!(value
& 4);
457 eth
->regs
[addr
] = value
;
461 eth
->regs
[addr
] = value
;
462 eth_validate_duplex(eth
);
466 eth
->regs
[addr
] = value
;
467 D(printf("%s %x %x\n", __func__
, addr
, value
));
472 /* The ETRAX FS has a groupt address table (GAT) which works like a k=1 bloom
473 filter dropping group addresses we have not joined. The filter has 64
474 bits (m). The has function is a simple nible xor of the group addr. */
475 static int eth_match_groupaddr(ETRAXFSEthState
*eth
, const unsigned char *sa
)
478 int m_individual
= eth
->regs
[RW_REC_CTRL
] & 4;
481 /* First bit on the wire of a MAC address signals multicast or
483 if (!m_individual
&& !(sa
[0] & 1)) {
487 /* Calculate the hash index for the GA registers. */
490 hsh
^= ((*sa
) >> 6) & 0x03;
492 hsh
^= ((*sa
) << 2) & 0x03c;
493 hsh
^= ((*sa
) >> 4) & 0xf;
495 hsh
^= ((*sa
) << 4) & 0x30;
496 hsh
^= ((*sa
) >> 2) & 0x3f;
499 hsh
^= ((*sa
) >> 6) & 0x03;
501 hsh
^= ((*sa
) << 2) & 0x03c;
502 hsh
^= ((*sa
) >> 4) & 0xf;
504 hsh
^= ((*sa
) << 4) & 0x30;
505 hsh
^= ((*sa
) >> 2) & 0x3f;
509 match
= eth
->regs
[RW_GA_HI
] & (1 << (hsh
- 32));
511 match
= eth
->regs
[RW_GA_LO
] & (1 << hsh
);
513 D(printf("hsh=%x ga=%x.%x mtch=%d\n", hsh
,
514 eth
->regs
[RW_GA_HI
], eth
->regs
[RW_GA_LO
], match
));
518 static ssize_t
eth_receive(NetClientState
*nc
, const uint8_t *buf
, size_t size
)
520 unsigned char sa_bcast
[6] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
521 ETRAXFSEthState
*eth
= qemu_get_nic_opaque(nc
);
522 int use_ma0
= eth
->regs
[RW_REC_CTRL
] & 1;
523 int use_ma1
= eth
->regs
[RW_REC_CTRL
] & 2;
524 int r_bcast
= eth
->regs
[RW_REC_CTRL
] & 8;
530 D(printf("%x.%x.%x.%x.%x.%x ma=%d %d bc=%d\n",
531 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5],
532 use_ma0
, use_ma1
, r_bcast
));
534 /* Does the frame get through the address filters? */
535 if ((!use_ma0
|| memcmp(buf
, eth
->macaddr
[0], 6))
536 && (!use_ma1
|| memcmp(buf
, eth
->macaddr
[1], 6))
537 && (!r_bcast
|| memcmp(buf
, sa_bcast
, 6))
538 && !eth_match_groupaddr(eth
, buf
)) {
542 /* FIXME: Find another way to pass on the fake csum. */
543 etraxfs_dmac_input(eth
->dma_in
, (void *)buf
, size
+ 4, 1);
548 static int eth_tx_push(void *opaque
, unsigned char *buf
, int len
, bool eop
)
550 ETRAXFSEthState
*eth
= opaque
;
552 D(printf("%s buf=%p len=%d\n", __func__
, buf
, len
));
553 qemu_send_packet(qemu_get_queue(eth
->nic
), buf
, len
);
557 static void eth_set_link(NetClientState
*nc
)
559 ETRAXFSEthState
*eth
= qemu_get_nic_opaque(nc
);
560 D(printf("%s %d\n", __func__
, nc
->link_down
));
561 eth
->phy
.link
= !nc
->link_down
;
564 static const MemoryRegionOps eth_ops
= {
567 .endianness
= DEVICE_LITTLE_ENDIAN
,
569 .min_access_size
= 4,
574 static NetClientInfo net_etraxfs_info
= {
575 .type
= NET_CLIENT_DRIVER_NIC
,
576 .size
= sizeof(NICState
),
577 .receive
= eth_receive
,
578 .link_status_changed
= eth_set_link
,
581 static void etraxfs_eth_reset(DeviceState
*dev
)
583 ETRAXFSEthState
*s
= ETRAX_FS_ETH(dev
);
585 memset(s
->regs
, 0, sizeof(s
->regs
));
586 memset(s
->macaddr
, 0, sizeof(s
->macaddr
));
587 s
->duplex_mismatch
= 0;
590 s
->mdio_bus
.mdio
= 0;
591 s
->mdio_bus
.state
= 0;
592 s
->mdio_bus
.drive
= 0;
594 s
->mdio_bus
.addr
= 0;
597 s
->mdio_bus
.data
= 0;
602 static void etraxfs_eth_realize(DeviceState
*dev
, Error
**errp
)
604 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
605 ETRAXFSEthState
*s
= ETRAX_FS_ETH(dev
);
607 if (!s
->dma_out
|| !s
->dma_in
) {
608 error_setg(errp
, "Unconnected ETRAX-FS Ethernet MAC");
612 s
->dma_out
->client
.push
= eth_tx_push
;
613 s
->dma_out
->client
.opaque
= s
;
614 s
->dma_in
->client
.opaque
= s
;
615 s
->dma_in
->client
.pull
= NULL
;
617 memory_region_init_io(&s
->mmio
, OBJECT(dev
), ð_ops
, s
,
618 "etraxfs-eth", 0x5c);
619 sysbus_init_mmio(sbd
, &s
->mmio
);
621 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
622 s
->nic
= qemu_new_nic(&net_etraxfs_info
, &s
->conf
,
623 object_get_typename(OBJECT(s
)), dev
->id
, s
);
624 qemu_format_nic_info_str(qemu_get_queue(s
->nic
), s
->conf
.macaddr
.a
);
626 s
->phy
.read
= tdk_read
;
627 s
->phy
.write
= tdk_write
;
628 mdio_attach(&s
->mdio_bus
, &s
->phy
, s
->phyaddr
);
631 static Property etraxfs_eth_properties
[] = {
632 DEFINE_PROP_UINT32("phyaddr", ETRAXFSEthState
, phyaddr
, 1),
633 DEFINE_NIC_PROPERTIES(ETRAXFSEthState
, conf
),
634 DEFINE_PROP_END_OF_LIST(),
637 static void etraxfs_eth_class_init(ObjectClass
*klass
, void *data
)
639 DeviceClass
*dc
= DEVICE_CLASS(klass
);
641 dc
->realize
= etraxfs_eth_realize
;
642 dc
->reset
= etraxfs_eth_reset
;
643 device_class_set_props(dc
, etraxfs_eth_properties
);
644 /* Reason: dma_out, dma_in are not user settable */
645 dc
->user_creatable
= false;
649 /* Instantiate an ETRAXFS Ethernet MAC. */
651 etraxfs_eth_init(NICInfo
*nd
, hwaddr base
, int phyaddr
,
652 struct etraxfs_dma_client
*dma_out
,
653 struct etraxfs_dma_client
*dma_in
)
656 qemu_check_nic_model(nd
, "fseth");
658 dev
= qdev_new("etraxfs-eth");
659 qdev_set_nic_properties(dev
, nd
);
660 qdev_prop_set_uint32(dev
, "phyaddr", phyaddr
);
663 * TODO: QOM design, define a QOM interface for "I am an etraxfs
664 * DMA client" (which replaces the current 'struct
665 * etraxfs_dma_client' ad-hoc interface), implement it on the
666 * ethernet device, and then have QOM link properties on the DMA
667 * controller device so that you can pass the interface
668 * implementations to it.
670 ETRAX_FS_ETH(dev
)->dma_out
= dma_out
;
671 ETRAX_FS_ETH(dev
)->dma_in
= dma_in
;
672 sysbus_realize_and_unref(SYS_BUS_DEVICE(dev
), &error_fatal
);
673 sysbus_mmio_map(SYS_BUS_DEVICE(dev
), 0, base
);
678 static const TypeInfo etraxfs_eth_info
= {
679 .name
= TYPE_ETRAX_FS_ETH
,
680 .parent
= TYPE_SYS_BUS_DEVICE
,
681 .instance_size
= sizeof(ETRAXFSEthState
),
682 .class_init
= etraxfs_eth_class_init
,
685 static void etraxfs_eth_register_types(void)
687 type_register_static(&etraxfs_eth_info
);
690 type_init(etraxfs_eth_register_types
)