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