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