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