2 * This program is free software; you can redistribute it and/or modify it
3 * under the terms of the GNU General Public License version 2 as published
4 * by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
11 * You should have received a copy of the GNU General Public License
12 * along with this program; if not, see <http://www.gnu.org/licenses/>.
14 * Copyright (C) 2011 John Crispin <blogic@openwrt.org>
17 #include <linux/kernel.h>
18 #include <linux/slab.h>
19 #include <linux/errno.h>
20 #include <linux/types.h>
21 #include <linux/interrupt.h>
22 #include <linux/uaccess.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include <linux/phy.h>
28 #include <linux/tcp.h>
29 #include <linux/skbuff.h>
31 #include <linux/platform_device.h>
32 #include <linux/ethtool.h>
33 #include <linux/init.h>
34 #include <linux/delay.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/module.h>
39 #include <asm/checksum.h>
41 #include <lantiq_soc.h>
43 #include <lantiq_platform.h>
45 #define LTQ_ETOP_MDIO 0x11804
46 #define MDIO_REQUEST 0x80000000
47 #define MDIO_READ 0x40000000
48 #define MDIO_ADDR_MASK 0x1f
49 #define MDIO_ADDR_OFFSET 0x15
50 #define MDIO_REG_MASK 0x1f
51 #define MDIO_REG_OFFSET 0x10
52 #define MDIO_VAL_MASK 0xffff
54 #define PPE32_CGEN 0x800
55 #define LQ_PPE32_ENET_MAC_CFG 0x1840
57 #define LTQ_ETOP_ENETS0 0x11850
58 #define LTQ_ETOP_MAC_DA0 0x1186C
59 #define LTQ_ETOP_MAC_DA1 0x11870
60 #define LTQ_ETOP_CFG 0x16020
61 #define LTQ_ETOP_IGPLEN 0x16080
63 #define MAX_DMA_CHAN 0x8
64 #define MAX_DMA_CRC_LEN 0x4
65 #define MAX_DMA_DATA_LEN 0x600
67 #define ETOP_FTCU BIT(28)
68 #define ETOP_MII_MASK 0xf
69 #define ETOP_MII_NORMAL 0xd
70 #define ETOP_MII_REVERSE 0xe
71 #define ETOP_PLEN_UNDER 0x40
72 #define ETOP_CGEN 0x800
74 /* use 2 static channels for TX/RX */
75 #define LTQ_ETOP_TX_CHANNEL 1
76 #define LTQ_ETOP_RX_CHANNEL 6
77 #define IS_TX(x) (x == LTQ_ETOP_TX_CHANNEL)
78 #define IS_RX(x) (x == LTQ_ETOP_RX_CHANNEL)
80 #define ltq_etop_r32(x) ltq_r32(ltq_etop_membase + (x))
81 #define ltq_etop_w32(x, y) ltq_w32(x, ltq_etop_membase + (y))
82 #define ltq_etop_w32_mask(x, y, z) \
83 ltq_w32_mask(x, y, ltq_etop_membase + (z))
85 #define DRV_VERSION "1.0"
87 static void __iomem *ltq_etop_membase;
89 struct ltq_etop_chan {
92 struct net_device *netdev;
93 struct napi_struct napi;
94 struct ltq_dma_channel dma;
95 struct sk_buff *skb[LTQ_DESC_NUM];
98 struct ltq_etop_priv {
99 struct net_device *netdev;
100 struct platform_device *pdev;
101 struct ltq_eth_data *pldata;
102 struct resource *res;
104 struct mii_bus *mii_bus;
106 struct ltq_etop_chan ch[MAX_DMA_CHAN];
107 int tx_free[MAX_DMA_CHAN >> 1];
113 ltq_etop_alloc_skb(struct ltq_etop_chan *ch)
115 struct ltq_etop_priv *priv = netdev_priv(ch->netdev);
117 ch->skb[ch->dma.desc] = netdev_alloc_skb(ch->netdev, MAX_DMA_DATA_LEN);
118 if (!ch->skb[ch->dma.desc])
120 ch->dma.desc_base[ch->dma.desc].addr = dma_map_single(&priv->pdev->dev,
121 ch->skb[ch->dma.desc]->data, MAX_DMA_DATA_LEN,
123 ch->dma.desc_base[ch->dma.desc].addr =
124 CPHYSADDR(ch->skb[ch->dma.desc]->data);
125 ch->dma.desc_base[ch->dma.desc].ctl =
126 LTQ_DMA_OWN | LTQ_DMA_RX_OFFSET(NET_IP_ALIGN) |
128 skb_reserve(ch->skb[ch->dma.desc], NET_IP_ALIGN);
133 ltq_etop_hw_receive(struct ltq_etop_chan *ch)
135 struct ltq_etop_priv *priv = netdev_priv(ch->netdev);
136 struct ltq_dma_desc *desc = &ch->dma.desc_base[ch->dma.desc];
137 struct sk_buff *skb = ch->skb[ch->dma.desc];
138 int len = (desc->ctl & LTQ_DMA_SIZE_MASK) - MAX_DMA_CRC_LEN;
141 spin_lock_irqsave(&priv->lock, flags);
142 if (ltq_etop_alloc_skb(ch)) {
143 netdev_err(ch->netdev,
144 "failed to allocate new rx buffer, stopping DMA\n");
145 ltq_dma_close(&ch->dma);
148 ch->dma.desc %= LTQ_DESC_NUM;
149 spin_unlock_irqrestore(&priv->lock, flags);
152 skb->protocol = eth_type_trans(skb, ch->netdev);
153 netif_receive_skb(skb);
157 ltq_etop_poll_rx(struct napi_struct *napi, int budget)
159 struct ltq_etop_chan *ch = container_of(napi,
160 struct ltq_etop_chan, napi);
163 while (work_done < budget) {
164 struct ltq_dma_desc *desc = &ch->dma.desc_base[ch->dma.desc];
166 if ((desc->ctl & (LTQ_DMA_OWN | LTQ_DMA_C)) != LTQ_DMA_C)
168 ltq_etop_hw_receive(ch);
171 if (work_done < budget) {
172 napi_complete_done(&ch->napi, work_done);
173 ltq_dma_ack_irq(&ch->dma);
179 ltq_etop_poll_tx(struct napi_struct *napi, int budget)
181 struct ltq_etop_chan *ch =
182 container_of(napi, struct ltq_etop_chan, napi);
183 struct ltq_etop_priv *priv = netdev_priv(ch->netdev);
184 struct netdev_queue *txq =
185 netdev_get_tx_queue(ch->netdev, ch->idx >> 1);
188 spin_lock_irqsave(&priv->lock, flags);
189 while ((ch->dma.desc_base[ch->tx_free].ctl &
190 (LTQ_DMA_OWN | LTQ_DMA_C)) == LTQ_DMA_C) {
191 dev_kfree_skb_any(ch->skb[ch->tx_free]);
192 ch->skb[ch->tx_free] = NULL;
193 memset(&ch->dma.desc_base[ch->tx_free], 0,
194 sizeof(struct ltq_dma_desc));
196 ch->tx_free %= LTQ_DESC_NUM;
198 spin_unlock_irqrestore(&priv->lock, flags);
200 if (netif_tx_queue_stopped(txq))
201 netif_tx_start_queue(txq);
202 napi_complete(&ch->napi);
203 ltq_dma_ack_irq(&ch->dma);
208 ltq_etop_dma_irq(int irq, void *_priv)
210 struct ltq_etop_priv *priv = _priv;
211 int ch = irq - LTQ_DMA_CH0_INT;
213 napi_schedule(&priv->ch[ch].napi);
218 ltq_etop_free_channel(struct net_device *dev, struct ltq_etop_chan *ch)
220 struct ltq_etop_priv *priv = netdev_priv(dev);
222 ltq_dma_free(&ch->dma);
224 free_irq(ch->dma.irq, priv);
225 if (IS_RX(ch->idx)) {
227 for (desc = 0; desc < LTQ_DESC_NUM; desc++)
228 dev_kfree_skb_any(ch->skb[ch->dma.desc]);
233 ltq_etop_hw_exit(struct net_device *dev)
235 struct ltq_etop_priv *priv = netdev_priv(dev);
238 ltq_pmu_disable(PMU_PPE);
239 for (i = 0; i < MAX_DMA_CHAN; i++)
240 if (IS_TX(i) || IS_RX(i))
241 ltq_etop_free_channel(dev, &priv->ch[i]);
245 ltq_etop_hw_init(struct net_device *dev)
247 struct ltq_etop_priv *priv = netdev_priv(dev);
250 ltq_pmu_enable(PMU_PPE);
252 switch (priv->pldata->mii_mode) {
253 case PHY_INTERFACE_MODE_RMII:
254 ltq_etop_w32_mask(ETOP_MII_MASK,
255 ETOP_MII_REVERSE, LTQ_ETOP_CFG);
258 case PHY_INTERFACE_MODE_MII:
259 ltq_etop_w32_mask(ETOP_MII_MASK,
260 ETOP_MII_NORMAL, LTQ_ETOP_CFG);
264 netdev_err(dev, "unknown mii mode %d\n",
265 priv->pldata->mii_mode);
269 /* enable crc generation */
270 ltq_etop_w32(PPE32_CGEN, LQ_PPE32_ENET_MAC_CFG);
272 ltq_dma_init_port(DMA_PORT_ETOP);
274 for (i = 0; i < MAX_DMA_CHAN; i++) {
275 int irq = LTQ_DMA_CH0_INT + i;
276 struct ltq_etop_chan *ch = &priv->ch[i];
278 ch->idx = ch->dma.nr = i;
279 ch->dma.dev = &priv->pdev->dev;
282 ltq_dma_alloc_tx(&ch->dma);
283 request_irq(irq, ltq_etop_dma_irq, 0, "etop_tx", priv);
284 } else if (IS_RX(i)) {
285 ltq_dma_alloc_rx(&ch->dma);
286 for (ch->dma.desc = 0; ch->dma.desc < LTQ_DESC_NUM;
288 if (ltq_etop_alloc_skb(ch))
291 request_irq(irq, ltq_etop_dma_irq, 0, "etop_rx", priv);
299 ltq_etop_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
301 strlcpy(info->driver, "Lantiq ETOP", sizeof(info->driver));
302 strlcpy(info->bus_info, "internal", sizeof(info->bus_info));
303 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
306 static const struct ethtool_ops ltq_etop_ethtool_ops = {
307 .get_drvinfo = ltq_etop_get_drvinfo,
308 .nway_reset = phy_ethtool_nway_reset,
309 .get_link_ksettings = phy_ethtool_get_link_ksettings,
310 .set_link_ksettings = phy_ethtool_set_link_ksettings,
314 ltq_etop_mdio_wr(struct mii_bus *bus, int phy_addr, int phy_reg, u16 phy_data)
316 u32 val = MDIO_REQUEST |
317 ((phy_addr & MDIO_ADDR_MASK) << MDIO_ADDR_OFFSET) |
318 ((phy_reg & MDIO_REG_MASK) << MDIO_REG_OFFSET) |
321 while (ltq_etop_r32(LTQ_ETOP_MDIO) & MDIO_REQUEST)
323 ltq_etop_w32(val, LTQ_ETOP_MDIO);
328 ltq_etop_mdio_rd(struct mii_bus *bus, int phy_addr, int phy_reg)
330 u32 val = MDIO_REQUEST | MDIO_READ |
331 ((phy_addr & MDIO_ADDR_MASK) << MDIO_ADDR_OFFSET) |
332 ((phy_reg & MDIO_REG_MASK) << MDIO_REG_OFFSET);
334 while (ltq_etop_r32(LTQ_ETOP_MDIO) & MDIO_REQUEST)
336 ltq_etop_w32(val, LTQ_ETOP_MDIO);
337 while (ltq_etop_r32(LTQ_ETOP_MDIO) & MDIO_REQUEST)
339 val = ltq_etop_r32(LTQ_ETOP_MDIO) & MDIO_VAL_MASK;
344 ltq_etop_mdio_link(struct net_device *dev)
350 ltq_etop_mdio_probe(struct net_device *dev)
352 struct ltq_etop_priv *priv = netdev_priv(dev);
353 struct phy_device *phydev;
355 phydev = phy_find_first(priv->mii_bus);
358 netdev_err(dev, "no PHY found\n");
362 phydev = phy_connect(dev, phydev_name(phydev),
363 <q_etop_mdio_link, priv->pldata->mii_mode);
365 if (IS_ERR(phydev)) {
366 netdev_err(dev, "Could not attach to PHY\n");
367 return PTR_ERR(phydev);
370 phy_set_max_speed(phydev, SPEED_100);
372 phy_attached_info(phydev);
378 ltq_etop_mdio_init(struct net_device *dev)
380 struct ltq_etop_priv *priv = netdev_priv(dev);
383 priv->mii_bus = mdiobus_alloc();
384 if (!priv->mii_bus) {
385 netdev_err(dev, "failed to allocate mii bus\n");
390 priv->mii_bus->priv = dev;
391 priv->mii_bus->read = ltq_etop_mdio_rd;
392 priv->mii_bus->write = ltq_etop_mdio_wr;
393 priv->mii_bus->name = "ltq_mii";
394 snprintf(priv->mii_bus->id, MII_BUS_ID_SIZE, "%s-%x",
395 priv->pdev->name, priv->pdev->id);
396 if (mdiobus_register(priv->mii_bus)) {
398 goto err_out_free_mdiobus;
401 if (ltq_etop_mdio_probe(dev)) {
403 goto err_out_unregister_bus;
407 err_out_unregister_bus:
408 mdiobus_unregister(priv->mii_bus);
409 err_out_free_mdiobus:
410 mdiobus_free(priv->mii_bus);
416 ltq_etop_mdio_cleanup(struct net_device *dev)
418 struct ltq_etop_priv *priv = netdev_priv(dev);
420 phy_disconnect(dev->phydev);
421 mdiobus_unregister(priv->mii_bus);
422 mdiobus_free(priv->mii_bus);
426 ltq_etop_open(struct net_device *dev)
428 struct ltq_etop_priv *priv = netdev_priv(dev);
431 for (i = 0; i < MAX_DMA_CHAN; i++) {
432 struct ltq_etop_chan *ch = &priv->ch[i];
434 if (!IS_TX(i) && (!IS_RX(i)))
436 ltq_dma_open(&ch->dma);
437 ltq_dma_enable_irq(&ch->dma);
438 napi_enable(&ch->napi);
440 phy_start(dev->phydev);
441 netif_tx_start_all_queues(dev);
446 ltq_etop_stop(struct net_device *dev)
448 struct ltq_etop_priv *priv = netdev_priv(dev);
451 netif_tx_stop_all_queues(dev);
452 phy_stop(dev->phydev);
453 for (i = 0; i < MAX_DMA_CHAN; i++) {
454 struct ltq_etop_chan *ch = &priv->ch[i];
456 if (!IS_RX(i) && !IS_TX(i))
458 napi_disable(&ch->napi);
459 ltq_dma_close(&ch->dma);
465 ltq_etop_tx(struct sk_buff *skb, struct net_device *dev)
467 int queue = skb_get_queue_mapping(skb);
468 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue);
469 struct ltq_etop_priv *priv = netdev_priv(dev);
470 struct ltq_etop_chan *ch = &priv->ch[(queue << 1) | 1];
471 struct ltq_dma_desc *desc = &ch->dma.desc_base[ch->dma.desc];
476 len = skb->len < ETH_ZLEN ? ETH_ZLEN : skb->len;
478 if ((desc->ctl & (LTQ_DMA_OWN | LTQ_DMA_C)) || ch->skb[ch->dma.desc]) {
479 dev_kfree_skb_any(skb);
480 netdev_err(dev, "tx ring full\n");
481 netif_tx_stop_queue(txq);
482 return NETDEV_TX_BUSY;
485 /* dma needs to start on a 16 byte aligned address */
486 byte_offset = CPHYSADDR(skb->data) % 16;
487 ch->skb[ch->dma.desc] = skb;
489 netif_trans_update(dev);
491 spin_lock_irqsave(&priv->lock, flags);
492 desc->addr = ((unsigned int) dma_map_single(&priv->pdev->dev, skb->data, len,
493 DMA_TO_DEVICE)) - byte_offset;
495 desc->ctl = LTQ_DMA_OWN | LTQ_DMA_SOP | LTQ_DMA_EOP |
496 LTQ_DMA_TX_OFFSET(byte_offset) | (len & LTQ_DMA_SIZE_MASK);
498 ch->dma.desc %= LTQ_DESC_NUM;
499 spin_unlock_irqrestore(&priv->lock, flags);
501 if (ch->dma.desc_base[ch->dma.desc].ctl & LTQ_DMA_OWN)
502 netif_tx_stop_queue(txq);
508 ltq_etop_change_mtu(struct net_device *dev, int new_mtu)
510 struct ltq_etop_priv *priv = netdev_priv(dev);
515 spin_lock_irqsave(&priv->lock, flags);
516 ltq_etop_w32((ETOP_PLEN_UNDER << 16) | new_mtu, LTQ_ETOP_IGPLEN);
517 spin_unlock_irqrestore(&priv->lock, flags);
523 ltq_etop_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
525 /* TODO: mii-toll reports "No MII transceiver present!." ?!*/
526 return phy_mii_ioctl(dev->phydev, rq, cmd);
530 ltq_etop_set_mac_address(struct net_device *dev, void *p)
532 int ret = eth_mac_addr(dev, p);
535 struct ltq_etop_priv *priv = netdev_priv(dev);
538 /* store the mac for the unicast filter */
539 spin_lock_irqsave(&priv->lock, flags);
540 ltq_etop_w32(*((u32 *)dev->dev_addr), LTQ_ETOP_MAC_DA0);
541 ltq_etop_w32(*((u16 *)&dev->dev_addr[4]) << 16,
543 spin_unlock_irqrestore(&priv->lock, flags);
549 ltq_etop_set_multicast_list(struct net_device *dev)
551 struct ltq_etop_priv *priv = netdev_priv(dev);
554 /* ensure that the unicast filter is not enabled in promiscious mode */
555 spin_lock_irqsave(&priv->lock, flags);
556 if ((dev->flags & IFF_PROMISC) || (dev->flags & IFF_ALLMULTI))
557 ltq_etop_w32_mask(ETOP_FTCU, 0, LTQ_ETOP_ENETS0);
559 ltq_etop_w32_mask(0, ETOP_FTCU, LTQ_ETOP_ENETS0);
560 spin_unlock_irqrestore(&priv->lock, flags);
564 ltq_etop_init(struct net_device *dev)
566 struct ltq_etop_priv *priv = netdev_priv(dev);
569 bool random_mac = false;
571 dev->watchdog_timeo = 10 * HZ;
572 err = ltq_etop_hw_init(dev);
575 ltq_etop_change_mtu(dev, 1500);
577 memcpy(&mac, &priv->pldata->mac, sizeof(struct sockaddr));
578 if (!is_valid_ether_addr(mac.sa_data)) {
579 pr_warn("etop: invalid MAC, using random\n");
580 eth_random_addr(mac.sa_data);
584 err = ltq_etop_set_mac_address(dev, &mac);
588 /* Set addr_assign_type here, ltq_etop_set_mac_address would reset it. */
590 dev->addr_assign_type = NET_ADDR_RANDOM;
592 ltq_etop_set_multicast_list(dev);
593 err = ltq_etop_mdio_init(dev);
599 unregister_netdev(dev);
602 ltq_etop_hw_exit(dev);
607 ltq_etop_tx_timeout(struct net_device *dev)
611 ltq_etop_hw_exit(dev);
612 err = ltq_etop_hw_init(dev);
615 netif_trans_update(dev);
616 netif_wake_queue(dev);
620 ltq_etop_hw_exit(dev);
621 netdev_err(dev, "failed to restart etop after TX timeout\n");
624 static const struct net_device_ops ltq_eth_netdev_ops = {
625 .ndo_open = ltq_etop_open,
626 .ndo_stop = ltq_etop_stop,
627 .ndo_start_xmit = ltq_etop_tx,
628 .ndo_change_mtu = ltq_etop_change_mtu,
629 .ndo_do_ioctl = ltq_etop_ioctl,
630 .ndo_set_mac_address = ltq_etop_set_mac_address,
631 .ndo_validate_addr = eth_validate_addr,
632 .ndo_set_rx_mode = ltq_etop_set_multicast_list,
633 .ndo_select_queue = dev_pick_tx_zero,
634 .ndo_init = ltq_etop_init,
635 .ndo_tx_timeout = ltq_etop_tx_timeout,
639 ltq_etop_probe(struct platform_device *pdev)
641 struct net_device *dev;
642 struct ltq_etop_priv *priv;
643 struct resource *res;
647 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
649 dev_err(&pdev->dev, "failed to get etop resource\n");
654 res = devm_request_mem_region(&pdev->dev, res->start,
655 resource_size(res), dev_name(&pdev->dev));
657 dev_err(&pdev->dev, "failed to request etop resource\n");
662 ltq_etop_membase = devm_ioremap_nocache(&pdev->dev,
663 res->start, resource_size(res));
664 if (!ltq_etop_membase) {
665 dev_err(&pdev->dev, "failed to remap etop engine %d\n",
671 dev = alloc_etherdev_mq(sizeof(struct ltq_etop_priv), 4);
676 strcpy(dev->name, "eth%d");
677 dev->netdev_ops = <q_eth_netdev_ops;
678 dev->ethtool_ops = <q_etop_ethtool_ops;
679 priv = netdev_priv(dev);
682 priv->pldata = dev_get_platdata(&pdev->dev);
684 spin_lock_init(&priv->lock);
685 SET_NETDEV_DEV(dev, &pdev->dev);
687 for (i = 0; i < MAX_DMA_CHAN; i++) {
689 netif_napi_add(dev, &priv->ch[i].napi,
690 ltq_etop_poll_tx, 8);
692 netif_napi_add(dev, &priv->ch[i].napi,
693 ltq_etop_poll_rx, 32);
694 priv->ch[i].netdev = dev;
697 err = register_netdev(dev);
701 platform_set_drvdata(pdev, dev);
711 ltq_etop_remove(struct platform_device *pdev)
713 struct net_device *dev = platform_get_drvdata(pdev);
716 netif_tx_stop_all_queues(dev);
717 ltq_etop_hw_exit(dev);
718 ltq_etop_mdio_cleanup(dev);
719 unregister_netdev(dev);
724 static struct platform_driver ltq_mii_driver = {
725 .remove = ltq_etop_remove,
734 int ret = platform_driver_probe(<q_mii_driver, ltq_etop_probe);
737 pr_err("ltq_etop: Error registering platform driver!");
744 platform_driver_unregister(<q_mii_driver);
747 module_init(init_ltq_etop);
748 module_exit(exit_ltq_etop);
750 MODULE_AUTHOR("John Crispin <blogic@openwrt.org>");
751 MODULE_DESCRIPTION("Lantiq SoC ETOP");
752 MODULE_LICENSE("GPL");