1 // SPDX-License-Identifier: GPL-2.0-only 2 /******************************************************************************* 3 This contains the functions to handle the platform driver. 4 5 Copyright (C) 2007-2011 STMicroelectronics Ltd 6 7 8 Author: Giuseppe Cavallaro <peppe.cavallaro@st.com> 9 *******************************************************************************/ 10 11 #include <linux/device.h> 12 #include <linux/platform_device.h> 13 #include <linux/pm_runtime.h> 14 #include <linux/module.h> 15 #include <linux/io.h> 16 #include <linux/of.h> 17 #include <linux/of_net.h> 18 #include <linux/of_mdio.h> 19 20 #include "stmmac.h" 21 #include "stmmac_platform.h" 22 23 #ifdef CONFIG_OF 24 25 /** 26 * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins 27 * @dev: struct device of the platform device 28 * @mcast_bins: Multicast filtering bins 29 * Description: 30 * this function validates the number of Multicast filtering bins specified 31 * by the configuration through the device tree. The Synopsys GMAC supports 32 * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC 33 * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds 34 * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is 35 * invalid and will cause the filtering algorithm to use Multicast 36 * promiscuous mode. 37 */ 38 static int dwmac1000_validate_mcast_bins(struct device *dev, int mcast_bins) 39 { 40 int x = mcast_bins; 41 42 switch (x) { 43 case HASH_TABLE_SIZE: 44 case 128: 45 case 256: 46 break; 47 default: 48 x = 0; 49 dev_info(dev, "Hash table entries set to unexpected value %d\n", 50 mcast_bins); 51 break; 52 } 53 return x; 54 } 55 56 /** 57 * dwmac1000_validate_ucast_entries - validate the Unicast address entries 58 * @dev: struct device of the platform device 59 * @ucast_entries: number of Unicast address entries 60 * Description: 61 * This function validates the number of Unicast address entries supported 62 * by a particular Synopsys 10/100/1000 controller. The Synopsys controller 63 * supports 1..32, 64, or 128 Unicast filter entries for it's Unicast filter 64 * logic. This function validates a valid, supported configuration is 65 * selected, and defaults to 1 Unicast address if an unsupported 66 * configuration is selected. 67 */ 68 static int dwmac1000_validate_ucast_entries(struct device *dev, 69 int ucast_entries) 70 { 71 int x = ucast_entries; 72 73 switch (x) { 74 case 1 ... 32: 75 case 64: 76 case 128: 77 break; 78 default: 79 x = 1; 80 dev_info(dev, "Unicast table entries set to unexpected value %d\n", 81 ucast_entries); 82 break; 83 } 84 return x; 85 } 86 87 /** 88 * stmmac_axi_setup - parse DT parameters for programming the AXI register 89 * @pdev: platform device 90 * Description: 91 * if required, from device-tree the AXI internal register can be tuned 92 * by using platform parameters. 93 */ 94 static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev) 95 { 96 struct device_node *np; 97 struct stmmac_axi *axi; 98 99 np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0); 100 if (!np) 101 return NULL; 102 103 axi = devm_kzalloc(&pdev->dev, sizeof(*axi), GFP_KERNEL); 104 if (!axi) { 105 of_node_put(np); 106 return ERR_PTR(-ENOMEM); 107 } 108 109 axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en"); 110 axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm"); 111 axi->axi_kbbe = of_property_read_bool(np, "snps,kbbe"); 112 axi->axi_fb = of_property_read_bool(np, "snps,fb"); 113 axi->axi_mb = of_property_read_bool(np, "snps,mb"); 114 axi->axi_rb = of_property_read_bool(np, "snps,rb"); 115 116 if (of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt)) 117 axi->axi_wr_osr_lmt = 1; 118 if (of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt)) 119 axi->axi_rd_osr_lmt = 1; 120 of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN); 121 of_node_put(np); 122 123 return axi; 124 } 125 126 /** 127 * stmmac_mtl_setup - parse DT parameters for multiple queues configuration 128 * @pdev: platform device 129 * @plat: enet data 130 */ 131 static int stmmac_mtl_setup(struct platform_device *pdev, 132 struct plat_stmmacenet_data *plat) 133 { 134 struct device_node *q_node; 135 struct device_node *rx_node; 136 struct device_node *tx_node; 137 u8 queue = 0; 138 int ret = 0; 139 140 /* For backwards-compatibility with device trees that don't have any 141 * snps,mtl-rx-config or snps,mtl-tx-config properties, we fall back 142 * to one RX and TX queues each. 143 */ 144 plat->rx_queues_to_use = 1; 145 plat->tx_queues_to_use = 1; 146 147 /* First Queue must always be in DCB mode. As MTL_QUEUE_DCB = 1 we need 148 * to always set this, otherwise Queue will be classified as AVB 149 * (because MTL_QUEUE_AVB = 0). 150 */ 151 plat->rx_queues_cfg[0].mode_to_use = MTL_QUEUE_DCB; 152 plat->tx_queues_cfg[0].mode_to_use = MTL_QUEUE_DCB; 153 154 rx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-rx-config", 0); 155 if (!rx_node) 156 return ret; 157 158 tx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-tx-config", 0); 159 if (!tx_node) { 160 of_node_put(rx_node); 161 return ret; 162 } 163 164 /* Processing RX queues common config */ 165 if (of_property_read_u32(rx_node, "snps,rx-queues-to-use", 166 &plat->rx_queues_to_use)) 167 plat->rx_queues_to_use = 1; 168 169 if (of_property_read_bool(rx_node, "snps,rx-sched-sp")) 170 plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP; 171 else if (of_property_read_bool(rx_node, "snps,rx-sched-wsp")) 172 plat->rx_sched_algorithm = MTL_RX_ALGORITHM_WSP; 173 else 174 plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP; 175 176 /* Processing individual RX queue config */ 177 for_each_child_of_node(rx_node, q_node) { 178 if (queue >= plat->rx_queues_to_use) 179 break; 180 181 if (of_property_read_bool(q_node, "snps,dcb-algorithm")) 182 plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB; 183 else if (of_property_read_bool(q_node, "snps,avb-algorithm")) 184 plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB; 185 else 186 plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB; 187 188 if (of_property_read_u32(q_node, "snps,map-to-dma-channel", 189 &plat->rx_queues_cfg[queue].chan)) 190 plat->rx_queues_cfg[queue].chan = queue; 191 /* TODO: Dynamic mapping to be included in the future */ 192 193 if (of_property_read_u32(q_node, "snps,priority", 194 &plat->rx_queues_cfg[queue].prio)) { 195 plat->rx_queues_cfg[queue].prio = 0; 196 plat->rx_queues_cfg[queue].use_prio = false; 197 } else { 198 plat->rx_queues_cfg[queue].use_prio = true; 199 } 200 201 /* RX queue specific packet type routing */ 202 if (of_property_read_bool(q_node, "snps,route-avcp")) 203 plat->rx_queues_cfg[queue].pkt_route = PACKET_AVCPQ; 204 else if (of_property_read_bool(q_node, "snps,route-ptp")) 205 plat->rx_queues_cfg[queue].pkt_route = PACKET_PTPQ; 206 else if (of_property_read_bool(q_node, "snps,route-dcbcp")) 207 plat->rx_queues_cfg[queue].pkt_route = PACKET_DCBCPQ; 208 else if (of_property_read_bool(q_node, "snps,route-up")) 209 plat->rx_queues_cfg[queue].pkt_route = PACKET_UPQ; 210 else if (of_property_read_bool(q_node, "snps,route-multi-broad")) 211 plat->rx_queues_cfg[queue].pkt_route = PACKET_MCBCQ; 212 else 213 plat->rx_queues_cfg[queue].pkt_route = 0x0; 214 215 queue++; 216 } 217 if (queue != plat->rx_queues_to_use) { 218 ret = -EINVAL; 219 dev_err(&pdev->dev, "Not all RX queues were configured\n"); 220 goto out; 221 } 222 223 /* Processing TX queues common config */ 224 if (of_property_read_u32(tx_node, "snps,tx-queues-to-use", 225 &plat->tx_queues_to_use)) 226 plat->tx_queues_to_use = 1; 227 228 if (of_property_read_bool(tx_node, "snps,tx-sched-wrr")) 229 plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WRR; 230 else if (of_property_read_bool(tx_node, "snps,tx-sched-wfq")) 231 plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WFQ; 232 else if (of_property_read_bool(tx_node, "snps,tx-sched-dwrr")) 233 plat->tx_sched_algorithm = MTL_TX_ALGORITHM_DWRR; 234 else 235 plat->tx_sched_algorithm = MTL_TX_ALGORITHM_SP; 236 237 queue = 0; 238 239 /* Processing individual TX queue config */ 240 for_each_child_of_node(tx_node, q_node) { 241 if (queue >= plat->tx_queues_to_use) 242 break; 243 244 if (of_property_read_u32(q_node, "snps,weight", 245 &plat->tx_queues_cfg[queue].weight)) 246 plat->tx_queues_cfg[queue].weight = 0x10 + queue; 247 248 if (of_property_read_bool(q_node, "snps,dcb-algorithm")) { 249 plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB; 250 } else if (of_property_read_bool(q_node, 251 "snps,avb-algorithm")) { 252 plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB; 253 254 /* Credit Base Shaper parameters used by AVB */ 255 if (of_property_read_u32(q_node, "snps,send_slope", 256 &plat->tx_queues_cfg[queue].send_slope)) 257 plat->tx_queues_cfg[queue].send_slope = 0x0; 258 if (of_property_read_u32(q_node, "snps,idle_slope", 259 &plat->tx_queues_cfg[queue].idle_slope)) 260 plat->tx_queues_cfg[queue].idle_slope = 0x0; 261 if (of_property_read_u32(q_node, "snps,high_credit", 262 &plat->tx_queues_cfg[queue].high_credit)) 263 plat->tx_queues_cfg[queue].high_credit = 0x0; 264 if (of_property_read_u32(q_node, "snps,low_credit", 265 &plat->tx_queues_cfg[queue].low_credit)) 266 plat->tx_queues_cfg[queue].low_credit = 0x0; 267 } else { 268 plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB; 269 } 270 271 if (of_property_read_u32(q_node, "snps,priority", 272 &plat->tx_queues_cfg[queue].prio)) { 273 plat->tx_queues_cfg[queue].prio = 0; 274 plat->tx_queues_cfg[queue].use_prio = false; 275 } else { 276 plat->tx_queues_cfg[queue].use_prio = true; 277 } 278 279 plat->tx_queues_cfg[queue].coe_unsupported = 280 of_property_read_bool(q_node, "snps,coe-unsupported"); 281 282 queue++; 283 } 284 if (queue != plat->tx_queues_to_use) { 285 ret = -EINVAL; 286 dev_err(&pdev->dev, "Not all TX queues were configured\n"); 287 goto out; 288 } 289 290 out: 291 of_node_put(rx_node); 292 of_node_put(tx_node); 293 of_node_put(q_node); 294 295 return ret; 296 } 297 298 /** 299 * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources 300 * @plat: driver data platform structure 301 * @np: device tree node 302 * @dev: device pointer 303 * Description: 304 * The mdio bus will be allocated in case of a phy transceiver is on board; 305 * it will be NULL if the fixed-link is configured. 306 * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated 307 * in any case (for DSA, mdio must be registered even if fixed-link). 308 * The table below sums the supported configurations: 309 * ------------------------------- 310 * snps,phy-addr | Y 311 * ------------------------------- 312 * phy-handle | Y 313 * ------------------------------- 314 * fixed-link | N 315 * ------------------------------- 316 * snps,dwmac-mdio | 317 * even if | Y 318 * fixed-link | 319 * ------------------------------- 320 * 321 * It returns 0 in case of success otherwise -ENODEV. 322 */ 323 static int stmmac_dt_phy(struct plat_stmmacenet_data *plat, 324 struct device_node *np, struct device *dev) 325 { 326 bool mdio = !of_phy_is_fixed_link(np); 327 static const struct of_device_id need_mdio_ids[] = { 328 { .compatible = "snps,dwc-qos-ethernet-4.10" }, 329 {}, 330 }; 331 332 if (of_match_node(need_mdio_ids, np)) { 333 plat->mdio_node = of_get_child_by_name(np, "mdio"); 334 } else { 335 /** 336 * If snps,dwmac-mdio is passed from DT, always register 337 * the MDIO 338 */ 339 for_each_child_of_node(np, plat->mdio_node) { 340 if (of_device_is_compatible(plat->mdio_node, 341 "snps,dwmac-mdio")) 342 break; 343 } 344 } 345 346 if (plat->mdio_node) { 347 dev_dbg(dev, "Found MDIO subnode\n"); 348 mdio = true; 349 } 350 351 if (mdio) { 352 plat->mdio_bus_data = 353 devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data), 354 GFP_KERNEL); 355 if (!plat->mdio_bus_data) 356 return -ENOMEM; 357 358 plat->mdio_bus_data->needs_reset = true; 359 } 360 361 return 0; 362 } 363 364 /** 365 * stmmac_of_get_mac_mode - retrieves the interface of the MAC 366 * @np: - device-tree node 367 * Description: 368 * Similar to `of_get_phy_mode()`, this function will retrieve (from 369 * the device-tree) the interface mode on the MAC side. This assumes 370 * that there is mode converter in-between the MAC & PHY 371 * (e.g. GMII-to-RGMII). 372 */ 373 static int stmmac_of_get_mac_mode(struct device_node *np) 374 { 375 const char *pm; 376 int err, i; 377 378 err = of_property_read_string(np, "mac-mode", &pm); 379 if (err < 0) 380 return err; 381 382 for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++) { 383 if (!strcasecmp(pm, phy_modes(i))) 384 return i; 385 } 386 387 return -ENODEV; 388 } 389 390 /** 391 * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt() 392 * @pdev: platform_device structure 393 * @plat: driver data platform structure 394 * 395 * Release resources claimed by stmmac_probe_config_dt(). 396 */ 397 static void stmmac_remove_config_dt(struct platform_device *pdev, 398 struct plat_stmmacenet_data *plat) 399 { 400 clk_disable_unprepare(plat->stmmac_clk); 401 clk_disable_unprepare(plat->pclk); 402 of_node_put(plat->phy_node); 403 of_node_put(plat->mdio_node); 404 } 405 406 /** 407 * stmmac_probe_config_dt - parse device-tree driver parameters 408 * @pdev: platform_device structure 409 * @mac: MAC address to use 410 * Description: 411 * this function is to read the driver parameters from device-tree and 412 * set some private fields that will be used by the main at runtime. 413 */ 414 static struct plat_stmmacenet_data * 415 stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac) 416 { 417 struct device_node *np = pdev->dev.of_node; 418 struct plat_stmmacenet_data *plat; 419 struct stmmac_dma_cfg *dma_cfg; 420 int phy_mode; 421 void *ret; 422 int rc; 423 424 plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL); 425 if (!plat) 426 return ERR_PTR(-ENOMEM); 427 428 rc = of_get_mac_address(np, mac); 429 if (rc) { 430 if (rc == -EPROBE_DEFER) 431 return ERR_PTR(rc); 432 433 eth_zero_addr(mac); 434 } 435 436 phy_mode = device_get_phy_mode(&pdev->dev); 437 if (phy_mode < 0) 438 return ERR_PTR(phy_mode); 439 440 plat->phy_interface = phy_mode; 441 rc = stmmac_of_get_mac_mode(np); 442 plat->mac_interface = rc < 0 ? plat->phy_interface : rc; 443 444 /* Some wrapper drivers still rely on phy_node. Let's save it while 445 * they are not converted to phylink. */ 446 plat->phy_node = of_parse_phandle(np, "phy-handle", 0); 447 448 /* PHYLINK automatically parses the phy-handle property */ 449 plat->port_node = of_fwnode_handle(np); 450 451 /* Get max speed of operation from device tree */ 452 of_property_read_u32(np, "max-speed", &plat->max_speed); 453 454 plat->bus_id = of_alias_get_id(np, "ethernet"); 455 if (plat->bus_id < 0) 456 plat->bus_id = 0; 457 458 /* Default to phy auto-detection */ 459 plat->phy_addr = -1; 460 461 /* Default to get clk_csr from stmmac_clk_csr_set(), 462 * or get clk_csr from device tree. 463 */ 464 plat->clk_csr = -1; 465 if (of_property_read_u32(np, "snps,clk-csr", &plat->clk_csr)) 466 of_property_read_u32(np, "clk_csr", &plat->clk_csr); 467 468 /* "snps,phy-addr" is not a standard property. Mark it as deprecated 469 * and warn of its use. Remove this when phy node support is added. 470 */ 471 if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0) 472 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n"); 473 474 /* To Configure PHY by using all device-tree supported properties */ 475 rc = stmmac_dt_phy(plat, np, &pdev->dev); 476 if (rc) 477 return ERR_PTR(rc); 478 479 of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size); 480 481 of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size); 482 483 plat->force_sf_dma_mode = 484 of_property_read_bool(np, "snps,force_sf_dma_mode"); 485 486 if (of_property_read_bool(np, "snps,en-tx-lpi-clockgating")) 487 plat->flags |= STMMAC_FLAG_EN_TX_LPI_CLOCKGATING; 488 489 /* Set the maxmtu to a default of JUMBO_LEN in case the 490 * parameter is not present in the device tree. 491 */ 492 plat->maxmtu = JUMBO_LEN; 493 494 /* Set default value for multicast hash bins */ 495 plat->multicast_filter_bins = HASH_TABLE_SIZE; 496 497 /* Set default value for unicast filter entries */ 498 plat->unicast_filter_entries = 1; 499 500 /* 501 * Currently only the properties needed on SPEAr600 502 * are provided. All other properties should be added 503 * once needed on other platforms. 504 */ 505 if (of_device_is_compatible(np, "st,spear600-gmac") || 506 of_device_is_compatible(np, "snps,dwmac-3.50a") || 507 of_device_is_compatible(np, "snps,dwmac-3.70a") || 508 of_device_is_compatible(np, "snps,dwmac")) { 509 /* Note that the max-frame-size parameter as defined in the 510 * ePAPR v1.1 spec is defined as max-frame-size, it's 511 * actually used as the IEEE definition of MAC Client 512 * data, or MTU. The ePAPR specification is confusing as 513 * the definition is max-frame-size, but usage examples 514 * are clearly MTUs 515 */ 516 of_property_read_u32(np, "max-frame-size", &plat->maxmtu); 517 of_property_read_u32(np, "snps,multicast-filter-bins", 518 &plat->multicast_filter_bins); 519 of_property_read_u32(np, "snps,perfect-filter-entries", 520 &plat->unicast_filter_entries); 521 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries( 522 &pdev->dev, plat->unicast_filter_entries); 523 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins( 524 &pdev->dev, plat->multicast_filter_bins); 525 plat->has_gmac = 1; 526 plat->pmt = 1; 527 } 528 529 if (of_device_is_compatible(np, "snps,dwmac-3.40a")) { 530 plat->has_gmac = 1; 531 plat->enh_desc = 1; 532 plat->tx_coe = 1; 533 plat->bugged_jumbo = 1; 534 plat->pmt = 1; 535 } 536 537 if (of_device_is_compatible(np, "snps,dwmac-4.00") || 538 of_device_is_compatible(np, "snps,dwmac-4.10a") || 539 of_device_is_compatible(np, "snps,dwmac-4.20a") || 540 of_device_is_compatible(np, "snps,dwmac-5.10a") || 541 of_device_is_compatible(np, "snps,dwmac-5.20")) { 542 plat->has_gmac4 = 1; 543 plat->has_gmac = 0; 544 plat->pmt = 1; 545 if (of_property_read_bool(np, "snps,tso")) 546 plat->flags |= STMMAC_FLAG_TSO_EN; 547 } 548 549 if (of_device_is_compatible(np, "snps,dwmac-3.610") || 550 of_device_is_compatible(np, "snps,dwmac-3.710")) { 551 plat->enh_desc = 1; 552 plat->bugged_jumbo = 1; 553 plat->force_sf_dma_mode = 1; 554 } 555 556 if (of_device_is_compatible(np, "snps,dwxgmac")) { 557 plat->has_xgmac = 1; 558 plat->pmt = 1; 559 if (of_property_read_bool(np, "snps,tso")) 560 plat->flags |= STMMAC_FLAG_TSO_EN; 561 } 562 563 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg), 564 GFP_KERNEL); 565 if (!dma_cfg) { 566 stmmac_remove_config_dt(pdev, plat); 567 return ERR_PTR(-ENOMEM); 568 } 569 plat->dma_cfg = dma_cfg; 570 571 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl); 572 if (!dma_cfg->pbl) 573 dma_cfg->pbl = DEFAULT_DMA_PBL; 574 of_property_read_u32(np, "snps,txpbl", &dma_cfg->txpbl); 575 of_property_read_u32(np, "snps,rxpbl", &dma_cfg->rxpbl); 576 dma_cfg->pblx8 = !of_property_read_bool(np, "snps,no-pbl-x8"); 577 578 dma_cfg->aal = of_property_read_bool(np, "snps,aal"); 579 dma_cfg->fixed_burst = of_property_read_bool(np, "snps,fixed-burst"); 580 dma_cfg->mixed_burst = of_property_read_bool(np, "snps,mixed-burst"); 581 582 plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode"); 583 if (plat->force_thresh_dma_mode && plat->force_sf_dma_mode) { 584 plat->force_sf_dma_mode = 0; 585 dev_warn(&pdev->dev, 586 "force_sf_dma_mode is ignored if force_thresh_dma_mode is set.\n"); 587 } 588 589 of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed); 590 591 plat->axi = stmmac_axi_setup(pdev); 592 593 rc = stmmac_mtl_setup(pdev, plat); 594 if (rc) { 595 stmmac_remove_config_dt(pdev, plat); 596 return ERR_PTR(rc); 597 } 598 599 /* clock setup */ 600 if (!of_device_is_compatible(np, "snps,dwc-qos-ethernet-4.10")) { 601 plat->stmmac_clk = devm_clk_get(&pdev->dev, 602 STMMAC_RESOURCE_NAME); 603 if (IS_ERR(plat->stmmac_clk)) { 604 dev_warn(&pdev->dev, "Cannot get CSR clock\n"); 605 plat->stmmac_clk = NULL; 606 } 607 clk_prepare_enable(plat->stmmac_clk); 608 } 609 610 plat->pclk = devm_clk_get_optional(&pdev->dev, "pclk"); 611 if (IS_ERR(plat->pclk)) { 612 ret = plat->pclk; 613 goto error_pclk_get; 614 } 615 clk_prepare_enable(plat->pclk); 616 617 /* Fall-back to main clock in case of no PTP ref is passed */ 618 plat->clk_ptp_ref = devm_clk_get(&pdev->dev, "ptp_ref"); 619 if (IS_ERR(plat->clk_ptp_ref)) { 620 plat->clk_ptp_rate = clk_get_rate(plat->stmmac_clk); 621 plat->clk_ptp_ref = NULL; 622 dev_info(&pdev->dev, "PTP uses main clock\n"); 623 } else { 624 plat->clk_ptp_rate = clk_get_rate(plat->clk_ptp_ref); 625 dev_dbg(&pdev->dev, "PTP rate %d\n", plat->clk_ptp_rate); 626 } 627 628 plat->stmmac_rst = devm_reset_control_get_optional(&pdev->dev, 629 STMMAC_RESOURCE_NAME); 630 if (IS_ERR(plat->stmmac_rst)) { 631 ret = plat->stmmac_rst; 632 goto error_hw_init; 633 } 634 635 plat->stmmac_ahb_rst = devm_reset_control_get_optional_shared( 636 &pdev->dev, "ahb"); 637 if (IS_ERR(plat->stmmac_ahb_rst)) { 638 ret = plat->stmmac_ahb_rst; 639 goto error_hw_init; 640 } 641 642 return plat; 643 644 error_hw_init: 645 clk_disable_unprepare(plat->pclk); 646 error_pclk_get: 647 clk_disable_unprepare(plat->stmmac_clk); 648 649 return ret; 650 } 651 652 static void devm_stmmac_remove_config_dt(void *data) 653 { 654 struct plat_stmmacenet_data *plat = data; 655 656 /* Platform data argument is unused */ 657 stmmac_remove_config_dt(NULL, plat); 658 } 659 660 /** 661 * devm_stmmac_probe_config_dt 662 * @pdev: platform_device structure 663 * @mac: MAC address to use 664 * Description: Devres variant of stmmac_probe_config_dt(). Does not require 665 * the user to call stmmac_remove_config_dt() at driver detach. 666 */ 667 struct plat_stmmacenet_data * 668 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac) 669 { 670 struct plat_stmmacenet_data *plat; 671 int ret; 672 673 plat = stmmac_probe_config_dt(pdev, mac); 674 if (IS_ERR(plat)) 675 return plat; 676 677 ret = devm_add_action_or_reset(&pdev->dev, 678 devm_stmmac_remove_config_dt, plat); 679 if (ret) 680 return ERR_PTR(ret); 681 682 return plat; 683 } 684 #else 685 struct plat_stmmacenet_data * 686 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac) 687 { 688 return ERR_PTR(-EINVAL); 689 } 690 #endif /* CONFIG_OF */ 691 EXPORT_SYMBOL_GPL(devm_stmmac_probe_config_dt); 692 693 int stmmac_get_platform_resources(struct platform_device *pdev, 694 struct stmmac_resources *stmmac_res) 695 { 696 memset(stmmac_res, 0, sizeof(*stmmac_res)); 697 698 /* Get IRQ information early to have an ability to ask for deferred 699 * probe if needed before we went too far with resource allocation. 700 */ 701 stmmac_res->irq = platform_get_irq_byname(pdev, "macirq"); 702 if (stmmac_res->irq < 0) 703 return stmmac_res->irq; 704 705 /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq 706 * The external wake up irq can be passed through the platform code 707 * named as "eth_wake_irq" 708 * 709 * In case the wake up interrupt is not passed from the platform 710 * so the driver will continue to use the mac irq (ndev->irq) 711 */ 712 stmmac_res->wol_irq = 713 platform_get_irq_byname_optional(pdev, "eth_wake_irq"); 714 if (stmmac_res->wol_irq < 0) { 715 if (stmmac_res->wol_irq == -EPROBE_DEFER) 716 return -EPROBE_DEFER; 717 dev_info(&pdev->dev, "IRQ eth_wake_irq not found\n"); 718 stmmac_res->wol_irq = stmmac_res->irq; 719 } 720 721 stmmac_res->lpi_irq = 722 platform_get_irq_byname_optional(pdev, "eth_lpi"); 723 if (stmmac_res->lpi_irq < 0) { 724 if (stmmac_res->lpi_irq == -EPROBE_DEFER) 725 return -EPROBE_DEFER; 726 dev_info(&pdev->dev, "IRQ eth_lpi not found\n"); 727 } 728 729 stmmac_res->addr = devm_platform_ioremap_resource(pdev, 0); 730 731 return PTR_ERR_OR_ZERO(stmmac_res->addr); 732 } 733 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources); 734 735 /** 736 * stmmac_pltfr_init 737 * @pdev: pointer to the platform device 738 * @plat: driver data platform structure 739 * Description: Call the platform's init callback (if any) and propagate 740 * the return value. 741 */ 742 int stmmac_pltfr_init(struct platform_device *pdev, 743 struct plat_stmmacenet_data *plat) 744 { 745 int ret = 0; 746 747 if (plat->init) 748 ret = plat->init(pdev, plat->bsp_priv); 749 750 return ret; 751 } 752 EXPORT_SYMBOL_GPL(stmmac_pltfr_init); 753 754 /** 755 * stmmac_pltfr_exit 756 * @pdev: pointer to the platform device 757 * @plat: driver data platform structure 758 * Description: Call the platform's exit callback (if any). 759 */ 760 void stmmac_pltfr_exit(struct platform_device *pdev, 761 struct plat_stmmacenet_data *plat) 762 { 763 if (plat->exit) 764 plat->exit(pdev, plat->bsp_priv); 765 } 766 EXPORT_SYMBOL_GPL(stmmac_pltfr_exit); 767 768 /** 769 * stmmac_pltfr_probe 770 * @pdev: platform device pointer 771 * @plat: driver data platform structure 772 * @res: stmmac resources structure 773 * Description: This calls the platform's init() callback and probes the 774 * stmmac driver. 775 */ 776 int stmmac_pltfr_probe(struct platform_device *pdev, 777 struct plat_stmmacenet_data *plat, 778 struct stmmac_resources *res) 779 { 780 int ret; 781 782 ret = stmmac_pltfr_init(pdev, plat); 783 if (ret) 784 return ret; 785 786 ret = stmmac_dvr_probe(&pdev->dev, plat, res); 787 if (ret) { 788 stmmac_pltfr_exit(pdev, plat); 789 return ret; 790 } 791 792 return ret; 793 } 794 EXPORT_SYMBOL_GPL(stmmac_pltfr_probe); 795 796 static void devm_stmmac_pltfr_remove(void *data) 797 { 798 struct platform_device *pdev = data; 799 800 stmmac_pltfr_remove(pdev); 801 } 802 803 /** 804 * devm_stmmac_pltfr_probe 805 * @pdev: pointer to the platform device 806 * @plat: driver data platform structure 807 * @res: stmmac resources 808 * Description: Devres variant of stmmac_pltfr_probe(). Allows users to skip 809 * calling stmmac_pltfr_remove() on driver detach. 810 */ 811 int devm_stmmac_pltfr_probe(struct platform_device *pdev, 812 struct plat_stmmacenet_data *plat, 813 struct stmmac_resources *res) 814 { 815 int ret; 816 817 ret = stmmac_pltfr_probe(pdev, plat, res); 818 if (ret) 819 return ret; 820 821 return devm_add_action_or_reset(&pdev->dev, devm_stmmac_pltfr_remove, 822 pdev); 823 } 824 EXPORT_SYMBOL_GPL(devm_stmmac_pltfr_probe); 825 826 /** 827 * stmmac_pltfr_remove 828 * @pdev: pointer to the platform device 829 * Description: This undoes the effects of stmmac_pltfr_probe() by removing the 830 * driver and calling the platform's exit() callback. 831 */ 832 void stmmac_pltfr_remove(struct platform_device *pdev) 833 { 834 struct net_device *ndev = platform_get_drvdata(pdev); 835 struct stmmac_priv *priv = netdev_priv(ndev); 836 struct plat_stmmacenet_data *plat = priv->plat; 837 838 stmmac_dvr_remove(&pdev->dev); 839 stmmac_pltfr_exit(pdev, plat); 840 } 841 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove); 842 843 /** 844 * stmmac_pltfr_suspend 845 * @dev: device pointer 846 * Description: this function is invoked when suspend the driver and it direcly 847 * call the main suspend function and then, if required, on some platform, it 848 * can call an exit helper. 849 */ 850 static int __maybe_unused stmmac_pltfr_suspend(struct device *dev) 851 { 852 int ret; 853 struct net_device *ndev = dev_get_drvdata(dev); 854 struct stmmac_priv *priv = netdev_priv(ndev); 855 struct platform_device *pdev = to_platform_device(dev); 856 857 ret = stmmac_suspend(dev); 858 stmmac_pltfr_exit(pdev, priv->plat); 859 860 return ret; 861 } 862 863 /** 864 * stmmac_pltfr_resume 865 * @dev: device pointer 866 * Description: this function is invoked when resume the driver before calling 867 * the main resume function, on some platforms, it can call own init helper 868 * if required. 869 */ 870 static int __maybe_unused stmmac_pltfr_resume(struct device *dev) 871 { 872 struct net_device *ndev = dev_get_drvdata(dev); 873 struct stmmac_priv *priv = netdev_priv(ndev); 874 struct platform_device *pdev = to_platform_device(dev); 875 int ret; 876 877 ret = stmmac_pltfr_init(pdev, priv->plat->bsp_priv); 878 if (ret) 879 return ret; 880 881 return stmmac_resume(dev); 882 } 883 884 static int __maybe_unused stmmac_runtime_suspend(struct device *dev) 885 { 886 struct net_device *ndev = dev_get_drvdata(dev); 887 struct stmmac_priv *priv = netdev_priv(ndev); 888 889 stmmac_bus_clks_config(priv, false); 890 891 return 0; 892 } 893 894 static int __maybe_unused stmmac_runtime_resume(struct device *dev) 895 { 896 struct net_device *ndev = dev_get_drvdata(dev); 897 struct stmmac_priv *priv = netdev_priv(ndev); 898 899 return stmmac_bus_clks_config(priv, true); 900 } 901 902 static int __maybe_unused stmmac_pltfr_noirq_suspend(struct device *dev) 903 { 904 struct net_device *ndev = dev_get_drvdata(dev); 905 struct stmmac_priv *priv = netdev_priv(ndev); 906 int ret; 907 908 if (!netif_running(ndev)) 909 return 0; 910 911 if (!device_may_wakeup(priv->device) || !priv->plat->pmt) { 912 /* Disable clock in case of PWM is off */ 913 clk_disable_unprepare(priv->plat->clk_ptp_ref); 914 915 ret = pm_runtime_force_suspend(dev); 916 if (ret) 917 return ret; 918 } 919 920 return 0; 921 } 922 923 static int __maybe_unused stmmac_pltfr_noirq_resume(struct device *dev) 924 { 925 struct net_device *ndev = dev_get_drvdata(dev); 926 struct stmmac_priv *priv = netdev_priv(ndev); 927 int ret; 928 929 if (!netif_running(ndev)) 930 return 0; 931 932 if (!device_may_wakeup(priv->device) || !priv->plat->pmt) { 933 /* enable the clk previously disabled */ 934 ret = pm_runtime_force_resume(dev); 935 if (ret) 936 return ret; 937 938 ret = clk_prepare_enable(priv->plat->clk_ptp_ref); 939 if (ret < 0) { 940 netdev_warn(priv->dev, 941 "failed to enable PTP reference clock: %pe\n", 942 ERR_PTR(ret)); 943 return ret; 944 } 945 } 946 947 return 0; 948 } 949 950 const struct dev_pm_ops stmmac_pltfr_pm_ops = { 951 SET_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_suspend, stmmac_pltfr_resume) 952 SET_RUNTIME_PM_OPS(stmmac_runtime_suspend, stmmac_runtime_resume, NULL) 953 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_noirq_suspend, stmmac_pltfr_noirq_resume) 954 }; 955 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops); 956 957 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support"); 958 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>"); 959 MODULE_LICENSE("GPL"); 960