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, 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->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 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 117 regs = devm_ioremap_resource(dev, res); 118 if (IS_ERR(regs)) 119 return PTR_ERR(regs); 120 121 /* 122 * Right now device-tree probed devices don't get dma_mask set. 123 * Since shared usb code relies on it, set it here for now. 124 * Once we have dma capability bindings this can go away. 125 */ 126 ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32)); 127 if (ret) 128 return ret; 129 130 ret = -ENODEV; 131 hcd = usb_create_hcd(&ehci_omap_hc_driver, dev, 132 dev_name(dev)); 133 if (!hcd) { 134 dev_err(dev, "Failed to create HCD\n"); 135 return -ENOMEM; 136 } 137 138 hcd->rsrc_start = res->start; 139 hcd->rsrc_len = resource_size(res); 140 hcd->regs = regs; 141 hcd_to_ehci(hcd)->caps = regs; 142 143 omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv; 144 omap->nports = pdata->nports; 145 146 platform_set_drvdata(pdev, hcd); 147 148 /* get the PHY devices if needed */ 149 for (i = 0 ; i < omap->nports ; i++) { 150 struct usb_phy *phy; 151 152 /* get the PHY device */ 153 phy = devm_usb_get_phy_by_phandle(dev, "phys", i); 154 if (IS_ERR(phy)) { 155 ret = PTR_ERR(phy); 156 if (ret == -ENODEV) { /* no PHY */ 157 phy = NULL; 158 continue; 159 } 160 161 if (ret != -EPROBE_DEFER) 162 dev_err(dev, "Can't get PHY for port %d: %d\n", 163 i, ret); 164 goto err_phy; 165 } 166 167 omap->phy[i] = phy; 168 169 if (pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) { 170 usb_phy_init(omap->phy[i]); 171 /* bring PHY out of suspend */ 172 usb_phy_set_suspend(omap->phy[i], 0); 173 } 174 } 175 176 pm_runtime_enable(dev); 177 pm_runtime_get_sync(dev); 178 179 /* 180 * An undocumented "feature" in the OMAP3 EHCI controller, 181 * causes suspended ports to be taken out of suspend when 182 * the USBCMD.Run/Stop bit is cleared (for example when 183 * we do ehci_bus_suspend). 184 * This breaks suspend-resume if the root-hub is allowed 185 * to suspend. Writing 1 to this undocumented register bit 186 * disables this feature and restores normal behavior. 187 */ 188 ehci_write(regs, EHCI_INSNREG04, 189 EHCI_INSNREG04_DISABLE_UNSUSPEND); 190 191 ret = usb_add_hcd(hcd, irq, IRQF_SHARED); 192 if (ret) { 193 dev_err(dev, "failed to add hcd with err %d\n", ret); 194 goto err_pm_runtime; 195 } 196 device_wakeup_enable(hcd->self.controller); 197 198 /* 199 * Bring PHYs out of reset for non PHY modes. 200 * Even though HSIC mode is a PHY-less mode, the reset 201 * line exists between the chips and can be modelled 202 * as a PHY device for reset control. 203 */ 204 for (i = 0; i < omap->nports; i++) { 205 if (!omap->phy[i] || 206 pdata->port_mode[i] == OMAP_EHCI_PORT_MODE_PHY) 207 continue; 208 209 usb_phy_init(omap->phy[i]); 210 /* bring PHY out of suspend */ 211 usb_phy_set_suspend(omap->phy[i], 0); 212 } 213 214 return 0; 215 216 err_pm_runtime: 217 pm_runtime_put_sync(dev); 218 pm_runtime_disable(dev); 219 220 err_phy: 221 for (i = 0; i < omap->nports; i++) { 222 if (omap->phy[i]) 223 usb_phy_shutdown(omap->phy[i]); 224 } 225 226 usb_put_hcd(hcd); 227 228 return ret; 229 } 230 231 232 /** 233 * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs 234 * @pdev: USB Host Controller being removed 235 * 236 * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking 237 * the HCD's stop() method. It is always called from a thread 238 * context, normally "rmmod", "apmd", or something similar. 239 */ 240 static int ehci_hcd_omap_remove(struct platform_device *pdev) 241 { 242 struct device *dev = &pdev->dev; 243 struct usb_hcd *hcd = dev_get_drvdata(dev); 244 struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv; 245 int i; 246 247 usb_remove_hcd(hcd); 248 249 for (i = 0; i < omap->nports; i++) { 250 if (omap->phy[i]) 251 usb_phy_shutdown(omap->phy[i]); 252 } 253 254 usb_put_hcd(hcd); 255 pm_runtime_put_sync(dev); 256 pm_runtime_disable(dev); 257 258 return 0; 259 } 260 261 static const struct of_device_id omap_ehci_dt_ids[] = { 262 { .compatible = "ti,ehci-omap" }, 263 { } 264 }; 265 266 MODULE_DEVICE_TABLE(of, omap_ehci_dt_ids); 267 268 static struct platform_driver ehci_hcd_omap_driver = { 269 .probe = ehci_hcd_omap_probe, 270 .remove = ehci_hcd_omap_remove, 271 .shutdown = usb_hcd_platform_shutdown, 272 /*.suspend = ehci_hcd_omap_suspend, */ 273 /*.resume = ehci_hcd_omap_resume, */ 274 .driver = { 275 .name = hcd_name, 276 .of_match_table = omap_ehci_dt_ids, 277 } 278 }; 279 280 /*-------------------------------------------------------------------------*/ 281 282 static int __init ehci_omap_init(void) 283 { 284 if (usb_disabled()) 285 return -ENODEV; 286 287 ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides); 288 return platform_driver_register(&ehci_hcd_omap_driver); 289 } 290 module_init(ehci_omap_init); 291 292 static void __exit ehci_omap_cleanup(void) 293 { 294 platform_driver_unregister(&ehci_hcd_omap_driver); 295 } 296 module_exit(ehci_omap_cleanup); 297 298 MODULE_ALIAS("platform:ehci-omap"); 299 MODULE_AUTHOR("Texas Instruments, Inc."); 300 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>"); 301 MODULE_AUTHOR("Roger Quadros <rogerq@ti.com>"); 302 303 MODULE_DESCRIPTION(DRIVER_DESC); 304 MODULE_LICENSE("GPL"); 305