drivers/usb/host/ehci-hub.c

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