drivers/usb/musb/plat_uds.c

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