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