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

   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 ... 32:
  85         case 64:
  86         case 128:
  87                 break;
  88         default:
  89                 x = 1;
  90                 pr_info("Unicast table entries set to unexpected value %d\n",
  91                         ucast_entries);
  92                 break;
  93         }
  94         return x;
  95 }
  96
  97 /**
  98  * stmmac_axi_setup - parse DT parameters for programming the AXI register
  99  * @pdev: platform device
 100  * @priv: driver private struct.
 101  * Description:
 102  * if required, from device-tree the AXI internal register can be tuned
 103  * by using platform parameters.
 104  */
 105 static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev)
 106 {
 107         struct device_node *np;
 108         struct stmmac_axi *axi;
 109
 110         np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0);
 111         if (!np)
 112                 return NULL;
 113
 114         axi = kzalloc(sizeof(*axi), GFP_KERNEL);
 115         if (!axi) {
 116                 of_node_put(np);
 117                 return ERR_PTR(-ENOMEM);
 118         }
 119
 120         axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en");
 121         axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm");
 122         axi->axi_kbbe = of_property_read_bool(np, "snps,axi_kbbe");
 123         axi->axi_axi_all = of_property_read_bool(np, "snps,axi_all");
 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         of_property_read_u32(np, "max-speed", &plat->max_speed);
 225
 226         plat->bus_id = of_alias_get_id(np, "ethernet");
 227         if (plat->bus_id < 0)
 228                 plat->bus_id = 0;
 229
 230         /* Default to phy auto-detection */
 231         plat->phy_addr = -1;
 232
 233         /* "snps,phy-addr" is not a standard property. Mark it as deprecated
 234          * and warn of its use. Remove this when phy node support is added.
 235          */
 236         if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
 237                 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
 238
 239         /* To Configure PHY by using all device-tree supported properties */
 240         if (stmmac_dt_phy(plat, np, &pdev->dev))
 241                 return ERR_PTR(-ENODEV);
 242
 243         of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
 244
 245         of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
 246
 247         plat->force_sf_dma_mode =
 248                 of_property_read_bool(np, "snps,force_sf_dma_mode");
 249
 250         /* Set the maxmtu to a default of JUMBO_LEN in case the
 251          * parameter is not present in the device tree.
 252          */
 253         plat->maxmtu = JUMBO_LEN;
 254
 255         /* Set default value for multicast hash bins */
 256         plat->multicast_filter_bins = HASH_TABLE_SIZE;
 257
 258         /* Set default value for unicast filter entries */
 259         plat->unicast_filter_entries = 1;
 260
 261         /*
 262          * Currently only the properties needed on SPEAr600
 263          * are provided. All other properties should be added
 264          * once needed on other platforms.
 265          */
 266         if (of_device_is_compatible(np, "st,spear600-gmac") ||
 267                 of_device_is_compatible(np, "snps,dwmac-3.50a") ||
 268                 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
 269                 of_device_is_compatible(np, "snps,dwmac")) {
 270                 /* Note that the max-frame-size parameter as defined in the
 271                  * ePAPR v1.1 spec is defined as max-frame-size, it's
 272                  * actually used as the IEEE definition of MAC Client
 273                  * data, or MTU. The ePAPR specification is confusing as
 274                  * the definition is max-frame-size, but usage examples
 275                  * are clearly MTUs
 276                  */
 277                 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
 278                 of_property_read_u32(np, "snps,multicast-filter-bins",
 279                                      &plat->multicast_filter_bins);
 280                 of_property_read_u32(np, "snps,perfect-filter-entries",
 281                                      &plat->unicast_filter_entries);
 282                 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
 283                                                plat->unicast_filter_entries);
 284                 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
 285                                               plat->multicast_filter_bins);
 286                 plat->has_gmac = 1;
 287                 plat->pmt = 1;
 288         }
 289
 290         if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
 291             of_device_is_compatible(np, "snps,dwmac-4.10a")) {
 292                 plat->has_gmac4 = 1;
 293                 plat->pmt = 1;
 294                 plat->tso_en = of_property_read_bool(np, "snps,tso");
 295         }
 296
 297         if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
 298                 of_device_is_compatible(np, "snps,dwmac-3.710")) {
 299                 plat->enh_desc = 1;
 300                 plat->bugged_jumbo = 1;
 301                 plat->force_sf_dma_mode = 1;
 302         }
 303
 304         if (of_find_property(np, "snps,pbl", NULL)) {
 305                 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
 306                                        GFP_KERNEL);
 307                 if (!dma_cfg) {
 308                         stmmac_remove_config_dt(pdev, plat);
 309                         return ERR_PTR(-ENOMEM);
 310                 }
 311                 plat->dma_cfg = dma_cfg;
 312                 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
 313                 dma_cfg->aal = of_property_read_bool(np, "snps,aal");
 314                 dma_cfg->fixed_burst =
 315                         of_property_read_bool(np, "snps,fixed-burst");
 316                 dma_cfg->mixed_burst =
 317                         of_property_read_bool(np, "snps,mixed-burst");
 318         }
 319         plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
 320         if (plat->force_thresh_dma_mode) {
 321                 plat->force_sf_dma_mode = 0;
 322                 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
 323         }
 324
 325         of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);
 326
 327         plat->axi = stmmac_axi_setup(pdev);
 328
 329         return plat;
 330 }
 331
 332 /**
 333  * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt()
 334  * @pdev: platform_device structure
 335  * @plat: driver data platform structure
 336  *
 337  * Release resources claimed by stmmac_probe_config_dt().
 338  */
 339 void stmmac_remove_config_dt(struct platform_device *pdev,
 340                              struct plat_stmmacenet_data *plat)
 341 {
 342         struct device_node *np = pdev->dev.of_node;
 343
 344         if (of_phy_is_fixed_link(np))
 345                 of_phy_deregister_fixed_link(np);
 346         of_node_put(plat->phy_node);
 347         of_node_put(plat->mdio_node);
 348 }
 349 #else
 350 struct plat_stmmacenet_data *
 351 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
 352 {
 353         return ERR_PTR(-ENOSYS);
 354 }
 355
 356 void stmmac_remove_config_dt(struct platform_device *pdev,
 357                              struct plat_stmmacenet_data *plat)
 358 {
 359 }
 360 #endif /* CONFIG_OF */
 361 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
 362 EXPORT_SYMBOL_GPL(stmmac_remove_config_dt);
 363
 364 int stmmac_get_platform_resources(struct platform_device *pdev,
 365                                   struct stmmac_resources *stmmac_res)
 366 {
 367         struct resource *res;
 368
 369         memset(stmmac_res, 0, sizeof(*stmmac_res));
 370
 371         /* Get IRQ information early to have an ability to ask for deferred
 372          * probe if needed before we went too far with resource allocation.
 373          */
 374         stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
 375         if (stmmac_res->irq < 0) {
 376                 if (stmmac_res->irq != -EPROBE_DEFER) {
 377                         dev_err(&pdev->dev,
 378                                 "MAC IRQ configuration information not found\n");
 379                 }
 380                 return stmmac_res->irq;
 381         }
 382
 383         /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
 384          * The external wake up irq can be passed through the platform code
 385          * named as "eth_wake_irq"
 386          *
 387          * In case the wake up interrupt is not passed from the platform
 388          * so the driver will continue to use the mac irq (ndev->irq)
 389          */
 390         stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
 391         if (stmmac_res->wol_irq < 0) {
 392                 if (stmmac_res->wol_irq == -EPROBE_DEFER)
 393                         return -EPROBE_DEFER;
 394                 stmmac_res->wol_irq = stmmac_res->irq;
 395         }
 396
 397         stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
 398         if (stmmac_res->lpi_irq == -EPROBE_DEFER)
 399                 return -EPROBE_DEFER;
 400
 401         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 402         stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
 403
 404         return PTR_ERR_OR_ZERO(stmmac_res->addr);
 405 }
 406 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
 407
 408 /**
 409  * stmmac_pltfr_remove
 410  * @pdev: platform device pointer
 411  * Description: this function calls the main to free the net resources
 412  * and calls the platforms hook and release the resources (e.g. mem).
 413  */
 414 int stmmac_pltfr_remove(struct platform_device *pdev)
 415 {
 416         struct net_device *ndev = platform_get_drvdata(pdev);
 417         struct stmmac_priv *priv = netdev_priv(ndev);
 418         struct plat_stmmacenet_data *plat = priv->plat;
 419         int ret = stmmac_dvr_remove(&pdev->dev);
 420
 421         if (plat->exit)
 422                 plat->exit(pdev, plat->bsp_priv);
 423
 424         stmmac_remove_config_dt(pdev, plat);
 425
 426         return ret;
 427 }
 428 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
 429
 430 #ifdef CONFIG_PM_SLEEP
 431 /**
 432  * stmmac_pltfr_suspend
 433  * @dev: device pointer
 434  * Description: this function is invoked when suspend the driver and it direcly
 435  * call the main suspend function and then, if required, on some platform, it
 436  * can call an exit helper.
 437  */
 438 static int stmmac_pltfr_suspend(struct device *dev)
 439 {
 440         int ret;
 441         struct net_device *ndev = dev_get_drvdata(dev);
 442         struct stmmac_priv *priv = netdev_priv(ndev);
 443         struct platform_device *pdev = to_platform_device(dev);
 444
 445         ret = stmmac_suspend(dev);
 446         if (priv->plat->suspend)
 447                 priv->plat->suspend(pdev, priv->plat->bsp_priv);
 448         else if (priv->plat->exit)
 449                 priv->plat->exit(pdev, priv->plat->bsp_priv);
 450
 451         return ret;
 452 }
 453
 454 /**
 455  * stmmac_pltfr_resume
 456  * @dev: device pointer
 457  * Description: this function is invoked when resume the driver before calling
 458  * the main resume function, on some platforms, it can call own init helper
 459  * if required.
 460  */
 461 static int stmmac_pltfr_resume(struct device *dev)
 462 {
 463         struct net_device *ndev = dev_get_drvdata(dev);
 464         struct stmmac_priv *priv = netdev_priv(ndev);
 465         struct platform_device *pdev = to_platform_device(dev);
 466
 467         if (priv->plat->resume)
 468                 priv->plat->resume(pdev, priv->plat->bsp_priv);
 469         else if (priv->plat->init)
 470                 priv->plat->init(pdev, priv->plat->bsp_priv);
 471
 472         return stmmac_resume(dev);
 473 }
 474 #endif /* CONFIG_PM_SLEEP */
 475
 476 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
 477                                        stmmac_pltfr_resume);
 478 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
 479
 480 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
 481 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
 482 MODULE_LICENSE("GPL");