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