net: fec_mxc: don't write to reserved register on i.MX6UL
[karo-tx-uboot.git] / drivers / net / fec_mxc.c
1 /*
2  * (C) Copyright 2009 Ilya Yanok, Emcraft Systems Ltd <yanok@emcraft.com>
3  * (C) Copyright 2008,2009 Eric Jarrige <eric.jarrige@armadeus.org>
4  * (C) Copyright 2008 Armadeus Systems nc
5  * (C) Copyright 2007 Pengutronix, Sascha Hauer <s.hauer@pengutronix.de>
6  * (C) Copyright 2007 Pengutronix, Juergen Beisert <j.beisert@pengutronix.de>
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  */
10
11 #include <common.h>
12 #include <malloc.h>
13 #include <net.h>
14 #include <netdev.h>
15 #include <miiphy.h>
16
17 #include <asm/arch/sys_proto.h>
18 #include <asm/arch/clock.h>
19 #include <asm/arch/imx-regs.h>
20 #include <asm/io.h>
21 #include <asm/errno.h>
22 #include <linux/compiler.h>
23
24 #include "fec_mxc.h"
25
26 DECLARE_GLOBAL_DATA_PTR;
27
28 /*
29  * Timeout the transfer after 5 mS. This is usually a bit more, since
30  * the code in the tightloops this timeout is used in adds some overhead.
31  */
32 #define FEC_XFER_TIMEOUT        5000
33
34 /*
35  * The standard 32-byte DMA alignment does not work on mx6solox, which requires
36  * 64-byte alignment in the DMA RX FEC buffer.
37  * Introduce the FEC_DMA_RX_MINALIGN which can cover mx6solox needs and also
38  * satisfies the alignment on other SoCs (32-bytes)
39  */
40 #define FEC_DMA_RX_MINALIGN     64
41
42 #ifndef CONFIG_MII
43 #error "CONFIG_MII has to be defined!"
44 #endif
45
46 #ifndef CONFIG_FEC_XCV_TYPE
47 #define CONFIG_FEC_XCV_TYPE MII100
48 #endif
49
50 /*
51  * The i.MX28 operates with packets in big endian. We need to swap them before
52  * sending and after receiving.
53  */
54 #ifdef CONFIG_SOC_MX28
55 #define CONFIG_FEC_MXC_SWAP_PACKET
56 #endif
57
58 #define RXDESC_PER_CACHELINE (ARCH_DMA_MINALIGN/sizeof(struct fec_bd))
59
60 /* Check various alignment issues at compile time */
61 #if ((ARCH_DMA_MINALIGN < 16) || (ARCH_DMA_MINALIGN % 16 != 0))
62 #error "ARCH_DMA_MINALIGN must be multiple of 16!"
63 #endif
64
65 #if ((PKTALIGN < ARCH_DMA_MINALIGN) || \
66         (PKTALIGN % ARCH_DMA_MINALIGN != 0))
67 #error "PKTALIGN must be multiple of ARCH_DMA_MINALIGN!"
68 #endif
69
70 #undef DEBUG
71
72 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
73 static void swap_packet(uint32_t *packet, int length)
74 {
75         int i;
76
77         for (i = 0; i < DIV_ROUND_UP(length, 4); i++)
78                 packet[i] = __swab32(packet[i]);
79 }
80 #endif
81
82 /*
83  * MII-interface related functions
84  */
85 static int fec_mdio_read(struct ethernet_regs *eth, uint8_t phyAddr,
86                 uint8_t regAddr)
87 {
88         uint32_t reg;           /* convenient holder for the PHY register */
89         uint32_t phy;           /* convenient holder for the PHY */
90         ulong start;
91         int val;
92
93         /*
94          * reading from any PHY's register is done by properly
95          * programming the FEC's MII data register.
96          */
97         writel(FEC_IEVENT_MII, &eth->ievent);
98         reg = regAddr << FEC_MII_DATA_RA_SHIFT;
99         phy = phyAddr << FEC_MII_DATA_PA_SHIFT;
100
101         writel(FEC_MII_DATA_ST | FEC_MII_DATA_OP_RD | FEC_MII_DATA_TA |
102                         phy | reg, &eth->mii_data);
103
104         /*
105          * wait for the related interrupt
106          */
107         start = get_timer(0);
108         while (!(readl(&eth->ievent) & FEC_IEVENT_MII)) {
109                 if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
110                         if (readl(&eth->ievent) & FEC_IEVENT_MII)
111                                 break;
112                         printf("Read MDIO failed...\n");
113                         return -1;
114                 }
115         }
116
117         /*
118          * clear mii interrupt bit
119          */
120         writel(FEC_IEVENT_MII, &eth->ievent);
121
122         /*
123          * it's now safe to read the PHY's register
124          */
125         val = (unsigned short)readl(&eth->mii_data);
126         debug("%s: phy: %02x reg:%02x val:%#06x\n", __func__, phyAddr,
127                         regAddr, val);
128         return val;
129 }
130
131 static void fec_mii_setspeed(struct ethernet_regs *eth)
132 {
133         /*
134          * Set MII_SPEED = (1/(mii_speed * 2)) * System Clock
135          * and do not drop the Preamble.
136          */
137         register u32 speed = DIV_ROUND_UP(imx_get_fecclk(), 5000000);
138 #ifdef FEC_QUIRK_ENET_MAC
139         speed--;
140 #endif
141         speed <<= 1;
142         writel(speed, &eth->mii_speed);
143         debug("%s: mii_speed %08x\n", __func__, readl(&eth->mii_speed));
144 }
145
146 static int fec_mdio_write(struct ethernet_regs *eth, uint8_t phyAddr,
147                 uint8_t regAddr, uint16_t data)
148 {
149         uint32_t reg;           /* convenient holder for the PHY register */
150         uint32_t phy;           /* convenient holder for the PHY */
151         ulong start;
152
153         reg = regAddr << FEC_MII_DATA_RA_SHIFT;
154         phy = phyAddr << FEC_MII_DATA_PA_SHIFT;
155
156         writel(FEC_MII_DATA_ST | FEC_MII_DATA_OP_WR |
157                 FEC_MII_DATA_TA | phy | reg | data, &eth->mii_data);
158
159         /*
160          * wait for the MII interrupt
161          */
162         start = get_timer(0);
163         while (!(readl(&eth->ievent) & FEC_IEVENT_MII)) {
164                 if (get_timer(start) > (CONFIG_SYS_HZ / 1000)) {
165                         if (readl(&eth->ievent) & FEC_IEVENT_MII)
166                                 break;
167                         printf("Write MDIO failed...\n");
168                         return -1;
169                 }
170         }
171
172         /*
173          * clear MII interrupt bit
174          */
175         writel(FEC_IEVENT_MII, &eth->ievent);
176         debug("%s: phy: %02x reg:%02x val:%#06x\n", __func__, phyAddr,
177                         regAddr, data);
178
179         return 0;
180 }
181
182 static int fec_phy_read(struct mii_dev *bus, int phyAddr, int dev_addr,
183                         int regAddr)
184 {
185         return fec_mdio_read(bus->priv, phyAddr, regAddr);
186 }
187
188 static int fec_phy_write(struct mii_dev *bus, int phyAddr, int dev_addr,
189                          int regAddr, u16 data)
190 {
191         return fec_mdio_write(bus->priv, phyAddr, regAddr, data);
192 }
193
194 #ifndef CONFIG_PHYLIB
195 static int miiphy_restart_aneg(struct eth_device *dev)
196 {
197         int ret = 0;
198 #if !defined(CONFIG_FEC_MXC_NO_ANEG)
199         struct fec_priv *fec = (struct fec_priv *)dev->priv;
200         struct ethernet_regs *eth = fec->bus->priv;
201
202         /*
203          * Wake up from sleep if necessary
204          * Reset PHY, then delay 300ns
205          */
206 #ifdef CONFIG_SOC_MX27
207         fec_mdio_write(eth, fec->phy_id, MII_DCOUNTER, 0x00FF);
208 #endif
209         fec_mdio_write(eth, fec->phy_id, MII_BMCR, BMCR_RESET);
210         udelay(1000);
211
212         /*
213          * Set the auto-negotiation advertisement register bits
214          */
215         fec_mdio_write(eth, fec->phy_id, MII_ADVERTISE,
216                         LPA_100FULL | LPA_100HALF | LPA_10FULL |
217                         LPA_10HALF | PHY_ANLPAR_PSB_802_3);
218         fec_mdio_write(eth, fec->phy_id, MII_BMCR,
219                         BMCR_ANENABLE | BMCR_ANRESTART);
220
221         if (fec->mii_postcall)
222                 ret = fec->mii_postcall(fec->phy_id);
223
224 #endif
225         return ret;
226 }
227
228 static int miiphy_wait_aneg(struct eth_device *dev)
229 {
230         uint32_t start;
231         int status;
232         struct fec_priv *fec = (struct fec_priv *)dev->priv;
233         struct ethernet_regs *eth = fec->bus->priv;
234
235         /*
236          * Wait for AN completion
237          */
238         start = get_timer(0);
239         do {
240                 if (get_timer(start) > (CONFIG_SYS_HZ * 5)) {
241                         printf("%s: Autonegotiation timeout\n", dev->name);
242                         return -1;
243                 }
244
245                 status = fec_mdio_read(eth, fec->phy_id, MII_BMSR);
246                 if (status < 0) {
247                         printf("%s: Autonegotiation failed. status: %d\n",
248                                         dev->name, status);
249                         return -1;
250                 }
251         } while (!(status & BMSR_LSTATUS));
252
253         return 0;
254 }
255 #endif
256
257 static inline void fec_rx_task_enable(struct fec_priv *fec)
258 {
259         writel(FEC_X_DES_ACTIVE_TDAR, &fec->eth->r_des_active);
260 }
261
262 static inline void fec_rx_task_disable(struct fec_priv *fec)
263 {
264 }
265
266 static inline void fec_tx_task_enable(struct fec_priv *fec)
267 {
268         writel(FEC_X_DES_ACTIVE_TDAR, &fec->eth->x_des_active);
269 }
270
271 static inline void fec_tx_task_disable(struct fec_priv *fec)
272 {
273 }
274
275 /**
276  * Initialize receive task's buffer descriptors
277  * @param[in] fec all we know about the device yet
278  * @param[in] count receive buffer count to be allocated
279  * @param[in] dsize desired size of each receive buffer
280  * @return 0 on success
281  *
282  * Init all RX descriptors to default values.
283  */
284 static void fec_rbd_init(struct fec_priv *fec, int count, int dsize)
285 {
286         uint32_t size;
287         uint8_t *data;
288         int i;
289
290         /*
291          * Reload the RX descriptors with default values and wipe
292          * the RX buffers.
293          */
294         size = roundup(dsize, ARCH_DMA_MINALIGN);
295         for (i = 0; i < count; i++) {
296                 data = (uint8_t *)fec->rbd_base[i].data_pointer;
297                 memset(data, 0, dsize);
298                 flush_dcache_range((uint32_t)data, (uint32_t)data + size);
299
300                 fec->rbd_base[i].status = FEC_RBD_EMPTY;
301                 fec->rbd_base[i].data_length = 0;
302         }
303
304         /* Mark the last RBD to close the ring. */
305         fec->rbd_base[i - 1].status = FEC_RBD_WRAP | FEC_RBD_EMPTY;
306         fec->rbd_index = 0;
307
308         flush_dcache_range((unsigned)fec->rbd_base,
309                            (unsigned)fec->rbd_base + size);
310 }
311
312 /**
313  * Initialize transmit task's buffer descriptors
314  * @param[in] fec all we know about the device yet
315  *
316  * Transmit buffers are created externally. We only have to init the BDs here.\n
317  * Note: There is a race condition in the hardware. When only one BD is in
318  * use it must be marked with the WRAP bit to use it for every transmitt.
319  * This bit in combination with the READY bit results into double transmit
320  * of each data buffer. It seems the state machine checks READY earlier then
321  * resetting it after the first transfer.
322  * Using two BDs solves this issue.
323  */
324 static void fec_tbd_init(struct fec_priv *fec)
325 {
326         unsigned addr = (unsigned)fec->tbd_base;
327         unsigned size = roundup(2 * sizeof(struct fec_bd),
328                                 ARCH_DMA_MINALIGN);
329
330         memset(fec->tbd_base, 0, size);
331         fec->tbd_base[0].status = 0;
332         fec->tbd_base[1].status = FEC_TBD_WRAP;
333         fec->tbd_index = 0;
334         flush_dcache_range(addr, addr + size);
335 }
336
337 /**
338  * Mark the given read buffer descriptor as free
339  * @param[in] last 1 if this is the last buffer descriptor in the chain, else 0
340  * @param[in] pRbd buffer descriptor to mark free again
341  */
342 static void fec_rbd_clean(int last, struct fec_bd *pRbd)
343 {
344         unsigned short flags = FEC_RBD_EMPTY;
345         if (last)
346                 flags |= FEC_RBD_WRAP;
347         writew(flags, &pRbd->status);
348         writew(0, &pRbd->data_length);
349 }
350
351 static int fec_get_hwaddr(struct eth_device *dev, int dev_id,
352                                                 unsigned char *mac)
353 {
354         imx_get_mac_from_fuse(dev_id, mac);
355         return !is_valid_ethaddr(mac);
356 }
357
358 static int fec_set_hwaddr(struct eth_device *dev)
359 {
360         uchar *mac = dev->enetaddr;
361         struct fec_priv *fec = (struct fec_priv *)dev->priv;
362
363         writel(0, &fec->eth->iaddr1);
364         writel(0, &fec->eth->iaddr2);
365         writel(0, &fec->eth->gaddr1);
366         writel(0, &fec->eth->gaddr2);
367
368         /*
369          * Set physical address
370          */
371         writel((mac[0] << 24) + (mac[1] << 16) + (mac[2] << 8) + mac[3],
372                         &fec->eth->paddr1);
373         writel((mac[4] << 24) + (mac[5] << 16) + 0x8808, &fec->eth->paddr2);
374
375         return 0;
376 }
377
378 /*
379  * Do initial configuration of the FEC registers
380  */
381 static void fec_reg_setup(struct fec_priv *fec)
382 {
383         uint32_t rcntrl;
384
385         /*
386          * Set interrupt mask register
387          */
388         writel(0x00000000, &fec->eth->imask);
389
390         /*
391          * Clear FEC-Lite interrupt event register(IEVENT)
392          */
393         writel(0xffffffff, &fec->eth->ievent);
394
395
396         /*
397          * Set FEC-Lite receive control register(R_CNTRL):
398          */
399
400         /* Start with frame length = 1518, common for all modes. */
401         rcntrl = PKTSIZE << FEC_RCNTRL_MAX_FL_SHIFT;
402         if (fec->xcv_type != SEVENWIRE)         /* xMII modes */
403                 rcntrl |= FEC_RCNTRL_FCE | FEC_RCNTRL_MII_MODE;
404         if (fec->xcv_type == RGMII)
405                 rcntrl |= FEC_RCNTRL_RGMII;
406         else if (fec->xcv_type == RMII)
407                 rcntrl |= FEC_RCNTRL_RMII;
408
409         writel(rcntrl, &fec->eth->r_cntrl);
410 }
411
412 /**
413  * Start the FEC engine
414  * @param[in] dev Our device to handle
415  */
416 static int fec_open(struct eth_device *edev)
417 {
418         struct fec_priv *fec = edev->priv;
419         int speed;
420         uint32_t addr, size;
421         int i;
422
423         debug("fec_open: fec_open(dev)\n");
424         /* full-duplex, heartbeat disabled */
425         writel(1 << 2, &fec->eth->x_cntrl);
426         fec->rbd_index = 0;
427
428         /* Invalidate all descriptors */
429         for (i = 0; i < FEC_RBD_NUM - 1; i++)
430                 fec_rbd_clean(0, &fec->rbd_base[i]);
431         fec_rbd_clean(1, &fec->rbd_base[i]);
432
433         /* Flush the descriptors into RAM */
434         size = roundup(FEC_RBD_NUM * sizeof(struct fec_bd),
435                         ARCH_DMA_MINALIGN);
436         addr = (uint32_t)fec->rbd_base;
437         flush_dcache_range(addr, addr + size);
438
439 #ifdef FEC_QUIRK_ENET_MAC
440         /* Enable ENET HW endian SWAP */
441         writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_DBSWAP,
442                 &fec->eth->ecntrl);
443         /* Enable ENET store and forward mode */
444         writel(readl(&fec->eth->x_wmrk) | FEC_X_WMRK_STRFWD,
445                 &fec->eth->x_wmrk);
446 #endif
447         /*
448          * Enable FEC-Lite controller
449          */
450         writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_ETHER_EN,
451                 &fec->eth->ecntrl);
452 #if defined(CONFIG_SOC_MX25) || defined(CONFIG_SOC_MX53) || defined(CONFIG_SOC_MX6SL)
453         udelay(100);
454         /*
455          * setup the MII gasket for RMII mode
456          */
457
458         /* disable the gasket */
459         writew(0, &fec->eth->miigsk_enr);
460
461         /* wait for the gasket to be disabled */
462         while (readw(&fec->eth->miigsk_enr) & MIIGSK_ENR_READY)
463                 udelay(2);
464
465         /* configure gasket for RMII, 50 MHz, no loopback, and no echo */
466         writew(MIIGSK_CFGR_IF_MODE_RMII, &fec->eth->miigsk_cfgr);
467
468         /* re-enable the gasket */
469         writew(MIIGSK_ENR_EN, &fec->eth->miigsk_enr);
470
471         /* wait until MII gasket is ready */
472         int max_loops = 10;
473         while ((readw(&fec->eth->miigsk_enr) & MIIGSK_ENR_READY) == 0) {
474                 if (--max_loops <= 0) {
475                         printf("WAIT for MII Gasket ready timed out\n");
476                         break;
477                 }
478         }
479 #endif
480
481 #ifdef CONFIG_PHYLIB
482         {
483                 /* Start up the PHY */
484                 int ret = phy_startup(fec->phydev);
485
486                 if (ret) {
487                         printf("Could not initialize PHY %s\n",
488                                fec->phydev->dev->name);
489                         return ret;
490                 }
491                 speed = fec->phydev->speed;
492         }
493 #else
494         miiphy_wait_aneg(edev);
495         speed = miiphy_speed(edev->name, fec->phy_id);
496         miiphy_duplex(edev->name, fec->phy_id);
497 #endif
498
499 #ifdef FEC_QUIRK_ENET_MAC
500         {
501                 u32 ecr = readl(&fec->eth->ecntrl) & ~FEC_ECNTRL_SPEED;
502                 u32 rcr = readl(&fec->eth->r_cntrl) & ~FEC_RCNTRL_RMII_10T;
503
504                 if (speed == _1000BASET)
505                         ecr |= FEC_ECNTRL_SPEED;
506                 else if (speed != _100BASET)
507                         rcr |= FEC_RCNTRL_RMII_10T;
508                 writel(ecr, &fec->eth->ecntrl);
509                 writel(rcr, &fec->eth->r_cntrl);
510         }
511 #elif defined(CONFIG_SOC_MX28)
512         {
513                 u32 rcr = readl(&fec->eth->r_cntrl) & ~FEC_RCNTRL_RMII_10T;
514
515                 if (speed == _10BASET)
516                         rcr |= FEC_RCNTRL_RMII_10T;
517                 writel(rcr, &fec->eth->r_cntrl);
518         }
519 #endif
520         debug("%s:Speed=%i\n", __func__, speed);
521
522         /*
523          * Enable SmartDMA receive task
524          */
525         fec_rx_task_enable(fec);
526
527 //      udelay(100000);
528         return 0;
529 }
530
531 static int fec_init(struct eth_device *dev, bd_t* bd)
532 {
533         struct fec_priv *fec = dev->priv;
534
535         /* Initialize MAC address */
536         fec_set_hwaddr(dev);
537
538         /*
539          * Setup transmit descriptors, there are two in total.
540          */
541         fec_tbd_init(fec);
542
543         /* Setup receive descriptors. */
544         fec_rbd_init(fec, FEC_RBD_NUM, FEC_MAX_PKT_SIZE);
545
546         fec_reg_setup(fec);
547
548         if (fec->xcv_type != SEVENWIRE)
549                 fec_mii_setspeed(fec->bus->priv);
550
551         /*
552          * Set Opcode/Pause Duration Register
553          */
554         writel(0x00010020, &fec->eth->op_pause);        /* FIXME 0xffff0020; */
555         writel(0x2, &fec->eth->x_wmrk);
556         /*
557          * Set multicast address filter
558          */
559         writel(0x00000000, &fec->eth->gaddr1);
560         writel(0x00000000, &fec->eth->gaddr2);
561
562         /* Do not access reserved register for i.MX6UL */
563 #ifndef CONFIG_SOC_MX6UL
564         /* FIFO receive start register */
565         writel(0x520, &fec->eth->r_fstart);
566 #endif
567         /* size and address of each buffer */
568         writel(FEC_MAX_PKT_SIZE, &fec->eth->emrbr);
569         writel((uint32_t)fec->tbd_base, &fec->eth->etdsr);
570         writel((uint32_t)fec->rbd_base, &fec->eth->erdsr);
571
572 #ifndef CONFIG_PHYLIB
573         if (fec->xcv_type != SEVENWIRE)
574                 miiphy_restart_aneg(dev);
575 #endif
576         fec_open(dev);
577         return 0;
578 }
579
580 /**
581  * Halt the FEC engine
582  * @param[in] dev Our device to handle
583  */
584 static void fec_halt(struct eth_device *dev)
585 {
586         struct fec_priv *fec = (struct fec_priv *)dev->priv;
587         int counter = 1000;
588
589         /*
590          * issue graceful stop command to the FEC transmitter if necessary
591          */
592         writel(FEC_TCNTRL_GTS | readl(&fec->eth->x_cntrl),
593                         &fec->eth->x_cntrl);
594
595         debug("eth_halt: wait for stop regs\n");
596         /*
597          * wait for graceful stop to register
598          */
599         while ((counter--) && (!(readl(&fec->eth->ievent) & FEC_IEVENT_GRA)))
600                 udelay(100);
601
602         /*
603          * Disable SmartDMA tasks
604          */
605         fec_tx_task_disable(fec);
606         fec_rx_task_disable(fec);
607
608         /*
609          * Disable the Ethernet Controller
610          * Note: this will also reset the BD index counter!
611          */
612         writel(readl(&fec->eth->ecntrl) & ~FEC_ECNTRL_ETHER_EN,
613                         &fec->eth->ecntrl);
614         fec->rbd_index = 0;
615         fec->tbd_index = 0;
616         debug("eth_halt: done\n");
617 }
618
619 /**
620  * Transmit one frame
621  * @param[in] dev Our ethernet device to handle
622  * @param[in] packet Pointer to the data to be transmitted
623  * @param[in] length Data count in bytes
624  * @return 0 on success
625  */
626 static int fec_send(struct eth_device *dev, void *packet, int length)
627 {
628         unsigned int status;
629         uint32_t size, end;
630         uint32_t addr;
631         int timeout = FEC_XFER_TIMEOUT;
632         int ret = 0;
633
634         /*
635          * This routine transmits one frame.  This routine only accepts
636          * 6-byte Ethernet addresses.
637          */
638         struct fec_priv *fec = dev->priv;
639
640         /*
641          * Check for valid length of data.
642          */
643         if ((length > 1500) || (length <= 0)) {
644                 printf("Payload (%d) too large\n", length);
645                 return -1;
646         }
647
648         /*
649          * Setup the transmit buffer. We are always using the first buffer for
650          * transmission, the second will be empty and only used to stop the DMA
651          * engine. We also flush the packet to RAM here to avoid cache trouble.
652          */
653 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
654         swap_packet((uint32_t *)packet, length);
655 #endif
656
657         addr = (uint32_t)packet;
658         end = roundup(addr + length, ARCH_DMA_MINALIGN);
659         addr &= ~(ARCH_DMA_MINALIGN - 1);
660         flush_dcache_range(addr, end);
661
662         writew(length, &fec->tbd_base[fec->tbd_index].data_length);
663         writel((unsigned long)packet,
664                 &fec->tbd_base[fec->tbd_index].data_pointer);
665
666         /*
667          * update BD's status now
668          * This block:
669          * - is always the last in a chain (means no chain)
670          * - should transmit the CRC
671          * - might be the last BD in the list, so the address counter should
672          *   wrap (-> keep the WRAP flag)
673          */
674         status = readw(&fec->tbd_base[fec->tbd_index].status) & FEC_TBD_WRAP;
675         status |= FEC_TBD_LAST | FEC_TBD_TC | FEC_TBD_READY;
676         writew(status, &fec->tbd_base[fec->tbd_index].status);
677
678         /*
679          * Flush data cache. This code flushes both TX descriptors to RAM.
680          * After this code, the descriptors will be safely in RAM and we
681          * can start DMA.
682          */
683         size = roundup(2 * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
684         addr = (uint32_t)fec->tbd_base;
685         flush_dcache_range(addr, addr + size);
686
687         /*
688          * Below we read the DMA descriptor's last four bytes back from the
689          * DRAM. This is important in order to make sure that all WRITE
690          * operations on the bus that were triggered by previous cache FLUSH
691          * have completed.
692          *
693          * Otherwise, on MX28, it is possible to observe a corruption of the
694          * DMA descriptors. Please refer to schematic "Figure 1-2" in MX28RM
695          * for the bus structure of MX28. The scenario is as follows:
696          *
697          * 1) ARM core triggers a series of WRITEs on the AHB_ARB2 bus going
698          *    to DRAM due to flush_dcache_range()
699          * 2) ARM core writes the FEC registers via AHB_ARB2
700          * 3) FEC DMA starts reading/writing from/to DRAM via AHB_ARB3
701          *
702          * Note that 2) does sometimes finish before 1) due to reordering of
703          * WRITE accesses on the AHB bus, therefore triggering 3) before the
704          * DMA descriptor is fully written into DRAM. This results in occasional
705          * corruption of the DMA descriptor.
706          */
707         readl(addr + size - 4);
708
709         /*
710          * Enable SmartDMA transmit task
711          */
712         fec_tx_task_enable(fec);
713
714         /*
715          * Wait until frame is sent. On each turn of the wait cycle, we must
716          * invalidate data cache to see what's really in RAM. Also, we need
717          * barrier here.
718          */
719         while (--timeout) {
720                 if (!(readl(&fec->eth->x_des_active) & FEC_X_DES_ACTIVE_TDAR))
721                         break;
722                 udelay(1);
723         }
724
725         if (!timeout) {
726                 ret = -EINVAL;
727                 goto out;
728         }
729
730         /*
731          * The TDAR bit is cleared when the descriptors are all out from TX
732          * but on mx6solox we noticed that the READY bit is still not cleared
733          * right after TDAR.
734          * These are two distinct signals, and in IC simulation, we found that
735          * TDAR always gets cleared prior than the READY bit of last BD becomes
736          * cleared.
737          * In mx6solox, we use a later version of FEC IP. It looks like that
738          * this intrinsic behaviour of TDAR bit has changed in this newer FEC
739          * version.
740          *
741          * Fix this by polling the READY bit of BD after the TDAR polling,
742          * which covers the mx6solox case and does not harm the other SoCs.
743          */
744         timeout = FEC_XFER_TIMEOUT;
745         while (--timeout) {
746                 invalidate_dcache_range(addr, addr + size);
747                 if (!(readw(&fec->tbd_base[fec->tbd_index].status) &
748                     FEC_TBD_READY))
749                         break;
750                 udelay(1);
751         }
752
753         if (!timeout)
754                 ret = -EINVAL;
755
756 out:
757         debug("fec_send: status 0x%x index %d ret %i\n",
758                         readw(&fec->tbd_base[fec->tbd_index].status),
759                         fec->tbd_index, ret);
760         /* for next transmission use the other buffer */
761         if (fec->tbd_index)
762                 fec->tbd_index = 0;
763         else
764                 fec->tbd_index = 1;
765
766         return ret;
767 }
768
769 /**
770  * Pull one frame from the card
771  * @param[in] dev Our ethernet device to handle
772  * @return Length of packet read
773  */
774 static int fec_recv(struct eth_device *dev)
775 {
776         struct fec_priv *fec = (struct fec_priv *)dev->priv;
777         struct fec_bd *rbd = &fec->rbd_base[fec->rbd_index];
778         unsigned long ievent;
779         int frame_length, len = 0;
780         uint16_t bd_status;
781         uint32_t addr, size, end;
782         int i;
783         ALLOC_CACHE_ALIGN_BUFFER(uchar, buff, FEC_MAX_PKT_SIZE);
784
785         /*
786          * Check if any critical events have happened
787          */
788         ievent = readl(&fec->eth->ievent);
789         if (ievent)
790                 writel(ievent, &fec->eth->ievent);
791
792         if (ievent)
793                 debug("fec_recv: ievent 0x%lx\n", ievent);
794         if (ievent & FEC_IEVENT_BABR) {
795                 fec_halt(dev);
796                 fec_init(dev, fec->bd);
797                 printf("some error: 0x%08lx\n", ievent);
798                 return 0;
799         }
800         if (ievent & FEC_IEVENT_HBERR) {
801                 /* Heartbeat error */
802                 writel(0x00000001 | readl(&fec->eth->x_cntrl),
803                                 &fec->eth->x_cntrl);
804         }
805         if (ievent & FEC_IEVENT_GRA) {
806                 /* Graceful stop complete */
807                 if (readl(&fec->eth->x_cntrl) & 0x00000001) {
808                         fec_halt(dev);
809                         writel(~0x00000001 & readl(&fec->eth->x_cntrl),
810                                         &fec->eth->x_cntrl);
811                         fec_init(dev, fec->bd);
812                 }
813         }
814
815         /*
816          * Read the buffer status. Before the status can be read, the data cache
817          * must be invalidated, because the data in RAM might have been changed
818          * by DMA. The descriptors are properly aligned to cachelines so there's
819          * no need to worry they'd overlap.
820          *
821          * WARNING: By invalidating the descriptor here, we also invalidate
822          * the descriptors surrounding this one. Therefore we can NOT change the
823          * contents of this descriptor nor the surrounding ones. The problem is
824          * that in order to mark the descriptor as processed, we need to change
825          * the descriptor. The solution is to mark the whole cache line when all
826          * descriptors in the cache line are processed.
827          */
828         addr = (uint32_t)rbd;
829         addr &= ~(ARCH_DMA_MINALIGN - 1);
830         size = roundup(sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
831         invalidate_dcache_range(addr, addr + size);
832
833         bd_status = readw(&rbd->status);
834         if (!(bd_status & FEC_RBD_EMPTY)) {
835                 debug("fec_recv: status 0x%04x len %u\n", bd_status,
836                         readw(&rbd->data_length) - 4);
837                 if ((bd_status & FEC_RBD_LAST) && !(bd_status & FEC_RBD_ERR) &&
838                         ((readw(&rbd->data_length) - 4) > 14)) {
839                         /*
840                          * Get buffer address and size
841                          */
842                         addr = readl(&rbd->data_pointer);
843                         frame_length = readw(&rbd->data_length) - 4;
844
845                         /*
846                          * Invalidate data cache over the buffer
847                          */
848                         end = roundup(addr + frame_length, ARCH_DMA_MINALIGN);
849                         addr &= ~(ARCH_DMA_MINALIGN - 1);
850                         invalidate_dcache_range(addr, end);
851
852                         /*
853                          *  Fill the buffer and pass it to upper layers
854                          */
855 #ifdef CONFIG_FEC_MXC_SWAP_PACKET
856                         swap_packet((uint32_t *)addr, frame_length);
857 #endif
858                         memcpy(buff, (char *)addr, frame_length);
859                         net_process_received_packet(buff, frame_length);
860                         len = frame_length;
861                 } else {
862                         if (bd_status & FEC_RBD_ERR)
863                                 printf("error frame: 0x%08x 0x%08x\n",
864                                        addr, bd_status);
865                 }
866
867                 /*
868                  * Free the current buffer, restart the engine and move forward
869                  * to the next buffer. Here we check if the whole cacheline of
870                  * descriptors was already processed and if so, we mark it free
871                  * as whole.
872                  */
873                 size = RXDESC_PER_CACHELINE - 1;
874                 if ((fec->rbd_index & size) == size) {
875                         i = fec->rbd_index - size;
876                         addr = (uint32_t)&fec->rbd_base[i];
877                         for (; i <= fec->rbd_index ; i++) {
878                                 fec_rbd_clean(i == (FEC_RBD_NUM - 1),
879                                               &fec->rbd_base[i]);
880                         }
881                         flush_dcache_range(addr,
882                                 addr + ARCH_DMA_MINALIGN);
883                 }
884
885                 fec_rx_task_enable(fec);
886                 fec->rbd_index = (fec->rbd_index + 1) % FEC_RBD_NUM;
887                 debug("fec_recv: stop\n");
888         }
889
890         return len;
891 }
892
893 static void fec_set_dev_name(char *dest, int dev_id)
894 {
895         sprintf(dest, (dev_id == -1) ? "FEC" : "FEC%i", dev_id);
896 }
897
898 static int fec_alloc_descs(struct fec_priv *fec)
899 {
900         unsigned int size;
901         int i;
902         uint8_t *data;
903
904         /* Allocate TX descriptors. */
905         size = roundup(2 * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
906         fec->tbd_base = memalign(ARCH_DMA_MINALIGN, size);
907         if (!fec->tbd_base)
908                 goto err_tx;
909
910         /* Allocate RX descriptors. */
911         size = roundup(FEC_RBD_NUM * sizeof(struct fec_bd), ARCH_DMA_MINALIGN);
912         fec->rbd_base = memalign(ARCH_DMA_MINALIGN, size);
913         if (!fec->rbd_base)
914                 goto err_rx;
915
916         memset(fec->rbd_base, 0, size);
917
918         /* Allocate RX buffers. */
919
920         /* Maximum RX buffer size. */
921         size = roundup(FEC_MAX_PKT_SIZE, FEC_DMA_RX_MINALIGN);
922         for (i = 0; i < FEC_RBD_NUM; i++) {
923                 data = memalign(FEC_DMA_RX_MINALIGN, size);
924                 if (!data) {
925                         printf("%s: error allocating rxbuf %d\n", __func__, i);
926                         goto err_ring;
927                 }
928
929                 memset(data, 0, size);
930
931                 fec->rbd_base[i].data_pointer = (uint32_t)data;
932                 fec->rbd_base[i].status = FEC_RBD_EMPTY;
933                 fec->rbd_base[i].data_length = 0;
934                 /* Flush the buffer to memory. */
935                 flush_dcache_range((uint32_t)data, (uint32_t)data + size);
936         }
937
938         /* Mark the last RBD to close the ring. */
939         fec->rbd_base[i - 1].status = FEC_RBD_WRAP | FEC_RBD_EMPTY;
940
941         fec->rbd_index = 0;
942         fec->tbd_index = 0;
943
944         return 0;
945
946 err_ring:
947         for (; i >= 0; i--)
948                 free((void *)fec->rbd_base[i].data_pointer);
949         free(fec->rbd_base);
950 err_rx:
951         free(fec->tbd_base);
952 err_tx:
953         return -ENOMEM;
954 }
955
956 static void fec_free_descs(struct fec_priv *fec)
957 {
958         int i;
959
960         for (i = 0; i < FEC_RBD_NUM; i++)
961                 free((void *)fec->rbd_base[i].data_pointer);
962         free(fec->rbd_base);
963         free(fec->tbd_base);
964 }
965
966 #ifdef CONFIG_PHYLIB
967 int fec_probe(bd_t *bd, int dev_id, uint32_t base_addr,
968                 struct mii_dev *bus, struct phy_device *phydev)
969 #else
970 static int fec_probe(bd_t *bd, int dev_id, uint32_t base_addr,
971                 struct mii_dev *bus, int phy_id)
972 #endif
973 {
974         struct eth_device *edev;
975         struct fec_priv *fec;
976         unsigned char ethaddr[6];
977         uint32_t start;
978         int ret = 0;
979
980         /* create and fill edev struct */
981         edev = calloc(sizeof(struct eth_device), 1);
982         if (!edev) {
983                 puts("fec_mxc: not enough malloc memory for eth_device\n");
984                 ret = -ENOMEM;
985                 goto err1;
986         }
987
988         fec = calloc(sizeof(struct fec_priv), 1);
989         if (!fec) {
990                 puts("fec_mxc: not enough malloc memory for fec_priv\n");
991                 ret = -ENOMEM;
992                 goto err2;
993         }
994
995         ret = fec_alloc_descs(fec);
996         if (ret)
997                 goto err3;
998
999         edev->priv = fec;
1000         edev->init = fec_init;
1001         edev->send = fec_send;
1002         edev->recv = fec_recv;
1003         edev->halt = fec_halt;
1004         edev->write_hwaddr = fec_set_hwaddr;
1005
1006         fec->eth = (struct ethernet_regs *)base_addr;
1007         fec->bd = bd;
1008
1009         fec->xcv_type = CONFIG_FEC_XCV_TYPE;
1010
1011         /* Reset chip. */
1012         writel(readl(&fec->eth->ecntrl) | FEC_ECNTRL_RESET, &fec->eth->ecntrl);
1013         start = get_timer(0);
1014         while (readl(&fec->eth->ecntrl) & FEC_ECNTRL_RESET) {
1015                 if (get_timer(start) > (CONFIG_SYS_HZ * 5)) {
1016                         printf("FEC MXC: Timeout reseting chip\n");
1017                         goto err4;
1018                 }
1019                 udelay(10);
1020         }
1021
1022         fec_reg_setup(fec);
1023         fec_set_dev_name(edev->name, dev_id);
1024         fec->dev_id = (dev_id == -1) ? 0 : dev_id;
1025         fec->bus = bus;
1026         fec_mii_setspeed(bus->priv);
1027 #ifdef CONFIG_PHYLIB
1028         fec->phydev = phydev;
1029         phy_connect_dev(phydev, edev);
1030         /* Configure phy */
1031         phy_config(phydev);
1032 #else
1033         fec->phy_id = phy_id;
1034 #endif
1035         eth_register(edev);
1036
1037         if (fec_get_hwaddr(edev, dev_id, ethaddr) == 0) {
1038                 if (dev_id < 0)
1039                         debug("got MAC address from fuse: %pM\n", ethaddr);
1040                 else
1041                         debug("got MAC%d address from fuse: %pM\n", dev_id, ethaddr);
1042                 memcpy(edev->enetaddr, ethaddr, 6);
1043                 if (!getenv("ethaddr"))
1044                         eth_setenv_enetaddr("ethaddr", ethaddr);
1045         }
1046         return ret;
1047 err4:
1048         fec_free_descs(fec);
1049 err3:
1050         free(fec);
1051 err2:
1052         free(edev);
1053 err1:
1054         return ret;
1055 }
1056
1057 struct mii_dev *fec_get_miibus(uint32_t base_addr, int dev_id)
1058 {
1059         struct ethernet_regs *eth = (struct ethernet_regs *)base_addr;
1060         struct mii_dev *bus;
1061         int ret;
1062
1063         bus = mdio_alloc();
1064         if (!bus) {
1065                 printf("mdio_alloc failed\n");
1066                 return NULL;
1067         }
1068         bus->read = fec_phy_read;
1069         bus->write = fec_phy_write;
1070         bus->priv = eth;
1071         fec_set_dev_name(bus->name, dev_id);
1072
1073         ret = mdio_register(bus);
1074         if (ret) {
1075                 printf("mdio_register failed\n");
1076                 free(bus);
1077                 return NULL;
1078         }
1079         fec_mii_setspeed(eth);
1080         return bus;
1081 }
1082
1083 int fecmxc_initialize_multi(bd_t *bd, int dev_id, int phy_id, uint32_t addr)
1084 {
1085         uint32_t base_mii;
1086         struct mii_dev *bus = NULL;
1087 #ifdef CONFIG_PHYLIB
1088         struct phy_device *phydev = NULL;
1089 #endif
1090         int ret;
1091
1092 #ifdef CONFIG_SOC_MX28
1093         /*
1094          * The i.MX28 has two ethernet interfaces, but they are not equal.
1095          * Only the first one can access the MDIO bus.
1096          */
1097         base_mii = MXS_ENET0_BASE;
1098 #else
1099         base_mii = addr;
1100 #endif
1101         debug("eth_init: fec_probe(bd, %i, %i) @ %08x\n", dev_id, phy_id, addr);
1102         bus = fec_get_miibus(base_mii, dev_id);
1103         if (!bus)
1104                 return -ENOMEM;
1105 #ifdef CONFIG_PHYLIB
1106         phydev = phy_find_by_mask(bus, phy_id < 0 ? 0xff : (1 << phy_id),
1107                                 PHY_INTERFACE_MODE_RGMII);
1108         if (!phydev) {
1109                 free(bus);
1110                 return -ENOMEM;
1111         }
1112         ret = fec_probe(bd, dev_id, addr, bus, phydev);
1113 #else
1114         ret = fec_probe(bd, dev_id, addr, bus, phy_id);
1115 #endif
1116         if (ret) {
1117 #ifdef CONFIG_PHYLIB
1118                 free(phydev);
1119 #endif
1120                 free(bus);
1121         }
1122         return ret;
1123 }
1124
1125 #ifdef CONFIG_FEC_MXC_PHYADDR
1126 int fecmxc_initialize(bd_t *bd)
1127 {
1128         return fecmxc_initialize_multi(bd, -1, CONFIG_FEC_MXC_PHYADDR,
1129                         IMX_FEC_BASE);
1130 }
1131 #endif
1132
1133 #ifndef CONFIG_PHYLIB
1134 int fecmxc_register_mii_postcall(struct eth_device *dev, int (*cb)(int))
1135 {
1136         struct fec_priv *fec = (struct fec_priv *)dev->priv;
1137         fec->mii_postcall = cb;
1138         return 0;
1139 }
1140 #endif