1 // SPDX-License-Identifier: GPL-2.0+
5 * (C) Copyright 2008 Armadeus Systems nc
19 #include <power/regulator.h>
22 #include <linux/errno.h>
23 #include <linux/compiler.h>
25 #include <asm/arch/clock.h>
26 #include <asm/arch/imx-regs.h>
27 #include <asm/mach-imx/sys_proto.h>
28 #include <asm-generic/gpio.h>
33 DECLARE_GLOBAL_DATA_PTR;
36 * Timeout the transfer after 5 mS. This is usually a bit more, since
37 * the code in the tightloops this timeout is used in adds some overhead.
39 #define FEC_XFER_TIMEOUT 5000
42 * The standard 32-byte DMA alignment does not work on mx6solox, which requires
43 * 64-byte alignment in the DMA RX FEC buffer.
44 * Introduce the FEC_DMA_RX_MINALIGN which can cover mx6solox needs and also
45 * satisfies the alignment on other SoCs (32-bytes)
47 #define FEC_DMA_RX_MINALIGN 64
50 #error "CONFIG_MII has to be defined!"
53 #ifndef CONFIG_FEC_XCV_TYPE
54 #define CONFIG_FEC_XCV_TYPE MII100
58 * The i.MX28 operates with packets in big endian. We need to swap them before
59 * sending and after receiving.
62 #define CONFIG_FEC_MXC_SWAP_PACKET
65 #define RXDESC_PER_CACHELINE (ARCH_DMA_MINALIGN/sizeof(struct fec_bd))
67 /* Check various alignment issues at compile time */
68 #if ((ARCH_DMA_MINALIGN < 16) || (ARCH_DMA_MINALIGN % 16 != 0))
69 #error "ARCH_DMA_MINALIGN must be multiple of 16!"
72 #if ((PKTALIGN < ARCH_DMA_MINALIGN) || \
73 (PKTALIGN % ARCH_DMA_MINALIGN != 0))
74 #error "PKTALIGN must be multiple of ARCH_DMA_MINALIGN!"
79 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
80 static void swap_packet(uint32_t *packet, int length)
84 for (i = 0; i < DIV_ROUND_UP(length, 4); i++)
85 packet[i] = __swab32(packet[i]);
89 /* MII-interface related functions */
90 static int fec_mdio_read(struct ethernet_regs *eth, uint8_t phyaddr,
93 uint32_t reg; /* convenient holder for the PHY register */
94 uint32_t phy; /* convenient holder for the PHY */
99 * reading from any PHY's register is done by properly
100 * programming the FEC's MII data register.
102 writel(FEC_IEVENT_MII, ð->ievent);
103 reg = regaddr << FEC_MII_DATA_RA_SHIFT;
104 phy = phyaddr << FEC_MII_DATA_PA_SHIFT;
106 writel(FEC_MII_DATA_ST | FEC_MII_DATA_OP_RD | FEC_MII_DATA_TA |
107 phy | reg, ð->mii_data);
109 /* wait for the related interrupt */
110 start = get_timer(0);
111 while (!(readl(ð->ievent) & FEC_IEVENT_MII)) {
112 if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
113 printf("Read MDIO failed...\n");
118 /* clear mii interrupt bit */
119 writel(FEC_IEVENT_MII, ð->ievent);
121 /* it's now safe to read the PHY's register */
122 val = (unsigned short)readl(ð->mii_data);
123 debug("%s: phy: %02x reg:%02x val:%#x\n", __func__, phyaddr,
128 #ifndef imx_get_fecclk
129 u32 __weak imx_get_fecclk(void)
135 static int fec_get_clk_rate(void *udev, int idx)
137 struct fec_priv *fec;
141 if (IS_ENABLED(CONFIG_IMX8) ||
142 CONFIG_IS_ENABLED(CLK_CCF)) {
145 ret = uclass_get_device(UCLASS_ETH, idx, &dev);
147 debug("Can't get FEC udev: %d\n", ret);
152 fec = dev_get_priv(dev);
154 return fec->clk_rate;
158 return imx_get_fecclk();
162 static void fec_mii_setspeed(struct ethernet_regs *eth)
165 * Set MII_SPEED = (1/(mii_speed * 2)) * System Clock
166 * and do not drop the Preamble.
168 * The i.MX28 and i.MX6 types have another field in the MSCR (aka
169 * MII_SPEED) register that defines the MDIO output hold time. Earlier
170 * versions are RAZ there, so just ignore the difference and write the
172 * The minimal hold time according to IEE802.3 (clause 22) is 10 ns.
173 * HOLDTIME + 1 is the number of clk cycles the fec is holding the
175 * The HOLDTIME bitfield takes values between 0 and 7 (inclusive).
176 * Given that ceil(clkrate / 5000000) <= 64, the calculation for
177 * holdtime cannot result in a value greater than 3.
184 ret = fec_get_clk_rate(NULL, 0);
186 printf("Can't find FEC0 clk rate: %d\n", ret);
190 speed = DIV_ROUND_UP(pclk, 5000000);
191 hold = DIV_ROUND_UP(pclk, 100000000) - 1;
193 #ifdef FEC_QUIRK_ENET_MAC
196 writel(speed << 1 | hold << 8, ð->mii_speed);
197 debug("%s: mii_speed %08x\n", __func__, readl(ð->mii_speed));
200 static int fec_mdio_write(struct ethernet_regs *eth, uint8_t phyaddr,
201 uint8_t regaddr, uint16_t data)
203 uint32_t reg; /* convenient holder for the PHY register */
204 uint32_t phy; /* convenient holder for the PHY */
207 reg = regaddr << FEC_MII_DATA_RA_SHIFT;
208 phy = phyaddr << FEC_MII_DATA_PA_SHIFT;
210 writel(FEC_MII_DATA_ST | FEC_MII_DATA_OP_WR |
211 FEC_MII_DATA_TA | phy | reg | data, ð->mii_data);
213 /* wait for the MII interrupt */
214 start = get_timer(0);
215 while (!(readl(ð->ievent) & FEC_IEVENT_MII)) {
216 if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
217 printf("Write MDIO failed...\n");
222 /* clear MII interrupt bit */
223 writel(FEC_IEVENT_MII, ð->ievent);
224 debug("%s: phy: %02x reg:%02x val:%#x\n", __func__, phyaddr,
230 static int fec_phy_read(struct mii_dev *bus, int phyaddr, int dev_addr,
233 return fec_mdio_read(bus->priv, phyaddr, regaddr);
236 static int fec_phy_write(struct mii_dev *bus, int phyaddr, int dev_addr,
237 int regaddr, u16 data)
239 return fec_mdio_write(bus->priv, phyaddr, regaddr, data);
242 #ifndef CONFIG_PHYLIB
243 static int miiphy_restart_aneg(struct eth_device *dev)
246 #if !defined(CONFIG_FEC_MXC_NO_ANEG)
247 struct fec_priv *fec = (struct fec_priv *)dev->priv;
248 struct ethernet_regs *eth = fec->bus->priv;
251 * Wake up from sleep if necessary
252 * Reset PHY, then delay 300ns
255 fec_mdio_write(eth, fec->phy_id, MII_DCOUNTER, 0x00FF);
257 fec_mdio_write(eth, fec->phy_id, MII_BMCR, BMCR_RESET);
260 /* Set the auto-negotiation advertisement register bits */
261 fec_mdio_write(eth, fec->phy_id, MII_ADVERTISE,
262 LPA_100FULL | LPA_100HALF | LPA_10FULL |
263 LPA_10HALF | PHY_ANLPAR_PSB_802_3);
264 fec_mdio_write(eth, fec->phy_id, MII_BMCR,
265 BMCR_ANENABLE | BMCR_ANRESTART);
267 if (fec->mii_postcall)
268 ret = fec->mii_postcall(fec->phy_id);
274 #ifndef CONFIG_FEC_FIXED_SPEED
275 static int miiphy_wait_aneg(struct eth_device *dev)
279 struct fec_priv *fec = (struct fec_priv *)dev->priv;
280 struct ethernet_regs *eth = fec->bus->priv;
282 /* Wait for AN completion */
283 start = get_timer(0);
285 if (get_timer(start) > (CONFIG_SYS_HZ * 5)) {
286 printf("%s: Autonegotiation timeout\n", dev->name);
290 status = fec_mdio_read(eth, fec->phy_id, MII_BMSR);
292 printf("%s: Autonegotiation failed. status: %d\n",
296 } while (!(status & BMSR_LSTATUS));
300 #endif /* CONFIG_FEC_FIXED_SPEED */
303 static int fec_rx_task_enable(struct fec_priv *fec)
305 writel(FEC_R_DES_ACTIVE_RDAR, &fec->eth->r_des_active);
309 static int fec_rx_task_disable(struct fec_priv *fec)
314 static int fec_tx_task_enable(struct fec_priv *fec)
316 writel(FEC_X_DES_ACTIVE_TDAR, &fec->eth->x_des_active);
320 static int fec_tx_task_disable(struct fec_priv *fec)
326 * Initialize receive task's buffer descriptors
327 * @param[in] fec all we know about the device yet
328 * @param[in] count receive buffer count to be allocated
329 * @param[in] dsize desired size of each receive buffer
330 * @return 0 on success
332 * Init all RX descriptors to default values.
334 static void fec_rbd_init(struct fec_priv *fec, int count, int dsize)
341 * Reload the RX descriptors with default values and wipe
344 size = roundup(dsize, ARCH_DMA_MINALIGN);
345 for (i = 0; i < count; i++) {
346 data = fec->rbd_base[i].data_pointer;
347 memset((void *)data, 0, dsize);
348 flush_dcache_range(data, data + size);
350 fec->rbd_base[i].status = FEC_RBD_EMPTY;
351 fec->rbd_base[i].data_length = 0;
354 /* Mark the last RBD to close the ring. */
355 fec->rbd_base[i - 1].status = FEC_RBD_WRAP | FEC_RBD_EMPTY;
358 flush_dcache_range((ulong)fec->rbd_base,
359 (ulong)fec->rbd_base + size);
363 * Initialize transmit task's buffer descriptors
364 * @param[in] fec all we know about the device yet
366 * Transmit buffers are created externally. We only have to init the BDs here.\n
367 * Note: There is a race condition in the hardware. When only one BD is in
368 * use it must be marked with the WRAP bit to use it for every transmitt.
369 * This bit in combination with the READY bit results into double transmit
370 * of each data buffer. It seems the state machine checks READY earlier then
371 * resetting it after the first transfer.
372 * Using two BDs solves this issue.
374 static void fec_tbd_init(struct fec_priv *fec)
376 ulong addr = (ulong)fec->tbd_base;
377 unsigned size = roundup(2 * sizeof(struct fec_bd),
380 memset(fec->tbd_base, 0, size);
381 fec->tbd_base[0].status = 0;
382 fec->tbd_base[1].status = FEC_TBD_WRAP;
384 flush_dcache_range(addr, addr + size);
388 * Mark the given read buffer descriptor as free
389 * @param[in] last 1 if this is the last buffer descriptor in the chain, else 0
390 * @param[in] prbd buffer descriptor to mark free again
392 static void fec_rbd_clean(int last, struct fec_bd *prbd)
394 unsigned short flags = FEC_RBD_EMPTY;
396 flags |= FEC_RBD_WRAP;
397 writew(flags, &prbd->status);
398 writew(0, &prbd->data_length);
401 static int fec_get_hwaddr(int dev_id, unsigned char *mac)
403 imx_get_mac_from_fuse(dev_id, mac);
404 return !is_valid_ethaddr(mac);
408 static int fecmxc_set_hwaddr(struct udevice *dev)
410 static int fec_set_hwaddr(struct eth_device *dev)
414 struct fec_priv *fec = dev_get_priv(dev);
415 struct eth_pdata *pdata = dev_get_platdata(dev);
416 uchar *mac = pdata->enetaddr;
418 uchar *mac = dev->enetaddr;
419 struct fec_priv *fec = (struct fec_priv *)dev->priv;
422 writel(0, &fec->eth->iaddr1);
423 writel(0, &fec->eth->iaddr2);
424 writel(0, &fec->eth->gaddr1);
425 writel(0, &fec->eth->gaddr2);
427 /* Set physical address */
428 writel((mac[0] << 24) + (mac[1] << 16) + (mac[2] << 8) + mac[3],
430 writel((mac[4] << 24) + (mac[5] << 16) + 0x8808, &fec->eth->paddr2);
435 /* Do initial configuration of the FEC registers */
436 static void fec_reg_setup(struct fec_priv *fec)
440 /* Set interrupt mask register */
441 writel(0x00000000, &fec->eth->imask);
443 /* Clear FEC-Lite interrupt event register(IEVENT) */
444 writel(0xffffffff, &fec->eth->ievent);
446 /* Set FEC-Lite receive control register(R_CNTRL): */
448 /* Start with frame length = 1518, common for all modes. */
449 rcntrl = PKTSIZE << FEC_RCNTRL_MAX_FL_SHIFT;
450 if (fec->xcv_type != SEVENWIRE) /* xMII modes */
451 rcntrl |= FEC_RCNTRL_FCE | FEC_RCNTRL_MII_MODE;
452 if (fec->xcv_type == RGMII)
453 rcntrl |= FEC_RCNTRL_RGMII;
454 else if (fec->xcv_type == RMII)
455 rcntrl |= FEC_RCNTRL_RMII;
457 writel(rcntrl, &fec->eth->r_cntrl);
461 * Start the FEC engine
462 * @param[in] dev Our device to handle
465 static int fec_open(struct udevice *dev)
467 static int fec_open(struct eth_device *edev)
471 struct fec_priv *fec = dev_get_priv(dev);
473 struct fec_priv *fec = (struct fec_priv *)edev->priv;
479 debug("fec_open: fec_open(dev)\n");
480 /* full-duplex, heartbeat disabled */
481 writel(1 << 2, &fec->eth->x_cntrl);
484 /* Invalidate all descriptors */
485 for (i = 0; i < FEC_RBD_NUM - 1; i++)
486 fec_rbd_clean(0, &fec->rbd_base[i]);
487 fec_rbd_clean(1, &fec->rbd_base[i]);
489 /* Flush the descriptors into RAM */
490 size = roundup(FEC_RBD_NUM * sizeof(struct fec_bd),
492 addr = (ulong)fec->rbd_base;
493 flush_dcache_range(addr, addr + size);
495 #ifdef FEC_QUIRK_ENET_MAC
496 /* Enable ENET HW endian SWAP */
497 writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_DBSWAP,
499 /* Enable ENET store and forward mode */
500 writel(readl(&fec->eth->x_wmrk) | FEC_X_WMRK_STRFWD,
503 /* Enable FEC-Lite controller */
504 writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_ETHER_EN,
507 #ifdef FEC_ENET_ENABLE_TXC_DELAY
508 writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_TXC_DLY,
512 #ifdef FEC_ENET_ENABLE_RXC_DELAY
513 writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_RXC_DLY,
517 #if defined(CONFIG_MX25) || defined(CONFIG_MX53) || defined(CONFIG_MX6SL)
520 /* setup the MII gasket for RMII mode */
521 /* disable the gasket */
522 writew(0, &fec->eth->miigsk_enr);
524 /* wait for the gasket to be disabled */
525 while (readw(&fec->eth->miigsk_enr) & MIIGSK_ENR_READY)
528 /* configure gasket for RMII, 50 MHz, no loopback, and no echo */
529 writew(MIIGSK_CFGR_IF_MODE_RMII, &fec->eth->miigsk_cfgr);
531 /* re-enable the gasket */
532 writew(MIIGSK_ENR_EN, &fec->eth->miigsk_enr);
534 /* wait until MII gasket is ready */
536 while ((readw(&fec->eth->miigsk_enr) & MIIGSK_ENR_READY) == 0) {
537 if (--max_loops <= 0) {
538 printf("WAIT for MII Gasket ready timed out\n");
546 /* Start up the PHY */
547 int ret = phy_startup(fec->phydev);
550 printf("Could not initialize PHY %s\n",
551 fec->phydev->dev->name);
554 speed = fec->phydev->speed;
556 #elif CONFIG_FEC_FIXED_SPEED
557 speed = CONFIG_FEC_FIXED_SPEED;
559 miiphy_wait_aneg(edev);
560 speed = miiphy_speed(edev->name, fec->phy_id);
561 miiphy_duplex(edev->name, fec->phy_id);
564 #ifdef FEC_QUIRK_ENET_MAC
566 u32 ecr = readl(&fec->eth->ecntrl) & ~FEC_ECNTRL_SPEED;
567 u32 rcr = readl(&fec->eth->r_cntrl) & ~FEC_RCNTRL_RMII_10T;
568 if (speed == _1000BASET)
569 ecr |= FEC_ECNTRL_SPEED;
570 else if (speed != _100BASET)
571 rcr |= FEC_RCNTRL_RMII_10T;
572 writel(ecr, &fec->eth->ecntrl);
573 writel(rcr, &fec->eth->r_cntrl);
576 debug("%s:Speed=%i\n", __func__, speed);
578 /* Enable SmartDMA receive task */
579 fec_rx_task_enable(fec);
586 static int fecmxc_init(struct udevice *dev)
588 static int fec_init(struct eth_device *dev, bd_t *bd)
592 struct fec_priv *fec = dev_get_priv(dev);
594 struct fec_priv *fec = (struct fec_priv *)dev->priv;
596 u8 *mib_ptr = (uint8_t *)&fec->eth->rmon_t_drop;
600 /* Initialize MAC address */
602 fecmxc_set_hwaddr(dev);
607 /* Setup transmit descriptors, there are two in total. */
610 /* Setup receive descriptors. */
611 fec_rbd_init(fec, FEC_RBD_NUM, FEC_MAX_PKT_SIZE);
615 if (fec->xcv_type != SEVENWIRE)
616 fec_mii_setspeed(fec->bus->priv);
618 /* Set Opcode/Pause Duration Register */
619 writel(0x00010020, &fec->eth->op_pause); /* FIXME 0xffff0020; */
620 writel(0x2, &fec->eth->x_wmrk);
622 /* Set multicast address filter */
623 writel(0x00000000, &fec->eth->gaddr1);
624 writel(0x00000000, &fec->eth->gaddr2);
626 /* Do not access reserved register */
627 if (!is_mx6ul() && !is_mx6ull() && !is_imx8() && !is_imx8m()) {
629 for (i = mib_ptr; i <= mib_ptr + 0xfc; i += 4)
632 /* FIFO receive start register */
633 writel(0x520, &fec->eth->r_fstart);
636 /* size and address of each buffer */
637 writel(FEC_MAX_PKT_SIZE, &fec->eth->emrbr);
639 addr = (ulong)fec->tbd_base;
640 writel((uint32_t)addr, &fec->eth->etdsr);
642 addr = (ulong)fec->rbd_base;
643 writel((uint32_t)addr, &fec->eth->erdsr);
645 #ifndef CONFIG_PHYLIB
646 if (fec->xcv_type != SEVENWIRE)
647 miiphy_restart_aneg(dev);
654 * Halt the FEC engine
655 * @param[in] dev Our device to handle
658 static void fecmxc_halt(struct udevice *dev)
660 static void fec_halt(struct eth_device *dev)
664 struct fec_priv *fec = dev_get_priv(dev);
666 struct fec_priv *fec = (struct fec_priv *)dev->priv;
668 int counter = 0xffff;
670 /* issue graceful stop command to the FEC transmitter if necessary */
671 writel(FEC_TCNTRL_GTS | readl(&fec->eth->x_cntrl),
674 debug("eth_halt: wait for stop regs\n");
675 /* wait for graceful stop to register */
676 while ((counter--) && (!(readl(&fec->eth->ievent) & FEC_IEVENT_GRA)))
679 /* Disable SmartDMA tasks */
680 fec_tx_task_disable(fec);
681 fec_rx_task_disable(fec);
684 * Disable the Ethernet Controller
685 * Note: this will also reset the BD index counter!
687 writel(readl(&fec->eth->ecntrl) & ~FEC_ECNTRL_ETHER_EN,
691 debug("eth_halt: done\n");
696 * @param[in] dev Our ethernet device to handle
697 * @param[in] packet Pointer to the data to be transmitted
698 * @param[in] length Data count in bytes
699 * @return 0 on success
702 static int fecmxc_send(struct udevice *dev, void *packet, int length)
704 static int fec_send(struct eth_device *dev, void *packet, int length)
710 int timeout = FEC_XFER_TIMEOUT;
714 * This routine transmits one frame. This routine only accepts
715 * 6-byte Ethernet addresses.
718 struct fec_priv *fec = dev_get_priv(dev);
720 struct fec_priv *fec = (struct fec_priv *)dev->priv;
724 * Check for valid length of data.
726 if ((length > 1500) || (length <= 0)) {
727 printf("Payload (%d) too large\n", length);
732 * Setup the transmit buffer. We are always using the first buffer for
733 * transmission, the second will be empty and only used to stop the DMA
734 * engine. We also flush the packet to RAM here to avoid cache trouble.
736 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
737 swap_packet((uint32_t *)packet, length);
740 addr = (ulong)packet;
741 end = roundup(addr + length, ARCH_DMA_MINALIGN);
742 addr &= ~(ARCH_DMA_MINALIGN - 1);
743 flush_dcache_range(addr, end);
745 writew(length, &fec->tbd_base[fec->tbd_index].data_length);
746 writel((uint32_t)addr, &fec->tbd_base[fec->tbd_index].data_pointer);
749 * update BD's status now
751 * - is always the last in a chain (means no chain)
752 * - should transmitt the CRC
753 * - might be the last BD in the list, so the address counter should
754 * wrap (-> keep the WRAP flag)
756 status = readw(&fec->tbd_base[fec->tbd_index].status) & FEC_TBD_WRAP;
757 status |= FEC_TBD_LAST | FEC_TBD_TC | FEC_TBD_READY;
758 writew(status, &fec->tbd_base[fec->tbd_index].status);
761 * Flush data cache. This code flushes both TX descriptors to RAM.
762 * After this code, the descriptors will be safely in RAM and we
765 size = roundup(2 * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
766 addr = (ulong)fec->tbd_base;
767 flush_dcache_range(addr, addr + size);
770 * Below we read the DMA descriptor's last four bytes back from the
771 * DRAM. This is important in order to make sure that all WRITE
772 * operations on the bus that were triggered by previous cache FLUSH
775 * Otherwise, on MX28, it is possible to observe a corruption of the
776 * DMA descriptors. Please refer to schematic "Figure 1-2" in MX28RM
777 * for the bus structure of MX28. The scenario is as follows:
779 * 1) ARM core triggers a series of WRITEs on the AHB_ARB2 bus going
780 * to DRAM due to flush_dcache_range()
781 * 2) ARM core writes the FEC registers via AHB_ARB2
782 * 3) FEC DMA starts reading/writing from/to DRAM via AHB_ARB3
784 * Note that 2) does sometimes finish before 1) due to reordering of
785 * WRITE accesses on the AHB bus, therefore triggering 3) before the
786 * DMA descriptor is fully written into DRAM. This results in occasional
787 * corruption of the DMA descriptor.
789 readl(addr + size - 4);
791 /* Enable SmartDMA transmit task */
792 fec_tx_task_enable(fec);
795 * Wait until frame is sent. On each turn of the wait cycle, we must
796 * invalidate data cache to see what's really in RAM. Also, we need
800 if (!(readl(&fec->eth->x_des_active) & FEC_X_DES_ACTIVE_TDAR))
810 * The TDAR bit is cleared when the descriptors are all out from TX
811 * but on mx6solox we noticed that the READY bit is still not cleared
813 * These are two distinct signals, and in IC simulation, we found that
814 * TDAR always gets cleared prior than the READY bit of last BD becomes
816 * In mx6solox, we use a later version of FEC IP. It looks like that
817 * this intrinsic behaviour of TDAR bit has changed in this newer FEC
820 * Fix this by polling the READY bit of BD after the TDAR polling,
821 * which covers the mx6solox case and does not harm the other SoCs.
823 timeout = FEC_XFER_TIMEOUT;
825 invalidate_dcache_range(addr, addr + size);
826 if (!(readw(&fec->tbd_base[fec->tbd_index].status) &
835 debug("fec_send: status 0x%x index %d ret %i\n",
836 readw(&fec->tbd_base[fec->tbd_index].status),
837 fec->tbd_index, ret);
838 /* for next transmission use the other buffer */
848 * Pull one frame from the card
849 * @param[in] dev Our ethernet device to handle
850 * @return Length of packet read
853 static int fecmxc_recv(struct udevice *dev, int flags, uchar **packetp)
855 static int fec_recv(struct eth_device *dev)
859 struct fec_priv *fec = dev_get_priv(dev);
861 struct fec_priv *fec = (struct fec_priv *)dev->priv;
863 struct fec_bd *rbd = &fec->rbd_base[fec->rbd_index];
864 unsigned long ievent;
865 int frame_length, len = 0;
867 ulong addr, size, end;
871 *packetp = memalign(ARCH_DMA_MINALIGN, FEC_MAX_PKT_SIZE);
873 printf("%s: error allocating packetp\n", __func__);
877 ALLOC_CACHE_ALIGN_BUFFER(uchar, buff, FEC_MAX_PKT_SIZE);
880 /* Check if any critical events have happened */
881 ievent = readl(&fec->eth->ievent);
882 writel(ievent, &fec->eth->ievent);
883 debug("fec_recv: ievent 0x%lx\n", ievent);
884 if (ievent & FEC_IEVENT_BABR) {
890 fec_init(dev, fec->bd);
892 printf("some error: 0x%08lx\n", ievent);
895 if (ievent & FEC_IEVENT_HBERR) {
896 /* Heartbeat error */
897 writel(0x00000001 | readl(&fec->eth->x_cntrl),
900 if (ievent & FEC_IEVENT_GRA) {
901 /* Graceful stop complete */
902 if (readl(&fec->eth->x_cntrl) & 0x00000001) {
908 writel(~0x00000001 & readl(&fec->eth->x_cntrl),
913 fec_init(dev, fec->bd);
919 * Read the buffer status. Before the status can be read, the data cache
920 * must be invalidated, because the data in RAM might have been changed
921 * by DMA. The descriptors are properly aligned to cachelines so there's
922 * no need to worry they'd overlap.
924 * WARNING: By invalidating the descriptor here, we also invalidate
925 * the descriptors surrounding this one. Therefore we can NOT change the
926 * contents of this descriptor nor the surrounding ones. The problem is
927 * that in order to mark the descriptor as processed, we need to change
928 * the descriptor. The solution is to mark the whole cache line when all
929 * descriptors in the cache line are processed.
932 addr &= ~(ARCH_DMA_MINALIGN - 1);
933 size = roundup(sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
934 invalidate_dcache_range(addr, addr + size);
936 bd_status = readw(&rbd->status);
937 debug("fec_recv: status 0x%x\n", bd_status);
939 if (!(bd_status & FEC_RBD_EMPTY)) {
940 if ((bd_status & FEC_RBD_LAST) && !(bd_status & FEC_RBD_ERR) &&
941 ((readw(&rbd->data_length) - 4) > 14)) {
942 /* Get buffer address and size */
943 addr = readl(&rbd->data_pointer);
944 frame_length = readw(&rbd->data_length) - 4;
945 /* Invalidate data cache over the buffer */
946 end = roundup(addr + frame_length, ARCH_DMA_MINALIGN);
947 addr &= ~(ARCH_DMA_MINALIGN - 1);
948 invalidate_dcache_range(addr, end);
950 /* Fill the buffer and pass it to upper layers */
951 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
952 swap_packet((uint32_t *)addr, frame_length);
956 memcpy(*packetp, (char *)addr, frame_length);
958 memcpy(buff, (char *)addr, frame_length);
959 net_process_received_packet(buff, frame_length);
963 if (bd_status & FEC_RBD_ERR)
964 debug("error frame: 0x%08lx 0x%08x\n",
969 * Free the current buffer, restart the engine and move forward
970 * to the next buffer. Here we check if the whole cacheline of
971 * descriptors was already processed and if so, we mark it free
974 size = RXDESC_PER_CACHELINE - 1;
975 if ((fec->rbd_index & size) == size) {
976 i = fec->rbd_index - size;
977 addr = (ulong)&fec->rbd_base[i];
978 for (; i <= fec->rbd_index ; i++) {
979 fec_rbd_clean(i == (FEC_RBD_NUM - 1),
982 flush_dcache_range(addr,
983 addr + ARCH_DMA_MINALIGN);
986 fec_rx_task_enable(fec);
987 fec->rbd_index = (fec->rbd_index + 1) % FEC_RBD_NUM;
989 debug("fec_recv: stop\n");
994 static void fec_set_dev_name(char *dest, int dev_id)
996 sprintf(dest, (dev_id == -1) ? "FEC" : "FEC%i", dev_id);
999 static int fec_alloc_descs(struct fec_priv *fec)
1006 /* Allocate TX descriptors. */
1007 size = roundup(2 * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
1008 fec->tbd_base = memalign(ARCH_DMA_MINALIGN, size);
1012 /* Allocate RX descriptors. */
1013 size = roundup(FEC_RBD_NUM * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
1014 fec->rbd_base = memalign(ARCH_DMA_MINALIGN, size);
1018 memset(fec->rbd_base, 0, size);
1020 /* Allocate RX buffers. */
1022 /* Maximum RX buffer size. */
1023 size = roundup(FEC_MAX_PKT_SIZE, FEC_DMA_RX_MINALIGN);
1024 for (i = 0; i < FEC_RBD_NUM; i++) {
1025 data = memalign(FEC_DMA_RX_MINALIGN, size);
1027 printf("%s: error allocating rxbuf %d\n", __func__, i);
1031 memset(data, 0, size);
1034 fec->rbd_base[i].data_pointer = (uint32_t)addr;
1035 fec->rbd_base[i].status = FEC_RBD_EMPTY;
1036 fec->rbd_base[i].data_length = 0;
1037 /* Flush the buffer to memory. */
1038 flush_dcache_range(addr, addr + size);
1041 /* Mark the last RBD to close the ring. */
1042 fec->rbd_base[i - 1].status = FEC_RBD_WRAP | FEC_RBD_EMPTY;
1050 for (; i >= 0; i--) {
1051 addr = fec->rbd_base[i].data_pointer;
1054 free(fec->rbd_base);
1056 free(fec->tbd_base);
1061 static void fec_free_descs(struct fec_priv *fec)
1066 for (i = 0; i < FEC_RBD_NUM; i++) {
1067 addr = fec->rbd_base[i].data_pointer;
1070 free(fec->rbd_base);
1071 free(fec->tbd_base);
1074 struct mii_dev *fec_get_miibus(ulong base_addr, int dev_id)
1076 struct ethernet_regs *eth = (struct ethernet_regs *)base_addr;
1077 struct mii_dev *bus;
1082 printf("mdio_alloc failed\n");
1085 bus->read = fec_phy_read;
1086 bus->write = fec_phy_write;
1088 fec_set_dev_name(bus->name, dev_id);
1090 ret = mdio_register(bus);
1092 printf("mdio_register failed\n");
1096 fec_mii_setspeed(eth);
1100 #ifndef CONFIG_DM_ETH
1101 #ifdef CONFIG_PHYLIB
1102 int fec_probe(bd_t *bd, int dev_id, uint32_t base_addr,
1103 struct mii_dev *bus, struct phy_device *phydev)
1105 static int fec_probe(bd_t *bd, int dev_id, uint32_t base_addr,
1106 struct mii_dev *bus, int phy_id)
1109 struct eth_device *edev;
1110 struct fec_priv *fec;
1111 unsigned char ethaddr[6];
1116 /* create and fill edev struct */
1117 edev = (struct eth_device *)malloc(sizeof(struct eth_device));
1119 puts("fec_mxc: not enough malloc memory for eth_device\n");
1124 fec = (struct fec_priv *)malloc(sizeof(struct fec_priv));
1126 puts("fec_mxc: not enough malloc memory for fec_priv\n");
1131 memset(edev, 0, sizeof(*edev));
1132 memset(fec, 0, sizeof(*fec));
1134 ret = fec_alloc_descs(fec);
1139 edev->init = fec_init;
1140 edev->send = fec_send;
1141 edev->recv = fec_recv;
1142 edev->halt = fec_halt;
1143 edev->write_hwaddr = fec_set_hwaddr;
1145 fec->eth = (struct ethernet_regs *)(ulong)base_addr;
1148 fec->xcv_type = CONFIG_FEC_XCV_TYPE;
1151 writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_RESET, &fec->eth->ecntrl);
1152 start = get_timer(0);
1153 while (readl(&fec->eth->ecntrl) & FEC_ECNTRL_RESET) {
1154 if (get_timer(start) > (CONFIG_SYS_HZ * 5)) {
1155 printf("FEC MXC: Timeout resetting chip\n");
1162 fec_set_dev_name(edev->name, dev_id);
1163 fec->dev_id = (dev_id == -1) ? 0 : dev_id;
1165 fec_mii_setspeed(bus->priv);
1166 #ifdef CONFIG_PHYLIB
1167 fec->phydev = phydev;
1168 phy_connect_dev(phydev, edev);
1172 fec->phy_id = phy_id;
1175 /* only support one eth device, the index number pointed by dev_id */
1176 edev->index = fec->dev_id;
1178 if (fec_get_hwaddr(fec->dev_id, ethaddr) == 0) {
1179 debug("got MAC%d address from fuse: %pM\n", fec->dev_id, ethaddr);
1180 memcpy(edev->enetaddr, ethaddr, 6);
1182 sprintf(mac, "eth%daddr", fec->dev_id);
1184 strcpy(mac, "ethaddr");
1186 eth_env_set_enetaddr(mac, ethaddr);
1190 fec_free_descs(fec);
1199 int fecmxc_initialize_multi(bd_t *bd, int dev_id, int phy_id, uint32_t addr)
1202 struct mii_dev *bus = NULL;
1203 #ifdef CONFIG_PHYLIB
1204 struct phy_device *phydev = NULL;
1208 if (CONFIG_IS_ENABLED(IMX_MODULE_FUSE)) {
1209 if (enet_fused((ulong)addr)) {
1210 printf("SoC fuse indicates Ethernet@0x%x is unavailable.\n", addr);
1215 #ifdef CONFIG_FEC_MXC_MDIO_BASE
1217 * The i.MX28 has two ethernet interfaces, but they are not equal.
1218 * Only the first one can access the MDIO bus.
1220 base_mii = CONFIG_FEC_MXC_MDIO_BASE;
1224 debug("eth_init: fec_probe(bd, %i, %i) @ %08x\n", dev_id, phy_id, addr);
1225 bus = fec_get_miibus(base_mii, dev_id);
1228 #ifdef CONFIG_PHYLIB
1229 phydev = phy_find_by_mask(bus, 1 << phy_id, PHY_INTERFACE_MODE_RGMII);
1231 mdio_unregister(bus);
1235 ret = fec_probe(bd, dev_id, addr, bus, phydev);
1237 ret = fec_probe(bd, dev_id, addr, bus, phy_id);
1240 #ifdef CONFIG_PHYLIB
1243 mdio_unregister(bus);
1249 #ifdef CONFIG_FEC_MXC_PHYADDR
1250 int fecmxc_initialize(bd_t *bd)
1252 return fecmxc_initialize_multi(bd, -1, CONFIG_FEC_MXC_PHYADDR,
1257 #ifndef CONFIG_PHYLIB
1258 int fecmxc_register_mii_postcall(struct eth_device *dev, int (*cb)(int))
1260 struct fec_priv *fec = (struct fec_priv *)dev->priv;
1261 fec->mii_postcall = cb;
1268 static int fecmxc_read_rom_hwaddr(struct udevice *dev)
1270 struct fec_priv *priv = dev_get_priv(dev);
1271 struct eth_pdata *pdata = dev_get_platdata(dev);
1273 return fec_get_hwaddr(priv->dev_id, pdata->enetaddr);
1276 static int fecmxc_free_pkt(struct udevice *dev, uchar *packet, int length)
1284 static const struct eth_ops fecmxc_ops = {
1285 .start = fecmxc_init,
1286 .send = fecmxc_send,
1287 .recv = fecmxc_recv,
1288 .free_pkt = fecmxc_free_pkt,
1289 .stop = fecmxc_halt,
1290 .write_hwaddr = fecmxc_set_hwaddr,
1291 .read_rom_hwaddr = fecmxc_read_rom_hwaddr,
1294 static int device_get_phy_addr(struct udevice *dev)
1296 struct ofnode_phandle_args phandle_args;
1299 if (dev_read_phandle_with_args(dev, "phy-handle", NULL, 0, 0,
1301 debug("Failed to find phy-handle");
1305 reg = ofnode_read_u32_default(phandle_args.node, "reg", 0);
1310 static int fec_phy_init(struct fec_priv *priv, struct udevice *dev)
1312 struct phy_device *phydev;
1315 addr = device_get_phy_addr(dev);
1316 #ifdef CONFIG_FEC_MXC_PHYADDR
1317 addr = CONFIG_FEC_MXC_PHYADDR;
1320 phydev = phy_connect(priv->bus, addr, dev, priv->interface);
1324 priv->phydev = phydev;
1330 #if CONFIG_IS_ENABLED(DM_GPIO)
1331 /* FEC GPIO reset */
1332 static void fec_gpio_reset(struct fec_priv *priv)
1334 debug("fec_gpio_reset: fec_gpio_reset(dev)\n");
1335 if (dm_gpio_is_valid(&priv->phy_reset_gpio)) {
1336 dm_gpio_set_value(&priv->phy_reset_gpio, 1);
1337 mdelay(priv->reset_delay);
1338 dm_gpio_set_value(&priv->phy_reset_gpio, 0);
1339 if (priv->reset_post_delay)
1340 mdelay(priv->reset_post_delay);
1345 static int fecmxc_probe(struct udevice *dev)
1347 struct eth_pdata *pdata = dev_get_platdata(dev);
1348 struct fec_priv *priv = dev_get_priv(dev);
1349 struct mii_dev *bus = NULL;
1353 if (CONFIG_IS_ENABLED(IMX_MODULE_FUSE)) {
1354 if (enet_fused((ulong)priv->eth)) {
1355 printf("SoC fuse indicates Ethernet@0x%lx is unavailable.\n", (ulong)priv->eth);
1360 if (IS_ENABLED(CONFIG_IMX8)) {
1361 ret = clk_get_by_name(dev, "ipg", &priv->ipg_clk);
1363 debug("Can't get FEC ipg clk: %d\n", ret);
1366 ret = clk_enable(&priv->ipg_clk);
1368 debug("Can't enable FEC ipg clk: %d\n", ret);
1372 priv->clk_rate = clk_get_rate(&priv->ipg_clk);
1373 } else if (CONFIG_IS_ENABLED(CLK_CCF)) {
1374 ret = clk_get_by_name(dev, "ipg", &priv->ipg_clk);
1376 debug("Can't get FEC ipg clk: %d\n", ret);
1379 ret = clk_enable(&priv->ipg_clk);
1383 ret = clk_get_by_name(dev, "ahb", &priv->ahb_clk);
1385 debug("Can't get FEC ahb clk: %d\n", ret);
1388 ret = clk_enable(&priv->ahb_clk);
1392 ret = clk_get_by_name(dev, "enet_out", &priv->clk_enet_out);
1394 ret = clk_enable(&priv->clk_enet_out);
1399 ret = clk_get_by_name(dev, "enet_clk_ref", &priv->clk_ref);
1401 ret = clk_enable(&priv->clk_ref);
1406 ret = clk_get_by_name(dev, "ptp", &priv->clk_ptp);
1408 ret = clk_enable(&priv->clk_ptp);
1413 priv->clk_rate = clk_get_rate(&priv->ipg_clk);
1416 ret = fec_alloc_descs(priv);
1420 #ifdef CONFIG_DM_REGULATOR
1421 if (priv->phy_supply) {
1422 ret = regulator_set_enable(priv->phy_supply, true);
1424 printf("%s: Error enabling phy supply\n", dev->name);
1430 #if CONFIG_IS_ENABLED(DM_GPIO)
1431 fec_gpio_reset(priv);
1434 writel(readl(&priv->eth->ecntrl) | FEC_ECNTRL_RESET,
1435 &priv->eth->ecntrl);
1436 start = get_timer(0);
1437 while (readl(&priv->eth->ecntrl) & FEC_ECNTRL_RESET) {
1438 if (get_timer(start) > (CONFIG_SYS_HZ * 5)) {
1439 printf("FEC MXC: Timeout reseting chip\n");
1445 fec_reg_setup(priv);
1447 priv->dev_id = dev->seq;
1449 #ifdef CONFIG_DM_ETH_PHY
1450 bus = eth_phy_get_mdio_bus(dev);
1454 #ifdef CONFIG_FEC_MXC_MDIO_BASE
1455 bus = fec_get_miibus((ulong)CONFIG_FEC_MXC_MDIO_BASE, dev->seq);
1457 bus = fec_get_miibus((ulong)priv->eth, dev->seq);
1465 #ifdef CONFIG_DM_ETH_PHY
1466 eth_phy_set_mdio_bus(dev, bus);
1470 priv->interface = pdata->phy_interface;
1471 switch (priv->interface) {
1472 case PHY_INTERFACE_MODE_MII:
1473 priv->xcv_type = MII100;
1475 case PHY_INTERFACE_MODE_RMII:
1476 priv->xcv_type = RMII;
1478 case PHY_INTERFACE_MODE_RGMII:
1479 case PHY_INTERFACE_MODE_RGMII_ID:
1480 case PHY_INTERFACE_MODE_RGMII_RXID:
1481 case PHY_INTERFACE_MODE_RGMII_TXID:
1482 priv->xcv_type = RGMII;
1485 priv->xcv_type = CONFIG_FEC_XCV_TYPE;
1486 printf("Unsupported interface type %d defaulting to %d\n",
1487 priv->interface, priv->xcv_type);
1491 ret = fec_phy_init(priv, dev);
1498 mdio_unregister(bus);
1502 fec_free_descs(priv);
1506 static int fecmxc_remove(struct udevice *dev)
1508 struct fec_priv *priv = dev_get_priv(dev);
1511 fec_free_descs(priv);
1512 mdio_unregister(priv->bus);
1513 mdio_free(priv->bus);
1515 #ifdef CONFIG_DM_REGULATOR
1516 if (priv->phy_supply)
1517 regulator_set_enable(priv->phy_supply, false);
1523 static int fecmxc_ofdata_to_platdata(struct udevice *dev)
1526 struct eth_pdata *pdata = dev_get_platdata(dev);
1527 struct fec_priv *priv = dev_get_priv(dev);
1528 const char *phy_mode;
1530 pdata->iobase = (phys_addr_t)devfdt_get_addr(dev);
1531 priv->eth = (struct ethernet_regs *)pdata->iobase;
1533 pdata->phy_interface = -1;
1534 phy_mode = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy-mode",
1537 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
1538 if (pdata->phy_interface == -1) {
1539 debug("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
1543 #ifdef CONFIG_DM_REGULATOR
1544 device_get_supply_regulator(dev, "phy-supply", &priv->phy_supply);
1547 #if CONFIG_IS_ENABLED(DM_GPIO)
1548 ret = gpio_request_by_name(dev, "phy-reset-gpios", 0,
1549 &priv->phy_reset_gpio, GPIOD_IS_OUT);
1551 return 0; /* property is optional, don't return error! */
1553 priv->reset_delay = dev_read_u32_default(dev, "phy-reset-duration", 1);
1554 if (priv->reset_delay > 1000) {
1555 printf("FEC MXC: phy reset duration should be <= 1000ms\n");
1556 /* property value wrong, use default value */
1557 priv->reset_delay = 1;
1560 priv->reset_post_delay = dev_read_u32_default(dev,
1561 "phy-reset-post-delay",
1563 if (priv->reset_post_delay > 1000) {
1564 printf("FEC MXC: phy reset post delay should be <= 1000ms\n");
1565 /* property value wrong, use default value */
1566 priv->reset_post_delay = 0;
1573 static const struct udevice_id fecmxc_ids[] = {
1574 { .compatible = "fsl,imx28-fec" },
1575 { .compatible = "fsl,imx6q-fec" },
1576 { .compatible = "fsl,imx6sl-fec" },
1577 { .compatible = "fsl,imx6sx-fec" },
1578 { .compatible = "fsl,imx6ul-fec" },
1579 { .compatible = "fsl,imx53-fec" },
1580 { .compatible = "fsl,imx7d-fec" },
1581 { .compatible = "fsl,mvf600-fec" },
1585 U_BOOT_DRIVER(fecmxc_gem) = {
1588 .of_match = fecmxc_ids,
1589 .ofdata_to_platdata = fecmxc_ofdata_to_platdata,
1590 .probe = fecmxc_probe,
1591 .remove = fecmxc_remove,
1593 .priv_auto_alloc_size = sizeof(struct fec_priv),
1594 .platdata_auto_alloc_size = sizeof(struct eth_pdata),