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