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