drivers/usb/musb/musb_core.c

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