1 | // SPDX-License-Identifier: GPL-2.0+ |
2 | /* |
3 | * ehci-omap.c - driver for USBHOST on OMAP3/4 processors |
4 | * |
5 | * Bus Glue for the EHCI controllers in OMAP3/4 |
6 | * Tested on several OMAP3 boards, and OMAP4 Pandaboard |
7 | * |
8 | * Copyright (C) 2007-2013 Texas Instruments, Inc. |
9 | * Author: Vikram Pandita <vikram.pandita@ti.com> |
10 | * Author: Anand Gadiyar <gadiyar@ti.com> |
11 | * Author: Keshava Munegowda <keshava_mgowda@ti.com> |
12 | * Author: Roger Quadros <rogerq@ti.com> |
13 | * |
14 | * Copyright (C) 2009 Nokia Corporation |
15 | * Contact: Felipe Balbi <felipe.balbi@nokia.com> |
16 | * |
17 | * Based on "ehci-fsl.c" and "ehci-au1xxx.c" ehci glue layers |
18 | */ |
19 | |
20 | #include <linux/kernel.h> |
21 | #include <linux/module.h> |
22 | #include <linux/io.h> |
23 | #include <linux/platform_device.h> |
24 | #include <linux/slab.h> |
25 | #include <linux/usb/ulpi.h> |
26 | #include <linux/pm_runtime.h> |
27 | #include <linux/clk.h> |
28 | #include <linux/usb.h> |
29 | #include <linux/usb/hcd.h> |
30 | #include <linux/of.h> |
31 | #include <linux/dma-mapping.h> |
32 | |
33 | #include "ehci.h" |
34 | |
35 | #include <linux/platform_data/usb-omap.h> |
36 | |
37 | /* EHCI Register Set */ |
38 | #define EHCI_INSNREG04 (0xA0) |
39 | #define EHCI_INSNREG04_DISABLE_UNSUSPEND (1 << 5) |
40 | #define EHCI_INSNREG05_ULPI (0xA4) |
41 | #define EHCI_INSNREG05_ULPI_CONTROL_SHIFT 31 |
42 | #define EHCI_INSNREG05_ULPI_PORTSEL_SHIFT 24 |
43 | #define EHCI_INSNREG05_ULPI_OPSEL_SHIFT 22 |
44 | #define EHCI_INSNREG05_ULPI_REGADD_SHIFT 16 |
45 | #define EHCI_INSNREG05_ULPI_EXTREGADD_SHIFT 8 |
46 | #define EHCI_INSNREG05_ULPI_WRDATA_SHIFT 0 |
47 | |
48 | #define DRIVER_DESC "OMAP-EHCI Host Controller driver" |
49 | |
50 | static const char hcd_name[] = "ehci-omap" ; |
51 | |
52 | /*-------------------------------------------------------------------------*/ |
53 | |
54 | struct omap_hcd { |
55 | struct usb_phy *phy[OMAP3_HS_USB_PORTS]; /* one PHY for each port */ |
56 | int nports; |
57 | }; |
58 | |
59 | static inline void ehci_write(void __iomem *base, u32 reg, u32 val) |
60 | { |
61 | __raw_writel(val, addr: base + reg); |
62 | } |
63 | |
64 | /* configure so an HC device and id are always provided */ |
65 | /* always called with process context; sleeping is OK */ |
66 | |
67 | static struct hc_driver __read_mostly ehci_omap_hc_driver; |
68 | |
69 | static const struct ehci_driver_overrides ehci_omap_overrides __initconst = { |
70 | .extra_priv_size = sizeof(struct omap_hcd), |
71 | }; |
72 | |
73 | /** |
74 | * ehci_hcd_omap_probe - initialize TI-based HCDs |
75 | * @pdev: Pointer to this platform device's information |
76 | * |
77 | * Allocates basic resources for this USB host controller, and |
78 | * then invokes the start() method for the HCD associated with it |
79 | * through the hotplug entry's driver_data. |
80 | */ |
81 | static int ehci_hcd_omap_probe(struct platform_device *pdev) |
82 | { |
83 | struct device *dev = &pdev->dev; |
84 | struct usbhs_omap_platform_data *pdata = dev_get_platdata(dev); |
85 | struct resource *res; |
86 | struct usb_hcd *hcd; |
87 | void __iomem *regs; |
88 | int ret; |
89 | int irq; |
90 | int i; |
91 | struct omap_hcd *omap; |
92 | |
93 | if (usb_disabled()) |
94 | return -ENODEV; |
95 | |
96 | if (!dev->parent) { |
97 | dev_err(dev, "Missing parent device\n" ); |
98 | return -ENODEV; |
99 | } |
100 | |
101 | /* For DT boot, get platform data from parent. i.e. usbhshost */ |
102 | if (dev->of_node) { |
103 | pdata = dev_get_platdata(dev: dev->parent); |
104 | dev->platform_data = pdata; |
105 | } |
106 | |
107 | if (!pdata) { |
108 | dev_err(dev, "Missing platform data\n" ); |
109 | return -ENODEV; |
110 | } |
111 | |
112 | irq = platform_get_irq(pdev, 0); |
113 | if (irq < 0) |
114 | return irq; |
115 | |
116 | regs = devm_platform_get_and_ioremap_resource(pdev, index: 0, res: &res); |
117 | if (IS_ERR(ptr: regs)) |
118 | return PTR_ERR(ptr: regs); |
119 | |
120 | /* |
121 | * Right now device-tree probed devices don't get dma_mask set. |
122 | * Since shared usb code relies on it, set it here for now. |
123 | * Once we have dma capability bindings this can go away. |
124 | */ |
125 | ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32)); |
126 | if (ret) |
127 | return ret; |
128 | |
129 | ret = -ENODEV; |
130 | hcd = usb_create_hcd(driver: &ehci_omap_hc_driver, dev, |
131 | bus_name: dev_name(dev)); |
132 | if (!hcd) { |
133 | dev_err(dev, "Failed to create HCD\n" ); |
134 | return -ENOMEM; |
135 | } |
136 | |
137 | hcd->rsrc_start = res->start; |
138 | hcd->rsrc_len = resource_size(res); |
139 | hcd->regs = regs; |
140 | hcd_to_ehci(hcd)->caps = regs; |
141 | |
142 | omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv; |
143 | omap->nports = pdata->nports; |
144 | |
145 | platform_set_drvdata(pdev, data: hcd); |
146 | |
147 | /* get the PHY devices if needed */ |
148 | for (i = 0 ; i < omap->nports ; i++) { |
149 | struct usb_phy *phy; |
150 | |
151 | /* get the PHY device */ |
152 | phy = devm_usb_get_phy_by_phandle(dev, phandle: "phys" , index: i); |
153 | if (IS_ERR(ptr: phy)) { |
154 | ret = PTR_ERR(ptr: phy); |
155 | if (ret == -ENODEV) { /* no PHY */ |
156 | phy = NULL; |
157 | continue; |
158 | } |
159 | |
160 | if (ret != -EPROBE_DEFER) |
161 | dev_err(dev, "Can't get PHY for port %d: %d\n" , |
162 | i, ret); |
163 | goto err_phy; |
164 | } |
165 | |
166 | omap->phy[i] = phy; |
167 | |
168 | if (pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) { |
169 | usb_phy_init(x: omap->phy[i]); |
170 | /* bring PHY out of suspend */ |
171 | usb_phy_set_suspend(x: omap->phy[i], suspend: 0); |
172 | } |
173 | } |
174 | |
175 | pm_runtime_enable(dev); |
176 | pm_runtime_get_sync(dev); |
177 | |
178 | /* |
179 | * An undocumented "feature" in the OMAP3 EHCI controller, |
180 | * causes suspended ports to be taken out of suspend when |
181 | * the USBCMD.Run/Stop bit is cleared (for example when |
182 | * we do ehci_bus_suspend). |
183 | * This breaks suspend-resume if the root-hub is allowed |
184 | * to suspend. Writing 1 to this undocumented register bit |
185 | * disables this feature and restores normal behavior. |
186 | */ |
187 | ehci_write(base: regs, EHCI_INSNREG04, |
188 | EHCI_INSNREG04_DISABLE_UNSUSPEND); |
189 | |
190 | ret = usb_add_hcd(hcd, irqnum: irq, IRQF_SHARED); |
191 | if (ret) { |
192 | dev_err(dev, "failed to add hcd with err %d\n" , ret); |
193 | goto err_pm_runtime; |
194 | } |
195 | device_wakeup_enable(dev: hcd->self.controller); |
196 | |
197 | /* |
198 | * Bring PHYs out of reset for non PHY modes. |
199 | * Even though HSIC mode is a PHY-less mode, the reset |
200 | * line exists between the chips and can be modelled |
201 | * as a PHY device for reset control. |
202 | */ |
203 | for (i = 0; i < omap->nports; i++) { |
204 | if (!omap->phy[i] || |
205 | pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) |
206 | continue; |
207 | |
208 | usb_phy_init(x: omap->phy[i]); |
209 | /* bring PHY out of suspend */ |
210 | usb_phy_set_suspend(x: omap->phy[i], suspend: 0); |
211 | } |
212 | |
213 | return 0; |
214 | |
215 | err_pm_runtime: |
216 | pm_runtime_put_sync(dev); |
217 | pm_runtime_disable(dev); |
218 | |
219 | err_phy: |
220 | for (i = 0; i < omap->nports; i++) { |
221 | if (omap->phy[i]) |
222 | usb_phy_shutdown(x: omap->phy[i]); |
223 | } |
224 | |
225 | usb_put_hcd(hcd); |
226 | |
227 | return ret; |
228 | } |
229 | |
230 | |
231 | /** |
232 | * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs |
233 | * @pdev: USB Host Controller being removed |
234 | * |
235 | * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking |
236 | * the HCD's stop() method. It is always called from a thread |
237 | * context, normally "rmmod", "apmd", or something similar. |
238 | */ |
239 | static void ehci_hcd_omap_remove(struct platform_device *pdev) |
240 | { |
241 | struct device *dev = &pdev->dev; |
242 | struct usb_hcd *hcd = dev_get_drvdata(dev); |
243 | struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv; |
244 | int i; |
245 | |
246 | usb_remove_hcd(hcd); |
247 | |
248 | for (i = 0; i < omap->nports; i++) { |
249 | if (omap->phy[i]) |
250 | usb_phy_shutdown(x: omap->phy[i]); |
251 | } |
252 | |
253 | usb_put_hcd(hcd); |
254 | pm_runtime_put_sync(dev); |
255 | pm_runtime_disable(dev); |
256 | } |
257 | |
258 | static const struct of_device_id omap_ehci_dt_ids[] = { |
259 | { .compatible = "ti,ehci-omap" }, |
260 | { } |
261 | }; |
262 | |
263 | MODULE_DEVICE_TABLE(of, omap_ehci_dt_ids); |
264 | |
265 | static struct platform_driver ehci_hcd_omap_driver = { |
266 | .probe = ehci_hcd_omap_probe, |
267 | .remove_new = ehci_hcd_omap_remove, |
268 | .shutdown = usb_hcd_platform_shutdown, |
269 | /*.suspend = ehci_hcd_omap_suspend, */ |
270 | /*.resume = ehci_hcd_omap_resume, */ |
271 | .driver = { |
272 | .name = hcd_name, |
273 | .of_match_table = omap_ehci_dt_ids, |
274 | } |
275 | }; |
276 | |
277 | /*-------------------------------------------------------------------------*/ |
278 | |
279 | static int __init ehci_omap_init(void) |
280 | { |
281 | if (usb_disabled()) |
282 | return -ENODEV; |
283 | |
284 | ehci_init_driver(drv: &ehci_omap_hc_driver, over: &ehci_omap_overrides); |
285 | return platform_driver_register(&ehci_hcd_omap_driver); |
286 | } |
287 | module_init(ehci_omap_init); |
288 | |
289 | static void __exit ehci_omap_cleanup(void) |
290 | { |
291 | platform_driver_unregister(&ehci_hcd_omap_driver); |
292 | } |
293 | module_exit(ehci_omap_cleanup); |
294 | |
295 | MODULE_ALIAS("platform:ehci-omap" ); |
296 | MODULE_AUTHOR("Texas Instruments, Inc." ); |
297 | MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>" ); |
298 | MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>" ); |
299 | |
300 | MODULE_DESCRIPTION(DRIVER_DESC); |
301 | MODULE_LICENSE("GPL" ); |
302 | |