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