1 /*******************************************************************************
2   This contains the functions to handle the platform driver.
3 
4   Copyright (C) 2007-2011  STMicroelectronics Ltd
5 
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.
9 
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
13   more details.
14 
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.
18 
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21 
22   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
24 
25 #include <linux/platform_device.h>
26 #include <linux/io.h>
27 #include <linux/of.h>
28 #include <linux/of_net.h>
29 #include "stmmac.h"
30 
31 #ifdef CONFIG_OF
32 static int stmmac_probe_config_dt(struct platform_device *pdev,
33 				  struct plat_stmmacenet_data *plat,
34 				  const char **mac)
35 {
36 	struct device_node *np = pdev->dev.of_node;
37 	struct stmmac_dma_cfg *dma_cfg;
38 
39 	if (!np)
40 		return -ENODEV;
41 
42 	*mac = of_get_mac_address(np);
43 	plat->interface = of_get_phy_mode(np);
44 
45 	plat->bus_id = of_alias_get_id(np, "ethernet");
46 	if (plat->bus_id < 0)
47 		plat->bus_id = 0;
48 
49 	of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr);
50 
51 	plat->mdio_bus_data = devm_kzalloc(&pdev->dev,
52 					   sizeof(struct stmmac_mdio_bus_data),
53 					   GFP_KERNEL);
54 
55 	/*
56 	 * Currently only the properties needed on SPEAr600
57 	 * are provided. All other properties should be added
58 	 * once needed on other platforms.
59 	 */
60 	if (of_device_is_compatible(np, "st,spear600-gmac") ||
61 		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
62 		of_device_is_compatible(np, "snps,dwmac")) {
63 		plat->has_gmac = 1;
64 		plat->pmt = 1;
65 	}
66 
67 	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
68 		of_device_is_compatible(np, "snps,dwmac-3.710")) {
69 		plat->enh_desc = 1;
70 		plat->bugged_jumbo = 1;
71 		plat->force_sf_dma_mode = 1;
72 	}
73 
74 	if (of_find_property(np, "snps,pbl", NULL)) {
75 		dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
76 				       GFP_KERNEL);
77 		if (!dma_cfg)
78 			return -ENOMEM;
79 		plat->dma_cfg = dma_cfg;
80 		of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
81 		dma_cfg->fixed_burst =
82 			of_property_read_bool(np, "snps,fixed-burst");
83 		dma_cfg->mixed_burst =
84 			of_property_read_bool(np, "snps,mixed-burst");
85 	}
86 	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
87 	if (plat->force_thresh_dma_mode) {
88 		plat->force_sf_dma_mode = 0;
89 		pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
90 	}
91 
92 	return 0;
93 }
94 #else
95 static int stmmac_probe_config_dt(struct platform_device *pdev,
96 				  struct plat_stmmacenet_data *plat,
97 				  const char **mac)
98 {
99 	return -ENOSYS;
100 }
101 #endif /* CONFIG_OF */
102 
103 /**
104  * stmmac_pltfr_probe
105  * @pdev: platform device pointer
106  * Description: platform_device probe function. It allocates
107  * the necessary resources and invokes the main to init
108  * the net device, register the mdio bus etc.
109  */
110 static int stmmac_pltfr_probe(struct platform_device *pdev)
111 {
112 	int ret = 0;
113 	struct resource *res;
114 	struct device *dev = &pdev->dev;
115 	void __iomem *addr = NULL;
116 	struct stmmac_priv *priv = NULL;
117 	struct plat_stmmacenet_data *plat_dat = NULL;
118 	const char *mac = NULL;
119 
120 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
121 	addr = devm_ioremap_resource(dev, res);
122 	if (IS_ERR(addr))
123 		return PTR_ERR(addr);
124 
125 	plat_dat = dev_get_platdata(&pdev->dev);
126 	if (pdev->dev.of_node) {
127 		if (!plat_dat)
128 			plat_dat = devm_kzalloc(&pdev->dev,
129 					sizeof(struct plat_stmmacenet_data),
130 					GFP_KERNEL);
131 		if (!plat_dat) {
132 			pr_err("%s: ERROR: no memory", __func__);
133 			return  -ENOMEM;
134 		}
135 
136 		ret = stmmac_probe_config_dt(pdev, plat_dat, &mac);
137 		if (ret) {
138 			pr_err("%s: main dt probe failed", __func__);
139 			return ret;
140 		}
141 	}
142 
143 	/* Custom initialisation (if needed)*/
144 	if (plat_dat->init) {
145 		ret = plat_dat->init(pdev);
146 		if (unlikely(ret))
147 			return ret;
148 	}
149 
150 	priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr);
151 	if (!priv) {
152 		pr_err("%s: main driver probe failed", __func__);
153 		return -ENODEV;
154 	}
155 
156 	/* Get MAC address if available (DT) */
157 	if (mac)
158 		memcpy(priv->dev->dev_addr, mac, ETH_ALEN);
159 
160 	/* Get the MAC information */
161 	priv->dev->irq = platform_get_irq_byname(pdev, "macirq");
162 	if (priv->dev->irq == -ENXIO) {
163 		pr_err("%s: ERROR: MAC IRQ configuration "
164 		       "information not found\n", __func__);
165 		return -ENXIO;
166 	}
167 
168 	/*
169 	 * On some platforms e.g. SPEAr the wake up irq differs from the mac irq
170 	 * The external wake up irq can be passed through the platform code
171 	 * named as "eth_wake_irq"
172 	 *
173 	 * In case the wake up interrupt is not passed from the platform
174 	 * so the driver will continue to use the mac irq (ndev->irq)
175 	 */
176 	priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
177 	if (priv->wol_irq == -ENXIO)
178 		priv->wol_irq = priv->dev->irq;
179 
180 	priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
181 
182 	platform_set_drvdata(pdev, priv->dev);
183 
184 	pr_debug("STMMAC platform driver registration completed");
185 
186 	return 0;
187 }
188 
189 /**
190  * stmmac_pltfr_remove
191  * @pdev: platform device pointer
192  * Description: this function calls the main to free the net resources
193  * and calls the platforms hook and release the resources (e.g. mem).
194  */
195 static int stmmac_pltfr_remove(struct platform_device *pdev)
196 {
197 	struct net_device *ndev = platform_get_drvdata(pdev);
198 	struct stmmac_priv *priv = netdev_priv(ndev);
199 	int ret = stmmac_dvr_remove(ndev);
200 
201 	if (priv->plat->exit)
202 		priv->plat->exit(pdev);
203 
204 	return ret;
205 }
206 
207 #ifdef CONFIG_PM
208 static int stmmac_pltfr_suspend(struct device *dev)
209 {
210 	struct net_device *ndev = dev_get_drvdata(dev);
211 
212 	return stmmac_suspend(ndev);
213 }
214 
215 static int stmmac_pltfr_resume(struct device *dev)
216 {
217 	struct net_device *ndev = dev_get_drvdata(dev);
218 
219 	return stmmac_resume(ndev);
220 }
221 
222 int stmmac_pltfr_freeze(struct device *dev)
223 {
224 	int ret;
225 	struct plat_stmmacenet_data *plat_dat = dev_get_platdata(dev);
226 	struct net_device *ndev = dev_get_drvdata(dev);
227 	struct platform_device *pdev = to_platform_device(dev);
228 
229 	ret = stmmac_freeze(ndev);
230 	if (plat_dat->exit)
231 		plat_dat->exit(pdev);
232 
233 	return ret;
234 }
235 
236 int stmmac_pltfr_restore(struct device *dev)
237 {
238 	struct plat_stmmacenet_data *plat_dat = dev_get_platdata(dev);
239 	struct net_device *ndev = dev_get_drvdata(dev);
240 	struct platform_device *pdev = to_platform_device(dev);
241 
242 	if (plat_dat->init)
243 		plat_dat->init(pdev);
244 
245 	return stmmac_restore(ndev);
246 }
247 
248 static const struct dev_pm_ops stmmac_pltfr_pm_ops = {
249 	.suspend = stmmac_pltfr_suspend,
250 	.resume = stmmac_pltfr_resume,
251 	.freeze = stmmac_pltfr_freeze,
252 	.thaw = stmmac_pltfr_restore,
253 	.restore = stmmac_pltfr_restore,
254 };
255 #else
256 static const struct dev_pm_ops stmmac_pltfr_pm_ops;
257 #endif /* CONFIG_PM */
258 
259 static const struct of_device_id stmmac_dt_ids[] = {
260 	{ .compatible = "st,spear600-gmac"},
261 	{ .compatible = "snps,dwmac-3.610"},
262 	{ .compatible = "snps,dwmac-3.70a"},
263 	{ .compatible = "snps,dwmac-3.710"},
264 	{ .compatible = "snps,dwmac"},
265 	{ /* sentinel */ }
266 };
267 MODULE_DEVICE_TABLE(of, stmmac_dt_ids);
268 
269 struct platform_driver stmmac_pltfr_driver = {
270 	.probe = stmmac_pltfr_probe,
271 	.remove = stmmac_pltfr_remove,
272 	.driver = {
273 		   .name = STMMAC_RESOURCE_NAME,
274 		   .owner = THIS_MODULE,
275 		   .pm = &stmmac_pltfr_pm_ops,
276 		   .of_match_table = of_match_ptr(stmmac_dt_ids),
277 		   },
278 };
279 
280 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver");
281 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
282 MODULE_LICENSE("GPL");
283