2 * LPC32xx Ethernet MAC interface driver
4 * (C) Copyright 2014 DENX Software Engineering GmbH
5 * Written-by: Albert ARIBAUD - 3ADEV <albert.aribaud@3adev.fr>
7 * SPDX-License-Identifier: GPL-2.0+
15 #include <asm/errno.h>
16 #include <asm/types.h>
17 #include <asm/system.h>
18 #include <asm/byteorder.h>
19 #include <asm/arch/cpu.h>
20 #include <asm/arch/config.h>
25 * 1. Unless specified otherwise, all references to tables or paragraphs
26 * are to UM10326, "LPC32x0 and LPC32x0/01 User manual".
28 * 2. Only bitfield masks/values which are actually used by the driver
32 /* a single RX descriptor. The controller has an array of these */
33 struct lpc32xx_eth_rxdesc {
34 u32 packet; /* Receive packet pointer */
35 u32 control; /* Descriptor command status */
38 #define LPC32XX_ETH_RX_DESC_SIZE (sizeof(struct lpc32xx_eth_rxdesc))
40 /* RX control bitfields/masks (see Table 330) */
41 #define LPC32XX_ETH_RX_CTRL_SIZE_MASK 0x000007FF
42 #define LPC32XX_ETH_RX_CTRL_UNUSED 0x7FFFF800
43 #define LPC32XX_ETH_RX_CTRL_INTERRUPT 0x80000000
45 /* a single RX status. The controller has an array of these */
46 struct lpc32xx_eth_rxstat {
47 u32 statusinfo; /* Transmit Descriptor status */
48 u32 statushashcrc; /* Transmit Descriptor CRCs */
51 #define LPC32XX_ETH_RX_STAT_SIZE (sizeof(struct lpc32xx_eth_rxstat))
53 /* RX statusinfo bitfields/masks (see Table 333) */
54 #define RX_STAT_RXSIZE 0x000007FF
55 /* Helper: OR of all errors except RANGE */
56 #define RX_STAT_ERRORS 0x1B800000
58 /* a single TX descriptor. The controller has an array of these */
59 struct lpc32xx_eth_txdesc {
60 u32 packet; /* Transmit packet pointer */
61 u32 control; /* Descriptor control */
64 #define LPC32XX_ETH_TX_DESC_SIZE (sizeof(struct lpc32xx_eth_txdesc))
66 /* TX control bitfields/masks (see Table 335) */
67 #define TX_CTRL_TXSIZE 0x000007FF
68 #define TX_CTRL_LAST 0x40000000
70 /* a single TX status. The controller has an array of these */
71 struct lpc32xx_eth_txstat {
72 u32 statusinfo; /* Transmit Descriptor status */
75 #define LPC32XX_ETH_TX_STAT_SIZE (sizeof(struct lpc32xx_eth_txstat))
77 /* Ethernet MAC interface registers (see Table 283) */
78 struct lpc32xx_eth_registers {
79 /* MAC registers - 0x3106_0000 to 0x3106_01FC */
80 u32 mac1; /* MAC configuration register 1 */
81 u32 mac2; /* MAC configuration register 2 */
82 u32 ipgt; /* Back-to-back Inter-Packet Gap reg. */
83 u32 ipgr; /* Non-back-to-back IPG register */
84 u32 clrt; /* Collision Window / Retry register */
85 u32 maxf; /* Maximum Frame register */
86 u32 supp; /* Phy Support register */
88 u32 mcfg; /* MII management configuration reg. */
89 u32 mcmd; /* MII management command register */
90 u32 madr; /* MII management address register */
91 u32 mwtd; /* MII management wite data register */
92 u32 mrdd; /* MII management read data register */
93 u32 mind; /* MII management indicators register */
95 u32 sa0; /* Station address register 0 */
96 u32 sa1; /* Station address register 1 */
97 u32 sa2; /* Station address register 2 */
99 /* Control registers */
104 u32 rxdescriptornumber; /* actually, number MINUS ONE */
105 u32 rxproduceindex; /* head of rx desc fifo */
106 u32 rxconsumeindex; /* tail of rx desc fifo */
109 u32 txdescriptornumber; /* actually, number MINUS ONE */
110 u32 txproduceindex; /* head of rx desc fifo */
111 u32 txconsumeindex; /* tail of rx desc fifo */
113 u32 tsv0; /* Transmit status vector register 0 */
114 u32 tsv1; /* Transmit status vector register 1 */
115 u32 rsv; /* Receive status vector register */
117 u32 flowcontrolcounter;
118 u32 flowcontrolstatus;
120 /* RX filter registers - 0x3106_0200 to 0x3106_0FDC */
122 u32 rxfilterwolstatus;
123 u32 rxfilterwolclear;
128 /* Module control registers - 0x3106_0FE0 to 0x3106_0FF8 */
129 u32 intstatus; /* Interrupt status register */
138 /* MAC1 register bitfields/masks and offsets (see Table 283) */
139 #define MAC1_RECV_ENABLE 0x00000001
140 #define MAC1_PASS_ALL_RX_FRAMES 0x00000002
141 #define MAC1_SOFT_RESET 0x00008000
142 /* Helper: general reset */
143 #define MAC1_RESETS 0x0000CF00
145 /* MAC2 register bitfields/masks and offsets (see Table 284) */
146 #define MAC2_FULL_DUPLEX 0x00000001
147 #define MAC2_CRC_ENABLE 0x00000010
148 #define MAC2_PAD_CRC_ENABLE 0x00000020
150 /* SUPP register bitfields/masks and offsets (see Table 290) */
151 #define SUPP_SPEED 0x00000100
153 /* MCFG register bitfields/masks and offsets (see Table 292) */
154 #define MCFG_CLOCK_SELECT_MASK 0x0000001C
155 /* divide clock by 28 (see Table 293) */
156 #define MCFG_CLOCK_SELECT_DIV28 0x0000001C
158 /* MADR register bitfields/masks and offsets (see Table 295) */
159 #define MADR_REG_MASK 0x0000001F
160 #define MADR_PHY_MASK 0x00001F00
161 #define MADR_REG_OFFSET 0
162 #define MADR_PHY_OFFSET 8
164 /* MIND register bitfields/masks (see Table 298) */
165 #define MIND_BUSY 0x00000001
167 /* COMMAND register bitfields/masks and offsets (see Table 283) */
168 #define COMMAND_RXENABLE 0x00000001
169 #define COMMAND_TXENABLE 0x00000002
170 #define COMMAND_PASSRUNTFRAME 0x00000040
171 #define COMMAND_FULL_DUPLEX 0x00000400
172 /* Helper: general reset */
173 #define COMMAND_RESETS 0x0000001C
175 /* STATUS register bitfields/masks and offsets (see Table 283) */
176 #define STATUS_RXSTATUS 0x00000001
177 #define STATUS_TXSTATUS 0x00000002
179 /* RXFILTERCTRL register bitfields/masks (see Table 319) */
180 #define RXFILTERCTRL_ACCEPTBROADCAST 0x00000002
181 #define RXFILTERCTRL_ACCEPTPERFECT 0x00000020
183 /* Buffers and descriptors */
185 #define ATTRS(n) __aligned(n)
187 #define TX_BUF_COUNT 4
188 #define RX_BUF_COUNT 4
190 struct lpc32xx_eth_buffers {
191 ATTRS(4) struct lpc32xx_eth_txdesc tx_desc[TX_BUF_COUNT];
192 ATTRS(4) struct lpc32xx_eth_txstat tx_stat[TX_BUF_COUNT];
193 ATTRS(PKTALIGN) u8 tx_buf[TX_BUF_COUNT*PKTSIZE_ALIGN];
194 ATTRS(4) struct lpc32xx_eth_rxdesc rx_desc[RX_BUF_COUNT];
195 ATTRS(8) struct lpc32xx_eth_rxstat rx_stat[RX_BUF_COUNT];
196 ATTRS(PKTALIGN) u8 rx_buf[RX_BUF_COUNT*PKTSIZE_ALIGN];
199 /* port device data struct */
200 struct lpc32xx_eth_device {
201 struct eth_device dev;
202 struct lpc32xx_eth_registers *regs;
203 struct lpc32xx_eth_buffers *bufs;
206 #define LPC32XX_ETH_DEVICE_SIZE (sizeof(struct lpc32xx_eth_device))
209 #define to_lpc32xx_eth(_d) container_of(_d, struct lpc32xx_eth_device, dev)
211 /* timeout for MII polling */
212 #define MII_TIMEOUT 10000000
214 /* limits for PHY and register addresses */
215 #define MII_MAX_REG (MADR_REG_MASK >> MADR_REG_OFFSET)
217 #define MII_MAX_PHY (MADR_PHY_MASK >> MADR_PHY_OFFSET)
219 DECLARE_GLOBAL_DATA_PTR;
221 #if defined(CONFIG_PHYLIB) || defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
223 * mii_reg_read - miiphy_read callback function.
225 * Returns 16bit phy register value, or 0xffff on error
227 static int mii_reg_read(const char *devname, u8 phy_adr, u8 reg_ofs, u16 *data)
229 struct eth_device *dev = eth_get_dev_by_name(devname);
230 struct lpc32xx_eth_device *dlpc32xx_eth = to_lpc32xx_eth(dev);
231 struct lpc32xx_eth_registers *regs = dlpc32xx_eth->regs;
235 /* check parameters */
236 if (phy_adr > MII_MAX_PHY) {
237 printf("%s:%u: Invalid PHY address %d\n",
238 __func__, __LINE__, phy_adr);
241 if (reg_ofs > MII_MAX_REG) {
242 printf("%s:%u: Invalid register offset %d\n",
243 __func__, __LINE__, reg_ofs);
247 /* write the phy and reg addressse into the MII address reg */
248 writel((phy_adr << MADR_PHY_OFFSET) | (reg_ofs << MADR_REG_OFFSET),
251 /* write 1 to the MII command register to cause a read */
252 writel(1, ®s->mcmd);
254 /* wait till the MII is not busy */
255 timeout = MII_TIMEOUT;
257 /* read MII indicators register */
258 mind_reg = readl(®s->mind);
261 } while (mind_reg & MIND_BUSY);
263 /* write 0 to the MII command register to finish the read */
264 writel(0, ®s->mcmd);
267 printf("%s:%u: MII busy timeout\n", __func__, __LINE__);
271 *data = (u16) readl(®s->mrdd);
273 debug("%s:(adr %d, off %d) => %04x\n", __func__, phy_adr,
280 * mii_reg_write - imiiphy_write callback function.
282 * Returns 0 if write succeed, -EINVAL on bad parameters
285 static int mii_reg_write(const char *devname, u8 phy_adr, u8 reg_ofs, u16 data)
287 struct eth_device *dev = eth_get_dev_by_name(devname);
288 struct lpc32xx_eth_device *dlpc32xx_eth = to_lpc32xx_eth(dev);
289 struct lpc32xx_eth_registers *regs = dlpc32xx_eth->regs;
293 /* check parameters */
294 if (phy_adr > MII_MAX_PHY) {
295 printf("%s:%u: Invalid PHY address %d\n",
296 __func__, __LINE__, phy_adr);
299 if (reg_ofs > MII_MAX_REG) {
300 printf("%s:%u: Invalid register offset %d\n",
301 __func__, __LINE__, reg_ofs);
305 /* wait till the MII is not busy */
306 timeout = MII_TIMEOUT;
308 /* read MII indicators register */
309 mind_reg = readl(®s->mind);
312 } while (mind_reg & MIND_BUSY);
315 printf("%s:%u: MII busy timeout\n", __func__,
320 /* write the phy and reg addressse into the MII address reg */
321 writel((phy_adr << MADR_PHY_OFFSET) | (reg_ofs << MADR_REG_OFFSET),
324 /* write data to the MII write register */
325 writel(data, ®s->mwtd);
327 /*debug("%s:(adr %d, off %d) <= %04x\n", __func__, phy_adr,
334 #if defined(CONFIG_PHYLIB)
335 int lpc32xx_eth_phy_read(struct mii_dev *bus, int phy_addr, int dev_addr,
340 ret = mii_reg_read(bus->name, phy_addr, reg_addr, &data);
346 int lpc32xx_eth_phy_write(struct mii_dev *bus, int phy_addr, int dev_addr,
347 int reg_addr, u16 data)
349 return mii_reg_write(bus->name, phy_addr, reg_addr, data);
354 * Locate buffers in SRAM at 0x00001000 to avoid cache issues and
355 * maximize throughput.
358 #define LPC32XX_ETH_BUFS 0x00001000
360 static struct lpc32xx_eth_device lpc32xx_eth = {
361 .regs = (struct lpc32xx_eth_registers *)LPC32XX_ETH_BASE,
362 .bufs = (struct lpc32xx_eth_buffers *)LPC32XX_ETH_BUFS
365 #define TX_TIMEOUT 10000
367 static int lpc32xx_eth_send(struct eth_device *dev, void *dataptr, int datasize)
369 struct lpc32xx_eth_device *lpc32xx_eth_device =
370 container_of(dev, struct lpc32xx_eth_device, dev);
371 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
372 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
373 int timeout, tx_index;
375 /* time out if transmit descriptor array remains full too long */
376 timeout = TX_TIMEOUT;
377 while ((readl(®s->status) & STATUS_TXSTATUS) &&
378 (readl(®s->txconsumeindex)
379 == readl(®s->txproduceindex))) {
384 /* determine next transmit packet index to use */
385 tx_index = readl(®s->txproduceindex);
387 /* set up transmit packet */
388 writel((u32)dataptr, &bufs->tx_desc[tx_index].packet);
389 writel(TX_CTRL_LAST | ((datasize - 1) & TX_CTRL_TXSIZE),
390 &bufs->tx_desc[tx_index].control);
391 writel(0, &bufs->tx_stat[tx_index].statusinfo);
393 /* pass transmit packet to DMA engine */
394 tx_index = (tx_index + 1) % TX_BUF_COUNT;
395 writel(tx_index, ®s->txproduceindex);
397 /* transmission succeeded */
401 #define RX_TIMEOUT 1000000
403 static int lpc32xx_eth_recv(struct eth_device *dev)
405 struct lpc32xx_eth_device *lpc32xx_eth_device =
406 container_of(dev, struct lpc32xx_eth_device, dev);
407 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
408 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
409 int timeout, rx_index;
411 /* time out if receive descriptor array remains empty too long */
412 timeout = RX_TIMEOUT;
413 while (readl(®s->rxproduceindex) == readl(®s->rxconsumeindex)) {
418 /* determine next receive packet index to use */
419 rx_index = readl(®s->rxconsumeindex);
421 /* if data was valid, pass it on */
422 if (!(bufs->rx_stat[rx_index].statusinfo & RX_STAT_ERRORS))
423 NetReceive(&(bufs->rx_buf[rx_index*PKTSIZE_ALIGN]),
424 (bufs->rx_stat[rx_index].statusinfo
425 & RX_STAT_RXSIZE) + 1);
427 /* pass receive slot back to DMA engine */
428 rx_index = (rx_index + 1) % RX_BUF_COUNT;
429 writel(rx_index, ®s->rxconsumeindex);
431 /* reception successful */
435 static int lpc32xx_eth_write_hwaddr(struct eth_device *dev)
437 struct lpc32xx_eth_device *lpc32xx_eth_device =
438 container_of(dev, struct lpc32xx_eth_device, dev);
439 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
441 /* Save station address */
442 writel((unsigned long) (dev->enetaddr[0] |
443 (dev->enetaddr[1] << 8)), ®s->sa2);
444 writel((unsigned long) (dev->enetaddr[2] |
445 (dev->enetaddr[3] << 8)), ®s->sa1);
446 writel((unsigned long) (dev->enetaddr[4] |
447 (dev->enetaddr[5] << 8)), ®s->sa0);
452 static int lpc32xx_eth_init(struct eth_device *dev)
454 struct lpc32xx_eth_device *lpc32xx_eth_device =
455 container_of(dev, struct lpc32xx_eth_device, dev);
456 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
457 struct lpc32xx_eth_buffers *bufs = lpc32xx_eth_device->bufs;
460 /* Release SOFT reset to let MII talk to PHY */
461 clrbits_le32(®s->mac1, MAC1_SOFT_RESET);
463 /* Configure Full/Half Duplex mode */
464 if (miiphy_duplex(dev->name, CONFIG_PHY_ADDR) == FULL) {
465 setbits_le32(®s->mac2, MAC2_FULL_DUPLEX);
466 setbits_le32(®s->command, COMMAND_FULL_DUPLEX);
467 writel(0x15, ®s->ipgt);
469 writel(0x12, ®s->ipgt);
472 /* Configure 100MBit/10MBit mode */
473 if (miiphy_speed(dev->name, CONFIG_PHY_ADDR) == _100BASET)
474 writel(SUPP_SPEED, ®s->supp);
476 writel(0, ®s->supp);
478 /* Initial MAC initialization */
479 writel(MAC1_PASS_ALL_RX_FRAMES, ®s->mac1);
480 writel(MAC2_PAD_CRC_ENABLE | MAC2_CRC_ENABLE, ®s->mac2);
481 writel(PKTSIZE_ALIGN, ®s->maxf);
483 /* Retries: 15 (0xF). Collision window: 57 (0x37). */
484 writel(0x370F, ®s->clrt);
486 /* Set IP gap pt 2 to default 0x12 but pt 1 to non-default 0 */
487 writel(0x0012, ®s->ipgr);
489 /* pass runt (smaller than 64 bytes) frames */
490 writel(COMMAND_PASSRUNTFRAME, ®s->command);
492 /* Save station address */
493 writel((unsigned long) (dev->enetaddr[0] |
494 (dev->enetaddr[1] << 8)), ®s->sa2);
495 writel((unsigned long) (dev->enetaddr[2] |
496 (dev->enetaddr[3] << 8)), ®s->sa1);
497 writel((unsigned long) (dev->enetaddr[4] |
498 (dev->enetaddr[5] << 8)), ®s->sa0);
500 /* set up transmit buffers */
501 for (index = 0; index < TX_BUF_COUNT; index++) {
502 bufs->tx_desc[index].control = 0;
503 bufs->tx_stat[index].statusinfo = 0;
505 writel((u32)(&bufs->tx_desc), (u32 *)®s->txdescriptor);
506 writel((u32)(&bufs->tx_stat), ®s->txstatus);
507 writel(TX_BUF_COUNT-1, ®s->txdescriptornumber);
509 /* set up receive buffers */
510 for (index = 0; index < RX_BUF_COUNT; index++) {
511 bufs->rx_desc[index].packet =
512 (u32) (bufs->rx_buf+index*PKTSIZE_ALIGN);
513 bufs->rx_desc[index].control = PKTSIZE_ALIGN - 1;
514 bufs->rx_stat[index].statusinfo = 0;
515 bufs->rx_stat[index].statushashcrc = 0;
517 writel((u32)(&bufs->rx_desc), ®s->rxdescriptor);
518 writel((u32)(&bufs->rx_stat), ®s->rxstatus);
519 writel(RX_BUF_COUNT-1, ®s->rxdescriptornumber);
521 /* Enable broadcast and matching address packets */
522 writel(RXFILTERCTRL_ACCEPTBROADCAST |
523 RXFILTERCTRL_ACCEPTPERFECT, ®s->rxfilterctrl);
525 /* Clear and disable interrupts */
526 writel(0xFFFF, ®s->intclear);
527 writel(0, ®s->intenable);
529 /* Enable receive and transmit mode of MAC ethernet core */
530 setbits_le32(®s->command, COMMAND_RXENABLE | COMMAND_TXENABLE);
531 setbits_le32(®s->mac1, MAC1_RECV_ENABLE);
534 * Perform a 'dummy' first send to work around Ethernet.1
535 * erratum (see ES_LPC3250 rev. 9 dated 1 June 2011).
536 * Use zeroed "index" variable as the dummy.
540 lpc32xx_eth_send(dev, &index, 4);
545 static int lpc32xx_eth_halt(struct eth_device *dev)
547 struct lpc32xx_eth_device *lpc32xx_eth_device =
548 container_of(dev, struct lpc32xx_eth_device, dev);
549 struct lpc32xx_eth_registers *regs = lpc32xx_eth_device->regs;
551 /* Reset all MAC logic */
552 writel(MAC1_RESETS, ®s->mac1);
553 writel(COMMAND_RESETS, ®s->command);
554 /* Let reset condition settle */
560 #if defined(CONFIG_PHYLIB)
561 int lpc32xx_eth_phylib_init(struct eth_device *dev, int phyid)
564 struct phy_device *phydev;
569 printf("mdio_alloc failed\n");
572 bus->read = lpc32xx_eth_phy_read;
573 bus->write = lpc32xx_eth_phy_write;
574 sprintf(bus->name, dev->name);
576 ret = mdio_register(bus);
578 printf("mdio_register failed\n");
583 phydev = phy_connect(bus, phyid, dev, PHY_INTERFACE_MODE_MII);
585 printf("phy_connect failed\n");
596 int lpc32xx_eth_initialize(bd_t *bis)
598 struct eth_device *dev = &lpc32xx_eth.dev;
599 struct lpc32xx_eth_registers *regs = lpc32xx_eth.regs;
602 * Set RMII management clock rate. With HCLK at 104 MHz and
603 * a divider of 28, this will be 3.72 MHz.
606 writel(MCFG_CLOCK_SELECT_DIV28, ®s->mcfg);
608 /* Reset all MAC logic */
609 writel(MAC1_RESETS, ®s->mac1);
610 writel(COMMAND_RESETS, ®s->command);
612 /* wait 10 ms for the whole I/F to reset */
615 /* must be less than sizeof(dev->name) */
616 strcpy(dev->name, "eth0");
618 dev->init = (void *)lpc32xx_eth_init;
619 dev->halt = (void *)lpc32xx_eth_halt;
620 dev->send = (void *)lpc32xx_eth_send;
621 dev->recv = (void *)lpc32xx_eth_recv;
622 dev->write_hwaddr = (void *)lpc32xx_eth_write_hwaddr;
624 /* Release SOFT reset to let MII talk to PHY */
625 clrbits_le32(®s->mac1, MAC1_SOFT_RESET);
627 /* register driver before talking to phy */
630 #if defined(CONFIG_PHYLIB)
631 lpc32xx_eth_phylib_init(dev, 0);
632 #elif defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
633 miiphy_register(dev->name, mii_reg_read, mii_reg_write);