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
  39 #include "musb_core.h"
  40 #include "omap2430.h"
  41
  42 struct omap2430_glue {
  43         struct device           *dev;
  44         struct platform_device  *musb;
  45 };
  46 #define glue_to_musb(g)         platform_get_drvdata(g->musb)
  47
  48 static struct timer_list musb_idle_timer;
  49
  50 static void musb_do_idle(unsigned long _musb)
  51 {
  52         struct musb     *musb = (void *)_musb;
  53         unsigned long   flags;
  54 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  55         u8      power;
  56 #endif
  57         u8      devctl;
  58
  59         spin_lock_irqsave(&musb->lock, flags);
  60
  61         switch (musb->xceiv->state) {
  62         case OTG_STATE_A_WAIT_BCON:
  63
  64                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  65                 if (devctl & MUSB_DEVCTL_BDEVICE) {
  66                         musb->xceiv->state = OTG_STATE_B_IDLE;
  67                         MUSB_DEV_MODE(musb);
  68                 } else {
  69                         musb->xceiv->state = OTG_STATE_A_IDLE;
  70                         MUSB_HST_MODE(musb);
  71                 }
  72                 break;
  73 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  74         case OTG_STATE_A_SUSPEND:
  75                 /* finish RESUME signaling? */
  76                 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
  77                         power = musb_readb(musb->mregs, MUSB_POWER);
  78                         power &= ~MUSB_POWER_RESUME;
  79                         DBG(1, "root port resume stopped, power %02x\n", power);
  80                         musb_writeb(musb->mregs, MUSB_POWER, power);
  81                         musb->is_active = 1;
  82                         musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
  83                                                 | MUSB_PORT_STAT_RESUME);
  84                         musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
  85                         usb_hcd_poll_rh_status(musb_to_hcd(musb));
  86                         /* NOTE: it might really be A_WAIT_BCON ... */
  87                         musb->xceiv->state = OTG_STATE_A_HOST;
  88                 }
  89                 break;
  90 #endif
  91 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  92         case OTG_STATE_A_HOST:
  93                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  94                 if (devctl &  MUSB_DEVCTL_BDEVICE)
  95                         musb->xceiv->state = OTG_STATE_B_IDLE;
  96                 else
  97                         musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
  98 #endif
  99         default:
 100                 break;
 101         }
 102         spin_unlock_irqrestore(&musb->lock, flags);
 103 }
 104
 105
 106 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
 107 {
 108         unsigned long           default_timeout = jiffies + msecs_to_jiffies(3);
 109         static unsigned long    last_timer;
 110
 111         if (timeout == 0)
 112                 timeout = default_timeout;
 113
 114         /* Never idle if active, or when VBUS timeout is not set as host */
 115         if (musb->is_active || ((musb->a_wait_bcon == 0)
 116                         && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
 117                 DBG(4, "%s active, deleting timer\n", otg_state_string(musb));
 118                 del_timer(&musb_idle_timer);
 119                 last_timer = jiffies;
 120                 return;
 121         }
 122
 123         if (time_after(last_timer, timeout)) {
 124                 if (!timer_pending(&musb_idle_timer))
 125                         last_timer = timeout;
 126                 else {
 127                         DBG(4, "Longer idle timer already pending, ignoring\n");
 128                         return;
 129                 }
 130         }
 131         last_timer = timeout;
 132
 133         DBG(4, "%s inactive, for idle timer for %lu ms\n",
 134                 otg_state_string(musb),
 135                 (unsigned long)jiffies_to_msecs(timeout - jiffies));
 136         mod_timer(&musb_idle_timer, timeout);
 137 }
 138
 139 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
 140 {
 141         u8              devctl;
 142         unsigned long timeout = jiffies + msecs_to_jiffies(1000);
 143         int ret = 1;
 144         /* HDRC controls CPEN, but beware current surges during device
 145          * connect.  They can trigger transient overcurrent conditions
 146          * that must be ignored.
 147          */
 148
 149         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 150
 151         if (is_on) {
 152                 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
 153                         /* start the session */
 154                         devctl |= MUSB_DEVCTL_SESSION;
 155                         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 156                         /*
 157                          * Wait for the musb to set as A device to enable the
 158                          * VBUS
 159                          */
 160                         while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
 161
 162                                 cpu_relax();
 163
 164                                 if (time_after(jiffies, timeout)) {
 165                                         dev_err(musb->controller,
 166                                         "configured as A device timeout");
 167                                         ret = -EINVAL;
 168                                         break;
 169                                 }
 170                         }
 171
 172                         if (ret && musb->xceiv->set_vbus)
 173                                 otg_set_vbus(musb->xceiv, 1);
 174                 } else {
 175                         musb->is_active = 1;
 176                         musb->xceiv->default_a = 1;
 177                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
 178                         devctl |= MUSB_DEVCTL_SESSION;
 179                         MUSB_HST_MODE(musb);
 180                 }
 181         } else {
 182                 musb->is_active = 0;
 183
 184                 /* NOTE:  we're skipping A_WAIT_VFALL -> A_IDLE and
 185                  * jumping right to B_IDLE...
 186                  */
 187
 188                 musb->xceiv->default_a = 0;
 189                 musb->xceiv->state = OTG_STATE_B_IDLE;
 190                 devctl &= ~MUSB_DEVCTL_SESSION;
 191
 192                 MUSB_DEV_MODE(musb);
 193         }
 194         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 195
 196         DBG(1, "VBUS %s, devctl %02x "
 197                 /* otg %3x conf %08x prcm %08x */ "\n",
 198                 otg_state_string(musb),
 199                 musb_readb(musb->mregs, MUSB_DEVCTL));
 200 }
 201
 202 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
 203 {
 204         u8      devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 205
 206         devctl |= MUSB_DEVCTL_SESSION;
 207         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 208
 209         return 0;
 210 }
 211
 212 static inline void omap2430_low_level_exit(struct musb *musb)
 213 {
 214         u32 l;
 215
 216         /* in any role */
 217         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 218         l |= ENABLEFORCE;       /* enable MSTANDBY */
 219         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 220 }
 221
 222 static inline void omap2430_low_level_init(struct musb *musb)
 223 {
 224         u32 l;
 225
 226         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 227         l &= ~ENABLEFORCE;      /* disable MSTANDBY */
 228         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 229 }
 230
 231 /* blocking notifier support */
 232 static int musb_otg_notifications(struct notifier_block *nb,
 233                 unsigned long event, void *unused)
 234 {
 235         struct musb     *musb = container_of(nb, struct musb, nb);
 236         struct device *dev = musb->controller;
 237         struct musb_hdrc_platform_data *pdata = dev->platform_data;
 238         struct omap_musb_board_data *data = pdata->board_data;
 239
 240         switch (event) {
 241         case USB_EVENT_ID:
 242                 DBG(4, "ID GND\n");
 243
 244                 if (is_otg_enabled(musb)) {
 245 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 246                         if (musb->gadget_driver) {
 247                                 pm_runtime_get_sync(musb->controller);
 248                                 otg_init(musb->xceiv);
 249                                 omap2430_musb_set_vbus(musb, 1);
 250                         }
 251 #endif
 252                 } else {
 253                         pm_runtime_get_sync(musb->controller);
 254                         otg_init(musb->xceiv);
 255                         omap2430_musb_set_vbus(musb, 1);
 256                 }
 257                 break;
 258
 259         case USB_EVENT_VBUS:
 260                 DBG(4, "VBUS Connect\n");
 261
 262                 if (musb->gadget_driver)
 263                         pm_runtime_get_sync(musb->controller);
 264
 265                 otg_init(musb->xceiv);
 266                 break;
 267
 268         case USB_EVENT_NONE:
 269                 DBG(4, "VBUS Disconnect\n");
 270
 271 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 272                 if (is_otg_enabled(musb))
 273                         if (musb->gadget_driver)
 274 #endif
 275                         {
 276                                 pm_runtime_mark_last_busy(musb->controller);
 277                                 pm_runtime_put_autosuspend(musb->controller);
 278                         }
 279
 280                 if (data->interface_type == MUSB_INTERFACE_UTMI) {
 281                         if (musb->xceiv->set_vbus)
 282                                 otg_set_vbus(musb->xceiv, 0);
 283                 }
 284                 otg_shutdown(musb->xceiv);
 285                 break;
 286         default:
 287                 DBG(4, "ID float\n");
 288                 return NOTIFY_DONE;
 289         }
 290
 291         return NOTIFY_OK;
 292 }
 293
 294 static int omap2430_musb_init(struct musb *musb)
 295 {
 296         u32 l, status = 0;
 297         struct device *dev = musb->controller;
 298         struct musb_hdrc_platform_data *plat = dev->platform_data;
 299         struct omap_musb_board_data *data = plat->board_data;
 300
 301         /* We require some kind of external transceiver, hooked
 302          * up through ULPI.  TWL4030-family PMICs include one,
 303          * which needs a driver, drivers aren't always needed.
 304          */
 305         musb->xceiv = otg_get_transceiver();
 306         if (!musb->xceiv) {
 307                 pr_err("HS USB OTG: no transceiver configured\n");
 308                 return -ENODEV;
 309         }
 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                 DBG(1, "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         omap2430_low_level_exit(musb);
 506         otg_set_suspend(musb->xceiv, 1);
 507
 508         return 0;
 509 }
 510
 511 static int omap2430_runtime_resume(struct device *dev)
 512 {
 513         struct omap2430_glue            *glue = dev_get_drvdata(dev);
 514         struct musb                     *musb = glue_to_musb(glue);
 515
 516         omap2430_low_level_init(musb);
 517         otg_set_suspend(musb->xceiv, 0);
 518
 519         return 0;
 520 }
 521
 522 static struct dev_pm_ops omap2430_pm_ops = {
 523         .runtime_suspend = omap2430_runtime_suspend,
 524         .runtime_resume = omap2430_runtime_resume,
 525 };
 526
 527 #define DEV_PM_OPS      (&omap2430_pm_ops)
 528 #else
 529 #define DEV_PM_OPS      NULL
 530 #endif
 531
 532 static struct platform_driver omap2430_driver = {
 533         .remove         = __exit_p(omap2430_remove),
 534         .driver         = {
 535                 .name   = "musb-omap2430",
 536                 .pm     = DEV_PM_OPS,
 537         },
 538 };
 539
 540 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
 541 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
 542 MODULE_LICENSE("GPL v2");
 543
 544 static int __init omap2430_init(void)
 545 {
 546         return platform_driver_probe(&omap2430_driver, omap2430_probe);
 547 }
 548 subsys_initcall(omap2430_init);
 549
 550 static void __exit omap2430_exit(void)
 551 {
 552         platform_driver_unregister(&omap2430_driver);
 553 }
 554 module_exit(omap2430_exit);