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