1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2011 Michal Simek <monstr@monstr.eu>
4 * Copyright (C) 2011 PetaLogix
5 * Copyright (C) 2010 Xilinx, Inc. All rights reserved.
20 DECLARE_GLOBAL_DATA_PTR;
23 #define XAE_EMMC_LINKSPEED_MASK 0xC0000000 /* Link speed */
24 #define XAE_EMMC_LINKSPD_10 0x00000000 /* Link Speed mask for 10 Mbit */
25 #define XAE_EMMC_LINKSPD_100 0x40000000 /* Link Speed mask for 100 Mbit */
26 #define XAE_EMMC_LINKSPD_1000 0x80000000 /* Link Speed mask for 1000 Mbit */
28 /* Interrupt Status/Enable/Mask Registers bit definitions */
29 #define XAE_INT_RXRJECT_MASK 0x00000008 /* Rx frame rejected */
30 #define XAE_INT_MGTRDY_MASK 0x00000080 /* MGT clock Lock */
32 /* Receive Configuration Word 1 (RCW1) Register bit definitions */
33 #define XAE_RCW1_RX_MASK 0x10000000 /* Receiver enable */
35 /* Transmitter Configuration (TC) Register bit definitions */
36 #define XAE_TC_TX_MASK 0x10000000 /* Transmitter enable */
38 #define XAE_UAW1_UNICASTADDR_MASK 0x0000FFFF
40 /* MDIO Management Configuration (MC) Register bit definitions */
41 #define XAE_MDIO_MC_MDIOEN_MASK 0x00000040 /* MII management enable*/
43 /* MDIO Management Control Register (MCR) Register bit definitions */
44 #define XAE_MDIO_MCR_PHYAD_MASK 0x1F000000 /* Phy Address Mask */
45 #define XAE_MDIO_MCR_PHYAD_SHIFT 24 /* Phy Address Shift */
46 #define XAE_MDIO_MCR_REGAD_MASK 0x001F0000 /* Reg Address Mask */
47 #define XAE_MDIO_MCR_REGAD_SHIFT 16 /* Reg Address Shift */
48 #define XAE_MDIO_MCR_OP_READ_MASK 0x00008000 /* Op Code Read Mask */
49 #define XAE_MDIO_MCR_OP_WRITE_MASK 0x00004000 /* Op Code Write Mask */
50 #define XAE_MDIO_MCR_INITIATE_MASK 0x00000800 /* Ready Mask */
51 #define XAE_MDIO_MCR_READY_MASK 0x00000080 /* Ready Mask */
53 #define XAE_MDIO_DIV_DFT 29 /* Default MDIO clock divisor */
55 #define XAXIDMA_BD_STS_ACTUAL_LEN_MASK 0x007FFFFF /* Actual len */
58 /* Bitmasks of XAXIDMA_CR_OFFSET register */
59 #define XAXIDMA_CR_RUNSTOP_MASK 0x00000001 /* Start/stop DMA channel */
60 #define XAXIDMA_CR_RESET_MASK 0x00000004 /* Reset DMA engine */
62 /* Bitmasks of XAXIDMA_SR_OFFSET register */
63 #define XAXIDMA_HALTED_MASK 0x00000001 /* DMA channel halted */
65 /* Bitmask for interrupts */
66 #define XAXIDMA_IRQ_IOC_MASK 0x00001000 /* Completion intr */
67 #define XAXIDMA_IRQ_DELAY_MASK 0x00002000 /* Delay interrupt */
68 #define XAXIDMA_IRQ_ALL_MASK 0x00007000 /* All interrupts */
70 /* Bitmasks of XAXIDMA_BD_CTRL_OFFSET register */
71 #define XAXIDMA_BD_CTRL_TXSOF_MASK 0x08000000 /* First tx packet */
72 #define XAXIDMA_BD_CTRL_TXEOF_MASK 0x04000000 /* Last tx packet */
76 static u8 rxframe[PKTSIZE_ALIGN] __attribute((aligned(DMAALIGN)));
78 /* Reflect dma offsets */
80 u32 control; /* DMACR */
81 u32 status; /* DMASR */
82 u32 current; /* CURDESC low 32 bit */
83 u32 current_hi; /* CURDESC high 32 bit */
84 u32 tail; /* TAILDESC low 32 bit */
85 u32 tail_hi; /* TAILDESC high 32 bit */
88 /* Private driver structures */
90 struct axidma_reg *dmatx;
91 struct axidma_reg *dmarx;
93 struct axi_regs *iobase;
94 phy_interface_t interface;
95 struct phy_device *phydev;
103 u32 next; /* Next descriptor pointer */
105 u32 phys; /* Buffer address */
109 u32 cntrl; /* Control */
110 u32 status; /* Status */
112 u32 app1; /* TX start << 16 | insert */
113 u32 app2; /* TX csum seed */
121 /* Static BDs - driver uses only one BD */
122 static struct axidma_bd tx_bd __attribute((aligned(DMAALIGN)));
123 static struct axidma_bd rx_bd __attribute((aligned(DMAALIGN)));
127 u32 is; /* 0xC: Interrupt status */
129 u32 ie; /* 0x14: Interrupt enable */
131 u32 rcw1; /* 0x404: Rx Configuration Word 1 */
132 u32 tc; /* 0x408: Tx Configuration */
134 u32 emmc; /* 0x410: EMAC mode configuration */
136 u32 mdio_mc; /* 0x500: MII Management Config */
137 u32 mdio_mcr; /* 0x504: MII Management Control */
138 u32 mdio_mwd; /* 0x508: MII Management Write Data */
139 u32 mdio_mrd; /* 0x50C: MII Management Read Data */
141 u32 uaw0; /* 0x700: Unicast address word 0 */
142 u32 uaw1; /* 0x704: Unicast address word 1 */
145 /* Use MII register 1 (MII status register) to detect PHY */
146 #define PHY_DETECT_REG 1
149 * Mask used to verify certain PHY features (or register contents)
150 * in the register above:
151 * 0x1000: 10Mbps full duplex support
152 * 0x0800: 10Mbps half duplex support
153 * 0x0008: Auto-negotiation support
155 #define PHY_DETECT_MASK 0x1808
157 static inline int mdio_wait(struct axi_regs *regs)
161 /* Wait till MDIO interface is ready to accept a new transaction. */
162 while (timeout && (!(readl(®s->mdio_mcr)
163 & XAE_MDIO_MCR_READY_MASK))) {
168 printf("%s: Timeout\n", __func__);
175 * axienet_dma_write - Memory mapped Axi DMA register Buffer Descriptor write.
176 * @bd: pointer to BD descriptor structure
177 * @desc: Address offset of DMA descriptors
179 * This function writes the value into the corresponding Axi DMA register.
181 static inline void axienet_dma_write(struct axidma_bd *bd, u32 *desc)
183 #if defined(CONFIG_PHYS_64BIT)
186 writel((u32)bd, desc);
190 static u32 phyread(struct axidma_priv *priv, u32 phyaddress, u32 registernum,
193 struct axi_regs *regs = priv->iobase;
199 mdioctrlreg = ((phyaddress << XAE_MDIO_MCR_PHYAD_SHIFT) &
200 XAE_MDIO_MCR_PHYAD_MASK) |
201 ((registernum << XAE_MDIO_MCR_REGAD_SHIFT)
202 & XAE_MDIO_MCR_REGAD_MASK) |
203 XAE_MDIO_MCR_INITIATE_MASK |
204 XAE_MDIO_MCR_OP_READ_MASK;
206 writel(mdioctrlreg, ®s->mdio_mcr);
212 *val = readl(®s->mdio_mrd);
216 static u32 phywrite(struct axidma_priv *priv, u32 phyaddress, u32 registernum,
219 struct axi_regs *regs = priv->iobase;
225 mdioctrlreg = ((phyaddress << XAE_MDIO_MCR_PHYAD_SHIFT) &
226 XAE_MDIO_MCR_PHYAD_MASK) |
227 ((registernum << XAE_MDIO_MCR_REGAD_SHIFT)
228 & XAE_MDIO_MCR_REGAD_MASK) |
229 XAE_MDIO_MCR_INITIATE_MASK |
230 XAE_MDIO_MCR_OP_WRITE_MASK;
233 writel(data, ®s->mdio_mwd);
235 writel(mdioctrlreg, ®s->mdio_mcr);
243 static int axiemac_phy_init(struct udevice *dev)
247 struct axidma_priv *priv = dev_get_priv(dev);
248 struct axi_regs *regs = priv->iobase;
249 struct phy_device *phydev;
251 u32 supported = SUPPORTED_10baseT_Half |
252 SUPPORTED_10baseT_Full |
253 SUPPORTED_100baseT_Half |
254 SUPPORTED_100baseT_Full |
255 SUPPORTED_1000baseT_Half |
256 SUPPORTED_1000baseT_Full;
258 /* Set default MDIO divisor */
259 writel(XAE_MDIO_DIV_DFT | XAE_MDIO_MC_MDIOEN_MASK, ®s->mdio_mc);
261 if (priv->phyaddr == -1) {
262 /* Detect the PHY address */
263 for (i = 31; i >= 0; i--) {
264 ret = phyread(priv, i, PHY_DETECT_REG, &phyreg);
265 if (!ret && (phyreg != 0xFFFF) &&
266 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
267 /* Found a valid PHY address */
269 debug("axiemac: Found valid phy address, %x\n",
276 /* Interface - look at tsec */
277 phydev = phy_connect(priv->bus, priv->phyaddr, dev, priv->interface);
279 phydev->supported &= supported;
280 phydev->advertising = phydev->supported;
281 priv->phydev = phydev;
282 if (priv->phy_of_handle)
283 priv->phydev->node = offset_to_ofnode(priv->phy_of_handle);
289 /* Setting axi emac and phy to proper setting */
290 static int setup_phy(struct udevice *dev)
293 u32 speed, emmc_reg, ret;
294 struct axidma_priv *priv = dev_get_priv(dev);
295 struct axi_regs *regs = priv->iobase;
296 struct phy_device *phydev = priv->phydev;
298 if (priv->interface == PHY_INTERFACE_MODE_SGMII) {
300 * In SGMII cases the isolate bit might set
301 * after DMA and ethernet resets and hence
302 * check and clear if set.
304 ret = phyread(priv, priv->phyaddr, MII_BMCR, &temp);
307 if (temp & BMCR_ISOLATE) {
308 temp &= ~BMCR_ISOLATE;
309 ret = phywrite(priv, priv->phyaddr, MII_BMCR, temp);
315 if (phy_startup(phydev)) {
316 printf("axiemac: could not initialize PHY %s\n",
321 printf("%s: No link.\n", phydev->dev->name);
325 switch (phydev->speed) {
327 speed = XAE_EMMC_LINKSPD_1000;
330 speed = XAE_EMMC_LINKSPD_100;
333 speed = XAE_EMMC_LINKSPD_10;
339 /* Setup the emac for the phy speed */
340 emmc_reg = readl(®s->emmc);
341 emmc_reg &= ~XAE_EMMC_LINKSPEED_MASK;
344 /* Write new speed setting out to Axi Ethernet */
345 writel(emmc_reg, ®s->emmc);
348 * Setting the operating speed of the MAC needs a delay. There
349 * doesn't seem to be register to poll, so please consider this
350 * during your application design.
357 /* STOP DMA transfers */
358 static void axiemac_stop(struct udevice *dev)
360 struct axidma_priv *priv = dev_get_priv(dev);
363 /* Stop the hardware */
364 temp = readl(&priv->dmatx->control);
365 temp &= ~XAXIDMA_CR_RUNSTOP_MASK;
366 writel(temp, &priv->dmatx->control);
368 temp = readl(&priv->dmarx->control);
369 temp &= ~XAXIDMA_CR_RUNSTOP_MASK;
370 writel(temp, &priv->dmarx->control);
372 debug("axiemac: Halted\n");
375 static int axi_ethernet_init(struct axidma_priv *priv)
377 struct axi_regs *regs = priv->iobase;
381 * Check the status of the MgtRdy bit in the interrupt status
382 * registers. This must be done to allow the MGT clock to become stable
383 * for the Sgmii and 1000BaseX PHY interfaces. No other register reads
384 * will be valid until this bit is valid.
385 * The bit is always a 1 for all other PHY interfaces.
386 * Interrupt status and enable registers are not available in non
387 * processor mode and hence bypass in this mode
389 if (!priv->eth_hasnobuf) {
390 err = wait_for_bit_le32(®s->is, XAE_INT_MGTRDY_MASK,
393 printf("%s: Timeout\n", __func__);
398 * Stop the device and reset HW
401 writel(0, ®s->ie);
404 /* Disable the receiver */
405 writel(readl(®s->rcw1) & ~XAE_RCW1_RX_MASK, ®s->rcw1);
408 * Stopping the receiver in mid-packet causes a dropped packet
409 * indication from HW. Clear it.
411 if (!priv->eth_hasnobuf) {
412 /* Set the interrupt status register to clear the interrupt */
413 writel(XAE_INT_RXRJECT_MASK, ®s->is);
417 /* Set default MDIO divisor */
418 writel(XAE_MDIO_DIV_DFT | XAE_MDIO_MC_MDIOEN_MASK, ®s->mdio_mc);
420 debug("axiemac: InitHw done\n");
424 static int axiemac_write_hwaddr(struct udevice *dev)
426 struct eth_pdata *pdata = dev_get_platdata(dev);
427 struct axidma_priv *priv = dev_get_priv(dev);
428 struct axi_regs *regs = priv->iobase;
430 /* Set the MAC address */
431 int val = ((pdata->enetaddr[3] << 24) | (pdata->enetaddr[2] << 16) |
432 (pdata->enetaddr[1] << 8) | (pdata->enetaddr[0]));
433 writel(val, ®s->uaw0);
435 val = (pdata->enetaddr[5] << 8) | pdata->enetaddr[4];
436 val |= readl(®s->uaw1) & ~XAE_UAW1_UNICASTADDR_MASK;
437 writel(val, ®s->uaw1);
441 /* Reset DMA engine */
442 static void axi_dma_init(struct axidma_priv *priv)
446 /* Reset the engine so the hardware starts from a known state */
447 writel(XAXIDMA_CR_RESET_MASK, &priv->dmatx->control);
448 writel(XAXIDMA_CR_RESET_MASK, &priv->dmarx->control);
450 /* At the initialization time, hardware should finish reset quickly */
452 /* Check transmit/receive channel */
453 /* Reset is done when the reset bit is low */
454 if (!((readl(&priv->dmatx->control) |
455 readl(&priv->dmarx->control))
456 & XAXIDMA_CR_RESET_MASK)) {
461 printf("%s: Timeout\n", __func__);
464 static int axiemac_start(struct udevice *dev)
466 struct axidma_priv *priv = dev_get_priv(dev);
467 struct axi_regs *regs = priv->iobase;
470 debug("axiemac: Init started\n");
472 * Initialize AXIDMA engine. AXIDMA engine must be initialized before
473 * AxiEthernet. During AXIDMA engine initialization, AXIDMA hardware is
474 * reset, and since AXIDMA reset line is connected to AxiEthernet, this
475 * would ensure a reset of AxiEthernet.
479 /* Initialize AxiEthernet hardware. */
480 if (axi_ethernet_init(priv))
483 /* Disable all RX interrupts before RxBD space setup */
484 temp = readl(&priv->dmarx->control);
485 temp &= ~XAXIDMA_IRQ_ALL_MASK;
486 writel(temp, &priv->dmarx->control);
488 /* Start DMA RX channel. Now it's ready to receive data.*/
489 axienet_dma_write(&rx_bd, &priv->dmarx->current);
492 memset(&rx_bd, 0, sizeof(rx_bd));
493 rx_bd.next = (u32)&rx_bd;
494 rx_bd.phys = (u32)&rxframe;
495 rx_bd.cntrl = sizeof(rxframe);
496 /* Flush the last BD so DMA core could see the updates */
497 flush_cache((u32)&rx_bd, sizeof(rx_bd));
499 /* It is necessary to flush rxframe because if you don't do it
500 * then cache can contain uninitialized data */
501 flush_cache((u32)&rxframe, sizeof(rxframe));
503 /* Start the hardware */
504 temp = readl(&priv->dmarx->control);
505 temp |= XAXIDMA_CR_RUNSTOP_MASK;
506 writel(temp, &priv->dmarx->control);
508 /* Rx BD is ready - start */
509 axienet_dma_write(&rx_bd, &priv->dmarx->tail);
512 writel(XAE_TC_TX_MASK, ®s->tc);
514 writel(XAE_RCW1_RX_MASK, ®s->rcw1);
517 if (!setup_phy(dev)) {
522 debug("axiemac: Init complete\n");
526 static int axiemac_send(struct udevice *dev, void *ptr, int len)
528 struct axidma_priv *priv = dev_get_priv(dev);
531 if (len > PKTSIZE_ALIGN)
534 /* Flush packet to main memory to be trasfered by DMA */
535 flush_cache((u32)ptr, len);
538 memset(&tx_bd, 0, sizeof(tx_bd));
539 /* At the end of the ring, link the last BD back to the top */
540 tx_bd.next = (u32)&tx_bd;
541 tx_bd.phys = (u32)ptr;
543 tx_bd.cntrl = len | XAXIDMA_BD_CTRL_TXSOF_MASK |
544 XAXIDMA_BD_CTRL_TXEOF_MASK;
546 /* Flush the last BD so DMA core could see the updates */
547 flush_cache((u32)&tx_bd, sizeof(tx_bd));
549 if (readl(&priv->dmatx->status) & XAXIDMA_HALTED_MASK) {
551 axienet_dma_write(&tx_bd, &priv->dmatx->current);
552 /* Start the hardware */
553 temp = readl(&priv->dmatx->control);
554 temp |= XAXIDMA_CR_RUNSTOP_MASK;
555 writel(temp, &priv->dmatx->control);
559 axienet_dma_write(&tx_bd, &priv->dmatx->tail);
561 /* Wait for transmission to complete */
562 debug("axiemac: Waiting for tx to be done\n");
564 while (timeout && (!(readl(&priv->dmatx->status) &
565 (XAXIDMA_IRQ_DELAY_MASK | XAXIDMA_IRQ_IOC_MASK)))) {
570 printf("%s: Timeout\n", __func__);
574 debug("axiemac: Sending complete\n");
578 static int isrxready(struct axidma_priv *priv)
582 /* Read pending interrupts */
583 status = readl(&priv->dmarx->status);
585 /* Acknowledge pending interrupts */
586 writel(status & XAXIDMA_IRQ_ALL_MASK, &priv->dmarx->status);
589 * If Reception done interrupt is asserted, call RX call back function
590 * to handle the processed BDs and then raise the according flag.
592 if ((status & (XAXIDMA_IRQ_DELAY_MASK | XAXIDMA_IRQ_IOC_MASK)))
598 static int axiemac_recv(struct udevice *dev, int flags, uchar **packetp)
601 struct axidma_priv *priv = dev_get_priv(dev);
604 /* Wait for an incoming packet */
605 if (!isrxready(priv))
608 debug("axiemac: RX data ready\n");
610 /* Disable IRQ for a moment till packet is handled */
611 temp = readl(&priv->dmarx->control);
612 temp &= ~XAXIDMA_IRQ_ALL_MASK;
613 writel(temp, &priv->dmarx->control);
614 if (!priv->eth_hasnobuf)
615 length = rx_bd.app4 & 0xFFFF; /* max length mask */
617 length = rx_bd.status & XAXIDMA_BD_STS_ACTUAL_LEN_MASK;
620 print_buffer(&rxframe, &rxframe[0], 1, length, 16);
627 static int axiemac_free_pkt(struct udevice *dev, uchar *packet, int length)
629 struct axidma_priv *priv = dev_get_priv(dev);
632 /* It is useful to clear buffer to be sure that it is consistent */
633 memset(rxframe, 0, sizeof(rxframe));
636 /* Clear the whole buffer and setup it again - all flags are cleared */
637 memset(&rx_bd, 0, sizeof(rx_bd));
638 rx_bd.next = (u32)&rx_bd;
639 rx_bd.phys = (u32)&rxframe;
640 rx_bd.cntrl = sizeof(rxframe);
643 flush_cache((u32)&rx_bd, sizeof(rx_bd));
645 /* It is necessary to flush rxframe because if you don't do it
646 * then cache will contain previous packet */
647 flush_cache((u32)&rxframe, sizeof(rxframe));
649 /* Rx BD is ready - start again */
650 axienet_dma_write(&rx_bd, &priv->dmarx->tail);
652 debug("axiemac: RX completed, framelength = %d\n", length);
657 static int axiemac_miiphy_read(struct mii_dev *bus, int addr,
663 ret = phyread(bus->priv, addr, reg, &value);
664 debug("axiemac: Read MII 0x%x, 0x%x, 0x%x, %d\n", addr, reg,
669 static int axiemac_miiphy_write(struct mii_dev *bus, int addr, int devad,
672 debug("axiemac: Write MII 0x%x, 0x%x, 0x%x\n", addr, reg, value);
673 return phywrite(bus->priv, addr, reg, value);
676 static int axi_emac_probe(struct udevice *dev)
678 struct axidma_priv *priv = dev_get_priv(dev);
681 priv->bus = mdio_alloc();
682 priv->bus->read = axiemac_miiphy_read;
683 priv->bus->write = axiemac_miiphy_write;
684 priv->bus->priv = priv;
686 ret = mdio_register_seq(priv->bus, dev->seq);
690 axiemac_phy_init(dev);
695 static int axi_emac_remove(struct udevice *dev)
697 struct axidma_priv *priv = dev_get_priv(dev);
700 mdio_unregister(priv->bus);
701 mdio_free(priv->bus);
706 static const struct eth_ops axi_emac_ops = {
707 .start = axiemac_start,
708 .send = axiemac_send,
709 .recv = axiemac_recv,
710 .free_pkt = axiemac_free_pkt,
711 .stop = axiemac_stop,
712 .write_hwaddr = axiemac_write_hwaddr,
715 static int axi_emac_ofdata_to_platdata(struct udevice *dev)
717 struct eth_pdata *pdata = dev_get_platdata(dev);
718 struct axidma_priv *priv = dev_get_priv(dev);
719 int node = dev_of_offset(dev);
721 const char *phy_mode;
723 pdata->iobase = (phys_addr_t)devfdt_get_addr(dev);
724 priv->iobase = (struct axi_regs *)pdata->iobase;
726 offset = fdtdec_lookup_phandle(gd->fdt_blob, node,
727 "axistream-connected");
729 printf("%s: axistream is not found\n", __func__);
732 priv->dmatx = (struct axidma_reg *)fdtdec_get_addr(gd->fdt_blob,
735 printf("%s: axi_dma register space not found\n", __func__);
738 /* RX channel offset is 0x30 */
739 priv->dmarx = (struct axidma_reg *)((u32)priv->dmatx + 0x30);
743 offset = fdtdec_lookup_phandle(gd->fdt_blob, node, "phy-handle");
745 priv->phyaddr = fdtdec_get_int(gd->fdt_blob, offset, "reg", -1);
746 priv->phy_of_handle = offset;
749 phy_mode = fdt_getprop(gd->fdt_blob, node, "phy-mode", NULL);
751 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
752 if (pdata->phy_interface == -1) {
753 printf("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
756 priv->interface = pdata->phy_interface;
758 priv->eth_hasnobuf = fdtdec_get_bool(gd->fdt_blob, node,
759 "xlnx,eth-hasnobuf");
761 printf("AXI EMAC: %lx, phyaddr %d, interface %s\n", (ulong)priv->iobase,
762 priv->phyaddr, phy_string_for_interface(priv->interface));
767 static const struct udevice_id axi_emac_ids[] = {
768 { .compatible = "xlnx,axi-ethernet-1.00.a" },
772 U_BOOT_DRIVER(axi_emac) = {
775 .of_match = axi_emac_ids,
776 .ofdata_to_platdata = axi_emac_ofdata_to_platdata,
777 .probe = axi_emac_probe,
778 .remove = axi_emac_remove,
779 .ops = &axi_emac_ops,
780 .priv_auto_alloc_size = sizeof(struct axidma_priv),
781 .platdata_auto_alloc_size = sizeof(struct eth_pdata),