1 // SPDX-License-Identifier: GPL-2.0+
3 * ehci-omap.c - driver for USBHOST on OMAP3/4 processors
5 * Bus Glue for the EHCI controllers in OMAP3/4
6 * Tested on several OMAP3 boards, and OMAP4 Pandaboard
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>
14 * Copyright (C) 2009 Nokia Corporation
15 * Contact: Felipe Balbi <felipe.balbi@nokia.com>
17 * Based on "ehci-fsl.c" and "ehci-au1xxx.c" ehci glue layers
20 #include <linux/kernel.h>
21 #include <linux/module.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>
32 #include <linux/dma-mapping.h>
36 #include <linux/platform_data/usb-omap.h>
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
49 #define DRIVER_DESC "OMAP-EHCI Host Controller driver"
51 static const char hcd_name
[] = "ehci-omap";
53 /*-------------------------------------------------------------------------*/
56 struct usb_phy
*phy
[OMAP3_HS_USB_PORTS
]; /* one PHY for each port */
60 static inline void ehci_write(void __iomem
*base
, u32 reg
, u32 val
)
62 __raw_writel(val
, base
+ reg
);
65 static inline u32
ehci_read(void __iomem
*base
, u32 reg
)
67 return __raw_readl(base
+ reg
);
70 /* configure so an HC device and id are always provided */
71 /* always called with process context; sleeping is OK */
73 static struct hc_driver __read_mostly ehci_omap_hc_driver
;
75 static const struct ehci_driver_overrides ehci_omap_overrides __initconst
= {
76 .extra_priv_size
= sizeof(struct omap_hcd
),
80 * ehci_hcd_omap_probe - initialize TI-based HCDs
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.
86 static int ehci_hcd_omap_probe(struct platform_device
*pdev
)
88 struct device
*dev
= &pdev
->dev
;
89 struct usbhs_omap_platform_data
*pdata
= dev_get_platdata(dev
);
96 struct omap_hcd
*omap
;
102 dev_err(dev
, "Missing parent device\n");
106 /* For DT boot, get platform data from parent. i.e. usbhshost */
108 pdata
= dev_get_platdata(dev
->parent
);
109 dev
->platform_data
= pdata
;
113 dev_err(dev
, "Missing platform data\n");
117 irq
= platform_get_irq(pdev
, 0);
119 dev_err(dev
, "EHCI irq failed: %d\n", irq
);
123 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
124 regs
= devm_ioremap_resource(dev
, res
);
126 return PTR_ERR(regs
);
129 * Right now device-tree probed devices don't get dma_mask set.
130 * Since shared usb code relies on it, set it here for now.
131 * Once we have dma capability bindings this can go away.
133 ret
= dma_coerce_mask_and_coherent(dev
, DMA_BIT_MASK(32));
138 hcd
= usb_create_hcd(&ehci_omap_hc_driver
, dev
,
141 dev_err(dev
, "Failed to create HCD\n");
145 hcd
->rsrc_start
= res
->start
;
146 hcd
->rsrc_len
= resource_size(res
);
148 hcd_to_ehci(hcd
)->caps
= regs
;
150 omap
= (struct omap_hcd
*)hcd_to_ehci(hcd
)->priv
;
151 omap
->nports
= pdata
->nports
;
153 platform_set_drvdata(pdev
, hcd
);
155 /* get the PHY devices if needed */
156 for (i
= 0 ; i
< omap
->nports
; i
++) {
159 /* get the PHY device */
160 phy
= devm_usb_get_phy_by_phandle(dev
, "phys", i
);
163 if (ret
== -ENODEV
) { /* no PHY */
168 if (ret
!= -EPROBE_DEFER
)
169 dev_err(dev
, "Can't get PHY for port %d: %d\n",
176 if (pdata
->port_mode
[i
] == OMAP_EHCI_PORT_MODE_PHY
) {
177 usb_phy_init(omap
->phy
[i
]);
178 /* bring PHY out of suspend */
179 usb_phy_set_suspend(omap
->phy
[i
], 0);
183 pm_runtime_enable(dev
);
184 pm_runtime_get_sync(dev
);
187 * An undocumented "feature" in the OMAP3 EHCI controller,
188 * causes suspended ports to be taken out of suspend when
189 * the USBCMD.Run/Stop bit is cleared (for example when
190 * we do ehci_bus_suspend).
191 * This breaks suspend-resume if the root-hub is allowed
192 * to suspend. Writing 1 to this undocumented register bit
193 * disables this feature and restores normal behavior.
195 ehci_write(regs
, EHCI_INSNREG04
,
196 EHCI_INSNREG04_DISABLE_UNSUSPEND
);
198 ret
= usb_add_hcd(hcd
, irq
, IRQF_SHARED
);
200 dev_err(dev
, "failed to add hcd with err %d\n", ret
);
203 device_wakeup_enable(hcd
->self
.controller
);
206 * Bring PHYs out of reset for non PHY modes.
207 * Even though HSIC mode is a PHY-less mode, the reset
208 * line exists between the chips and can be modelled
209 * as a PHY device for reset control.
211 for (i
= 0; i
< omap
->nports
; i
++) {
213 pdata
->port_mode
[i
] == OMAP_EHCI_PORT_MODE_PHY
)
216 usb_phy_init(omap
->phy
[i
]);
217 /* bring PHY out of suspend */
218 usb_phy_set_suspend(omap
->phy
[i
], 0);
224 pm_runtime_put_sync(dev
);
227 for (i
= 0; i
< omap
->nports
; i
++) {
229 usb_phy_shutdown(omap
->phy
[i
]);
239 * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
240 * @pdev: USB Host Controller being removed
242 * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
243 * the HCD's stop() method. It is always called from a thread
244 * context, normally "rmmod", "apmd", or something similar.
246 static int ehci_hcd_omap_remove(struct platform_device
*pdev
)
248 struct device
*dev
= &pdev
->dev
;
249 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
250 struct omap_hcd
*omap
= (struct omap_hcd
*)hcd_to_ehci(hcd
)->priv
;
255 for (i
= 0; i
< omap
->nports
; i
++) {
257 usb_phy_shutdown(omap
->phy
[i
]);
261 pm_runtime_put_sync(dev
);
262 pm_runtime_disable(dev
);
267 static const struct of_device_id omap_ehci_dt_ids
[] = {
268 { .compatible
= "ti,ehci-omap" },
272 MODULE_DEVICE_TABLE(of
, omap_ehci_dt_ids
);
274 static struct platform_driver ehci_hcd_omap_driver
= {
275 .probe
= ehci_hcd_omap_probe
,
276 .remove
= ehci_hcd_omap_remove
,
277 .shutdown
= usb_hcd_platform_shutdown
,
278 /*.suspend = ehci_hcd_omap_suspend, */
279 /*.resume = ehci_hcd_omap_resume, */
282 .of_match_table
= omap_ehci_dt_ids
,
286 /*-------------------------------------------------------------------------*/
288 static int __init
ehci_omap_init(void)
293 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
295 ehci_init_driver(&ehci_omap_hc_driver
, &ehci_omap_overrides
);
296 return platform_driver_register(&ehci_hcd_omap_driver
);
298 module_init(ehci_omap_init
);
300 static void __exit
ehci_omap_cleanup(void)
302 platform_driver_unregister(&ehci_hcd_omap_driver
);
304 module_exit(ehci_omap_cleanup
);
306 MODULE_ALIAS("platform:ehci-omap");
307 MODULE_AUTHOR("Texas Instruments, Inc.");
308 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
309 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>");
311 MODULE_DESCRIPTION(DRIVER_DESC
);
312 MODULE_LICENSE("GPL");