drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c

   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 <[email protected]>
   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_of_get_mdio() - Gets the MDIO bus from the devicetree.
 300  * @np: devicetree node
 301  *
 302  * The MDIO bus will be searched for in the following ways:
 303  * 1. The compatible is "snps,dwc-qos-ethernet-4.10" && a "mdio" named
 304  *    child node exists
 305  * 2. A child node with the "snps,dwmac-mdio" compatible is present
 306  *
 307  * Return: The MDIO node if present otherwise NULL
 308  */
 309 static struct device_node *stmmac_of_get_mdio(struct device_node *np)
 310 {
 311         static const struct of_device_id need_mdio_ids[] = {
 312                 { .compatible = "snps,dwc-qos-ethernet-4.10" },
 313                 {},
 314         };
 315         struct device_node *mdio_node = NULL;
 316
 317         if (of_match_node(need_mdio_ids, np)) {
 318                 mdio_node = of_get_child_by_name(np, "mdio");
 319         } else {
 320                 /**
 321                  * If snps,dwmac-mdio is passed from DT, always register
 322                  * the MDIO
 323                  */
 324                 for_each_child_of_node(np, mdio_node) {
 325                         if (of_device_is_compatible(mdio_node,
 326                                                     "snps,dwmac-mdio"))
 327                                 break;
 328                 }
 329         }
 330
 331         return mdio_node;
 332 }
 333
 334 /**
 335  * stmmac_mdio_setup() - Populate platform related MDIO structures.
 336  * @plat: driver data platform structure
 337  * @np: devicetree node
 338  * @dev: device pointer
 339  *
 340  * This searches for MDIO information from the devicetree.
 341  * If an MDIO node is found, it's assigned to plat->mdio_node and
 342  * plat->mdio_bus_data is allocated.
 343  * If no connection can be determined, just plat->mdio_bus_data is allocated
 344  * to indicate a bus should be created and scanned for a phy.
 345  * If it's determined there's no MDIO bus needed, both are left NULL.
 346  *
 347  * This expects that plat->phy_node has already been searched for.
 348  *
 349  * Return: 0 on success, errno otherwise.
 350  */
 351 static int stmmac_mdio_setup(struct plat_stmmacenet_data *plat,
 352                              struct device_node *np, struct device *dev)
 353 {
 354         bool legacy_mdio;
 355
 356         plat->mdio_node = stmmac_of_get_mdio(np);
 357         if (plat->mdio_node)
 358                 dev_dbg(dev, "Found MDIO subnode\n");
 359
 360         /* Legacy devicetrees allowed for no MDIO bus description and expect
 361          * the bus to be scanned for devices. If there's no phy or fixed-link
 362          * described assume this is the case since there must be something
 363          * connected to the MAC.
 364          */
 365         legacy_mdio = !of_phy_is_fixed_link(np) && !plat->phy_node;
 366         if (legacy_mdio)
 367                 dev_info(dev, "Deprecated MDIO bus assumption used\n");
 368
 369         if (plat->mdio_node || legacy_mdio) {
 370                 plat->mdio_bus_data = devm_kzalloc(dev,
 371                                                    sizeof(*plat->mdio_bus_data),
 372                                                    GFP_KERNEL);
 373                 if (!plat->mdio_bus_data)
 374                         return -ENOMEM;
 375
 376                 plat->mdio_bus_data->needs_reset = true;
 377         }
 378
 379         return 0;
 380 }
 381
 382 /**
 383  * stmmac_of_get_mac_mode - retrieves the interface of the MAC
 384  * @np: - device-tree node
 385  * Description:
 386  * Similar to `of_get_phy_mode()`, this function will retrieve (from
 387  * the device-tree) the interface mode on the MAC side. This assumes
 388  * that there is mode converter in-between the MAC & PHY
 389  * (e.g. GMII-to-RGMII).
 390  */
 391 static int stmmac_of_get_mac_mode(struct device_node *np)
 392 {
 393         const char *pm;
 394         int err, i;
 395
 396         err = of_property_read_string(np, "mac-mode", &pm);
 397         if (err < 0)
 398                 return err;
 399
 400         for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++) {
 401                 if (!strcasecmp(pm, phy_modes(i)))
 402                         return i;
 403         }
 404
 405         return -ENODEV;
 406 }
 407
 408 /**
 409  * stmmac_probe_config_dt - parse device-tree driver parameters
 410  * @pdev: platform_device structure
 411  * @mac: MAC address to use
 412  * Description:
 413  * this function is to read the driver parameters from device-tree and
 414  * set some private fields that will be used by the main at runtime.
 415  */
 416 static struct plat_stmmacenet_data *
 417 stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
 418 {
 419         struct device_node *np = pdev->dev.of_node;
 420         struct plat_stmmacenet_data *plat;
 421         struct stmmac_dma_cfg *dma_cfg;
 422         int phy_mode;
 423         void *ret;
 424         int rc;
 425
 426         plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
 427         if (!plat)
 428                 return ERR_PTR(-ENOMEM);
 429
 430         rc = of_get_mac_address(np, mac);
 431         if (rc) {
 432                 if (rc == -EPROBE_DEFER)
 433                         return ERR_PTR(rc);
 434
 435                 eth_zero_addr(mac);
 436         }
 437
 438         phy_mode = device_get_phy_mode(&pdev->dev);
 439         if (phy_mode < 0)
 440                 return ERR_PTR(phy_mode);
 441
 442         plat->phy_interface = phy_mode;
 443         rc = stmmac_of_get_mac_mode(np);
 444         plat->mac_interface = rc < 0 ? plat->phy_interface : rc;
 445
 446         /* Some wrapper drivers still rely on phy_node. Let's save it while
 447          * they are not converted to phylink. */
 448         plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
 449
 450         /* PHYLINK automatically parses the phy-handle property */
 451         plat->port_node = of_fwnode_handle(np);
 452
 453         /* Get max speed of operation from device tree */
 454         of_property_read_u32(np, "max-speed", &plat->max_speed);
 455
 456         plat->bus_id = of_alias_get_id(np, "ethernet");
 457         if (plat->bus_id < 0)
 458                 plat->bus_id = 0;
 459
 460         /* Default to phy auto-detection */
 461         plat->phy_addr = -1;
 462
 463         /* Default to get clk_csr from stmmac_clk_csr_set(),
 464          * or get clk_csr from device tree.
 465          */
 466         plat->clk_csr = -1;
 467         if (of_property_read_u32(np, "snps,clk-csr", &plat->clk_csr))
 468                 of_property_read_u32(np, "clk_csr", &plat->clk_csr);
 469
 470         /* "snps,phy-addr" is not a standard property. Mark it as deprecated
 471          * and warn of its use. Remove this when phy node support is added.
 472          */
 473         if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
 474                 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
 475
 476         rc = stmmac_mdio_setup(plat, np, &pdev->dev);
 477         if (rc) {
 478                 ret = ERR_PTR(rc);
 479                 goto error_put_phy;
 480         }
 481
 482         of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
 483
 484         of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
 485
 486         plat->force_sf_dma_mode =
 487                 of_property_read_bool(np, "snps,force_sf_dma_mode");
 488
 489         if (of_property_read_bool(np, "snps,en-tx-lpi-clockgating"))
 490                 plat->flags |= STMMAC_FLAG_EN_TX_LPI_CLOCKGATING;
 491
 492         /* Set the maxmtu to a default of JUMBO_LEN in case the
 493          * parameter is not present in the device tree.
 494          */
 495         plat->maxmtu = JUMBO_LEN;
 496
 497         /* Set default value for multicast hash bins */
 498         plat->multicast_filter_bins = HASH_TABLE_SIZE;
 499
 500         /* Set default value for unicast filter entries */
 501         plat->unicast_filter_entries = 1;
 502
 503         /*
 504          * Currently only the properties needed on SPEAr600
 505          * are provided. All other properties should be added
 506          * once needed on other platforms.
 507          */
 508         if (of_device_is_compatible(np, "st,spear600-gmac") ||
 509                 of_device_is_compatible(np, "snps,dwmac-3.50a") ||
 510                 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
 511                 of_device_is_compatible(np, "snps,dwmac-3.72a") ||
 512                 of_device_is_compatible(np, "snps,dwmac")) {
 513                 /* Note that the max-frame-size parameter as defined in the
 514                  * ePAPR v1.1 spec is defined as max-frame-size, it's
 515                  * actually used as the IEEE definition of MAC Client
 516                  * data, or MTU. The ePAPR specification is confusing as
 517                  * the definition is max-frame-size, but usage examples
 518                  * are clearly MTUs
 519                  */
 520                 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
 521                 of_property_read_u32(np, "snps,multicast-filter-bins",
 522                                      &plat->multicast_filter_bins);
 523                 of_property_read_u32(np, "snps,perfect-filter-entries",
 524                                      &plat->unicast_filter_entries);
 525                 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
 526                                 &pdev->dev, plat->unicast_filter_entries);
 527                 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
 528                                 &pdev->dev, plat->multicast_filter_bins);
 529                 plat->has_gmac = 1;
 530                 plat->pmt = 1;
 531         }
 532
 533         if (of_device_is_compatible(np, "snps,dwmac-3.40a")) {
 534                 plat->has_gmac = 1;
 535                 plat->enh_desc = 1;
 536                 plat->tx_coe = 1;
 537                 plat->bugged_jumbo = 1;
 538                 plat->pmt = 1;
 539         }
 540
 541         if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
 542             of_device_is_compatible(np, "snps,dwmac-4.10a") ||
 543             of_device_is_compatible(np, "snps,dwmac-4.20a") ||
 544             of_device_is_compatible(np, "snps,dwmac-5.10a") ||
 545             of_device_is_compatible(np, "snps,dwmac-5.20")) {
 546                 plat->has_gmac4 = 1;
 547                 plat->has_gmac = 0;
 548                 plat->pmt = 1;
 549                 if (of_property_read_bool(np, "snps,tso"))
 550                         plat->flags |= STMMAC_FLAG_TSO_EN;
 551         }
 552
 553         if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
 554                 of_device_is_compatible(np, "snps,dwmac-3.710")) {
 555                 plat->enh_desc = 1;
 556                 plat->bugged_jumbo = 1;
 557                 plat->force_sf_dma_mode = 1;
 558         }
 559
 560         if (of_device_is_compatible(np, "snps,dwxgmac")) {
 561                 plat->has_xgmac = 1;
 562                 plat->pmt = 1;
 563                 if (of_property_read_bool(np, "snps,tso"))
 564                         plat->flags |= STMMAC_FLAG_TSO_EN;
 565         }
 566
 567         dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
 568                                GFP_KERNEL);
 569         if (!dma_cfg) {
 570                 ret = ERR_PTR(-ENOMEM);
 571                 goto error_put_mdio;
 572         }
 573         plat->dma_cfg = dma_cfg;
 574
 575         of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
 576         if (!dma_cfg->pbl)
 577                 dma_cfg->pbl = DEFAULT_DMA_PBL;
 578         of_property_read_u32(np, "snps,txpbl", &dma_cfg->txpbl);
 579         of_property_read_u32(np, "snps,rxpbl", &dma_cfg->rxpbl);
 580         dma_cfg->pblx8 = !of_property_read_bool(np, "snps,no-pbl-x8");
 581
 582         dma_cfg->aal = of_property_read_bool(np, "snps,aal");
 583         dma_cfg->fixed_burst = of_property_read_bool(np, "snps,fixed-burst");
 584         dma_cfg->mixed_burst = of_property_read_bool(np, "snps,mixed-burst");
 585
 586         plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
 587         if (plat->force_thresh_dma_mode && plat->force_sf_dma_mode) {
 588                 plat->force_sf_dma_mode = 0;
 589                 dev_warn(&pdev->dev,
 590                          "force_sf_dma_mode is ignored if force_thresh_dma_mode is set.\n");
 591         }
 592
 593         of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);
 594
 595         plat->axi = stmmac_axi_setup(pdev);
 596
 597         rc = stmmac_mtl_setup(pdev, plat);
 598         if (rc) {
 599                 ret = ERR_PTR(rc);
 600                 goto error_put_mdio;
 601         }
 602
 603         /* clock setup */
 604         if (!of_device_is_compatible(np, "snps,dwc-qos-ethernet-4.10")) {
 605                 plat->stmmac_clk = devm_clk_get(&pdev->dev,
 606                                                 STMMAC_RESOURCE_NAME);
 607                 if (IS_ERR(plat->stmmac_clk)) {
 608                         dev_warn(&pdev->dev, "Cannot get CSR clock\n");
 609                         plat->stmmac_clk = NULL;
 610                 }
 611                 clk_prepare_enable(plat->stmmac_clk);
 612         }
 613
 614         plat->pclk = devm_clk_get_optional(&pdev->dev, "pclk");
 615         if (IS_ERR(plat->pclk)) {
 616                 ret = plat->pclk;
 617                 goto error_pclk_get;
 618         }
 619         clk_prepare_enable(plat->pclk);
 620
 621         /* Fall-back to main clock in case of no PTP ref is passed */
 622         plat->clk_ptp_ref = devm_clk_get(&pdev->dev, "ptp_ref");
 623         if (IS_ERR(plat->clk_ptp_ref)) {
 624                 plat->clk_ptp_rate = clk_get_rate(plat->stmmac_clk);
 625                 plat->clk_ptp_ref = NULL;
 626                 dev_info(&pdev->dev, "PTP uses main clock\n");
 627         } else {
 628                 plat->clk_ptp_rate = clk_get_rate(plat->clk_ptp_ref);
 629                 dev_dbg(&pdev->dev, "PTP rate %d\n", plat->clk_ptp_rate);
 630         }
 631
 632         plat->stmmac_rst = devm_reset_control_get_optional(&pdev->dev,
 633                                                            STMMAC_RESOURCE_NAME);
 634         if (IS_ERR(plat->stmmac_rst)) {
 635                 ret = plat->stmmac_rst;
 636                 goto error_hw_init;
 637         }
 638
 639         plat->stmmac_ahb_rst = devm_reset_control_get_optional_shared(
 640                                                         &pdev->dev, "ahb");
 641         if (IS_ERR(plat->stmmac_ahb_rst)) {
 642                 ret = plat->stmmac_ahb_rst;
 643                 goto error_hw_init;
 644         }
 645
 646         return plat;
 647
 648 error_hw_init:
 649         clk_disable_unprepare(plat->pclk);
 650 error_pclk_get:
 651         clk_disable_unprepare(plat->stmmac_clk);
 652 error_put_mdio:
 653         of_node_put(plat->mdio_node);
 654 error_put_phy:
 655         of_node_put(plat->phy_node);
 656
 657         return ret;
 658 }
 659
 660 static void devm_stmmac_remove_config_dt(void *data)
 661 {
 662         struct plat_stmmacenet_data *plat = data;
 663
 664         clk_disable_unprepare(plat->stmmac_clk);
 665         clk_disable_unprepare(plat->pclk);
 666         of_node_put(plat->mdio_node);
 667         of_node_put(plat->phy_node);
 668 }
 669
 670 /**
 671  * devm_stmmac_probe_config_dt
 672  * @pdev: platform_device structure
 673  * @mac: MAC address to use
 674  * Description: Devres variant of stmmac_probe_config_dt().
 675  */
 676 struct plat_stmmacenet_data *
 677 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
 678 {
 679         struct plat_stmmacenet_data *plat;
 680         int ret;
 681
 682         plat = stmmac_probe_config_dt(pdev, mac);
 683         if (IS_ERR(plat))
 684                 return plat;
 685
 686         ret = devm_add_action_or_reset(&pdev->dev,
 687                                        devm_stmmac_remove_config_dt, plat);
 688         if (ret)
 689                 return ERR_PTR(ret);
 690
 691         return plat;
 692 }
 693 #else
 694 struct plat_stmmacenet_data *
 695 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
 696 {
 697         return ERR_PTR(-EINVAL);
 698 }
 699 #endif /* CONFIG_OF */
 700 EXPORT_SYMBOL_GPL(devm_stmmac_probe_config_dt);
 701
 702 int stmmac_get_platform_resources(struct platform_device *pdev,
 703                                   struct stmmac_resources *stmmac_res)
 704 {
 705         memset(stmmac_res, 0, sizeof(*stmmac_res));
 706
 707         /* Get IRQ information early to have an ability to ask for deferred
 708          * probe if needed before we went too far with resource allocation.
 709          */
 710         stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
 711         if (stmmac_res->irq < 0)
 712                 return stmmac_res->irq;
 713
 714         /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
 715          * The external wake up irq can be passed through the platform code
 716          * named as "eth_wake_irq"
 717          *
 718          * In case the wake up interrupt is not passed from the platform
 719          * so the driver will continue to use the mac irq (ndev->irq)
 720          */
 721         stmmac_res->wol_irq =
 722                 platform_get_irq_byname_optional(pdev, "eth_wake_irq");
 723         if (stmmac_res->wol_irq < 0) {
 724                 if (stmmac_res->wol_irq == -EPROBE_DEFER)
 725                         return -EPROBE_DEFER;
 726                 dev_info(&pdev->dev, "IRQ eth_wake_irq not found\n");
 727                 stmmac_res->wol_irq = stmmac_res->irq;
 728         }
 729
 730         stmmac_res->lpi_irq =
 731                 platform_get_irq_byname_optional(pdev, "eth_lpi");
 732         if (stmmac_res->lpi_irq < 0) {
 733                 if (stmmac_res->lpi_irq == -EPROBE_DEFER)
 734                         return -EPROBE_DEFER;
 735                 dev_info(&pdev->dev, "IRQ eth_lpi not found\n");
 736         }
 737
 738         stmmac_res->sfty_irq =
 739                 platform_get_irq_byname_optional(pdev, "sfty");
 740         if (stmmac_res->sfty_irq < 0) {
 741                 if (stmmac_res->sfty_irq == -EPROBE_DEFER)
 742                         return -EPROBE_DEFER;
 743                 dev_info(&pdev->dev, "IRQ sfty not found\n");
 744         }
 745
 746         stmmac_res->addr = devm_platform_ioremap_resource(pdev, 0);
 747
 748         return PTR_ERR_OR_ZERO(stmmac_res->addr);
 749 }
 750 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
 751
 752 /**
 753  * stmmac_pltfr_init
 754  * @pdev: pointer to the platform device
 755  * @plat: driver data platform structure
 756  * Description: Call the platform's init callback (if any) and propagate
 757  * the return value.
 758  */
 759 static int stmmac_pltfr_init(struct platform_device *pdev,
 760                              struct plat_stmmacenet_data *plat)
 761 {
 762         int ret = 0;
 763
 764         if (plat->init)
 765                 ret = plat->init(pdev, plat->bsp_priv);
 766
 767         return ret;
 768 }
 769
 770 /**
 771  * stmmac_pltfr_exit
 772  * @pdev: pointer to the platform device
 773  * @plat: driver data platform structure
 774  * Description: Call the platform's exit callback (if any).
 775  */
 776 static void stmmac_pltfr_exit(struct platform_device *pdev,
 777                               struct plat_stmmacenet_data *plat)
 778 {
 779         if (plat->exit)
 780                 plat->exit(pdev, plat->bsp_priv);
 781 }
 782
 783 /**
 784  * stmmac_pltfr_probe
 785  * @pdev: platform device pointer
 786  * @plat: driver data platform structure
 787  * @res: stmmac resources structure
 788  * Description: This calls the platform's init() callback and probes the
 789  * stmmac driver.
 790  */
 791 int stmmac_pltfr_probe(struct platform_device *pdev,
 792                        struct plat_stmmacenet_data *plat,
 793                        struct stmmac_resources *res)
 794 {
 795         int ret;
 796
 797         ret = stmmac_pltfr_init(pdev, plat);
 798         if (ret)
 799                 return ret;
 800
 801         ret = stmmac_dvr_probe(&pdev->dev, plat, res);
 802         if (ret) {
 803                 stmmac_pltfr_exit(pdev, plat);
 804                 return ret;
 805         }
 806
 807         return ret;
 808 }
 809 EXPORT_SYMBOL_GPL(stmmac_pltfr_probe);
 810
 811 static void devm_stmmac_pltfr_remove(void *data)
 812 {
 813         struct platform_device *pdev = data;
 814
 815         stmmac_pltfr_remove(pdev);
 816 }
 817
 818 /**
 819  * devm_stmmac_pltfr_probe
 820  * @pdev: pointer to the platform device
 821  * @plat: driver data platform structure
 822  * @res: stmmac resources
 823  * Description: Devres variant of stmmac_pltfr_probe(). Allows users to skip
 824  * calling stmmac_pltfr_remove() on driver detach.
 825  */
 826 int devm_stmmac_pltfr_probe(struct platform_device *pdev,
 827                             struct plat_stmmacenet_data *plat,
 828                             struct stmmac_resources *res)
 829 {
 830         int ret;
 831
 832         ret = stmmac_pltfr_probe(pdev, plat, res);
 833         if (ret)
 834                 return ret;
 835
 836         return devm_add_action_or_reset(&pdev->dev, devm_stmmac_pltfr_remove,
 837                                         pdev);
 838 }
 839 EXPORT_SYMBOL_GPL(devm_stmmac_pltfr_probe);
 840
 841 /**
 842  * stmmac_pltfr_remove
 843  * @pdev: pointer to the platform device
 844  * Description: This undoes the effects of stmmac_pltfr_probe() by removing the
 845  * driver and calling the platform's exit() callback.
 846  */
 847 void stmmac_pltfr_remove(struct platform_device *pdev)
 848 {
 849         struct net_device *ndev = platform_get_drvdata(pdev);
 850         struct stmmac_priv *priv = netdev_priv(ndev);
 851         struct plat_stmmacenet_data *plat = priv->plat;
 852
 853         stmmac_dvr_remove(&pdev->dev);
 854         stmmac_pltfr_exit(pdev, plat);
 855 }
 856 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
 857
 858 /**
 859  * stmmac_pltfr_suspend
 860  * @dev: device pointer
 861  * Description: this function is invoked when suspend the driver and it direcly
 862  * call the main suspend function and then, if required, on some platform, it
 863  * can call an exit helper.
 864  */
 865 static int __maybe_unused stmmac_pltfr_suspend(struct device *dev)
 866 {
 867         int ret;
 868         struct net_device *ndev = dev_get_drvdata(dev);
 869         struct stmmac_priv *priv = netdev_priv(ndev);
 870         struct platform_device *pdev = to_platform_device(dev);
 871
 872         ret = stmmac_suspend(dev);
 873         stmmac_pltfr_exit(pdev, priv->plat);
 874
 875         return ret;
 876 }
 877
 878 /**
 879  * stmmac_pltfr_resume
 880  * @dev: device pointer
 881  * Description: this function is invoked when resume the driver before calling
 882  * the main resume function, on some platforms, it can call own init helper
 883  * if required.
 884  */
 885 static int __maybe_unused stmmac_pltfr_resume(struct device *dev)
 886 {
 887         struct net_device *ndev = dev_get_drvdata(dev);
 888         struct stmmac_priv *priv = netdev_priv(ndev);
 889         struct platform_device *pdev = to_platform_device(dev);
 890         int ret;
 891
 892         ret = stmmac_pltfr_init(pdev, priv->plat);
 893         if (ret)
 894                 return ret;
 895
 896         return stmmac_resume(dev);
 897 }
 898
 899 static int __maybe_unused stmmac_runtime_suspend(struct device *dev)
 900 {
 901         struct net_device *ndev = dev_get_drvdata(dev);
 902         struct stmmac_priv *priv = netdev_priv(ndev);
 903
 904         stmmac_bus_clks_config(priv, false);
 905
 906         return 0;
 907 }
 908
 909 static int __maybe_unused stmmac_runtime_resume(struct device *dev)
 910 {
 911         struct net_device *ndev = dev_get_drvdata(dev);
 912         struct stmmac_priv *priv = netdev_priv(ndev);
 913
 914         return stmmac_bus_clks_config(priv, true);
 915 }
 916
 917 static int __maybe_unused stmmac_pltfr_noirq_suspend(struct device *dev)
 918 {
 919         struct net_device *ndev = dev_get_drvdata(dev);
 920         struct stmmac_priv *priv = netdev_priv(ndev);
 921         int ret;
 922
 923         if (!netif_running(ndev))
 924                 return 0;
 925
 926         if (!device_may_wakeup(priv->device) || !priv->plat->pmt) {
 927                 /* Disable clock in case of PWM is off */
 928                 clk_disable_unprepare(priv->plat->clk_ptp_ref);
 929
 930                 ret = pm_runtime_force_suspend(dev);
 931                 if (ret)
 932                         return ret;
 933         }
 934
 935         return 0;
 936 }
 937
 938 static int __maybe_unused stmmac_pltfr_noirq_resume(struct device *dev)
 939 {
 940         struct net_device *ndev = dev_get_drvdata(dev);
 941         struct stmmac_priv *priv = netdev_priv(ndev);
 942         int ret;
 943
 944         if (!netif_running(ndev))
 945                 return 0;
 946
 947         if (!device_may_wakeup(priv->device) || !priv->plat->pmt) {
 948                 /* enable the clk previously disabled */
 949                 ret = pm_runtime_force_resume(dev);
 950                 if (ret)
 951                         return ret;
 952
 953                 ret = clk_prepare_enable(priv->plat->clk_ptp_ref);
 954                 if (ret < 0) {
 955                         netdev_warn(priv->dev,
 956                                     "failed to enable PTP reference clock: %pe\n",
 957                                     ERR_PTR(ret));
 958                         return ret;
 959                 }
 960         }
 961
 962         return 0;
 963 }
 964
 965 const struct dev_pm_ops stmmac_pltfr_pm_ops = {
 966         SET_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_suspend, stmmac_pltfr_resume)
 967         SET_RUNTIME_PM_OPS(stmmac_runtime_suspend, stmmac_runtime_resume, NULL)
 968         SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_noirq_suspend, stmmac_pltfr_noirq_resume)
 969 };
 970 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
 971
 972 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
 973 MODULE_AUTHOR("Giuseppe Cavallaro <[email protected]>");
 974 MODULE_LICENSE("GPL");