1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Generic platform ehci driver
  4 *
  5 * Copyright 2007 Steven Brown <sbrown@cortland.com>
  6 * Copyright 2010-2012 Hauke Mehrtens <hauke@hauke-m.de>
  7 * Copyright 2014 Hans de Goede <hdegoede@redhat.com>
  8 *
  9 * Derived from the ohci-ssb driver
 10 * Copyright 2007 Michael Buesch <m@bues.ch>
 11 *
 12 * Derived from the EHCI-PCI driver
 13 * Copyright (c) 2000-2004 by David Brownell
 14 *
 15 * Derived from the ohci-pci driver
 16 * Copyright 1999 Roman Weissgaerber
 17 * Copyright 2000-2002 David Brownell
 18 * Copyright 1999 Linus Torvalds
 19 * Copyright 1999 Gregory P. Smith
 20 */
 21#include <linux/acpi.h>
 22#include <linux/clk.h>
 23#include <linux/dma-mapping.h>
 24#include <linux/err.h>
 25#include <linux/kernel.h>
 26#include <linux/hrtimer.h>
 27#include <linux/io.h>
 28#include <linux/module.h>
 29#include <linux/of.h>
 30#include <linux/platform_device.h>
 31#include <linux/reset.h>
 32#include <linux/usb.h>
 33#include <linux/usb/hcd.h>
 34#include <linux/usb/ehci_pdriver.h>
 35#include <linux/usb/of.h>
 36
 37#include "ehci.h"
 38
 39#define DRIVER_DESC "EHCI generic platform driver"
 40#define EHCI_MAX_CLKS 4
 41#define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
 42
 43struct ehci_platform_priv {
 44	struct clk *clks[EHCI_MAX_CLKS];
 45	struct reset_control *rsts;
 46	bool reset_on_resume;
 47};
 48
 49static const char hcd_name[] = "ehci-platform";
 50
 51static int ehci_platform_reset(struct usb_hcd *hcd)
 52{
 53	struct platform_device *pdev = to_platform_device(hcd->self.controller);
 54	struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
 55	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 56	int retval;
 57
 58	ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
 59
 60	if (pdata->pre_setup) {
 61		retval = pdata->pre_setup(hcd);
 62		if (retval < 0)
 63			return retval;
 64	}
 65
 66	ehci->caps = hcd->regs + pdata->caps_offset;
 67	retval = ehci_setup(hcd);
 68	if (retval)
 69		return retval;
 70
 71	if (pdata->no_io_watchdog)
 72		ehci->need_io_watchdog = 0;
 73	return 0;
 74}
 75
 76static int ehci_platform_power_on(struct platform_device *dev)
 77{
 78	struct usb_hcd *hcd = platform_get_drvdata(dev);
 79	struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
 80	int clk, ret;
 81
 82	for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
 83		ret = clk_prepare_enable(priv->clks[clk]);
 84		if (ret)
 85			goto err_disable_clks;
 86	}
 87
 88	return 0;
 89
 90err_disable_clks:
 91	while (--clk >= 0)
 92		clk_disable_unprepare(priv->clks[clk]);
 93
 94	return ret;
 95}
 96
 97static void ehci_platform_power_off(struct platform_device *dev)
 98{
 99	struct usb_hcd *hcd = platform_get_drvdata(dev);
100	struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
101	int clk;
102
103	for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
104		if (priv->clks[clk])
105			clk_disable_unprepare(priv->clks[clk]);
106}
107
108static struct hc_driver __read_mostly ehci_platform_hc_driver;
109
110static const struct ehci_driver_overrides platform_overrides __initconst = {
111	.reset =		ehci_platform_reset,
112	.extra_priv_size =	sizeof(struct ehci_platform_priv),
113};
114
115static struct usb_ehci_pdata ehci_platform_defaults = {
116	.power_on =		ehci_platform_power_on,
117	.power_suspend =	ehci_platform_power_off,
118	.power_off =		ehci_platform_power_off,
119};
120
121static int ehci_platform_probe(struct platform_device *dev)
122{
123	struct usb_hcd *hcd;
124	struct resource *res_mem;
125	struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
126	struct ehci_platform_priv *priv;
127	struct ehci_hcd *ehci;
128	int err, irq, clk = 0;
129
130	if (usb_disabled())
131		return -ENODEV;
132
133	/*
134	 * Use reasonable defaults so platforms don't have to provide these
135	 * with DT probing on ARM.
136	 */
137	if (!pdata)
138		pdata = &ehci_platform_defaults;
139
140	err = dma_coerce_mask_and_coherent(&dev->dev,
141		pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
142	if (err) {
143		dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
144		return err;
145	}
146
147	irq = platform_get_irq(dev, 0);
148	if (irq < 0)
149		return irq;
150
151	hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
152			     dev_name(&dev->dev));
153	if (!hcd)
154		return -ENOMEM;
155
156	platform_set_drvdata(dev, hcd);
157	dev->dev.platform_data = pdata;
158	priv = hcd_to_ehci_priv(hcd);
159	ehci = hcd_to_ehci(hcd);
160
161	if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
162		if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
163			ehci->big_endian_mmio = 1;
164
165		if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
166			ehci->big_endian_desc = 1;
167
168		if (of_property_read_bool(dev->dev.of_node, "big-endian"))
169			ehci->big_endian_mmio = ehci->big_endian_desc = 1;
170
171		if (of_property_read_bool(dev->dev.of_node,
172					  "needs-reset-on-resume"))
173			priv->reset_on_resume = true;
174
175		if (of_property_read_bool(dev->dev.of_node,
176					  "has-transaction-translator"))
177			hcd->has_tt = 1;
178
179		for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
180			priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
181			if (IS_ERR(priv->clks[clk])) {
182				err = PTR_ERR(priv->clks[clk]);
183				if (err == -EPROBE_DEFER)
184					goto err_put_clks;
185				priv->clks[clk] = NULL;
186				break;
187			}
188		}
189	}
190
191	priv->rsts = devm_reset_control_array_get_optional_shared(&dev->dev);
192	if (IS_ERR(priv->rsts)) {
193		err = PTR_ERR(priv->rsts);
194		goto err_put_clks;
195	}
196
197	err = reset_control_deassert(priv->rsts);
198	if (err)
199		goto err_put_clks;
200
201	if (pdata->big_endian_desc)
202		ehci->big_endian_desc = 1;
203	if (pdata->big_endian_mmio)
204		ehci->big_endian_mmio = 1;
205	if (pdata->has_tt)
206		hcd->has_tt = 1;
207	if (pdata->reset_on_resume)
208		priv->reset_on_resume = true;
209
210#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
211	if (ehci->big_endian_mmio) {
212		dev_err(&dev->dev,
213			"Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
214		err = -EINVAL;
215		goto err_reset;
216	}
217#endif
218#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
219	if (ehci->big_endian_desc) {
220		dev_err(&dev->dev,
221			"Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
222		err = -EINVAL;
223		goto err_reset;
224	}
225#endif
226
227	if (pdata->power_on) {
228		err = pdata->power_on(dev);
229		if (err < 0)
230			goto err_reset;
231	}
232
233	res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
234	hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
235	if (IS_ERR(hcd->regs)) {
236		err = PTR_ERR(hcd->regs);
237		goto err_power;
238	}
239	hcd->rsrc_start = res_mem->start;
240	hcd->rsrc_len = resource_size(res_mem);
241
242	err = usb_add_hcd(hcd, irq, IRQF_SHARED);
243	if (err)
244		goto err_power;
245
246	device_wakeup_enable(hcd->self.controller);
247	device_enable_async_suspend(hcd->self.controller);
248	platform_set_drvdata(dev, hcd);
249
250	return err;
251
252err_power:
253	if (pdata->power_off)
254		pdata->power_off(dev);
255err_reset:
256	reset_control_assert(priv->rsts);
257err_put_clks:
258	while (--clk >= 0)
259		clk_put(priv->clks[clk]);
260
261	if (pdata == &ehci_platform_defaults)
262		dev->dev.platform_data = NULL;
263
264	usb_put_hcd(hcd);
265
266	return err;
267}
268
269static int ehci_platform_remove(struct platform_device *dev)
270{
271	struct usb_hcd *hcd = platform_get_drvdata(dev);
272	struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
273	struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
274	int clk;
275
276	usb_remove_hcd(hcd);
277
278	if (pdata->power_off)
279		pdata->power_off(dev);
280
281	reset_control_assert(priv->rsts);
282
283	for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
284		clk_put(priv->clks[clk]);
285
286	usb_put_hcd(hcd);
287
288	if (pdata == &ehci_platform_defaults)
289		dev->dev.platform_data = NULL;
290
291	return 0;
292}
293
294#ifdef CONFIG_PM_SLEEP
295static int ehci_platform_suspend(struct device *dev)
296{
297	struct usb_hcd *hcd = dev_get_drvdata(dev);
298	struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
299	struct platform_device *pdev = to_platform_device(dev);
300	bool do_wakeup = device_may_wakeup(dev);
301	int ret;
302
303	ret = ehci_suspend(hcd, do_wakeup);
304	if (ret)
305		return ret;
306
307	if (pdata->power_suspend)
308		pdata->power_suspend(pdev);
309
310	return ret;
311}
312
313static int ehci_platform_resume(struct device *dev)
314{
315	struct usb_hcd *hcd = dev_get_drvdata(dev);
316	struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
317	struct platform_device *pdev = to_platform_device(dev);
318	struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
319	struct device *companion_dev;
320
321	if (pdata->power_on) {
322		int err = pdata->power_on(pdev);
323		if (err < 0)
324			return err;
325	}
326
327	companion_dev = usb_of_get_companion_dev(hcd->self.controller);
328	if (companion_dev) {
329		device_pm_wait_for_dev(hcd->self.controller, companion_dev);
330		put_device(companion_dev);
331	}
332
333	ehci_resume(hcd, priv->reset_on_resume);
334	return 0;
335}
336#endif /* CONFIG_PM_SLEEP */
337
338static const struct of_device_id vt8500_ehci_ids[] = {
339	{ .compatible = "via,vt8500-ehci", },
340	{ .compatible = "wm,prizm-ehci", },
341	{ .compatible = "generic-ehci", },
342	{ .compatible = "cavium,octeon-6335-ehci", },
343	{}
344};
345MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
346
347static const struct acpi_device_id ehci_acpi_match[] = {
348	{ "PNP0D20", 0 }, /* EHCI controller without debug */
349	{ }
350};
351MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
352
353static const struct platform_device_id ehci_platform_table[] = {
354	{ "ehci-platform", 0 },
355	{ }
356};
357MODULE_DEVICE_TABLE(platform, ehci_platform_table);
358
359static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
360	ehci_platform_resume);
361
362static struct platform_driver ehci_platform_driver = {
363	.id_table	= ehci_platform_table,
364	.probe		= ehci_platform_probe,
365	.remove		= ehci_platform_remove,
366	.shutdown	= usb_hcd_platform_shutdown,
367	.driver		= {
368		.name	= "ehci-platform",
369		.pm	= &ehci_platform_pm_ops,
370		.of_match_table = vt8500_ehci_ids,
371		.acpi_match_table = ACPI_PTR(ehci_acpi_match),
372	}
373};
374
375static int __init ehci_platform_init(void)
376{
377	if (usb_disabled())
378		return -ENODEV;
379
380	pr_info("%s: " DRIVER_DESC "\n", hcd_name);
381
382	ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
383	return platform_driver_register(&ehci_platform_driver);
384}
385module_init(ehci_platform_init);
386
387static void __exit ehci_platform_cleanup(void)
388{
389	platform_driver_unregister(&ehci_platform_driver);
390}
391module_exit(ehci_platform_cleanup);
392
393MODULE_DESCRIPTION(DRIVER_DESC);
394MODULE_AUTHOR("Hauke Mehrtens");
395MODULE_AUTHOR("Alan Stern");
396MODULE_LICENSE("GPL");