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