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