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