xref: /linux/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c (revision 995231c820e3bd3633cb38bf4ea6f2541e1da331)
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 	static const struct of_device_id need_mdio_ids[] = {
313 		{ .compatible = "snps,dwc-qos-ethernet-4.10" },
314 		{},
315 	};
316 
317 	/* If phy-handle property is passed from DT, use it as the PHY */
318 	plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
319 	if (plat->phy_node)
320 		dev_dbg(dev, "Found phy-handle subnode\n");
321 
322 	/* If phy-handle is not specified, check if we have a fixed-phy */
323 	if (!plat->phy_node && of_phy_is_fixed_link(np)) {
324 		if ((of_phy_register_fixed_link(np) < 0))
325 			return -ENODEV;
326 
327 		dev_dbg(dev, "Found fixed-link subnode\n");
328 		plat->phy_node = of_node_get(np);
329 		mdio = false;
330 	}
331 
332 	if (of_match_node(need_mdio_ids, np)) {
333 		plat->mdio_node = of_get_child_by_name(np, "mdio");
334 	} else {
335 		/**
336 		 * If snps,dwmac-mdio is passed from DT, always register
337 		 * the MDIO
338 		 */
339 		for_each_child_of_node(np, plat->mdio_node) {
340 			if (of_device_is_compatible(plat->mdio_node,
341 						    "snps,dwmac-mdio"))
342 				break;
343 		}
344 	}
345 
346 	if (plat->mdio_node) {
347 		dev_dbg(dev, "Found MDIO subnode\n");
348 		mdio = true;
349 	}
350 
351 	if (mdio)
352 		plat->mdio_bus_data =
353 			devm_kzalloc(dev, sizeof(struct stmmac_mdio_bus_data),
354 				     GFP_KERNEL);
355 	return 0;
356 }
357 
358 /**
359  * stmmac_probe_config_dt - parse device-tree driver parameters
360  * @pdev: platform_device structure
361  * @mac: MAC address to use
362  * Description:
363  * this function is to read the driver parameters from device-tree and
364  * set some private fields that will be used by the main at runtime.
365  */
366 struct plat_stmmacenet_data *
367 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
368 {
369 	struct device_node *np = pdev->dev.of_node;
370 	struct plat_stmmacenet_data *plat;
371 	struct stmmac_dma_cfg *dma_cfg;
372 
373 	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
374 	if (!plat)
375 		return ERR_PTR(-ENOMEM);
376 
377 	*mac = of_get_mac_address(np);
378 	plat->interface = of_get_phy_mode(np);
379 
380 	/* Get max speed of operation from device tree */
381 	if (of_property_read_u32(np, "max-speed", &plat->max_speed))
382 		plat->max_speed = -1;
383 
384 	plat->bus_id = of_alias_get_id(np, "ethernet");
385 	if (plat->bus_id < 0)
386 		plat->bus_id = 0;
387 
388 	/* Default to phy auto-detection */
389 	plat->phy_addr = -1;
390 
391 	/* "snps,phy-addr" is not a standard property. Mark it as deprecated
392 	 * and warn of its use. Remove this when phy node support is added.
393 	 */
394 	if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
395 		dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
396 
397 	/* To Configure PHY by using all device-tree supported properties */
398 	if (stmmac_dt_phy(plat, np, &pdev->dev))
399 		return ERR_PTR(-ENODEV);
400 
401 	of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
402 
403 	of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
404 
405 	plat->force_sf_dma_mode =
406 		of_property_read_bool(np, "snps,force_sf_dma_mode");
407 
408 	plat->en_tx_lpi_clockgating =
409 		of_property_read_bool(np, "snps,en-tx-lpi-clockgating");
410 
411 	/* Set the maxmtu to a default of JUMBO_LEN in case the
412 	 * parameter is not present in the device tree.
413 	 */
414 	plat->maxmtu = JUMBO_LEN;
415 
416 	/* Set default value for multicast hash bins */
417 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
418 
419 	/* Set default value for unicast filter entries */
420 	plat->unicast_filter_entries = 1;
421 
422 	/*
423 	 * Currently only the properties needed on SPEAr600
424 	 * are provided. All other properties should be added
425 	 * once needed on other platforms.
426 	 */
427 	if (of_device_is_compatible(np, "st,spear600-gmac") ||
428 		of_device_is_compatible(np, "snps,dwmac-3.50a") ||
429 		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
430 		of_device_is_compatible(np, "snps,dwmac")) {
431 		/* Note that the max-frame-size parameter as defined in the
432 		 * ePAPR v1.1 spec is defined as max-frame-size, it's
433 		 * actually used as the IEEE definition of MAC Client
434 		 * data, or MTU. The ePAPR specification is confusing as
435 		 * the definition is max-frame-size, but usage examples
436 		 * are clearly MTUs
437 		 */
438 		of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
439 		of_property_read_u32(np, "snps,multicast-filter-bins",
440 				     &plat->multicast_filter_bins);
441 		of_property_read_u32(np, "snps,perfect-filter-entries",
442 				     &plat->unicast_filter_entries);
443 		plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
444 					       plat->unicast_filter_entries);
445 		plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
446 					      plat->multicast_filter_bins);
447 		plat->has_gmac = 1;
448 		plat->pmt = 1;
449 	}
450 
451 	if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
452 	    of_device_is_compatible(np, "snps,dwmac-4.10a")) {
453 		plat->has_gmac4 = 1;
454 		plat->has_gmac = 0;
455 		plat->pmt = 1;
456 		plat->tso_en = of_property_read_bool(np, "snps,tso");
457 	}
458 
459 	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
460 		of_device_is_compatible(np, "snps,dwmac-3.710")) {
461 		plat->enh_desc = 1;
462 		plat->bugged_jumbo = 1;
463 		plat->force_sf_dma_mode = 1;
464 	}
465 
466 	dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
467 			       GFP_KERNEL);
468 	if (!dma_cfg) {
469 		stmmac_remove_config_dt(pdev, plat);
470 		return ERR_PTR(-ENOMEM);
471 	}
472 	plat->dma_cfg = dma_cfg;
473 
474 	of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
475 	if (!dma_cfg->pbl)
476 		dma_cfg->pbl = DEFAULT_DMA_PBL;
477 	of_property_read_u32(np, "snps,txpbl", &dma_cfg->txpbl);
478 	of_property_read_u32(np, "snps,rxpbl", &dma_cfg->rxpbl);
479 	dma_cfg->pblx8 = !of_property_read_bool(np, "snps,no-pbl-x8");
480 
481 	dma_cfg->aal = of_property_read_bool(np, "snps,aal");
482 	dma_cfg->fixed_burst = of_property_read_bool(np, "snps,fixed-burst");
483 	dma_cfg->mixed_burst = of_property_read_bool(np, "snps,mixed-burst");
484 
485 	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
486 	if (plat->force_thresh_dma_mode) {
487 		plat->force_sf_dma_mode = 0;
488 		pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
489 	}
490 
491 	of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);
492 
493 	plat->axi = stmmac_axi_setup(pdev);
494 
495 	stmmac_mtl_setup(pdev, plat);
496 
497 	/* clock setup */
498 	plat->stmmac_clk = devm_clk_get(&pdev->dev,
499 					STMMAC_RESOURCE_NAME);
500 	if (IS_ERR(plat->stmmac_clk)) {
501 		dev_warn(&pdev->dev, "Cannot get CSR clock\n");
502 		plat->stmmac_clk = NULL;
503 	}
504 	clk_prepare_enable(plat->stmmac_clk);
505 
506 	plat->pclk = devm_clk_get(&pdev->dev, "pclk");
507 	if (IS_ERR(plat->pclk)) {
508 		if (PTR_ERR(plat->pclk) == -EPROBE_DEFER)
509 			goto error_pclk_get;
510 
511 		plat->pclk = NULL;
512 	}
513 	clk_prepare_enable(plat->pclk);
514 
515 	/* Fall-back to main clock in case of no PTP ref is passed */
516 	plat->clk_ptp_ref = devm_clk_get(&pdev->dev, "ptp_ref");
517 	if (IS_ERR(plat->clk_ptp_ref)) {
518 		plat->clk_ptp_rate = clk_get_rate(plat->stmmac_clk);
519 		plat->clk_ptp_ref = NULL;
520 		dev_warn(&pdev->dev, "PTP uses main clock\n");
521 	} else {
522 		plat->clk_ptp_rate = clk_get_rate(plat->clk_ptp_ref);
523 		dev_dbg(&pdev->dev, "PTP rate %d\n", plat->clk_ptp_rate);
524 	}
525 
526 	plat->stmmac_rst = devm_reset_control_get(&pdev->dev,
527 						  STMMAC_RESOURCE_NAME);
528 	if (IS_ERR(plat->stmmac_rst)) {
529 		if (PTR_ERR(plat->stmmac_rst) == -EPROBE_DEFER)
530 			goto error_hw_init;
531 
532 		dev_info(&pdev->dev, "no reset control found\n");
533 		plat->stmmac_rst = NULL;
534 	}
535 
536 	return plat;
537 
538 error_hw_init:
539 	clk_disable_unprepare(plat->pclk);
540 error_pclk_get:
541 	clk_disable_unprepare(plat->stmmac_clk);
542 
543 	return ERR_PTR(-EPROBE_DEFER);
544 }
545 
546 /**
547  * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt()
548  * @pdev: platform_device structure
549  * @plat: driver data platform structure
550  *
551  * Release resources claimed by stmmac_probe_config_dt().
552  */
553 void stmmac_remove_config_dt(struct platform_device *pdev,
554 			     struct plat_stmmacenet_data *plat)
555 {
556 	struct device_node *np = pdev->dev.of_node;
557 
558 	if (of_phy_is_fixed_link(np))
559 		of_phy_deregister_fixed_link(np);
560 	of_node_put(plat->phy_node);
561 	of_node_put(plat->mdio_node);
562 }
563 #else
564 struct plat_stmmacenet_data *
565 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
566 {
567 	return ERR_PTR(-EINVAL);
568 }
569 
570 void stmmac_remove_config_dt(struct platform_device *pdev,
571 			     struct plat_stmmacenet_data *plat)
572 {
573 }
574 #endif /* CONFIG_OF */
575 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
576 EXPORT_SYMBOL_GPL(stmmac_remove_config_dt);
577 
578 int stmmac_get_platform_resources(struct platform_device *pdev,
579 				  struct stmmac_resources *stmmac_res)
580 {
581 	struct resource *res;
582 
583 	memset(stmmac_res, 0, sizeof(*stmmac_res));
584 
585 	/* Get IRQ information early to have an ability to ask for deferred
586 	 * probe if needed before we went too far with resource allocation.
587 	 */
588 	stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
589 	if (stmmac_res->irq < 0) {
590 		if (stmmac_res->irq != -EPROBE_DEFER) {
591 			dev_err(&pdev->dev,
592 				"MAC IRQ configuration information not found\n");
593 		}
594 		return stmmac_res->irq;
595 	}
596 
597 	/* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
598 	 * The external wake up irq can be passed through the platform code
599 	 * named as "eth_wake_irq"
600 	 *
601 	 * In case the wake up interrupt is not passed from the platform
602 	 * so the driver will continue to use the mac irq (ndev->irq)
603 	 */
604 	stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
605 	if (stmmac_res->wol_irq < 0) {
606 		if (stmmac_res->wol_irq == -EPROBE_DEFER)
607 			return -EPROBE_DEFER;
608 		stmmac_res->wol_irq = stmmac_res->irq;
609 	}
610 
611 	stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
612 	if (stmmac_res->lpi_irq == -EPROBE_DEFER)
613 		return -EPROBE_DEFER;
614 
615 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
616 	stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
617 
618 	return PTR_ERR_OR_ZERO(stmmac_res->addr);
619 }
620 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
621 
622 /**
623  * stmmac_pltfr_remove
624  * @pdev: platform device pointer
625  * Description: this function calls the main to free the net resources
626  * and calls the platforms hook and release the resources (e.g. mem).
627  */
628 int stmmac_pltfr_remove(struct platform_device *pdev)
629 {
630 	struct net_device *ndev = platform_get_drvdata(pdev);
631 	struct stmmac_priv *priv = netdev_priv(ndev);
632 	struct plat_stmmacenet_data *plat = priv->plat;
633 	int ret = stmmac_dvr_remove(&pdev->dev);
634 
635 	if (plat->exit)
636 		plat->exit(pdev, plat->bsp_priv);
637 
638 	stmmac_remove_config_dt(pdev, plat);
639 
640 	return ret;
641 }
642 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
643 
644 #ifdef CONFIG_PM_SLEEP
645 /**
646  * stmmac_pltfr_suspend
647  * @dev: device pointer
648  * Description: this function is invoked when suspend the driver and it direcly
649  * call the main suspend function and then, if required, on some platform, it
650  * can call an exit helper.
651  */
652 static int stmmac_pltfr_suspend(struct device *dev)
653 {
654 	int ret;
655 	struct net_device *ndev = dev_get_drvdata(dev);
656 	struct stmmac_priv *priv = netdev_priv(ndev);
657 	struct platform_device *pdev = to_platform_device(dev);
658 
659 	ret = stmmac_suspend(dev);
660 	if (priv->plat->exit)
661 		priv->plat->exit(pdev, priv->plat->bsp_priv);
662 
663 	return ret;
664 }
665 
666 /**
667  * stmmac_pltfr_resume
668  * @dev: device pointer
669  * Description: this function is invoked when resume the driver before calling
670  * the main resume function, on some platforms, it can call own init helper
671  * if required.
672  */
673 static int stmmac_pltfr_resume(struct device *dev)
674 {
675 	struct net_device *ndev = dev_get_drvdata(dev);
676 	struct stmmac_priv *priv = netdev_priv(ndev);
677 	struct platform_device *pdev = to_platform_device(dev);
678 
679 	if (priv->plat->init)
680 		priv->plat->init(pdev, priv->plat->bsp_priv);
681 
682 	return stmmac_resume(dev);
683 }
684 #endif /* CONFIG_PM_SLEEP */
685 
686 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
687 				       stmmac_pltfr_resume);
688 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
689 
690 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
691 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
692 MODULE_LICENSE("GPL");
693