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> |
5790cf3c | 31 | #include <linux/of_mdio.h> |
f10f9fb2 | 32 | |
bfab27a1 | 33 | #include "stmmac.h" |
f10f9fb2 | 34 | #include "stmmac_platform.h" |
bfab27a1 | 35 | |
6a228452 | 36 | #ifdef CONFIG_OF |
3b57de95 | 37 | |
732fdf0e GC |
38 | /** |
39 | * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins | |
40 | * @mcast_bins: Multicast filtering bins | |
41 | * Description: | |
42 | * this function validates the number of Multicast filtering bins specified | |
3b57de95 VB |
43 | * by the configuration through the device tree. The Synopsys GMAC supports |
44 | * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC | |
45 | * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds | |
46 | * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is | |
47 | * invalid and will cause the filtering algorithm to use Multicast | |
48 | * promiscuous mode. | |
49 | */ | |
50 | static int dwmac1000_validate_mcast_bins(int mcast_bins) | |
51 | { | |
52 | int x = mcast_bins; | |
53 | ||
54 | switch (x) { | |
55 | case HASH_TABLE_SIZE: | |
56 | case 128: | |
57 | case 256: | |
58 | break; | |
59 | default: | |
60 | x = 0; | |
61 | pr_info("Hash table entries set to unexpected value %d", | |
62 | mcast_bins); | |
63 | break; | |
64 | } | |
65 | return x; | |
66 | } | |
67 | ||
732fdf0e GC |
68 | /** |
69 | * dwmac1000_validate_ucast_entries - validate the Unicast address entries | |
70 | * @ucast_entries: number of Unicast address entries | |
71 | * Description: | |
72 | * This function validates the number of Unicast address entries supported | |
3b57de95 VB |
73 | * by a particular Synopsys 10/100/1000 controller. The Synopsys controller |
74 | * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter | |
75 | * logic. This function validates a valid, supported configuration is | |
76 | * selected, and defaults to 1 Unicast address if an unsupported | |
77 | * configuration is selected. | |
78 | */ | |
79 | static int dwmac1000_validate_ucast_entries(int ucast_entries) | |
80 | { | |
81 | int x = ucast_entries; | |
82 | ||
83 | switch (x) { | |
84 | case 1: | |
85 | case 32: | |
86 | case 64: | |
87 | case 128: | |
88 | break; | |
89 | default: | |
90 | x = 1; | |
91 | pr_info("Unicast table entries set to unexpected value %d\n", | |
92 | ucast_entries); | |
93 | break; | |
94 | } | |
95 | return x; | |
96 | } | |
97 | ||
afea0365 GC |
98 | /** |
99 | * stmmac_axi_setup - parse DT parameters for programming the AXI register | |
100 | * @pdev: platform device | |
101 | * @priv: driver private struct. | |
102 | * Description: | |
103 | * if required, from device-tree the AXI internal register can be tuned | |
104 | * by using platform parameters. | |
105 | */ | |
106 | static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev) | |
107 | { | |
108 | struct device_node *np; | |
109 | struct stmmac_axi *axi; | |
110 | ||
111 | np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0); | |
112 | if (!np) | |
113 | return NULL; | |
114 | ||
4c3e962d | 115 | axi = kzalloc(sizeof(*axi), GFP_KERNEL); |
4613b279 PC |
116 | if (!axi) { |
117 | of_node_put(np); | |
afea0365 | 118 | return ERR_PTR(-ENOMEM); |
4613b279 | 119 | } |
afea0365 GC |
120 | |
121 | axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en"); | |
122 | axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm"); | |
123 | axi->axi_kbbe = of_property_read_bool(np, "snps,axi_kbbe"); | |
124 | axi->axi_axi_all = of_property_read_bool(np, "snps,axi_all"); | |
125 | axi->axi_fb = of_property_read_bool(np, "snps,axi_fb"); | |
126 | axi->axi_mb = of_property_read_bool(np, "snps,axi_mb"); | |
127 | axi->axi_rb = of_property_read_bool(np, "snps,axi_rb"); | |
128 | ||
129 | of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt); | |
130 | of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt); | |
131 | of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN); | |
4613b279 | 132 | of_node_put(np); |
afea0365 GC |
133 | |
134 | return axi; | |
135 | } | |
136 | ||
a7657f12 GC |
137 | /** |
138 | * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources | |
139 | * @plat: driver data platform structure | |
140 | * @np: device tree node | |
141 | * @dev: device pointer | |
142 | * Description: | |
143 | * The mdio bus will be allocated in case of a phy transceiver is on board; | |
144 | * it will be NULL if the fixed-link is configured. | |
145 | * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated | |
146 | * in any case (for DSA, mdio must be registered even if fixed-link). | |
147 | * The table below sums the supported configurations: | |
148 | * ------------------------------- | |
149 | * snps,phy-addr | Y | |
150 | * ------------------------------- | |
151 | * phy-handle | Y | |
152 | * ------------------------------- | |
153 | * fixed-link | N | |
154 | * ------------------------------- | |
155 | * snps,dwmac-mdio | | |
156 | * even if | Y | |
157 | * fixed-link | | |
158 | * ------------------------------- | |
159 | * | |
160 | * It returns 0 in case of success otherwise -ENODEV. | |
161 | */ | |
162 | static int stmmac_dt_phy(struct plat_stmmacenet_data *plat, | |
163 | struct device_node *np, struct device *dev) | |
164 | { | |
165 | bool mdio = true; | |
166 | ||
167 | /* If phy-handle property is passed from DT, use it as the PHY */ | |
168 | plat->phy_node = of_parse_phandle(np, "phy-handle", 0); | |
169 | if (plat->phy_node) | |
170 | dev_dbg(dev, "Found phy-handle subnode\n"); | |
171 | ||
172 | /* If phy-handle is not specified, check if we have a fixed-phy */ | |
173 | if (!plat->phy_node && of_phy_is_fixed_link(np)) { | |
174 | if ((of_phy_register_fixed_link(np) < 0)) | |
175 | return -ENODEV; | |
176 | ||
177 | dev_dbg(dev, "Found fixed-link subnode\n"); | |
178 | plat->phy_node = of_node_get(np); | |
179 | mdio = false; | |
180 | } | |
181 | ||
182 | /* If snps,dwmac-mdio is passed from DT, always register the MDIO */ | |
183 | for_each_child_of_node(np, plat->mdio_node) { | |
184 | if (of_device_is_compatible(plat->mdio_node, "snps,dwmac-mdio")) | |
185 | break; | |
186 | } | |
187 | ||
188 | if (plat->mdio_node) { | |
189 | dev_dbg(dev, "Found MDIO subnode\n"); | |
190 | mdio = true; | |
191 | } | |
192 | ||
193 | if (mdio) | |
194 | plat->mdio_bus_data = | |
195 | devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data), | |
196 | GFP_KERNEL); | |
197 | return 0; | |
198 | } | |
199 | ||
732fdf0e GC |
200 | /** |
201 | * stmmac_probe_config_dt - parse device-tree driver parameters | |
202 | * @pdev: platform_device structure | |
203 | * @plat: driver data platform structure | |
204 | * @mac: MAC address to use | |
205 | * Description: | |
206 | * this function is to read the driver parameters from device-tree and | |
207 | * set some private fields that will be used by the main at runtime. | |
208 | */ | |
402dae0b | 209 | struct plat_stmmacenet_data * |
b0003ead | 210 | stmmac_probe_config_dt(struct platform_device *pdev, const char **mac) |
6a228452 SR |
211 | { |
212 | struct device_node *np = pdev->dev.of_node; | |
4ed2d8fc | 213 | struct plat_stmmacenet_data *plat; |
25c83b5c | 214 | struct stmmac_dma_cfg *dma_cfg; |
6a228452 | 215 | |
4ed2d8fc JE |
216 | plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL); |
217 | if (!plat) | |
b0003ead | 218 | return ERR_PTR(-ENOMEM); |
4ed2d8fc | 219 | |
6a228452 SR |
220 | *mac = of_get_mac_address(np); |
221 | plat->interface = of_get_phy_mode(np); | |
25c83b5c | 222 | |
9cbadf09 SK |
223 | /* Get max speed of operation from device tree */ |
224 | if (of_property_read_u32(np, "max-speed", &plat->max_speed)) | |
225 | plat->max_speed = -1; | |
226 | ||
25c83b5c SK |
227 | plat->bus_id = of_alias_get_id(np, "ethernet"); |
228 | if (plat->bus_id < 0) | |
229 | plat->bus_id = 0; | |
230 | ||
436f7ecd CYT |
231 | /* Default to phy auto-detection */ |
232 | plat->phy_addr = -1; | |
233 | ||
234 | /* "snps,phy-addr" is not a standard property. Mark it as deprecated | |
235 | * and warn of its use. Remove this when phy node support is added. | |
236 | */ | |
237 | if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0) | |
238 | dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n"); | |
25c83b5c | 239 | |
a7657f12 GC |
240 | /* To Configure PHY by using all device-tree supported properties */ |
241 | if (stmmac_dt_phy(plat, np, &pdev->dev)) | |
242 | return ERR_PTR(-ENODEV); | |
8c2a7a5d | 243 | |
e7877f52 VB |
244 | of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size); |
245 | ||
246 | of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size); | |
247 | ||
8c2a7a5d GC |
248 | plat->force_sf_dma_mode = |
249 | of_property_read_bool(np, "snps,force_sf_dma_mode"); | |
6aedb8c0 | 250 | |
2618abb7 VB |
251 | /* Set the maxmtu to a default of JUMBO_LEN in case the |
252 | * parameter is not present in the device tree. | |
253 | */ | |
254 | plat->maxmtu = JUMBO_LEN; | |
255 | ||
4ed2d8fc JE |
256 | /* Set default value for multicast hash bins */ |
257 | plat->multicast_filter_bins = HASH_TABLE_SIZE; | |
258 | ||
259 | /* Set default value for unicast filter entries */ | |
260 | plat->unicast_filter_entries = 1; | |
261 | ||
6a228452 SR |
262 | /* |
263 | * Currently only the properties needed on SPEAr600 | |
264 | * are provided. All other properties should be added | |
265 | * once needed on other platforms. | |
266 | */ | |
84c9f8c4 | 267 | if (of_device_is_compatible(np, "st,spear600-gmac") || |
f9a09687 | 268 | of_device_is_compatible(np, "snps,dwmac-3.50a") || |
84c9f8c4 DN |
269 | of_device_is_compatible(np, "snps,dwmac-3.70a") || |
270 | of_device_is_compatible(np, "snps,dwmac")) { | |
2618abb7 VB |
271 | /* Note that the max-frame-size parameter as defined in the |
272 | * ePAPR v1.1 spec is defined as max-frame-size, it's | |
273 | * actually used as the IEEE definition of MAC Client | |
274 | * data, or MTU. The ePAPR specification is confusing as | |
275 | * the definition is max-frame-size, but usage examples | |
276 | * are clearly MTUs | |
277 | */ | |
278 | of_property_read_u32(np, "max-frame-size", &plat->maxmtu); | |
3b57de95 VB |
279 | of_property_read_u32(np, "snps,multicast-filter-bins", |
280 | &plat->multicast_filter_bins); | |
281 | of_property_read_u32(np, "snps,perfect-filter-entries", | |
282 | &plat->unicast_filter_entries); | |
283 | plat->unicast_filter_entries = dwmac1000_validate_ucast_entries( | |
284 | plat->unicast_filter_entries); | |
285 | plat->multicast_filter_bins = dwmac1000_validate_mcast_bins( | |
286 | plat->multicast_filter_bins); | |
6a228452 SR |
287 | plat->has_gmac = 1; |
288 | plat->pmt = 1; | |
289 | } | |
290 | ||
ee2ae1ed AT |
291 | if (of_device_is_compatible(np, "snps,dwmac-4.00") || |
292 | of_device_is_compatible(np, "snps,dwmac-4.10a")) { | |
293 | plat->has_gmac4 = 1; | |
294 | plat->pmt = 1; | |
295 | plat->tso_en = of_property_read_bool(np, "snps,tso"); | |
296 | } | |
297 | ||
25c83b5c SK |
298 | if (of_device_is_compatible(np, "snps,dwmac-3.610") || |
299 | of_device_is_compatible(np, "snps,dwmac-3.710")) { | |
300 | plat->enh_desc = 1; | |
301 | plat->bugged_jumbo = 1; | |
302 | plat->force_sf_dma_mode = 1; | |
303 | } | |
304 | ||
64c3b252 BA |
305 | if (of_find_property(np, "snps,pbl", NULL)) { |
306 | dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg), | |
307 | GFP_KERNEL); | |
27732381 | 308 | if (!dma_cfg) { |
4613b279 | 309 | of_node_put(plat->phy_node); |
b0003ead | 310 | return ERR_PTR(-ENOMEM); |
27732381 | 311 | } |
64c3b252 BA |
312 | plat->dma_cfg = dma_cfg; |
313 | of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl); | |
afea0365 | 314 | dma_cfg->aal = of_property_read_bool(np, "snps,aal"); |
64c3b252 BA |
315 | dma_cfg->fixed_burst = |
316 | of_property_read_bool(np, "snps,fixed-burst"); | |
317 | dma_cfg->mixed_burst = | |
318 | of_property_read_bool(np, "snps,mixed-burst"); | |
319 | } | |
e2a240c7 SZ |
320 | plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode"); |
321 | if (plat->force_thresh_dma_mode) { | |
322 | plat->force_sf_dma_mode = 0; | |
323 | pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set."); | |
356f9e74 | 324 | } |
25c83b5c | 325 | |
02e57b9d GC |
326 | of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed); |
327 | ||
afea0365 GC |
328 | plat->axi = stmmac_axi_setup(pdev); |
329 | ||
b0003ead | 330 | return plat; |
6a228452 SR |
331 | } |
332 | #else | |
402dae0b | 333 | struct plat_stmmacenet_data * |
b0003ead | 334 | stmmac_probe_config_dt(struct platform_device *pdev, const char **mac) |
6a228452 | 335 | { |
b0003ead | 336 | return ERR_PTR(-ENOSYS); |
6a228452 SR |
337 | } |
338 | #endif /* CONFIG_OF */ | |
402dae0b | 339 | EXPORT_SYMBOL_GPL(stmmac_probe_config_dt); |
6a228452 | 340 | |
402dae0b JE |
341 | int stmmac_get_platform_resources(struct platform_device *pdev, |
342 | struct stmmac_resources *stmmac_res) | |
bfab27a1 | 343 | { |
bfab27a1 | 344 | struct resource *res; |
e56788cf | 345 | |
f396cb01 | 346 | memset(stmmac_res, 0, sizeof(*stmmac_res)); |
8f02d8da AB |
347 | |
348 | /* Get IRQ information early to have an ability to ask for deferred | |
349 | * probe if needed before we went too far with resource allocation. | |
350 | */ | |
f396cb01 JE |
351 | stmmac_res->irq = platform_get_irq_byname(pdev, "macirq"); |
352 | if (stmmac_res->irq < 0) { | |
353 | if (stmmac_res->irq != -EPROBE_DEFER) { | |
354 | dev_err(&pdev->dev, | |
8f02d8da AB |
355 | "MAC IRQ configuration information not found\n"); |
356 | } | |
f396cb01 | 357 | return stmmac_res->irq; |
8f02d8da AB |
358 | } |
359 | ||
360 | /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq | |
361 | * The external wake up irq can be passed through the platform code | |
362 | * named as "eth_wake_irq" | |
363 | * | |
364 | * In case the wake up interrupt is not passed from the platform | |
365 | * so the driver will continue to use the mac irq (ndev->irq) | |
366 | */ | |
f396cb01 JE |
367 | stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq"); |
368 | if (stmmac_res->wol_irq < 0) { | |
369 | if (stmmac_res->wol_irq == -EPROBE_DEFER) | |
8f02d8da | 370 | return -EPROBE_DEFER; |
f396cb01 | 371 | stmmac_res->wol_irq = stmmac_res->irq; |
8f02d8da AB |
372 | } |
373 | ||
f396cb01 JE |
374 | stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi"); |
375 | if (stmmac_res->lpi_irq == -EPROBE_DEFER) | |
8f02d8da | 376 | return -EPROBE_DEFER; |
bfab27a1 GC |
377 | |
378 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); | |
f396cb01 | 379 | stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res); |
f396cb01 | 380 | |
a04c0aef | 381 | return PTR_ERR_OR_ZERO(stmmac_res->addr); |
f396cb01 | 382 | } |
402dae0b | 383 | EXPORT_SYMBOL_GPL(stmmac_get_platform_resources); |
f396cb01 | 384 | |
bfab27a1 GC |
385 | /** |
386 | * stmmac_pltfr_remove | |
387 | * @pdev: platform device pointer | |
388 | * Description: this function calls the main to free the net resources | |
389 | * and calls the platforms hook and release the resources (e.g. mem). | |
390 | */ | |
902b1607 | 391 | int stmmac_pltfr_remove(struct platform_device *pdev) |
bfab27a1 GC |
392 | { |
393 | struct net_device *ndev = platform_get_drvdata(pdev); | |
394 | struct stmmac_priv *priv = netdev_priv(ndev); | |
f4e7bd81 | 395 | int ret = stmmac_dvr_remove(&pdev->dev); |
bfab27a1 | 396 | |
bfab27a1 | 397 | if (priv->plat->exit) |
938dfdaa CYT |
398 | priv->plat->exit(pdev, priv->plat->bsp_priv); |
399 | ||
bfab27a1 GC |
400 | return ret; |
401 | } | |
902b1607 | 402 | EXPORT_SYMBOL_GPL(stmmac_pltfr_remove); |
bfab27a1 | 403 | |
b2e2f0c7 | 404 | #ifdef CONFIG_PM_SLEEP |
732fdf0e GC |
405 | /** |
406 | * stmmac_pltfr_suspend | |
407 | * @dev: device pointer | |
408 | * Description: this function is invoked when suspend the driver and it direcly | |
409 | * call the main suspend function and then, if required, on some platform, it | |
410 | * can call an exit helper. | |
411 | */ | |
bfab27a1 | 412 | static int stmmac_pltfr_suspend(struct device *dev) |
bfab27a1 | 413 | { |
3256251f | 414 | int ret; |
bfab27a1 | 415 | struct net_device *ndev = dev_get_drvdata(dev); |
33a23e22 | 416 | struct stmmac_priv *priv = netdev_priv(ndev); |
3256251f | 417 | struct platform_device *pdev = to_platform_device(dev); |
bfab27a1 | 418 | |
f4e7bd81 | 419 | ret = stmmac_suspend(dev); |
cecbc556 VP |
420 | if (priv->plat->suspend) |
421 | priv->plat->suspend(pdev, priv->plat->bsp_priv); | |
422 | else if (priv->plat->exit) | |
938dfdaa | 423 | priv->plat->exit(pdev, priv->plat->bsp_priv); |
3256251f FV |
424 | |
425 | return ret; | |
bfab27a1 GC |
426 | } |
427 | ||
732fdf0e GC |
428 | /** |
429 | * stmmac_pltfr_resume | |
430 | * @dev: device pointer | |
431 | * Description: this function is invoked when resume the driver before calling | |
432 | * the main resume function, on some platforms, it can call own init helper | |
433 | * if required. | |
434 | */ | |
33a23e22 | 435 | static int stmmac_pltfr_resume(struct device *dev) |
bfab27a1 GC |
436 | { |
437 | struct net_device *ndev = dev_get_drvdata(dev); | |
33a23e22 | 438 | struct stmmac_priv *priv = netdev_priv(ndev); |
3256251f FV |
439 | struct platform_device *pdev = to_platform_device(dev); |
440 | ||
cecbc556 VP |
441 | if (priv->plat->resume) |
442 | priv->plat->resume(pdev, priv->plat->bsp_priv); | |
443 | else if (priv->plat->init) | |
938dfdaa | 444 | priv->plat->init(pdev, priv->plat->bsp_priv); |
bfab27a1 | 445 | |
f4e7bd81 | 446 | return stmmac_resume(dev); |
bfab27a1 | 447 | } |
b2e2f0c7 | 448 | #endif /* CONFIG_PM_SLEEP */ |
bfab27a1 | 449 | |
902b1607 JE |
450 | SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend, |
451 | stmmac_pltfr_resume); | |
452 | EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops); | |
ea111545 JE |
453 | |
454 | MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support"); | |
455 | MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>"); | |
456 | MODULE_LICENSE("GPL"); |