2 * Ethernet driver for the Atmel AT91RM9200 (Thunder)
4 * Copyright (C) 2003 SAN People (Pty) Ltd
6 * Based on an earlier Atmel EMAC macrocell driver by Atmel and Lineo Inc.
7 * Initial version by Rick Bronson 01/11/2003
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/skbuff.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/ethtool.h>
23 #include <linux/platform_data/macb.h>
24 #include <linux/platform_device.h>
25 #include <linux/clk.h>
26 #include <linux/gfp.h>
27 #include <linux/phy.h>
30 #include <linux/of_device.h>
31 #include <linux/of_net.h>
32 #include <linux/pinctrl/consumer.h>
37 #define MAX_RBUFF_SZ 0x600
38 /* max number of receive buffers */
39 #define MAX_RX_DESCR 9
41 /* Initialize and start the Receiver and Transmit subsystems */
42 static int at91ether_start(struct net_device *dev)
44 struct macb *lp = netdev_priv(dev);
49 lp->rx_ring = dma_alloc_coherent(&lp->pdev->dev,
50 MAX_RX_DESCR * sizeof(struct macb_dma_desc),
51 &lp->rx_ring_dma, GFP_KERNEL);
53 netdev_err(dev, "unable to alloc rx ring DMA buffer\n");
57 lp->rx_buffers = dma_alloc_coherent(&lp->pdev->dev,
58 MAX_RX_DESCR * MAX_RBUFF_SZ,
59 &lp->rx_buffers_dma, GFP_KERNEL);
60 if (!lp->rx_buffers) {
61 netdev_err(dev, "unable to alloc rx data DMA buffer\n");
63 dma_free_coherent(&lp->pdev->dev,
64 MAX_RX_DESCR * sizeof(struct macb_dma_desc),
65 lp->rx_ring, lp->rx_ring_dma);
70 addr = lp->rx_buffers_dma;
71 for (i = 0; i < MAX_RX_DESCR; i++) {
72 lp->rx_ring[i].addr = addr;
73 lp->rx_ring[i].ctrl = 0;
77 /* Set the Wrap bit on the last descriptor */
78 lp->rx_ring[MAX_RX_DESCR - 1].addr |= MACB_BIT(RX_WRAP);
80 /* Reset buffer index */
83 /* Program address of descriptor list in Rx Buffer Queue register */
84 macb_writel(lp, RBQP, lp->rx_ring_dma);
86 /* Enable Receive and Transmit */
87 ctl = macb_readl(lp, NCR);
88 macb_writel(lp, NCR, ctl | MACB_BIT(RE) | MACB_BIT(TE));
93 /* Open the ethernet interface */
94 static int at91ether_open(struct net_device *dev)
96 struct macb *lp = netdev_priv(dev);
100 /* Clear internal statistics */
101 ctl = macb_readl(lp, NCR);
102 macb_writel(lp, NCR, ctl | MACB_BIT(CLRSTAT));
106 ret = at91ether_start(dev);
110 /* Enable MAC interrupts */
111 macb_writel(lp, IER, MACB_BIT(RCOMP) |
119 /* schedule a link state check */
120 phy_start(lp->phy_dev);
122 netif_start_queue(dev);
127 /* Close the interface */
128 static int at91ether_close(struct net_device *dev)
130 struct macb *lp = netdev_priv(dev);
133 /* Disable Receiver and Transmitter */
134 ctl = macb_readl(lp, NCR);
135 macb_writel(lp, NCR, ctl & ~(MACB_BIT(TE) | MACB_BIT(RE)));
137 /* Disable MAC interrupts */
138 macb_writel(lp, IDR, MACB_BIT(RCOMP) |
146 netif_stop_queue(dev);
148 dma_free_coherent(&lp->pdev->dev,
149 MAX_RX_DESCR * sizeof(struct macb_dma_desc),
150 lp->rx_ring, lp->rx_ring_dma);
153 dma_free_coherent(&lp->pdev->dev,
154 MAX_RX_DESCR * MAX_RBUFF_SZ,
155 lp->rx_buffers, lp->rx_buffers_dma);
156 lp->rx_buffers = NULL;
161 /* Transmit packet */
162 static int at91ether_start_xmit(struct sk_buff *skb, struct net_device *dev)
164 struct macb *lp = netdev_priv(dev);
166 if (macb_readl(lp, TSR) & MACB_BIT(RM9200_BNQ)) {
167 netif_stop_queue(dev);
169 /* Store packet information (to free when Tx completed) */
171 lp->skb_length = skb->len;
172 lp->skb_physaddr = dma_map_single(NULL, skb->data, skb->len,
175 /* Set address of the data in the Transmit Address register */
176 macb_writel(lp, TAR, lp->skb_physaddr);
177 /* Set length of the packet in the Transmit Control register */
178 macb_writel(lp, TCR, skb->len);
181 netdev_err(dev, "%s called, but device is busy!\n", __func__);
182 return NETDEV_TX_BUSY;
188 /* Extract received frame from buffer descriptors and sent to upper layers.
189 * (Called from interrupt context)
191 static void at91ether_rx(struct net_device *dev)
193 struct macb *lp = netdev_priv(dev);
194 unsigned char *p_recv;
198 while (lp->rx_ring[lp->rx_tail].addr & MACB_BIT(RX_USED)) {
199 p_recv = lp->rx_buffers + lp->rx_tail * MAX_RBUFF_SZ;
200 pktlen = MACB_BF(RX_FRMLEN, lp->rx_ring[lp->rx_tail].ctrl);
201 skb = netdev_alloc_skb(dev, pktlen + 2);
204 memcpy(skb_put(skb, pktlen), p_recv, pktlen);
206 skb->protocol = eth_type_trans(skb, dev);
207 lp->stats.rx_packets++;
208 lp->stats.rx_bytes += pktlen;
211 lp->stats.rx_dropped++;
212 netdev_notice(dev, "Memory squeeze, dropping packet.\n");
215 if (lp->rx_ring[lp->rx_tail].ctrl & MACB_BIT(RX_MHASH_MATCH))
216 lp->stats.multicast++;
218 /* reset ownership bit */
219 lp->rx_ring[lp->rx_tail].addr &= ~MACB_BIT(RX_USED);
221 /* wrap after last buffer */
222 if (lp->rx_tail == MAX_RX_DESCR - 1)
229 /* MAC interrupt handler */
230 static irqreturn_t at91ether_interrupt(int irq, void *dev_id)
232 struct net_device *dev = dev_id;
233 struct macb *lp = netdev_priv(dev);
236 /* MAC Interrupt Status register indicates what interrupts are pending.
237 * It is automatically cleared once read.
239 intstatus = macb_readl(lp, ISR);
241 /* Receive complete */
242 if (intstatus & MACB_BIT(RCOMP))
245 /* Transmit complete */
246 if (intstatus & MACB_BIT(TCOMP)) {
247 /* The TCOM bit is set even if the transmission failed */
248 if (intstatus & (MACB_BIT(ISR_TUND) | MACB_BIT(ISR_RLE)))
249 lp->stats.tx_errors++;
252 dev_kfree_skb_irq(lp->skb);
254 dma_unmap_single(NULL, lp->skb_physaddr, lp->skb_length, DMA_TO_DEVICE);
255 lp->stats.tx_packets++;
256 lp->stats.tx_bytes += lp->skb_length;
258 netif_wake_queue(dev);
261 /* Work-around for EMAC Errata section 41.3.1 */
262 if (intstatus & MACB_BIT(RXUBR)) {
263 ctl = macb_readl(lp, NCR);
264 macb_writel(lp, NCR, ctl & ~MACB_BIT(RE));
265 macb_writel(lp, NCR, ctl | MACB_BIT(RE));
268 if (intstatus & MACB_BIT(ISR_ROVR))
269 netdev_err(dev, "ROVR error\n");
274 #ifdef CONFIG_NET_POLL_CONTROLLER
275 static void at91ether_poll_controller(struct net_device *dev)
279 local_irq_save(flags);
280 at91ether_interrupt(dev->irq, dev);
281 local_irq_restore(flags);
285 static const struct net_device_ops at91ether_netdev_ops = {
286 .ndo_open = at91ether_open,
287 .ndo_stop = at91ether_close,
288 .ndo_start_xmit = at91ether_start_xmit,
289 .ndo_get_stats = macb_get_stats,
290 .ndo_set_rx_mode = macb_set_rx_mode,
291 .ndo_set_mac_address = eth_mac_addr,
292 .ndo_do_ioctl = macb_ioctl,
293 .ndo_validate_addr = eth_validate_addr,
294 .ndo_change_mtu = eth_change_mtu,
295 #ifdef CONFIG_NET_POLL_CONTROLLER
296 .ndo_poll_controller = at91ether_poll_controller,
300 #if defined(CONFIG_OF)
301 static const struct of_device_id at91ether_dt_ids[] = {
302 { .compatible = "cdns,at91rm9200-emac" },
303 { .compatible = "cdns,emac" },
307 MODULE_DEVICE_TABLE(of, at91ether_dt_ids);
309 static int at91ether_get_phy_mode_dt(struct platform_device *pdev)
311 struct device_node *np = pdev->dev.of_node;
314 return of_get_phy_mode(np);
319 static int at91ether_get_hwaddr_dt(struct macb *bp)
321 struct device_node *np = bp->pdev->dev.of_node;
324 const char *mac = of_get_mac_address(np);
326 memcpy(bp->dev->dev_addr, mac, ETH_ALEN);
334 static int at91ether_get_phy_mode_dt(struct platform_device *pdev)
338 static int at91ether_get_hwaddr_dt(struct macb *bp)
344 /* Detect MAC & PHY and perform ethernet interface initialization */
345 static int __init at91ether_probe(struct platform_device *pdev)
347 struct macb_platform_data *board_data = pdev->dev.platform_data;
348 struct resource *regs;
349 struct net_device *dev;
350 struct phy_device *phydev;
351 struct pinctrl *pinctrl;
356 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
360 pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
361 if (IS_ERR(pinctrl)) {
362 res = PTR_ERR(pinctrl);
363 if (res == -EPROBE_DEFER)
366 dev_warn(&pdev->dev, "No pinctrl provided\n");
369 dev = alloc_etherdev(sizeof(struct macb));
373 lp = netdev_priv(dev);
376 spin_lock_init(&lp->lock);
378 /* physical base address */
379 dev->base_addr = regs->start;
380 lp->regs = devm_ioremap(&pdev->dev, regs->start, resource_size(regs));
387 lp->pclk = devm_clk_get(&pdev->dev, "ether_clk");
388 if (IS_ERR(lp->pclk)) {
389 res = PTR_ERR(lp->pclk);
392 clk_enable(lp->pclk);
394 /* Install the interrupt handler */
395 dev->irq = platform_get_irq(pdev, 0);
396 res = devm_request_irq(&pdev->dev, dev->irq, at91ether_interrupt, 0, dev->name, dev);
398 goto err_disable_clock;
401 dev->netdev_ops = &at91ether_netdev_ops;
402 dev->ethtool_ops = &macb_ethtool_ops;
403 platform_set_drvdata(pdev, dev);
404 SET_NETDEV_DEV(dev, &pdev->dev);
406 res = at91ether_get_hwaddr_dt(lp);
410 res = at91ether_get_phy_mode_dt(pdev);
412 if (board_data && board_data->is_rmii)
413 lp->phy_interface = PHY_INTERFACE_MODE_RMII;
415 lp->phy_interface = PHY_INTERFACE_MODE_MII;
417 lp->phy_interface = res;
420 macb_writel(lp, NCR, 0);
422 reg = MACB_BF(CLK, MACB_CLK_DIV32) | MACB_BIT(BIG);
423 if (lp->phy_interface == PHY_INTERFACE_MODE_RMII)
424 reg |= MACB_BIT(RM9200_RMII);
426 macb_writel(lp, NCFGR, reg);
428 /* Register the network interface */
429 res = register_netdev(dev);
431 goto err_disable_clock;
433 if (macb_mii_init(lp) != 0)
434 goto err_out_unregister_netdev;
436 /* will be enabled in open() */
437 netif_carrier_off(dev);
439 phydev = lp->phy_dev;
440 netdev_info(dev, "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)\n",
441 phydev->drv->name, dev_name(&phydev->dev),
444 /* Display ethernet banner */
445 netdev_info(dev, "AT91 ethernet at 0x%08lx int=%d (%pM)\n",
446 dev->base_addr, dev->irq, dev->dev_addr);
450 err_out_unregister_netdev:
451 unregister_netdev(dev);
453 clk_disable(lp->pclk);
459 static int at91ether_remove(struct platform_device *pdev)
461 struct net_device *dev = platform_get_drvdata(pdev);
462 struct macb *lp = netdev_priv(dev);
465 phy_disconnect(lp->phy_dev);
467 mdiobus_unregister(lp->mii_bus);
468 kfree(lp->mii_bus->irq);
469 mdiobus_free(lp->mii_bus);
470 unregister_netdev(dev);
471 clk_disable(lp->pclk);
473 platform_set_drvdata(pdev, NULL);
479 static int at91ether_suspend(struct platform_device *pdev, pm_message_t mesg)
481 struct net_device *net_dev = platform_get_drvdata(pdev);
482 struct macb *lp = netdev_priv(net_dev);
484 if (netif_running(net_dev)) {
485 netif_stop_queue(net_dev);
486 netif_device_detach(net_dev);
488 clk_disable(lp->pclk);
493 static int at91ether_resume(struct platform_device *pdev)
495 struct net_device *net_dev = platform_get_drvdata(pdev);
496 struct macb *lp = netdev_priv(net_dev);
498 if (netif_running(net_dev)) {
499 clk_enable(lp->pclk);
501 netif_device_attach(net_dev);
502 netif_start_queue(net_dev);
507 #define at91ether_suspend NULL
508 #define at91ether_resume NULL
511 static struct platform_driver at91ether_driver = {
512 .remove = at91ether_remove,
513 .suspend = at91ether_suspend,
514 .resume = at91ether_resume,
516 .name = "at91_ether",
517 .owner = THIS_MODULE,
518 .of_match_table = of_match_ptr(at91ether_dt_ids),
522 module_platform_driver_probe(at91ether_driver, at91ether_probe);
524 MODULE_LICENSE("GPL");
525 MODULE_DESCRIPTION("AT91RM9200 EMAC Ethernet driver");
526 MODULE_AUTHOR("Andrew Victor");
527 MODULE_ALIAS("platform:at91_ether");