1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * xhci-plat.c - xHCI host controller driver platform Bus Glue.
4 *
5 * Copyright (C) 2012 Texas Instruments Incorporated - https://www.ti.com
6 * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
7 *
8 * A lot of code borrowed from the Linux xHCI driver.
9 */
10
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/module.h>
14 #include <linux/pci.h>
15 #include <linux/of.h>
16 #include <linux/of_device.h>
17 #include <linux/platform_device.h>
18 #include <linux/usb/phy.h>
19 #include <linux/slab.h>
20 #include <linux/acpi.h>
21 #include <linux/usb/of.h>
22 #include <linux/reset.h>
23
24 #include "xhci.h"
25 #include "xhci-plat.h"
26 #include "xhci-mvebu.h"
27
28 static struct hc_driver __read_mostly xhci_plat_hc_driver;
29
30 static int xhci_plat_setup(struct usb_hcd *hcd);
31 static int xhci_plat_start(struct usb_hcd *hcd);
32
33 static const struct xhci_driver_overrides xhci_plat_overrides __initconst = {
34 .extra_priv_size = sizeof(struct xhci_plat_priv),
35 .reset = xhci_plat_setup,
36 .start = xhci_plat_start,
37 };
38
xhci_priv_plat_start(struct usb_hcd * hcd)39 static void xhci_priv_plat_start(struct usb_hcd *hcd)
40 {
41 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
42
43 if (priv->plat_start)
44 priv->plat_start(hcd);
45 }
46
xhci_priv_init_quirk(struct usb_hcd * hcd)47 static int xhci_priv_init_quirk(struct usb_hcd *hcd)
48 {
49 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
50
51 if (!priv->init_quirk)
52 return 0;
53
54 return priv->init_quirk(hcd);
55 }
56
xhci_priv_suspend_quirk(struct usb_hcd * hcd)57 static int xhci_priv_suspend_quirk(struct usb_hcd *hcd)
58 {
59 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
60
61 if (!priv->suspend_quirk)
62 return 0;
63
64 return priv->suspend_quirk(hcd);
65 }
66
xhci_priv_resume_quirk(struct usb_hcd * hcd)67 static int xhci_priv_resume_quirk(struct usb_hcd *hcd)
68 {
69 struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd);
70
71 if (!priv->resume_quirk)
72 return 0;
73
74 return priv->resume_quirk(hcd);
75 }
76
xhci_plat_quirks(struct device * dev,struct xhci_hcd * xhci)77 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
78 {
79 struct xhci_plat_priv *priv = xhci_to_priv(xhci);
80
81 xhci->quirks |= priv->quirks;
82 }
83
84 /* called during probe() after chip reset completes */
xhci_plat_setup(struct usb_hcd * hcd)85 static int xhci_plat_setup(struct usb_hcd *hcd)
86 {
87 int ret;
88
89
90 ret = xhci_priv_init_quirk(hcd);
91 if (ret)
92 return ret;
93
94 return xhci_gen_setup(hcd, xhci_plat_quirks);
95 }
96
xhci_plat_start(struct usb_hcd * hcd)97 static int xhci_plat_start(struct usb_hcd *hcd)
98 {
99 xhci_priv_plat_start(hcd);
100 return xhci_run(hcd);
101 }
102
103 #ifdef CONFIG_OF
104 static const struct xhci_plat_priv xhci_plat_marvell_armada = {
105 .init_quirk = xhci_mvebu_mbus_init_quirk,
106 };
107
108 static const struct xhci_plat_priv xhci_plat_marvell_armada3700 = {
109 .quirks = XHCI_RESET_ON_RESUME,
110 };
111
112 static const struct xhci_plat_priv xhci_plat_brcm = {
113 .quirks = XHCI_RESET_ON_RESUME | XHCI_SUSPEND_RESUME_CLKS,
114 };
115
116 static const struct of_device_id usb_xhci_of_match[] = {
117 {
118 .compatible = "generic-xhci",
119 }, {
120 .compatible = "xhci-platform",
121 }, {
122 .compatible = "marvell,armada-375-xhci",
123 .data = &xhci_plat_marvell_armada,
124 }, {
125 .compatible = "marvell,armada-380-xhci",
126 .data = &xhci_plat_marvell_armada,
127 }, {
128 .compatible = "marvell,armada3700-xhci",
129 .data = &xhci_plat_marvell_armada3700,
130 }, {
131 .compatible = "brcm,xhci-brcm-v2",
132 .data = &xhci_plat_brcm,
133 }, {
134 .compatible = "brcm,bcm7445-xhci",
135 .data = &xhci_plat_brcm,
136 },
137 {},
138 };
139 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
140 #endif
141
xhci_plat_probe(struct platform_device * pdev,struct device * sysdev,const struct xhci_plat_priv * priv_match)142 int xhci_plat_probe(struct platform_device *pdev, struct device *sysdev, const struct xhci_plat_priv *priv_match)
143 {
144 const struct hc_driver *driver;
145 struct device *tmpdev;
146 struct xhci_hcd *xhci;
147 struct resource *res;
148 struct usb_hcd *hcd, *usb3_hcd;
149 int ret;
150 int irq;
151 struct xhci_plat_priv *priv = NULL;
152 bool of_match;
153
154 if (usb_disabled())
155 return -ENODEV;
156
157 driver = &xhci_plat_hc_driver;
158
159 irq = platform_get_irq(pdev, 0);
160 if (irq < 0)
161 return irq;
162
163 if (!sysdev)
164 sysdev = &pdev->dev;
165
166 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
167 if (ret)
168 return ret;
169
170 pm_runtime_set_active(&pdev->dev);
171 pm_runtime_enable(&pdev->dev);
172 pm_runtime_get_noresume(&pdev->dev);
173
174 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
175 dev_name(&pdev->dev), NULL);
176 if (!hcd) {
177 ret = -ENOMEM;
178 goto disable_runtime;
179 }
180
181 hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
182 if (IS_ERR(hcd->regs)) {
183 ret = PTR_ERR(hcd->regs);
184 goto put_hcd;
185 }
186
187 hcd->rsrc_start = res->start;
188 hcd->rsrc_len = resource_size(res);
189
190 xhci = hcd_to_xhci(hcd);
191
192 xhci->allow_single_roothub = 1;
193
194 /*
195 * Not all platforms have clks so it is not an error if the
196 * clock do not exist.
197 */
198 xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
199 if (IS_ERR(xhci->reg_clk)) {
200 ret = PTR_ERR(xhci->reg_clk);
201 goto put_hcd;
202 }
203
204 xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
205 if (IS_ERR(xhci->clk)) {
206 ret = PTR_ERR(xhci->clk);
207 goto put_hcd;
208 }
209
210 xhci->reset = devm_reset_control_array_get_optional_shared(&pdev->dev);
211 if (IS_ERR(xhci->reset)) {
212 ret = PTR_ERR(xhci->reset);
213 goto put_hcd;
214 }
215
216 ret = reset_control_deassert(xhci->reset);
217 if (ret)
218 goto put_hcd;
219
220 ret = clk_prepare_enable(xhci->reg_clk);
221 if (ret)
222 goto err_reset;
223
224 ret = clk_prepare_enable(xhci->clk);
225 if (ret)
226 goto disable_reg_clk;
227
228 if (priv_match) {
229 priv = hcd_to_xhci_priv(hcd);
230 /* Just copy data for now */
231 *priv = *priv_match;
232 }
233
234 device_set_wakeup_capable(&pdev->dev, true);
235
236 xhci->main_hcd = hcd;
237
238 /* imod_interval is the interrupt moderation value in nanoseconds. */
239 xhci->imod_interval = 40000;
240
241 /* Iterate over all parent nodes for finding quirks */
242 for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
243
244 if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
245 xhci->quirks |= XHCI_HW_LPM_DISABLE;
246
247 if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
248 xhci->quirks |= XHCI_LPM_SUPPORT;
249
250 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
251 xhci->quirks |= XHCI_BROKEN_PORT_PED;
252
253 if (device_property_read_bool(tmpdev, "xhci-sg-trb-cache-size-quirk"))
254 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
255
256 device_property_read_u32(tmpdev, "imod-interval-ns",
257 &xhci->imod_interval);
258 }
259
260 /*
261 * Drivers such as dwc3 manages PHYs themself (and rely on driver name
262 * matching for the xhci platform device).
263 */
264 of_match = of_match_device(pdev->dev.driver->of_match_table, &pdev->dev);
265 if (of_match) {
266 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
267 if (IS_ERR(hcd->usb_phy)) {
268 ret = PTR_ERR(hcd->usb_phy);
269 if (ret == -EPROBE_DEFER)
270 goto disable_clk;
271 hcd->usb_phy = NULL;
272 } else {
273 ret = usb_phy_init(hcd->usb_phy);
274 if (ret)
275 goto disable_clk;
276 }
277 }
278
279 hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
280
281 if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT))
282 hcd->skip_phy_initialization = 1;
283
284 if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK))
285 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
286
287 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
288 if (ret)
289 goto disable_usb_phy;
290
291 if (!xhci_has_one_roothub(xhci)) {
292 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
293 dev_name(&pdev->dev), hcd);
294 if (!xhci->shared_hcd) {
295 ret = -ENOMEM;
296 goto dealloc_usb2_hcd;
297 }
298
299 if (of_match) {
300 xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev,
301 "usb-phy", 1);
302 if (IS_ERR(xhci->shared_hcd->usb_phy)) {
303 xhci->shared_hcd->usb_phy = NULL;
304 } else {
305 ret = usb_phy_init(xhci->shared_hcd->usb_phy);
306 if (ret)
307 dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n",
308 __func__, ret);
309 }
310 }
311
312 xhci->shared_hcd->tpl_support = hcd->tpl_support;
313 }
314
315 usb3_hcd = xhci_get_usb3_hcd(xhci);
316 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4 &&
317 !(xhci->quirks & XHCI_BROKEN_STREAMS))
318 usb3_hcd->can_do_streams = 1;
319
320 if (xhci->shared_hcd) {
321 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
322 if (ret)
323 goto put_usb3_hcd;
324 }
325
326 device_enable_async_suspend(&pdev->dev);
327 pm_runtime_put_noidle(&pdev->dev);
328
329 /*
330 * Prevent runtime pm from being on as default, users should enable
331 * runtime pm using power/control in sysfs.
332 */
333 pm_runtime_forbid(&pdev->dev);
334
335 return 0;
336
337
338 put_usb3_hcd:
339 usb_put_hcd(xhci->shared_hcd);
340
341 dealloc_usb2_hcd:
342 usb_remove_hcd(hcd);
343
344 disable_usb_phy:
345 usb_phy_shutdown(hcd->usb_phy);
346
347 disable_clk:
348 clk_disable_unprepare(xhci->clk);
349
350 disable_reg_clk:
351 clk_disable_unprepare(xhci->reg_clk);
352
353 err_reset:
354 reset_control_assert(xhci->reset);
355
356 put_hcd:
357 usb_put_hcd(hcd);
358
359 disable_runtime:
360 pm_runtime_put_noidle(&pdev->dev);
361 pm_runtime_disable(&pdev->dev);
362
363 return ret;
364 }
365 EXPORT_SYMBOL_GPL(xhci_plat_probe);
366
xhci_generic_plat_probe(struct platform_device * pdev)367 static int xhci_generic_plat_probe(struct platform_device *pdev)
368 {
369 const struct xhci_plat_priv *priv_match;
370 struct device *sysdev;
371 int ret;
372
373 /*
374 * sysdev must point to a device that is known to the system firmware
375 * or PCI hardware. We handle these three cases here:
376 * 1. xhci_plat comes from firmware
377 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
378 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
379 */
380 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
381 if (is_of_node(sysdev->fwnode) ||
382 is_acpi_device_node(sysdev->fwnode))
383 break;
384 else if (dev_is_pci(sysdev))
385 break;
386 }
387
388 if (!sysdev)
389 sysdev = &pdev->dev;
390
391 if (WARN_ON(!sysdev->dma_mask)) {
392 /* Platform did not initialize dma_mask */
393 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
394 if (ret)
395 return ret;
396 }
397
398 if (pdev->dev.of_node)
399 priv_match = of_device_get_match_data(&pdev->dev);
400 else
401 priv_match = dev_get_platdata(&pdev->dev);
402
403 return xhci_plat_probe(pdev, sysdev, priv_match);
404 }
405
xhci_plat_remove(struct platform_device * dev)406 void xhci_plat_remove(struct platform_device *dev)
407 {
408 struct usb_hcd *hcd = platform_get_drvdata(dev);
409 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
410 struct clk *clk = xhci->clk;
411 struct clk *reg_clk = xhci->reg_clk;
412 struct usb_hcd *shared_hcd = xhci->shared_hcd;
413
414 xhci->xhc_state |= XHCI_STATE_REMOVING;
415 pm_runtime_get_sync(&dev->dev);
416
417 if (shared_hcd) {
418 usb_remove_hcd(shared_hcd);
419 xhci->shared_hcd = NULL;
420 }
421
422 usb_phy_shutdown(hcd->usb_phy);
423
424 usb_remove_hcd(hcd);
425
426 if (shared_hcd)
427 usb_put_hcd(shared_hcd);
428
429 clk_disable_unprepare(clk);
430 clk_disable_unprepare(reg_clk);
431 reset_control_assert(xhci->reset);
432 usb_put_hcd(hcd);
433
434 pm_runtime_disable(&dev->dev);
435 pm_runtime_put_noidle(&dev->dev);
436 pm_runtime_set_suspended(&dev->dev);
437 }
438 EXPORT_SYMBOL_GPL(xhci_plat_remove);
439
xhci_plat_suspend(struct device * dev)440 static int xhci_plat_suspend(struct device *dev)
441 {
442 struct usb_hcd *hcd = dev_get_drvdata(dev);
443 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
444 int ret;
445
446 if (pm_runtime_suspended(dev))
447 pm_runtime_resume(dev);
448
449 ret = xhci_priv_suspend_quirk(hcd);
450 if (ret)
451 return ret;
452 /*
453 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
454 * to do wakeup during suspend.
455 */
456 ret = xhci_suspend(xhci, device_may_wakeup(dev));
457 if (ret)
458 return ret;
459
460 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
461 clk_disable_unprepare(xhci->clk);
462 clk_disable_unprepare(xhci->reg_clk);
463 }
464
465 return 0;
466 }
467
xhci_plat_resume_common(struct device * dev,struct pm_message pmsg)468 static int xhci_plat_resume_common(struct device *dev, struct pm_message pmsg)
469 {
470 struct usb_hcd *hcd = dev_get_drvdata(dev);
471 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
472 int ret;
473
474 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
475 ret = clk_prepare_enable(xhci->clk);
476 if (ret)
477 return ret;
478
479 ret = clk_prepare_enable(xhci->reg_clk);
480 if (ret) {
481 clk_disable_unprepare(xhci->clk);
482 return ret;
483 }
484 }
485
486 ret = xhci_priv_resume_quirk(hcd);
487 if (ret)
488 goto disable_clks;
489
490 ret = xhci_resume(xhci, pmsg);
491 if (ret)
492 goto disable_clks;
493
494 pm_runtime_disable(dev);
495 pm_runtime_set_active(dev);
496 pm_runtime_enable(dev);
497
498 return 0;
499
500 disable_clks:
501 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
502 clk_disable_unprepare(xhci->clk);
503 clk_disable_unprepare(xhci->reg_clk);
504 }
505
506 return ret;
507 }
508
xhci_plat_resume(struct device * dev)509 static int xhci_plat_resume(struct device *dev)
510 {
511 return xhci_plat_resume_common(dev, PMSG_RESUME);
512 }
513
xhci_plat_restore(struct device * dev)514 static int xhci_plat_restore(struct device *dev)
515 {
516 return xhci_plat_resume_common(dev, PMSG_RESTORE);
517 }
518
xhci_plat_runtime_suspend(struct device * dev)519 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
520 {
521 struct usb_hcd *hcd = dev_get_drvdata(dev);
522 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
523 int ret;
524
525 ret = xhci_priv_suspend_quirk(hcd);
526 if (ret)
527 return ret;
528
529 return xhci_suspend(xhci, true);
530 }
531
xhci_plat_runtime_resume(struct device * dev)532 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
533 {
534 struct usb_hcd *hcd = dev_get_drvdata(dev);
535 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
536
537 return xhci_resume(xhci, PMSG_AUTO_RESUME);
538 }
539
540 const struct dev_pm_ops xhci_plat_pm_ops = {
541 .suspend = pm_sleep_ptr(xhci_plat_suspend),
542 .resume = pm_sleep_ptr(xhci_plat_resume),
543 .freeze = pm_sleep_ptr(xhci_plat_suspend),
544 .thaw = pm_sleep_ptr(xhci_plat_resume),
545 .poweroff = pm_sleep_ptr(xhci_plat_suspend),
546 .restore = pm_sleep_ptr(xhci_plat_restore),
547
548 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
549 xhci_plat_runtime_resume,
550 NULL)
551 };
552 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops);
553
554 #ifdef CONFIG_ACPI
555 static const struct acpi_device_id usb_xhci_acpi_match[] = {
556 /* XHCI-compliant USB Controller */
557 { "PNP0D10", },
558 { }
559 };
560 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
561 #endif
562
563 static struct platform_driver usb_generic_xhci_driver = {
564 .probe = xhci_generic_plat_probe,
565 .remove_new = xhci_plat_remove,
566 .shutdown = usb_hcd_platform_shutdown,
567 .driver = {
568 .name = "xhci-hcd",
569 .pm = &xhci_plat_pm_ops,
570 .of_match_table = of_match_ptr(usb_xhci_of_match),
571 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
572 },
573 };
574 MODULE_ALIAS("platform:xhci-hcd");
575
xhci_plat_init(void)576 static int __init xhci_plat_init(void)
577 {
578 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
579 return platform_driver_register(&usb_generic_xhci_driver);
580 }
581 module_init(xhci_plat_init);
582
xhci_plat_exit(void)583 static void __exit xhci_plat_exit(void)
584 {
585 platform_driver_unregister(&usb_generic_xhci_driver);
586 }
587 module_exit(xhci_plat_exit);
588
589 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
590 MODULE_LICENSE("GPL");
591