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