Loading...
Note: File does not exist in v3.1.
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/module.h>
27#include <linux/io.h>
28#include <linux/of.h>
29#include <linux/of_net.h>
30#include <linux/of_device.h>
31#include <linux/of_mdio.h>
32
33#include "stmmac.h"
34#include "stmmac_platform.h"
35
36#ifdef CONFIG_OF
37
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
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 */
50static 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
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
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 */
79static 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
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 */
106static 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
115 axi = kzalloc(sizeof(*axi), GFP_KERNEL);
116 if (!axi)
117 return ERR_PTR(-ENOMEM);
118
119 axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en");
120 axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm");
121 axi->axi_kbbe = of_property_read_bool(np, "snps,axi_kbbe");
122 axi->axi_axi_all = of_property_read_bool(np, "snps,axi_all");
123 axi->axi_fb = of_property_read_bool(np, "snps,axi_fb");
124 axi->axi_mb = of_property_read_bool(np, "snps,axi_mb");
125 axi->axi_rb = of_property_read_bool(np, "snps,axi_rb");
126
127 of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt);
128 of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt);
129 of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN);
130
131 return axi;
132}
133
134/**
135 * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources
136 * @plat: driver data platform structure
137 * @np: device tree node
138 * @dev: device pointer
139 * Description:
140 * The mdio bus will be allocated in case of a phy transceiver is on board;
141 * it will be NULL if the fixed-link is configured.
142 * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated
143 * in any case (for DSA, mdio must be registered even if fixed-link).
144 * The table below sums the supported configurations:
145 * -------------------------------
146 * snps,phy-addr | Y
147 * -------------------------------
148 * phy-handle | Y
149 * -------------------------------
150 * fixed-link | N
151 * -------------------------------
152 * snps,dwmac-mdio |
153 * even if | Y
154 * fixed-link |
155 * -------------------------------
156 *
157 * It returns 0 in case of success otherwise -ENODEV.
158 */
159static int stmmac_dt_phy(struct plat_stmmacenet_data *plat,
160 struct device_node *np, struct device *dev)
161{
162 bool mdio = true;
163
164 /* If phy-handle property is passed from DT, use it as the PHY */
165 plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
166 if (plat->phy_node)
167 dev_dbg(dev, "Found phy-handle subnode\n");
168
169 /* If phy-handle is not specified, check if we have a fixed-phy */
170 if (!plat->phy_node && of_phy_is_fixed_link(np)) {
171 if ((of_phy_register_fixed_link(np) < 0))
172 return -ENODEV;
173
174 dev_dbg(dev, "Found fixed-link subnode\n");
175 plat->phy_node = of_node_get(np);
176 mdio = false;
177 }
178
179 /* If snps,dwmac-mdio is passed from DT, always register the MDIO */
180 for_each_child_of_node(np, plat->mdio_node) {
181 if (of_device_is_compatible(plat->mdio_node, "snps,dwmac-mdio"))
182 break;
183 }
184
185 if (plat->mdio_node) {
186 dev_dbg(dev, "Found MDIO subnode\n");
187 mdio = true;
188 }
189
190 if (mdio)
191 plat->mdio_bus_data =
192 devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data),
193 GFP_KERNEL);
194 return 0;
195}
196
197/**
198 * stmmac_probe_config_dt - parse device-tree driver parameters
199 * @pdev: platform_device structure
200 * @plat: driver data platform structure
201 * @mac: MAC address to use
202 * Description:
203 * this function is to read the driver parameters from device-tree and
204 * set some private fields that will be used by the main at runtime.
205 */
206struct plat_stmmacenet_data *
207stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
208{
209 struct device_node *np = pdev->dev.of_node;
210 struct plat_stmmacenet_data *plat;
211 struct stmmac_dma_cfg *dma_cfg;
212
213 plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
214 if (!plat)
215 return ERR_PTR(-ENOMEM);
216
217 *mac = of_get_mac_address(np);
218 plat->interface = of_get_phy_mode(np);
219
220 /* Get max speed of operation from device tree */
221 if (of_property_read_u32(np, "max-speed", &plat->max_speed))
222 plat->max_speed = -1;
223
224 plat->bus_id = of_alias_get_id(np, "ethernet");
225 if (plat->bus_id < 0)
226 plat->bus_id = 0;
227
228 /* Default to phy auto-detection */
229 plat->phy_addr = -1;
230
231 /* "snps,phy-addr" is not a standard property. Mark it as deprecated
232 * and warn of its use. Remove this when phy node support is added.
233 */
234 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
235 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
236
237 /* To Configure PHY by using all device-tree supported properties */
238 if (stmmac_dt_phy(plat, np, &pdev->dev))
239 return ERR_PTR(-ENODEV);
240
241 of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
242
243 of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
244
245 plat->force_sf_dma_mode =
246 of_property_read_bool(np, "snps,force_sf_dma_mode");
247
248 /* Set the maxmtu to a default of JUMBO_LEN in case the
249 * parameter is not present in the device tree.
250 */
251 plat->maxmtu = JUMBO_LEN;
252
253 /* Set default value for multicast hash bins */
254 plat->multicast_filter_bins = HASH_TABLE_SIZE;
255
256 /* Set default value for unicast filter entries */
257 plat->unicast_filter_entries = 1;
258
259 /*
260 * Currently only the properties needed on SPEAr600
261 * are provided. All other properties should be added
262 * once needed on other platforms.
263 */
264 if (of_device_is_compatible(np, "st,spear600-gmac") ||
265 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
266 of_device_is_compatible(np, "snps,dwmac")) {
267 /* Note that the max-frame-size parameter as defined in the
268 * ePAPR v1.1 spec is defined as max-frame-size, it's
269 * actually used as the IEEE definition of MAC Client
270 * data, or MTU. The ePAPR specification is confusing as
271 * the definition is max-frame-size, but usage examples
272 * are clearly MTUs
273 */
274 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
275 of_property_read_u32(np, "snps,multicast-filter-bins",
276 &plat->multicast_filter_bins);
277 of_property_read_u32(np, "snps,perfect-filter-entries",
278 &plat->unicast_filter_entries);
279 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
280 plat->unicast_filter_entries);
281 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
282 plat->multicast_filter_bins);
283 plat->has_gmac = 1;
284 plat->pmt = 1;
285 }
286
287 if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
288 of_device_is_compatible(np, "snps,dwmac-3.710")) {
289 plat->enh_desc = 1;
290 plat->bugged_jumbo = 1;
291 plat->force_sf_dma_mode = 1;
292 }
293
294 if (of_find_property(np, "snps,pbl", NULL)) {
295 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
296 GFP_KERNEL);
297 if (!dma_cfg) {
298 of_node_put(np);
299 return ERR_PTR(-ENOMEM);
300 }
301 plat->dma_cfg = dma_cfg;
302 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
303 dma_cfg->aal = of_property_read_bool(np, "snps,aal");
304 dma_cfg->fixed_burst =
305 of_property_read_bool(np, "snps,fixed-burst");
306 dma_cfg->mixed_burst =
307 of_property_read_bool(np, "snps,mixed-burst");
308 }
309 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
310 if (plat->force_thresh_dma_mode) {
311 plat->force_sf_dma_mode = 0;
312 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
313 }
314
315 plat->axi = stmmac_axi_setup(pdev);
316
317 return plat;
318}
319#else
320struct plat_stmmacenet_data *
321stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
322{
323 return ERR_PTR(-ENOSYS);
324}
325#endif /* CONFIG_OF */
326EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
327
328int stmmac_get_platform_resources(struct platform_device *pdev,
329 struct stmmac_resources *stmmac_res)
330{
331 struct resource *res;
332
333 memset(stmmac_res, 0, sizeof(*stmmac_res));
334
335 /* Get IRQ information early to have an ability to ask for deferred
336 * probe if needed before we went too far with resource allocation.
337 */
338 stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
339 if (stmmac_res->irq < 0) {
340 if (stmmac_res->irq != -EPROBE_DEFER) {
341 dev_err(&pdev->dev,
342 "MAC IRQ configuration information not found\n");
343 }
344 return stmmac_res->irq;
345 }
346
347 /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
348 * The external wake up irq can be passed through the platform code
349 * named as "eth_wake_irq"
350 *
351 * In case the wake up interrupt is not passed from the platform
352 * so the driver will continue to use the mac irq (ndev->irq)
353 */
354 stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
355 if (stmmac_res->wol_irq < 0) {
356 if (stmmac_res->wol_irq == -EPROBE_DEFER)
357 return -EPROBE_DEFER;
358 stmmac_res->wol_irq = stmmac_res->irq;
359 }
360
361 stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
362 if (stmmac_res->lpi_irq == -EPROBE_DEFER)
363 return -EPROBE_DEFER;
364
365 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
366 stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
367
368 return PTR_ERR_OR_ZERO(stmmac_res->addr);
369}
370EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
371
372/**
373 * stmmac_pltfr_remove
374 * @pdev: platform device pointer
375 * Description: this function calls the main to free the net resources
376 * and calls the platforms hook and release the resources (e.g. mem).
377 */
378int stmmac_pltfr_remove(struct platform_device *pdev)
379{
380 struct net_device *ndev = platform_get_drvdata(pdev);
381 struct stmmac_priv *priv = netdev_priv(ndev);
382 int ret = stmmac_dvr_remove(ndev);
383
384 if (priv->plat->exit)
385 priv->plat->exit(pdev, priv->plat->bsp_priv);
386
387 return ret;
388}
389EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
390
391#ifdef CONFIG_PM_SLEEP
392/**
393 * stmmac_pltfr_suspend
394 * @dev: device pointer
395 * Description: this function is invoked when suspend the driver and it direcly
396 * call the main suspend function and then, if required, on some platform, it
397 * can call an exit helper.
398 */
399static int stmmac_pltfr_suspend(struct device *dev)
400{
401 int ret;
402 struct net_device *ndev = dev_get_drvdata(dev);
403 struct stmmac_priv *priv = netdev_priv(ndev);
404 struct platform_device *pdev = to_platform_device(dev);
405
406 ret = stmmac_suspend(ndev);
407 if (priv->plat->exit)
408 priv->plat->exit(pdev, priv->plat->bsp_priv);
409
410 return ret;
411}
412
413/**
414 * stmmac_pltfr_resume
415 * @dev: device pointer
416 * Description: this function is invoked when resume the driver before calling
417 * the main resume function, on some platforms, it can call own init helper
418 * if required.
419 */
420static int stmmac_pltfr_resume(struct device *dev)
421{
422 struct net_device *ndev = dev_get_drvdata(dev);
423 struct stmmac_priv *priv = netdev_priv(ndev);
424 struct platform_device *pdev = to_platform_device(dev);
425
426 if (priv->plat->init)
427 priv->plat->init(pdev, priv->plat->bsp_priv);
428
429 return stmmac_resume(ndev);
430}
431#endif /* CONFIG_PM_SLEEP */
432
433SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
434 stmmac_pltfr_resume);
435EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
436
437MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
438MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
439MODULE_LICENSE("GPL");