drivers/usb/musb/musb_virthub.c

   1 /*
   2  * MUSB OTG driver virtual root hub support
   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 #include <linux/module.h>
  36 #include <linux/kernel.h>
  37 #include <linux/sched.h>
  38 #include <linux/errno.h>
  39 #include <linux/time.h>
  40 #include <linux/timer.h>
  41
  42 #include <asm/unaligned.h>
  43
  44 #include "musb_core.h"
  45
  46 void musb_host_finish_resume(struct work_struct *work)
  47 {
  48         struct musb *musb;
  49         unsigned long flags;
  50         u8 power;
  51
  52         musb = container_of(work, struct musb, finish_resume_work.work);
  53
  54         spin_lock_irqsave(&musb->lock, flags);
  55
  56         power = musb_readb(musb->mregs, MUSB_POWER);
  57         power &= ~MUSB_POWER_RESUME;
  58         musb_dbg(musb, "root port resume stopped, power %02x", power);
  59         musb_writeb(musb->mregs, MUSB_POWER, power);
  60
  61         /*
  62          * ISSUE:  DaVinci (RTL 1.300) disconnects after
  63          * resume of high speed peripherals (but not full
  64          * speed ones).
  65          */
  66         musb->is_active = 1;
  67         musb->port1_status &= ~(USB_PORT_STAT_SUSPEND | MUSB_PORT_STAT_RESUME);
  68         musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
  69         usb_hcd_poll_rh_status(musb->hcd);
  70         /* NOTE: it might really be A_WAIT_BCON ... */
  71         musb->xceiv->otg->state = OTG_STATE_A_HOST;
  72
  73         spin_unlock_irqrestore(&musb->lock, flags);
  74 }
  75
  76 int musb_port_suspend(struct musb *musb, bool do_suspend)
  77 {
  78         struct usb_otg  *otg = musb->xceiv->otg;
  79         u8              power;
  80         void __iomem    *mbase = musb->mregs;
  81
  82         if (!is_host_active(musb))
  83                 return 0;
  84
  85         /* NOTE:  this doesn't necessarily put PHY into low power mode,
  86          * turning off its clock; that's a function of PHY integration and
  87          * MUSB_POWER_ENSUSPEND.  PHY may need a clock (sigh) to detect
  88          * SE0 changing to connect (J) or wakeup (K) states.
  89          */
  90         power = musb_readb(mbase, MUSB_POWER);
  91         if (do_suspend) {
  92                 int retries = 10000;
  93
  94                 if (power & MUSB_POWER_RESUME)
  95                         return -EBUSY;
  96
  97                 if (!(power & MUSB_POWER_SUSPENDM)) {
  98                         power |= MUSB_POWER_SUSPENDM;
  99                         musb_writeb(mbase, MUSB_POWER, power);
 100
 101                         /* Needed for OPT A tests */
 102                         power = musb_readb(mbase, MUSB_POWER);
 103                         while (power & MUSB_POWER_SUSPENDM) {
 104                                 power = musb_readb(mbase, MUSB_POWER);
 105                                 if (retries-- < 1)
 106                                         break;
 107                         }
 108                 }
 109
 110                 musb_dbg(musb, "Root port suspended, power %02x", power);
 111
 112                 musb->port1_status |= USB_PORT_STAT_SUSPEND;
 113                 switch (musb->xceiv->otg->state) {
 114                 case OTG_STATE_A_HOST:
 115                         musb->xceiv->otg->state = OTG_STATE_A_SUSPEND;
 116                         musb->is_active = otg->host->b_hnp_enable;
 117                         if (musb->is_active)
 118                                 mod_timer(&musb->otg_timer, jiffies
 119                                         + msecs_to_jiffies(
 120                                                 OTG_TIME_A_AIDL_BDIS));
 121                         musb_platform_try_idle(musb, 0);
 122                         break;
 123                 case OTG_STATE_B_HOST:
 124                         musb->xceiv->otg->state = OTG_STATE_B_WAIT_ACON;
 125                         musb->is_active = otg->host->b_hnp_enable;
 126                         musb_platform_try_idle(musb, 0);
 127                         break;
 128                 default:
 129                         musb_dbg(musb, "bogus rh suspend? %s",
 130                                 usb_otg_state_string(musb->xceiv->otg->state));
 131                 }
 132         } else if (power & MUSB_POWER_SUSPENDM) {
 133                 power &= ~MUSB_POWER_SUSPENDM;
 134                 power |= MUSB_POWER_RESUME;
 135                 musb_writeb(mbase, MUSB_POWER, power);
 136
 137                 musb_dbg(musb, "Root port resuming, power %02x", power);
 138
 139                 musb->port1_status |= MUSB_PORT_STAT_RESUME;
 140                 schedule_delayed_work(&musb->finish_resume_work,
 141                                       msecs_to_jiffies(USB_RESUME_TIMEOUT));
 142         }
 143         return 0;
 144 }
 145
 146 void musb_port_reset(struct musb *musb, bool do_reset)
 147 {
 148         u8              power;
 149         void __iomem    *mbase = musb->mregs;
 150
 151         if (musb->xceiv->otg->state == OTG_STATE_B_IDLE) {
 152                 musb_dbg(musb, "HNP: Returning from HNP; no hub reset from b_idle");
 153                 musb->port1_status &= ~USB_PORT_STAT_RESET;
 154                 return;
 155         }
 156
 157         if (!is_host_active(musb))
 158                 return;
 159
 160         /* NOTE:  caller guarantees it will turn off the reset when
 161          * the appropriate amount of time has passed
 162          */
 163         power = musb_readb(mbase, MUSB_POWER);
 164         if (do_reset) {
 165                 /*
 166                  * If RESUME is set, we must make sure it stays minimum 20 ms.
 167                  * Then we must clear RESUME and wait a bit to let musb start
 168                  * generating SOFs. If we don't do this, OPT HS A 6.8 tests
 169                  * fail with "Error! Did not receive an SOF before suspend
 170                  * detected".
 171                  */
 172                 if (power &  MUSB_POWER_RESUME) {
 173                         long remain = (unsigned long) musb->rh_timer - jiffies;
 174
 175                         if (musb->rh_timer > 0 && remain > 0) {
 176                                 /* take into account the minimum delay after resume */
 177                                 schedule_delayed_work(
 178                                         &musb->deassert_reset_work, remain);
 179                                 return;
 180                         }
 181
 182                         musb_writeb(mbase, MUSB_POWER,
 183                                     power & ~MUSB_POWER_RESUME);
 184
 185                         /* Give the core 1 ms to clear MUSB_POWER_RESUME */
 186                         schedule_delayed_work(&musb->deassert_reset_work,
 187                                               msecs_to_jiffies(1));
 188                         return;
 189                 }
 190
 191                 power &= 0xf0;
 192                 musb_writeb(mbase, MUSB_POWER,
 193                                 power | MUSB_POWER_RESET);
 194
 195                 musb->port1_status |= USB_PORT_STAT_RESET;
 196                 musb->port1_status &= ~USB_PORT_STAT_ENABLE;
 197                 schedule_delayed_work(&musb->deassert_reset_work,
 198                                       msecs_to_jiffies(50));
 199         } else {
 200                 musb_dbg(musb, "root port reset stopped");
 201                 musb_platform_pre_root_reset_end(musb);
 202                 musb_writeb(mbase, MUSB_POWER,
 203                                 power & ~MUSB_POWER_RESET);
 204                 musb_platform_post_root_reset_end(musb);
 205
 206                 power = musb_readb(mbase, MUSB_POWER);
 207                 if (power & MUSB_POWER_HSMODE) {
 208                         musb_dbg(musb, "high-speed device connected");
 209                         musb->port1_status |= USB_PORT_STAT_HIGH_SPEED;
 210                 }
 211
 212                 musb->port1_status &= ~USB_PORT_STAT_RESET;
 213                 musb->port1_status |= USB_PORT_STAT_ENABLE
 214                                         | (USB_PORT_STAT_C_RESET << 16)
 215                                         | (USB_PORT_STAT_C_ENABLE << 16);
 216                 usb_hcd_poll_rh_status(musb->hcd);
 217
 218                 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
 219         }
 220 }
 221
 222 void musb_root_disconnect(struct musb *musb)
 223 {
 224         struct usb_otg  *otg = musb->xceiv->otg;
 225
 226         musb->port1_status = USB_PORT_STAT_POWER
 227                         | (USB_PORT_STAT_C_CONNECTION << 16);
 228
 229         usb_hcd_poll_rh_status(musb->hcd);
 230         musb->is_active = 0;
 231
 232         switch (musb->xceiv->otg->state) {
 233         case OTG_STATE_A_SUSPEND:
 234                 if (otg->host->b_hnp_enable) {
 235                         musb->xceiv->otg->state = OTG_STATE_A_PERIPHERAL;
 236                         musb->g.is_a_peripheral = 1;
 237                         break;
 238                 }
 239                 /* FALLTHROUGH */
 240         case OTG_STATE_A_HOST:
 241                 musb->xceiv->otg->state = OTG_STATE_A_WAIT_BCON;
 242                 musb->is_active = 0;
 243                 break;
 244         case OTG_STATE_A_WAIT_VFALL:
 245                 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
 246                 break;
 247         default:
 248                 musb_dbg(musb, "host disconnect (%s)",
 249                         usb_otg_state_string(musb->xceiv->otg->state));
 250         }
 251 }
 252 EXPORT_SYMBOL_GPL(musb_root_disconnect);
 253
 254
 255 /*---------------------------------------------------------------------*/
 256
 257 /* Caller may or may not hold musb->lock */
 258 int musb_hub_status_data(struct usb_hcd *hcd, char *buf)
 259 {
 260         struct musb     *musb = hcd_to_musb(hcd);
 261         int             retval = 0;
 262
 263         /* called in_irq() via usb_hcd_poll_rh_status() */
 264         if (musb->port1_status & 0xffff0000) {
 265                 *buf = 0x02;
 266                 retval = 1;
 267         }
 268         return retval;
 269 }
 270
 271 static int musb_has_gadget(struct musb *musb)
 272 {
 273         /*
 274          * In host-only mode we start a connection right away. In OTG mode
 275          * we have to wait until we loaded a gadget. We don't really need a
 276          * gadget if we operate as a host but we should not start a session
 277          * as a device without a gadget or else we explode.
 278          */
 279 #ifdef CONFIG_USB_MUSB_HOST
 280         return 1;
 281 #else
 282         return musb->port_mode == MUSB_PORT_MODE_HOST;
 283 #endif
 284 }
 285
 286 int musb_hub_control(
 287         struct usb_hcd  *hcd,
 288         u16             typeReq,
 289         u16             wValue,
 290         u16             wIndex,
 291         char            *buf,
 292         u16             wLength)
 293 {
 294         struct musb     *musb = hcd_to_musb(hcd);
 295         u32             temp;
 296         int             retval = 0;
 297         unsigned long   flags;
 298         bool            start_musb = false;
 299
 300         spin_lock_irqsave(&musb->lock, flags);
 301
 302         if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) {
 303                 spin_unlock_irqrestore(&musb->lock, flags);
 304                 return -ESHUTDOWN;
 305         }
 306
 307         /* hub features:  always zero, setting is a NOP
 308          * port features: reported, sometimes updated when host is active
 309          * no indicators
 310          */
 311         switch (typeReq) {
 312         case ClearHubFeature:
 313         case SetHubFeature:
 314                 switch (wValue) {
 315                 case C_HUB_OVER_CURRENT:
 316                 case C_HUB_LOCAL_POWER:
 317                         break;
 318                 default:
 319                         goto error;
 320                 }
 321                 break;
 322         case ClearPortFeature:
 323                 if ((wIndex & 0xff) != 1)
 324                         goto error;
 325
 326                 switch (wValue) {
 327                 case USB_PORT_FEAT_ENABLE:
 328                         break;
 329                 case USB_PORT_FEAT_SUSPEND:
 330                         musb_port_suspend(musb, false);
 331                         break;
 332                 case USB_PORT_FEAT_POWER:
 333                         if (!hcd->self.is_b_host)
 334                                 musb_platform_set_vbus(musb, 0);
 335                         break;
 336                 case USB_PORT_FEAT_C_CONNECTION:
 337                 case USB_PORT_FEAT_C_ENABLE:
 338                 case USB_PORT_FEAT_C_OVER_CURRENT:
 339                 case USB_PORT_FEAT_C_RESET:
 340                 case USB_PORT_FEAT_C_SUSPEND:
 341                         break;
 342                 default:
 343                         goto error;
 344                 }
 345                 musb_dbg(musb, "clear feature %d", wValue);
 346                 musb->port1_status &= ~(1 << wValue);
 347                 break;
 348         case GetHubDescriptor:
 349                 {
 350                 struct usb_hub_descriptor *desc = (void *)buf;
 351
 352                 desc->bDescLength = 9;
 353                 desc->bDescriptorType = USB_DT_HUB;
 354                 desc->bNbrPorts = 1;
 355                 desc->wHubCharacteristics = cpu_to_le16(
 356                         HUB_CHAR_INDV_PORT_LPSM /* per-port power switching */
 357                         | HUB_CHAR_NO_OCPM      /* no overcurrent reporting */
 358                         );
 359                 desc->bPwrOn2PwrGood = 5;       /* msec/2 */
 360                 desc->bHubContrCurrent = 0;
 361
 362                 /* workaround bogus struct definition */
 363                 desc->u.hs.DeviceRemovable[0] = 0x02;   /* port 1 */
 364                 desc->u.hs.DeviceRemovable[1] = 0xff;
 365                 }
 366                 break;
 367         case GetHubStatus:
 368                 temp = 0;
 369                 *(__le32 *) buf = cpu_to_le32(temp);
 370                 break;
 371         case GetPortStatus:
 372                 if (wIndex != 1)
 373                         goto error;
 374
 375                 put_unaligned(cpu_to_le32(musb->port1_status
 376                                         & ~MUSB_PORT_STAT_RESUME),
 377                                 (__le32 *) buf);
 378
 379                 /* port change status is more interesting */
 380                 musb_dbg(musb, "port status %08x", musb->port1_status);
 381                 break;
 382         case SetPortFeature:
 383                 if ((wIndex & 0xff) != 1)
 384                         goto error;
 385
 386                 switch (wValue) {
 387                 case USB_PORT_FEAT_POWER:
 388                         /* NOTE: this controller has a strange state machine
 389                          * that involves "requesting sessions" according to
 390                          * magic side effects from incompletely-described
 391                          * rules about startup...
 392                          *
 393                          * This call is what really starts the host mode; be
 394                          * very careful about side effects if you reorder any
 395                          * initialization logic, e.g. for OTG, or change any
 396                          * logic relating to VBUS power-up.
 397                          */
 398                         if (!hcd->self.is_b_host && musb_has_gadget(musb))
 399                                 start_musb = true;
 400                         break;
 401                 case USB_PORT_FEAT_RESET:
 402                         musb_port_reset(musb, true);
 403                         break;
 404                 case USB_PORT_FEAT_SUSPEND:
 405                         musb_port_suspend(musb, true);
 406                         break;
 407                 case USB_PORT_FEAT_TEST:
 408                         if (unlikely(is_host_active(musb)))
 409                                 goto error;
 410
 411                         wIndex >>= 8;
 412                         switch (wIndex) {
 413                         case 1:
 414                                 pr_debug("TEST_J\n");
 415                                 temp = MUSB_TEST_J;
 416                                 break;
 417                         case 2:
 418                                 pr_debug("TEST_K\n");
 419                                 temp = MUSB_TEST_K;
 420                                 break;
 421                         case 3:
 422                                 pr_debug("TEST_SE0_NAK\n");
 423                                 temp = MUSB_TEST_SE0_NAK;
 424                                 break;
 425                         case 4:
 426                                 pr_debug("TEST_PACKET\n");
 427                                 temp = MUSB_TEST_PACKET;
 428                                 musb_load_testpacket(musb);
 429                                 break;
 430                         case 5:
 431                                 pr_debug("TEST_FORCE_ENABLE\n");
 432                                 temp = MUSB_TEST_FORCE_HOST
 433                                         | MUSB_TEST_FORCE_HS;
 434
 435                                 musb_writeb(musb->mregs, MUSB_DEVCTL,
 436                                                 MUSB_DEVCTL_SESSION);
 437                                 break;
 438                         case 6:
 439                                 pr_debug("TEST_FIFO_ACCESS\n");
 440                                 temp = MUSB_TEST_FIFO_ACCESS;
 441                                 break;
 442                         default:
 443                                 goto error;
 444                         }
 445                         musb_writeb(musb->mregs, MUSB_TESTMODE, temp);
 446                         break;
 447                 default:
 448                         goto error;
 449                 }
 450                 musb_dbg(musb, "set feature %d", wValue);
 451                 musb->port1_status |= 1 << wValue;
 452                 break;
 453
 454         default:
 455 error:
 456                 /* "protocol stall" on error */
 457                 retval = -EPIPE;
 458         }
 459         spin_unlock_irqrestore(&musb->lock, flags);
 460
 461         if (start_musb)
 462                 musb_start(musb);
 463
 464         return retval;
 465 }