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