1 // SPDX-License-Identifier: GPL-2.0-only
2 /*******************************************************************************
3   This contains the functions to handle the platform driver.
4 
5   Copyright (C) 2007-2011  STMicroelectronics Ltd
6 
7 
8   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
9 *******************************************************************************/
10 
11 #include <linux/device.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/module.h>
15 #include <linux/io.h>
16 #include <linux/of.h>
17 #include <linux/of_net.h>
18 #include <linux/of_mdio.h>
19 
20 #include "stmmac.h"
21 #include "stmmac_platform.h"
22 
23 #ifdef CONFIG_OF
24 
25 /**
26  * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
27  * @dev: struct device of the platform device
28  * @mcast_bins: Multicast filtering bins
29  * Description:
30  * this function validates the number of Multicast filtering bins specified
31  * by the configuration through the device tree. The Synopsys GMAC supports
32  * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC
33  * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds
34  * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is
35  * invalid and will cause the filtering algorithm to use Multicast
36  * promiscuous mode.
37  */
38 static int dwmac1000_validate_mcast_bins(struct device *dev, int mcast_bins)
39 {
40 	int x = mcast_bins;
41 
42 	switch (x) {
43 	case HASH_TABLE_SIZE:
44 	case 128:
45 	case 256:
46 		break;
47 	default:
48 		x = 0;
49 		dev_info(dev, "Hash table entries set to unexpected value %d\n",
50 			 mcast_bins);
51 		break;
52 	}
53 	return x;
54 }
55 
56 /**
57  * dwmac1000_validate_ucast_entries - validate the Unicast address entries
58  * @dev: struct device of the platform device
59  * @ucast_entries: number of Unicast address entries
60  * Description:
61  * This function validates the number of Unicast address entries supported
62  * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
63  * supports 1..32, 64, or 128 Unicast filter entries for it's Unicast filter
64  * logic. This function validates a valid, supported configuration is
65  * selected, and defaults to 1 Unicast address if an unsupported
66  * configuration is selected.
67  */
68 static int dwmac1000_validate_ucast_entries(struct device *dev,
69 					    int ucast_entries)
70 {
71 	int x = ucast_entries;
72 
73 	switch (x) {
74 	case 1 ... 32:
75 	case 64:
76 	case 128:
77 		break;
78 	default:
79 		x = 1;
80 		dev_info(dev, "Unicast table entries set to unexpected value %d\n",
81 			 ucast_entries);
82 		break;
83 	}
84 	return x;
85 }
86 
87 /**
88  * stmmac_axi_setup - parse DT parameters for programming the AXI register
89  * @pdev: platform device
90  * Description:
91  * if required, from device-tree the AXI internal register can be tuned
92  * by using platform parameters.
93  */
94 static struct stmmac_axi *stmmac_axi_setup(struct platform_device *pdev)
95 {
96 	struct device_node *np;
97 	struct stmmac_axi *axi;
98 
99 	np = of_parse_phandle(pdev->dev.of_node, "snps,axi-config", 0);
100 	if (!np)
101 		return NULL;
102 
103 	axi = devm_kzalloc(&pdev->dev, sizeof(*axi), GFP_KERNEL);
104 	if (!axi) {
105 		of_node_put(np);
106 		return ERR_PTR(-ENOMEM);
107 	}
108 
109 	axi->axi_lpi_en = of_property_read_bool(np, "snps,lpi_en");
110 	axi->axi_xit_frm = of_property_read_bool(np, "snps,xit_frm");
111 	axi->axi_kbbe = of_property_read_bool(np, "snps,kbbe");
112 	axi->axi_fb = of_property_read_bool(np, "snps,fb");
113 	axi->axi_mb = of_property_read_bool(np, "snps,mb");
114 	axi->axi_rb =  of_property_read_bool(np, "snps,rb");
115 
116 	if (of_property_read_u32(np, "snps,wr_osr_lmt", &axi->axi_wr_osr_lmt))
117 		axi->axi_wr_osr_lmt = 1;
118 	if (of_property_read_u32(np, "snps,rd_osr_lmt", &axi->axi_rd_osr_lmt))
119 		axi->axi_rd_osr_lmt = 1;
120 	of_property_read_u32_array(np, "snps,blen", axi->axi_blen, AXI_BLEN);
121 	of_node_put(np);
122 
123 	return axi;
124 }
125 
126 /**
127  * stmmac_mtl_setup - parse DT parameters for multiple queues configuration
128  * @pdev: platform device
129  * @plat: enet data
130  */
131 static int stmmac_mtl_setup(struct platform_device *pdev,
132 			    struct plat_stmmacenet_data *plat)
133 {
134 	struct device_node *q_node;
135 	struct device_node *rx_node;
136 	struct device_node *tx_node;
137 	u8 queue = 0;
138 	int ret = 0;
139 
140 	/* For backwards-compatibility with device trees that don't have any
141 	 * snps,mtl-rx-config or snps,mtl-tx-config properties, we fall back
142 	 * to one RX and TX queues each.
143 	 */
144 	plat->rx_queues_to_use = 1;
145 	plat->tx_queues_to_use = 1;
146 
147 	/* First Queue must always be in DCB mode. As MTL_QUEUE_DCB = 1 we need
148 	 * to always set this, otherwise Queue will be classified as AVB
149 	 * (because MTL_QUEUE_AVB = 0).
150 	 */
151 	plat->rx_queues_cfg[0].mode_to_use = MTL_QUEUE_DCB;
152 	plat->tx_queues_cfg[0].mode_to_use = MTL_QUEUE_DCB;
153 
154 	rx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-rx-config", 0);
155 	if (!rx_node)
156 		return ret;
157 
158 	tx_node = of_parse_phandle(pdev->dev.of_node, "snps,mtl-tx-config", 0);
159 	if (!tx_node) {
160 		of_node_put(rx_node);
161 		return ret;
162 	}
163 
164 	/* Processing RX queues common config */
165 	if (of_property_read_u32(rx_node, "snps,rx-queues-to-use",
166 				 &plat->rx_queues_to_use))
167 		plat->rx_queues_to_use = 1;
168 
169 	if (of_property_read_bool(rx_node, "snps,rx-sched-sp"))
170 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP;
171 	else if (of_property_read_bool(rx_node, "snps,rx-sched-wsp"))
172 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_WSP;
173 	else
174 		plat->rx_sched_algorithm = MTL_RX_ALGORITHM_SP;
175 
176 	/* Processing individual RX queue config */
177 	for_each_child_of_node(rx_node, q_node) {
178 		if (queue >= plat->rx_queues_to_use)
179 			break;
180 
181 		if (of_property_read_bool(q_node, "snps,dcb-algorithm"))
182 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
183 		else if (of_property_read_bool(q_node, "snps,avb-algorithm"))
184 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB;
185 		else
186 			plat->rx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
187 
188 		if (of_property_read_u32(q_node, "snps,map-to-dma-channel",
189 					 &plat->rx_queues_cfg[queue].chan))
190 			plat->rx_queues_cfg[queue].chan = queue;
191 		/* TODO: Dynamic mapping to be included in the future */
192 
193 		if (of_property_read_u32(q_node, "snps,priority",
194 					&plat->rx_queues_cfg[queue].prio)) {
195 			plat->rx_queues_cfg[queue].prio = 0;
196 			plat->rx_queues_cfg[queue].use_prio = false;
197 		} else {
198 			plat->rx_queues_cfg[queue].use_prio = true;
199 		}
200 
201 		/* RX queue specific packet type routing */
202 		if (of_property_read_bool(q_node, "snps,route-avcp"))
203 			plat->rx_queues_cfg[queue].pkt_route = PACKET_AVCPQ;
204 		else if (of_property_read_bool(q_node, "snps,route-ptp"))
205 			plat->rx_queues_cfg[queue].pkt_route = PACKET_PTPQ;
206 		else if (of_property_read_bool(q_node, "snps,route-dcbcp"))
207 			plat->rx_queues_cfg[queue].pkt_route = PACKET_DCBCPQ;
208 		else if (of_property_read_bool(q_node, "snps,route-up"))
209 			plat->rx_queues_cfg[queue].pkt_route = PACKET_UPQ;
210 		else if (of_property_read_bool(q_node, "snps,route-multi-broad"))
211 			plat->rx_queues_cfg[queue].pkt_route = PACKET_MCBCQ;
212 		else
213 			plat->rx_queues_cfg[queue].pkt_route = 0x0;
214 
215 		queue++;
216 	}
217 	if (queue != plat->rx_queues_to_use) {
218 		ret = -EINVAL;
219 		dev_err(&pdev->dev, "Not all RX queues were configured\n");
220 		goto out;
221 	}
222 
223 	/* Processing TX queues common config */
224 	if (of_property_read_u32(tx_node, "snps,tx-queues-to-use",
225 				 &plat->tx_queues_to_use))
226 		plat->tx_queues_to_use = 1;
227 
228 	if (of_property_read_bool(tx_node, "snps,tx-sched-wrr"))
229 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WRR;
230 	else if (of_property_read_bool(tx_node, "snps,tx-sched-wfq"))
231 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_WFQ;
232 	else if (of_property_read_bool(tx_node, "snps,tx-sched-dwrr"))
233 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_DWRR;
234 	else
235 		plat->tx_sched_algorithm = MTL_TX_ALGORITHM_SP;
236 
237 	queue = 0;
238 
239 	/* Processing individual TX queue config */
240 	for_each_child_of_node(tx_node, q_node) {
241 		if (queue >= plat->tx_queues_to_use)
242 			break;
243 
244 		if (of_property_read_u32(q_node, "snps,weight",
245 					 &plat->tx_queues_cfg[queue].weight))
246 			plat->tx_queues_cfg[queue].weight = 0x10 + queue;
247 
248 		if (of_property_read_bool(q_node, "snps,dcb-algorithm")) {
249 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
250 		} else if (of_property_read_bool(q_node,
251 						 "snps,avb-algorithm")) {
252 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_AVB;
253 
254 			/* Credit Base Shaper parameters used by AVB */
255 			if (of_property_read_u32(q_node, "snps,send_slope",
256 				&plat->tx_queues_cfg[queue].send_slope))
257 				plat->tx_queues_cfg[queue].send_slope = 0x0;
258 			if (of_property_read_u32(q_node, "snps,idle_slope",
259 				&plat->tx_queues_cfg[queue].idle_slope))
260 				plat->tx_queues_cfg[queue].idle_slope = 0x0;
261 			if (of_property_read_u32(q_node, "snps,high_credit",
262 				&plat->tx_queues_cfg[queue].high_credit))
263 				plat->tx_queues_cfg[queue].high_credit = 0x0;
264 			if (of_property_read_u32(q_node, "snps,low_credit",
265 				&plat->tx_queues_cfg[queue].low_credit))
266 				plat->tx_queues_cfg[queue].low_credit = 0x0;
267 		} else {
268 			plat->tx_queues_cfg[queue].mode_to_use = MTL_QUEUE_DCB;
269 		}
270 
271 		if (of_property_read_u32(q_node, "snps,priority",
272 					&plat->tx_queues_cfg[queue].prio)) {
273 			plat->tx_queues_cfg[queue].prio = 0;
274 			plat->tx_queues_cfg[queue].use_prio = false;
275 		} else {
276 			plat->tx_queues_cfg[queue].use_prio = true;
277 		}
278 
279 		plat->tx_queues_cfg[queue].coe_unsupported =
280 			of_property_read_bool(q_node, "snps,coe-unsupported");
281 
282 		queue++;
283 	}
284 	if (queue != plat->tx_queues_to_use) {
285 		ret = -EINVAL;
286 		dev_err(&pdev->dev, "Not all TX queues were configured\n");
287 		goto out;
288 	}
289 
290 out:
291 	of_node_put(rx_node);
292 	of_node_put(tx_node);
293 	of_node_put(q_node);
294 
295 	return ret;
296 }
297 
298 /**
299  * stmmac_dt_phy - parse device-tree driver parameters to allocate PHY resources
300  * @plat: driver data platform structure
301  * @np: device tree node
302  * @dev: device pointer
303  * Description:
304  * The mdio bus will be allocated in case of a phy transceiver is on board;
305  * it will be NULL if the fixed-link is configured.
306  * If there is the "snps,dwmac-mdio" sub-node the mdio will be allocated
307  * in any case (for DSA, mdio must be registered even if fixed-link).
308  * The table below sums the supported configurations:
309  *	-------------------------------
310  *	snps,phy-addr	|     Y
311  *	-------------------------------
312  *	phy-handle	|     Y
313  *	-------------------------------
314  *	fixed-link	|     N
315  *	-------------------------------
316  *	snps,dwmac-mdio	|
317  *	  even if	|     Y
318  *	fixed-link	|
319  *	-------------------------------
320  *
321  * It returns 0 in case of success otherwise -ENODEV.
322  */
323 static int stmmac_dt_phy(struct plat_stmmacenet_data *plat,
324 			 struct device_node *np, struct device *dev)
325 {
326 	bool mdio = !of_phy_is_fixed_link(np);
327 	static const struct of_device_id need_mdio_ids[] = {
328 		{ .compatible = "snps,dwc-qos-ethernet-4.10" },
329 		{},
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 		if (!plat->mdio_bus_data)
356 			return -ENOMEM;
357 
358 		plat->mdio_bus_data->needs_reset = true;
359 	}
360 
361 	return 0;
362 }
363 
364 /**
365  * stmmac_of_get_mac_mode - retrieves the interface of the MAC
366  * @np: - device-tree node
367  * Description:
368  * Similar to `of_get_phy_mode()`, this function will retrieve (from
369  * the device-tree) the interface mode on the MAC side. This assumes
370  * that there is mode converter in-between the MAC & PHY
371  * (e.g. GMII-to-RGMII).
372  */
373 static int stmmac_of_get_mac_mode(struct device_node *np)
374 {
375 	const char *pm;
376 	int err, i;
377 
378 	err = of_property_read_string(np, "mac-mode", &pm);
379 	if (err < 0)
380 		return err;
381 
382 	for (i = 0; i < PHY_INTERFACE_MODE_MAX; i++) {
383 		if (!strcasecmp(pm, phy_modes(i)))
384 			return i;
385 	}
386 
387 	return -ENODEV;
388 }
389 
390 /**
391  * stmmac_probe_config_dt - parse device-tree driver parameters
392  * @pdev: platform_device structure
393  * @mac: MAC address to use
394  * Description:
395  * this function is to read the driver parameters from device-tree and
396  * set some private fields that will be used by the main at runtime.
397  */
398 struct plat_stmmacenet_data *
399 stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
400 {
401 	struct device_node *np = pdev->dev.of_node;
402 	struct plat_stmmacenet_data *plat;
403 	struct stmmac_dma_cfg *dma_cfg;
404 	int phy_mode;
405 	void *ret;
406 	int rc;
407 
408 	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
409 	if (!plat)
410 		return ERR_PTR(-ENOMEM);
411 
412 	rc = of_get_mac_address(np, mac);
413 	if (rc) {
414 		if (rc == -EPROBE_DEFER)
415 			return ERR_PTR(rc);
416 
417 		eth_zero_addr(mac);
418 	}
419 
420 	phy_mode = device_get_phy_mode(&pdev->dev);
421 	if (phy_mode < 0)
422 		return ERR_PTR(phy_mode);
423 
424 	plat->phy_interface = phy_mode;
425 	rc = stmmac_of_get_mac_mode(np);
426 	plat->mac_interface = rc < 0 ? plat->phy_interface : rc;
427 
428 	/* Some wrapper drivers still rely on phy_node. Let's save it while
429 	 * they are not converted to phylink. */
430 	plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
431 
432 	/* PHYLINK automatically parses the phy-handle property */
433 	plat->port_node = of_fwnode_handle(np);
434 
435 	/* Get max speed of operation from device tree */
436 	of_property_read_u32(np, "max-speed", &plat->max_speed);
437 
438 	plat->bus_id = of_alias_get_id(np, "ethernet");
439 	if (plat->bus_id < 0)
440 		plat->bus_id = 0;
441 
442 	/* Default to phy auto-detection */
443 	plat->phy_addr = -1;
444 
445 	/* Default to get clk_csr from stmmac_clk_csr_set(),
446 	 * or get clk_csr from device tree.
447 	 */
448 	plat->clk_csr = -1;
449 	if (of_property_read_u32(np, "snps,clk-csr", &plat->clk_csr))
450 		of_property_read_u32(np, "clk_csr", &plat->clk_csr);
451 
452 	/* "snps,phy-addr" is not a standard property. Mark it as deprecated
453 	 * and warn of its use. Remove this when phy node support is added.
454 	 */
455 	if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
456 		dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
457 
458 	/* To Configure PHY by using all device-tree supported properties */
459 	rc = stmmac_dt_phy(plat, np, &pdev->dev);
460 	if (rc)
461 		return ERR_PTR(rc);
462 
463 	of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
464 
465 	of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
466 
467 	plat->force_sf_dma_mode =
468 		of_property_read_bool(np, "snps,force_sf_dma_mode");
469 
470 	if (of_property_read_bool(np, "snps,en-tx-lpi-clockgating"))
471 		plat->flags |= STMMAC_FLAG_EN_TX_LPI_CLOCKGATING;
472 
473 	/* Set the maxmtu to a default of JUMBO_LEN in case the
474 	 * parameter is not present in the device tree.
475 	 */
476 	plat->maxmtu = JUMBO_LEN;
477 
478 	/* Set default value for multicast hash bins */
479 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
480 
481 	/* Set default value for unicast filter entries */
482 	plat->unicast_filter_entries = 1;
483 
484 	/*
485 	 * Currently only the properties needed on SPEAr600
486 	 * are provided. All other properties should be added
487 	 * once needed on other platforms.
488 	 */
489 	if (of_device_is_compatible(np, "st,spear600-gmac") ||
490 		of_device_is_compatible(np, "snps,dwmac-3.50a") ||
491 		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
492 		of_device_is_compatible(np, "snps,dwmac")) {
493 		/* Note that the max-frame-size parameter as defined in the
494 		 * ePAPR v1.1 spec is defined as max-frame-size, it's
495 		 * actually used as the IEEE definition of MAC Client
496 		 * data, or MTU. The ePAPR specification is confusing as
497 		 * the definition is max-frame-size, but usage examples
498 		 * are clearly MTUs
499 		 */
500 		of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
501 		of_property_read_u32(np, "snps,multicast-filter-bins",
502 				     &plat->multicast_filter_bins);
503 		of_property_read_u32(np, "snps,perfect-filter-entries",
504 				     &plat->unicast_filter_entries);
505 		plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
506 				&pdev->dev, plat->unicast_filter_entries);
507 		plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
508 				&pdev->dev, plat->multicast_filter_bins);
509 		plat->has_gmac = 1;
510 		plat->pmt = 1;
511 	}
512 
513 	if (of_device_is_compatible(np, "snps,dwmac-3.40a")) {
514 		plat->has_gmac = 1;
515 		plat->enh_desc = 1;
516 		plat->tx_coe = 1;
517 		plat->bugged_jumbo = 1;
518 		plat->pmt = 1;
519 	}
520 
521 	if (of_device_is_compatible(np, "snps,dwmac-4.00") ||
522 	    of_device_is_compatible(np, "snps,dwmac-4.10a") ||
523 	    of_device_is_compatible(np, "snps,dwmac-4.20a") ||
524 	    of_device_is_compatible(np, "snps,dwmac-5.10a") ||
525 	    of_device_is_compatible(np, "snps,dwmac-5.20")) {
526 		plat->has_gmac4 = 1;
527 		plat->has_gmac = 0;
528 		plat->pmt = 1;
529 		if (of_property_read_bool(np, "snps,tso"))
530 			plat->flags |= STMMAC_FLAG_TSO_EN;
531 	}
532 
533 	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
534 		of_device_is_compatible(np, "snps,dwmac-3.710")) {
535 		plat->enh_desc = 1;
536 		plat->bugged_jumbo = 1;
537 		plat->force_sf_dma_mode = 1;
538 	}
539 
540 	if (of_device_is_compatible(np, "snps,dwxgmac")) {
541 		plat->has_xgmac = 1;
542 		plat->pmt = 1;
543 		if (of_property_read_bool(np, "snps,tso"))
544 			plat->flags |= STMMAC_FLAG_TSO_EN;
545 	}
546 
547 	dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
548 			       GFP_KERNEL);
549 	if (!dma_cfg) {
550 		stmmac_remove_config_dt(pdev, plat);
551 		return ERR_PTR(-ENOMEM);
552 	}
553 	plat->dma_cfg = dma_cfg;
554 
555 	of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
556 	if (!dma_cfg->pbl)
557 		dma_cfg->pbl = DEFAULT_DMA_PBL;
558 	of_property_read_u32(np, "snps,txpbl", &dma_cfg->txpbl);
559 	of_property_read_u32(np, "snps,rxpbl", &dma_cfg->rxpbl);
560 	dma_cfg->pblx8 = !of_property_read_bool(np, "snps,no-pbl-x8");
561 
562 	dma_cfg->aal = of_property_read_bool(np, "snps,aal");
563 	dma_cfg->fixed_burst = of_property_read_bool(np, "snps,fixed-burst");
564 	dma_cfg->mixed_burst = of_property_read_bool(np, "snps,mixed-burst");
565 
566 	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
567 	if (plat->force_thresh_dma_mode && plat->force_sf_dma_mode) {
568 		plat->force_sf_dma_mode = 0;
569 		dev_warn(&pdev->dev,
570 			 "force_sf_dma_mode is ignored if force_thresh_dma_mode is set.\n");
571 	}
572 
573 	of_property_read_u32(np, "snps,ps-speed", &plat->mac_port_sel_speed);
574 
575 	plat->axi = stmmac_axi_setup(pdev);
576 
577 	rc = stmmac_mtl_setup(pdev, plat);
578 	if (rc) {
579 		stmmac_remove_config_dt(pdev, plat);
580 		return ERR_PTR(rc);
581 	}
582 
583 	/* clock setup */
584 	if (!of_device_is_compatible(np, "snps,dwc-qos-ethernet-4.10")) {
585 		plat->stmmac_clk = devm_clk_get(&pdev->dev,
586 						STMMAC_RESOURCE_NAME);
587 		if (IS_ERR(plat->stmmac_clk)) {
588 			dev_warn(&pdev->dev, "Cannot get CSR clock\n");
589 			plat->stmmac_clk = NULL;
590 		}
591 		clk_prepare_enable(plat->stmmac_clk);
592 	}
593 
594 	plat->pclk = devm_clk_get_optional(&pdev->dev, "pclk");
595 	if (IS_ERR(plat->pclk)) {
596 		ret = plat->pclk;
597 		goto error_pclk_get;
598 	}
599 	clk_prepare_enable(plat->pclk);
600 
601 	/* Fall-back to main clock in case of no PTP ref is passed */
602 	plat->clk_ptp_ref = devm_clk_get(&pdev->dev, "ptp_ref");
603 	if (IS_ERR(plat->clk_ptp_ref)) {
604 		plat->clk_ptp_rate = clk_get_rate(plat->stmmac_clk);
605 		plat->clk_ptp_ref = NULL;
606 		dev_info(&pdev->dev, "PTP uses main clock\n");
607 	} else {
608 		plat->clk_ptp_rate = clk_get_rate(plat->clk_ptp_ref);
609 		dev_dbg(&pdev->dev, "PTP rate %d\n", plat->clk_ptp_rate);
610 	}
611 
612 	plat->stmmac_rst = devm_reset_control_get_optional(&pdev->dev,
613 							   STMMAC_RESOURCE_NAME);
614 	if (IS_ERR(plat->stmmac_rst)) {
615 		ret = plat->stmmac_rst;
616 		goto error_hw_init;
617 	}
618 
619 	plat->stmmac_ahb_rst = devm_reset_control_get_optional_shared(
620 							&pdev->dev, "ahb");
621 	if (IS_ERR(plat->stmmac_ahb_rst)) {
622 		ret = plat->stmmac_ahb_rst;
623 		goto error_hw_init;
624 	}
625 
626 	return plat;
627 
628 error_hw_init:
629 	clk_disable_unprepare(plat->pclk);
630 error_pclk_get:
631 	clk_disable_unprepare(plat->stmmac_clk);
632 
633 	return ret;
634 }
635 
636 static void devm_stmmac_remove_config_dt(void *data)
637 {
638 	struct plat_stmmacenet_data *plat = data;
639 
640 	/* Platform data argument is unused */
641 	stmmac_remove_config_dt(NULL, plat);
642 }
643 
644 /**
645  * devm_stmmac_probe_config_dt
646  * @pdev: platform_device structure
647  * @mac: MAC address to use
648  * Description: Devres variant of stmmac_probe_config_dt(). Does not require
649  * the user to call stmmac_remove_config_dt() at driver detach.
650  */
651 struct plat_stmmacenet_data *
652 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
653 {
654 	struct plat_stmmacenet_data *plat;
655 	int ret;
656 
657 	plat = stmmac_probe_config_dt(pdev, mac);
658 	if (IS_ERR(plat))
659 		return plat;
660 
661 	ret = devm_add_action_or_reset(&pdev->dev,
662 				       devm_stmmac_remove_config_dt, plat);
663 	if (ret)
664 		return ERR_PTR(ret);
665 
666 	return plat;
667 }
668 
669 /**
670  * stmmac_remove_config_dt - undo the effects of stmmac_probe_config_dt()
671  * @pdev: platform_device structure
672  * @plat: driver data platform structure
673  *
674  * Release resources claimed by stmmac_probe_config_dt().
675  */
676 void stmmac_remove_config_dt(struct platform_device *pdev,
677 			     struct plat_stmmacenet_data *plat)
678 {
679 	clk_disable_unprepare(plat->stmmac_clk);
680 	clk_disable_unprepare(plat->pclk);
681 	of_node_put(plat->phy_node);
682 	of_node_put(plat->mdio_node);
683 }
684 #else
685 struct plat_stmmacenet_data *
686 stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
687 {
688 	return ERR_PTR(-EINVAL);
689 }
690 
691 struct plat_stmmacenet_data *
692 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
693 {
694 	return ERR_PTR(-EINVAL);
695 }
696 
697 void stmmac_remove_config_dt(struct platform_device *pdev,
698 			     struct plat_stmmacenet_data *plat)
699 {
700 }
701 #endif /* CONFIG_OF */
702 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
703 EXPORT_SYMBOL_GPL(devm_stmmac_probe_config_dt);
704 EXPORT_SYMBOL_GPL(stmmac_remove_config_dt);
705 
706 int stmmac_get_platform_resources(struct platform_device *pdev,
707 				  struct stmmac_resources *stmmac_res)
708 {
709 	memset(stmmac_res, 0, sizeof(*stmmac_res));
710 
711 	/* Get IRQ information early to have an ability to ask for deferred
712 	 * probe if needed before we went too far with resource allocation.
713 	 */
714 	stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
715 	if (stmmac_res->irq < 0)
716 		return stmmac_res->irq;
717 
718 	/* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
719 	 * The external wake up irq can be passed through the platform code
720 	 * named as "eth_wake_irq"
721 	 *
722 	 * In case the wake up interrupt is not passed from the platform
723 	 * so the driver will continue to use the mac irq (ndev->irq)
724 	 */
725 	stmmac_res->wol_irq =
726 		platform_get_irq_byname_optional(pdev, "eth_wake_irq");
727 	if (stmmac_res->wol_irq < 0) {
728 		if (stmmac_res->wol_irq == -EPROBE_DEFER)
729 			return -EPROBE_DEFER;
730 		dev_info(&pdev->dev, "IRQ eth_wake_irq not found\n");
731 		stmmac_res->wol_irq = stmmac_res->irq;
732 	}
733 
734 	stmmac_res->lpi_irq =
735 		platform_get_irq_byname_optional(pdev, "eth_lpi");
736 	if (stmmac_res->lpi_irq < 0) {
737 		if (stmmac_res->lpi_irq == -EPROBE_DEFER)
738 			return -EPROBE_DEFER;
739 		dev_info(&pdev->dev, "IRQ eth_lpi not found\n");
740 	}
741 
742 	stmmac_res->addr = devm_platform_ioremap_resource(pdev, 0);
743 
744 	return PTR_ERR_OR_ZERO(stmmac_res->addr);
745 }
746 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
747 
748 /**
749  * stmmac_pltfr_init
750  * @pdev: pointer to the platform device
751  * @plat: driver data platform structure
752  * Description: Call the platform's init callback (if any) and propagate
753  * the return value.
754  */
755 int stmmac_pltfr_init(struct platform_device *pdev,
756 		      struct plat_stmmacenet_data *plat)
757 {
758 	int ret = 0;
759 
760 	if (plat->init)
761 		ret = plat->init(pdev, plat->bsp_priv);
762 
763 	return ret;
764 }
765 EXPORT_SYMBOL_GPL(stmmac_pltfr_init);
766 
767 /**
768  * stmmac_pltfr_exit
769  * @pdev: pointer to the platform device
770  * @plat: driver data platform structure
771  * Description: Call the platform's exit callback (if any).
772  */
773 void stmmac_pltfr_exit(struct platform_device *pdev,
774 		       struct plat_stmmacenet_data *plat)
775 {
776 	if (plat->exit)
777 		plat->exit(pdev, plat->bsp_priv);
778 }
779 EXPORT_SYMBOL_GPL(stmmac_pltfr_exit);
780 
781 /**
782  * stmmac_pltfr_probe
783  * @pdev: platform device pointer
784  * @plat: driver data platform structure
785  * @res: stmmac resources structure
786  * Description: This calls the platform's init() callback and probes the
787  * stmmac driver.
788  */
789 int stmmac_pltfr_probe(struct platform_device *pdev,
790 		       struct plat_stmmacenet_data *plat,
791 		       struct stmmac_resources *res)
792 {
793 	int ret;
794 
795 	ret = stmmac_pltfr_init(pdev, plat);
796 	if (ret)
797 		return ret;
798 
799 	ret = stmmac_dvr_probe(&pdev->dev, plat, res);
800 	if (ret) {
801 		stmmac_pltfr_exit(pdev, plat);
802 		return ret;
803 	}
804 
805 	return ret;
806 }
807 EXPORT_SYMBOL_GPL(stmmac_pltfr_probe);
808 
809 static void devm_stmmac_pltfr_remove(void *data)
810 {
811 	struct platform_device *pdev = data;
812 
813 	stmmac_pltfr_remove_no_dt(pdev);
814 }
815 
816 /**
817  * devm_stmmac_pltfr_probe
818  * @pdev: pointer to the platform device
819  * @plat: driver data platform structure
820  * @res: stmmac resources
821  * Description: Devres variant of stmmac_pltfr_probe(). Allows users to skip
822  * calling stmmac_pltfr_remove() on driver detach.
823  */
824 int devm_stmmac_pltfr_probe(struct platform_device *pdev,
825 			    struct plat_stmmacenet_data *plat,
826 			    struct stmmac_resources *res)
827 {
828 	int ret;
829 
830 	ret = stmmac_pltfr_probe(pdev, plat, res);
831 	if (ret)
832 		return ret;
833 
834 	return devm_add_action_or_reset(&pdev->dev, devm_stmmac_pltfr_remove,
835 					pdev);
836 }
837 EXPORT_SYMBOL_GPL(devm_stmmac_pltfr_probe);
838 
839 /**
840  * stmmac_pltfr_remove_no_dt
841  * @pdev: pointer to the platform device
842  * Description: This undoes the effects of stmmac_pltfr_probe() by removing the
843  * driver and calling the platform's exit() callback.
844  */
845 void stmmac_pltfr_remove_no_dt(struct platform_device *pdev)
846 {
847 	struct net_device *ndev = platform_get_drvdata(pdev);
848 	struct stmmac_priv *priv = netdev_priv(ndev);
849 	struct plat_stmmacenet_data *plat = priv->plat;
850 
851 	stmmac_dvr_remove(&pdev->dev);
852 	stmmac_pltfr_exit(pdev, plat);
853 }
854 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove_no_dt);
855 
856 /**
857  * stmmac_pltfr_remove
858  * @pdev: platform device pointer
859  * Description: this function calls the main to free the net resources
860  * and calls the platforms hook and release the resources (e.g. mem).
861  */
862 void stmmac_pltfr_remove(struct platform_device *pdev)
863 {
864 	struct net_device *ndev = platform_get_drvdata(pdev);
865 	struct stmmac_priv *priv = netdev_priv(ndev);
866 	struct plat_stmmacenet_data *plat = priv->plat;
867 
868 	stmmac_pltfr_remove_no_dt(pdev);
869 	stmmac_remove_config_dt(pdev, plat);
870 }
871 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
872 
873 /**
874  * stmmac_pltfr_suspend
875  * @dev: device pointer
876  * Description: this function is invoked when suspend the driver and it direcly
877  * call the main suspend function and then, if required, on some platform, it
878  * can call an exit helper.
879  */
880 static int __maybe_unused stmmac_pltfr_suspend(struct device *dev)
881 {
882 	int ret;
883 	struct net_device *ndev = dev_get_drvdata(dev);
884 	struct stmmac_priv *priv = netdev_priv(ndev);
885 	struct platform_device *pdev = to_platform_device(dev);
886 
887 	ret = stmmac_suspend(dev);
888 	stmmac_pltfr_exit(pdev, priv->plat);
889 
890 	return ret;
891 }
892 
893 /**
894  * stmmac_pltfr_resume
895  * @dev: device pointer
896  * Description: this function is invoked when resume the driver before calling
897  * the main resume function, on some platforms, it can call own init helper
898  * if required.
899  */
900 static int __maybe_unused stmmac_pltfr_resume(struct device *dev)
901 {
902 	struct net_device *ndev = dev_get_drvdata(dev);
903 	struct stmmac_priv *priv = netdev_priv(ndev);
904 	struct platform_device *pdev = to_platform_device(dev);
905 	int ret;
906 
907 	ret = stmmac_pltfr_init(pdev, priv->plat);
908 	if (ret)
909 		return ret;
910 
911 	return stmmac_resume(dev);
912 }
913 
914 static int __maybe_unused stmmac_runtime_suspend(struct device *dev)
915 {
916 	struct net_device *ndev = dev_get_drvdata(dev);
917 	struct stmmac_priv *priv = netdev_priv(ndev);
918 
919 	stmmac_bus_clks_config(priv, false);
920 
921 	return 0;
922 }
923 
924 static int __maybe_unused stmmac_runtime_resume(struct device *dev)
925 {
926 	struct net_device *ndev = dev_get_drvdata(dev);
927 	struct stmmac_priv *priv = netdev_priv(ndev);
928 
929 	return stmmac_bus_clks_config(priv, true);
930 }
931 
932 static int __maybe_unused stmmac_pltfr_noirq_suspend(struct device *dev)
933 {
934 	struct net_device *ndev = dev_get_drvdata(dev);
935 	struct stmmac_priv *priv = netdev_priv(ndev);
936 	int ret;
937 
938 	if (!netif_running(ndev))
939 		return 0;
940 
941 	if (!device_may_wakeup(priv->device) || !priv->plat->pmt) {
942 		/* Disable clock in case of PWM is off */
943 		clk_disable_unprepare(priv->plat->clk_ptp_ref);
944 
945 		ret = pm_runtime_force_suspend(dev);
946 		if (ret)
947 			return ret;
948 	}
949 
950 	return 0;
951 }
952 
953 static int __maybe_unused stmmac_pltfr_noirq_resume(struct device *dev)
954 {
955 	struct net_device *ndev = dev_get_drvdata(dev);
956 	struct stmmac_priv *priv = netdev_priv(ndev);
957 	int ret;
958 
959 	if (!netif_running(ndev))
960 		return 0;
961 
962 	if (!device_may_wakeup(priv->device) || !priv->plat->pmt) {
963 		/* enable the clk previously disabled */
964 		ret = pm_runtime_force_resume(dev);
965 		if (ret)
966 			return ret;
967 
968 		ret = clk_prepare_enable(priv->plat->clk_ptp_ref);
969 		if (ret < 0) {
970 			netdev_warn(priv->dev,
971 				    "failed to enable PTP reference clock: %pe\n",
972 				    ERR_PTR(ret));
973 			return ret;
974 		}
975 	}
976 
977 	return 0;
978 }
979 
980 const struct dev_pm_ops stmmac_pltfr_pm_ops = {
981 	SET_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_suspend, stmmac_pltfr_resume)
982 	SET_RUNTIME_PM_OPS(stmmac_runtime_suspend, stmmac_runtime_resume, NULL)
983 	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(stmmac_pltfr_noirq_suspend, stmmac_pltfr_noirq_resume)
984 };
985 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
986 
987 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
988 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
989 MODULE_LICENSE("GPL");
990