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