1 // SPDX-License-Identifier: GPL-2.0
3 * Generic platform ehci driver
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>
9 * Derived from the ohci-ssb driver
10 * Copyright 2007 Michael Buesch <m@bues.ch>
12 * Derived from the EHCI-PCI driver
13 * Copyright (c) 2000-2004 by David Brownell
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
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>
28 #include <linux/module.h>
30 #include <linux/platform_device.h>
31 #include <linux/reset.h>
32 #include <linux/sys_soc.h>
33 #include <linux/timer.h>
34 #include <linux/usb.h>
35 #include <linux/usb/hcd.h>
36 #include <linux/usb/ehci_pdriver.h>
37 #include <linux/usb/of.h>
41 #define DRIVER_DESC "EHCI generic platform driver"
42 #define EHCI_MAX_CLKS 4
43 #define hcd_to_ehci_priv(h) ((struct ehci_platform_priv *)hcd_to_ehci(h)->priv)
45 struct ehci_platform_priv {
46 struct clk *clks[EHCI_MAX_CLKS];
47 struct reset_control *rsts;
50 struct timer_list poll_timer;
51 struct delayed_work poll_work;
54 static const char hcd_name[] = "ehci-platform";
56 static int ehci_platform_reset(struct usb_hcd *hcd)
58 struct platform_device *pdev = to_platform_device(hcd->self.controller);
59 struct usb_ehci_pdata *pdata = dev_get_platdata(&pdev->dev);
60 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
63 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
65 if (pdata->pre_setup) {
66 retval = pdata->pre_setup(hcd);
71 ehci->caps = hcd->regs + pdata->caps_offset;
72 retval = ehci_setup(hcd);
76 if (pdata->no_io_watchdog)
77 ehci->need_io_watchdog = 0;
81 static int ehci_platform_power_on(struct platform_device *dev)
83 struct usb_hcd *hcd = platform_get_drvdata(dev);
84 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
87 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
88 ret = clk_prepare_enable(priv->clks[clk]);
90 goto err_disable_clks;
97 clk_disable_unprepare(priv->clks[clk]);
102 static void ehci_platform_power_off(struct platform_device *dev)
104 struct usb_hcd *hcd = platform_get_drvdata(dev);
105 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
108 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
110 clk_disable_unprepare(priv->clks[clk]);
113 static struct hc_driver __read_mostly ehci_platform_hc_driver;
115 static const struct ehci_driver_overrides platform_overrides __initconst = {
116 .reset = ehci_platform_reset,
117 .extra_priv_size = sizeof(struct ehci_platform_priv),
120 static struct usb_ehci_pdata ehci_platform_defaults = {
121 .power_on = ehci_platform_power_on,
122 .power_suspend = ehci_platform_power_off,
123 .power_off = ehci_platform_power_off,
127 * quirk_poll_check_port_status - Poll port_status if the device sticks
128 * @ehci: the ehci hcd pointer
130 * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
131 * stuck very rarely after a full/low usb device was disconnected. To
132 * detect such a situation, the controllers require a special way which poll
133 * the EHCI PORTSC register.
135 * Return: true if the controller's port_status indicated getting stuck
137 static bool quirk_poll_check_port_status(struct ehci_hcd *ehci)
139 u32 port_status = ehci_readl(ehci, &ehci->regs->port_status[0]);
141 if (!(port_status & PORT_OWNER) &&
142 (port_status & PORT_POWER) &&
143 !(port_status & PORT_CONNECT) &&
144 (port_status & PORT_LS_MASK))
151 * quirk_poll_rebind_companion - rebind comanion device to recover
152 * @ehci: the ehci hcd pointer
154 * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
155 * stuck very rarely after a full/low usb device was disconnected. To
156 * recover from such a situation, the controllers require changing the OHCI
159 static void quirk_poll_rebind_companion(struct ehci_hcd *ehci)
161 struct device *companion_dev;
162 struct usb_hcd *hcd = ehci_to_hcd(ehci);
164 companion_dev = usb_of_get_companion_dev(hcd->self.controller);
168 device_release_driver(companion_dev);
169 if (device_attach(companion_dev) < 0)
170 ehci_err(ehci, "%s: failed\n", __func__);
172 put_device(companion_dev);
175 static void quirk_poll_work(struct work_struct *work)
177 struct ehci_platform_priv *priv =
178 container_of(to_delayed_work(work), struct ehci_platform_priv,
180 struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
183 /* check the status twice to reduce misdetection rate */
184 if (!quirk_poll_check_port_status(ehci))
187 if (!quirk_poll_check_port_status(ehci))
190 ehci_dbg(ehci, "%s: detected getting stuck. rebind now!\n", __func__);
191 quirk_poll_rebind_companion(ehci);
194 static void quirk_poll_timer(struct timer_list *t)
196 struct ehci_platform_priv *priv = from_timer(priv, t, poll_timer);
197 struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
200 if (quirk_poll_check_port_status(ehci)) {
202 * Now scheduling the work for testing the port more. Note that
203 * updating the status is possible to be delayed when
204 * reconnection. So, this uses delayed work with 5 ms delay
205 * to avoid misdetection.
207 schedule_delayed_work(&priv->poll_work, msecs_to_jiffies(5));
210 mod_timer(&priv->poll_timer, jiffies + HZ);
213 static void quirk_poll_init(struct ehci_platform_priv *priv)
215 INIT_DELAYED_WORK(&priv->poll_work, quirk_poll_work);
216 timer_setup(&priv->poll_timer, quirk_poll_timer, 0);
217 mod_timer(&priv->poll_timer, jiffies + HZ);
220 static void quirk_poll_end(struct ehci_platform_priv *priv)
222 del_timer_sync(&priv->poll_timer);
223 cancel_delayed_work(&priv->poll_work);
226 static const struct soc_device_attribute quirk_poll_match[] = {
227 { .family = "R-Car Gen3" },
231 static int ehci_platform_probe(struct platform_device *dev)
234 struct resource *res_mem;
235 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
236 struct ehci_platform_priv *priv;
237 struct ehci_hcd *ehci;
238 int err, irq, clk = 0;
244 * Use reasonable defaults so platforms don't have to provide these
245 * with DT probing on ARM.
248 pdata = &ehci_platform_defaults;
250 err = dma_coerce_mask_and_coherent(&dev->dev,
251 pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
253 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
257 irq = platform_get_irq(dev, 0);
259 dev_err(&dev->dev, "no irq provided");
263 hcd = usb_create_hcd(&ehci_platform_hc_driver, &dev->dev,
264 dev_name(&dev->dev));
268 platform_set_drvdata(dev, hcd);
269 dev->dev.platform_data = pdata;
270 priv = hcd_to_ehci_priv(hcd);
271 ehci = hcd_to_ehci(hcd);
273 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
274 if (of_property_read_bool(dev->dev.of_node, "big-endian-regs"))
275 ehci->big_endian_mmio = 1;
277 if (of_property_read_bool(dev->dev.of_node, "big-endian-desc"))
278 ehci->big_endian_desc = 1;
280 if (of_property_read_bool(dev->dev.of_node, "big-endian"))
281 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
283 if (of_property_read_bool(dev->dev.of_node,
284 "needs-reset-on-resume"))
285 priv->reset_on_resume = true;
287 if (of_property_read_bool(dev->dev.of_node,
288 "has-transaction-translator"))
291 if (of_device_is_compatible(dev->dev.of_node,
292 "aspeed,ast2500-ehci") ||
293 of_device_is_compatible(dev->dev.of_node,
294 "aspeed,ast2600-ehci"))
297 if (soc_device_match(quirk_poll_match))
298 priv->quirk_poll = true;
300 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
301 priv->clks[clk] = of_clk_get(dev->dev.of_node, clk);
302 if (IS_ERR(priv->clks[clk])) {
303 err = PTR_ERR(priv->clks[clk]);
304 if (err == -EPROBE_DEFER)
306 priv->clks[clk] = NULL;
312 priv->rsts = devm_reset_control_array_get_optional_shared(&dev->dev);
313 if (IS_ERR(priv->rsts)) {
314 err = PTR_ERR(priv->rsts);
318 err = reset_control_deassert(priv->rsts);
322 if (pdata->big_endian_desc)
323 ehci->big_endian_desc = 1;
324 if (pdata->big_endian_mmio)
325 ehci->big_endian_mmio = 1;
328 if (pdata->reset_on_resume)
329 priv->reset_on_resume = true;
331 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
332 if (ehci->big_endian_mmio) {
334 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
339 #ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
340 if (ehci->big_endian_desc) {
342 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
348 if (pdata->power_on) {
349 err = pdata->power_on(dev);
354 res_mem = platform_get_resource(dev, IORESOURCE_MEM, 0);
355 hcd->regs = devm_ioremap_resource(&dev->dev, res_mem);
356 if (IS_ERR(hcd->regs)) {
357 err = PTR_ERR(hcd->regs);
360 hcd->rsrc_start = res_mem->start;
361 hcd->rsrc_len = resource_size(res_mem);
363 err = usb_add_hcd(hcd, irq, IRQF_SHARED);
367 device_wakeup_enable(hcd->self.controller);
368 device_enable_async_suspend(hcd->self.controller);
369 platform_set_drvdata(dev, hcd);
371 if (priv->quirk_poll)
372 quirk_poll_init(priv);
377 if (pdata->power_off)
378 pdata->power_off(dev);
380 reset_control_assert(priv->rsts);
383 clk_put(priv->clks[clk]);
385 if (pdata == &ehci_platform_defaults)
386 dev->dev.platform_data = NULL;
393 static int ehci_platform_remove(struct platform_device *dev)
395 struct usb_hcd *hcd = platform_get_drvdata(dev);
396 struct usb_ehci_pdata *pdata = dev_get_platdata(&dev->dev);
397 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
400 if (priv->quirk_poll)
401 quirk_poll_end(priv);
405 if (pdata->power_off)
406 pdata->power_off(dev);
408 reset_control_assert(priv->rsts);
410 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
411 clk_put(priv->clks[clk]);
415 if (pdata == &ehci_platform_defaults)
416 dev->dev.platform_data = NULL;
421 #ifdef CONFIG_PM_SLEEP
422 static int ehci_platform_suspend(struct device *dev)
424 struct usb_hcd *hcd = dev_get_drvdata(dev);
425 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
426 struct platform_device *pdev = to_platform_device(dev);
427 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
428 bool do_wakeup = device_may_wakeup(dev);
431 if (priv->quirk_poll)
432 quirk_poll_end(priv);
434 ret = ehci_suspend(hcd, do_wakeup);
438 if (pdata->power_suspend)
439 pdata->power_suspend(pdev);
444 static int ehci_platform_resume(struct device *dev)
446 struct usb_hcd *hcd = dev_get_drvdata(dev);
447 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
448 struct platform_device *pdev = to_platform_device(dev);
449 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
450 struct device *companion_dev;
452 if (pdata->power_on) {
453 int err = pdata->power_on(pdev);
458 companion_dev = usb_of_get_companion_dev(hcd->self.controller);
460 device_pm_wait_for_dev(hcd->self.controller, companion_dev);
461 put_device(companion_dev);
464 ehci_resume(hcd, priv->reset_on_resume);
466 if (priv->quirk_poll)
467 quirk_poll_init(priv);
471 #endif /* CONFIG_PM_SLEEP */
473 static const struct of_device_id vt8500_ehci_ids[] = {
474 { .compatible = "via,vt8500-ehci", },
475 { .compatible = "wm,prizm-ehci", },
476 { .compatible = "generic-ehci", },
477 { .compatible = "cavium,octeon-6335-ehci", },
480 MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
482 static const struct acpi_device_id ehci_acpi_match[] = {
483 { "PNP0D20", 0 }, /* EHCI controller without debug */
486 MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
488 static const struct platform_device_id ehci_platform_table[] = {
489 { "ehci-platform", 0 },
492 MODULE_DEVICE_TABLE(platform, ehci_platform_table);
494 static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
495 ehci_platform_resume);
497 static struct platform_driver ehci_platform_driver = {
498 .id_table = ehci_platform_table,
499 .probe = ehci_platform_probe,
500 .remove = ehci_platform_remove,
501 .shutdown = usb_hcd_platform_shutdown,
503 .name = "ehci-platform",
504 .pm = &ehci_platform_pm_ops,
505 .of_match_table = vt8500_ehci_ids,
506 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
510 static int __init ehci_platform_init(void)
515 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
517 ehci_init_driver(&ehci_platform_hc_driver, &platform_overrides);
518 return platform_driver_register(&ehci_platform_driver);
520 module_init(ehci_platform_init);
522 static void __exit ehci_platform_cleanup(void)
524 platform_driver_unregister(&ehci_platform_driver);
526 module_exit(ehci_platform_cleanup);
528 MODULE_DESCRIPTION(DRIVER_DESC);
529 MODULE_AUTHOR("Hauke Mehrtens");
530 MODULE_AUTHOR("Alan Stern");
531 MODULE_LICENSE("GPL");