3 * Vipin Kumar, ST Micoelectronics, vipin.kumar@st.com.
5 * SPDX-License-Identifier: GPL-2.0+
9 * Designware ethernet IP driver for U-Boot
17 #include <linux/compiler.h>
18 #include <linux/err.h>
20 #include "designware.h"
22 DECLARE_GLOBAL_DATA_PTR
;
24 #if !defined(CONFIG_PHYLIB)
25 # error "DesignWare Ether MAC requires PHYLIB - missing CONFIG_PHYLIB"
28 static int dw_mdio_read(struct mii_dev
*bus
, int addr
, int devad
, int reg
)
30 struct eth_mac_regs
*mac_p
= bus
->priv
;
33 int timeout
= CONFIG_MDIO_TIMEOUT
;
35 miiaddr
= ((addr
<< MIIADDRSHIFT
) & MII_ADDRMSK
) |
36 ((reg
<< MIIREGSHIFT
) & MII_REGMSK
);
38 writel(miiaddr
| MII_CLKRANGE_150_250M
| MII_BUSY
, &mac_p
->miiaddr
);
41 while (get_timer(start
) < timeout
) {
42 if (!(readl(&mac_p
->miiaddr
) & MII_BUSY
))
43 return readl(&mac_p
->miidata
);
50 static int dw_mdio_write(struct mii_dev
*bus
, int addr
, int devad
, int reg
,
53 struct eth_mac_regs
*mac_p
= bus
->priv
;
56 int ret
= -ETIMEDOUT
, timeout
= CONFIG_MDIO_TIMEOUT
;
58 writel(val
, &mac_p
->miidata
);
59 miiaddr
= ((addr
<< MIIADDRSHIFT
) & MII_ADDRMSK
) |
60 ((reg
<< MIIREGSHIFT
) & MII_REGMSK
) | MII_WRITE
;
62 writel(miiaddr
| MII_CLKRANGE_150_250M
| MII_BUSY
, &mac_p
->miiaddr
);
65 while (get_timer(start
) < timeout
) {
66 if (!(readl(&mac_p
->miiaddr
) & MII_BUSY
)) {
76 static int dw_mdio_init(const char *name
, struct eth_mac_regs
*mac_regs_p
)
78 struct mii_dev
*bus
= mdio_alloc();
81 printf("Failed to allocate MDIO bus\n");
85 bus
->read
= dw_mdio_read
;
86 bus
->write
= dw_mdio_write
;
87 snprintf(bus
->name
, sizeof(bus
->name
), name
);
89 bus
->priv
= (void *)mac_regs_p
;
91 return mdio_register(bus
);
94 static void tx_descs_init(struct dw_eth_dev
*priv
)
96 struct eth_dma_regs
*dma_p
= priv
->dma_regs_p
;
97 struct dmamacdescr
*desc_table_p
= &priv
->tx_mac_descrtable
[0];
98 char *txbuffs
= &priv
->txbuffs
[0];
99 struct dmamacdescr
*desc_p
;
102 for (idx
= 0; idx
< CONFIG_TX_DESCR_NUM
; idx
++) {
103 desc_p
= &desc_table_p
[idx
];
104 desc_p
->dmamac_addr
= &txbuffs
[idx
* CONFIG_ETH_BUFSIZE
];
105 desc_p
->dmamac_next
= &desc_table_p
[idx
+ 1];
107 #if defined(CONFIG_DW_ALTDESCRIPTOR)
108 desc_p
->txrx_status
&= ~(DESC_TXSTS_TXINT
| DESC_TXSTS_TXLAST
|
109 DESC_TXSTS_TXFIRST
| DESC_TXSTS_TXCRCDIS
| \
110 DESC_TXSTS_TXCHECKINSCTRL
| \
111 DESC_TXSTS_TXRINGEND
| DESC_TXSTS_TXPADDIS
);
113 desc_p
->txrx_status
|= DESC_TXSTS_TXCHAIN
;
114 desc_p
->dmamac_cntl
= 0;
115 desc_p
->txrx_status
&= ~(DESC_TXSTS_MSK
| DESC_TXSTS_OWNBYDMA
);
117 desc_p
->dmamac_cntl
= DESC_TXCTRL_TXCHAIN
;
118 desc_p
->txrx_status
= 0;
122 /* Correcting the last pointer of the chain */
123 desc_p
->dmamac_next
= &desc_table_p
[0];
125 /* Flush all Tx buffer descriptors at once */
126 flush_dcache_range((unsigned int)priv
->tx_mac_descrtable
,
127 (unsigned int)priv
->tx_mac_descrtable
+
128 sizeof(priv
->tx_mac_descrtable
));
130 writel((ulong
)&desc_table_p
[0], &dma_p
->txdesclistaddr
);
131 priv
->tx_currdescnum
= 0;
134 static void rx_descs_init(struct dw_eth_dev
*priv
)
136 struct eth_dma_regs
*dma_p
= priv
->dma_regs_p
;
137 struct dmamacdescr
*desc_table_p
= &priv
->rx_mac_descrtable
[0];
138 char *rxbuffs
= &priv
->rxbuffs
[0];
139 struct dmamacdescr
*desc_p
;
142 /* Before passing buffers to GMAC we need to make sure zeros
143 * written there right after "priv" structure allocation were
145 * Otherwise there's a chance to get some of them flushed in RAM when
146 * GMAC is already pushing data to RAM via DMA. This way incoming from
147 * GMAC data will be corrupted. */
148 flush_dcache_range((unsigned int)rxbuffs
, (unsigned int)rxbuffs
+
151 for (idx
= 0; idx
< CONFIG_RX_DESCR_NUM
; idx
++) {
152 desc_p
= &desc_table_p
[idx
];
153 desc_p
->dmamac_addr
= &rxbuffs
[idx
* CONFIG_ETH_BUFSIZE
];
154 desc_p
->dmamac_next
= &desc_table_p
[idx
+ 1];
156 desc_p
->dmamac_cntl
=
157 (MAC_MAX_FRAME_SZ
& DESC_RXCTRL_SIZE1MASK
) | \
160 desc_p
->txrx_status
= DESC_RXSTS_OWNBYDMA
;
163 /* Correcting the last pointer of the chain */
164 desc_p
->dmamac_next
= &desc_table_p
[0];
166 /* Flush all Rx buffer descriptors at once */
167 flush_dcache_range((unsigned int)priv
->rx_mac_descrtable
,
168 (unsigned int)priv
->rx_mac_descrtable
+
169 sizeof(priv
->rx_mac_descrtable
));
171 writel((ulong
)&desc_table_p
[0], &dma_p
->rxdesclistaddr
);
172 priv
->rx_currdescnum
= 0;
175 static int _dw_write_hwaddr(struct dw_eth_dev
*priv
, u8
*mac_id
)
177 struct eth_mac_regs
*mac_p
= priv
->mac_regs_p
;
178 u32 macid_lo
, macid_hi
;
180 macid_lo
= mac_id
[0] + (mac_id
[1] << 8) + (mac_id
[2] << 16) +
182 macid_hi
= mac_id
[4] + (mac_id
[5] << 8);
184 writel(macid_hi
, &mac_p
->macaddr0hi
);
185 writel(macid_lo
, &mac_p
->macaddr0lo
);
190 static void dw_adjust_link(struct eth_mac_regs
*mac_p
,
191 struct phy_device
*phydev
)
193 u32 conf
= readl(&mac_p
->conf
) | FRAMEBURSTENABLE
| DISABLERXOWN
;
196 printf("%s: No link.\n", phydev
->dev
->name
);
200 if (phydev
->speed
!= 1000)
201 conf
|= MII_PORTSELECT
;
203 if (phydev
->speed
== 100)
207 conf
|= FULLDPLXMODE
;
209 writel(conf
, &mac_p
->conf
);
211 printf("Speed: %d, %s duplex%s\n", phydev
->speed
,
212 (phydev
->duplex
) ? "full" : "half",
213 (phydev
->port
== PORT_FIBRE
) ? ", fiber mode" : "");
216 static void _dw_eth_halt(struct dw_eth_dev
*priv
)
218 struct eth_mac_regs
*mac_p
= priv
->mac_regs_p
;
219 struct eth_dma_regs
*dma_p
= priv
->dma_regs_p
;
221 writel(readl(&mac_p
->conf
) & ~(RXENABLE
| TXENABLE
), &mac_p
->conf
);
222 writel(readl(&dma_p
->opmode
) & ~(RXSTART
| TXSTART
), &dma_p
->opmode
);
224 phy_shutdown(priv
->phydev
);
227 static int _dw_eth_init(struct dw_eth_dev
*priv
, u8
*enetaddr
)
229 struct eth_mac_regs
*mac_p
= priv
->mac_regs_p
;
230 struct eth_dma_regs
*dma_p
= priv
->dma_regs_p
;
234 writel(readl(&dma_p
->busmode
) | DMAMAC_SRST
, &dma_p
->busmode
);
236 start
= get_timer(0);
237 while (readl(&dma_p
->busmode
) & DMAMAC_SRST
) {
238 if (get_timer(start
) >= CONFIG_MACRESET_TIMEOUT
) {
239 printf("DMA reset timeout\n");
247 * Soft reset above clears HW address registers.
248 * So we have to set it here once again.
250 _dw_write_hwaddr(priv
, enetaddr
);
255 writel(FIXEDBURST
| PRIORXTX_41
| DMA_PBL
, &dma_p
->busmode
);
257 #ifndef CONFIG_DW_MAC_FORCE_THRESHOLD_MODE
258 writel(readl(&dma_p
->opmode
) | FLUSHTXFIFO
| STOREFORWARD
,
261 writel(readl(&dma_p
->opmode
) | FLUSHTXFIFO
,
265 writel(readl(&dma_p
->opmode
) | RXSTART
| TXSTART
, &dma_p
->opmode
);
267 #ifdef CONFIG_DW_AXI_BURST_LEN
268 writel((CONFIG_DW_AXI_BURST_LEN
& 0x1FF >> 1), &dma_p
->axibus
);
271 /* Start up the PHY */
272 ret
= phy_startup(priv
->phydev
);
274 printf("Could not initialize PHY %s\n",
275 priv
->phydev
->dev
->name
);
279 dw_adjust_link(mac_p
, priv
->phydev
);
281 if (!priv
->phydev
->link
)
284 writel(readl(&mac_p
->conf
) | RXENABLE
| TXENABLE
, &mac_p
->conf
);
289 static int _dw_eth_send(struct dw_eth_dev
*priv
, void *packet
, int length
)
291 struct eth_dma_regs
*dma_p
= priv
->dma_regs_p
;
292 u32 desc_num
= priv
->tx_currdescnum
;
293 struct dmamacdescr
*desc_p
= &priv
->tx_mac_descrtable
[desc_num
];
294 uint32_t desc_start
= (uint32_t)desc_p
;
295 uint32_t desc_end
= desc_start
+
296 roundup(sizeof(*desc_p
), ARCH_DMA_MINALIGN
);
297 uint32_t data_start
= (uint32_t)desc_p
->dmamac_addr
;
298 uint32_t data_end
= data_start
+
299 roundup(length
, ARCH_DMA_MINALIGN
);
301 * Strictly we only need to invalidate the "txrx_status" field
302 * for the following check, but on some platforms we cannot
303 * invalidate only 4 bytes, so we flush the entire descriptor,
304 * which is 16 bytes in total. This is safe because the
305 * individual descriptors in the array are each aligned to
306 * ARCH_DMA_MINALIGN and padded appropriately.
308 invalidate_dcache_range(desc_start
, desc_end
);
310 /* Check if the descriptor is owned by CPU */
311 if (desc_p
->txrx_status
& DESC_TXSTS_OWNBYDMA
) {
312 printf("CPU not owner of tx frame\n");
316 memcpy(desc_p
->dmamac_addr
, packet
, length
);
318 /* Flush data to be sent */
319 flush_dcache_range(data_start
, data_end
);
321 #if defined(CONFIG_DW_ALTDESCRIPTOR)
322 desc_p
->txrx_status
|= DESC_TXSTS_TXFIRST
| DESC_TXSTS_TXLAST
;
323 desc_p
->dmamac_cntl
|= (length
<< DESC_TXCTRL_SIZE1SHFT
) & \
324 DESC_TXCTRL_SIZE1MASK
;
326 desc_p
->txrx_status
&= ~(DESC_TXSTS_MSK
);
327 desc_p
->txrx_status
|= DESC_TXSTS_OWNBYDMA
;
329 desc_p
->dmamac_cntl
|= ((length
<< DESC_TXCTRL_SIZE1SHFT
) & \
330 DESC_TXCTRL_SIZE1MASK
) | DESC_TXCTRL_TXLAST
| \
333 desc_p
->txrx_status
= DESC_TXSTS_OWNBYDMA
;
336 /* Flush modified buffer descriptor */
337 flush_dcache_range(desc_start
, desc_end
);
339 /* Test the wrap-around condition. */
340 if (++desc_num
>= CONFIG_TX_DESCR_NUM
)
343 priv
->tx_currdescnum
= desc_num
;
345 /* Start the transmission */
346 writel(POLL_DATA
, &dma_p
->txpolldemand
);
351 static int _dw_eth_recv(struct dw_eth_dev
*priv
, uchar
**packetp
)
353 u32 status
, desc_num
= priv
->rx_currdescnum
;
354 struct dmamacdescr
*desc_p
= &priv
->rx_mac_descrtable
[desc_num
];
355 int length
= -EAGAIN
;
356 uint32_t desc_start
= (uint32_t)desc_p
;
357 uint32_t desc_end
= desc_start
+
358 roundup(sizeof(*desc_p
), ARCH_DMA_MINALIGN
);
359 uint32_t data_start
= (uint32_t)desc_p
->dmamac_addr
;
362 /* Invalidate entire buffer descriptor */
363 invalidate_dcache_range(desc_start
, desc_end
);
365 status
= desc_p
->txrx_status
;
367 /* Check if the owner is the CPU */
368 if (!(status
& DESC_RXSTS_OWNBYDMA
)) {
370 length
= (status
& DESC_RXSTS_FRMLENMSK
) >> \
371 DESC_RXSTS_FRMLENSHFT
;
373 /* Invalidate received data */
374 data_end
= data_start
+ roundup(length
, ARCH_DMA_MINALIGN
);
375 invalidate_dcache_range(data_start
, data_end
);
376 *packetp
= desc_p
->dmamac_addr
;
382 static int _dw_free_pkt(struct dw_eth_dev
*priv
)
384 u32 desc_num
= priv
->rx_currdescnum
;
385 struct dmamacdescr
*desc_p
= &priv
->rx_mac_descrtable
[desc_num
];
386 uint32_t desc_start
= (uint32_t)desc_p
;
387 uint32_t desc_end
= desc_start
+
388 roundup(sizeof(*desc_p
), ARCH_DMA_MINALIGN
);
391 * Make the current descriptor valid again and go to
394 desc_p
->txrx_status
|= DESC_RXSTS_OWNBYDMA
;
396 /* Flush only status field - others weren't changed */
397 flush_dcache_range(desc_start
, desc_end
);
399 /* Test the wrap-around condition. */
400 if (++desc_num
>= CONFIG_RX_DESCR_NUM
)
402 priv
->rx_currdescnum
= desc_num
;
407 static int dw_phy_init(struct dw_eth_dev
*priv
, void *dev
)
409 struct phy_device
*phydev
;
410 int mask
= 0xffffffff;
412 #ifdef CONFIG_PHY_ADDR
413 mask
= 1 << CONFIG_PHY_ADDR
;
416 phydev
= phy_find_by_mask(priv
->bus
, mask
, priv
->interface
);
420 phy_connect_dev(phydev
, dev
);
422 phydev
->supported
&= PHY_GBIT_FEATURES
;
423 phydev
->advertising
= phydev
->supported
;
425 priv
->phydev
= phydev
;
431 #ifndef CONFIG_DM_ETH
432 static int dw_eth_init(struct eth_device
*dev
, bd_t
*bis
)
434 return _dw_eth_init(dev
->priv
, dev
->enetaddr
);
437 static int dw_eth_send(struct eth_device
*dev
, void *packet
, int length
)
439 return _dw_eth_send(dev
->priv
, packet
, length
);
442 static int dw_eth_recv(struct eth_device
*dev
)
447 length
= _dw_eth_recv(dev
->priv
, &packet
);
448 if (length
== -EAGAIN
)
450 net_process_received_packet(packet
, length
);
452 _dw_free_pkt(dev
->priv
);
457 static void dw_eth_halt(struct eth_device
*dev
)
459 return _dw_eth_halt(dev
->priv
);
462 static int dw_write_hwaddr(struct eth_device
*dev
)
464 return _dw_write_hwaddr(dev
->priv
, dev
->enetaddr
);
467 int designware_initialize(ulong base_addr
, u32 interface
)
469 struct eth_device
*dev
;
470 struct dw_eth_dev
*priv
;
472 dev
= (struct eth_device
*) malloc(sizeof(struct eth_device
));
477 * Since the priv structure contains the descriptors which need a strict
478 * buswidth alignment, memalign is used to allocate memory
480 priv
= (struct dw_eth_dev
*) memalign(ARCH_DMA_MINALIGN
,
481 sizeof(struct dw_eth_dev
));
487 memset(dev
, 0, sizeof(struct eth_device
));
488 memset(priv
, 0, sizeof(struct dw_eth_dev
));
490 sprintf(dev
->name
, "dwmac.%lx", base_addr
);
491 dev
->iobase
= (int)base_addr
;
495 priv
->mac_regs_p
= (struct eth_mac_regs
*)base_addr
;
496 priv
->dma_regs_p
= (struct eth_dma_regs
*)(base_addr
+
499 dev
->init
= dw_eth_init
;
500 dev
->send
= dw_eth_send
;
501 dev
->recv
= dw_eth_recv
;
502 dev
->halt
= dw_eth_halt
;
503 dev
->write_hwaddr
= dw_write_hwaddr
;
507 priv
->interface
= interface
;
509 dw_mdio_init(dev
->name
, priv
->mac_regs_p
);
510 priv
->bus
= miiphy_get_dev_by_name(dev
->name
);
512 return dw_phy_init(priv
, dev
);
517 static int designware_eth_start(struct udevice
*dev
)
519 struct eth_pdata
*pdata
= dev_get_platdata(dev
);
521 return _dw_eth_init(dev
->priv
, pdata
->enetaddr
);
524 static int designware_eth_send(struct udevice
*dev
, void *packet
, int length
)
526 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
528 return _dw_eth_send(priv
, packet
, length
);
531 static int designware_eth_recv(struct udevice
*dev
, int flags
, uchar
**packetp
)
533 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
535 return _dw_eth_recv(priv
, packetp
);
538 static int designware_eth_free_pkt(struct udevice
*dev
, uchar
*packet
,
541 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
543 return _dw_free_pkt(priv
);
546 static void designware_eth_stop(struct udevice
*dev
)
548 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
550 return _dw_eth_halt(priv
);
553 static int designware_eth_write_hwaddr(struct udevice
*dev
)
555 struct eth_pdata
*pdata
= dev_get_platdata(dev
);
556 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
558 return _dw_write_hwaddr(priv
, pdata
->enetaddr
);
561 static int designware_eth_probe(struct udevice
*dev
)
563 struct eth_pdata
*pdata
= dev_get_platdata(dev
);
564 struct dw_eth_dev
*priv
= dev_get_priv(dev
);
567 debug("%s, iobase=%lx, priv=%p\n", __func__
, pdata
->iobase
, priv
);
568 priv
->mac_regs_p
= (struct eth_mac_regs
*)pdata
->iobase
;
569 priv
->dma_regs_p
= (struct eth_dma_regs
*)(pdata
->iobase
+
571 priv
->interface
= pdata
->phy_interface
;
573 dw_mdio_init(dev
->name
, priv
->mac_regs_p
);
574 priv
->bus
= miiphy_get_dev_by_name(dev
->name
);
576 ret
= dw_phy_init(priv
, dev
);
577 debug("%s, ret=%d\n", __func__
, ret
);
582 static const struct eth_ops designware_eth_ops
= {
583 .start
= designware_eth_start
,
584 .send
= designware_eth_send
,
585 .recv
= designware_eth_recv
,
586 .free_pkt
= designware_eth_free_pkt
,
587 .stop
= designware_eth_stop
,
588 .write_hwaddr
= designware_eth_write_hwaddr
,
591 static int designware_eth_ofdata_to_platdata(struct udevice
*dev
)
593 struct eth_pdata
*pdata
= dev_get_platdata(dev
);
594 const char *phy_mode
;
596 pdata
->iobase
= dev_get_addr(dev
);
597 pdata
->phy_interface
= -1;
598 phy_mode
= fdt_getprop(gd
->fdt_blob
, dev
->of_offset
, "phy-mode", NULL
);
600 pdata
->phy_interface
= phy_get_interface_by_name(phy_mode
);
601 if (pdata
->phy_interface
== -1) {
602 debug("%s: Invalid PHY interface '%s'\n", __func__
, phy_mode
);
609 static const struct udevice_id designware_eth_ids
[] = {
610 { .compatible
= "allwinner,sun7i-a20-gmac" },
611 { .compatible
= "altr,socfpga-stmmac" },
615 U_BOOT_DRIVER(eth_designware
) = {
616 .name
= "eth_designware",
618 .of_match
= designware_eth_ids
,
619 .ofdata_to_platdata
= designware_eth_ofdata_to_platdata
,
620 .probe
= designware_eth_probe
,
621 .ops
= &designware_eth_ops
,
622 .priv_auto_alloc_size
= sizeof(struct dw_eth_dev
),
623 .platdata_auto_alloc_size
= sizeof(struct eth_pdata
),
624 .flags
= DM_FLAG_ALLOC_PRIV_DMA
,