xref: /openbmc/linux/drivers/usb/host/xhci-plat.c (revision 95acd4c7)
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 
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 */
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 
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 
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 -ENODEV;
85 
86 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
87 	if (!res)
88 		return -ENODEV;
89 
90 	if (of_device_is_compatible(pdev->dev.of_node,
91 				    "marvell,armada-375-xhci") ||
92 	    of_device_is_compatible(pdev->dev.of_node,
93 				    "marvell,armada-380-xhci")) {
94 		ret = xhci_mvebu_mbus_init_quirk(pdev);
95 		if (ret)
96 			return ret;
97 	}
98 
99 	/* Initialize dma_mask and coherent_dma_mask to 32-bits */
100 	ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
101 	if (ret)
102 		return ret;
103 	if (!pdev->dev.dma_mask)
104 		pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
105 	else
106 		dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
107 
108 	hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
109 	if (!hcd)
110 		return -ENOMEM;
111 
112 	hcd->rsrc_start = res->start;
113 	hcd->rsrc_len = resource_size(res);
114 
115 	hcd->regs = devm_ioremap_resource(&pdev->dev, res);
116 	if (IS_ERR(hcd->regs)) {
117 		ret = PTR_ERR(hcd->regs);
118 		goto put_hcd;
119 	}
120 
121 	/*
122 	 * Not all platforms have a clk so it is not an error if the
123 	 * clock does not exists.
124 	 */
125 	clk = devm_clk_get(&pdev->dev, NULL);
126 	if (!IS_ERR(clk)) {
127 		ret = clk_prepare_enable(clk);
128 		if (ret)
129 			goto put_hcd;
130 	}
131 
132 	ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
133 	if (ret)
134 		goto disable_clk;
135 
136 	device_wakeup_enable(hcd->self.controller);
137 
138 	/* USB 2.0 roothub is stored in the platform_device now. */
139 	hcd = platform_get_drvdata(pdev);
140 	xhci = hcd_to_xhci(hcd);
141 	xhci->clk = clk;
142 	xhci->shared_hcd = usb_create_shared_hcd(driver, &pdev->dev,
143 			dev_name(&pdev->dev), hcd);
144 	if (!xhci->shared_hcd) {
145 		ret = -ENOMEM;
146 		goto dealloc_usb2_hcd;
147 	}
148 
149 	if ((node && of_property_read_bool(node, "usb3-lpm-capable")) ||
150 			(pdata && pdata->usb3_lpm_capable))
151 		xhci->quirks |= XHCI_LPM_SUPPORT;
152 	/*
153 	 * Set the xHCI pointer before xhci_plat_setup() (aka hcd_driver.reset)
154 	 * is called by usb_add_hcd().
155 	 */
156 	*((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
157 
158 	if (HCC_MAX_PSA(xhci->hcc_params) >= 4)
159 		xhci->shared_hcd->can_do_streams = 1;
160 
161 	ret = usb_add_hcd(xhci->shared_hcd, irq, IRQF_SHARED);
162 	if (ret)
163 		goto put_usb3_hcd;
164 
165 	return 0;
166 
167 put_usb3_hcd:
168 	usb_put_hcd(xhci->shared_hcd);
169 
170 dealloc_usb2_hcd:
171 	usb_remove_hcd(hcd);
172 
173 disable_clk:
174 	if (!IS_ERR(clk))
175 		clk_disable_unprepare(clk);
176 
177 put_hcd:
178 	usb_put_hcd(hcd);
179 
180 	return ret;
181 }
182 
183 static int xhci_plat_remove(struct platform_device *dev)
184 {
185 	struct usb_hcd	*hcd = platform_get_drvdata(dev);
186 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
187 	struct clk *clk = xhci->clk;
188 
189 	usb_remove_hcd(xhci->shared_hcd);
190 	usb_put_hcd(xhci->shared_hcd);
191 
192 	usb_remove_hcd(hcd);
193 	if (!IS_ERR(clk))
194 		clk_disable_unprepare(clk);
195 	usb_put_hcd(hcd);
196 	kfree(xhci);
197 
198 	return 0;
199 }
200 
201 #ifdef CONFIG_PM_SLEEP
202 static int xhci_plat_suspend(struct device *dev)
203 {
204 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
205 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
206 
207 	/*
208 	 * xhci_suspend() needs `do_wakeup` to know whether host is allowed
209 	 * to do wakeup during suspend. Since xhci_plat_suspend is currently
210 	 * only designed for system suspend, device_may_wakeup() is enough
211 	 * to dertermine whether host is allowed to do wakeup. Need to
212 	 * reconsider this when xhci_plat_suspend enlarges its scope, e.g.,
213 	 * also applies to runtime suspend.
214 	 */
215 	return xhci_suspend(xhci, device_may_wakeup(dev));
216 }
217 
218 static int xhci_plat_resume(struct device *dev)
219 {
220 	struct usb_hcd	*hcd = dev_get_drvdata(dev);
221 	struct xhci_hcd	*xhci = hcd_to_xhci(hcd);
222 
223 	return xhci_resume(xhci, 0);
224 }
225 
226 static const struct dev_pm_ops xhci_plat_pm_ops = {
227 	SET_SYSTEM_SLEEP_PM_OPS(xhci_plat_suspend, xhci_plat_resume)
228 };
229 #define DEV_PM_OPS	(&xhci_plat_pm_ops)
230 #else
231 #define DEV_PM_OPS	NULL
232 #endif /* CONFIG_PM */
233 
234 #ifdef CONFIG_OF
235 static const struct of_device_id usb_xhci_of_match[] = {
236 	{ .compatible = "generic-xhci" },
237 	{ .compatible = "xhci-platform" },
238 	{ .compatible = "marvell,armada-375-xhci"},
239 	{ .compatible = "marvell,armada-380-xhci"},
240 	{ .compatible = "renesas,xhci-r8a7790"},
241 	{ .compatible = "renesas,xhci-r8a7791"},
242 	{ },
243 };
244 MODULE_DEVICE_TABLE(of, usb_xhci_of_match);
245 #endif
246 
247 static struct platform_driver usb_xhci_driver = {
248 	.probe	= xhci_plat_probe,
249 	.remove	= xhci_plat_remove,
250 	.driver	= {
251 		.name = "xhci-hcd",
252 		.pm = DEV_PM_OPS,
253 		.of_match_table = of_match_ptr(usb_xhci_of_match),
254 	},
255 };
256 MODULE_ALIAS("platform:xhci-hcd");
257 
258 static int __init xhci_plat_init(void)
259 {
260 	xhci_init_driver(&xhci_plat_hc_driver, xhci_plat_setup);
261 	xhci_plat_hc_driver.start = xhci_plat_start;
262 	return platform_driver_register(&usb_xhci_driver);
263 }
264 module_init(xhci_plat_init);
265 
266 static void __exit xhci_plat_exit(void)
267 {
268 	platform_driver_unregister(&usb_xhci_driver);
269 }
270 module_exit(xhci_plat_exit);
271 
272 MODULE_DESCRIPTION("xHCI Platform Host Controller Driver");
273 MODULE_LICENSE("GPL");
274