2 * (C) Copyright 2003-2010
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * Derived from the MPC8xx FEC driver.
6 * Adapted for MPC512x by Grzegorz Bernacki <gjb@semihalf.com>
15 #include "mpc512x_fec.h"
17 DECLARE_GLOBAL_DATA_PTR;
21 #if defined(CONFIG_CMD_NET) && defined(CONFIG_NET_MULTI) && \
22 defined(CONFIG_MPC512x_FEC)
24 #if !(defined(CONFIG_MII) || defined(CONFIG_CMD_MII))
25 #error "CONFIG_MII has to be defined!"
28 int fec512x_miiphy_read(char *devname, u8 phyAddr, u8 regAddr, u16 * retVal);
29 int fec512x_miiphy_write(char *devname, u8 phyAddr, u8 regAddr, u16 data);
30 int mpc512x_fec_init_phy(struct eth_device *dev, bd_t * bis);
32 static uchar rx_buff[FEC_BUFFER_SIZE];
33 static int rx_buff_idx = 0;
35 /********************************************************************/
37 static void mpc512x_fec_phydump (char *devname)
40 u8 phyAddr = CONFIG_PHY_ADDR;
42 /* regs to print: 0...8, 21,27,31 */
43 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0,
44 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1,
47 for (i = 0; i < 32; i++) {
49 miiphy_read (devname, phyAddr, i, &phyStatus);
50 printf ("Mii reg %d: 0x%04x\n", i, phyStatus);
56 /********************************************************************/
57 static int mpc512x_fec_bd_init (mpc512x_fec_priv *fec)
64 for (ix = 0; ix < FEC_RBD_NUM; ix++) {
65 fec->bdBase->rbd[ix].dataPointer =
66 (u32)&fec->bdBase->recv_frames[ix];
67 fec->bdBase->rbd[ix].status = FEC_RBD_EMPTY;
68 fec->bdBase->rbd[ix].dataLength = 0;
72 * have the last RBD to close the ring
74 fec->bdBase->rbd[ix - 1].status |= FEC_RBD_WRAP;
80 for (ix = 0; ix < FEC_TBD_NUM; ix++) {
81 fec->bdBase->tbd[ix].status = 0;
85 * Have the last TBD to close the ring
87 fec->bdBase->tbd[ix - 1].status |= FEC_TBD_WRAP;
90 * Initialize some indices
93 fec->usedTbdIndex = 0;
94 fec->cleanTbdNum = FEC_TBD_NUM;
99 /********************************************************************/
100 static void mpc512x_fec_rbd_clean (mpc512x_fec_priv *fec, volatile FEC_RBD * pRbd)
103 * Reset buffer descriptor as empty
105 if ((fec->rbdIndex) == (FEC_RBD_NUM - 1))
106 pRbd->status = (FEC_RBD_WRAP | FEC_RBD_EMPTY);
108 pRbd->status = FEC_RBD_EMPTY;
110 pRbd->dataLength = 0;
115 fec->rbdIndex = (fec->rbdIndex + 1) % FEC_RBD_NUM;
118 * Now, we have an empty RxBD, notify FEC
119 * Set Descriptor polling active
121 out_be32(&fec->eth->r_des_active, 0x01000000);
124 /********************************************************************/
125 static void mpc512x_fec_tbd_scrub (mpc512x_fec_priv *fec)
127 volatile FEC_TBD *pUsedTbd;
130 printf ("tbd_scrub: fec->cleanTbdNum = %d, fec->usedTbdIndex = %d\n",
131 fec->cleanTbdNum, fec->usedTbdIndex);
135 * process all the consumed TBDs
137 while (fec->cleanTbdNum < FEC_TBD_NUM) {
138 pUsedTbd = &fec->bdBase->tbd[fec->usedTbdIndex];
139 if (pUsedTbd->status & FEC_TBD_READY) {
141 printf ("Cannot clean TBD %d, in use\n", fec->usedTbdIndex);
147 * clean this buffer descriptor
149 if (fec->usedTbdIndex == (FEC_TBD_NUM - 1))
150 pUsedTbd->status = FEC_TBD_WRAP;
152 pUsedTbd->status = 0;
155 * update some indeces for a correct handling of the TBD ring
158 fec->usedTbdIndex = (fec->usedTbdIndex + 1) % FEC_TBD_NUM;
162 /********************************************************************/
163 static void mpc512x_fec_set_hwaddr (mpc512x_fec_priv *fec, unsigned char *mac)
165 u8 currByte; /* byte for which to compute the CRC */
166 int byte; /* loop - counter */
167 int bit; /* loop - counter */
168 u32 crc = 0xffffffff; /* initial value */
171 * The algorithm used is the following:
172 * we loop on each of the six bytes of the provided address,
173 * and we compute the CRC by left-shifting the previous
174 * value by one position, so that each bit in the current
175 * byte of the address may contribute the calculation. If
176 * the latter and the MSB in the CRC are different, then
177 * the CRC value so computed is also ex-ored with the
178 * "polynomium generator". The current byte of the address
179 * is also shifted right by one bit at each iteration.
180 * This is because the CRC generatore in hardware is implemented
181 * as a shift-register with as many ex-ores as the radixes
182 * in the polynomium. This suggests that we represent the
183 * polynomiumm itself as a 32-bit constant.
185 for (byte = 0; byte < 6; byte++) {
186 currByte = mac[byte];
187 for (bit = 0; bit < 8; bit++) {
188 if ((currByte & 0x01) ^ (crc & 0x01)) {
190 crc = crc ^ 0xedb88320;
201 * Set individual hash table register
204 out_be32(&fec->eth->iaddr1, (1 << (crc - 32)));
205 out_be32(&fec->eth->iaddr2, 0);
207 out_be32(&fec->eth->iaddr1, 0);
208 out_be32(&fec->eth->iaddr2, (1 << crc));
212 * Set physical address
214 out_be32(&fec->eth->paddr1, (mac[0] << 24) + (mac[1] << 16) +
215 (mac[2] << 8) + mac[3]);
216 out_be32(&fec->eth->paddr2, (mac[4] << 24) + (mac[5] << 16) +
220 /********************************************************************/
221 static int mpc512x_fec_init (struct eth_device *dev, bd_t * bis)
223 mpc512x_fec_priv *fec = (mpc512x_fec_priv *)dev->priv;
226 printf ("mpc512x_fec_init... Begin\n");
229 mpc512x_fec_set_hwaddr (fec, dev->enetaddr);
230 out_be32(&fec->eth->gaddr1, 0x00000000);
231 out_be32(&fec->eth->gaddr2, 0x00000000);
233 mpc512x_fec_init_phy (dev, bis);
235 /* Set interrupt mask register */
236 out_be32(&fec->eth->imask, 0x00000000);
238 /* Clear FEC-Lite interrupt event register(IEVENT) */
239 out_be32(&fec->eth->ievent, 0xffffffff);
241 /* Set transmit fifo watermark register(X_WMRK), default = 64 */
242 out_be32(&fec->eth->x_wmrk, 0x0);
244 /* Set Opcode/Pause Duration Register */
245 out_be32(&fec->eth->op_pause, 0x00010020);
247 /* Frame length=1522; MII mode */
248 out_be32(&fec->eth->r_cntrl, (FEC_MAX_FRAME_LEN << 16) | 0x24);
250 /* Half-duplex, heartbeat disabled */
251 out_be32(&fec->eth->x_cntrl, 0x00000000);
253 /* Enable MIB counters */
254 out_be32(&fec->eth->mib_control, 0x0);
256 /* Setup recv fifo start and buff size */
257 out_be32(&fec->eth->r_fstart, 0x500);
258 out_be32(&fec->eth->r_buff_size, FEC_BUFFER_SIZE);
260 /* Setup BD base addresses */
261 out_be32(&fec->eth->r_des_start, (u32)fec->bdBase->rbd);
262 out_be32(&fec->eth->x_des_start, (u32)fec->bdBase->tbd);
265 out_be32(&fec->eth->dma_control, 0xc0000000);
268 setbits_be32(&fec->eth->ecntrl, 0x00000006);
270 /* Initilize addresses and status words of BDs */
271 mpc512x_fec_bd_init (fec);
273 /* Descriptor polling active */
274 out_be32(&fec->eth->r_des_active, 0x01000000);
277 printf("mpc512x_fec_init... Done \n");
282 /********************************************************************/
283 int mpc512x_fec_init_phy (struct eth_device *dev, bd_t * bis)
285 mpc512x_fec_priv *fec = (mpc512x_fec_priv *)dev->priv;
286 const u8 phyAddr = CONFIG_PHY_ADDR; /* Only one PHY */
291 printf ("mpc512x_fec_init_phy... Begin\n");
295 * Clear FEC-Lite interrupt event register(IEVENT)
297 out_be32(&fec->eth->ievent, 0xffffffff);
300 * Set interrupt mask register
302 out_be32(&fec->eth->imask, 0x00000000);
304 if (fec->xcv_type != SEVENWIRE) {
306 * Set MII_SPEED = (1/(mii_speed * 2)) * System Clock
307 * and do not drop the Preamble.
309 out_be32(&fec->eth->mii_speed,
310 (((gd->ips_clk / 1000000) / 5) + 1) << 1);
313 * Reset PHY, then delay 300ns
315 miiphy_write (dev->name, phyAddr, 0x0, 0x8000);
318 if (fec->xcv_type == MII10) {
320 * Force 10Base-T, FDX operation
323 printf ("Forcing 10 Mbps ethernet link... ");
325 miiphy_read (dev->name, phyAddr, 0x1, &phyStatus);
327 miiphy_write (dev->name, phyAddr, 0x0, 0x0180);
330 do { /* wait for link status to go down */
332 if ((timeout--) == 0) {
334 printf ("hmmm, should not have waited...");
338 miiphy_read (dev->name, phyAddr, 0x1, &phyStatus);
342 } while ((phyStatus & 0x0004)); /* !link up */
345 do { /* wait for link status to come back up */
347 if ((timeout--) == 0) {
348 printf ("failed. Link is down.\n");
351 miiphy_read (dev->name, phyAddr, 0x1, &phyStatus);
355 } while (!(phyStatus & 0x0004)); /* !link up */
360 } else { /* MII100 */
362 * Set the auto-negotiation advertisement register bits
364 miiphy_write (dev->name, phyAddr, 0x4, 0x01e1);
367 * Set MDIO bit 0.12 = 1(&& bit 0.9=1?) to enable auto-negotiation
369 miiphy_write (dev->name, phyAddr, 0x0, 0x1200);
372 * Wait for AN completion
378 if ((timeout--) == 0) {
380 printf ("PHY auto neg 0 failed...\n");
385 if (miiphy_read (dev->name, phyAddr, 0x1, &phyStatus) != 0) {
387 printf ("PHY auto neg 1 failed 0x%04x...\n", phyStatus);
391 } while (!(phyStatus & 0x0004));
394 printf ("PHY auto neg complete! \n");
400 if (fec->xcv_type != SEVENWIRE)
401 mpc512x_fec_phydump (dev->name);
405 printf ("mpc512x_fec_init_phy... Done \n");
410 /********************************************************************/
411 static void mpc512x_fec_halt (struct eth_device *dev)
413 mpc512x_fec_priv *fec = (mpc512x_fec_priv *)dev->priv;
414 int counter = 0xffff;
417 if (fec->xcv_type != SEVENWIRE)
418 mpc512x_fec_phydump (dev->name);
422 * mask FEC chip interrupts
424 out_be32(&fec->eth->imask, 0);
427 * issue graceful stop command to the FEC transmitter if necessary
429 setbits_be32(&fec->eth->x_cntrl, 0x00000001);
432 * wait for graceful stop to register
434 while ((counter--) && (!(in_be32(&fec->eth->ievent) & 0x10000000)))
438 * Disable the Ethernet Controller
440 clrbits_be32(&fec->eth->ecntrl, 0x00000002);
443 * Issue a reset command to the FEC chip
445 setbits_be32(&fec->eth->ecntrl, 0x1);
448 * wait at least 16 clock cycles
452 printf ("Ethernet task stopped\n");
456 /********************************************************************/
458 static int mpc512x_fec_send (struct eth_device *dev, volatile void *eth_data,
462 * This routine transmits one frame. This routine only accepts
463 * 6-byte Ethernet addresses.
465 mpc512x_fec_priv *fec = (mpc512x_fec_priv *)dev->priv;
466 volatile FEC_TBD *pTbd;
469 printf("tbd status: 0x%04x\n", fec->tbdBase[fec->tbdIndex].status);
473 * Clear Tx BD ring at first
475 mpc512x_fec_tbd_scrub (fec);
478 * Check for valid length of data.
480 if ((data_length > 1500) || (data_length <= 0)) {
485 * Check the number of vacant TxBDs.
487 if (fec->cleanTbdNum < 1) {
489 printf ("No available TxBDs ...\n");
495 * Get the first TxBD to send the mac header
497 pTbd = &fec->bdBase->tbd[fec->tbdIndex];
498 pTbd->dataLength = data_length;
499 pTbd->dataPointer = (u32)eth_data;
500 pTbd->status |= FEC_TBD_LAST | FEC_TBD_TC | FEC_TBD_READY;
501 fec->tbdIndex = (fec->tbdIndex + 1) % FEC_TBD_NUM;
503 /* Activate transmit Buffer Descriptor polling */
504 out_be32(&fec->eth->x_des_active, 0x01000000);
510 fec->cleanTbdNum -= 1;
513 * wait until frame is sent .
515 while (pTbd->status & FEC_TBD_READY) {
518 printf ("TDB status = %04x\n", pTbd->status);
526 /********************************************************************/
527 static int mpc512x_fec_recv (struct eth_device *dev)
530 * This command pulls one frame from the card
532 mpc512x_fec_priv *fec = (mpc512x_fec_priv *)dev->priv;
533 volatile FEC_RBD *pRbd = &fec->bdBase->rbd[fec->rbdIndex];
534 unsigned long ievent;
535 int frame_length = 0;
538 printf ("mpc512x_fec_recv %d Start...\n", fec->rbdIndex);
545 * Check if any critical events have happened
547 ievent = in_be32(&fec->eth->ievent);
548 out_be32(&fec->eth->ievent, ievent);
549 if (ievent & 0x20060000) {
550 /* BABT, Rx/Tx FIFO errors */
551 mpc512x_fec_halt (dev);
552 mpc512x_fec_init (dev, NULL);
555 if (ievent & 0x80000000) {
556 /* Heartbeat error */
557 setbits_be32(&fec->eth->x_cntrl, 0x00000001);
559 if (ievent & 0x10000000) {
560 /* Graceful stop complete */
561 if (in_be32(&fec->eth->x_cntrl) & 0x00000001) {
562 mpc512x_fec_halt (dev);
563 clrbits_be32(&fec->eth->x_cntrl, 0x00000001);;
564 mpc512x_fec_init (dev, NULL);
568 if (!(pRbd->status & FEC_RBD_EMPTY)) {
569 if (!(pRbd->status & FEC_RBD_ERR) &&
570 ((pRbd->dataLength - 4) > 14)) {
575 if (pRbd->status & FEC_RBD_LAST)
576 frame_length = pRbd->dataLength - 4;
578 frame_length = pRbd->dataLength;
582 printf ("recv data length 0x%08x data hdr: ",
584 for (i = 0; i < 14; i++)
585 printf ("%x ", *((u8*)pRbd->dataPointer + i));
590 * Fill the buffer and pass it to upper layers
592 memcpy (&rx_buff[rx_buff_idx], (void*)pRbd->dataPointer,
593 frame_length - rx_buff_idx);
594 rx_buff_idx = frame_length;
596 if (pRbd->status & FEC_RBD_LAST) {
597 NetReceive ((uchar*)rx_buff, frame_length);
603 * Reset buffer descriptor as empty
605 mpc512x_fec_rbd_clean (fec, pRbd);
608 /* Try to fill Buffer Descriptors */
609 out_be32(&fec->eth->r_des_active, 0x01000000);
614 /********************************************************************/
615 int mpc512x_fec_initialize (bd_t * bis)
617 volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
618 mpc512x_fec_priv *fec;
619 struct eth_device *dev;
622 fec = (mpc512x_fec_priv *) malloc (sizeof(*fec));
623 dev = (struct eth_device *) malloc (sizeof(*dev));
624 memset (dev, 0, sizeof *dev);
628 # ifndef CONFIG_FEC_10MBIT
629 fec->xcv_type = MII100;
631 fec->xcv_type = MII10;
633 dev->priv = (void *)fec;
634 dev->iobase = (int)&im->fec;
635 dev->init = mpc512x_fec_init;
636 dev->halt = mpc512x_fec_halt;
637 dev->send = mpc512x_fec_send;
638 dev->recv = mpc512x_fec_recv;
640 sprintf (dev->name, "FEC");
643 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
644 miiphy_register (dev->name,
645 fec512x_miiphy_read, fec512x_miiphy_write);
648 /* Clean up space FEC's MIB and FIFO RAM ...*/
649 memset ((void *)&im->fec.mib, 0x00, sizeof(im->fec.mib));
650 memset ((void *)&im->fec.fifo, 0x00, sizeof(im->fec.fifo));
653 * Malloc space for BDs (must be quad word-aligned)
654 * this pointer is lost, so cannot be freed
656 bd = malloc (sizeof(mpc512x_buff_descs) + 0x1f);
657 fec->bdBase = (mpc512x_buff_descs*)((u32)bd & 0xfffffff0);
658 memset ((void *) bd, 0x00, sizeof(mpc512x_buff_descs) + 0x1f);
661 * Set interrupt mask register
663 out_be32(&fec->eth->imask, 0x00000000);
666 * Clear FEC-Lite interrupt event register(IEVENT)
668 out_be32(&fec->eth->ievent, 0xffffffff);
673 /* MII-interface related functions */
674 /********************************************************************/
675 int fec512x_miiphy_read (char *devname, u8 phyAddr, u8 regAddr, u16 * retVal)
677 volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
678 volatile fec512x_t *eth = &im->fec;
679 u32 reg; /* convenient holder for the PHY register */
680 u32 phy; /* convenient holder for the PHY */
681 int timeout = 0xffff;
684 * reading from any PHY's register is done by properly
685 * programming the FEC's MII data register.
687 reg = regAddr << FEC_MII_DATA_RA_SHIFT;
688 phy = phyAddr << FEC_MII_DATA_PA_SHIFT;
690 out_be32(ð->mii_data, FEC_MII_DATA_ST |
696 * wait for the related interrupt
698 while ((timeout--) && (!(in_be32(ð->ievent) & 0x00800000)))
703 printf ("Read MDIO failed...\n");
709 * clear mii interrupt bit
711 out_be32(ð->ievent, 0x00800000);
714 * it's now safe to read the PHY's register
716 *retVal = (u16) in_be32(ð->mii_data);
721 /********************************************************************/
722 int fec512x_miiphy_write (char *devname, u8 phyAddr, u8 regAddr, u16 data)
724 volatile immap_t *im = (immap_t *) CONFIG_SYS_IMMR;
725 volatile fec512x_t *eth = &im->fec;
726 u32 reg; /* convenient holder for the PHY register */
727 u32 phy; /* convenient holder for the PHY */
728 int timeout = 0xffff;
730 reg = regAddr << FEC_MII_DATA_RA_SHIFT;
731 phy = phyAddr << FEC_MII_DATA_PA_SHIFT;
733 out_be32(ð->mii_data, FEC_MII_DATA_ST |
739 * wait for the MII interrupt
741 while ((timeout--) && (!(in_be32(ð->ievent) & 0x00800000)))
746 printf ("Write MDIO failed...\n");
752 * clear MII interrupt bit
754 out_be32(ð->ievent, 0x00800000);
759 #endif /* CONFIG_MPC512x_FEC */