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
32 /* Advertisement control register. */
33 #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */
34 #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */
35 #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */
36 #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */
39 * The MDIO extensions in the TDK PHY model were reversed engineered from the
40 * linux driver (PHYID and Diagnostics reg).
41 * TODO: Add friendly names for the register nums.
49 unsigned int (*read
)(struct qemu_phy
*phy
, unsigned int req
);
50 void (*write
)(struct qemu_phy
*phy
, unsigned int req
,
54 static unsigned int tdk_read(struct qemu_phy
*phy
, unsigned int req
)
66 /* Speeds and modes. */
67 r
|= (1 << 13) | (1 << 14);
68 r
|= (1 << 11) | (1 << 12);
69 r
|= (1 << 5); /* Autoneg complete. */
70 r
|= (1 << 3); /* Autoneg able. */
71 r
|= (1 << 2); /* link. */
74 /* Link partner ability.
75 We are kind; always agree with whatever best mode
76 the guest advertises. */
77 r
= 1 << 14; /* Success. */
78 /* Copy advertised modes. */
79 r
|= phy
->regs
[4] & (15 << 5);
80 /* Autoneg support. */
85 /* Diagnostics reg. */
92 /* Are we advertising 100 half or 100 duplex ? */
93 speed_100
= !!(phy
->regs
[4] & ADVERTISE_100HALF
);
94 speed_100
|= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
96 /* Are we advertising 10 duplex or 100 duplex ? */
97 duplex
= !!(phy
->regs
[4] & ADVERTISE_100FULL
);
98 duplex
|= !!(phy
->regs
[4] & ADVERTISE_10FULL
);
99 r
= (speed_100
<< 10) | (duplex
<< 11);
104 r
= phy
->regs
[regnum
];
107 D(printf("\n%s %x = reg[%d]\n", __func__
, r
, regnum
));
112 tdk_write(struct qemu_phy
*phy
, unsigned int req
, unsigned int data
)
117 D(printf("%s reg[%d] = %x\n", __func__
, regnum
, data
));
120 phy
->regs
[regnum
] = data
;
126 tdk_init(struct qemu_phy
*phy
)
128 phy
->regs
[0] = 0x3100;
130 phy
->regs
[2] = 0x0300;
131 phy
->regs
[3] = 0xe400;
132 /* Autonegotiation advertisement reg. */
133 phy
->regs
[4] = 0x01E1;
136 phy
->read
= tdk_read
;
137 phy
->write
= tdk_write
;
164 struct qemu_phy
*devs
[32];
168 mdio_attach(struct qemu_mdio
*bus
, struct qemu_phy
*phy
, unsigned int addr
)
170 bus
->devs
[addr
& 0x1f] = phy
;
173 #ifdef USE_THIS_DEAD_CODE
175 mdio_detach(struct qemu_mdio
*bus
, struct qemu_phy
*phy
, unsigned int addr
)
177 bus
->devs
[addr
& 0x1f] = NULL
;
181 static void mdio_read_req(struct qemu_mdio
*bus
)
183 struct qemu_phy
*phy
;
185 phy
= bus
->devs
[bus
->addr
];
186 if (phy
&& phy
->read
)
187 bus
->data
= phy
->read(phy
, bus
->req
);
192 static void mdio_write_req(struct qemu_mdio
*bus
)
194 struct qemu_phy
*phy
;
196 phy
= bus
->devs
[bus
->addr
];
197 if (phy
&& phy
->write
)
198 phy
->write(phy
, bus
->req
, bus
->data
);
201 static void mdio_cycle(struct qemu_mdio
*bus
)
205 D(printf("mdc=%d mdio=%d state=%d cnt=%d drv=%d\n",
206 bus
->mdc
, bus
->mdio
, bus
->state
, bus
->cnt
, bus
->drive
));
209 printf("%d", bus
->mdio
);
215 if (bus
->cnt
>= (32 * 2) && !bus
->mdio
) {
225 printf("WARNING: no SOF\n");
226 if (bus
->cnt
== 1*2) {
236 bus
->opc
|= bus
->mdio
& 1;
237 if (bus
->cnt
== 2*2) {
247 bus
->addr
|= bus
->mdio
& 1;
249 if (bus
->cnt
== 5*2) {
259 bus
->req
|= bus
->mdio
& 1;
260 if (bus
->cnt
== 5*2) {
262 bus
->state
= TURNAROUND
;
267 if (bus
->mdc
&& bus
->cnt
== 2*2) {
274 bus
->mdio
= bus
->data
& 1;
282 bus
->mdio
= !!(bus
->data
& (1 << 15));
288 bus
->data
|= bus
->mdio
;
290 if (bus
->cnt
== 16 * 2) {
292 bus
->state
= PREAMBLE
;
304 /* ETRAX-FS Ethernet MAC block starts here. */
306 #define RW_MA0_LO 0x00
307 #define RW_MA0_HI 0x01
308 #define RW_MA1_LO 0x02
309 #define RW_MA1_HI 0x03
310 #define RW_GA_LO 0x04
311 #define RW_GA_HI 0x05
312 #define RW_GEN_CTRL 0x06
313 #define RW_REC_CTRL 0x07
314 #define RW_TR_CTRL 0x08
315 #define RW_CLR_ERR 0x09
316 #define RW_MGM_CTRL 0x0a
318 #define FS_ETH_MAX_REGS 0x17
327 /* Two addrs in the filter. */
328 uint8_t macaddr
[2][6];
329 uint32_t regs
[FS_ETH_MAX_REGS
];
333 struct etraxfs_dma_client
*dma_out
;
337 struct etraxfs_dma_client
*dma_in
;
341 struct qemu_mdio mdio_bus
;
342 unsigned int phyaddr
;
349 static void eth_validate_duplex(struct fs_eth
*eth
)
351 struct qemu_phy
*phy
;
352 unsigned int phy_duplex
;
353 unsigned int mac_duplex
;
356 phy
= eth
->mdio_bus
.devs
[eth
->phyaddr
];
357 phy_duplex
= !!(phy
->read(phy
, 18) & (1 << 11));
358 mac_duplex
= !!(eth
->regs
[RW_REC_CTRL
] & 128);
360 if (mac_duplex
!= phy_duplex
)
363 if (eth
->regs
[RW_GEN_CTRL
] & 1) {
364 if (new_mm
!= eth
->duplex_mismatch
) {
366 printf("HW: WARNING "
367 "ETH duplex mismatch MAC=%d PHY=%d\n",
368 mac_duplex
, phy_duplex
);
370 printf("HW: ETH duplex ok.\n");
372 eth
->duplex_mismatch
= new_mm
;
377 eth_read(void *opaque
, target_phys_addr_t addr
, unsigned int size
)
379 struct fs_eth
*eth
= opaque
;
386 r
= eth
->mdio_bus
.mdio
& 1;
390 D(printf ("%s %x\n", __func__
, addr
* 4));
396 static void eth_update_ma(struct fs_eth
*eth
, int ma
)
407 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
];
408 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 8;
409 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 16;
410 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
] >> 24;
411 eth
->macaddr
[ma
][i
++] = eth
->regs
[reg
+ 1];
412 eth
->macaddr
[ma
][i
] = eth
->regs
[reg
+ 1] >> 8;
414 D(printf("set mac%d=%x.%x.%x.%x.%x.%x\n", ma
,
415 eth
->macaddr
[ma
][0], eth
->macaddr
[ma
][1],
416 eth
->macaddr
[ma
][2], eth
->macaddr
[ma
][3],
417 eth
->macaddr
[ma
][4], eth
->macaddr
[ma
][5]));
421 eth_write(void *opaque
, target_phys_addr_t addr
,
422 uint64_t val64
, unsigned int size
)
424 struct fs_eth
*eth
= opaque
;
425 uint32_t value
= val64
;
432 eth
->regs
[addr
] = value
;
433 eth_update_ma(eth
, 0);
437 eth
->regs
[addr
] = value
;
438 eth_update_ma(eth
, 1);
442 /* Attach an MDIO/PHY abstraction. */
444 eth
->mdio_bus
.mdio
= value
& 1;
445 if (eth
->mdio_bus
.mdc
!= (value
& 4)) {
446 mdio_cycle(ð
->mdio_bus
);
447 eth_validate_duplex(eth
);
449 eth
->mdio_bus
.mdc
= !!(value
& 4);
450 eth
->regs
[addr
] = value
;
454 eth
->regs
[addr
] = value
;
455 eth_validate_duplex(eth
);
459 eth
->regs
[addr
] = value
;
460 D(printf ("%s %x %x\n",
461 __func__
, addr
, value
));
466 /* The ETRAX FS has a groupt address table (GAT) which works like a k=1 bloom
467 filter dropping group addresses we have not joined. The filter has 64
468 bits (m). The has function is a simple nible xor of the group addr. */
469 static int eth_match_groupaddr(struct fs_eth
*eth
, const unsigned char *sa
)
472 int m_individual
= eth
->regs
[RW_REC_CTRL
] & 4;
475 /* First bit on the wire of a MAC address signals multicast or
477 if (!m_individual
&& !(sa
[0] & 1))
480 /* Calculate the hash index for the GA registers. */
483 hsh
^= ((*sa
) >> 6) & 0x03;
485 hsh
^= ((*sa
) << 2) & 0x03c;
486 hsh
^= ((*sa
) >> 4) & 0xf;
488 hsh
^= ((*sa
) << 4) & 0x30;
489 hsh
^= ((*sa
) >> 2) & 0x3f;
492 hsh
^= ((*sa
) >> 6) & 0x03;
494 hsh
^= ((*sa
) << 2) & 0x03c;
495 hsh
^= ((*sa
) >> 4) & 0xf;
497 hsh
^= ((*sa
) << 4) & 0x30;
498 hsh
^= ((*sa
) >> 2) & 0x3f;
502 match
= eth
->regs
[RW_GA_HI
] & (1 << (hsh
- 32));
504 match
= eth
->regs
[RW_GA_LO
] & (1 << hsh
);
505 D(printf("hsh=%x ga=%x.%x mtch=%d\n", hsh
,
506 eth
->regs
[RW_GA_HI
], eth
->regs
[RW_GA_LO
], match
));
510 static int eth_can_receive(VLANClientState
*nc
)
515 static ssize_t
eth_receive(VLANClientState
*nc
, const uint8_t *buf
, size_t size
)
517 unsigned char sa_bcast
[6] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
518 struct fs_eth
*eth
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
519 int use_ma0
= eth
->regs
[RW_REC_CTRL
] & 1;
520 int use_ma1
= eth
->regs
[RW_REC_CTRL
] & 2;
521 int r_bcast
= eth
->regs
[RW_REC_CTRL
] & 8;
526 D(printf("%x.%x.%x.%x.%x.%x ma=%d %d bc=%d\n",
527 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5],
528 use_ma0
, use_ma1
, r_bcast
));
530 /* Does the frame get through the address filters? */
531 if ((!use_ma0
|| memcmp(buf
, eth
->macaddr
[0], 6))
532 && (!use_ma1
|| memcmp(buf
, eth
->macaddr
[1], 6))
533 && (!r_bcast
|| memcmp(buf
, sa_bcast
, 6))
534 && !eth_match_groupaddr(eth
, buf
))
537 /* FIXME: Find another way to pass on the fake csum. */
538 etraxfs_dmac_input(eth
->dma_in
, (void *)buf
, size
+ 4, 1);
543 static int eth_tx_push(void *opaque
, unsigned char *buf
, int len
)
545 struct fs_eth
*eth
= opaque
;
547 D(printf("%s buf=%p len=%d\n", __func__
, buf
, len
));
548 qemu_send_packet(ð
->nic
->nc
, buf
, len
);
552 static void eth_set_link(VLANClientState
*nc
)
554 struct fs_eth
*eth
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
555 D(printf("%s %d\n", __func__
, nc
->link_down
));
556 eth
->phy
.link
= !nc
->link_down
;
559 static const MemoryRegionOps eth_ops
= {
562 .endianness
= DEVICE_LITTLE_ENDIAN
,
564 .min_access_size
= 4,
569 static void eth_cleanup(VLANClientState
*nc
)
571 struct fs_eth
*eth
= DO_UPCAST(NICState
, nc
, nc
)->opaque
;
573 /* Disconnect the client. */
574 eth
->dma_out
->client
.push
= NULL
;
575 eth
->dma_out
->client
.opaque
= NULL
;
576 eth
->dma_in
->client
.opaque
= NULL
;
577 eth
->dma_in
->client
.pull
= NULL
;
581 static NetClientInfo net_etraxfs_info
= {
582 .type
= NET_CLIENT_TYPE_NIC
,
583 .size
= sizeof(NICState
),
584 .can_receive
= eth_can_receive
,
585 .receive
= eth_receive
,
586 .cleanup
= eth_cleanup
,
587 .link_status_changed
= eth_set_link
,
590 static int fs_eth_init(SysBusDevice
*dev
)
592 struct fs_eth
*s
= FROM_SYSBUS(typeof(*s
), dev
);
594 if (!s
->dma_out
|| !s
->dma_in
) {
595 hw_error("Unconnected ETRAX-FS Ethernet MAC.\n");
598 s
->dma_out
->client
.push
= eth_tx_push
;
599 s
->dma_out
->client
.opaque
= s
;
600 s
->dma_in
->client
.opaque
= s
;
601 s
->dma_in
->client
.pull
= NULL
;
603 memory_region_init_io(&s
->mmio
, ð_ops
, s
, "etraxfs-eth", 0x5c);
604 sysbus_init_mmio(dev
, &s
->mmio
);
606 qemu_macaddr_default_if_unset(&s
->conf
.macaddr
);
607 s
->nic
= qemu_new_nic(&net_etraxfs_info
, &s
->conf
,
608 dev
->qdev
.info
->name
, dev
->qdev
.id
, s
);
609 qemu_format_nic_info_str(&s
->nic
->nc
, s
->conf
.macaddr
.a
);
612 mdio_attach(&s
->mdio_bus
, &s
->phy
, s
->phyaddr
);
616 static SysBusDeviceInfo etraxfs_eth_info
= {
618 .qdev
.name
= "etraxfs-eth",
619 .qdev
.size
= sizeof(struct fs_eth
),
620 .qdev
.props
= (Property
[]) {
621 DEFINE_PROP_UINT32("phyaddr", struct fs_eth
, phyaddr
, 1),
622 DEFINE_PROP_PTR("dma_out", struct fs_eth
, vdma_out
),
623 DEFINE_PROP_PTR("dma_in", struct fs_eth
, vdma_in
),
624 DEFINE_NIC_PROPERTIES(struct fs_eth
, conf
),
625 DEFINE_PROP_END_OF_LIST(),
629 static void etraxfs_eth_register(void)
631 sysbus_register_withprop(&etraxfs_eth_info
);
634 device_init(etraxfs_eth_register
)