drivers/usb/musb/davinci.c

   1 /*
   2  * Copyright (C) 2005-2006 by Texas Instruments
   3  *
   4  * This file is part of the Inventra Controller Driver for Linux.
   5  *
   6  * The Inventra Controller Driver for Linux is free software; you
   7  * can redistribute it and/or modify it under the terms of the GNU
   8  * General Public License version 2 as published by the Free Software
   9  * Foundation.
  10  *
  11  * The Inventra Controller Driver for Linux is distributed in
  12  * the hope that it will be useful, but WITHOUT ANY WARRANTY;
  13  * without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  15  * License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with The Inventra Controller Driver for Linux ; if not,
  19  * write to the Free Software Foundation, Inc., 59 Temple Place,
  20  * Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/kernel.h>
  26 #include <linux/sched.h>
  27 #include <linux/init.h>
  28 #include <linux/list.h>
  29 #include <linux/delay.h>
  30 #include <linux/clk.h>
  31 #include <linux/io.h>
  32 #include <linux/gpio.h>
  33
  34 #include <mach/hardware.h>
  35 #include <mach/memory.h>
  36 #include <mach/gpio.h>
  37 #include <mach/cputype.h>
  38
  39 #include <asm/mach-types.h>
  40
  41 #include "musb_core.h"
  42
  43 #ifdef CONFIG_MACH_DAVINCI_EVM
  44 #define GPIO_nVBUS_DRV          160
  45 #endif
  46
  47 #include "davinci.h"
  48 #include "cppi_dma.h"
  49
  50
  51 #define USB_PHY_CTRL    IO_ADDRESS(USBPHY_CTL_PADDR)
  52 #define DM355_DEEPSLEEP IO_ADDRESS(DM355_DEEPSLEEP_PADDR)
  53
  54 /* REVISIT (PM) we should be able to keep the PHY in low power mode most
  55  * of the time (24 MHZ oscillator and PLL off, etc) by setting POWER.D0
  56  * and, when in host mode, autosuspending idle root ports... PHYPLLON
  57  * (overriding SUSPENDM?) then likely needs to stay off.
  58  */
  59
  60 static inline void phy_on(void)
  61 {
  62         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
  63
  64         /* power everything up; start the on-chip PHY and its PLL */
  65         phy_ctrl &= ~(USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN);
  66         phy_ctrl |= USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON;
  67         __raw_writel(phy_ctrl, USB_PHY_CTRL);
  68
  69         /* wait for PLL to lock before proceeding */
  70         while ((__raw_readl(USB_PHY_CTRL) & USBPHY_PHYCLKGD) == 0)
  71                 cpu_relax();
  72 }
  73
  74 static inline void phy_off(void)
  75 {
  76         u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
  77
  78         /* powerdown the on-chip PHY, its PLL, and the OTG block */
  79         phy_ctrl &= ~(USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON);
  80         phy_ctrl |= USBPHY_OSCPDWN | USBPHY_OTGPDWN | USBPHY_PHYPDWN;
  81         __raw_writel(phy_ctrl, USB_PHY_CTRL);
  82 }
  83
  84 static int dma_off = 1;
  85
  86 void musb_platform_enable(struct musb *musb)
  87 {
  88         u32     tmp, old, val;
  89
  90         /* workaround:  setup irqs through both register sets */
  91         tmp = (musb->epmask & DAVINCI_USB_TX_ENDPTS_MASK)
  92                         << DAVINCI_USB_TXINT_SHIFT;
  93         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
  94         old = tmp;
  95         tmp = (musb->epmask & (0xfffe & DAVINCI_USB_RX_ENDPTS_MASK))
  96                         << DAVINCI_USB_RXINT_SHIFT;
  97         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
  98         tmp |= old;
  99
 100         val = ~MUSB_INTR_SOF;
 101         tmp |= ((val & 0x01ff) << DAVINCI_USB_USBINT_SHIFT);
 102         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_SET_REG, tmp);
 103
 104         if (is_dma_capable() && !dma_off)
 105                 printk(KERN_WARNING "%s %s: dma not reactivated\n",
 106                                 __FILE__, __func__);
 107         else
 108                 dma_off = 0;
 109
 110         /* force a DRVVBUS irq so we can start polling for ID change */
 111         if (is_otg_enabled(musb))
 112                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
 113                         DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT);
 114 }
 115
 116 /*
 117  * Disable the HDRC and flush interrupts
 118  */
 119 void musb_platform_disable(struct musb *musb)
 120 {
 121         /* because we don't set CTRLR.UINT, "important" to:
 122          *  - not read/write INTRUSB/INTRUSBE
 123          *  - (except during initial setup, as workaround)
 124          *  - use INTSETR/INTCLRR instead
 125          */
 126         musb_writel(musb->ctrl_base, DAVINCI_USB_INT_MASK_CLR_REG,
 127                           DAVINCI_USB_USBINT_MASK
 128                         | DAVINCI_USB_TXINT_MASK
 129                         | DAVINCI_USB_RXINT_MASK);
 130         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
 131         musb_writel(musb->ctrl_base, DAVINCI_USB_EOI_REG, 0);
 132
 133         if (is_dma_capable() && !dma_off)
 134                 WARNING("dma still active\n");
 135 }
 136
 137
 138 #ifdef CONFIG_USB_MUSB_HDRC_HCD
 139 #define portstate(stmt)         stmt
 140 #else
 141 #define portstate(stmt)
 142 #endif
 143
 144
 145 /*
 146  * VBUS SWITCHING IS BOARD-SPECIFIC ... at least for the DM6446 EVM,
 147  * which doesn't wire DRVVBUS to the FET that switches it.  Unclear
 148  * if that's a problem with the DM6446 chip or just with that board.
 149  *
 150  * In either case, the DM355 EVM automates DRVVBUS the normal way,
 151  * when J10 is out, and TI documents it as handling OTG.
 152  */
 153
 154 #ifdef CONFIG_MACH_DAVINCI_EVM
 155
 156 static int vbus_state = -1;
 157
 158 /* I2C operations are always synchronous, and require a task context.
 159  * With unloaded systems, using the shared workqueue seems to suffice
 160  * to satisfy the 100msec A_WAIT_VRISE timeout...
 161  */
 162 static void evm_deferred_drvvbus(struct work_struct *ignored)
 163 {
 164         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
 165         vbus_state = !vbus_state;
 166 }
 167
 168 #endif  /* EVM */
 169
 170 static void davinci_source_power(struct musb *musb, int is_on, int immediate)
 171 {
 172 #ifdef CONFIG_MACH_DAVINCI_EVM
 173         if (is_on)
 174                 is_on = 1;
 175
 176         if (vbus_state == is_on)
 177                 return;
 178         vbus_state = !is_on;            /* 0/1 vs "-1 == unknown/init" */
 179
 180         if (machine_is_davinci_evm()) {
 181                 static DECLARE_WORK(evm_vbus_work, evm_deferred_drvvbus);
 182
 183                 if (immediate)
 184                         gpio_set_value_cansleep(GPIO_nVBUS_DRV, vbus_state);
 185                 else
 186                         schedule_work(&evm_vbus_work);
 187         }
 188         if (immediate)
 189                 vbus_state = is_on;
 190 #endif
 191 }
 192
 193 static void davinci_set_vbus(struct musb *musb, int is_on)
 194 {
 195         WARN_ON(is_on && is_peripheral_active(musb));
 196         davinci_source_power(musb, is_on, 0);
 197 }
 198
 199
 200 #define POLL_SECONDS    2
 201
 202 static struct timer_list otg_workaround;
 203
 204 static void otg_timer(unsigned long _musb)
 205 {
 206         struct musb             *musb = (void *)_musb;
 207         void __iomem            *mregs = musb->mregs;
 208         u8                      devctl;
 209         unsigned long           flags;
 210
 211         /* We poll because DaVinci's won't expose several OTG-critical
 212         * status change events (from the transceiver) otherwise.
 213          */
 214         devctl = musb_readb(mregs, MUSB_DEVCTL);
 215         DBG(7, "poll devctl %02x (%s)\n", devctl, otg_state_string(musb));
 216
 217         spin_lock_irqsave(&musb->lock, flags);
 218         switch (musb->xceiv->state) {
 219         case OTG_STATE_A_WAIT_VFALL:
 220                 /* Wait till VBUS falls below SessionEnd (~0.2V); the 1.3 RTL
 221                  * seems to mis-handle session "start" otherwise (or in our
 222                  * case "recover"), in routine "VBUS was valid by the time
 223                  * VBUSERR got reported during enumeration" cases.
 224                  */
 225                 if (devctl & MUSB_DEVCTL_VBUS) {
 226                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
 227                         break;
 228                 }
 229                 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
 230                 musb_writel(musb->ctrl_base, DAVINCI_USB_INT_SET_REG,
 231                         MUSB_INTR_VBUSERROR << DAVINCI_USB_USBINT_SHIFT);
 232                 break;
 233         case OTG_STATE_B_IDLE:
 234                 if (!is_peripheral_enabled(musb))
 235                         break;
 236
 237                 /* There's no ID-changed IRQ, so we have no good way to tell
 238                  * when to switch to the A-Default state machine (by setting
 239                  * the DEVCTL.SESSION flag).
 240                  *
 241                  * Workaround:  whenever we're in B_IDLE, try setting the
 242                  * session flag every few seconds.  If it works, ID was
 243                  * grounded and we're now in the A-Default state machine.
 244                  *
 245                  * NOTE setting the session flag is _supposed_ to trigger
 246                  * SRP, but clearly it doesn't.
 247                  */
 248                 musb_writeb(mregs, MUSB_DEVCTL,
 249                                 devctl | MUSB_DEVCTL_SESSION);
 250                 devctl = musb_readb(mregs, MUSB_DEVCTL);
 251                 if (devctl & MUSB_DEVCTL_BDEVICE)
 252                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
 253                 else
 254                         musb->xceiv->state = OTG_STATE_A_IDLE;
 255                 break;
 256         default:
 257                 break;
 258         }
 259         spin_unlock_irqrestore(&musb->lock, flags);
 260 }
 261
 262 static irqreturn_t davinci_interrupt(int irq, void *__hci)
 263 {
 264         unsigned long   flags;
 265         irqreturn_t     retval = IRQ_NONE;
 266         struct musb     *musb = __hci;
 267         void __iomem    *tibase = musb->ctrl_base;
 268         struct cppi     *cppi;
 269         u32             tmp;
 270
 271         spin_lock_irqsave(&musb->lock, flags);
 272
 273         /* NOTE: DaVinci shadows the Mentor IRQs.  Don't manage them through
 274          * the Mentor registers (except for setup), use the TI ones and EOI.
 275          *
 276          * Docs describe irq "vector" registers associated with the CPPI and
 277          * USB EOI registers.  These hold a bitmask corresponding to the
 278          * current IRQ, not an irq handler address.  Would using those bits
 279          * resolve some of the races observed in this dispatch code??
 280          */
 281
 282         /* CPPI interrupts share the same IRQ line, but have their own
 283          * mask, state, "vector", and EOI registers.
 284          */
 285         cppi = container_of(musb->dma_controller, struct cppi, controller);
 286         if (is_cppi_enabled() && musb->dma_controller && !cppi->irq)
 287                 retval = cppi_interrupt(irq, __hci);
 288
 289         /* ack and handle non-CPPI interrupts */
 290         tmp = musb_readl(tibase, DAVINCI_USB_INT_SRC_MASKED_REG);
 291         musb_writel(tibase, DAVINCI_USB_INT_SRC_CLR_REG, tmp);
 292         DBG(4, "IRQ %08x\n", tmp);
 293
 294         musb->int_rx = (tmp & DAVINCI_USB_RXINT_MASK)
 295                         >> DAVINCI_USB_RXINT_SHIFT;
 296         musb->int_tx = (tmp & DAVINCI_USB_TXINT_MASK)
 297                         >> DAVINCI_USB_TXINT_SHIFT;
 298         musb->int_usb = (tmp & DAVINCI_USB_USBINT_MASK)
 299                         >> DAVINCI_USB_USBINT_SHIFT;
 300
 301         /* DRVVBUS irqs are the only proxy we have (a very poor one!) for
 302          * DaVinci's missing ID change IRQ.  We need an ID change IRQ to
 303          * switch appropriately between halves of the OTG state machine.
 304          * Managing DEVCTL.SESSION per Mentor docs requires we know its
 305          * value, but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
 306          * Also, DRVVBUS pulses for SRP (but not at 5V) ...
 307          */
 308         if (tmp & (DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT)) {
 309                 int     drvvbus = musb_readl(tibase, DAVINCI_USB_STAT_REG);
 310                 void __iomem *mregs = musb->mregs;
 311                 u8      devctl = musb_readb(mregs, MUSB_DEVCTL);
 312                 int     err = musb->int_usb & MUSB_INTR_VBUSERROR;
 313
 314                 err = is_host_enabled(musb)
 315                                 && (musb->int_usb & MUSB_INTR_VBUSERROR);
 316                 if (err) {
 317                         /* The Mentor core doesn't debounce VBUS as needed
 318                          * to cope with device connect current spikes. This
 319                          * means it's not uncommon for bus-powered devices
 320                          * to get VBUS errors during enumeration.
 321                          *
 322                          * This is a workaround, but newer RTL from Mentor
 323                          * seems to allow a better one: "re"starting sessions
 324                          * without waiting (on EVM, a **long** time) for VBUS
 325                          * to stop registering in devctl.
 326                          */
 327                         musb->int_usb &= ~MUSB_INTR_VBUSERROR;
 328                         musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
 329                         mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
 330                         WARNING("VBUS error workaround (delay coming)\n");
 331                 } else if (is_host_enabled(musb) && drvvbus) {
 332                         MUSB_HST_MODE(musb);
 333                         musb->xceiv->default_a = 1;
 334                         musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
 335                         portstate(musb->port1_status |= USB_PORT_STAT_POWER);
 336                         del_timer(&otg_workaround);
 337                 } else {
 338                         musb->is_active = 0;
 339                         MUSB_DEV_MODE(musb);
 340                         musb->xceiv->default_a = 0;
 341                         musb->xceiv->state = OTG_STATE_B_IDLE;
 342                         portstate(musb->port1_status &= ~USB_PORT_STAT_POWER);
 343                 }
 344
 345                 /* NOTE:  this must complete poweron within 100 msec
 346                  * (OTG_TIME_A_WAIT_VRISE) but we don't check for that.
 347                  */
 348                 davinci_source_power(musb, drvvbus, 0);
 349                 DBG(2, "VBUS %s (%s)%s, devctl %02x\n",
 350                                 drvvbus ? "on" : "off",
 351                                 otg_state_string(musb),
 352                                 err ? " ERROR" : "",
 353                                 devctl);
 354                 retval = IRQ_HANDLED;
 355         }
 356
 357         if (musb->int_tx || musb->int_rx || musb->int_usb)
 358                 retval |= musb_interrupt(musb);
 359
 360         /* irq stays asserted until EOI is written */
 361         musb_writel(tibase, DAVINCI_USB_EOI_REG, 0);
 362
 363         /* poll for ID change */
 364         if (is_otg_enabled(musb)
 365                         && musb->xceiv->state == OTG_STATE_B_IDLE)
 366                 mod_timer(&otg_workaround, jiffies + POLL_SECONDS * HZ);
 367
 368         spin_unlock_irqrestore(&musb->lock, flags);
 369
 370         return retval;
 371 }
 372
 373 int musb_platform_set_mode(struct musb *musb, u8 mode)
 374 {
 375         /* EVM can't do this (right?) */
 376         return -EIO;
 377 }
 378
 379 int __init musb_platform_init(struct musb *musb)
 380 {
 381         void __iomem    *tibase = musb->ctrl_base;
 382         u32             revision;
 383
 384         usb_nop_xceiv_register();
 385         musb->xceiv = otg_get_transceiver();
 386         if (!musb->xceiv)
 387                 return -ENODEV;
 388
 389         musb->mregs += DAVINCI_BASE_OFFSET;
 390
 391         clk_enable(musb->clock);
 392
 393         /* returns zero if e.g. not clocked */
 394         revision = musb_readl(tibase, DAVINCI_USB_VERSION_REG);
 395         if (revision == 0)
 396                 goto fail;
 397
 398         if (is_host_enabled(musb))
 399                 setup_timer(&otg_workaround, otg_timer, (unsigned long) musb);
 400
 401         musb->board_set_vbus = davinci_set_vbus;
 402         davinci_source_power(musb, 0, 1);
 403
 404         /* dm355 EVM swaps D+/D- for signal integrity, and
 405          * is clocked from the main 24 MHz crystal.
 406          */
 407         if (machine_is_davinci_dm355_evm()) {
 408                 u32     phy_ctrl = __raw_readl(USB_PHY_CTRL);
 409
 410                 phy_ctrl &= ~(3 << 9);
 411                 phy_ctrl |= USBPHY_DATAPOL;
 412                 __raw_writel(phy_ctrl, USB_PHY_CTRL);
 413         }
 414
 415         /* On dm355, the default-A state machine needs DRVVBUS control.
 416          * If we won't be a host, there's no need to turn it on.
 417          */
 418         if (cpu_is_davinci_dm355()) {
 419                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
 420
 421                 if (is_host_enabled(musb)) {
 422                         deepsleep &= ~DRVVBUS_OVERRIDE;
 423                 } else {
 424                         deepsleep &= ~DRVVBUS_FORCE;
 425                         deepsleep |= DRVVBUS_OVERRIDE;
 426                 }
 427                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
 428         }
 429
 430         /* reset the controller */
 431         musb_writel(tibase, DAVINCI_USB_CTRL_REG, 0x1);
 432
 433         /* start the on-chip PHY and its PLL */
 434         phy_on();
 435
 436         msleep(5);
 437
 438         /* NOTE:  irqs are in mixed mode, not bypass to pure-musb */
 439         pr_debug("DaVinci OTG revision %08x phy %03x control %02x\n",
 440                 revision, __raw_readl(USB_PHY_CTRL),
 441                 musb_readb(tibase, DAVINCI_USB_CTRL_REG));
 442
 443         musb->isr = davinci_interrupt;
 444         return 0;
 445
 446 fail:
 447         clk_disable(musb->clock);
 448
 449         usb_nop_xceiv_unregister();
 450         return -ENODEV;
 451 }
 452
 453 int musb_platform_exit(struct musb *musb)
 454 {
 455         if (is_host_enabled(musb))
 456                 del_timer_sync(&otg_workaround);
 457
 458         /* force VBUS off */
 459         if (cpu_is_davinci_dm355()) {
 460                 u32     deepsleep = __raw_readl(DM355_DEEPSLEEP);
 461
 462                 deepsleep &= ~DRVVBUS_FORCE;
 463                 deepsleep |= DRVVBUS_OVERRIDE;
 464                 __raw_writel(deepsleep, DM355_DEEPSLEEP);
 465         }
 466
 467         davinci_source_power(musb, 0 /*off*/, 1);
 468
 469         /* delay, to avoid problems with module reload */
 470         if (is_host_enabled(musb) && musb->xceiv->default_a) {
 471                 int     maxdelay = 30;
 472                 u8      devctl, warn = 0;
 473
 474                 /* if there's no peripheral connected, this can take a
 475                  * long time to fall, especially on EVM with huge C133.
 476                  */
 477                 do {
 478                         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
 479                         if (!(devctl & MUSB_DEVCTL_VBUS))
 480                                 break;
 481                         if ((devctl & MUSB_DEVCTL_VBUS) != warn) {
 482                                 warn = devctl & MUSB_DEVCTL_VBUS;
 483                                 DBG(1, "VBUS %d\n",
 484                                         warn >> MUSB_DEVCTL_VBUS_SHIFT);
 485                         }
 486                         msleep(1000);
 487                         maxdelay--;
 488                 } while (maxdelay > 0);
 489
 490                 /* in OTG mode, another host might be connected */
 491                 if (devctl & MUSB_DEVCTL_VBUS)
 492                         DBG(1, "VBUS off timeout (devctl %02x)\n", devctl);
 493         }
 494
 495         phy_off();
 496
 497         clk_disable(musb->clock);
 498
 499         usb_nop_xceiv_unregister();
 500
 501         return 0;
 502 }