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