2 * Copyright (C) 2011 Michal Simek <monstr@monstr.eu>
3 * Copyright (C) 2011 PetaLogix
4 * Copyright (C) 2010 Xilinx, Inc. All rights reserved.
6 * SPDX-License-Identifier: GPL-2.0+
18 DECLARE_GLOBAL_DATA_PTR;
21 #define XAE_EMMC_LINKSPEED_MASK 0xC0000000 /* Link speed */
22 #define XAE_EMMC_LINKSPD_10 0x00000000 /* Link Speed mask for 10 Mbit */
23 #define XAE_EMMC_LINKSPD_100 0x40000000 /* Link Speed mask for 100 Mbit */
24 #define XAE_EMMC_LINKSPD_1000 0x80000000 /* Link Speed mask for 1000 Mbit */
26 /* Interrupt Status/Enable/Mask Registers bit definitions */
27 #define XAE_INT_RXRJECT_MASK 0x00000008 /* Rx frame rejected */
28 #define XAE_INT_MGTRDY_MASK 0x00000080 /* MGT clock Lock */
30 /* Receive Configuration Word 1 (RCW1) Register bit definitions */
31 #define XAE_RCW1_RX_MASK 0x10000000 /* Receiver enable */
33 /* Transmitter Configuration (TC) Register bit definitions */
34 #define XAE_TC_TX_MASK 0x10000000 /* Transmitter enable */
36 #define XAE_UAW1_UNICASTADDR_MASK 0x0000FFFF
38 /* MDIO Management Configuration (MC) Register bit definitions */
39 #define XAE_MDIO_MC_MDIOEN_MASK 0x00000040 /* MII management enable*/
41 /* MDIO Management Control Register (MCR) Register bit definitions */
42 #define XAE_MDIO_MCR_PHYAD_MASK 0x1F000000 /* Phy Address Mask */
43 #define XAE_MDIO_MCR_PHYAD_SHIFT 24 /* Phy Address Shift */
44 #define XAE_MDIO_MCR_REGAD_MASK 0x001F0000 /* Reg Address Mask */
45 #define XAE_MDIO_MCR_REGAD_SHIFT 16 /* Reg Address Shift */
46 #define XAE_MDIO_MCR_OP_READ_MASK 0x00008000 /* Op Code Read Mask */
47 #define XAE_MDIO_MCR_OP_WRITE_MASK 0x00004000 /* Op Code Write Mask */
48 #define XAE_MDIO_MCR_INITIATE_MASK 0x00000800 /* Ready Mask */
49 #define XAE_MDIO_MCR_READY_MASK 0x00000080 /* Ready Mask */
51 #define XAE_MDIO_DIV_DFT 29 /* Default MDIO clock divisor */
54 /* Bitmasks of XAXIDMA_CR_OFFSET register */
55 #define XAXIDMA_CR_RUNSTOP_MASK 0x00000001 /* Start/stop DMA channel */
56 #define XAXIDMA_CR_RESET_MASK 0x00000004 /* Reset DMA engine */
58 /* Bitmasks of XAXIDMA_SR_OFFSET register */
59 #define XAXIDMA_HALTED_MASK 0x00000001 /* DMA channel halted */
61 /* Bitmask for interrupts */
62 #define XAXIDMA_IRQ_IOC_MASK 0x00001000 /* Completion intr */
63 #define XAXIDMA_IRQ_DELAY_MASK 0x00002000 /* Delay interrupt */
64 #define XAXIDMA_IRQ_ALL_MASK 0x00007000 /* All interrupts */
66 /* Bitmasks of XAXIDMA_BD_CTRL_OFFSET register */
67 #define XAXIDMA_BD_CTRL_TXSOF_MASK 0x08000000 /* First tx packet */
68 #define XAXIDMA_BD_CTRL_TXEOF_MASK 0x04000000 /* Last tx packet */
72 static u8 rxframe[PKTSIZE_ALIGN] __attribute((aligned(DMAALIGN)));
74 /* Reflect dma offsets */
76 u32 control; /* DMACR */
77 u32 status; /* DMASR */
78 u32 current; /* CURDESC */
80 u32 tail; /* TAILDESC */
83 /* Private driver structures */
85 struct axidma_reg *dmatx;
86 struct axidma_reg *dmarx;
88 struct axi_regs *iobase;
89 phy_interface_t interface;
90 struct phy_device *phydev;
96 u32 next; /* Next descriptor pointer */
98 u32 phys; /* Buffer address */
102 u32 cntrl; /* Control */
103 u32 status; /* Status */
105 u32 app1; /* TX start << 16 | insert */
106 u32 app2; /* TX csum seed */
114 /* Static BDs - driver uses only one BD */
115 static struct axidma_bd tx_bd __attribute((aligned(DMAALIGN)));
116 static struct axidma_bd rx_bd __attribute((aligned(DMAALIGN)));
120 u32 is; /* 0xC: Interrupt status */
122 u32 ie; /* 0x14: Interrupt enable */
124 u32 rcw1; /* 0x404: Rx Configuration Word 1 */
125 u32 tc; /* 0x408: Tx Configuration */
127 u32 emmc; /* 0x410: EMAC mode configuration */
129 u32 mdio_mc; /* 0x500: MII Management Config */
130 u32 mdio_mcr; /* 0x504: MII Management Control */
131 u32 mdio_mwd; /* 0x508: MII Management Write Data */
132 u32 mdio_mrd; /* 0x50C: MII Management Read Data */
134 u32 uaw0; /* 0x700: Unicast address word 0 */
135 u32 uaw1; /* 0x704: Unicast address word 1 */
138 /* Use MII register 1 (MII status register) to detect PHY */
139 #define PHY_DETECT_REG 1
142 * Mask used to verify certain PHY features (or register contents)
143 * in the register above:
144 * 0x1000: 10Mbps full duplex support
145 * 0x0800: 10Mbps half duplex support
146 * 0x0008: Auto-negotiation support
148 #define PHY_DETECT_MASK 0x1808
150 static inline int mdio_wait(struct axi_regs *regs)
154 /* Wait till MDIO interface is ready to accept a new transaction. */
155 while (timeout && (!(in_be32(®s->mdio_mcr)
156 & XAE_MDIO_MCR_READY_MASK))) {
161 printf("%s: Timeout\n", __func__);
167 static u32 phyread(struct axidma_priv *priv, u32 phyaddress, u32 registernum,
170 struct axi_regs *regs = priv->iobase;
176 mdioctrlreg = ((phyaddress << XAE_MDIO_MCR_PHYAD_SHIFT) &
177 XAE_MDIO_MCR_PHYAD_MASK) |
178 ((registernum << XAE_MDIO_MCR_REGAD_SHIFT)
179 & XAE_MDIO_MCR_REGAD_MASK) |
180 XAE_MDIO_MCR_INITIATE_MASK |
181 XAE_MDIO_MCR_OP_READ_MASK;
183 out_be32(®s->mdio_mcr, mdioctrlreg);
189 *val = in_be32(®s->mdio_mrd);
193 static u32 phywrite(struct axidma_priv *priv, u32 phyaddress, u32 registernum,
196 struct axi_regs *regs = priv->iobase;
202 mdioctrlreg = ((phyaddress << XAE_MDIO_MCR_PHYAD_SHIFT) &
203 XAE_MDIO_MCR_PHYAD_MASK) |
204 ((registernum << XAE_MDIO_MCR_REGAD_SHIFT)
205 & XAE_MDIO_MCR_REGAD_MASK) |
206 XAE_MDIO_MCR_INITIATE_MASK |
207 XAE_MDIO_MCR_OP_WRITE_MASK;
210 out_be32(®s->mdio_mwd, data);
212 out_be32(®s->mdio_mcr, mdioctrlreg);
220 static int axiemac_phy_init(struct udevice *dev)
224 struct axidma_priv *priv = dev_get_priv(dev);
225 struct axi_regs *regs = priv->iobase;
226 struct phy_device *phydev;
228 u32 supported = SUPPORTED_10baseT_Half |
229 SUPPORTED_10baseT_Full |
230 SUPPORTED_100baseT_Half |
231 SUPPORTED_100baseT_Full |
232 SUPPORTED_1000baseT_Half |
233 SUPPORTED_1000baseT_Full;
235 /* Set default MDIO divisor */
236 out_be32(®s->mdio_mc, XAE_MDIO_DIV_DFT | XAE_MDIO_MC_MDIOEN_MASK);
238 if (priv->phyaddr == -1) {
239 /* Detect the PHY address */
240 for (i = 31; i >= 0; i--) {
241 ret = phyread(priv, i, PHY_DETECT_REG, &phyreg);
242 if (!ret && (phyreg != 0xFFFF) &&
243 ((phyreg & PHY_DETECT_MASK) == PHY_DETECT_MASK)) {
244 /* Found a valid PHY address */
246 debug("axiemac: Found valid phy address, %x\n",
253 /* Interface - look at tsec */
254 phydev = phy_connect(priv->bus, priv->phyaddr, dev, priv->interface);
256 phydev->supported &= supported;
257 phydev->advertising = phydev->supported;
258 priv->phydev = phydev;
264 /* Setting axi emac and phy to proper setting */
265 static int setup_phy(struct udevice *dev)
268 u32 speed, emmc_reg, ret;
269 struct axidma_priv *priv = dev_get_priv(dev);
270 struct axi_regs *regs = priv->iobase;
271 struct phy_device *phydev = priv->phydev;
273 if (priv->interface == PHY_INTERFACE_MODE_SGMII) {
275 * In SGMII cases the isolate bit might set
276 * after DMA and ethernet resets and hence
277 * check and clear if set.
279 ret = phyread(priv, priv->phyaddr, MII_BMCR, &temp);
282 if (temp & BMCR_ISOLATE) {
283 temp &= ~BMCR_ISOLATE;
284 ret = phywrite(priv, priv->phyaddr, MII_BMCR, temp);
290 if (phy_startup(phydev)) {
291 printf("axiemac: could not initialize PHY %s\n",
296 printf("%s: No link.\n", phydev->dev->name);
300 switch (phydev->speed) {
302 speed = XAE_EMMC_LINKSPD_1000;
305 speed = XAE_EMMC_LINKSPD_100;
308 speed = XAE_EMMC_LINKSPD_10;
314 /* Setup the emac for the phy speed */
315 emmc_reg = in_be32(®s->emmc);
316 emmc_reg &= ~XAE_EMMC_LINKSPEED_MASK;
319 /* Write new speed setting out to Axi Ethernet */
320 out_be32(®s->emmc, emmc_reg);
323 * Setting the operating speed of the MAC needs a delay. There
324 * doesn't seem to be register to poll, so please consider this
325 * during your application design.
332 /* STOP DMA transfers */
333 static void axiemac_stop(struct udevice *dev)
335 struct axidma_priv *priv = dev_get_priv(dev);
338 /* Stop the hardware */
339 temp = in_be32(&priv->dmatx->control);
340 temp &= ~XAXIDMA_CR_RUNSTOP_MASK;
341 out_be32(&priv->dmatx->control, temp);
343 temp = in_be32(&priv->dmarx->control);
344 temp &= ~XAXIDMA_CR_RUNSTOP_MASK;
345 out_be32(&priv->dmarx->control, temp);
347 debug("axiemac: Halted\n");
350 static int axi_ethernet_init(struct axidma_priv *priv)
352 struct axi_regs *regs = priv->iobase;
356 * Check the status of the MgtRdy bit in the interrupt status
357 * registers. This must be done to allow the MGT clock to become stable
358 * for the Sgmii and 1000BaseX PHY interfaces. No other register reads
359 * will be valid until this bit is valid.
360 * The bit is always a 1 for all other PHY interfaces.
362 while (timeout && (!(in_be32(®s->is) & XAE_INT_MGTRDY_MASK))) {
367 printf("%s: Timeout\n", __func__);
371 /* Stop the device and reset HW */
372 /* Disable interrupts */
373 out_be32(®s->ie, 0);
375 /* Disable the receiver */
376 out_be32(®s->rcw1, in_be32(®s->rcw1) & ~XAE_RCW1_RX_MASK);
379 * Stopping the receiver in mid-packet causes a dropped packet
380 * indication from HW. Clear it.
382 /* Set the interrupt status register to clear the interrupt */
383 out_be32(®s->is, XAE_INT_RXRJECT_MASK);
386 /* Set default MDIO divisor */
387 out_be32(®s->mdio_mc, XAE_MDIO_DIV_DFT | XAE_MDIO_MC_MDIOEN_MASK);
389 debug("axiemac: InitHw done\n");
393 static int axiemac_write_hwaddr(struct udevice *dev)
395 struct eth_pdata *pdata = dev_get_platdata(dev);
396 struct axidma_priv *priv = dev_get_priv(dev);
397 struct axi_regs *regs = priv->iobase;
399 /* Set the MAC address */
400 int val = ((pdata->enetaddr[3] << 24) | (pdata->enetaddr[2] << 16) |
401 (pdata->enetaddr[1] << 8) | (pdata->enetaddr[0]));
402 out_be32(®s->uaw0, val);
404 val = (pdata->enetaddr[5] << 8) | pdata->enetaddr[4];
405 val |= in_be32(®s->uaw1) & ~XAE_UAW1_UNICASTADDR_MASK;
406 out_be32(®s->uaw1, val);
410 /* Reset DMA engine */
411 static void axi_dma_init(struct axidma_priv *priv)
415 /* Reset the engine so the hardware starts from a known state */
416 out_be32(&priv->dmatx->control, XAXIDMA_CR_RESET_MASK);
417 out_be32(&priv->dmarx->control, XAXIDMA_CR_RESET_MASK);
419 /* At the initialization time, hardware should finish reset quickly */
421 /* Check transmit/receive channel */
422 /* Reset is done when the reset bit is low */
423 if (!((in_be32(&priv->dmatx->control) |
424 in_be32(&priv->dmarx->control))
425 & XAXIDMA_CR_RESET_MASK)) {
430 printf("%s: Timeout\n", __func__);
433 static int axiemac_start(struct udevice *dev)
435 struct axidma_priv *priv = dev_get_priv(dev);
436 struct axi_regs *regs = priv->iobase;
439 debug("axiemac: Init started\n");
441 * Initialize AXIDMA engine. AXIDMA engine must be initialized before
442 * AxiEthernet. During AXIDMA engine initialization, AXIDMA hardware is
443 * reset, and since AXIDMA reset line is connected to AxiEthernet, this
444 * would ensure a reset of AxiEthernet.
448 /* Initialize AxiEthernet hardware. */
449 if (axi_ethernet_init(priv))
452 /* Disable all RX interrupts before RxBD space setup */
453 temp = in_be32(&priv->dmarx->control);
454 temp &= ~XAXIDMA_IRQ_ALL_MASK;
455 out_be32(&priv->dmarx->control, temp);
457 /* Start DMA RX channel. Now it's ready to receive data.*/
458 out_be32(&priv->dmarx->current, (u32)&rx_bd);
461 memset(&rx_bd, 0, sizeof(rx_bd));
462 rx_bd.next = (u32)&rx_bd;
463 rx_bd.phys = (u32)&rxframe;
464 rx_bd.cntrl = sizeof(rxframe);
465 /* Flush the last BD so DMA core could see the updates */
466 flush_cache((u32)&rx_bd, sizeof(rx_bd));
468 /* It is necessary to flush rxframe because if you don't do it
469 * then cache can contain uninitialized data */
470 flush_cache((u32)&rxframe, sizeof(rxframe));
472 /* Start the hardware */
473 temp = in_be32(&priv->dmarx->control);
474 temp |= XAXIDMA_CR_RUNSTOP_MASK;
475 out_be32(&priv->dmarx->control, temp);
477 /* Rx BD is ready - start */
478 out_be32(&priv->dmarx->tail, (u32)&rx_bd);
481 out_be32(®s->tc, XAE_TC_TX_MASK);
483 out_be32(®s->rcw1, XAE_RCW1_RX_MASK);
486 if (!setup_phy(dev)) {
491 debug("axiemac: Init complete\n");
495 static int axiemac_send(struct udevice *dev, void *ptr, int len)
497 struct axidma_priv *priv = dev_get_priv(dev);
500 if (len > PKTSIZE_ALIGN)
503 /* Flush packet to main memory to be trasfered by DMA */
504 flush_cache((u32)ptr, len);
507 memset(&tx_bd, 0, sizeof(tx_bd));
508 /* At the end of the ring, link the last BD back to the top */
509 tx_bd.next = (u32)&tx_bd;
510 tx_bd.phys = (u32)ptr;
512 tx_bd.cntrl = len | XAXIDMA_BD_CTRL_TXSOF_MASK |
513 XAXIDMA_BD_CTRL_TXEOF_MASK;
515 /* Flush the last BD so DMA core could see the updates */
516 flush_cache((u32)&tx_bd, sizeof(tx_bd));
518 if (in_be32(&priv->dmatx->status) & XAXIDMA_HALTED_MASK) {
520 out_be32(&priv->dmatx->current, (u32)&tx_bd);
521 /* Start the hardware */
522 temp = in_be32(&priv->dmatx->control);
523 temp |= XAXIDMA_CR_RUNSTOP_MASK;
524 out_be32(&priv->dmatx->control, temp);
528 out_be32(&priv->dmatx->tail, (u32)&tx_bd);
530 /* Wait for transmission to complete */
531 debug("axiemac: Waiting for tx to be done\n");
533 while (timeout && (!(in_be32(&priv->dmatx->status) &
534 (XAXIDMA_IRQ_DELAY_MASK | XAXIDMA_IRQ_IOC_MASK)))) {
539 printf("%s: Timeout\n", __func__);
543 debug("axiemac: Sending complete\n");
547 static int isrxready(struct axidma_priv *priv)
551 /* Read pending interrupts */
552 status = in_be32(&priv->dmarx->status);
554 /* Acknowledge pending interrupts */
555 out_be32(&priv->dmarx->status, status & XAXIDMA_IRQ_ALL_MASK);
558 * If Reception done interrupt is asserted, call RX call back function
559 * to handle the processed BDs and then raise the according flag.
561 if ((status & (XAXIDMA_IRQ_DELAY_MASK | XAXIDMA_IRQ_IOC_MASK)))
567 static int axiemac_recv(struct udevice *dev, int flags, uchar **packetp)
570 struct axidma_priv *priv = dev_get_priv(dev);
573 /* Wait for an incoming packet */
574 if (!isrxready(priv))
577 debug("axiemac: RX data ready\n");
579 /* Disable IRQ for a moment till packet is handled */
580 temp = in_be32(&priv->dmarx->control);
581 temp &= ~XAXIDMA_IRQ_ALL_MASK;
582 out_be32(&priv->dmarx->control, temp);
584 length = rx_bd.app4 & 0xFFFF; /* max length mask */
586 print_buffer(&rxframe, &rxframe[0], 1, length, 16);
593 static int axiemac_free_pkt(struct udevice *dev, uchar *packet, int length)
595 struct axidma_priv *priv = dev_get_priv(dev);
598 /* It is useful to clear buffer to be sure that it is consistent */
599 memset(rxframe, 0, sizeof(rxframe));
602 /* Clear the whole buffer and setup it again - all flags are cleared */
603 memset(&rx_bd, 0, sizeof(rx_bd));
604 rx_bd.next = (u32)&rx_bd;
605 rx_bd.phys = (u32)&rxframe;
606 rx_bd.cntrl = sizeof(rxframe);
609 flush_cache((u32)&rx_bd, sizeof(rx_bd));
611 /* It is necessary to flush rxframe because if you don't do it
612 * then cache will contain previous packet */
613 flush_cache((u32)&rxframe, sizeof(rxframe));
615 /* Rx BD is ready - start again */
616 out_be32(&priv->dmarx->tail, (u32)&rx_bd);
618 debug("axiemac: RX completed, framelength = %d\n", length);
623 static int axiemac_miiphy_read(struct mii_dev *bus, int addr,
629 ret = phyread(bus->priv, addr, reg, &value);
630 debug("axiemac: Read MII 0x%x, 0x%x, 0x%x, %d\n", addr, reg,
635 static int axiemac_miiphy_write(struct mii_dev *bus, int addr, int devad,
638 debug("axiemac: Write MII 0x%x, 0x%x, 0x%x\n", addr, reg, value);
639 return phywrite(bus->priv, addr, reg, value);
642 static int axi_emac_probe(struct udevice *dev)
644 struct axidma_priv *priv = dev_get_priv(dev);
647 priv->bus = mdio_alloc();
648 priv->bus->read = axiemac_miiphy_read;
649 priv->bus->write = axiemac_miiphy_write;
650 priv->bus->priv = priv;
652 ret = mdio_register_seq(priv->bus, dev->seq);
656 axiemac_phy_init(dev);
661 static int axi_emac_remove(struct udevice *dev)
663 struct axidma_priv *priv = dev_get_priv(dev);
666 mdio_unregister(priv->bus);
667 mdio_free(priv->bus);
672 static const struct eth_ops axi_emac_ops = {
673 .start = axiemac_start,
674 .send = axiemac_send,
675 .recv = axiemac_recv,
676 .free_pkt = axiemac_free_pkt,
677 .stop = axiemac_stop,
678 .write_hwaddr = axiemac_write_hwaddr,
681 static int axi_emac_ofdata_to_platdata(struct udevice *dev)
683 struct eth_pdata *pdata = dev_get_platdata(dev);
684 struct axidma_priv *priv = dev_get_priv(dev);
685 int node = dev_of_offset(dev);
687 const char *phy_mode;
689 pdata->iobase = (phys_addr_t)dev_get_addr(dev);
690 priv->iobase = (struct axi_regs *)pdata->iobase;
692 offset = fdtdec_lookup_phandle(gd->fdt_blob, node,
693 "axistream-connected");
695 printf("%s: axistream is not found\n", __func__);
698 priv->dmatx = (struct axidma_reg *)fdtdec_get_int(gd->fdt_blob,
701 printf("%s: axi_dma register space not found\n", __func__);
704 /* RX channel offset is 0x30 */
705 priv->dmarx = (struct axidma_reg *)((u32)priv->dmatx + 0x30);
709 offset = fdtdec_lookup_phandle(gd->fdt_blob, node, "phy-handle");
711 priv->phyaddr = fdtdec_get_int(gd->fdt_blob, offset, "reg", -1);
713 phy_mode = fdt_getprop(gd->fdt_blob, node, "phy-mode", NULL);
715 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
716 if (pdata->phy_interface == -1) {
717 printf("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
720 priv->interface = pdata->phy_interface;
722 printf("AXI EMAC: %lx, phyaddr %d, interface %s\n", (ulong)priv->iobase,
723 priv->phyaddr, phy_string_for_interface(priv->interface));
728 static const struct udevice_id axi_emac_ids[] = {
729 { .compatible = "xlnx,axi-ethernet-1.00.a" },
733 U_BOOT_DRIVER(axi_emac) = {
736 .of_match = axi_emac_ids,
737 .ofdata_to_platdata = axi_emac_ofdata_to_platdata,
738 .probe = axi_emac_probe,
739 .remove = axi_emac_remove,
740 .ops = &axi_emac_ops,
741 .priv_auto_alloc_size = sizeof(struct axidma_priv),
742 .platdata_auto_alloc_size = sizeof(struct eth_pdata),