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