1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (c) 2013-2016, The Linux Foundation. All rights reserved.
5 /* Qualcomm Technologies, Inc. EMAC Gigabit Ethernet Driver */
7 #include <linux/if_ether.h>
8 #include <linux/if_vlan.h>
9 #include <linux/interrupt.h>
11 #include <linux/module.h>
13 #include <linux/of_net.h>
14 #include <linux/phy.h>
15 #include <linux/platform_device.h>
16 #include <linux/acpi.h>
20 #include "emac-sgmii.h"
22 #define EMAC_MSG_DEFAULT (NETIF_MSG_DRV | NETIF_MSG_PROBE | NETIF_MSG_LINK | \
23 NETIF_MSG_TIMER | NETIF_MSG_IFDOWN | NETIF_MSG_IFUP)
25 #define EMAC_RRD_SIZE 4
26 /* The RRD size if timestamping is enabled: */
27 #define EMAC_TS_RRD_SIZE 6
28 #define EMAC_TPD_SIZE 4
29 #define EMAC_RFD_SIZE 2
31 #define REG_MAC_RX_STATUS_BIN EMAC_RXMAC_STATC_REG0
32 #define REG_MAC_RX_STATUS_END EMAC_RXMAC_STATC_REG22
33 #define REG_MAC_TX_STATUS_BIN EMAC_TXMAC_STATC_REG0
34 #define REG_MAC_TX_STATUS_END EMAC_TXMAC_STATC_REG24
36 #define RXQ0_NUM_RFD_PREF_DEF 8
37 #define TXQ0_NUM_TPD_PREF_DEF 5
39 #define EMAC_PREAMBLE_DEF 7
41 #define DMAR_DLY_CNT_DEF 15
42 #define DMAW_DLY_CNT_DEF 4
44 #define IMR_NORMAL_MASK (ISR_ERROR | ISR_OVER | ISR_TX_PKT)
66 /* in sync with enum emac_clk_id */
67 static const char * const emac_clk_name[] = {
68 "axi_clk", "cfg_ahb_clk", "high_speed_clk", "mdio_clk", "tx_clk",
72 void emac_reg_update32(void __iomem *addr, u32 mask, u32 val)
74 u32 data = readl(addr);
76 writel(((data & ~mask) | val), addr);
80 int emac_reinit_locked(struct emac_adapter *adpt)
84 mutex_lock(&adpt->reset_lock);
87 emac_sgmii_reset(adpt);
88 ret = emac_mac_up(adpt);
90 mutex_unlock(&adpt->reset_lock);
96 static int emac_napi_rtx(struct napi_struct *napi, int budget)
98 struct emac_rx_queue *rx_q =
99 container_of(napi, struct emac_rx_queue, napi);
100 struct emac_adapter *adpt = netdev_priv(rx_q->netdev);
101 struct emac_irq *irq = rx_q->irq;
104 emac_mac_rx_process(adpt, rx_q, &work_done, budget);
106 if (work_done < budget) {
107 napi_complete_done(napi, work_done);
109 irq->mask |= rx_q->intr;
110 writel(irq->mask, adpt->base + EMAC_INT_MASK);
116 /* Transmit the packet */
117 static netdev_tx_t emac_start_xmit(struct sk_buff *skb,
118 struct net_device *netdev)
120 struct emac_adapter *adpt = netdev_priv(netdev);
122 return emac_mac_tx_buf_send(adpt, &adpt->tx_q, skb);
125 static irqreturn_t emac_isr(int _irq, void *data)
127 struct emac_irq *irq = data;
128 struct emac_adapter *adpt =
129 container_of(irq, struct emac_adapter, irq);
130 struct emac_rx_queue *rx_q = &adpt->rx_q;
133 /* disable the interrupt */
134 writel(0, adpt->base + EMAC_INT_MASK);
136 isr = readl_relaxed(adpt->base + EMAC_INT_STATUS);
138 status = isr & irq->mask;
142 if (status & ISR_ERROR) {
143 net_err_ratelimited("%s: error interrupt 0x%lx\n",
144 adpt->netdev->name, status & ISR_ERROR);
146 schedule_work(&adpt->work_thread);
149 /* Schedule the napi for receive queue with interrupt
152 if (status & rx_q->intr) {
153 if (napi_schedule_prep(&rx_q->napi)) {
154 irq->mask &= ~rx_q->intr;
155 __napi_schedule(&rx_q->napi);
159 if (status & TX_PKT_INT)
160 emac_mac_tx_process(adpt, &adpt->tx_q);
162 if (status & ISR_OVER)
163 net_warn_ratelimited("%s: TX/RX overflow interrupt\n",
167 /* enable the interrupt */
168 writel(irq->mask, adpt->base + EMAC_INT_MASK);
173 /* Configure VLAN tag strip/insert feature */
174 static int emac_set_features(struct net_device *netdev,
175 netdev_features_t features)
177 netdev_features_t changed = features ^ netdev->features;
178 struct emac_adapter *adpt = netdev_priv(netdev);
180 /* We only need to reprogram the hardware if the VLAN tag features
181 * have changed, and if it's already running.
183 if (!(changed & (NETIF_F_HW_VLAN_CTAG_TX | NETIF_F_HW_VLAN_CTAG_RX)))
186 if (!netif_running(netdev))
189 /* emac_mac_mode_config() uses netdev->features to configure the EMAC,
190 * so make sure it's set first.
192 netdev->features = features;
194 return emac_reinit_locked(adpt);
197 /* Configure Multicast and Promiscuous modes */
198 static void emac_rx_mode_set(struct net_device *netdev)
200 struct emac_adapter *adpt = netdev_priv(netdev);
201 struct netdev_hw_addr *ha;
203 emac_mac_mode_config(adpt);
205 /* update multicast address filtering */
206 emac_mac_multicast_addr_clear(adpt);
207 netdev_for_each_mc_addr(ha, netdev)
208 emac_mac_multicast_addr_set(adpt, ha->addr);
211 /* Change the Maximum Transfer Unit (MTU) */
212 static int emac_change_mtu(struct net_device *netdev, int new_mtu)
214 struct emac_adapter *adpt = netdev_priv(netdev);
216 netif_dbg(adpt, hw, adpt->netdev,
217 "changing MTU from %d to %d\n", netdev->mtu,
219 netdev->mtu = new_mtu;
221 if (netif_running(netdev))
222 return emac_reinit_locked(adpt);
227 /* Called when the network interface is made active */
228 static int emac_open(struct net_device *netdev)
230 struct emac_adapter *adpt = netdev_priv(netdev);
231 struct emac_irq *irq = &adpt->irq;
234 ret = request_irq(irq->irq, emac_isr, 0, "emac-core0", irq);
236 netdev_err(adpt->netdev, "could not request emac-core0 irq\n");
240 /* allocate rx/tx dma buffer & descriptors */
241 ret = emac_mac_rx_tx_rings_alloc_all(adpt);
243 netdev_err(adpt->netdev, "error allocating rx/tx rings\n");
244 free_irq(irq->irq, irq);
248 ret = emac_sgmii_open(adpt);
250 emac_mac_rx_tx_rings_free_all(adpt);
251 free_irq(irq->irq, irq);
255 ret = emac_mac_up(adpt);
257 emac_mac_rx_tx_rings_free_all(adpt);
258 free_irq(irq->irq, irq);
259 emac_sgmii_close(adpt);
266 /* Called when the network interface is disabled */
267 static int emac_close(struct net_device *netdev)
269 struct emac_adapter *adpt = netdev_priv(netdev);
271 mutex_lock(&adpt->reset_lock);
273 emac_sgmii_close(adpt);
275 emac_mac_rx_tx_rings_free_all(adpt);
277 free_irq(adpt->irq.irq, &adpt->irq);
279 mutex_unlock(&adpt->reset_lock);
284 /* Respond to a TX hang */
285 static void emac_tx_timeout(struct net_device *netdev, unsigned int txqueue)
287 struct emac_adapter *adpt = netdev_priv(netdev);
289 schedule_work(&adpt->work_thread);
293 * emac_update_hw_stats - read the EMAC stat registers
294 * @adpt: pointer to adapter struct
296 * Reads the stats registers and write the values to adpt->stats.
298 * adpt->stats.lock must be held while calling this function,
299 * and while reading from adpt->stats.
301 void emac_update_hw_stats(struct emac_adapter *adpt)
303 struct emac_stats *stats = &adpt->stats;
304 u64 *stats_itr = &adpt->stats.rx_ok;
305 void __iomem *base = adpt->base;
308 addr = REG_MAC_RX_STATUS_BIN;
309 while (addr <= REG_MAC_RX_STATUS_END) {
310 *stats_itr += readl_relaxed(base + addr);
315 /* additional rx status */
316 stats->rx_crc_align += readl_relaxed(base + EMAC_RXMAC_STATC_REG23);
317 stats->rx_jabbers += readl_relaxed(base + EMAC_RXMAC_STATC_REG24);
319 /* update tx status */
320 addr = REG_MAC_TX_STATUS_BIN;
321 stats_itr = &stats->tx_ok;
323 while (addr <= REG_MAC_TX_STATUS_END) {
324 *stats_itr += readl_relaxed(base + addr);
329 /* additional tx status */
330 stats->tx_col += readl_relaxed(base + EMAC_TXMAC_STATC_REG25);
333 /* Provide network statistics info for the interface */
334 static void emac_get_stats64(struct net_device *netdev,
335 struct rtnl_link_stats64 *net_stats)
337 struct emac_adapter *adpt = netdev_priv(netdev);
338 struct emac_stats *stats = &adpt->stats;
340 spin_lock(&stats->lock);
342 emac_update_hw_stats(adpt);
344 /* return parsed statistics */
345 net_stats->rx_packets = stats->rx_ok;
346 net_stats->tx_packets = stats->tx_ok;
347 net_stats->rx_bytes = stats->rx_byte_cnt;
348 net_stats->tx_bytes = stats->tx_byte_cnt;
349 net_stats->multicast = stats->rx_mcast;
350 net_stats->collisions = stats->tx_1_col + stats->tx_2_col * 2 +
351 stats->tx_late_col + stats->tx_abort_col;
353 net_stats->rx_errors = stats->rx_frag + stats->rx_fcs_err +
354 stats->rx_len_err + stats->rx_sz_ov +
356 net_stats->rx_fifo_errors = stats->rx_rxf_ov;
357 net_stats->rx_length_errors = stats->rx_len_err;
358 net_stats->rx_crc_errors = stats->rx_fcs_err;
359 net_stats->rx_frame_errors = stats->rx_align_err;
360 net_stats->rx_over_errors = stats->rx_rxf_ov;
361 net_stats->rx_missed_errors = stats->rx_rxf_ov;
363 net_stats->tx_errors = stats->tx_late_col + stats->tx_abort_col +
364 stats->tx_underrun + stats->tx_trunc;
365 net_stats->tx_fifo_errors = stats->tx_underrun;
366 net_stats->tx_aborted_errors = stats->tx_abort_col;
367 net_stats->tx_window_errors = stats->tx_late_col;
369 spin_unlock(&stats->lock);
372 static const struct net_device_ops emac_netdev_ops = {
373 .ndo_open = emac_open,
374 .ndo_stop = emac_close,
375 .ndo_validate_addr = eth_validate_addr,
376 .ndo_start_xmit = emac_start_xmit,
377 .ndo_set_mac_address = eth_mac_addr,
378 .ndo_change_mtu = emac_change_mtu,
379 .ndo_eth_ioctl = phy_do_ioctl_running,
380 .ndo_tx_timeout = emac_tx_timeout,
381 .ndo_get_stats64 = emac_get_stats64,
382 .ndo_set_features = emac_set_features,
383 .ndo_set_rx_mode = emac_rx_mode_set,
386 /* Watchdog task routine, called to reinitialize the EMAC */
387 static void emac_work_thread(struct work_struct *work)
389 struct emac_adapter *adpt =
390 container_of(work, struct emac_adapter, work_thread);
392 emac_reinit_locked(adpt);
395 /* Initialize various data structures */
396 static void emac_init_adapter(struct emac_adapter *adpt)
400 adpt->rrd_size = EMAC_RRD_SIZE;
401 adpt->tpd_size = EMAC_TPD_SIZE;
402 adpt->rfd_size = EMAC_RFD_SIZE;
405 adpt->tx_desc_cnt = EMAC_DEF_TX_DESCS;
406 adpt->rx_desc_cnt = EMAC_DEF_RX_DESCS;
409 adpt->dma_order = emac_dma_ord_out;
410 adpt->dmar_block = emac_dma_req_4096;
411 adpt->dmaw_block = emac_dma_req_128;
412 adpt->dmar_dly_cnt = DMAR_DLY_CNT_DEF;
413 adpt->dmaw_dly_cnt = DMAW_DLY_CNT_DEF;
414 adpt->tpd_burst = TXQ0_NUM_TPD_PREF_DEF;
415 adpt->rfd_burst = RXQ0_NUM_RFD_PREF_DEF;
418 reg = ((EMAC_DEF_RX_IRQ_MOD >> 1) << IRQ_MODERATOR2_INIT_SHFT) |
419 ((EMAC_DEF_TX_IRQ_MOD >> 1) << IRQ_MODERATOR_INIT_SHFT);
423 adpt->preamble = EMAC_PREAMBLE_DEF;
425 /* default to automatic flow control */
426 adpt->automatic = true;
428 /* Disable single-pause-frame mode by default */
429 adpt->single_pause_mode = false;
433 static int emac_clks_get(struct platform_device *pdev,
434 struct emac_adapter *adpt)
438 for (i = 0; i < EMAC_CLK_CNT; i++) {
439 struct clk *clk = devm_clk_get(&pdev->dev, emac_clk_name[i]);
443 "could not claim clock %s (error=%li)\n",
444 emac_clk_name[i], PTR_ERR(clk));
455 /* Initialize clocks */
456 static int emac_clks_phase1_init(struct platform_device *pdev,
457 struct emac_adapter *adpt)
461 /* On ACPI platforms, clocks are controlled by firmware and/or
462 * ACPI, not by drivers.
464 if (has_acpi_companion(&pdev->dev))
467 ret = emac_clks_get(pdev, adpt);
471 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_AXI]);
475 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_CFG_AHB]);
477 goto disable_clk_axi;
479 ret = clk_set_rate(adpt->clk[EMAC_CLK_HIGH_SPEED], 19200000);
481 goto disable_clk_cfg_ahb;
483 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_HIGH_SPEED]);
485 goto disable_clk_cfg_ahb;
490 clk_disable_unprepare(adpt->clk[EMAC_CLK_CFG_AHB]);
492 clk_disable_unprepare(adpt->clk[EMAC_CLK_AXI]);
497 /* Enable clocks; needs emac_clks_phase1_init to be called before */
498 static int emac_clks_phase2_init(struct platform_device *pdev,
499 struct emac_adapter *adpt)
503 if (has_acpi_companion(&pdev->dev))
506 ret = clk_set_rate(adpt->clk[EMAC_CLK_TX], 125000000);
510 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_TX]);
514 ret = clk_set_rate(adpt->clk[EMAC_CLK_HIGH_SPEED], 125000000);
518 ret = clk_set_rate(adpt->clk[EMAC_CLK_MDIO], 25000000);
522 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_MDIO]);
526 ret = clk_prepare_enable(adpt->clk[EMAC_CLK_RX]);
530 return clk_prepare_enable(adpt->clk[EMAC_CLK_SYS]);
533 static void emac_clks_teardown(struct emac_adapter *adpt)
538 for (i = 0; i < EMAC_CLK_CNT; i++)
539 clk_disable_unprepare(adpt->clk[i]);
542 /* Get the resources */
543 static int emac_probe_resources(struct platform_device *pdev,
544 struct emac_adapter *adpt)
546 struct net_device *netdev = adpt->netdev;
549 /* get mac address */
550 if (device_get_ethdev_address(&pdev->dev, netdev))
551 eth_hw_addr_random(netdev);
553 /* Core 0 interrupt */
554 ret = platform_get_irq(pdev, 0);
559 /* base register address */
560 adpt->base = devm_platform_ioremap_resource(pdev, 0);
561 if (IS_ERR(adpt->base))
562 return PTR_ERR(adpt->base);
564 /* CSR register address */
565 adpt->csr = devm_platform_ioremap_resource(pdev, 1);
566 if (IS_ERR(adpt->csr))
567 return PTR_ERR(adpt->csr);
569 netdev->base_addr = (unsigned long)adpt->base;
574 static const struct of_device_id emac_dt_match[] = {
576 .compatible = "qcom,fsm9900-emac",
580 MODULE_DEVICE_TABLE(of, emac_dt_match);
582 #if IS_ENABLED(CONFIG_ACPI)
583 static const struct acpi_device_id emac_acpi_match[] = {
589 MODULE_DEVICE_TABLE(acpi, emac_acpi_match);
592 static int emac_probe(struct platform_device *pdev)
594 struct net_device *netdev;
595 struct emac_adapter *adpt;
596 struct emac_sgmii *phy;
601 /* The TPD buffer address is limited to:
602 * 1. PTP: 45bits. (Driver doesn't support yet.)
603 * 2. NON-PTP: 46bits.
605 ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(46));
607 dev_err(&pdev->dev, "could not set DMA mask\n");
611 netdev = alloc_etherdev(sizeof(struct emac_adapter));
615 dev_set_drvdata(&pdev->dev, netdev);
616 SET_NETDEV_DEV(netdev, &pdev->dev);
617 emac_set_ethtool_ops(netdev);
619 adpt = netdev_priv(netdev);
620 adpt->netdev = netdev;
621 adpt->msg_enable = EMAC_MSG_DEFAULT;
624 atomic_set(&phy->decode_error_count, 0);
626 mutex_init(&adpt->reset_lock);
627 spin_lock_init(&adpt->stats.lock);
629 adpt->irq.mask = RX_PKT_INT0 | IMR_NORMAL_MASK;
631 ret = emac_probe_resources(pdev, adpt);
633 goto err_undo_netdev;
635 /* initialize clocks */
636 ret = emac_clks_phase1_init(pdev, adpt);
638 dev_err(&pdev->dev, "could not initialize clocks\n");
639 goto err_undo_netdev;
642 netdev->watchdog_timeo = EMAC_WATCHDOG_TIME;
643 netdev->irq = adpt->irq.irq;
645 netdev->netdev_ops = &emac_netdev_ops;
647 emac_init_adapter(adpt);
649 /* init external phy */
650 ret = emac_phy_config(pdev, adpt);
652 goto err_undo_clocks;
654 /* init internal sgmii phy */
655 ret = emac_sgmii_config(pdev, adpt);
657 goto err_undo_mdiobus;
660 ret = emac_clks_phase2_init(pdev, adpt);
662 dev_err(&pdev->dev, "could not initialize clocks\n");
663 goto err_undo_mdiobus;
666 /* set hw features */
667 netdev->features = NETIF_F_SG | NETIF_F_HW_CSUM | NETIF_F_RXCSUM |
668 NETIF_F_TSO | NETIF_F_TSO6 | NETIF_F_HW_VLAN_CTAG_RX |
669 NETIF_F_HW_VLAN_CTAG_TX;
670 netdev->hw_features = netdev->features;
672 netdev->vlan_features |= NETIF_F_SG | NETIF_F_HW_CSUM |
673 NETIF_F_TSO | NETIF_F_TSO6;
675 /* MTU range: 46 - 9194 */
676 netdev->min_mtu = EMAC_MIN_ETH_FRAME_SIZE -
677 (ETH_HLEN + ETH_FCS_LEN + VLAN_HLEN);
678 netdev->max_mtu = EMAC_MAX_ETH_FRAME_SIZE -
679 (ETH_HLEN + ETH_FCS_LEN + VLAN_HLEN);
681 INIT_WORK(&adpt->work_thread, emac_work_thread);
683 /* Initialize queues */
684 emac_mac_rx_tx_ring_init_all(pdev, adpt);
686 netif_napi_add(netdev, &adpt->rx_q.napi, emac_napi_rtx);
688 ret = register_netdev(netdev);
690 dev_err(&pdev->dev, "could not register net device\n");
694 reg = readl_relaxed(adpt->base + EMAC_DMA_MAS_CTRL);
695 devid = (reg & DEV_ID_NUM_BMSK) >> DEV_ID_NUM_SHFT;
696 revid = (reg & DEV_REV_NUM_BMSK) >> DEV_REV_NUM_SHFT;
697 reg = readl_relaxed(adpt->base + EMAC_CORE_HW_VERSION);
699 netif_info(adpt, probe, netdev,
700 "hardware id %d.%d, hardware version %d.%d.%d\n",
702 (reg & MAJOR_BMSK) >> MAJOR_SHFT,
703 (reg & MINOR_BMSK) >> MINOR_SHFT,
704 (reg & STEP_BMSK) >> STEP_SHFT);
709 netif_napi_del(&adpt->rx_q.napi);
711 put_device(&adpt->phydev->mdio.dev);
712 mdiobus_unregister(adpt->mii_bus);
714 emac_clks_teardown(adpt);
721 static void emac_remove(struct platform_device *pdev)
723 struct net_device *netdev = dev_get_drvdata(&pdev->dev);
724 struct emac_adapter *adpt = netdev_priv(netdev);
726 netif_carrier_off(netdev);
727 netif_tx_disable(netdev);
729 unregister_netdev(netdev);
730 netif_napi_del(&adpt->rx_q.napi);
732 free_irq(adpt->irq.irq, &adpt->irq);
733 cancel_work_sync(&adpt->work_thread);
735 emac_clks_teardown(adpt);
737 put_device(&adpt->phydev->mdio.dev);
738 mdiobus_unregister(adpt->mii_bus);
740 if (adpt->phy.digital)
741 iounmap(adpt->phy.digital);
742 iounmap(adpt->phy.base);
747 static void emac_shutdown(struct platform_device *pdev)
749 struct net_device *netdev = dev_get_drvdata(&pdev->dev);
750 struct emac_adapter *adpt = netdev_priv(netdev);
752 if (netdev->flags & IFF_UP) {
753 /* Closing the SGMII turns off its interrupts */
754 emac_sgmii_close(adpt);
756 /* Resetting the MAC turns off all DMA and its interrupts */
757 emac_mac_reset(adpt);
761 static struct platform_driver emac_platform_driver = {
763 .remove_new = emac_remove,
766 .of_match_table = emac_dt_match,
767 .acpi_match_table = ACPI_PTR(emac_acpi_match),
769 .shutdown = emac_shutdown,
772 module_platform_driver(emac_platform_driver);
774 MODULE_LICENSE("GPL v2");
775 MODULE_ALIAS("platform:qcom-emac");