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 */ 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 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 */ 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 98 /** 99 * stmmac_probe_config_dt - parse device-tree driver parameters 100 * @pdev: platform_device structure 101 * @plat: driver data platform structure 102 * @mac: MAC address to use 103 * Description: 104 * this function is to read the driver parameters from device-tree and 105 * set some private fields that will be used by the main at runtime. 106 */ 107 static int stmmac_probe_config_dt(struct platform_device *pdev, 108 struct plat_stmmacenet_data *plat, 109 const char **mac) 110 { 111 struct device_node *np = pdev->dev.of_node; 112 struct stmmac_dma_cfg *dma_cfg; 113 const struct of_device_id *device; 114 struct device *dev = &pdev->dev; 115 116 device = of_match_device(dev->driver->of_match_table, dev); 117 if (device->data) { 118 const struct stmmac_of_data *data = device->data; 119 plat->has_gmac = data->has_gmac; 120 plat->enh_desc = data->enh_desc; 121 plat->tx_coe = data->tx_coe; 122 plat->rx_coe = data->rx_coe; 123 plat->bugged_jumbo = data->bugged_jumbo; 124 plat->pmt = data->pmt; 125 plat->riwt_off = data->riwt_off; 126 plat->fix_mac_speed = data->fix_mac_speed; 127 plat->bus_setup = data->bus_setup; 128 plat->setup = data->setup; 129 plat->free = data->free; 130 plat->init = data->init; 131 plat->exit = data->exit; 132 } 133 134 *mac = of_get_mac_address(np); 135 plat->interface = of_get_phy_mode(np); 136 137 /* Get max speed of operation from device tree */ 138 if (of_property_read_u32(np, "max-speed", &plat->max_speed)) 139 plat->max_speed = -1; 140 141 plat->bus_id = of_alias_get_id(np, "ethernet"); 142 if (plat->bus_id < 0) 143 plat->bus_id = 0; 144 145 /* Default to phy auto-detection */ 146 plat->phy_addr = -1; 147 148 /* If we find a phy-handle property, use it as the PHY */ 149 plat->phy_node = of_parse_phandle(np, "phy-handle", 0); 150 151 /* If phy-handle is not specified, check if we have a fixed-phy */ 152 if (!plat->phy_node && of_phy_is_fixed_link(np)) { 153 if ((of_phy_register_fixed_link(np) < 0)) 154 return -ENODEV; 155 156 plat->phy_node = of_node_get(np); 157 } 158 159 /* "snps,phy-addr" is not a standard property. Mark it as deprecated 160 * and warn of its use. Remove this when phy node support is added. 161 */ 162 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0) 163 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n"); 164 165 if (plat->phy_node || plat->phy_bus_name) 166 plat->mdio_bus_data = NULL; 167 else 168 plat->mdio_bus_data = 169 devm_kzalloc(&pdev->dev, 170 sizeof(struct stmmac_mdio_bus_data), 171 GFP_KERNEL); 172 173 of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size); 174 175 of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size); 176 177 plat->force_sf_dma_mode = 178 of_property_read_bool(np, "snps,force_sf_dma_mode"); 179 180 /* Set the maxmtu to a default of JUMBO_LEN in case the 181 * parameter is not present in the device tree. 182 */ 183 plat->maxmtu = JUMBO_LEN; 184 185 /* 186 * Currently only the properties needed on SPEAr600 187 * are provided. All other properties should be added 188 * once needed on other platforms. 189 */ 190 if (of_device_is_compatible(np, "st,spear600-gmac") || 191 of_device_is_compatible(np, "snps,dwmac-3.70a") || 192 of_device_is_compatible(np, "snps,dwmac")) { 193 /* Note that the max-frame-size parameter as defined in the 194 * ePAPR v1.1 spec is defined as max-frame-size, it's 195 * actually used as the IEEE definition of MAC Client 196 * data, or MTU. The ePAPR specification is confusing as 197 * the definition is max-frame-size, but usage examples 198 * are clearly MTUs 199 */ 200 of_property_read_u32(np, "max-frame-size", &plat->maxmtu); 201 of_property_read_u32(np, "snps,multicast-filter-bins", 202 &plat->multicast_filter_bins); 203 of_property_read_u32(np, "snps,perfect-filter-entries", 204 &plat->unicast_filter_entries); 205 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries( 206 plat->unicast_filter_entries); 207 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins( 208 plat->multicast_filter_bins); 209 plat->has_gmac = 1; 210 plat->pmt = 1; 211 } 212 213 if (of_device_is_compatible(np, "snps,dwmac-3.610") || 214 of_device_is_compatible(np, "snps,dwmac-3.710")) { 215 plat->enh_desc = 1; 216 plat->bugged_jumbo = 1; 217 plat->force_sf_dma_mode = 1; 218 } 219 220 if (of_find_property(np, "snps,pbl", NULL)) { 221 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg), 222 GFP_KERNEL); 223 if (!dma_cfg) { 224 of_node_put(np); 225 return -ENOMEM; 226 } 227 plat->dma_cfg = dma_cfg; 228 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl); 229 dma_cfg->fixed_burst = 230 of_property_read_bool(np, "snps,fixed-burst"); 231 dma_cfg->mixed_burst = 232 of_property_read_bool(np, "snps,mixed-burst"); 233 of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len); 234 if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256) 235 dma_cfg->burst_len = 0; 236 } 237 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode"); 238 if (plat->force_thresh_dma_mode) { 239 plat->force_sf_dma_mode = 0; 240 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set."); 241 } 242 243 return 0; 244 } 245 #else 246 static int stmmac_probe_config_dt(struct platform_device *pdev, 247 struct plat_stmmacenet_data *plat, 248 const char **mac) 249 { 250 return -ENOSYS; 251 } 252 #endif /* CONFIG_OF */ 253 254 /** 255 * stmmac_pltfr_probe - platform driver probe. 256 * @pdev: platform device pointer 257 * Description: platform_device probe function. It is to allocate 258 * the necessary platform resources, invoke custom helper (if required) and 259 * invoke the main probe function. 260 */ 261 int stmmac_pltfr_probe(struct platform_device *pdev) 262 { 263 struct stmmac_resources stmmac_res; 264 int ret = 0; 265 struct resource *res; 266 struct device *dev = &pdev->dev; 267 struct plat_stmmacenet_data *plat_dat = NULL; 268 269 memset(&stmmac_res, 0, sizeof(stmmac_res)); 270 271 /* Get IRQ information early to have an ability to ask for deferred 272 * probe if needed before we went too far with resource allocation. 273 */ 274 stmmac_res.irq = platform_get_irq_byname(pdev, "macirq"); 275 if (stmmac_res.irq < 0) { 276 if (stmmac_res.irq != -EPROBE_DEFER) { 277 dev_err(dev, 278 "MAC IRQ configuration information not found\n"); 279 } 280 return stmmac_res.irq; 281 } 282 283 /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq 284 * The external wake up irq can be passed through the platform code 285 * named as "eth_wake_irq" 286 * 287 * In case the wake up interrupt is not passed from the platform 288 * so the driver will continue to use the mac irq (ndev->irq) 289 */ 290 stmmac_res.wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq"); 291 if (stmmac_res.wol_irq < 0) { 292 if (stmmac_res.wol_irq == -EPROBE_DEFER) 293 return -EPROBE_DEFER; 294 stmmac_res.wol_irq = stmmac_res.irq; 295 } 296 297 stmmac_res.lpi_irq = platform_get_irq_byname(pdev, "eth_lpi"); 298 if (stmmac_res.lpi_irq == -EPROBE_DEFER) 299 return -EPROBE_DEFER; 300 301 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 302 stmmac_res.addr = devm_ioremap_resource(dev, res); 303 if (IS_ERR(stmmac_res.addr)) 304 return PTR_ERR(stmmac_res.addr); 305 306 plat_dat = dev_get_platdata(&pdev->dev); 307 308 if (!plat_dat) 309 plat_dat = devm_kzalloc(&pdev->dev, 310 sizeof(struct plat_stmmacenet_data), 311 GFP_KERNEL); 312 if (!plat_dat) { 313 pr_err("%s: ERROR: no memory", __func__); 314 return -ENOMEM; 315 } 316 317 /* Set default value for multicast hash bins */ 318 plat_dat->multicast_filter_bins = HASH_TABLE_SIZE; 319 320 /* Set default value for unicast filter entries */ 321 plat_dat->unicast_filter_entries = 1; 322 323 if (pdev->dev.of_node) { 324 ret = stmmac_probe_config_dt(pdev, plat_dat, &stmmac_res.mac); 325 if (ret) { 326 pr_err("%s: main dt probe failed", __func__); 327 return ret; 328 } 329 } 330 331 /* Custom setup (if needed) */ 332 if (plat_dat->setup) { 333 plat_dat->bsp_priv = plat_dat->setup(pdev); 334 if (IS_ERR(plat_dat->bsp_priv)) 335 return PTR_ERR(plat_dat->bsp_priv); 336 } 337 338 /* Custom initialisation (if needed)*/ 339 if (plat_dat->init) { 340 ret = plat_dat->init(pdev, plat_dat->bsp_priv); 341 if (unlikely(ret)) 342 return ret; 343 } 344 345 return stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res); 346 } 347 EXPORT_SYMBOL_GPL(stmmac_pltfr_probe); 348 349 /** 350 * stmmac_pltfr_remove 351 * @pdev: platform device pointer 352 * Description: this function calls the main to free the net resources 353 * and calls the platforms hook and release the resources (e.g. mem). 354 */ 355 int stmmac_pltfr_remove(struct platform_device *pdev) 356 { 357 struct net_device *ndev = platform_get_drvdata(pdev); 358 struct stmmac_priv *priv = netdev_priv(ndev); 359 int ret = stmmac_dvr_remove(ndev); 360 361 if (priv->plat->exit) 362 priv->plat->exit(pdev, priv->plat->bsp_priv); 363 364 if (priv->plat->free) 365 priv->plat->free(pdev, priv->plat->bsp_priv); 366 367 return ret; 368 } 369 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove); 370 371 #ifdef CONFIG_PM_SLEEP 372 /** 373 * stmmac_pltfr_suspend 374 * @dev: device pointer 375 * Description: this function is invoked when suspend the driver and it direcly 376 * call the main suspend function and then, if required, on some platform, it 377 * can call an exit helper. 378 */ 379 static int stmmac_pltfr_suspend(struct device *dev) 380 { 381 int ret; 382 struct net_device *ndev = dev_get_drvdata(dev); 383 struct stmmac_priv *priv = netdev_priv(ndev); 384 struct platform_device *pdev = to_platform_device(dev); 385 386 ret = stmmac_suspend(ndev); 387 if (priv->plat->exit) 388 priv->plat->exit(pdev, priv->plat->bsp_priv); 389 390 return ret; 391 } 392 393 /** 394 * stmmac_pltfr_resume 395 * @dev: device pointer 396 * Description: this function is invoked when resume the driver before calling 397 * the main resume function, on some platforms, it can call own init helper 398 * if required. 399 */ 400 static int stmmac_pltfr_resume(struct device *dev) 401 { 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 if (priv->plat->init) 407 priv->plat->init(pdev, priv->plat->bsp_priv); 408 409 return stmmac_resume(ndev); 410 } 411 #endif /* CONFIG_PM_SLEEP */ 412 413 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend, 414 stmmac_pltfr_resume); 415 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops); 416 417 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support"); 418 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>"); 419 MODULE_LICENSE("GPL"); 420