drivers/net/ethernet/moxa/moxart_ether.c

   1 /* MOXA ART Ethernet (RTL8201CP) driver.
   2  *
   3  * Copyright (C) 2013 Jonas Jensen
   4  *
   5  * Jonas Jensen <jonas.jensen@gmail.com>
   6  *
   7  * Based on code from
   8  * Moxa Technology Co., Ltd. <www.moxa.com>
   9  *
  10  * This file is licensed under the terms of the GNU General Public
  11  * License version 2.  This program is licensed "as is" without any
  12  * warranty of any kind, whether express or implied.
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/netdevice.h>
  17 #include <linux/etherdevice.h>
  18 #include <linux/skbuff.h>
  19 #include <linux/dma-mapping.h>
  20 #include <linux/ethtool.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/irq.h>
  24 #include <linux/of_address.h>
  25 #include <linux/of_irq.h>
  26 #include <linux/crc32.h>
  27 #include <linux/crc32c.h>
  28
  29 #include "moxart_ether.h"
  30
  31 static inline void moxart_emac_write(struct net_device *ndev,
  32                                      unsigned int reg, unsigned long value)
  33 {
  34         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
  35
  36         writel(value, priv->base + reg);
  37 }
  38
  39 static void moxart_update_mac_address(struct net_device *ndev)
  40 {
  41         moxart_emac_write(ndev, REG_MAC_MS_ADDRESS,
  42                           ((ndev->dev_addr[0] << 8) | (ndev->dev_addr[1])));
  43         moxart_emac_write(ndev, REG_MAC_MS_ADDRESS + 4,
  44                           ((ndev->dev_addr[2] << 24) |
  45                            (ndev->dev_addr[3] << 16) |
  46                            (ndev->dev_addr[4] << 8) |
  47                            (ndev->dev_addr[5])));
  48 }
  49
  50 static int moxart_set_mac_address(struct net_device *ndev, void *addr)
  51 {
  52         struct sockaddr *address = addr;
  53
  54         if (!is_valid_ether_addr(address->sa_data))
  55                 return -EADDRNOTAVAIL;
  56
  57         memcpy(ndev->dev_addr, address->sa_data, ndev->addr_len);
  58         moxart_update_mac_address(ndev);
  59
  60         return 0;
  61 }
  62
  63 static void moxart_mac_free_memory(struct net_device *ndev)
  64 {
  65         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
  66         int i;
  67
  68         for (i = 0; i < RX_DESC_NUM; i++)
  69                 dma_unmap_single(&ndev->dev, priv->rx_mapping[i],
  70                                  priv->rx_buf_size, DMA_FROM_DEVICE);
  71
  72         if (priv->tx_desc_base)
  73                 dma_free_coherent(NULL, TX_REG_DESC_SIZE * TX_DESC_NUM,
  74                                   priv->tx_desc_base, priv->tx_base);
  75
  76         if (priv->rx_desc_base)
  77                 dma_free_coherent(NULL, RX_REG_DESC_SIZE * RX_DESC_NUM,
  78                                   priv->rx_desc_base, priv->rx_base);
  79
  80         kfree(priv->tx_buf_base);
  81         kfree(priv->rx_buf_base);
  82 }
  83
  84 static void moxart_mac_reset(struct net_device *ndev)
  85 {
  86         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
  87
  88         writel(SW_RST, priv->base + REG_MAC_CTRL);
  89         while (readl(priv->base + REG_MAC_CTRL) & SW_RST)
  90                 mdelay(10);
  91
  92         writel(0, priv->base + REG_INTERRUPT_MASK);
  93
  94         priv->reg_maccr = RX_BROADPKT | FULLDUP | CRC_APD | RX_FTL;
  95 }
  96
  97 static void moxart_mac_enable(struct net_device *ndev)
  98 {
  99         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 100
 101         writel(0x00001010, priv->base + REG_INT_TIMER_CTRL);
 102         writel(0x00000001, priv->base + REG_APOLL_TIMER_CTRL);
 103         writel(0x00000390, priv->base + REG_DMA_BLEN_CTRL);
 104
 105         priv->reg_imr |= (RPKT_FINISH_M | XPKT_FINISH_M);
 106         writel(priv->reg_imr, priv->base + REG_INTERRUPT_MASK);
 107
 108         priv->reg_maccr |= (RCV_EN | XMT_EN | RDMA_EN | XDMA_EN);
 109         writel(priv->reg_maccr, priv->base + REG_MAC_CTRL);
 110 }
 111
 112 static void moxart_mac_setup_desc_ring(struct net_device *ndev)
 113 {
 114         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 115         void __iomem *desc;
 116         int i;
 117
 118         for (i = 0; i < TX_DESC_NUM; i++) {
 119                 desc = priv->tx_desc_base + i * TX_REG_DESC_SIZE;
 120                 memset(desc, 0, TX_REG_DESC_SIZE);
 121
 122                 priv->tx_buf[i] = priv->tx_buf_base + priv->tx_buf_size * i;
 123         }
 124         writel(TX_DESC1_END, desc + TX_REG_OFFSET_DESC1);
 125
 126         priv->tx_head = 0;
 127         priv->tx_tail = 0;
 128
 129         for (i = 0; i < RX_DESC_NUM; i++) {
 130                 desc = priv->rx_desc_base + i * RX_REG_DESC_SIZE;
 131                 memset(desc, 0, RX_REG_DESC_SIZE);
 132                 writel(RX_DESC0_DMA_OWN, desc + RX_REG_OFFSET_DESC0);
 133                 writel(RX_BUF_SIZE & RX_DESC1_BUF_SIZE_MASK,
 134                        desc + RX_REG_OFFSET_DESC1);
 135
 136                 priv->rx_buf[i] = priv->rx_buf_base + priv->rx_buf_size * i;
 137                 priv->rx_mapping[i] = dma_map_single(&ndev->dev,
 138                                                      priv->rx_buf[i],
 139                                                      priv->rx_buf_size,
 140                                                      DMA_FROM_DEVICE);
 141                 if (dma_mapping_error(&ndev->dev, priv->rx_mapping[i]))
 142                         netdev_err(ndev, "DMA mapping error\n");
 143
 144                 writel(priv->rx_mapping[i],
 145                        desc + RX_REG_OFFSET_DESC2 + RX_DESC2_ADDRESS_PHYS);
 146                 writel(priv->rx_buf[i],
 147                        desc + RX_REG_OFFSET_DESC2 + RX_DESC2_ADDRESS_VIRT);
 148         }
 149         writel(RX_DESC1_END, desc + RX_REG_OFFSET_DESC1);
 150
 151         priv->rx_head = 0;
 152
 153         /* reset the MAC controler TX/RX desciptor base address */
 154         writel(priv->tx_base, priv->base + REG_TXR_BASE_ADDRESS);
 155         writel(priv->rx_base, priv->base + REG_RXR_BASE_ADDRESS);
 156 }
 157
 158 static int moxart_mac_open(struct net_device *ndev)
 159 {
 160         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 161
 162         if (!is_valid_ether_addr(ndev->dev_addr))
 163                 return -EADDRNOTAVAIL;
 164
 165         napi_enable(&priv->napi);
 166
 167         moxart_mac_reset(ndev);
 168         moxart_update_mac_address(ndev);
 169         moxart_mac_setup_desc_ring(ndev);
 170         moxart_mac_enable(ndev);
 171         netif_start_queue(ndev);
 172
 173         netdev_dbg(ndev, "%s: IMR=0x%x, MACCR=0x%x\n",
 174                    __func__, readl(priv->base + REG_INTERRUPT_MASK),
 175                    readl(priv->base + REG_MAC_CTRL));
 176
 177         return 0;
 178 }
 179
 180 static int moxart_mac_stop(struct net_device *ndev)
 181 {
 182         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 183
 184         napi_disable(&priv->napi);
 185
 186         netif_stop_queue(ndev);
 187
 188         /* disable all interrupts */
 189         writel(0, priv->base + REG_INTERRUPT_MASK);
 190
 191         /* disable all functions */
 192         writel(0, priv->base + REG_MAC_CTRL);
 193
 194         return 0;
 195 }
 196
 197 static int moxart_rx_poll(struct napi_struct *napi, int budget)
 198 {
 199         struct moxart_mac_priv_t *priv = container_of(napi,
 200                                                       struct moxart_mac_priv_t,
 201                                                       napi);
 202         struct net_device *ndev = priv->ndev;
 203         struct sk_buff *skb;
 204         void __iomem *desc;
 205         unsigned int desc0, len;
 206         int rx_head = priv->rx_head;
 207         int rx = 0;
 208
 209         while (1) {
 210                 desc = priv->rx_desc_base + (RX_REG_DESC_SIZE * rx_head);
 211                 desc0 = readl(desc + RX_REG_OFFSET_DESC0);
 212
 213                 if (desc0 & RX_DESC0_DMA_OWN)
 214                         break;
 215
 216                 if (desc0 & (RX_DESC0_ERR | RX_DESC0_CRC_ERR | RX_DESC0_FTL |
 217                              RX_DESC0_RUNT | RX_DESC0_ODD_NB)) {
 218                         net_dbg_ratelimited("packet error\n");
 219                         priv->stats.rx_dropped++;
 220                         priv->stats.rx_errors++;
 221                         continue;
 222                 }
 223
 224                 len = desc0 & RX_DESC0_FRAME_LEN_MASK;
 225
 226                 if (len > RX_BUF_SIZE)
 227                         len = RX_BUF_SIZE;
 228
 229                 skb = build_skb(priv->rx_buf[rx_head], priv->rx_buf_size);
 230                 if (unlikely(!skb)) {
 231                         net_dbg_ratelimited("build_skb failed\n");
 232                         priv->stats.rx_dropped++;
 233                         priv->stats.rx_errors++;
 234                 }
 235
 236                 skb_put(skb, len);
 237                 skb->protocol = eth_type_trans(skb, ndev);
 238                 napi_gro_receive(&priv->napi, skb);
 239                 rx++;
 240
 241                 ndev->last_rx = jiffies;
 242                 priv->stats.rx_packets++;
 243                 priv->stats.rx_bytes += len;
 244                 if (desc0 & RX_DESC0_MULTICAST)
 245                         priv->stats.multicast++;
 246
 247                 writel(RX_DESC0_DMA_OWN, desc + RX_REG_OFFSET_DESC0);
 248
 249                 rx_head = RX_NEXT(rx_head);
 250                 priv->rx_head = rx_head;
 251
 252                 if (rx >= budget)
 253                         break;
 254         }
 255
 256         if (rx < budget) {
 257                 napi_gro_flush(napi, false);
 258                 __napi_complete(napi);
 259         }
 260
 261         priv->reg_imr |= RPKT_FINISH_M;
 262         writel(priv->reg_imr, priv->base + REG_INTERRUPT_MASK);
 263
 264         return rx;
 265 }
 266
 267 static void moxart_tx_finished(struct net_device *ndev)
 268 {
 269         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 270         unsigned tx_head = priv->tx_head;
 271         unsigned tx_tail = priv->tx_tail;
 272
 273         while (tx_tail != tx_head) {
 274                 dma_unmap_single(&ndev->dev, priv->tx_mapping[tx_tail],
 275                                  priv->tx_len[tx_tail], DMA_TO_DEVICE);
 276
 277                 priv->stats.tx_packets++;
 278                 priv->stats.tx_bytes += priv->tx_skb[tx_tail]->len;
 279
 280                 dev_kfree_skb_irq(priv->tx_skb[tx_tail]);
 281                 priv->tx_skb[tx_tail] = NULL;
 282
 283                 tx_tail = TX_NEXT(tx_tail);
 284         }
 285         priv->tx_tail = tx_tail;
 286 }
 287
 288 static irqreturn_t moxart_mac_interrupt(int irq, void *dev_id)
 289 {
 290         struct net_device *ndev = (struct net_device *) dev_id;
 291         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 292         unsigned int ists = readl(priv->base + REG_INTERRUPT_STATUS);
 293
 294         if (ists & XPKT_OK_INT_STS)
 295                 moxart_tx_finished(ndev);
 296
 297         if (ists & RPKT_FINISH) {
 298                 if (napi_schedule_prep(&priv->napi)) {
 299                         priv->reg_imr &= ~RPKT_FINISH_M;
 300                         writel(priv->reg_imr, priv->base + REG_INTERRUPT_MASK);
 301                         __napi_schedule(&priv->napi);
 302                 }
 303         }
 304
 305         return IRQ_HANDLED;
 306 }
 307
 308 static int moxart_mac_start_xmit(struct sk_buff *skb, struct net_device *ndev)
 309 {
 310         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 311         void __iomem *desc;
 312         unsigned int len;
 313         unsigned int tx_head = priv->tx_head;
 314         u32 txdes1;
 315         int ret = NETDEV_TX_BUSY;
 316
 317         desc = priv->tx_desc_base + (TX_REG_DESC_SIZE * tx_head);
 318
 319         spin_lock_irq(&priv->txlock);
 320         if (readl(desc + TX_REG_OFFSET_DESC0) & TX_DESC0_DMA_OWN) {
 321                 net_dbg_ratelimited("no TX space for packet\n");
 322                 priv->stats.tx_dropped++;
 323                 goto out_unlock;
 324         }
 325
 326         len = skb->len > TX_BUF_SIZE ? TX_BUF_SIZE : skb->len;
 327
 328         priv->tx_mapping[tx_head] = dma_map_single(&ndev->dev, skb->data,
 329                                                    len, DMA_TO_DEVICE);
 330         if (dma_mapping_error(&ndev->dev, priv->tx_mapping[tx_head])) {
 331                 netdev_err(ndev, "DMA mapping error\n");
 332                 goto out_unlock;
 333         }
 334
 335         priv->tx_len[tx_head] = len;
 336         priv->tx_skb[tx_head] = skb;
 337
 338         writel(priv->tx_mapping[tx_head],
 339                desc + TX_REG_OFFSET_DESC2 + TX_DESC2_ADDRESS_PHYS);
 340         writel(skb->data,
 341                desc + TX_REG_OFFSET_DESC2 + TX_DESC2_ADDRESS_VIRT);
 342
 343         if (skb->len < ETH_ZLEN) {
 344                 memset(&skb->data[skb->len],
 345                        0, ETH_ZLEN - skb->len);
 346                 len = ETH_ZLEN;
 347         }
 348
 349         txdes1 = readl(desc + TX_REG_OFFSET_DESC1);
 350         txdes1 |= TX_DESC1_LTS | TX_DESC1_FTS;
 351         txdes1 &= ~(TX_DESC1_FIFO_COMPLETE | TX_DESC1_INTR_COMPLETE);
 352         txdes1 |= (len & TX_DESC1_BUF_SIZE_MASK);
 353         writel(txdes1, desc + TX_REG_OFFSET_DESC1);
 354         writel(TX_DESC0_DMA_OWN, desc + TX_REG_OFFSET_DESC0);
 355
 356         /* start to send packet */
 357         writel(0xffffffff, priv->base + REG_TX_POLL_DEMAND);
 358
 359         priv->tx_head = TX_NEXT(tx_head);
 360
 361         ndev->trans_start = jiffies;
 362         ret = NETDEV_TX_OK;
 363 out_unlock:
 364         spin_unlock_irq(&priv->txlock);
 365
 366         return ret;
 367 }
 368
 369 static struct net_device_stats *moxart_mac_get_stats(struct net_device *ndev)
 370 {
 371         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 372
 373         return &priv->stats;
 374 }
 375
 376 static void moxart_mac_setmulticast(struct net_device *ndev)
 377 {
 378         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 379         struct netdev_hw_addr *ha;
 380         int crc_val;
 381
 382         netdev_for_each_mc_addr(ha, ndev) {
 383                 crc_val = crc32_le(~0, ha->addr, ETH_ALEN);
 384                 crc_val = (crc_val >> 26) & 0x3f;
 385                 if (crc_val >= 32) {
 386                         writel(readl(priv->base + REG_MCAST_HASH_TABLE1) |
 387                                (1UL << (crc_val - 32)),
 388                                priv->base + REG_MCAST_HASH_TABLE1);
 389                 } else {
 390                         writel(readl(priv->base + REG_MCAST_HASH_TABLE0) |
 391                                (1UL << crc_val),
 392                                priv->base + REG_MCAST_HASH_TABLE0);
 393                 }
 394         }
 395 }
 396
 397 static void moxart_mac_set_rx_mode(struct net_device *ndev)
 398 {
 399         struct moxart_mac_priv_t *priv = netdev_priv(ndev);
 400
 401         spin_lock_irq(&priv->txlock);
 402
 403         (ndev->flags & IFF_PROMISC) ? (priv->reg_maccr |= RCV_ALL) :
 404                                       (priv->reg_maccr &= ~RCV_ALL);
 405
 406         (ndev->flags & IFF_ALLMULTI) ? (priv->reg_maccr |= RX_MULTIPKT) :
 407                                        (priv->reg_maccr &= ~RX_MULTIPKT);
 408
 409         if ((ndev->flags & IFF_MULTICAST) && netdev_mc_count(ndev)) {
 410                 priv->reg_maccr |= HT_MULTI_EN;
 411                 moxart_mac_setmulticast(ndev);
 412         } else {
 413                 priv->reg_maccr &= ~HT_MULTI_EN;
 414         }
 415
 416         writel(priv->reg_maccr, priv->base + REG_MAC_CTRL);
 417
 418         spin_unlock_irq(&priv->txlock);
 419 }
 420
 421 static struct net_device_ops moxart_netdev_ops = {
 422         .ndo_open               = moxart_mac_open,
 423         .ndo_stop               = moxart_mac_stop,
 424         .ndo_start_xmit         = moxart_mac_start_xmit,
 425         .ndo_get_stats          = moxart_mac_get_stats,
 426         .ndo_set_rx_mode        = moxart_mac_set_rx_mode,
 427         .ndo_set_mac_address    = moxart_set_mac_address,
 428         .ndo_validate_addr      = eth_validate_addr,
 429         .ndo_change_mtu         = eth_change_mtu,
 430 };
 431
 432 static int moxart_mac_probe(struct platform_device *pdev)
 433 {
 434         struct device *p_dev = &pdev->dev;
 435         struct device_node *node = p_dev->of_node;
 436         struct net_device *ndev;
 437         struct moxart_mac_priv_t *priv;
 438         struct resource *res;
 439         unsigned int irq;
 440         int ret;
 441
 442         ndev = alloc_etherdev(sizeof(struct moxart_mac_priv_t));
 443         if (!ndev)
 444                 return -ENOMEM;
 445
 446         irq = irq_of_parse_and_map(node, 0);
 447         if (irq <= 0) {
 448                 netdev_err(ndev, "irq_of_parse_and_map failed\n");
 449                 ret = -EINVAL;
 450                 goto irq_map_fail;
 451         }
 452
 453         priv = netdev_priv(ndev);
 454         priv->ndev = ndev;
 455
 456         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 457         ndev->base_addr = res->start;
 458         priv->base = devm_ioremap_resource(p_dev, res);
 459         ret = IS_ERR(priv->base);
 460         if (ret) {
 461                 dev_err(p_dev, "devm_ioremap_resource failed\n");
 462                 goto init_fail;
 463         }
 464
 465         spin_lock_init(&priv->txlock);
 466
 467         priv->tx_buf_size = TX_BUF_SIZE;
 468         priv->rx_buf_size = RX_BUF_SIZE +
 469                             SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
 470
 471         priv->tx_desc_base = dma_alloc_coherent(NULL, TX_REG_DESC_SIZE *
 472                                                 TX_DESC_NUM, &priv->tx_base,
 473                                                 GFP_DMA | GFP_KERNEL);
 474         if (priv->tx_desc_base == NULL) {
 475                 ret = -ENOMEM;
 476                 goto init_fail;
 477         }
 478
 479         priv->rx_desc_base = dma_alloc_coherent(NULL, RX_REG_DESC_SIZE *
 480                                                 RX_DESC_NUM, &priv->rx_base,
 481                                                 GFP_DMA | GFP_KERNEL);
 482         if (priv->rx_desc_base == NULL) {
 483                 ret = -ENOMEM;
 484                 goto init_fail;
 485         }
 486
 487         priv->tx_buf_base = kmalloc(priv->tx_buf_size * TX_DESC_NUM,
 488                                     GFP_ATOMIC);
 489         if (!priv->tx_buf_base) {
 490                 ret = -ENOMEM;
 491                 goto init_fail;
 492         }
 493
 494         priv->rx_buf_base = kmalloc(priv->rx_buf_size * RX_DESC_NUM,
 495                                     GFP_ATOMIC);
 496         if (!priv->rx_buf_base) {
 497                 ret = -ENOMEM;
 498                 goto init_fail;
 499         }
 500
 501         platform_set_drvdata(pdev, ndev);
 502
 503         ret = devm_request_irq(p_dev, irq, moxart_mac_interrupt, 0,
 504                                pdev->name, ndev);
 505         if (ret) {
 506                 netdev_err(ndev, "devm_request_irq failed\n");
 507                 goto init_fail;
 508         }
 509
 510         ether_setup(ndev);
 511         ndev->netdev_ops = &moxart_netdev_ops;
 512         netif_napi_add(ndev, &priv->napi, moxart_rx_poll, RX_DESC_NUM);
 513         ndev->priv_flags |= IFF_UNICAST_FLT;
 514         ndev->irq = irq;
 515
 516         SET_NETDEV_DEV(ndev, &pdev->dev);
 517
 518         ret = register_netdev(ndev);
 519         if (ret) {
 520                 free_netdev(ndev);
 521                 goto init_fail;
 522         }
 523
 524         netdev_dbg(ndev, "%s: IRQ=%d address=%pM\n",
 525                    __func__, ndev->irq, ndev->dev_addr);
 526
 527         return 0;
 528
 529 init_fail:
 530         netdev_err(ndev, "init failed\n");
 531         moxart_mac_free_memory(ndev);
 532 irq_map_fail:
 533         free_netdev(ndev);
 534         return ret;
 535 }
 536
 537 static int moxart_remove(struct platform_device *pdev)
 538 {
 539         struct net_device *ndev = platform_get_drvdata(pdev);
 540
 541         unregister_netdev(ndev);
 542         free_irq(ndev->irq, ndev);
 543         moxart_mac_free_memory(ndev);
 544         free_netdev(ndev);
 545
 546         return 0;
 547 }
 548
 549 static const struct of_device_id moxart_mac_match[] = {
 550         { .compatible = "moxa,moxart-mac" },
 551         { }
 552 };
 553
 554 static struct platform_driver moxart_mac_driver = {
 555         .probe  = moxart_mac_probe,
 556         .remove = moxart_remove,
 557         .driver = {
 558                 .name           = "moxart-ethernet",
 559                 .owner          = THIS_MODULE,
 560                 .of_match_table = moxart_mac_match,
 561         },
 562 };
 563 module_platform_driver(moxart_mac_driver);
 564
 565 MODULE_DESCRIPTION("MOXART RTL8201CP Ethernet driver");
 566 MODULE_LICENSE("GPL v2");
 567 MODULE_AUTHOR("Jonas Jensen <jonas.jensen@gmail.com>");