1 // SPDX-License-Identifier: GPL-2.0+
3 * LPC32xx Ethernet MAC interface driver
5 * (C) Copyright 2014 DENX Software Engineering GmbH
15 #include <linux/delay.h>
16 #include <linux/errno.h>
17 #include <asm/types.h>
18 #include <asm/system.h>
19 #include <asm/byteorder.h>
20 #include <asm/arch/cpu.h>
21 #include <asm/arch/config.h>
26 * 1. Unless specified otherwise, all references to tables or paragraphs
27 * are to UM10326, "LPC32x0 and LPC32x0/01 User manual".
29 * 2. Only bitfield masks/values which are actually used by the driver
33 /* a single RX descriptor. The controller has an array of these */
34 struct lpc32xx_eth_rxdesc {
35 u32 packet; /* Receive packet pointer */
36 u32 control; /* Descriptor command status */
39 #define LPC32XX_ETH_RX_DESC_SIZE (sizeof(struct lpc32xx_eth_rxdesc))
41 /* RX control bitfields/masks (see Table 330) */
42 #define LPC32XX_ETH_RX_CTRL_SIZE_MASK 0x000007FF
43 #define LPC32XX_ETH_RX_CTRL_UNUSED 0x7FFFF800
44 #define LPC32XX_ETH_RX_CTRL_INTERRUPT 0x80000000
46 /* a single RX status. The controller has an array of these */
47 struct lpc32xx_eth_rxstat {
48 u32 statusinfo; /* Transmit Descriptor status */
49 u32 statushashcrc; /* Transmit Descriptor CRCs */
52 #define LPC32XX_ETH_RX_STAT_SIZE (sizeof(struct lpc32xx_eth_rxstat))
54 /* RX statusinfo bitfields/masks (see Table 333) */
55 #define RX_STAT_RXSIZE 0x000007FF
56 /* Helper: OR of all errors except RANGE */
57 #define RX_STAT_ERRORS 0x1B800000
59 /* a single TX descriptor. The controller has an array of these */
60 struct lpc32xx_eth_txdesc {
61 u32 packet; /* Transmit packet pointer */
62 u32 control; /* Descriptor control */
65 #define LPC32XX_ETH_TX_DESC_SIZE (sizeof(struct lpc32xx_eth_txdesc))
67 /* TX control bitfields/masks (see Table 335) */
68 #define TX_CTRL_TXSIZE 0x000007FF
69 #define TX_CTRL_LAST 0x40000000
71 /* a single TX status. The controller has an array of these */
72 struct lpc32xx_eth_txstat {
73 u32 statusinfo; /* Transmit Descriptor status */
76 #define LPC32XX_ETH_TX_STAT_SIZE (sizeof(struct lpc32xx_eth_txstat))
78 /* Ethernet MAC interface registers (see Table 283) */
79 struct lpc32xx_eth_registers {
80 /* MAC registers - 0x3106_0000 to 0x3106_01FC */
81 u32 mac1; /* MAC configuration register 1 */
82 u32 mac2; /* MAC configuration register 2 */
83 u32 ipgt; /* Back-to-back Inter-Packet Gap reg. */
84 u32 ipgr; /* Non-back-to-back IPG register */
85 u32 clrt; /* Collision Window / Retry register */
86 u32 maxf; /* Maximum Frame register */
87 u32 supp; /* Phy Support register */
89 u32 mcfg; /* MII management configuration reg. */
90 u32 mcmd; /* MII management command register */
91 u32 madr; /* MII management address register */
92 u32 mwtd; /* MII management wite data register */
93 u32 mrdd; /* MII management read data register */
94 u32 mind; /* MII management indicators register */
96 u32 sa0; /* Station address register 0 */
97 u32 sa1; /* Station address register 1 */
98 u32 sa2; /* Station address register 2 */
100 /* Control registers */
105 u32 rxdescriptornumber; /* actually, number MINUS ONE */
106 u32 rxproduceindex; /* head of rx desc fifo */
107 u32 rxconsumeindex; /* tail of rx desc fifo */
110 u32 txdescriptornumber; /* actually, number MINUS ONE */
111 u32 txproduceindex; /* head of rx desc fifo */
112 u32 txconsumeindex; /* tail of rx desc fifo */
114 u32 tsv0; /* Transmit status vector register 0 */
115 u32 tsv1; /* Transmit status vector register 1 */
116 u32 rsv; /* Receive status vector register */
118 u32 flowcontrolcounter;
119 u32 flowcontrolstatus;
121 /* RX filter registers - 0x3106_0200 to 0x3106_0FDC */
123 u32 rxfilterwolstatus;
124 u32 rxfilterwolclear;
129 /* Module control registers - 0x3106_0FE0 to 0x3106_0FF8 */
130 u32 intstatus; /* Interrupt status register */
139 /* MAC1 register bitfields/masks and offsets (see Table 283) */
140 #define MAC1_RECV_ENABLE 0x00000001
141 #define MAC1_PASS_ALL_RX_FRAMES 0x00000002
142 #define MAC1_SOFT_RESET 0x00008000
143 /* Helper: general reset */
144 #define MAC1_RESETS 0x0000CF00
146 /* MAC2 register bitfields/masks and offsets (see Table 284) */
147 #define MAC2_FULL_DUPLEX 0x00000001
148 #define MAC2_CRC_ENABLE 0x00000010
149 #define MAC2_PAD_CRC_ENABLE 0x00000020
151 /* SUPP register bitfields/masks and offsets (see Table 290) */
152 #define SUPP_SPEED 0x00000100
154 /* MCFG register bitfields/masks and offsets (see Table 292) */
155 #define MCFG_RESET_MII_MGMT 0x00008000
156 /* divide clock by 28 (see Table 293) */
157 #define MCFG_CLOCK_SELECT_DIV28 0x0000001C
159 /* MADR register bitfields/masks and offsets (see Table 295) */
160 #define MADR_REG_MASK 0x0000001F
161 #define MADR_PHY_MASK 0x00001F00
162 #define MADR_REG_OFFSET 0
163 #define MADR_PHY_OFFSET 8
165 /* MIND register bitfields/masks (see Table 298) */
166 #define MIND_BUSY 0x00000001
168 /* COMMAND register bitfields/masks and offsets (see Table 283) */
169 #define COMMAND_RXENABLE 0x00000001
170 #define COMMAND_TXENABLE 0x00000002
171 #define COMMAND_PASSRUNTFRAME 0x00000040
172 #define COMMAND_RMII 0x00000200
173 #define COMMAND_FULL_DUPLEX 0x00000400
174 /* Helper: general reset */
175 #define COMMAND_RESETS 0x00000038
177 /* STATUS register bitfields/masks and offsets (see Table 283) */
178 #define STATUS_RXSTATUS 0x00000001
179 #define STATUS_TXSTATUS 0x00000002
181 /* RXFILTERCTRL register bitfields/masks (see Table 319) */
182 #define RXFILTERCTRL_ACCEPTBROADCAST 0x00000002
183 #define RXFILTERCTRL_ACCEPTPERFECT 0x00000020
185 /* Buffers and descriptors */
187 #define ATTRS(n) __aligned(n)
189 #define TX_BUF_COUNT 4
190 #define RX_BUF_COUNT 4
192 struct lpc32xx_eth_buffers {
193 ATTRS(4) struct lpc32xx_eth_txdesc tx_desc[TX_BUF_COUNT];
194 ATTRS(4) struct lpc32xx_eth_txstat tx_stat[TX_BUF_COUNT];
195 ATTRS(PKTALIGN) u8 tx_buf[TX_BUF_COUNT*PKTSIZE_ALIGN];
196 ATTRS(4) struct lpc32xx_eth_rxdesc rx_desc[RX_BUF_COUNT];
197 ATTRS(8) struct lpc32xx_eth_rxstat rx_stat[RX_BUF_COUNT];
198 ATTRS(PKTALIGN) u8 rx_buf[RX_BUF_COUNT*PKTSIZE_ALIGN];
201 /* port device data struct */
202 struct lpc32xx_eth_device {
203 struct eth_device dev;
204 struct lpc32xx_eth_registers *regs;
205 struct lpc32xx_eth_buffers *bufs;
209 #define LPC32XX_ETH_DEVICE_SIZE (sizeof(struct lpc32xx_eth_device))
212 #define to_lpc32xx_eth(_d) container_of(_d, struct lpc32xx_eth_device, dev)
214 /* timeout for MII polling */
215 #define MII_TIMEOUT 10000000
217 /* limits for PHY and register addresses */
218 #define MII_MAX_REG (MADR_REG_MASK >> MADR_REG_OFFSET)
220 #define MII_MAX_PHY (MADR_PHY_MASK >> MADR_PHY_OFFSET)
222 #if defined(CONFIG_PHYLIB) || defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
224 * mii_reg_read - miiphy_read callback function.
226 * Returns 16bit phy register value, or 0xffff on error
228 static int mii_reg_read(struct mii_dev *bus, int phy_adr, int devad,
232 struct eth_device *dev = eth_get_dev_by_name(bus->name);
233 struct lpc32xx_eth_device *dlpc32xx_eth = to_lpc32xx_eth(dev);
234 struct lpc32xx_eth_registers *regs = dlpc32xx_eth->regs;
238 /* check parameters */
239 if (phy_adr > MII_MAX_PHY) {
240 printf("%s:%u: Invalid PHY address %d\n",
241 __func__, __LINE__, phy_adr);
244 if (reg_ofs > MII_MAX_REG) {
245 printf("%s:%u: Invalid register offset %d\n",
246 __func__, __LINE__, reg_ofs);
250 /* write the phy and reg addressse into the MII address reg */
251 writel((phy_adr << MADR_PHY_OFFSET) | (reg_ofs << MADR_REG_OFFSET),
254 /* write 1 to the MII command register to cause a read */
255 writel(1, ®s->mcmd);
257 /* wait till the MII is not busy */
258 timeout = MII_TIMEOUT;
260 /* read MII indicators register */
261 mind_reg = readl(®s->mind);
264 } while (mind_reg & MIND_BUSY);
266 /* write 0 to the MII command register to finish the read */
267 writel(0, ®s->mcmd);
270 printf("%s:%u: MII busy timeout\n", __func__, __LINE__);
274 data = (u16) readl(®s->mrdd);
276 debug("%s:(adr %d, off %d) => %04x\n", __func__, phy_adr,
283 * mii_reg_write - imiiphy_write callback function.
285 * Returns 0 if write succeed, -EINVAL on bad parameters
288 static int mii_reg_write(struct mii_dev *bus, int phy_adr, int devad,
289 int reg_ofs, u16 data)
291 struct eth_device *dev = eth_get_dev_by_name(bus->name);
292 struct lpc32xx_eth_device *dlpc32xx_eth = to_lpc32xx_eth(dev);
293 struct lpc32xx_eth_registers *regs = dlpc32xx_eth->regs;
297 /* check parameters */
298 if (phy_adr > MII_MAX_PHY) {
299 printf("%s:%u: Invalid PHY address %d\n",
300 __func__, __LINE__, phy_adr);
303 if (reg_ofs > MII_MAX_REG) {
304 printf("%s:%u: Invalid register offset %d\n",
305 __func__, __LINE__, reg_ofs);
309 /* write the phy and reg addressse into the MII address reg */
310 writel((phy_adr << MADR_PHY_OFFSET) | (reg_ofs << MADR_REG_OFFSET),
313 /* write data to the MII write register */
314 writel(data, ®s->mwtd);
316 /* wait till the MII is not busy */
317 timeout = MII_TIMEOUT;
319 /* read MII indicators register */
320 mind_reg = readl(®s->mind);
323 } while (mind_reg & MIND_BUSY);
326 printf("%s:%u: MII busy timeout\n", __func__,
331 /*debug("%s:(adr %d, off %d) <= %04x\n", __func__, phy_adr,
339 * Provide default Ethernet buffers base address if target did not.
340 * Locate buffers in SRAM at 0x00001000 to avoid cache issues and
341 * maximize throughput.
343 #if !defined(CONFIG_LPC32XX_ETH_BUFS_BASE)
344 #define CONFIG_LPC32XX_ETH_BUFS_BASE 0x00001000
347 static struct lpc32xx_eth_device lpc32xx_eth = {
348 .regs = (struct lpc32xx_eth_registers *)LPC32XX_ETH_BASE,
349 .bufs = (struct lpc32xx_eth_buffers *)CONFIG_LPC32XX_ETH_BUFS_BASE,
350 #if defined(CONFIG_RMII)
355 #define TX_TIMEOUT 10000
357 static int lpc32xx_eth_send(struct eth_device *dev, void *dataptr, int datasize)
359 struct lpc32xx_eth_device *lpc32xx_eth_device =
360 container_of(dev, struct lpc32xx_eth_device, dev);
361 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
362 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
363 int timeout, tx_index;
365 /* time out if transmit descriptor array remains full too long */
366 timeout = TX_TIMEOUT;
367 while ((readl(®s->status) & STATUS_TXSTATUS) &&
368 (readl(®s->txconsumeindex)
369 == readl(®s->txproduceindex))) {
374 /* determine next transmit packet index to use */
375 tx_index = readl(®s->txproduceindex);
377 /* set up transmit packet */
378 memcpy((void *)&bufs->tx_buf[tx_index * PKTSIZE_ALIGN],
379 (void *)dataptr, datasize);
380 writel(TX_CTRL_LAST | ((datasize - 1) & TX_CTRL_TXSIZE),
381 &bufs->tx_desc[tx_index].control);
382 writel(0, &bufs->tx_stat[tx_index].statusinfo);
384 /* pass transmit packet to DMA engine */
385 tx_index = (tx_index + 1) % TX_BUF_COUNT;
386 writel(tx_index, ®s->txproduceindex);
388 /* transmission succeeded */
392 #define RX_TIMEOUT 1000000
394 static int lpc32xx_eth_recv(struct eth_device *dev)
396 struct lpc32xx_eth_device *lpc32xx_eth_device =
397 container_of(dev, struct lpc32xx_eth_device, dev);
398 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
399 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
400 int timeout, rx_index;
402 /* time out if receive descriptor array remains empty too long */
403 timeout = RX_TIMEOUT;
404 while (readl(®s->rxproduceindex) == readl(®s->rxconsumeindex)) {
409 /* determine next receive packet index to use */
410 rx_index = readl(®s->rxconsumeindex);
412 /* if data was valid, pass it on */
413 if (!(bufs->rx_stat[rx_index].statusinfo & RX_STAT_ERRORS)) {
414 net_process_received_packet(
415 &(bufs->rx_buf[rx_index * PKTSIZE_ALIGN]),
416 (bufs->rx_stat[rx_index].statusinfo
417 & RX_STAT_RXSIZE) + 1);
420 /* pass receive slot back to DMA engine */
421 rx_index = (rx_index + 1) % RX_BUF_COUNT;
422 writel(rx_index, ®s->rxconsumeindex);
424 /* reception successful */
428 static int lpc32xx_eth_write_hwaddr(struct eth_device *dev)
430 struct lpc32xx_eth_device *lpc32xx_eth_device =
431 container_of(dev, struct lpc32xx_eth_device, dev);
432 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
434 /* Save station address */
435 writel((unsigned long) (dev->enetaddr[0] |
436 (dev->enetaddr[1] << 8)), ®s->sa2);
437 writel((unsigned long) (dev->enetaddr[2] |
438 (dev->enetaddr[3] << 8)), ®s->sa1);
439 writel((unsigned long) (dev->enetaddr[4] |
440 (dev->enetaddr[5] << 8)), ®s->sa0);
445 static int lpc32xx_eth_init(struct eth_device *dev)
447 struct lpc32xx_eth_device *lpc32xx_eth_device =
448 container_of(dev, struct lpc32xx_eth_device, dev);
449 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
450 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
453 /* Initial MAC initialization */
454 writel(MAC1_PASS_ALL_RX_FRAMES, ®s->mac1);
455 writel(MAC2_PAD_CRC_ENABLE | MAC2_CRC_ENABLE, ®s->mac2);
456 writel(PKTSIZE_ALIGN, ®s->maxf);
458 /* Retries: 15 (0xF). Collision window: 57 (0x37). */
459 writel(0x370F, ®s->clrt);
461 /* Set IP gap pt 2 to default 0x12 but pt 1 to non-default 0 */
462 writel(0x0012, ®s->ipgr);
464 /* pass runt (smaller than 64 bytes) frames */
465 if (lpc32xx_eth_device->phy_rmii)
466 writel(COMMAND_PASSRUNTFRAME | COMMAND_RMII, ®s->command);
468 writel(COMMAND_PASSRUNTFRAME, ®s->command);
470 /* Configure Full/Half Duplex mode */
471 if (miiphy_duplex(dev->name, CONFIG_PHY_ADDR) == FULL) {
472 setbits_le32(®s->mac2, MAC2_FULL_DUPLEX);
473 setbits_le32(®s->command, COMMAND_FULL_DUPLEX);
474 writel(0x15, ®s->ipgt);
476 writel(0x12, ®s->ipgt);
479 /* Configure 100MBit/10MBit mode */
480 if (miiphy_speed(dev->name, CONFIG_PHY_ADDR) == _100BASET)
481 writel(SUPP_SPEED, ®s->supp);
483 writel(0, ®s->supp);
485 /* Save station address */
486 writel((unsigned long) (dev->enetaddr[0] |
487 (dev->enetaddr[1] << 8)), ®s->sa2);
488 writel((unsigned long) (dev->enetaddr[2] |
489 (dev->enetaddr[3] << 8)), ®s->sa1);
490 writel((unsigned long) (dev->enetaddr[4] |
491 (dev->enetaddr[5] << 8)), ®s->sa0);
493 /* set up transmit buffers */
494 for (index = 0; index < TX_BUF_COUNT; index++) {
495 bufs->tx_desc[index].control = 0;
496 bufs->tx_stat[index].statusinfo = 0;
498 writel((u32)(&bufs->tx_desc), (u32 *)®s->txdescriptor);
499 writel((u32)(&bufs->tx_stat), ®s->txstatus);
500 writel(TX_BUF_COUNT-1, ®s->txdescriptornumber);
502 /* set up receive buffers */
503 for (index = 0; index < RX_BUF_COUNT; index++) {
504 bufs->rx_desc[index].packet =
505 (u32) (bufs->rx_buf+index*PKTSIZE_ALIGN);
506 bufs->rx_desc[index].control = PKTSIZE_ALIGN - 1;
507 bufs->rx_stat[index].statusinfo = 0;
508 bufs->rx_stat[index].statushashcrc = 0;
510 writel((u32)(&bufs->rx_desc), ®s->rxdescriptor);
511 writel((u32)(&bufs->rx_stat), ®s->rxstatus);
512 writel(RX_BUF_COUNT-1, ®s->rxdescriptornumber);
514 /* set up transmit buffers */
515 for (index = 0; index < TX_BUF_COUNT; index++)
516 bufs->tx_desc[index].packet =
517 (u32)(bufs->tx_buf + index * PKTSIZE_ALIGN);
519 /* Enable broadcast and matching address packets */
520 writel(RXFILTERCTRL_ACCEPTBROADCAST |
521 RXFILTERCTRL_ACCEPTPERFECT, ®s->rxfilterctrl);
523 /* Clear and disable interrupts */
524 writel(0xFFFF, ®s->intclear);
525 writel(0, ®s->intenable);
527 /* Enable receive and transmit mode of MAC ethernet core */
528 setbits_le32(®s->command, COMMAND_RXENABLE | COMMAND_TXENABLE);
529 setbits_le32(®s->mac1, MAC1_RECV_ENABLE);
532 * Perform a 'dummy' first send to work around Ethernet.1
533 * erratum (see ES_LPC3250 rev. 9 dated 1 June 2011).
534 * Use zeroed "index" variable as the dummy.
538 lpc32xx_eth_send(dev, &index, 4);
543 static int lpc32xx_eth_halt(struct eth_device *dev)
545 struct lpc32xx_eth_device *lpc32xx_eth_device =
546 container_of(dev, struct lpc32xx_eth_device, dev);
547 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
549 /* Reset all MAC logic */
550 writel(MAC1_RESETS, ®s->mac1);
551 writel(COMMAND_RESETS, ®s->command);
552 /* Let reset condition settle */
558 #if defined(CONFIG_PHYLIB)
559 int lpc32xx_eth_phylib_init(struct eth_device *dev, int phyid)
561 struct lpc32xx_eth_device *lpc32xx_eth_device =
562 container_of(dev, struct lpc32xx_eth_device, dev);
564 struct phy_device *phydev;
569 printf("mdio_alloc failed\n");
572 bus->read = mii_reg_read;
573 bus->write = mii_reg_write;
574 strcpy(bus->name, dev->name);
576 ret = mdio_register(bus);
578 printf("mdio_register failed\n");
583 if (lpc32xx_eth_device->phy_rmii)
584 phydev = phy_connect(bus, phyid, dev, PHY_INTERFACE_MODE_RMII);
586 phydev = phy_connect(bus, phyid, dev, PHY_INTERFACE_MODE_MII);
589 printf("phy_connect failed\n");
600 int lpc32xx_eth_initialize(struct bd_info *bis)
602 struct eth_device *dev = &lpc32xx_eth.dev;
603 struct lpc32xx_eth_registers *regs = lpc32xx_eth.regs;
606 * Set RMII management clock rate. With HCLK at 104 MHz and
607 * a divider of 28, this will be 3.72 MHz.
609 writel(MCFG_RESET_MII_MGMT, ®s->mcfg);
610 writel(MCFG_CLOCK_SELECT_DIV28, ®s->mcfg);
612 /* Reset all MAC logic */
613 writel(MAC1_RESETS, ®s->mac1);
614 writel(COMMAND_RESETS, ®s->command);
616 /* wait 10 ms for the whole I/F to reset */
619 /* must be less than sizeof(dev->name) */
620 strcpy(dev->name, "eth0");
622 dev->init = (void *)lpc32xx_eth_init;
623 dev->halt = (void *)lpc32xx_eth_halt;
624 dev->send = (void *)lpc32xx_eth_send;
625 dev->recv = (void *)lpc32xx_eth_recv;
626 dev->write_hwaddr = (void *)lpc32xx_eth_write_hwaddr;
628 /* Release SOFT reset to let MII talk to PHY */
629 clrbits_le32(®s->mac1, MAC1_SOFT_RESET);
631 /* register driver before talking to phy */
634 #if defined(CONFIG_PHYLIB)
635 lpc32xx_eth_phylib_init(dev, CONFIG_PHY_ADDR);
636 #elif defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
638 struct mii_dev *mdiodev = mdio_alloc();
641 strncpy(mdiodev->name, dev->name, MDIO_NAME_LEN);
642 mdiodev->read = mii_reg_read;
643 mdiodev->write = mii_reg_write;
645 retval = mdio_register(mdiodev);