Commit | Line | Data |
---|---|---|
5fd54ace | 1 | // SPDX-License-Identifier: GPL-2.0 |
3429e91a SAS |
2 | /* |
3 | * xhci-plat.c - xHCI host controller driver platform Bus Glue. | |
4 | * | |
5 | * Copyright (C) 2012 Texas Instruments Incorporated - http://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 | * This program is free software; you can redistribute it and/or | |
11 | * modify it under the terms of the GNU General Public License | |
12 | * version 2 as published by the Free Software Foundation. | |
13 | */ | |
14 | ||
4718c177 | 15 | #include <linux/clk.h> |
48157bb9 | 16 | #include <linux/dma-mapping.h> |
3429e91a | 17 | #include <linux/module.h> |
4c39d4b9 | 18 | #include <linux/pci.h> |
1fe6c452 | 19 | #include <linux/of.h> |
2847d242 | 20 | #include <linux/of_device.h> |
48157bb9 | 21 | #include <linux/platform_device.h> |
7b8ef22e | 22 | #include <linux/usb/phy.h> |
48157bb9 | 23 | #include <linux/slab.h> |
579085b5 | 24 | #include <linux/acpi.h> |
3429e91a SAS |
25 | |
26 | #include "xhci.h" | |
4efb2f69 | 27 | #include "xhci-plat.h" |
97374792 | 28 | #include "xhci-mvebu.h" |
4ac8918f | 29 | #include "xhci-rcar.h" |
3429e91a | 30 | |
1885d9a3 AB |
31 | static struct hc_driver __read_mostly xhci_plat_hc_driver; |
32 | ||
cd33a321 RQ |
33 | static int xhci_plat_setup(struct usb_hcd *hcd); |
34 | static int xhci_plat_start(struct usb_hcd *hcd); | |
35 | ||
36 | static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { | |
4efb2f69 | 37 | .extra_priv_size = sizeof(struct xhci_plat_priv), |
cd33a321 RQ |
38 | .reset = xhci_plat_setup, |
39 | .start = xhci_plat_start, | |
40 | }; | |
41 | ||
b1c127ae | 42 | static void xhci_priv_plat_start(struct usb_hcd *hcd) |
3429e91a | 43 | { |
b1c127ae FB |
44 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); |
45 | ||
46 | if (priv->plat_start) | |
47 | priv->plat_start(hcd); | |
48 | } | |
49 | ||
50 | static int xhci_priv_init_quirk(struct usb_hcd *hcd) | |
51 | { | |
52 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
53 | ||
54 | if (!priv->init_quirk) | |
55 | return 0; | |
56 | ||
57 | return priv->init_quirk(hcd); | |
58 | } | |
5ad3b03e | 59 | |
98c0a3ff YS |
60 | static int xhci_priv_resume_quirk(struct usb_hcd *hcd) |
61 | { | |
62 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
63 | ||
64 | if (!priv->resume_quirk) | |
65 | return 0; | |
66 | ||
67 | return priv->resume_quirk(hcd); | |
68 | } | |
69 | ||
b1c127ae FB |
70 | static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) |
71 | { | |
3429e91a SAS |
72 | /* |
73 | * As of now platform drivers don't provide MSI support so we ensure | |
74 | * here that the generic code does not try to make a pci_dev from our | |
75 | * dev struct in order to setup MSI | |
76 | */ | |
52fb6125 | 77 | xhci->quirks |= XHCI_PLAT; |
3429e91a SAS |
78 | } |
79 | ||
80 | /* called during probe() after chip reset completes */ | |
81 | static int xhci_plat_setup(struct usb_hcd *hcd) | |
82 | { | |
4ac8918f YS |
83 | int ret; |
84 | ||
4ac8918f | 85 | |
b1c127ae FB |
86 | ret = xhci_priv_init_quirk(hcd); |
87 | if (ret) | |
88 | return ret; | |
3bdb263d | 89 | |
3429e91a SAS |
90 | return xhci_gen_setup(hcd, xhci_plat_quirks); |
91 | } | |
92 | ||
94adcdce YS |
93 | static int xhci_plat_start(struct usb_hcd *hcd) |
94 | { | |
b1c127ae | 95 | xhci_priv_plat_start(hcd); |
94adcdce YS |
96 | return xhci_run(hcd); |
97 | } | |
98 | ||
4efb2f69 YS |
99 | #ifdef CONFIG_OF |
100 | static const struct xhci_plat_priv xhci_plat_marvell_armada = { | |
b1c127ae | 101 | .init_quirk = xhci_mvebu_mbus_init_quirk, |
4efb2f69 YS |
102 | }; |
103 | ||
104 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { | |
9bf9d9d6 | 105 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, |
b1c127ae FB |
106 | .init_quirk = xhci_rcar_init_quirk, |
107 | .plat_start = xhci_rcar_start, | |
435cc113 | 108 | .resume_quirk = xhci_rcar_resume_quirk, |
4efb2f69 YS |
109 | }; |
110 | ||
526a240f | 111 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { |
3f1dae6b YS |
112 | .init_quirk = xhci_rcar_init_quirk, |
113 | .plat_start = xhci_rcar_start, | |
435cc113 | 114 | .resume_quirk = xhci_rcar_resume_quirk, |
3f1dae6b YS |
115 | }; |
116 | ||
4efb2f69 YS |
117 | static const struct of_device_id usb_xhci_of_match[] = { |
118 | { | |
119 | .compatible = "generic-xhci", | |
120 | }, { | |
121 | .compatible = "xhci-platform", | |
122 | }, { | |
123 | .compatible = "marvell,armada-375-xhci", | |
124 | .data = &xhci_plat_marvell_armada, | |
125 | }, { | |
126 | .compatible = "marvell,armada-380-xhci", | |
127 | .data = &xhci_plat_marvell_armada, | |
128 | }, { | |
129 | .compatible = "renesas,xhci-r8a7790", | |
130 | .data = &xhci_plat_renesas_rcar_gen2, | |
131 | }, { | |
132 | .compatible = "renesas,xhci-r8a7791", | |
133 | .data = &xhci_plat_renesas_rcar_gen2, | |
82487b71 YS |
134 | }, { |
135 | .compatible = "renesas,xhci-r8a7793", | |
136 | .data = &xhci_plat_renesas_rcar_gen2, | |
526a240f YS |
137 | }, { |
138 | .compatible = "renesas,xhci-r8a7795", | |
139 | .data = &xhci_plat_renesas_rcar_gen3, | |
3f1dae6b YS |
140 | }, { |
141 | .compatible = "renesas,xhci-r8a7796", | |
4dd51864 | 142 | .data = &xhci_plat_renesas_rcar_gen3, |
4efb2f69 | 143 | }, { |
f1bbdc3b SH |
144 | .compatible = "renesas,rcar-gen2-xhci", |
145 | .data = &xhci_plat_renesas_rcar_gen2, | |
146 | }, { | |
147 | .compatible = "renesas,rcar-gen3-xhci", | |
148 | .data = &xhci_plat_renesas_rcar_gen3, | |
4efb2f69 | 149 | }, |
ff075d67 | 150 | {}, |
4efb2f69 YS |
151 | }; |
152 | MODULE_DEVICE_TABLE(of, usb_xhci_of_match); | |
153 | #endif | |
154 | ||
3429e91a SAS |
155 | static int xhci_plat_probe(struct platform_device *pdev) |
156 | { | |
2847d242 | 157 | const struct xhci_plat_priv *priv_match; |
3429e91a | 158 | const struct hc_driver *driver; |
4c39d4b9 | 159 | struct device *sysdev; |
3429e91a SAS |
160 | struct xhci_hcd *xhci; |
161 | struct resource *res; | |
162 | struct usb_hcd *hcd; | |
4718c177 | 163 | struct clk *clk; |
3429e91a SAS |
164 | int ret; |
165 | int irq; | |
166 | ||
167 | if (usb_disabled()) | |
168 | return -ENODEV; | |
169 | ||
1885d9a3 | 170 | driver = &xhci_plat_hc_driver; |
3429e91a SAS |
171 | |
172 | irq = platform_get_irq(pdev, 0); | |
173 | if (irq < 0) | |
4b148d51 | 174 | return irq; |
3429e91a | 175 | |
4c39d4b9 AB |
176 | /* |
177 | * sysdev must point to a device that is known to the system firmware | |
178 | * or PCI hardware. We handle these three cases here: | |
179 | * 1. xhci_plat comes from firmware | |
180 | * 2. xhci_plat is child of a device from firmware (dwc3-plat) | |
181 | * 3. xhci_plat is grandchild of a pci device (dwc3-pci) | |
182 | */ | |
c6b8e793 AW |
183 | for (sysdev = &pdev->dev; sysdev; sysdev = sysdev->parent) { |
184 | if (is_of_node(sysdev->fwnode) || | |
185 | is_acpi_device_node(sysdev->fwnode)) | |
186 | break; | |
4c39d4b9 | 187 | #ifdef CONFIG_PCI |
c6b8e793 AW |
188 | else if (sysdev->bus == &pci_bus_type) |
189 | break; | |
4c39d4b9 | 190 | #endif |
c6b8e793 AW |
191 | } |
192 | ||
193 | if (!sysdev) | |
194 | sysdev = &pdev->dev; | |
4c39d4b9 | 195 | |
0ebbe398 | 196 | /* Try to set 64-bit DMA first */ |
4c39d4b9 | 197 | if (WARN_ON(!sysdev->dma_mask)) |
0ebbe398 | 198 | /* Platform did not initialize dma_mask */ |
4c39d4b9 | 199 | ret = dma_coerce_mask_and_coherent(sysdev, |
0ebbe398 | 200 | DMA_BIT_MASK(64)); |
c10cf118 | 201 | else |
4c39d4b9 | 202 | ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); |
0ebbe398 DD |
203 | |
204 | /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ | |
205 | if (ret) { | |
4c39d4b9 | 206 | ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32)); |
0ebbe398 DD |
207 | if (ret) |
208 | return ret; | |
209 | } | |
c10cf118 | 210 | |
b0c69b4b BW |
211 | pm_runtime_set_active(&pdev->dev); |
212 | pm_runtime_enable(&pdev->dev); | |
213 | pm_runtime_get_noresume(&pdev->dev); | |
214 | ||
4c39d4b9 AB |
215 | hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, |
216 | dev_name(&pdev->dev), NULL); | |
b0c69b4b BW |
217 | if (!hcd) { |
218 | ret = -ENOMEM; | |
219 | goto disable_runtime; | |
220 | } | |
3429e91a | 221 | |
e7020f19 | 222 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
fd666348 HS |
223 | hcd->regs = devm_ioremap_resource(&pdev->dev, res); |
224 | if (IS_ERR(hcd->regs)) { | |
225 | ret = PTR_ERR(hcd->regs); | |
3429e91a SAS |
226 | goto put_hcd; |
227 | } | |
228 | ||
e7020f19 VB |
229 | hcd->rsrc_start = res->start; |
230 | hcd->rsrc_len = resource_size(res); | |
231 | ||
4718c177 GC |
232 | /* |
233 | * Not all platforms have a clk so it is not an error if the | |
234 | * clock does not exists. | |
235 | */ | |
236 | clk = devm_clk_get(&pdev->dev, NULL); | |
237 | if (!IS_ERR(clk)) { | |
238 | ret = clk_prepare_enable(clk); | |
239 | if (ret) | |
fd666348 | 240 | goto put_hcd; |
de95c40d TP |
241 | } else if (PTR_ERR(clk) == -EPROBE_DEFER) { |
242 | ret = -EPROBE_DEFER; | |
243 | goto put_hcd; | |
4718c177 GC |
244 | } |
245 | ||
4efb2f69 | 246 | xhci = hcd_to_xhci(hcd); |
2847d242 GU |
247 | priv_match = of_device_get_match_data(&pdev->dev); |
248 | if (priv_match) { | |
4efb2f69 YS |
249 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); |
250 | ||
251 | /* Just copy data for now */ | |
2ad294d5 GC |
252 | if (priv_match) |
253 | *priv = *priv_match; | |
4efb2f69 YS |
254 | } |
255 | ||
3c9740a1 | 256 | device_wakeup_enable(hcd->self.controller); |
3429e91a | 257 | |
4718c177 | 258 | xhci->clk = clk; |
9fa733f2 | 259 | xhci->main_hcd = hcd; |
4c39d4b9 | 260 | xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, |
3429e91a SAS |
261 | dev_name(&pdev->dev), hcd); |
262 | if (!xhci->shared_hcd) { | |
263 | ret = -ENOMEM; | |
4ac53087 | 264 | goto disable_clk; |
3429e91a SAS |
265 | } |
266 | ||
4750bc78 TN |
267 | if (device_property_read_bool(sysdev, "usb2-lpm-disable")) |
268 | xhci->quirks |= XHCI_HW_LPM_DISABLE; | |
269 | ||
4c39d4b9 | 270 | if (device_property_read_bool(sysdev, "usb3-lpm-capable")) |
20f6fdd0 | 271 | xhci->quirks |= XHCI_LPM_SUPPORT; |
3429e91a | 272 | |
21939f00 FB |
273 | if (device_property_read_bool(&pdev->dev, "quirk-broken-port-ped")) |
274 | xhci->quirks |= XHCI_BROKEN_PORT_PED; | |
275 | ||
4c39d4b9 | 276 | hcd->usb_phy = devm_usb_get_phy_by_phandle(sysdev, "usb-phy", 0); |
7b8ef22e MR |
277 | if (IS_ERR(hcd->usb_phy)) { |
278 | ret = PTR_ERR(hcd->usb_phy); | |
279 | if (ret == -EPROBE_DEFER) | |
280 | goto put_usb3_hcd; | |
281 | hcd->usb_phy = NULL; | |
282 | } else { | |
283 | ret = usb_phy_init(hcd->usb_phy); | |
284 | if (ret) | |
285 | goto put_usb3_hcd; | |
286 | } | |
287 | ||
4ac53087 | 288 | ret = usb_add_hcd(hcd, irq, IRQF_SHARED); |
3429e91a | 289 | if (ret) |
7b8ef22e | 290 | goto disable_usb_phy; |
3429e91a | 291 | |
5de4e1ea W |
292 | if (HCC_MAX_PSA(xhci->hcc_params) >= 4) |
293 | xhci->shared_hcd->can_do_streams = 1; | |
294 | ||
4ac53087 RQ |
295 | ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); |
296 | if (ret) | |
297 | goto dealloc_usb2_hcd; | |
298 | ||
c70a1529 | 299 | device_enable_async_suspend(&pdev->dev); |
b0c69b4b BW |
300 | pm_runtime_put_noidle(&pdev->dev); |
301 | ||
302 | /* | |
303 | * Prevent runtime pm from being on as default, users should enable | |
304 | * runtime pm using power/control in sysfs. | |
305 | */ | |
306 | pm_runtime_forbid(&pdev->dev); | |
c70a1529 | 307 | |
3429e91a SAS |
308 | return 0; |
309 | ||
4ac53087 RQ |
310 | |
311 | dealloc_usb2_hcd: | |
312 | usb_remove_hcd(hcd); | |
313 | ||
7b8ef22e MR |
314 | disable_usb_phy: |
315 | usb_phy_shutdown(hcd->usb_phy); | |
316 | ||
3429e91a SAS |
317 | put_usb3_hcd: |
318 | usb_put_hcd(xhci->shared_hcd); | |
319 | ||
4718c177 GC |
320 | disable_clk: |
321 | if (!IS_ERR(clk)) | |
322 | clk_disable_unprepare(clk); | |
323 | ||
3429e91a SAS |
324 | put_hcd: |
325 | usb_put_hcd(hcd); | |
326 | ||
b0c69b4b BW |
327 | disable_runtime: |
328 | pm_runtime_put_noidle(&pdev->dev); | |
329 | pm_runtime_disable(&pdev->dev); | |
330 | ||
3429e91a SAS |
331 | return ret; |
332 | } | |
333 | ||
334 | static int xhci_plat_remove(struct platform_device *dev) | |
335 | { | |
336 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
337 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
4718c177 | 338 | struct clk *clk = xhci->clk; |
3429e91a | 339 | |
dcc7620c GR |
340 | xhci->xhc_state |= XHCI_STATE_REMOVING; |
341 | ||
3429e91a | 342 | usb_remove_hcd(xhci->shared_hcd); |
7b8ef22e | 343 | usb_phy_shutdown(hcd->usb_phy); |
3429e91a SAS |
344 | |
345 | usb_remove_hcd(hcd); | |
4ac53087 RQ |
346 | usb_put_hcd(xhci->shared_hcd); |
347 | ||
4718c177 GC |
348 | if (!IS_ERR(clk)) |
349 | clk_disable_unprepare(clk); | |
3429e91a | 350 | usb_put_hcd(hcd); |
3429e91a | 351 | |
b0c69b4b BW |
352 | pm_runtime_set_suspended(&dev->dev); |
353 | pm_runtime_disable(&dev->dev); | |
354 | ||
3429e91a SAS |
355 | return 0; |
356 | } | |
357 | ||
d852ed98 | 358 | static int __maybe_unused xhci_plat_suspend(struct device *dev) |
57d04eb1 VS |
359 | { |
360 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
361 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
835e4241 | 362 | int ret; |
57d04eb1 | 363 | |
a1377e53 LB |
364 | /* |
365 | * xhci_suspend() needs `do_wakeup` to know whether host is allowed | |
366 | * to do wakeup during suspend. Since xhci_plat_suspend is currently | |
367 | * only designed for system suspend, device_may_wakeup() is enough | |
368 | * to dertermine whether host is allowed to do wakeup. Need to | |
369 | * reconsider this when xhci_plat_suspend enlarges its scope, e.g., | |
370 | * also applies to runtime suspend. | |
371 | */ | |
835e4241 YS |
372 | ret = xhci_suspend(xhci, device_may_wakeup(dev)); |
373 | ||
374 | if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) | |
375 | clk_disable_unprepare(xhci->clk); | |
376 | ||
377 | return ret; | |
57d04eb1 VS |
378 | } |
379 | ||
d852ed98 | 380 | static int __maybe_unused xhci_plat_resume(struct device *dev) |
57d04eb1 VS |
381 | { |
382 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
383 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
98c0a3ff | 384 | int ret; |
57d04eb1 | 385 | |
835e4241 YS |
386 | if (!device_may_wakeup(dev) && !IS_ERR(xhci->clk)) |
387 | clk_prepare_enable(xhci->clk); | |
388 | ||
98c0a3ff YS |
389 | ret = xhci_priv_resume_quirk(hcd); |
390 | if (ret) | |
391 | return ret; | |
392 | ||
57d04eb1 VS |
393 | return xhci_resume(xhci, 0); |
394 | } | |
b0c69b4b | 395 | |
d852ed98 | 396 | static int __maybe_unused xhci_plat_runtime_suspend(struct device *dev) |
b0c69b4b BW |
397 | { |
398 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
399 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
400 | ||
401 | return xhci_suspend(xhci, true); | |
402 | } | |
403 | ||
d852ed98 | 404 | static int __maybe_unused xhci_plat_runtime_resume(struct device *dev) |
b0c69b4b BW |
405 | { |
406 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
407 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
408 | ||
409 | return xhci_resume(xhci, 0); | |
410 | } | |
57d04eb1 VS |
411 | |
412 | static const struct dev_pm_ops xhci_plat_pm_ops = { | |
413 | SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) | |
b0c69b4b BW |
414 | |
415 | SET_RUNTIME_PM_OPS(xhci_plat_runtime_suspend, | |
416 | xhci_plat_runtime_resume, | |
417 | NULL) | |
57d04eb1 | 418 | }; |
57d04eb1 | 419 | |
579085b5 DD |
420 | static const struct acpi_device_id usb_xhci_acpi_match[] = { |
421 | /* XHCI-compliant USB Controller */ | |
422 | { "PNP0D10", }, | |
423 | { } | |
424 | }; | |
425 | MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); | |
426 | ||
3429e91a SAS |
427 | static struct platform_driver usb_xhci_driver = { |
428 | .probe = xhci_plat_probe, | |
429 | .remove = xhci_plat_remove, | |
b07c1251 | 430 | .shutdown = usb_hcd_platform_shutdown, |
3429e91a SAS |
431 | .driver = { |
432 | .name = "xhci-hcd", | |
b0c69b4b | 433 | .pm = &xhci_plat_pm_ops, |
1fe6c452 | 434 | .of_match_table = of_match_ptr(usb_xhci_of_match), |
579085b5 | 435 | .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), |
3429e91a SAS |
436 | }, |
437 | }; | |
438 | MODULE_ALIAS("platform:xhci-hcd"); | |
439 | ||
29e409f0 | 440 | static int __init xhci_plat_init(void) |
3429e91a | 441 | { |
cd33a321 | 442 | xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); |
3429e91a SAS |
443 | return platform_driver_register(&usb_xhci_driver); |
444 | } | |
29e409f0 | 445 | module_init(xhci_plat_init); |
3429e91a | 446 | |
29e409f0 | 447 | static void __exit xhci_plat_exit(void) |
3429e91a SAS |
448 | { |
449 | platform_driver_unregister(&usb_xhci_driver); | |
450 | } | |
29e409f0 AB |
451 | module_exit(xhci_plat_exit); |
452 | ||
453 | MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); | |
454 | MODULE_LICENSE("GPL"); |