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