1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Faraday FTGMAC100 Gigabit Ethernet
5 * (C) Copyright 2009-2011 Faraday Technology
6 * Po-Yu Chuang <ratbert@faraday-tech.com>
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/etherdevice.h>
14 #include <linux/ethtool.h>
15 #include <linux/interrupt.h>
17 #include <linux/module.h>
18 #include <linux/netdevice.h>
20 #include <linux/of_mdio.h>
21 #include <linux/phy.h>
22 #include <linux/platform_device.h>
23 #include <linux/property.h>
24 #include <linux/crc32.h>
25 #include <linux/if_vlan.h>
26 #include <linux/of_net.h>
30 #include "ftgmac100.h"
32 #define DRV_NAME "ftgmac100"
33 #define DRV_VERSION "0.7"
35 /* Arbitrary values, I am not sure the HW has limits */
36 #define MAX_RX_QUEUE_ENTRIES 1024
37 #define MAX_TX_QUEUE_ENTRIES 1024
38 #define MIN_RX_QUEUE_ENTRIES 32
39 #define MIN_TX_QUEUE_ENTRIES 32
42 #define DEF_RX_QUEUE_ENTRIES 128
43 #define DEF_TX_QUEUE_ENTRIES 128
45 #define MAX_PKT_SIZE 1536
46 #define RX_BUF_SIZE MAX_PKT_SIZE /* must be smaller than 0x3fff */
48 /* Min number of tx ring entries before stopping queue */
49 #define TX_THRESHOLD (MAX_SKB_FRAGS + 1)
51 #define FTGMAC_100MHZ 100000000
52 #define FTGMAC_25MHZ 25000000
60 unsigned int rx_q_entries;
61 struct ftgmac100_rxdes *rxdes;
63 struct sk_buff **rx_skbs;
64 unsigned int rx_pointer;
65 u32 rxdes0_edorr_mask;
68 unsigned int tx_q_entries;
69 struct ftgmac100_txdes *txdes;
71 struct sk_buff **tx_skbs;
72 unsigned int tx_clean_pointer;
73 unsigned int tx_pointer;
74 u32 txdes0_edotr_mask;
76 /* Used to signal the reset task of ring change request */
77 unsigned int new_rx_q_entries;
78 unsigned int new_tx_q_entries;
80 /* Scratch page to use when rx skb alloc fails */
82 dma_addr_t rx_scratch_dma;
84 /* Component structures */
85 struct net_device *netdev;
87 struct ncsi_dev *ndev;
88 struct napi_struct napi;
89 struct work_struct reset_task;
90 struct mii_bus *mii_bus;
98 /* Multicast filter settings */
102 /* Flow control settings */
108 bool need_mac_restart;
112 static int ftgmac100_reset_mac(struct ftgmac100 *priv, u32 maccr)
114 struct net_device *netdev = priv->netdev;
117 /* NOTE: reset clears all registers */
118 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
119 iowrite32(maccr | FTGMAC100_MACCR_SW_RST,
120 priv->base + FTGMAC100_OFFSET_MACCR);
121 for (i = 0; i < 200; i++) {
124 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
125 if (!(maccr & FTGMAC100_MACCR_SW_RST))
131 netdev_err(netdev, "Hardware reset failed\n");
135 static int ftgmac100_reset_and_config_mac(struct ftgmac100 *priv)
139 switch (priv->cur_speed) {
141 case 0: /* no link */
145 maccr |= FTGMAC100_MACCR_FAST_MODE;
149 maccr |= FTGMAC100_MACCR_GIGA_MODE;
152 netdev_err(priv->netdev, "Unknown speed %d !\n",
157 /* (Re)initialize the queue pointers */
158 priv->rx_pointer = 0;
159 priv->tx_clean_pointer = 0;
160 priv->tx_pointer = 0;
162 /* The doc says reset twice with 10us interval */
163 if (ftgmac100_reset_mac(priv, maccr))
165 usleep_range(10, 1000);
166 return ftgmac100_reset_mac(priv, maccr);
169 static void ftgmac100_write_mac_addr(struct ftgmac100 *priv, const u8 *mac)
171 unsigned int maddr = mac[0] << 8 | mac[1];
172 unsigned int laddr = mac[2] << 24 | mac[3] << 16 | mac[4] << 8 | mac[5];
174 iowrite32(maddr, priv->base + FTGMAC100_OFFSET_MAC_MADR);
175 iowrite32(laddr, priv->base + FTGMAC100_OFFSET_MAC_LADR);
178 static void ftgmac100_initial_mac(struct ftgmac100 *priv)
185 addr = device_get_mac_address(priv->dev, mac, ETH_ALEN);
187 ether_addr_copy(priv->netdev->dev_addr, mac);
188 dev_info(priv->dev, "Read MAC address %pM from device tree\n",
193 m = ioread32(priv->base + FTGMAC100_OFFSET_MAC_MADR);
194 l = ioread32(priv->base + FTGMAC100_OFFSET_MAC_LADR);
196 mac[0] = (m >> 8) & 0xff;
198 mac[2] = (l >> 24) & 0xff;
199 mac[3] = (l >> 16) & 0xff;
200 mac[4] = (l >> 8) & 0xff;
203 if (is_valid_ether_addr(mac)) {
204 ether_addr_copy(priv->netdev->dev_addr, mac);
205 dev_info(priv->dev, "Read MAC address %pM from chip\n", mac);
207 eth_hw_addr_random(priv->netdev);
208 dev_info(priv->dev, "Generated random MAC address %pM\n",
209 priv->netdev->dev_addr);
213 static int ftgmac100_set_mac_addr(struct net_device *dev, void *p)
217 ret = eth_prepare_mac_addr_change(dev, p);
221 eth_commit_mac_addr_change(dev, p);
222 ftgmac100_write_mac_addr(netdev_priv(dev), dev->dev_addr);
227 static void ftgmac100_config_pause(struct ftgmac100 *priv)
229 u32 fcr = FTGMAC100_FCR_PAUSE_TIME(16);
231 /* Throttle tx queue when receiving pause frames */
233 fcr |= FTGMAC100_FCR_FC_EN;
235 /* Enables sending pause frames when the RX queue is past a
239 fcr |= FTGMAC100_FCR_FCTHR_EN;
241 iowrite32(fcr, priv->base + FTGMAC100_OFFSET_FCR);
244 static void ftgmac100_init_hw(struct ftgmac100 *priv)
246 u32 reg, rfifo_sz, tfifo_sz;
248 /* Clear stale interrupts */
249 reg = ioread32(priv->base + FTGMAC100_OFFSET_ISR);
250 iowrite32(reg, priv->base + FTGMAC100_OFFSET_ISR);
252 /* Setup RX ring buffer base */
253 iowrite32(priv->rxdes_dma, priv->base + FTGMAC100_OFFSET_RXR_BADR);
255 /* Setup TX ring buffer base */
256 iowrite32(priv->txdes_dma, priv->base + FTGMAC100_OFFSET_NPTXR_BADR);
258 /* Configure RX buffer size */
259 iowrite32(FTGMAC100_RBSR_SIZE(RX_BUF_SIZE),
260 priv->base + FTGMAC100_OFFSET_RBSR);
262 /* Set RX descriptor autopoll */
263 iowrite32(FTGMAC100_APTC_RXPOLL_CNT(1),
264 priv->base + FTGMAC100_OFFSET_APTC);
266 /* Write MAC address */
267 ftgmac100_write_mac_addr(priv, priv->netdev->dev_addr);
269 /* Write multicast filter */
270 iowrite32(priv->maht0, priv->base + FTGMAC100_OFFSET_MAHT0);
271 iowrite32(priv->maht1, priv->base + FTGMAC100_OFFSET_MAHT1);
273 /* Configure descriptor sizes and increase burst sizes according
274 * to values in Aspeed SDK. The FIFO arbitration is enabled and
275 * the thresholds set based on the recommended values in the
276 * AST2400 specification.
278 iowrite32(FTGMAC100_DBLAC_RXDES_SIZE(2) | /* 2*8 bytes RX descs */
279 FTGMAC100_DBLAC_TXDES_SIZE(2) | /* 2*8 bytes TX descs */
280 FTGMAC100_DBLAC_RXBURST_SIZE(3) | /* 512 bytes max RX bursts */
281 FTGMAC100_DBLAC_TXBURST_SIZE(3) | /* 512 bytes max TX bursts */
282 FTGMAC100_DBLAC_RX_THR_EN | /* Enable fifo threshold arb */
283 FTGMAC100_DBLAC_RXFIFO_HTHR(6) | /* 6/8 of FIFO high threshold */
284 FTGMAC100_DBLAC_RXFIFO_LTHR(2), /* 2/8 of FIFO low threshold */
285 priv->base + FTGMAC100_OFFSET_DBLAC);
287 /* Interrupt mitigation configured for 1 interrupt/packet. HW interrupt
288 * mitigation doesn't seem to provide any benefit with NAPI so leave
291 iowrite32(FTGMAC100_ITC_RXINT_THR(1) |
292 FTGMAC100_ITC_TXINT_THR(1),
293 priv->base + FTGMAC100_OFFSET_ITC);
295 /* Configure FIFO sizes in the TPAFCR register */
296 reg = ioread32(priv->base + FTGMAC100_OFFSET_FEAR);
297 rfifo_sz = reg & 0x00000007;
298 tfifo_sz = (reg >> 3) & 0x00000007;
299 reg = ioread32(priv->base + FTGMAC100_OFFSET_TPAFCR);
301 reg |= (tfifo_sz << 27);
302 reg |= (rfifo_sz << 24);
303 iowrite32(reg, priv->base + FTGMAC100_OFFSET_TPAFCR);
306 static void ftgmac100_start_hw(struct ftgmac100 *priv)
308 u32 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
310 /* Keep the original GMAC and FAST bits */
311 maccr &= (FTGMAC100_MACCR_FAST_MODE | FTGMAC100_MACCR_GIGA_MODE);
313 /* Add all the main enable bits */
314 maccr |= FTGMAC100_MACCR_TXDMA_EN |
315 FTGMAC100_MACCR_RXDMA_EN |
316 FTGMAC100_MACCR_TXMAC_EN |
317 FTGMAC100_MACCR_RXMAC_EN |
318 FTGMAC100_MACCR_CRC_APD |
319 FTGMAC100_MACCR_PHY_LINK_LEVEL |
320 FTGMAC100_MACCR_RX_RUNT |
321 FTGMAC100_MACCR_RX_BROADPKT;
323 /* Add other bits as needed */
324 if (priv->cur_duplex == DUPLEX_FULL)
325 maccr |= FTGMAC100_MACCR_FULLDUP;
326 if (priv->netdev->flags & IFF_PROMISC)
327 maccr |= FTGMAC100_MACCR_RX_ALL;
328 if (priv->netdev->flags & IFF_ALLMULTI)
329 maccr |= FTGMAC100_MACCR_RX_MULTIPKT;
330 else if (netdev_mc_count(priv->netdev))
331 maccr |= FTGMAC100_MACCR_HT_MULTI_EN;
333 /* Vlan filtering enabled */
334 if (priv->netdev->features & NETIF_F_HW_VLAN_CTAG_RX)
335 maccr |= FTGMAC100_MACCR_RM_VLAN;
338 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
341 static void ftgmac100_stop_hw(struct ftgmac100 *priv)
343 iowrite32(0, priv->base + FTGMAC100_OFFSET_MACCR);
346 static void ftgmac100_calc_mc_hash(struct ftgmac100 *priv)
348 struct netdev_hw_addr *ha;
352 netdev_for_each_mc_addr(ha, priv->netdev) {
353 u32 crc_val = ether_crc_le(ETH_ALEN, ha->addr);
355 crc_val = (~(crc_val >> 2)) & 0x3f;
357 priv->maht1 |= 1ul << (crc_val - 32);
359 priv->maht0 |= 1ul << (crc_val);
363 static void ftgmac100_set_rx_mode(struct net_device *netdev)
365 struct ftgmac100 *priv = netdev_priv(netdev);
367 /* Setup the hash filter */
368 ftgmac100_calc_mc_hash(priv);
370 /* Interface down ? that's all there is to do */
371 if (!netif_running(netdev))
375 iowrite32(priv->maht0, priv->base + FTGMAC100_OFFSET_MAHT0);
376 iowrite32(priv->maht1, priv->base + FTGMAC100_OFFSET_MAHT1);
378 /* Reconfigure MACCR */
379 ftgmac100_start_hw(priv);
382 static int ftgmac100_alloc_rx_buf(struct ftgmac100 *priv, unsigned int entry,
383 struct ftgmac100_rxdes *rxdes, gfp_t gfp)
385 struct net_device *netdev = priv->netdev;
390 skb = netdev_alloc_skb_ip_align(netdev, RX_BUF_SIZE);
391 if (unlikely(!skb)) {
393 netdev_warn(netdev, "failed to allocate rx skb\n");
395 map = priv->rx_scratch_dma;
397 map = dma_map_single(priv->dev, skb->data, RX_BUF_SIZE,
399 if (unlikely(dma_mapping_error(priv->dev, map))) {
401 netdev_err(netdev, "failed to map rx page\n");
402 dev_kfree_skb_any(skb);
403 map = priv->rx_scratch_dma;
410 priv->rx_skbs[entry] = skb;
412 /* Store DMA address into RX desc */
413 rxdes->rxdes3 = cpu_to_le32(map);
415 /* Ensure the above is ordered vs clearing the OWN bit */
418 /* Clean status (which resets own bit) */
419 if (entry == (priv->rx_q_entries - 1))
420 rxdes->rxdes0 = cpu_to_le32(priv->rxdes0_edorr_mask);
427 static unsigned int ftgmac100_next_rx_pointer(struct ftgmac100 *priv,
428 unsigned int pointer)
430 return (pointer + 1) & (priv->rx_q_entries - 1);
433 static void ftgmac100_rx_packet_error(struct ftgmac100 *priv, u32 status)
435 struct net_device *netdev = priv->netdev;
437 if (status & FTGMAC100_RXDES0_RX_ERR)
438 netdev->stats.rx_errors++;
440 if (status & FTGMAC100_RXDES0_CRC_ERR)
441 netdev->stats.rx_crc_errors++;
443 if (status & (FTGMAC100_RXDES0_FTL |
444 FTGMAC100_RXDES0_RUNT |
445 FTGMAC100_RXDES0_RX_ODD_NB))
446 netdev->stats.rx_length_errors++;
449 static bool ftgmac100_rx_packet(struct ftgmac100 *priv, int *processed)
451 struct net_device *netdev = priv->netdev;
452 struct ftgmac100_rxdes *rxdes;
454 unsigned int pointer, size;
455 u32 status, csum_vlan;
458 /* Grab next RX descriptor */
459 pointer = priv->rx_pointer;
460 rxdes = &priv->rxdes[pointer];
462 /* Grab descriptor status */
463 status = le32_to_cpu(rxdes->rxdes0);
465 /* Do we have a packet ? */
466 if (!(status & FTGMAC100_RXDES0_RXPKT_RDY))
469 /* Order subsequent reads with the test for the ready bit */
472 /* We don't cope with fragmented RX packets */
473 if (unlikely(!(status & FTGMAC100_RXDES0_FRS) ||
474 !(status & FTGMAC100_RXDES0_LRS)))
477 /* Grab received size and csum vlan field in the descriptor */
478 size = status & FTGMAC100_RXDES0_VDBC;
479 csum_vlan = le32_to_cpu(rxdes->rxdes1);
481 /* Any error (other than csum offload) flagged ? */
482 if (unlikely(status & RXDES0_ANY_ERROR)) {
483 /* Correct for incorrect flagging of runt packets
484 * with vlan tags... Just accept a runt packet that
485 * has been flagged as vlan and whose size is at
488 if ((status & FTGMAC100_RXDES0_RUNT) &&
489 (csum_vlan & FTGMAC100_RXDES1_VLANTAG_AVAIL) &&
491 status &= ~FTGMAC100_RXDES0_RUNT;
493 /* Any error still in there ? */
494 if (status & RXDES0_ANY_ERROR) {
495 ftgmac100_rx_packet_error(priv, status);
500 /* If the packet had no skb (failed to allocate earlier)
501 * then try to allocate one and skip
503 skb = priv->rx_skbs[pointer];
504 if (!unlikely(skb)) {
505 ftgmac100_alloc_rx_buf(priv, pointer, rxdes, GFP_ATOMIC);
509 if (unlikely(status & FTGMAC100_RXDES0_MULTICAST))
510 netdev->stats.multicast++;
512 /* If the HW found checksum errors, bounce it to software.
514 * If we didn't, we need to see if the packet was recognized
515 * by HW as one of the supported checksummed protocols before
516 * we accept the HW test results.
518 if (netdev->features & NETIF_F_RXCSUM) {
519 u32 err_bits = FTGMAC100_RXDES1_TCP_CHKSUM_ERR |
520 FTGMAC100_RXDES1_UDP_CHKSUM_ERR |
521 FTGMAC100_RXDES1_IP_CHKSUM_ERR;
522 if ((csum_vlan & err_bits) ||
523 !(csum_vlan & FTGMAC100_RXDES1_PROT_MASK))
524 skb->ip_summed = CHECKSUM_NONE;
526 skb->ip_summed = CHECKSUM_UNNECESSARY;
529 /* Transfer received size to skb */
532 /* Extract vlan tag */
533 if ((netdev->features & NETIF_F_HW_VLAN_CTAG_RX) &&
534 (csum_vlan & FTGMAC100_RXDES1_VLANTAG_AVAIL))
535 __vlan_hwaccel_put_tag(skb, htons(ETH_P_8021Q),
538 /* Tear down DMA mapping, do necessary cache management */
539 map = le32_to_cpu(rxdes->rxdes3);
541 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM_DMA_USE_IOMMU)
542 /* When we don't have an iommu, we can save cycles by not
543 * invalidating the cache for the part of the packet that
546 dma_unmap_single(priv->dev, map, size, DMA_FROM_DEVICE);
548 dma_unmap_single(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
552 /* Resplenish rx ring */
553 ftgmac100_alloc_rx_buf(priv, pointer, rxdes, GFP_ATOMIC);
554 priv->rx_pointer = ftgmac100_next_rx_pointer(priv, pointer);
556 skb->protocol = eth_type_trans(skb, netdev);
558 netdev->stats.rx_packets++;
559 netdev->stats.rx_bytes += size;
561 /* push packet to protocol stack */
562 if (skb->ip_summed == CHECKSUM_NONE)
563 netif_receive_skb(skb);
565 napi_gro_receive(&priv->napi, skb);
571 /* Clean rxdes0 (which resets own bit) */
572 rxdes->rxdes0 = cpu_to_le32(status & priv->rxdes0_edorr_mask);
573 priv->rx_pointer = ftgmac100_next_rx_pointer(priv, pointer);
574 netdev->stats.rx_dropped++;
578 static u32 ftgmac100_base_tx_ctlstat(struct ftgmac100 *priv,
581 if (index == (priv->tx_q_entries - 1))
582 return priv->txdes0_edotr_mask;
587 static unsigned int ftgmac100_next_tx_pointer(struct ftgmac100 *priv,
588 unsigned int pointer)
590 return (pointer + 1) & (priv->tx_q_entries - 1);
593 static u32 ftgmac100_tx_buf_avail(struct ftgmac100 *priv)
595 /* Returns the number of available slots in the TX queue
597 * This always leaves one free slot so we don't have to
598 * worry about empty vs. full, and this simplifies the
599 * test for ftgmac100_tx_buf_cleanable() below
601 return (priv->tx_clean_pointer - priv->tx_pointer - 1) &
602 (priv->tx_q_entries - 1);
605 static bool ftgmac100_tx_buf_cleanable(struct ftgmac100 *priv)
607 return priv->tx_pointer != priv->tx_clean_pointer;
610 static void ftgmac100_free_tx_packet(struct ftgmac100 *priv,
611 unsigned int pointer,
613 struct ftgmac100_txdes *txdes,
616 dma_addr_t map = le32_to_cpu(txdes->txdes3);
619 if (ctl_stat & FTGMAC100_TXDES0_FTS) {
620 len = skb_headlen(skb);
621 dma_unmap_single(priv->dev, map, len, DMA_TO_DEVICE);
623 len = FTGMAC100_TXDES0_TXBUF_SIZE(ctl_stat);
624 dma_unmap_page(priv->dev, map, len, DMA_TO_DEVICE);
627 /* Free SKB on last segment */
628 if (ctl_stat & FTGMAC100_TXDES0_LTS)
630 priv->tx_skbs[pointer] = NULL;
633 static bool ftgmac100_tx_complete_packet(struct ftgmac100 *priv)
635 struct net_device *netdev = priv->netdev;
636 struct ftgmac100_txdes *txdes;
638 unsigned int pointer;
641 pointer = priv->tx_clean_pointer;
642 txdes = &priv->txdes[pointer];
644 ctl_stat = le32_to_cpu(txdes->txdes0);
645 if (ctl_stat & FTGMAC100_TXDES0_TXDMA_OWN)
648 skb = priv->tx_skbs[pointer];
649 netdev->stats.tx_packets++;
650 netdev->stats.tx_bytes += skb->len;
651 ftgmac100_free_tx_packet(priv, pointer, skb, txdes, ctl_stat);
652 txdes->txdes0 = cpu_to_le32(ctl_stat & priv->txdes0_edotr_mask);
654 priv->tx_clean_pointer = ftgmac100_next_tx_pointer(priv, pointer);
659 static void ftgmac100_tx_complete(struct ftgmac100 *priv)
661 struct net_device *netdev = priv->netdev;
663 /* Process all completed packets */
664 while (ftgmac100_tx_buf_cleanable(priv) &&
665 ftgmac100_tx_complete_packet(priv))
668 /* Restart queue if needed */
670 if (unlikely(netif_queue_stopped(netdev) &&
671 ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)) {
672 struct netdev_queue *txq;
674 txq = netdev_get_tx_queue(netdev, 0);
675 __netif_tx_lock(txq, smp_processor_id());
676 if (netif_queue_stopped(netdev) &&
677 ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)
678 netif_wake_queue(netdev);
679 __netif_tx_unlock(txq);
683 static bool ftgmac100_prep_tx_csum(struct sk_buff *skb, u32 *csum_vlan)
685 if (skb->protocol == cpu_to_be16(ETH_P_IP)) {
686 u8 ip_proto = ip_hdr(skb)->protocol;
688 *csum_vlan |= FTGMAC100_TXDES1_IP_CHKSUM;
691 *csum_vlan |= FTGMAC100_TXDES1_TCP_CHKSUM;
694 *csum_vlan |= FTGMAC100_TXDES1_UDP_CHKSUM;
700 return skb_checksum_help(skb) == 0;
703 static netdev_tx_t ftgmac100_hard_start_xmit(struct sk_buff *skb,
704 struct net_device *netdev)
706 struct ftgmac100 *priv = netdev_priv(netdev);
707 struct ftgmac100_txdes *txdes, *first;
708 unsigned int pointer, nfrags, len, i, j;
709 u32 f_ctl_stat, ctl_stat, csum_vlan;
712 /* The HW doesn't pad small frames */
713 if (eth_skb_pad(skb)) {
714 netdev->stats.tx_dropped++;
718 /* Reject oversize packets */
719 if (unlikely(skb->len > MAX_PKT_SIZE)) {
721 netdev_dbg(netdev, "tx packet too big\n");
725 /* Do we have a limit on #fragments ? I yet have to get a reply
726 * from Aspeed. If there's one I haven't hit it.
728 nfrags = skb_shinfo(skb)->nr_frags;
731 len = skb_headlen(skb);
733 /* Map the packet head */
734 map = dma_map_single(priv->dev, skb->data, len, DMA_TO_DEVICE);
735 if (dma_mapping_error(priv->dev, map)) {
737 netdev_err(netdev, "map tx packet head failed\n");
741 /* Grab the next free tx descriptor */
742 pointer = priv->tx_pointer;
743 txdes = first = &priv->txdes[pointer];
745 /* Setup it up with the packet head. Don't write the head to the
748 priv->tx_skbs[pointer] = skb;
749 f_ctl_stat = ftgmac100_base_tx_ctlstat(priv, pointer);
750 f_ctl_stat |= FTGMAC100_TXDES0_TXDMA_OWN;
751 f_ctl_stat |= FTGMAC100_TXDES0_TXBUF_SIZE(len);
752 f_ctl_stat |= FTGMAC100_TXDES0_FTS;
754 f_ctl_stat |= FTGMAC100_TXDES0_LTS;
755 txdes->txdes3 = cpu_to_le32(map);
757 /* Setup HW checksumming */
759 if (skb->ip_summed == CHECKSUM_PARTIAL &&
760 !ftgmac100_prep_tx_csum(skb, &csum_vlan))
764 if (skb_vlan_tag_present(skb)) {
765 csum_vlan |= FTGMAC100_TXDES1_INS_VLANTAG;
766 csum_vlan |= skb_vlan_tag_get(skb) & 0xffff;
769 txdes->txdes1 = cpu_to_le32(csum_vlan);
771 /* Next descriptor */
772 pointer = ftgmac100_next_tx_pointer(priv, pointer);
774 /* Add the fragments */
775 for (i = 0; i < nfrags; i++) {
776 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
778 len = skb_frag_size(frag);
781 map = skb_frag_dma_map(priv->dev, frag, 0, len,
783 if (dma_mapping_error(priv->dev, map))
786 /* Setup descriptor */
787 priv->tx_skbs[pointer] = skb;
788 txdes = &priv->txdes[pointer];
789 ctl_stat = ftgmac100_base_tx_ctlstat(priv, pointer);
790 ctl_stat |= FTGMAC100_TXDES0_TXDMA_OWN;
791 ctl_stat |= FTGMAC100_TXDES0_TXBUF_SIZE(len);
792 if (i == (nfrags - 1))
793 ctl_stat |= FTGMAC100_TXDES0_LTS;
794 txdes->txdes0 = cpu_to_le32(ctl_stat);
796 txdes->txdes3 = cpu_to_le32(map);
799 pointer = ftgmac100_next_tx_pointer(priv, pointer);
802 /* Order the previous packet and descriptor udpates
803 * before setting the OWN bit on the first descriptor.
806 first->txdes0 = cpu_to_le32(f_ctl_stat);
808 /* Update next TX pointer */
809 priv->tx_pointer = pointer;
811 /* If there isn't enough room for all the fragments of a new packet
812 * in the TX ring, stop the queue. The sequence below is race free
813 * vs. a concurrent restart in ftgmac100_poll()
815 if (unlikely(ftgmac100_tx_buf_avail(priv) < TX_THRESHOLD)) {
816 netif_stop_queue(netdev);
817 /* Order the queue stop with the test below */
819 if (ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)
820 netif_wake_queue(netdev);
823 /* Poke transmitter to read the updated TX descriptors */
824 iowrite32(1, priv->base + FTGMAC100_OFFSET_NPTXPD);
830 netdev_err(netdev, "map tx fragment failed\n");
833 pointer = priv->tx_pointer;
834 ftgmac100_free_tx_packet(priv, pointer, skb, first, f_ctl_stat);
835 first->txdes0 = cpu_to_le32(f_ctl_stat & priv->txdes0_edotr_mask);
837 /* Then all fragments */
838 for (j = 0; j < i; j++) {
839 pointer = ftgmac100_next_tx_pointer(priv, pointer);
840 txdes = &priv->txdes[pointer];
841 ctl_stat = le32_to_cpu(txdes->txdes0);
842 ftgmac100_free_tx_packet(priv, pointer, skb, txdes, ctl_stat);
843 txdes->txdes0 = cpu_to_le32(ctl_stat & priv->txdes0_edotr_mask);
846 /* This cannot be reached if we successfully mapped the
847 * last fragment, so we know ftgmac100_free_tx_packet()
848 * hasn't freed the skb yet.
851 /* Drop the packet */
852 dev_kfree_skb_any(skb);
853 netdev->stats.tx_dropped++;
858 static void ftgmac100_free_buffers(struct ftgmac100 *priv)
862 /* Free all RX buffers */
863 for (i = 0; i < priv->rx_q_entries; i++) {
864 struct ftgmac100_rxdes *rxdes = &priv->rxdes[i];
865 struct sk_buff *skb = priv->rx_skbs[i];
866 dma_addr_t map = le32_to_cpu(rxdes->rxdes3);
871 priv->rx_skbs[i] = NULL;
872 dma_unmap_single(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
873 dev_kfree_skb_any(skb);
876 /* Free all TX buffers */
877 for (i = 0; i < priv->tx_q_entries; i++) {
878 struct ftgmac100_txdes *txdes = &priv->txdes[i];
879 struct sk_buff *skb = priv->tx_skbs[i];
883 ftgmac100_free_tx_packet(priv, i, skb, txdes,
884 le32_to_cpu(txdes->txdes0));
888 static void ftgmac100_free_rings(struct ftgmac100 *priv)
890 /* Free skb arrays */
891 kfree(priv->rx_skbs);
892 kfree(priv->tx_skbs);
894 /* Free descriptors */
896 dma_free_coherent(priv->dev, MAX_RX_QUEUE_ENTRIES *
897 sizeof(struct ftgmac100_rxdes),
898 priv->rxdes, priv->rxdes_dma);
902 dma_free_coherent(priv->dev, MAX_TX_QUEUE_ENTRIES *
903 sizeof(struct ftgmac100_txdes),
904 priv->txdes, priv->txdes_dma);
907 /* Free scratch packet buffer */
908 if (priv->rx_scratch)
909 dma_free_coherent(priv->dev, RX_BUF_SIZE,
910 priv->rx_scratch, priv->rx_scratch_dma);
913 static int ftgmac100_alloc_rings(struct ftgmac100 *priv)
915 /* Allocate skb arrays */
916 priv->rx_skbs = kcalloc(MAX_RX_QUEUE_ENTRIES, sizeof(void *),
920 priv->tx_skbs = kcalloc(MAX_TX_QUEUE_ENTRIES, sizeof(void *),
925 /* Allocate descriptors */
926 priv->rxdes = dma_alloc_coherent(priv->dev,
927 MAX_RX_QUEUE_ENTRIES * sizeof(struct ftgmac100_rxdes),
928 &priv->rxdes_dma, GFP_KERNEL);
931 priv->txdes = dma_alloc_coherent(priv->dev,
932 MAX_TX_QUEUE_ENTRIES * sizeof(struct ftgmac100_txdes),
933 &priv->txdes_dma, GFP_KERNEL);
937 /* Allocate scratch packet buffer */
938 priv->rx_scratch = dma_alloc_coherent(priv->dev,
940 &priv->rx_scratch_dma,
942 if (!priv->rx_scratch)
948 static void ftgmac100_init_rings(struct ftgmac100 *priv)
950 struct ftgmac100_rxdes *rxdes = NULL;
951 struct ftgmac100_txdes *txdes = NULL;
954 /* Update entries counts */
955 priv->rx_q_entries = priv->new_rx_q_entries;
956 priv->tx_q_entries = priv->new_tx_q_entries;
958 if (WARN_ON(priv->rx_q_entries < MIN_RX_QUEUE_ENTRIES))
961 /* Initialize RX ring */
962 for (i = 0; i < priv->rx_q_entries; i++) {
963 rxdes = &priv->rxdes[i];
965 rxdes->rxdes3 = cpu_to_le32(priv->rx_scratch_dma);
967 /* Mark the end of the ring */
968 rxdes->rxdes0 |= cpu_to_le32(priv->rxdes0_edorr_mask);
970 if (WARN_ON(priv->tx_q_entries < MIN_RX_QUEUE_ENTRIES))
973 /* Initialize TX ring */
974 for (i = 0; i < priv->tx_q_entries; i++) {
975 txdes = &priv->txdes[i];
978 txdes->txdes0 |= cpu_to_le32(priv->txdes0_edotr_mask);
981 static int ftgmac100_alloc_rx_buffers(struct ftgmac100 *priv)
985 for (i = 0; i < priv->rx_q_entries; i++) {
986 struct ftgmac100_rxdes *rxdes = &priv->rxdes[i];
988 if (ftgmac100_alloc_rx_buf(priv, i, rxdes, GFP_KERNEL))
994 static void ftgmac100_adjust_link(struct net_device *netdev)
996 struct ftgmac100 *priv = netdev_priv(netdev);
997 struct phy_device *phydev = netdev->phydev;
998 bool tx_pause, rx_pause;
1001 /* We store "no link" as speed 0 */
1005 new_speed = phydev->speed;
1007 /* Grab pause settings from PHY if configured to do so */
1008 if (priv->aneg_pause) {
1009 rx_pause = tx_pause = phydev->pause;
1010 if (phydev->asym_pause)
1011 tx_pause = !rx_pause;
1013 rx_pause = priv->rx_pause;
1014 tx_pause = priv->tx_pause;
1017 /* Link hasn't changed, do nothing */
1018 if (phydev->speed == priv->cur_speed &&
1019 phydev->duplex == priv->cur_duplex &&
1020 rx_pause == priv->rx_pause &&
1021 tx_pause == priv->tx_pause)
1024 /* Print status if we have a link or we had one and just lost it,
1025 * don't print otherwise.
1027 if (new_speed || priv->cur_speed)
1028 phy_print_status(phydev);
1030 priv->cur_speed = new_speed;
1031 priv->cur_duplex = phydev->duplex;
1032 priv->rx_pause = rx_pause;
1033 priv->tx_pause = tx_pause;
1035 /* Link is down, do nothing else */
1039 /* Disable all interrupts */
1040 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1042 /* Reset the adapter asynchronously */
1043 schedule_work(&priv->reset_task);
1046 static int ftgmac100_mii_probe(struct ftgmac100 *priv, phy_interface_t intf)
1048 struct net_device *netdev = priv->netdev;
1049 struct phy_device *phydev;
1051 phydev = phy_find_first(priv->mii_bus);
1053 netdev_info(netdev, "%s: no PHY found\n", netdev->name);
1057 phydev = phy_connect(netdev, phydev_name(phydev),
1058 &ftgmac100_adjust_link, intf);
1060 if (IS_ERR(phydev)) {
1061 netdev_err(netdev, "%s: Could not attach to PHY\n", netdev->name);
1062 return PTR_ERR(phydev);
1065 /* Indicate that we support PAUSE frames (see comment in
1066 * Documentation/networking/phy.rst)
1068 phy_support_asym_pause(phydev);
1070 /* Display what we found */
1071 phy_attached_info(phydev);
1076 static int ftgmac100_mdiobus_read(struct mii_bus *bus, int phy_addr, int regnum)
1078 struct net_device *netdev = bus->priv;
1079 struct ftgmac100 *priv = netdev_priv(netdev);
1083 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1085 /* preserve MDC cycle threshold */
1086 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
1088 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
1089 FTGMAC100_PHYCR_REGAD(regnum) |
1090 FTGMAC100_PHYCR_MIIRD;
1092 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
1094 for (i = 0; i < 10; i++) {
1095 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1097 if ((phycr & FTGMAC100_PHYCR_MIIRD) == 0) {
1100 data = ioread32(priv->base + FTGMAC100_OFFSET_PHYDATA);
1101 return FTGMAC100_PHYDATA_MIIRDATA(data);
1107 netdev_err(netdev, "mdio read timed out\n");
1111 static int ftgmac100_mdiobus_write(struct mii_bus *bus, int phy_addr,
1112 int regnum, u16 value)
1114 struct net_device *netdev = bus->priv;
1115 struct ftgmac100 *priv = netdev_priv(netdev);
1120 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1122 /* preserve MDC cycle threshold */
1123 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
1125 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
1126 FTGMAC100_PHYCR_REGAD(regnum) |
1127 FTGMAC100_PHYCR_MIIWR;
1129 data = FTGMAC100_PHYDATA_MIIWDATA(value);
1131 iowrite32(data, priv->base + FTGMAC100_OFFSET_PHYDATA);
1132 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
1134 for (i = 0; i < 10; i++) {
1135 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1137 if ((phycr & FTGMAC100_PHYCR_MIIWR) == 0)
1143 netdev_err(netdev, "mdio write timed out\n");
1147 static void ftgmac100_get_drvinfo(struct net_device *netdev,
1148 struct ethtool_drvinfo *info)
1150 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
1151 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
1152 strlcpy(info->bus_info, dev_name(&netdev->dev), sizeof(info->bus_info));
1155 static void ftgmac100_get_ringparam(struct net_device *netdev,
1156 struct ethtool_ringparam *ering)
1158 struct ftgmac100 *priv = netdev_priv(netdev);
1160 memset(ering, 0, sizeof(*ering));
1161 ering->rx_max_pending = MAX_RX_QUEUE_ENTRIES;
1162 ering->tx_max_pending = MAX_TX_QUEUE_ENTRIES;
1163 ering->rx_pending = priv->rx_q_entries;
1164 ering->tx_pending = priv->tx_q_entries;
1167 static int ftgmac100_set_ringparam(struct net_device *netdev,
1168 struct ethtool_ringparam *ering)
1170 struct ftgmac100 *priv = netdev_priv(netdev);
1172 if (ering->rx_pending > MAX_RX_QUEUE_ENTRIES ||
1173 ering->tx_pending > MAX_TX_QUEUE_ENTRIES ||
1174 ering->rx_pending < MIN_RX_QUEUE_ENTRIES ||
1175 ering->tx_pending < MIN_TX_QUEUE_ENTRIES ||
1176 !is_power_of_2(ering->rx_pending) ||
1177 !is_power_of_2(ering->tx_pending))
1180 priv->new_rx_q_entries = ering->rx_pending;
1181 priv->new_tx_q_entries = ering->tx_pending;
1182 if (netif_running(netdev))
1183 schedule_work(&priv->reset_task);
1188 static void ftgmac100_get_pauseparam(struct net_device *netdev,
1189 struct ethtool_pauseparam *pause)
1191 struct ftgmac100 *priv = netdev_priv(netdev);
1193 pause->autoneg = priv->aneg_pause;
1194 pause->tx_pause = priv->tx_pause;
1195 pause->rx_pause = priv->rx_pause;
1198 static int ftgmac100_set_pauseparam(struct net_device *netdev,
1199 struct ethtool_pauseparam *pause)
1201 struct ftgmac100 *priv = netdev_priv(netdev);
1202 struct phy_device *phydev = netdev->phydev;
1204 priv->aneg_pause = pause->autoneg;
1205 priv->tx_pause = pause->tx_pause;
1206 priv->rx_pause = pause->rx_pause;
1209 phy_set_asym_pause(phydev, pause->rx_pause, pause->tx_pause);
1211 if (netif_running(netdev)) {
1212 if (!(phydev && priv->aneg_pause))
1213 ftgmac100_config_pause(priv);
1219 static const struct ethtool_ops ftgmac100_ethtool_ops = {
1220 .get_drvinfo = ftgmac100_get_drvinfo,
1221 .get_link = ethtool_op_get_link,
1222 .get_link_ksettings = phy_ethtool_get_link_ksettings,
1223 .set_link_ksettings = phy_ethtool_set_link_ksettings,
1224 .nway_reset = phy_ethtool_nway_reset,
1225 .get_ringparam = ftgmac100_get_ringparam,
1226 .set_ringparam = ftgmac100_set_ringparam,
1227 .get_pauseparam = ftgmac100_get_pauseparam,
1228 .set_pauseparam = ftgmac100_set_pauseparam,
1231 static irqreturn_t ftgmac100_interrupt(int irq, void *dev_id)
1233 struct net_device *netdev = dev_id;
1234 struct ftgmac100 *priv = netdev_priv(netdev);
1235 unsigned int status, new_mask = FTGMAC100_INT_BAD;
1237 /* Fetch and clear interrupt bits, process abnormal ones */
1238 status = ioread32(priv->base + FTGMAC100_OFFSET_ISR);
1239 iowrite32(status, priv->base + FTGMAC100_OFFSET_ISR);
1240 if (unlikely(status & FTGMAC100_INT_BAD)) {
1242 /* RX buffer unavailable */
1243 if (status & FTGMAC100_INT_NO_RXBUF)
1244 netdev->stats.rx_over_errors++;
1246 /* received packet lost due to RX FIFO full */
1247 if (status & FTGMAC100_INT_RPKT_LOST)
1248 netdev->stats.rx_fifo_errors++;
1250 /* sent packet lost due to excessive TX collision */
1251 if (status & FTGMAC100_INT_XPKT_LOST)
1252 netdev->stats.tx_fifo_errors++;
1254 /* AHB error -> Reset the chip */
1255 if (status & FTGMAC100_INT_AHB_ERR) {
1256 if (net_ratelimit())
1258 "AHB bus error ! Resetting chip.\n");
1259 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1260 schedule_work(&priv->reset_task);
1264 /* We may need to restart the MAC after such errors, delay
1265 * this until after we have freed some Rx buffers though
1267 priv->need_mac_restart = true;
1269 /* Disable those errors until we restart */
1270 new_mask &= ~status;
1273 /* Only enable "bad" interrupts while NAPI is on */
1274 iowrite32(new_mask, priv->base + FTGMAC100_OFFSET_IER);
1276 /* Schedule NAPI bh */
1277 napi_schedule_irqoff(&priv->napi);
1282 static bool ftgmac100_check_rx(struct ftgmac100 *priv)
1284 struct ftgmac100_rxdes *rxdes = &priv->rxdes[priv->rx_pointer];
1286 /* Do we have a packet ? */
1287 return !!(rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RXPKT_RDY));
1290 static int ftgmac100_poll(struct napi_struct *napi, int budget)
1292 struct ftgmac100 *priv = container_of(napi, struct ftgmac100, napi);
1296 /* Handle TX completions */
1297 if (ftgmac100_tx_buf_cleanable(priv))
1298 ftgmac100_tx_complete(priv);
1300 /* Handle RX packets */
1302 more = ftgmac100_rx_packet(priv, &work_done);
1303 } while (more && work_done < budget);
1306 /* The interrupt is telling us to kick the MAC back to life
1307 * after an RX overflow
1309 if (unlikely(priv->need_mac_restart)) {
1310 ftgmac100_start_hw(priv);
1312 /* Re-enable "bad" interrupts */
1313 iowrite32(FTGMAC100_INT_BAD,
1314 priv->base + FTGMAC100_OFFSET_IER);
1317 /* As long as we are waiting for transmit packets to be
1318 * completed we keep NAPI going
1320 if (ftgmac100_tx_buf_cleanable(priv))
1323 if (work_done < budget) {
1324 /* We are about to re-enable all interrupts. However
1325 * the HW has been latching RX/TX packet interrupts while
1326 * they were masked. So we clear them first, then we need
1327 * to re-check if there's something to process
1329 iowrite32(FTGMAC100_INT_RXTX,
1330 priv->base + FTGMAC100_OFFSET_ISR);
1332 /* Push the above (and provides a barrier vs. subsequent
1333 * reads of the descriptor).
1335 ioread32(priv->base + FTGMAC100_OFFSET_ISR);
1337 /* Check RX and TX descriptors for more work to do */
1338 if (ftgmac100_check_rx(priv) ||
1339 ftgmac100_tx_buf_cleanable(priv))
1342 /* deschedule NAPI */
1343 napi_complete(napi);
1345 /* enable all interrupts */
1346 iowrite32(FTGMAC100_INT_ALL,
1347 priv->base + FTGMAC100_OFFSET_IER);
1353 static int ftgmac100_init_all(struct ftgmac100 *priv, bool ignore_alloc_err)
1357 /* Re-init descriptors (adjust queue sizes) */
1358 ftgmac100_init_rings(priv);
1360 /* Realloc rx descriptors */
1361 err = ftgmac100_alloc_rx_buffers(priv);
1362 if (err && !ignore_alloc_err)
1365 /* Reinit and restart HW */
1366 ftgmac100_init_hw(priv);
1367 ftgmac100_config_pause(priv);
1368 ftgmac100_start_hw(priv);
1370 /* Re-enable the device */
1371 napi_enable(&priv->napi);
1372 netif_start_queue(priv->netdev);
1374 /* Enable all interrupts */
1375 iowrite32(FTGMAC100_INT_ALL, priv->base + FTGMAC100_OFFSET_IER);
1380 static void ftgmac100_reset_task(struct work_struct *work)
1382 struct ftgmac100 *priv = container_of(work, struct ftgmac100,
1384 struct net_device *netdev = priv->netdev;
1387 netdev_dbg(netdev, "Resetting NIC...\n");
1389 /* Lock the world */
1392 mutex_lock(&netdev->phydev->lock);
1394 mutex_lock(&priv->mii_bus->mdio_lock);
1397 /* Check if the interface is still up */
1398 if (!netif_running(netdev))
1401 /* Stop the network stack */
1402 netif_trans_update(netdev);
1403 napi_disable(&priv->napi);
1404 netif_tx_disable(netdev);
1406 /* Stop and reset the MAC */
1407 ftgmac100_stop_hw(priv);
1408 err = ftgmac100_reset_and_config_mac(priv);
1410 /* Not much we can do ... it might come back... */
1411 netdev_err(netdev, "attempting to continue...\n");
1414 /* Free all rx and tx buffers */
1415 ftgmac100_free_buffers(priv);
1417 /* Setup everything again and restart chip */
1418 ftgmac100_init_all(priv, true);
1420 netdev_dbg(netdev, "Reset done !\n");
1423 mutex_unlock(&priv->mii_bus->mdio_lock);
1425 mutex_unlock(&netdev->phydev->lock);
1429 static int ftgmac100_open(struct net_device *netdev)
1431 struct ftgmac100 *priv = netdev_priv(netdev);
1434 /* Allocate ring buffers */
1435 err = ftgmac100_alloc_rings(priv);
1437 netdev_err(netdev, "Failed to allocate descriptors\n");
1441 /* When using NC-SI we force the speed to 100Mbit/s full duplex,
1443 * Otherwise we leave it set to 0 (no link), the link
1444 * message from the PHY layer will handle setting it up to
1445 * something else if needed.
1447 if (priv->use_ncsi) {
1448 priv->cur_duplex = DUPLEX_FULL;
1449 priv->cur_speed = SPEED_100;
1451 priv->cur_duplex = 0;
1452 priv->cur_speed = 0;
1455 /* Reset the hardware */
1456 err = ftgmac100_reset_and_config_mac(priv);
1460 /* Initialize NAPI */
1461 netif_napi_add(netdev, &priv->napi, ftgmac100_poll, 64);
1463 /* Grab our interrupt */
1464 err = request_irq(netdev->irq, ftgmac100_interrupt, 0, netdev->name, netdev);
1466 netdev_err(netdev, "failed to request irq %d\n", netdev->irq);
1470 /* Start things up */
1471 err = ftgmac100_init_all(priv, false);
1473 netdev_err(netdev, "Failed to allocate packet buffers\n");
1477 if (netdev->phydev) {
1478 /* If we have a PHY, start polling */
1479 phy_start(netdev->phydev);
1480 } else if (priv->use_ncsi) {
1481 /* If using NC-SI, set our carrier on and start the stack */
1482 netif_carrier_on(netdev);
1484 /* Start the NCSI device */
1485 err = ncsi_start_dev(priv->ndev);
1493 napi_disable(&priv->napi);
1494 netif_stop_queue(netdev);
1496 ftgmac100_free_buffers(priv);
1497 free_irq(netdev->irq, netdev);
1499 netif_napi_del(&priv->napi);
1501 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1502 ftgmac100_free_rings(priv);
1506 static int ftgmac100_stop(struct net_device *netdev)
1508 struct ftgmac100 *priv = netdev_priv(netdev);
1510 /* Note about the reset task: We are called with the rtnl lock
1511 * held, so we are synchronized against the core of the reset
1512 * task. We must not try to synchronously cancel it otherwise
1513 * we can deadlock. But since it will test for netif_running()
1514 * which has already been cleared by the net core, we don't
1515 * anything special to do.
1518 /* disable all interrupts */
1519 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1521 netif_stop_queue(netdev);
1522 napi_disable(&priv->napi);
1523 netif_napi_del(&priv->napi);
1525 phy_stop(netdev->phydev);
1526 else if (priv->use_ncsi)
1527 ncsi_stop_dev(priv->ndev);
1529 ftgmac100_stop_hw(priv);
1530 free_irq(netdev->irq, netdev);
1531 ftgmac100_free_buffers(priv);
1532 ftgmac100_free_rings(priv);
1538 static int ftgmac100_do_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
1540 if (!netdev->phydev)
1543 return phy_mii_ioctl(netdev->phydev, ifr, cmd);
1546 static void ftgmac100_tx_timeout(struct net_device *netdev)
1548 struct ftgmac100 *priv = netdev_priv(netdev);
1550 /* Disable all interrupts */
1551 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1553 /* Do the reset outside of interrupt context */
1554 schedule_work(&priv->reset_task);
1557 static int ftgmac100_set_features(struct net_device *netdev,
1558 netdev_features_t features)
1560 struct ftgmac100 *priv = netdev_priv(netdev);
1561 netdev_features_t changed = netdev->features ^ features;
1563 if (!netif_running(netdev))
1566 /* Update the vlan filtering bit */
1567 if (changed & NETIF_F_HW_VLAN_CTAG_RX) {
1570 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
1571 if (priv->netdev->features & NETIF_F_HW_VLAN_CTAG_RX)
1572 maccr |= FTGMAC100_MACCR_RM_VLAN;
1574 maccr &= ~FTGMAC100_MACCR_RM_VLAN;
1575 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
1581 #ifdef CONFIG_NET_POLL_CONTROLLER
1582 static void ftgmac100_poll_controller(struct net_device *netdev)
1584 unsigned long flags;
1586 local_irq_save(flags);
1587 ftgmac100_interrupt(netdev->irq, netdev);
1588 local_irq_restore(flags);
1592 static const struct net_device_ops ftgmac100_netdev_ops = {
1593 .ndo_open = ftgmac100_open,
1594 .ndo_stop = ftgmac100_stop,
1595 .ndo_start_xmit = ftgmac100_hard_start_xmit,
1596 .ndo_set_mac_address = ftgmac100_set_mac_addr,
1597 .ndo_validate_addr = eth_validate_addr,
1598 .ndo_do_ioctl = ftgmac100_do_ioctl,
1599 .ndo_tx_timeout = ftgmac100_tx_timeout,
1600 .ndo_set_rx_mode = ftgmac100_set_rx_mode,
1601 .ndo_set_features = ftgmac100_set_features,
1602 #ifdef CONFIG_NET_POLL_CONTROLLER
1603 .ndo_poll_controller = ftgmac100_poll_controller,
1605 .ndo_vlan_rx_add_vid = ncsi_vlan_rx_add_vid,
1606 .ndo_vlan_rx_kill_vid = ncsi_vlan_rx_kill_vid,
1609 static int ftgmac100_setup_mdio(struct net_device *netdev)
1611 struct ftgmac100 *priv = netdev_priv(netdev);
1612 struct platform_device *pdev = to_platform_device(priv->dev);
1613 int phy_intf = PHY_INTERFACE_MODE_RGMII;
1614 struct device_node *np = pdev->dev.of_node;
1618 /* initialize mdio bus */
1619 priv->mii_bus = mdiobus_alloc();
1623 if (of_device_is_compatible(np, "aspeed,ast2400-mac") ||
1624 of_device_is_compatible(np, "aspeed,ast2500-mac")) {
1625 /* The AST2600 has a separate MDIO controller */
1627 /* For the AST2400 and AST2500 this driver only supports the
1628 * old MDIO interface
1630 reg = ioread32(priv->base + FTGMAC100_OFFSET_REVR);
1631 reg &= ~FTGMAC100_REVR_NEW_MDIO_INTERFACE;
1632 iowrite32(reg, priv->base + FTGMAC100_OFFSET_REVR);
1635 /* Get PHY mode from device-tree */
1637 /* Default to RGMII. It's a gigabit part after all */
1638 phy_intf = of_get_phy_mode(np);
1640 phy_intf = PHY_INTERFACE_MODE_RGMII;
1642 /* Aspeed only supports these. I don't know about other IP
1643 * block vendors so I'm going to just let them through for
1644 * now. Note that this is only a warning if for some obscure
1645 * reason the DT really means to lie about it or it's a newer
1646 * part we don't know about.
1648 * On the Aspeed SoC there are additionally straps and SCU
1649 * control bits that could tell us what the interface is
1650 * (or allow us to configure it while the IP block is held
1651 * in reset). For now I chose to keep this driver away from
1652 * those SoC specific bits and assume the device-tree is
1653 * right and the SCU has been configured properly by pinmux
1656 if (priv->is_aspeed &&
1657 phy_intf != PHY_INTERFACE_MODE_RMII &&
1658 phy_intf != PHY_INTERFACE_MODE_RGMII &&
1659 phy_intf != PHY_INTERFACE_MODE_RGMII_ID &&
1660 phy_intf != PHY_INTERFACE_MODE_RGMII_RXID &&
1661 phy_intf != PHY_INTERFACE_MODE_RGMII_TXID) {
1663 "Unsupported PHY mode %s !\n",
1664 phy_modes(phy_intf));
1668 priv->mii_bus->name = "ftgmac100_mdio";
1669 snprintf(priv->mii_bus->id, MII_BUS_ID_SIZE, "%s-%d",
1670 pdev->name, pdev->id);
1671 priv->mii_bus->parent = priv->dev;
1672 priv->mii_bus->priv = priv->netdev;
1673 priv->mii_bus->read = ftgmac100_mdiobus_read;
1674 priv->mii_bus->write = ftgmac100_mdiobus_write;
1676 for (i = 0; i < PHY_MAX_ADDR; i++)
1677 priv->mii_bus->irq[i] = PHY_POLL;
1679 err = mdiobus_register(priv->mii_bus);
1681 dev_err(priv->dev, "Cannot register MDIO bus!\n");
1682 goto err_register_mdiobus;
1685 err = ftgmac100_mii_probe(priv, phy_intf);
1687 dev_err(priv->dev, "MII Probe failed!\n");
1694 mdiobus_unregister(priv->mii_bus);
1695 err_register_mdiobus:
1696 mdiobus_free(priv->mii_bus);
1700 static void ftgmac100_destroy_mdio(struct net_device *netdev)
1702 struct ftgmac100 *priv = netdev_priv(netdev);
1704 if (!netdev->phydev)
1707 phy_disconnect(netdev->phydev);
1708 mdiobus_unregister(priv->mii_bus);
1709 mdiobus_free(priv->mii_bus);
1712 static void ftgmac100_ncsi_handler(struct ncsi_dev *nd)
1714 if (unlikely(nd->state != ncsi_dev_state_functional))
1717 netdev_dbg(nd->dev, "NCSI interface %s\n",
1718 nd->link_up ? "up" : "down");
1721 static void ftgmac100_setup_clk(struct ftgmac100 *priv)
1723 priv->clk = devm_clk_get(priv->dev, NULL);
1724 if (IS_ERR(priv->clk))
1727 clk_prepare_enable(priv->clk);
1729 /* Aspeed specifies a 100MHz clock is required for up to
1730 * 1000Mbit link speeds. As NCSI is limited to 100Mbit, 25MHz
1733 clk_set_rate(priv->clk, priv->use_ncsi ? FTGMAC_25MHZ :
1737 static int ftgmac100_probe(struct platform_device *pdev)
1739 struct resource *res;
1741 struct net_device *netdev;
1742 struct ftgmac100 *priv;
1743 struct device_node *np;
1749 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1753 irq = platform_get_irq(pdev, 0);
1757 /* setup net_device */
1758 netdev = alloc_etherdev(sizeof(*priv));
1761 goto err_alloc_etherdev;
1764 SET_NETDEV_DEV(netdev, &pdev->dev);
1766 netdev->ethtool_ops = &ftgmac100_ethtool_ops;
1767 netdev->netdev_ops = &ftgmac100_netdev_ops;
1768 netdev->watchdog_timeo = 5 * HZ;
1770 platform_set_drvdata(pdev, netdev);
1772 /* setup private data */
1773 priv = netdev_priv(netdev);
1774 priv->netdev = netdev;
1775 priv->dev = &pdev->dev;
1776 INIT_WORK(&priv->reset_task, ftgmac100_reset_task);
1779 priv->res = request_mem_region(res->start, resource_size(res),
1780 dev_name(&pdev->dev));
1782 dev_err(&pdev->dev, "Could not reserve memory region\n");
1787 priv->base = ioremap(res->start, resource_size(res));
1789 dev_err(&pdev->dev, "Failed to ioremap ethernet registers\n");
1797 priv->tx_pause = true;
1798 priv->rx_pause = true;
1799 priv->aneg_pause = true;
1801 /* MAC address from chip or random one */
1802 ftgmac100_initial_mac(priv);
1804 np = pdev->dev.of_node;
1805 if (np && (of_device_is_compatible(np, "aspeed,ast2400-mac") ||
1806 of_device_is_compatible(np, "aspeed,ast2500-mac") ||
1807 of_device_is_compatible(np, "aspeed,ast2600-mac"))) {
1808 priv->rxdes0_edorr_mask = BIT(30);
1809 priv->txdes0_edotr_mask = BIT(30);
1810 priv->is_aspeed = true;
1812 priv->rxdes0_edorr_mask = BIT(15);
1813 priv->txdes0_edotr_mask = BIT(15);
1816 if (np && of_get_property(np, "use-ncsi", NULL)) {
1817 if (!IS_ENABLED(CONFIG_NET_NCSI)) {
1818 dev_err(&pdev->dev, "NCSI stack not enabled\n");
1822 dev_info(&pdev->dev, "Using NCSI interface\n");
1823 priv->use_ncsi = true;
1824 priv->ndev = ncsi_register_dev(netdev, ftgmac100_ncsi_handler);
1827 } else if (np && of_get_property(np, "phy-handle", NULL)) {
1828 struct phy_device *phy;
1830 phy = of_phy_get_and_connect(priv->netdev, np,
1831 &ftgmac100_adjust_link);
1833 dev_err(&pdev->dev, "Failed to connect to phy\n");
1834 goto err_setup_mdio;
1837 /* Indicate that we support PAUSE frames (see comment in
1838 * Documentation/networking/phy.txt)
1840 phy_support_asym_pause(phy);
1842 /* Display what we found */
1843 phy_attached_info(phy);
1844 } else if (np && !of_get_child_by_name(np, "mdio")) {
1845 /* Support legacy ASPEED devicetree descriptions that decribe a
1846 * MAC with an embedded MDIO controller but have no "mdio"
1847 * child node. Automatically scan the MDIO bus for available
1850 priv->use_ncsi = false;
1851 err = ftgmac100_setup_mdio(netdev);
1853 goto err_setup_mdio;
1856 if (priv->is_aspeed)
1857 ftgmac100_setup_clk(priv);
1859 /* Default ring sizes */
1860 priv->rx_q_entries = priv->new_rx_q_entries = DEF_RX_QUEUE_ENTRIES;
1861 priv->tx_q_entries = priv->new_tx_q_entries = DEF_TX_QUEUE_ENTRIES;
1863 /* Base feature set */
1864 netdev->hw_features = NETIF_F_RXCSUM | NETIF_F_HW_CSUM |
1865 NETIF_F_GRO | NETIF_F_SG | NETIF_F_HW_VLAN_CTAG_RX |
1866 NETIF_F_HW_VLAN_CTAG_TX;
1869 netdev->hw_features |= NETIF_F_HW_VLAN_CTAG_FILTER;
1871 /* AST2400 doesn't have working HW checksum generation */
1872 if (np && (of_device_is_compatible(np, "aspeed,ast2400-mac")))
1873 netdev->hw_features &= ~NETIF_F_HW_CSUM;
1874 if (np && of_get_property(np, "no-hw-checksum", NULL))
1875 netdev->hw_features &= ~(NETIF_F_HW_CSUM | NETIF_F_RXCSUM);
1876 netdev->features |= netdev->hw_features;
1878 /* register network device */
1879 err = register_netdev(netdev);
1881 dev_err(&pdev->dev, "Failed to register netdev\n");
1882 goto err_register_netdev;
1885 netdev_info(netdev, "irq %d, mapped at %p\n", netdev->irq, priv->base);
1890 err_register_netdev:
1891 ftgmac100_destroy_mdio(netdev);
1893 iounmap(priv->base);
1895 release_resource(priv->res);
1897 free_netdev(netdev);
1902 static int ftgmac100_remove(struct platform_device *pdev)
1904 struct net_device *netdev;
1905 struct ftgmac100 *priv;
1907 netdev = platform_get_drvdata(pdev);
1908 priv = netdev_priv(netdev);
1910 unregister_netdev(netdev);
1912 clk_disable_unprepare(priv->clk);
1914 /* There's a small chance the reset task will have been re-queued,
1915 * during stop, make sure it's gone before we free the structure.
1917 cancel_work_sync(&priv->reset_task);
1919 ftgmac100_destroy_mdio(netdev);
1921 iounmap(priv->base);
1922 release_resource(priv->res);
1924 netif_napi_del(&priv->napi);
1925 free_netdev(netdev);
1929 static const struct of_device_id ftgmac100_of_match[] = {
1930 { .compatible = "faraday,ftgmac100" },
1933 MODULE_DEVICE_TABLE(of, ftgmac100_of_match);
1935 static struct platform_driver ftgmac100_driver = {
1936 .probe = ftgmac100_probe,
1937 .remove = ftgmac100_remove,
1940 .of_match_table = ftgmac100_of_match,
1943 module_platform_driver(ftgmac100_driver);
1945 MODULE_AUTHOR("Po-Yu Chuang <ratbert@faraday-tech.com>");
1946 MODULE_DESCRIPTION("FTGMAC100 driver");
1947 MODULE_LICENSE("GPL");