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
  37 #include "musb_core.h"
  38 #include "omap2430.h"
  39
  40 struct omap2430_glue {
  41         struct device           *dev;
  42         struct platform_device  *musb;
  43         struct clk              *clk;
  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 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  54         u8      power;
  55 #endif
  56         u8      devctl;
  57
  58         spin_lock_irqsave(&musb->lock, flags);
  59
  60         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  61
  62         switch (musb->xceiv->state) {
  63         case OTG_STATE_A_WAIT_BCON:
  64                 devctl &= ~MUSB_DEVCTL_SESSION;
  65                 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
  66
  67                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  68                 if (devctl & MUSB_DEVCTL_BDEVICE) {
  69                         musb->xceiv->state = OTG_STATE_B_IDLE;
  70                         MUSB_DEV_MODE(musb);
  71                 } else {
  72                         musb->xceiv->state = OTG_STATE_A_IDLE;
  73                         MUSB_HST_MODE(musb);
  74                 }
  75                 break;
  76 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  77         case OTG_STATE_A_SUSPEND:
  78                 /* finish RESUME signaling? */
  79                 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
  80                         power = musb_readb(musb->mregs, MUSB_POWER);
  81                         power &= ~MUSB_POWER_RESUME;
  82                         DBG(1, "root port resume stopped, power %02x\n", power);
  83                         musb_writeb(musb->mregs, MUSB_POWER, power);
  84                         musb->is_active = 1;
  85                         musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
  86                                                 | MUSB_PORT_STAT_RESUME);
  87                         musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
  88                         usb_hcd_poll_rh_status(musb_to_hcd(musb));
  89                         /* NOTE: it might really be A_WAIT_BCON ... */
  90                         musb->xceiv->state = OTG_STATE_A_HOST;
  91                 }
  92                 break;
  93 #endif
  94 #ifdef CONFIG_USB_MUSB_HDRC_HCD
  95         case OTG_STATE_A_HOST:
  96                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
  97                 if (devctl &  MUSB_DEVCTL_BDEVICE)
  98                         musb->xceiv->state = OTG_STATE_B_IDLE;
  99                 else
 100                         musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
 101 #endif
 102         default:
 103                 break;
 104         }
 105         spin_unlock_irqrestore(&musb->lock, flags);
 106 }
 107
 108
 109 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
 110 {
 111         unsigned long           default_timeout = jiffies + msecs_to_jiffies(3);
 112         static unsigned long    last_timer;
 113
 114         if (timeout == 0)
 115                 timeout = default_timeout;
 116
 117         /* Never idle if active, or when VBUS timeout is not set as host */
 118         if (musb->is_active || ((musb->a_wait_bcon == 0)
 119                         && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
 120                 DBG(4, "%s active, deleting timer\n", otg_state_string(musb));
 121                 del_timer(&musb_idle_timer);
 122                 last_timer = jiffies;
 123                 return;
 124         }
 125
 126         if (time_after(last_timer, timeout)) {
 127                 if (!timer_pending(&musb_idle_timer))
 128                         last_timer = timeout;
 129                 else {
 130                         DBG(4, "Longer idle timer already pending, ignoring\n");
 131                         return;
 132                 }
 133         }
 134         last_timer = timeout;
 135
 136         DBG(4, "%s inactive, for idle timer for %lu ms\n",
 137                 otg_state_string(musb),
 138                 (unsigned long)jiffies_to_msecs(timeout - jiffies));
 139         mod_timer(&musb_idle_timer, timeout);
 140 }
 141
 142 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
 143 {
 144         u8              devctl;
 145         /* HDRC controls CPEN, but beware current surges during device
 146          * connect.  They can trigger transient overcurrent conditions
 147          * that must be ignored.
 148          */
 149
 150         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 151
 152         if (is_on) {
 153                 musb->is_active = 1;
 154                 musb->xceiv->default_a = 1;
 155                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
 156                 devctl |= MUSB_DEVCTL_SESSION;
 157
 158                 MUSB_HST_MODE(musb);
 159         } else {
 160                 musb->is_active = 0;
 161
 162                 /* NOTE:  we're skipping A_WAIT_VFALL -> A_IDLE and
 163                  * jumping right to B_IDLE...
 164                  */
 165
 166                 musb->xceiv->default_a = 0;
 167                 musb->xceiv->state = OTG_STATE_B_IDLE;
 168                 devctl &= ~MUSB_DEVCTL_SESSION;
 169
 170                 MUSB_DEV_MODE(musb);
 171         }
 172         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 173
 174         DBG(1, "VBUS %s, devctl %02x "
 175                 /* otg %3x conf %08x prcm %08x */ "\n",
 176                 otg_state_string(musb),
 177                 musb_readb(musb->mregs, MUSB_DEVCTL));
 178 }
 179
 180 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
 181 {
 182         u8      devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 183
 184         devctl |= MUSB_DEVCTL_SESSION;
 185         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 186
 187         return 0;
 188 }
 189
 190 static inline void omap2430_low_level_exit(struct musb *musb)
 191 {
 192         u32 l;
 193
 194         /* in any role */
 195         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 196         l |= ENABLEFORCE;       /* enable MSTANDBY */
 197         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 198
 199         l = musb_readl(musb->mregs, OTG_SYSCONFIG);
 200         l |= ENABLEWAKEUP;      /* enable wakeup */
 201         musb_writel(musb->mregs, OTG_SYSCONFIG, l);
 202 }
 203
 204 static inline void omap2430_low_level_init(struct musb *musb)
 205 {
 206         u32 l;
 207
 208         l = musb_readl(musb->mregs, OTG_SYSCONFIG);
 209         l &= ~ENABLEWAKEUP;     /* disable wakeup */
 210         musb_writel(musb->mregs, OTG_SYSCONFIG, l);
 211
 212         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
 213         l &= ~ENABLEFORCE;      /* disable MSTANDBY */
 214         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
 215 }
 216
 217 static int omap2430_musb_init(struct musb *musb)
 218 {
 219         u32 l;
 220         struct device *dev = musb->controller;
 221         struct musb_hdrc_platform_data *plat = dev->platform_data;
 222         struct omap_musb_board_data *data = plat->board_data;
 223
 224         /* We require some kind of external transceiver, hooked
 225          * up through ULPI.  TWL4030-family PMICs include one,
 226          * which needs a driver, drivers aren't always needed.
 227          */
 228         musb->xceiv = otg_get_transceiver();
 229         if (!musb->xceiv) {
 230                 pr_err("HS USB OTG: no transceiver configured\n");
 231                 return -ENODEV;
 232         }
 233
 234         omap2430_low_level_init(musb);
 235
 236         l = musb_readl(musb->mregs, OTG_SYSCONFIG);
 237         l &= ~ENABLEWAKEUP;     /* disable wakeup */
 238         l &= ~NOSTDBY;          /* remove possible nostdby */
 239         l |= SMARTSTDBY;        /* enable smart standby */
 240         l &= ~AUTOIDLE;         /* disable auto idle */
 241         l &= ~NOIDLE;           /* remove possible noidle */
 242         l |= SMARTIDLE;         /* enable smart idle */
 243         /*
 244          * MUSB AUTOIDLE don't work in 3430.
 245          * Workaround by Richard Woodruff/TI
 246          */
 247         if (!cpu_is_omap3430())
 248                 l |= AUTOIDLE;          /* enable auto idle */
 249         musb_writel(musb->mregs, OTG_SYSCONFIG, l);
 250
 251         l = musb_readl(musb->mregs, OTG_INTERFSEL);
 252
 253         if (data->interface_type == MUSB_INTERFACE_UTMI) {
 254                 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
 255                 l &= ~ULPI_12PIN;       /* Disable ULPI */
 256                 l |= UTMI_8BIT;         /* Enable UTMI  */
 257         } else {
 258                 l |= ULPI_12PIN;
 259         }
 260
 261         musb_writel(musb->mregs, OTG_INTERFSEL, l);
 262
 263         pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
 264                         "sysstatus 0x%x, intrfsel 0x%x, simenable  0x%x\n",
 265                         musb_readl(musb->mregs, OTG_REVISION),
 266                         musb_readl(musb->mregs, OTG_SYSCONFIG),
 267                         musb_readl(musb->mregs, OTG_SYSSTATUS),
 268                         musb_readl(musb->mregs, OTG_INTERFSEL),
 269                         musb_readl(musb->mregs, OTG_SIMENABLE));
 270
 271         setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
 272
 273         return 0;
 274 }
 275
 276 static int omap2430_musb_exit(struct musb *musb)
 277 {
 278
 279         omap2430_low_level_exit(musb);
 280         otg_put_transceiver(musb->xceiv);
 281
 282         return 0;
 283 }
 284
 285 static const struct musb_platform_ops omap2430_ops = {
 286         .init           = omap2430_musb_init,
 287         .exit           = omap2430_musb_exit,
 288
 289         .set_mode       = omap2430_musb_set_mode,
 290         .try_idle       = omap2430_musb_try_idle,
 291
 292         .set_vbus       = omap2430_musb_set_vbus,
 293 };
 294
 295 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
 296
 297 static int __init omap2430_probe(struct platform_device *pdev)
 298 {
 299         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
 300         struct platform_device          *musb;
 301         struct omap2430_glue            *glue;
 302         struct clk                      *clk;
 303
 304         int                             ret = -ENOMEM;
 305
 306         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
 307         if (!glue) {
 308                 dev_err(&pdev->dev, "failed to allocate glue context\n");
 309                 goto err0;
 310         }
 311
 312         musb = platform_device_alloc("musb-hdrc", -1);
 313         if (!musb) {
 314                 dev_err(&pdev->dev, "failed to allocate musb device\n");
 315                 goto err1;
 316         }
 317
 318         clk = clk_get(&pdev->dev, "ick");
 319         if (IS_ERR(clk)) {
 320                 dev_err(&pdev->dev, "failed to get clock\n");
 321                 ret = PTR_ERR(clk);
 322                 goto err2;
 323         }
 324
 325         ret = clk_enable(clk);
 326         if (ret) {
 327                 dev_err(&pdev->dev, "failed to enable clock\n");
 328                 goto err3;
 329         }
 330
 331         musb->dev.parent                = &pdev->dev;
 332         musb->dev.dma_mask              = &omap2430_dmamask;
 333         musb->dev.coherent_dma_mask     = omap2430_dmamask;
 334
 335         glue->dev                       = &pdev->dev;
 336         glue->musb                      = musb;
 337         glue->clk                       = clk;
 338
 339         pdata->platform_ops             = &omap2430_ops;
 340
 341         platform_set_drvdata(pdev, glue);
 342
 343         ret = platform_device_add_resources(musb, pdev->resource,
 344                         pdev->num_resources);
 345         if (ret) {
 346                 dev_err(&pdev->dev, "failed to add resources\n");
 347                 goto err4;
 348         }
 349
 350         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
 351         if (ret) {
 352                 dev_err(&pdev->dev, "failed to add platform_data\n");
 353                 goto err4;
 354         }
 355
 356         ret = platform_device_add(musb);
 357         if (ret) {
 358                 dev_err(&pdev->dev, "failed to register musb device\n");
 359                 goto err4;
 360         }
 361
 362         return 0;
 363
 364 err4:
 365         clk_disable(clk);
 366
 367 err3:
 368         clk_put(clk);
 369
 370 err2:
 371         platform_device_put(musb);
 372
 373 err1:
 374         kfree(glue);
 375
 376 err0:
 377         return ret;
 378 }
 379
 380 static int __exit omap2430_remove(struct platform_device *pdev)
 381 {
 382         struct omap2430_glue            *glue = platform_get_drvdata(pdev);
 383
 384         platform_device_del(glue->musb);
 385         platform_device_put(glue->musb);
 386         clk_disable(glue->clk);
 387         clk_put(glue->clk);
 388         kfree(glue);
 389
 390         return 0;
 391 }
 392
 393 #ifdef CONFIG_PM
 394 static void omap2430_save_context(struct musb *musb)
 395 {
 396         musb->context.otg_sysconfig = musb_readl(musb->mregs, OTG_SYSCONFIG);
 397         musb->context.otg_forcestandby = musb_readl(musb->mregs, OTG_FORCESTDBY);
 398 }
 399
 400 static void omap2430_restore_context(struct musb *musb)
 401 {
 402         musb_writel(musb->mregs, OTG_SYSCONFIG, musb->context.otg_sysconfig);
 403         musb_writel(musb->mregs, OTG_FORCESTDBY, musb->context.otg_forcestandby);
 404 }
 405
 406 static int omap2430_suspend(struct device *dev)
 407 {
 408         struct omap2430_glue            *glue = dev_get_drvdata(dev);
 409         struct musb                     *musb = glue_to_musb(glue);
 410
 411         omap2430_low_level_exit(musb);
 412         otg_set_suspend(musb->xceiv, 1);
 413         omap2430_save_context(musb);
 414         clk_disable(glue->clk);
 415
 416         return 0;
 417 }
 418
 419 static int omap2430_resume(struct device *dev)
 420 {
 421         struct omap2430_glue            *glue = dev_get_drvdata(dev);
 422         struct musb                     *musb = glue_to_musb(glue);
 423         int                             ret;
 424
 425         ret = clk_enable(glue->clk);
 426         if (ret) {
 427                 dev_err(dev, "faled to enable clock\n");
 428                 return ret;
 429         }
 430
 431         omap2430_low_level_init(musb);
 432         omap2430_restore_context(musb);
 433         otg_set_suspend(musb->xceiv, 0);
 434
 435         return 0;
 436 }
 437
 438 static struct dev_pm_ops omap2430_pm_ops = {
 439         .suspend        = omap2430_suspend,
 440         .resume         = omap2430_resume,
 441 };
 442
 443 #define DEV_PM_OPS      (&omap2430_pm_ops)
 444 #else
 445 #define DEV_PM_OPS      NULL
 446 #endif
 447
 448 static struct platform_driver omap2430_driver = {
 449         .remove         = __exit_p(omap2430_remove),
 450         .driver         = {
 451                 .name   = "musb-omap2430",
 452                 .pm     = DEV_PM_OPS,
 453         },
 454 };
 455
 456 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
 457 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
 458 MODULE_LICENSE("GPL v2");
 459
 460 static int __init omap2430_init(void)
 461 {
 462         return platform_driver_probe(&omap2430_driver, omap2430_probe);
 463 }
 464 subsys_initcall(omap2430_init);
 465
 466 static void __exit omap2430_exit(void)
 467 {
 468         platform_driver_unregister(&omap2430_driver);
 469 }
 470 module_exit(omap2430_exit);