2 * (C) Copyright 2007-2009 Michal Simek
3 * (C) Copyright 2003 Xilinx Inc.
5 * Michal SIMEK <monstr@monstr.eu>
7 * SPDX-License-Identifier: GPL-2.0+
19 #include <asm-generic/errno.h>
23 #define ENET_ADDR_LENGTH 6
25 /* EmacLite constants */
26 #define XEL_BUFFER_OFFSET 0x0800 /* Next buffer's offset */
27 #define XEL_TPLR_OFFSET 0x07F4 /* Tx packet length */
28 #define XEL_TSR_OFFSET 0x07FC /* Tx status */
29 #define XEL_RSR_OFFSET 0x17FC /* Rx status */
30 #define XEL_RXBUFF_OFFSET 0x1000 /* Receive Buffer */
33 #define XEL_TSR_XMIT_BUSY_MASK 0x00000001UL
34 /* Xmit interrupt enable bit */
35 #define XEL_TSR_XMIT_IE_MASK 0x00000008UL
36 /* Buffer is active, SW bit only */
37 #define XEL_TSR_XMIT_ACTIVE_MASK 0x80000000UL
38 /* Program the MAC address */
39 #define XEL_TSR_PROGRAM_MASK 0x00000002UL
40 /* define for programming the MAC address into the EMAC Lite */
41 #define XEL_TSR_PROG_MAC_ADDR (XEL_TSR_XMIT_BUSY_MASK | XEL_TSR_PROGRAM_MASK)
43 /* Transmit packet length upper byte */
44 #define XEL_TPLR_LENGTH_MASK_HI 0x0000FF00UL
45 /* Transmit packet length lower byte */
46 #define XEL_TPLR_LENGTH_MASK_LO 0x000000FFUL
49 #define XEL_RSR_RECV_DONE_MASK 0x00000001UL
50 /* Recv interrupt enable bit */
51 #define XEL_RSR_RECV_IE_MASK 0x00000008UL
53 /* MDIO Address Register Bit Masks */
54 #define XEL_MDIOADDR_REGADR_MASK 0x0000001F /* Register Address */
55 #define XEL_MDIOADDR_PHYADR_MASK 0x000003E0 /* PHY Address */
56 #define XEL_MDIOADDR_PHYADR_SHIFT 5
57 #define XEL_MDIOADDR_OP_MASK 0x00000400 /* RD/WR Operation */
59 /* MDIO Write Data Register Bit Masks */
60 #define XEL_MDIOWR_WRDATA_MASK 0x0000FFFF /* Data to be Written */
62 /* MDIO Read Data Register Bit Masks */
63 #define XEL_MDIORD_RDDATA_MASK 0x0000FFFF /* Data to be Read */
65 /* MDIO Control Register Bit Masks */
66 #define XEL_MDIOCTRL_MDIOSTS_MASK 0x00000001 /* MDIO Status Mask */
67 #define XEL_MDIOCTRL_MDIOEN_MASK 0x00000008 /* MDIO Enable */
69 struct emaclite_regs {
70 u32 tx_ping; /* 0x0 - TX Ping buffer */
72 u32 mdioaddr; /* 0x7e4 - MDIO Address Register */
73 u32 mdiowr; /* 0x7e8 - MDIO Write Data Register */
74 u32 mdiord;/* 0x7ec - MDIO Read Data Register */
75 u32 mdioctrl; /* 0x7f0 - MDIO Control Register */
76 u32 tx_ping_tplr; /* 0x7f4 - Tx packet length */
77 u32 global_interrupt; /* 0x7f8 - Global interrupt enable */
78 u32 tx_ping_tsr; /* 0x7fc - Tx status */
79 u32 tx_pong; /* 0x800 - TX Pong buffer */
81 u32 tx_pong_tplr; /* 0xff4 - Tx packet length */
82 u32 reserved3; /* 0xff8 */
83 u32 tx_pong_tsr; /* 0xffc - Tx status */
84 u32 rx_ping; /* 0x1000 - Receive Buffer */
86 u32 rx_ping_rsr; /* 0x17fc - Rx status */
87 u32 rx_pong; /* 0x1800 - Receive Buffer */
89 u32 rx_pong_rsr; /* 0x1ffc - Rx status */
93 u32 nexttxbuffertouse; /* Next TX buffer to write to */
94 u32 nextrxbuffertouse; /* Next RX buffer to read from */
95 u32 txpp; /* TX ping pong buffer */
96 u32 rxpp; /* RX ping pong buffer */
98 struct emaclite_regs *regs;
99 struct phy_device *phydev;
103 static u32 etherrxbuff[PKTSIZE_ALIGN/4]; /* Receive buffer */
105 static void xemaclite_alignedread(u32 *srcptr, void *destptr, u32 bytecount)
114 from32ptr = (u32 *) srcptr;
116 /* Word aligned buffer, no correction needed. */
117 to32ptr = (u32 *) destptr;
118 while (bytecount > 3) {
119 *to32ptr++ = *from32ptr++;
122 to8ptr = (u8 *) to32ptr;
124 alignbuffer = *from32ptr++;
125 from8ptr = (u8 *) &alignbuffer;
127 for (i = 0; i < bytecount; i++)
128 *to8ptr++ = *from8ptr++;
131 static void xemaclite_alignedwrite(void *srcptr, u32 destptr, u32 bytecount)
135 u32 *to32ptr = (u32 *) destptr;
140 from32ptr = (u32 *) srcptr;
141 while (bytecount > 3) {
143 *to32ptr++ = *from32ptr++;
148 to8ptr = (u8 *) &alignbuffer;
149 from8ptr = (u8 *) from32ptr;
151 for (i = 0; i < bytecount; i++)
152 *to8ptr++ = *from8ptr++;
154 *to32ptr++ = alignbuffer;
157 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
158 static int wait_for_bit(const char *func, u32 *reg, const u32 mask,
159 bool set, unsigned int timeout)
162 unsigned long start = get_timer(0);
170 if ((val & mask) == mask)
173 if (get_timer(start) > timeout)
184 debug("%s: Timeout (reg=%p mask=%08x wait_set=%i)\n",
185 func, reg, mask, set);
190 static int mdio_wait(struct emaclite_regs *regs)
192 return wait_for_bit(__func__, ®s->mdioctrl,
193 XEL_MDIOCTRL_MDIOSTS_MASK, false, 2000);
196 static u32 phyread(struct xemaclite *emaclite, u32 phyaddress, u32 registernum,
199 struct emaclite_regs *regs = emaclite->regs;
204 u32 ctrl_reg = in_be32(®s->mdioctrl);
205 out_be32(®s->mdioaddr, XEL_MDIOADDR_OP_MASK |
206 ((phyaddress << XEL_MDIOADDR_PHYADR_SHIFT) | registernum));
207 out_be32(®s->mdioctrl, ctrl_reg | XEL_MDIOCTRL_MDIOSTS_MASK);
213 *data = in_be32(®s->mdiord);
217 static u32 phywrite(struct xemaclite *emaclite, u32 phyaddress, u32 registernum,
220 struct emaclite_regs *regs = emaclite->regs;
226 * Write the PHY address, register number and clear the OP bit in the
227 * MDIO Address register and then write the value into the MDIO Write
228 * Data register. Finally, set the Status bit in the MDIO Control
229 * register to start a MDIO write transaction.
231 u32 ctrl_reg = in_be32(®s->mdioctrl);
232 out_be32(®s->mdioaddr, ~XEL_MDIOADDR_OP_MASK &
233 ((phyaddress << XEL_MDIOADDR_PHYADR_SHIFT) | registernum));
234 out_be32(®s->mdiowr, data);
235 out_be32(®s->mdioctrl, ctrl_reg | XEL_MDIOCTRL_MDIOSTS_MASK);
244 static void emaclite_halt(struct eth_device *dev)
249 /* Use MII register 1 (MII status register) to detect PHY */
250 #define PHY_DETECT_REG 1
252 /* Mask used to verify certain PHY features (or register contents)
253 * in the register above:
254 * 0x1000: 10Mbps full duplex support
255 * 0x0800: 10Mbps half duplex support
256 * 0x0008: Auto-negotiation support
258 #define PHY_DETECT_MASK 0x1808
260 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
261 static int setup_phy(struct eth_device *dev)
265 struct xemaclite *emaclite = dev->priv;
266 struct phy_device *phydev;
268 u32 supported = SUPPORTED_10baseT_Half |
269 SUPPORTED_10baseT_Full |
270 SUPPORTED_100baseT_Half |
271 SUPPORTED_100baseT_Full;
273 if (emaclite->phyaddr != -1) {
274 phyread(emaclite, emaclite->phyaddr, PHY_DETECT_REG, &phyreg);
275 if ((phyreg != 0xFFFF) &&
276 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
277 /* Found a valid PHY address */
278 debug("Default phy address %d is valid\n",
281 debug("PHY address is not setup correctly %d\n",
283 emaclite->phyaddr = -1;
287 if (emaclite->phyaddr == -1) {
288 /* detect the PHY address */
289 for (i = 31; i >= 0; i--) {
290 phyread(emaclite, i, PHY_DETECT_REG, &phyreg);
291 if ((phyreg != 0xFFFF) &&
292 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
293 /* Found a valid PHY address */
294 emaclite->phyaddr = i;
295 debug("emaclite: Found valid phy address, %d\n",
302 /* interface - look at tsec */
303 phydev = phy_connect(emaclite->bus, emaclite->phyaddr, dev,
304 PHY_INTERFACE_MODE_MII);
306 * Phy can support 1000baseT but device NOT that's why phydev->supported
307 * must be setup for 1000baseT. phydev->advertising setups what speeds
308 * will be used for autonegotiation where 1000baseT must be disabled.
310 phydev->supported = supported | SUPPORTED_1000baseT_Half |
311 SUPPORTED_1000baseT_Full;
312 phydev->advertising = supported;
313 emaclite->phydev = phydev;
318 printf("%s: No link.\n", phydev->dev->name);
322 /* Do not setup anything */
327 static int emaclite_init(struct eth_device *dev, bd_t *bis)
329 struct xemaclite *emaclite = dev->priv;
330 struct emaclite_regs *regs = emaclite->regs;
332 debug("EmacLite Initialization Started\n");
335 * TX - TX_PING & TX_PONG initialization
337 /* Restart PING TX */
338 out_be32(®s->tx_ping_tsr, 0);
339 /* Copy MAC address */
340 xemaclite_alignedwrite(dev->enetaddr, (u32)®s->tx_ping,
343 out_be32(®s->tx_ping_tplr, ENET_ADDR_LENGTH);
344 /* Update the MAC address in the EMAC Lite */
345 out_be32(®s->tx_ping_tsr, XEL_TSR_PROG_MAC_ADDR);
346 /* Wait for EMAC Lite to finish with the MAC address update */
347 while ((in_be32 (®s->tx_ping_tsr) &
348 XEL_TSR_PROG_MAC_ADDR) != 0)
351 if (emaclite->txpp) {
352 /* The same operation with PONG TX */
353 out_be32(®s->tx_pong_tsr, 0);
354 xemaclite_alignedwrite(dev->enetaddr, (u32)®s->tx_pong,
356 out_be32(®s->tx_pong_tplr, ENET_ADDR_LENGTH);
357 out_be32(®s->tx_pong_tsr, XEL_TSR_PROG_MAC_ADDR);
358 while ((in_be32(®s->tx_pong_tsr) &
359 XEL_TSR_PROG_MAC_ADDR) != 0)
364 * RX - RX_PING & RX_PONG initialization
366 /* Write out the value to flush the RX buffer */
367 out_be32(®s->rx_ping_rsr, XEL_RSR_RECV_IE_MASK);
370 out_be32(®s->rx_pong_rsr, XEL_RSR_RECV_IE_MASK);
372 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
373 out_be32(®s->mdioctrl, XEL_MDIOCTRL_MDIOEN_MASK);
374 if (in_be32(®s->mdioctrl) & XEL_MDIOCTRL_MDIOEN_MASK)
378 debug("EmacLite Initialization complete\n");
382 static int xemaclite_txbufferavailable(struct eth_device *dev)
387 struct xemaclite *emaclite = dev->priv;
390 * Read the other buffer register
391 * and determine if the other buffer is available
393 reg = in_be32 (dev->iobase +
394 emaclite->nexttxbuffertouse + 0);
395 txpingbusy = ((reg & XEL_TSR_XMIT_BUSY_MASK) ==
396 XEL_TSR_XMIT_BUSY_MASK);
398 reg = in_be32 (dev->iobase +
399 (emaclite->nexttxbuffertouse ^ XEL_TSR_OFFSET) + 0);
400 txpongbusy = ((reg & XEL_TSR_XMIT_BUSY_MASK) ==
401 XEL_TSR_XMIT_BUSY_MASK);
403 return !(txpingbusy && txpongbusy);
406 static int emaclite_send(struct eth_device *dev, void *ptr, int len)
410 struct xemaclite *emaclite = dev->priv;
417 while (!xemaclite_txbufferavailable(dev) && maxtry) {
423 printf("Error: Timeout waiting for ethernet TX buffer\n");
424 /* Restart PING TX */
425 out_be32 (dev->iobase + XEL_TSR_OFFSET, 0);
426 if (emaclite->txpp) {
427 out_be32 (dev->iobase + XEL_TSR_OFFSET +
428 XEL_BUFFER_OFFSET, 0);
433 /* Determine the expected TX buffer address */
434 baseaddress = (dev->iobase + emaclite->nexttxbuffertouse);
436 /* Determine if the expected buffer address is empty */
437 reg = in_be32 (baseaddress + XEL_TSR_OFFSET);
438 if (((reg & XEL_TSR_XMIT_BUSY_MASK) == 0)
439 && ((in_be32 ((baseaddress) + XEL_TSR_OFFSET)
440 & XEL_TSR_XMIT_ACTIVE_MASK) == 0)) {
443 emaclite->nexttxbuffertouse ^= XEL_BUFFER_OFFSET;
445 debug("Send packet from 0x%x\n", baseaddress);
446 /* Write the frame to the buffer */
447 xemaclite_alignedwrite(ptr, baseaddress, len);
448 out_be32 (baseaddress + XEL_TPLR_OFFSET,(len &
449 (XEL_TPLR_LENGTH_MASK_HI | XEL_TPLR_LENGTH_MASK_LO)));
450 reg = in_be32 (baseaddress + XEL_TSR_OFFSET);
451 reg |= XEL_TSR_XMIT_BUSY_MASK;
452 if ((reg & XEL_TSR_XMIT_IE_MASK) != 0)
453 reg |= XEL_TSR_XMIT_ACTIVE_MASK;
454 out_be32 (baseaddress + XEL_TSR_OFFSET, reg);
458 if (emaclite->txpp) {
459 /* Switch to second buffer */
460 baseaddress ^= XEL_BUFFER_OFFSET;
461 /* Determine if the expected buffer address is empty */
462 reg = in_be32 (baseaddress + XEL_TSR_OFFSET);
463 if (((reg & XEL_TSR_XMIT_BUSY_MASK) == 0)
464 && ((in_be32 ((baseaddress) + XEL_TSR_OFFSET)
465 & XEL_TSR_XMIT_ACTIVE_MASK) == 0)) {
466 debug("Send packet from 0x%x\n", baseaddress);
467 /* Write the frame to the buffer */
468 xemaclite_alignedwrite(ptr, baseaddress, len);
469 out_be32 (baseaddress + XEL_TPLR_OFFSET, (len &
470 (XEL_TPLR_LENGTH_MASK_HI |
471 XEL_TPLR_LENGTH_MASK_LO)));
472 reg = in_be32 (baseaddress + XEL_TSR_OFFSET);
473 reg |= XEL_TSR_XMIT_BUSY_MASK;
474 if ((reg & XEL_TSR_XMIT_IE_MASK) != 0)
475 reg |= XEL_TSR_XMIT_ACTIVE_MASK;
476 out_be32 (baseaddress + XEL_TSR_OFFSET, reg);
481 puts("Error while sending frame\n");
485 static int emaclite_recv(struct eth_device *dev)
490 struct xemaclite *emaclite = dev->priv;
492 baseaddress = dev->iobase + emaclite->nextrxbuffertouse;
493 reg = in_be32 (baseaddress + XEL_RSR_OFFSET);
494 debug("Testing data at address 0x%x\n", baseaddress);
495 if ((reg & XEL_RSR_RECV_DONE_MASK) == XEL_RSR_RECV_DONE_MASK) {
497 emaclite->nextrxbuffertouse ^= XEL_BUFFER_OFFSET;
500 if (!emaclite->rxpp) {
501 debug("No data was available - address 0x%x\n",
505 baseaddress ^= XEL_BUFFER_OFFSET;
506 reg = in_be32 (baseaddress + XEL_RSR_OFFSET);
507 if ((reg & XEL_RSR_RECV_DONE_MASK) !=
508 XEL_RSR_RECV_DONE_MASK) {
509 debug("No data was available - address 0x%x\n",
515 /* Get the length of the frame that arrived */
516 switch(((ntohl(in_be32 (baseaddress + XEL_RXBUFF_OFFSET + 0xC))) &
517 0xFFFF0000 ) >> 16) {
519 length = 42 + 20; /* FIXME size of ARP */
520 debug("ARP Packet\n");
524 (((ntohl(in_be32 (baseaddress + XEL_RXBUFF_OFFSET +
525 0x10))) & 0xFFFF0000) >> 16);
526 /* FIXME size of IP packet */
527 debug ("IP Packet\n");
530 debug("Other Packet\n");
535 xemaclite_alignedread((u32 *) (baseaddress + XEL_RXBUFF_OFFSET),
536 etherrxbuff, length);
538 /* Acknowledge the frame */
539 reg = in_be32 (baseaddress + XEL_RSR_OFFSET);
540 reg &= ~XEL_RSR_RECV_DONE_MASK;
541 out_be32 (baseaddress + XEL_RSR_OFFSET, reg);
543 debug("Packet receive from 0x%x, length %dB\n", baseaddress, length);
544 net_process_received_packet((uchar *)etherrxbuff, length);
549 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
550 static int emaclite_miiphy_read(const char *devname, uchar addr,
551 uchar reg, ushort *val)
554 struct eth_device *dev = eth_get_dev();
556 ret = phyread(dev->priv, addr, reg, val);
557 debug("emaclite: Read MII 0x%x, 0x%x, 0x%x\n", addr, reg, *val);
561 static int emaclite_miiphy_write(const char *devname, uchar addr,
562 uchar reg, ushort val)
564 struct eth_device *dev = eth_get_dev();
566 debug("emaclite: Write MII 0x%x, 0x%x, 0x%x\n", addr, reg, val);
567 return phywrite(dev->priv, addr, reg, val);
571 int xilinx_emaclite_initialize(bd_t *bis, unsigned long base_addr,
574 struct eth_device *dev;
575 struct xemaclite *emaclite;
576 struct emaclite_regs *regs;
578 dev = calloc(1, sizeof(*dev));
582 emaclite = calloc(1, sizeof(struct xemaclite));
583 if (emaclite == NULL) {
588 dev->priv = emaclite;
590 emaclite->txpp = txpp;
591 emaclite->rxpp = rxpp;
593 sprintf(dev->name, "Xelite.%lx", base_addr);
595 emaclite->regs = (struct emaclite_regs *)base_addr;
596 regs = emaclite->regs;
597 dev->iobase = base_addr;
598 dev->init = emaclite_init;
599 dev->halt = emaclite_halt;
600 dev->send = emaclite_send;
601 dev->recv = emaclite_recv;
603 #ifdef CONFIG_PHY_ADDR
604 emaclite->phyaddr = CONFIG_PHY_ADDR;
606 emaclite->phyaddr = -1;
611 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
612 miiphy_register(dev->name, emaclite_miiphy_read, emaclite_miiphy_write);
613 emaclite->bus = miiphy_get_dev_by_name(dev->name);
615 out_be32(®s->mdioctrl, XEL_MDIOCTRL_MDIOEN_MASK);