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:
  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_probe_config_dt - parse device-tree driver parameters
 100  * @pdev: platform_device structure
 101  * @plat: driver data platform structure
 102  * @mac: MAC address to use
 103  * Description:
 104  * this function is to read the driver parameters from device-tree and
 105  * set some private fields that will be used by the main at runtime.
 106  */
 107 static int stmmac_probe_config_dt(struct platform_device *pdev,
 108                                   struct plat_stmmacenet_data **plat_dat,
 109                                   const char **mac)
 110 {
 111         struct device_node *np = pdev->dev.of_node;
 112         struct plat_stmmacenet_data *plat;
 113         const struct stmmac_of_data *data;
 114         struct stmmac_dma_cfg *dma_cfg;
 115
 116         plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
 117         if (!plat)
 118                 return -ENOMEM;
 119
 120         *plat_dat = plat;
 121
 122         data = of_device_get_match_data(&pdev->dev);
 123         if (data) {
 124                 plat->has_gmac = data->has_gmac;
 125                 plat->enh_desc = data->enh_desc;
 126                 plat->tx_coe = data->tx_coe;
 127                 plat->rx_coe = data->rx_coe;
 128                 plat->bugged_jumbo = data->bugged_jumbo;
 129                 plat->pmt = data->pmt;
 130                 plat->riwt_off = data->riwt_off;
 131                 plat->fix_mac_speed = data->fix_mac_speed;
 132                 plat->bus_setup = data->bus_setup;
 133                 plat->setup = data->setup;
 134                 plat->free = data->free;
 135                 plat->init = data->init;
 136                 plat->exit = data->exit;
 137         }
 138
 139         *mac = of_get_mac_address(np);
 140         plat->interface = of_get_phy_mode(np);
 141
 142         /* Get max speed of operation from device tree */
 143         if (of_property_read_u32(np, "max-speed", &plat->max_speed))
 144                 plat->max_speed = -1;
 145
 146         plat->bus_id = of_alias_get_id(np, "ethernet");
 147         if (plat->bus_id < 0)
 148                 plat->bus_id = 0;
 149
 150         /* Default to phy auto-detection */
 151         plat->phy_addr = -1;
 152
 153         /* If we find a phy-handle property, use it as the PHY */
 154         plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
 155
 156         /* If phy-handle is not specified, check if we have a fixed-phy */
 157         if (!plat->phy_node && of_phy_is_fixed_link(np)) {
 158                 if ((of_phy_register_fixed_link(np) < 0))
 159                         return -ENODEV;
 160
 161                 plat->phy_node = of_node_get(np);
 162         }
 163
 164         /* "snps,phy-addr" is not a standard property. Mark it as deprecated
 165          * and warn of its use. Remove this when phy node support is added.
 166          */
 167         if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
 168                 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
 169
 170         if (plat->phy_node || plat->phy_bus_name)
 171                 plat->mdio_bus_data = NULL;
 172         else
 173                 plat->mdio_bus_data =
 174                         devm_kzalloc(&pdev->dev,
 175                                      sizeof(struct stmmac_mdio_bus_data),
 176                                      GFP_KERNEL);
 177
 178         of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
 179
 180         of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
 181
 182         plat->force_sf_dma_mode =
 183                 of_property_read_bool(np, "snps,force_sf_dma_mode");
 184
 185         /* Set the maxmtu to a default of JUMBO_LEN in case the
 186          * parameter is not present in the device tree.
 187          */
 188         plat->maxmtu = JUMBO_LEN;
 189
 190         /* Set default value for multicast hash bins */
 191         plat->multicast_filter_bins = HASH_TABLE_SIZE;
 192
 193         /* Set default value for unicast filter entries */
 194         plat->unicast_filter_entries = 1;
 195
 196         /*
 197          * Currently only the properties needed on SPEAr600
 198          * are provided. All other properties should be added
 199          * once needed on other platforms.
 200          */
 201         if (of_device_is_compatible(np, "st,spear600-gmac") ||
 202                 of_device_is_compatible(np, "snps,dwmac-3.70a") ||
 203                 of_device_is_compatible(np, "snps,dwmac")) {
 204                 /* Note that the max-frame-size parameter as defined in the
 205                  * ePAPR v1.1 spec is defined as max-frame-size, it's
 206                  * actually used as the IEEE definition of MAC Client
 207                  * data, or MTU. The ePAPR specification is confusing as
 208                  * the definition is max-frame-size, but usage examples
 209                  * are clearly MTUs
 210                  */
 211                 of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
 212                 of_property_read_u32(np, "snps,multicast-filter-bins",
 213                                      &plat->multicast_filter_bins);
 214                 of_property_read_u32(np, "snps,perfect-filter-entries",
 215                                      &plat->unicast_filter_entries);
 216                 plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
 217                                                plat->unicast_filter_entries);
 218                 plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
 219                                               plat->multicast_filter_bins);
 220                 plat->has_gmac = 1;
 221                 plat->pmt = 1;
 222         }
 223
 224         if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
 225                 of_device_is_compatible(np, "snps,dwmac-3.710")) {
 226                 plat->enh_desc = 1;
 227                 plat->bugged_jumbo = 1;
 228                 plat->force_sf_dma_mode = 1;
 229         }
 230
 231         if (of_find_property(np, "snps,pbl", NULL)) {
 232                 dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
 233                                        GFP_KERNEL);
 234                 if (!dma_cfg) {
 235                         of_node_put(np);
 236                         return -ENOMEM;
 237                 }
 238                 plat->dma_cfg = dma_cfg;
 239                 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
 240                 dma_cfg->fixed_burst =
 241                         of_property_read_bool(np, "snps,fixed-burst");
 242                 dma_cfg->mixed_burst =
 243                         of_property_read_bool(np, "snps,mixed-burst");
 244                 of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len);
 245                 if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256)
 246                         dma_cfg->burst_len = 0;
 247         }
 248         plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
 249         if (plat->force_thresh_dma_mode) {
 250                 plat->force_sf_dma_mode = 0;
 251                 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
 252         }
 253
 254         return 0;
 255 }
 256 #else
 257 static int stmmac_probe_config_dt(struct platform_device *pdev,
 258                                   struct plat_stmmacenet_data **plat,
 259                                   const char **mac)
 260 {
 261         return -ENOSYS;
 262 }
 263 #endif /* CONFIG_OF */
 264
 265 static int stmmac_get_platform_resources(struct platform_device *pdev,
 266                                          struct stmmac_resources *stmmac_res)
 267 {
 268         struct resource *res;
 269
 270         memset(stmmac_res, 0, sizeof(*stmmac_res));
 271
 272         /* Get IRQ information early to have an ability to ask for deferred
 273          * probe if needed before we went too far with resource allocation.
 274          */
 275         stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
 276         if (stmmac_res->irq < 0) {
 277                 if (stmmac_res->irq != -EPROBE_DEFER) {
 278                         dev_err(&pdev->dev,
 279                                 "MAC IRQ configuration information not found\n");
 280                 }
 281                 return stmmac_res->irq;
 282         }
 283
 284         /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
 285          * The external wake up irq can be passed through the platform code
 286          * named as "eth_wake_irq"
 287          *
 288          * In case the wake up interrupt is not passed from the platform
 289          * so the driver will continue to use the mac irq (ndev->irq)
 290          */
 291         stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
 292         if (stmmac_res->wol_irq < 0) {
 293                 if (stmmac_res->wol_irq == -EPROBE_DEFER)
 294                         return -EPROBE_DEFER;
 295                 stmmac_res->wol_irq = stmmac_res->irq;
 296         }
 297
 298         stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
 299         if (stmmac_res->lpi_irq == -EPROBE_DEFER)
 300                 return -EPROBE_DEFER;
 301
 302         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 303         stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
 304         if (IS_ERR(stmmac_res->addr))
 305                 return PTR_ERR(stmmac_res->addr);
 306
 307         return 0;
 308 }
 309
 310 /**
 311  * stmmac_pltfr_probe - platform driver probe.
 312  * @pdev: platform device pointer
 313  * Description: platform_device probe function. It is to allocate
 314  * the necessary platform resources, invoke custom helper (if required) and
 315  * invoke the main probe function.
 316  */
 317 int stmmac_pltfr_probe(struct platform_device *pdev)
 318 {
 319         struct plat_stmmacenet_data *plat_dat;
 320         struct stmmac_resources stmmac_res;
 321         int ret;
 322
 323         ret = stmmac_get_platform_resources(pdev, &stmmac_res);
 324         if (ret)
 325                 return ret;
 326
 327         if (pdev->dev.of_node) {
 328                 ret = stmmac_probe_config_dt(pdev, &plat_dat, &stmmac_res.mac);
 329                 if (ret) {
 330                         dev_err(&pdev->dev, "dt configuration failed\n");
 331                         return ret;
 332                 }
 333         } else {
 334                 plat_dat = dev_get_platdata(&pdev->dev);
 335                 if (!plat_dat) {
 336                         dev_err(&pdev->dev, "no platform data provided\n");
 337                         return  -EINVAL;
 338                 }
 339
 340                 /* Set default value for multicast hash bins */
 341                 plat_dat->multicast_filter_bins = HASH_TABLE_SIZE;
 342
 343                 /* Set default value for unicast filter entries */
 344                 plat_dat->unicast_filter_entries = 1;
 345         }
 346
 347         /* Custom setup (if needed) */
 348         if (plat_dat->setup) {
 349                 plat_dat->bsp_priv = plat_dat->setup(pdev);
 350                 if (IS_ERR(plat_dat->bsp_priv))
 351                         return PTR_ERR(plat_dat->bsp_priv);
 352         }
 353
 354         /* Custom initialisation (if needed)*/
 355         if (plat_dat->init) {
 356                 ret = plat_dat->init(pdev, plat_dat->bsp_priv);
 357                 if (unlikely(ret))
 358                         return ret;
 359         }
 360
 361         return stmmac_dvr_probe(&pdev->dev, plat_dat, &stmmac_res);
 362 }
 363 EXPORT_SYMBOL_GPL(stmmac_pltfr_probe);
 364
 365 /**
 366  * stmmac_pltfr_remove
 367  * @pdev: platform device pointer
 368  * Description: this function calls the main to free the net resources
 369  * and calls the platforms hook and release the resources (e.g. mem).
 370  */
 371 int stmmac_pltfr_remove(struct platform_device *pdev)
 372 {
 373         struct net_device *ndev = platform_get_drvdata(pdev);
 374         struct stmmac_priv *priv = netdev_priv(ndev);
 375         int ret = stmmac_dvr_remove(ndev);
 376
 377         if (priv->plat->exit)
 378                 priv->plat->exit(pdev, priv->plat->bsp_priv);
 379
 380         if (priv->plat->free)
 381                 priv->plat->free(pdev, priv->plat->bsp_priv);
 382
 383         return ret;
 384 }
 385 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
 386
 387 #ifdef CONFIG_PM_SLEEP
 388 /**
 389  * stmmac_pltfr_suspend
 390  * @dev: device pointer
 391  * Description: this function is invoked when suspend the driver and it direcly
 392  * call the main suspend function and then, if required, on some platform, it
 393  * can call an exit helper.
 394  */
 395 static int stmmac_pltfr_suspend(struct device *dev)
 396 {
 397         int ret;
 398         struct net_device *ndev = dev_get_drvdata(dev);
 399         struct stmmac_priv *priv = netdev_priv(ndev);
 400         struct platform_device *pdev = to_platform_device(dev);
 401
 402         ret = stmmac_suspend(ndev);
 403         if (priv->plat->exit)
 404                 priv->plat->exit(pdev, priv->plat->bsp_priv);
 405
 406         return ret;
 407 }
 408
 409 /**
 410  * stmmac_pltfr_resume
 411  * @dev: device pointer
 412  * Description: this function is invoked when resume the driver before calling
 413  * the main resume function, on some platforms, it can call own init helper
 414  * if required.
 415  */
 416 static int stmmac_pltfr_resume(struct device *dev)
 417 {
 418         struct net_device *ndev = dev_get_drvdata(dev);
 419         struct stmmac_priv *priv = netdev_priv(ndev);
 420         struct platform_device *pdev = to_platform_device(dev);
 421
 422         if (priv->plat->init)
 423                 priv->plat->init(pdev, priv->plat->bsp_priv);
 424
 425         return stmmac_resume(ndev);
 426 }
 427 #endif /* CONFIG_PM_SLEEP */
 428
 429 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
 430                                        stmmac_pltfr_resume);
 431 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);