drivers/usb/host/ehci-mxc.c

   1 /*
   2  * Copyright (c) 2008 Sascha Hauer <s.hauer@pengutronix.de>, Pengutronix
   3  * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software Foundation,
  17  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 #include <linux/kernel.h>
  21 #include <linux/module.h>
  22 #include <linux/io.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/clk.h>
  25 #include <linux/delay.h>
  26 #include <linux/usb/otg.h>
  27 #include <linux/usb/ulpi.h>
  28 #include <linux/slab.h>
  29 #include <linux/usb.h>
  30 #include <linux/usb/hcd.h>
  31
  32 #include <linux/platform_data/usb-ehci-mxc.h>
  33
  34 #include <asm/mach-types.h>
  35
  36 #include "ehci.h"
  37
  38 #define DRIVER_DESC "Freescale On-Chip EHCI Host driver"
  39
  40 static const char hcd_name[] = "ehci-mxc";
  41
  42 #define ULPI_VIEWPORT_OFFSET    0x170
  43
  44 struct ehci_mxc_priv {
  45         struct clk *usbclk, *ahbclk, *phyclk;
  46 };
  47
  48 static struct hc_driver __read_mostly ehci_mxc_hc_driver;
  49
  50 static const struct ehci_driver_overrides ehci_mxc_overrides __initdata = {
  51         .extra_priv_size =      sizeof(struct ehci_mxc_priv),
  52 };
  53
  54 static int ehci_mxc_drv_probe(struct platform_device *pdev)
  55 {
  56         struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
  57         struct usb_hcd *hcd;
  58         struct resource *res;
  59         int irq, ret;
  60         struct ehci_mxc_priv *priv;
  61         struct device *dev = &pdev->dev;
  62         struct ehci_hcd *ehci;
  63
  64         dev_info(&pdev->dev, "initializing i.MX USB Controller\n");
  65
  66         if (!pdata) {
  67                 dev_err(dev, "No platform data given, bailing out.\n");
  68                 return -EINVAL;
  69         }
  70
  71         irq = platform_get_irq(pdev, 0);
  72
  73         hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
  74         if (!hcd)
  75                 return -ENOMEM;
  76
  77         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  78         if (!res) {
  79                 dev_err(dev, "Found HC with no register addr. Check setup!\n");
  80                 ret = -ENODEV;
  81                 goto err_alloc;
  82         }
  83
  84         hcd->rsrc_start = res->start;
  85         hcd->rsrc_len = resource_size(res);
  86
  87         hcd->regs = devm_ioremap_resource(&pdev->dev, res);
  88         if (IS_ERR(hcd->regs)) {
  89                 ret = PTR_ERR(hcd->regs);
  90                 goto err_alloc;
  91         }
  92
  93         hcd->has_tt = 1;
  94         ehci = hcd_to_ehci(hcd);
  95         priv = (struct ehci_mxc_priv *) ehci->priv;
  96
  97         /* enable clocks */
  98         priv->usbclk = devm_clk_get(&pdev->dev, "ipg");
  99         if (IS_ERR(priv->usbclk)) {
 100                 ret = PTR_ERR(priv->usbclk);
 101                 goto err_alloc;
 102         }
 103         clk_prepare_enable(priv->usbclk);
 104
 105         priv->ahbclk = devm_clk_get(&pdev->dev, "ahb");
 106         if (IS_ERR(priv->ahbclk)) {
 107                 ret = PTR_ERR(priv->ahbclk);
 108                 goto err_clk_ahb;
 109         }
 110         clk_prepare_enable(priv->ahbclk);
 111
 112         /* "dr" device has its own clock on i.MX51 */
 113         priv->phyclk = devm_clk_get(&pdev->dev, "phy");
 114         if (IS_ERR(priv->phyclk))
 115                 priv->phyclk = NULL;
 116         if (priv->phyclk)
 117                 clk_prepare_enable(priv->phyclk);
 118
 119
 120         /* call platform specific init function */
 121         if (pdata->init) {
 122                 ret = pdata->init(pdev);
 123                 if (ret) {
 124                         dev_err(dev, "platform init failed\n");
 125                         goto err_init;
 126                 }
 127                 /* platforms need some time to settle changed IO settings */
 128                 mdelay(10);
 129         }
 130
 131         /* EHCI registers start at offset 0x100 */
 132         ehci->caps = hcd->regs + 0x100;
 133         ehci->regs = hcd->regs + 0x100 +
 134                 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 135
 136         /* set up the PORTSCx register */
 137         ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);
 138
 139         /* is this really needed? */
 140         msleep(10);
 141
 142         /* Initialize the transceiver */
 143         if (pdata->otg) {
 144                 pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
 145                 ret = usb_phy_init(pdata->otg);
 146                 if (ret) {
 147                         dev_err(dev, "unable to init transceiver, probably missing\n");
 148                         ret = -ENODEV;
 149                         goto err_add;
 150                 }
 151                 ret = otg_set_vbus(pdata->otg->otg, 1);
 152                 if (ret) {
 153                         dev_err(dev, "unable to enable vbus on transceiver\n");
 154                         goto err_add;
 155                 }
 156         }
 157
 158         platform_set_drvdata(pdev, hcd);
 159
 160         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 161         if (ret)
 162                 goto err_add;
 163
 164         return 0;
 165
 166 err_add:
 167         if (pdata && pdata->exit)
 168                 pdata->exit(pdev);
 169 err_init:
 170         if (priv->phyclk)
 171                 clk_disable_unprepare(priv->phyclk);
 172
 173         clk_disable_unprepare(priv->ahbclk);
 174 err_clk_ahb:
 175         clk_disable_unprepare(priv->usbclk);
 176 err_alloc:
 177         usb_put_hcd(hcd);
 178         return ret;
 179 }
 180
 181 static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
 182 {
 183         struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
 184         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 185         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 186         struct ehci_mxc_priv *priv = (struct ehci_mxc_priv *) ehci->priv;
 187
 188         usb_remove_hcd(hcd);
 189
 190         if (pdata && pdata->exit)
 191                 pdata->exit(pdev);
 192
 193         if (pdata->otg)
 194                 usb_phy_shutdown(pdata->otg);
 195
 196         clk_disable_unprepare(priv->usbclk);
 197         clk_disable_unprepare(priv->ahbclk);
 198
 199         if (priv->phyclk)
 200                 clk_disable_unprepare(priv->phyclk);
 201
 202         usb_put_hcd(hcd);
 203         platform_set_drvdata(pdev, NULL);
 204         return 0;
 205 }
 206
 207 static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
 208 {
 209         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 210
 211         if (hcd->driver->shutdown)
 212                 hcd->driver->shutdown(hcd);
 213 }
 214
 215 MODULE_ALIAS("platform:mxc-ehci");
 216
 217 static struct platform_driver ehci_mxc_driver = {
 218         .probe = ehci_mxc_drv_probe,
 219         .remove = ehci_mxc_drv_remove,
 220         .shutdown = ehci_mxc_drv_shutdown,
 221         .driver = {
 222                    .name = "mxc-ehci",
 223         },
 224 };
 225
 226 static int __init ehci_mxc_init(void)
 227 {
 228         if (usb_disabled())
 229                 return -ENODEV;
 230
 231         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 232
 233         ehci_init_driver(&ehci_mxc_hc_driver, &ehci_mxc_overrides);
 234         return platform_driver_register(&ehci_mxc_driver);
 235 }
 236 module_init(ehci_mxc_init);
 237
 238 static void __exit ehci_mxc_cleanup(void)
 239 {
 240         platform_driver_unregister(&ehci_mxc_driver);
 241 }
 242 module_exit(ehci_mxc_cleanup);
 243
 244 MODULE_DESCRIPTION(DRIVER_DESC);
 245 MODULE_AUTHOR("Sascha Hauer");
 246 MODULE_LICENSE("GPL");