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