]>
Commit | Line | Data |
---|---|---|
3429e91a SAS |
1 | /* |
2 | * xhci-plat.c - xHCI host controller driver platform Bus Glue. | |
3 | * | |
4 | * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com | |
5 | * Author: Sebastian Andrzej Siewior <bigeasy@linutronix.de> | |
6 | * | |
7 | * A lot of code borrowed from the Linux xHCI driver. | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU General Public License | |
11 | * version 2 as published by the Free Software Foundation. | |
12 | */ | |
13 | ||
4718c177 | 14 | #include <linux/clk.h> |
48157bb9 | 15 | #include <linux/dma-mapping.h> |
3429e91a | 16 | #include <linux/module.h> |
4c39d4b9 | 17 | #include <linux/pci.h> |
1fe6c452 | 18 | #include <linux/of.h> |
48157bb9 | 19 | #include <linux/platform_device.h> |
7b8ef22e | 20 | #include <linux/usb/phy.h> |
48157bb9 | 21 | #include <linux/slab.h> |
579085b5 | 22 | #include <linux/acpi.h> |
3429e91a SAS |
23 | |
24 | #include "xhci.h" | |
4efb2f69 | 25 | #include "xhci-plat.h" |
97374792 | 26 | #include "xhci-mvebu.h" |
4ac8918f | 27 | #include "xhci-rcar.h" |
3429e91a | 28 | |
1885d9a3 AB |
29 | static struct hc_driver __read_mostly xhci_plat_hc_driver; |
30 | ||
cd33a321 RQ |
31 | static int xhci_plat_setup(struct usb_hcd *hcd); |
32 | static int xhci_plat_start(struct usb_hcd *hcd); | |
33 | ||
34 | static const struct xhci_driver_overrides xhci_plat_overrides __initconst = { | |
4efb2f69 | 35 | .extra_priv_size = sizeof(struct xhci_plat_priv), |
cd33a321 RQ |
36 | .reset = xhci_plat_setup, |
37 | .start = xhci_plat_start, | |
38 | }; | |
39 | ||
b1c127ae | 40 | static void xhci_priv_plat_start(struct usb_hcd *hcd) |
3429e91a | 41 | { |
b1c127ae FB |
42 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); |
43 | ||
44 | if (priv->plat_start) | |
45 | priv->plat_start(hcd); | |
46 | } | |
47 | ||
48 | static int xhci_priv_init_quirk(struct usb_hcd *hcd) | |
49 | { | |
50 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
51 | ||
52 | if (!priv->init_quirk) | |
53 | return 0; | |
54 | ||
55 | return priv->init_quirk(hcd); | |
56 | } | |
5ad3b03e | 57 | |
98c0a3ff YS |
58 | static int xhci_priv_resume_quirk(struct usb_hcd *hcd) |
59 | { | |
60 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
61 | ||
62 | if (!priv->resume_quirk) | |
63 | return 0; | |
64 | ||
65 | return priv->resume_quirk(hcd); | |
66 | } | |
67 | ||
b1c127ae FB |
68 | static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) |
69 | { | |
3429e91a SAS |
70 | /* |
71 | * As of now platform drivers don't provide MSI support so we ensure | |
72 | * here that the generic code does not try to make a pci_dev from our | |
73 | * dev struct in order to setup MSI | |
74 | */ | |
52fb6125 | 75 | xhci->quirks |= XHCI_PLAT; |
3429e91a SAS |
76 | } |
77 | ||
78 | /* called during probe() after chip reset completes */ | |
79 | static int xhci_plat_setup(struct usb_hcd *hcd) | |
80 | { | |
4ac8918f YS |
81 | int ret; |
82 | ||
4ac8918f | 83 | |
b1c127ae FB |
84 | ret = xhci_priv_init_quirk(hcd); |
85 | if (ret) | |
86 | return ret; | |
3bdb263d | 87 | |
3429e91a SAS |
88 | return xhci_gen_setup(hcd, xhci_plat_quirks); |
89 | } | |
90 | ||
94adcdce YS |
91 | static int xhci_plat_start(struct usb_hcd *hcd) |
92 | { | |
b1c127ae | 93 | xhci_priv_plat_start(hcd); |
94adcdce YS |
94 | return xhci_run(hcd); |
95 | } | |
96 | ||
4efb2f69 YS |
97 | #ifdef CONFIG_OF |
98 | static const struct xhci_plat_priv xhci_plat_marvell_armada = { | |
b1c127ae | 99 | .init_quirk = xhci_mvebu_mbus_init_quirk, |
4efb2f69 YS |
100 | }; |
101 | ||
102 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { | |
9bf9d9d6 | 103 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, |
b1c127ae FB |
104 | .init_quirk = xhci_rcar_init_quirk, |
105 | .plat_start = xhci_rcar_start, | |
435cc113 | 106 | .resume_quirk = xhci_rcar_resume_quirk, |
4efb2f69 YS |
107 | }; |
108 | ||
526a240f | 109 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { |
526a240f | 110 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V2, |
b1c127ae FB |
111 | .init_quirk = xhci_rcar_init_quirk, |
112 | .plat_start = xhci_rcar_start, | |
435cc113 | 113 | .resume_quirk = xhci_rcar_resume_quirk, |
526a240f YS |
114 | }; |
115 | ||
3f1dae6b YS |
116 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_r8a7796 = { |
117 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V3, | |
118 | .init_quirk = xhci_rcar_init_quirk, | |
119 | .plat_start = xhci_rcar_start, | |
435cc113 | 120 | .resume_quirk = xhci_rcar_resume_quirk, |
3f1dae6b YS |
121 | }; |
122 | ||
4efb2f69 YS |
123 | static const struct of_device_id usb_xhci_of_match[] = { |
124 | { | |
125 | .compatible = "generic-xhci", | |
126 | }, { | |
127 | .compatible = "xhci-platform", | |
128 | }, { | |
129 | .compatible = "marvell,armada-375-xhci", | |
130 | .data = &xhci_plat_marvell_armada, | |
131 | }, { | |
132 | .compatible = "marvell,armada-380-xhci", | |
133 | .data = &xhci_plat_marvell_armada, | |
134 | }, { | |
135 | .compatible = "renesas,xhci-r8a7790", | |
136 | .data = &xhci_plat_renesas_rcar_gen2, | |
137 | }, { | |
138 | .compatible = "renesas,xhci-r8a7791", | |
139 | .data = &xhci_plat_renesas_rcar_gen2, | |
82487b71 YS |
140 | }, { |
141 | .compatible = "renesas,xhci-r8a7793", | |
142 | .data = &xhci_plat_renesas_rcar_gen2, | |
526a240f YS |
143 | }, { |
144 | .compatible = "renesas,xhci-r8a7795", | |
145 | .data = &xhci_plat_renesas_rcar_gen3, | |
3f1dae6b YS |
146 | }, { |
147 | .compatible = "renesas,xhci-r8a7796", | |
148 | .data = &xhci_plat_renesas_rcar_r8a7796, | |
4efb2f69 | 149 | }, { |
f1bbdc3b SH |
150 | .compatible = "renesas,rcar-gen2-xhci", |
151 | .data = &xhci_plat_renesas_rcar_gen2, | |
152 | }, { | |
153 | .compatible = "renesas,rcar-gen3-xhci", | |
154 | .data = &xhci_plat_renesas_rcar_gen3, | |
4efb2f69 | 155 | }, |
ff075d67 | 156 | {}, |
4efb2f69 YS |
157 | }; |
158 | MODULE_DEVICE_TABLE(of, usb_xhci_of_match); | |
159 | #endif | |
160 | ||
3429e91a SAS |
161 | static int xhci_plat_probe(struct platform_device *pdev) |
162 | { | |
4efb2f69 | 163 | const struct of_device_id *match; |
3429e91a | 164 | const struct hc_driver *driver; |
4c39d4b9 | 165 | struct device *sysdev; |
3429e91a SAS |
166 | struct xhci_hcd *xhci; |
167 | struct resource *res; | |
168 | struct usb_hcd *hcd; | |
4718c177 | 169 | struct clk *clk; |
3429e91a SAS |
170 | int ret; |
171 | int irq; | |
172 | ||
173 | if (usb_disabled()) | |
174 | return -ENODEV; | |
175 | ||
1885d9a3 | 176 | driver = &xhci_plat_hc_driver; |
3429e91a SAS |
177 | |
178 | irq = platform_get_irq(pdev, 0); | |
179 | if (irq < 0) | |
180 | return -ENODEV; | |
181 | ||
4c39d4b9 AB |
182 | /* |
183 | * sysdev must point to a device that is known to the system firmware | |
184 | * or PCI hardware. We handle these three cases here: | |
185 | * 1. xhci_plat comes from firmware | |
186 | * 2. xhci_plat is child of a device from firmware (dwc3-plat) | |
187 | * 3. xhci_plat is grandchild of a pci device (dwc3-pci) | |
188 | */ | |
189 | sysdev = &pdev->dev; | |
190 | if (sysdev->parent && !sysdev->of_node && sysdev->parent->of_node) | |
191 | sysdev = sysdev->parent; | |
192 | #ifdef CONFIG_PCI | |
193 | else if (sysdev->parent && sysdev->parent->parent && | |
194 | sysdev->parent->parent->bus == &pci_bus_type) | |
195 | sysdev = sysdev->parent->parent; | |
196 | #endif | |
197 | ||
0ebbe398 | 198 | /* Try to set 64-bit DMA first */ |
4c39d4b9 | 199 | if (WARN_ON(!sysdev->dma_mask)) |
0ebbe398 | 200 | /* Platform did not initialize dma_mask */ |
4c39d4b9 | 201 | ret = dma_coerce_mask_and_coherent(sysdev, |
0ebbe398 | 202 | DMA_BIT_MASK(64)); |
c10cf118 | 203 | else |
4c39d4b9 | 204 | ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(64)); |
0ebbe398 DD |
205 | |
206 | /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ | |
207 | if (ret) { | |
4c39d4b9 | 208 | ret = dma_set_mask_and_coherent(sysdev, DMA_BIT_MASK(32)); |
0ebbe398 DD |
209 | if (ret) |
210 | return ret; | |
211 | } | |
c10cf118 | 212 | |
b0c69b4b BW |
213 | pm_runtime_set_active(&pdev->dev); |
214 | pm_runtime_enable(&pdev->dev); | |
215 | pm_runtime_get_noresume(&pdev->dev); | |
216 | ||
4c39d4b9 AB |
217 | hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, |
218 | dev_name(&pdev->dev), NULL); | |
b0c69b4b BW |
219 | if (!hcd) { |
220 | ret = -ENOMEM; | |
221 | goto disable_runtime; | |
222 | } | |
3429e91a | 223 | |
e7020f19 | 224 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
fd666348 HS |
225 | hcd->regs = devm_ioremap_resource(&pdev->dev, res); |
226 | if (IS_ERR(hcd->regs)) { | |
227 | ret = PTR_ERR(hcd->regs); | |
3429e91a SAS |
228 | goto put_hcd; |
229 | } | |
230 | ||
e7020f19 VB |
231 | hcd->rsrc_start = res->start; |
232 | hcd->rsrc_len = resource_size(res); | |
233 | ||
4718c177 GC |
234 | /* |
235 | * Not all platforms have a clk so it is not an error if the | |
236 | * clock does not exists. | |
237 | */ | |
238 | clk = devm_clk_get(&pdev->dev, NULL); | |
239 | if (!IS_ERR(clk)) { | |
240 | ret = clk_prepare_enable(clk); | |
241 | if (ret) | |
fd666348 | 242 | goto put_hcd; |
de95c40d TP |
243 | } else if (PTR_ERR(clk) == -EPROBE_DEFER) { |
244 | ret = -EPROBE_DEFER; | |
245 | goto put_hcd; | |
4718c177 GC |
246 | } |
247 | ||
4efb2f69 | 248 | xhci = hcd_to_xhci(hcd); |
76f9502f | 249 | match = of_match_node(usb_xhci_of_match, pdev->dev.of_node); |
4efb2f69 YS |
250 | if (match) { |
251 | const struct xhci_plat_priv *priv_match = match->data; | |
252 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
253 | ||
254 | /* Just copy data for now */ | |
2ad294d5 GC |
255 | if (priv_match) |
256 | *priv = *priv_match; | |
4efb2f69 YS |
257 | } |
258 | ||
3c9740a1 | 259 | device_wakeup_enable(hcd->self.controller); |
3429e91a | 260 | |
4718c177 | 261 | xhci->clk = clk; |
9fa733f2 | 262 | xhci->main_hcd = hcd; |
4c39d4b9 | 263 | xhci->shared_hcd = __usb_create_hcd(driver, sysdev, &pdev->dev, |
3429e91a SAS |
264 | dev_name(&pdev->dev), hcd); |
265 | if (!xhci->shared_hcd) { | |
266 | ret = -ENOMEM; | |
4ac53087 | 267 | goto disable_clk; |
3429e91a SAS |
268 | } |
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"); |