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
ehci_write(void __iomem * base,u32 reg,u32 val)59 static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
60 {
61 __raw_writel(val, base + reg);
62 }
63
ehci_read(void __iomem * base,u32 reg)64 static inline u32 ehci_read(void __iomem *base, u32 reg)
65 {
66 return __raw_readl(base + reg);
67 }
68
69 /* configure so an HC device and id are always provided */
70 /* always called with process context; sleeping is OK */
71
72 static struct hc_driver __read_mostly ehci_omap_hc_driver;
73
74 static const struct ehci_driver_overrides ehci_omap_overrides __initconst = {
75 .extra_priv_size = sizeof(struct omap_hcd),
76 };
77
78 /**
79 * ehci_hcd_omap_probe - initialize TI-based HCDs
80 * @pdev: Pointer to this platform device's information
81 *
82 * Allocates basic resources for this USB host controller, and
83 * then invokes the start() method for the HCD associated with it
84 * through the hotplug entry's driver_data.
85 */
ehci_hcd_omap_probe(struct platform_device * pdev)86 static int ehci_hcd_omap_probe(struct platform_device *pdev)
87 {
88 struct device *dev = &pdev->dev;
89 struct usbhs_omap_platform_data *pdata = dev_get_platdata(dev);
90 struct resource *res;
91 struct usb_hcd *hcd;
92 void __iomem *regs;
93 int ret;
94 int irq;
95 int i;
96 struct omap_hcd *omap;
97
98 if (usb_disabled())
99 return -ENODEV;
100
101 if (!dev->parent) {
102 dev_err(dev, "Missing parent device\n");
103 return -ENODEV;
104 }
105
106 /* For DT boot, get platform data from parent. i.e. usbhshost */
107 if (dev->of_node) {
108 pdata = dev_get_platdata(dev->parent);
109 dev->platform_data = pdata;
110 }
111
112 if (!pdata) {
113 dev_err(dev, "Missing platform data\n");
114 return -ENODEV;
115 }
116
117 irq = platform_get_irq(pdev, 0);
118 if (irq < 0)
119 return irq;
120
121 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
122 regs = devm_ioremap_resource(dev, res);
123 if (IS_ERR(regs))
124 return PTR_ERR(regs);
125
126 /*
127 * Right now device-tree probed devices don't get dma_mask set.
128 * Since shared usb code relies on it, set it here for now.
129 * Once we have dma capability bindings this can go away.
130 */
131 ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32));
132 if (ret)
133 return ret;
134
135 ret = -ENODEV;
136 hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
137 dev_name(dev));
138 if (!hcd) {
139 dev_err(dev, "Failed to create HCD\n");
140 return -ENOMEM;
141 }
142
143 hcd->rsrc_start = res->start;
144 hcd->rsrc_len = resource_size(res);
145 hcd->regs = regs;
146 hcd_to_ehci(hcd)->caps = regs;
147
148 omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
149 omap->nports = pdata->nports;
150
151 platform_set_drvdata(pdev, hcd);
152
153 /* get the PHY devices if needed */
154 for (i = 0 ; i < omap->nports ; i++) {
155 struct usb_phy *phy;
156
157 /* get the PHY device */
158 phy = devm_usb_get_phy_by_phandle(dev, "phys", i);
159 if (IS_ERR(phy)) {
160 ret = PTR_ERR(phy);
161 if (ret == -ENODEV) { /* no PHY */
162 phy = NULL;
163 continue;
164 }
165
166 if (ret != -EPROBE_DEFER)
167 dev_err(dev, "Can't get PHY for port %d: %d\n",
168 i, ret);
169 goto err_phy;
170 }
171
172 omap->phy[i] = phy;
173
174 if (pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) {
175 usb_phy_init(omap->phy[i]);
176 /* bring PHY out of suspend */
177 usb_phy_set_suspend(omap->phy[i], 0);
178 }
179 }
180
181 pm_runtime_enable(dev);
182 pm_runtime_get_sync(dev);
183
184 /*
185 * An undocumented "feature" in the OMAP3 EHCI controller,
186 * causes suspended ports to be taken out of suspend when
187 * the USBCMD.Run/Stop bit is cleared (for example when
188 * we do ehci_bus_suspend).
189 * This breaks suspend-resume if the root-hub is allowed
190 * to suspend. Writing 1 to this undocumented register bit
191 * disables this feature and restores normal behavior.
192 */
193 ehci_write(regs, EHCI_INSNREG04,
194 EHCI_INSNREG04_DISABLE_UNSUSPEND);
195
196 ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
197 if (ret) {
198 dev_err(dev, "failed to add hcd with err %d\n", ret);
199 goto err_pm_runtime;
200 }
201 device_wakeup_enable(hcd->self.controller);
202
203 /*
204 * Bring PHYs out of reset for non PHY modes.
205 * Even though HSIC mode is a PHY-less mode, the reset
206 * line exists between the chips and can be modelled
207 * as a PHY device for reset control.
208 */
209 for (i = 0; i < omap->nports; i++) {
210 if (!omap->phy[i] ||
211 pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY)
212 continue;
213
214 usb_phy_init(omap->phy[i]);
215 /* bring PHY out of suspend */
216 usb_phy_set_suspend(omap->phy[i], 0);
217 }
218
219 return 0;
220
221 err_pm_runtime:
222 pm_runtime_put_sync(dev);
223 pm_runtime_disable(dev);
224
225 err_phy:
226 for (i = 0; i < omap->nports; i++) {
227 if (omap->phy[i])
228 usb_phy_shutdown(omap->phy[i]);
229 }
230
231 usb_put_hcd(hcd);
232
233 return ret;
234 }
235
236
237 /**
238 * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
239 * @pdev: USB Host Controller being removed
240 *
241 * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
242 * the HCD's stop() method. It is always called from a thread
243 * context, normally "rmmod", "apmd", or something similar.
244 */
ehci_hcd_omap_remove(struct platform_device * pdev)245 static int ehci_hcd_omap_remove(struct platform_device *pdev)
246 {
247 struct device *dev = &pdev->dev;
248 struct usb_hcd *hcd = dev_get_drvdata(dev);
249 struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
250 int i;
251
252 usb_remove_hcd(hcd);
253
254 for (i = 0; i < omap->nports; i++) {
255 if (omap->phy[i])
256 usb_phy_shutdown(omap->phy[i]);
257 }
258
259 usb_put_hcd(hcd);
260 pm_runtime_put_sync(dev);
261 pm_runtime_disable(dev);
262
263 return 0;
264 }
265
266 static const struct of_device_id omap_ehci_dt_ids[] = {
267 { .compatible = "ti,ehci-omap" },
268 { }
269 };
270
271 MODULE_DEVICE_TABLE(of, omap_ehci_dt_ids);
272
273 static struct platform_driver ehci_hcd_omap_driver = {
274 .probe = ehci_hcd_omap_probe,
275 .remove = ehci_hcd_omap_remove,
276 .shutdown = usb_hcd_platform_shutdown,
277 /*.suspend = ehci_hcd_omap_suspend, */
278 /*.resume = ehci_hcd_omap_resume, */
279 .driver = {
280 .name = hcd_name,
281 .of_match_table = omap_ehci_dt_ids,
282 }
283 };
284
285 /*-------------------------------------------------------------------------*/
286
ehci_omap_init(void)287 static int __init ehci_omap_init(void)
288 {
289 if (usb_disabled())
290 return -ENODEV;
291
292 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
293
294 ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides);
295 return platform_driver_register(&ehci_hcd_omap_driver);
296 }
297 module_init(ehci_omap_init);
298
ehci_omap_cleanup(void)299 static void __exit ehci_omap_cleanup(void)
300 {
301 platform_driver_unregister(&ehci_hcd_omap_driver);
302 }
303 module_exit(ehci_omap_cleanup);
304
305 MODULE_ALIAS("platform:ehci-omap");
306 MODULE_AUTHOR("Texas Instruments, Inc.");
307 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
308 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
309
310 MODULE_DESCRIPTION(DRIVER_DESC);
311 MODULE_LICENSE("GPL");
312