1 /*******************************************************************************
2   This contains the functions to handle the platform driver.
3 
4   Copyright (C) 2007-2011  STMicroelectronics Ltd
5 
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9 
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14 
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21 
22   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
24 
25 #include <linux/platform_device.h>
26 #include <linux/module.h>
27 #include <linux/io.h>
28 #include <linux/of.h>
29 #include <linux/of_net.h>
30 #include <linux/of_device.h>
31 #include <linux/of_mdio.h>
32 
33 #include "stmmac.h"
34 #include "stmmac_platform.h"
35 
36 #ifdef CONFIG_OF
37 
38 /**
39  * dwmac1000_validate_mcast_bins - validates the number of Multicast filter bins
40  * @mcast_bins: Multicast filtering bins
41  * Description:
42  * this function validates the number of Multicast filtering bins specified
43  * by the configuration through the device tree. The Synopsys GMAC supports
44  * 64 bins, 128 bins, or 256 bins. "bins" refer to the division of CRC
45  * number space. 64 bins correspond to 6 bits of the CRC, 128 corresponds
46  * to 7 bits, and 256 refers to 8 bits of the CRC. Any other setting is
47  * invalid and will cause the filtering algorithm to use Multicast
48  * promiscuous mode.
49  */
50 static int dwmac1000_validate_mcast_bins(int mcast_bins)
51 {
52 	int x = mcast_bins;
53 
54 	switch (x) {
55 	case HASH_TABLE_SIZE:
56 	case 128:
57 	case 256:
58 		break;
59 	default:
60 		x = 0;
61 		pr_info("Hash table entries set to unexpected value %d",
62 			mcast_bins);
63 		break;
64 	}
65 	return x;
66 }
67 
68 /**
69  * dwmac1000_validate_ucast_entries - validate the Unicast address entries
70  * @ucast_entries: number of Unicast address entries
71  * Description:
72  * This function validates the number of Unicast address entries supported
73  * by a particular Synopsys 10/100/1000 controller. The Synopsys controller
74  * supports 1, 32, 64, or 128 Unicast filter entries for it's Unicast filter
75  * logic. This function validates a valid, supported configuration is
76  * selected, and defaults to 1 Unicast address if an unsupported
77  * configuration is selected.
78  */
79 static int dwmac1000_validate_ucast_entries(int ucast_entries)
80 {
81 	int x = ucast_entries;
82 
83 	switch (x) {
84 	case 1:
85 	case 32:
86 	case 64:
87 	case 128:
88 		break;
89 	default:
90 		x = 1;
91 		pr_info("Unicast table entries set to unexpected value %d\n",
92 			ucast_entries);
93 		break;
94 	}
95 	return x;
96 }
97 
98 /**
99  * stmmac_probe_config_dt - parse device-tree driver parameters
100  * @pdev: platform_device structure
101  * @plat: driver data platform structure
102  * @mac: MAC address to use
103  * Description:
104  * this function is to read the driver parameters from device-tree and
105  * set some private fields that will be used by the main at runtime.
106  */
107 struct plat_stmmacenet_data *
108 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
109 {
110 	struct device_node *np = pdev->dev.of_node;
111 	struct plat_stmmacenet_data *plat;
112 	struct stmmac_dma_cfg *dma_cfg;
113 	struct device_node *child_node = NULL;
114 
115 	plat = devm_kzalloc(&pdev->dev, sizeof(*plat), GFP_KERNEL);
116 	if (!plat)
117 		return ERR_PTR(-ENOMEM);
118 
119 	*mac = of_get_mac_address(np);
120 	plat->interface = of_get_phy_mode(np);
121 
122 	/* Get max speed of operation from device tree */
123 	if (of_property_read_u32(np, "max-speed", &plat->max_speed))
124 		plat->max_speed = -1;
125 
126 	plat->bus_id = of_alias_get_id(np, "ethernet");
127 	if (plat->bus_id < 0)
128 		plat->bus_id = 0;
129 
130 	/* Default to phy auto-detection */
131 	plat->phy_addr = -1;
132 
133 	/* If we find a phy-handle property, use it as the PHY */
134 	plat->phy_node = of_parse_phandle(np, "phy-handle", 0);
135 
136 	/* If phy-handle is not specified, check if we have a fixed-phy */
137 	if (!plat->phy_node && of_phy_is_fixed_link(np)) {
138 		if ((of_phy_register_fixed_link(np) < 0))
139 			return ERR_PTR(-ENODEV);
140 
141 		plat->phy_node = of_node_get(np);
142 	}
143 
144 	for_each_child_of_node(np, child_node)
145 		if (of_device_is_compatible(child_node,	"snps,dwmac-mdio")) {
146 			plat->mdio_node = child_node;
147 			break;
148 		}
149 
150 	/* "snps,phy-addr" is not a standard property. Mark it as deprecated
151 	 * and warn of its use. Remove this when phy node support is added.
152 	 */
153 	if (of_property_read_u32(np, "snps,phy-addr", &plat->phy_addr) == 0)
154 		dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
155 
156 	if ((plat->phy_node && !of_phy_is_fixed_link(np)) || !plat->mdio_node)
157 		plat->mdio_bus_data = NULL;
158 	else
159 		plat->mdio_bus_data =
160 			devm_kzalloc(&pdev->dev,
161 				     sizeof(struct stmmac_mdio_bus_data),
162 				     GFP_KERNEL);
163 
164 	of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
165 
166 	of_property_read_u32(np, "rx-fifo-depth", &plat->rx_fifo_size);
167 
168 	plat->force_sf_dma_mode =
169 		of_property_read_bool(np, "snps,force_sf_dma_mode");
170 
171 	/* Set the maxmtu to a default of JUMBO_LEN in case the
172 	 * parameter is not present in the device tree.
173 	 */
174 	plat->maxmtu = JUMBO_LEN;
175 
176 	/* Set default value for multicast hash bins */
177 	plat->multicast_filter_bins = HASH_TABLE_SIZE;
178 
179 	/* Set default value for unicast filter entries */
180 	plat->unicast_filter_entries = 1;
181 
182 	/*
183 	 * Currently only the properties needed on SPEAr600
184 	 * are provided. All other properties should be added
185 	 * once needed on other platforms.
186 	 */
187 	if (of_device_is_compatible(np, "st,spear600-gmac") ||
188 		of_device_is_compatible(np, "snps,dwmac-3.70a") ||
189 		of_device_is_compatible(np, "snps,dwmac")) {
190 		/* Note that the max-frame-size parameter as defined in the
191 		 * ePAPR v1.1 spec is defined as max-frame-size, it's
192 		 * actually used as the IEEE definition of MAC Client
193 		 * data, or MTU. The ePAPR specification is confusing as
194 		 * the definition is max-frame-size, but usage examples
195 		 * are clearly MTUs
196 		 */
197 		of_property_read_u32(np, "max-frame-size", &plat->maxmtu);
198 		of_property_read_u32(np, "snps,multicast-filter-bins",
199 				     &plat->multicast_filter_bins);
200 		of_property_read_u32(np, "snps,perfect-filter-entries",
201 				     &plat->unicast_filter_entries);
202 		plat->unicast_filter_entries = dwmac1000_validate_ucast_entries(
203 					       plat->unicast_filter_entries);
204 		plat->multicast_filter_bins = dwmac1000_validate_mcast_bins(
205 					      plat->multicast_filter_bins);
206 		plat->has_gmac = 1;
207 		plat->pmt = 1;
208 	}
209 
210 	if (of_device_is_compatible(np, "snps,dwmac-3.610") ||
211 		of_device_is_compatible(np, "snps,dwmac-3.710")) {
212 		plat->enh_desc = 1;
213 		plat->bugged_jumbo = 1;
214 		plat->force_sf_dma_mode = 1;
215 	}
216 
217 	if (of_find_property(np, "snps,pbl", NULL)) {
218 		dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
219 				       GFP_KERNEL);
220 		if (!dma_cfg) {
221 			of_node_put(np);
222 			return ERR_PTR(-ENOMEM);
223 		}
224 		plat->dma_cfg = dma_cfg;
225 		of_property_read_u32(np, "snps,pbl", &dma_cfg->pbl);
226 		dma_cfg->fixed_burst =
227 			of_property_read_bool(np, "snps,fixed-burst");
228 		dma_cfg->mixed_burst =
229 			of_property_read_bool(np, "snps,mixed-burst");
230 		of_property_read_u32(np, "snps,burst_len", &dma_cfg->burst_len);
231 		if (dma_cfg->burst_len < 0 || dma_cfg->burst_len > 256)
232 			dma_cfg->burst_len = 0;
233 	}
234 	plat->force_thresh_dma_mode = of_property_read_bool(np, "snps,force_thresh_dma_mode");
235 	if (plat->force_thresh_dma_mode) {
236 		plat->force_sf_dma_mode = 0;
237 		pr_warn("force_sf_dma_mode is ignored if force_thresh_dma_mode is set.");
238 	}
239 
240 	return plat;
241 }
242 #else
243 struct plat_stmmacenet_data *
244 stmmac_probe_config_dt(struct platform_device *pdev, const char **mac)
245 {
246 	return ERR_PTR(-ENOSYS);
247 }
248 #endif /* CONFIG_OF */
249 EXPORT_SYMBOL_GPL(stmmac_probe_config_dt);
250 
251 int stmmac_get_platform_resources(struct platform_device *pdev,
252 				  struct stmmac_resources *stmmac_res)
253 {
254 	struct resource *res;
255 
256 	memset(stmmac_res, 0, sizeof(*stmmac_res));
257 
258 	/* Get IRQ information early to have an ability to ask for deferred
259 	 * probe if needed before we went too far with resource allocation.
260 	 */
261 	stmmac_res->irq = platform_get_irq_byname(pdev, "macirq");
262 	if (stmmac_res->irq < 0) {
263 		if (stmmac_res->irq != -EPROBE_DEFER) {
264 			dev_err(&pdev->dev,
265 				"MAC IRQ configuration information not found\n");
266 		}
267 		return stmmac_res->irq;
268 	}
269 
270 	/* On some platforms e.g. SPEAr the wake up irq differs from the mac irq
271 	 * The external wake up irq can be passed through the platform code
272 	 * named as "eth_wake_irq"
273 	 *
274 	 * In case the wake up interrupt is not passed from the platform
275 	 * so the driver will continue to use the mac irq (ndev->irq)
276 	 */
277 	stmmac_res->wol_irq = platform_get_irq_byname(pdev, "eth_wake_irq");
278 	if (stmmac_res->wol_irq < 0) {
279 		if (stmmac_res->wol_irq == -EPROBE_DEFER)
280 			return -EPROBE_DEFER;
281 		stmmac_res->wol_irq = stmmac_res->irq;
282 	}
283 
284 	stmmac_res->lpi_irq = platform_get_irq_byname(pdev, "eth_lpi");
285 	if (stmmac_res->lpi_irq == -EPROBE_DEFER)
286 		return -EPROBE_DEFER;
287 
288 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
289 	stmmac_res->addr = devm_ioremap_resource(&pdev->dev, res);
290 
291 	return PTR_ERR_OR_ZERO(stmmac_res->addr);
292 }
293 EXPORT_SYMBOL_GPL(stmmac_get_platform_resources);
294 
295 /**
296  * stmmac_pltfr_remove
297  * @pdev: platform device pointer
298  * Description: this function calls the main to free the net resources
299  * and calls the platforms hook and release the resources (e.g. mem).
300  */
301 int stmmac_pltfr_remove(struct platform_device *pdev)
302 {
303 	struct net_device *ndev = platform_get_drvdata(pdev);
304 	struct stmmac_priv *priv = netdev_priv(ndev);
305 	int ret = stmmac_dvr_remove(ndev);
306 
307 	if (priv->plat->exit)
308 		priv->plat->exit(pdev, priv->plat->bsp_priv);
309 
310 	return ret;
311 }
312 EXPORT_SYMBOL_GPL(stmmac_pltfr_remove);
313 
314 #ifdef CONFIG_PM_SLEEP
315 /**
316  * stmmac_pltfr_suspend
317  * @dev: device pointer
318  * Description: this function is invoked when suspend the driver and it direcly
319  * call the main suspend function and then, if required, on some platform, it
320  * can call an exit helper.
321  */
322 static int stmmac_pltfr_suspend(struct device *dev)
323 {
324 	int ret;
325 	struct net_device *ndev = dev_get_drvdata(dev);
326 	struct stmmac_priv *priv = netdev_priv(ndev);
327 	struct platform_device *pdev = to_platform_device(dev);
328 
329 	ret = stmmac_suspend(ndev);
330 	if (priv->plat->exit)
331 		priv->plat->exit(pdev, priv->plat->bsp_priv);
332 
333 	return ret;
334 }
335 
336 /**
337  * stmmac_pltfr_resume
338  * @dev: device pointer
339  * Description: this function is invoked when resume the driver before calling
340  * the main resume function, on some platforms, it can call own init helper
341  * if required.
342  */
343 static int stmmac_pltfr_resume(struct device *dev)
344 {
345 	struct net_device *ndev = dev_get_drvdata(dev);
346 	struct stmmac_priv *priv = netdev_priv(ndev);
347 	struct platform_device *pdev = to_platform_device(dev);
348 
349 	if (priv->plat->init)
350 		priv->plat->init(pdev, priv->plat->bsp_priv);
351 
352 	return stmmac_resume(ndev);
353 }
354 #endif /* CONFIG_PM_SLEEP */
355 
356 SIMPLE_DEV_PM_OPS(stmmac_pltfr_pm_ops, stmmac_pltfr_suspend,
357 				       stmmac_pltfr_resume);
358 EXPORT_SYMBOL_GPL(stmmac_pltfr_pm_ops);
359 
360 MODULE_DESCRIPTION("STMMAC 10/100/1000 Ethernet platform support");
361 MODULE_AUTHOR("Giuseppe Cavallaro <peppe.cavallaro@st.com>");
362 MODULE_LICENSE("GPL");
363