Commit | Line | Data |
---|---|---|
bfab27a1 GC |
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> | |
6a228452 SR |
27 | #include <linux/of.h> |
28 | #include <linux/of_net.h> | |
022066f5 | 29 | #include <linux/of_device.h> |
f10f9fb2 | 30 | |
bfab27a1 | 31 | #include "stmmac.h" |
f10f9fb2 | 32 | #include "stmmac_platform.h" |
bfab27a1 | 33 | |
022066f5 | 34 | static const struct of_device_id stmmac_dt_ids[] = { |
c0d54066 | 35 | /* SoC specific glue layers should come before generic bindings */ |
7ad269ea | 36 | { .compatible = "rockchip,rk3288-gmac", .data = &rk3288_gmac_data}, |
0ad5adcd | 37 | { .compatible = "amlogic,meson6-dwmac", .data = &meson6_dwmac_data}, |
af0bd4e9 | 38 | { .compatible = "allwinner,sun7i-a20-gmac", .data = &sun7i_gmac_data}, |
71ae8f52 GC |
39 | { .compatible = "st,stih415-dwmac", .data = &stih4xx_dwmac_data}, |
40 | { .compatible = "st,stih416-dwmac", .data = &stih4xx_dwmac_data}, | |
41 | { .compatible = "st,stid127-dwmac", .data = &stid127_dwmac_data}, | |
42 | { .compatible = "st,stih407-dwmac", .data = &stih4xx_dwmac_data}, | |
801d233b | 43 | { .compatible = "altr,socfpga-stmmac", .data = &socfpga_gmac_data }, |
022066f5 CYT |
44 | { .compatible = "st,spear600-gmac"}, |
45 | { .compatible = "snps,dwmac-3.610"}, | |
46 | { .compatible = "snps,dwmac-3.70a"}, | |
47 | { .compatible = "snps,dwmac-3.710"}, | |
48 | { .compatible = "snps,dwmac"}, | |
49 | { /* sentinel */ } | |
50 | }; | |
51 | MODULE_DEVICE_TABLE(of, stmmac_dt_ids); | |
52 | ||
6a228452 | 53 | #ifdef CONFIG_OF |
3b57de95 | 54 | |
732fdf0e GC |
55 | /** |
56 | * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins | |
57 | * @mcast_bins: Multicast filtering bins | |
58 | * Description: | |
59 | * this function validates the number of Multicast filtering bins specified | |
3b57de95 VB |
60 | * by the configuration through the device tree. The Synopsys GMAC supports |
61 | * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC | |
62 | * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds | |
63 | * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is | |
64 | * invalid and will cause the filtering algorithm to use Multicast | |
65 | * promiscuous mode. | |
66 | */ | |
67 | static int dwmac1000_validate_mcast_bins(int mcast_bins) | |
68 | { | |
69 | int x = mcast_bins; | |
70 | ||
71 | switch (x) { | |
72 | case HASH_TABLE_SIZE: | |
73 | case 128: | |
74 | case 256: | |
75 | break; | |
76 | default: | |
77 | x = 0; | |
78 | pr_info("Hash table entries set to unexpected value %d", | |
79 | mcast_bins); | |
80 | break; | |
81 | } | |
82 | return x; | |
83 | } | |
84 | ||
732fdf0e GC |
85 | /** |
86 | * dwmac1000_validate_ucast_entries - validate the Unicast address entries | |
87 | * @ucast_entries: number of Unicast address entries | |
88 | * Description: | |
89 | * This function validates the number of Unicast address entries supported | |
3b57de95 VB |
90 | * by a particular Synopsys 10/100/1000 controller. The Synopsys controller |
91 | * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter | |
92 | * logic. This function validates a valid, supported configuration is | |
93 | * selected, and defaults to 1 Unicast address if an unsupported | |
94 | * configuration is selected. | |
95 | */ | |
96 | static int dwmac1000_validate_ucast_entries(int ucast_entries) | |
97 | { | |
98 | int x = ucast_entries; | |
99 | ||
100 | switch (x) { | |
101 | case 1: | |
102 | case 32: | |
103 | case 64: | |
104 | case 128: | |
105 | break; | |
106 | default: | |
107 | x = 1; | |
108 | pr_info("Unicast table entries set to unexpected value %d\n", | |
109 | ucast_entries); | |
110 | break; | |
111 | } | |
112 | return x; | |
113 | } | |
114 | ||
732fdf0e GC |
115 | /** |
116 | * stmmac_probe_config_dt - parse device-tree driver parameters | |
117 | * @pdev: platform_device structure | |
118 | * @plat: driver data platform structure | |
119 | * @mac: MAC address to use | |
120 | * Description: | |
121 | * this function is to read the driver parameters from device-tree and | |
122 | * set some private fields that will be used by the main at runtime. | |
123 | */ | |
979857bb | 124 | static int stmmac_probe_config_dt(struct platform_device *pdev, |
1dd06ae8 GKH |
125 | struct plat_stmmacenet_data *plat, |
126 | const char **mac) | |
6a228452 SR |
127 | { |
128 | struct device_node *np = pdev->dev.of_node; | |
25c83b5c | 129 | struct stmmac_dma_cfg *dma_cfg; |
022066f5 | 130 | const struct of_device_id *device; |
6a228452 SR |
131 | |
132 | if (!np) | |
133 | return -ENODEV; | |
134 | ||
022066f5 CYT |
135 | device = of_match_device(stmmac_dt_ids, &pdev->dev); |
136 | if (!device) | |
137 | return -ENODEV; | |
138 | ||
139 | if (device->data) { | |
140 | const struct stmmac_of_data *data = device->data; | |
141 | plat->has_gmac = data->has_gmac; | |
142 | plat->enh_desc = data->enh_desc; | |
143 | plat->tx_coe = data->tx_coe; | |
144 | plat->rx_coe = data->rx_coe; | |
145 | plat->bugged_jumbo = data->bugged_jumbo; | |
146 | plat->pmt = data->pmt; | |
147 | plat->riwt_off = data->riwt_off; | |
148 | plat->fix_mac_speed = data->fix_mac_speed; | |
149 | plat->bus_setup = data->bus_setup; | |
150 | plat->setup = data->setup; | |
151 | plat->free = data->free; | |
152 | plat->init = data->init; | |
153 | plat->exit = data->exit; | |
154 | } | |
155 | ||
6a228452 SR |
156 | *mac = of_get_mac_address(np); |
157 | plat->interface = of_get_phy_mode(np); | |
25c83b5c | 158 | |
9cbadf09 SK |
159 | /* Get max speed of operation from device tree */ |
160 | if (of_property_read_u32(np, "max-speed", &plat->max_speed)) | |
161 | plat->max_speed = -1; | |
162 | ||
25c83b5c SK |
163 | plat->bus_id = of_alias_get_id(np, "ethernet"); |
164 | if (plat->bus_id < 0) | |
165 | plat->bus_id = 0; | |
166 | ||
436f7ecd CYT |
167 | /* Default to phy auto-detection */ |
168 | plat->phy_addr = -1; | |
169 | ||
170 | /* "snps,phy-addr" is not a standard property. Mark it as deprecated | |
171 | * and warn of its use. Remove this when phy node support is added. | |
172 | */ | |
173 | if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0) | |
174 | dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n"); | |
25c83b5c | 175 | |
8c2a7a5d GC |
176 | if (plat->phy_bus_name) |
177 | plat->mdio_bus_data = NULL; | |
178 | else | |
179 | plat->mdio_bus_data = | |
180 | devm_kzalloc(&pdev->dev, | |
181 | sizeof(struct stmmac_mdio_bus_data), | |
182 | GFP_KERNEL); | |
183 | ||
184 | plat->force_sf_dma_mode = | |
185 | of_property_read_bool(np, "snps,force_sf_dma_mode"); | |
6aedb8c0 | 186 | |
2618abb7 VB |
187 | /* Set the maxmtu to a default of JUMBO_LEN in case the |
188 | * parameter is not present in the device tree. | |
189 | */ | |
190 | plat->maxmtu = JUMBO_LEN; | |
191 | ||
6a228452 SR |
192 | /* |
193 | * Currently only the properties needed on SPEAr600 | |
194 | * are provided. All other properties should be added | |
195 | * once needed on other platforms. | |
196 | */ | |
84c9f8c4 DN |
197 | if (of_device_is_compatible(np, "st,spear600-gmac") || |
198 | of_device_is_compatible(np, "snps,dwmac-3.70a") || | |
199 | of_device_is_compatible(np, "snps,dwmac")) { | |
2618abb7 VB |
200 | /* Note that the max-frame-size parameter as defined in the |
201 | * ePAPR v1.1 spec is defined as max-frame-size, it's | |
202 | * actually used as the IEEE definition of MAC Client | |
203 | * data, or MTU. The ePAPR specification is confusing as | |
204 | * the definition is max-frame-size, but usage examples | |
205 | * are clearly MTUs | |
206 | */ | |
207 | of_property_read_u32(np, "max-frame-size", &plat->maxmtu); | |
3b57de95 VB |
208 | of_property_read_u32(np, "snps,multicast-filter-bins", |
209 | &plat->multicast_filter_bins); | |
210 | of_property_read_u32(np, "snps,perfect-filter-entries", | |
211 | &plat->unicast_filter_entries); | |
212 | plat->unicast_filter_entries = dwmac1000_validate_ucast_entries( | |
213 | plat->unicast_filter_entries); | |
214 | plat->multicast_filter_bins = dwmac1000_validate_mcast_bins( | |
215 | plat->multicast_filter_bins); | |
6a228452 SR |
216 | plat->has_gmac = 1; |
217 | plat->pmt = 1; | |
218 | } | |
219 | ||
25c83b5c SK |
220 | if (of_device_is_compatible(np, "snps,dwmac-3.610") || |
221 | of_device_is_compatible(np, "snps,dwmac-3.710")) { | |
222 | plat->enh_desc = 1; | |
223 | plat->bugged_jumbo = 1; | |
224 | plat->force_sf_dma_mode = 1; | |
225 | } | |
226 | ||
64c3b252 BA |
227 | if (of_find_property(np, "snps,pbl", NULL)) { |
228 | dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg), | |
229 | GFP_KERNEL); | |
230 | if (!dma_cfg) | |
231 | return -ENOMEM; | |
232 | plat->dma_cfg = dma_cfg; | |
233 | of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl); | |
234 | dma_cfg->fixed_burst = | |
235 | of_property_read_bool(np, "snps,fixed-burst"); | |
236 | dma_cfg->mixed_burst = | |
237 | of_property_read_bool(np, "snps,mixed-burst"); | |
fa067467 SZ |
238 | of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len); |
239 | if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256) | |
240 | dma_cfg->burst_len = 0; | |
64c3b252 | 241 | } |
e2a240c7 SZ |
242 | plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode"); |
243 | if (plat->force_thresh_dma_mode) { | |
244 | plat->force_sf_dma_mode = 0; | |
245 | pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set."); | |
356f9e74 | 246 | } |
25c83b5c | 247 | |
6a228452 SR |
248 | return 0; |
249 | } | |
250 | #else | |
979857bb | 251 | static int stmmac_probe_config_dt(struct platform_device *pdev, |
1dd06ae8 GKH |
252 | struct plat_stmmacenet_data *plat, |
253 | const char **mac) | |
6a228452 SR |
254 | { |
255 | return -ENOSYS; | |
256 | } | |
257 | #endif /* CONFIG_OF */ | |
258 | ||
bfab27a1 | 259 | /** |
732fdf0e | 260 | * stmmac_pltfr_probe - platform driver probe. |
bfab27a1 | 261 | * @pdev: platform device pointer |
732fdf0e GC |
262 | * Description: platform_device probe function. It is to allocate |
263 | * the necessary platform resources, invoke custom helper (if required) and | |
264 | * invoke the main probe function. | |
bfab27a1 | 265 | */ |
979857bb | 266 | static int stmmac_pltfr_probe(struct platform_device *pdev) |
bfab27a1 GC |
267 | { |
268 | int ret = 0; | |
269 | struct resource *res; | |
3f8bdecd | 270 | struct device *dev = &pdev->dev; |
bfab27a1 GC |
271 | void __iomem *addr = NULL; |
272 | struct stmmac_priv *priv = NULL; | |
6a228452 SR |
273 | struct plat_stmmacenet_data *plat_dat = NULL; |
274 | const char *mac = NULL; | |
bfab27a1 GC |
275 | |
276 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); | |
5760f427 SMP |
277 | addr = devm_ioremap_resource(dev, res); |
278 | if (IS_ERR(addr)) | |
279 | return PTR_ERR(addr); | |
6a228452 | 280 | |
f91b29f5 | 281 | plat_dat = dev_get_platdata(&pdev->dev); |
571dcfde | 282 | |
28603d13 HC |
283 | if (!plat_dat) |
284 | plat_dat = devm_kzalloc(&pdev->dev, | |
285 | sizeof(struct plat_stmmacenet_data), | |
286 | GFP_KERNEL); | |
287 | if (!plat_dat) { | |
288 | pr_err("%s: ERROR: no memory", __func__); | |
289 | return -ENOMEM; | |
290 | } | |
291 | ||
571dcfde HC |
292 | /* Set default value for multicast hash bins */ |
293 | plat_dat->multicast_filter_bins = HASH_TABLE_SIZE; | |
294 | ||
295 | /* Set default value for unicast filter entries */ | |
296 | plat_dat->unicast_filter_entries = 1; | |
297 | ||
6a228452 | 298 | if (pdev->dev.of_node) { |
6a228452 SR |
299 | ret = stmmac_probe_config_dt(pdev, plat_dat, &mac); |
300 | if (ret) { | |
301 | pr_err("%s: main dt probe failed", __func__); | |
3f8bdecd | 302 | return ret; |
6a228452 | 303 | } |
6a228452 | 304 | } |
cf3f047b | 305 | |
938dfdaa CYT |
306 | /* Custom setup (if needed) */ |
307 | if (plat_dat->setup) { | |
308 | plat_dat->bsp_priv = plat_dat->setup(pdev); | |
309 | if (IS_ERR(plat_dat->bsp_priv)) | |
310 | return PTR_ERR(plat_dat->bsp_priv); | |
311 | } | |
312 | ||
cf3f047b GC |
313 | /* Custom initialisation (if needed)*/ |
314 | if (plat_dat->init) { | |
938dfdaa | 315 | ret = plat_dat->init(pdev, plat_dat->bsp_priv); |
cf3f047b | 316 | if (unlikely(ret)) |
3f8bdecd | 317 | return ret; |
cf3f047b GC |
318 | } |
319 | ||
320 | priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr); | |
c5e4ddbd | 321 | if (IS_ERR(priv)) { |
cf3f047b | 322 | pr_err("%s: main driver probe failed", __func__); |
c5e4ddbd | 323 | return PTR_ERR(priv); |
bfab27a1 GC |
324 | } |
325 | ||
6a228452 SR |
326 | /* Get MAC address if available (DT) */ |
327 | if (mac) | |
328 | memcpy(priv->dev->dev_addr, mac, ETH_ALEN); | |
329 | ||
bfab27a1 GC |
330 | /* Get the MAC information */ |
331 | priv->dev->irq = platform_get_irq_byname(pdev, "macirq"); | |
d7ec8584 CYT |
332 | if (priv->dev->irq < 0) { |
333 | if (priv->dev->irq != -EPROBE_DEFER) { | |
334 | netdev_err(priv->dev, | |
335 | "MAC IRQ configuration information not found\n"); | |
336 | } | |
337 | return priv->dev->irq; | |
bfab27a1 GC |
338 | } |
339 | ||
340 | /* | |
341 | * On some platforms e.g. SPEAr the wake up irq differs from the mac irq | |
342 | * The external wake up irq can be passed through the platform code | |
343 | * named as "eth_wake_irq" | |
344 | * | |
345 | * In case the wake up interrupt is not passed from the platform | |
346 | * so the driver will continue to use the mac irq (ndev->irq) | |
347 | */ | |
348 | priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq"); | |
d7ec8584 CYT |
349 | if (priv->wol_irq < 0) { |
350 | if (priv->wol_irq == -EPROBE_DEFER) | |
351 | return -EPROBE_DEFER; | |
bfab27a1 | 352 | priv->wol_irq = priv->dev->irq; |
d7ec8584 | 353 | } |
bfab27a1 | 354 | |
d765955d | 355 | priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi"); |
d7ec8584 CYT |
356 | if (priv->lpi_irq == -EPROBE_DEFER) |
357 | return -EPROBE_DEFER; | |
d765955d | 358 | |
bfab27a1 GC |
359 | platform_set_drvdata(pdev, priv->dev); |
360 | ||
bfab27a1 GC |
361 | pr_debug("STMMAC platform driver registration completed"); |
362 | ||
363 | return 0; | |
bfab27a1 GC |
364 | } |
365 | ||
366 | /** | |
367 | * stmmac_pltfr_remove | |
368 | * @pdev: platform device pointer | |
369 | * Description: this function calls the main to free the net resources | |
370 | * and calls the platforms hook and release the resources (e.g. mem). | |
371 | */ | |
372 | static int stmmac_pltfr_remove(struct platform_device *pdev) | |
373 | { | |
374 | struct net_device *ndev = platform_get_drvdata(pdev); | |
375 | struct stmmac_priv *priv = netdev_priv(ndev); | |
bfab27a1 GC |
376 | int ret = stmmac_dvr_remove(ndev); |
377 | ||
bfab27a1 | 378 | if (priv->plat->exit) |
938dfdaa CYT |
379 | priv->plat->exit(pdev, priv->plat->bsp_priv); |
380 | ||
381 | if (priv->plat->free) | |
382 | priv->plat->free(pdev, priv->plat->bsp_priv); | |
bfab27a1 | 383 | |
bfab27a1 GC |
384 | return ret; |
385 | } | |
386 | ||
b2e2f0c7 | 387 | #ifdef CONFIG_PM_SLEEP |
732fdf0e GC |
388 | /** |
389 | * stmmac_pltfr_suspend | |
390 | * @dev: device pointer | |
391 | * Description: this function is invoked when suspend the driver and it direcly | |
392 | * call the main suspend function and then, if required, on some platform, it | |
393 | * can call an exit helper. | |
394 | */ | |
bfab27a1 | 395 | static int stmmac_pltfr_suspend(struct device *dev) |
bfab27a1 | 396 | { |
3256251f | 397 | int ret; |
bfab27a1 | 398 | struct net_device *ndev = dev_get_drvdata(dev); |
33a23e22 | 399 | struct stmmac_priv *priv = netdev_priv(ndev); |
3256251f | 400 | struct platform_device *pdev = to_platform_device(dev); |
bfab27a1 | 401 | |
33a23e22 SK |
402 | ret = stmmac_suspend(ndev); |
403 | if (priv->plat->exit) | |
938dfdaa | 404 | priv->plat->exit(pdev, priv->plat->bsp_priv); |
3256251f FV |
405 | |
406 | return ret; | |
bfab27a1 GC |
407 | } |
408 | ||
732fdf0e GC |
409 | /** |
410 | * stmmac_pltfr_resume | |
411 | * @dev: device pointer | |
412 | * Description: this function is invoked when resume the driver before calling | |
413 | * the main resume function, on some platforms, it can call own init helper | |
414 | * if required. | |
415 | */ | |
33a23e22 | 416 | static int stmmac_pltfr_resume(struct device *dev) |
bfab27a1 GC |
417 | { |
418 | struct net_device *ndev = dev_get_drvdata(dev); | |
33a23e22 | 419 | struct stmmac_priv *priv = netdev_priv(ndev); |
3256251f FV |
420 | struct platform_device *pdev = to_platform_device(dev); |
421 | ||
33a23e22 | 422 | if (priv->plat->init) |
938dfdaa | 423 | priv->plat->init(pdev, priv->plat->bsp_priv); |
bfab27a1 | 424 | |
33a23e22 | 425 | return stmmac_resume(ndev); |
bfab27a1 | 426 | } |
b2e2f0c7 | 427 | #endif /* CONFIG_PM_SLEEP */ |
bfab27a1 | 428 | |
33a23e22 | 429 | static SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, |
b2e2f0c7 | 430 | stmmac_pltfr_suspend, stmmac_pltfr_resume); |
33a23e22 | 431 | |
b2e2f0c7 | 432 | static struct platform_driver stmmac_pltfr_driver = { |
bfab27a1 GC |
433 | .probe = stmmac_pltfr_probe, |
434 | .remove = stmmac_pltfr_remove, | |
435 | .driver = { | |
436 | .name = STMMAC_RESOURCE_NAME, | |
bfab27a1 | 437 | .pm = &stmmac_pltfr_pm_ops, |
6a228452 | 438 | .of_match_table = of_match_ptr(stmmac_dt_ids), |
b2e2f0c7 | 439 | }, |
bfab27a1 GC |
440 | }; |
441 | ||
b2e2f0c7 AS |
442 | module_platform_driver(stmmac_pltfr_driver); |
443 | ||
bfab27a1 GC |
444 | MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver"); |
445 | MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>"); | |
446 | MODULE_LICENSE("GPL"); |