drivers/usb/musb/musb_core.c

   1 /*
   2  * MUSB OTG driver core code
   3  *
   4  * Copyright 2005 Mentor Graphics Corporation
   5  * Copyright (C) 2005-2006 by Texas Instruments
   6  * Copyright (C) 2006-2007 Nokia Corporation
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  *
  22  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
  23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  25  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  28  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  29  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 /*
  36  * Inventra (Multipoint) Dual-Role Controller Driver for Linux.
  37  *
  38  * This consists of a Host Controller Driver (HCD) and a peripheral
  39  * controller driver implementing the "Gadget" API; OTG support is
  40  * in the works.  These are normal Linux-USB controller drivers which
  41  * use IRQs and have no dedicated thread.
  42  *
  43  * This version of the driver has only been used with products from
  44  * Texas Instruments.  Those products integrate the Inventra logic
  45  * with other DMA, IRQ, and bus modules, as well as other logic that
  46  * needs to be reflected in this driver.
  47  *
  48  *
  49  * NOTE:  the original Mentor code here was pretty much a collection
  50  * of mechanisms that don't seem to have been fully integrated/working
  51  * for *any* Linux kernel version.  This version aims at Linux 2.6.now,
  52  * Key open issues include:
  53  *
  54  *  - Lack of host-side transaction scheduling, for all transfer types.
  55  *    The hardware doesn't do it; instead, software must.
  56  *
  57  *    This is not an issue for OTG devices that don't support external
  58  *    hubs, but for more "normal" USB hosts it's a user issue that the
  59  *    "multipoint" support doesn't scale in the expected ways.  That
  60  *    includes DaVinci EVM in a common non-OTG mode.
  61  *
  62  *      * Control and bulk use dedicated endpoints, and there's as
  63  *        yet no mechanism to either (a) reclaim the hardware when
  64  *        peripherals are NAKing, which gets complicated with bulk
  65  *        endpoints, or (b) use more than a single bulk endpoint in
  66  *        each direction.
  67  *
  68  *        RESULT:  one device may be perceived as blocking another one.
  69  *
  70  *      * Interrupt and isochronous will dynamically allocate endpoint
  71  *        hardware, but (a) there's no record keeping for bandwidth;
  72  *        (b) in the common case that few endpoints are available, there
  73  *        is no mechanism to reuse endpoints to talk to multiple devices.
  74  *
  75  *        RESULT:  At one extreme, bandwidth can be overcommitted in
  76  *        some hardware configurations, no faults will be reported.
  77  *        At the other extreme, the bandwidth capabilities which do
  78  *        exist tend to be severely undercommitted.  You can't yet hook
  79  *        up both a keyboard and a mouse to an external USB hub.
  80  */
  81
  82 /*
  83  * This gets many kinds of configuration information:
  84  *      - Kconfig for everything user-configurable
  85  *      - platform_device for addressing, irq, and platform_data
  86  *      - platform_data is mostly for board-specific informarion
  87  *        (plus recentrly, SOC or family details)
  88  *
  89  * Most of the conditional compilation will (someday) vanish.
  90  */
  91
  92 #include <linux/module.h>
  93 #include <linux/kernel.h>
  94 #include <linux/sched.h>
  95 #include <linux/slab.h>
  96 #include <linux/init.h>
  97 #include <linux/list.h>
  98 #include <linux/kobject.h>
  99 #include <linux/prefetch.h>
 100 #include <linux/platform_device.h>
 101 #include <linux/io.h>
 102 #include <linux/idr.h>
 103 #include <linux/dma-mapping.h>
 104
 105 #include "musb_core.h"
 106
 107 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
 108
 109
 110 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
 111 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
 112
 113 #define MUSB_VERSION "6.0"
 114
 115 #define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
 116
 117 #define MUSB_DRIVER_NAME "musb-hdrc"
 118 const char musb_driver_name[] = MUSB_DRIVER_NAME;
 119
 120 MODULE_DESCRIPTION(DRIVER_INFO);
 121 MODULE_AUTHOR(DRIVER_AUTHOR);
 122 MODULE_LICENSE("GPL");
 123 MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
 124
 125
 126 /*-------------------------------------------------------------------------*/
 127
 128 static inline struct musb *dev_to_musb(struct device *dev)
 129 {
 130         return dev_get_drvdata(dev);
 131 }
 132
 133 /*-------------------------------------------------------------------------*/
 134
 135 #ifndef CONFIG_BLACKFIN
 136 static int musb_ulpi_read(struct usb_phy *phy, u32 offset)
 137 {
 138         void __iomem *addr = phy->io_priv;
 139         int     i = 0;
 140         u8      r;
 141         u8      power;
 142         int     ret;
 143
 144         pm_runtime_get_sync(phy->io_dev);
 145
 146         /* Make sure the transceiver is not in low power mode */
 147         power = musb_readb(addr, MUSB_POWER);
 148         power &= ~MUSB_POWER_SUSPENDM;
 149         musb_writeb(addr, MUSB_POWER, power);
 150
 151         /* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
 152          * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
 153          */
 154
 155         musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
 156         musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
 157                         MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
 158
 159         while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 160                                 & MUSB_ULPI_REG_CMPLT)) {
 161                 i++;
 162                 if (i == 10000) {
 163                         ret = -ETIMEDOUT;
 164                         goto out;
 165                 }
 166
 167         }
 168         r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 169         r &= ~MUSB_ULPI_REG_CMPLT;
 170         musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 171
 172         ret = musb_readb(addr, MUSB_ULPI_REG_DATA);
 173
 174 out:
 175         pm_runtime_put(phy->io_dev);
 176
 177         return ret;
 178 }
 179
 180 static int musb_ulpi_write(struct usb_phy *phy, u32 offset, u32 data)
 181 {
 182         void __iomem *addr = phy->io_priv;
 183         int     i = 0;
 184         u8      r = 0;
 185         u8      power;
 186         int     ret = 0;
 187
 188         pm_runtime_get_sync(phy->io_dev);
 189
 190         /* Make sure the transceiver is not in low power mode */
 191         power = musb_readb(addr, MUSB_POWER);
 192         power &= ~MUSB_POWER_SUSPENDM;
 193         musb_writeb(addr, MUSB_POWER, power);
 194
 195         musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
 196         musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)data);
 197         musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
 198
 199         while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 200                                 & MUSB_ULPI_REG_CMPLT)) {
 201                 i++;
 202                 if (i == 10000) {
 203                         ret = -ETIMEDOUT;
 204                         goto out;
 205                 }
 206         }
 207
 208         r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 209         r &= ~MUSB_ULPI_REG_CMPLT;
 210         musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 211
 212 out:
 213         pm_runtime_put(phy->io_dev);
 214
 215         return ret;
 216 }
 217 #else
 218 #define musb_ulpi_read          NULL
 219 #define musb_ulpi_write         NULL
 220 #endif
 221
 222 static struct usb_phy_io_ops musb_ulpi_access = {
 223         .read = musb_ulpi_read,
 224         .write = musb_ulpi_write,
 225 };
 226
 227 /*-------------------------------------------------------------------------*/
 228
 229 #if !defined(CONFIG_USB_MUSB_TUSB6010) && !defined(CONFIG_USB_MUSB_BLACKFIN)
 230
 231 /*
 232  * Load an endpoint's FIFO
 233  */
 234 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
 235 {
 236         struct musb *musb = hw_ep->musb;
 237         void __iomem *fifo = hw_ep->fifo;
 238
 239         if (unlikely(len == 0))
 240                 return;
 241
 242         prefetch((u8 *)src);
 243
 244         dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 245                         'T', hw_ep->epnum, fifo, len, src);
 246
 247         /* we can't assume unaligned reads work */
 248         if (likely((0x01 & (unsigned long) src) == 0)) {
 249                 u16     index = 0;
 250
 251                 /* best case is 32bit-aligned source address */
 252                 if ((0x02 & (unsigned long) src) == 0) {
 253                         if (len >= 4) {
 254                                 iowrite32_rep(fifo, src + index, len >> 2);
 255                                 index += len & ~0x03;
 256                         }
 257                         if (len & 0x02) {
 258                                 musb_writew(fifo, 0, *(u16 *)&src[index]);
 259                                 index += 2;
 260                         }
 261                 } else {
 262                         if (len >= 2) {
 263                                 iowrite16_rep(fifo, src + index, len >> 1);
 264                                 index += len & ~0x01;
 265                         }
 266                 }
 267                 if (len & 0x01)
 268                         musb_writeb(fifo, 0, src[index]);
 269         } else  {
 270                 /* byte aligned */
 271                 iowrite8_rep(fifo, src, len);
 272         }
 273 }
 274
 275 #if !defined(CONFIG_USB_MUSB_AM35X)
 276 /*
 277  * Unload an endpoint's FIFO
 278  */
 279 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 280 {
 281         struct musb *musb = hw_ep->musb;
 282         void __iomem *fifo = hw_ep->fifo;
 283
 284         if (unlikely(len == 0))
 285                 return;
 286
 287         dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 288                         'R', hw_ep->epnum, fifo, len, dst);
 289
 290         /* we can't assume unaligned writes work */
 291         if (likely((0x01 & (unsigned long) dst) == 0)) {
 292                 u16     index = 0;
 293
 294                 /* best case is 32bit-aligned destination address */
 295                 if ((0x02 & (unsigned long) dst) == 0) {
 296                         if (len >= 4) {
 297                                 ioread32_rep(fifo, dst, len >> 2);
 298                                 index = len & ~0x03;
 299                         }
 300                         if (len & 0x02) {
 301                                 *(u16 *)&dst[index] = musb_readw(fifo, 0);
 302                                 index += 2;
 303                         }
 304                 } else {
 305                         if (len >= 2) {
 306                                 ioread16_rep(fifo, dst, len >> 1);
 307                                 index = len & ~0x01;
 308                         }
 309                 }
 310                 if (len & 0x01)
 311                         dst[index] = musb_readb(fifo, 0);
 312         } else  {
 313                 /* byte aligned */
 314                 ioread8_rep(fifo, dst, len);
 315         }
 316 }
 317 #endif
 318
 319 #endif  /* normal PIO */
 320
 321
 322 /*-------------------------------------------------------------------------*/
 323
 324 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
 325 static const u8 musb_test_packet[53] = {
 326         /* implicit SYNC then DATA0 to start */
 327
 328         /* JKJKJKJK x9 */
 329         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 330         /* JJKKJJKK x8 */
 331         0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
 332         /* JJJJKKKK x8 */
 333         0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
 334         /* JJJJJJJKKKKKKK x8 */
 335         0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 336         /* JJJJJJJK x8 */
 337         0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
 338         /* JKKKKKKK x10, JK */
 339         0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
 340
 341         /* implicit CRC16 then EOP to end */
 342 };
 343
 344 void musb_load_testpacket(struct musb *musb)
 345 {
 346         void __iomem    *regs = musb->endpoints[0].regs;
 347
 348         musb_ep_select(musb->mregs, 0);
 349         musb_write_fifo(musb->control_ep,
 350                         sizeof(musb_test_packet), musb_test_packet);
 351         musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
 352 }
 353
 354 /*-------------------------------------------------------------------------*/
 355
 356 /*
 357  * Handles OTG hnp timeouts, such as b_ase0_brst
 358  */
 359 static void musb_otg_timer_func(unsigned long data)
 360 {
 361         struct musb     *musb = (struct musb *)data;
 362         unsigned long   flags;
 363
 364         spin_lock_irqsave(&musb->lock, flags);
 365         switch (musb->xceiv->state) {
 366         case OTG_STATE_B_WAIT_ACON:
 367                 dev_dbg(musb->controller, "HNP: b_wait_acon timeout; back to b_peripheral\n");
 368                 musb_g_disconnect(musb);
 369                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 370                 musb->is_active = 0;
 371                 break;
 372         case OTG_STATE_A_SUSPEND:
 373         case OTG_STATE_A_WAIT_BCON:
 374                 dev_dbg(musb->controller, "HNP: %s timeout\n",
 375                         usb_otg_state_string(musb->xceiv->state));
 376                 musb_platform_set_vbus(musb, 0);
 377                 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
 378                 break;
 379         default:
 380                 dev_dbg(musb->controller, "HNP: Unhandled mode %s\n",
 381                         usb_otg_state_string(musb->xceiv->state));
 382         }
 383         musb->ignore_disconnect = 0;
 384         spin_unlock_irqrestore(&musb->lock, flags);
 385 }
 386
 387 /*
 388  * Stops the HNP transition. Caller must take care of locking.
 389  */
 390 void musb_hnp_stop(struct musb *musb)
 391 {
 392         struct usb_hcd  *hcd = musb_to_hcd(musb);
 393         void __iomem    *mbase = musb->mregs;
 394         u8      reg;
 395
 396         dev_dbg(musb->controller, "HNP: stop from %s\n",
 397                         usb_otg_state_string(musb->xceiv->state));
 398
 399         switch (musb->xceiv->state) {
 400         case OTG_STATE_A_PERIPHERAL:
 401                 musb_g_disconnect(musb);
 402                 dev_dbg(musb->controller, "HNP: back to %s\n",
 403                         usb_otg_state_string(musb->xceiv->state));
 404                 break;
 405         case OTG_STATE_B_HOST:
 406                 dev_dbg(musb->controller, "HNP: Disabling HR\n");
 407                 hcd->self.is_b_host = 0;
 408                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 409                 MUSB_DEV_MODE(musb);
 410                 reg = musb_readb(mbase, MUSB_POWER);
 411                 reg |= MUSB_POWER_SUSPENDM;
 412                 musb_writeb(mbase, MUSB_POWER, reg);
 413                 /* REVISIT: Start SESSION_REQUEST here? */
 414                 break;
 415         default:
 416                 dev_dbg(musb->controller, "HNP: Stopping in unknown state %s\n",
 417                         usb_otg_state_string(musb->xceiv->state));
 418         }
 419
 420         /*
 421          * When returning to A state after HNP, avoid hub_port_rebounce(),
 422          * which cause occasional OPT A "Did not receive reset after connect"
 423          * errors.
 424          */
 425         musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
 426 }
 427
 428 /*
 429  * Interrupt Service Routine to record USB "global" interrupts.
 430  * Since these do not happen often and signify things of
 431  * paramount importance, it seems OK to check them individually;
 432  * the order of the tests is specified in the manual
 433  *
 434  * @param musb instance pointer
 435  * @param int_usb register contents
 436  * @param devctl
 437  * @param power
 438  */
 439
 440 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
 441                                 u8 devctl)
 442 {
 443         irqreturn_t handled = IRQ_NONE;
 444
 445         dev_dbg(musb->controller, "<== DevCtl=%02x, int_usb=0x%x\n", devctl,
 446                 int_usb);
 447
 448         /* in host mode, the peripheral may issue remote wakeup.
 449          * in peripheral mode, the host may resume the link.
 450          * spurious RESUME irqs happen too, paired with SUSPEND.
 451          */
 452         if (int_usb & MUSB_INTR_RESUME) {
 453                 handled = IRQ_HANDLED;
 454                 dev_dbg(musb->controller, "RESUME (%s)\n", usb_otg_state_string(musb->xceiv->state));
 455
 456                 if (devctl & MUSB_DEVCTL_HM) {
 457                         void __iomem *mbase = musb->mregs;
 458                         u8 power;
 459
 460                         switch (musb->xceiv->state) {
 461                         case OTG_STATE_A_SUSPEND:
 462                                 /* remote wakeup?  later, GetPortStatus
 463                                  * will stop RESUME signaling
 464                                  */
 465
 466                                 power = musb_readb(musb->mregs, MUSB_POWER);
 467                                 if (power & MUSB_POWER_SUSPENDM) {
 468                                         /* spurious */
 469                                         musb->int_usb &= ~MUSB_INTR_SUSPEND;
 470                                         dev_dbg(musb->controller, "Spurious SUSPENDM\n");
 471                                         break;
 472                                 }
 473
 474                                 power &= ~MUSB_POWER_SUSPENDM;
 475                                 musb_writeb(mbase, MUSB_POWER,
 476                                                 power | MUSB_POWER_RESUME);
 477
 478                                 musb->port1_status |=
 479                                                 (USB_PORT_STAT_C_SUSPEND << 16)
 480                                                 | MUSB_PORT_STAT_RESUME;
 481                                 musb->rh_timer = jiffies
 482                                                 + msecs_to_jiffies(20);
 483
 484                                 musb->xceiv->state = OTG_STATE_A_HOST;
 485                                 musb->is_active = 1;
 486                                 usb_hcd_resume_root_hub(musb_to_hcd(musb));
 487                                 break;
 488                         case OTG_STATE_B_WAIT_ACON:
 489                                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 490                                 musb->is_active = 1;
 491                                 MUSB_DEV_MODE(musb);
 492                                 break;
 493                         default:
 494                                 WARNING("bogus %s RESUME (%s)\n",
 495                                         "host",
 496                                         usb_otg_state_string(musb->xceiv->state));
 497                         }
 498                 } else {
 499                         switch (musb->xceiv->state) {
 500                         case OTG_STATE_A_SUSPEND:
 501                                 /* possibly DISCONNECT is upcoming */
 502                                 musb->xceiv->state = OTG_STATE_A_HOST;
 503                                 usb_hcd_resume_root_hub(musb_to_hcd(musb));
 504                                 break;
 505                         case OTG_STATE_B_WAIT_ACON:
 506                         case OTG_STATE_B_PERIPHERAL:
 507                                 /* disconnect while suspended?  we may
 508                                  * not get a disconnect irq...
 509                                  */
 510                                 if ((devctl & MUSB_DEVCTL_VBUS)
 511                                                 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
 512                                                 ) {
 513                                         musb->int_usb |= MUSB_INTR_DISCONNECT;
 514                                         musb->int_usb &= ~MUSB_INTR_SUSPEND;
 515                                         break;
 516                                 }
 517                                 musb_g_resume(musb);
 518                                 break;
 519                         case OTG_STATE_B_IDLE:
 520                                 musb->int_usb &= ~MUSB_INTR_SUSPEND;
 521                                 break;
 522                         default:
 523                                 WARNING("bogus %s RESUME (%s)\n",
 524                                         "peripheral",
 525                                         usb_otg_state_string(musb->xceiv->state));
 526                         }
 527                 }
 528         }
 529
 530         /* see manual for the order of the tests */
 531         if (int_usb & MUSB_INTR_SESSREQ) {
 532                 void __iomem *mbase = musb->mregs;
 533
 534                 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
 535                                 && (devctl & MUSB_DEVCTL_BDEVICE)) {
 536                         dev_dbg(musb->controller, "SessReq while on B state\n");
 537                         return IRQ_HANDLED;
 538                 }
 539
 540                 dev_dbg(musb->controller, "SESSION_REQUEST (%s)\n",
 541                         usb_otg_state_string(musb->xceiv->state));
 542
 543                 /* IRQ arrives from ID pin sense or (later, if VBUS power
 544                  * is removed) SRP.  responses are time critical:
 545                  *  - turn on VBUS (with silicon-specific mechanism)
 546                  *  - go through A_WAIT_VRISE
 547                  *  - ... to A_WAIT_BCON.
 548                  * a_wait_vrise_tmout triggers VBUS_ERROR transitions
 549                  */
 550                 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
 551                 musb->ep0_stage = MUSB_EP0_START;
 552                 musb->xceiv->state = OTG_STATE_A_IDLE;
 553                 MUSB_HST_MODE(musb);
 554                 musb_platform_set_vbus(musb, 1);
 555
 556                 handled = IRQ_HANDLED;
 557         }
 558
 559         if (int_usb & MUSB_INTR_VBUSERROR) {
 560                 int     ignore = 0;
 561
 562                 /* During connection as an A-Device, we may see a short
 563                  * current spikes causing voltage drop, because of cable
 564                  * and peripheral capacitance combined with vbus draw.
 565                  * (So: less common with truly self-powered devices, where
 566                  * vbus doesn't act like a power supply.)
 567                  *
 568                  * Such spikes are short; usually less than ~500 usec, max
 569                  * of ~2 msec.  That is, they're not sustained overcurrent
 570                  * errors, though they're reported using VBUSERROR irqs.
 571                  *
 572                  * Workarounds:  (a) hardware: use self powered devices.
 573                  * (b) software:  ignore non-repeated VBUS errors.
 574                  *
 575                  * REVISIT:  do delays from lots of DEBUG_KERNEL checks
 576                  * make trouble here, keeping VBUS < 4.4V ?
 577                  */
 578                 switch (musb->xceiv->state) {
 579                 case OTG_STATE_A_HOST:
 580                         /* recovery is dicey once we've gotten past the
 581                          * initial stages of enumeration, but if VBUS
 582                          * stayed ok at the other end of the link, and
 583                          * another reset is due (at least for high speed,
 584                          * to redo the chirp etc), it might work OK...
 585                          */
 586                 case OTG_STATE_A_WAIT_BCON:
 587                 case OTG_STATE_A_WAIT_VRISE:
 588                         if (musb->vbuserr_retry) {
 589                                 void __iomem *mbase = musb->mregs;
 590
 591                                 musb->vbuserr_retry--;
 592                                 ignore = 1;
 593                                 devctl |= MUSB_DEVCTL_SESSION;
 594                                 musb_writeb(mbase, MUSB_DEVCTL, devctl);
 595                         } else {
 596                                 musb->port1_status |=
 597                                           USB_PORT_STAT_OVERCURRENT
 598                                         | (USB_PORT_STAT_C_OVERCURRENT << 16);
 599                         }
 600                         break;
 601                 default:
 602                         break;
 603                 }
 604
 605                 dev_printk(ignore ? KERN_DEBUG : KERN_ERR, musb->controller,
 606                                 "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
 607                                 usb_otg_state_string(musb->xceiv->state),
 608                                 devctl,
 609                                 ({ char *s;
 610                                 switch (devctl & MUSB_DEVCTL_VBUS) {
 611                                 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
 612                                         s = "<SessEnd"; break;
 613                                 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
 614                                         s = "<AValid"; break;
 615                                 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
 616                                         s = "<VBusValid"; break;
 617                                 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
 618                                 default:
 619                                         s = "VALID"; break;
 620                                 }; s; }),
 621                                 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
 622                                 musb->port1_status);
 623
 624                 /* go through A_WAIT_VFALL then start a new session */
 625                 if (!ignore)
 626                         musb_platform_set_vbus(musb, 0);
 627                 handled = IRQ_HANDLED;
 628         }
 629
 630         if (int_usb & MUSB_INTR_SUSPEND) {
 631                 dev_dbg(musb->controller, "SUSPEND (%s) devctl %02x\n",
 632                         usb_otg_state_string(musb->xceiv->state), devctl);
 633                 handled = IRQ_HANDLED;
 634
 635                 switch (musb->xceiv->state) {
 636                 case OTG_STATE_A_PERIPHERAL:
 637                         /* We also come here if the cable is removed, since
 638                          * this silicon doesn't report ID-no-longer-grounded.
 639                          *
 640                          * We depend on T(a_wait_bcon) to shut us down, and
 641                          * hope users don't do anything dicey during this
 642                          * undesired detour through A_WAIT_BCON.
 643                          */
 644                         musb_hnp_stop(musb);
 645                         usb_hcd_resume_root_hub(musb_to_hcd(musb));
 646                         musb_root_disconnect(musb);
 647                         musb_platform_try_idle(musb, jiffies
 648                                         + msecs_to_jiffies(musb->a_wait_bcon
 649                                                 ? : OTG_TIME_A_WAIT_BCON));
 650
 651                         break;
 652                 case OTG_STATE_B_IDLE:
 653                         if (!musb->is_active)
 654                                 break;
 655                 case OTG_STATE_B_PERIPHERAL:
 656                         musb_g_suspend(musb);
 657                         musb->is_active = musb->g.b_hnp_enable;
 658                         if (musb->is_active) {
 659                                 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
 660                                 dev_dbg(musb->controller, "HNP: Setting timer for b_ase0_brst\n");
 661                                 mod_timer(&musb->otg_timer, jiffies
 662                                         + msecs_to_jiffies(
 663                                                         OTG_TIME_B_ASE0_BRST));
 664                         }
 665                         break;
 666                 case OTG_STATE_A_WAIT_BCON:
 667                         if (musb->a_wait_bcon != 0)
 668                                 musb_platform_try_idle(musb, jiffies
 669                                         + msecs_to_jiffies(musb->a_wait_bcon));
 670                         break;
 671                 case OTG_STATE_A_HOST:
 672                         musb->xceiv->state = OTG_STATE_A_SUSPEND;
 673                         musb->is_active = musb_to_hcd(musb)->self.b_hnp_enable;
 674                         break;
 675                 case OTG_STATE_B_HOST:
 676                         /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
 677                         dev_dbg(musb->controller, "REVISIT: SUSPEND as B_HOST\n");
 678                         break;
 679                 default:
 680                         /* "should not happen" */
 681                         musb->is_active = 0;
 682                         break;
 683                 }
 684         }
 685
 686         if (int_usb & MUSB_INTR_CONNECT) {
 687                 struct usb_hcd *hcd = musb_to_hcd(musb);
 688
 689                 handled = IRQ_HANDLED;
 690                 musb->is_active = 1;
 691
 692                 musb->ep0_stage = MUSB_EP0_START;
 693
 694                 /* flush endpoints when transitioning from Device Mode */
 695                 if (is_peripheral_active(musb)) {
 696                         /* REVISIT HNP; just force disconnect */
 697                 }
 698                 musb->intrtxe = musb->epmask;
 699                 musb_writew(musb->mregs, MUSB_INTRTXE, musb->intrtxe);
 700                 musb->intrrxe = musb->epmask & 0xfffe;
 701                 musb_writew(musb->mregs, MUSB_INTRRXE, musb->intrrxe);
 702                 musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
 703                 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
 704                                         |USB_PORT_STAT_HIGH_SPEED
 705                                         |USB_PORT_STAT_ENABLE
 706                                         );
 707                 musb->port1_status |= USB_PORT_STAT_CONNECTION
 708                                         |(USB_PORT_STAT_C_CONNECTION << 16);
 709
 710                 /* high vs full speed is just a guess until after reset */
 711                 if (devctl & MUSB_DEVCTL_LSDEV)
 712                         musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
 713
 714                 /* indicate new connection to OTG machine */
 715                 switch (musb->xceiv->state) {
 716                 case OTG_STATE_B_PERIPHERAL:
 717                         if (int_usb & MUSB_INTR_SUSPEND) {
 718                                 dev_dbg(musb->controller, "HNP: SUSPEND+CONNECT, now b_host\n");
 719                                 int_usb &= ~MUSB_INTR_SUSPEND;
 720                                 goto b_host;
 721                         } else
 722                                 dev_dbg(musb->controller, "CONNECT as b_peripheral???\n");
 723                         break;
 724                 case OTG_STATE_B_WAIT_ACON:
 725                         dev_dbg(musb->controller, "HNP: CONNECT, now b_host\n");
 726 b_host:
 727                         musb->xceiv->state = OTG_STATE_B_HOST;
 728                         hcd->self.is_b_host = 1;
 729                         musb->ignore_disconnect = 0;
 730                         del_timer(&musb->otg_timer);
 731                         break;
 732                 default:
 733                         if ((devctl & MUSB_DEVCTL_VBUS)
 734                                         == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
 735                                 musb->xceiv->state = OTG_STATE_A_HOST;
 736                                 hcd->self.is_b_host = 0;
 737                         }
 738                         break;
 739                 }
 740
 741                 /* poke the root hub */
 742                 MUSB_HST_MODE(musb);
 743                 if (hcd->status_urb)
 744                         usb_hcd_poll_rh_status(hcd);
 745                 else
 746                         usb_hcd_resume_root_hub(hcd);
 747
 748                 dev_dbg(musb->controller, "CONNECT (%s) devctl %02x\n",
 749                                 usb_otg_state_string(musb->xceiv->state), devctl);
 750         }
 751
 752         if ((int_usb & MUSB_INTR_DISCONNECT) && !musb->ignore_disconnect) {
 753                 dev_dbg(musb->controller, "DISCONNECT (%s) as %s, devctl %02x\n",
 754                                 usb_otg_state_string(musb->xceiv->state),
 755                                 MUSB_MODE(musb), devctl);
 756                 handled = IRQ_HANDLED;
 757
 758                 switch (musb->xceiv->state) {
 759                 case OTG_STATE_A_HOST:
 760                 case OTG_STATE_A_SUSPEND:
 761                         usb_hcd_resume_root_hub(musb_to_hcd(musb));
 762                         musb_root_disconnect(musb);
 763                         if (musb->a_wait_bcon != 0)
 764                                 musb_platform_try_idle(musb, jiffies
 765                                         + msecs_to_jiffies(musb->a_wait_bcon));
 766                         break;
 767                 case OTG_STATE_B_HOST:
 768                         /* REVISIT this behaves for "real disconnect"
 769                          * cases; make sure the other transitions from
 770                          * from B_HOST act right too.  The B_HOST code
 771                          * in hnp_stop() is currently not used...
 772                          */
 773                         musb_root_disconnect(musb);
 774                         musb_to_hcd(musb)->self.is_b_host = 0;
 775                         musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 776                         MUSB_DEV_MODE(musb);
 777                         musb_g_disconnect(musb);
 778                         break;
 779                 case OTG_STATE_A_PERIPHERAL:
 780                         musb_hnp_stop(musb);
 781                         musb_root_disconnect(musb);
 782                         /* FALLTHROUGH */
 783                 case OTG_STATE_B_WAIT_ACON:
 784                         /* FALLTHROUGH */
 785                 case OTG_STATE_B_PERIPHERAL:
 786                 case OTG_STATE_B_IDLE:
 787                         musb_g_disconnect(musb);
 788                         break;
 789                 default:
 790                         WARNING("unhandled DISCONNECT transition (%s)\n",
 791                                 usb_otg_state_string(musb->xceiv->state));
 792                         break;
 793                 }
 794         }
 795
 796         /* mentor saves a bit: bus reset and babble share the same irq.
 797          * only host sees babble; only peripheral sees bus reset.
 798          */
 799         if (int_usb & MUSB_INTR_RESET) {
 800                 handled = IRQ_HANDLED;
 801                 if ((devctl & MUSB_DEVCTL_HM) != 0) {
 802                         /*
 803                          * Looks like non-HS BABBLE can be ignored, but
 804                          * HS BABBLE is an error condition. For HS the solution
 805                          * is to avoid babble in the first place and fix what
 806                          * caused BABBLE. When HS BABBLE happens we can only
 807                          * stop the session.
 808                          */
 809                         if (devctl & (MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV))
 810                                 dev_dbg(musb->controller, "BABBLE devctl: %02x\n", devctl);
 811                         else {
 812                                 ERR("Stopping host session -- babble\n");
 813                                 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
 814                         }
 815                 } else {
 816                         dev_dbg(musb->controller, "BUS RESET as %s\n",
 817                                 usb_otg_state_string(musb->xceiv->state));
 818                         switch (musb->xceiv->state) {
 819                         case OTG_STATE_A_SUSPEND:
 820                                 /* We need to ignore disconnect on suspend
 821                                  * otherwise tusb 2.0 won't reconnect after a
 822                                  * power cycle, which breaks otg compliance.
 823                                  */
 824                                 musb->ignore_disconnect = 1;
 825                                 musb_g_reset(musb);
 826                                 /* FALLTHROUGH */
 827                         case OTG_STATE_A_WAIT_BCON:     /* OPT TD.4.7-900ms */
 828                                 /* never use invalid T(a_wait_bcon) */
 829                                 dev_dbg(musb->controller, "HNP: in %s, %d msec timeout\n",
 830                                         usb_otg_state_string(musb->xceiv->state),
 831                                         TA_WAIT_BCON(musb));
 832                                 mod_timer(&musb->otg_timer, jiffies
 833                                         + msecs_to_jiffies(TA_WAIT_BCON(musb)));
 834                                 break;
 835                         case OTG_STATE_A_PERIPHERAL:
 836                                 musb->ignore_disconnect = 0;
 837                                 del_timer(&musb->otg_timer);
 838                                 musb_g_reset(musb);
 839                                 break;
 840                         case OTG_STATE_B_WAIT_ACON:
 841                                 dev_dbg(musb->controller, "HNP: RESET (%s), to b_peripheral\n",
 842                                         usb_otg_state_string(musb->xceiv->state));
 843                                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 844                                 musb_g_reset(musb);
 845                                 break;
 846                         case OTG_STATE_B_IDLE:
 847                                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
 848                                 /* FALLTHROUGH */
 849                         case OTG_STATE_B_PERIPHERAL:
 850                                 musb_g_reset(musb);
 851                                 break;
 852                         default:
 853                                 dev_dbg(musb->controller, "Unhandled BUS RESET as %s\n",
 854                                         usb_otg_state_string(musb->xceiv->state));
 855                         }
 856                 }
 857         }
 858
 859 #if 0
 860 /* REVISIT ... this would be for multiplexing periodic endpoints, or
 861  * supporting transfer phasing to prevent exceeding ISO bandwidth
 862  * limits of a given frame or microframe.
 863  *
 864  * It's not needed for peripheral side, which dedicates endpoints;
 865  * though it _might_ use SOF irqs for other purposes.
 866  *
 867  * And it's not currently needed for host side, which also dedicates
 868  * endpoints, relies on TX/RX interval registers, and isn't claimed
 869  * to support ISO transfers yet.
 870  */
 871         if (int_usb & MUSB_INTR_SOF) {
 872                 void __iomem *mbase = musb->mregs;
 873                 struct musb_hw_ep       *ep;
 874                 u8 epnum;
 875                 u16 frame;
 876
 877                 dev_dbg(musb->controller, "START_OF_FRAME\n");
 878                 handled = IRQ_HANDLED;
 879
 880                 /* start any periodic Tx transfers waiting for current frame */
 881                 frame = musb_readw(mbase, MUSB_FRAME);
 882                 ep = musb->endpoints;
 883                 for (epnum = 1; (epnum < musb->nr_endpoints)
 884                                         && (musb->epmask >= (1 << epnum));
 885                                 epnum++, ep++) {
 886                         /*
 887                          * FIXME handle framecounter wraps (12 bits)
 888                          * eliminate duplicated StartUrb logic
 889                          */
 890                         if (ep->dwWaitFrame >= frame) {
 891                                 ep->dwWaitFrame = 0;
 892                                 pr_debug("SOF --> periodic TX%s on %d\n",
 893                                         ep->tx_channel ? " DMA" : "",
 894                                         epnum);
 895                                 if (!ep->tx_channel)
 896                                         musb_h_tx_start(musb, epnum);
 897                                 else
 898                                         cppi_hostdma_start(musb, epnum);
 899                         }
 900                 }               /* end of for loop */
 901         }
 902 #endif
 903
 904         schedule_work(&musb->irq_work);
 905
 906         return handled;
 907 }
 908
 909 /*-------------------------------------------------------------------------*/
 910
 911 /*
 912 * Program the HDRC to start (enable interrupts, dma, etc.).
 913 */
 914 void musb_start(struct musb *musb)
 915 {
 916         void __iomem    *regs = musb->mregs;
 917         u8              devctl = musb_readb(regs, MUSB_DEVCTL);
 918
 919         dev_dbg(musb->controller, "<== devctl %02x\n", devctl);
 920
 921         /*  Set INT enable registers, enable interrupts */
 922         musb->intrtxe = musb->epmask;
 923         musb_writew(regs, MUSB_INTRTXE, musb->intrtxe);
 924         musb->intrrxe = musb->epmask & 0xfffe;
 925         musb_writew(regs, MUSB_INTRRXE, musb->intrrxe);
 926         musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
 927
 928         musb_writeb(regs, MUSB_TESTMODE, 0);
 929
 930         /* put into basic highspeed mode and start session */
 931         musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
 932                                                 | MUSB_POWER_HSENAB
 933                                                 /* ENSUSPEND wedges tusb */
 934                                                 /* | MUSB_POWER_ENSUSPEND */
 935                                                 );
 936
 937         musb->is_active = 0;
 938         devctl = musb_readb(regs, MUSB_DEVCTL);
 939         devctl &= ~MUSB_DEVCTL_SESSION;
 940
 941         /* session started after:
 942          * (a) ID-grounded irq, host mode;
 943          * (b) vbus present/connect IRQ, peripheral mode;
 944          * (c) peripheral initiates, using SRP
 945          */
 946         if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
 947                 musb->is_active = 1;
 948         else
 949                 devctl |= MUSB_DEVCTL_SESSION;
 950
 951         musb_platform_enable(musb);
 952         musb_writeb(regs, MUSB_DEVCTL, devctl);
 953 }
 954
 955
 956 static void musb_generic_disable(struct musb *musb)
 957 {
 958         void __iomem    *mbase = musb->mregs;
 959         u16     temp;
 960
 961         /* disable interrupts */
 962         musb_writeb(mbase, MUSB_INTRUSBE, 0);
 963         musb->intrtxe = 0;
 964         musb_writew(mbase, MUSB_INTRTXE, 0);
 965         musb->intrrxe = 0;
 966         musb_writew(mbase, MUSB_INTRRXE, 0);
 967
 968         /* off */
 969         musb_writeb(mbase, MUSB_DEVCTL, 0);
 970
 971         /*  flush pending interrupts */
 972         temp = musb_readb(mbase, MUSB_INTRUSB);
 973         temp = musb_readw(mbase, MUSB_INTRTX);
 974         temp = musb_readw(mbase, MUSB_INTRRX);
 975
 976 }
 977
 978 /*
 979  * Make the HDRC stop (disable interrupts, etc.);
 980  * reversible by musb_start
 981  * called on gadget driver unregister
 982  * with controller locked, irqs blocked
 983  * acts as a NOP unless some role activated the hardware
 984  */
 985 void musb_stop(struct musb *musb)
 986 {
 987         /* stop IRQs, timers, ... */
 988         musb_platform_disable(musb);
 989         musb_generic_disable(musb);
 990         dev_dbg(musb->controller, "HDRC disabled\n");
 991
 992         /* FIXME
 993          *  - mark host and/or peripheral drivers unusable/inactive
 994          *  - disable DMA (and enable it in HdrcStart)
 995          *  - make sure we can musb_start() after musb_stop(); with
 996          *    OTG mode, gadget driver module rmmod/modprobe cycles that
 997          *  - ...
 998          */
 999         musb_platform_try_idle(musb, 0);
1000 }
1001
1002 static void musb_shutdown(struct platform_device *pdev)
1003 {
1004         struct musb     *musb = dev_to_musb(&pdev->dev);
1005         unsigned long   flags;
1006
1007         pm_runtime_get_sync(musb->controller);
1008
1009         musb_gadget_cleanup(musb);
1010
1011         spin_lock_irqsave(&musb->lock, flags);
1012         musb_platform_disable(musb);
1013         musb_generic_disable(musb);
1014         spin_unlock_irqrestore(&musb->lock, flags);
1015
1016         musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1017         musb_platform_exit(musb);
1018
1019         pm_runtime_put(musb->controller);
1020         /* FIXME power down */
1021 }
1022
1023
1024 /*-------------------------------------------------------------------------*/
1025
1026 /*
1027  * The silicon either has hard-wired endpoint configurations, or else
1028  * "dynamic fifo" sizing.  The driver has support for both, though at this
1029  * writing only the dynamic sizing is very well tested.   Since we switched
1030  * away from compile-time hardware parameters, we can no longer rely on
1031  * dead code elimination to leave only the relevant one in the object file.
1032  *
1033  * We don't currently use dynamic fifo setup capability to do anything
1034  * more than selecting one of a bunch of predefined configurations.
1035  */
1036 #if defined(CONFIG_USB_MUSB_TUSB6010)                   \
1037         || defined(CONFIG_USB_MUSB_TUSB6010_MODULE)     \
1038         || defined(CONFIG_USB_MUSB_OMAP2PLUS)           \
1039         || defined(CONFIG_USB_MUSB_OMAP2PLUS_MODULE)    \
1040         || defined(CONFIG_USB_MUSB_AM35X)               \
1041         || defined(CONFIG_USB_MUSB_AM35X_MODULE)        \
1042         || defined(CONFIG_USB_MUSB_DSPS)                \
1043         || defined(CONFIG_USB_MUSB_DSPS_MODULE)
1044 static ushort fifo_mode = 4;
1045 #elif defined(CONFIG_USB_MUSB_UX500)                    \
1046         || defined(CONFIG_USB_MUSB_UX500_MODULE)
1047 static ushort fifo_mode = 5;
1048 #else
1049 static ushort fifo_mode = 2;
1050 #endif
1051
1052 /* "modprobe ... fifo_mode=1" etc */
1053 module_param(fifo_mode, ushort, 0);
1054 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1055
1056 /*
1057  * tables defining fifo_mode values.  define more if you like.
1058  * for host side, make sure both halves of ep1 are set up.
1059  */
1060
1061 /* mode 0 - fits in 2KB */
1062 static struct musb_fifo_cfg mode_0_cfg[] = {
1063 { .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1064 { .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1065 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1066 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1067 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1068 };
1069
1070 /* mode 1 - fits in 4KB */
1071 static struct musb_fifo_cfg mode_1_cfg[] = {
1072 { .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1073 { .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1074 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1075 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1076 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1077 };
1078
1079 /* mode 2 - fits in 4KB */
1080 static struct musb_fifo_cfg mode_2_cfg[] = {
1081 { .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1082 { .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1083 { .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1084 { .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1085 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1086 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1087 };
1088
1089 /* mode 3 - fits in 4KB */
1090 static struct musb_fifo_cfg mode_3_cfg[] = {
1091 { .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1092 { .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1093 { .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1094 { .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1095 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1096 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1097 };
1098
1099 /* mode 4 - fits in 16KB */
1100 static struct musb_fifo_cfg mode_4_cfg[] = {
1101 { .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1102 { .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1103 { .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1104 { .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1105 { .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1106 { .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1107 { .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1108 { .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1109 { .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1110 { .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1111 { .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 512, },
1112 { .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 512, },
1113 { .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 512, },
1114 { .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 512, },
1115 { .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 512, },
1116 { .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 512, },
1117 { .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 512, },
1118 { .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 512, },
1119 { .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 256, },
1120 { .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 64, },
1121 { .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 256, },
1122 { .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 64, },
1123 { .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 256, },
1124 { .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 64, },
1125 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1126 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1127 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1128 };
1129
1130 /* mode 5 - fits in 8KB */
1131 static struct musb_fifo_cfg mode_5_cfg[] = {
1132 { .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1133 { .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1134 { .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1135 { .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1136 { .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1137 { .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1138 { .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1139 { .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1140 { .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1141 { .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1142 { .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 32, },
1143 { .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 32, },
1144 { .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 32, },
1145 { .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 32, },
1146 { .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 32, },
1147 { .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 32, },
1148 { .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 32, },
1149 { .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 32, },
1150 { .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 32, },
1151 { .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 32, },
1152 { .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 32, },
1153 { .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 32, },
1154 { .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 32, },
1155 { .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 32, },
1156 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1157 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1158 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1159 };
1160
1161 /*
1162  * configure a fifo; for non-shared endpoints, this may be called
1163  * once for a tx fifo and once for an rx fifo.
1164  *
1165  * returns negative errno or offset for next fifo.
1166  */
1167 static int
1168 fifo_setup(struct musb *musb, struct musb_hw_ep  *hw_ep,
1169                 const struct musb_fifo_cfg *cfg, u16 offset)
1170 {
1171         void __iomem    *mbase = musb->mregs;
1172         int     size = 0;
1173         u16     maxpacket = cfg->maxpacket;
1174         u16     c_off = offset >> 3;
1175         u8      c_size;
1176
1177         /* expect hw_ep has already been zero-initialized */
1178
1179         size = ffs(max(maxpacket, (u16) 8)) - 1;
1180         maxpacket = 1 << size;
1181
1182         c_size = size - 3;
1183         if (cfg->mode == BUF_DOUBLE) {
1184                 if ((offset + (maxpacket << 1)) >
1185                                 (1 << (musb->config->ram_bits + 2)))
1186                         return -EMSGSIZE;
1187                 c_size |= MUSB_FIFOSZ_DPB;
1188         } else {
1189                 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1190                         return -EMSGSIZE;
1191         }
1192
1193         /* configure the FIFO */
1194         musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1195
1196         /* EP0 reserved endpoint for control, bidirectional;
1197          * EP1 reserved for bulk, two unidirection halves.
1198          */
1199         if (hw_ep->epnum == 1)
1200                 musb->bulk_ep = hw_ep;
1201         /* REVISIT error check:  be sure ep0 can both rx and tx ... */
1202         switch (cfg->style) {
1203         case FIFO_TX:
1204                 musb_write_txfifosz(mbase, c_size);
1205                 musb_write_txfifoadd(mbase, c_off);
1206                 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1207                 hw_ep->max_packet_sz_tx = maxpacket;
1208                 break;
1209         case FIFO_RX:
1210                 musb_write_rxfifosz(mbase, c_size);
1211                 musb_write_rxfifoadd(mbase, c_off);
1212                 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1213                 hw_ep->max_packet_sz_rx = maxpacket;
1214                 break;
1215         case FIFO_RXTX:
1216                 musb_write_txfifosz(mbase, c_size);
1217                 musb_write_txfifoadd(mbase, c_off);
1218                 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1219                 hw_ep->max_packet_sz_rx = maxpacket;
1220
1221                 musb_write_rxfifosz(mbase, c_size);
1222                 musb_write_rxfifoadd(mbase, c_off);
1223                 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1224                 hw_ep->max_packet_sz_tx = maxpacket;
1225
1226                 hw_ep->is_shared_fifo = true;
1227                 break;
1228         }
1229
1230         /* NOTE rx and tx endpoint irqs aren't managed separately,
1231          * which happens to be ok
1232          */
1233         musb->epmask |= (1 << hw_ep->epnum);
1234
1235         return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1236 }
1237
1238 static struct musb_fifo_cfg ep0_cfg = {
1239         .style = FIFO_RXTX, .maxpacket = 64,
1240 };
1241
1242 static int ep_config_from_table(struct musb *musb)
1243 {
1244         const struct musb_fifo_cfg      *cfg;
1245         unsigned                i, n;
1246         int                     offset;
1247         struct musb_hw_ep       *hw_ep = musb->endpoints;
1248
1249         if (musb->config->fifo_cfg) {
1250                 cfg = musb->config->fifo_cfg;
1251                 n = musb->config->fifo_cfg_size;
1252                 goto done;
1253         }
1254
1255         switch (fifo_mode) {
1256         default:
1257                 fifo_mode = 0;
1258                 /* FALLTHROUGH */
1259         case 0:
1260                 cfg = mode_0_cfg;
1261                 n = ARRAY_SIZE(mode_0_cfg);
1262                 break;
1263         case 1:
1264                 cfg = mode_1_cfg;
1265                 n = ARRAY_SIZE(mode_1_cfg);
1266                 break;
1267         case 2:
1268                 cfg = mode_2_cfg;
1269                 n = ARRAY_SIZE(mode_2_cfg);
1270                 break;
1271         case 3:
1272                 cfg = mode_3_cfg;
1273                 n = ARRAY_SIZE(mode_3_cfg);
1274                 break;
1275         case 4:
1276                 cfg = mode_4_cfg;
1277                 n = ARRAY_SIZE(mode_4_cfg);
1278                 break;
1279         case 5:
1280                 cfg = mode_5_cfg;
1281                 n = ARRAY_SIZE(mode_5_cfg);
1282                 break;
1283         }
1284
1285         printk(KERN_DEBUG "%s: setup fifo_mode %d\n",
1286                         musb_driver_name, fifo_mode);
1287
1288
1289 done:
1290         offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1291         /* assert(offset > 0) */
1292
1293         /* NOTE:  for RTL versions >= 1.400 EPINFO and RAMINFO would
1294          * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1295          */
1296
1297         for (i = 0; i < n; i++) {
1298                 u8      epn = cfg->hw_ep_num;
1299
1300                 if (epn >= musb->config->num_eps) {
1301                         pr_debug("%s: invalid ep %d\n",
1302                                         musb_driver_name, epn);
1303                         return -EINVAL;
1304                 }
1305                 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1306                 if (offset < 0) {
1307                         pr_debug("%s: mem overrun, ep %d\n",
1308                                         musb_driver_name, epn);
1309                         return offset;
1310                 }
1311                 epn++;
1312                 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1313         }
1314
1315         printk(KERN_DEBUG "%s: %d/%d max ep, %d/%d memory\n",
1316                         musb_driver_name,
1317                         n + 1, musb->config->num_eps * 2 - 1,
1318                         offset, (1 << (musb->config->ram_bits + 2)));
1319
1320         if (!musb->bulk_ep) {
1321                 pr_debug("%s: missing bulk\n", musb_driver_name);
1322                 return -EINVAL;
1323         }
1324
1325         return 0;
1326 }
1327
1328
1329 /*
1330  * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1331  * @param musb the controller
1332  */
1333 static int ep_config_from_hw(struct musb *musb)
1334 {
1335         u8 epnum = 0;
1336         struct musb_hw_ep *hw_ep;
1337         void __iomem *mbase = musb->mregs;
1338         int ret = 0;
1339
1340         dev_dbg(musb->controller, "<== static silicon ep config\n");
1341
1342         /* FIXME pick up ep0 maxpacket size */
1343
1344         for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1345                 musb_ep_select(mbase, epnum);
1346                 hw_ep = musb->endpoints + epnum;
1347
1348                 ret = musb_read_fifosize(musb, hw_ep, epnum);
1349                 if (ret < 0)
1350                         break;
1351
1352                 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1353
1354                 /* pick an RX/TX endpoint for bulk */
1355                 if (hw_ep->max_packet_sz_tx < 512
1356                                 || hw_ep->max_packet_sz_rx < 512)
1357                         continue;
1358
1359                 /* REVISIT:  this algorithm is lazy, we should at least
1360                  * try to pick a double buffered endpoint.
1361                  */
1362                 if (musb->bulk_ep)
1363                         continue;
1364                 musb->bulk_ep = hw_ep;
1365         }
1366
1367         if (!musb->bulk_ep) {
1368                 pr_debug("%s: missing bulk\n", musb_driver_name);
1369                 return -EINVAL;
1370         }
1371
1372         return 0;
1373 }
1374
1375 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1376
1377 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1378  * configure endpoints, or take their config from silicon
1379  */
1380 static int musb_core_init(u16 musb_type, struct musb *musb)
1381 {
1382         u8 reg;
1383         char *type;
1384         char aInfo[90], aRevision[32], aDate[12];
1385         void __iomem    *mbase = musb->mregs;
1386         int             status = 0;
1387         int             i;
1388
1389         /* log core options (read using indexed model) */
1390         reg = musb_read_configdata(mbase);
1391
1392         strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1393         if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1394                 strcat(aInfo, ", dyn FIFOs");
1395                 musb->dyn_fifo = true;
1396         }
1397         if (reg & MUSB_CONFIGDATA_MPRXE) {
1398                 strcat(aInfo, ", bulk combine");
1399                 musb->bulk_combine = true;
1400         }
1401         if (reg & MUSB_CONFIGDATA_MPTXE) {
1402                 strcat(aInfo, ", bulk split");
1403                 musb->bulk_split = true;
1404         }
1405         if (reg & MUSB_CONFIGDATA_HBRXE) {
1406                 strcat(aInfo, ", HB-ISO Rx");
1407                 musb->hb_iso_rx = true;
1408         }
1409         if (reg & MUSB_CONFIGDATA_HBTXE) {
1410                 strcat(aInfo, ", HB-ISO Tx");
1411                 musb->hb_iso_tx = true;
1412         }
1413         if (reg & MUSB_CONFIGDATA_SOFTCONE)
1414                 strcat(aInfo, ", SoftConn");
1415
1416         printk(KERN_DEBUG "%s: ConfigData=0x%02x (%s)\n",
1417                         musb_driver_name, reg, aInfo);
1418
1419         aDate[0] = 0;
1420         if (MUSB_CONTROLLER_MHDRC == musb_type) {
1421                 musb->is_multipoint = 1;
1422                 type = "M";
1423         } else {
1424                 musb->is_multipoint = 0;
1425                 type = "";
1426 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1427                 printk(KERN_ERR
1428                         "%s: kernel must blacklist external hubs\n",
1429                         musb_driver_name);
1430 #endif
1431         }
1432
1433         /* log release info */
1434         musb->hwvers = musb_read_hwvers(mbase);
1435         snprintf(aRevision, 32, "%d.%d%s", MUSB_HWVERS_MAJOR(musb->hwvers),
1436                 MUSB_HWVERS_MINOR(musb->hwvers),
1437                 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1438         printk(KERN_DEBUG "%s: %sHDRC RTL version %s %s\n",
1439                         musb_driver_name, type, aRevision, aDate);
1440
1441         /* configure ep0 */
1442         musb_configure_ep0(musb);
1443
1444         /* discover endpoint configuration */
1445         musb->nr_endpoints = 1;
1446         musb->epmask = 1;
1447
1448         if (musb->dyn_fifo)
1449                 status = ep_config_from_table(musb);
1450         else
1451                 status = ep_config_from_hw(musb);
1452
1453         if (status < 0)
1454                 return status;
1455
1456         /* finish init, and print endpoint config */
1457         for (i = 0; i < musb->nr_endpoints; i++) {
1458                 struct musb_hw_ep       *hw_ep = musb->endpoints + i;
1459
1460                 hw_ep->fifo = MUSB_FIFO_OFFSET(i) + mbase;
1461 #if defined(CONFIG_USB_MUSB_TUSB6010) || defined (CONFIG_USB_MUSB_TUSB6010_MODULE)
1462                 hw_ep->fifo_async = musb->async + 0x400 + MUSB_FIFO_OFFSET(i);
1463                 hw_ep->fifo_sync = musb->sync + 0x400 + MUSB_FIFO_OFFSET(i);
1464                 hw_ep->fifo_sync_va =
1465                         musb->sync_va + 0x400 + MUSB_FIFO_OFFSET(i);
1466
1467                 if (i == 0)
1468                         hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1469                 else
1470                         hw_ep->conf = mbase + 0x400 + (((i - 1) & 0xf) << 2);
1471 #endif
1472
1473                 hw_ep->regs = MUSB_EP_OFFSET(i, 0) + mbase;
1474                 hw_ep->target_regs = musb_read_target_reg_base(i, mbase);
1475                 hw_ep->rx_reinit = 1;
1476                 hw_ep->tx_reinit = 1;
1477
1478                 if (hw_ep->max_packet_sz_tx) {
1479                         dev_dbg(musb->controller,
1480                                 "%s: hw_ep %d%s, %smax %d\n",
1481                                 musb_driver_name, i,
1482                                 hw_ep->is_shared_fifo ? "shared" : "tx",
1483                                 hw_ep->tx_double_buffered
1484                                         ? "doublebuffer, " : "",
1485                                 hw_ep->max_packet_sz_tx);
1486                 }
1487                 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1488                         dev_dbg(musb->controller,
1489                                 "%s: hw_ep %d%s, %smax %d\n",
1490                                 musb_driver_name, i,
1491                                 "rx",
1492                                 hw_ep->rx_double_buffered
1493                                         ? "doublebuffer, " : "",
1494                                 hw_ep->max_packet_sz_rx);
1495                 }
1496                 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1497                         dev_dbg(musb->controller, "hw_ep %d not configured\n", i);
1498         }
1499
1500         return 0;
1501 }
1502
1503 /*-------------------------------------------------------------------------*/
1504
1505 /*
1506  * handle all the irqs defined by the HDRC core. for now we expect:  other
1507  * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1508  * will be assigned, and the irq will already have been acked.
1509  *
1510  * called in irq context with spinlock held, irqs blocked
1511  */
1512 irqreturn_t musb_interrupt(struct musb *musb)
1513 {
1514         irqreturn_t     retval = IRQ_NONE;
1515         u8              devctl;
1516         int             ep_num;
1517         u32             reg;
1518
1519         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1520
1521         dev_dbg(musb->controller, "** IRQ %s usb%04x tx%04x rx%04x\n",
1522                 (devctl & MUSB_DEVCTL_HM) ? "host" : "peripheral",
1523                 musb->int_usb, musb->int_tx, musb->int_rx);
1524
1525         /* the core can interrupt us for multiple reasons; docs have
1526          * a generic interrupt flowchart to follow
1527          */
1528         if (musb->int_usb)
1529                 retval |= musb_stage0_irq(musb, musb->int_usb,
1530                                 devctl);
1531
1532         /* "stage 1" is handling endpoint irqs */
1533
1534         /* handle endpoint 0 first */
1535         if (musb->int_tx & 1) {
1536                 if (devctl & MUSB_DEVCTL_HM)
1537                         retval |= musb_h_ep0_irq(musb);
1538                 else
1539                         retval |= musb_g_ep0_irq(musb);
1540         }
1541
1542         /* RX on endpoints 1-15 */
1543         reg = musb->int_rx >> 1;
1544         ep_num = 1;
1545         while (reg) {
1546                 if (reg & 1) {
1547                         /* musb_ep_select(musb->mregs, ep_num); */
1548                         /* REVISIT just retval = ep->rx_irq(...) */
1549                         retval = IRQ_HANDLED;
1550                         if (devctl & MUSB_DEVCTL_HM)
1551                                 musb_host_rx(musb, ep_num);
1552                         else
1553                                 musb_g_rx(musb, ep_num);
1554                 }
1555
1556                 reg >>= 1;
1557                 ep_num++;
1558         }
1559
1560         /* TX on endpoints 1-15 */
1561         reg = musb->int_tx >> 1;
1562         ep_num = 1;
1563         while (reg) {
1564                 if (reg & 1) {
1565                         /* musb_ep_select(musb->mregs, ep_num); */
1566                         /* REVISIT just retval |= ep->tx_irq(...) */
1567                         retval = IRQ_HANDLED;
1568                         if (devctl & MUSB_DEVCTL_HM)
1569                                 musb_host_tx(musb, ep_num);
1570                         else
1571                                 musb_g_tx(musb, ep_num);
1572                 }
1573                 reg >>= 1;
1574                 ep_num++;
1575         }
1576
1577         return retval;
1578 }
1579 EXPORT_SYMBOL_GPL(musb_interrupt);
1580
1581 #ifndef CONFIG_MUSB_PIO_ONLY
1582 static bool use_dma = 1;
1583
1584 /* "modprobe ... use_dma=0" etc */
1585 module_param(use_dma, bool, 0);
1586 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1587
1588 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1589 {
1590         u8      devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1591
1592         /* called with controller lock already held */
1593
1594         if (!epnum) {
1595 #ifndef CONFIG_USB_TUSB_OMAP_DMA
1596                 if (!is_cppi_enabled()) {
1597                         /* endpoint 0 */
1598                         if (devctl & MUSB_DEVCTL_HM)
1599                                 musb_h_ep0_irq(musb);
1600                         else
1601                                 musb_g_ep0_irq(musb);
1602                 }
1603 #endif
1604         } else {
1605                 /* endpoints 1..15 */
1606                 if (transmit) {
1607                         if (devctl & MUSB_DEVCTL_HM)
1608                                 musb_host_tx(musb, epnum);
1609                         else
1610                                 musb_g_tx(musb, epnum);
1611                 } else {
1612                         /* receive */
1613                         if (devctl & MUSB_DEVCTL_HM)
1614                                 musb_host_rx(musb, epnum);
1615                         else
1616                                 musb_g_rx(musb, epnum);
1617                 }
1618         }
1619 }
1620 EXPORT_SYMBOL_GPL(musb_dma_completion);
1621
1622 #else
1623 #define use_dma                 0
1624 #endif
1625
1626 /*-------------------------------------------------------------------------*/
1627
1628 static ssize_t
1629 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1630 {
1631         struct musb *musb = dev_to_musb(dev);
1632         unsigned long flags;
1633         int ret = -EINVAL;
1634
1635         spin_lock_irqsave(&musb->lock, flags);
1636         ret = sprintf(buf, "%s\n", usb_otg_state_string(musb->xceiv->state));
1637         spin_unlock_irqrestore(&musb->lock, flags);
1638
1639         return ret;
1640 }
1641
1642 static ssize_t
1643 musb_mode_store(struct device *dev, struct device_attribute *attr,
1644                 const char *buf, size_t n)
1645 {
1646         struct musb     *musb = dev_to_musb(dev);
1647         unsigned long   flags;
1648         int             status;
1649
1650         spin_lock_irqsave(&musb->lock, flags);
1651         if (sysfs_streq(buf, "host"))
1652                 status = musb_platform_set_mode(musb, MUSB_HOST);
1653         else if (sysfs_streq(buf, "peripheral"))
1654                 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1655         else if (sysfs_streq(buf, "otg"))
1656                 status = musb_platform_set_mode(musb, MUSB_OTG);
1657         else
1658                 status = -EINVAL;
1659         spin_unlock_irqrestore(&musb->lock, flags);
1660
1661         return (status == 0) ? n : status;
1662 }
1663 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1664
1665 static ssize_t
1666 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1667                 const char *buf, size_t n)
1668 {
1669         struct musb     *musb = dev_to_musb(dev);
1670         unsigned long   flags;
1671         unsigned long   val;
1672
1673         if (sscanf(buf, "%lu", &val) < 1) {
1674                 dev_err(dev, "Invalid VBUS timeout ms value\n");
1675                 return -EINVAL;
1676         }
1677
1678         spin_lock_irqsave(&musb->lock, flags);
1679         /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1680         musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1681         if (musb->xceiv->state == OTG_STATE_A_WAIT_BCON)
1682                 musb->is_active = 0;
1683         musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1684         spin_unlock_irqrestore(&musb->lock, flags);
1685
1686         return n;
1687 }
1688
1689 static ssize_t
1690 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1691 {
1692         struct musb     *musb = dev_to_musb(dev);
1693         unsigned long   flags;
1694         unsigned long   val;
1695         int             vbus;
1696
1697         spin_lock_irqsave(&musb->lock, flags);
1698         val = musb->a_wait_bcon;
1699         /* FIXME get_vbus_status() is normally #defined as false...
1700          * and is effectively TUSB-specific.
1701          */
1702         vbus = musb_platform_get_vbus_status(musb);
1703         spin_unlock_irqrestore(&musb->lock, flags);
1704
1705         return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1706                         vbus ? "on" : "off", val);
1707 }
1708 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1709
1710 /* Gadget drivers can't know that a host is connected so they might want
1711  * to start SRP, but users can.  This allows userspace to trigger SRP.
1712  */
1713 static ssize_t
1714 musb_srp_store(struct device *dev, struct device_attribute *attr,
1715                 const char *buf, size_t n)
1716 {
1717         struct musb     *musb = dev_to_musb(dev);
1718         unsigned short  srp;
1719
1720         if (sscanf(buf, "%hu", &srp) != 1
1721                         || (srp != 1)) {
1722                 dev_err(dev, "SRP: Value must be 1\n");
1723                 return -EINVAL;
1724         }
1725
1726         if (srp == 1)
1727                 musb_g_wakeup(musb);
1728
1729         return n;
1730 }
1731 static DEVICE_ATTR(srp, 0644, NULL, musb_srp_store);
1732
1733 static struct attribute *musb_attributes[] = {
1734         &dev_attr_mode.attr,
1735         &dev_attr_vbus.attr,
1736         &dev_attr_srp.attr,
1737         NULL
1738 };
1739
1740 static const struct attribute_group musb_attr_group = {
1741         .attrs = musb_attributes,
1742 };
1743
1744 /* Only used to provide driver mode change events */
1745 static void musb_irq_work(struct work_struct *data)
1746 {
1747         struct musb *musb = container_of(data, struct musb, irq_work);
1748
1749         if (musb->xceiv->state != musb->xceiv_old_state) {
1750                 musb->xceiv_old_state = musb->xceiv->state;
1751                 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1752         }
1753 }
1754
1755 /* --------------------------------------------------------------------------
1756  * Init support
1757  */
1758
1759 static struct musb *allocate_instance(struct device *dev,
1760                 struct musb_hdrc_config *config, void __iomem *mbase)
1761 {
1762         struct musb             *musb;
1763         struct musb_hw_ep       *ep;
1764         int                     epnum;
1765         struct usb_hcd  *hcd;
1766
1767         hcd = usb_create_hcd(&musb_hc_driver, dev, dev_name(dev));
1768         if (!hcd)
1769                 return NULL;
1770         /* usbcore sets dev->driver_data to hcd, and sometimes uses that... */
1771
1772         musb = hcd_to_musb(hcd);
1773         INIT_LIST_HEAD(&musb->control);
1774         INIT_LIST_HEAD(&musb->in_bulk);
1775         INIT_LIST_HEAD(&musb->out_bulk);
1776
1777         hcd->uses_new_polling = 1;
1778         hcd->has_tt = 1;
1779
1780         musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
1781         musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
1782         dev_set_drvdata(dev, musb);
1783         musb->mregs = mbase;
1784         musb->ctrl_base = mbase;
1785         musb->nIrq = -ENODEV;
1786         musb->config = config;
1787         BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
1788         for (epnum = 0, ep = musb->endpoints;
1789                         epnum < musb->config->num_eps;
1790                         epnum++, ep++) {
1791                 ep->musb = musb;
1792                 ep->epnum = epnum;
1793         }
1794
1795         musb->controller = dev;
1796
1797         return musb;
1798 }
1799
1800 static void musb_free(struct musb *musb)
1801 {
1802         /* this has multiple entry modes. it handles fault cleanup after
1803          * probe(), where things may be partially set up, as well as rmmod
1804          * cleanup after everything's been de-activated.
1805          */
1806
1807 #ifdef CONFIG_SYSFS
1808         sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
1809 #endif
1810
1811         if (musb->nIrq >= 0) {
1812                 if (musb->irq_wake)
1813                         disable_irq_wake(musb->nIrq);
1814                 free_irq(musb->nIrq, musb);
1815         }
1816         if (is_dma_capable() && musb->dma_controller) {
1817                 struct dma_controller   *c = musb->dma_controller;
1818
1819                 (void) c->stop(c);
1820                 dma_controller_destroy(c);
1821         }
1822
1823         usb_put_hcd(musb_to_hcd(musb));
1824 }
1825
1826 /*
1827  * Perform generic per-controller initialization.
1828  *
1829  * @dev: the controller (already clocked, etc)
1830  * @nIrq: IRQ number
1831  * @ctrl: virtual address of controller registers,
1832  *      not yet corrected for platform-specific offsets
1833  */
1834 static int
1835 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
1836 {
1837         int                     status;
1838         struct musb             *musb;
1839         struct musb_hdrc_platform_data *plat = dev->platform_data;
1840         struct usb_hcd          *hcd;
1841
1842         /* The driver might handle more features than the board; OK.
1843          * Fail when the board needs a feature that's not enabled.
1844          */
1845         if (!plat) {
1846                 dev_dbg(dev, "no platform_data?\n");
1847                 status = -ENODEV;
1848                 goto fail0;
1849         }
1850
1851         /* allocate */
1852         musb = allocate_instance(dev, plat->config, ctrl);
1853         if (!musb) {
1854                 status = -ENOMEM;
1855                 goto fail0;
1856         }
1857
1858         pm_runtime_use_autosuspend(musb->controller);
1859         pm_runtime_set_autosuspend_delay(musb->controller, 200);
1860         pm_runtime_enable(musb->controller);
1861
1862         spin_lock_init(&musb->lock);
1863         musb->board_set_power = plat->set_power;
1864         musb->min_power = plat->min_power;
1865         musb->ops = plat->platform_ops;
1866
1867         /* The musb_platform_init() call:
1868          *   - adjusts musb->mregs
1869          *   - sets the musb->isr
1870          *   - may initialize an integrated tranceiver
1871          *   - initializes musb->xceiv, usually by otg_get_phy()
1872          *   - stops powering VBUS
1873          *
1874          * There are various transceiver configurations.  Blackfin,
1875          * DaVinci, TUSB60x0, and others integrate them.  OMAP3 uses
1876          * external/discrete ones in various flavors (twl4030 family,
1877          * isp1504, non-OTG, etc) mostly hooking up through ULPI.
1878          */
1879         status = musb_platform_init(musb);
1880         if (status < 0)
1881                 goto fail1;
1882
1883         if (!musb->isr) {
1884                 status = -ENODEV;
1885                 goto fail2;
1886         }
1887
1888         if (!musb->xceiv->io_ops) {
1889                 musb->xceiv->io_dev = musb->controller;
1890                 musb->xceiv->io_priv = musb->mregs;
1891                 musb->xceiv->io_ops = &musb_ulpi_access;
1892         }
1893
1894         pm_runtime_get_sync(musb->controller);
1895
1896 #ifndef CONFIG_MUSB_PIO_ONLY
1897         if (use_dma && dev->dma_mask) {
1898                 struct dma_controller   *c;
1899
1900                 c = dma_controller_create(musb, musb->mregs);
1901                 musb->dma_controller = c;
1902                 if (c)
1903                         (void) c->start(c);
1904         }
1905 #endif
1906         /* ideally this would be abstracted in platform setup */
1907         if (!is_dma_capable() || !musb->dma_controller)
1908                 dev->dma_mask = NULL;
1909
1910         /* be sure interrupts are disabled before connecting ISR */
1911         musb_platform_disable(musb);
1912         musb_generic_disable(musb);
1913
1914         /* setup musb parts of the core (especially endpoints) */
1915         status = musb_core_init(plat->config->multipoint
1916                         ? MUSB_CONTROLLER_MHDRC
1917                         : MUSB_CONTROLLER_HDRC, musb);
1918         if (status < 0)
1919                 goto fail3;
1920
1921         setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
1922
1923         /* Init IRQ workqueue before request_irq */
1924         INIT_WORK(&musb->irq_work, musb_irq_work);
1925
1926         /* attach to the IRQ */
1927         if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
1928                 dev_err(dev, "request_irq %d failed!\n", nIrq);
1929                 status = -ENODEV;
1930                 goto fail3;
1931         }
1932         musb->nIrq = nIrq;
1933         /* FIXME this handles wakeup irqs wrong */
1934         if (enable_irq_wake(nIrq) == 0) {
1935                 musb->irq_wake = 1;
1936                 device_init_wakeup(dev, 1);
1937         } else {
1938                 musb->irq_wake = 0;
1939         }
1940
1941         /* host side needs more setup */
1942         hcd = musb_to_hcd(musb);
1943         otg_set_host(musb->xceiv->otg, &hcd->self);
1944         hcd->self.otg_port = 1;
1945         musb->xceiv->otg->host = &hcd->self;
1946         hcd->power_budget = 2 * (plat->power ? : 250);
1947
1948         /* program PHY to use external vBus if required */
1949         if (plat->extvbus) {
1950                 u8 busctl = musb_read_ulpi_buscontrol(musb->mregs);
1951                 busctl |= MUSB_ULPI_USE_EXTVBUS;
1952                 musb_write_ulpi_buscontrol(musb->mregs, busctl);
1953         }
1954
1955         if (musb->xceiv->otg->default_a) {
1956                 MUSB_HST_MODE(musb);
1957                 musb->xceiv->state = OTG_STATE_A_IDLE;
1958         } else {
1959                 MUSB_DEV_MODE(musb);
1960                 musb->xceiv->state = OTG_STATE_B_IDLE;
1961         }
1962
1963         status = musb_gadget_setup(musb);
1964
1965         if (status < 0)
1966                 goto fail3;
1967
1968         status = musb_init_debugfs(musb);
1969         if (status < 0)
1970                 goto fail4;
1971
1972         status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
1973         if (status)
1974                 goto fail5;
1975
1976         pm_runtime_put(musb->controller);
1977
1978         return 0;
1979
1980 fail5:
1981         musb_exit_debugfs(musb);
1982
1983 fail4:
1984         musb_gadget_cleanup(musb);
1985
1986 fail3:
1987         pm_runtime_put_sync(musb->controller);
1988
1989 fail2:
1990         if (musb->irq_wake)
1991                 device_init_wakeup(dev, 0);
1992         musb_platform_exit(musb);
1993
1994 fail1:
1995         pm_runtime_disable(musb->controller);
1996         dev_err(musb->controller,
1997                 "musb_init_controller failed with status %d\n", status);
1998
1999         musb_free(musb);
2000
2001 fail0:
2002
2003         return status;
2004
2005 }
2006
2007 /*-------------------------------------------------------------------------*/
2008
2009 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2010  * bridge to a platform device; this driver then suffices.
2011  */
2012 static int musb_probe(struct platform_device *pdev)
2013 {
2014         struct device   *dev = &pdev->dev;
2015         int             irq = platform_get_irq_byname(pdev, "mc");
2016         struct resource *iomem;
2017         void __iomem    *base;
2018
2019         iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2020         if (!iomem || irq <= 0)
2021                 return -ENODEV;
2022
2023         base = devm_ioremap_resource(dev, iomem);
2024         if (IS_ERR(base))
2025                 return PTR_ERR(base);
2026
2027         return musb_init_controller(dev, irq, base);
2028 }
2029
2030 static int musb_remove(struct platform_device *pdev)
2031 {
2032         struct device   *dev = &pdev->dev;
2033         struct musb     *musb = dev_to_musb(dev);
2034
2035         /* this gets called on rmmod.
2036          *  - Host mode: host may still be active
2037          *  - Peripheral mode: peripheral is deactivated (or never-activated)
2038          *  - OTG mode: both roles are deactivated (or never-activated)
2039          */
2040         musb_exit_debugfs(musb);
2041         musb_shutdown(pdev);
2042
2043         musb_free(musb);
2044         device_init_wakeup(dev, 0);
2045 #ifndef CONFIG_MUSB_PIO_ONLY
2046         dma_set_mask(dev, *dev->parent->dma_mask);
2047 #endif
2048         return 0;
2049 }
2050
2051 #ifdef  CONFIG_PM
2052
2053 static void musb_save_context(struct musb *musb)
2054 {
2055         int i;
2056         void __iomem *musb_base = musb->mregs;
2057         void __iomem *epio;
2058
2059         musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2060         musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2061         musb->context.busctl = musb_read_ulpi_buscontrol(musb->mregs);
2062         musb->context.power = musb_readb(musb_base, MUSB_POWER);
2063         musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2064         musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2065         musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2066
2067         for (i = 0; i < musb->config->num_eps; ++i) {
2068                 struct musb_hw_ep       *hw_ep;
2069
2070                 hw_ep = &musb->endpoints[i];
2071                 if (!hw_ep)
2072                         continue;
2073
2074                 epio = hw_ep->regs;
2075                 if (!epio)
2076                         continue;
2077
2078                 musb_writeb(musb_base, MUSB_INDEX, i);
2079                 musb->context.index_regs[i].txmaxp =
2080                         musb_readw(epio, MUSB_TXMAXP);
2081                 musb->context.index_regs[i].txcsr =
2082                         musb_readw(epio, MUSB_TXCSR);
2083                 musb->context.index_regs[i].rxmaxp =
2084                         musb_readw(epio, MUSB_RXMAXP);
2085                 musb->context.index_regs[i].rxcsr =
2086                         musb_readw(epio, MUSB_RXCSR);
2087
2088                 if (musb->dyn_fifo) {
2089                         musb->context.index_regs[i].txfifoadd =
2090                                         musb_read_txfifoadd(musb_base);
2091                         musb->context.index_regs[i].rxfifoadd =
2092                                         musb_read_rxfifoadd(musb_base);
2093                         musb->context.index_regs[i].txfifosz =
2094                                         musb_read_txfifosz(musb_base);
2095                         musb->context.index_regs[i].rxfifosz =
2096                                         musb_read_rxfifosz(musb_base);
2097                 }
2098
2099                 musb->context.index_regs[i].txtype =
2100                         musb_readb(epio, MUSB_TXTYPE);
2101                 musb->context.index_regs[i].txinterval =
2102                         musb_readb(epio, MUSB_TXINTERVAL);
2103                 musb->context.index_regs[i].rxtype =
2104                         musb_readb(epio, MUSB_RXTYPE);
2105                 musb->context.index_regs[i].rxinterval =
2106                         musb_readb(epio, MUSB_RXINTERVAL);
2107
2108                 musb->context.index_regs[i].txfunaddr =
2109                         musb_read_txfunaddr(musb_base, i);
2110                 musb->context.index_regs[i].txhubaddr =
2111                         musb_read_txhubaddr(musb_base, i);
2112                 musb->context.index_regs[i].txhubport =
2113                         musb_read_txhubport(musb_base, i);
2114
2115                 musb->context.index_regs[i].rxfunaddr =
2116                         musb_read_rxfunaddr(musb_base, i);
2117                 musb->context.index_regs[i].rxhubaddr =
2118                         musb_read_rxhubaddr(musb_base, i);
2119                 musb->context.index_regs[i].rxhubport =
2120                         musb_read_rxhubport(musb_base, i);
2121         }
2122 }
2123
2124 static void musb_restore_context(struct musb *musb)
2125 {
2126         int i;
2127         void __iomem *musb_base = musb->mregs;
2128         void __iomem *ep_target_regs;
2129         void __iomem *epio;
2130
2131         musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2132         musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2133         musb_write_ulpi_buscontrol(musb->mregs, musb->context.busctl);
2134         musb_writeb(musb_base, MUSB_POWER, musb->context.power);
2135         musb_writew(musb_base, MUSB_INTRTXE, musb->intrtxe);
2136         musb_writew(musb_base, MUSB_INTRRXE, musb->intrrxe);
2137         musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2138         musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2139
2140         for (i = 0; i < musb->config->num_eps; ++i) {
2141                 struct musb_hw_ep       *hw_ep;
2142
2143                 hw_ep = &musb->endpoints[i];
2144                 if (!hw_ep)
2145                         continue;
2146
2147                 epio = hw_ep->regs;
2148                 if (!epio)
2149                         continue;
2150
2151                 musb_writeb(musb_base, MUSB_INDEX, i);
2152                 musb_writew(epio, MUSB_TXMAXP,
2153                         musb->context.index_regs[i].txmaxp);
2154                 musb_writew(epio, MUSB_TXCSR,
2155                         musb->context.index_regs[i].txcsr);
2156                 musb_writew(epio, MUSB_RXMAXP,
2157                         musb->context.index_regs[i].rxmaxp);
2158                 musb_writew(epio, MUSB_RXCSR,
2159                         musb->context.index_regs[i].rxcsr);
2160
2161                 if (musb->dyn_fifo) {
2162                         musb_write_txfifosz(musb_base,
2163                                 musb->context.index_regs[i].txfifosz);
2164                         musb_write_rxfifosz(musb_base,
2165                                 musb->context.index_regs[i].rxfifosz);
2166                         musb_write_txfifoadd(musb_base,
2167                                 musb->context.index_regs[i].txfifoadd);
2168                         musb_write_rxfifoadd(musb_base,
2169                                 musb->context.index_regs[i].rxfifoadd);
2170                 }
2171
2172                 musb_writeb(epio, MUSB_TXTYPE,
2173                                 musb->context.index_regs[i].txtype);
2174                 musb_writeb(epio, MUSB_TXINTERVAL,
2175                                 musb->context.index_regs[i].txinterval);
2176                 musb_writeb(epio, MUSB_RXTYPE,
2177                                 musb->context.index_regs[i].rxtype);
2178                 musb_writeb(epio, MUSB_RXINTERVAL,
2179
2180                                 musb->context.index_regs[i].rxinterval);
2181                 musb_write_txfunaddr(musb_base, i,
2182                                 musb->context.index_regs[i].txfunaddr);
2183                 musb_write_txhubaddr(musb_base, i,
2184                                 musb->context.index_regs[i].txhubaddr);
2185                 musb_write_txhubport(musb_base, i,
2186                                 musb->context.index_regs[i].txhubport);
2187
2188                 ep_target_regs =
2189                         musb_read_target_reg_base(i, musb_base);
2190
2191                 musb_write_rxfunaddr(ep_target_regs,
2192                                 musb->context.index_regs[i].rxfunaddr);
2193                 musb_write_rxhubaddr(ep_target_regs,
2194                                 musb->context.index_regs[i].rxhubaddr);
2195                 musb_write_rxhubport(ep_target_regs,
2196                                 musb->context.index_regs[i].rxhubport);
2197         }
2198         musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2199 }
2200
2201 static int musb_suspend(struct device *dev)
2202 {
2203         struct musb     *musb = dev_to_musb(dev);
2204         unsigned long   flags;
2205
2206         spin_lock_irqsave(&musb->lock, flags);
2207
2208         if (is_peripheral_active(musb)) {
2209                 /* FIXME force disconnect unless we know USB will wake
2210                  * the system up quickly enough to respond ...
2211                  */
2212         } else if (is_host_active(musb)) {
2213                 /* we know all the children are suspended; sometimes
2214                  * they will even be wakeup-enabled.
2215                  */
2216         }
2217
2218         spin_unlock_irqrestore(&musb->lock, flags);
2219         return 0;
2220 }
2221
2222 static int musb_resume_noirq(struct device *dev)
2223 {
2224         /* for static cmos like DaVinci, register values were preserved
2225          * unless for some reason the whole soc powered down or the USB
2226          * module got reset through the PSC (vs just being disabled).
2227          */
2228         return 0;
2229 }
2230
2231 static int musb_runtime_suspend(struct device *dev)
2232 {
2233         struct musb     *musb = dev_to_musb(dev);
2234
2235         musb_save_context(musb);
2236
2237         return 0;
2238 }
2239
2240 static int musb_runtime_resume(struct device *dev)
2241 {
2242         struct musb     *musb = dev_to_musb(dev);
2243         static int      first = 1;
2244
2245         /*
2246          * When pm_runtime_get_sync called for the first time in driver
2247          * init,  some of the structure is still not initialized which is
2248          * used in restore function. But clock needs to be
2249          * enabled before any register access, so
2250          * pm_runtime_get_sync has to be called.
2251          * Also context restore without save does not make
2252          * any sense
2253          */
2254         if (!first)
2255                 musb_restore_context(musb);
2256         first = 0;
2257
2258         return 0;
2259 }
2260
2261 static const struct dev_pm_ops musb_dev_pm_ops = {
2262         .suspend        = musb_suspend,
2263         .resume_noirq   = musb_resume_noirq,
2264         .runtime_suspend = musb_runtime_suspend,
2265         .runtime_resume = musb_runtime_resume,
2266 };
2267
2268 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2269 #else
2270 #define MUSB_DEV_PM_OPS NULL
2271 #endif
2272
2273 static struct platform_driver musb_driver = {
2274         .driver = {
2275                 .name           = (char *)musb_driver_name,
2276                 .bus            = &platform_bus_type,
2277                 .owner          = THIS_MODULE,
2278                 .pm             = MUSB_DEV_PM_OPS,
2279         },
2280         .probe          = musb_probe,
2281         .remove         = musb_remove,
2282         .shutdown       = musb_shutdown,
2283 };
2284
2285 /*-------------------------------------------------------------------------*/
2286
2287 static int __init musb_init(void)
2288 {
2289         if (usb_disabled())
2290                 return 0;
2291
2292         return platform_driver_register(&musb_driver);
2293 }
2294 module_init(musb_init);
2295
2296 static void __exit musb_cleanup(void)
2297 {
2298         platform_driver_unregister(&musb_driver);
2299 }
2300 module_exit(musb_cleanup);