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