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