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