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