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>
28 #include <linux/of_net.h>
29 #include <linux/of_device.h>
32 static const struct of_device_id stmmac_dt_ids[] = {
33 #ifdef CONFIG_DWMAC_MESON
34 { .compatible = "amlogic,meson6-dwmac", .data = &meson6_dwmac_data},
36 #ifdef CONFIG_DWMAC_SUNXI
37 { .compatible = "allwinner,sun7i-a20-gmac", .data = &sun7i_gmac_data},
39 #ifdef CONFIG_DWMAC_STI
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},
45 #ifdef CONFIG_DWMAC_SOCFPGA
46 { .compatible = "altr,socfpga-stmmac", .data = &socfpga_gmac_data },
48 /* SoC specific glue layers should come before generic bindings */
49 { .compatible = "st,spear600-gmac"},
50 { .compatible = "snps,dwmac-3.610"},
51 { .compatible = "snps,dwmac-3.70a"},
52 { .compatible = "snps,dwmac-3.710"},
53 { .compatible = "snps,dwmac"},
56 MODULE_DEVICE_TABLE(of, stmmac_dt_ids);
60 /* This function validates the number of Multicast filtering bins specified
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
68 static int dwmac1000_validate_mcast_bins(int mcast_bins)
79 pr_info("Hash table entries set to unexpected value %d",
86 /* This function validates the number of Unicast address entries supported
87 * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
88 * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter
89 * logic. This function validates a valid, supported configuration is
90 * selected, and defaults to 1 Unicast address if an unsupported
91 * configuration is selected.
93 static int dwmac1000_validate_ucast_entries(int ucast_entries)
95 int x = ucast_entries;
105 pr_info("Unicast table entries set to unexpected value %d\n",
112 static int stmmac_probe_config_dt(struct platform_device *pdev,
113 struct plat_stmmacenet_data *plat,
116 struct device_node *np = pdev->dev.of_node;
117 struct stmmac_dma_cfg *dma_cfg;
118 const struct of_device_id *device;
123 device = of_match_device(stmmac_dt_ids, &pdev->dev);
128 const struct stmmac_of_data *data = device->data;
129 plat->has_gmac = data->has_gmac;
130 plat->enh_desc = data->enh_desc;
131 plat->tx_coe = data->tx_coe;
132 plat->rx_coe = data->rx_coe;
133 plat->bugged_jumbo = data->bugged_jumbo;
134 plat->pmt = data->pmt;
135 plat->riwt_off = data->riwt_off;
136 plat->fix_mac_speed = data->fix_mac_speed;
137 plat->bus_setup = data->bus_setup;
138 plat->setup = data->setup;
139 plat->free = data->free;
140 plat->init = data->init;
141 plat->exit = data->exit;
144 *mac = of_get_mac_address(np);
145 plat->interface = of_get_phy_mode(np);
147 /* Get max speed of operation from device tree */
148 if (of_property_read_u32(np, "max-speed", &plat->max_speed))
149 plat->max_speed = -1;
151 plat->bus_id = of_alias_get_id(np, "ethernet");
152 if (plat->bus_id < 0)
155 /* Default to phy auto-detection */
158 /* "snps,phy-addr" is not a standard property. Mark it as deprecated
159 * and warn of its use. Remove this when phy node support is added.
161 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
162 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
164 if (plat->phy_bus_name)
165 plat->mdio_bus_data = NULL;
167 plat->mdio_bus_data =
168 devm_kzalloc(&pdev->dev,
169 sizeof(struct stmmac_mdio_bus_data),
172 plat->force_sf_dma_mode =
173 of_property_read_bool(np, "snps,force_sf_dma_mode");
175 /* Set the maxmtu to a default of JUMBO_LEN in case the
176 * parameter is not present in the device tree.
178 plat->maxmtu = JUMBO_LEN;
180 /* Set default value for multicast hash bins */
181 plat->multicast_filter_bins = HASH_TABLE_SIZE;
183 /* Set default value for unicast filter entries */
184 plat->unicast_filter_entries = 1;
187 * Currently only the properties needed on SPEAr600
188 * are provided. All other properties should be added
189 * once needed on other platforms.
191 if (of_device_is_compatible(np, "st,spear600-gmac") ||
192 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
193 of_device_is_compatible(np, "snps,dwmac")) {
194 /* Note that the max-frame-size parameter as defined in the
195 * ePAPR v1.1 spec is defined as max-frame-size, it's
196 * actually used as the IEEE definition of MAC Client
197 * data, or MTU. The ePAPR specification is confusing as
198 * the definition is max-frame-size, but usage examples
201 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
202 of_property_read_u32(np, "snps,multicast-filter-bins",
203 &plat->multicast_filter_bins);
204 of_property_read_u32(np, "snps,perfect-filter-entries",
205 &plat->unicast_filter_entries);
206 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
207 plat->unicast_filter_entries);
208 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
209 plat->multicast_filter_bins);
214 if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
215 of_device_is_compatible(np, "snps,dwmac-3.710")) {
217 plat->bugged_jumbo = 1;
218 plat->force_sf_dma_mode = 1;
221 if (of_find_property(np, "snps,pbl", NULL)) {
222 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
226 plat->dma_cfg = dma_cfg;
227 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
228 dma_cfg->fixed_burst =
229 of_property_read_bool(np, "snps,fixed-burst");
230 dma_cfg->mixed_burst =
231 of_property_read_bool(np, "snps,mixed-burst");
233 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
234 if (plat->force_thresh_dma_mode) {
235 plat->force_sf_dma_mode = 0;
236 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
242 static int stmmac_probe_config_dt(struct platform_device *pdev,
243 struct plat_stmmacenet_data *plat,
248 #endif /* CONFIG_OF */
252 * @pdev: platform device pointer
253 * Description: platform_device probe function. It allocates
254 * the necessary resources and invokes the main to init
255 * the net device, register the mdio bus etc.
257 static int stmmac_pltfr_probe(struct platform_device *pdev)
260 struct resource *res;
261 struct device *dev = &pdev->dev;
262 void __iomem *addr = NULL;
263 struct stmmac_priv *priv = NULL;
264 struct plat_stmmacenet_data *plat_dat = NULL;
265 const char *mac = NULL;
267 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
268 addr = devm_ioremap_resource(dev, res);
270 return PTR_ERR(addr);
272 plat_dat = dev_get_platdata(&pdev->dev);
273 if (pdev->dev.of_node) {
275 plat_dat = devm_kzalloc(&pdev->dev,
276 sizeof(struct plat_stmmacenet_data),
279 pr_err("%s: ERROR: no memory", __func__);
283 ret = stmmac_probe_config_dt(pdev, plat_dat, &mac);
285 pr_err("%s: main dt probe failed", __func__);
290 /* Custom setup (if needed) */
291 if (plat_dat->setup) {
292 plat_dat->bsp_priv = plat_dat->setup(pdev);
293 if (IS_ERR(plat_dat->bsp_priv))
294 return PTR_ERR(plat_dat->bsp_priv);
297 /* Custom initialisation (if needed)*/
298 if (plat_dat->init) {
299 ret = plat_dat->init(pdev, plat_dat->bsp_priv);
304 priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr);
306 pr_err("%s: main driver probe failed", __func__);
307 return PTR_ERR(priv);
310 /* Get MAC address if available (DT) */
312 memcpy(priv->dev->dev_addr, mac, ETH_ALEN);
314 /* Get the MAC information */
315 priv->dev->irq = platform_get_irq_byname(pdev, "macirq");
316 if (priv->dev->irq < 0) {
317 if (priv->dev->irq != -EPROBE_DEFER) {
318 netdev_err(priv->dev,
319 "MAC IRQ configuration information not found\n");
321 return priv->dev->irq;
325 * On some platforms e.g. SPEAr the wake up irq differs from the mac irq
326 * The external wake up irq can be passed through the platform code
327 * named as "eth_wake_irq"
329 * In case the wake up interrupt is not passed from the platform
330 * so the driver will continue to use the mac irq (ndev->irq)
332 priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
333 if (priv->wol_irq < 0) {
334 if (priv->wol_irq == -EPROBE_DEFER)
335 return -EPROBE_DEFER;
336 priv->wol_irq = priv->dev->irq;
339 priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
340 if (priv->lpi_irq == -EPROBE_DEFER)
341 return -EPROBE_DEFER;
343 platform_set_drvdata(pdev, priv->dev);
345 pr_debug("STMMAC platform driver registration completed");
351 * stmmac_pltfr_remove
352 * @pdev: platform device pointer
353 * Description: this function calls the main to free the net resources
354 * and calls the platforms hook and release the resources (e.g. mem).
356 static int stmmac_pltfr_remove(struct platform_device *pdev)
358 struct net_device *ndev = platform_get_drvdata(pdev);
359 struct stmmac_priv *priv = netdev_priv(ndev);
360 int ret = stmmac_dvr_remove(ndev);
362 if (priv->plat->exit)
363 priv->plat->exit(pdev, priv->plat->bsp_priv);
365 if (priv->plat->free)
366 priv->plat->free(pdev, priv->plat->bsp_priv);
372 static int stmmac_pltfr_suspend(struct device *dev)
375 struct net_device *ndev = dev_get_drvdata(dev);
376 struct stmmac_priv *priv = netdev_priv(ndev);
377 struct platform_device *pdev = to_platform_device(dev);
379 ret = stmmac_suspend(ndev);
380 if (priv->plat->exit)
381 priv->plat->exit(pdev, priv->plat->bsp_priv);
386 static int stmmac_pltfr_resume(struct device *dev)
388 struct net_device *ndev = dev_get_drvdata(dev);
389 struct stmmac_priv *priv = netdev_priv(ndev);
390 struct platform_device *pdev = to_platform_device(dev);
392 if (priv->plat->init)
393 priv->plat->init(pdev, priv->plat->bsp_priv);
395 return stmmac_resume(ndev);
398 #endif /* CONFIG_PM */
400 static SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops,
401 stmmac_pltfr_suspend, stmmac_pltfr_resume);
403 struct platform_driver stmmac_pltfr_driver = {
404 .probe = stmmac_pltfr_probe,
405 .remove = stmmac_pltfr_remove,
407 .name = STMMAC_RESOURCE_NAME,
408 .owner = THIS_MODULE,
409 .pm = &stmmac_pltfr_pm_ops,
410 .of_match_table = of_match_ptr(stmmac_dt_ids),
414 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver");
415 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
416 MODULE_LICENSE("GPL");