drivers/net/ethernet/cadence/at91_ether.c

   1 /*
   2  * Ethernet driver for the Atmel AT91RM9200 (Thunder)
   3  *
   4  *  Copyright (C) 2003 SAN People (Pty) Ltd
   5  *
   6  * Based on an earlier Atmel EMAC macrocell driver by Atmel and Lineo Inc.
   7  * Initial version by Rick Bronson 01/11/2003
   8  *
   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.
  13  */
  14
  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>
  28 #include <linux/io.h>
  29 #include <linux/of.h>
  30 #include <linux/of_device.h>
  31 #include <linux/of_net.h>
  32 #include <linux/pinctrl/consumer.h>
  33
  34 #include "macb.h"
  35
  36 /* 1518 rounded up */
  37 #define MAX_RBUFF_SZ    0x600
  38 /* max number of receive buffers */
  39 #define MAX_RX_DESCR    9
  40
  41 /* Initialize and start the Receiver and Transmit subsystems */
  42 static int at91ether_start(struct net_device *dev)
  43 {
  44         struct macb *lp = netdev_priv(dev);
  45         dma_addr_t addr;
  46         u32 ctl;
  47         int i;
  48
  49         lp->rx_ring = dma_alloc_coherent(&lp->pdev->dev,
  50                                          (MAX_RX_DESCR *
  51                                           sizeof(struct macb_dma_desc)),
  52                                          &lp->rx_ring_dma, GFP_KERNEL);
  53         if (!lp->rx_ring)
  54                 return -ENOMEM;
  55
  56         lp->rx_buffers = dma_alloc_coherent(&lp->pdev->dev,
  57                                             MAX_RX_DESCR * MAX_RBUFF_SZ,
  58                                             &lp->rx_buffers_dma, GFP_KERNEL);
  59         if (!lp->rx_buffers) {
  60                 dma_free_coherent(&lp->pdev->dev,
  61                                   MAX_RX_DESCR * sizeof(struct macb_dma_desc),
  62                                   lp->rx_ring, lp->rx_ring_dma);
  63                 lp->rx_ring = NULL;
  64                 return -ENOMEM;
  65         }
  66
  67         addr = lp->rx_buffers_dma;
  68         for (i = 0; i < MAX_RX_DESCR; i++) {
  69                 lp->rx_ring[i].addr = addr;
  70                 lp->rx_ring[i].ctrl = 0;
  71                 addr += MAX_RBUFF_SZ;
  72         }
  73
  74         /* Set the Wrap bit on the last descriptor */
  75         lp->rx_ring[MAX_RX_DESCR - 1].addr |= MACB_BIT(RX_WRAP);
  76
  77         /* Reset buffer index */
  78         lp->rx_tail = 0;
  79
  80         /* Program address of descriptor list in Rx Buffer Queue register */
  81         macb_writel(lp, RBQP, lp->rx_ring_dma);
  82
  83         /* Enable Receive and Transmit */
  84         ctl = macb_readl(lp, NCR);
  85         macb_writel(lp, NCR, ctl | MACB_BIT(RE) | MACB_BIT(TE));
  86
  87         return 0;
  88 }
  89
  90 /* Open the ethernet interface */
  91 static int at91ether_open(struct net_device *dev)
  92 {
  93         struct macb *lp = netdev_priv(dev);
  94         u32 ctl;
  95         int ret;
  96
  97         /* Clear internal statistics */
  98         ctl = macb_readl(lp, NCR);
  99         macb_writel(lp, NCR, ctl | MACB_BIT(CLRSTAT));
 100
 101         macb_set_hwaddr(lp);
 102
 103         ret = at91ether_start(dev);
 104         if (ret)
 105                 return ret;
 106
 107         /* Enable MAC interrupts */
 108         macb_writel(lp, IER, MACB_BIT(RCOMP)    |
 109                              MACB_BIT(RXUBR)    |
 110                              MACB_BIT(ISR_TUND) |
 111                              MACB_BIT(ISR_RLE)  |
 112                              MACB_BIT(TCOMP)    |
 113                              MACB_BIT(ISR_ROVR) |
 114                              MACB_BIT(HRESP));
 115
 116         /* schedule a link state check */
 117         phy_start(lp->phy_dev);
 118
 119         netif_start_queue(dev);
 120
 121         return 0;
 122 }
 123
 124 /* Close the interface */
 125 static int at91ether_close(struct net_device *dev)
 126 {
 127         struct macb *lp = netdev_priv(dev);
 128         u32 ctl;
 129
 130         /* Disable Receiver and Transmitter */
 131         ctl = macb_readl(lp, NCR);
 132         macb_writel(lp, NCR, ctl & ~(MACB_BIT(TE) | MACB_BIT(RE)));
 133
 134         /* Disable MAC interrupts */
 135         macb_writel(lp, IDR, MACB_BIT(RCOMP)    |
 136                              MACB_BIT(RXUBR)    |
 137                              MACB_BIT(ISR_TUND) |
 138                              MACB_BIT(ISR_RLE)  |
 139                              MACB_BIT(TCOMP)    |
 140                              MACB_BIT(ISR_ROVR) |
 141                              MACB_BIT(HRESP));
 142
 143         netif_stop_queue(dev);
 144
 145         dma_free_coherent(&lp->pdev->dev,
 146                                 MAX_RX_DESCR * sizeof(struct macb_dma_desc),
 147                                 lp->rx_ring, lp->rx_ring_dma);
 148         lp->rx_ring = NULL;
 149
 150         dma_free_coherent(&lp->pdev->dev,
 151                                 MAX_RX_DESCR * MAX_RBUFF_SZ,
 152                                 lp->rx_buffers, lp->rx_buffers_dma);
 153         lp->rx_buffers = NULL;
 154
 155         return 0;
 156 }
 157
 158 /* Transmit packet */
 159 static int at91ether_start_xmit(struct sk_buff *skb, struct net_device *dev)
 160 {
 161         struct macb *lp = netdev_priv(dev);
 162
 163         if (macb_readl(lp, TSR) & MACB_BIT(RM9200_BNQ)) {
 164                 netif_stop_queue(dev);
 165
 166                 /* Store packet information (to free when Tx completed) */
 167                 lp->skb = skb;
 168                 lp->skb_length = skb->len;
 169                 lp->skb_physaddr = dma_map_single(NULL, skb->data, skb->len,
 170                                                         DMA_TO_DEVICE);
 171
 172                 /* Set address of the data in the Transmit Address register */
 173                 macb_writel(lp, TAR, lp->skb_physaddr);
 174                 /* Set length of the packet in the Transmit Control register */
 175                 macb_writel(lp, TCR, skb->len);
 176
 177         } else {
 178                 netdev_err(dev, "%s called, but device is busy!\n", __func__);
 179                 return NETDEV_TX_BUSY;
 180         }
 181
 182         return NETDEV_TX_OK;
 183 }
 184
 185 /* Extract received frame from buffer descriptors and sent to upper layers.
 186  * (Called from interrupt context)
 187  */
 188 static void at91ether_rx(struct net_device *dev)
 189 {
 190         struct macb *lp = netdev_priv(dev);
 191         unsigned char *p_recv;
 192         struct sk_buff *skb;
 193         unsigned int pktlen;
 194
 195         while (lp->rx_ring[lp->rx_tail].addr & MACB_BIT(RX_USED)) {
 196                 p_recv = lp->rx_buffers + lp->rx_tail * MAX_RBUFF_SZ;
 197                 pktlen = MACB_BF(RX_FRMLEN, lp->rx_ring[lp->rx_tail].ctrl);
 198                 skb = netdev_alloc_skb(dev, pktlen + 2);
 199                 if (skb) {
 200                         skb_reserve(skb, 2);
 201                         memcpy(skb_put(skb, pktlen), p_recv, pktlen);
 202
 203                         skb->protocol = eth_type_trans(skb, dev);
 204                         lp->stats.rx_packets++;
 205                         lp->stats.rx_bytes += pktlen;
 206                         netif_rx(skb);
 207                 } else {
 208                         lp->stats.rx_dropped++;
 209                 }
 210
 211                 if (lp->rx_ring[lp->rx_tail].ctrl & MACB_BIT(RX_MHASH_MATCH))
 212                         lp->stats.multicast++;
 213
 214                 /* reset ownership bit */
 215                 lp->rx_ring[lp->rx_tail].addr &= ~MACB_BIT(RX_USED);
 216
 217                 /* wrap after last buffer */
 218                 if (lp->rx_tail == MAX_RX_DESCR - 1)
 219                         lp->rx_tail = 0;
 220                 else
 221                         lp->rx_tail++;
 222         }
 223 }
 224
 225 /* MAC interrupt handler */
 226 static irqreturn_t at91ether_interrupt(int irq, void *dev_id)
 227 {
 228         struct net_device *dev = dev_id;
 229         struct macb *lp = netdev_priv(dev);
 230         u32 intstatus, ctl;
 231
 232         /* MAC Interrupt Status register indicates what interrupts are pending.
 233          * It is automatically cleared once read.
 234          */
 235         intstatus = macb_readl(lp, ISR);
 236
 237         /* Receive complete */
 238         if (intstatus & MACB_BIT(RCOMP))
 239                 at91ether_rx(dev);
 240
 241         /* Transmit complete */
 242         if (intstatus & MACB_BIT(TCOMP)) {
 243                 /* The TCOM bit is set even if the transmission failed */
 244                 if (intstatus & (MACB_BIT(ISR_TUND) | MACB_BIT(ISR_RLE)))
 245                         lp->stats.tx_errors++;
 246
 247                 if (lp->skb) {
 248                         dev_kfree_skb_irq(lp->skb);
 249                         lp->skb = NULL;
 250                         dma_unmap_single(NULL, lp->skb_physaddr, lp->skb_length, DMA_TO_DEVICE);
 251                         lp->stats.tx_packets++;
 252                         lp->stats.tx_bytes += lp->skb_length;
 253                 }
 254                 netif_wake_queue(dev);
 255         }
 256
 257         /* Work-around for EMAC Errata section 41.3.1 */
 258         if (intstatus & MACB_BIT(RXUBR)) {
 259                 ctl = macb_readl(lp, NCR);
 260                 macb_writel(lp, NCR, ctl & ~MACB_BIT(RE));
 261                 macb_writel(lp, NCR, ctl | MACB_BIT(RE));
 262         }
 263
 264         if (intstatus & MACB_BIT(ISR_ROVR))
 265                 netdev_err(dev, "ROVR error\n");
 266
 267         return IRQ_HANDLED;
 268 }
 269
 270 #ifdef CONFIG_NET_POLL_CONTROLLER
 271 static void at91ether_poll_controller(struct net_device *dev)
 272 {
 273         unsigned long flags;
 274
 275         local_irq_save(flags);
 276         at91ether_interrupt(dev->irq, dev);
 277         local_irq_restore(flags);
 278 }
 279 #endif
 280
 281 static const struct net_device_ops at91ether_netdev_ops = {
 282         .ndo_open               = at91ether_open,
 283         .ndo_stop               = at91ether_close,
 284         .ndo_start_xmit         = at91ether_start_xmit,
 285         .ndo_get_stats          = macb_get_stats,
 286         .ndo_set_rx_mode        = macb_set_rx_mode,
 287         .ndo_set_mac_address    = eth_mac_addr,
 288         .ndo_do_ioctl           = macb_ioctl,
 289         .ndo_validate_addr      = eth_validate_addr,
 290         .ndo_change_mtu         = eth_change_mtu,
 291 #ifdef CONFIG_NET_POLL_CONTROLLER
 292         .ndo_poll_controller    = at91ether_poll_controller,
 293 #endif
 294 };
 295
 296 #if defined(CONFIG_OF)
 297 static const struct of_device_id at91ether_dt_ids[] = {
 298         { .compatible = "cdns,at91rm9200-emac" },
 299         { .compatible = "cdns,emac" },
 300         { /* sentinel */ }
 301 };
 302
 303 MODULE_DEVICE_TABLE(of, at91ether_dt_ids);
 304
 305 static int at91ether_get_phy_mode_dt(struct platform_device *pdev)
 306 {
 307         struct device_node *np = pdev->dev.of_node;
 308
 309         if (np)
 310                 return of_get_phy_mode(np);
 311
 312         return -ENODEV;
 313 }
 314
 315 static int at91ether_get_hwaddr_dt(struct macb *bp)
 316 {
 317         struct device_node *np = bp->pdev->dev.of_node;
 318
 319         if (np) {
 320                 const char *mac = of_get_mac_address(np);
 321                 if (mac) {
 322                         memcpy(bp->dev->dev_addr, mac, ETH_ALEN);
 323                         return 0;
 324                 }
 325         }
 326
 327         return -ENODEV;
 328 }
 329 #else
 330 static int at91ether_get_phy_mode_dt(struct platform_device *pdev)
 331 {
 332         return -ENODEV;
 333 }
 334 static int at91ether_get_hwaddr_dt(struct macb *bp)
 335 {
 336         return -ENODEV;
 337 }
 338 #endif
 339
 340 /* Detect MAC & PHY and perform ethernet interface initialization */
 341 static int __init at91ether_probe(struct platform_device *pdev)
 342 {
 343         struct macb_platform_data *board_data = pdev->dev.platform_data;
 344         struct resource *regs;
 345         struct net_device *dev;
 346         struct phy_device *phydev;
 347         struct pinctrl *pinctrl;
 348         struct macb *lp;
 349         int res;
 350         u32 reg;
 351
 352         regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 353         if (!regs)
 354                 return -ENOENT;
 355
 356         pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
 357         if (IS_ERR(pinctrl)) {
 358                 res = PTR_ERR(pinctrl);
 359                 if (res == -EPROBE_DEFER)
 360                         return res;
 361
 362                 dev_warn(&pdev->dev, "No pinctrl provided\n");
 363         }
 364
 365         dev = alloc_etherdev(sizeof(struct macb));
 366         if (!dev)
 367                 return -ENOMEM;
 368
 369         lp = netdev_priv(dev);
 370         lp->pdev = pdev;
 371         lp->dev = dev;
 372         spin_lock_init(&lp->lock);
 373
 374         /* physical base address */
 375         dev->base_addr = regs->start;
 376         lp->regs = devm_ioremap(&pdev->dev, regs->start, resource_size(regs));
 377         if (!lp->regs) {
 378                 res = -ENOMEM;
 379                 goto err_free_dev;
 380         }
 381
 382         /* Clock */
 383         lp->pclk = devm_clk_get(&pdev->dev, "ether_clk");
 384         if (IS_ERR(lp->pclk)) {
 385                 res = PTR_ERR(lp->pclk);
 386                 goto err_free_dev;
 387         }
 388         clk_enable(lp->pclk);
 389
 390         /* Install the interrupt handler */
 391         dev->irq = platform_get_irq(pdev, 0);
 392         res = devm_request_irq(&pdev->dev, dev->irq, at91ether_interrupt, 0, dev->name, dev);
 393         if (res)
 394                 goto err_disable_clock;
 395
 396         ether_setup(dev);
 397         dev->netdev_ops = &at91ether_netdev_ops;
 398         dev->ethtool_ops = &macb_ethtool_ops;
 399         platform_set_drvdata(pdev, dev);
 400         SET_NETDEV_DEV(dev, &pdev->dev);
 401
 402         res = at91ether_get_hwaddr_dt(lp);
 403         if (res < 0)
 404                 macb_get_hwaddr(lp);
 405
 406         res = at91ether_get_phy_mode_dt(pdev);
 407         if (res < 0) {
 408                 if (board_data && board_data->is_rmii)
 409                         lp->phy_interface = PHY_INTERFACE_MODE_RMII;
 410                 else
 411                         lp->phy_interface = PHY_INTERFACE_MODE_MII;
 412         } else {
 413                 lp->phy_interface = res;
 414         }
 415
 416         macb_writel(lp, NCR, 0);
 417
 418         reg = MACB_BF(CLK, MACB_CLK_DIV32) | MACB_BIT(BIG);
 419         if (lp->phy_interface == PHY_INTERFACE_MODE_RMII)
 420                 reg |= MACB_BIT(RM9200_RMII);
 421
 422         macb_writel(lp, NCFGR, reg);
 423
 424         /* Register the network interface */
 425         res = register_netdev(dev);
 426         if (res)
 427                 goto err_disable_clock;
 428
 429         if (macb_mii_init(lp) != 0)
 430                 goto err_out_unregister_netdev;
 431
 432         /* will be enabled in open() */
 433         netif_carrier_off(dev);
 434
 435         phydev = lp->phy_dev;
 436         netdev_info(dev, "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)\n",
 437                                 phydev->drv->name, dev_name(&phydev->dev),
 438                                 phydev->irq);
 439
 440         /* Display ethernet banner */
 441         netdev_info(dev, "AT91 ethernet at 0x%08lx int=%d (%pM)\n",
 442                                 dev->base_addr, dev->irq, dev->dev_addr);
 443
 444         return 0;
 445
 446 err_out_unregister_netdev:
 447         unregister_netdev(dev);
 448 err_disable_clock:
 449         clk_disable(lp->pclk);
 450 err_free_dev:
 451         free_netdev(dev);
 452         return res;
 453 }
 454
 455 static int at91ether_remove(struct platform_device *pdev)
 456 {
 457         struct net_device *dev = platform_get_drvdata(pdev);
 458         struct macb *lp = netdev_priv(dev);
 459
 460         if (lp->phy_dev)
 461                 phy_disconnect(lp->phy_dev);
 462
 463         mdiobus_unregister(lp->mii_bus);
 464         kfree(lp->mii_bus->irq);
 465         mdiobus_free(lp->mii_bus);
 466         unregister_netdev(dev);
 467         clk_disable(lp->pclk);
 468         free_netdev(dev);
 469         platform_set_drvdata(pdev, NULL);
 470
 471         return 0;
 472 }
 473
 474 #ifdef CONFIG_PM
 475 static int at91ether_suspend(struct platform_device *pdev, pm_message_t mesg)
 476 {
 477         struct net_device *net_dev = platform_get_drvdata(pdev);
 478         struct macb *lp = netdev_priv(net_dev);
 479
 480         if (netif_running(net_dev)) {
 481                 netif_stop_queue(net_dev);
 482                 netif_device_detach(net_dev);
 483
 484                 clk_disable(lp->pclk);
 485         }
 486         return 0;
 487 }
 488
 489 static int at91ether_resume(struct platform_device *pdev)
 490 {
 491         struct net_device *net_dev = platform_get_drvdata(pdev);
 492         struct macb *lp = netdev_priv(net_dev);
 493
 494         if (netif_running(net_dev)) {
 495                 clk_enable(lp->pclk);
 496
 497                 netif_device_attach(net_dev);
 498                 netif_start_queue(net_dev);
 499         }
 500         return 0;
 501 }
 502 #else
 503 #define at91ether_suspend       NULL
 504 #define at91ether_resume        NULL
 505 #endif
 506
 507 static struct platform_driver at91ether_driver = {
 508         .remove         = at91ether_remove,
 509         .suspend        = at91ether_suspend,
 510         .resume         = at91ether_resume,
 511         .driver         = {
 512                 .name   = "at91_ether",
 513                 .owner  = THIS_MODULE,
 514                 .of_match_table = of_match_ptr(at91ether_dt_ids),
 515         },
 516 };
 517
 518 module_platform_driver_probe(at91ether_driver, at91ether_probe);
 519
 520 MODULE_LICENSE("GPL");
 521 MODULE_DESCRIPTION("AT91RM9200 EMAC Ethernet driver");
 522 MODULE_AUTHOR("Andrew Victor");
 523 MODULE_ALIAS("platform:at91_ether");