xref: /linux/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c (revision e58e871becec2d3b04ed91c0c16fe8deac9c9dfa)
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   The full GNU General Public License is included in this distribution in
16   the file called "COPYING".
17 
18   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
19 *******************************************************************************/
20 
21 #include <linux/platform_device.h>
22 #include <linux/module.h>
23 #include <linux/io.h>
24 #include <linux/of.h>
25 #include <linux/of_net.h>
26 #include <linux/of_device.h>
27 #include <linux/of_mdio.h>
28 
29 #include "stmmac.h"
30 #include "stmmac_platform.h"
31 
32 #ifdef CONFIG_OF
33 
34 /**
35  * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
36  * @mcast_bins: Multicast filtering bins
37  * Description:
38  * this function validates the number of Multicast filtering bins specified
39  * by the configuration through the device tree. The Synopsys GMAC supports
40  * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC
41  * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds
42  * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is
43  * invalid and will cause the filtering algorithm to use Multicast
44  * promiscuous mode.
45  */
46 static int dwmac1000_validate_mcast_bins(int mcast_bins)
47 {
48 	int x = mcast_bins;
49 
50 	switch (x) {
51 	case HASH_TABLE_SIZE:
52 	case 128:
53 	case 256:
54 		break;
55 	default:
56 		x = 0;
57 		pr_info("Hash table entries set to unexpected value %d",
58 			mcast_bins);
59 		break;
60 	}
61 	return x;
62 }
63 
64 /**
65  * dwmac1000_validate_ucast_entries - validate the Unicast address entries
66  * @ucast_entries: number of Unicast address entries
67  * Description:
68  * This function validates the number of Unicast address entries supported
69  * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
70  * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter
71  * logic. This function validates a valid, supported configuration is
72  * selected, and defaults to 1 Unicast address if an unsupported
73  * configuration is selected.
74  */
75 static int dwmac1000_validate_ucast_entries(int ucast_entries)
76 {
77 	int x = ucast_entries;
78 
79 	switch (x) {
80 	case 1:
81 	case 32:
82 	case 64:
83 	case 128:
84 		break;
85 	default:
86 		x = 1;
87 		pr_info("Unicast table entries set to unexpected value %d\n",
88 			ucast_entries);
89 		break;
90 	}
91 	return x;
92 }
93 
94 /**
95  * stmmac_axi_setup - parse DT parameters for programming the AXI register
96  * @pdev: platform device
97  * @priv: driver private struct.
98  * Description:
99  * if required, from device-tree the AXI internal register can be tuned
100  * by using platform parameters.
101  */
102 static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev)
103 {
104 	struct device_node *np;
105 	struct stmmac_axi *axi;
106 
107 	np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0);
108 	if (!np)
109 		return NULL;
110 
111 	axi = devm_kzalloc(&pdev->dev, sizeof(*axi), GFP_KERNEL);
112 	if (!axi) {
113 		of_node_put(np);
114 		return ERR_PTR(-ENOMEM);
115 	}
116 
117 	axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en");
118 	axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm");
119 	axi->axi_kbbe = of_property_read_bool(np, "snps,axi_kbbe");
120 	axi->axi_fb = of_property_read_bool(np, "snps,axi_fb");
121 	axi->axi_mb = of_property_read_bool(np, "snps,axi_mb");
122 	axi->axi_rb =  of_property_read_bool(np, "snps,axi_rb");
123 
124 	if (of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt))
125 		axi->axi_wr_osr_lmt = 1;
126 	if (of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt))
127 		axi->axi_rd_osr_lmt = 1;
128 	of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN);
129 	of_node_put(np);
130 
131 	return axi;
132 }
133 
134 /**
135  * stmmac_mtl_setup - parse DT parameters for multiple queues configuration
136  * @pdev: platform device
137  */
138 static void stmmac_mtl_setup(struct platform_device *pdev,
139 			     struct plat_stmmacenet_data *plat)
140 {
141 	struct device_node *q_node;
142 	struct device_node *rx_node;
143 	struct device_node *tx_node;
144 	u8 queue = 0;
145 
146 	/* For backwards-compatibility with device trees that don't have any
147 	 * snps,mtl-rx-config or snps,mtl-tx-config properties, we fall back
148 	 * to one RX and TX queues each.
149 	 */
150 	plat->rx_queues_to_use = 1;
151 	plat->tx_queues_to_use = 1;
152 
153 	rx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-rx-config", 0);
154 	if (!rx_node)
155 		return;
156 
157 	tx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-tx-config", 0);
158 	if (!tx_node) {
159 		of_node_put(rx_node);
160 		return;
161 	}
162 
163 	/* Processing RX queues common config */
164 	if (of_property_read_u8(rx_node, "snps,rx-queues-to-use",
165 				&plat->rx_queues_to_use))
166 		plat->rx_queues_to_use = 1;
167 
168 	if (of_property_read_bool(rx_node, "snps,rx-sched-sp"))
169 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP;
170 	else if (of_property_read_bool(rx_node, "snps,rx-sched-wsp"))
171 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_WSP;
172 	else
173 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP;
174 
175 	/* Processing individual RX queue config */
176 	for_each_child_of_node(rx_node, q_node) {
177 		if (queue >= plat->rx_queues_to_use)
178 			break;
179 
180 		if (of_property_read_bool(q_node, "snps,dcb-algorithm"))
181 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
182 		else if (of_property_read_bool(q_node, "snps,avb-algorithm"))
183 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB;
184 		else
185 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
186 
187 		if (of_property_read_u8(q_node, "snps,map-to-dma-channel",
188 					&plat->rx_queues_cfg[queue].chan))
189 			plat->rx_queues_cfg[queue].chan = queue;
190 		/* TODO: Dynamic mapping to be included in the future */
191 
192 		if (of_property_read_u32(q_node, "snps,priority",
193 					&plat->rx_queues_cfg[queue].prio)) {
194 			plat->rx_queues_cfg[queue].prio = 0;
195 			plat->rx_queues_cfg[queue].use_prio = false;
196 		} else {
197 			plat->rx_queues_cfg[queue].use_prio = true;
198 		}
199 
200 		/* RX queue specific packet type routing */
201 		if (of_property_read_bool(q_node, "snps,route-avcp"))
202 			plat->rx_queues_cfg[queue].pkt_route = PACKET_AVCPQ;
203 		else if (of_property_read_bool(q_node, "snps,route-ptp"))
204 			plat->rx_queues_cfg[queue].pkt_route = PACKET_PTPQ;
205 		else if (of_property_read_bool(q_node, "snps,route-dcbcp"))
206 			plat->rx_queues_cfg[queue].pkt_route = PACKET_DCBCPQ;
207 		else if (of_property_read_bool(q_node, "snps,route-up"))
208 			plat->rx_queues_cfg[queue].pkt_route = PACKET_UPQ;
209 		else if (of_property_read_bool(q_node, "snps,route-multi-broad"))
210 			plat->rx_queues_cfg[queue].pkt_route = PACKET_MCBCQ;
211 		else
212 			plat->rx_queues_cfg[queue].pkt_route = 0x0;
213 
214 		queue++;
215 	}
216 
217 	/* Processing TX queues common config */
218 	if (of_property_read_u8(tx_node, "snps,tx-queues-to-use",
219 				&plat->tx_queues_to_use))
220 		plat->tx_queues_to_use = 1;
221 
222 	if (of_property_read_bool(tx_node, "snps,tx-sched-wrr"))
223 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WRR;
224 	else if (of_property_read_bool(tx_node, "snps,tx-sched-wfq"))
225 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WFQ;
226 	else if (of_property_read_bool(tx_node, "snps,tx-sched-dwrr"))
227 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_DWRR;
228 	else if (of_property_read_bool(tx_node, "snps,tx-sched-sp"))
229 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_SP;
230 	else
231 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_SP;
232 
233 	queue = 0;
234 
235 	/* Processing individual TX queue config */
236 	for_each_child_of_node(tx_node, q_node) {
237 		if (queue >= plat->tx_queues_to_use)
238 			break;
239 
240 		if (of_property_read_u8(q_node, "snps,weight",
241 					&plat->tx_queues_cfg[queue].weight))
242 			plat->tx_queues_cfg[queue].weight = 0x10 + queue;
243 
244 		if (of_property_read_bool(q_node, "snps,dcb-algorithm")) {
245 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
246 		} else if (of_property_read_bool(q_node,
247 						 "snps,avb-algorithm")) {
248 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB;
249 
250 			/* Credit Base Shaper parameters used by AVB */
251 			if (of_property_read_u32(q_node, "snps,send_slope",
252 				&plat->tx_queues_cfg[queue].send_slope))
253 				plat->tx_queues_cfg[queue].send_slope = 0x0;
254 			if (of_property_read_u32(q_node, "snps,idle_slope",
255 				&plat->tx_queues_cfg[queue].idle_slope))
256 				plat->tx_queues_cfg[queue].idle_slope = 0x0;
257 			if (of_property_read_u32(q_node, "snps,high_credit",
258 				&plat->tx_queues_cfg[queue].high_credit))
259 				plat->tx_queues_cfg[queue].high_credit = 0x0;
260 			if (of_property_read_u32(q_node, "snps,low_credit",
261 				&plat->tx_queues_cfg[queue].low_credit))
262 				plat->tx_queues_cfg[queue].low_credit = 0x0;
263 		} else {
264 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
265 		}
266 
267 		if (of_property_read_u32(q_node, "snps,priority",
268 					&plat->tx_queues_cfg[queue].prio)) {
269 			plat->tx_queues_cfg[queue].prio = 0;
270 			plat->tx_queues_cfg[queue].use_prio = false;
271 		} else {
272 			plat->tx_queues_cfg[queue].use_prio = true;
273 		}
274 
275 		queue++;
276 	}
277 
278 	of_node_put(rx_node);
279 	of_node_put(tx_node);
280 	of_node_put(q_node);
281 }
282 
283 /**
284  * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources
285  * @plat: driver data platform structure
286  * @np: device tree node
287  * @dev: device pointer
288  * Description:
289  * The mdio bus will be allocated in case of a phy transceiver is on board;
290  * it will be NULL if the fixed-link is configured.
291  * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated
292  * in any case (for DSA, mdio must be registered even if fixed-link).
293  * The table below sums the supported configurations:
294  *	-------------------------------
295  *	snps,phy-addr	|     Y
296  *	-------------------------------
297  *	phy-handle	|     Y
298  *	-------------------------------
299  *	fixed-link	|     N
300  *	-------------------------------
301  *	snps,dwmac-mdio	|
302  *	  even if	|     Y
303  *	fixed-link	|
304  *	-------------------------------
305  *
306  * It returns 0 in case of success otherwise -ENODEV.
307  */
308 static int stmmac_dt_phy(struct plat_stmmacenet_data *plat,
309 			 struct device_node *np, struct device *dev)
310 {
311 	bool mdio = true;
312 
313 	/* If phy-handle property is passed from DT, use it as the PHY */
314 	plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
315 	if (plat->phy_node)
316 		dev_dbg(dev, "Found phy-handle subnode\n");
317 
318 	/* If phy-handle is not specified, check if we have a fixed-phy */
319 	if (!plat->phy_node && of_phy_is_fixed_link(np)) {
320 		if ((of_phy_register_fixed_link(np) < 0))
321 			return -ENODEV;
322 
323 		dev_dbg(dev, "Found fixed-link subnode\n");
324 		plat->phy_node = of_node_get(np);
325 		mdio = false;
326 	}
327 
328 	/* exception for dwmac-dwc-qos-eth glue logic */
329 	if (of_device_is_compatible(np, "snps,dwc-qos-ethernet-4.10")) {
330 		plat->mdio_node = of_get_child_by_name(np, "mdio");
331 	} else {
332 		/**
333 		 * If snps,dwmac-mdio is passed from DT, always register
334 		 * the MDIO
335 		 */
336 		for_each_child_of_node(np, plat->mdio_node) {
337 			if (of_device_is_compatible(plat->mdio_node,
338 						    "snps,dwmac-mdio"))
339 				break;
340 		}
341 	}
342 
343 	if (plat->mdio_node) {
344 		dev_dbg(dev, "Found MDIO subnode\n");
345 		mdio = true;
346 	}
347 
348 	if (mdio)
349 		plat->mdio_bus_data =
350 			devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data),
351 				     GFP_KERNEL);
352 	return 0;
353 }
354 
355 /**
356  * stmmac_probe_config_dt - parse device-tree driver parameters
357  * @pdev: platform_device structure
358  * @mac: MAC address to use
359  * Description:
360  * this function is to read the driver parameters from device-tree and
361  * set some private fields that will be used by the main at runtime.
362  */
363 struct plat_stmmacenet_data *
364 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
365 {
366 	struct device_node *np = pdev->dev.of_node;
367 	struct plat_stmmacenet_data *plat;
368 	struct stmmac_dma_cfg *dma_cfg;
369 
370 	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
371 	if (!plat)
372 		return ERR_PTR(-ENOMEM);
373 
374 	*mac = of_get_mac_address(np);
375 	plat->interface = of_get_phy_mode(np);
376 
377 	/* Get max speed of operation from device tree */
378 	if (of_property_read_u32(np, "max-speed", &plat->max_speed))
379 		plat->max_speed = -1;
380 
381 	plat->bus_id = of_alias_get_id(np, "ethernet");
382 	if (plat->bus_id < 0)
383 		plat->bus_id = 0;
384 
385 	/* Default to phy auto-detection */
386 	plat->phy_addr = -1;
387 
388 	/* "snps,phy-addr" is not a standard property. Mark it as deprecated
389 	 * and warn of its use. Remove this when phy node support is added.
390 	 */
391 	if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
392 		dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
393 
394 	/* To Configure PHY by using all device-tree supported properties */
395 	if (stmmac_dt_phy(plat, np, &pdev->dev))
396 		return ERR_PTR(-ENODEV);
397 
398 	of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
399 
400 	of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
401 
402 	plat->force_sf_dma_mode =
403 		of_property_read_bool(np, "snps,force_sf_dma_mode");
404 
405 	plat->en_tx_lpi_clockgating =
406 		of_property_read_bool(np, "snps,en-tx-lpi-clockgating");
407 
408 	/* Set the maxmtu to a default of JUMBO_LEN in case the
409 	 * parameter is not present in the device tree.
410 	 */
411 	plat->maxmtu = JUMBO_LEN;
412 
413 	/* Set default value for multicast hash bins */
414 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
415 
416 	/* Set default value for unicast filter entries */
417 	plat->unicast_filter_entries = 1;
418 
419 	/*
420 	 * Currently only the properties needed on SPEAr600
421 	 * are provided. All other properties should be added
422 	 * once needed on other platforms.
423 	 */
424 	if (of_device_is_compatible(np, "st,spear600-gmac") ||
425 		of_device_is_compatible(np, "snps,dwmac-3.50a") ||
426 		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
427 		of_device_is_compatible(np, "snps,dwmac")) {
428 		/* Note that the max-frame-size parameter as defined in the
429 		 * ePAPR v1.1 spec is defined as max-frame-size, it's
430 		 * actually used as the IEEE definition of MAC Client
431 		 * data, or MTU. The ePAPR specification is confusing as
432 		 * the definition is max-frame-size, but usage examples
433 		 * are clearly MTUs
434 		 */
435 		of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
436 		of_property_read_u32(np, "snps,multicast-filter-bins",
437 				     &plat->multicast_filter_bins);
438 		of_property_read_u32(np, "snps,perfect-filter-entries",
439 				     &plat->unicast_filter_entries);
440 		plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
441 					       plat->unicast_filter_entries);
442 		plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
443 					      plat->multicast_filter_bins);
444 		plat->has_gmac = 1;
445 		plat->pmt = 1;
446 	}
447 
448 	if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
449 	    of_device_is_compatible(np, "snps,dwmac-4.10a")) {
450 		plat->has_gmac4 = 1;
451 		plat->has_gmac = 0;
452 		plat->pmt = 1;
453 		plat->tso_en = of_property_read_bool(np, "snps,tso");
454 	}
455 
456 	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
457 		of_device_is_compatible(np, "snps,dwmac-3.710")) {
458 		plat->enh_desc = 1;
459 		plat->bugged_jumbo = 1;
460 		plat->force_sf_dma_mode = 1;
461 	}
462 
463 	dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
464 			       GFP_KERNEL);
465 	if (!dma_cfg) {
466 		stmmac_remove_config_dt(pdev, plat);
467 		return ERR_PTR(-ENOMEM);
468 	}
469 	plat->dma_cfg = dma_cfg;
470 
471 	of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
472 	if (!dma_cfg->pbl)
473 		dma_cfg->pbl = DEFAULT_DMA_PBL;
474 	of_property_read_u32(np, "snps,txpbl", &dma_cfg->txpbl);
475 	of_property_read_u32(np, "snps,rxpbl", &dma_cfg->rxpbl);
476 	dma_cfg->pblx8 = !of_property_read_bool(np, "snps,no-pbl-x8");
477 
478 	dma_cfg->aal = of_property_read_bool(np, "snps,aal");
479 	dma_cfg->fixed_burst = of_property_read_bool(np, "snps,fixed-burst");
480 	dma_cfg->mixed_burst = of_property_read_bool(np, "snps,mixed-burst");
481 
482 	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
483 	if (plat->force_thresh_dma_mode) {
484 		plat->force_sf_dma_mode = 0;
485 		pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
486 	}
487 
488 	of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);
489 
490 	plat->axi = stmmac_axi_setup(pdev);
491 
492 	stmmac_mtl_setup(pdev, plat);
493 
494 	/* clock setup */
495 	plat->stmmac_clk = devm_clk_get(&pdev->dev,
496 					STMMAC_RESOURCE_NAME);
497 	if (IS_ERR(plat->stmmac_clk)) {
498 		dev_warn(&pdev->dev, "Cannot get CSR clock\n");
499 		plat->stmmac_clk = NULL;
500 	}
501 	clk_prepare_enable(plat->stmmac_clk);
502 
503 	plat->pclk = devm_clk_get(&pdev->dev, "pclk");
504 	if (IS_ERR(plat->pclk)) {
505 		if (PTR_ERR(plat->pclk) == -EPROBE_DEFER)
506 			goto error_pclk_get;
507 
508 		plat->pclk = NULL;
509 	}
510 	clk_prepare_enable(plat->pclk);
511 
512 	/* Fall-back to main clock in case of no PTP ref is passed */
513 	plat->clk_ptp_ref = devm_clk_get(&pdev->dev, "ptp_ref");
514 	if (IS_ERR(plat->clk_ptp_ref)) {
515 		plat->clk_ptp_rate = clk_get_rate(plat->stmmac_clk);
516 		plat->clk_ptp_ref = NULL;
517 		dev_warn(&pdev->dev, "PTP uses main clock\n");
518 	} else {
519 		plat->clk_ptp_rate = clk_get_rate(plat->clk_ptp_ref);
520 		dev_dbg(&pdev->dev, "PTP rate %d\n", plat->clk_ptp_rate);
521 	}
522 
523 	plat->stmmac_rst = devm_reset_control_get(&pdev->dev,
524 						  STMMAC_RESOURCE_NAME);
525 	if (IS_ERR(plat->stmmac_rst)) {
526 		if (PTR_ERR(plat->stmmac_rst) == -EPROBE_DEFER)
527 			goto error_hw_init;
528 
529 		dev_info(&pdev->dev, "no reset control found\n");
530 		plat->stmmac_rst = NULL;
531 	}
532 
533 	return plat;
534 
535 error_hw_init:
536 	clk_disable_unprepare(plat->pclk);
537 error_pclk_get:
538 	clk_disable_unprepare(plat->stmmac_clk);
539 
540 	return ERR_PTR(-EPROBE_DEFER);
541 }
542 
543 /**
544  * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt()
545  * @pdev: platform_device structure
546  * @plat: driver data platform structure
547  *
548  * Release resources claimed by stmmac_probe_config_dt().
549  */
550 void stmmac_remove_config_dt(struct platform_device *pdev,
551 			     struct plat_stmmacenet_data *plat)
552 {
553 	struct device_node *np = pdev->dev.of_node;
554 
555 	if (of_phy_is_fixed_link(np))
556 		of_phy_deregister_fixed_link(np);
557 	of_node_put(plat->phy_node);
558 	of_node_put(plat->mdio_node);
559 }
560 #else
561 struct plat_stmmacenet_data *
562 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
563 {
564 	return ERR_PTR(-EINVAL);
565 }
566 
567 void stmmac_remove_config_dt(struct platform_device *pdev,
568 			     struct plat_stmmacenet_data *plat)
569 {
570 }
571 #endif /* CONFIG_OF */
572 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
573 EXPORT_SYMBOL_GPL(stmmac_remove_config_dt);
574 
575 int stmmac_get_platform_resources(struct platform_device *pdev,
576 				  struct stmmac_resources *stmmac_res)
577 {
578 	struct resource *res;
579 
580 	memset(stmmac_res, 0, sizeof(*stmmac_res));
581 
582 	/* Get IRQ information early to have an ability to ask for deferred
583 	 * probe if needed before we went too far with resource allocation.
584 	 */
585 	stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
586 	if (stmmac_res->irq < 0) {
587 		if (stmmac_res->irq != -EPROBE_DEFER) {
588 			dev_err(&pdev->dev,
589 				"MAC IRQ configuration information not found\n");
590 		}
591 		return stmmac_res->irq;
592 	}
593 
594 	/* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
595 	 * The external wake up irq can be passed through the platform code
596 	 * named as "eth_wake_irq"
597 	 *
598 	 * In case the wake up interrupt is not passed from the platform
599 	 * so the driver will continue to use the mac irq (ndev->irq)
600 	 */
601 	stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
602 	if (stmmac_res->wol_irq < 0) {
603 		if (stmmac_res->wol_irq == -EPROBE_DEFER)
604 			return -EPROBE_DEFER;
605 		stmmac_res->wol_irq = stmmac_res->irq;
606 	}
607 
608 	stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
609 	if (stmmac_res->lpi_irq == -EPROBE_DEFER)
610 		return -EPROBE_DEFER;
611 
612 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
613 	stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
614 
615 	return PTR_ERR_OR_ZERO(stmmac_res->addr);
616 }
617 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
618 
619 /**
620  * stmmac_pltfr_remove
621  * @pdev: platform device pointer
622  * Description: this function calls the main to free the net resources
623  * and calls the platforms hook and release the resources (e.g. mem).
624  */
625 int stmmac_pltfr_remove(struct platform_device *pdev)
626 {
627 	struct net_device *ndev = platform_get_drvdata(pdev);
628 	struct stmmac_priv *priv = netdev_priv(ndev);
629 	struct plat_stmmacenet_data *plat = priv->plat;
630 	int ret = stmmac_dvr_remove(&pdev->dev);
631 
632 	if (plat->exit)
633 		plat->exit(pdev, plat->bsp_priv);
634 
635 	stmmac_remove_config_dt(pdev, plat);
636 
637 	return ret;
638 }
639 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
640 
641 #ifdef CONFIG_PM_SLEEP
642 /**
643  * stmmac_pltfr_suspend
644  * @dev: device pointer
645  * Description: this function is invoked when suspend the driver and it direcly
646  * call the main suspend function and then, if required, on some platform, it
647  * can call an exit helper.
648  */
649 static int stmmac_pltfr_suspend(struct device *dev)
650 {
651 	int ret;
652 	struct net_device *ndev = dev_get_drvdata(dev);
653 	struct stmmac_priv *priv = netdev_priv(ndev);
654 	struct platform_device *pdev = to_platform_device(dev);
655 
656 	ret = stmmac_suspend(dev);
657 	if (priv->plat->exit)
658 		priv->plat->exit(pdev, priv->plat->bsp_priv);
659 
660 	return ret;
661 }
662 
663 /**
664  * stmmac_pltfr_resume
665  * @dev: device pointer
666  * Description: this function is invoked when resume the driver before calling
667  * the main resume function, on some platforms, it can call own init helper
668  * if required.
669  */
670 static int stmmac_pltfr_resume(struct device *dev)
671 {
672 	struct net_device *ndev = dev_get_drvdata(dev);
673 	struct stmmac_priv *priv = netdev_priv(ndev);
674 	struct platform_device *pdev = to_platform_device(dev);
675 
676 	if (priv->plat->init)
677 		priv->plat->init(pdev, priv->plat->bsp_priv);
678 
679 	return stmmac_resume(dev);
680 }
681 #endif /* CONFIG_PM_SLEEP */
682 
683 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
684 				       stmmac_pltfr_resume);
685 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
686 
687 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
688 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
689 MODULE_LICENSE("GPL");
690