drivers/usb/host/ohci-omap3.c

   1 /*
   2  * ohci-omap3.c - driver for OHCI on OMAP3 and later processors
   3  *
   4  * Bus Glue for OMAP3 USBHOST 3 port OHCI controller
   5  * This controller is also used in later OMAPs and AM35x chips
   6  *
   7  * Copyright (C) 2007-2010 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  *
  12  * Based on ehci-omap.c and some other ohci glue layers
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  27  *
  28  * TODO (last updated Feb 27, 2011):
  29  *      - add kernel-doc
  30  */
  31
  32 #include <linux/dma-mapping.h>
  33 #include <linux/kernel.h>
  34 #include <linux/module.h>
  35 #include <linux/of.h>
  36 #include <linux/usb/otg.h>
  37 #include <linux/platform_device.h>
  38 #include <linux/pm_runtime.h>
  39 #include <linux/usb.h>
  40 #include <linux/usb/hcd.h>
  41
  42 #include "ohci.h"
  43
  44 #define DRIVER_DESC "OHCI OMAP3 driver"
  45
  46 static const char hcd_name[] = "ohci-omap3";
  47 static struct hc_driver __read_mostly ohci_omap3_hc_driver;
  48
  49 /*
  50  * configure so an HC device and id are always provided
  51  * always called with process context; sleeping is OK
  52  */
  53
  54 /**
  55  * ohci_hcd_omap3_probe - initialize OMAP-based HCDs
  56  *
  57  * Allocates basic resources for this USB host controller, and
  58  * then invokes the start() method for the HCD associated with it
  59  * through the hotplug entry's driver_data.
  60  */
  61 static int ohci_hcd_omap3_probe(struct platform_device *pdev)
  62 {
  63         struct device           *dev = &pdev->dev;
  64         struct ohci_hcd         *ohci;
  65         struct usb_hcd          *hcd = NULL;
  66         void __iomem            *regs = NULL;
  67         struct resource         *res;
  68         int                     ret;
  69         int                     irq;
  70
  71         if (usb_disabled())
  72                 return -ENODEV;
  73
  74         if (!dev->parent) {
  75                 dev_err(dev, "Missing parent device\n");
  76                 return -ENODEV;
  77         }
  78
  79         irq = platform_get_irq(pdev, 0);
  80         if (irq < 0) {
  81                 dev_err(dev, "OHCI irq failed\n");
  82                 return -ENODEV;
  83         }
  84
  85         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  86         if (!res) {
  87                 dev_err(dev, "UHH OHCI get resource failed\n");
  88                 return -ENOMEM;
  89         }
  90
  91         regs = ioremap(res->start, resource_size(res));
  92         if (!regs) {
  93                 dev_err(dev, "UHH OHCI ioremap failed\n");
  94                 return -ENOMEM;
  95         }
  96
  97         /*
  98          * Right now device-tree probed devices don't get dma_mask set.
  99          * Since shared usb code relies on it, set it here for now.
 100          * Once we have dma capability bindings this can go away.
 101          */
 102         ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32));
 103         if (ret)
 104                 goto err_io;
 105
 106         ret = -ENODEV;
 107         hcd = usb_create_hcd(&ohci_omap3_hc_driver, dev,
 108                         dev_name(dev));
 109         if (!hcd) {
 110                 dev_err(dev, "usb_create_hcd failed\n");
 111                 goto err_io;
 112         }
 113
 114         hcd->rsrc_start = res->start;
 115         hcd->rsrc_len = resource_size(res);
 116         hcd->regs =  regs;
 117
 118         pm_runtime_enable(dev);
 119         pm_runtime_get_sync(dev);
 120
 121         ohci = hcd_to_ohci(hcd);
 122         /*
 123          * RemoteWakeupConnected has to be set explicitly before
 124          * calling ohci_run. The reset value of RWC is 0.
 125          */
 126         ohci->hc_control = OHCI_CTRL_RWC;
 127
 128         ret = usb_add_hcd(hcd, irq, 0);
 129         if (ret) {
 130                 dev_dbg(dev, "failed to add hcd with err %d\n", ret);
 131                 goto err_add_hcd;
 132         }
 133
 134         return 0;
 135
 136 err_add_hcd:
 137         pm_runtime_put_sync(dev);
 138         usb_put_hcd(hcd);
 139
 140 err_io:
 141         iounmap(regs);
 142
 143         return ret;
 144 }
 145
 146 /*
 147  * may be called without controller electrically present
 148  * may be called with controller, bus, and devices active
 149  */
 150
 151 /**
 152  * ohci_hcd_omap3_remove - shutdown processing for OHCI HCDs
 153  * @pdev: USB Host Controller being removed
 154  *
 155  * Reverses the effect of ohci_hcd_omap3_probe(), first invoking
 156  * the HCD's stop() method.  It is always called from a thread
 157  * context, normally "rmmod", "apmd", or something similar.
 158  */
 159 static int ohci_hcd_omap3_remove(struct platform_device *pdev)
 160 {
 161         struct device *dev      = &pdev->dev;
 162         struct usb_hcd *hcd     = dev_get_drvdata(dev);
 163
 164         iounmap(hcd->regs);
 165         usb_remove_hcd(hcd);
 166         pm_runtime_put_sync(dev);
 167         pm_runtime_disable(dev);
 168         usb_put_hcd(hcd);
 169         return 0;
 170 }
 171
 172 static const struct of_device_id omap_ohci_dt_ids[] = {
 173         { .compatible = "ti,ohci-omap3" },
 174         { }
 175 };
 176
 177 MODULE_DEVICE_TABLE(of, omap_ohci_dt_ids);
 178
 179 static struct platform_driver ohci_hcd_omap3_driver = {
 180         .probe          = ohci_hcd_omap3_probe,
 181         .remove         = ohci_hcd_omap3_remove,
 182         .shutdown       = usb_hcd_platform_shutdown,
 183         .driver         = {
 184                 .name   = "ohci-omap3",
 185                 .of_match_table = omap_ohci_dt_ids,
 186         },
 187 };
 188
 189 static int __init ohci_omap3_init(void)
 190 {
 191         if (usb_disabled())
 192                 return -ENODEV;
 193
 194         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 195
 196         ohci_init_driver(&ohci_omap3_hc_driver, NULL);
 197         return platform_driver_register(&ohci_hcd_omap3_driver);
 198 }
 199 module_init(ohci_omap3_init);
 200
 201 static void __exit ohci_omap3_cleanup(void)
 202 {
 203         platform_driver_unregister(&ohci_hcd_omap3_driver);
 204 }
 205 module_exit(ohci_omap3_cleanup);
 206
 207 MODULE_DESCRIPTION(DRIVER_DESC);
 208 MODULE_ALIAS("platform:ohci-omap3");
 209 MODULE_AUTHOR("Anand Gadiyar <gadiyar@ti.com>");
 210 MODULE_LICENSE("GPL");