stmmac_platform.c 14.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*******************************************************************************
  This contains the functions to handle the platform driver.

  Copyright (C) 2007-2011  STMicroelectronics Ltd

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  more details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
*******************************************************************************/

#include <linux/platform_device.h>
26
#include <linux/module.h>
27
#include <linux/io.h>
S
Stefan Roese 已提交
28 29
#include <linux/of.h>
#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

S
Stefan Roese 已提交
36
#ifdef CONFIG_OF
37

38 39 40 41 42
/**
 * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
 * @mcast_bins: Multicast filtering bins
 * Description:
 * this function validates the number of Multicast filtering bins specified
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 * by the configuration through the device tree. The Synopsys GMAC supports
 * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC
 * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds
 * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is
 * invalid and will cause the filtering algorithm to use Multicast
 * promiscuous mode.
 */
static int dwmac1000_validate_mcast_bins(int mcast_bins)
{
	int x = mcast_bins;

	switch (x) {
	case HASH_TABLE_SIZE:
	case 128:
	case 256:
		break;
	default:
		x = 0;
		pr_info("Hash table entries set to unexpected value %d",
			mcast_bins);
		break;
	}
	return x;
}

68 69 70 71 72
/**
 * dwmac1000_validate_ucast_entries - validate the Unicast address entries
 * @ucast_entries: number of Unicast address entries
 * Description:
 * This function validates the number of Unicast address entries supported
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
 * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
 * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter
 * logic. This function validates a valid, supported configuration is
 * selected, and defaults to 1 Unicast address if an unsupported
 * configuration is selected.
 */
static int dwmac1000_validate_ucast_entries(int ucast_entries)
{
	int x = ucast_entries;

	switch (x) {
	case 1:
	case 32:
	case 64:
	case 128:
		break;
	default:
		x = 1;
		pr_info("Unicast table entries set to unexpected value %d\n",
			ucast_entries);
		break;
	}
	return x;
}

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
/**
 * stmmac_axi_setup - parse DT parameters for programming the AXI register
 * @pdev: platform device
 * @priv: driver private struct.
 * Description:
 * if required, from device-tree the AXI internal register can be tuned
 * by using platform parameters.
 */
static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev)
{
	struct device_node *np;
	struct stmmac_axi *axi;

	np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0);
	if (!np)
		return NULL;

115
	axi = kzalloc(sizeof(*axi), GFP_KERNEL);
116 117
	if (!axi) {
		of_node_put(np);
118
		return ERR_PTR(-ENOMEM);
119
	}
120 121 122 123 124 125 126 127 128 129 130 131

	axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en");
	axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm");
	axi->axi_kbbe = of_property_read_bool(np, "snps,axi_kbbe");
	axi->axi_axi_all = of_property_read_bool(np, "snps,axi_all");
	axi->axi_fb = of_property_read_bool(np, "snps,axi_fb");
	axi->axi_mb = of_property_read_bool(np, "snps,axi_mb");
	axi->axi_rb =  of_property_read_bool(np, "snps,axi_rb");

	of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt);
	of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt);
	of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN);
132
	of_node_put(np);
133 134 135 136

	return axi;
}

G
Giuseppe CAVALLARO 已提交
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
/**
 * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources
 * @plat: driver data platform structure
 * @np: device tree node
 * @dev: device pointer
 * Description:
 * The mdio bus will be allocated in case of a phy transceiver is on board;
 * it will be NULL if the fixed-link is configured.
 * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated
 * in any case (for DSA, mdio must be registered even if fixed-link).
 * The table below sums the supported configurations:
 *	-------------------------------
 *	snps,phy-addr	|     Y
 *	-------------------------------
 *	phy-handle	|     Y
 *	-------------------------------
 *	fixed-link	|     N
 *	-------------------------------
 *	snps,dwmac-mdio	|
 *	  even if	|     Y
 *	fixed-link	|
 *	-------------------------------
 *
 * It returns 0 in case of success otherwise -ENODEV.
 */
static int stmmac_dt_phy(struct plat_stmmacenet_data *plat,
			 struct device_node *np, struct device *dev)
{
	bool mdio = true;

	/* If phy-handle property is passed from DT, use it as the PHY */
	plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
	if (plat->phy_node)
		dev_dbg(dev, "Found phy-handle subnode\n");

	/* If phy-handle is not specified, check if we have a fixed-phy */
	if (!plat->phy_node && of_phy_is_fixed_link(np)) {
		if ((of_phy_register_fixed_link(np) < 0))
			return -ENODEV;

		dev_dbg(dev, "Found fixed-link subnode\n");
		plat->phy_node = of_node_get(np);
		mdio = false;
	}

	/* If snps,dwmac-mdio is passed from DT, always register the MDIO */
	for_each_child_of_node(np, plat->mdio_node) {
		if (of_device_is_compatible(plat->mdio_node, "snps,dwmac-mdio"))
			break;
	}

	if (plat->mdio_node) {
		dev_dbg(dev, "Found MDIO subnode\n");
		mdio = true;
	}

	if (mdio)
		plat->mdio_bus_data =
			devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data),
				     GFP_KERNEL);
	return 0;
}

200 201 202 203 204 205 206 207
/**
 * stmmac_probe_config_dt - parse device-tree driver parameters
 * @pdev: platform_device structure
 * @mac: MAC address to use
 * Description:
 * this function is to read the driver parameters from device-tree and
 * set some private fields that will be used by the main at runtime.
 */
208
struct plat_stmmacenet_data *
209
stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
S
Stefan Roese 已提交
210 211
{
	struct device_node *np = pdev->dev.of_node;
212
	struct plat_stmmacenet_data *plat;
213
	struct stmmac_dma_cfg *dma_cfg;
S
Stefan Roese 已提交
214

215 216
	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
	if (!plat)
217
		return ERR_PTR(-ENOMEM);
218

S
Stefan Roese 已提交
219 220
	*mac = of_get_mac_address(np);
	plat->interface = of_get_phy_mode(np);
221

222 223 224 225
	/* Get max speed of operation from device tree */
	if (of_property_read_u32(np, "max-speed", &plat->max_speed))
		plat->max_speed = -1;

226 227 228 229
	plat->bus_id = of_alias_get_id(np, "ethernet");
	if (plat->bus_id < 0)
		plat->bus_id = 0;

230 231 232 233 234 235 236 237
	/* Default to phy auto-detection */
	plat->phy_addr = -1;

	/* "snps,phy-addr" is not a standard property. Mark it as deprecated
	 * and warn of its use. Remove this when phy node support is added.
	 */
	if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
		dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
238

G
Giuseppe CAVALLARO 已提交
239 240 241
	/* To Configure PHY by using all device-tree supported properties */
	if (stmmac_dt_phy(plat, np, &pdev->dev))
		return ERR_PTR(-ENODEV);
242

243 244 245 246
	of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);

	of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);

247 248
	plat->force_sf_dma_mode =
		of_property_read_bool(np, "snps,force_sf_dma_mode");
249

250 251 252 253 254
	/* Set the maxmtu to a default of JUMBO_LEN in case the
	 * parameter is not present in the device tree.
	 */
	plat->maxmtu = JUMBO_LEN;

255 256 257 258 259 260
	/* Set default value for multicast hash bins */
	plat->multicast_filter_bins = HASH_TABLE_SIZE;

	/* Set default value for unicast filter entries */
	plat->unicast_filter_entries = 1;

S
Stefan Roese 已提交
261 262 263 264 265
	/*
	 * Currently only the properties needed on SPEAr600
	 * are provided. All other properties should be added
	 * once needed on other platforms.
	 */
266
	if (of_device_is_compatible(np, "st,spear600-gmac") ||
267
		of_device_is_compatible(np, "snps,dwmac-3.50a") ||
268 269
		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
		of_device_is_compatible(np, "snps,dwmac")) {
270 271 272 273 274 275 276 277
		/* Note that the max-frame-size parameter as defined in the
		 * ePAPR v1.1 spec is defined as max-frame-size, it's
		 * actually used as the IEEE definition of MAC Client
		 * data, or MTU. The ePAPR specification is confusing as
		 * the definition is max-frame-size, but usage examples
		 * are clearly MTUs
		 */
		of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
278 279 280 281 282 283 284 285
		of_property_read_u32(np, "snps,multicast-filter-bins",
				     &plat->multicast_filter_bins);
		of_property_read_u32(np, "snps,perfect-filter-entries",
				     &plat->unicast_filter_entries);
		plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
					       plat->unicast_filter_entries);
		plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
					      plat->multicast_filter_bins);
S
Stefan Roese 已提交
286 287 288 289
		plat->has_gmac = 1;
		plat->pmt = 1;
	}

290 291 292 293 294 295 296
	if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
	    of_device_is_compatible(np, "snps,dwmac-4.10a")) {
		plat->has_gmac4 = 1;
		plat->pmt = 1;
		plat->tso_en = of_property_read_bool(np, "snps,tso");
	}

297 298 299 300 301 302 303
	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
		of_device_is_compatible(np, "snps,dwmac-3.710")) {
		plat->enh_desc = 1;
		plat->bugged_jumbo = 1;
		plat->force_sf_dma_mode = 1;
	}

304 305 306
	if (of_find_property(np, "snps,pbl", NULL)) {
		dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
				       GFP_KERNEL);
307
		if (!dma_cfg) {
308
			stmmac_remove_config_dt(pdev, plat);
309
			return ERR_PTR(-ENOMEM);
310
		}
311 312
		plat->dma_cfg = dma_cfg;
		of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
313
		dma_cfg->aal = of_property_read_bool(np, "snps,aal");
314 315 316 317 318
		dma_cfg->fixed_burst =
			of_property_read_bool(np, "snps,fixed-burst");
		dma_cfg->mixed_burst =
			of_property_read_bool(np, "snps,mixed-burst");
	}
319 320 321 322
	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
	if (plat->force_thresh_dma_mode) {
		plat->force_sf_dma_mode = 0;
		pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
323
	}
324

325 326
	of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);

327 328
	plat->axi = stmmac_axi_setup(pdev);

329
	return plat;
S
Stefan Roese 已提交
330
}
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

/**
 * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt()
 * @pdev: platform_device structure
 * @plat: driver data platform structure
 *
 * Release resources claimed by stmmac_probe_config_dt().
 */
void stmmac_remove_config_dt(struct platform_device *pdev,
			     struct plat_stmmacenet_data *plat)
{
	struct device_node *np = pdev->dev.of_node;

	if (of_phy_is_fixed_link(np))
		of_phy_deregister_fixed_link(np);
	of_node_put(plat->phy_node);
}
S
Stefan Roese 已提交
348
#else
349
struct plat_stmmacenet_data *
350
stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
S
Stefan Roese 已提交
351
{
352
	return ERR_PTR(-ENOSYS);
S
Stefan Roese 已提交
353
}
354 355 356 357 358

void stmmac_remove_config_dt(struct platform_device *pdev,
			     struct plat_stmmacenet_data *plat)
{
}
S
Stefan Roese 已提交
359
#endif /* CONFIG_OF */
360
EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
361
EXPORT_SYMBOL_GPL(stmmac_remove_config_dt);
S
Stefan Roese 已提交
362

363 364
int stmmac_get_platform_resources(struct platform_device *pdev,
				  struct stmmac_resources *stmmac_res)
365 366
{
	struct resource *res;
367

368
	memset(stmmac_res, 0, sizeof(*stmmac_res));
369 370 371 372

	/* Get IRQ information early to have an ability to ask for deferred
	 * probe if needed before we went too far with resource allocation.
	 */
373 374 375 376
	stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
	if (stmmac_res->irq < 0) {
		if (stmmac_res->irq != -EPROBE_DEFER) {
			dev_err(&pdev->dev,
377 378
				"MAC IRQ configuration information not found\n");
		}
379
		return stmmac_res->irq;
380 381 382 383 384 385 386 387 388
	}

	/* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
	 * The external wake up irq can be passed through the platform code
	 * named as "eth_wake_irq"
	 *
	 * In case the wake up interrupt is not passed from the platform
	 * so the driver will continue to use the mac irq (ndev->irq)
	 */
389 390 391
	stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
	if (stmmac_res->wol_irq < 0) {
		if (stmmac_res->wol_irq == -EPROBE_DEFER)
392
			return -EPROBE_DEFER;
393
		stmmac_res->wol_irq = stmmac_res->irq;
394 395
	}

396 397
	stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
	if (stmmac_res->lpi_irq == -EPROBE_DEFER)
398
		return -EPROBE_DEFER;
399 400

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
401 402
	stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);

F
Fengguang Wu 已提交
403
	return PTR_ERR_OR_ZERO(stmmac_res->addr);
404
}
405
EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
406

407 408 409 410 411 412
/**
 * stmmac_pltfr_remove
 * @pdev: platform device pointer
 * Description: this function calls the main to free the net resources
 * and calls the platforms hook and release the resources (e.g. mem).
 */
413
int stmmac_pltfr_remove(struct platform_device *pdev)
414 415 416
{
	struct net_device *ndev = platform_get_drvdata(pdev);
	struct stmmac_priv *priv = netdev_priv(ndev);
417
	struct plat_stmmacenet_data *plat = priv->plat;
418
	int ret = stmmac_dvr_remove(&pdev->dev);
419

420 421 422 423
	if (plat->exit)
		plat->exit(pdev, plat->bsp_priv);

	stmmac_remove_config_dt(pdev, plat);
424

425 426
	return ret;
}
427
EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
428

429
#ifdef CONFIG_PM_SLEEP
430 431 432 433 434 435 436
/**
 * stmmac_pltfr_suspend
 * @dev: device pointer
 * Description: this function is invoked when suspend the driver and it direcly
 * call the main suspend function and then, if required, on some platform, it
 * can call an exit helper.
 */
437 438
static int stmmac_pltfr_suspend(struct device *dev)
{
439
	int ret;
440
	struct net_device *ndev = dev_get_drvdata(dev);
441
	struct stmmac_priv *priv = netdev_priv(ndev);
442
	struct platform_device *pdev = to_platform_device(dev);
443

444
	ret = stmmac_suspend(dev);
445 446 447
	if (priv->plat->suspend)
		priv->plat->suspend(pdev, priv->plat->bsp_priv);
	else if (priv->plat->exit)
448
		priv->plat->exit(pdev, priv->plat->bsp_priv);
449 450

	return ret;
451 452
}

453 454 455 456 457 458 459
/**
 * stmmac_pltfr_resume
 * @dev: device pointer
 * Description: this function is invoked when resume the driver before calling
 * the main resume function, on some platforms, it can call own init helper
 * if required.
 */
460
static int stmmac_pltfr_resume(struct device *dev)
461 462
{
	struct net_device *ndev = dev_get_drvdata(dev);
463
	struct stmmac_priv *priv = netdev_priv(ndev);
464 465
	struct platform_device *pdev = to_platform_device(dev);

466 467 468
	if (priv->plat->resume)
		priv->plat->resume(pdev, priv->plat->bsp_priv);
	else if (priv->plat->init)
469
		priv->plat->init(pdev, priv->plat->bsp_priv);
470

471
	return stmmac_resume(dev);
472
}
473
#endif /* CONFIG_PM_SLEEP */
474

475 476 477
SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
				       stmmac_pltfr_resume);
EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
478 479 480 481

MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
MODULE_LICENSE("GPL");