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