xref: /linux/drivers/usb/host/ohci-platform.c (revision 905e46acd3272d04566fec49afbd7ad9e2ed9ae3)
1 /*
2  * Generic platform ohci driver
3  *
4  * Copyright 2007 Michael Buesch <m@bues.ch>
5  * Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de>
6  * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
7  *
8  * Derived from the OCHI-SSB driver
9  * Derived from the OHCI-PCI driver
10  * Copyright 1999 Roman Weissgaerber
11  * Copyright 2000-2002 David Brownell
12  * Copyright 1999 Linus Torvalds
13  * Copyright 1999 Gregory P. Smith
14  *
15  * Licensed under the GNU/GPL. See COPYING for details.
16  */
17 
18 #include <linux/clk.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/hrtimer.h>
21 #include <linux/io.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/err.h>
25 #include <linux/phy/phy.h>
26 #include <linux/platform_device.h>
27 #include <linux/reset.h>
28 #include <linux/usb/ohci_pdriver.h>
29 #include <linux/usb.h>
30 #include <linux/usb/hcd.h>
31 
32 #include "ohci.h"
33 
34 #define DRIVER_DESC "OHCI generic platform driver"
35 #define OHCI_MAX_CLKS 3
36 #define OHCI_MAX_RESETS 2
37 #define hcd_to_ohci_priv(h) ((struct ohci_platform_priv *)hcd_to_ohci(h)->priv)
38 
39 struct ohci_platform_priv {
40 	struct clk *clks[OHCI_MAX_CLKS];
41 	struct reset_control *resets[OHCI_MAX_RESETS];
42 	struct phy **phys;
43 	int num_phys;
44 };
45 
46 static const char hcd_name[] = "ohci-platform";
47 
48 static int ohci_platform_power_on(struct platform_device *dev)
49 {
50 	struct usb_hcd *hcd = platform_get_drvdata(dev);
51 	struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
52 	int clk, ret, phy_num;
53 
54 	for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++) {
55 		ret = clk_prepare_enable(priv->clks[clk]);
56 		if (ret)
57 			goto err_disable_clks;
58 	}
59 
60 	for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
61 		ret = phy_init(priv->phys[phy_num]);
62 		if (ret)
63 			goto err_exit_phy;
64 		ret = phy_power_on(priv->phys[phy_num]);
65 		if (ret) {
66 			phy_exit(priv->phys[phy_num]);
67 			goto err_exit_phy;
68 		}
69 	}
70 
71 	return 0;
72 
73 err_exit_phy:
74 	while (--phy_num >= 0) {
75 		phy_power_off(priv->phys[phy_num]);
76 		phy_exit(priv->phys[phy_num]);
77 	}
78 err_disable_clks:
79 	while (--clk >= 0)
80 		clk_disable_unprepare(priv->clks[clk]);
81 
82 	return ret;
83 }
84 
85 static void ohci_platform_power_off(struct platform_device *dev)
86 {
87 	struct usb_hcd *hcd = platform_get_drvdata(dev);
88 	struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
89 	int clk, phy_num;
90 
91 	for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
92 		phy_power_off(priv->phys[phy_num]);
93 		phy_exit(priv->phys[phy_num]);
94 	}
95 
96 	for (clk = OHCI_MAX_CLKS - 1; clk >= 0; clk--)
97 		if (priv->clks[clk])
98 			clk_disable_unprepare(priv->clks[clk]);
99 }
100 
101 static struct hc_driver __read_mostly ohci_platform_hc_driver;
102 
103 static const struct ohci_driver_overrides platform_overrides __initconst = {
104 	.product_desc =		"Generic Platform OHCI controller",
105 	.extra_priv_size =	sizeof(struct ohci_platform_priv),
106 };
107 
108 static struct usb_ohci_pdata ohci_platform_defaults = {
109 	.power_on =		ohci_platform_power_on,
110 	.power_suspend =	ohci_platform_power_off,
111 	.power_off =		ohci_platform_power_off,
112 };
113 
114 static int ohci_platform_probe(struct platform_device *dev)
115 {
116 	struct usb_hcd *hcd;
117 	struct resource *res_mem;
118 	struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
119 	struct ohci_platform_priv *priv;
120 	struct ohci_hcd *ohci;
121 	int err, irq, phy_num, clk = 0, rst = 0;
122 
123 	if (usb_disabled())
124 		return -ENODEV;
125 
126 	/*
127 	 * Use reasonable defaults so platforms don't have to provide these
128 	 * with DT probing on ARM.
129 	 */
130 	if (!pdata)
131 		pdata = &ohci_platform_defaults;
132 
133 	err = dma_coerce_mask_and_coherent(&dev->dev, DMA_BIT_MASK(32));
134 	if (err)
135 		return err;
136 
137 	irq = platform_get_irq(dev, 0);
138 	if (irq < 0) {
139 		dev_err(&dev->dev, "no irq provided");
140 		return irq;
141 	}
142 
143 	hcd = usb_create_hcd(&ohci_platform_hc_driver, &dev->dev,
144 			dev_name(&dev->dev));
145 	if (!hcd)
146 		return -ENOMEM;
147 
148 	platform_set_drvdata(dev, hcd);
149 	dev->dev.platform_data = pdata;
150 	priv = hcd_to_ohci_priv(hcd);
151 	ohci = hcd_to_ohci(hcd);
152 
153 	if (pdata == &ohci_platform_defaults && dev->dev.of_node) {
154 		if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
155 			ohci->flags |= OHCI_QUIRK_BE_MMIO;
156 
157 		if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
158 			ohci->flags |= OHCI_QUIRK_BE_DESC;
159 
160 		if (of_property_read_bool(dev->dev.of_node, "big-endian"))
161 			ohci->flags |= OHCI_QUIRK_BE_MMIO | OHCI_QUIRK_BE_DESC;
162 
163 		if (of_property_read_bool(dev->dev.of_node, "no-big-frame-no"))
164 			ohci->flags |= OHCI_QUIRK_FRAME_NO;
165 
166 		of_property_read_u32(dev->dev.of_node, "num-ports",
167 				     &ohci->num_ports);
168 
169 		priv->num_phys = of_count_phandle_with_args(dev->dev.of_node,
170 				"phys", "#phy-cells");
171 
172 		if (priv->num_phys > 0) {
173 			priv->phys = devm_kcalloc(&dev->dev, priv->num_phys,
174 					    sizeof(struct phy *), GFP_KERNEL);
175 			if (!priv->phys)
176 				return -ENOMEM;
177 		} else
178 			priv->num_phys = 0;
179 
180 		for (phy_num = 0; phy_num < priv->num_phys; phy_num++) {
181 			priv->phys[phy_num] = devm_of_phy_get_by_index(
182 					&dev->dev, dev->dev.of_node, phy_num);
183 			if (IS_ERR(priv->phys[phy_num])) {
184 				err = PTR_ERR(priv->phys[phy_num]);
185 				goto err_put_hcd;
186 			} else if (!hcd->phy) {
187 				/* Avoiding phy_get() in usb_add_hcd() */
188 				hcd->phy = priv->phys[phy_num];
189 			}
190 		}
191 
192 		for (clk = 0; clk < OHCI_MAX_CLKS; clk++) {
193 			priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
194 			if (IS_ERR(priv->clks[clk])) {
195 				err = PTR_ERR(priv->clks[clk]);
196 				if (err == -EPROBE_DEFER)
197 					goto err_put_clks;
198 				priv->clks[clk] = NULL;
199 				break;
200 			}
201 		}
202 		for (rst = 0; rst < OHCI_MAX_RESETS; rst++) {
203 			priv->resets[rst] =
204 				devm_reset_control_get_shared_by_index(
205 								&dev->dev, rst);
206 			if (IS_ERR(priv->resets[rst])) {
207 				err = PTR_ERR(priv->resets[rst]);
208 				if (err == -EPROBE_DEFER)
209 					goto err_reset;
210 				priv->resets[rst] = NULL;
211 				break;
212 			}
213 			err = reset_control_deassert(priv->resets[rst]);
214 			if (err)
215 				goto err_reset;
216 		}
217 	}
218 
219 	if (pdata->big_endian_desc)
220 		ohci->flags |= OHCI_QUIRK_BE_DESC;
221 	if (pdata->big_endian_mmio)
222 		ohci->flags |= OHCI_QUIRK_BE_MMIO;
223 	if (pdata->no_big_frame_no)
224 		ohci->flags |= OHCI_QUIRK_FRAME_NO;
225 	if (pdata->num_ports)
226 		ohci->num_ports = pdata->num_ports;
227 
228 #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
229 	if (ohci->flags & OHCI_QUIRK_BE_MMIO) {
230 		dev_err(&dev->dev,
231 			"Error: CONFIG_USB_OHCI_BIG_ENDIAN_MMIO not set\n");
232 		err = -EINVAL;
233 		goto err_reset;
234 	}
235 #endif
236 #ifndef CONFIG_USB_OHCI_BIG_ENDIAN_DESC
237 	if (ohci->flags & OHCI_QUIRK_BE_DESC) {
238 		dev_err(&dev->dev,
239 			"Error: CONFIG_USB_OHCI_BIG_ENDIAN_DESC not set\n");
240 		err = -EINVAL;
241 		goto err_reset;
242 	}
243 #endif
244 
245 	if (pdata->power_on) {
246 		err = pdata->power_on(dev);
247 		if (err < 0)
248 			goto err_reset;
249 	}
250 
251 	res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
252 	hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
253 	if (IS_ERR(hcd->regs)) {
254 		err = PTR_ERR(hcd->regs);
255 		goto err_power;
256 	}
257 	hcd->rsrc_start = res_mem->start;
258 	hcd->rsrc_len = resource_size(res_mem);
259 
260 	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
261 	if (err)
262 		goto err_power;
263 
264 	device_wakeup_enable(hcd->self.controller);
265 
266 	platform_set_drvdata(dev, hcd);
267 
268 	return err;
269 
270 err_power:
271 	if (pdata->power_off)
272 		pdata->power_off(dev);
273 err_reset:
274 	while (--rst >= 0)
275 		reset_control_assert(priv->resets[rst]);
276 err_put_clks:
277 	while (--clk >= 0)
278 		clk_put(priv->clks[clk]);
279 err_put_hcd:
280 	if (pdata == &ohci_platform_defaults)
281 		dev->dev.platform_data = NULL;
282 
283 	usb_put_hcd(hcd);
284 
285 	return err;
286 }
287 
288 static int ohci_platform_remove(struct platform_device *dev)
289 {
290 	struct usb_hcd *hcd = platform_get_drvdata(dev);
291 	struct usb_ohci_pdata *pdata = dev_get_platdata(&dev->dev);
292 	struct ohci_platform_priv *priv = hcd_to_ohci_priv(hcd);
293 	int clk, rst;
294 
295 	usb_remove_hcd(hcd);
296 
297 	if (pdata->power_off)
298 		pdata->power_off(dev);
299 
300 	for (rst = 0; rst < OHCI_MAX_RESETS && priv->resets[rst]; rst++)
301 		reset_control_assert(priv->resets[rst]);
302 
303 	for (clk = 0; clk < OHCI_MAX_CLKS && priv->clks[clk]; clk++)
304 		clk_put(priv->clks[clk]);
305 
306 	usb_put_hcd(hcd);
307 
308 	if (pdata == &ohci_platform_defaults)
309 		dev->dev.platform_data = NULL;
310 
311 	return 0;
312 }
313 
314 #ifdef CONFIG_PM_SLEEP
315 static int ohci_platform_suspend(struct device *dev)
316 {
317 	struct usb_hcd *hcd = dev_get_drvdata(dev);
318 	struct usb_ohci_pdata *pdata = dev->platform_data;
319 	struct platform_device *pdev = to_platform_device(dev);
320 	bool do_wakeup = device_may_wakeup(dev);
321 	int ret;
322 
323 	ret = ohci_suspend(hcd, do_wakeup);
324 	if (ret)
325 		return ret;
326 
327 	if (pdata->power_suspend)
328 		pdata->power_suspend(pdev);
329 
330 	return ret;
331 }
332 
333 static int ohci_platform_resume(struct device *dev)
334 {
335 	struct usb_hcd *hcd = dev_get_drvdata(dev);
336 	struct usb_ohci_pdata *pdata = dev_get_platdata(dev);
337 	struct platform_device *pdev = to_platform_device(dev);
338 
339 	if (pdata->power_on) {
340 		int err = pdata->power_on(pdev);
341 		if (err < 0)
342 			return err;
343 	}
344 
345 	ohci_resume(hcd, false);
346 	return 0;
347 }
348 #endif /* CONFIG_PM_SLEEP */
349 
350 static const struct of_device_id ohci_platform_ids[] = {
351 	{ .compatible = "generic-ohci", },
352 	{ .compatible = "cavium,octeon-6335-ohci", },
353 	{ }
354 };
355 MODULE_DEVICE_TABLE(of, ohci_platform_ids);
356 
357 static const struct platform_device_id ohci_platform_table[] = {
358 	{ "ohci-platform", 0 },
359 	{ }
360 };
361 MODULE_DEVICE_TABLE(platform, ohci_platform_table);
362 
363 static SIMPLE_DEV_PM_OPS(ohci_platform_pm_ops, ohci_platform_suspend,
364 	ohci_platform_resume);
365 
366 static struct platform_driver ohci_platform_driver = {
367 	.id_table	= ohci_platform_table,
368 	.probe		= ohci_platform_probe,
369 	.remove		= ohci_platform_remove,
370 	.shutdown	= usb_hcd_platform_shutdown,
371 	.driver		= {
372 		.name	= "ohci-platform",
373 		.pm	= &ohci_platform_pm_ops,
374 		.of_match_table = ohci_platform_ids,
375 	}
376 };
377 
378 static int __init ohci_platform_init(void)
379 {
380 	if (usb_disabled())
381 		return -ENODEV;
382 
383 	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
384 
385 	ohci_init_driver(&ohci_platform_hc_driver, &platform_overrides);
386 	return platform_driver_register(&ohci_platform_driver);
387 }
388 module_init(ohci_platform_init);
389 
390 static void __exit ohci_platform_cleanup(void)
391 {
392 	platform_driver_unregister(&ohci_platform_driver);
393 }
394 module_exit(ohci_platform_cleanup);
395 
396 MODULE_DESCRIPTION(DRIVER_DESC);
397 MODULE_AUTHOR("Hauke Mehrtens");
398 MODULE_AUTHOR("Alan Stern");
399 MODULE_LICENSE("GPL");
400