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