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 51 static const char hcd_name[] = "ehci-omap"; 52 53 /*-------------------------------------------------------------------------*/ 54 55 struct omap_hcd { 56 struct usb_phy *phy[OMAP3_HS_USB_PORTS]; /* one PHY for each port */ 57 int nports; 58 }; 59 60 static inline void ehci_write(void __iomem *base, u32 reg, u32 val) 61 { 62 __raw_writel(val, base + reg); 63 } 64 65 static 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 73 static struct hc_driver __read_mostly ehci_omap_hc_driver; 74 75 static 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 */ 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 dev_err(dev, "EHCI irq failed: %d\n", irq); 120 return irq; 121 } 122 123 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 124 regs = devm_ioremap_resource(dev, res); 125 if (IS_ERR(regs)) 126 return PTR_ERR(regs); 127 128 /* 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. 132 */ 133 ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32)); 134 if (ret) 135 return ret; 136 137 ret = -ENODEV; 138 hcd = usb_create_hcd(&ehci_omap_hc_driver, dev, 139 dev_name(dev)); 140 if (!hcd) { 141 dev_err(dev, "Failed to create HCD\n"); 142 return -ENOMEM; 143 } 144 145 hcd->rsrc_start = res->start; 146 hcd->rsrc_len = resource_size(res); 147 hcd->regs = regs; 148 hcd_to_ehci(hcd)->caps = regs; 149 150 omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv; 151 omap->nports = pdata->nports; 152 153 platform_set_drvdata(pdev, hcd); 154 155 /* get the PHY devices if needed */ 156 for (i = 0 ; i < omap->nports ; i++) { 157 struct usb_phy *phy; 158 159 /* get the PHY device */ 160 phy = devm_usb_get_phy_by_phandle(dev, "phys", i); 161 if (IS_ERR(phy)) { 162 /* Don't bail out if PHY is not absolutely necessary */ 163 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY) 164 continue; 165 166 ret = PTR_ERR(phy); 167 if (ret != -EPROBE_DEFER) 168 dev_err(dev, "Can't get PHY for port %d: %d\n", 169 i, ret); 170 goto err_phy; 171 } 172 173 omap->phy[i] = phy; 174 175 if (pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) { 176 usb_phy_init(omap->phy[i]); 177 /* bring PHY out of suspend */ 178 usb_phy_set_suspend(omap->phy[i], 0); 179 } 180 } 181 182 pm_runtime_enable(dev); 183 pm_runtime_get_sync(dev); 184 185 /* 186 * An undocumented "feature" in the OMAP3 EHCI controller, 187 * causes suspended ports to be taken out of suspend when 188 * the USBCMD.Run/Stop bit is cleared (for example when 189 * we do ehci_bus_suspend). 190 * This breaks suspend-resume if the root-hub is allowed 191 * to suspend. Writing 1 to this undocumented register bit 192 * disables this feature and restores normal behavior. 193 */ 194 ehci_write(regs, EHCI_INSNREG04, 195 EHCI_INSNREG04_DISABLE_UNSUSPEND); 196 197 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 198 if (ret) { 199 dev_err(dev, "failed to add hcd with err %d\n", ret); 200 goto err_pm_runtime; 201 } 202 device_wakeup_enable(hcd->self.controller); 203 204 /* 205 * Bring PHYs out of reset for non PHY modes. 206 * Even though HSIC mode is a PHY-less mode, the reset 207 * line exists between the chips and can be modelled 208 * as a PHY device for reset control. 209 */ 210 for (i = 0; i < omap->nports; i++) { 211 if (!omap->phy[i] || 212 pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) 213 continue; 214 215 usb_phy_init(omap->phy[i]); 216 /* bring PHY out of suspend */ 217 usb_phy_set_suspend(omap->phy[i], 0); 218 } 219 220 return 0; 221 222 err_pm_runtime: 223 pm_runtime_put_sync(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 */ 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 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 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