1 /* Copyright Altera Corporation (C) 2014. All rights reserved.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License, version 2,
5 * as published by the Free Software Foundation.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 * Adopted from dwmac-sti.c
18 #include <linux/mfd/syscon.h>
20 #include <linux/of_address.h>
21 #include <linux/of_net.h>
22 #include <linux/phy.h>
23 #include <linux/regmap.h>
24 #include <linux/reset.h>
25 #include <linux/stmmac.h>
28 #include "stmmac_platform.h"
30 #include "altr_tse_pcs.h"
32 #define SGMII_ADAPTER_CTRL_REG 0x00
33 #define SGMII_ADAPTER_DISABLE 0x0001
35 #define SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_GMII_MII 0x0
36 #define SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_RGMII 0x1
37 #define SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_RMII 0x2
38 #define SYSMGR_EMACGRP_CTRL_PHYSEL_WIDTH 2
39 #define SYSMGR_EMACGRP_CTRL_PHYSEL_MASK 0x00000003
40 #define SYSMGR_EMACGRP_CTRL_PTP_REF_CLK_MASK 0x00000010
42 #define SYSMGR_FPGAGRP_MODULE_REG 0x00000028
43 #define SYSMGR_FPGAGRP_MODULE_EMAC 0x00000004
45 #define EMAC_SPLITTER_CTRL_REG 0x0
46 #define EMAC_SPLITTER_CTRL_SPEED_MASK 0x3
47 #define EMAC_SPLITTER_CTRL_SPEED_10 0x2
48 #define EMAC_SPLITTER_CTRL_SPEED_100 0x3
49 #define EMAC_SPLITTER_CTRL_SPEED_1000 0x0
51 struct socfpga_dwmac {
56 struct regmap *sys_mgr_base_addr;
57 struct reset_control *stmmac_rst;
58 void __iomem *splitter_base;
63 static void socfpga_dwmac_fix_mac_speed(void *priv, unsigned int speed)
65 struct socfpga_dwmac *dwmac = (struct socfpga_dwmac *)priv;
66 void __iomem *splitter_base = dwmac->splitter_base;
67 void __iomem *tse_pcs_base = dwmac->pcs.tse_pcs_base;
68 void __iomem *sgmii_adapter_base = dwmac->pcs.sgmii_adapter_base;
69 struct device *dev = dwmac->dev;
70 struct net_device *ndev = dev_get_drvdata(dev);
71 struct phy_device *phy_dev = ndev->phydev;
74 if ((tse_pcs_base) && (sgmii_adapter_base))
75 writew(SGMII_ADAPTER_DISABLE,
76 sgmii_adapter_base + SGMII_ADAPTER_CTRL_REG);
79 val = readl(splitter_base + EMAC_SPLITTER_CTRL_REG);
80 val &= ~EMAC_SPLITTER_CTRL_SPEED_MASK;
84 val |= EMAC_SPLITTER_CTRL_SPEED_1000;
87 val |= EMAC_SPLITTER_CTRL_SPEED_100;
90 val |= EMAC_SPLITTER_CTRL_SPEED_10;
95 writel(val, splitter_base + EMAC_SPLITTER_CTRL_REG);
98 if (tse_pcs_base && sgmii_adapter_base)
99 tse_pcs_fix_mac_speed(&dwmac->pcs, phy_dev, speed);
102 static int socfpga_dwmac_parse_data(struct socfpga_dwmac *dwmac, struct device *dev)
104 struct device_node *np = dev->of_node;
105 struct regmap *sys_mgr_base_addr;
106 u32 reg_offset, reg_shift;
108 struct device_node *np_splitter = NULL;
109 struct device_node *np_sgmii_adapter = NULL;
110 struct resource res_splitter;
111 struct resource res_tse_pcs;
112 struct resource res_sgmii_adapter;
114 dwmac->interface = of_get_phy_mode(np);
116 sys_mgr_base_addr = syscon_regmap_lookup_by_phandle(np, "altr,sysmgr-syscon");
117 if (IS_ERR(sys_mgr_base_addr)) {
118 dev_info(dev, "No sysmgr-syscon node found\n");
119 return PTR_ERR(sys_mgr_base_addr);
122 ret = of_property_read_u32_index(np, "altr,sysmgr-syscon", 1, ®_offset);
124 dev_info(dev, "Could not read reg_offset from sysmgr-syscon!\n");
128 ret = of_property_read_u32_index(np, "altr,sysmgr-syscon", 2, ®_shift);
130 dev_info(dev, "Could not read reg_shift from sysmgr-syscon!\n");
134 dwmac->f2h_ptp_ref_clk = of_property_read_bool(np, "altr,f2h_ptp_ref_clk");
136 np_splitter = of_parse_phandle(np, "altr,emac-splitter", 0);
138 ret = of_address_to_resource(np_splitter, 0, &res_splitter);
139 of_node_put(np_splitter);
141 dev_info(dev, "Missing emac splitter address\n");
145 dwmac->splitter_base = devm_ioremap_resource(dev, &res_splitter);
146 if (IS_ERR(dwmac->splitter_base)) {
147 dev_info(dev, "Failed to mapping emac splitter\n");
148 return PTR_ERR(dwmac->splitter_base);
152 np_sgmii_adapter = of_parse_phandle(np,
153 "altr,gmii-to-sgmii-converter", 0);
154 if (np_sgmii_adapter) {
155 index = of_property_match_string(np_sgmii_adapter, "reg-names",
156 "hps_emac_interface_splitter_avalon_slave");
159 if (of_address_to_resource(np_sgmii_adapter, index,
162 "%s: ERROR: missing emac splitter address\n",
168 dwmac->splitter_base =
169 devm_ioremap_resource(dev, &res_splitter);
171 if (IS_ERR(dwmac->splitter_base)) {
172 ret = PTR_ERR(dwmac->splitter_base);
177 index = of_property_match_string(np_sgmii_adapter, "reg-names",
178 "gmii_to_sgmii_adapter_avalon_slave");
181 if (of_address_to_resource(np_sgmii_adapter, index,
182 &res_sgmii_adapter)) {
184 "%s: ERROR: failed mapping adapter\n",
190 dwmac->pcs.sgmii_adapter_base =
191 devm_ioremap_resource(dev, &res_sgmii_adapter);
193 if (IS_ERR(dwmac->pcs.sgmii_adapter_base)) {
194 ret = PTR_ERR(dwmac->pcs.sgmii_adapter_base);
199 index = of_property_match_string(np_sgmii_adapter, "reg-names",
200 "eth_tse_control_port");
203 if (of_address_to_resource(np_sgmii_adapter, index,
206 "%s: ERROR: failed mapping tse control port\n",
212 dwmac->pcs.tse_pcs_base =
213 devm_ioremap_resource(dev, &res_tse_pcs);
215 if (IS_ERR(dwmac->pcs.tse_pcs_base)) {
216 ret = PTR_ERR(dwmac->pcs.tse_pcs_base);
221 dwmac->reg_offset = reg_offset;
222 dwmac->reg_shift = reg_shift;
223 dwmac->sys_mgr_base_addr = sys_mgr_base_addr;
225 of_node_put(np_sgmii_adapter);
230 of_node_put(np_sgmii_adapter);
234 static int socfpga_dwmac_set_phy_mode(struct socfpga_dwmac *dwmac)
236 struct regmap *sys_mgr_base_addr = dwmac->sys_mgr_base_addr;
237 int phymode = dwmac->interface;
238 u32 reg_offset = dwmac->reg_offset;
239 u32 reg_shift = dwmac->reg_shift;
240 u32 ctrl, val, module;
243 case PHY_INTERFACE_MODE_RGMII:
244 case PHY_INTERFACE_MODE_RGMII_ID:
245 val = SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_RGMII;
247 case PHY_INTERFACE_MODE_MII:
248 case PHY_INTERFACE_MODE_GMII:
249 case PHY_INTERFACE_MODE_SGMII:
250 val = SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_GMII_MII;
253 dev_err(dwmac->dev, "bad phy mode %d\n", phymode);
257 /* Overwrite val to GMII if splitter core is enabled. The phymode here
258 * is the actual phy mode on phy hardware, but phy interface from
261 if (dwmac->splitter_base)
262 val = SYSMGR_EMACGRP_CTRL_PHYSEL_ENUM_GMII_MII;
264 /* Assert reset to the enet controller before changing the phy mode */
265 if (dwmac->stmmac_rst)
266 reset_control_assert(dwmac->stmmac_rst);
268 regmap_read(sys_mgr_base_addr, reg_offset, &ctrl);
269 ctrl &= ~(SYSMGR_EMACGRP_CTRL_PHYSEL_MASK << reg_shift);
270 ctrl |= val << reg_shift;
272 if (dwmac->f2h_ptp_ref_clk ||
273 phymode == PHY_INTERFACE_MODE_MII ||
274 phymode == PHY_INTERFACE_MODE_GMII ||
275 phymode == PHY_INTERFACE_MODE_SGMII) {
276 ctrl |= SYSMGR_EMACGRP_CTRL_PTP_REF_CLK_MASK << (reg_shift / 2);
277 regmap_read(sys_mgr_base_addr, SYSMGR_FPGAGRP_MODULE_REG,
279 module |= (SYSMGR_FPGAGRP_MODULE_EMAC << (reg_shift / 2));
280 regmap_write(sys_mgr_base_addr, SYSMGR_FPGAGRP_MODULE_REG,
283 ctrl &= ~(SYSMGR_EMACGRP_CTRL_PTP_REF_CLK_MASK << (reg_shift / 2));
286 regmap_write(sys_mgr_base_addr, reg_offset, ctrl);
288 /* Deassert reset for the phy configuration to be sampled by
289 * the enet controller, and operation to start in requested mode
291 if (dwmac->stmmac_rst)
292 reset_control_deassert(dwmac->stmmac_rst);
293 if (phymode == PHY_INTERFACE_MODE_SGMII) {
294 if (tse_pcs_init(dwmac->pcs.tse_pcs_base, &dwmac->pcs) != 0) {
295 dev_err(dwmac->dev, "Unable to initialize TSE PCS");
303 static int socfpga_dwmac_probe(struct platform_device *pdev)
305 struct plat_stmmacenet_data *plat_dat;
306 struct stmmac_resources stmmac_res;
307 struct device *dev = &pdev->dev;
309 struct socfpga_dwmac *dwmac;
310 struct net_device *ndev;
311 struct stmmac_priv *stpriv;
313 ret = stmmac_get_platform_resources(pdev, &stmmac_res);
317 plat_dat = stmmac_probe_config_dt(pdev, &stmmac_res.mac);
318 if (IS_ERR(plat_dat))
319 return PTR_ERR(plat_dat);
321 dwmac = devm_kzalloc(dev, sizeof(*dwmac), GFP_KERNEL);
324 goto err_remove_config_dt;
327 ret = socfpga_dwmac_parse_data(dwmac, dev);
329 dev_err(dev, "Unable to parse OF data\n");
330 goto err_remove_config_dt;
333 plat_dat->bsp_priv = dwmac;
334 plat_dat->fix_mac_speed = socfpga_dwmac_fix_mac_speed;
336 ret = stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
338 goto err_remove_config_dt;
340 ndev = platform_get_drvdata(pdev);
341 stpriv = netdev_priv(ndev);
343 /* The socfpga driver needs to control the stmmac reset to set the phy
344 * mode. Create a copy of the core reset handle so it can be used by
347 dwmac->stmmac_rst = stpriv->plat->stmmac_rst;
349 ret = socfpga_dwmac_set_phy_mode(dwmac);
356 stmmac_dvr_remove(&pdev->dev);
357 err_remove_config_dt:
358 stmmac_remove_config_dt(pdev, plat_dat);
363 #ifdef CONFIG_PM_SLEEP
364 static int socfpga_dwmac_resume(struct device *dev)
366 struct net_device *ndev = dev_get_drvdata(dev);
367 struct stmmac_priv *priv = netdev_priv(ndev);
369 socfpga_dwmac_set_phy_mode(priv->plat->bsp_priv);
371 /* Before the enet controller is suspended, the phy is suspended.
372 * This causes the phy clock to be gated. The enet controller is
373 * resumed before the phy, so the clock is still gated "off" when
374 * the enet controller is resumed. This code makes sure the phy
375 * is "resumed" before reinitializing the enet controller since
376 * the enet controller depends on an active phy clock to complete
377 * a DMA reset. A DMA reset will "time out" if executed
378 * with no phy clock input on the Synopsys enet controller.
379 * Verified through Synopsys Case #8000711656.
381 * Note that the phy clock is also gated when the phy is isolated.
382 * Phy "suspend" and "isolate" controls are located in phy basic
383 * control register 0, and can be modified by the phy driver
387 phy_resume(ndev->phydev);
389 return stmmac_resume(dev);
391 #endif /* CONFIG_PM_SLEEP */
393 static SIMPLE_DEV_PM_OPS(socfpga_dwmac_pm_ops, stmmac_suspend,
394 socfpga_dwmac_resume);
396 static const struct of_device_id socfpga_dwmac_match[] = {
397 { .compatible = "altr,socfpga-stmmac" },
400 MODULE_DEVICE_TABLE(of, socfpga_dwmac_match);
402 static struct platform_driver socfpga_dwmac_driver = {
403 .probe = socfpga_dwmac_probe,
404 .remove = stmmac_pltfr_remove,
406 .name = "socfpga-dwmac",
407 .pm = &socfpga_dwmac_pm_ops,
408 .of_match_table = socfpga_dwmac_match,
411 module_platform_driver(socfpga_dwmac_driver);
413 MODULE_LICENSE("GPL v2");