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