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/io.h>
  27 #include <linux/of.h>
  28 #include <linux/of_net.h>
  29 #include <linux/of_device.h>
  30
  31 #include "stmmac.h"
  32 #include "stmmac_platform.h"
  33
  34 static const struct of_device_id stmmac_dt_ids[] = {
  35         /* SoC specific glue layers should come before generic bindings */
  36         { .compatible = "rockchip,rk3288-gmac", .data = &rk3288_gmac_data},
  37         { .compatible = "amlogic,meson6-dwmac", .data = &meson6_dwmac_data},
  38         { .compatible = "allwinner,sun7i-a20-gmac", .data = &sun7i_gmac_data},
  39         { .compatible = "st,stih415-dwmac", .data = &stih4xx_dwmac_data},
  40         { .compatible = "st,stih416-dwmac", .data = &stih4xx_dwmac_data},
  41         { .compatible = "st,stid127-dwmac", .data = &stid127_dwmac_data},
  42         { .compatible = "st,stih407-dwmac", .data = &stih4xx_dwmac_data},
  43         { .compatible = "altr,socfpga-stmmac", .data = &socfpga_gmac_data },
  44         { .compatible = "st,spear600-gmac"},
  45         { .compatible = "snps,dwmac-3.610"},
  46         { .compatible = "snps,dwmac-3.70a"},
  47         { .compatible = "snps,dwmac-3.710"},
  48         { .compatible = "snps,dwmac"},
  49         { /* sentinel */ }
  50 };
  51 MODULE_DEVICE_TABLE(of, stmmac_dt_ids);
  52
  53 #ifdef CONFIG_OF
  54
  55 /**
  56  * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
  57  * @mcast_bins: Multicast filtering bins
  58  * Description:
  59  * this function validates the number of Multicast filtering bins specified
  60  * by the configuration through the device tree. The Synopsys GMAC supports
  61  * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC
  62  * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds
  63  * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is
  64  * invalid and will cause the filtering algorithm to use Multicast
  65  * promiscuous mode.
  66  */
  67 static int dwmac1000_validate_mcast_bins(int mcast_bins)
  68 {
  69         int x = mcast_bins;
  70
  71         switch (x) {
  72         case HASH_TABLE_SIZE:
  73         case 128:
  74         case 256:
  75                 break;
  76         default:
  77                 x = 0;
  78                 pr_info("Hash table entries set to unexpected value %d",
  79                         mcast_bins);
  80                 break;
  81         }
  82         return x;
  83 }
  84
  85 /**
  86  * dwmac1000_validate_ucast_entries - validate the Unicast address entries
  87  * @ucast_entries: number of Unicast address entries
  88  * Description:
  89  * This function validates the number of Unicast address entries supported
  90  * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
  91  * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter
  92  * logic. This function validates a valid, supported configuration is
  93  * selected, and defaults to 1 Unicast address if an unsupported
  94  * configuration is selected.
  95  */
  96 static int dwmac1000_validate_ucast_entries(int ucast_entries)
  97 {
  98         int x = ucast_entries;
  99
 100         switch (x) {
 101         case 1:
 102         case 32:
 103         case 64:
 104         case 128:
 105                 break;
 106         default:
 107                 x = 1;
 108                 pr_info("Unicast table entries set to unexpected value %d\n",
 109                         ucast_entries);
 110                 break;
 111         }
 112         return x;
 113 }
 114
 115 /**
 116  * stmmac_probe_config_dt - parse device-tree driver parameters
 117  * @pdev: platform_device structure
 118  * @plat: driver data platform structure
 119  * @mac: MAC address to use
 120  * Description:
 121  * this function is to read the driver parameters from device-tree and
 122  * set some private fields that will be used by the main at runtime.
 123  */
 124 static int stmmac_probe_config_dt(struct platform_device *pdev,
 125                                   struct plat_stmmacenet_data *plat,
 126                                   const char **mac)
 127 {
 128         struct device_node *np = pdev->dev.of_node;
 129         struct stmmac_dma_cfg *dma_cfg;
 130         const struct of_device_id *device;
 131
 132         if (!np)
 133                 return -ENODEV;
 134
 135         device = of_match_device(stmmac_dt_ids, &pdev->dev);
 136         if (!device)
 137                 return -ENODEV;
 138
 139         if (device->data) {
 140                 const struct stmmac_of_data *data = device->data;
 141                 plat->has_gmac = data->has_gmac;
 142                 plat->enh_desc = data->enh_desc;
 143                 plat->tx_coe = data->tx_coe;
 144                 plat->rx_coe = data->rx_coe;
 145                 plat->bugged_jumbo = data->bugged_jumbo;
 146                 plat->pmt = data->pmt;
 147                 plat->riwt_off = data->riwt_off;
 148                 plat->fix_mac_speed = data->fix_mac_speed;
 149                 plat->bus_setup = data->bus_setup;
 150                 plat->setup = data->setup;
 151                 plat->free = data->free;
 152                 plat->init = data->init;
 153                 plat->exit = data->exit;
 154         }
 155
 156         *mac = of_get_mac_address(np);
 157         plat->interface = of_get_phy_mode(np);
 158
 159         /* Get max speed of operation from device tree */
 160         if (of_property_read_u32(np, "max-speed", &plat->max_speed))
 161                 plat->max_speed = -1;
 162
 163         plat->bus_id = of_alias_get_id(np, "ethernet");
 164         if (plat->bus_id < 0)
 165                 plat->bus_id = 0;
 166
 167         /* Default to phy auto-detection */
 168         plat->phy_addr = -1;
 169
 170         /* "snps,phy-addr" is not a standard property. Mark it as deprecated
 171          * and warn of its use. Remove this when phy node support is added.
 172          */
 173         if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
 174                 dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
 175
 176         if (plat->phy_bus_name)
 177                 plat->mdio_bus_data = NULL;
 178         else
 179                 plat->mdio_bus_data =
 180                         devm_kzalloc(&pdev->dev,
 181                                      sizeof(struct stmmac_mdio_bus_data),
 182                                      GFP_KERNEL);
 183
 184         of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
 185
 186         of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
 187
 188         plat->force_sf_dma_mode =
 189                 of_property_read_bool(np, "snps,force_sf_dma_mode");
 190
 191         /* Set the maxmtu to a default of JUMBO_LEN in case the
 192          * parameter is not present in the device tree.
 193          */
 194         plat->maxmtu = JUMBO_LEN;
 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                         return -ENOMEM;
 236                 plat->dma_cfg = dma_cfg;
 237                 of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
 238                 dma_cfg->fixed_burst =
 239                         of_property_read_bool(np, "snps,fixed-burst");
 240                 dma_cfg->mixed_burst =
 241                         of_property_read_bool(np, "snps,mixed-burst");
 242                 of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len);
 243                 if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256)
 244                         dma_cfg->burst_len = 0;
 245         }
 246         plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
 247         if (plat->force_thresh_dma_mode) {
 248                 plat->force_sf_dma_mode = 0;
 249                 pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
 250         }
 251
 252         return 0;
 253 }
 254 #else
 255 static int stmmac_probe_config_dt(struct platform_device *pdev,
 256                                   struct plat_stmmacenet_data *plat,
 257                                   const char **mac)
 258 {
 259         return -ENOSYS;
 260 }
 261 #endif /* CONFIG_OF */
 262
 263 /**
 264  * stmmac_pltfr_probe - platform driver probe.
 265  * @pdev: platform device pointer
 266  * Description: platform_device probe function. It is to allocate
 267  * the necessary platform resources, invoke custom helper (if required) and
 268  * invoke the main probe function.
 269  */
 270 static int stmmac_pltfr_probe(struct platform_device *pdev)
 271 {
 272         int ret = 0;
 273         struct resource *res;
 274         struct device *dev = &pdev->dev;
 275         void __iomem *addr = NULL;
 276         struct stmmac_priv *priv = NULL;
 277         struct plat_stmmacenet_data *plat_dat = NULL;
 278         const char *mac = NULL;
 279         int irq, wol_irq, lpi_irq;
 280
 281         /* Get IRQ information early to have an ability to ask for deferred
 282          * probe if needed before we went too far with resource allocation.
 283          */
 284         irq = platform_get_irq_byname(pdev, "macirq");
 285         if (irq < 0) {
 286                 if (irq != -EPROBE_DEFER) {
 287                         dev_err(dev,
 288                                 "MAC IRQ configuration information not found\n");
 289                 }
 290                 return irq;
 291         }
 292
 293         /* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
 294          * The external wake up irq can be passed through the platform code
 295          * named as "eth_wake_irq"
 296          *
 297          * In case the wake up interrupt is not passed from the platform
 298          * so the driver will continue to use the mac irq (ndev->irq)
 299          */
 300         wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
 301         if (wol_irq < 0) {
 302                 if (wol_irq == -EPROBE_DEFER)
 303                         return -EPROBE_DEFER;
 304                 wol_irq = irq;
 305         }
 306
 307         lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
 308         if (lpi_irq == -EPROBE_DEFER)
 309                 return -EPROBE_DEFER;
 310
 311         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 312         addr = devm_ioremap_resource(dev, res);
 313         if (IS_ERR(addr))
 314                 return PTR_ERR(addr);
 315
 316         plat_dat = dev_get_platdata(&pdev->dev);
 317
 318         if (!plat_dat)
 319                 plat_dat = devm_kzalloc(&pdev->dev,
 320                                         sizeof(struct plat_stmmacenet_data),
 321                                         GFP_KERNEL);
 322         if (!plat_dat) {
 323                 pr_err("%s: ERROR: no memory", __func__);
 324                 return  -ENOMEM;
 325         }
 326
 327         /* Set default value for multicast hash bins */
 328         plat_dat->multicast_filter_bins = HASH_TABLE_SIZE;
 329
 330         /* Set default value for unicast filter entries */
 331         plat_dat->unicast_filter_entries = 1;
 332
 333         if (pdev->dev.of_node) {
 334                 ret = stmmac_probe_config_dt(pdev, plat_dat, &mac);
 335                 if (ret) {
 336                         pr_err("%s: main dt probe failed", __func__);
 337                         return ret;
 338                 }
 339         }
 340
 341         /* Custom setup (if needed) */
 342         if (plat_dat->setup) {
 343                 plat_dat->bsp_priv = plat_dat->setup(pdev);
 344                 if (IS_ERR(plat_dat->bsp_priv))
 345                         return PTR_ERR(plat_dat->bsp_priv);
 346         }
 347
 348         /* Custom initialisation (if needed)*/
 349         if (plat_dat->init) {
 350                 ret = plat_dat->init(pdev, plat_dat->bsp_priv);
 351                 if (unlikely(ret))
 352                         return ret;
 353         }
 354
 355         priv = stmmac_dvr_probe(&(pdev->dev), plat_dat, addr);
 356         if (IS_ERR(priv)) {
 357                 pr_err("%s: main driver probe failed", __func__);
 358                 return PTR_ERR(priv);
 359         }
 360
 361         /* Copy IRQ values to priv structure which is now avaialble */
 362         priv->dev->irq = irq;
 363         priv->wol_irq = wol_irq;
 364         priv->lpi_irq = lpi_irq;
 365
 366         /* Get MAC address if available (DT) */
 367         if (mac)
 368                 memcpy(priv->dev->dev_addr, mac, ETH_ALEN);
 369
 370         platform_set_drvdata(pdev, priv->dev);
 371
 372         pr_debug("STMMAC platform driver registration completed");
 373
 374         return 0;
 375 }
 376
 377 /**
 378  * stmmac_pltfr_remove
 379  * @pdev: platform device pointer
 380  * Description: this function calls the main to free the net resources
 381  * and calls the platforms hook and release the resources (e.g. mem).
 382  */
 383 static int stmmac_pltfr_remove(struct platform_device *pdev)
 384 {
 385         struct net_device *ndev = platform_get_drvdata(pdev);
 386         struct stmmac_priv *priv = netdev_priv(ndev);
 387         int ret = stmmac_dvr_remove(ndev);
 388
 389         if (priv->plat->exit)
 390                 priv->plat->exit(pdev, priv->plat->bsp_priv);
 391
 392         if (priv->plat->free)
 393                 priv->plat->free(pdev, priv->plat->bsp_priv);
 394
 395         return ret;
 396 }
 397
 398 #ifdef CONFIG_PM_SLEEP
 399 /**
 400  * stmmac_pltfr_suspend
 401  * @dev: device pointer
 402  * Description: this function is invoked when suspend the driver and it direcly
 403  * call the main suspend function and then, if required, on some platform, it
 404  * can call an exit helper.
 405  */
 406 static int stmmac_pltfr_suspend(struct device *dev)
 407 {
 408         int ret;
 409         struct net_device *ndev = dev_get_drvdata(dev);
 410         struct stmmac_priv *priv = netdev_priv(ndev);
 411         struct platform_device *pdev = to_platform_device(dev);
 412
 413         ret = stmmac_suspend(ndev);
 414         if (priv->plat->exit)
 415                 priv->plat->exit(pdev, priv->plat->bsp_priv);
 416
 417         return ret;
 418 }
 419
 420 /**
 421  * stmmac_pltfr_resume
 422  * @dev: device pointer
 423  * Description: this function is invoked when resume the driver before calling
 424  * the main resume function, on some platforms, it can call own init helper
 425  * if required.
 426  */
 427 static int stmmac_pltfr_resume(struct device *dev)
 428 {
 429         struct net_device *ndev = dev_get_drvdata(dev);
 430         struct stmmac_priv *priv = netdev_priv(ndev);
 431         struct platform_device *pdev = to_platform_device(dev);
 432
 433         if (priv->plat->init)
 434                 priv->plat->init(pdev, priv->plat->bsp_priv);
 435
 436         return stmmac_resume(ndev);
 437 }
 438 #endif /* CONFIG_PM_SLEEP */
 439
 440 static SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops,
 441                          stmmac_pltfr_suspend, stmmac_pltfr_resume);
 442
 443 static struct platform_driver stmmac_pltfr_driver = {
 444         .probe = stmmac_pltfr_probe,
 445         .remove = stmmac_pltfr_remove,
 446         .driver = {
 447                    .name = STMMAC_RESOURCE_NAME,
 448                    .pm = &stmmac_pltfr_pm_ops,
 449                    .of_match_table = of_match_ptr(stmmac_dt_ids),
 450         },
 451 };
 452
 453 module_platform_driver(stmmac_pltfr_driver);
 454
 455 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet PLATFORM driver");
 456 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
 457 MODULE_LICENSE("GPL");