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/platform_device.h>
  21 #include <linux/clk.h>
  22 #include <linux/delay.h>
  23 #include <linux/usb/otg.h>
  24 #include <linux/usb/ulpi.h>
  25 #include <linux/slab.h>
  26
  27 #include <mach/hardware.h>
  28 #include <mach/mxc_ehci.h>
  29
  30 #include <asm/mach-types.h>
  31
  32 #define ULPI_VIEWPORT_OFFSET    0x170
  33
  34 struct ehci_mxc_priv {
  35         struct clk *usbclk, *ahbclk, *phyclk;
  36         struct usb_hcd *hcd;
  37 };
  38
  39 /* called during probe() after chip reset completes */
  40 static int ehci_mxc_setup(struct usb_hcd *hcd)
  41 {
  42         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  43         int retval;
  44
  45         hcd->has_tt = 1;
  46
  47         retval = ehci_setup(hcd);
  48         if (retval)
  49                 return retval;
  50
  51         ehci_port_power(ehci, 0);
  52         return 0;
  53 }
  54
  55 static const struct hc_driver ehci_mxc_hc_driver = {
  56         .description = hcd_name,
  57         .product_desc = "Freescale On-Chip EHCI Host Controller",
  58         .hcd_priv_size = sizeof(struct ehci_hcd),
  59
  60         /*
  61          * generic hardware linkage
  62          */
  63         .irq = ehci_irq,
  64         .flags = HCD_USB2 | HCD_MEMORY,
  65
  66         /*
  67          * basic lifecycle operations
  68          */
  69         .reset = ehci_mxc_setup,
  70         .start = ehci_run,
  71         .stop = ehci_stop,
  72         .shutdown = ehci_shutdown,
  73
  74         /*
  75          * managing i/o requests and associated device resources
  76          */
  77         .urb_enqueue = ehci_urb_enqueue,
  78         .urb_dequeue = ehci_urb_dequeue,
  79         .endpoint_disable = ehci_endpoint_disable,
  80         .endpoint_reset = ehci_endpoint_reset,
  81
  82         /*
  83          * scheduling support
  84          */
  85         .get_frame_number = ehci_get_frame,
  86
  87         /*
  88          * root hub support
  89          */
  90         .hub_status_data = ehci_hub_status_data,
  91         .hub_control = ehci_hub_control,
  92         .bus_suspend = ehci_bus_suspend,
  93         .bus_resume = ehci_bus_resume,
  94         .relinquish_port = ehci_relinquish_port,
  95         .port_handed_over = ehci_port_handed_over,
  96
  97         .clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
  98 };
  99
 100 static int ehci_mxc_drv_probe(struct platform_device *pdev)
 101 {
 102         struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
 103         struct usb_hcd *hcd;
 104         struct resource *res;
 105         int irq, ret;
 106         unsigned int flags;
 107         struct ehci_mxc_priv *priv;
 108         struct device *dev = &pdev->dev;
 109         struct ehci_hcd *ehci;
 110
 111         dev_info(&pdev->dev, "initializing i.MX USB Controller\n");
 112
 113         if (!pdata) {
 114                 dev_err(dev, "No platform data given, bailing out.\n");
 115                 return -EINVAL;
 116         }
 117
 118         irq = platform_get_irq(pdev, 0);
 119
 120         hcd = usb_create_hcd(&ehci_mxc_hc_driver, dev, dev_name(dev));
 121         if (!hcd)
 122                 return -ENOMEM;
 123
 124         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 125         if (!priv) {
 126                 ret = -ENOMEM;
 127                 goto err_alloc;
 128         }
 129
 130         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 131         if (!res) {
 132                 dev_err(dev, "Found HC with no register addr. Check setup!\n");
 133                 ret = -ENODEV;
 134                 goto err_get_resource;
 135         }
 136
 137         hcd->rsrc_start = res->start;
 138         hcd->rsrc_len = resource_size(res);
 139
 140         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
 141                 dev_dbg(dev, "controller already in use\n");
 142                 ret = -EBUSY;
 143                 goto err_request_mem;
 144         }
 145
 146         hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
 147         if (!hcd->regs) {
 148                 dev_err(dev, "error mapping memory\n");
 149                 ret = -EFAULT;
 150                 goto err_ioremap;
 151         }
 152
 153         /* enable clocks */
 154         priv->usbclk = clk_get(dev, "ipg");
 155         if (IS_ERR(priv->usbclk)) {
 156                 ret = PTR_ERR(priv->usbclk);
 157                 goto err_clk;
 158         }
 159         clk_prepare_enable(priv->usbclk);
 160
 161         priv->ahbclk = clk_get(dev, "ahb");
 162         if (IS_ERR(priv->ahbclk)) {
 163                 ret = PTR_ERR(priv->ahbclk);
 164                 goto err_clk_ahb;
 165         }
 166         clk_prepare_enable(priv->ahbclk);
 167
 168         /* "dr" device has its own clock on i.MX51 */
 169         priv->phyclk = clk_get(dev, "phy");
 170         if (IS_ERR(priv->phyclk))
 171                 priv->phyclk = NULL;
 172         if (priv->phyclk)
 173                 clk_prepare_enable(priv->phyclk);
 174
 175
 176         /* call platform specific init function */
 177         if (pdata->init) {
 178                 ret = pdata->init(pdev);
 179                 if (ret) {
 180                         dev_err(dev, "platform init failed\n");
 181                         goto err_init;
 182                 }
 183                 /* platforms need some time to settle changed IO settings */
 184                 mdelay(10);
 185         }
 186
 187         ehci = hcd_to_ehci(hcd);
 188
 189         /* EHCI registers start at offset 0x100 */
 190         ehci->caps = hcd->regs + 0x100;
 191         ehci->regs = hcd->regs + 0x100 +
 192                 HC_LENGTH(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 193
 194         /* set up the PORTSCx register */
 195         ehci_writel(ehci, pdata->portsc, &ehci->regs->port_status[0]);
 196
 197         /* is this really needed? */
 198         msleep(10);
 199
 200         /* Initialize the transceiver */
 201         if (pdata->otg) {
 202                 pdata->otg->io_priv = hcd->regs + ULPI_VIEWPORT_OFFSET;
 203                 ret = usb_phy_init(pdata->otg);
 204                 if (ret) {
 205                         dev_err(dev, "unable to init transceiver, probably missing\n");
 206                         ret = -ENODEV;
 207                         goto err_add;
 208                 }
 209                 ret = otg_set_vbus(pdata->otg->otg, 1);
 210                 if (ret) {
 211                         dev_err(dev, "unable to enable vbus on transceiver\n");
 212                         goto err_add;
 213                 }
 214         }
 215
 216         priv->hcd = hcd;
 217         platform_set_drvdata(pdev, priv);
 218
 219         ret = usb_add_hcd(hcd, irq, IRQF_SHARED);
 220         if (ret)
 221                 goto err_add;
 222
 223         if (pdata->otg) {
 224                 /*
 225                  * efikamx and efikasb have some hardware bug which is
 226                  * preventing usb to work unless CHRGVBUS is set.
 227                  * It's in violation of USB specs
 228                  */
 229                 if (machine_is_mx51_efikamx() || machine_is_mx51_efikasb()) {
 230                         flags = usb_phy_io_read(pdata->otg,
 231                                                         ULPI_OTG_CTRL);
 232                         flags |= ULPI_OTG_CTRL_CHRGVBUS;
 233                         ret = usb_phy_io_write(pdata->otg, flags,
 234                                                         ULPI_OTG_CTRL);
 235                         if (ret) {
 236                                 dev_err(dev, "unable to set CHRVBUS\n");
 237                                 goto err_add;
 238                         }
 239                 }
 240         }
 241
 242         return 0;
 243
 244 err_add:
 245         if (pdata && pdata->exit)
 246                 pdata->exit(pdev);
 247 err_init:
 248         if (priv->phyclk) {
 249                 clk_disable_unprepare(priv->phyclk);
 250                 clk_put(priv->phyclk);
 251         }
 252
 253         clk_disable_unprepare(priv->ahbclk);
 254         clk_put(priv->ahbclk);
 255 err_clk_ahb:
 256         clk_disable_unprepare(priv->usbclk);
 257         clk_put(priv->usbclk);
 258 err_clk:
 259         iounmap(hcd->regs);
 260 err_ioremap:
 261         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 262 err_request_mem:
 263 err_get_resource:
 264         kfree(priv);
 265 err_alloc:
 266         usb_put_hcd(hcd);
 267         return ret;
 268 }
 269
 270 static int __exit ehci_mxc_drv_remove(struct platform_device *pdev)
 271 {
 272         struct mxc_usbh_platform_data *pdata = pdev->dev.platform_data;
 273         struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
 274         struct usb_hcd *hcd = priv->hcd;
 275
 276         if (pdata && pdata->exit)
 277                 pdata->exit(pdev);
 278
 279         if (pdata->otg)
 280                 usb_phy_shutdown(pdata->otg);
 281
 282         usb_remove_hcd(hcd);
 283         iounmap(hcd->regs);
 284         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 285         usb_put_hcd(hcd);
 286         platform_set_drvdata(pdev, NULL);
 287
 288         clk_disable_unprepare(priv->usbclk);
 289         clk_put(priv->usbclk);
 290         clk_disable_unprepare(priv->ahbclk);
 291         clk_put(priv->ahbclk);
 292
 293         if (priv->phyclk) {
 294                 clk_disable_unprepare(priv->phyclk);
 295                 clk_put(priv->phyclk);
 296         }
 297
 298         kfree(priv);
 299
 300         return 0;
 301 }
 302
 303 static void ehci_mxc_drv_shutdown(struct platform_device *pdev)
 304 {
 305         struct ehci_mxc_priv *priv = platform_get_drvdata(pdev);
 306         struct usb_hcd *hcd = priv->hcd;
 307
 308         if (hcd->driver->shutdown)
 309                 hcd->driver->shutdown(hcd);
 310 }
 311
 312 MODULE_ALIAS("platform:mxc-ehci");
 313
 314 static struct platform_driver ehci_mxc_driver = {
 315         .probe = ehci_mxc_drv_probe,
 316         .remove = __exit_p(ehci_mxc_drv_remove),
 317         .shutdown = ehci_mxc_drv_shutdown,
 318         .driver = {
 319                    .name = "mxc-ehci",
 320         },
 321 };