1 /*******************************************************************************
2 This contains the functions to handle the platform driver.
4 Copyright (C) 2007-2011 STMicroelectronics Ltd
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.
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
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.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
22 Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
25 #include <linux/platform_device.h>
26 #include <linux/module.h>
29 #include <linux/of_net.h>
30 #include <linux/of_device.h>
31 #include <linux/of_mdio.h>
34 #include "stmmac_platform.h"
39 * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
40 * @mcast_bins: Multicast filtering bins
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
50 static int dwmac1000_validate_mcast_bins(int mcast_bins)
61 pr_info("Hash table entries set to unexpected value %d",
69 * dwmac1000_validate_ucast_entries - validate the Unicast address entries
70 * @ucast_entries: number of Unicast address entries
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.
79 static int dwmac1000_validate_ucast_entries(int ucast_entries)
81 int x = ucast_entries;
90 pr_info("Unicast table entries set to unexpected value %d\n",
98 * stmmac_probe_config_dt - parse device-tree driver parameters
99 * @pdev: platform_device structure
100 * @plat: driver data platform structure
101 * @mac: MAC address to use
103 * this function is to read the driver parameters from device-tree and
104 * set some private fields that will be used by the main at runtime.
106 struct plat_stmmacenet_data *
107 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
109 struct device_node *np = pdev->dev.of_node;
110 struct plat_stmmacenet_data *plat;
111 struct stmmac_dma_cfg *dma_cfg;
113 plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
115 return ERR_PTR(-ENOMEM);
117 *mac = of_get_mac_address(np);
118 plat->interface = of_get_phy_mode(np);
120 /* Get max speed of operation from device tree */
121 if (of_property_read_u32(np, "max-speed", &plat->max_speed))
122 plat->max_speed = -1;
124 plat->bus_id = of_alias_get_id(np, "ethernet");
125 if (plat->bus_id < 0)
128 /* Default to phy auto-detection */
131 /* If we find a phy-handle property, use it as the PHY */
132 plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
134 /* If phy-handle is not specified, check if we have a fixed-phy */
135 if (!plat->phy_node && of_phy_is_fixed_link(np)) {
136 if ((of_phy_register_fixed_link(np) < 0))
137 return ERR_PTR(-ENODEV);
139 plat->phy_node = of_node_get(np);
142 /* "snps,phy-addr" is not a standard property. Mark it as deprecated
143 * and warn of its use. Remove this when phy node support is added.
145 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
146 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
148 if (plat->phy_node || plat->phy_bus_name)
149 plat->mdio_bus_data = NULL;
151 plat->mdio_bus_data =
152 devm_kzalloc(&pdev->dev,
153 sizeof(struct stmmac_mdio_bus_data),
156 of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
158 of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
160 plat->force_sf_dma_mode =
161 of_property_read_bool(np, "snps,force_sf_dma_mode");
163 /* Set the maxmtu to a default of JUMBO_LEN in case the
164 * parameter is not present in the device tree.
166 plat->maxmtu = JUMBO_LEN;
168 /* Set default value for multicast hash bins */
169 plat->multicast_filter_bins = HASH_TABLE_SIZE;
171 /* Set default value for unicast filter entries */
172 plat->unicast_filter_entries = 1;
175 * Currently only the properties needed on SPEAr600
176 * are provided. All other properties should be added
177 * once needed on other platforms.
179 if (of_device_is_compatible(np, "st,spear600-gmac") ||
180 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
181 of_device_is_compatible(np, "snps,dwmac")) {
182 /* Note that the max-frame-size parameter as defined in the
183 * ePAPR v1.1 spec is defined as max-frame-size, it's
184 * actually used as the IEEE definition of MAC Client
185 * data, or MTU. The ePAPR specification is confusing as
186 * the definition is max-frame-size, but usage examples
189 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
190 of_property_read_u32(np, "snps,multicast-filter-bins",
191 &plat->multicast_filter_bins);
192 of_property_read_u32(np, "snps,perfect-filter-entries",
193 &plat->unicast_filter_entries);
194 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
195 plat->unicast_filter_entries);
196 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
197 plat->multicast_filter_bins);
202 if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
203 of_device_is_compatible(np, "snps,dwmac-3.710")) {
205 plat->bugged_jumbo = 1;
206 plat->force_sf_dma_mode = 1;
209 if (of_find_property(np, "snps,pbl", NULL)) {
210 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
214 return ERR_PTR(-ENOMEM);
216 plat->dma_cfg = dma_cfg;
217 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
218 dma_cfg->fixed_burst =
219 of_property_read_bool(np, "snps,fixed-burst");
220 dma_cfg->mixed_burst =
221 of_property_read_bool(np, "snps,mixed-burst");
222 of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len);
223 if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256)
224 dma_cfg->burst_len = 0;
226 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
227 if (plat->force_thresh_dma_mode) {
228 plat->force_sf_dma_mode = 0;
229 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
235 struct plat_stmmacenet_data *
236 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
238 return ERR_PTR(-ENOSYS);
240 #endif /* CONFIG_OF */
241 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
243 int stmmac_get_platform_resources(struct platform_device *pdev,
244 struct stmmac_resources *stmmac_res)
246 struct resource *res;
248 memset(stmmac_res, 0, sizeof(*stmmac_res));
250 /* Get IRQ information early to have an ability to ask for deferred
251 * probe if needed before we went too far with resource allocation.
253 stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
254 if (stmmac_res->irq < 0) {
255 if (stmmac_res->irq != -EPROBE_DEFER) {
257 "MAC IRQ configuration information not found\n");
259 return stmmac_res->irq;
262 /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
263 * The external wake up irq can be passed through the platform code
264 * named as "eth_wake_irq"
266 * In case the wake up interrupt is not passed from the platform
267 * so the driver will continue to use the mac irq (ndev->irq)
269 stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
270 if (stmmac_res->wol_irq < 0) {
271 if (stmmac_res->wol_irq == -EPROBE_DEFER)
272 return -EPROBE_DEFER;
273 stmmac_res->wol_irq = stmmac_res->irq;
276 stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
277 if (stmmac_res->lpi_irq == -EPROBE_DEFER)
278 return -EPROBE_DEFER;
280 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
281 stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
283 return PTR_ERR_OR_ZERO(stmmac_res->addr);
285 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
288 * stmmac_pltfr_remove
289 * @pdev: platform device pointer
290 * Description: this function calls the main to free the net resources
291 * and calls the platforms hook and release the resources (e.g. mem).
293 int stmmac_pltfr_remove(struct platform_device *pdev)
295 struct net_device *ndev = platform_get_drvdata(pdev);
296 struct stmmac_priv *priv = netdev_priv(ndev);
297 int ret = stmmac_dvr_remove(ndev);
299 if (priv->plat->exit)
300 priv->plat->exit(pdev, priv->plat->bsp_priv);
304 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
306 #ifdef CONFIG_PM_SLEEP
308 * stmmac_pltfr_suspend
309 * @dev: device pointer
310 * Description: this function is invoked when suspend the driver and it direcly
311 * call the main suspend function and then, if required, on some platform, it
312 * can call an exit helper.
314 static int stmmac_pltfr_suspend(struct device *dev)
317 struct net_device *ndev = dev_get_drvdata(dev);
318 struct stmmac_priv *priv = netdev_priv(ndev);
319 struct platform_device *pdev = to_platform_device(dev);
321 ret = stmmac_suspend(ndev);
322 if (priv->plat->exit)
323 priv->plat->exit(pdev, priv->plat->bsp_priv);
329 * stmmac_pltfr_resume
330 * @dev: device pointer
331 * Description: this function is invoked when resume the driver before calling
332 * the main resume function, on some platforms, it can call own init helper
335 static int stmmac_pltfr_resume(struct device *dev)
337 struct net_device *ndev = dev_get_drvdata(dev);
338 struct stmmac_priv *priv = netdev_priv(ndev);
339 struct platform_device *pdev = to_platform_device(dev);
341 if (priv->plat->init)
342 priv->plat->init(pdev, priv->plat->bsp_priv);
344 return stmmac_resume(ndev);
346 #endif /* CONFIG_PM_SLEEP */
348 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
349 stmmac_pltfr_resume);
350 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
352 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
353 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
354 MODULE_LICENSE("GPL");