drivers/usb/musb/omap2430.c

   1 /*
   2  * Copyright (C) 2005-2007 by Texas Instruments
   3  * Some code has been taken from tusb6010.c
   4  * Copyrights for that are attributable to:
   5  * Copyright (C) 2006 Nokia Corporation
   6  * Tony Lindgren <tony@atomide.com>
   7  *
   8  * This file is part of the Inventra Controller Driver for Linux.
   9  *
  10  * The Inventra Controller Driver for Linux is free software; you
  11  * can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License version 2 as published by the Free Software
  13  * Foundation.
  14  *
  15  * The Inventra Controller Driver for Linux is distributed in
  16  * the hope that it will be useful, but WITHOUT ANY WARRANTY;
  17  * without even the implied warranty of MERCHANTABILITY or
  18  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  19  * License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with The Inventra Controller Driver for Linux ; if not,
  23  * write to the Free Software Foundation, Inc., 59 Temple Place,
  24  * Suite 330, Boston, MA  02111-1307  USA
  25  *
  26  */
  27 #include <linux/module.h>
  28 #include <linux/kernel.h>
  29 #include <linux/sched.h>
  30 #include <linux/init.h>
  31 #include <linux/list.h>
  32 #include <linux/clk.h>
  33 #include <linux/io.h>
  34 #include <linux/platform_device.h>
  35 #include <linux/dma-mapping.h>
  36 #include <linux/pm_runtime.h>
  37 #include <linux/err.h>
  38 #include <linux/delay.h>
  39
  40 #include "musb_core.h"
  41 #include "omap2430.h"
  42
  43 struct omap2430_glue {
  44         struct device           *dev;
  45         struct platform_device  *musb;
  46 };
  47 #define glue_to_musb(g)         platform_get_drvdata(g->musb)
  48
  49 static struct timer_list musb_idle_timer;
  50
  51 static void musb_do_idle(unsigned long _musb)
  52 {
  53         struct musb     *musb = (void *)_musb;
  54         unsigned long   flags;
  55         u8      power;
  56         u8      devctl;
  57
  58         spin_lock_irqsave(&musb->lock, flags);
  59
  60         switch (musb->xceiv->state) {
  61         case OTG_STATE_A_WAIT_BCON:
  62
  63                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  64                 if (devctl & MUSB_DEVCTL_BDEVICE) {
  65                         musb->xceiv->state = OTG_STATE_B_IDLE;
  66                         MUSB_DEV_MODE(musb);
  67                 } else {
  68                         musb->xceiv->state = OTG_STATE_A_IDLE;
  69                         MUSB_HST_MODE(musb);
  70                 }
  71                 break;
  72         case OTG_STATE_A_SUSPEND:
  73                 /* finish RESUME signaling? */
  74                 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
  75                         power = musb_readb(musb->mregs, MUSB_POWER);
  76                         power &= ~MUSB_POWER_RESUME;
  77                         dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
  78                         musb_writeb(musb->mregs, MUSB_POWER, power);
  79                         musb->is_active = 1;
  80                         musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
  81                                                 | MUSB_PORT_STAT_RESUME);
  82                         musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
  83                         usb_hcd_poll_rh_status(musb_to_hcd(musb));
  84                         /* NOTE: it might really be A_WAIT_BCON ... */
  85                         musb->xceiv->state = OTG_STATE_A_HOST;
  86                 }
  87                 break;
  88         case OTG_STATE_A_HOST:
  89                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  90                 if (devctl &  MUSB_DEVCTL_BDEVICE)
  91                         musb->xceiv->state = OTG_STATE_B_IDLE;
  92                 else
  93                         musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
  94         default:
  95                 break;
  96         }
  97         spin_unlock_irqrestore(&musb->lock, flags);
  98 }
  99
 100
 101 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
 102 {
 103         unsigned long           default_timeout = jiffies + msecs_to_jiffies(3);
 104         static unsigned long    last_timer;
 105
 106         if (timeout == 0)
 107                 timeout = default_timeout;
 108
 109         /* Never idle if active, or when VBUS timeout is not set as host */
 110         if (musb->is_active || ((musb->a_wait_bcon == 0)
 111                         && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
 112                 dev_dbg(musb->controller, "%s active, deleting timer\n",
 113                         otg_state_string(musb->xceiv->state));
 114                 del_timer(&musb_idle_timer);
 115                 last_timer = jiffies;
 116                 return;
 117         }
 118
 119         if (time_after(last_timer, timeout)) {
 120                 if (!timer_pending(&musb_idle_timer))
 121                         last_timer = timeout;
 122                 else {
 123                         dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
 124                         return;
 125                 }
 126         }
 127         last_timer = timeout;
 128
 129         dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
 130                 otg_state_string(musb->xceiv->state),
 131                 (unsigned long)jiffies_to_msecs(timeout - jiffies));
 132         mod_timer(&musb_idle_timer, timeout);
 133 }
 134
 135 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
 136 {
 137         u8              devctl;
 138         unsigned long timeout = jiffies + msecs_to_jiffies(1000);
 139         int ret = 1;
 140         /* HDRC controls CPEN, but beware current surges during device
 141          * connect.  They can trigger transient overcurrent conditions
 142          * that must be ignored.
 143          */
 144
 145         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 146
 147         if (is_on) {
 148                 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
 149                         int loops = 100;
 150                         /* start the session */
 151                         devctl |= MUSB_DEVCTL_SESSION;
 152                         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 153                         /*
 154                          * Wait for the musb to set as A device to enable the
 155                          * VBUS
 156                          */
 157                         while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
 158
 159                                 mdelay(5);
 160                                 cpu_relax();
 161
 162                                 if (time_after(jiffies, timeout)
 163                                     || loops-- <= 0) {
 164                                         dev_err(musb->controller,
 165                                         "configured as A device timeout");
 166                                         ret = -EINVAL;
 167                                         break;
 168                                 }
 169                         }
 170
 171                         if (ret && musb->xceiv->set_vbus)
 172                                 otg_set_vbus(musb->xceiv, 1);
 173                 } else {
 174                         musb->is_active = 1;
 175                         musb->xceiv->default_a = 1;
 176                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
 177                         devctl |= MUSB_DEVCTL_SESSION;
 178                         MUSB_HST_MODE(musb);
 179                 }
 180         } else {
 181                 musb->is_active = 0;
 182
 183                 /* NOTE:  we're skipping A_WAIT_VFALL -> A_IDLE and
 184                  * jumping right to B_IDLE...
 185                  */
 186
 187                 musb->xceiv->default_a = 0;
 188                 musb->xceiv->state = OTG_STATE_B_IDLE;
 189                 devctl &= ~MUSB_DEVCTL_SESSION;
 190
 191                 MUSB_DEV_MODE(musb);
 192         }
 193         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 194
 195         dev_dbg(musb->controller, "VBUS %s, devctl %02x "
 196                 /* otg %3x conf %08x prcm %08x */ "\n",
 197                 otg_state_string(musb->xceiv->state),
 198                 musb_readb(musb->mregs, MUSB_DEVCTL));
 199 }
 200
 201 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
 202 {
 203         u8      devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 204
 205         devctl |= MUSB_DEVCTL_SESSION;
 206         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 207
 208         return 0;
 209 }
 210
 211 static inline void omap2430_low_level_exit(struct musb *musb)
 212 {
 213         u32 l;
 214
 215         /* in any role */
 216         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 217         l |= ENABLEFORCE;       /* enable MSTANDBY */
 218         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 219 }
 220
 221 static inline void omap2430_low_level_init(struct musb *musb)
 222 {
 223         u32 l;
 224
 225         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 226         l &= ~ENABLEFORCE;      /* disable MSTANDBY */
 227         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 228 }
 229
 230 /* blocking notifier support */
 231 static int musb_otg_notifications(struct notifier_block *nb,
 232                 unsigned long event, void *unused)
 233 {
 234         struct musb     *musb = container_of(nb, struct musb, nb);
 235         struct device *dev = musb->controller;
 236         struct musb_hdrc_platform_data *pdata = dev->platform_data;
 237         struct omap_musb_board_data *data = pdata->board_data;
 238
 239         switch (event) {
 240         case USB_EVENT_ID:
 241                 dev_dbg(musb->controller, "ID GND\n");
 242
 243                 if (is_otg_enabled(musb)) {
 244                         if (musb->gadget_driver) {
 245                                 pm_runtime_get_sync(musb->controller);
 246                                 otg_init(musb->xceiv);
 247                                 omap2430_musb_set_vbus(musb, 1);
 248                         }
 249                 } else {
 250                         pm_runtime_get_sync(musb->controller);
 251                         otg_init(musb->xceiv);
 252                         omap2430_musb_set_vbus(musb, 1);
 253                 }
 254                 break;
 255
 256         case USB_EVENT_VBUS:
 257                 dev_dbg(musb->controller, "VBUS Connect\n");
 258
 259                 if (musb->gadget_driver)
 260                         pm_runtime_get_sync(musb->controller);
 261                 otg_init(musb->xceiv);
 262                 break;
 263
 264         case USB_EVENT_NONE:
 265                 dev_dbg(musb->controller, "VBUS Disconnect\n");
 266
 267                 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
 268                         if (musb->gadget_driver) {
 269                                 omap2430_musb_set_vbus(musb, 0);
 270
 271                                 pm_runtime_mark_last_busy(musb->controller);
 272                                 pm_runtime_put_autosuspend(musb->controller);
 273                         }
 274
 275                 if (data->interface_type == MUSB_INTERFACE_UTMI) {
 276                         if (musb->xceiv->set_vbus)
 277                                 otg_set_vbus(musb->xceiv, 0);
 278                 }
 279                 otg_shutdown(musb->xceiv);
 280                 break;
 281         default:
 282                 dev_dbg(musb->controller, "ID float\n");
 283                 return NOTIFY_DONE;
 284         }
 285
 286         return NOTIFY_OK;
 287 }
 288
 289 static int omap2430_musb_init(struct musb *musb)
 290 {
 291         u32 l;
 292         int status = 0;
 293         struct device *dev = musb->controller;
 294         struct musb_hdrc_platform_data *plat = dev->platform_data;
 295         struct omap_musb_board_data *data = plat->board_data;
 296
 297         /* We require some kind of external transceiver, hooked
 298          * up through ULPI.  TWL4030-family PMICs include one,
 299          * which needs a driver, drivers aren't always needed.
 300          */
 301         musb->xceiv = otg_get_transceiver();
 302         if (!musb->xceiv) {
 303                 pr_err("HS USB OTG: no transceiver configured\n");
 304                 return -ENODEV;
 305         }
 306
 307         status = pm_runtime_get_sync(dev);
 308         if (status < 0) {
 309                 dev_err(dev, "pm_runtime_get_sync FAILED %d\n", status);
 310                 goto err1;
 311         }
 312
 313         l = musb_readl(musb->mregs, OTG_INTERFSEL);
 314
 315         if (data->interface_type == MUSB_INTERFACE_UTMI) {
 316                 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
 317                 l &= ~ULPI_12PIN;       /* Disable ULPI */
 318                 l |= UTMI_8BIT;         /* Enable UTMI  */
 319         } else {
 320                 l |= ULPI_12PIN;
 321         }
 322
 323         musb_writel(musb->mregs, OTG_INTERFSEL, l);
 324
 325         pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
 326                         "sysstatus 0x%x, intrfsel 0x%x, simenable  0x%x\n",
 327                         musb_readl(musb->mregs, OTG_REVISION),
 328                         musb_readl(musb->mregs, OTG_SYSCONFIG),
 329                         musb_readl(musb->mregs, OTG_SYSSTATUS),
 330                         musb_readl(musb->mregs, OTG_INTERFSEL),
 331                         musb_readl(musb->mregs, OTG_SIMENABLE));
 332
 333         musb->nb.notifier_call = musb_otg_notifications;
 334         status = otg_register_notifier(musb->xceiv, &musb->nb);
 335
 336         if (status)
 337                 dev_dbg(musb->controller, "notification register failed\n");
 338
 339         setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
 340
 341         return 0;
 342
 343 err1:
 344         pm_runtime_disable(dev);
 345         return status;
 346 }
 347
 348 static void omap2430_musb_enable(struct musb *musb)
 349 {
 350         u8              devctl;
 351         unsigned long timeout = jiffies + msecs_to_jiffies(1000);
 352         struct device *dev = musb->controller;
 353         struct musb_hdrc_platform_data *pdata = dev->platform_data;
 354         struct omap_musb_board_data *data = pdata->board_data;
 355
 356         switch (musb->xceiv->last_event) {
 357
 358         case USB_EVENT_ID:
 359                 otg_init(musb->xceiv);
 360                 if (data->interface_type == MUSB_INTERFACE_UTMI) {
 361                         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 362                         /* start the session */
 363                         devctl |= MUSB_DEVCTL_SESSION;
 364                         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 365                         while (musb_readb(musb->mregs, MUSB_DEVCTL) &
 366                                                 MUSB_DEVCTL_BDEVICE) {
 367                                 cpu_relax();
 368
 369                                 if (time_after(jiffies, timeout)) {
 370                                         dev_err(musb->controller,
 371                                         "configured as A device timeout");
 372                                         break;
 373                                 }
 374                         }
 375                 }
 376                 break;
 377
 378         case USB_EVENT_VBUS:
 379                 otg_init(musb->xceiv);
 380                 break;
 381
 382         default:
 383                 break;
 384         }
 385 }
 386
 387 static void omap2430_musb_disable(struct musb *musb)
 388 {
 389         if (musb->xceiv->last_event)
 390                 otg_shutdown(musb->xceiv);
 391 }
 392
 393 static int omap2430_musb_exit(struct musb *musb)
 394 {
 395         del_timer_sync(&musb_idle_timer);
 396
 397         omap2430_low_level_exit(musb);
 398         otg_put_transceiver(musb->xceiv);
 399
 400         return 0;
 401 }
 402
 403 static const struct musb_platform_ops omap2430_ops = {
 404         .init           = omap2430_musb_init,
 405         .exit           = omap2430_musb_exit,
 406
 407         .set_mode       = omap2430_musb_set_mode,
 408         .try_idle       = omap2430_musb_try_idle,
 409
 410         .set_vbus       = omap2430_musb_set_vbus,
 411
 412         .enable         = omap2430_musb_enable,
 413         .disable        = omap2430_musb_disable,
 414 };
 415
 416 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
 417
 418 static int __init omap2430_probe(struct platform_device *pdev)
 419 {
 420         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
 421         struct platform_device          *musb;
 422         struct omap2430_glue            *glue;
 423         int                             ret = -ENOMEM;
 424
 425         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
 426         if (!glue) {
 427                 dev_err(&pdev->dev, "failed to allocate glue context\n");
 428                 goto err0;
 429         }
 430
 431         musb = platform_device_alloc("musb-hdrc", -1);
 432         if (!musb) {
 433                 dev_err(&pdev->dev, "failed to allocate musb device\n");
 434                 goto err1;
 435         }
 436
 437         musb->dev.parent                = &pdev->dev;
 438         musb->dev.dma_mask              = &omap2430_dmamask;
 439         musb->dev.coherent_dma_mask     = omap2430_dmamask;
 440
 441         glue->dev                       = &pdev->dev;
 442         glue->musb                      = musb;
 443
 444         pdata->platform_ops             = &omap2430_ops;
 445
 446         platform_set_drvdata(pdev, glue);
 447
 448         ret = platform_device_add_resources(musb, pdev->resource,
 449                         pdev->num_resources);
 450         if (ret) {
 451                 dev_err(&pdev->dev, "failed to add resources\n");
 452                 goto err2;
 453         }
 454
 455         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
 456         if (ret) {
 457                 dev_err(&pdev->dev, "failed to add platform_data\n");
 458                 goto err2;
 459         }
 460
 461         pm_runtime_enable(&pdev->dev);
 462
 463         ret = platform_device_add(musb);
 464         if (ret) {
 465                 dev_err(&pdev->dev, "failed to register musb device\n");
 466                 goto err2;
 467         }
 468
 469         return 0;
 470
 471 err2:
 472         platform_device_put(musb);
 473
 474 err1:
 475         kfree(glue);
 476
 477 err0:
 478         return ret;
 479 }
 480
 481 static int __exit omap2430_remove(struct platform_device *pdev)
 482 {
 483         struct omap2430_glue            *glue = platform_get_drvdata(pdev);
 484
 485         platform_device_del(glue->musb);
 486         platform_device_put(glue->musb);
 487         pm_runtime_put(&pdev->dev);
 488         pm_runtime_disable(&pdev->dev);
 489         kfree(glue);
 490
 491         return 0;
 492 }
 493
 494 #ifdef CONFIG_PM
 495
 496 static int omap2430_runtime_suspend(struct device *dev)
 497 {
 498         struct omap2430_glue            *glue = dev_get_drvdata(dev);
 499         struct musb                     *musb = glue_to_musb(glue);
 500
 501         musb->context.otg_interfsel = musb_readl(musb->mregs,
 502                                                 OTG_INTERFSEL);
 503
 504         omap2430_low_level_exit(musb);
 505         otg_set_suspend(musb->xceiv, 1);
 506
 507         return 0;
 508 }
 509
 510 static int omap2430_runtime_resume(struct device *dev)
 511 {
 512         struct omap2430_glue            *glue = dev_get_drvdata(dev);
 513         struct musb                     *musb = glue_to_musb(glue);
 514
 515         omap2430_low_level_init(musb);
 516         musb_writel(musb->mregs, OTG_INTERFSEL,
 517                                         musb->context.otg_interfsel);
 518
 519         otg_set_suspend(musb->xceiv, 0);
 520
 521         return 0;
 522 }
 523
 524 static struct dev_pm_ops omap2430_pm_ops = {
 525         .runtime_suspend = omap2430_runtime_suspend,
 526         .runtime_resume = omap2430_runtime_resume,
 527 };
 528
 529 #define DEV_PM_OPS      (&omap2430_pm_ops)
 530 #else
 531 #define DEV_PM_OPS      NULL
 532 #endif
 533
 534 static struct platform_driver omap2430_driver = {
 535         .remove         = __exit_p(omap2430_remove),
 536         .driver         = {
 537                 .name   = "musb-omap2430",
 538                 .pm     = DEV_PM_OPS,
 539         },
 540 };
 541
 542 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
 543 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
 544 MODULE_LICENSE("GPL v2");
 545
 546 static int __init omap2430_init(void)
 547 {
 548         return platform_driver_probe(&omap2430_driver, omap2430_probe);
 549 }
 550 subsys_initcall(omap2430_init);
 551
 552 static void __exit omap2430_exit(void)
 553 {
 554         platform_driver_unregister(&omap2430_driver);
 555 }
 556 module_exit(omap2430_exit);