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"
34 /* Arbitrary values, I am not sure the HW has limits */
35 #define MAX_RX_QUEUE_ENTRIES 1024
36 #define MAX_TX_QUEUE_ENTRIES 1024
37 #define MIN_RX_QUEUE_ENTRIES 32
38 #define MIN_TX_QUEUE_ENTRIES 32
41 #define DEF_RX_QUEUE_ENTRIES 128
42 #define DEF_TX_QUEUE_ENTRIES 128
44 #define MAX_PKT_SIZE 1536
45 #define RX_BUF_SIZE MAX_PKT_SIZE /* must be smaller than 0x3fff */
47 /* Min number of tx ring entries before stopping queue */
48 #define TX_THRESHOLD (MAX_SKB_FRAGS + 1)
50 #define FTGMAC_100MHZ 100000000
51 #define FTGMAC_25MHZ 25000000
59 unsigned int rx_q_entries;
60 struct ftgmac100_rxdes *rxdes;
62 struct sk_buff **rx_skbs;
63 unsigned int rx_pointer;
64 u32 rxdes0_edorr_mask;
67 unsigned int tx_q_entries;
68 struct ftgmac100_txdes *txdes;
70 struct sk_buff **tx_skbs;
71 unsigned int tx_clean_pointer;
72 unsigned int tx_pointer;
73 u32 txdes0_edotr_mask;
75 /* Used to signal the reset task of ring change request */
76 unsigned int new_rx_q_entries;
77 unsigned int new_tx_q_entries;
79 /* Scratch page to use when rx skb alloc fails */
81 dma_addr_t rx_scratch_dma;
83 /* Component structures */
84 struct net_device *netdev;
86 struct ncsi_dev *ndev;
87 struct napi_struct napi;
88 struct work_struct reset_task;
89 struct mii_bus *mii_bus;
92 /* AST2500/AST2600 RMII ref clock gate */
100 /* Multicast filter settings */
104 /* Flow control settings */
110 bool need_mac_restart;
114 static int ftgmac100_reset_mac(struct ftgmac100 *priv, u32 maccr)
116 struct net_device *netdev = priv->netdev;
119 /* NOTE: reset clears all registers */
120 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
121 iowrite32(maccr | FTGMAC100_MACCR_SW_RST,
122 priv->base + FTGMAC100_OFFSET_MACCR);
123 for (i = 0; i < 200; i++) {
126 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
127 if (!(maccr & FTGMAC100_MACCR_SW_RST))
133 netdev_err(netdev, "Hardware reset failed\n");
137 static int ftgmac100_reset_and_config_mac(struct ftgmac100 *priv)
141 switch (priv->cur_speed) {
143 case 0: /* no link */
147 maccr |= FTGMAC100_MACCR_FAST_MODE;
151 maccr |= FTGMAC100_MACCR_GIGA_MODE;
154 netdev_err(priv->netdev, "Unknown speed %d !\n",
159 /* (Re)initialize the queue pointers */
160 priv->rx_pointer = 0;
161 priv->tx_clean_pointer = 0;
162 priv->tx_pointer = 0;
164 /* The doc says reset twice with 10us interval */
165 if (ftgmac100_reset_mac(priv, maccr))
167 usleep_range(10, 1000);
168 return ftgmac100_reset_mac(priv, maccr);
171 static void ftgmac100_write_mac_addr(struct ftgmac100 *priv, const u8 *mac)
173 unsigned int maddr = mac[0] << 8 | mac[1];
174 unsigned int laddr = mac[2] << 24 | mac[3] << 16 | mac[4] << 8 | mac[5];
176 iowrite32(maddr, priv->base + FTGMAC100_OFFSET_MAC_MADR);
177 iowrite32(laddr, priv->base + FTGMAC100_OFFSET_MAC_LADR);
180 static void ftgmac100_initial_mac(struct ftgmac100 *priv)
186 if (!device_get_ethdev_address(priv->dev, priv->netdev)) {
187 dev_info(priv->dev, "Read MAC address %pM from device tree\n",
188 priv->netdev->dev_addr);
192 m = ioread32(priv->base + FTGMAC100_OFFSET_MAC_MADR);
193 l = ioread32(priv->base + FTGMAC100_OFFSET_MAC_LADR);
195 mac[0] = (m >> 8) & 0xff;
197 mac[2] = (l >> 24) & 0xff;
198 mac[3] = (l >> 16) & 0xff;
199 mac[4] = (l >> 8) & 0xff;
202 if (is_valid_ether_addr(mac)) {
203 eth_hw_addr_set(priv->netdev, mac);
204 dev_info(priv->dev, "Read MAC address %pM from chip\n", mac);
206 eth_hw_addr_random(priv->netdev);
207 dev_info(priv->dev, "Generated random MAC address %pM\n",
208 priv->netdev->dev_addr);
212 static int ftgmac100_set_mac_addr(struct net_device *dev, void *p)
216 ret = eth_prepare_mac_addr_change(dev, p);
220 eth_commit_mac_addr_change(dev, p);
221 ftgmac100_write_mac_addr(netdev_priv(dev), dev->dev_addr);
226 static void ftgmac100_config_pause(struct ftgmac100 *priv)
228 u32 fcr = FTGMAC100_FCR_PAUSE_TIME(16);
230 /* Throttle tx queue when receiving pause frames */
232 fcr |= FTGMAC100_FCR_FC_EN;
234 /* Enables sending pause frames when the RX queue is past a
238 fcr |= FTGMAC100_FCR_FCTHR_EN;
240 iowrite32(fcr, priv->base + FTGMAC100_OFFSET_FCR);
243 static void ftgmac100_init_hw(struct ftgmac100 *priv)
245 u32 reg, rfifo_sz, tfifo_sz;
247 /* Clear stale interrupts */
248 reg = ioread32(priv->base + FTGMAC100_OFFSET_ISR);
249 iowrite32(reg, priv->base + FTGMAC100_OFFSET_ISR);
251 /* Setup RX ring buffer base */
252 iowrite32(priv->rxdes_dma, priv->base + FTGMAC100_OFFSET_RXR_BADR);
254 /* Setup TX ring buffer base */
255 iowrite32(priv->txdes_dma, priv->base + FTGMAC100_OFFSET_NPTXR_BADR);
257 /* Configure RX buffer size */
258 iowrite32(FTGMAC100_RBSR_SIZE(RX_BUF_SIZE),
259 priv->base + FTGMAC100_OFFSET_RBSR);
261 /* Set RX descriptor autopoll */
262 iowrite32(FTGMAC100_APTC_RXPOLL_CNT(1),
263 priv->base + FTGMAC100_OFFSET_APTC);
265 /* Write MAC address */
266 ftgmac100_write_mac_addr(priv, priv->netdev->dev_addr);
268 /* Write multicast filter */
269 iowrite32(priv->maht0, priv->base + FTGMAC100_OFFSET_MAHT0);
270 iowrite32(priv->maht1, priv->base + FTGMAC100_OFFSET_MAHT1);
272 /* Configure descriptor sizes and increase burst sizes according
273 * to values in Aspeed SDK. The FIFO arbitration is enabled and
274 * the thresholds set based on the recommended values in the
275 * AST2400 specification.
277 iowrite32(FTGMAC100_DBLAC_RXDES_SIZE(2) | /* 2*8 bytes RX descs */
278 FTGMAC100_DBLAC_TXDES_SIZE(2) | /* 2*8 bytes TX descs */
279 FTGMAC100_DBLAC_RXBURST_SIZE(3) | /* 512 bytes max RX bursts */
280 FTGMAC100_DBLAC_TXBURST_SIZE(3) | /* 512 bytes max TX bursts */
281 FTGMAC100_DBLAC_RX_THR_EN | /* Enable fifo threshold arb */
282 FTGMAC100_DBLAC_RXFIFO_HTHR(6) | /* 6/8 of FIFO high threshold */
283 FTGMAC100_DBLAC_RXFIFO_LTHR(2), /* 2/8 of FIFO low threshold */
284 priv->base + FTGMAC100_OFFSET_DBLAC);
286 /* Interrupt mitigation configured for 1 interrupt/packet. HW interrupt
287 * mitigation doesn't seem to provide any benefit with NAPI so leave
290 iowrite32(FTGMAC100_ITC_RXINT_THR(1) |
291 FTGMAC100_ITC_TXINT_THR(1),
292 priv->base + FTGMAC100_OFFSET_ITC);
294 /* Configure FIFO sizes in the TPAFCR register */
295 reg = ioread32(priv->base + FTGMAC100_OFFSET_FEAR);
296 rfifo_sz = reg & 0x00000007;
297 tfifo_sz = (reg >> 3) & 0x00000007;
298 reg = ioread32(priv->base + FTGMAC100_OFFSET_TPAFCR);
300 reg |= (tfifo_sz << 27);
301 reg |= (rfifo_sz << 24);
302 iowrite32(reg, priv->base + FTGMAC100_OFFSET_TPAFCR);
305 static void ftgmac100_start_hw(struct ftgmac100 *priv)
307 u32 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
309 /* Keep the original GMAC and FAST bits */
310 maccr &= (FTGMAC100_MACCR_FAST_MODE | FTGMAC100_MACCR_GIGA_MODE);
312 /* Add all the main enable bits */
313 maccr |= FTGMAC100_MACCR_TXDMA_EN |
314 FTGMAC100_MACCR_RXDMA_EN |
315 FTGMAC100_MACCR_TXMAC_EN |
316 FTGMAC100_MACCR_RXMAC_EN |
317 FTGMAC100_MACCR_CRC_APD |
318 FTGMAC100_MACCR_PHY_LINK_LEVEL |
319 FTGMAC100_MACCR_RX_RUNT |
320 FTGMAC100_MACCR_RX_BROADPKT;
322 /* Add other bits as needed */
323 if (priv->cur_duplex == DUPLEX_FULL)
324 maccr |= FTGMAC100_MACCR_FULLDUP;
325 if (priv->netdev->flags & IFF_PROMISC)
326 maccr |= FTGMAC100_MACCR_RX_ALL;
327 if (priv->netdev->flags & IFF_ALLMULTI)
328 maccr |= FTGMAC100_MACCR_RX_MULTIPKT;
329 else if (netdev_mc_count(priv->netdev))
330 maccr |= FTGMAC100_MACCR_HT_MULTI_EN;
332 /* Vlan filtering enabled */
333 if (priv->netdev->features & NETIF_F_HW_VLAN_CTAG_RX)
334 maccr |= FTGMAC100_MACCR_RM_VLAN;
337 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
340 static void ftgmac100_stop_hw(struct ftgmac100 *priv)
342 iowrite32(0, priv->base + FTGMAC100_OFFSET_MACCR);
345 static void ftgmac100_calc_mc_hash(struct ftgmac100 *priv)
347 struct netdev_hw_addr *ha;
351 netdev_for_each_mc_addr(ha, priv->netdev) {
352 u32 crc_val = ether_crc_le(ETH_ALEN, ha->addr);
354 crc_val = (~(crc_val >> 2)) & 0x3f;
356 priv->maht1 |= 1ul << (crc_val - 32);
358 priv->maht0 |= 1ul << (crc_val);
362 static void ftgmac100_set_rx_mode(struct net_device *netdev)
364 struct ftgmac100 *priv = netdev_priv(netdev);
366 /* Setup the hash filter */
367 ftgmac100_calc_mc_hash(priv);
369 /* Interface down ? that's all there is to do */
370 if (!netif_running(netdev))
374 iowrite32(priv->maht0, priv->base + FTGMAC100_OFFSET_MAHT0);
375 iowrite32(priv->maht1, priv->base + FTGMAC100_OFFSET_MAHT1);
377 /* Reconfigure MACCR */
378 ftgmac100_start_hw(priv);
381 static int ftgmac100_alloc_rx_buf(struct ftgmac100 *priv, unsigned int entry,
382 struct ftgmac100_rxdes *rxdes, gfp_t gfp)
384 struct net_device *netdev = priv->netdev;
389 skb = netdev_alloc_skb_ip_align(netdev, RX_BUF_SIZE);
390 if (unlikely(!skb)) {
392 netdev_warn(netdev, "failed to allocate rx skb\n");
394 map = priv->rx_scratch_dma;
396 map = dma_map_single(priv->dev, skb->data, RX_BUF_SIZE,
398 if (unlikely(dma_mapping_error(priv->dev, map))) {
400 netdev_err(netdev, "failed to map rx page\n");
401 dev_kfree_skb_any(skb);
402 map = priv->rx_scratch_dma;
409 priv->rx_skbs[entry] = skb;
411 /* Store DMA address into RX desc */
412 rxdes->rxdes3 = cpu_to_le32(map);
414 /* Ensure the above is ordered vs clearing the OWN bit */
417 /* Clean status (which resets own bit) */
418 if (entry == (priv->rx_q_entries - 1))
419 rxdes->rxdes0 = cpu_to_le32(priv->rxdes0_edorr_mask);
426 static unsigned int ftgmac100_next_rx_pointer(struct ftgmac100 *priv,
427 unsigned int pointer)
429 return (pointer + 1) & (priv->rx_q_entries - 1);
432 static void ftgmac100_rx_packet_error(struct ftgmac100 *priv, u32 status)
434 struct net_device *netdev = priv->netdev;
436 if (status & FTGMAC100_RXDES0_RX_ERR)
437 netdev->stats.rx_errors++;
439 if (status & FTGMAC100_RXDES0_CRC_ERR)
440 netdev->stats.rx_crc_errors++;
442 if (status & (FTGMAC100_RXDES0_FTL |
443 FTGMAC100_RXDES0_RUNT |
444 FTGMAC100_RXDES0_RX_ODD_NB))
445 netdev->stats.rx_length_errors++;
448 static bool ftgmac100_rx_packet(struct ftgmac100 *priv, int *processed)
450 struct net_device *netdev = priv->netdev;
451 struct ftgmac100_rxdes *rxdes;
453 unsigned int pointer, size;
454 u32 status, csum_vlan;
457 /* Grab next RX descriptor */
458 pointer = priv->rx_pointer;
459 rxdes = &priv->rxdes[pointer];
461 /* Grab descriptor status */
462 status = le32_to_cpu(rxdes->rxdes0);
464 /* Do we have a packet ? */
465 if (!(status & FTGMAC100_RXDES0_RXPKT_RDY))
468 /* Order subsequent reads with the test for the ready bit */
471 /* We don't cope with fragmented RX packets */
472 if (unlikely(!(status & FTGMAC100_RXDES0_FRS) ||
473 !(status & FTGMAC100_RXDES0_LRS)))
476 /* Grab received size and csum vlan field in the descriptor */
477 size = status & FTGMAC100_RXDES0_VDBC;
478 csum_vlan = le32_to_cpu(rxdes->rxdes1);
480 /* Any error (other than csum offload) flagged ? */
481 if (unlikely(status & RXDES0_ANY_ERROR)) {
482 /* Correct for incorrect flagging of runt packets
483 * with vlan tags... Just accept a runt packet that
484 * has been flagged as vlan and whose size is at
487 if ((status & FTGMAC100_RXDES0_RUNT) &&
488 (csum_vlan & FTGMAC100_RXDES1_VLANTAG_AVAIL) &&
490 status &= ~FTGMAC100_RXDES0_RUNT;
492 /* Any error still in there ? */
493 if (status & RXDES0_ANY_ERROR) {
494 ftgmac100_rx_packet_error(priv, status);
499 /* If the packet had no skb (failed to allocate earlier)
500 * then try to allocate one and skip
502 skb = priv->rx_skbs[pointer];
503 if (!unlikely(skb)) {
504 ftgmac100_alloc_rx_buf(priv, pointer, rxdes, GFP_ATOMIC);
508 if (unlikely(status & FTGMAC100_RXDES0_MULTICAST))
509 netdev->stats.multicast++;
511 /* If the HW found checksum errors, bounce it to software.
513 * If we didn't, we need to see if the packet was recognized
514 * by HW as one of the supported checksummed protocols before
515 * we accept the HW test results.
517 if (netdev->features & NETIF_F_RXCSUM) {
518 u32 err_bits = FTGMAC100_RXDES1_TCP_CHKSUM_ERR |
519 FTGMAC100_RXDES1_UDP_CHKSUM_ERR |
520 FTGMAC100_RXDES1_IP_CHKSUM_ERR;
521 if ((csum_vlan & err_bits) ||
522 !(csum_vlan & FTGMAC100_RXDES1_PROT_MASK))
523 skb->ip_summed = CHECKSUM_NONE;
525 skb->ip_summed = CHECKSUM_UNNECESSARY;
528 /* Transfer received size to skb */
531 /* Extract vlan tag */
532 if ((netdev->features & NETIF_F_HW_VLAN_CTAG_RX) &&
533 (csum_vlan & FTGMAC100_RXDES1_VLANTAG_AVAIL))
534 __vlan_hwaccel_put_tag(skb, htons(ETH_P_8021Q),
537 /* Tear down DMA mapping, do necessary cache management */
538 map = le32_to_cpu(rxdes->rxdes3);
540 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM_DMA_USE_IOMMU)
541 /* When we don't have an iommu, we can save cycles by not
542 * invalidating the cache for the part of the packet that
545 dma_unmap_single(priv->dev, map, size, DMA_FROM_DEVICE);
547 dma_unmap_single(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
551 /* Resplenish rx ring */
552 ftgmac100_alloc_rx_buf(priv, pointer, rxdes, GFP_ATOMIC);
553 priv->rx_pointer = ftgmac100_next_rx_pointer(priv, pointer);
555 skb->protocol = eth_type_trans(skb, netdev);
557 netdev->stats.rx_packets++;
558 netdev->stats.rx_bytes += size;
560 /* push packet to protocol stack */
561 if (skb->ip_summed == CHECKSUM_NONE)
562 netif_receive_skb(skb);
564 napi_gro_receive(&priv->napi, skb);
570 /* Clean rxdes0 (which resets own bit) */
571 rxdes->rxdes0 = cpu_to_le32(status & priv->rxdes0_edorr_mask);
572 priv->rx_pointer = ftgmac100_next_rx_pointer(priv, pointer);
573 netdev->stats.rx_dropped++;
577 static u32 ftgmac100_base_tx_ctlstat(struct ftgmac100 *priv,
580 if (index == (priv->tx_q_entries - 1))
581 return priv->txdes0_edotr_mask;
586 static unsigned int ftgmac100_next_tx_pointer(struct ftgmac100 *priv,
587 unsigned int pointer)
589 return (pointer + 1) & (priv->tx_q_entries - 1);
592 static u32 ftgmac100_tx_buf_avail(struct ftgmac100 *priv)
594 /* Returns the number of available slots in the TX queue
596 * This always leaves one free slot so we don't have to
597 * worry about empty vs. full, and this simplifies the
598 * test for ftgmac100_tx_buf_cleanable() below
600 return (priv->tx_clean_pointer - priv->tx_pointer - 1) &
601 (priv->tx_q_entries - 1);
604 static bool ftgmac100_tx_buf_cleanable(struct ftgmac100 *priv)
606 return priv->tx_pointer != priv->tx_clean_pointer;
609 static void ftgmac100_free_tx_packet(struct ftgmac100 *priv,
610 unsigned int pointer,
612 struct ftgmac100_txdes *txdes,
615 dma_addr_t map = le32_to_cpu(txdes->txdes3);
618 if (ctl_stat & FTGMAC100_TXDES0_FTS) {
619 len = skb_headlen(skb);
620 dma_unmap_single(priv->dev, map, len, DMA_TO_DEVICE);
622 len = FTGMAC100_TXDES0_TXBUF_SIZE(ctl_stat);
623 dma_unmap_page(priv->dev, map, len, DMA_TO_DEVICE);
626 /* Free SKB on last segment */
627 if (ctl_stat & FTGMAC100_TXDES0_LTS)
629 priv->tx_skbs[pointer] = NULL;
632 static bool ftgmac100_tx_complete_packet(struct ftgmac100 *priv)
634 struct net_device *netdev = priv->netdev;
635 struct ftgmac100_txdes *txdes;
637 unsigned int pointer;
640 pointer = priv->tx_clean_pointer;
641 txdes = &priv->txdes[pointer];
643 ctl_stat = le32_to_cpu(txdes->txdes0);
644 if (ctl_stat & FTGMAC100_TXDES0_TXDMA_OWN)
647 skb = priv->tx_skbs[pointer];
648 netdev->stats.tx_packets++;
649 netdev->stats.tx_bytes += skb->len;
650 ftgmac100_free_tx_packet(priv, pointer, skb, txdes, ctl_stat);
651 txdes->txdes0 = cpu_to_le32(ctl_stat & priv->txdes0_edotr_mask);
653 priv->tx_clean_pointer = ftgmac100_next_tx_pointer(priv, pointer);
658 static void ftgmac100_tx_complete(struct ftgmac100 *priv)
660 struct net_device *netdev = priv->netdev;
662 /* Process all completed packets */
663 while (ftgmac100_tx_buf_cleanable(priv) &&
664 ftgmac100_tx_complete_packet(priv))
667 /* Restart queue if needed */
669 if (unlikely(netif_queue_stopped(netdev) &&
670 ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)) {
671 struct netdev_queue *txq;
673 txq = netdev_get_tx_queue(netdev, 0);
674 __netif_tx_lock(txq, smp_processor_id());
675 if (netif_queue_stopped(netdev) &&
676 ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)
677 netif_wake_queue(netdev);
678 __netif_tx_unlock(txq);
682 static bool ftgmac100_prep_tx_csum(struct sk_buff *skb, u32 *csum_vlan)
684 if (skb->protocol == cpu_to_be16(ETH_P_IP)) {
685 u8 ip_proto = ip_hdr(skb)->protocol;
687 *csum_vlan |= FTGMAC100_TXDES1_IP_CHKSUM;
690 *csum_vlan |= FTGMAC100_TXDES1_TCP_CHKSUM;
693 *csum_vlan |= FTGMAC100_TXDES1_UDP_CHKSUM;
699 return skb_checksum_help(skb) == 0;
702 static netdev_tx_t ftgmac100_hard_start_xmit(struct sk_buff *skb,
703 struct net_device *netdev)
705 struct ftgmac100 *priv = netdev_priv(netdev);
706 struct ftgmac100_txdes *txdes, *first;
707 unsigned int pointer, nfrags, len, i, j;
708 u32 f_ctl_stat, ctl_stat, csum_vlan;
711 /* The HW doesn't pad small frames */
712 if (eth_skb_pad(skb)) {
713 netdev->stats.tx_dropped++;
717 /* Reject oversize packets */
718 if (unlikely(skb->len > MAX_PKT_SIZE)) {
720 netdev_dbg(netdev, "tx packet too big\n");
724 /* Do we have a limit on #fragments ? I yet have to get a reply
725 * from Aspeed. If there's one I haven't hit it.
727 nfrags = skb_shinfo(skb)->nr_frags;
729 /* Setup HW checksumming */
731 if (skb->ip_summed == CHECKSUM_PARTIAL &&
732 !ftgmac100_prep_tx_csum(skb, &csum_vlan))
736 if (skb_vlan_tag_present(skb)) {
737 csum_vlan |= FTGMAC100_TXDES1_INS_VLANTAG;
738 csum_vlan |= skb_vlan_tag_get(skb) & 0xffff;
742 len = skb_headlen(skb);
744 /* Map the packet head */
745 map = dma_map_single(priv->dev, skb->data, len, DMA_TO_DEVICE);
746 if (dma_mapping_error(priv->dev, map)) {
748 netdev_err(netdev, "map tx packet head failed\n");
752 /* Grab the next free tx descriptor */
753 pointer = priv->tx_pointer;
754 txdes = first = &priv->txdes[pointer];
756 /* Setup it up with the packet head. Don't write the head to the
759 priv->tx_skbs[pointer] = skb;
760 f_ctl_stat = ftgmac100_base_tx_ctlstat(priv, pointer);
761 f_ctl_stat |= FTGMAC100_TXDES0_TXDMA_OWN;
762 f_ctl_stat |= FTGMAC100_TXDES0_TXBUF_SIZE(len);
763 f_ctl_stat |= FTGMAC100_TXDES0_FTS;
765 f_ctl_stat |= FTGMAC100_TXDES0_LTS;
766 txdes->txdes3 = cpu_to_le32(map);
767 txdes->txdes1 = cpu_to_le32(csum_vlan);
769 /* Next descriptor */
770 pointer = ftgmac100_next_tx_pointer(priv, pointer);
772 /* Add the fragments */
773 for (i = 0; i < nfrags; i++) {
774 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
776 len = skb_frag_size(frag);
779 map = skb_frag_dma_map(priv->dev, frag, 0, len,
781 if (dma_mapping_error(priv->dev, map))
784 /* Setup descriptor */
785 priv->tx_skbs[pointer] = skb;
786 txdes = &priv->txdes[pointer];
787 ctl_stat = ftgmac100_base_tx_ctlstat(priv, pointer);
788 ctl_stat |= FTGMAC100_TXDES0_TXDMA_OWN;
789 ctl_stat |= FTGMAC100_TXDES0_TXBUF_SIZE(len);
790 if (i == (nfrags - 1))
791 ctl_stat |= FTGMAC100_TXDES0_LTS;
792 txdes->txdes0 = cpu_to_le32(ctl_stat);
794 txdes->txdes3 = cpu_to_le32(map);
797 pointer = ftgmac100_next_tx_pointer(priv, pointer);
800 /* Order the previous packet and descriptor udpates
801 * before setting the OWN bit on the first descriptor.
804 first->txdes0 = cpu_to_le32(f_ctl_stat);
806 /* Update next TX pointer */
807 priv->tx_pointer = pointer;
809 /* If there isn't enough room for all the fragments of a new packet
810 * in the TX ring, stop the queue. The sequence below is race free
811 * vs. a concurrent restart in ftgmac100_poll()
813 if (unlikely(ftgmac100_tx_buf_avail(priv) < TX_THRESHOLD)) {
814 netif_stop_queue(netdev);
815 /* Order the queue stop with the test below */
817 if (ftgmac100_tx_buf_avail(priv) >= TX_THRESHOLD)
818 netif_wake_queue(netdev);
821 /* Poke transmitter to read the updated TX descriptors */
822 iowrite32(1, priv->base + FTGMAC100_OFFSET_NPTXPD);
828 netdev_err(netdev, "map tx fragment failed\n");
831 pointer = priv->tx_pointer;
832 ftgmac100_free_tx_packet(priv, pointer, skb, first, f_ctl_stat);
833 first->txdes0 = cpu_to_le32(f_ctl_stat & priv->txdes0_edotr_mask);
835 /* Then all fragments */
836 for (j = 0; j < i; j++) {
837 pointer = ftgmac100_next_tx_pointer(priv, pointer);
838 txdes = &priv->txdes[pointer];
839 ctl_stat = le32_to_cpu(txdes->txdes0);
840 ftgmac100_free_tx_packet(priv, pointer, skb, txdes, ctl_stat);
841 txdes->txdes0 = cpu_to_le32(ctl_stat & priv->txdes0_edotr_mask);
844 /* This cannot be reached if we successfully mapped the
845 * last fragment, so we know ftgmac100_free_tx_packet()
846 * hasn't freed the skb yet.
849 /* Drop the packet */
850 dev_kfree_skb_any(skb);
851 netdev->stats.tx_dropped++;
856 static void ftgmac100_free_buffers(struct ftgmac100 *priv)
860 /* Free all RX buffers */
861 for (i = 0; i < priv->rx_q_entries; i++) {
862 struct ftgmac100_rxdes *rxdes = &priv->rxdes[i];
863 struct sk_buff *skb = priv->rx_skbs[i];
864 dma_addr_t map = le32_to_cpu(rxdes->rxdes3);
869 priv->rx_skbs[i] = NULL;
870 dma_unmap_single(priv->dev, map, RX_BUF_SIZE, DMA_FROM_DEVICE);
871 dev_kfree_skb_any(skb);
874 /* Free all TX buffers */
875 for (i = 0; i < priv->tx_q_entries; i++) {
876 struct ftgmac100_txdes *txdes = &priv->txdes[i];
877 struct sk_buff *skb = priv->tx_skbs[i];
881 ftgmac100_free_tx_packet(priv, i, skb, txdes,
882 le32_to_cpu(txdes->txdes0));
886 static void ftgmac100_free_rings(struct ftgmac100 *priv)
888 /* Free skb arrays */
889 kfree(priv->rx_skbs);
890 kfree(priv->tx_skbs);
892 /* Free descriptors */
894 dma_free_coherent(priv->dev, MAX_RX_QUEUE_ENTRIES *
895 sizeof(struct ftgmac100_rxdes),
896 priv->rxdes, priv->rxdes_dma);
900 dma_free_coherent(priv->dev, MAX_TX_QUEUE_ENTRIES *
901 sizeof(struct ftgmac100_txdes),
902 priv->txdes, priv->txdes_dma);
905 /* Free scratch packet buffer */
906 if (priv->rx_scratch)
907 dma_free_coherent(priv->dev, RX_BUF_SIZE,
908 priv->rx_scratch, priv->rx_scratch_dma);
911 static int ftgmac100_alloc_rings(struct ftgmac100 *priv)
913 /* Allocate skb arrays */
914 priv->rx_skbs = kcalloc(MAX_RX_QUEUE_ENTRIES, sizeof(void *),
918 priv->tx_skbs = kcalloc(MAX_TX_QUEUE_ENTRIES, sizeof(void *),
923 /* Allocate descriptors */
924 priv->rxdes = dma_alloc_coherent(priv->dev,
925 MAX_RX_QUEUE_ENTRIES * sizeof(struct ftgmac100_rxdes),
926 &priv->rxdes_dma, GFP_KERNEL);
929 priv->txdes = dma_alloc_coherent(priv->dev,
930 MAX_TX_QUEUE_ENTRIES * sizeof(struct ftgmac100_txdes),
931 &priv->txdes_dma, GFP_KERNEL);
935 /* Allocate scratch packet buffer */
936 priv->rx_scratch = dma_alloc_coherent(priv->dev,
938 &priv->rx_scratch_dma,
940 if (!priv->rx_scratch)
946 static void ftgmac100_init_rings(struct ftgmac100 *priv)
948 struct ftgmac100_rxdes *rxdes = NULL;
949 struct ftgmac100_txdes *txdes = NULL;
952 /* Update entries counts */
953 priv->rx_q_entries = priv->new_rx_q_entries;
954 priv->tx_q_entries = priv->new_tx_q_entries;
956 if (WARN_ON(priv->rx_q_entries < MIN_RX_QUEUE_ENTRIES))
959 /* Initialize RX ring */
960 for (i = 0; i < priv->rx_q_entries; i++) {
961 rxdes = &priv->rxdes[i];
963 rxdes->rxdes3 = cpu_to_le32(priv->rx_scratch_dma);
965 /* Mark the end of the ring */
966 rxdes->rxdes0 |= cpu_to_le32(priv->rxdes0_edorr_mask);
968 if (WARN_ON(priv->tx_q_entries < MIN_RX_QUEUE_ENTRIES))
971 /* Initialize TX ring */
972 for (i = 0; i < priv->tx_q_entries; i++) {
973 txdes = &priv->txdes[i];
976 txdes->txdes0 |= cpu_to_le32(priv->txdes0_edotr_mask);
979 static int ftgmac100_alloc_rx_buffers(struct ftgmac100 *priv)
983 for (i = 0; i < priv->rx_q_entries; i++) {
984 struct ftgmac100_rxdes *rxdes = &priv->rxdes[i];
986 if (ftgmac100_alloc_rx_buf(priv, i, rxdes, GFP_KERNEL))
992 static void ftgmac100_adjust_link(struct net_device *netdev)
994 struct ftgmac100 *priv = netdev_priv(netdev);
995 struct phy_device *phydev = netdev->phydev;
996 bool tx_pause, rx_pause;
999 /* We store "no link" as speed 0 */
1003 new_speed = phydev->speed;
1005 /* Grab pause settings from PHY if configured to do so */
1006 if (priv->aneg_pause) {
1007 rx_pause = tx_pause = phydev->pause;
1008 if (phydev->asym_pause)
1009 tx_pause = !rx_pause;
1011 rx_pause = priv->rx_pause;
1012 tx_pause = priv->tx_pause;
1015 /* Link hasn't changed, do nothing */
1016 if (phydev->speed == priv->cur_speed &&
1017 phydev->duplex == priv->cur_duplex &&
1018 rx_pause == priv->rx_pause &&
1019 tx_pause == priv->tx_pause)
1022 /* Print status if we have a link or we had one and just lost it,
1023 * don't print otherwise.
1025 if (new_speed || priv->cur_speed)
1026 phy_print_status(phydev);
1028 priv->cur_speed = new_speed;
1029 priv->cur_duplex = phydev->duplex;
1030 priv->rx_pause = rx_pause;
1031 priv->tx_pause = tx_pause;
1033 /* Link is down, do nothing else */
1037 /* Disable all interrupts */
1038 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1040 /* Reset the adapter asynchronously */
1041 schedule_work(&priv->reset_task);
1044 static int ftgmac100_mii_probe(struct net_device *netdev)
1046 struct ftgmac100 *priv = netdev_priv(netdev);
1047 struct platform_device *pdev = to_platform_device(priv->dev);
1048 struct device_node *np = pdev->dev.of_node;
1049 struct phy_device *phydev;
1050 phy_interface_t phy_intf;
1053 /* Default to RGMII. It's a gigabit part after all */
1054 err = of_get_phy_mode(np, &phy_intf);
1056 phy_intf = PHY_INTERFACE_MODE_RGMII;
1058 /* Aspeed only supports these. I don't know about other IP
1059 * block vendors so I'm going to just let them through for
1060 * now. Note that this is only a warning if for some obscure
1061 * reason the DT really means to lie about it or it's a newer
1062 * part we don't know about.
1064 * On the Aspeed SoC there are additionally straps and SCU
1065 * control bits that could tell us what the interface is
1066 * (or allow us to configure it while the IP block is held
1067 * in reset). For now I chose to keep this driver away from
1068 * those SoC specific bits and assume the device-tree is
1069 * right and the SCU has been configured properly by pinmux
1072 if (priv->is_aspeed && !(phy_interface_mode_is_rgmii(phy_intf))) {
1074 "Unsupported PHY mode %s !\n",
1075 phy_modes(phy_intf));
1078 phydev = phy_find_first(priv->mii_bus);
1080 netdev_info(netdev, "%s: no PHY found\n", netdev->name);
1084 phydev = phy_connect(netdev, phydev_name(phydev),
1085 &ftgmac100_adjust_link, phy_intf);
1087 if (IS_ERR(phydev)) {
1088 netdev_err(netdev, "%s: Could not attach to PHY\n", netdev->name);
1089 return PTR_ERR(phydev);
1092 /* Indicate that we support PAUSE frames (see comment in
1093 * Documentation/networking/phy.rst)
1095 phy_support_asym_pause(phydev);
1097 /* Display what we found */
1098 phy_attached_info(phydev);
1103 static int ftgmac100_mdiobus_read(struct mii_bus *bus, int phy_addr, int regnum)
1105 struct net_device *netdev = bus->priv;
1106 struct ftgmac100 *priv = netdev_priv(netdev);
1110 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1112 /* preserve MDC cycle threshold */
1113 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
1115 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
1116 FTGMAC100_PHYCR_REGAD(regnum) |
1117 FTGMAC100_PHYCR_MIIRD;
1119 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
1121 for (i = 0; i < 10; i++) {
1122 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1124 if ((phycr & FTGMAC100_PHYCR_MIIRD) == 0) {
1127 data = ioread32(priv->base + FTGMAC100_OFFSET_PHYDATA);
1128 return FTGMAC100_PHYDATA_MIIRDATA(data);
1134 netdev_err(netdev, "mdio read timed out\n");
1138 static int ftgmac100_mdiobus_write(struct mii_bus *bus, int phy_addr,
1139 int regnum, u16 value)
1141 struct net_device *netdev = bus->priv;
1142 struct ftgmac100 *priv = netdev_priv(netdev);
1147 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1149 /* preserve MDC cycle threshold */
1150 phycr &= FTGMAC100_PHYCR_MDC_CYCTHR_MASK;
1152 phycr |= FTGMAC100_PHYCR_PHYAD(phy_addr) |
1153 FTGMAC100_PHYCR_REGAD(regnum) |
1154 FTGMAC100_PHYCR_MIIWR;
1156 data = FTGMAC100_PHYDATA_MIIWDATA(value);
1158 iowrite32(data, priv->base + FTGMAC100_OFFSET_PHYDATA);
1159 iowrite32(phycr, priv->base + FTGMAC100_OFFSET_PHYCR);
1161 for (i = 0; i < 10; i++) {
1162 phycr = ioread32(priv->base + FTGMAC100_OFFSET_PHYCR);
1164 if ((phycr & FTGMAC100_PHYCR_MIIWR) == 0)
1170 netdev_err(netdev, "mdio write timed out\n");
1174 static void ftgmac100_get_drvinfo(struct net_device *netdev,
1175 struct ethtool_drvinfo *info)
1177 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
1178 strlcpy(info->bus_info, dev_name(&netdev->dev), sizeof(info->bus_info));
1182 ftgmac100_get_ringparam(struct net_device *netdev,
1183 struct ethtool_ringparam *ering,
1184 struct kernel_ethtool_ringparam *kernel_ering,
1185 struct netlink_ext_ack *extack)
1187 struct ftgmac100 *priv = netdev_priv(netdev);
1189 memset(ering, 0, sizeof(*ering));
1190 ering->rx_max_pending = MAX_RX_QUEUE_ENTRIES;
1191 ering->tx_max_pending = MAX_TX_QUEUE_ENTRIES;
1192 ering->rx_pending = priv->rx_q_entries;
1193 ering->tx_pending = priv->tx_q_entries;
1197 ftgmac100_set_ringparam(struct net_device *netdev,
1198 struct ethtool_ringparam *ering,
1199 struct kernel_ethtool_ringparam *kernel_ering,
1200 struct netlink_ext_ack *extack)
1202 struct ftgmac100 *priv = netdev_priv(netdev);
1204 if (ering->rx_pending > MAX_RX_QUEUE_ENTRIES ||
1205 ering->tx_pending > MAX_TX_QUEUE_ENTRIES ||
1206 ering->rx_pending < MIN_RX_QUEUE_ENTRIES ||
1207 ering->tx_pending < MIN_TX_QUEUE_ENTRIES ||
1208 !is_power_of_2(ering->rx_pending) ||
1209 !is_power_of_2(ering->tx_pending))
1212 priv->new_rx_q_entries = ering->rx_pending;
1213 priv->new_tx_q_entries = ering->tx_pending;
1214 if (netif_running(netdev))
1215 schedule_work(&priv->reset_task);
1220 static void ftgmac100_get_pauseparam(struct net_device *netdev,
1221 struct ethtool_pauseparam *pause)
1223 struct ftgmac100 *priv = netdev_priv(netdev);
1225 pause->autoneg = priv->aneg_pause;
1226 pause->tx_pause = priv->tx_pause;
1227 pause->rx_pause = priv->rx_pause;
1230 static int ftgmac100_set_pauseparam(struct net_device *netdev,
1231 struct ethtool_pauseparam *pause)
1233 struct ftgmac100 *priv = netdev_priv(netdev);
1234 struct phy_device *phydev = netdev->phydev;
1236 priv->aneg_pause = pause->autoneg;
1237 priv->tx_pause = pause->tx_pause;
1238 priv->rx_pause = pause->rx_pause;
1241 phy_set_asym_pause(phydev, pause->rx_pause, pause->tx_pause);
1243 if (netif_running(netdev)) {
1244 if (!(phydev && priv->aneg_pause))
1245 ftgmac100_config_pause(priv);
1251 static const struct ethtool_ops ftgmac100_ethtool_ops = {
1252 .get_drvinfo = ftgmac100_get_drvinfo,
1253 .get_link = ethtool_op_get_link,
1254 .get_link_ksettings = phy_ethtool_get_link_ksettings,
1255 .set_link_ksettings = phy_ethtool_set_link_ksettings,
1256 .nway_reset = phy_ethtool_nway_reset,
1257 .get_ringparam = ftgmac100_get_ringparam,
1258 .set_ringparam = ftgmac100_set_ringparam,
1259 .get_pauseparam = ftgmac100_get_pauseparam,
1260 .set_pauseparam = ftgmac100_set_pauseparam,
1263 static irqreturn_t ftgmac100_interrupt(int irq, void *dev_id)
1265 struct net_device *netdev = dev_id;
1266 struct ftgmac100 *priv = netdev_priv(netdev);
1267 unsigned int status, new_mask = FTGMAC100_INT_BAD;
1269 /* Fetch and clear interrupt bits, process abnormal ones */
1270 status = ioread32(priv->base + FTGMAC100_OFFSET_ISR);
1271 iowrite32(status, priv->base + FTGMAC100_OFFSET_ISR);
1272 if (unlikely(status & FTGMAC100_INT_BAD)) {
1274 /* RX buffer unavailable */
1275 if (status & FTGMAC100_INT_NO_RXBUF)
1276 netdev->stats.rx_over_errors++;
1278 /* received packet lost due to RX FIFO full */
1279 if (status & FTGMAC100_INT_RPKT_LOST)
1280 netdev->stats.rx_fifo_errors++;
1282 /* sent packet lost due to excessive TX collision */
1283 if (status & FTGMAC100_INT_XPKT_LOST)
1284 netdev->stats.tx_fifo_errors++;
1286 /* AHB error -> Reset the chip */
1287 if (status & FTGMAC100_INT_AHB_ERR) {
1288 if (net_ratelimit())
1290 "AHB bus error ! Resetting chip.\n");
1291 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1292 schedule_work(&priv->reset_task);
1296 /* We may need to restart the MAC after such errors, delay
1297 * this until after we have freed some Rx buffers though
1299 priv->need_mac_restart = true;
1301 /* Disable those errors until we restart */
1302 new_mask &= ~status;
1305 /* Only enable "bad" interrupts while NAPI is on */
1306 iowrite32(new_mask, priv->base + FTGMAC100_OFFSET_IER);
1308 /* Schedule NAPI bh */
1309 napi_schedule_irqoff(&priv->napi);
1314 static bool ftgmac100_check_rx(struct ftgmac100 *priv)
1316 struct ftgmac100_rxdes *rxdes = &priv->rxdes[priv->rx_pointer];
1318 /* Do we have a packet ? */
1319 return !!(rxdes->rxdes0 & cpu_to_le32(FTGMAC100_RXDES0_RXPKT_RDY));
1322 static int ftgmac100_poll(struct napi_struct *napi, int budget)
1324 struct ftgmac100 *priv = container_of(napi, struct ftgmac100, napi);
1328 /* Handle TX completions */
1329 if (ftgmac100_tx_buf_cleanable(priv))
1330 ftgmac100_tx_complete(priv);
1332 /* Handle RX packets */
1334 more = ftgmac100_rx_packet(priv, &work_done);
1335 } while (more && work_done < budget);
1338 /* The interrupt is telling us to kick the MAC back to life
1339 * after an RX overflow
1341 if (unlikely(priv->need_mac_restart)) {
1342 ftgmac100_start_hw(priv);
1343 priv->need_mac_restart = false;
1345 /* Re-enable "bad" interrupts */
1346 iowrite32(FTGMAC100_INT_BAD,
1347 priv->base + FTGMAC100_OFFSET_IER);
1350 /* As long as we are waiting for transmit packets to be
1351 * completed we keep NAPI going
1353 if (ftgmac100_tx_buf_cleanable(priv))
1356 if (work_done < budget) {
1357 /* We are about to re-enable all interrupts. However
1358 * the HW has been latching RX/TX packet interrupts while
1359 * they were masked. So we clear them first, then we need
1360 * to re-check if there's something to process
1362 iowrite32(FTGMAC100_INT_RXTX,
1363 priv->base + FTGMAC100_OFFSET_ISR);
1365 /* Push the above (and provides a barrier vs. subsequent
1366 * reads of the descriptor).
1368 ioread32(priv->base + FTGMAC100_OFFSET_ISR);
1370 /* Check RX and TX descriptors for more work to do */
1371 if (ftgmac100_check_rx(priv) ||
1372 ftgmac100_tx_buf_cleanable(priv))
1375 /* deschedule NAPI */
1376 napi_complete(napi);
1378 /* enable all interrupts */
1379 iowrite32(FTGMAC100_INT_ALL,
1380 priv->base + FTGMAC100_OFFSET_IER);
1386 static int ftgmac100_init_all(struct ftgmac100 *priv, bool ignore_alloc_err)
1390 /* Re-init descriptors (adjust queue sizes) */
1391 ftgmac100_init_rings(priv);
1393 /* Realloc rx descriptors */
1394 err = ftgmac100_alloc_rx_buffers(priv);
1395 if (err && !ignore_alloc_err)
1398 /* Reinit and restart HW */
1399 ftgmac100_init_hw(priv);
1400 ftgmac100_config_pause(priv);
1401 ftgmac100_start_hw(priv);
1403 /* Re-enable the device */
1404 napi_enable(&priv->napi);
1405 netif_start_queue(priv->netdev);
1407 /* Enable all interrupts */
1408 iowrite32(FTGMAC100_INT_ALL, priv->base + FTGMAC100_OFFSET_IER);
1413 static void ftgmac100_reset_task(struct work_struct *work)
1415 struct ftgmac100 *priv = container_of(work, struct ftgmac100,
1417 struct net_device *netdev = priv->netdev;
1420 netdev_dbg(netdev, "Resetting NIC...\n");
1422 /* Lock the world */
1425 mutex_lock(&netdev->phydev->lock);
1427 mutex_lock(&priv->mii_bus->mdio_lock);
1430 /* Check if the interface is still up */
1431 if (!netif_running(netdev))
1434 /* Stop the network stack */
1435 netif_trans_update(netdev);
1436 napi_disable(&priv->napi);
1437 netif_tx_disable(netdev);
1439 /* Stop and reset the MAC */
1440 ftgmac100_stop_hw(priv);
1441 err = ftgmac100_reset_and_config_mac(priv);
1443 /* Not much we can do ... it might come back... */
1444 netdev_err(netdev, "attempting to continue...\n");
1447 /* Free all rx and tx buffers */
1448 ftgmac100_free_buffers(priv);
1450 /* Setup everything again and restart chip */
1451 ftgmac100_init_all(priv, true);
1453 netdev_dbg(netdev, "Reset done !\n");
1456 mutex_unlock(&priv->mii_bus->mdio_lock);
1458 mutex_unlock(&netdev->phydev->lock);
1462 static int ftgmac100_open(struct net_device *netdev)
1464 struct ftgmac100 *priv = netdev_priv(netdev);
1467 /* Allocate ring buffers */
1468 err = ftgmac100_alloc_rings(priv);
1470 netdev_err(netdev, "Failed to allocate descriptors\n");
1474 /* When using NC-SI we force the speed to 100Mbit/s full duplex,
1476 * Otherwise we leave it set to 0 (no link), the link
1477 * message from the PHY layer will handle setting it up to
1478 * something else if needed.
1480 if (priv->use_ncsi) {
1481 priv->cur_duplex = DUPLEX_FULL;
1482 priv->cur_speed = SPEED_100;
1484 priv->cur_duplex = 0;
1485 priv->cur_speed = 0;
1488 /* Reset the hardware */
1489 err = ftgmac100_reset_and_config_mac(priv);
1493 /* Initialize NAPI */
1494 netif_napi_add(netdev, &priv->napi, ftgmac100_poll, 64);
1496 /* Grab our interrupt */
1497 err = request_irq(netdev->irq, ftgmac100_interrupt, 0, netdev->name, netdev);
1499 netdev_err(netdev, "failed to request irq %d\n", netdev->irq);
1503 /* Start things up */
1504 err = ftgmac100_init_all(priv, false);
1506 netdev_err(netdev, "Failed to allocate packet buffers\n");
1510 if (netdev->phydev) {
1511 /* If we have a PHY, start polling */
1512 phy_start(netdev->phydev);
1513 } else if (priv->use_ncsi) {
1514 /* If using NC-SI, set our carrier on and start the stack */
1515 netif_carrier_on(netdev);
1517 /* Start the NCSI device */
1518 err = ncsi_start_dev(priv->ndev);
1526 napi_disable(&priv->napi);
1527 netif_stop_queue(netdev);
1529 ftgmac100_free_buffers(priv);
1530 free_irq(netdev->irq, netdev);
1532 netif_napi_del(&priv->napi);
1534 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1535 ftgmac100_free_rings(priv);
1539 static int ftgmac100_stop(struct net_device *netdev)
1541 struct ftgmac100 *priv = netdev_priv(netdev);
1543 /* Note about the reset task: We are called with the rtnl lock
1544 * held, so we are synchronized against the core of the reset
1545 * task. We must not try to synchronously cancel it otherwise
1546 * we can deadlock. But since it will test for netif_running()
1547 * which has already been cleared by the net core, we don't
1548 * anything special to do.
1551 /* disable all interrupts */
1552 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1554 netif_stop_queue(netdev);
1555 napi_disable(&priv->napi);
1556 netif_napi_del(&priv->napi);
1558 phy_stop(netdev->phydev);
1559 else if (priv->use_ncsi)
1560 ncsi_stop_dev(priv->ndev);
1562 ftgmac100_stop_hw(priv);
1563 free_irq(netdev->irq, netdev);
1564 ftgmac100_free_buffers(priv);
1565 ftgmac100_free_rings(priv);
1570 static void ftgmac100_tx_timeout(struct net_device *netdev, unsigned int txqueue)
1572 struct ftgmac100 *priv = netdev_priv(netdev);
1574 /* Disable all interrupts */
1575 iowrite32(0, priv->base + FTGMAC100_OFFSET_IER);
1577 /* Do the reset outside of interrupt context */
1578 schedule_work(&priv->reset_task);
1581 static int ftgmac100_set_features(struct net_device *netdev,
1582 netdev_features_t features)
1584 struct ftgmac100 *priv = netdev_priv(netdev);
1585 netdev_features_t changed = netdev->features ^ features;
1587 if (!netif_running(netdev))
1590 /* Update the vlan filtering bit */
1591 if (changed & NETIF_F_HW_VLAN_CTAG_RX) {
1594 maccr = ioread32(priv->base + FTGMAC100_OFFSET_MACCR);
1595 if (priv->netdev->features & NETIF_F_HW_VLAN_CTAG_RX)
1596 maccr |= FTGMAC100_MACCR_RM_VLAN;
1598 maccr &= ~FTGMAC100_MACCR_RM_VLAN;
1599 iowrite32(maccr, priv->base + FTGMAC100_OFFSET_MACCR);
1605 #ifdef CONFIG_NET_POLL_CONTROLLER
1606 static void ftgmac100_poll_controller(struct net_device *netdev)
1608 unsigned long flags;
1610 local_irq_save(flags);
1611 ftgmac100_interrupt(netdev->irq, netdev);
1612 local_irq_restore(flags);
1616 static const struct net_device_ops ftgmac100_netdev_ops = {
1617 .ndo_open = ftgmac100_open,
1618 .ndo_stop = ftgmac100_stop,
1619 .ndo_start_xmit = ftgmac100_hard_start_xmit,
1620 .ndo_set_mac_address = ftgmac100_set_mac_addr,
1621 .ndo_validate_addr = eth_validate_addr,
1622 .ndo_eth_ioctl = phy_do_ioctl,
1623 .ndo_tx_timeout = ftgmac100_tx_timeout,
1624 .ndo_set_rx_mode = ftgmac100_set_rx_mode,
1625 .ndo_set_features = ftgmac100_set_features,
1626 #ifdef CONFIG_NET_POLL_CONTROLLER
1627 .ndo_poll_controller = ftgmac100_poll_controller,
1629 .ndo_vlan_rx_add_vid = ncsi_vlan_rx_add_vid,
1630 .ndo_vlan_rx_kill_vid = ncsi_vlan_rx_kill_vid,
1633 static int ftgmac100_setup_mdio(struct net_device *netdev)
1635 struct ftgmac100 *priv = netdev_priv(netdev);
1636 struct platform_device *pdev = to_platform_device(priv->dev);
1637 struct device_node *np = pdev->dev.of_node;
1638 struct device_node *mdio_np;
1642 /* initialize mdio bus */
1643 priv->mii_bus = mdiobus_alloc();
1647 if (of_device_is_compatible(np, "aspeed,ast2400-mac") ||
1648 of_device_is_compatible(np, "aspeed,ast2500-mac")) {
1649 /* The AST2600 has a separate MDIO controller */
1651 /* For the AST2400 and AST2500 this driver only supports the
1652 * old MDIO interface
1654 reg = ioread32(priv->base + FTGMAC100_OFFSET_REVR);
1655 reg &= ~FTGMAC100_REVR_NEW_MDIO_INTERFACE;
1656 iowrite32(reg, priv->base + FTGMAC100_OFFSET_REVR);
1659 priv->mii_bus->name = "ftgmac100_mdio";
1660 snprintf(priv->mii_bus->id, MII_BUS_ID_SIZE, "%s-%d",
1661 pdev->name, pdev->id);
1662 priv->mii_bus->parent = priv->dev;
1663 priv->mii_bus->priv = priv->netdev;
1664 priv->mii_bus->read = ftgmac100_mdiobus_read;
1665 priv->mii_bus->write = ftgmac100_mdiobus_write;
1667 for (i = 0; i < PHY_MAX_ADDR; i++)
1668 priv->mii_bus->irq[i] = PHY_POLL;
1670 mdio_np = of_get_child_by_name(np, "mdio");
1672 err = of_mdiobus_register(priv->mii_bus, mdio_np);
1674 dev_err(priv->dev, "Cannot register MDIO bus!\n");
1675 goto err_register_mdiobus;
1678 of_node_put(mdio_np);
1682 err_register_mdiobus:
1683 mdiobus_free(priv->mii_bus);
1687 static void ftgmac100_phy_disconnect(struct net_device *netdev)
1689 if (!netdev->phydev)
1692 phy_disconnect(netdev->phydev);
1695 static void ftgmac100_destroy_mdio(struct net_device *netdev)
1697 struct ftgmac100 *priv = netdev_priv(netdev);
1702 mdiobus_unregister(priv->mii_bus);
1703 mdiobus_free(priv->mii_bus);
1706 static void ftgmac100_ncsi_handler(struct ncsi_dev *nd)
1708 if (unlikely(nd->state != ncsi_dev_state_functional))
1711 netdev_dbg(nd->dev, "NCSI interface %s\n",
1712 nd->link_up ? "up" : "down");
1715 static int ftgmac100_setup_clk(struct ftgmac100 *priv)
1720 clk = devm_clk_get(priv->dev, NULL /* MACCLK */);
1722 return PTR_ERR(clk);
1724 rc = clk_prepare_enable(priv->clk);
1728 /* Aspeed specifies a 100MHz clock is required for up to
1729 * 1000Mbit link speeds. As NCSI is limited to 100Mbit, 25MHz
1732 rc = clk_set_rate(priv->clk, priv->use_ncsi ? FTGMAC_25MHZ :
1737 /* RCLK is for RMII, typically used for NCSI. Optional because it's not
1738 * necessary if it's the AST2400 MAC, or the MAC is configured for
1739 * RGMII, or the controller is not an ASPEED-based controller.
1741 priv->rclk = devm_clk_get_optional(priv->dev, "RCLK");
1742 rc = clk_prepare_enable(priv->rclk);
1747 clk_disable_unprepare(priv->clk);
1752 static int ftgmac100_probe(struct platform_device *pdev)
1754 struct resource *res;
1756 struct net_device *netdev;
1757 struct ftgmac100 *priv;
1758 struct device_node *np;
1761 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1765 irq = platform_get_irq(pdev, 0);
1769 /* setup net_device */
1770 netdev = alloc_etherdev(sizeof(*priv));
1773 goto err_alloc_etherdev;
1776 SET_NETDEV_DEV(netdev, &pdev->dev);
1778 netdev->ethtool_ops = &ftgmac100_ethtool_ops;
1779 netdev->netdev_ops = &ftgmac100_netdev_ops;
1780 netdev->watchdog_timeo = 5 * HZ;
1782 platform_set_drvdata(pdev, netdev);
1784 /* setup private data */
1785 priv = netdev_priv(netdev);
1786 priv->netdev = netdev;
1787 priv->dev = &pdev->dev;
1788 INIT_WORK(&priv->reset_task, ftgmac100_reset_task);
1791 priv->res = request_mem_region(res->start, resource_size(res),
1792 dev_name(&pdev->dev));
1794 dev_err(&pdev->dev, "Could not reserve memory region\n");
1799 priv->base = ioremap(res->start, resource_size(res));
1801 dev_err(&pdev->dev, "Failed to ioremap ethernet registers\n");
1809 priv->tx_pause = true;
1810 priv->rx_pause = true;
1811 priv->aneg_pause = true;
1813 /* MAC address from chip or random one */
1814 ftgmac100_initial_mac(priv);
1816 np = pdev->dev.of_node;
1817 if (np && (of_device_is_compatible(np, "aspeed,ast2400-mac") ||
1818 of_device_is_compatible(np, "aspeed,ast2500-mac") ||
1819 of_device_is_compatible(np, "aspeed,ast2600-mac"))) {
1820 priv->rxdes0_edorr_mask = BIT(30);
1821 priv->txdes0_edotr_mask = BIT(30);
1822 priv->is_aspeed = true;
1823 /* Disable ast2600 problematic HW arbitration */
1824 if (of_device_is_compatible(np, "aspeed,ast2600-mac")) {
1825 iowrite32(FTGMAC100_TM_DEFAULT,
1826 priv->base + FTGMAC100_OFFSET_TM);
1829 priv->rxdes0_edorr_mask = BIT(15);
1830 priv->txdes0_edotr_mask = BIT(15);
1833 if (np && of_get_property(np, "use-ncsi", NULL)) {
1834 if (!IS_ENABLED(CONFIG_NET_NCSI)) {
1835 dev_err(&pdev->dev, "NCSI stack not enabled\n");
1837 goto err_phy_connect;
1840 dev_info(&pdev->dev, "Using NCSI interface\n");
1841 priv->use_ncsi = true;
1842 priv->ndev = ncsi_register_dev(netdev, ftgmac100_ncsi_handler);
1845 goto err_phy_connect;
1847 } else if (np && of_get_property(np, "phy-handle", NULL)) {
1848 struct phy_device *phy;
1850 /* Support "mdio"/"phy" child nodes for ast2400/2500 with
1851 * an embedded MDIO controller. Automatically scan the DTS for
1852 * available PHYs and register them.
1854 if (of_device_is_compatible(np, "aspeed,ast2400-mac") ||
1855 of_device_is_compatible(np, "aspeed,ast2500-mac")) {
1856 err = ftgmac100_setup_mdio(netdev);
1858 goto err_setup_mdio;
1861 phy = of_phy_get_and_connect(priv->netdev, np,
1862 &ftgmac100_adjust_link);
1864 dev_err(&pdev->dev, "Failed to connect to phy\n");
1866 goto err_phy_connect;
1869 /* Indicate that we support PAUSE frames (see comment in
1870 * Documentation/networking/phy.rst)
1872 phy_support_asym_pause(phy);
1874 /* Display what we found */
1875 phy_attached_info(phy);
1876 } else if (np && !of_get_child_by_name(np, "mdio")) {
1877 /* Support legacy ASPEED devicetree descriptions that decribe a
1878 * MAC with an embedded MDIO controller but have no "mdio"
1879 * child node. Automatically scan the MDIO bus for available
1882 priv->use_ncsi = false;
1883 err = ftgmac100_setup_mdio(netdev);
1885 goto err_setup_mdio;
1887 err = ftgmac100_mii_probe(netdev);
1889 dev_err(priv->dev, "MII probe failed!\n");
1895 if (priv->is_aspeed) {
1896 err = ftgmac100_setup_clk(priv);
1898 goto err_phy_connect;
1901 /* Default ring sizes */
1902 priv->rx_q_entries = priv->new_rx_q_entries = DEF_RX_QUEUE_ENTRIES;
1903 priv->tx_q_entries = priv->new_tx_q_entries = DEF_TX_QUEUE_ENTRIES;
1905 /* Base feature set */
1906 netdev->hw_features = NETIF_F_RXCSUM | NETIF_F_HW_CSUM |
1907 NETIF_F_GRO | NETIF_F_SG | NETIF_F_HW_VLAN_CTAG_RX |
1908 NETIF_F_HW_VLAN_CTAG_TX;
1911 netdev->hw_features |= NETIF_F_HW_VLAN_CTAG_FILTER;
1913 /* AST2400 doesn't have working HW checksum generation */
1914 if (np && (of_device_is_compatible(np, "aspeed,ast2400-mac")))
1915 netdev->hw_features &= ~NETIF_F_HW_CSUM;
1916 if (np && of_get_property(np, "no-hw-checksum", NULL))
1917 netdev->hw_features &= ~(NETIF_F_HW_CSUM | NETIF_F_RXCSUM);
1918 netdev->features |= netdev->hw_features;
1920 /* register network device */
1921 err = register_netdev(netdev);
1923 dev_err(&pdev->dev, "Failed to register netdev\n");
1924 goto err_register_netdev;
1927 netdev_info(netdev, "irq %d, mapped at %p\n", netdev->irq, priv->base);
1931 err_register_netdev:
1932 clk_disable_unprepare(priv->rclk);
1933 clk_disable_unprepare(priv->clk);
1935 ftgmac100_phy_disconnect(netdev);
1938 ncsi_unregister_dev(priv->ndev);
1939 ftgmac100_destroy_mdio(netdev);
1941 iounmap(priv->base);
1943 release_resource(priv->res);
1945 free_netdev(netdev);
1950 static int ftgmac100_remove(struct platform_device *pdev)
1952 struct net_device *netdev;
1953 struct ftgmac100 *priv;
1955 netdev = platform_get_drvdata(pdev);
1956 priv = netdev_priv(netdev);
1959 ncsi_unregister_dev(priv->ndev);
1960 unregister_netdev(netdev);
1962 clk_disable_unprepare(priv->rclk);
1963 clk_disable_unprepare(priv->clk);
1965 /* There's a small chance the reset task will have been re-queued,
1966 * during stop, make sure it's gone before we free the structure.
1968 cancel_work_sync(&priv->reset_task);
1970 ftgmac100_phy_disconnect(netdev);
1971 ftgmac100_destroy_mdio(netdev);
1973 iounmap(priv->base);
1974 release_resource(priv->res);
1976 netif_napi_del(&priv->napi);
1977 free_netdev(netdev);
1981 static const struct of_device_id ftgmac100_of_match[] = {
1982 { .compatible = "faraday,ftgmac100" },
1985 MODULE_DEVICE_TABLE(of, ftgmac100_of_match);
1987 static struct platform_driver ftgmac100_driver = {
1988 .probe = ftgmac100_probe,
1989 .remove = ftgmac100_remove,
1992 .of_match_table = ftgmac100_of_match,
1995 module_platform_driver(ftgmac100_driver);
1997 MODULE_AUTHOR("Po-Yu Chuang <ratbert@faraday-tech.com>");
1998 MODULE_DESCRIPTION("FTGMAC100 driver");
1999 MODULE_LICENSE("GPL");