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         unsigned int flags;
  61         struct ehci_mxc_priv *priv;
  62         struct device *dev = &pdev->dev;
  63         struct ehci_hcd *ehci;
  64
  65         dev_info(&pdev->dev, "initializing i.MX USB Controller\n");
  66
  67         if (!pdata) {
  68                 dev_err(dev, "No platform data given, bailing out.\n");
  69                 return -EINVAL;
  70         }
  71
  72         irq = platform_get_irq(pdev, 0);
  73
  74         hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
  75         if (!hcd)
  76                 return -ENOMEM;
  77
  78         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  79         if (!res) {
  80                 dev_err(dev, "Found HC with no register addr. Check setup!\n");
  81                 ret = -ENODEV;
  82                 goto err_alloc;
  83         }
  84
  85         hcd->rsrc_start = res->start;
  86         hcd->rsrc_len = resource_size(res);
  87
  88         hcd->regs = devm_request_and_ioremap(&pdev->dev, res);
  89         if (!hcd->regs) {
  90                 dev_err(dev, "error mapping memory\n");
  91                 ret = -EFAULT;
  92                 goto err_alloc;
  93         }
  94
  95         hcd->has_tt = 1;
  96         ehci = hcd_to_ehci(hcd);
  97         priv = (struct ehci_mxc_priv *) ehci->priv;
  98
  99         /* enable clocks */
 100         priv->usbclk = devm_clk_get(&pdev->dev, "ipg");
 101         if (IS_ERR(priv->usbclk)) {
 102                 ret = PTR_ERR(priv->usbclk);
 103                 goto err_alloc;
 104         }
 105         clk_prepare_enable(priv->usbclk);
 106
 107         priv->ahbclk = devm_clk_get(&pdev->dev, "ahb");
 108         if (IS_ERR(priv->ahbclk)) {
 109                 ret = PTR_ERR(priv->ahbclk);
 110                 goto err_clk_ahb;
 111         }
 112         clk_prepare_enable(priv->ahbclk);
 113
 114         /* "dr" device has its own clock on i.MX51 */
 115         priv->phyclk = devm_clk_get(&pdev->dev, "phy");
 116         if (IS_ERR(priv->phyclk))
 117                 priv->phyclk = NULL;
 118         if (priv->phyclk)
 119                 clk_prepare_enable(priv->phyclk);
 120
 121
 122         /* call platform specific init function */
 123         if (pdata->init) {
 124                 ret = pdata->init(pdev);
 125                 if (ret) {
 126                         dev_err(dev, "platform init failed\n");
 127                         goto err_init;
 128                 }
 129                 /* platforms need some time to settle changed IO settings */
 130                 mdelay(10);
 131         }
 132
 133         /* EHCI registers start at offset 0x100 */
 134         ehci->caps = hcd->regs + 0x100;
 135         ehci->regs = hcd->regs + 0x100 +
 136                 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 137
 138         /* set up the PORTSCx register */
 139         ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);
 140
 141         /* is this really needed? */
 142         msleep(10);
 143
 144         /* Initialize the transceiver */
 145         if (pdata->otg) {
 146                 pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
 147                 ret = usb_phy_init(pdata->otg);
 148                 if (ret) {
 149                         dev_err(dev, "unable to init transceiver, probably missing\n");
 150                         ret = -ENODEV;
 151                         goto err_add;
 152                 }
 153                 ret = otg_set_vbus(pdata->otg->otg, 1);
 154                 if (ret) {
 155                         dev_err(dev, "unable to enable vbus on transceiver\n");
 156                         goto err_add;
 157                 }
 158         }
 159
 160         platform_set_drvdata(pdev, hcd);
 161
 162         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 163         if (ret)
 164                 goto err_add;
 165
 166         if (pdata->otg) {
 167                 /*
 168                  * efikamx and efikasb have some hardware bug which is
 169                  * preventing usb to work unless CHRGVBUS is set.
 170                  * It's in violation of USB specs
 171                  */
 172                 if (machine_is_mx51_efikamx() || machine_is_mx51_efikasb()) {
 173                         flags = usb_phy_io_read(pdata->otg,
 174                                                         ULPI_OTG_CTRL);
 175                         flags |= ULPI_OTG_CTRL_CHRGVBUS;
 176                         ret = usb_phy_io_write(pdata->otg, flags,
 177                                                         ULPI_OTG_CTRL);
 178                         if (ret) {
 179                                 dev_err(dev, "unable to set CHRVBUS\n");
 180                                 goto err_add;
 181                         }
 182                 }
 183         }
 184
 185         return 0;
 186
 187 err_add:
 188         if (pdata && pdata->exit)
 189                 pdata->exit(pdev);
 190 err_init:
 191         if (priv->phyclk)
 192                 clk_disable_unprepare(priv->phyclk);
 193
 194         clk_disable_unprepare(priv->ahbclk);
 195 err_clk_ahb:
 196         clk_disable_unprepare(priv->usbclk);
 197 err_alloc:
 198         usb_put_hcd(hcd);
 199         return ret;
 200 }
 201
 202 static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
 203 {
 204         struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
 205         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 206         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
 207         struct ehci_mxc_priv *priv = (struct ehci_mxc_priv *) ehci->priv;
 208
 209         usb_remove_hcd(hcd);
 210
 211         if (pdata && pdata->exit)
 212                 pdata->exit(pdev);
 213
 214         if (pdata->otg)
 215                 usb_phy_shutdown(pdata->otg);
 216
 217         clk_disable_unprepare(priv->usbclk);
 218         clk_disable_unprepare(priv->ahbclk);
 219
 220         if (priv->phyclk)
 221                 clk_disable_unprepare(priv->phyclk);
 222
 223         usb_put_hcd(hcd);
 224         platform_set_drvdata(pdev, NULL);
 225         return 0;
 226 }
 227
 228 static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
 229 {
 230         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 231
 232         if (hcd->driver->shutdown)
 233                 hcd->driver->shutdown(hcd);
 234 }
 235
 236 MODULE_ALIAS("platform:mxc-ehci");
 237
 238 static struct platform_driver ehci_mxc_driver = {
 239         .probe = ehci_mxc_drv_probe,
 240         .remove = ehci_mxc_drv_remove,
 241         .shutdown = ehci_mxc_drv_shutdown,
 242         .driver = {
 243                    .name = "mxc-ehci",
 244         },
 245 };
 246
 247 static int __init ehci_mxc_init(void)
 248 {
 249         if (usb_disabled())
 250                 return -ENODEV;
 251
 252         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 253
 254         ehci_init_driver(&ehci_mxc_hc_driver, &ehci_mxc_overrides);
 255         return platform_driver_register(&ehci_mxc_driver);
 256 }
 257 module_init(ehci_mxc_init);
 258
 259 static void __exit ehci_mxc_cleanup(void)
 260 {
 261         platform_driver_unregister(&ehci_mxc_driver);
 262 }
 263 module_exit(ehci_mxc_cleanup);
 264
 265 MODULE_DESCRIPTION(DRIVER_DESC);
 266 MODULE_AUTHOR("Sascha Hauer");
 267 MODULE_LICENSE("GPL");