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 .init_quirk = xhci_mvebu_a3700_init_quirk,
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,bcm2711-xhci",
135 .data = &xhci_plat_brcm,
136 }, {
137 .compatible = "brcm,bcm7445-xhci",
138 .data = &xhci_plat_brcm,
139 },
140 {},
141 };
142 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
143 #endif
144
xhci_plat_probe(struct platform_device * pdev,struct device * sysdev,const struct xhci_plat_priv * priv_match)145 int xhci_plat_probe(struct platform_device *pdev, struct device *sysdev, const struct xhci_plat_priv *priv_match)
146 {
147 const struct hc_driver *driver;
148 struct device *tmpdev;
149 struct xhci_hcd *xhci;
150 struct resource *res;
151 struct usb_hcd *hcd, *usb3_hcd;
152 int ret;
153 int irq;
154 struct xhci_plat_priv *priv = NULL;
155 bool of_match;
156
157 if (usb_disabled())
158 return -ENODEV;
159
160 driver = &xhci_plat_hc_driver;
161
162 irq = platform_get_irq(pdev, 0);
163 if (irq < 0)
164 return irq;
165
166 if (!sysdev)
167 sysdev = &pdev->dev;
168
169 ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
170 if (ret)
171 return ret;
172
173 pm_runtime_set_active(&pdev->dev);
174 pm_runtime_enable(&pdev->dev);
175 pm_runtime_get_noresume(&pdev->dev);
176
177 hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
178 dev_name(&pdev->dev), NULL);
179 if (!hcd) {
180 ret = -ENOMEM;
181 goto disable_runtime;
182 }
183
184 hcd->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
185 if (IS_ERR(hcd->regs)) {
186 ret = PTR_ERR(hcd->regs);
187 goto put_hcd;
188 }
189
190 hcd->rsrc_start = res->start;
191 hcd->rsrc_len = resource_size(res);
192
193 xhci = hcd_to_xhci(hcd);
194
195 xhci->allow_single_roothub = 1;
196
197 /*
198 * Not all platforms have clks so it is not an error if the
199 * clock do not exist.
200 */
201 xhci->reg_clk = devm_clk_get_optional(&pdev->dev, "reg");
202 if (IS_ERR(xhci->reg_clk)) {
203 ret = PTR_ERR(xhci->reg_clk);
204 goto put_hcd;
205 }
206
207 xhci->clk = devm_clk_get_optional(&pdev->dev, NULL);
208 if (IS_ERR(xhci->clk)) {
209 ret = PTR_ERR(xhci->clk);
210 goto put_hcd;
211 }
212
213 xhci->reset = devm_reset_control_array_get_optional_shared(&pdev->dev);
214 if (IS_ERR(xhci->reset)) {
215 ret = PTR_ERR(xhci->reset);
216 goto put_hcd;
217 }
218
219 ret = reset_control_deassert(xhci->reset);
220 if (ret)
221 goto put_hcd;
222
223 ret = clk_prepare_enable(xhci->reg_clk);
224 if (ret)
225 goto err_reset;
226
227 ret = clk_prepare_enable(xhci->clk);
228 if (ret)
229 goto disable_reg_clk;
230
231 if (priv_match) {
232 priv = hcd_to_xhci_priv(hcd);
233 /* Just copy data for now */
234 *priv = *priv_match;
235 }
236
237 device_set_wakeup_capable(&pdev->dev, true);
238
239 xhci->main_hcd = hcd;
240
241 /* imod_interval is the interrupt moderation value in nanoseconds. */
242 xhci->imod_interval = 40000;
243
244 /* Iterate over all parent nodes for finding quirks */
245 for (tmpdev = &pdev->dev; tmpdev; tmpdev = tmpdev->parent) {
246
247 if (device_property_read_bool(tmpdev, "usb2-lpm-disable"))
248 xhci->quirks |= XHCI_HW_LPM_DISABLE;
249
250 if (device_property_read_bool(tmpdev, "usb3-lpm-capable"))
251 xhci->quirks |= XHCI_LPM_SUPPORT;
252
253 if (device_property_read_bool(tmpdev, "quirk-broken-port-ped"))
254 xhci->quirks |= XHCI_BROKEN_PORT_PED;
255
256 if (device_property_read_bool(tmpdev, "xhci-sg-trb-cache-size-quirk"))
257 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
258
259 if (device_property_read_bool(tmpdev, "write-64-hi-lo-quirk"))
260 xhci->quirks |= XHCI_WRITE_64_HI_LO;
261
262 device_property_read_u32(tmpdev, "imod-interval-ns",
263 &xhci->imod_interval);
264 }
265
266 /*
267 * Drivers such as dwc3 manages PHYs themself (and rely on driver name
268 * matching for the xhci platform device).
269 */
270 of_match = of_match_device(pdev->dev.driver->of_match_table, &pdev->dev);
271 if (of_match) {
272 hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0);
273 if (IS_ERR(hcd->usb_phy)) {
274 ret = PTR_ERR(hcd->usb_phy);
275 if (ret == -EPROBE_DEFER)
276 goto disable_clk;
277 hcd->usb_phy = NULL;
278 } else {
279 ret = usb_phy_init(hcd->usb_phy);
280 if (ret)
281 goto disable_clk;
282 }
283 }
284
285 hcd->tpl_support = of_usb_host_tpl_support(sysdev->of_node);
286
287 if (priv && (priv->quirks & XHCI_SKIP_PHY_INIT))
288 hcd->skip_phy_initialization = 1;
289
290 if (priv && (priv->quirks & XHCI_SG_TRB_CACHE_SIZE_QUIRK))
291 xhci->quirks |= XHCI_SG_TRB_CACHE_SIZE_QUIRK;
292
293 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
294 if (ret)
295 goto disable_usb_phy;
296
297 if (!xhci_has_one_roothub(xhci)) {
298 xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev,
299 dev_name(&pdev->dev), hcd);
300 if (!xhci->shared_hcd) {
301 ret = -ENOMEM;
302 goto dealloc_usb2_hcd;
303 }
304
305 if (of_match) {
306 xhci->shared_hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev,
307 "usb-phy", 1);
308 if (IS_ERR(xhci->shared_hcd->usb_phy)) {
309 xhci->shared_hcd->usb_phy = NULL;
310 } else {
311 ret = usb_phy_init(xhci->shared_hcd->usb_phy);
312 if (ret)
313 dev_err(sysdev, "%s init usb3phy fail (ret=%d)\n",
314 __func__, ret);
315 }
316 }
317
318 xhci->shared_hcd->tpl_support = hcd->tpl_support;
319 }
320
321 usb3_hcd = xhci_get_usb3_hcd(xhci);
322 if (usb3_hcd && HCC_MAX_PSA(xhci->hcc_params) >= 4)
323 usb3_hcd->can_do_streams = 1;
324
325 if (xhci->shared_hcd) {
326 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
327 if (ret)
328 goto put_usb3_hcd;
329 }
330
331 device_enable_async_suspend(&pdev->dev);
332 pm_runtime_put_noidle(&pdev->dev);
333
334 /*
335 * Prevent runtime pm from being on as default, users should enable
336 * runtime pm using power/control in sysfs.
337 */
338 pm_runtime_forbid(&pdev->dev);
339
340 return 0;
341
342
343 put_usb3_hcd:
344 usb_put_hcd(xhci->shared_hcd);
345
346 dealloc_usb2_hcd:
347 usb_remove_hcd(hcd);
348
349 disable_usb_phy:
350 usb_phy_shutdown(hcd->usb_phy);
351
352 disable_clk:
353 clk_disable_unprepare(xhci->clk);
354
355 disable_reg_clk:
356 clk_disable_unprepare(xhci->reg_clk);
357
358 err_reset:
359 reset_control_assert(xhci->reset);
360
361 put_hcd:
362 usb_put_hcd(hcd);
363
364 disable_runtime:
365 pm_runtime_put_noidle(&pdev->dev);
366 pm_runtime_disable(&pdev->dev);
367
368 return ret;
369 }
370 EXPORT_SYMBOL_GPL(xhci_plat_probe);
371
xhci_generic_plat_probe(struct platform_device * pdev)372 static int xhci_generic_plat_probe(struct platform_device *pdev)
373 {
374 const struct xhci_plat_priv *priv_match;
375 struct device *sysdev;
376 int ret;
377
378 /*
379 * sysdev must point to a device that is known to the system firmware
380 * or PCI hardware. We handle these three cases here:
381 * 1. xhci_plat comes from firmware
382 * 2. xhci_plat is child of a device from firmware (dwc3-plat)
383 * 3. xhci_plat is grandchild of a pci device (dwc3-pci)
384 */
385 for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) {
386 if (is_of_node(sysdev->fwnode) ||
387 is_acpi_device_node(sysdev->fwnode))
388 break;
389 else if (dev_is_pci(sysdev))
390 break;
391 }
392
393 if (!sysdev)
394 sysdev = &pdev->dev;
395
396 if (WARN_ON(!sysdev->dma_mask)) {
397 /* Platform did not initialize dma_mask */
398 ret = dma_coerce_mask_and_coherent(sysdev, DMA_BIT_MASK(64));
399 if (ret)
400 return ret;
401 }
402
403 if (pdev->dev.of_node)
404 priv_match = of_device_get_match_data(&pdev->dev);
405 else
406 priv_match = dev_get_platdata(&pdev->dev);
407
408 return xhci_plat_probe(pdev, sysdev, priv_match);
409 }
410
xhci_plat_remove(struct platform_device * dev)411 void xhci_plat_remove(struct platform_device *dev)
412 {
413 struct usb_hcd *hcd = platform_get_drvdata(dev);
414 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
415 struct clk *clk = xhci->clk;
416 struct clk *reg_clk = xhci->reg_clk;
417 struct usb_hcd *shared_hcd = xhci->shared_hcd;
418
419 xhci->xhc_state |= XHCI_STATE_REMOVING;
420 pm_runtime_get_sync(&dev->dev);
421
422 if (shared_hcd) {
423 usb_remove_hcd(shared_hcd);
424 xhci->shared_hcd = NULL;
425 }
426
427 usb_phy_shutdown(hcd->usb_phy);
428
429 usb_remove_hcd(hcd);
430
431 if (shared_hcd)
432 usb_put_hcd(shared_hcd);
433
434 clk_disable_unprepare(clk);
435 clk_disable_unprepare(reg_clk);
436 reset_control_assert(xhci->reset);
437 usb_put_hcd(hcd);
438
439 pm_runtime_disable(&dev->dev);
440 pm_runtime_put_noidle(&dev->dev);
441 pm_runtime_set_suspended(&dev->dev);
442 }
443 EXPORT_SYMBOL_GPL(xhci_plat_remove);
444
xhci_plat_suspend(struct device * dev)445 static int xhci_plat_suspend(struct device *dev)
446 {
447 struct usb_hcd *hcd = dev_get_drvdata(dev);
448 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
449 int ret;
450
451 if (pm_runtime_suspended(dev))
452 pm_runtime_resume(dev);
453
454 ret = xhci_priv_suspend_quirk(hcd);
455 if (ret)
456 return ret;
457 /*
458 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
459 * to do wakeup during suspend.
460 */
461 ret = xhci_suspend(xhci, device_may_wakeup(dev));
462 if (ret)
463 return ret;
464
465 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
466 clk_disable_unprepare(xhci->clk);
467 clk_disable_unprepare(xhci->reg_clk);
468 }
469
470 return 0;
471 }
472
xhci_plat_resume_common(struct device * dev,struct pm_message pmsg)473 static int xhci_plat_resume_common(struct device *dev, struct pm_message pmsg)
474 {
475 struct usb_hcd *hcd = dev_get_drvdata(dev);
476 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
477 int ret;
478
479 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
480 ret = clk_prepare_enable(xhci->clk);
481 if (ret)
482 return ret;
483
484 ret = clk_prepare_enable(xhci->reg_clk);
485 if (ret) {
486 clk_disable_unprepare(xhci->clk);
487 return ret;
488 }
489 }
490
491 ret = xhci_priv_resume_quirk(hcd);
492 if (ret)
493 goto disable_clks;
494
495 ret = xhci_resume(xhci, pmsg);
496 if (ret)
497 goto disable_clks;
498
499 pm_runtime_disable(dev);
500 pm_runtime_set_active(dev);
501 pm_runtime_enable(dev);
502
503 return 0;
504
505 disable_clks:
506 if (!device_may_wakeup(dev) && (xhci->quirks & XHCI_SUSPEND_RESUME_CLKS)) {
507 clk_disable_unprepare(xhci->clk);
508 clk_disable_unprepare(xhci->reg_clk);
509 }
510
511 return ret;
512 }
513
xhci_plat_resume(struct device * dev)514 static int xhci_plat_resume(struct device *dev)
515 {
516 return xhci_plat_resume_common(dev, PMSG_RESUME);
517 }
518
xhci_plat_restore(struct device * dev)519 static int xhci_plat_restore(struct device *dev)
520 {
521 return xhci_plat_resume_common(dev, PMSG_RESTORE);
522 }
523
xhci_plat_runtime_suspend(struct device * dev)524 static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev)
525 {
526 struct usb_hcd *hcd = dev_get_drvdata(dev);
527 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
528 int ret;
529
530 ret = xhci_priv_suspend_quirk(hcd);
531 if (ret)
532 return ret;
533
534 return xhci_suspend(xhci, true);
535 }
536
xhci_plat_runtime_resume(struct device * dev)537 static int __maybe_unused xhci_plat_runtime_resume(struct device *dev)
538 {
539 struct usb_hcd *hcd = dev_get_drvdata(dev);
540 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
541
542 return xhci_resume(xhci, PMSG_AUTO_RESUME);
543 }
544
545 const struct dev_pm_ops xhci_plat_pm_ops = {
546 .suspend = pm_sleep_ptr(xhci_plat_suspend),
547 .resume = pm_sleep_ptr(xhci_plat_resume),
548 .freeze = pm_sleep_ptr(xhci_plat_suspend),
549 .thaw = pm_sleep_ptr(xhci_plat_resume),
550 .poweroff = pm_sleep_ptr(xhci_plat_suspend),
551 .restore = pm_sleep_ptr(xhci_plat_restore),
552
553 SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend,
554 xhci_plat_runtime_resume,
555 NULL)
556 };
557 EXPORT_SYMBOL_GPL(xhci_plat_pm_ops);
558
559 #ifdef CONFIG_ACPI
560 static const struct acpi_device_id usb_xhci_acpi_match[] = {
561 /* XHCI-compliant USB Controller */
562 { "PNP0D10", },
563 { }
564 };
565 MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match);
566 #endif
567
568 static struct platform_driver usb_generic_xhci_driver = {
569 .probe = xhci_generic_plat_probe,
570 .remove_new = xhci_plat_remove,
571 .shutdown = usb_hcd_platform_shutdown,
572 .driver = {
573 .name = "xhci-hcd",
574 .pm = &xhci_plat_pm_ops,
575 .of_match_table = of_match_ptr(usb_xhci_of_match),
576 .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match),
577 },
578 };
579 MODULE_ALIAS("platform:xhci-hcd");
580
xhci_plat_init(void)581 static int __init xhci_plat_init(void)
582 {
583 xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides);
584 return platform_driver_register(&usb_generic_xhci_driver);
585 }
586 module_init(xhci_plat_init);
587
xhci_plat_exit(void)588 static void __exit xhci_plat_exit(void)
589 {
590 platform_driver_unregister(&usb_generic_xhci_driver);
591 }
592 module_exit(xhci_plat_exit);
593
594 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
595 MODULE_LICENSE("GPL");
596