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>
20 #include <linux/kernel.h>
24 #define ENET_ADDR_LENGTH 6
25 #define ETH_FCS_LEN 4 /* Octets in the FCS */
28 #define XEL_TSR_XMIT_BUSY_MASK 0x00000001UL
29 /* Xmit interrupt enable bit */
30 #define XEL_TSR_XMIT_IE_MASK 0x00000008UL
31 /* Program the MAC address */
32 #define XEL_TSR_PROGRAM_MASK 0x00000002UL
33 /* define for programming the MAC address into the EMAC Lite */
34 #define XEL_TSR_PROG_MAC_ADDR (XEL_TSR_XMIT_BUSY_MASK | XEL_TSR_PROGRAM_MASK)
36 /* Transmit packet length upper byte */
37 #define XEL_TPLR_LENGTH_MASK_HI 0x0000FF00UL
38 /* Transmit packet length lower byte */
39 #define XEL_TPLR_LENGTH_MASK_LO 0x000000FFUL
42 #define XEL_RSR_RECV_DONE_MASK 0x00000001UL
43 /* Recv interrupt enable bit */
44 #define XEL_RSR_RECV_IE_MASK 0x00000008UL
46 /* MDIO Address Register Bit Masks */
47 #define XEL_MDIOADDR_REGADR_MASK 0x0000001F /* Register Address */
48 #define XEL_MDIOADDR_PHYADR_MASK 0x000003E0 /* PHY Address */
49 #define XEL_MDIOADDR_PHYADR_SHIFT 5
50 #define XEL_MDIOADDR_OP_MASK 0x00000400 /* RD/WR Operation */
52 /* MDIO Write Data Register Bit Masks */
53 #define XEL_MDIOWR_WRDATA_MASK 0x0000FFFF /* Data to be Written */
55 /* MDIO Read Data Register Bit Masks */
56 #define XEL_MDIORD_RDDATA_MASK 0x0000FFFF /* Data to be Read */
58 /* MDIO Control Register Bit Masks */
59 #define XEL_MDIOCTRL_MDIOSTS_MASK 0x00000001 /* MDIO Status Mask */
60 #define XEL_MDIOCTRL_MDIOEN_MASK 0x00000008 /* MDIO Enable */
62 struct emaclite_regs {
63 u32 tx_ping; /* 0x0 - TX Ping buffer */
65 u32 mdioaddr; /* 0x7e4 - MDIO Address Register */
66 u32 mdiowr; /* 0x7e8 - MDIO Write Data Register */
67 u32 mdiord;/* 0x7ec - MDIO Read Data Register */
68 u32 mdioctrl; /* 0x7f0 - MDIO Control Register */
69 u32 tx_ping_tplr; /* 0x7f4 - Tx packet length */
70 u32 global_interrupt; /* 0x7f8 - Global interrupt enable */
71 u32 tx_ping_tsr; /* 0x7fc - Tx status */
72 u32 tx_pong; /* 0x800 - TX Pong buffer */
74 u32 tx_pong_tplr; /* 0xff4 - Tx packet length */
75 u32 reserved3; /* 0xff8 */
76 u32 tx_pong_tsr; /* 0xffc - Tx status */
77 u32 rx_ping; /* 0x1000 - Receive Buffer */
79 u32 rx_ping_rsr; /* 0x17fc - Rx status */
80 u32 rx_pong; /* 0x1800 - Receive Buffer */
82 u32 rx_pong_rsr; /* 0x1ffc - Rx status */
86 bool use_rx_pong_buffer_next; /* Next RX buffer to read from */
87 u32 txpp; /* TX ping pong buffer */
88 u32 rxpp; /* RX ping pong buffer */
90 struct emaclite_regs *regs;
91 struct phy_device *phydev;
95 static u32 etherrxbuff[PKTSIZE_ALIGN/4]; /* Receive buffer */
97 static void xemaclite_alignedread(u32 *srcptr, void *destptr, u32 bytecount)
106 from32ptr = (u32 *) srcptr;
108 /* Word aligned buffer, no correction needed. */
109 to32ptr = (u32 *) destptr;
110 while (bytecount > 3) {
111 *to32ptr++ = *from32ptr++;
114 to8ptr = (u8 *) to32ptr;
116 alignbuffer = *from32ptr++;
117 from8ptr = (u8 *) &alignbuffer;
119 for (i = 0; i < bytecount; i++)
120 *to8ptr++ = *from8ptr++;
123 static void xemaclite_alignedwrite(void *srcptr, u32 *destptr, u32 bytecount)
127 u32 *to32ptr = (u32 *) destptr;
132 from32ptr = (u32 *) srcptr;
133 while (bytecount > 3) {
135 *to32ptr++ = *from32ptr++;
140 to8ptr = (u8 *) &alignbuffer;
141 from8ptr = (u8 *) from32ptr;
143 for (i = 0; i < bytecount; i++)
144 *to8ptr++ = *from8ptr++;
146 *to32ptr++ = alignbuffer;
149 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
150 static int wait_for_bit(const char *func, u32 *reg, const u32 mask,
151 bool set, unsigned int timeout)
154 unsigned long start = get_timer(0);
162 if ((val & mask) == mask)
165 if (get_timer(start) > timeout)
176 debug("%s: Timeout (reg=%p mask=%08x wait_set=%i)\n",
177 func, reg, mask, set);
182 static int mdio_wait(struct emaclite_regs *regs)
184 return wait_for_bit(__func__, ®s->mdioctrl,
185 XEL_MDIOCTRL_MDIOSTS_MASK, false, 2000);
188 static u32 phyread(struct xemaclite *emaclite, u32 phyaddress, u32 registernum,
191 struct emaclite_regs *regs = emaclite->regs;
196 u32 ctrl_reg = in_be32(®s->mdioctrl);
197 out_be32(®s->mdioaddr, XEL_MDIOADDR_OP_MASK |
198 ((phyaddress << XEL_MDIOADDR_PHYADR_SHIFT) | registernum));
199 out_be32(®s->mdioctrl, ctrl_reg | XEL_MDIOCTRL_MDIOSTS_MASK);
205 *data = in_be32(®s->mdiord);
209 static u32 phywrite(struct xemaclite *emaclite, u32 phyaddress, u32 registernum,
212 struct emaclite_regs *regs = emaclite->regs;
218 * Write the PHY address, register number and clear the OP bit in the
219 * MDIO Address register and then write the value into the MDIO Write
220 * Data register. Finally, set the Status bit in the MDIO Control
221 * register to start a MDIO write transaction.
223 u32 ctrl_reg = in_be32(®s->mdioctrl);
224 out_be32(®s->mdioaddr, ~XEL_MDIOADDR_OP_MASK &
225 ((phyaddress << XEL_MDIOADDR_PHYADR_SHIFT) | registernum));
226 out_be32(®s->mdiowr, data);
227 out_be32(®s->mdioctrl, ctrl_reg | XEL_MDIOCTRL_MDIOSTS_MASK);
236 static void emaclite_halt(struct eth_device *dev)
241 /* Use MII register 1 (MII status register) to detect PHY */
242 #define PHY_DETECT_REG 1
244 /* Mask used to verify certain PHY features (or register contents)
245 * in the register above:
246 * 0x1000: 10Mbps full duplex support
247 * 0x0800: 10Mbps half duplex support
248 * 0x0008: Auto-negotiation support
250 #define PHY_DETECT_MASK 0x1808
252 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
253 static int setup_phy(struct eth_device *dev)
257 struct xemaclite *emaclite = dev->priv;
258 struct phy_device *phydev;
260 u32 supported = SUPPORTED_10baseT_Half |
261 SUPPORTED_10baseT_Full |
262 SUPPORTED_100baseT_Half |
263 SUPPORTED_100baseT_Full;
265 if (emaclite->phyaddr != -1) {
266 phyread(emaclite, emaclite->phyaddr, PHY_DETECT_REG, &phyreg);
267 if ((phyreg != 0xFFFF) &&
268 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
269 /* Found a valid PHY address */
270 debug("Default phy address %d is valid\n",
273 debug("PHY address is not setup correctly %d\n",
275 emaclite->phyaddr = -1;
279 if (emaclite->phyaddr == -1) {
280 /* detect the PHY address */
281 for (i = 31; i >= 0; i--) {
282 phyread(emaclite, i, PHY_DETECT_REG, &phyreg);
283 if ((phyreg != 0xFFFF) &&
284 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
285 /* Found a valid PHY address */
286 emaclite->phyaddr = i;
287 debug("emaclite: Found valid phy address, %d\n",
294 /* interface - look at tsec */
295 phydev = phy_connect(emaclite->bus, emaclite->phyaddr, dev,
296 PHY_INTERFACE_MODE_MII);
298 * Phy can support 1000baseT but device NOT that's why phydev->supported
299 * must be setup for 1000baseT. phydev->advertising setups what speeds
300 * will be used for autonegotiation where 1000baseT must be disabled.
302 phydev->supported = supported | SUPPORTED_1000baseT_Half |
303 SUPPORTED_1000baseT_Full;
304 phydev->advertising = supported;
305 emaclite->phydev = phydev;
310 printf("%s: No link.\n", phydev->dev->name);
314 /* Do not setup anything */
319 static int emaclite_init(struct eth_device *dev, bd_t *bis)
321 struct xemaclite *emaclite = dev->priv;
322 struct emaclite_regs *regs = emaclite->regs;
324 debug("EmacLite Initialization Started\n");
327 * TX - TX_PING & TX_PONG initialization
329 /* Restart PING TX */
330 out_be32(®s->tx_ping_tsr, 0);
331 /* Copy MAC address */
332 xemaclite_alignedwrite(dev->enetaddr, ®s->tx_ping,
335 out_be32(®s->tx_ping_tplr, ENET_ADDR_LENGTH);
336 /* Update the MAC address in the EMAC Lite */
337 out_be32(®s->tx_ping_tsr, XEL_TSR_PROG_MAC_ADDR);
338 /* Wait for EMAC Lite to finish with the MAC address update */
339 while ((in_be32 (®s->tx_ping_tsr) &
340 XEL_TSR_PROG_MAC_ADDR) != 0)
343 if (emaclite->txpp) {
344 /* The same operation with PONG TX */
345 out_be32(®s->tx_pong_tsr, 0);
346 xemaclite_alignedwrite(dev->enetaddr, ®s->tx_pong,
348 out_be32(®s->tx_pong_tplr, ENET_ADDR_LENGTH);
349 out_be32(®s->tx_pong_tsr, XEL_TSR_PROG_MAC_ADDR);
350 while ((in_be32(®s->tx_pong_tsr) &
351 XEL_TSR_PROG_MAC_ADDR) != 0)
356 * RX - RX_PING & RX_PONG initialization
358 /* Write out the value to flush the RX buffer */
359 out_be32(®s->rx_ping_rsr, XEL_RSR_RECV_IE_MASK);
362 out_be32(®s->rx_pong_rsr, XEL_RSR_RECV_IE_MASK);
364 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
365 out_be32(®s->mdioctrl, XEL_MDIOCTRL_MDIOEN_MASK);
366 if (in_be32(®s->mdioctrl) & XEL_MDIOCTRL_MDIOEN_MASK)
370 debug("EmacLite Initialization complete\n");
374 static int xemaclite_txbufferavailable(struct xemaclite *emaclite)
377 struct emaclite_regs *regs = emaclite->regs;
380 * Read the other buffer register
381 * and determine if the other buffer is available
383 tmp = ~in_be32(®s->tx_ping_tsr);
385 tmp |= ~in_be32(®s->tx_pong_tsr);
387 return !(tmp & XEL_TSR_XMIT_BUSY_MASK);
390 static int emaclite_send(struct eth_device *dev, void *ptr, int len)
393 struct xemaclite *emaclite = dev->priv;
394 struct emaclite_regs *regs = emaclite->regs;
401 while (xemaclite_txbufferavailable(emaclite) && maxtry) {
407 printf("Error: Timeout waiting for ethernet TX buffer\n");
408 /* Restart PING TX */
409 out_be32(®s->tx_ping_tsr, 0);
410 if (emaclite->txpp) {
411 out_be32(®s->tx_pong_tsr, 0);
416 /* Determine if the expected buffer address is empty */
417 reg = in_be32(®s->tx_ping_tsr);
418 if ((reg & XEL_TSR_XMIT_BUSY_MASK) == 0) {
419 debug("Send packet from tx_ping buffer\n");
420 /* Write the frame to the buffer */
421 xemaclite_alignedwrite(ptr, ®s->tx_ping, len);
422 out_be32(®s->tx_ping_tplr, len &
423 (XEL_TPLR_LENGTH_MASK_HI | XEL_TPLR_LENGTH_MASK_LO));
424 reg = in_be32(®s->tx_ping_tsr);
425 reg |= XEL_TSR_XMIT_BUSY_MASK;
426 out_be32(®s->tx_ping_tsr, reg);
430 if (emaclite->txpp) {
431 /* Determine if the expected buffer address is empty */
432 reg = in_be32(®s->tx_pong_tsr);
433 if ((reg & XEL_TSR_XMIT_BUSY_MASK) == 0) {
434 debug("Send packet from tx_pong buffer\n");
435 /* Write the frame to the buffer */
436 xemaclite_alignedwrite(ptr, ®s->tx_pong, len);
437 out_be32(®s->tx_pong_tplr, len &
438 (XEL_TPLR_LENGTH_MASK_HI |
439 XEL_TPLR_LENGTH_MASK_LO));
440 reg = in_be32(®s->tx_pong_tsr);
441 reg |= XEL_TSR_XMIT_BUSY_MASK;
442 out_be32(®s->tx_pong_tsr, reg);
447 puts("Error while sending frame\n");
451 static int emaclite_recv(struct eth_device *dev)
453 u32 length, first_read, reg, attempt = 0;
455 struct xemaclite *emaclite = dev->priv;
456 struct emaclite_regs *regs = emaclite->regs;
457 struct ethernet_hdr *eth;
458 struct ip_udp_hdr *ip;
461 if (!emaclite->use_rx_pong_buffer_next) {
462 reg = in_be32(®s->rx_ping_rsr);
463 debug("Testing data at rx_ping\n");
464 if ((reg & XEL_RSR_RECV_DONE_MASK) == XEL_RSR_RECV_DONE_MASK) {
465 debug("Data found in rx_ping buffer\n");
466 addr = ®s->rx_ping;
467 ack = ®s->rx_ping_rsr;
469 debug("Data not found in rx_ping buffer\n");
470 /* Pong buffer is not available - return immediately */
474 /* Try pong buffer if this is first attempt */
477 emaclite->use_rx_pong_buffer_next =
478 !emaclite->use_rx_pong_buffer_next;
482 reg = in_be32(®s->rx_pong_rsr);
483 debug("Testing data at rx_pong\n");
484 if ((reg & XEL_RSR_RECV_DONE_MASK) == XEL_RSR_RECV_DONE_MASK) {
485 debug("Data found in rx_pong buffer\n");
486 addr = ®s->rx_pong;
487 ack = ®s->rx_pong_rsr;
489 debug("Data not found in rx_pong buffer\n");
490 /* Try ping buffer if this is first attempt */
493 emaclite->use_rx_pong_buffer_next =
494 !emaclite->use_rx_pong_buffer_next;
499 /* Read all bytes for ARP packet with 32bit alignment - 48bytes */
500 first_read = ALIGN(ETHER_HDR_SIZE + ARP_HDR_SIZE + ETH_FCS_LEN, 4);
501 xemaclite_alignedread(addr, etherrxbuff, first_read);
503 /* Detect real packet size */
504 eth = (struct ethernet_hdr *)etherrxbuff;
505 switch (ntohs(eth->et_protlen)) {
508 debug("ARP Packet %x\n", length);
511 ip = (struct ip_udp_hdr *)(etherrxbuff + ETHER_HDR_SIZE);
512 length = ntohs(ip->ip_len);
513 length += ETHER_HDR_SIZE + ETH_FCS_LEN;
514 debug("IP Packet %x\n", length);
517 debug("Other Packet\n");
522 /* Read the rest of the packet which is longer then first read */
523 if (length != first_read)
524 xemaclite_alignedread(addr + first_read,
525 etherrxbuff + first_read,
526 length - first_read);
528 /* Acknowledge the frame */
530 reg &= ~XEL_RSR_RECV_DONE_MASK;
533 debug("Packet receive from 0x%p, length %dB\n", addr, length);
534 net_process_received_packet((uchar *)etherrxbuff, length);
539 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
540 static int emaclite_miiphy_read(const char *devname, uchar addr,
541 uchar reg, ushort *val)
544 struct eth_device *dev = eth_get_dev();
546 ret = phyread(dev->priv, addr, reg, val);
547 debug("emaclite: Read MII 0x%x, 0x%x, 0x%x\n", addr, reg, *val);
551 static int emaclite_miiphy_write(const char *devname, uchar addr,
552 uchar reg, ushort val)
554 struct eth_device *dev = eth_get_dev();
556 debug("emaclite: Write MII 0x%x, 0x%x, 0x%x\n", addr, reg, val);
557 return phywrite(dev->priv, addr, reg, val);
561 int xilinx_emaclite_initialize(bd_t *bis, unsigned long base_addr,
564 struct eth_device *dev;
565 struct xemaclite *emaclite;
566 struct emaclite_regs *regs;
568 dev = calloc(1, sizeof(*dev));
572 emaclite = calloc(1, sizeof(struct xemaclite));
573 if (emaclite == NULL) {
578 dev->priv = emaclite;
580 emaclite->txpp = txpp;
581 emaclite->rxpp = rxpp;
583 sprintf(dev->name, "Xelite.%lx", base_addr);
585 emaclite->regs = (struct emaclite_regs *)base_addr;
586 regs = emaclite->regs;
587 dev->iobase = base_addr;
588 dev->init = emaclite_init;
589 dev->halt = emaclite_halt;
590 dev->send = emaclite_send;
591 dev->recv = emaclite_recv;
593 #ifdef CONFIG_PHY_ADDR
594 emaclite->phyaddr = CONFIG_PHY_ADDR;
596 emaclite->phyaddr = -1;
601 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
602 miiphy_register(dev->name, emaclite_miiphy_read, emaclite_miiphy_write);
603 emaclite->bus = miiphy_get_dev_by_name(dev->name);
605 out_be32(®s->mdioctrl, XEL_MDIOCTRL_MDIOEN_MASK);