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/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 struct omap_hcd {
  74         struct usb_phy *phy[OMAP3_HS_USB_PORTS]; /* one PHY for each port */
  75         int nports;
  76 };
  77
  78 static inline void ehci_write(void __iomem *base, u32 reg, u32 val)
  79 {
  80         __raw_writel(val, base + reg);
  81 }
  82
  83 static inline u32 ehci_read(void __iomem *base, u32 reg)
  84 {
  85         return __raw_readl(base + reg);
  86 }
  87
  88 static int omap_ehci_init(struct usb_hcd *hcd)
  89 {
  90         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  91         struct omap_hcd *omap = (struct omap_hcd *)ehci->priv;
  92         int rc, i;
  93
  94         /* Hold PHYs in reset while initializing EHCI controller */
  95         for (i = 0; i < omap->nports; i++) {
  96                 if (omap->phy[i])
  97                         usb_phy_shutdown(omap->phy[i]);
  98         }
  99
 100         /* we know this is the memory we want, no need to ioremap again */
 101         ehci->caps = hcd->regs;
 102
 103         rc = ehci_setup(hcd);
 104
 105         /* Bring PHYs out of reset */
 106         for (i = 0; i < omap->nports; i++) {
 107                 if (omap->phy[i])
 108                         usb_phy_init(omap->phy[i]);
 109         }
 110
 111         return rc;
 112 }
 113
 114 /* configure so an HC device and id are always provided */
 115 /* always called with process context; sleeping is OK */
 116
 117 static struct hc_driver __read_mostly ehci_omap_hc_driver;
 118
 119 static const struct ehci_driver_overrides ehci_omap_overrides __initdata = {
 120         .reset = omap_ehci_init,
 121         .extra_priv_size = sizeof(struct omap_hcd),
 122 };
 123
 124 /**
 125  * ehci_hcd_omap_probe - initialize TI-based HCDs
 126  *
 127  * Allocates basic resources for this USB host controller, and
 128  * then invokes the start() method for the HCD associated with it
 129  * through the hotplug entry's driver_data.
 130  */
 131 static int ehci_hcd_omap_probe(struct platform_device *pdev)
 132 {
 133         struct device *dev = &pdev->dev;
 134         struct usbhs_omap_platform_data *pdata = dev->platform_data;
 135         struct resource *res;
 136         struct usb_hcd  *hcd;
 137         void __iomem *regs;
 138         int ret = -ENODEV;
 139         int irq;
 140         int i;
 141         struct omap_hcd *omap;
 142
 143         if (usb_disabled())
 144                 return -ENODEV;
 145
 146         if (!dev->parent) {
 147                 dev_err(dev, "Missing parent device\n");
 148                 return -ENODEV;
 149         }
 150
 151         irq = platform_get_irq_byname(pdev, "ehci-irq");
 152         if (irq < 0) {
 153                 dev_err(dev, "EHCI irq failed\n");
 154                 return -ENODEV;
 155         }
 156
 157         res =  platform_get_resource_byname(pdev,
 158                                 IORESOURCE_MEM, "ehci");
 159         regs = devm_ioremap_resource(dev, res);
 160         if (IS_ERR(regs))
 161                 return PTR_ERR(regs);
 162
 163         hcd = usb_create_hcd(&ehci_omap_hc_driver, dev,
 164                         dev_name(dev));
 165         if (!hcd) {
 166                 dev_err(dev, "Failed to create HCD\n");
 167                 return -ENOMEM;
 168         }
 169
 170         hcd->rsrc_start = res->start;
 171         hcd->rsrc_len = resource_size(res);
 172         hcd->regs = regs;
 173
 174         omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
 175         omap->nports = pdata->nports;
 176
 177         platform_set_drvdata(pdev, hcd);
 178
 179         /* get the PHY devices if needed */
 180         for (i = 0 ; i < omap->nports ; i++) {
 181                 struct usb_phy *phy;
 182
 183                 if (pdata->port_mode[i] != OMAP_EHCI_PORT_MODE_PHY)
 184                         continue;
 185
 186                 /* get the PHY device */
 187                 phy = devm_usb_get_phy_dev(dev, i);
 188                 if (IS_ERR(phy) || !phy) {
 189                         ret = IS_ERR(phy) ? PTR_ERR(phy) : -ENODEV;
 190                         dev_err(dev, "Can't get PHY device for port %d: %d\n",
 191                                         i, ret);
 192                         goto err_phy;
 193                 }
 194
 195                 omap->phy[i] = phy;
 196                 usb_phy_init(omap->phy[i]);
 197                 /* bring PHY out of suspend */
 198                 usb_phy_set_suspend(omap->phy[i], 0);
 199         }
 200
 201         pm_runtime_enable(dev);
 202         pm_runtime_get_sync(dev);
 203
 204         /*
 205          * An undocumented "feature" in the OMAP3 EHCI controller,
 206          * causes suspended ports to be taken out of suspend when
 207          * the USBCMD.Run/Stop bit is cleared (for example when
 208          * we do ehci_bus_suspend).
 209          * This breaks suspend-resume if the root-hub is allowed
 210          * to suspend. Writing 1 to this undocumented register bit
 211          * disables this feature and restores normal behavior.
 212          */
 213         ehci_write(regs, EHCI_INSNREG04,
 214                                 EHCI_INSNREG04_DISABLE_UNSUSPEND);
 215
 216         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 217         if (ret) {
 218                 dev_err(dev, "failed to add hcd with err %d\n", ret);
 219                 goto err_pm_runtime;
 220         }
 221
 222
 223         return 0;
 224
 225 err_pm_runtime:
 226         pm_runtime_put_sync(dev);
 227
 228 err_phy:
 229         for (i = 0; i < omap->nports; i++) {
 230                 if (omap->phy[i])
 231                         usb_phy_shutdown(omap->phy[i]);
 232         }
 233
 234         usb_put_hcd(hcd);
 235
 236         return ret;
 237 }
 238
 239
 240 /**
 241  * ehci_hcd_omap_remove - shutdown processing for EHCI HCDs
 242  * @pdev: USB Host Controller being removed
 243  *
 244  * Reverses the effect of usb_ehci_hcd_omap_probe(), first invoking
 245  * the HCD's stop() method.  It is always called from a thread
 246  * context, normally "rmmod", "apmd", or something similar.
 247  */
 248 static int ehci_hcd_omap_remove(struct platform_device *pdev)
 249 {
 250         struct device *dev = &pdev->dev;
 251         struct usb_hcd *hcd = dev_get_drvdata(dev);
 252         struct omap_hcd *omap = (struct omap_hcd *)hcd_to_ehci(hcd)->priv;
 253         int i;
 254
 255         usb_remove_hcd(hcd);
 256
 257         for (i = 0; i < omap->nports; i++) {
 258                 if (omap->phy[i])
 259                         usb_phy_shutdown(omap->phy[i]);
 260         }
 261
 262         usb_put_hcd(hcd);
 263         pm_runtime_put_sync(dev);
 264         pm_runtime_disable(dev);
 265
 266         return 0;
 267 }
 268
 269 static void ehci_hcd_omap_shutdown(struct platform_device *pdev)
 270 {
 271         struct usb_hcd *hcd = dev_get_drvdata(&pdev->dev);
 272
 273         if (hcd->driver->shutdown)
 274                 hcd->driver->shutdown(hcd);
 275 }
 276
 277 static struct platform_driver ehci_hcd_omap_driver = {
 278         .probe                  = ehci_hcd_omap_probe,
 279         .remove                 = ehci_hcd_omap_remove,
 280         .shutdown               = ehci_hcd_omap_shutdown,
 281         /*.suspend              = ehci_hcd_omap_suspend, */
 282         /*.resume               = ehci_hcd_omap_resume, */
 283         .driver = {
 284                 .name           = hcd_name,
 285         }
 286 };
 287
 288 /*-------------------------------------------------------------------------*/
 289
 290 static int __init ehci_omap_init(void)
 291 {
 292         if (usb_disabled())
 293                 return -ENODEV;
 294
 295         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 296
 297         ehci_init_driver(&ehci_omap_hc_driver, &ehci_omap_overrides);
 298         return platform_driver_register(&ehci_hcd_omap_driver);
 299 }
 300 module_init(ehci_omap_init);
 301
 302 static void __exit ehci_omap_cleanup(void)
 303 {
 304         platform_driver_unregister(&ehci_hcd_omap_driver);
 305 }
 306 module_exit(ehci_omap_cleanup);
 307
 308 MODULE_ALIAS("platform:ehci-omap");
 309 MODULE_AUTHOR("Texas Instruments, Inc.");
 310 MODULE_AUTHOR("Felipe Balbi <felipe.balbi@nokia.com>");
 311
 312 MODULE_DESCRIPTION(DRIVER_DESC);
 313 MODULE_LICENSE("GPL");