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