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