SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/host/ehci-hub.c

   1 /*
   2  * Copyright (C) 2001-2004 by David Brownell
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 /* this file is part of ehci-hcd.c */
  20
  21 /*-------------------------------------------------------------------------*/
  22
  23 /*
  24  * EHCI Root Hub ... the nonsharable stuff
  25  *
  26  * Registers don't need cpu_to_le32, that happens transparently
  27  */
  28
  29 /*-------------------------------------------------------------------------*/
  30
  31 #define PORT_WAKE_BITS  (PORT_WKOC_E|PORT_WKDISC_E|PORT_WKCONN_E)
  32
  33 #ifdef  CONFIG_PM
  34
  35 static int ehci_hub_control(
  36         struct usb_hcd  *hcd,
  37         u16             typeReq,
  38         u16             wValue,
  39         u16             wIndex,
  40         char            *buf,
  41         u16             wLength
  42 );
  43
  44 /* After a power loss, ports that were owned by the companion must be
  45  * reset so that the companion can still own them.
  46  */
  47 static void ehci_handover_companion_ports(struct ehci_hcd *ehci)
  48 {
  49         u32 __iomem     *reg;
  50         u32             status;
  51         int             port;
  52         __le32          buf;
  53         struct usb_hcd  *hcd = ehci_to_hcd(ehci);
  54
  55         if (!ehci->owned_ports)
  56                 return;
  57
  58         /* Give the connections some time to appear */
  59         msleep(20);
  60
  61         port = HCS_N_PORTS(ehci->hcs_params);
  62         while (port--) {
  63                 if (test_bit(port, &ehci->owned_ports)) {
  64                         reg = &ehci->regs->port_status[port];
  65                         status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
  66
  67                         /* Port already owned by companion? */
  68                         if (status & PORT_OWNER)
  69                                 clear_bit(port, &ehci->owned_ports);
  70                         else if (test_bit(port, &ehci->companion_ports))
  71                                 ehci_writel(ehci, status & ~PORT_PE, reg);
  72                         else
  73                                 ehci_hub_control(hcd, SetPortFeature,
  74                                                 USB_PORT_FEAT_RESET, port + 1,
  75                                                 NULL, 0);
  76                 }
  77         }
  78
  79         if (!ehci->owned_ports)
  80                 return;
  81         msleep(90);             /* Wait for resets to complete */
  82
  83         port = HCS_N_PORTS(ehci->hcs_params);
  84         while (port--) {
  85                 if (test_bit(port, &ehci->owned_ports)) {
  86                         ehci_hub_control(hcd, GetPortStatus,
  87                                         0, port + 1,
  88                                         (char *) &buf, sizeof(buf));
  89
  90                         /* The companion should now own the port,
  91                          * but if something went wrong the port must not
  92                          * remain enabled.
  93                          */
  94                         reg = &ehci->regs->port_status[port];
  95                         status = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
  96                         if (status & PORT_OWNER)
  97                                 ehci_writel(ehci, status | PORT_CSC, reg);
  98                         else {
  99                                 ehci_dbg(ehci, "failed handover port %d: %x\n",
 100                                                 port + 1, status);
 101                                 ehci_writel(ehci, status & ~PORT_PE, reg);
 102                         }
 103                 }
 104         }
 105
 106         ehci->owned_ports = 0;
 107 }
 108
 109 static int ehci_bus_suspend (struct usb_hcd *hcd)
 110 {
 111         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 112         int                     port;
 113         int                     mask;
 114         u32 __iomem             *hostpc_reg = NULL;
 115
 116         ehci_dbg(ehci, "suspend root hub\n");
 117
 118         if (time_before (jiffies, ehci->next_statechange))
 119                 msleep(5);
 120         del_timer_sync(&ehci->watchdog);
 121         del_timer_sync(&ehci->iaa_watchdog);
 122
 123         port = HCS_N_PORTS (ehci->hcs_params);
 124         spin_lock_irq (&ehci->lock);
 125
 126         /* stop schedules, clean any completed work */
 127         if (HC_IS_RUNNING(hcd->state)) {
 128                 ehci_quiesce (ehci);
 129                 hcd->state = HC_STATE_QUIESCING;
 130         }
 131         ehci->command = ehci_readl(ehci, &ehci->regs->command);
 132         ehci_work(ehci);
 133
 134         /* Unlike other USB host controller types, EHCI doesn't have
 135          * any notion of "global" or bus-wide suspend.  The driver has
 136          * to manually suspend all the active unsuspended ports, and
 137          * then manually resume them in the bus_resume() routine.
 138          */
 139         ehci->bus_suspended = 0;
 140         ehci->owned_ports = 0;
 141         while (port--) {
 142                 u32 __iomem     *reg = &ehci->regs->port_status [port];
 143                 u32             t1 = ehci_readl(ehci, reg) & ~PORT_RWC_BITS;
 144                 u32             t2 = t1;
 145
 146                 if (ehci->has_hostpc)
 147                         hostpc_reg = (u32 __iomem *)((u8 *)ehci->regs
 148                                 + HOSTPC0 + 4 * (port & 0xff));
 149                 /* keep track of which ports we suspend */
 150                 if (t1 & PORT_OWNER)
 151                         set_bit(port, &ehci->owned_ports);
 152                 else if ((t1 & PORT_PE) && !(t1 & PORT_SUSPEND)) {
 153                         t2 |= PORT_SUSPEND;
 154                         set_bit(port, &ehci->bus_suspended);
 155                 }
 156
 157                 /* enable remote wakeup on all ports */
 158                 if (hcd->self.root_hub->do_remote_wakeup) {
 159                         /* only enable appropriate wake bits, otherwise the
 160                          * hardware can not go phy low power mode. If a race
 161                          * condition happens here(connection change during bits
 162                          * set), the port change detection will finally fix it.
 163                          */
 164                         if (t1 & PORT_CONNECT) {
 165                                 t2 |= PORT_WKOC_E | PORT_WKDISC_E;
 166                                 t2 &= ~PORT_WKCONN_E;
 167                         } else {
 168                                 t2 |= PORT_WKOC_E | PORT_WKCONN_E;
 169                                 t2 &= ~PORT_WKDISC_E;
 170                         }
 171                 } else
 172                         t2 &= ~PORT_WAKE_BITS;
 173
 174                 if (t1 != t2) {
 175                         ehci_vdbg (ehci, "port %d, %08x -> %08x\n",
 176                                 port + 1, t1, t2);
 177                         ehci_writel(ehci, t2, reg);
 178                         if (hostpc_reg) {
 179                                 u32     t3;
 180
 181                                 msleep(5);/* 5ms for HCD enter low pwr mode */
 182                                 t3 = ehci_readl(ehci, hostpc_reg);
 183                                 ehci_writel(ehci, t3 | HOSTPC_PHCD, hostpc_reg);
 184                                 t3 = ehci_readl(ehci, hostpc_reg);
 185                                 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
 186                                         port, (t3 & HOSTPC_PHCD) ?
 187                                         "succeeded" : "failed");
 188                         }
 189                 }
 190         }
 191
 192         /* Apparently some devices need a >= 1-uframe delay here */
 193         if (ehci->bus_suspended)
 194                 udelay(150);
 195
 196         /* turn off now-idle HC */
 197         ehci_halt (ehci);
 198         hcd->state = HC_STATE_SUSPENDED;
 199
 200         if (ehci->reclaim)
 201                 end_unlink_async(ehci);
 202
 203         /* allow remote wakeup */
 204         mask = INTR_MASK;
 205         if (!hcd->self.root_hub->do_remote_wakeup)
 206                 mask &= ~STS_PCD;
 207         ehci_writel(ehci, mask, &ehci->regs->intr_enable);
 208         ehci_readl(ehci, &ehci->regs->intr_enable);
 209
 210         ehci->next_statechange = jiffies + msecs_to_jiffies(10);
 211         spin_unlock_irq (&ehci->lock);
 212
 213         /* ehci_work() may have re-enabled the watchdog timer, which we do not
 214          * want, and so we must delete any pending watchdog timer events.
 215          */
 216         del_timer_sync(&ehci->watchdog);
 217         return 0;
 218 }
 219
 220
 221 /* caller has locked the root hub, and should reset/reinit on error */
 222 static int ehci_bus_resume (struct usb_hcd *hcd)
 223 {
 224         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
 225         u32                     temp;
 226         u32                     power_okay;
 227         int                     i;
 228         u8                      resume_needed = 0;
 229
 230         if (time_before (jiffies, ehci->next_statechange))
 231                 msleep(5);
 232         spin_lock_irq (&ehci->lock);
 233         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
 234                 spin_unlock_irq(&ehci->lock);
 235                 return -ESHUTDOWN;
 236         }
 237
 238         if (unlikely(ehci->debug)) {
 239                 if (ehci->debug && !dbgp_reset_prep())
 240                         ehci->debug = NULL;
 241                 else
 242                         dbgp_external_startup();
 243         }
 244
 245         /* Ideally and we've got a real resume here, and no port's power
 246          * was lost.  (For PCI, that means Vaux was maintained.)  But we
 247          * could instead be restoring a swsusp snapshot -- so that BIOS was
 248          * the last user of the controller, not reset/pm hardware keeping
 249          * state we gave to it.
 250          */
 251         power_okay = ehci_readl(ehci, &ehci->regs->intr_enable);
 252         ehci_dbg(ehci, "resume root hub%s\n",
 253                         power_okay ? "" : " after power loss");
 254
 255         /* at least some APM implementations will try to deliver
 256          * IRQs right away, so delay them until we're ready.
 257          */
 258         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
 259
 260         /* re-init operational registers */
 261         ehci_writel(ehci, 0, &ehci->regs->segment);
 262         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
 263         ehci_writel(ehci, (u32) ehci->async->qh_dma, &ehci->regs->async_next);
 264
 265         /* restore CMD_RUN, framelist size, and irq threshold */
 266         ehci_writel(ehci, ehci->command, &ehci->regs->command);
 267
 268         /* Some controller/firmware combinations need a delay during which
 269          * they set up the port statuses.  See Bugzilla #8190. */
 270         spin_unlock_irq(&ehci->lock);
 271         msleep(8);
 272         spin_lock_irq(&ehci->lock);
 273
 274         /* manually resume the ports we suspended during bus_suspend() */
 275         i = HCS_N_PORTS (ehci->hcs_params);
 276         while (i--) {
 277                 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
 278                 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
 279                 if (test_bit(i, &ehci->bus_suspended) &&
 280                                 (temp & PORT_SUSPEND)) {
 281                         temp |= PORT_RESUME;
 282                         resume_needed = 1;
 283                 }
 284                 ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
 285         }
 286
 287         /* msleep for 20ms only if code is trying to resume port */
 288         if (resume_needed) {
 289                 spin_unlock_irq(&ehci->lock);
 290                 msleep(20);
 291                 spin_lock_irq(&ehci->lock);
 292         }
 293
 294         i = HCS_N_PORTS (ehci->hcs_params);
 295         while (i--) {
 296                 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
 297                 if (test_bit(i, &ehci->bus_suspended) &&
 298                                 (temp & PORT_SUSPEND)) {
 299                         temp &= ~(PORT_RWC_BITS | PORT_RESUME);
 300                         ehci_writel(ehci, temp, &ehci->regs->port_status [i]);
 301                         ehci_vdbg (ehci, "resumed port %d\n", i + 1);
 302                 }
 303         }
 304         (void) ehci_readl(ehci, &ehci->regs->command);
 305
 306         /* maybe re-activate the schedule(s) */
 307         temp = 0;
 308         if (ehci->async->qh_next.qh)
 309                 temp |= CMD_ASE;
 310         if (ehci->periodic_sched)
 311                 temp |= CMD_PSE;
 312         if (temp) {
 313                 ehci->command |= temp;
 314                 ehci_writel(ehci, ehci->command, &ehci->regs->command);
 315         }
 316
 317         ehci->next_statechange = jiffies + msecs_to_jiffies(5);
 318         hcd->state = HC_STATE_RUNNING;
 319
 320         /* Now we can safely re-enable irqs */
 321         ehci_writel(ehci, INTR_MASK, &ehci->regs->intr_enable);
 322
 323         spin_unlock_irq (&ehci->lock);
 324         ehci_handover_companion_ports(ehci);
 325         return 0;
 326 }
 327
 328 #else
 329
 330 #define ehci_bus_suspend        NULL
 331 #define ehci_bus_resume         NULL
 332
 333 #endif  /* CONFIG_PM */
 334
 335 /*-------------------------------------------------------------------------*/
 336
 337 /* Display the ports dedicated to the companion controller */
 338 static ssize_t show_companion(struct device *dev,
 339                               struct device_attribute *attr,
 340                               char *buf)
 341 {
 342         struct ehci_hcd         *ehci;
 343         int                     nports, index, n;
 344         int                     count = PAGE_SIZE;
 345         char                    *ptr = buf;
 346
 347         ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
 348         nports = HCS_N_PORTS(ehci->hcs_params);
 349
 350         for (index = 0; index < nports; ++index) {
 351                 if (test_bit(index, &ehci->companion_ports)) {
 352                         n = scnprintf(ptr, count, "%d\n", index + 1);
 353                         ptr += n;
 354                         count -= n;
 355                 }
 356         }
 357         return ptr - buf;
 358 }
 359
 360 /*
 361  * Sets the owner of a port
 362  */
 363 static void set_owner(struct ehci_hcd *ehci, int portnum, int new_owner)
 364 {
 365         u32 __iomem             *status_reg;
 366         u32                     port_status;
 367         int                     try;
 368
 369         status_reg = &ehci->regs->port_status[portnum];
 370
 371         /*
 372          * The controller won't set the OWNER bit if the port is
 373          * enabled, so this loop will sometimes require at least two
 374          * iterations: one to disable the port and one to set OWNER.
 375          */
 376         for (try = 4; try > 0; --try) {
 377                 spin_lock_irq(&ehci->lock);
 378                 port_status = ehci_readl(ehci, status_reg);
 379                 if ((port_status & PORT_OWNER) == new_owner
 380                                 || (port_status & (PORT_OWNER | PORT_CONNECT))
 381                                         == 0)
 382                         try = 0;
 383                 else {
 384                         port_status ^= PORT_OWNER;
 385                         port_status &= ~(PORT_PE | PORT_RWC_BITS);
 386                         ehci_writel(ehci, port_status, status_reg);
 387                 }
 388                 spin_unlock_irq(&ehci->lock);
 389                 if (try > 1)
 390                         msleep(5);
 391         }
 392 }
 393
 394 /*
 395  * Dedicate or undedicate a port to the companion controller.
 396  * Syntax is "[-]portnum", where a leading '-' sign means
 397  * return control of the port to the EHCI controller.
 398  */
 399 static ssize_t store_companion(struct device *dev,
 400                                struct device_attribute *attr,
 401                                const char *buf, size_t count)
 402 {
 403         struct ehci_hcd         *ehci;
 404         int                     portnum, new_owner;
 405
 406         ehci = hcd_to_ehci(bus_to_hcd(dev_get_drvdata(dev)));
 407         new_owner = PORT_OWNER;         /* Owned by companion */
 408         if (sscanf(buf, "%d", &portnum) != 1)
 409                 return -EINVAL;
 410         if (portnum < 0) {
 411                 portnum = - portnum;
 412                 new_owner = 0;          /* Owned by EHCI */
 413         }
 414         if (portnum <= 0 || portnum > HCS_N_PORTS(ehci->hcs_params))
 415                 return -ENOENT;
 416         portnum--;
 417         if (new_owner)
 418                 set_bit(portnum, &ehci->companion_ports);
 419         else
 420                 clear_bit(portnum, &ehci->companion_ports);
 421         set_owner(ehci, portnum, new_owner);
 422         return count;
 423 }
 424 static DEVICE_ATTR(companion, 0644, show_companion, store_companion);
 425
 426 static inline void create_companion_file(struct ehci_hcd *ehci)
 427 {
 428         int     i;
 429
 430         /* with integrated TT there is no companion! */
 431         if (!ehci_is_TDI(ehci))
 432                 i = device_create_file(ehci_to_hcd(ehci)->self.controller,
 433                                        &dev_attr_companion);
 434 }
 435
 436 static inline void remove_companion_file(struct ehci_hcd *ehci)
 437 {
 438         /* with integrated TT there is no companion! */
 439         if (!ehci_is_TDI(ehci))
 440                 device_remove_file(ehci_to_hcd(ehci)->self.controller,
 441                                    &dev_attr_companion);
 442 }
 443
 444
 445 /*-------------------------------------------------------------------------*/
 446
 447 static int check_reset_complete (
 448         struct ehci_hcd *ehci,
 449         int             index,
 450         u32 __iomem     *status_reg,
 451         int             port_status
 452 ) {
 453         if (!(port_status & PORT_CONNECT))
 454                 return port_status;
 455
 456         /* if reset finished and it's still not enabled -- handoff */
 457         if (!(port_status & PORT_PE)) {
 458
 459                 /* with integrated TT, there's nobody to hand it to! */
 460                 if (ehci_is_TDI(ehci)) {
 461                         ehci_dbg (ehci,
 462                                 "Failed to enable port %d on root hub TT\n",
 463                                 index+1);
 464                         return port_status;
 465                 }
 466
 467                 ehci_dbg (ehci, "port %d full speed --> companion\n",
 468                         index + 1);
 469
 470                 // what happens if HCS_N_CC(params) == 0 ?
 471                 port_status |= PORT_OWNER;
 472                 port_status &= ~PORT_RWC_BITS;
 473                 ehci_writel(ehci, port_status, status_reg);
 474
 475                 /* ensure 440EPX ohci controller state is operational */
 476                 if (ehci->has_amcc_usb23)
 477                         set_ohci_hcfs(ehci, 1);
 478         } else {
 479                 ehci_dbg (ehci, "port %d high speed\n", index + 1);
 480                 /* ensure 440EPx ohci controller state is suspended */
 481                 if (ehci->has_amcc_usb23)
 482                         set_ohci_hcfs(ehci, 0);
 483         }
 484
 485         return port_status;
 486 }
 487
 488 /*-------------------------------------------------------------------------*/
 489
 490
 491 /* build "status change" packet (one or two bytes) from HC registers */
 492
 493 static int
 494 ehci_hub_status_data (struct usb_hcd *hcd, char *buf)
 495 {
 496         struct ehci_hcd *ehci = hcd_to_ehci (hcd);
 497         u32             temp, status = 0;
 498         u32             mask;
 499         int             ports, i, retval = 1;
 500         unsigned long   flags;
 501
 502         /* if !USB_SUSPEND, root hub timers won't get shut down ... */
 503         if (!HC_IS_RUNNING(hcd->state))
 504                 return 0;
 505
 506         /* init status to no-changes */
 507         buf [0] = 0;
 508         ports = HCS_N_PORTS (ehci->hcs_params);
 509         if (ports > 7) {
 510                 buf [1] = 0;
 511                 retval++;
 512         }
 513
 514         /* Some boards (mostly VIA?) report bogus overcurrent indications,
 515          * causing massive log spam unless we completely ignore them.  It
 516          * may be relevant that VIA VT8235 controllers, where PORT_POWER is
 517          * always set, seem to clear PORT_OCC and PORT_CSC when writing to
 518          * PORT_POWER; that's surprising, but maybe within-spec.
 519          */
 520         if (!ignore_oc)
 521                 mask = PORT_CSC | PORT_PEC | PORT_OCC;
 522         else
 523                 mask = PORT_CSC | PORT_PEC;
 524         // PORT_RESUME from hardware ~= PORT_STAT_C_SUSPEND
 525
 526         /* no hub change reports (bit 0) for now (power, ...) */
 527
 528         /* port N changes (bit N)? */
 529         spin_lock_irqsave (&ehci->lock, flags);
 530         for (i = 0; i < ports; i++) {
 531                 temp = ehci_readl(ehci, &ehci->regs->port_status [i]);
 532
 533                 /*
 534                  * Return status information even for ports with OWNER set.
 535                  * Otherwise khubd wouldn't see the disconnect event when a
 536                  * high-speed device is switched over to the companion
 537                  * controller by the user.
 538                  */
 539
 540                 if ((temp & mask) != 0 || test_bit(i, &ehci->port_c_suspend)
 541                                 || (ehci->reset_done[i] && time_after_eq(
 542                                         jiffies, ehci->reset_done[i]))) {
 543                         if (i < 7)
 544                             buf [0] |= 1 << (i + 1);
 545                         else
 546                             buf [1] |= 1 << (i - 7);
 547                         status = STS_PCD;
 548                 }
 549         }
 550         /* FIXME autosuspend idle root hubs */
 551         spin_unlock_irqrestore (&ehci->lock, flags);
 552         return status ? retval : 0;
 553 }
 554
 555 /*-------------------------------------------------------------------------*/
 556
 557 static void
 558 ehci_hub_descriptor (
 559         struct ehci_hcd                 *ehci,
 560         struct usb_hub_descriptor       *desc
 561 ) {
 562         int             ports = HCS_N_PORTS (ehci->hcs_params);
 563         u16             temp;
 564
 565         desc->bDescriptorType = 0x29;
 566         desc->bPwrOn2PwrGood = 10;      /* ehci 1.0, 2.3.9 says 20ms max */
 567         desc->bHubContrCurrent = 0;
 568
 569         desc->bNbrPorts = ports;
 570         temp = 1 + (ports / 8);
 571         desc->bDescLength = 7 + 2 * temp;
 572
 573         /* two bitmaps:  ports removable, and usb 1.0 legacy PortPwrCtrlMask */
 574         memset (&desc->bitmap [0], 0, temp);
 575         memset (&desc->bitmap [temp], 0xff, temp);
 576
 577         temp = 0x0008;                  /* per-port overcurrent reporting */
 578         if (HCS_PPC (ehci->hcs_params))
 579                 temp |= 0x0001;         /* per-port power control */
 580         else
 581                 temp |= 0x0002;         /* no power switching */
 582 #if 0
 583 // re-enable when we support USB_PORT_FEAT_INDICATOR below.
 584         if (HCS_INDICATOR (ehci->hcs_params))
 585                 temp |= 0x0080;         /* per-port indicators (LEDs) */
 586 #endif
 587         desc->wHubCharacteristics = cpu_to_le16(temp);
 588 }
 589
 590 /*-------------------------------------------------------------------------*/
 591
 592 static int ehci_hub_control (
 593         struct usb_hcd  *hcd,
 594         u16             typeReq,
 595         u16             wValue,
 596         u16             wIndex,
 597         char            *buf,
 598         u16             wLength
 599 ) {
 600         struct ehci_hcd *ehci = hcd_to_ehci (hcd);
 601         int             ports = HCS_N_PORTS (ehci->hcs_params);
 602         u32 __iomem     *status_reg = &ehci->regs->port_status[
 603                                 (wIndex & 0xff) - 1];
 604         u32 __iomem     *hostpc_reg = NULL;
 605         u32             temp, temp1, status;
 606         unsigned long   flags;
 607         int             retval = 0;
 608         unsigned        selector;
 609
 610         /*
 611          * FIXME:  support SetPortFeatures USB_PORT_FEAT_INDICATOR.
 612          * HCS_INDICATOR may say we can change LEDs to off/amber/green.
 613          * (track current state ourselves) ... blink for diagnostics,
 614          * power, "this is the one", etc.  EHCI spec supports this.
 615          */
 616
 617         if (ehci->has_hostpc)
 618                 hostpc_reg = (u32 __iomem *)((u8 *)ehci->regs
 619                                 + HOSTPC0 + 4 * ((wIndex & 0xff) - 1));
 620         spin_lock_irqsave (&ehci->lock, flags);
 621         switch (typeReq) {
 622         case ClearHubFeature:
 623                 switch (wValue) {
 624                 case C_HUB_LOCAL_POWER:
 625                 case C_HUB_OVER_CURRENT:
 626                         /* no hub-wide feature/status flags */
 627                         break;
 628                 default:
 629                         goto error;
 630                 }
 631                 break;
 632         case ClearPortFeature:
 633                 if (!wIndex || wIndex > ports)
 634                         goto error;
 635                 wIndex--;
 636                 temp = ehci_readl(ehci, status_reg);
 637
 638                 /*
 639                  * Even if OWNER is set, so the port is owned by the
 640                  * companion controller, khubd needs to be able to clear
 641                  * the port-change status bits (especially
 642                  * USB_PORT_FEAT_C_CONNECTION).
 643                  */
 644
 645                 switch (wValue) {
 646                 case USB_PORT_FEAT_ENABLE:
 647                         ehci_writel(ehci, temp & ~PORT_PE, status_reg);
 648                         break;
 649                 case USB_PORT_FEAT_C_ENABLE:
 650                         ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_PEC,
 651                                         status_reg);
 652                         break;
 653                 case USB_PORT_FEAT_SUSPEND:
 654                         if (temp & PORT_RESET)
 655                                 goto error;
 656                         if (ehci->no_selective_suspend)
 657                                 break;
 658                         if (temp & PORT_SUSPEND) {
 659                                 if ((temp & PORT_PE) == 0)
 660                                         goto error;
 661                                 /* resume signaling for 20 msec */
 662                                 temp &= ~(PORT_RWC_BITS | PORT_WAKE_BITS);
 663                                 ehci_writel(ehci, temp | PORT_RESUME,
 664                                                 status_reg);
 665                                 ehci->reset_done [wIndex] = jiffies
 666                                                 + msecs_to_jiffies (20);
 667                         }
 668                         break;
 669                 case USB_PORT_FEAT_C_SUSPEND:
 670                         clear_bit(wIndex, &ehci->port_c_suspend);
 671                         break;
 672                 case USB_PORT_FEAT_POWER:
 673                         if (HCS_PPC (ehci->hcs_params))
 674                                 ehci_writel(ehci,
 675                                           temp & ~(PORT_RWC_BITS | PORT_POWER),
 676                                           status_reg);
 677                         break;
 678                 case USB_PORT_FEAT_C_CONNECTION:
 679                         ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_CSC,
 680                                         status_reg);
 681                         break;
 682                 case USB_PORT_FEAT_C_OVER_CURRENT:
 683                         ehci_writel(ehci, (temp & ~PORT_RWC_BITS) | PORT_OCC,
 684                                         status_reg);
 685                         break;
 686                 case USB_PORT_FEAT_C_RESET:
 687                         /* GetPortStatus clears reset */
 688                         break;
 689                 default:
 690                         goto error;
 691                 }
 692                 ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
 693                 break;
 694         case GetHubDescriptor:
 695                 ehci_hub_descriptor (ehci, (struct usb_hub_descriptor *)
 696                         buf);
 697                 break;
 698         case GetHubStatus:
 699                 /* no hub-wide feature/status flags */
 700                 memset (buf, 0, 4);
 701                 //cpu_to_le32s ((u32 *) buf);
 702                 break;
 703         case GetPortStatus:
 704                 if (!wIndex || wIndex > ports)
 705                         goto error;
 706                 wIndex--;
 707                 status = 0;
 708                 temp = ehci_readl(ehci, status_reg);
 709
 710                 // wPortChange bits
 711                 if (temp & PORT_CSC)
 712                         status |= 1 << USB_PORT_FEAT_C_CONNECTION;
 713                 if (temp & PORT_PEC)
 714                         status |= 1 << USB_PORT_FEAT_C_ENABLE;
 715
 716                 if ((temp & PORT_OCC) && !ignore_oc){
 717                         status |= 1 << USB_PORT_FEAT_C_OVER_CURRENT;
 718
 719                         /*
 720                          * Hubs should disable port power on over-current.
 721                          * However, not all EHCI implementations do this
 722                          * automatically, even if they _do_ support per-port
 723                          * power switching; they're allowed to just limit the
 724                          * current.  khubd will turn the power back on.
 725                          */
 726                         if (HCS_PPC (ehci->hcs_params)){
 727                                 ehci_writel(ehci,
 728                                         temp & ~(PORT_RWC_BITS | PORT_POWER),
 729                                         status_reg);
 730                         }
 731                 }
 732
 733                 /* whoever resumes must GetPortStatus to complete it!! */
 734                 if (temp & PORT_RESUME) {
 735
 736                         /* Remote Wakeup received? */
 737                         if (!ehci->reset_done[wIndex]) {
 738                                 /* resume signaling for 20 msec */
 739                                 ehci->reset_done[wIndex] = jiffies
 740                                                 + msecs_to_jiffies(20);
 741                                 /* check the port again */
 742                                 mod_timer(&ehci_to_hcd(ehci)->rh_timer,
 743                                                 ehci->reset_done[wIndex]);
 744                         }
 745
 746                         /* resume completed? */
 747                         else if (time_after_eq(jiffies,
 748                                         ehci->reset_done[wIndex])) {
 749                                 clear_bit(wIndex, &ehci->suspended_ports);
 750                                 set_bit(wIndex, &ehci->port_c_suspend);
 751                                 ehci->reset_done[wIndex] = 0;
 752
 753                                 /* stop resume signaling */
 754                                 temp = ehci_readl(ehci, status_reg);
 755                                 ehci_writel(ehci,
 756                                         temp & ~(PORT_RWC_BITS | PORT_RESUME),
 757                                         status_reg);
 758                                 retval = handshake(ehci, status_reg,
 759                                            PORT_RESUME, 0, 2000 /* 2msec */);
 760                                 if (retval != 0) {
 761                                         ehci_err(ehci,
 762                                                 "port %d resume error %d\n",
 763                                                 wIndex + 1, retval);
 764                                         goto error;
 765                                 }
 766                                 temp &= ~(PORT_SUSPEND|PORT_RESUME|(3<<10));
 767                         }
 768                 }
 769
 770                 /* whoever resets must GetPortStatus to complete it!! */
 771                 if ((temp & PORT_RESET)
 772                                 && time_after_eq(jiffies,
 773                                         ehci->reset_done[wIndex])) {
 774                         status |= 1 << USB_PORT_FEAT_C_RESET;
 775                         ehci->reset_done [wIndex] = 0;
 776
 777                         /* force reset to complete */
 778                         ehci_writel(ehci, temp & ~(PORT_RWC_BITS | PORT_RESET),
 779                                         status_reg);
 780                         /* REVISIT:  some hardware needs 550+ usec to clear
 781                          * this bit; seems too long to spin routinely...
 782                          */
 783                         retval = handshake(ehci, status_reg,
 784                                         PORT_RESET, 0, 750);
 785                         if (retval != 0) {
 786                                 ehci_err (ehci, "port %d reset error %d\n",
 787                                         wIndex + 1, retval);
 788                                 goto error;
 789                         }
 790
 791                         /* see what we found out */
 792                         temp = check_reset_complete (ehci, wIndex, status_reg,
 793                                         ehci_readl(ehci, status_reg));
 794                 }
 795
 796                 if (!(temp & (PORT_RESUME|PORT_RESET)))
 797                         ehci->reset_done[wIndex] = 0;
 798
 799                 /* transfer dedicated ports to the companion hc */
 800                 if ((temp & PORT_CONNECT) &&
 801                                 test_bit(wIndex, &ehci->companion_ports)) {
 802                         temp &= ~PORT_RWC_BITS;
 803                         temp |= PORT_OWNER;
 804                         ehci_writel(ehci, temp, status_reg);
 805                         ehci_dbg(ehci, "port %d --> companion\n", wIndex + 1);
 806                         temp = ehci_readl(ehci, status_reg);
 807                 }
 808
 809                 /*
 810                  * Even if OWNER is set, there's no harm letting khubd
 811                  * see the wPortStatus values (they should all be 0 except
 812                  * for PORT_POWER anyway).
 813                  */
 814
 815                 if (temp & PORT_CONNECT) {
 816                         status |= 1 << USB_PORT_FEAT_CONNECTION;
 817                         // status may be from integrated TT
 818                         if (ehci->has_hostpc) {
 819                                 temp1 = ehci_readl(ehci, hostpc_reg);
 820                                 status |= ehci_port_speed(ehci, temp1);
 821                         } else
 822                                 status |= ehci_port_speed(ehci, temp);
 823                 }
 824                 if (temp & PORT_PE)
 825                         status |= 1 << USB_PORT_FEAT_ENABLE;
 826
 827                 /* maybe the port was unsuspended without our knowledge */
 828                 if (temp & (PORT_SUSPEND|PORT_RESUME)) {
 829                         status |= 1 << USB_PORT_FEAT_SUSPEND;
 830                 } else if (test_bit(wIndex, &ehci->suspended_ports)) {
 831                         clear_bit(wIndex, &ehci->suspended_ports);
 832                         ehci->reset_done[wIndex] = 0;
 833                         if (temp & PORT_PE)
 834                                 set_bit(wIndex, &ehci->port_c_suspend);
 835                 }
 836
 837                 if (temp & PORT_OC)
 838                         status |= 1 << USB_PORT_FEAT_OVER_CURRENT;
 839                 if (temp & PORT_RESET)
 840                         status |= 1 << USB_PORT_FEAT_RESET;
 841                 if (temp & PORT_POWER)
 842                         status |= 1 << USB_PORT_FEAT_POWER;
 843                 if (test_bit(wIndex, &ehci->port_c_suspend))
 844                         status |= 1 << USB_PORT_FEAT_C_SUSPEND;
 845
 846 #ifndef VERBOSE_DEBUG
 847         if (status & ~0xffff)   /* only if wPortChange is interesting */
 848 #endif
 849                 dbg_port (ehci, "GetStatus", wIndex + 1, temp);
 850                 put_unaligned_le32(status, buf);
 851                 break;
 852         case SetHubFeature:
 853                 switch (wValue) {
 854                 case C_HUB_LOCAL_POWER:
 855                 case C_HUB_OVER_CURRENT:
 856                         /* no hub-wide feature/status flags */
 857                         break;
 858                 default:
 859                         goto error;
 860                 }
 861                 break;
 862         case SetPortFeature:
 863                 selector = wIndex >> 8;
 864                 wIndex &= 0xff;
 865                 if (unlikely(ehci->debug)) {
 866                         /* If the debug port is active any port
 867                          * feature requests should get denied */
 868                         if (wIndex == HCS_DEBUG_PORT(ehci->hcs_params) &&
 869                             (readl(&ehci->debug->control) & DBGP_ENABLED)) {
 870                                 retval = -ENODEV;
 871                                 goto error_exit;
 872                         }
 873                 }
 874                 if (!wIndex || wIndex > ports)
 875                         goto error;
 876                 wIndex--;
 877                 temp = ehci_readl(ehci, status_reg);
 878                 if (temp & PORT_OWNER)
 879                         break;
 880
 881                 temp &= ~PORT_RWC_BITS;
 882                 switch (wValue) {
 883                 case USB_PORT_FEAT_SUSPEND:
 884                         if (ehci->no_selective_suspend)
 885                                 break;
 886                         if ((temp & PORT_PE) == 0
 887                                         || (temp & PORT_RESET) != 0)
 888                                 goto error;
 889                         ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
 890                         /* After above check the port must be connected.
 891                          * Set appropriate bit thus could put phy into low power
 892                          * mode if we have hostpc feature
 893                          */
 894                         if (hostpc_reg) {
 895                                 temp &= ~PORT_WKCONN_E;
 896                                 temp |= (PORT_WKDISC_E | PORT_WKOC_E);
 897                                 ehci_writel(ehci, temp | PORT_SUSPEND,
 898                                                         status_reg);
 899                                 msleep(5);/* 5ms for HCD enter low pwr mode */
 900                                 temp1 = ehci_readl(ehci, hostpc_reg);
 901                                 ehci_writel(ehci, temp1 | HOSTPC_PHCD,
 902                                         hostpc_reg);
 903                                 temp1 = ehci_readl(ehci, hostpc_reg);
 904                                 ehci_dbg(ehci, "Port%d phy low pwr mode %s\n",
 905                                         wIndex, (temp1 & HOSTPC_PHCD) ?
 906                                         "succeeded" : "failed");
 907                         }
 908                         set_bit(wIndex, &ehci->suspended_ports);
 909                         break;
 910                 case USB_PORT_FEAT_POWER:
 911                         if (HCS_PPC (ehci->hcs_params))
 912                                 ehci_writel(ehci, temp | PORT_POWER,
 913                                                 status_reg);
 914                         break;
 915                 case USB_PORT_FEAT_RESET:
 916                         if (temp & PORT_RESUME)
 917                                 goto error;
 918                         /* line status bits may report this as low speed,
 919                          * which can be fine if this root hub has a
 920                          * transaction translator built in.
 921                          */
 922                         if ((temp & (PORT_PE|PORT_CONNECT)) == PORT_CONNECT
 923                                         && !ehci_is_TDI(ehci)
 924                                         && PORT_USB11 (temp)) {
 925                                 ehci_dbg (ehci,
 926                                         "port %d low speed --> companion\n",
 927                                         wIndex + 1);
 928                                 temp |= PORT_OWNER;
 929                         } else {
 930                                 ehci_vdbg (ehci, "port %d reset\n", wIndex + 1);
 931                                 temp |= PORT_RESET;
 932                                 temp &= ~PORT_PE;
 933
 934                                 /*
 935                                  * caller must wait, then call GetPortStatus
 936                                  * usb 2.0 spec says 50 ms resets on root
 937                                  */
 938                                 ehci->reset_done [wIndex] = jiffies
 939                                                 + msecs_to_jiffies (50);
 940                         }
 941                         ehci_writel(ehci, temp, status_reg);
 942                         break;
 943
 944                 /* For downstream facing ports (these):  one hub port is put
 945                  * into test mode according to USB2 11.24.2.13, then the hub
 946                  * must be reset (which for root hub now means rmmod+modprobe,
 947                  * or else system reboot).  See EHCI 2.3.9 and 4.14 for info
 948                  * about the EHCI-specific stuff.
 949                  */
 950                 case USB_PORT_FEAT_TEST:
 951                         if (!selector || selector > 5)
 952                                 goto error;
 953                         ehci_quiesce(ehci);
 954                         ehci_halt(ehci);
 955                         temp |= selector << 16;
 956                         ehci_writel(ehci, temp, status_reg);
 957                         break;
 958
 959                 default:
 960                         goto error;
 961                 }
 962                 ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
 963                 break;
 964
 965         default:
 966 error:
 967                 /* "stall" on error */
 968                 retval = -EPIPE;
 969         }
 970 error_exit:
 971         spin_unlock_irqrestore (&ehci->lock, flags);
 972         return retval;
 973 }
 974
 975 static void ehci_relinquish_port(struct usb_hcd *hcd, int portnum)
 976 {
 977         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 978
 979         if (ehci_is_TDI(ehci))
 980                 return;
 981         set_owner(ehci, --portnum, PORT_OWNER);
 982 }
 983
 984 static int ehci_port_handed_over(struct usb_hcd *hcd, int portnum)
 985 {
 986         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 987         u32 __iomem             *reg;
 988
 989         if (ehci_is_TDI(ehci))
 990                 return 0;
 991         reg = &ehci->regs->port_status[portnum - 1];
 992         return ehci_readl(ehci, reg) & PORT_OWNER;
 993 }