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