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> |
1fe6c452 | 17 | #include <linux/of.h> |
48157bb9 | 18 | #include <linux/platform_device.h> |
7b8ef22e | 19 | #include <linux/usb/phy.h> |
48157bb9 | 20 | #include <linux/slab.h> |
20f6fdd0 | 21 | #include <linux/usb/xhci_pdriver.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 | ||
3429e91a SAS |
40 | static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci) |
41 | { | |
5ad3b03e YS |
42 | struct usb_hcd *hcd = xhci_to_hcd(xhci); |
43 | ||
3429e91a SAS |
44 | /* |
45 | * As of now platform drivers don't provide MSI support so we ensure | |
46 | * here that the generic code does not try to make a pci_dev from our | |
47 | * dev struct in order to setup MSI | |
48 | */ | |
52fb6125 | 49 | xhci->quirks |= XHCI_PLAT; |
5ad3b03e YS |
50 | |
51 | /* | |
52 | * On R-Car Gen2 and Gen3, the AC64 bit (bit 0) of HCCPARAMS1 is set | |
53 | * to 1. However, these SoCs don't support 64-bit address memory | |
54 | * pointers. So, this driver clears the AC64 bit of xhci->hcc_params | |
55 | * to call dma_set_coherent_mask(dev, DMA_BIT_MASK(32)) in | |
56 | * xhci_gen_setup(). | |
57 | */ | |
58 | if (xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2) || | |
59 | xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3)) | |
60 | xhci->quirks |= XHCI_NO_64BIT_SUPPORT; | |
3429e91a SAS |
61 | } |
62 | ||
63 | /* called during probe() after chip reset completes */ | |
64 | static int xhci_plat_setup(struct usb_hcd *hcd) | |
65 | { | |
4ac8918f YS |
66 | int ret; |
67 | ||
526a240f YS |
68 | if (xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2) || |
69 | xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3)) { | |
4ac8918f YS |
70 | ret = xhci_rcar_init_quirk(hcd); |
71 | if (ret) | |
72 | return ret; | |
73 | } | |
74 | ||
3429e91a SAS |
75 | return xhci_gen_setup(hcd, xhci_plat_quirks); |
76 | } | |
77 | ||
94adcdce YS |
78 | static int xhci_plat_start(struct usb_hcd *hcd) |
79 | { | |
526a240f YS |
80 | if (xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2) || |
81 | xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3)) | |
4ac8918f YS |
82 | xhci_rcar_start(hcd); |
83 | ||
94adcdce YS |
84 | return xhci_run(hcd); |
85 | } | |
86 | ||
4efb2f69 YS |
87 | #ifdef CONFIG_OF |
88 | static const struct xhci_plat_priv xhci_plat_marvell_armada = { | |
89 | .type = XHCI_PLAT_TYPE_MARVELL_ARMADA, | |
90 | }; | |
91 | ||
92 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen2 = { | |
93 | .type = XHCI_PLAT_TYPE_RENESAS_RCAR_GEN2, | |
9bf9d9d6 | 94 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V1, |
4efb2f69 YS |
95 | }; |
96 | ||
526a240f YS |
97 | static const struct xhci_plat_priv xhci_plat_renesas_rcar_gen3 = { |
98 | .type = XHCI_PLAT_TYPE_RENESAS_RCAR_GEN3, | |
99 | .firmware_name = XHCI_RCAR_FIRMWARE_NAME_V2, | |
100 | }; | |
101 | ||
4efb2f69 YS |
102 | static const struct of_device_id usb_xhci_of_match[] = { |
103 | { | |
104 | .compatible = "generic-xhci", | |
105 | }, { | |
106 | .compatible = "xhci-platform", | |
107 | }, { | |
108 | .compatible = "marvell,armada-375-xhci", | |
109 | .data = &xhci_plat_marvell_armada, | |
110 | }, { | |
111 | .compatible = "marvell,armada-380-xhci", | |
112 | .data = &xhci_plat_marvell_armada, | |
113 | }, { | |
114 | .compatible = "renesas,xhci-r8a7790", | |
115 | .data = &xhci_plat_renesas_rcar_gen2, | |
116 | }, { | |
117 | .compatible = "renesas,xhci-r8a7791", | |
118 | .data = &xhci_plat_renesas_rcar_gen2, | |
82487b71 YS |
119 | }, { |
120 | .compatible = "renesas,xhci-r8a7793", | |
121 | .data = &xhci_plat_renesas_rcar_gen2, | |
526a240f YS |
122 | }, { |
123 | .compatible = "renesas,xhci-r8a7795", | |
124 | .data = &xhci_plat_renesas_rcar_gen3, | |
4efb2f69 | 125 | }, { |
f1bbdc3b SH |
126 | .compatible = "renesas,rcar-gen2-xhci", |
127 | .data = &xhci_plat_renesas_rcar_gen2, | |
128 | }, { | |
129 | .compatible = "renesas,rcar-gen3-xhci", | |
130 | .data = &xhci_plat_renesas_rcar_gen3, | |
4efb2f69 | 131 | }, |
ff075d67 | 132 | {}, |
4efb2f69 YS |
133 | }; |
134 | MODULE_DEVICE_TABLE(of, usb_xhci_of_match); | |
135 | #endif | |
136 | ||
3429e91a SAS |
137 | static int xhci_plat_probe(struct platform_device *pdev) |
138 | { | |
20f6fdd0 PA |
139 | struct device_node *node = pdev->dev.of_node; |
140 | struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev); | |
4efb2f69 | 141 | const struct of_device_id *match; |
3429e91a SAS |
142 | const struct hc_driver *driver; |
143 | struct xhci_hcd *xhci; | |
144 | struct resource *res; | |
145 | struct usb_hcd *hcd; | |
4718c177 | 146 | struct clk *clk; |
3429e91a SAS |
147 | int ret; |
148 | int irq; | |
149 | ||
150 | if (usb_disabled()) | |
151 | return -ENODEV; | |
152 | ||
1885d9a3 | 153 | driver = &xhci_plat_hc_driver; |
3429e91a SAS |
154 | |
155 | irq = platform_get_irq(pdev, 0); | |
156 | if (irq < 0) | |
157 | return -ENODEV; | |
158 | ||
0ebbe398 DD |
159 | /* Try to set 64-bit DMA first */ |
160 | if (WARN_ON(!pdev->dev.dma_mask)) | |
161 | /* Platform did not initialize dma_mask */ | |
162 | ret = dma_coerce_mask_and_coherent(&pdev->dev, | |
163 | DMA_BIT_MASK(64)); | |
c10cf118 | 164 | else |
0ebbe398 DD |
165 | ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64)); |
166 | ||
167 | /* If seting 64-bit DMA mask fails, fall back to 32-bit DMA mask */ | |
168 | if (ret) { | |
169 | ret = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)); | |
170 | if (ret) | |
171 | return ret; | |
172 | } | |
c10cf118 | 173 | |
3429e91a SAS |
174 | hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev)); |
175 | if (!hcd) | |
176 | return -ENOMEM; | |
177 | ||
e7020f19 | 178 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
fd666348 HS |
179 | hcd->regs = devm_ioremap_resource(&pdev->dev, res); |
180 | if (IS_ERR(hcd->regs)) { | |
181 | ret = PTR_ERR(hcd->regs); | |
3429e91a SAS |
182 | goto put_hcd; |
183 | } | |
184 | ||
e7020f19 VB |
185 | hcd->rsrc_start = res->start; |
186 | hcd->rsrc_len = resource_size(res); | |
187 | ||
4718c177 GC |
188 | /* |
189 | * Not all platforms have a clk so it is not an error if the | |
190 | * clock does not exists. | |
191 | */ | |
192 | clk = devm_clk_get(&pdev->dev, NULL); | |
193 | if (!IS_ERR(clk)) { | |
194 | ret = clk_prepare_enable(clk); | |
195 | if (ret) | |
fd666348 | 196 | goto put_hcd; |
4718c177 GC |
197 | } |
198 | ||
4efb2f69 YS |
199 | xhci = hcd_to_xhci(hcd); |
200 | match = of_match_node(usb_xhci_of_match, node); | |
201 | if (match) { | |
202 | const struct xhci_plat_priv *priv_match = match->data; | |
203 | struct xhci_plat_priv *priv = hcd_to_xhci_priv(hcd); | |
204 | ||
205 | /* Just copy data for now */ | |
2ad294d5 GC |
206 | if (priv_match) |
207 | *priv = *priv_match; | |
4efb2f69 YS |
208 | } |
209 | ||
210 | if (xhci_plat_type_is(hcd, XHCI_PLAT_TYPE_MARVELL_ARMADA)) { | |
1e7e4fb6 MR |
211 | ret = xhci_mvebu_mbus_init_quirk(pdev); |
212 | if (ret) | |
213 | goto disable_clk; | |
214 | } | |
215 | ||
3c9740a1 | 216 | device_wakeup_enable(hcd->self.controller); |
3429e91a | 217 | |
4718c177 | 218 | xhci->clk = clk; |
9fa733f2 | 219 | xhci->main_hcd = hcd; |
3429e91a SAS |
220 | xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev, |
221 | dev_name(&pdev->dev), hcd); | |
222 | if (!xhci->shared_hcd) { | |
223 | ret = -ENOMEM; | |
4ac53087 | 224 | goto disable_clk; |
3429e91a SAS |
225 | } |
226 | ||
20f6fdd0 PA |
227 | if ((node && of_property_read_bool(node, "usb3-lpm-capable")) || |
228 | (pdata && pdata->usb3_lpm_capable)) | |
229 | xhci->quirks |= XHCI_LPM_SUPPORT; | |
3429e91a | 230 | |
14aec589 ON |
231 | if (HCC_MAX_PSA(xhci->hcc_params) >= 4) |
232 | xhci->shared_hcd->can_do_streams = 1; | |
233 | ||
7b8ef22e MR |
234 | hcd->usb_phy = devm_usb_get_phy_by_phandle(&pdev->dev, "usb-phy", 0); |
235 | if (IS_ERR(hcd->usb_phy)) { | |
236 | ret = PTR_ERR(hcd->usb_phy); | |
237 | if (ret == -EPROBE_DEFER) | |
238 | goto put_usb3_hcd; | |
239 | hcd->usb_phy = NULL; | |
240 | } else { | |
241 | ret = usb_phy_init(hcd->usb_phy); | |
242 | if (ret) | |
243 | goto put_usb3_hcd; | |
244 | } | |
245 | ||
4ac53087 | 246 | ret = usb_add_hcd(hcd, irq, IRQF_SHARED); |
3429e91a | 247 | if (ret) |
7b8ef22e | 248 | goto disable_usb_phy; |
3429e91a | 249 | |
4ac53087 RQ |
250 | ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED); |
251 | if (ret) | |
252 | goto dealloc_usb2_hcd; | |
253 | ||
3429e91a SAS |
254 | return 0; |
255 | ||
4ac53087 RQ |
256 | |
257 | dealloc_usb2_hcd: | |
258 | usb_remove_hcd(hcd); | |
259 | ||
7b8ef22e MR |
260 | disable_usb_phy: |
261 | usb_phy_shutdown(hcd->usb_phy); | |
262 | ||
3429e91a SAS |
263 | put_usb3_hcd: |
264 | usb_put_hcd(xhci->shared_hcd); | |
265 | ||
4718c177 GC |
266 | disable_clk: |
267 | if (!IS_ERR(clk)) | |
268 | clk_disable_unprepare(clk); | |
269 | ||
3429e91a SAS |
270 | put_hcd: |
271 | usb_put_hcd(hcd); | |
272 | ||
273 | return ret; | |
274 | } | |
275 | ||
276 | static int xhci_plat_remove(struct platform_device *dev) | |
277 | { | |
278 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
279 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
4718c177 | 280 | struct clk *clk = xhci->clk; |
3429e91a SAS |
281 | |
282 | usb_remove_hcd(xhci->shared_hcd); | |
7b8ef22e | 283 | usb_phy_shutdown(hcd->usb_phy); |
3429e91a SAS |
284 | |
285 | usb_remove_hcd(hcd); | |
4ac53087 RQ |
286 | usb_put_hcd(xhci->shared_hcd); |
287 | ||
4718c177 GC |
288 | if (!IS_ERR(clk)) |
289 | clk_disable_unprepare(clk); | |
3429e91a | 290 | usb_put_hcd(hcd); |
3429e91a SAS |
291 | |
292 | return 0; | |
293 | } | |
294 | ||
274f6afa | 295 | #ifdef CONFIG_PM_SLEEP |
57d04eb1 VS |
296 | static int xhci_plat_suspend(struct device *dev) |
297 | { | |
298 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
299 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
300 | ||
a1377e53 LB |
301 | /* |
302 | * xhci_suspend() needs `do_wakeup` to know whether host is allowed | |
303 | * to do wakeup during suspend. Since xhci_plat_suspend is currently | |
304 | * only designed for system suspend, device_may_wakeup() is enough | |
305 | * to dertermine whether host is allowed to do wakeup. Need to | |
306 | * reconsider this when xhci_plat_suspend enlarges its scope, e.g., | |
307 | * also applies to runtime suspend. | |
308 | */ | |
309 | return xhci_suspend(xhci, device_may_wakeup(dev)); | |
57d04eb1 VS |
310 | } |
311 | ||
312 | static int xhci_plat_resume(struct device *dev) | |
313 | { | |
314 | struct usb_hcd *hcd = dev_get_drvdata(dev); | |
315 | struct xhci_hcd *xhci = hcd_to_xhci(hcd); | |
316 | ||
317 | return xhci_resume(xhci, 0); | |
318 | } | |
319 | ||
320 | static const struct dev_pm_ops xhci_plat_pm_ops = { | |
321 | SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume) | |
322 | }; | |
323 | #define DEV_PM_OPS (&xhci_plat_pm_ops) | |
324 | #else | |
325 | #define DEV_PM_OPS NULL | |
326 | #endif /* CONFIG_PM */ | |
327 | ||
579085b5 DD |
328 | static const struct acpi_device_id usb_xhci_acpi_match[] = { |
329 | /* XHCI-compliant USB Controller */ | |
330 | { "PNP0D10", }, | |
331 | { } | |
332 | }; | |
333 | MODULE_DEVICE_TABLE(acpi, usb_xhci_acpi_match); | |
334 | ||
3429e91a SAS |
335 | static struct platform_driver usb_xhci_driver = { |
336 | .probe = xhci_plat_probe, | |
337 | .remove = xhci_plat_remove, | |
338 | .driver = { | |
339 | .name = "xhci-hcd", | |
57d04eb1 | 340 | .pm = DEV_PM_OPS, |
1fe6c452 | 341 | .of_match_table = of_match_ptr(usb_xhci_of_match), |
579085b5 | 342 | .acpi_match_table = ACPI_PTR(usb_xhci_acpi_match), |
3429e91a SAS |
343 | }, |
344 | }; | |
345 | MODULE_ALIAS("platform:xhci-hcd"); | |
346 | ||
29e409f0 | 347 | static int __init xhci_plat_init(void) |
3429e91a | 348 | { |
cd33a321 | 349 | xhci_init_driver(&xhci_plat_hc_driver, &xhci_plat_overrides); |
3429e91a SAS |
350 | return platform_driver_register(&usb_xhci_driver); |
351 | } | |
29e409f0 | 352 | module_init(xhci_plat_init); |
3429e91a | 353 | |
29e409f0 | 354 | static void __exit xhci_plat_exit(void) |
3429e91a SAS |
355 | { |
356 | platform_driver_unregister(&usb_xhci_driver); | |
357 | } | |
29e409f0 AB |
358 | module_exit(xhci_plat_exit); |
359 | ||
360 | MODULE_DESCRIPTION("xHCI Platform Host Controller Driver"); | |
361 | MODULE_LICENSE("GPL"); |