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/io.h> 27 #include <linux/of.h> 28 #include <linux/of_net.h> 29 #include <linux/of_device.h> 30 #include "stmmac.h" 31 32 static const struct of_device_id stmmac_dt_ids[] = { 33 #ifdef CONFIG_DWMAC_SUNXI 34 { .compatible = "allwinner,sun7i-a20-gmac", .data = &sun7i_gmac_data}, 35 #endif 36 /* SoC specific glue layers should come before generic bindings */ 37 { .compatible = "st,spear600-gmac"}, 38 { .compatible = "snps,dwmac-3.610"}, 39 { .compatible = "snps,dwmac-3.70a"}, 40 { .compatible = "snps,dwmac-3.710"}, 41 { .compatible = "snps,dwmac"}, 42 { /* sentinel */ } 43 }; 44 MODULE_DEVICE_TABLE(of, stmmac_dt_ids); 45 46 #ifdef CONFIG_OF 47 static int stmmac_probe_config_dt(struct platform_device *pdev, 48 struct plat_stmmacenet_data *plat, 49 const char **mac) 50 { 51 struct device_node *np = pdev->dev.of_node; 52 struct stmmac_dma_cfg *dma_cfg; 53 const struct of_device_id *device; 54 55 if (!np) 56 return -ENODEV; 57 58 device = of_match_device(stmmac_dt_ids, &pdev->dev); 59 if (!device) 60 return -ENODEV; 61 62 if (device->data) { 63 const struct stmmac_of_data *data = device->data; 64 plat->has_gmac = data->has_gmac; 65 plat->enh_desc = data->enh_desc; 66 plat->tx_coe = data->tx_coe; 67 plat->rx_coe = data->rx_coe; 68 plat->bugged_jumbo = data->bugged_jumbo; 69 plat->pmt = data->pmt; 70 plat->riwt_off = data->riwt_off; 71 plat->fix_mac_speed = data->fix_mac_speed; 72 plat->bus_setup = data->bus_setup; 73 plat->setup = data->setup; 74 plat->free = data->free; 75 plat->init = data->init; 76 plat->exit = data->exit; 77 } 78 79 *mac = of_get_mac_address(np); 80 plat->interface = of_get_phy_mode(np); 81 82 /* Get max speed of operation from device tree */ 83 if (of_property_read_u32(np, "max-speed", &plat->max_speed)) 84 plat->max_speed = -1; 85 86 plat->bus_id = of_alias_get_id(np, "ethernet"); 87 if (plat->bus_id < 0) 88 plat->bus_id = 0; 89 90 /* Default to phy auto-detection */ 91 plat->phy_addr = -1; 92 93 /* "snps,phy-addr" is not a standard property. Mark it as deprecated 94 * and warn of its use. Remove this when phy node support is added. 95 */ 96 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0) 97 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n"); 98 99 plat->mdio_bus_data = devm_kzalloc(&pdev->dev, 100 sizeof(struct stmmac_mdio_bus_data), 101 GFP_KERNEL); 102 103 plat->force_sf_dma_mode = of_property_read_bool(np, "snps,force_sf_dma_mode"); 104 105 /* Set the maxmtu to a default of JUMBO_LEN in case the 106 * parameter is not present in the device tree. 107 */ 108 plat->maxmtu = JUMBO_LEN; 109 110 /* 111 * Currently only the properties needed on SPEAr600 112 * are provided. All other properties should be added 113 * once needed on other platforms. 114 */ 115 if (of_device_is_compatible(np, "st,spear600-gmac") || 116 of_device_is_compatible(np, "snps,dwmac-3.70a") || 117 of_device_is_compatible(np, "snps,dwmac")) { 118 /* Note that the max-frame-size parameter as defined in the 119 * ePAPR v1.1 spec is defined as max-frame-size, it's 120 * actually used as the IEEE definition of MAC Client 121 * data, or MTU. The ePAPR specification is confusing as 122 * the definition is max-frame-size, but usage examples 123 * are clearly MTUs 124 */ 125 of_property_read_u32(np, "max-frame-size", &plat->maxmtu); 126 plat->has_gmac = 1; 127 plat->pmt = 1; 128 } 129 130 if (of_device_is_compatible(np, "snps,dwmac-3.610") || 131 of_device_is_compatible(np, "snps,dwmac-3.710")) { 132 plat->enh_desc = 1; 133 plat->bugged_jumbo = 1; 134 plat->force_sf_dma_mode = 1; 135 } 136 137 if (of_find_property(np, "snps,pbl", NULL)) { 138 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg), 139 GFP_KERNEL); 140 if (!dma_cfg) 141 return -ENOMEM; 142 plat->dma_cfg = dma_cfg; 143 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl); 144 dma_cfg->fixed_burst = 145 of_property_read_bool(np, "snps,fixed-burst"); 146 dma_cfg->mixed_burst = 147 of_property_read_bool(np, "snps,mixed-burst"); 148 } 149 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode"); 150 if (plat->force_thresh_dma_mode) { 151 plat->force_sf_dma_mode = 0; 152 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set."); 153 } 154 155 return 0; 156 } 157 #else 158 static int stmmac_probe_config_dt(struct platform_device *pdev, 159 struct plat_stmmacenet_data *plat, 160 const char **mac) 161 { 162 return -ENOSYS; 163 } 164 #endif /* CONFIG_OF */ 165 166 /** 167 * stmmac_pltfr_probe 168 * @pdev: platform device pointer 169 * Description: platform_device probe function. It allocates 170 * the necessary resources and invokes the main to init 171 * the net device, register the mdio bus etc. 172 */ 173 static int stmmac_pltfr_probe(struct platform_device *pdev) 174 { 175 int ret = 0; 176 struct resource *res; 177 struct device *dev = &pdev->dev; 178 void __iomem *addr = NULL; 179 struct stmmac_priv *priv = NULL; 180 struct plat_stmmacenet_data *plat_dat = NULL; 181 const char *mac = NULL; 182 183 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 184 addr = devm_ioremap_resource(dev, res); 185 if (IS_ERR(addr)) 186 return PTR_ERR(addr); 187 188 plat_dat = dev_get_platdata(&pdev->dev); 189 if (pdev->dev.of_node) { 190 if (!plat_dat) 191 plat_dat = devm_kzalloc(&pdev->dev, 192 sizeof(struct plat_stmmacenet_data), 193 GFP_KERNEL); 194 if (!plat_dat) { 195 pr_err("%s: ERROR: no memory", __func__); 196 return -ENOMEM; 197 } 198 199 ret = stmmac_probe_config_dt(pdev, plat_dat, &mac); 200 if (ret) { 201 pr_err("%s: main dt probe failed", __func__); 202 return ret; 203 } 204 } 205 206 /* Custom setup (if needed) */ 207 if (plat_dat->setup) { 208 plat_dat->bsp_priv = plat_dat->setup(pdev); 209 if (IS_ERR(plat_dat->bsp_priv)) 210 return PTR_ERR(plat_dat->bsp_priv); 211 } 212 213 /* Custom initialisation (if needed)*/ 214 if (plat_dat->init) { 215 ret = plat_dat->init(pdev, plat_dat->bsp_priv); 216 if (unlikely(ret)) 217 return ret; 218 } 219 220 priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr); 221 if (IS_ERR(priv)) { 222 pr_err("%s: main driver probe failed", __func__); 223 return PTR_ERR(priv); 224 } 225 226 /* Get MAC address if available (DT) */ 227 if (mac) 228 memcpy(priv->dev->dev_addr, mac, ETH_ALEN); 229 230 /* Get the MAC information */ 231 priv->dev->irq = platform_get_irq_byname(pdev, "macirq"); 232 if (priv->dev->irq == -ENXIO) { 233 pr_err("%s: ERROR: MAC IRQ configuration " 234 "information not found\n", __func__); 235 return -ENXIO; 236 } 237 238 /* 239 * On some platforms e.g. SPEAr the wake up irq differs from the mac irq 240 * The external wake up irq can be passed through the platform code 241 * named as "eth_wake_irq" 242 * 243 * In case the wake up interrupt is not passed from the platform 244 * so the driver will continue to use the mac irq (ndev->irq) 245 */ 246 priv->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq"); 247 if (priv->wol_irq == -ENXIO) 248 priv->wol_irq = priv->dev->irq; 249 250 priv->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi"); 251 252 platform_set_drvdata(pdev, priv->dev); 253 254 pr_debug("STMMAC platform driver registration completed"); 255 256 return 0; 257 } 258 259 /** 260 * stmmac_pltfr_remove 261 * @pdev: platform device pointer 262 * Description: this function calls the main to free the net resources 263 * and calls the platforms hook and release the resources (e.g. mem). 264 */ 265 static int stmmac_pltfr_remove(struct platform_device *pdev) 266 { 267 struct net_device *ndev = platform_get_drvdata(pdev); 268 struct stmmac_priv *priv = netdev_priv(ndev); 269 int ret = stmmac_dvr_remove(ndev); 270 271 if (priv->plat->exit) 272 priv->plat->exit(pdev, priv->plat->bsp_priv); 273 274 if (priv->plat->free) 275 priv->plat->free(pdev, priv->plat->bsp_priv); 276 277 return ret; 278 } 279 280 #ifdef CONFIG_PM 281 static int stmmac_pltfr_suspend(struct device *dev) 282 { 283 int ret; 284 struct net_device *ndev = dev_get_drvdata(dev); 285 struct stmmac_priv *priv = netdev_priv(ndev); 286 struct platform_device *pdev = to_platform_device(dev); 287 288 ret = stmmac_suspend(ndev); 289 if (priv->plat->exit) 290 priv->plat->exit(pdev, priv->plat->bsp_priv); 291 292 return ret; 293 } 294 295 static int stmmac_pltfr_resume(struct device *dev) 296 { 297 struct net_device *ndev = dev_get_drvdata(dev); 298 struct stmmac_priv *priv = netdev_priv(ndev); 299 struct platform_device *pdev = to_platform_device(dev); 300 301 if (priv->plat->init) 302 priv->plat->init(pdev, priv->plat->bsp_priv); 303 304 return stmmac_resume(ndev); 305 } 306 307 #endif /* CONFIG_PM */ 308 309 static SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, 310 stmmac_pltfr_suspend, stmmac_pltfr_resume); 311 312 struct platform_driver stmmac_pltfr_driver = { 313 .probe = stmmac_pltfr_probe, 314 .remove = stmmac_pltfr_remove, 315 .driver = { 316 .name = STMMAC_RESOURCE_NAME, 317 .owner = THIS_MODULE, 318 .pm = &stmmac_pltfr_pm_ops, 319 .of_match_table = of_match_ptr(stmmac_dt_ids), 320 }, 321 }; 322 323 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver"); 324 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>"); 325 MODULE_LICENSE("GPL"); 326