1 /*******************************************************************************
2 This contains the functions to handle the platform driver.
4 Copyright (C) 2007-2011 STMicroelectronics Ltd
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
22 Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
25 #include <linux/platform_device.h>
28 #include <linux/of_net.h>
29 #include <linux/of_device.h>
32 static const struct of_device_id stmmac_dt_ids[] = {
33 #ifdef CONFIG_DWMAC_SUNXI
34 { .compatible = "allwinner,sun7i-a20-gmac", .data = &sun7i_gmac_data},
36 #ifdef CONFIG_DWMAC_STI
37 { .compatible = "st,stih415-dwmac", .data = &sti_gmac_data},
38 { .compatible = "st,stih416-dwmac", .data = &sti_gmac_data},
39 { .compatible = "st,stih127-dwmac", .data = &sti_gmac_data},
41 /* SoC specific glue layers should come before generic bindings */
42 { .compatible = "st,spear600-gmac"},
43 { .compatible = "snps,dwmac-3.610"},
44 { .compatible = "snps,dwmac-3.70a"},
45 { .compatible = "snps,dwmac-3.710"},
46 { .compatible = "snps,dwmac"},
49 MODULE_DEVICE_TABLE(of, stmmac_dt_ids);
52 static int stmmac_probe_config_dt(struct platform_device *pdev,
53 struct plat_stmmacenet_data *plat,
56 struct device_node *np = pdev->dev.of_node;
57 struct stmmac_dma_cfg *dma_cfg;
58 const struct of_device_id *device;
63 device = of_match_device(stmmac_dt_ids, &pdev->dev);
68 const struct stmmac_of_data *data = device->data;
69 plat->has_gmac = data->has_gmac;
70 plat->enh_desc = data->enh_desc;
71 plat->tx_coe = data->tx_coe;
72 plat->rx_coe = data->rx_coe;
73 plat->bugged_jumbo = data->bugged_jumbo;
74 plat->pmt = data->pmt;
75 plat->riwt_off = data->riwt_off;
76 plat->fix_mac_speed = data->fix_mac_speed;
77 plat->bus_setup = data->bus_setup;
78 plat->setup = data->setup;
79 plat->free = data->free;
80 plat->init = data->init;
81 plat->exit = data->exit;
84 *mac = of_get_mac_address(np);
85 plat->interface = of_get_phy_mode(np);
87 /* Get max speed of operation from device tree */
88 if (of_property_read_u32(np, "max-speed", &plat->max_speed))
91 plat->bus_id = of_alias_get_id(np, "ethernet");
95 /* Default to phy auto-detection */
98 /* "snps,phy-addr" is not a standard property. Mark it as deprecated
99 * and warn of its use. Remove this when phy node support is added.
101 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
102 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
104 plat->mdio_bus_data = devm_kzalloc(&pdev->dev,
105 sizeof(struct stmmac_mdio_bus_data),
108 plat->force_sf_dma_mode = of_property_read_bool(np, "snps,force_sf_dma_mode");
110 /* Set the maxmtu to a default of JUMBO_LEN in case the
111 * parameter is not present in the device tree.
113 plat->maxmtu = JUMBO_LEN;
116 * Currently only the properties needed on SPEAr600
117 * are provided. All other properties should be added
118 * once needed on other platforms.
120 if (of_device_is_compatible(np, "st,spear600-gmac") ||
121 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
122 of_device_is_compatible(np, "snps,dwmac")) {
123 /* Note that the max-frame-size parameter as defined in the
124 * ePAPR v1.1 spec is defined as max-frame-size, it's
125 * actually used as the IEEE definition of MAC Client
126 * data, or MTU. The ePAPR specification is confusing as
127 * the definition is max-frame-size, but usage examples
130 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
135 if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
136 of_device_is_compatible(np, "snps,dwmac-3.710")) {
138 plat->bugged_jumbo = 1;
139 plat->force_sf_dma_mode = 1;
142 if (of_find_property(np, "snps,pbl", NULL)) {
143 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
147 plat->dma_cfg = dma_cfg;
148 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
149 dma_cfg->fixed_burst =
150 of_property_read_bool(np, "snps,fixed-burst");
151 dma_cfg->mixed_burst =
152 of_property_read_bool(np, "snps,mixed-burst");
154 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
155 if (plat->force_thresh_dma_mode) {
156 plat->force_sf_dma_mode = 0;
157 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
163 static int stmmac_probe_config_dt(struct platform_device *pdev,
164 struct plat_stmmacenet_data *plat,
169 #endif /* CONFIG_OF */
173 * @pdev: platform device pointer
174 * Description: platform_device probe function. It allocates
175 * the necessary resources and invokes the main to init
176 * the net device, register the mdio bus etc.
178 static int stmmac_pltfr_probe(struct platform_device *pdev)
181 struct resource *res;
182 struct device *dev = &pdev->dev;
183 void __iomem *addr = NULL;
184 struct stmmac_priv *priv = NULL;
185 struct plat_stmmacenet_data *plat_dat = NULL;
186 const char *mac = NULL;
188 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
189 addr = devm_ioremap_resource(dev, res);
191 return PTR_ERR(addr);
193 plat_dat = dev_get_platdata(&pdev->dev);
194 if (pdev->dev.of_node) {
196 plat_dat = devm_kzalloc(&pdev->dev,
197 sizeof(struct plat_stmmacenet_data),
200 pr_err("%s: ERROR: no memory", __func__);
204 ret = stmmac_probe_config_dt(pdev, plat_dat, &mac);
206 pr_err("%s: main dt probe failed", __func__);
211 /* Custom setup (if needed) */
212 if (plat_dat->setup) {
213 plat_dat->bsp_priv = plat_dat->setup(pdev);
214 if (IS_ERR(plat_dat->bsp_priv))
215 return PTR_ERR(plat_dat->bsp_priv);
218 /* Custom initialisation (if needed)*/
219 if (plat_dat->init) {
220 ret = plat_dat->init(pdev, plat_dat->bsp_priv);
225 priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr);
227 pr_err("%s: main driver probe failed", __func__);
228 return PTR_ERR(priv);
231 /* Get MAC address if available (DT) */
233 memcpy(priv->dev->dev_addr, mac, ETH_ALEN);
235 /* Get the MAC information */
236 priv->dev->irq = platform_get_irq_byname(pdev, "macirq");
237 if (priv->dev->irq == -ENXIO) {
238 pr_err("%s: ERROR: MAC IRQ configuration "
239 "information not found\n", __func__);
244 * On some platforms e.g. SPEAr the wake up irq differs from the mac irq
245 * The external wake up irq can be passed through the platform code
246 * named as "eth_wake_irq"
248 * In case the wake up interrupt is not passed from the platform
249 * so the driver will continue to use the mac irq (ndev->irq)
251 priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
252 if (priv->wol_irq == -ENXIO)
253 priv->wol_irq = priv->dev->irq;
255 priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
257 platform_set_drvdata(pdev, priv->dev);
259 pr_debug("STMMAC platform driver registration completed");
265 * stmmac_pltfr_remove
266 * @pdev: platform device pointer
267 * Description: this function calls the main to free the net resources
268 * and calls the platforms hook and release the resources (e.g. mem).
270 static int stmmac_pltfr_remove(struct platform_device *pdev)
272 struct net_device *ndev = platform_get_drvdata(pdev);
273 struct stmmac_priv *priv = netdev_priv(ndev);
274 int ret = stmmac_dvr_remove(ndev);
276 if (priv->plat->exit)
277 priv->plat->exit(pdev, priv->plat->bsp_priv);
279 if (priv->plat->free)
280 priv->plat->free(pdev, priv->plat->bsp_priv);
286 static int stmmac_pltfr_suspend(struct device *dev)
289 struct net_device *ndev = dev_get_drvdata(dev);
290 struct stmmac_priv *priv = netdev_priv(ndev);
291 struct platform_device *pdev = to_platform_device(dev);
293 ret = stmmac_suspend(ndev);
294 if (priv->plat->exit)
295 priv->plat->exit(pdev, priv->plat->bsp_priv);
300 static int stmmac_pltfr_resume(struct device *dev)
302 struct net_device *ndev = dev_get_drvdata(dev);
303 struct stmmac_priv *priv = netdev_priv(ndev);
304 struct platform_device *pdev = to_platform_device(dev);
306 if (priv->plat->init)
307 priv->plat->init(pdev, priv->plat->bsp_priv);
309 return stmmac_resume(ndev);
312 #endif /* CONFIG_PM */
314 static SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops,
315 stmmac_pltfr_suspend, stmmac_pltfr_resume);
317 struct platform_driver stmmac_pltfr_driver = {
318 .probe = stmmac_pltfr_probe,
319 .remove = stmmac_pltfr_remove,
321 .name = STMMAC_RESOURCE_NAME,
322 .owner = THIS_MODULE,
323 .pm = &stmmac_pltfr_pm_ops,
324 .of_match_table = of_match_ptr(stmmac_dt_ids),
328 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver");
329 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
330 MODULE_LICENSE("GPL");