drivers/usb/host/ohci-hcd.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  * [ Initialisation is based on Linus'  ]
   8  * [ uhci code and gregs ohci fragments ]
   9  * [ (C) Copyright 1999 Linus Torvalds  ]
  10  * [ (C) Copyright 1999 Gregory P. Smith]
  11  *
  12  *
  13  * OHCI is the main "non-Intel/VIA" standard for USB 1.1 host controller
  14  * interfaces (though some non-x86 Intel chips use it).  It supports
  15  * smarter hardware than UHCI.  A download link for the spec available
  16  * through the http://www.usb.org website.
  17  *
  18  * This file is licenced under the GPL.
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/moduleparam.h>
  23 #include <linux/pci.h>
  24 #include <linux/kernel.h>
  25 #include <linux/delay.h>
  26 #include <linux/ioport.h>
  27 #include <linux/sched.h>
  28 #include <linux/slab.h>
  29 #include <linux/errno.h>
  30 #include <linux/init.h>
  31 #include <linux/timer.h>
  32 #include <linux/list.h>
  33 #include <linux/usb.h>
  34 #include <linux/usb/otg.h>
  35 #include <linux/dma-mapping.h>
  36 #include <linux/dmapool.h>
  37 #include <linux/reboot.h>
  38 #include <linux/workqueue.h>
  39
  40 #include <asm/io.h>
  41 #include <asm/irq.h>
  42 #include <asm/system.h>
  43 #include <asm/unaligned.h>
  44 #include <asm/byteorder.h>
  45
  46 #include "../core/hcd.h"
  47
  48 #define DRIVER_VERSION "2006 August 04"
  49 #define DRIVER_AUTHOR "Roman Weissgaerber, David Brownell"
  50 #define DRIVER_DESC "USB 1.1 'Open' Host Controller (OHCI) Driver"
  51
  52 /*-------------------------------------------------------------------------*/
  53
  54 #undef OHCI_VERBOSE_DEBUG       /* not always helpful */
  55
  56 /* For initializing controller (mask in an HCFS mode too) */
  57 #define OHCI_CONTROL_INIT       OHCI_CTRL_CBSR
  58 #define OHCI_INTR_INIT \
  59                 (OHCI_INTR_MIE | OHCI_INTR_RHSC | OHCI_INTR_UE \
  60                 | OHCI_INTR_RD | OHCI_INTR_WDH)
  61
  62 #ifdef __hppa__
  63 /* On PA-RISC, PDC can leave IR set incorrectly; ignore it there. */
  64 #define IR_DISABLE
  65 #endif
  66
  67 #ifdef CONFIG_ARCH_OMAP
  68 /* OMAP doesn't support IR (no SMM; not needed) */
  69 #define IR_DISABLE
  70 #endif
  71
  72 /*-------------------------------------------------------------------------*/
  73
  74 static const char       hcd_name [] = "ohci_hcd";
  75
  76 #define STATECHANGE_DELAY       msecs_to_jiffies(300)
  77
  78 #include "ohci.h"
  79
  80 static void ohci_dump (struct ohci_hcd *ohci, int verbose);
  81 static int ohci_init (struct ohci_hcd *ohci);
  82 static void ohci_stop (struct usb_hcd *hcd);
  83 static int ohci_restart (struct ohci_hcd *ohci);
  84
  85 #include "ohci-hub.c"
  86 #include "ohci-dbg.c"
  87 #include "ohci-mem.c"
  88 #include "ohci-q.c"
  89
  90
  91 /*
  92  * On architectures with edge-triggered interrupts we must never return
  93  * IRQ_NONE.
  94  */
  95 #if defined(CONFIG_SA1111)  /* ... or other edge-triggered systems */
  96 #define IRQ_NOTMINE     IRQ_HANDLED
  97 #else
  98 #define IRQ_NOTMINE     IRQ_NONE
  99 #endif
 100
 101
 102 /* Some boards misreport power switching/overcurrent */
 103 static int distrust_firmware = 1;
 104 module_param (distrust_firmware, bool, 0);
 105 MODULE_PARM_DESC (distrust_firmware,
 106         "true to distrust firmware power/overcurrent setup");
 107
 108 /* Some boards leave IR set wrongly, since they fail BIOS/SMM handshakes */
 109 static int no_handshake = 0;
 110 module_param (no_handshake, bool, 0);
 111 MODULE_PARM_DESC (no_handshake, "true (not default) disables BIOS handshake");
 112
 113 /*-------------------------------------------------------------------------*/
 114
 115 /*
 116  * queue up an urb for anything except the root hub
 117  */
 118 static int ohci_urb_enqueue (
 119         struct usb_hcd  *hcd,
 120         struct usb_host_endpoint *ep,
 121         struct urb      *urb,
 122         gfp_t           mem_flags
 123 ) {
 124         struct ohci_hcd *ohci = hcd_to_ohci (hcd);
 125         struct ed       *ed;
 126         urb_priv_t      *urb_priv;
 127         unsigned int    pipe = urb->pipe;
 128         int             i, size = 0;
 129         unsigned long   flags;
 130         int             retval = 0;
 131
 132 #ifdef OHCI_VERBOSE_DEBUG
 133         urb_print (urb, "SUB", usb_pipein (pipe));
 134 #endif
 135
 136         /* every endpoint has a ed, locate and maybe (re)initialize it */
 137         if (! (ed = ed_get (ohci, ep, urb->dev, pipe, urb->interval)))
 138                 return -ENOMEM;
 139
 140         /* for the private part of the URB we need the number of TDs (size) */
 141         switch (ed->type) {
 142                 case PIPE_CONTROL:
 143                         /* td_submit_urb() doesn't yet handle these */
 144                         if (urb->transfer_buffer_length > 4096)
 145                                 return -EMSGSIZE;
 146
 147                         /* 1 TD for setup, 1 for ACK, plus ... */
 148                         size = 2;
 149                         /* FALLTHROUGH */
 150                 // case PIPE_INTERRUPT:
 151                 // case PIPE_BULK:
 152                 default:
 153                         /* one TD for every 4096 Bytes (can be upto 8K) */
 154                         size += urb->transfer_buffer_length / 4096;
 155                         /* ... and for any remaining bytes ... */
 156                         if ((urb->transfer_buffer_length % 4096) != 0)
 157                                 size++;
 158                         /* ... and maybe a zero length packet to wrap it up */
 159                         if (size == 0)
 160                                 size++;
 161                         else if ((urb->transfer_flags & URB_ZERO_PACKET) != 0
 162                                 && (urb->transfer_buffer_length
 163                                         % usb_maxpacket (urb->dev, pipe,
 164                                                 usb_pipeout (pipe))) == 0)
 165                                 size++;
 166                         break;
 167                 case PIPE_ISOCHRONOUS: /* number of packets from URB */
 168                         size = urb->number_of_packets;
 169                         break;
 170         }
 171
 172         /* allocate the private part of the URB */
 173         urb_priv = kzalloc (sizeof (urb_priv_t) + size * sizeof (struct td *),
 174                         mem_flags);
 175         if (!urb_priv)
 176                 return -ENOMEM;
 177         INIT_LIST_HEAD (&urb_priv->pending);
 178         urb_priv->length = size;
 179         urb_priv->ed = ed;
 180
 181         /* allocate the TDs (deferring hash chain updates) */
 182         for (i = 0; i < size; i++) {
 183                 urb_priv->td [i] = td_alloc (ohci, mem_flags);
 184                 if (!urb_priv->td [i]) {
 185                         urb_priv->length = i;
 186                         urb_free_priv (ohci, urb_priv);
 187                         return -ENOMEM;
 188                 }
 189         }
 190
 191         spin_lock_irqsave (&ohci->lock, flags);
 192
 193         /* don't submit to a dead HC */
 194         if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
 195                 retval = -ENODEV;
 196                 goto fail;
 197         }
 198         if (!HC_IS_RUNNING(hcd->state)) {
 199                 retval = -ENODEV;
 200                 goto fail;
 201         }
 202
 203         /* in case of unlink-during-submit */
 204         spin_lock (&urb->lock);
 205         if (urb->status != -EINPROGRESS) {
 206                 spin_unlock (&urb->lock);
 207                 urb->hcpriv = urb_priv;
 208                 finish_urb (ohci, urb);
 209                 retval = 0;
 210                 goto fail;
 211         }
 212
 213         /* schedule the ed if needed */
 214         if (ed->state == ED_IDLE) {
 215                 retval = ed_schedule (ohci, ed);
 216                 if (retval < 0)
 217                         goto fail0;
 218                 if (ed->type == PIPE_ISOCHRONOUS) {
 219                         u16     frame = ohci_frame_no(ohci);
 220
 221                         /* delay a few frames before the first TD */
 222                         frame += max_t (u16, 8, ed->interval);
 223                         frame &= ~(ed->interval - 1);
 224                         frame |= ed->branch;
 225                         urb->start_frame = frame;
 226
 227                         /* yes, only URB_ISO_ASAP is supported, and
 228                          * urb->start_frame is never used as input.
 229                          */
 230                 }
 231         } else if (ed->type == PIPE_ISOCHRONOUS)
 232                 urb->start_frame = ed->last_iso + ed->interval;
 233
 234         /* fill the TDs and link them to the ed; and
 235          * enable that part of the schedule, if needed
 236          * and update count of queued periodic urbs
 237          */
 238         urb->hcpriv = urb_priv;
 239         td_submit_urb (ohci, urb);
 240
 241 fail0:
 242         spin_unlock (&urb->lock);
 243 fail:
 244         if (retval)
 245                 urb_free_priv (ohci, urb_priv);
 246         spin_unlock_irqrestore (&ohci->lock, flags);
 247         return retval;
 248 }
 249
 250 /*
 251  * decouple the URB from the HC queues (TDs, urb_priv); it's
 252  * already marked using urb->status.  reporting is always done
 253  * asynchronously, and we might be dealing with an urb that's
 254  * partially transferred, or an ED with other urbs being unlinked.
 255  */
 256 static int ohci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 257 {
 258         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 259         unsigned long           flags;
 260
 261 #ifdef OHCI_VERBOSE_DEBUG
 262         urb_print (urb, "UNLINK", 1);
 263 #endif
 264
 265         spin_lock_irqsave (&ohci->lock, flags);
 266         if (HC_IS_RUNNING(hcd->state)) {
 267                 urb_priv_t  *urb_priv;
 268
 269                 /* Unless an IRQ completed the unlink while it was being
 270                  * handed to us, flag it for unlink and giveback, and force
 271                  * some upcoming INTR_SF to call finish_unlinks()
 272                  */
 273                 urb_priv = urb->hcpriv;
 274                 if (urb_priv) {
 275                         if (urb_priv->ed->state == ED_OPER)
 276                                 start_ed_unlink (ohci, urb_priv->ed);
 277                 }
 278         } else {
 279                 /*
 280                  * with HC dead, we won't respect hc queue pointers
 281                  * any more ... just clean up every urb's memory.
 282                  */
 283                 if (urb->hcpriv)
 284                         finish_urb (ohci, urb);
 285         }
 286         spin_unlock_irqrestore (&ohci->lock, flags);
 287         return 0;
 288 }
 289
 290 /*-------------------------------------------------------------------------*/
 291
 292 /* frees config/altsetting state for endpoints,
 293  * including ED memory, dummy TD, and bulk/intr data toggle
 294  */
 295
 296 static void
 297 ohci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
 298 {
 299         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 300         unsigned long           flags;
 301         struct ed               *ed = ep->hcpriv;
 302         unsigned                limit = 1000;
 303
 304         /* ASSERT:  any requests/urbs are being unlinked */
 305         /* ASSERT:  nobody can be submitting urbs for this any more */
 306
 307         if (!ed)
 308                 return;
 309
 310 rescan:
 311         spin_lock_irqsave (&ohci->lock, flags);
 312
 313         if (!HC_IS_RUNNING (hcd->state)) {
 314 sanitize:
 315                 ed->state = ED_IDLE;
 316                 if (quirk_zfmicro(ohci) && ed->type == PIPE_INTERRUPT)
 317                         ohci->eds_scheduled--;
 318                 finish_unlinks (ohci, 0);
 319         }
 320
 321         switch (ed->state) {
 322         case ED_UNLINK:         /* wait for hw to finish? */
 323                 /* major IRQ delivery trouble loses INTR_SF too... */
 324                 if (limit-- == 0) {
 325                         ohci_warn(ohci, "ED unlink timeout\n");
 326                         if (quirk_zfmicro(ohci)) {
 327                                 ohci_warn(ohci, "Attempting ZF TD recovery\n");
 328                                 ohci->ed_to_check = ed;
 329                                 ohci->zf_delay = 2;
 330                         }
 331                         goto sanitize;
 332                 }
 333                 spin_unlock_irqrestore (&ohci->lock, flags);
 334                 schedule_timeout_uninterruptible(1);
 335                 goto rescan;
 336         case ED_IDLE:           /* fully unlinked */
 337                 if (list_empty (&ed->td_list)) {
 338                         td_free (ohci, ed->dummy);
 339                         ed_free (ohci, ed);
 340                         break;
 341                 }
 342                 /* else FALL THROUGH */
 343         default:
 344                 /* caller was supposed to have unlinked any requests;
 345                  * that's not our job.  can't recover; must leak ed.
 346                  */
 347                 ohci_err (ohci, "leak ed %p (#%02x) state %d%s\n",
 348                         ed, ep->desc.bEndpointAddress, ed->state,
 349                         list_empty (&ed->td_list) ? "" : " (has tds)");
 350                 td_free (ohci, ed->dummy);
 351                 break;
 352         }
 353         ep->hcpriv = NULL;
 354         spin_unlock_irqrestore (&ohci->lock, flags);
 355         return;
 356 }
 357
 358 static int ohci_get_frame (struct usb_hcd *hcd)
 359 {
 360         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 361
 362         return ohci_frame_no(ohci);
 363 }
 364
 365 static void ohci_usb_reset (struct ohci_hcd *ohci)
 366 {
 367         ohci->hc_control = ohci_readl (ohci, &ohci->regs->control);
 368         ohci->hc_control &= OHCI_CTRL_RWC;
 369         ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 370 }
 371
 372 /* ohci_shutdown forcibly disables IRQs and DMA, helping kexec and
 373  * other cases where the next software may expect clean state from the
 374  * "firmware".  this is bus-neutral, unlike shutdown() methods.
 375  */
 376 static void
 377 ohci_shutdown (struct usb_hcd *hcd)
 378 {
 379         struct ohci_hcd *ohci;
 380
 381         ohci = hcd_to_ohci (hcd);
 382         ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
 383         ohci_usb_reset (ohci);
 384         /* flush the writes */
 385         (void) ohci_readl (ohci, &ohci->regs->control);
 386 }
 387
 388 static int check_ed(struct ohci_hcd *ohci, struct ed *ed)
 389 {
 390         return (hc32_to_cpu(ohci, ed->hwINFO) & ED_IN) != 0
 391                 && (hc32_to_cpu(ohci, ed->hwHeadP) & TD_MASK)
 392                         == (hc32_to_cpu(ohci, ed->hwTailP) & TD_MASK)
 393                 && !list_empty(&ed->td_list);
 394 }
 395
 396 /* ZF Micro watchdog timer callback. The ZF Micro chipset sometimes completes
 397  * an interrupt TD but neglects to add it to the donelist.  On systems with
 398  * this chipset, we need to periodically check the state of the queues to look
 399  * for such "lost" TDs.
 400  */
 401 static void unlink_watchdog_func(unsigned long _ohci)
 402 {
 403         long            flags;
 404         unsigned        max;
 405         unsigned        seen_count = 0;
 406         unsigned        i;
 407         struct ed       **seen = NULL;
 408         struct ohci_hcd *ohci = (struct ohci_hcd *) _ohci;
 409
 410         spin_lock_irqsave(&ohci->lock, flags);
 411         max = ohci->eds_scheduled;
 412         if (!max)
 413                 goto done;
 414
 415         if (ohci->ed_to_check)
 416                 goto out;
 417
 418         seen = kcalloc(max, sizeof *seen, GFP_ATOMIC);
 419         if (!seen)
 420                 goto out;
 421
 422         for (i = 0; i < NUM_INTS; i++) {
 423                 struct ed       *ed = ohci->periodic[i];
 424
 425                 while (ed) {
 426                         unsigned        temp;
 427
 428                         /* scan this branch of the periodic schedule tree */
 429                         for (temp = 0; temp < seen_count; temp++) {
 430                                 if (seen[temp] == ed) {
 431                                         /* we've checked it and what's after */
 432                                         ed = NULL;
 433                                         break;
 434                                 }
 435                         }
 436                         if (!ed)
 437                                 break;
 438                         seen[seen_count++] = ed;
 439                         if (!check_ed(ohci, ed)) {
 440                                 ed = ed->ed_next;
 441                                 continue;
 442                         }
 443
 444                         /* HC's TD list is empty, but HCD sees at least one
 445                          * TD that's not been sent through the donelist.
 446                          */
 447                         ohci->ed_to_check = ed;
 448                         ohci->zf_delay = 2;
 449
 450                         /* The HC may wait until the next frame to report the
 451                          * TD as done through the donelist and INTR_WDH.  (We
 452                          * just *assume* it's not a multi-TD interrupt URB;
 453                          * those could defer the IRQ more than one frame, using
 454                          * DI...)  Check again after the next INTR_SF.
 455                          */
 456                         ohci_writel(ohci, OHCI_INTR_SF,
 457                                         &ohci->regs->intrstatus);
 458                         ohci_writel(ohci, OHCI_INTR_SF,
 459                                         &ohci->regs->intrenable);
 460
 461                         /* flush those writes */
 462                         (void) ohci_readl(ohci, &ohci->regs->control);
 463
 464                         goto out;
 465                 }
 466         }
 467 out:
 468         kfree(seen);
 469         if (ohci->eds_scheduled)
 470                 mod_timer(&ohci->unlink_watchdog, round_jiffies_relative(HZ));
 471 done:
 472         spin_unlock_irqrestore(&ohci->lock, flags);
 473 }
 474
 475 /*-------------------------------------------------------------------------*
 476  * HC functions
 477  *-------------------------------------------------------------------------*/
 478
 479 /* init memory, and kick BIOS/SMM off */
 480
 481 static int ohci_init (struct ohci_hcd *ohci)
 482 {
 483         int ret;
 484         struct usb_hcd *hcd = ohci_to_hcd(ohci);
 485
 486         disable (ohci);
 487         ohci->regs = hcd->regs;
 488
 489         /* REVISIT this BIOS handshake is now moved into PCI "quirks", and
 490          * was never needed for most non-PCI systems ... remove the code?
 491          */
 492
 493 #ifndef IR_DISABLE
 494         /* SMM owns the HC?  not for long! */
 495         if (!no_handshake && ohci_readl (ohci,
 496                                         &ohci->regs->control) & OHCI_CTRL_IR) {
 497                 u32 temp;
 498
 499                 ohci_dbg (ohci, "USB HC TakeOver from BIOS/SMM\n");
 500
 501                 /* this timeout is arbitrary.  we make it long, so systems
 502                  * depending on usb keyboards may be usable even if the
 503                  * BIOS/SMM code seems pretty broken.
 504                  */
 505                 temp = 500;     /* arbitrary: five seconds */
 506
 507                 ohci_writel (ohci, OHCI_INTR_OC, &ohci->regs->intrenable);
 508                 ohci_writel (ohci, OHCI_OCR, &ohci->regs->cmdstatus);
 509                 while (ohci_readl (ohci, &ohci->regs->control) & OHCI_CTRL_IR) {
 510                         msleep (10);
 511                         if (--temp == 0) {
 512                                 ohci_err (ohci, "USB HC takeover failed!"
 513                                         "  (BIOS/SMM bug)\n");
 514                                 return -EBUSY;
 515                         }
 516                 }
 517                 ohci_usb_reset (ohci);
 518         }
 519 #endif
 520
 521         /* Disable HC interrupts */
 522         ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
 523
 524         /* flush the writes, and save key bits like RWC */
 525         if (ohci_readl (ohci, &ohci->regs->control) & OHCI_CTRL_RWC)
 526                 ohci->hc_control |= OHCI_CTRL_RWC;
 527
 528         /* Read the number of ports unless overridden */
 529         if (ohci->num_ports == 0)
 530                 ohci->num_ports = roothub_a(ohci) & RH_A_NDP;
 531
 532         if (ohci->hcca)
 533                 return 0;
 534
 535         ohci->hcca = dma_alloc_coherent (hcd->self.controller,
 536                         sizeof *ohci->hcca, &ohci->hcca_dma, 0);
 537         if (!ohci->hcca)
 538                 return -ENOMEM;
 539
 540         if ((ret = ohci_mem_init (ohci)) < 0)
 541                 ohci_stop (hcd);
 542         else {
 543                 create_debug_files (ohci);
 544         }
 545
 546         return ret;
 547 }
 548
 549 /*-------------------------------------------------------------------------*/
 550
 551 /* Start an OHCI controller, set the BUS operational
 552  * resets USB and controller
 553  * enable interrupts
 554  */
 555 static int ohci_run (struct ohci_hcd *ohci)
 556 {
 557         u32                     mask, temp;
 558         int                     first = ohci->fminterval == 0;
 559         struct usb_hcd          *hcd = ohci_to_hcd(ohci);
 560
 561         disable (ohci);
 562
 563         /* boot firmware should have set this up (5.1.1.3.1) */
 564         if (first) {
 565
 566                 temp = ohci_readl (ohci, &ohci->regs->fminterval);
 567                 ohci->fminterval = temp & 0x3fff;
 568                 if (ohci->fminterval != FI)
 569                         ohci_dbg (ohci, "fminterval delta %d\n",
 570                                 ohci->fminterval - FI);
 571                 ohci->fminterval |= FSMP (ohci->fminterval) << 16;
 572                 /* also: power/overcurrent flags in roothub.a */
 573         }
 574
 575         /* Reset USB nearly "by the book".  RemoteWakeupConnected was
 576          * saved if boot firmware (BIOS/SMM/...) told us it's connected,
 577          * or if bus glue did the same (e.g. for PCI add-in cards with
 578          * PCI PM support).
 579          */
 580         if ((ohci->hc_control & OHCI_CTRL_RWC) != 0
 581                         && !device_may_wakeup(hcd->self.controller))
 582                 device_init_wakeup(hcd->self.controller, 1);
 583
 584         switch (ohci->hc_control & OHCI_CTRL_HCFS) {
 585         case OHCI_USB_OPER:
 586                 temp = 0;
 587                 break;
 588         case OHCI_USB_SUSPEND:
 589         case OHCI_USB_RESUME:
 590                 ohci->hc_control &= OHCI_CTRL_RWC;
 591                 ohci->hc_control |= OHCI_USB_RESUME;
 592                 temp = 10 /* msec wait */;
 593                 break;
 594         // case OHCI_USB_RESET:
 595         default:
 596                 ohci->hc_control &= OHCI_CTRL_RWC;
 597                 ohci->hc_control |= OHCI_USB_RESET;
 598                 temp = 50 /* msec wait */;
 599                 break;
 600         }
 601         ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 602         // flush the writes
 603         (void) ohci_readl (ohci, &ohci->regs->control);
 604         msleep(temp);
 605
 606         memset (ohci->hcca, 0, sizeof (struct ohci_hcca));
 607
 608         /* 2msec timelimit here means no irqs/preempt */
 609         spin_lock_irq (&ohci->lock);
 610
 611 retry:
 612         /* HC Reset requires max 10 us delay */
 613         ohci_writel (ohci, OHCI_HCR,  &ohci->regs->cmdstatus);
 614         temp = 30;      /* ... allow extra time */
 615         while ((ohci_readl (ohci, &ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
 616                 if (--temp == 0) {
 617                         spin_unlock_irq (&ohci->lock);
 618                         ohci_err (ohci, "USB HC reset timed out!\n");
 619                         return -1;
 620                 }
 621                 udelay (1);
 622         }
 623
 624         /* now we're in the SUSPEND state ... must go OPERATIONAL
 625          * within 2msec else HC enters RESUME
 626          *
 627          * ... but some hardware won't init fmInterval "by the book"
 628          * (SiS, OPTi ...), so reset again instead.  SiS doesn't need
 629          * this if we write fmInterval after we're OPERATIONAL.
 630          * Unclear about ALi, ServerWorks, and others ... this could
 631          * easily be a longstanding bug in chip init on Linux.
 632          */
 633         if (ohci->flags & OHCI_QUIRK_INITRESET) {
 634                 ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 635                 // flush those writes
 636                 (void) ohci_readl (ohci, &ohci->regs->control);
 637         }
 638
 639         /* Tell the controller where the control and bulk lists are
 640          * The lists are empty now. */
 641         ohci_writel (ohci, 0, &ohci->regs->ed_controlhead);
 642         ohci_writel (ohci, 0, &ohci->regs->ed_bulkhead);
 643
 644         /* a reset clears this */
 645         ohci_writel (ohci, (u32) ohci->hcca_dma, &ohci->regs->hcca);
 646
 647         periodic_reinit (ohci);
 648
 649         /* some OHCI implementations are finicky about how they init.
 650          * bogus values here mean not even enumeration could work.
 651          */
 652         if ((ohci_readl (ohci, &ohci->regs->fminterval) & 0x3fff0000) == 0
 653                         || !ohci_readl (ohci, &ohci->regs->periodicstart)) {
 654                 if (!(ohci->flags & OHCI_QUIRK_INITRESET)) {
 655                         ohci->flags |= OHCI_QUIRK_INITRESET;
 656                         ohci_dbg (ohci, "enabling initreset quirk\n");
 657                         goto retry;
 658                 }
 659                 spin_unlock_irq (&ohci->lock);
 660                 ohci_err (ohci, "init err (%08x %04x)\n",
 661                         ohci_readl (ohci, &ohci->regs->fminterval),
 662                         ohci_readl (ohci, &ohci->regs->periodicstart));
 663                 return -EOVERFLOW;
 664         }
 665
 666         /* use rhsc irqs after khubd is fully initialized */
 667         hcd->poll_rh = 1;
 668         hcd->uses_new_polling = 1;
 669
 670         /* start controller operations */
 671         ohci->hc_control &= OHCI_CTRL_RWC;
 672         ohci->hc_control |= OHCI_CONTROL_INIT | OHCI_USB_OPER;
 673         ohci_writel (ohci, ohci->hc_control, &ohci->regs->control);
 674         hcd->state = HC_STATE_RUNNING;
 675
 676         /* wake on ConnectStatusChange, matching external hubs */
 677         ohci_writel (ohci, RH_HS_DRWE, &ohci->regs->roothub.status);
 678
 679         /* Choose the interrupts we care about now, others later on demand */
 680         mask = OHCI_INTR_INIT;
 681         ohci_writel (ohci, ~0, &ohci->regs->intrstatus);
 682         ohci_writel (ohci, mask, &ohci->regs->intrenable);
 683
 684         /* handle root hub init quirks ... */
 685         temp = roothub_a (ohci);
 686         temp &= ~(RH_A_PSM | RH_A_OCPM);
 687         if (ohci->flags & OHCI_QUIRK_SUPERIO) {
 688                 /* NSC 87560 and maybe others */
 689                 temp |= RH_A_NOCP;
 690                 temp &= ~(RH_A_POTPGT | RH_A_NPS);
 691                 ohci_writel (ohci, temp, &ohci->regs->roothub.a);
 692         } else if ((ohci->flags & OHCI_QUIRK_AMD756) || distrust_firmware) {
 693                 /* hub power always on; required for AMD-756 and some
 694                  * Mac platforms.  ganged overcurrent reporting, if any.
 695                  */
 696                 temp |= RH_A_NPS;
 697                 ohci_writel (ohci, temp, &ohci->regs->roothub.a);
 698         }
 699         ohci_writel (ohci, RH_HS_LPSC, &ohci->regs->roothub.status);
 700         ohci_writel (ohci, (temp & RH_A_NPS) ? 0 : RH_B_PPCM,
 701                                                 &ohci->regs->roothub.b);
 702         // flush those writes
 703         (void) ohci_readl (ohci, &ohci->regs->control);
 704
 705         ohci->next_statechange = jiffies + STATECHANGE_DELAY;
 706         spin_unlock_irq (&ohci->lock);
 707
 708         // POTPGT delay is bits 24-31, in 2 ms units.
 709         mdelay ((temp >> 23) & 0x1fe);
 710         hcd->state = HC_STATE_RUNNING;
 711
 712         if (quirk_zfmicro(ohci)) {
 713                 /* Create timer to watch for bad queue state on ZF Micro */
 714                 setup_timer(&ohci->unlink_watchdog, unlink_watchdog_func,
 715                                 (unsigned long) ohci);
 716
 717                 ohci->eds_scheduled = 0;
 718                 ohci->ed_to_check = NULL;
 719         }
 720
 721         ohci_dump (ohci, 1);
 722
 723         return 0;
 724 }
 725
 726 /*-------------------------------------------------------------------------*/
 727
 728 /* an interrupt happens */
 729
 730 static irqreturn_t ohci_irq (struct usb_hcd *hcd)
 731 {
 732         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 733         struct ohci_regs __iomem *regs = ohci->regs;
 734         int                     ints;
 735
 736         /* we can eliminate a (slow) ohci_readl()
 737          * if _only_ WDH caused this irq
 738          */
 739         if ((ohci->hcca->done_head != 0)
 740                         && ! (hc32_to_cpup (ohci, &ohci->hcca->done_head)
 741                                 & 0x01)) {
 742                 ints =  OHCI_INTR_WDH;
 743
 744         /* cardbus/... hardware gone before remove() */
 745         } else if ((ints = ohci_readl (ohci, &regs->intrstatus)) == ~(u32)0) {
 746                 disable (ohci);
 747                 ohci_dbg (ohci, "device removed!\n");
 748                 return IRQ_HANDLED;
 749
 750         /* interrupt for some other device? */
 751         } else if ((ints &= ohci_readl (ohci, &regs->intrenable)) == 0) {
 752                 return IRQ_NOTMINE;
 753         }
 754
 755         if (ints & OHCI_INTR_UE) {
 756                 // e.g. due to PCI Master/Target Abort
 757                 if (quirk_nec(ohci)) {
 758                         /* Workaround for a silicon bug in some NEC chips used
 759                          * in Apple's PowerBooks. Adapted from Darwin code.
 760                          */
 761                         ohci_err (ohci, "OHCI Unrecoverable Error, scheduling NEC chip restart\n");
 762
 763                         ohci_writel (ohci, OHCI_INTR_UE, &regs->intrdisable);
 764
 765                         schedule_work (&ohci->nec_work);
 766                 } else {
 767                         disable (ohci);
 768                         ohci_err (ohci, "OHCI Unrecoverable Error, disabled\n");
 769                 }
 770
 771                 ohci_dump (ohci, 1);
 772                 ohci_usb_reset (ohci);
 773         }
 774
 775         if (ints & OHCI_INTR_RHSC) {
 776                 ohci_vdbg(ohci, "rhsc\n");
 777                 ohci->next_statechange = jiffies + STATECHANGE_DELAY;
 778                 ohci_writel(ohci, OHCI_INTR_RD | OHCI_INTR_RHSC,
 779                                 &regs->intrstatus);
 780
 781                 /* NOTE: Vendors didn't always make the same implementation
 782                  * choices for RHSC.  Many followed the spec; RHSC triggers
 783                  * on an edge, like setting and maybe clearing a port status
 784                  * change bit.  With others it's level-triggered, active
 785                  * until khubd clears all the port status change bits.  We'll
 786                  * always disable it here and rely on polling until khubd
 787                  * re-enables it.
 788                  */
 789                 ohci_writel(ohci, OHCI_INTR_RHSC, &regs->intrdisable);
 790                 usb_hcd_poll_rh_status(hcd);
 791         }
 792
 793         /* For connect and disconnect events, we expect the controller
 794          * to turn on RHSC along with RD.  But for remote wakeup events
 795          * this might not happen.
 796          */
 797         else if (ints & OHCI_INTR_RD) {
 798                 ohci_vdbg(ohci, "resume detect\n");
 799                 ohci_writel(ohci, OHCI_INTR_RD, &regs->intrstatus);
 800                 hcd->poll_rh = 1;
 801                 if (ohci->autostop) {
 802                         spin_lock (&ohci->lock);
 803                         ohci_rh_resume (ohci);
 804                         spin_unlock (&ohci->lock);
 805                 } else
 806                         usb_hcd_resume_root_hub(hcd);
 807         }
 808
 809         if (ints & OHCI_INTR_WDH) {
 810                 if (HC_IS_RUNNING(hcd->state))
 811                         ohci_writel (ohci, OHCI_INTR_WDH, &regs->intrdisable);
 812                 spin_lock (&ohci->lock);
 813                 dl_done_list (ohci);
 814                 spin_unlock (&ohci->lock);
 815                 if (HC_IS_RUNNING(hcd->state))
 816                         ohci_writel (ohci, OHCI_INTR_WDH, &regs->intrenable);
 817         }
 818
 819         if (quirk_zfmicro(ohci) && (ints & OHCI_INTR_SF)) {
 820                 spin_lock(&ohci->lock);
 821                 if (ohci->ed_to_check) {
 822                         struct ed *ed = ohci->ed_to_check;
 823
 824                         if (check_ed(ohci, ed)) {
 825                                 /* HC thinks the TD list is empty; HCD knows
 826                                  * at least one TD is outstanding
 827                                  */
 828                                 if (--ohci->zf_delay == 0) {
 829                                         struct td *td = list_entry(
 830                                                 ed->td_list.next,
 831                                                 struct td, td_list);
 832                                         ohci_warn(ohci,
 833                                                   "Reclaiming orphan TD %p\n",
 834                                                   td);
 835                                         takeback_td(ohci, td);
 836                                         ohci->ed_to_check = NULL;
 837                                 }
 838                         } else
 839                                 ohci->ed_to_check = NULL;
 840                 }
 841                 spin_unlock(&ohci->lock);
 842         }
 843
 844         /* could track INTR_SO to reduce available PCI/... bandwidth */
 845
 846         /* handle any pending URB/ED unlinks, leaving INTR_SF enabled
 847          * when there's still unlinking to be done (next frame).
 848          */
 849         spin_lock (&ohci->lock);
 850         if (ohci->ed_rm_list)
 851                 finish_unlinks (ohci, ohci_frame_no(ohci));
 852         if ((ints & OHCI_INTR_SF) != 0
 853                         && !ohci->ed_rm_list
 854                         && !ohci->ed_to_check
 855                         && HC_IS_RUNNING(hcd->state))
 856                 ohci_writel (ohci, OHCI_INTR_SF, &regs->intrdisable);
 857         spin_unlock (&ohci->lock);
 858
 859         if (HC_IS_RUNNING(hcd->state)) {
 860                 ohci_writel (ohci, ints, &regs->intrstatus);
 861                 ohci_writel (ohci, OHCI_INTR_MIE, &regs->intrenable);
 862                 // flush those writes
 863                 (void) ohci_readl (ohci, &ohci->regs->control);
 864         }
 865
 866         return IRQ_HANDLED;
 867 }
 868
 869 /*-------------------------------------------------------------------------*/
 870
 871 static void ohci_stop (struct usb_hcd *hcd)
 872 {
 873         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 874
 875         ohci_dump (ohci, 1);
 876
 877         flush_scheduled_work();
 878
 879         ohci_usb_reset (ohci);
 880         ohci_writel (ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
 881         free_irq(hcd->irq, hcd);
 882         hcd->irq = -1;
 883
 884         if (quirk_zfmicro(ohci))
 885                 del_timer(&ohci->unlink_watchdog);
 886
 887         remove_debug_files (ohci);
 888         ohci_mem_cleanup (ohci);
 889         if (ohci->hcca) {
 890                 dma_free_coherent (hcd->self.controller,
 891                                 sizeof *ohci->hcca,
 892                                 ohci->hcca, ohci->hcca_dma);
 893                 ohci->hcca = NULL;
 894                 ohci->hcca_dma = 0;
 895         }
 896 }
 897
 898 /*-------------------------------------------------------------------------*/
 899
 900 /* must not be called from interrupt context */
 901 static int ohci_restart (struct ohci_hcd *ohci)
 902 {
 903         int temp;
 904         int i;
 905         struct urb_priv *priv;
 906
 907         spin_lock_irq(&ohci->lock);
 908         disable (ohci);
 909
 910         /* Recycle any "live" eds/tds (and urbs). */
 911         if (!list_empty (&ohci->pending))
 912                 ohci_dbg(ohci, "abort schedule...\n");
 913         list_for_each_entry (priv, &ohci->pending, pending) {
 914                 struct urb      *urb = priv->td[0]->urb;
 915                 struct ed       *ed = priv->ed;
 916
 917                 switch (ed->state) {
 918                 case ED_OPER:
 919                         ed->state = ED_UNLINK;
 920                         ed->hwINFO |= cpu_to_hc32(ohci, ED_DEQUEUE);
 921                         ed_deschedule (ohci, ed);
 922
 923                         ed->ed_next = ohci->ed_rm_list;
 924                         ed->ed_prev = NULL;
 925                         ohci->ed_rm_list = ed;
 926                         /* FALLTHROUGH */
 927                 case ED_UNLINK:
 928                         break;
 929                 default:
 930                         ohci_dbg(ohci, "bogus ed %p state %d\n",
 931                                         ed, ed->state);
 932                 }
 933
 934                 spin_lock (&urb->lock);
 935                 urb->status = -ESHUTDOWN;
 936                 spin_unlock (&urb->lock);
 937         }
 938         finish_unlinks (ohci, 0);
 939         spin_unlock_irq(&ohci->lock);
 940
 941         /* paranoia, in case that didn't work: */
 942
 943         /* empty the interrupt branches */
 944         for (i = 0; i < NUM_INTS; i++) ohci->load [i] = 0;
 945         for (i = 0; i < NUM_INTS; i++) ohci->hcca->int_table [i] = 0;
 946
 947         /* no EDs to remove */
 948         ohci->ed_rm_list = NULL;
 949
 950         /* empty control and bulk lists */
 951         ohci->ed_controltail = NULL;
 952         ohci->ed_bulktail    = NULL;
 953
 954         if ((temp = ohci_run (ohci)) < 0) {
 955                 ohci_err (ohci, "can't restart, %d\n", temp);
 956                 return temp;
 957         }
 958         ohci_dbg(ohci, "restart complete\n");
 959         return 0;
 960 }
 961
 962 /*-------------------------------------------------------------------------*/
 963
 964 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
 965
 966 MODULE_AUTHOR (DRIVER_AUTHOR);
 967 MODULE_DESCRIPTION (DRIVER_INFO);
 968 MODULE_LICENSE ("GPL");
 969
 970 #ifdef CONFIG_PCI
 971 #include "ohci-pci.c"
 972 #define PCI_DRIVER              ohci_pci_driver
 973 #endif
 974
 975 #ifdef CONFIG_SA1111
 976 #include "ohci-sa1111.c"
 977 #define SA1111_DRIVER           ohci_hcd_sa1111_driver
 978 #endif
 979
 980 #ifdef CONFIG_ARCH_S3C2410
 981 #include "ohci-s3c2410.c"
 982 #define PLATFORM_DRIVER         ohci_hcd_s3c2410_driver
 983 #endif
 984
 985 #ifdef CONFIG_ARCH_OMAP
 986 #include "ohci-omap.c"
 987 #define PLATFORM_DRIVER         ohci_hcd_omap_driver
 988 #endif
 989
 990 #ifdef CONFIG_ARCH_LH7A404
 991 #include "ohci-lh7a404.c"
 992 #define PLATFORM_DRIVER         ohci_hcd_lh7a404_driver
 993 #endif
 994
 995 #ifdef CONFIG_PXA27x
 996 #include "ohci-pxa27x.c"
 997 #define PLATFORM_DRIVER         ohci_hcd_pxa27x_driver
 998 #endif
 999
1000 #ifdef CONFIG_ARCH_EP93XX
1001 #include "ohci-ep93xx.c"
1002 #define PLATFORM_DRIVER         ohci_hcd_ep93xx_driver
1003 #endif
1004
1005 #ifdef CONFIG_SOC_AU1X00
1006 #include "ohci-au1xxx.c"
1007 #define PLATFORM_DRIVER         ohci_hcd_au1xxx_driver
1008 #endif
1009
1010 #ifdef CONFIG_PNX8550
1011 #include "ohci-pnx8550.c"
1012 #define PLATFORM_DRIVER         ohci_hcd_pnx8550_driver
1013 #endif
1014
1015 #ifdef CONFIG_USB_OHCI_HCD_PPC_SOC
1016 #include "ohci-ppc-soc.c"
1017 #define PLATFORM_DRIVER         ohci_hcd_ppc_soc_driver
1018 #endif
1019
1020 #ifdef CONFIG_ARCH_AT91
1021 #include "ohci-at91.c"
1022 #define PLATFORM_DRIVER         ohci_hcd_at91_driver
1023 #endif
1024
1025 #ifdef CONFIG_ARCH_PNX4008
1026 #include "ohci-pnx4008.c"
1027 #define PLATFORM_DRIVER         usb_hcd_pnx4008_driver
1028 #endif
1029
1030
1031 #ifdef CONFIG_USB_OHCI_HCD_PPC_OF
1032 #include "ohci-ppc-of.c"
1033 #define OF_PLATFORM_DRIVER      ohci_hcd_ppc_of_driver
1034 #endif
1035
1036 #ifdef CONFIG_PPC_PS3
1037 #include "ohci-ps3.c"
1038 #define PS3_SYSTEM_BUS_DRIVER   ps3_ohci_driver
1039 #endif
1040
1041 #if     !defined(PCI_DRIVER) &&         \
1042         !defined(PLATFORM_DRIVER) &&    \
1043         !defined(OF_PLATFORM_DRIVER) && \
1044         !defined(SA1111_DRIVER) &&      \
1045         !defined(PS3_SYSTEM_BUS_DRIVER)
1046 #error "missing bus glue for ohci-hcd"
1047 #endif
1048
1049 static int __init ohci_hcd_mod_init(void)
1050 {
1051         int retval = 0;
1052
1053         if (usb_disabled())
1054                 return -ENODEV;
1055
1056         printk (KERN_DEBUG "%s: " DRIVER_INFO "\n", hcd_name);
1057         pr_debug ("%s: block sizes: ed %Zd td %Zd\n", hcd_name,
1058                 sizeof (struct ed), sizeof (struct td));
1059
1060 #ifdef PS3_SYSTEM_BUS_DRIVER
1061         retval = ps3_ohci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1062         if (retval < 0)
1063                 goto error_ps3;
1064 #endif
1065
1066 #ifdef PLATFORM_DRIVER
1067         retval = platform_driver_register(&PLATFORM_DRIVER);
1068         if (retval < 0)
1069                 goto error_platform;
1070 #endif
1071
1072 #ifdef OF_PLATFORM_DRIVER
1073         retval = of_register_platform_driver(&OF_PLATFORM_DRIVER);
1074         if (retval < 0)
1075                 goto error_of_platform;
1076 #endif
1077
1078 #ifdef SA1111_DRIVER
1079         retval = sa1111_driver_register(&SA1111_DRIVER);
1080         if (retval < 0)
1081                 goto error_sa1111;
1082 #endif
1083
1084 #ifdef PCI_DRIVER
1085         retval = pci_register_driver(&PCI_DRIVER);
1086         if (retval < 0)
1087                 goto error_pci;
1088 #endif
1089
1090         return retval;
1091
1092         /* Error path */
1093 #ifdef PCI_DRIVER
1094  error_pci:
1095 #endif
1096 #ifdef SA1111_DRIVER
1097         sa1111_driver_unregister(&SA1111_DRIVER);
1098  error_sa1111:
1099 #endif
1100 #ifdef OF_PLATFORM_DRIVER
1101         of_unregister_platform_driver(&OF_PLATFORM_DRIVER);
1102  error_of_platform:
1103 #endif
1104 #ifdef PLATFORM_DRIVER
1105         platform_driver_unregister(&PLATFORM_DRIVER);
1106  error_platform:
1107 #endif
1108 #ifdef PS3_SYSTEM_BUS_DRIVER
1109         ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1110  error_ps3:
1111 #endif
1112         return retval;
1113 }
1114 module_init(ohci_hcd_mod_init);
1115
1116 static void __exit ohci_hcd_mod_exit(void)
1117 {
1118 #ifdef PCI_DRIVER
1119         pci_unregister_driver(&PCI_DRIVER);
1120 #endif
1121 #ifdef SA1111_DRIVER
1122         sa1111_driver_unregister(&SA1111_DRIVER);
1123 #endif
1124 #ifdef OF_PLATFORM_DRIVER
1125         of_unregister_platform_driver(&OF_PLATFORM_DRIVER);
1126 #endif
1127 #ifdef PLATFORM_DRIVER
1128         platform_driver_unregister(&PLATFORM_DRIVER);
1129 #endif
1130 #ifdef PS3_SYSTEM_BUS_DRIVER
1131         ps3_ohci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1132 #endif
1133 }
1134 module_exit(ohci_hcd_mod_exit);
1135