drivers/usb/host/ehci-omap.c

   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-2011 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  *
  12  * Copyright (C) 2009 Nokia Corporation
  13  *      Contact: Felipe Balbi <felipe.balbi@nokia.com>
  14  *
  15  * Based on "ehci-fsl.c" and "ehci-au1xxx.c" ehci glue layers
  16  *
  17  * This program is free software; you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation; either version 2 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, write to the Free Software
  29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  30  *
  31  * TODO (last updated Feb 27, 2010):
  32  *      - add kernel-doc
  33  *      - enable AUTOIDLE
  34  *      - add suspend/resume
  35  *      - add HSIC and TLL support
  36  *      - convert to use hwmod and runtime PM
  37  */
  38
  39 #include <linux/kernel.h>
  40 #include <linux/module.h>
  41 #include <linux/io.h>
  42 #include <linux/platform_device.h>
  43 #include <linux/slab.h>
  44 #include <linux/usb/ulpi.h>
  45 #include <linux/regulator/consumer.h>
  46 #include <linux/pm_runtime.h>
  47 #include <linux/gpio.h>
  48 #include <linux/clk.h>
  49 #include <linux/usb.h>
  50 #include <linux/usb/hcd.h>
  51
  52 #include "ehci.h"
  53
  54 #include <linux/platform_data/usb-omap.h>
  55
  56 /* EHCI Register Set */
  57 #define EHCI_INSNREG04                                  (0xA0)
  58 #define EHCI_INSNREG04_DISABLE_UNSUSPEND                (1 << 5)
  59 #define EHCI_INSNREG05_ULPI                             (0xA4)
  60 #define EHCI_INSNREG05_ULPI_CONTROL_SHIFT               31
  61 #define EHCI_INSNREG05_ULPI_PORTSEL_SHIFT               24
  62 #define EHCI_INSNREG05_ULPI_OPSEL_SHIFT                 22
  63 #define EHCI_INSNREG05_ULPI_REGADD_SHIFT                16
  64 #define EHCI_INSNREG05_ULPI_EXTREGADD_SHIFT             8
  65 #define EHCI_INSNREG05_ULPI_WRDATA_SHIFT                0
  66
  67 #define DRIVER_DESC "OMAP-EHCI Host Controller driver"
  68
  69 static const char hcd_name[] = "ehci-omap";
  70
  71 /*-------------------------------------------------------------------------*/
  72
  73
  74 static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
  75 {
  76         __raw_writel(val, base + reg);
  77 }
  78
  79 static inline u32 ehci_read(void __iomem *base, u32 reg)
  80 {
  81         return __raw_readl(base + reg);
  82 }
  83
  84
  85 static void omap_ehci_soft_phy_reset(struct usb_hcd *hcd, u8 port)
  86 {
  87         unsigned long timeout = jiffies + msecs_to_jiffies(1000);
  88         unsigned reg = 0;
  89
  90         reg = ULPI_FUNC_CTRL_RESET
  91                 /* FUNCTION_CTRL_SET register */
  92                 | (ULPI_SET(ULPI_FUNC_CTRL) << EHCI_INSNREG05_ULPI_REGADD_SHIFT)
  93                 /* Write */
  94                 | (2 << EHCI_INSNREG05_ULPI_OPSEL_SHIFT)
  95                 /* PORTn */
  96                 | ((port + 1) << EHCI_INSNREG05_ULPI_PORTSEL_SHIFT)
  97                 /* start ULPI access*/
  98                 | (1 << EHCI_INSNREG05_ULPI_CONTROL_SHIFT);
  99
 100         ehci_write(hcd->regs, EHCI_INSNREG05_ULPI, reg);
 101
 102         /* Wait for ULPI access completion */
 103         while ((ehci_read(hcd->regs, EHCI_INSNREG05_ULPI)
 104                         & (1 << EHCI_INSNREG05_ULPI_CONTROL_SHIFT))) {
 105                 cpu_relax();
 106
 107                 if (time_after(jiffies, timeout)) {
 108                         dev_dbg(hcd->self.controller,
 109                                         "phy reset operation timed out\n");
 110                         break;
 111                 }
 112         }
 113 }
 114
 115 static int omap_ehci_init(struct usb_hcd *hcd)
 116 {
 117         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 118         int                     rc;
 119         struct usbhs_omap_platform_data *pdata;
 120
 121         pdata = hcd->self.controller->platform_data;
 122
 123         /* Hold PHYs in reset while initializing EHCI controller */
 124         if (pdata->phy_reset) {
 125                 if (gpio_is_valid(pdata->reset_gpio_port[0]))
 126                         gpio_set_value_cansleep(pdata->reset_gpio_port[0], 0);
 127
 128                 if (gpio_is_valid(pdata->reset_gpio_port[1]))
 129                         gpio_set_value_cansleep(pdata->reset_gpio_port[1], 0);
 130
 131                 /* Hold the PHY in RESET for enough time till DIR is high */
 132                 udelay(10);
 133         }
 134
 135         /* Soft reset the PHY using PHY reset command over ULPI */
 136         if (pdata->port_mode[0] == OMAP_EHCI_PORT_MODE_PHY)
 137                 omap_ehci_soft_phy_reset(hcd, 0);
 138         if (pdata->port_mode[1] == OMAP_EHCI_PORT_MODE_PHY)
 139                 omap_ehci_soft_phy_reset(hcd, 1);
 140
 141         /* we know this is the memory we want, no need to ioremap again */
 142         ehci->caps = hcd->regs;
 143
 144         rc = ehci_setup(hcd);
 145
 146         if (pdata->phy_reset) {
 147                 /* Hold the PHY in RESET for enough time till
 148                  * PHY is settled and ready
 149                  */
 150                 udelay(10);
 151
 152                 if (gpio_is_valid(pdata->reset_gpio_port[0]))
 153                         gpio_set_value_cansleep(pdata->reset_gpio_port[0], 1);
 154
 155                 if (gpio_is_valid(pdata->reset_gpio_port[1]))
 156                         gpio_set_value_cansleep(pdata->reset_gpio_port[1], 1);
 157         }
 158
 159         return rc;
 160 }
 161
 162 static void disable_put_regulator(
 163                 struct usbhs_omap_platform_data *pdata)
 164 {
 165         int i;
 166
 167         for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
 168                 if (pdata->regulator[i]) {
 169                         regulator_disable(pdata->regulator[i]);
 170                         regulator_put(pdata->regulator[i]);
 171                 }
 172         }
 173 }
 174
 175 /* configure so an HC device and id are always provided */
 176 /* always called with process context; sleeping is OK */
 177
 178 static struct hc_driver __read_mostly ehci_omap_hc_driver;
 179
 180 static const struct ehci_driver_overrides ehci_omap_overrides __initdata = {
 181         .reset =                omap_ehci_init,
 182 };
 183
 184 /**
 185  * ehci_hcd_omap_probe - initialize TI-based HCDs
 186  *
 187  * Allocates basic resources for this USB host controller, and
 188  * then invokes the start() method for the HCD associated with it
 189  * through the hotplug entry's driver_data.
 190  */
 191 static int ehci_hcd_omap_probe(struct platform_device *pdev)
 192 {
 193         struct device                           *dev = &pdev->dev;
 194         struct usbhs_omap_platform_data         *pdata = dev->platform_data;
 195         struct resource                         *res;
 196         struct usb_hcd                          *hcd;
 197         void __iomem                            *regs;
 198         int                                     ret = -ENODEV;
 199         int                                     irq;
 200         int                                     i;
 201         char                                    supply[7];
 202
 203         if (usb_disabled())
 204                 return -ENODEV;
 205
 206         if (!dev->parent) {
 207                 dev_err(dev, "Missing parent device\n");
 208                 return -ENODEV;
 209         }
 210
 211         irq = platform_get_irq_byname(pdev, "ehci-irq");
 212         if (irq < 0) {
 213                 dev_err(dev, "EHCI irq failed\n");
 214                 return -ENODEV;
 215         }
 216
 217         res =  platform_get_resource_byname(pdev,
 218                                 IORESOURCE_MEM, "ehci");
 219         if (!res) {
 220                 dev_err(dev, "UHH EHCI get resource failed\n");
 221                 return -ENODEV;
 222         }
 223
 224         regs = ioremap(res->start, resource_size(res));
 225         if (!regs) {
 226                 dev_err(dev, "UHH EHCI ioremap failed\n");
 227                 return -ENOMEM;
 228         }
 229
 230         hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
 231                         dev_name(dev));
 232         if (!hcd) {
 233                 dev_err(dev, "failed to create hcd with err %d\n", ret);
 234                 ret = -ENOMEM;
 235                 goto err_io;
 236         }
 237
 238         hcd->rsrc_start = res->start;
 239         hcd->rsrc_len = resource_size(res);
 240         hcd->regs = regs;
 241
 242         /* get ehci regulator and enable */
 243         for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
 244                 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY) {
 245                         pdata->regulator[i] = NULL;
 246                         continue;
 247                 }
 248                 snprintf(supply, sizeof(supply), "hsusb%d", i);
 249                 pdata->regulator[i] = regulator_get(dev, supply);
 250                 if (IS_ERR(pdata->regulator[i])) {
 251                         pdata->regulator[i] = NULL;
 252                         dev_dbg(dev,
 253                         "failed to get ehci port%d regulator\n", i);
 254                 } else {
 255                         regulator_enable(pdata->regulator[i]);
 256                 }
 257         }
 258
 259         pm_runtime_enable(dev);
 260         pm_runtime_get_sync(dev);
 261
 262         /*
 263          * An undocumented "feature" in the OMAP3 EHCI controller,
 264          * causes suspended ports to be taken out of suspend when
 265          * the USBCMD.Run/Stop bit is cleared (for example when
 266          * we do ehci_bus_suspend).
 267          * This breaks suspend-resume if the root-hub is allowed
 268          * to suspend. Writing 1 to this undocumented register bit
 269          * disables this feature and restores normal behavior.
 270          */
 271         ehci_write(regs, EHCI_INSNREG04,
 272                                 EHCI_INSNREG04_DISABLE_UNSUSPEND);
 273
 274         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 275         if (ret) {
 276                 dev_err(dev, "failed to add hcd with err %d\n", ret);
 277                 goto err_pm_runtime;
 278         }
 279
 280
 281         return 0;
 282
 283 err_pm_runtime:
 284         disable_put_regulator(pdata);
 285         pm_runtime_put_sync(dev);
 286         usb_put_hcd(hcd);
 287
 288 err_io:
 289         iounmap(regs);
 290         return ret;
 291 }
 292
 293
 294 /**
 295  * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
 296  * @pdev: USB Host Controller being removed
 297  *
 298  * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
 299  * the HCD's stop() method.  It is always called from a thread
 300  * context, normally "rmmod", "apmd", or something similar.
 301  */
 302 static int ehci_hcd_omap_remove(struct platform_device *pdev)
 303 {
 304         struct device *dev                              = &pdev->dev;
 305         struct usb_hcd *hcd                             = dev_get_drvdata(dev);
 306
 307         usb_remove_hcd(hcd);
 308         disable_put_regulator(dev->platform_data);
 309         iounmap(hcd->regs);
 310         usb_put_hcd(hcd);
 311
 312         pm_runtime_put_sync(dev);
 313         pm_runtime_disable(dev);
 314
 315         return 0;
 316 }
 317
 318 static void ehci_hcd_omap_shutdown(struct platform_device *pdev)
 319 {
 320         struct usb_hcd *hcd = dev_get_drvdata(&pdev->dev);
 321
 322         if (hcd->driver->shutdown)
 323                 hcd->driver->shutdown(hcd);
 324 }
 325
 326 static struct platform_driver ehci_hcd_omap_driver = {
 327         .probe                  = ehci_hcd_omap_probe,
 328         .remove                 = ehci_hcd_omap_remove,
 329         .shutdown               = ehci_hcd_omap_shutdown,
 330         /*.suspend              = ehci_hcd_omap_suspend, */
 331         /*.resume               = ehci_hcd_omap_resume, */
 332         .driver = {
 333                 .name           = hcd_name,
 334         }
 335 };
 336
 337 /*-------------------------------------------------------------------------*/
 338
 339 static int __init ehci_omap_init(void)
 340 {
 341         if (usb_disabled())
 342                 return -ENODEV;
 343
 344         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 345
 346         ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides);
 347         return platform_driver_register(&ehci_hcd_omap_driver);
 348 }
 349 module_init(ehci_omap_init);
 350
 351 static void __exit ehci_omap_cleanup(void)
 352 {
 353         platform_driver_unregister(&ehci_hcd_omap_driver);
 354 }
 355 module_exit(ehci_omap_cleanup);
 356
 357 MODULE_ALIAS("platform:ehci-omap");
 358 MODULE_AUTHOR("Texas Instruments, Inc.");
 359 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
 360
 361 MODULE_DESCRIPTION(DRIVER_DESC);
 362 MODULE_LICENSE("GPL");