drivers/usb/host/ohci-hub.c

   1 /*
   2  * OHCI HCD (Host Controller Driver) for USB.
   3  *
   4  * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
   5  * (C) Copyright 2000-2004 David Brownell <dbrownell@users.sourceforge.net>
   6  *
   7  * This file is licenced under GPL
   8  */
   9
  10 /*-------------------------------------------------------------------------*/
  11
  12 /*
  13  * OHCI Root Hub ... the nonsharable stuff
  14  */
  15
  16 #define dbg_port(hc,label,num,value) \
  17         ohci_dbg (hc, \
  18                 "%s roothub.portstatus [%d] " \
  19                 "= 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
  20                 label, num, temp, \
  21                 (temp & RH_PS_PRSC) ? " PRSC" : "", \
  22                 (temp & RH_PS_OCIC) ? " OCIC" : "", \
  23                 (temp & RH_PS_PSSC) ? " PSSC" : "", \
  24                 (temp & RH_PS_PESC) ? " PESC" : "", \
  25                 (temp & RH_PS_CSC) ? " CSC" : "", \
  26                 \
  27                 (temp & RH_PS_LSDA) ? " LSDA" : "", \
  28                 (temp & RH_PS_PPS) ? " PPS" : "", \
  29                 (temp & RH_PS_PRS) ? " PRS" : "", \
  30                 (temp & RH_PS_POCI) ? " POCI" : "", \
  31                 (temp & RH_PS_PSS) ? " PSS" : "", \
  32                 \
  33                 (temp & RH_PS_PES) ? " PES" : "", \
  34                 (temp & RH_PS_CCS) ? " CCS" : "" \
  35                 );
  36
  37 /*-------------------------------------------------------------------------*/
  38
  39 #define OHCI_SCHED_ENABLES \
  40         (OHCI_CTRL_CLE|OHCI_CTRL_BLE|OHCI_CTRL_PLE|OHCI_CTRL_IE)
  41
  42 static void dl_done_list (struct ohci_hcd *);
  43 static void finish_unlinks (struct ohci_hcd *, u16);
  44
  45 #ifdef  CONFIG_PM
  46 static int ohci_rh_suspend (struct ohci_hcd *ohci, int autostop)
  47 __releases(ohci->lock)
  48 __acquires(ohci->lock)
  49 {
  50         int                     status = 0;
  51
  52         ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
  53         switch (ohci->hc_control & OHCI_CTRL_HCFS) {
  54         case OHCI_USB_RESUME:
  55                 ohci_dbg (ohci, "resume/suspend?\n");
  56                 ohci->hc_control &= ~OHCI_CTRL_HCFS;
  57                 ohci->hc_control |= OHCI_USB_RESET;
  58                 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
  59                 (void) ohci_readl (ohci, &ohci->regs->control);
  60                 /* FALL THROUGH */
  61         case OHCI_USB_RESET:
  62                 status = -EBUSY;
  63                 ohci_dbg (ohci, "needs reinit!\n");
  64                 goto done;
  65         case OHCI_USB_SUSPEND:
  66                 if (!ohci->autostop) {
  67                         ohci_dbg (ohci, "already suspended\n");
  68                         goto done;
  69                 }
  70         }
  71         ohci_dbg (ohci, "%s root hub\n",
  72                         autostop ? "auto-stop" : "suspend");
  73
  74         /* First stop any processing */
  75         if (!autostop && (ohci->hc_control & OHCI_SCHED_ENABLES)) {
  76                 ohci->hc_control &= ~OHCI_SCHED_ENABLES;
  77                 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
  78                 ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
  79                 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrstatus);
  80
  81                 /* sched disables take effect on the next frame,
  82                  * then the last WDH could take 6+ msec
  83                  */
  84                 ohci_dbg (ohci, "stopping schedules ...\n");
  85                 ohci->autostop = 0;
  86                 spin_unlock_irq (&ohci->lock);
  87                 msleep (8);
  88                 spin_lock_irq (&ohci->lock);
  89         }
  90         dl_done_list (ohci);
  91         finish_unlinks (ohci, ohci_frame_no(ohci));
  92
  93         /* maybe resume can wake root hub */
  94         if (ohci_to_hcd(ohci)->self.root_hub->do_remote_wakeup || autostop) {
  95                 ohci->hc_control |= OHCI_CTRL_RWE;
  96         } else {
  97                 ohci_writel(ohci, OHCI_INTR_RHSC | OHCI_INTR_RD,
  98                                 &ohci->regs->intrdisable);
  99                 ohci->hc_control &= ~OHCI_CTRL_RWE;
 100         }
 101
 102         /* Suspend hub ... this is the "global (to this bus) suspend" mode,
 103          * which doesn't imply ports will first be individually suspended.
 104          */
 105         ohci->hc_control &= ~OHCI_CTRL_HCFS;
 106         ohci->hc_control |= OHCI_USB_SUSPEND;
 107         ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 108         (void) ohci_readl (ohci, &ohci->regs->control);
 109
 110         /* no resumes until devices finish suspending */
 111         if (!autostop) {
 112                 ohci->next_statechange = jiffies + msecs_to_jiffies (5);
 113                 ohci->autostop = 0;
 114         }
 115
 116 done:
 117         return status;
 118 }
 119
 120 static inline struct ed *find_head (struct ed *ed)
 121 {
 122         /* for bulk and control lists */
 123         while (ed->ed_prev)
 124                 ed = ed->ed_prev;
 125         return ed;
 126 }
 127
 128 /* caller has locked the root hub */
 129 static int ohci_rh_resume (struct ohci_hcd *ohci)
 130 __releases(ohci->lock)
 131 __acquires(ohci->lock)
 132 {
 133         struct usb_hcd          *hcd = ohci_to_hcd (ohci);
 134         u32                     temp, enables;
 135         int                     status = -EINPROGRESS;
 136         int                     autostopped = ohci->autostop;
 137
 138         ohci->autostop = 0;
 139         ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
 140
 141         if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
 142                 /* this can happen after resuming a swsusp snapshot */
 143                 if (hcd->state == HC_STATE_RESUMING) {
 144                         ohci_dbg (ohci, "BIOS/SMM active, control %03x\n",
 145                                         ohci->hc_control);
 146                         status = -EBUSY;
 147                 /* this happens when pmcore resumes HC then root */
 148                 } else {
 149                         ohci_dbg (ohci, "duplicate resume\n");
 150                         status = 0;
 151                 }
 152         } else switch (ohci->hc_control & OHCI_CTRL_HCFS) {
 153         case OHCI_USB_SUSPEND:
 154                 ohci->hc_control &= ~(OHCI_CTRL_HCFS|OHCI_SCHED_ENABLES);
 155                 ohci->hc_control |= OHCI_USB_RESUME;
 156                 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 157                 (void) ohci_readl (ohci, &ohci->regs->control);
 158                 ohci_dbg (ohci, "%s root hub\n",
 159                                 autostopped ? "auto-start" : "resume");
 160                 break;
 161         case OHCI_USB_RESUME:
 162                 /* HCFS changes sometime after INTR_RD */
 163                 ohci_dbg(ohci, "%swakeup root hub\n",
 164                                 autostopped ? "auto-" : "");
 165                 break;
 166         case OHCI_USB_OPER:
 167                 /* this can happen after resuming a swsusp snapshot */
 168                 ohci_dbg (ohci, "snapshot resume? reinit\n");
 169                 status = -EBUSY;
 170                 break;
 171         default:                /* RESET, we lost power */
 172                 ohci_dbg (ohci, "lost power\n");
 173                 status = -EBUSY;
 174         }
 175         if (status == -EBUSY) {
 176                 if (!autostopped) {
 177                         spin_unlock_irq (&ohci->lock);
 178                         (void) ohci_init (ohci);
 179                         status = ohci_restart (ohci);
 180
 181                         usb_root_hub_lost_power(hcd->self.root_hub);
 182
 183                         spin_lock_irq (&ohci->lock);
 184                 }
 185                 return status;
 186         }
 187         if (status != -EINPROGRESS)
 188                 return status;
 189         if (autostopped)
 190                 goto skip_resume;
 191         spin_unlock_irq (&ohci->lock);
 192
 193         /* Some controllers (lucent erratum) need extra-long delays */
 194         msleep (20 /* usb 11.5.1.10 */ + 12 /* 32 msec counter */ + 1);
 195
 196         temp = ohci_readl (ohci, &ohci->regs->control);
 197         temp &= OHCI_CTRL_HCFS;
 198         if (temp != OHCI_USB_RESUME) {
 199                 ohci_err (ohci, "controller won't resume\n");
 200                 spin_lock_irq(&ohci->lock);
 201                 return -EBUSY;
 202         }
 203
 204         /* disable old schedule state, reinit from scratch */
 205         ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
 206         ohci_writel (ohci, 0, &ohci->regs->ed_controlcurrent);
 207         ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
 208         ohci_writel (ohci, 0, &ohci->regs->ed_bulkcurrent);
 209         ohci_writel (ohci, 0, &ohci->regs->ed_periodcurrent);
 210         ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
 211
 212         /* Sometimes PCI D3 suspend trashes frame timings ... */
 213         periodic_reinit (ohci);
 214
 215         /* the following code is executed with ohci->lock held and
 216          * irqs disabled if and only if autostopped is true
 217          */
 218
 219 skip_resume:
 220         /* interrupts might have been disabled */
 221         ohci_writel (ohci, OHCI_INTR_INIT, &ohci->regs->intrenable);
 222         if (ohci->ed_rm_list)
 223                 ohci_writel (ohci, OHCI_INTR_SF, &ohci->regs->intrenable);
 224
 225         /* Then re-enable operations */
 226         ohci_writel (ohci, OHCI_USB_OPER, &ohci->regs->control);
 227         (void) ohci_readl (ohci, &ohci->regs->control);
 228         if (!autostopped)
 229                 msleep (3);
 230
 231         temp = ohci->hc_control;
 232         temp &= OHCI_CTRL_RWC;
 233         temp |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
 234         ohci->hc_control = temp;
 235         ohci_writel (ohci, temp, &ohci->regs->control);
 236         (void) ohci_readl (ohci, &ohci->regs->control);
 237
 238         /* TRSMRCY */
 239         if (!autostopped) {
 240                 msleep (10);
 241                 spin_lock_irq (&ohci->lock);
 242         }
 243         /* now ohci->lock is always held and irqs are always disabled */
 244
 245         /* keep it alive for more than ~5x suspend + resume costs */
 246         ohci->next_statechange = jiffies + STATECHANGE_DELAY;
 247
 248         /* maybe turn schedules back on */
 249         enables = 0;
 250         temp = 0;
 251         if (!ohci->ed_rm_list) {
 252                 if (ohci->ed_controltail) {
 253                         ohci_writel (ohci,
 254                                         find_head (ohci->ed_controltail)->dma,
 255                                         &ohci->regs->ed_controlhead);
 256                         enables |= OHCI_CTRL_CLE;
 257                         temp |= OHCI_CLF;
 258                 }
 259                 if (ohci->ed_bulktail) {
 260                         ohci_writel (ohci, find_head (ohci->ed_bulktail)->dma,
 261                                 &ohci->regs->ed_bulkhead);
 262                         enables |= OHCI_CTRL_BLE;
 263                         temp |= OHCI_BLF;
 264                 }
 265         }
 266         if (hcd->self.bandwidth_isoc_reqs || hcd->self.bandwidth_int_reqs)
 267                 enables |= OHCI_CTRL_PLE|OHCI_CTRL_IE;
 268         if (enables) {
 269                 ohci_dbg (ohci, "restarting schedules ... %08x\n", enables);
 270                 ohci->hc_control |= enables;
 271                 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 272                 if (temp)
 273                         ohci_writel (ohci, temp, &ohci->regs->cmdstatus);
 274                 (void) ohci_readl (ohci, &ohci->regs->control);
 275         }
 276
 277         return 0;
 278 }
 279
 280 static int ohci_bus_suspend (struct usb_hcd *hcd)
 281 {
 282         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 283         int                     rc;
 284
 285         spin_lock_irq (&ohci->lock);
 286
 287         if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
 288                 rc = -ESHUTDOWN;
 289         else
 290                 rc = ohci_rh_suspend (ohci, 0);
 291         spin_unlock_irq (&ohci->lock);
 292         return rc;
 293 }
 294
 295 static int ohci_bus_resume (struct usb_hcd *hcd)
 296 {
 297         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 298         int                     rc;
 299
 300         if (time_before (jiffies, ohci->next_statechange))
 301                 msleep(5);
 302
 303         spin_lock_irq (&ohci->lock);
 304
 305         if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
 306                 rc = -ESHUTDOWN;
 307         else
 308                 rc = ohci_rh_resume (ohci);
 309         spin_unlock_irq (&ohci->lock);
 310
 311         /* poll until we know a device is connected or we autostop */
 312         if (rc == 0)
 313                 usb_hcd_poll_rh_status(hcd);
 314         return rc;
 315 }
 316
 317 /* Carry out the final steps of resuming the controller device */
 318 static void ohci_finish_controller_resume(struct usb_hcd *hcd)
 319 {
 320         struct ohci_hcd         *ohci = hcd_to_ohci(hcd);
 321         int                     port;
 322         bool                    need_reinit = false;
 323
 324         /* See if the controller is already running or has been reset */
 325         ohci->hc_control = ohci_readl(ohci, &ohci->regs->control);
 326         if (ohci->hc_control & (OHCI_CTRL_IR | OHCI_SCHED_ENABLES)) {
 327                 need_reinit = true;
 328         } else {
 329                 switch (ohci->hc_control & OHCI_CTRL_HCFS) {
 330                 case OHCI_USB_OPER:
 331                 case OHCI_USB_RESET:
 332                         need_reinit = true;
 333                 }
 334         }
 335
 336         /* If needed, reinitialize and suspend the root hub */
 337         if (need_reinit) {
 338                 spin_lock_irq(&ohci->lock);
 339                 hcd->state = HC_STATE_RESUMING;
 340                 ohci_rh_resume(ohci);
 341                 hcd->state = HC_STATE_QUIESCING;
 342                 ohci_rh_suspend(ohci, 0);
 343                 hcd->state = HC_STATE_SUSPENDED;
 344                 spin_unlock_irq(&ohci->lock);
 345         }
 346
 347         /* Normally just turn on port power and enable interrupts */
 348         else {
 349                 ohci_dbg(ohci, "powerup ports\n");
 350                 for (port = 0; port < ohci->num_ports; port++)
 351                         ohci_writel(ohci, RH_PS_PPS,
 352                                         &ohci->regs->roothub.portstatus[port]);
 353
 354                 ohci_writel(ohci, OHCI_INTR_MIE, &ohci->regs->intrenable);
 355                 ohci_readl(ohci, &ohci->regs->intrenable);
 356                 msleep(20);
 357         }
 358
 359         /* Does the root hub have a port wakeup pending? */
 360         if (ohci_readl(ohci, &ohci->regs->intrstatus) &
 361                         (OHCI_INTR_RD | OHCI_INTR_RHSC))
 362                 usb_hcd_resume_root_hub(hcd);
 363 }
 364
 365 /* Carry out polling-, autostop-, and autoresume-related state changes */
 366 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
 367                 int any_connected, int rhsc_status)
 368 {
 369         int     poll_rh = 1;
 370         int     rhsc_enable;
 371
 372         /* Some broken controllers never turn off RHSC in the interrupt
 373          * status register.  For their sake we won't re-enable RHSC
 374          * interrupts if the interrupt bit is already active.
 375          */
 376         rhsc_enable = ohci_readl(ohci, &ohci->regs->intrenable) &
 377                         OHCI_INTR_RHSC;
 378
 379         switch (ohci->hc_control & OHCI_CTRL_HCFS) {
 380         case OHCI_USB_OPER:
 381                 /* If no status changes are pending, enable RHSC interrupts. */
 382                 if (!rhsc_enable && !rhsc_status && !changed) {
 383                         rhsc_enable = OHCI_INTR_RHSC;
 384                         ohci_writel(ohci, rhsc_enable, &ohci->regs->intrenable);
 385                 }
 386
 387                 /* Keep on polling until we know a device is connected
 388                  * and RHSC is enabled, or until we autostop.
 389                  */
 390                 if (!ohci->autostop) {
 391                         if (any_connected ||
 392                                         !device_may_wakeup(&ohci_to_hcd(ohci)
 393                                                 ->self.root_hub->dev)) {
 394                                 if (rhsc_enable)
 395                                         poll_rh = 0;
 396                         } else {
 397                                 ohci->autostop = 1;
 398                                 ohci->next_statechange = jiffies + HZ;
 399                         }
 400
 401                 /* if no devices have been attached for one second, autostop */
 402                 } else {
 403                         if (changed || any_connected) {
 404                                 ohci->autostop = 0;
 405                                 ohci->next_statechange = jiffies +
 406                                                 STATECHANGE_DELAY;
 407                         } else if (time_after_eq(jiffies,
 408                                                 ohci->next_statechange)
 409                                         && !ohci->ed_rm_list
 410                                         && !(ohci->hc_control &
 411                                                 OHCI_SCHED_ENABLES)) {
 412                                 ohci_rh_suspend(ohci, 1);
 413                                 if (rhsc_enable)
 414                                         poll_rh = 0;
 415                         }
 416                 }
 417                 break;
 418
 419         case OHCI_USB_SUSPEND:
 420         case OHCI_USB_RESUME:
 421                 /* if there is a port change, autostart or ask to be resumed */
 422                 if (changed) {
 423                         if (ohci->autostop)
 424                                 ohci_rh_resume(ohci);
 425                         else
 426                                 usb_hcd_resume_root_hub(ohci_to_hcd(ohci));
 427
 428                 /* If remote wakeup is disabled, stop polling */
 429                 } else if (!ohci->autostop &&
 430                                 !ohci_to_hcd(ohci)->self.root_hub->
 431                                         do_remote_wakeup) {
 432                         poll_rh = 0;
 433
 434                 } else {
 435                         /* If no status changes are pending,
 436                          * enable RHSC interrupts
 437                          */
 438                         if (!rhsc_enable && !rhsc_status) {
 439                                 rhsc_enable = OHCI_INTR_RHSC;
 440                                 ohci_writel(ohci, rhsc_enable,
 441                                                 &ohci->regs->intrenable);
 442                         }
 443                         /* Keep polling until RHSC is enabled */
 444                         if (rhsc_enable)
 445                                 poll_rh = 0;
 446                 }
 447                 break;
 448         }
 449         return poll_rh;
 450 }
 451
 452 #else   /* CONFIG_PM */
 453
 454 static inline int ohci_rh_resume(struct ohci_hcd *ohci)
 455 {
 456         return 0;
 457 }
 458
 459 /* Carry out polling-related state changes.
 460  * autostop isn't used when CONFIG_PM is turned off.
 461  */
 462 static int ohci_root_hub_state_changes(struct ohci_hcd *ohci, int changed,
 463                 int any_connected, int rhsc_status)
 464 {
 465         /* If RHSC is enabled, don't poll */
 466         if (ohci_readl(ohci, &ohci->regs->intrenable) & OHCI_INTR_RHSC)
 467                 return 0;
 468
 469         /* If status changes are pending, continue polling.
 470          * Conversely, if no status changes are pending but the RHSC
 471          * status bit was set, then RHSC may be broken so continue polling.
 472          */
 473         if (changed || rhsc_status)
 474                 return 1;
 475
 476         /* It's safe to re-enable RHSC interrupts */
 477         ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrenable);
 478         return 0;
 479 }
 480
 481 #endif  /* CONFIG_PM */
 482
 483 /*-------------------------------------------------------------------------*/
 484
 485 /* build "status change" packet (one or two bytes) from HC registers */
 486
 487 static int
 488 ohci_hub_status_data (struct usb_hcd *hcd, char *buf)
 489 {
 490         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
 491         int             i, changed = 0, length = 1;
 492         int             any_connected = 0;
 493         int             rhsc_status;
 494         unsigned long   flags;
 495
 496         spin_lock_irqsave (&ohci->lock, flags);
 497         if (!HCD_HW_ACCESSIBLE(hcd))
 498                 goto done;
 499
 500         /* undocumented erratum seen on at least rev D */
 501         if ((ohci->flags & OHCI_QUIRK_AMD756)
 502                         && (roothub_a (ohci) & RH_A_NDP) > MAX_ROOT_PORTS) {
 503                 ohci_warn (ohci, "bogus NDP, rereads as NDP=%d\n",
 504                           ohci_readl (ohci, &ohci->regs->roothub.a) & RH_A_NDP);
 505                 /* retry later; "should not happen" */
 506                 goto done;
 507         }
 508
 509         /* init status */
 510         if (roothub_status (ohci) & (RH_HS_LPSC | RH_HS_OCIC))
 511                 buf [0] = changed = 1;
 512         else
 513                 buf [0] = 0;
 514         if (ohci->num_ports > 7) {
 515                 buf [1] = 0;
 516                 length++;
 517         }
 518
 519         /* Clear the RHSC status flag before reading the port statuses */
 520         ohci_writel(ohci, OHCI_INTR_RHSC, &ohci->regs->intrstatus);
 521         rhsc_status = ohci_readl(ohci, &ohci->regs->intrstatus) &
 522                         OHCI_INTR_RHSC;
 523
 524         /* look at each port */
 525         for (i = 0; i < ohci->num_ports; i++) {
 526                 u32     status = roothub_portstatus (ohci, i);
 527
 528                 /* can't autostop if ports are connected */
 529                 any_connected |= (status & RH_PS_CCS);
 530
 531                 if (status & (RH_PS_CSC | RH_PS_PESC | RH_PS_PSSC
 532                                 | RH_PS_OCIC | RH_PS_PRSC)) {
 533                         changed = 1;
 534                         if (i < 7)
 535                             buf [0] |= 1 << (i + 1);
 536                         else
 537                             buf [1] |= 1 << (i - 7);
 538                 }
 539         }
 540
 541         if (ohci_root_hub_state_changes(ohci, changed,
 542                         any_connected, rhsc_status))
 543                 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
 544         else
 545                 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
 546
 547
 548 done:
 549         spin_unlock_irqrestore (&ohci->lock, flags);
 550
 551         return changed ? length : 0;
 552 }
 553
 554 /*-------------------------------------------------------------------------*/
 555
 556 static void
 557 ohci_hub_descriptor (
 558         struct ohci_hcd                 *ohci,
 559         struct usb_hub_descriptor       *desc
 560 ) {
 561         u32             rh = roothub_a (ohci);
 562         u16             temp;
 563
 564         desc->bDescriptorType = 0x29;
 565         desc->bPwrOn2PwrGood = (rh & RH_A_POTPGT) >> 24;
 566         desc->bHubContrCurrent = 0;
 567
 568         desc->bNbrPorts = ohci->num_ports;
 569         temp = 1 + (ohci->num_ports / 8);
 570         desc->bDescLength = 7 + 2 * temp;
 571
 572         temp = 0;
 573         if (rh & RH_A_NPS)              /* no power switching? */
 574             temp |= 0x0002;
 575         if (rh & RH_A_PSM)              /* per-port power switching? */
 576             temp |= 0x0001;
 577         if (rh & RH_A_NOCP)             /* no overcurrent reporting? */
 578             temp |= 0x0010;
 579         else if (rh & RH_A_OCPM)        /* per-port overcurrent reporting? */
 580             temp |= 0x0008;
 581         desc->wHubCharacteristics = (__force __u16)cpu_to_hc16(ohci, temp);
 582
 583         /* two bitmaps:  ports removable, and usb 1.0 legacy PortPwrCtrlMask */
 584         rh = roothub_b (ohci);
 585         memset(desc->bitmap, 0xff, sizeof(desc->bitmap));
 586         desc->bitmap [0] = rh & RH_B_DR;
 587         if (ohci->num_ports > 7) {
 588                 desc->bitmap [1] = (rh & RH_B_DR) >> 8;
 589                 desc->bitmap [2] = 0xff;
 590         } else
 591                 desc->bitmap [1] = 0xff;
 592 }
 593
 594 /*-------------------------------------------------------------------------*/
 595
 596 #ifdef  CONFIG_USB_OTG
 597
 598 static int ohci_start_port_reset (struct usb_hcd *hcd, unsigned port)
 599 {
 600         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
 601         u32                     status;
 602
 603         if (!port)
 604                 return -EINVAL;
 605         port--;
 606
 607         /* start port reset before HNP protocol times out */
 608         status = ohci_readl(ohci, &ohci->regs->roothub.portstatus [port]);
 609         if (!(status & RH_PS_CCS))
 610                 return -ENODEV;
 611
 612         /* khubd will finish the reset later */
 613         ohci_writel(ohci, RH_PS_PRS, &ohci->regs->roothub.portstatus [port]);
 614         return 0;
 615 }
 616
 617 #else
 618
 619 #define ohci_start_port_reset           NULL
 620
 621 #endif
 622
 623 /*-------------------------------------------------------------------------*/
 624
 625
 626 /* See usb 7.1.7.5:  root hubs must issue at least 50 msec reset signaling,
 627  * not necessarily continuous ... to guard against resume signaling.
 628  * The short timeout is safe for non-root hubs, and is backward-compatible
 629  * with earlier Linux hosts.
 630  */
 631 #ifdef  CONFIG_USB_SUSPEND
 632 #define PORT_RESET_MSEC         50
 633 #else
 634 #define PORT_RESET_MSEC         10
 635 #endif
 636
 637 /* this timer value might be vendor-specific ... */
 638 #define PORT_RESET_HW_MSEC      10
 639
 640 /* wrap-aware logic morphed from <linux/jiffies.h> */
 641 #define tick_before(t1,t2) ((s16)(((s16)(t1))-((s16)(t2))) < 0)
 642
 643 /* called from some task, normally khubd */
 644 static inline int root_port_reset (struct ohci_hcd *ohci, unsigned port)
 645 {
 646         __hc32 __iomem *portstat = &ohci->regs->roothub.portstatus [port];
 647         u32     temp = 0;
 648         u16     now = ohci_readl(ohci, &ohci->regs->fmnumber);
 649         u16     reset_done = now + PORT_RESET_MSEC;
 650         int     limit_1 = DIV_ROUND_UP(PORT_RESET_MSEC, PORT_RESET_HW_MSEC);
 651
 652         /* build a "continuous enough" reset signal, with up to
 653          * 3msec gap between pulses.  scheduler HZ==100 must work;
 654          * this might need to be deadline-scheduled.
 655          */
 656         do {
 657                 int limit_2;
 658
 659                 /* spin until any current reset finishes */
 660                 limit_2 = PORT_RESET_HW_MSEC * 2;
 661                 while (--limit_2 >= 0) {
 662                         temp = ohci_readl (ohci, portstat);
 663                         /* handle e.g. CardBus eject */
 664                         if (temp == ~(u32)0)
 665                                 return -ESHUTDOWN;
 666                         if (!(temp & RH_PS_PRS))
 667                                 break;
 668                         udelay (500);
 669                 }
 670
 671                 /* timeout (a hardware error) has been observed when
 672                  * EHCI sets CF while this driver is resetting a port;
 673                  * presumably other disconnect paths might do it too.
 674                  */
 675                 if (limit_2 < 0) {
 676                         ohci_dbg(ohci,
 677                                 "port[%d] reset timeout, stat %08x\n",
 678                                 port, temp);
 679                         break;
 680                 }
 681
 682                 if (!(temp & RH_PS_CCS))
 683                         break;
 684                 if (temp & RH_PS_PRSC)
 685                         ohci_writel (ohci, RH_PS_PRSC, portstat);
 686
 687                 /* start the next reset, sleep till it's probably done */
 688                 ohci_writel (ohci, RH_PS_PRS, portstat);
 689                 msleep(PORT_RESET_HW_MSEC);
 690                 now = ohci_readl(ohci, &ohci->regs->fmnumber);
 691         } while (tick_before(now, reset_done) && --limit_1 >= 0);
 692
 693         /* caller synchronizes using PRSC ... and handles PRS
 694          * still being set when this returns.
 695          */
 696
 697         return 0;
 698 }
 699
 700 static int ohci_hub_control (
 701         struct usb_hcd  *hcd,
 702         u16             typeReq,
 703         u16             wValue,
 704         u16             wIndex,
 705         char            *buf,
 706         u16             wLength
 707 ) {
 708         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
 709         int             ports = ohci->num_ports;
 710         u32             temp;
 711         int             retval = 0;
 712
 713         if (unlikely(!HCD_HW_ACCESSIBLE(hcd)))
 714                 return -ESHUTDOWN;
 715
 716         switch (typeReq) {
 717         case ClearHubFeature:
 718                 switch (wValue) {
 719                 case C_HUB_OVER_CURRENT:
 720                         ohci_writel (ohci, RH_HS_OCIC,
 721                                         &ohci->regs->roothub.status);
 722                 case C_HUB_LOCAL_POWER:
 723                         break;
 724                 default:
 725                         goto error;
 726                 }
 727                 break;
 728         case ClearPortFeature:
 729                 if (!wIndex || wIndex > ports)
 730                         goto error;
 731                 wIndex--;
 732
 733                 switch (wValue) {
 734                 case USB_PORT_FEAT_ENABLE:
 735                         temp = RH_PS_CCS;
 736                         break;
 737                 case USB_PORT_FEAT_C_ENABLE:
 738                         temp = RH_PS_PESC;
 739                         break;
 740                 case USB_PORT_FEAT_SUSPEND:
 741                         temp = RH_PS_POCI;
 742                         break;
 743                 case USB_PORT_FEAT_C_SUSPEND:
 744                         temp = RH_PS_PSSC;
 745                         break;
 746                 case USB_PORT_FEAT_POWER:
 747                         temp = RH_PS_LSDA;
 748                         break;
 749                 case USB_PORT_FEAT_C_CONNECTION:
 750                         temp = RH_PS_CSC;
 751                         break;
 752                 case USB_PORT_FEAT_C_OVER_CURRENT:
 753                         temp = RH_PS_OCIC;
 754                         break;
 755                 case USB_PORT_FEAT_C_RESET:
 756                         temp = RH_PS_PRSC;
 757                         break;
 758                 default:
 759                         goto error;
 760                 }
 761                 ohci_writel (ohci, temp,
 762                                 &ohci->regs->roothub.portstatus [wIndex]);
 763                 // ohci_readl (ohci, &ohci->regs->roothub.portstatus [wIndex]);
 764                 break;
 765         case GetHubDescriptor:
 766                 ohci_hub_descriptor (ohci, (struct usb_hub_descriptor *) buf);
 767                 break;
 768         case GetHubStatus:
 769                 temp = roothub_status (ohci) & ~(RH_HS_CRWE | RH_HS_DRWE);
 770                 put_unaligned_le32(temp, buf);
 771                 break;
 772         case GetPortStatus:
 773                 if (!wIndex || wIndex > ports)
 774                         goto error;
 775                 wIndex--;
 776                 temp = roothub_portstatus (ohci, wIndex);
 777                 put_unaligned_le32(temp, buf);
 778
 779 #ifndef OHCI_VERBOSE_DEBUG
 780         if (*(u16*)(buf+2))     /* only if wPortChange is interesting */
 781 #endif
 782                 dbg_port (ohci, "GetStatus", wIndex, temp);
 783                 break;
 784         case SetHubFeature:
 785                 switch (wValue) {
 786                 case C_HUB_OVER_CURRENT:
 787                         // FIXME:  this can be cleared, yes?
 788                 case C_HUB_LOCAL_POWER:
 789                         break;
 790                 default:
 791                         goto error;
 792                 }
 793                 break;
 794         case SetPortFeature:
 795                 if (!wIndex || wIndex > ports)
 796                         goto error;
 797                 wIndex--;
 798                 switch (wValue) {
 799                 case USB_PORT_FEAT_SUSPEND:
 800 #ifdef  CONFIG_USB_OTG
 801                         if (hcd->self.otg_port == (wIndex + 1)
 802                                         && hcd->self.b_hnp_enable)
 803                                 ohci->start_hnp(ohci);
 804                         else
 805 #endif
 806                         ohci_writel (ohci, RH_PS_PSS,
 807                                 &ohci->regs->roothub.portstatus [wIndex]);
 808                         break;
 809                 case USB_PORT_FEAT_POWER:
 810                         ohci_writel (ohci, RH_PS_PPS,
 811                                 &ohci->regs->roothub.portstatus [wIndex]);
 812                         break;
 813                 case USB_PORT_FEAT_RESET:
 814                         retval = root_port_reset (ohci, wIndex);
 815                         break;
 816                 default:
 817                         goto error;
 818                 }
 819                 break;
 820
 821         default:
 822 error:
 823                 /* "protocol stall" on error */
 824                 retval = -EPIPE;
 825         }
 826         return retval;
 827 }
 828