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
14 #include <linux/clk.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/module.h>
17 #include <linux/of.h>
18 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <linux/usb/xhci_pdriver.h>
21
22 #include "xhci.h"
23 #include "xhci-mvebu.h"
24 #include "xhci-rcar.h"
25
26 static struct hc_driver __read_mostly xhci_plat_hc_driver;
27
xhci_plat_quirks(struct device * dev,struct xhci_hcd * xhci)28 static void xhci_plat_quirks(struct device *dev, struct xhci_hcd *xhci)
29 {
30 /*
31 * As of now platform drivers don't provide MSI support so we ensure
32 * here that the generic code does not try to make a pci_dev from our
33 * dev struct in order to setup MSI
34 */
35 xhci->quirks |= XHCI_PLAT;
36 }
37
38 /* called during probe() after chip reset completes */
xhci_plat_setup(struct usb_hcd * hcd)39 static int xhci_plat_setup(struct usb_hcd *hcd)
40 {
41 struct device_node *of_node = hcd->self.controller->of_node;
42 int ret;
43
44 if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
45 of_device_is_compatible(of_node, "renesas,xhci-r8a7791")) {
46 ret = xhci_rcar_init_quirk(hcd);
47 if (ret)
48 return ret;
49 }
50
51 return xhci_gen_setup(hcd, xhci_plat_quirks);
52 }
53
xhci_plat_start(struct usb_hcd * hcd)54 static int xhci_plat_start(struct usb_hcd *hcd)
55 {
56 struct device_node *of_node = hcd->self.controller->of_node;
57
58 if (of_device_is_compatible(of_node, "renesas,xhci-r8a7790") ||
59 of_device_is_compatible(of_node, "renesas,xhci-r8a7791"))
60 xhci_rcar_start(hcd);
61
62 return xhci_run(hcd);
63 }
64
xhci_plat_probe(struct platform_device * pdev)65 static int xhci_plat_probe(struct platform_device *pdev)
66 {
67 struct device_node *node = pdev->dev.of_node;
68 struct usb_xhci_pdata *pdata = dev_get_platdata(&pdev->dev);
69 const struct hc_driver *driver;
70 struct xhci_hcd *xhci;
71 struct resource *res;
72 struct usb_hcd *hcd;
73 struct clk *clk;
74 int ret;
75 int irq;
76
77 if (usb_disabled())
78 return -ENODEV;
79
80 driver = &xhci_plat_hc_driver;
81
82 irq = platform_get_irq(pdev, 0);
83 if (irq < 0)
84 return irq;
85
86 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
87 if (!res)
88 return -ENODEV;
89
90 /* Initialize dma_mask and coherent_dma_mask to 32-bits */
91 ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
92 if (ret)
93 return ret;
94 if (!pdev->dev.dma_mask)
95 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
96 else
97 dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
98
99 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
100 if (!hcd)
101 return -ENOMEM;
102
103 hcd->rsrc_start = res->start;
104 hcd->rsrc_len = resource_size(res);
105
106 hcd->regs = devm_ioremap_resource(&pdev->dev, res);
107 if (IS_ERR(hcd->regs)) {
108 ret = PTR_ERR(hcd->regs);
109 goto put_hcd;
110 }
111
112 /*
113 * Not all platforms have a clk so it is not an error if the
114 * clock does not exists.
115 */
116 clk = devm_clk_get(&pdev->dev, NULL);
117 if (!IS_ERR(clk)) {
118 ret = clk_prepare_enable(clk);
119 if (ret)
120 goto put_hcd;
121 } else if (PTR_ERR(clk) == -EPROBE_DEFER) {
122 ret = -EPROBE_DEFER;
123 goto put_hcd;
124 }
125
126 if (of_device_is_compatible(pdev->dev.of_node,
127 "marvell,armada-375-xhci") ||
128 of_device_is_compatible(pdev->dev.of_node,
129 "marvell,armada-380-xhci")) {
130 ret = xhci_mvebu_mbus_init_quirk(pdev);
131 if (ret)
132 goto disable_clk;
133 }
134
135 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
136 if (ret)
137 goto disable_clk;
138
139 device_wakeup_enable(hcd->self.controller);
140
141 /* USB 2.0 roothub is stored in the platform_device now. */
142 hcd = platform_get_drvdata(pdev);
143 xhci = hcd_to_xhci(hcd);
144 xhci->clk = clk;
145 xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
146 dev_name(&pdev->dev), hcd);
147 if (!xhci->shared_hcd) {
148 ret = -ENOMEM;
149 goto dealloc_usb2_hcd;
150 }
151
152 if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
153 (pdata && pdata->usb3_lpm_capable))
154 xhci->quirks |= XHCI_LPM_SUPPORT;
155 /*
156 * Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
157 * is called by usb_add_hcd().
158 */
159 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
160
161 if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
162 xhci->shared_hcd->can_do_streams = 1;
163
164 ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
165 if (ret)
166 goto put_usb3_hcd;
167
168 return 0;
169
170 put_usb3_hcd:
171 usb_put_hcd(xhci->shared_hcd);
172
173 dealloc_usb2_hcd:
174 usb_remove_hcd(hcd);
175
176 disable_clk:
177 if (!IS_ERR(clk))
178 clk_disable_unprepare(clk);
179
180 put_hcd:
181 usb_put_hcd(hcd);
182
183 return ret;
184 }
185
xhci_plat_remove(struct platform_device * dev)186 static int xhci_plat_remove(struct platform_device *dev)
187 {
188 struct usb_hcd *hcd = platform_get_drvdata(dev);
189 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
190 struct clk *clk = xhci->clk;
191
192 xhci->xhc_state |= XHCI_STATE_REMOVING;
193
194 usb_remove_hcd(xhci->shared_hcd);
195 usb_put_hcd(xhci->shared_hcd);
196
197 usb_remove_hcd(hcd);
198 if (!IS_ERR(clk))
199 clk_disable_unprepare(clk);
200 usb_put_hcd(hcd);
201 kfree(xhci);
202
203 return 0;
204 }
205
206 #ifdef CONFIG_PM_SLEEP
xhci_plat_suspend(struct device * dev)207 static int xhci_plat_suspend(struct device *dev)
208 {
209 struct usb_hcd *hcd = dev_get_drvdata(dev);
210 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
211
212 /*
213 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
214 * to do wakeup during suspend. Since xhci_plat_suspend is currently
215 * only designed for system suspend, device_may_wakeup() is enough
216 * to dertermine whether host is allowed to do wakeup. Need to
217 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
218 * also applies to runtime suspend.
219 */
220 return xhci_suspend(xhci, device_may_wakeup(dev));
221 }
222
xhci_plat_resume(struct device * dev)223 static int xhci_plat_resume(struct device *dev)
224 {
225 struct usb_hcd *hcd = dev_get_drvdata(dev);
226 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
227
228 return xhci_resume(xhci, 0);
229 }
230
231 static const struct dev_pm_ops xhci_plat_pm_ops = {
232 SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
233 };
234 #define DEV_PM_OPS (&xhci_plat_pm_ops)
235 #else
236 #define DEV_PM_OPS NULL
237 #endif /* CONFIG_PM */
238
239 #ifdef CONFIG_OF
240 static const struct of_device_id usb_xhci_of_match[] = {
241 { .compatible = "generic-xhci" },
242 { .compatible = "xhci-platform" },
243 { .compatible = "marvell,armada-375-xhci"},
244 { .compatible = "marvell,armada-380-xhci"},
245 { .compatible = "renesas,xhci-r8a7790"},
246 { .compatible = "renesas,xhci-r8a7791"},
247 { },
248 };
249 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
250 #endif
251
252 static struct platform_driver usb_xhci_driver = {
253 .probe = xhci_plat_probe,
254 .remove = xhci_plat_remove,
255 .shutdown = usb_hcd_platform_shutdown,
256 .driver = {
257 .name = "xhci-hcd",
258 .pm = DEV_PM_OPS,
259 .of_match_table = of_match_ptr(usb_xhci_of_match),
260 },
261 };
262 MODULE_ALIAS("platform:xhci-hcd");
263
xhci_plat_init(void)264 static int __init xhci_plat_init(void)
265 {
266 xhci_init_driver(&xhci_plat_hc_driver, xhci_plat_setup);
267 xhci_plat_hc_driver.start = xhci_plat_start;
268 return platform_driver_register(&usb_xhci_driver);
269 }
270 module_init(xhci_plat_init);
271
xhci_plat_exit(void)272 static void __exit xhci_plat_exit(void)
273 {
274 platform_driver_unregister(&usb_xhci_driver);
275 }
276 module_exit(xhci_plat_exit);
277
278 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
279 MODULE_LICENSE("GPL");
280