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/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>
38
39#include "ehci.h"
40
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)
44
45#define BCM_USB_FIFO_THRESHOLD 0x00800040
46
47struct ehci_platform_priv {
48 struct clk *clks[EHCI_MAX_CLKS];
49 struct reset_control *rsts;
50 bool reset_on_resume;
51 bool quirk_poll;
52 struct timer_list poll_timer;
53 struct delayed_work poll_work;
54};
55
56static int ehci_platform_reset(struct usb_hcd *hcd)
57{
58 struct platform_device *pdev = to_platform_device(hcd->self.controller);
59 struct usb_ehci_pdata *pdata = dev_get_platdata(dev: &pdev->dev);
60 struct ehci_hcd *ehci = hcd_to_ehci(hcd);
61 int retval;
62
63 ehci->has_synopsys_hc_bug = pdata->has_synopsys_hc_bug;
64
65 if (pdata->pre_setup) {
66 retval = pdata->pre_setup(hcd);
67 if (retval < 0)
68 return retval;
69 }
70
71 ehci->caps = hcd->regs + pdata->caps_offset;
72 retval = ehci_setup(hcd);
73 if (retval)
74 return retval;
75
76 if (pdata->no_io_watchdog)
77 ehci->need_io_watchdog = 0;
78
79 if (of_device_is_compatible(device: pdev->dev.of_node, "brcm,xgs-iproc-ehci"))
80 ehci_writel(ehci, BCM_USB_FIFO_THRESHOLD,
81 regs: &ehci->regs->brcm_insnreg[1]);
82
83 return 0;
84}
85
86static int ehci_platform_power_on(struct platform_device *dev)
87{
88 struct usb_hcd *hcd = platform_get_drvdata(pdev: dev);
89 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
90 int clk, ret;
91
92 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++) {
93 ret = clk_prepare_enable(clk: priv->clks[clk]);
94 if (ret)
95 goto err_disable_clks;
96 }
97
98 return 0;
99
100err_disable_clks:
101 while (--clk >= 0)
102 clk_disable_unprepare(clk: priv->clks[clk]);
103
104 return ret;
105}
106
107static void ehci_platform_power_off(struct platform_device *dev)
108{
109 struct usb_hcd *hcd = platform_get_drvdata(pdev: dev);
110 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
111 int clk;
112
113 for (clk = EHCI_MAX_CLKS - 1; clk >= 0; clk--)
114 if (priv->clks[clk])
115 clk_disable_unprepare(clk: priv->clks[clk]);
116}
117
118static struct hc_driver __read_mostly ehci_platform_hc_driver;
119
120static const struct ehci_driver_overrides platform_overrides __initconst = {
121 .reset = ehci_platform_reset,
122 .extra_priv_size = sizeof(struct ehci_platform_priv),
123};
124
125static struct usb_ehci_pdata ehci_platform_defaults = {
126 .power_on = ehci_platform_power_on,
127 .power_suspend = ehci_platform_power_off,
128 .power_off = ehci_platform_power_off,
129};
130
131/**
132 * quirk_poll_check_port_status - Poll port_status if the device sticks
133 * @ehci: the ehci hcd pointer
134 *
135 * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
136 * stuck very rarely after a full/low usb device was disconnected. To
137 * detect such a situation, the controllers require a special way which poll
138 * the EHCI PORTSC register.
139 *
140 * Return: true if the controller's port_status indicated getting stuck
141 */
142static bool quirk_poll_check_port_status(struct ehci_hcd *ehci)
143{
144 u32 port_status = ehci_readl(ehci, regs: &ehci->regs->port_status[0]);
145
146 if (!(port_status & PORT_OWNER) &&
147 (port_status & PORT_POWER) &&
148 !(port_status & PORT_CONNECT) &&
149 (port_status & PORT_LS_MASK))
150 return true;
151
152 return false;
153}
154
155/**
156 * quirk_poll_rebind_companion - rebind comanion device to recover
157 * @ehci: the ehci hcd pointer
158 *
159 * Since EHCI/OHCI controllers on R-Car Gen3 SoCs are possible to be getting
160 * stuck very rarely after a full/low usb device was disconnected. To
161 * recover from such a situation, the controllers require changing the OHCI
162 * functional state.
163 */
164static void quirk_poll_rebind_companion(struct ehci_hcd *ehci)
165{
166 struct device *companion_dev;
167 struct usb_hcd *hcd = ehci_to_hcd(ehci);
168
169 companion_dev = usb_of_get_companion_dev(dev: hcd->self.controller);
170 if (!companion_dev)
171 return;
172
173 device_release_driver(dev: companion_dev);
174 if (device_attach(dev: companion_dev) < 0)
175 ehci_err(ehci, "%s: failed\n", __func__);
176
177 put_device(dev: companion_dev);
178}
179
180static void quirk_poll_work(struct work_struct *work)
181{
182 struct ehci_platform_priv *priv =
183 container_of(to_delayed_work(work), struct ehci_platform_priv,
184 poll_work);
185 struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
186 priv);
187
188 /* check the status twice to reduce misdetection rate */
189 if (!quirk_poll_check_port_status(ehci))
190 return;
191 udelay(usec: 10);
192 if (!quirk_poll_check_port_status(ehci))
193 return;
194
195 ehci_dbg(ehci, "%s: detected getting stuck. rebind now!\n", __func__);
196 quirk_poll_rebind_companion(ehci);
197}
198
199static void quirk_poll_timer(struct timer_list *t)
200{
201 struct ehci_platform_priv *priv = timer_container_of(priv, t,
202 poll_timer);
203 struct ehci_hcd *ehci = container_of((void *)priv, struct ehci_hcd,
204 priv);
205
206 if (quirk_poll_check_port_status(ehci)) {
207 /*
208 * Now scheduling the work for testing the port more. Note that
209 * updating the status is possible to be delayed when
210 * reconnection. So, this uses delayed work with 5 ms delay
211 * to avoid misdetection.
212 */
213 schedule_delayed_work(dwork: &priv->poll_work, delay: msecs_to_jiffies(m: 5));
214 }
215
216 mod_timer(timer: &priv->poll_timer, expires: jiffies + HZ);
217}
218
219static void quirk_poll_init(struct ehci_platform_priv *priv)
220{
221 INIT_DELAYED_WORK(&priv->poll_work, quirk_poll_work);
222 timer_setup(&priv->poll_timer, quirk_poll_timer, 0);
223 mod_timer(timer: &priv->poll_timer, expires: jiffies + HZ);
224}
225
226static void quirk_poll_end(struct ehci_platform_priv *priv)
227{
228 timer_delete_sync(timer: &priv->poll_timer);
229 cancel_delayed_work(dwork: &priv->poll_work);
230}
231
232static const struct soc_device_attribute quirk_poll_match[] = {
233 { .family = "R-Car Gen3" },
234 { /* sentinel*/ }
235};
236
237static int ehci_platform_probe(struct platform_device *dev)
238{
239 struct usb_hcd *hcd;
240 struct resource *res_mem;
241 struct usb_ehci_pdata *pdata = dev_get_platdata(dev: &dev->dev);
242 struct ehci_platform_priv *priv;
243 struct ehci_hcd *ehci;
244 int err, irq, clk = 0;
245
246 if (usb_disabled())
247 return -ENODEV;
248
249 /*
250 * Use reasonable defaults so platforms don't have to provide these
251 * with DT probing on ARM.
252 */
253 if (!pdata)
254 pdata = &ehci_platform_defaults;
255
256 err = dma_coerce_mask_and_coherent(dev: &dev->dev,
257 mask: pdata->dma_mask_64 ? DMA_BIT_MASK(64) : DMA_BIT_MASK(32));
258 if (err) {
259 dev_err(&dev->dev, "Error: DMA mask configuration failed\n");
260 return err;
261 }
262
263 irq = platform_get_irq(dev, 0);
264 if (irq < 0)
265 return irq;
266
267 hcd = usb_create_hcd(driver: &ehci_platform_hc_driver, dev: &dev->dev,
268 bus_name: dev_name(dev: &dev->dev));
269 if (!hcd)
270 return -ENOMEM;
271
272 platform_set_drvdata(pdev: dev, data: hcd);
273 dev->dev.platform_data = pdata;
274 priv = hcd_to_ehci_priv(hcd);
275 ehci = hcd_to_ehci(hcd);
276
277 if (pdata == &ehci_platform_defaults && dev->dev.of_node) {
278 if (of_property_read_bool(np: dev->dev.of_node, propname: "big-endian-regs"))
279 ehci->big_endian_mmio = 1;
280
281 if (of_property_read_bool(np: dev->dev.of_node, propname: "big-endian-desc"))
282 ehci->big_endian_desc = 1;
283
284 if (of_property_read_bool(np: dev->dev.of_node, propname: "big-endian"))
285 ehci->big_endian_mmio = ehci->big_endian_desc = 1;
286
287 if (of_property_read_bool(np: dev->dev.of_node, propname: "spurious-oc"))
288 ehci->spurious_oc = 1;
289
290 if (of_property_read_bool(np: dev->dev.of_node,
291 propname: "needs-reset-on-resume"))
292 priv->reset_on_resume = true;
293
294 if (of_property_read_bool(np: dev->dev.of_node,
295 propname: "has-transaction-translator"))
296 hcd->has_tt = 1;
297
298 if (of_device_is_compatible(device: dev->dev.of_node,
299 "aspeed,ast2500-ehci") ||
300 of_device_is_compatible(device: dev->dev.of_node,
301 "aspeed,ast2600-ehci"))
302 ehci->is_aspeed = 1;
303
304 if (soc_device_match(matches: quirk_poll_match))
305 priv->quirk_poll = true;
306
307 for (clk = 0; clk < EHCI_MAX_CLKS; clk++) {
308 priv->clks[clk] = of_clk_get(np: dev->dev.of_node, index: clk);
309 if (IS_ERR(ptr: priv->clks[clk])) {
310 err = PTR_ERR(ptr: priv->clks[clk]);
311 if (err == -EPROBE_DEFER)
312 goto err_put_clks;
313 priv->clks[clk] = NULL;
314 break;
315 }
316 }
317 }
318
319 priv->rsts = devm_reset_control_array_get_optional_shared(dev: &dev->dev);
320 if (IS_ERR(ptr: priv->rsts)) {
321 err = PTR_ERR(ptr: priv->rsts);
322 goto err_put_clks;
323 }
324
325 err = reset_control_deassert(rstc: priv->rsts);
326 if (err)
327 goto err_put_clks;
328
329 if (pdata->big_endian_desc)
330 ehci->big_endian_desc = 1;
331 if (pdata->big_endian_mmio)
332 ehci->big_endian_mmio = 1;
333 if (pdata->has_tt)
334 hcd->has_tt = 1;
335 if (pdata->reset_on_resume)
336 priv->reset_on_resume = true;
337 if (pdata->spurious_oc)
338 ehci->spurious_oc = 1;
339
340#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
341 if (ehci->big_endian_mmio) {
342 dev_err(&dev->dev,
343 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_MMIO not set\n");
344 err = -EINVAL;
345 goto err_reset;
346 }
347#endif
348#ifndef CONFIG_USB_EHCI_BIG_ENDIAN_DESC
349 if (ehci->big_endian_desc) {
350 dev_err(&dev->dev,
351 "Error: CONFIG_USB_EHCI_BIG_ENDIAN_DESC not set\n");
352 err = -EINVAL;
353 goto err_reset;
354 }
355#endif
356
357 if (pdata->power_on) {
358 err = pdata->power_on(dev);
359 if (err < 0)
360 goto err_reset;
361 }
362
363 hcd->regs = devm_platform_get_and_ioremap_resource(pdev: dev, index: 0, res: &res_mem);
364 if (IS_ERR(ptr: hcd->regs)) {
365 err = PTR_ERR(ptr: hcd->regs);
366 goto err_power;
367 }
368 hcd->rsrc_start = res_mem->start;
369 hcd->rsrc_len = resource_size(res: res_mem);
370
371 hcd->tpl_support = of_usb_host_tpl_support(np: dev->dev.of_node);
372
373 err = usb_add_hcd(hcd, irqnum: irq, IRQF_SHARED);
374 if (err)
375 goto err_power;
376
377 device_wakeup_enable(dev: hcd->self.controller);
378 device_enable_async_suspend(dev: hcd->self.controller);
379 platform_set_drvdata(pdev: dev, data: hcd);
380
381 if (priv->quirk_poll)
382 quirk_poll_init(priv);
383
384 return err;
385
386err_power:
387 if (pdata->power_off)
388 pdata->power_off(dev);
389err_reset:
390 reset_control_assert(rstc: priv->rsts);
391err_put_clks:
392 while (--clk >= 0)
393 clk_put(clk: priv->clks[clk]);
394
395 if (pdata == &ehci_platform_defaults)
396 dev->dev.platform_data = NULL;
397
398 usb_put_hcd(hcd);
399
400 return err;
401}
402
403static void ehci_platform_remove(struct platform_device *dev)
404{
405 struct usb_hcd *hcd = platform_get_drvdata(pdev: dev);
406 struct usb_ehci_pdata *pdata = dev_get_platdata(dev: &dev->dev);
407 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
408 int clk;
409
410 if (priv->quirk_poll)
411 quirk_poll_end(priv);
412
413 usb_remove_hcd(hcd);
414
415 if (pdata->power_off)
416 pdata->power_off(dev);
417
418 reset_control_assert(rstc: priv->rsts);
419
420 for (clk = 0; clk < EHCI_MAX_CLKS && priv->clks[clk]; clk++)
421 clk_put(clk: priv->clks[clk]);
422
423 usb_put_hcd(hcd);
424
425 if (pdata == &ehci_platform_defaults)
426 dev->dev.platform_data = NULL;
427}
428
429static int __maybe_unused ehci_platform_suspend(struct device *dev)
430{
431 struct usb_hcd *hcd = dev_get_drvdata(dev);
432 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
433 struct platform_device *pdev = to_platform_device(dev);
434 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
435 bool do_wakeup = device_may_wakeup(dev);
436 int ret;
437
438 if (priv->quirk_poll)
439 quirk_poll_end(priv);
440
441 ret = ehci_suspend(hcd, do_wakeup);
442 if (ret)
443 return ret;
444
445 if (pdata->power_suspend)
446 pdata->power_suspend(pdev);
447
448 return ret;
449}
450
451static int __maybe_unused ehci_platform_resume(struct device *dev)
452{
453 struct usb_hcd *hcd = dev_get_drvdata(dev);
454 struct usb_ehci_pdata *pdata = dev_get_platdata(dev);
455 struct platform_device *pdev = to_platform_device(dev);
456 struct ehci_platform_priv *priv = hcd_to_ehci_priv(hcd);
457 struct device *companion_dev;
458
459 if (pdata->power_on) {
460 int err = pdata->power_on(pdev);
461 if (err < 0)
462 return err;
463 }
464
465 companion_dev = usb_of_get_companion_dev(dev: hcd->self.controller);
466 if (companion_dev) {
467 device_pm_wait_for_dev(sub: hcd->self.controller, dev: companion_dev);
468 put_device(dev: companion_dev);
469 }
470
471 ehci_resume(hcd, force_reset: priv->reset_on_resume);
472
473 pm_runtime_disable(dev);
474 pm_runtime_set_active(dev);
475 pm_runtime_enable(dev);
476
477 if (priv->quirk_poll)
478 quirk_poll_init(priv);
479
480 return 0;
481}
482
483static const struct of_device_id vt8500_ehci_ids[] = {
484 { .compatible = "via,vt8500-ehci", },
485 { .compatible = "wm,prizm-ehci", },
486 { .compatible = "generic-ehci", },
487 { .compatible = "cavium,octeon-6335-ehci", },
488 {}
489};
490MODULE_DEVICE_TABLE(of, vt8500_ehci_ids);
491
492#ifdef CONFIG_ACPI
493static const struct acpi_device_id ehci_acpi_match[] = {
494 { "PNP0D20", 0 }, /* EHCI controller without debug */
495 { }
496};
497MODULE_DEVICE_TABLE(acpi, ehci_acpi_match);
498#endif
499
500static const struct platform_device_id ehci_platform_table[] = {
501 { "ehci-platform", 0 },
502 { }
503};
504MODULE_DEVICE_TABLE(platform, ehci_platform_table);
505
506static SIMPLE_DEV_PM_OPS(ehci_platform_pm_ops, ehci_platform_suspend,
507 ehci_platform_resume);
508
509static struct platform_driver ehci_platform_driver = {
510 .id_table = ehci_platform_table,
511 .probe = ehci_platform_probe,
512 .remove = ehci_platform_remove,
513 .shutdown = usb_hcd_platform_shutdown,
514 .driver = {
515 .name = "ehci-platform",
516 .pm = pm_ptr(&ehci_platform_pm_ops),
517 .of_match_table = vt8500_ehci_ids,
518 .acpi_match_table = ACPI_PTR(ehci_acpi_match),
519 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
520 }
521};
522
523static int __init ehci_platform_init(void)
524{
525 if (usb_disabled())
526 return -ENODEV;
527
528 ehci_init_driver(drv: &ehci_platform_hc_driver, over: &platform_overrides);
529 return platform_driver_register(&ehci_platform_driver);
530}
531module_init(ehci_platform_init);
532
533static void __exit ehci_platform_cleanup(void)
534{
535 platform_driver_unregister(&ehci_platform_driver);
536}
537module_exit(ehci_platform_cleanup);
538
539MODULE_DESCRIPTION(DRIVER_DESC);
540MODULE_AUTHOR("Hauke Mehrtens");
541MODULE_AUTHOR("Alan Stern");
542MODULE_LICENSE("GPL");
543

source code of linux/drivers/usb/host/ehci-platform.c