1 // SPDX-License-Identifier: GPL-2.0-only
3 * dwmac-stm32.c - DWMAC Specific Glue layer for STM32 MCU
5 * Copyright (C) STMicroelectronics SA 2017
10 #include <linux/kernel.h>
11 #include <linux/mfd/syscon.h>
12 #include <linux/module.h>
14 #include <linux/of_net.h>
15 #include <linux/phy.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm_wakeirq.h>
18 #include <linux/regmap.h>
19 #include <linux/slab.h>
20 #include <linux/stmmac.h>
22 #include "stmmac_platform.h"
24 #define SYSCFG_MCU_ETH_MASK BIT(23)
25 #define SYSCFG_MP1_ETH_MASK GENMASK(23, 16)
26 #define SYSCFG_PMCCLRR_OFFSET 0x40
28 #define SYSCFG_PMCR_ETH_CLK_SEL BIT(16)
29 #define SYSCFG_PMCR_ETH_REF_CLK_SEL BIT(17)
31 /* CLOCK feed to PHY*/
32 #define ETH_CK_F_25M 25000000
33 #define ETH_CK_F_50M 50000000
34 #define ETH_CK_F_125M 125000000
36 /* Ethernet PHY interface selection in register SYSCFG Configuration
37 *------------------------------------------
38 * src |BIT(23)| BIT(22)| BIT(21)|BIT(20)|
39 *------------------------------------------
40 * MII | 0 | 0 | 0 | 1 |
41 *------------------------------------------
42 * GMII | 0 | 0 | 0 | 0 |
43 *------------------------------------------
44 * RGMII | 0 | 0 | 1 | n/a |
45 *------------------------------------------
46 * RMII | 1 | 0 | 0 | n/a |
47 *------------------------------------------
49 #define SYSCFG_PMCR_ETH_SEL_MII BIT(20)
50 #define SYSCFG_PMCR_ETH_SEL_RGMII BIT(21)
51 #define SYSCFG_PMCR_ETH_SEL_RMII BIT(23)
52 #define SYSCFG_PMCR_ETH_SEL_GMII 0
53 #define SYSCFG_MCU_ETH_SEL_MII 0
54 #define SYSCFG_MCU_ETH_SEL_RMII 1
56 /* STM32MP2 register definitions */
57 #define SYSCFG_MP2_ETH_MASK GENMASK(31, 0)
59 #define SYSCFG_ETHCR_ETH_PTP_CLK_SEL BIT(2)
60 #define SYSCFG_ETHCR_ETH_CLK_SEL BIT(1)
61 #define SYSCFG_ETHCR_ETH_REF_CLK_SEL BIT(0)
63 #define SYSCFG_ETHCR_ETH_SEL_MII 0
64 #define SYSCFG_ETHCR_ETH_SEL_RGMII BIT(4)
65 #define SYSCFG_ETHCR_ETH_SEL_RMII BIT(6)
67 /* STM32MPx register definitions
69 * Below table summarizes the clock requirement and clock sources for
70 * supported phy interface modes.
71 * __________________________________________________________________________
72 *|PHY_MODE | Normal | PHY wo crystal| PHY wo crystal |No 125MHz from PHY|
73 *| | | 25MHz | 50MHz | |
74 * ---------------------------------------------------------------------------
75 *| MII | - | eth-ck | n/a | n/a |
76 *| | | st,ext-phyclk | | |
77 * ---------------------------------------------------------------------------
78 *| GMII | - | eth-ck | n/a | n/a |
79 *| | | st,ext-phyclk | | |
80 * ---------------------------------------------------------------------------
81 *| RGMII | - | eth-ck | n/a | eth-ck |
82 *| | | st,ext-phyclk | | st,eth-clk-sel or|
83 *| | | | | st,ext-phyclk |
84 * ---------------------------------------------------------------------------
85 *| RMII | - | eth-ck | eth-ck | n/a |
86 *| | | st,ext-phyclk | st,eth-ref-clk-sel | |
87 *| | | | or st,ext-phyclk | |
88 * ---------------------------------------------------------------------------
95 struct clk *clk_eth_ck;
96 struct clk *clk_ethstp;
97 struct clk *syscfg_clk;
101 int eth_ref_clk_sel_reg;
103 u32 mode_reg; /* MAC glue-logic mode register */
105 struct regmap *regmap;
107 const struct stm32_ops *ops;
112 int (*set_mode)(struct plat_stmmacenet_data *plat_dat);
113 int (*suspend)(struct stm32_dwmac *dwmac);
114 void (*resume)(struct stm32_dwmac *dwmac);
115 int (*parse_data)(struct stm32_dwmac *dwmac,
117 bool clk_rx_enable_in_suspend;
118 bool is_mp13, is_mp2;
122 static int stm32_dwmac_clk_enable(struct stm32_dwmac *dwmac, bool resume)
126 ret = clk_prepare_enable(dwmac->clk_tx);
130 if (!dwmac->ops->clk_rx_enable_in_suspend || !resume) {
131 ret = clk_prepare_enable(dwmac->clk_rx);
136 ret = clk_prepare_enable(dwmac->syscfg_clk);
140 if (dwmac->enable_eth_ck) {
141 ret = clk_prepare_enable(dwmac->clk_eth_ck);
149 clk_disable_unprepare(dwmac->syscfg_clk);
151 if (!dwmac->ops->clk_rx_enable_in_suspend || !resume)
152 clk_disable_unprepare(dwmac->clk_rx);
154 clk_disable_unprepare(dwmac->clk_tx);
159 static int stm32_dwmac_init(struct plat_stmmacenet_data *plat_dat, bool resume)
161 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
164 if (dwmac->ops->set_mode) {
165 ret = dwmac->ops->set_mode(plat_dat);
170 return stm32_dwmac_clk_enable(dwmac, resume);
173 static int stm32mp1_select_ethck_external(struct plat_stmmacenet_data *plat_dat)
175 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
177 switch (plat_dat->mac_interface) {
178 case PHY_INTERFACE_MODE_MII:
179 dwmac->enable_eth_ck = dwmac->ext_phyclk;
181 case PHY_INTERFACE_MODE_GMII:
182 dwmac->enable_eth_ck = dwmac->eth_clk_sel_reg ||
185 case PHY_INTERFACE_MODE_RMII:
186 dwmac->enable_eth_ck = dwmac->eth_ref_clk_sel_reg ||
189 case PHY_INTERFACE_MODE_RGMII:
190 case PHY_INTERFACE_MODE_RGMII_ID:
191 case PHY_INTERFACE_MODE_RGMII_RXID:
192 case PHY_INTERFACE_MODE_RGMII_TXID:
193 dwmac->enable_eth_ck = dwmac->eth_clk_sel_reg ||
197 dwmac->enable_eth_ck = false;
198 dev_err(dwmac->dev, "Mode %s not supported",
199 phy_modes(plat_dat->mac_interface));
204 static int stm32mp1_validate_ethck_rate(struct plat_stmmacenet_data *plat_dat)
206 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
207 const u32 clk_rate = clk_get_rate(dwmac->clk_eth_ck);
209 if (!dwmac->enable_eth_ck)
212 switch (plat_dat->mac_interface) {
213 case PHY_INTERFACE_MODE_MII:
214 case PHY_INTERFACE_MODE_GMII:
215 if (clk_rate == ETH_CK_F_25M)
218 case PHY_INTERFACE_MODE_RMII:
219 if (clk_rate == ETH_CK_F_25M || clk_rate == ETH_CK_F_50M)
222 case PHY_INTERFACE_MODE_RGMII:
223 case PHY_INTERFACE_MODE_RGMII_ID:
224 case PHY_INTERFACE_MODE_RGMII_RXID:
225 case PHY_INTERFACE_MODE_RGMII_TXID:
226 if (clk_rate == ETH_CK_F_25M || clk_rate == ETH_CK_F_125M)
233 dev_err(dwmac->dev, "Mode %s does not match eth-ck frequency %d Hz",
234 phy_modes(plat_dat->mac_interface), clk_rate);
238 static int stm32mp1_configure_pmcr(struct plat_stmmacenet_data *plat_dat)
240 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
241 u32 reg = dwmac->mode_reg;
244 switch (plat_dat->mac_interface) {
245 case PHY_INTERFACE_MODE_MII:
247 * STM32MP15xx supports both MII and GMII, STM32MP13xx MII only.
248 * SYSCFG_PMCSETR ETH_SELMII is present only on STM32MP15xx and
249 * acts as a selector between 0:GMII and 1:MII. As STM32MP13xx
250 * supports only MII, ETH_SELMII is not present.
252 if (!dwmac->ops->is_mp13) /* Select MII mode on STM32MP15xx */
253 val |= SYSCFG_PMCR_ETH_SEL_MII;
255 case PHY_INTERFACE_MODE_GMII:
256 val = SYSCFG_PMCR_ETH_SEL_GMII;
257 if (dwmac->enable_eth_ck)
258 val |= SYSCFG_PMCR_ETH_CLK_SEL;
260 case PHY_INTERFACE_MODE_RMII:
261 val = SYSCFG_PMCR_ETH_SEL_RMII;
262 if (dwmac->enable_eth_ck)
263 val |= SYSCFG_PMCR_ETH_REF_CLK_SEL;
265 case PHY_INTERFACE_MODE_RGMII:
266 case PHY_INTERFACE_MODE_RGMII_ID:
267 case PHY_INTERFACE_MODE_RGMII_RXID:
268 case PHY_INTERFACE_MODE_RGMII_TXID:
269 val = SYSCFG_PMCR_ETH_SEL_RGMII;
270 if (dwmac->enable_eth_ck)
271 val |= SYSCFG_PMCR_ETH_CLK_SEL;
274 dev_err(dwmac->dev, "Mode %s not supported",
275 phy_modes(plat_dat->mac_interface));
276 /* Do not manage others interfaces */
280 dev_dbg(dwmac->dev, "Mode %s", phy_modes(plat_dat->mac_interface));
282 /* Shift value at correct ethernet MAC offset in SYSCFG_PMCSETR */
283 val <<= ffs(dwmac->mode_mask) - ffs(SYSCFG_MP1_ETH_MASK);
285 /* Need to update PMCCLRR (clear register) */
286 regmap_write(dwmac->regmap, dwmac->ops->syscfg_clr_off,
289 /* Update PMCSETR (set register) */
290 return regmap_update_bits(dwmac->regmap, reg,
291 dwmac->mode_mask, val);
294 static int stm32mp2_configure_syscfg(struct plat_stmmacenet_data *plat_dat)
296 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
297 u32 reg = dwmac->mode_reg;
300 switch (plat_dat->mac_interface) {
301 case PHY_INTERFACE_MODE_MII:
302 /* ETH_REF_CLK_SEL bit in SYSCFG register is not applicable in MII mode */
304 case PHY_INTERFACE_MODE_RMII:
305 val = SYSCFG_ETHCR_ETH_SEL_RMII;
306 if (dwmac->enable_eth_ck) {
307 /* Internal clock ETH_CLK of 50MHz from RCC is used */
308 val |= SYSCFG_ETHCR_ETH_REF_CLK_SEL;
311 case PHY_INTERFACE_MODE_RGMII:
312 case PHY_INTERFACE_MODE_RGMII_ID:
313 case PHY_INTERFACE_MODE_RGMII_RXID:
314 case PHY_INTERFACE_MODE_RGMII_TXID:
315 val = SYSCFG_ETHCR_ETH_SEL_RGMII;
317 case PHY_INTERFACE_MODE_GMII:
318 if (dwmac->enable_eth_ck) {
319 /* Internal clock ETH_CLK of 125MHz from RCC is used */
320 val |= SYSCFG_ETHCR_ETH_CLK_SEL;
324 dev_err(dwmac->dev, "Mode %s not supported",
325 phy_modes(plat_dat->mac_interface));
326 /* Do not manage others interfaces */
330 dev_dbg(dwmac->dev, "Mode %s", phy_modes(plat_dat->mac_interface));
332 /* Select PTP (IEEE1588) clock selection from RCC (ck_ker_ethxptp) */
333 val |= SYSCFG_ETHCR_ETH_PTP_CLK_SEL;
335 /* Update ETHCR (set register) */
336 return regmap_update_bits(dwmac->regmap, reg,
337 SYSCFG_MP2_ETH_MASK, val);
340 static int stm32mp1_set_mode(struct plat_stmmacenet_data *plat_dat)
342 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
345 ret = stm32mp1_select_ethck_external(plat_dat);
349 ret = stm32mp1_validate_ethck_rate(plat_dat);
353 if (!dwmac->ops->is_mp2)
354 return stm32mp1_configure_pmcr(plat_dat);
356 return stm32mp2_configure_syscfg(plat_dat);
359 static int stm32mcu_set_mode(struct plat_stmmacenet_data *plat_dat)
361 struct stm32_dwmac *dwmac = plat_dat->bsp_priv;
362 u32 reg = dwmac->mode_reg;
365 switch (plat_dat->mac_interface) {
366 case PHY_INTERFACE_MODE_MII:
367 val = SYSCFG_MCU_ETH_SEL_MII;
369 case PHY_INTERFACE_MODE_RMII:
370 val = SYSCFG_MCU_ETH_SEL_RMII;
373 dev_err(dwmac->dev, "Mode %s not supported",
374 phy_modes(plat_dat->mac_interface));
375 /* Do not manage others interfaces */
379 dev_dbg(dwmac->dev, "Mode %s", phy_modes(plat_dat->mac_interface));
381 return regmap_update_bits(dwmac->regmap, reg,
382 SYSCFG_MCU_ETH_MASK, val << 23);
385 static void stm32_dwmac_clk_disable(struct stm32_dwmac *dwmac, bool suspend)
387 clk_disable_unprepare(dwmac->clk_tx);
388 if (!dwmac->ops->clk_rx_enable_in_suspend || !suspend)
389 clk_disable_unprepare(dwmac->clk_rx);
391 clk_disable_unprepare(dwmac->syscfg_clk);
392 if (dwmac->enable_eth_ck)
393 clk_disable_unprepare(dwmac->clk_eth_ck);
396 static int stm32_dwmac_parse_data(struct stm32_dwmac *dwmac,
399 struct device_node *np = dev->of_node;
402 /* Get TX/RX clocks */
403 dwmac->clk_tx = devm_clk_get(dev, "mac-clk-tx");
404 if (IS_ERR(dwmac->clk_tx)) {
405 dev_err(dev, "No ETH Tx clock provided...\n");
406 return PTR_ERR(dwmac->clk_tx);
409 dwmac->clk_rx = devm_clk_get(dev, "mac-clk-rx");
410 if (IS_ERR(dwmac->clk_rx)) {
411 dev_err(dev, "No ETH Rx clock provided...\n");
412 return PTR_ERR(dwmac->clk_rx);
415 if (dwmac->ops->parse_data) {
416 err = dwmac->ops->parse_data(dwmac, dev);
421 /* Get mode register */
422 dwmac->regmap = syscon_regmap_lookup_by_phandle_args(np, "st,syscon",
423 1, &dwmac->mode_reg);
424 if (IS_ERR(dwmac->regmap))
425 return PTR_ERR(dwmac->regmap);
427 if (dwmac->ops->is_mp2)
430 dwmac->mode_mask = SYSCFG_MP1_ETH_MASK;
431 err = of_property_read_u32_index(np, "st,syscon", 2, &dwmac->mode_mask);
433 if (dwmac->ops->is_mp13) {
434 dev_err(dev, "Sysconfig register mask must be set (%d)\n", err);
436 dev_dbg(dev, "Warning sysconfig register mask not set\n");
444 static int stm32mp1_parse_data(struct stm32_dwmac *dwmac,
447 struct platform_device *pdev = to_platform_device(dev);
448 struct device_node *np = dev->of_node;
451 /* Ethernet PHY have no crystal */
452 dwmac->ext_phyclk = of_property_read_bool(np, "st,ext-phyclk");
454 /* Gigabit Ethernet 125MHz clock selection. */
455 dwmac->eth_clk_sel_reg = of_property_read_bool(np, "st,eth-clk-sel");
457 /* Ethernet 50MHz RMII clock selection */
458 dwmac->eth_ref_clk_sel_reg =
459 of_property_read_bool(np, "st,eth-ref-clk-sel");
461 /* Get ETH_CLK clocks */
462 dwmac->clk_eth_ck = devm_clk_get(dev, "eth-ck");
463 if (IS_ERR(dwmac->clk_eth_ck)) {
464 dev_info(dev, "No phy clock provided...\n");
465 dwmac->clk_eth_ck = NULL;
468 /* Clock used for low power mode */
469 dwmac->clk_ethstp = devm_clk_get(dev, "ethstp");
470 if (IS_ERR(dwmac->clk_ethstp)) {
472 "No ETH peripheral clock provided for CStop mode ...\n");
473 return PTR_ERR(dwmac->clk_ethstp);
476 /* Optional Clock for sysconfig */
477 dwmac->syscfg_clk = devm_clk_get(dev, "syscfg-clk");
478 if (IS_ERR(dwmac->syscfg_clk))
479 dwmac->syscfg_clk = NULL;
481 /* Get IRQ information early to have an ability to ask for deferred
482 * probe if needed before we went too far with resource allocation.
484 dwmac->irq_pwr_wakeup = platform_get_irq_byname_optional(pdev,
486 if (dwmac->irq_pwr_wakeup == -EPROBE_DEFER)
487 return -EPROBE_DEFER;
489 if (!dwmac->clk_eth_ck && dwmac->irq_pwr_wakeup >= 0) {
490 err = device_init_wakeup(&pdev->dev, true);
492 dev_err(&pdev->dev, "Failed to init wake up irq\n");
495 err = dev_pm_set_dedicated_wake_irq(&pdev->dev,
496 dwmac->irq_pwr_wakeup);
498 dev_err(&pdev->dev, "Failed to set wake up irq\n");
499 device_init_wakeup(&pdev->dev, false);
501 device_set_wakeup_enable(&pdev->dev, false);
506 static int stm32_dwmac_probe(struct platform_device *pdev)
508 struct plat_stmmacenet_data *plat_dat;
509 struct stmmac_resources stmmac_res;
510 struct stm32_dwmac *dwmac;
511 const struct stm32_ops *data;
514 ret = stmmac_get_platform_resources(pdev, &stmmac_res);
518 plat_dat = devm_stmmac_probe_config_dt(pdev, stmmac_res.mac);
519 if (IS_ERR(plat_dat))
520 return PTR_ERR(plat_dat);
522 dwmac = devm_kzalloc(&pdev->dev, sizeof(*dwmac), GFP_KERNEL);
526 data = of_device_get_match_data(&pdev->dev);
528 dev_err(&pdev->dev, "no of match data provided\n");
533 dwmac->dev = &pdev->dev;
535 ret = stm32_dwmac_parse_data(dwmac, &pdev->dev);
537 dev_err(&pdev->dev, "Unable to parse OF data\n");
541 plat_dat->bsp_priv = dwmac;
543 ret = stm32_dwmac_init(plat_dat, false);
547 ret = stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
549 goto err_clk_disable;
554 stm32_dwmac_clk_disable(dwmac, false);
559 static void stm32_dwmac_remove(struct platform_device *pdev)
561 struct net_device *ndev = platform_get_drvdata(pdev);
562 struct stmmac_priv *priv = netdev_priv(ndev);
563 struct stm32_dwmac *dwmac = priv->plat->bsp_priv;
565 stmmac_dvr_remove(&pdev->dev);
567 stm32_dwmac_clk_disable(dwmac, false);
569 if (dwmac->irq_pwr_wakeup >= 0) {
570 dev_pm_clear_wake_irq(&pdev->dev);
571 device_init_wakeup(&pdev->dev, false);
575 static int stm32mp1_suspend(struct stm32_dwmac *dwmac)
577 return clk_prepare_enable(dwmac->clk_ethstp);
580 static void stm32mp1_resume(struct stm32_dwmac *dwmac)
582 clk_disable_unprepare(dwmac->clk_ethstp);
585 #ifdef CONFIG_PM_SLEEP
586 static int stm32_dwmac_suspend(struct device *dev)
588 struct net_device *ndev = dev_get_drvdata(dev);
589 struct stmmac_priv *priv = netdev_priv(ndev);
590 struct stm32_dwmac *dwmac = priv->plat->bsp_priv;
594 ret = stmmac_suspend(dev);
598 stm32_dwmac_clk_disable(dwmac, true);
600 if (dwmac->ops->suspend)
601 ret = dwmac->ops->suspend(dwmac);
606 static int stm32_dwmac_resume(struct device *dev)
608 struct net_device *ndev = dev_get_drvdata(dev);
609 struct stmmac_priv *priv = netdev_priv(ndev);
610 struct stm32_dwmac *dwmac = priv->plat->bsp_priv;
613 if (dwmac->ops->resume)
614 dwmac->ops->resume(dwmac);
616 ret = stm32_dwmac_init(priv->plat, true);
620 ret = stmmac_resume(dev);
624 #endif /* CONFIG_PM_SLEEP */
626 static SIMPLE_DEV_PM_OPS(stm32_dwmac_pm_ops,
627 stm32_dwmac_suspend, stm32_dwmac_resume);
629 static struct stm32_ops stm32mcu_dwmac_data = {
630 .set_mode = stm32mcu_set_mode
633 static struct stm32_ops stm32mp1_dwmac_data = {
634 .set_mode = stm32mp1_set_mode,
635 .suspend = stm32mp1_suspend,
636 .resume = stm32mp1_resume,
637 .parse_data = stm32mp1_parse_data,
638 .syscfg_clr_off = 0x44,
640 .clk_rx_enable_in_suspend = true
643 static struct stm32_ops stm32mp13_dwmac_data = {
644 .set_mode = stm32mp1_set_mode,
645 .suspend = stm32mp1_suspend,
646 .resume = stm32mp1_resume,
647 .parse_data = stm32mp1_parse_data,
648 .syscfg_clr_off = 0x08,
650 .clk_rx_enable_in_suspend = true
653 static struct stm32_ops stm32mp25_dwmac_data = {
654 .set_mode = stm32mp1_set_mode,
655 .suspend = stm32mp1_suspend,
656 .resume = stm32mp1_resume,
657 .parse_data = stm32mp1_parse_data,
659 .clk_rx_enable_in_suspend = true
662 static const struct of_device_id stm32_dwmac_match[] = {
663 { .compatible = "st,stm32-dwmac", .data = &stm32mcu_dwmac_data},
664 { .compatible = "st,stm32mp1-dwmac", .data = &stm32mp1_dwmac_data},
665 { .compatible = "st,stm32mp13-dwmac", .data = &stm32mp13_dwmac_data},
666 { .compatible = "st,stm32mp25-dwmac", .data = &stm32mp25_dwmac_data},
669 MODULE_DEVICE_TABLE(of, stm32_dwmac_match);
671 static struct platform_driver stm32_dwmac_driver = {
672 .probe = stm32_dwmac_probe,
673 .remove = stm32_dwmac_remove,
675 .name = "stm32-dwmac",
676 .pm = &stm32_dwmac_pm_ops,
677 .of_match_table = stm32_dwmac_match,
680 module_platform_driver(stm32_dwmac_driver);
684 MODULE_DESCRIPTION("STMicroelectronics STM32 DWMAC Specific Glue layer");
685 MODULE_LICENSE("GPL v2");