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-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  * TODO (last updated Feb 27, 2010):
  33  *      - add kernel-doc
  34  *      - enable AUTOIDLE
  35  *      - add suspend/resume
  36  *      - add HSIC and TLL support
  37  *      - convert to use hwmod and runtime PM
  38  */
  39
  40 #include <linux/kernel.h>
  41 #include <linux/module.h>
  42 #include <linux/io.h>
  43 #include <linux/platform_device.h>
  44 #include <linux/slab.h>
  45 #include <linux/usb/ulpi.h>
  46 #include <linux/regulator/consumer.h>
  47 #include <linux/pm_runtime.h>
  48 #include <linux/gpio.h>
  49 #include <linux/clk.h>
  50 #include <linux/usb.h>
  51 #include <linux/usb/hcd.h>
  52
  53 #include "ehci.h"
  54
  55 #include <linux/platform_data/usb-omap.h>
  56
  57 /* EHCI Register Set */
  58 #define EHCI_INSNREG04                                  (0xA0)
  59 #define EHCI_INSNREG04_DISABLE_UNSUSPEND                (1 << 5)
  60 #define EHCI_INSNREG05_ULPI                             (0xA4)
  61 #define EHCI_INSNREG05_ULPI_CONTROL_SHIFT               31
  62 #define EHCI_INSNREG05_ULPI_PORTSEL_SHIFT               24
  63 #define EHCI_INSNREG05_ULPI_OPSEL_SHIFT                 22
  64 #define EHCI_INSNREG05_ULPI_REGADD_SHIFT                16
  65 #define EHCI_INSNREG05_ULPI_EXTREGADD_SHIFT             8
  66 #define EHCI_INSNREG05_ULPI_WRDATA_SHIFT                0
  67
  68 #define DRIVER_DESC "OMAP-EHCI Host Controller driver"
  69
  70 static const char hcd_name[] = "ehci-omap";
  71
  72 /*-------------------------------------------------------------------------*/
  73
  74 struct omap_hcd {
  75         struct usb_phy *phy[OMAP3_HS_USB_PORTS]; /* one PHY for each port */
  76         int nports;
  77 };
  78
  79 static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
  80 {
  81         __raw_writel(val, base + reg);
  82 }
  83
  84 static inline u32 ehci_read(void __iomem *base, u32 reg)
  85 {
  86         return __raw_readl(base + reg);
  87 }
  88
  89 static int omap_ehci_init(struct usb_hcd *hcd)
  90 {
  91         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  92         struct omap_hcd *omap = (struct omap_hcd *)ehci->priv;
  93         int rc, i;
  94
  95         /* Hold PHYs in reset while initializing EHCI controller */
  96         for (i = 0; i < omap->nports; i++) {
  97                 if (omap->phy[i])
  98                         usb_phy_shutdown(omap->phy[i]);
  99         }
 100
 101         /* we know this is the memory we want, no need to ioremap again */
 102         ehci->caps = hcd->regs;
 103
 104         rc = ehci_setup(hcd);
 105
 106         /* Bring PHYs out of reset */
 107         for (i = 0; i < omap->nports; i++) {
 108                 if (omap->phy[i])
 109                         usb_phy_init(omap->phy[i]);
 110         }
 111
 112         return rc;
 113 }
 114
 115 static void disable_put_regulator(
 116                 struct usbhs_omap_platform_data *pdata)
 117 {
 118         int i;
 119
 120         for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
 121                 if (pdata->regulator[i]) {
 122                         regulator_disable(pdata->regulator[i]);
 123                         regulator_put(pdata->regulator[i]);
 124                 }
 125         }
 126 }
 127
 128 /* configure so an HC device and id are always provided */
 129 /* always called with process context; sleeping is OK */
 130
 131 static struct hc_driver __read_mostly ehci_omap_hc_driver;
 132
 133 static const struct ehci_driver_overrides ehci_omap_overrides __initdata = {
 134         .reset = omap_ehci_init,
 135         .extra_priv_size = sizeof(struct omap_hcd),
 136 };
 137
 138 /**
 139  * ehci_hcd_omap_probe - initialize TI-based HCDs
 140  *
 141  * Allocates basic resources for this USB host controller, and
 142  * then invokes the start() method for the HCD associated with it
 143  * through the hotplug entry's driver_data.
 144  */
 145 static int ehci_hcd_omap_probe(struct platform_device *pdev)
 146 {
 147         struct device *dev = &pdev->dev;
 148         struct usbhs_omap_platform_data *pdata = dev->platform_data;
 149         struct resource *res;
 150         struct usb_hcd  *hcd;
 151         void __iomem *regs;
 152         int ret = -ENODEV;
 153         int irq;
 154         int i;
 155         char supply[7];
 156         struct omap_hcd *omap;
 157
 158         if (usb_disabled())
 159                 return -ENODEV;
 160
 161         if (!dev->parent) {
 162                 dev_err(dev, "Missing parent device\n");
 163                 return -ENODEV;
 164         }
 165
 166         irq = platform_get_irq_byname(pdev, "ehci-irq");
 167         if (irq < 0) {
 168                 dev_err(dev, "EHCI irq failed\n");
 169                 return -ENODEV;
 170         }
 171
 172         res =  platform_get_resource_byname(pdev,
 173                                 IORESOURCE_MEM, "ehci");
 174         regs = devm_ioremap_resource(dev, res);
 175         if (IS_ERR(regs))
 176                 return PTR_ERR(regs);
 177
 178         hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
 179                         dev_name(dev));
 180         if (!hcd) {
 181                 dev_err(dev, "Failed to create HCD\n");
 182                 return -ENOMEM;
 183         }
 184
 185         hcd->rsrc_start = res->start;
 186         hcd->rsrc_len = resource_size(res);
 187         hcd->regs = regs;
 188
 189         omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
 190         omap->nports = pdata->nports;
 191
 192         platform_set_drvdata(pdev, hcd);
 193
 194         /* get the PHY devices if needed */
 195         for (i = 0 ; i < omap->nports ; i++) {
 196                 struct usb_phy *phy;
 197
 198                 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY)
 199                         continue;
 200
 201                 /* get the PHY device */
 202                 phy = devm_usb_get_phy_dev(dev, i);
 203                 if (IS_ERR(phy) || !phy) {
 204                         ret = IS_ERR(phy) ? PTR_ERR(phy) : -ENODEV;
 205                         dev_err(dev, "Can't get PHY device for port %d: %d\n",
 206                                         i, ret);
 207                         goto err_phy;
 208                 }
 209
 210                 omap->phy[i] = phy;
 211                 usb_phy_init(omap->phy[i]);
 212                 /* bring PHY out of suspend */
 213                 usb_phy_set_suspend(omap->phy[i], 0);
 214         }
 215
 216         /* get ehci regulator and enable */
 217         for (i = 0 ; i < OMAP3_HS_USB_PORTS ; i++) {
 218                 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY) {
 219                         pdata->regulator[i] = NULL;
 220                         continue;
 221                 }
 222                 snprintf(supply, sizeof(supply), "hsusb%d", i);
 223                 pdata->regulator[i] = regulator_get(dev, supply);
 224                 if (IS_ERR(pdata->regulator[i])) {
 225                         pdata->regulator[i] = NULL;
 226                         dev_dbg(dev,
 227                         "failed to get ehci port%d regulator\n", i);
 228                 } else {
 229                         regulator_enable(pdata->regulator[i]);
 230                 }
 231         }
 232
 233         pm_runtime_enable(dev);
 234         pm_runtime_get_sync(dev);
 235
 236         /*
 237          * An undocumented "feature" in the OMAP3 EHCI controller,
 238          * causes suspended ports to be taken out of suspend when
 239          * the USBCMD.Run/Stop bit is cleared (for example when
 240          * we do ehci_bus_suspend).
 241          * This breaks suspend-resume if the root-hub is allowed
 242          * to suspend. Writing 1 to this undocumented register bit
 243          * disables this feature and restores normal behavior.
 244          */
 245         ehci_write(regs, EHCI_INSNREG04,
 246                                 EHCI_INSNREG04_DISABLE_UNSUSPEND);
 247
 248         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 249         if (ret) {
 250                 dev_err(dev, "failed to add hcd with err %d\n", ret);
 251                 goto err_pm_runtime;
 252         }
 253
 254
 255         return 0;
 256
 257 err_pm_runtime:
 258         disable_put_regulator(pdata);
 259         pm_runtime_put_sync(dev);
 260
 261 err_phy:
 262         for (i = 0; i < omap->nports; i++) {
 263                 if (omap->phy[i])
 264                         usb_phy_shutdown(omap->phy[i]);
 265         }
 266
 267         usb_put_hcd(hcd);
 268
 269         return ret;
 270 }
 271
 272
 273 /**
 274  * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
 275  * @pdev: USB Host Controller being removed
 276  *
 277  * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
 278  * the HCD's stop() method.  It is always called from a thread
 279  * context, normally "rmmod", "apmd", or something similar.
 280  */
 281 static int ehci_hcd_omap_remove(struct platform_device *pdev)
 282 {
 283         struct device *dev = &pdev->dev;
 284         struct usb_hcd *hcd = dev_get_drvdata(dev);
 285         struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
 286         int i;
 287
 288         usb_remove_hcd(hcd);
 289         disable_put_regulator(dev->platform_data);
 290
 291         for (i = 0; i < omap->nports; i++) {
 292                 if (omap->phy[i])
 293                         usb_phy_shutdown(omap->phy[i]);
 294         }
 295
 296         usb_put_hcd(hcd);
 297         pm_runtime_put_sync(dev);
 298         pm_runtime_disable(dev);
 299
 300         return 0;
 301 }
 302
 303 static void ehci_hcd_omap_shutdown(struct platform_device *pdev)
 304 {
 305         struct usb_hcd *hcd = dev_get_drvdata(&pdev->dev);
 306
 307         if (hcd->driver->shutdown)
 308                 hcd->driver->shutdown(hcd);
 309 }
 310
 311 static struct platform_driver ehci_hcd_omap_driver = {
 312         .probe                  = ehci_hcd_omap_probe,
 313         .remove                 = ehci_hcd_omap_remove,
 314         .shutdown               = ehci_hcd_omap_shutdown,
 315         /*.suspend              = ehci_hcd_omap_suspend, */
 316         /*.resume               = ehci_hcd_omap_resume, */
 317         .driver = {
 318                 .name           = hcd_name,
 319         }
 320 };
 321
 322 /*-------------------------------------------------------------------------*/
 323
 324 static int __init ehci_omap_init(void)
 325 {
 326         if (usb_disabled())
 327                 return -ENODEV;
 328
 329         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 330
 331         ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides);
 332         return platform_driver_register(&ehci_hcd_omap_driver);
 333 }
 334 module_init(ehci_omap_init);
 335
 336 static void __exit ehci_omap_cleanup(void)
 337 {
 338         platform_driver_unregister(&ehci_hcd_omap_driver);
 339 }
 340 module_exit(ehci_omap_cleanup);
 341
 342 MODULE_ALIAS("platform:ehci-omap");
 343 MODULE_AUTHOR("Texas Instruments, Inc.");
 344 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
 345
 346 MODULE_DESCRIPTION(DRIVER_DESC);
 347 MODULE_LICENSE("GPL");