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