drivers/usb/host/ehci-q.c

   1 /*
   2  * Copyright (c) 2001-2002 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 hardware queue manipulation ... the core.  QH/QTD manipulation.
  25  *
  26  * Control, bulk, and interrupt traffic all use "qh" lists.  They list "qtd"
  27  * entries describing USB transactions, max 16-20kB/entry (with 4kB-aligned
  28  * buffers needed for the larger number).  We use one QH per endpoint, queue
  29  * multiple urbs (all three types) per endpoint.  URBs may need several qtds.
  30  *
  31  * ISO traffic uses "ISO TD" (itd, and sitd) records, and (along with
  32  * interrupts) needs careful scheduling.  Performance improvements can be
  33  * an ongoing challenge.  That's in "ehci-sched.c".
  34  *
  35  * USB 1.1 devices are handled (a) by "companion" OHCI or UHCI root hubs,
  36  * or otherwise through transaction translators (TTs) in USB 2.0 hubs using
  37  * (b) special fields in qh entries or (c) split iso entries.  TTs will
  38  * buffer low/full speed data so the host collects it at high speed.
  39  */
  40
  41 /*-------------------------------------------------------------------------*/
  42
  43 /* fill a qtd, returning how much of the buffer we were able to queue up */
  44
  45 static int
  46 qtd_fill (struct ehci_qtd *qtd, dma_addr_t buf, size_t len,
  47                 int token, int maxpacket)
  48 {
  49         int     i, count;
  50         u64     addr = buf;
  51
  52         /* one buffer entry per 4K ... first might be short or unaligned */
  53         qtd->hw_buf [0] = cpu_to_le32 ((u32)addr);
  54         qtd->hw_buf_hi [0] = cpu_to_le32 ((u32)(addr >> 32));
  55         count = 0x1000 - (buf & 0x0fff);        /* rest of that page */
  56         if (likely (len < count))               /* ... iff needed */
  57                 count = len;
  58         else {
  59                 buf +=  0x1000;
  60                 buf &= ~0x0fff;
  61
  62                 /* per-qtd limit: from 16K to 20K (best alignment) */
  63                 for (i = 1; count < len && i < 5; i++) {
  64                         addr = buf;
  65                         qtd->hw_buf [i] = cpu_to_le32 ((u32)addr);
  66                         qtd->hw_buf_hi [i] = cpu_to_le32 ((u32)(addr >> 32));
  67                         buf += 0x1000;
  68                         if ((count + 0x1000) < len)
  69                                 count += 0x1000;
  70                         else
  71                                 count = len;
  72                 }
  73
  74                 /* short packets may only terminate transfers */
  75                 if (count != len)
  76                         count -= (count % maxpacket);
  77         }
  78         qtd->hw_token = cpu_to_le32 ((count << 16) | token);
  79         qtd->length = count;
  80
  81         return count;
  82 }
  83
  84 /*-------------------------------------------------------------------------*/
  85
  86 /* update halted (but potentially linked) qh */
  87
  88 static inline void
  89 qh_update (struct ehci_hcd *ehci, struct ehci_qh *qh, struct ehci_qtd *qtd)
  90 {
  91         qh->hw_qtd_next = QTD_NEXT (qtd->qtd_dma);
  92         qh->hw_alt_next = EHCI_LIST_END;
  93
  94         /* HC must see latest qtd and qh data before we clear ACTIVE+HALT */
  95         wmb ();
  96         qh->hw_token &= __constant_cpu_to_le32 (QTD_TOGGLE | QTD_STS_PING);
  97 }
  98
  99 /*-------------------------------------------------------------------------*/
 100
 101 static void qtd_copy_status (
 102         struct ehci_hcd *ehci,
 103         struct urb *urb,
 104         size_t length,
 105         u32 token
 106 )
 107 {
 108         /* count IN/OUT bytes, not SETUP (even short packets) */
 109         if (likely (QTD_PID (token) != 2))
 110                 urb->actual_length += length - QTD_LENGTH (token);
 111
 112         /* don't modify error codes */
 113         if (unlikely (urb->status != -EINPROGRESS))
 114                 return;
 115
 116         /* force cleanup after short read; not always an error */
 117         if (unlikely (IS_SHORT_READ (token)))
 118                 urb->status = -EREMOTEIO;
 119
 120         /* serious "can't proceed" faults reported by the hardware */
 121         if (token & QTD_STS_HALT) {
 122                 if (token & QTD_STS_BABBLE) {
 123                         /* FIXME "must" disable babbling device's port too */
 124                         urb->status = -EOVERFLOW;
 125                 } else if (token & QTD_STS_MMF) {
 126                         /* fs/ls interrupt xfer missed the complete-split */
 127                         urb->status = -EPROTO;
 128                 } else if (token & QTD_STS_DBE) {
 129                         urb->status = (QTD_PID (token) == 1) /* IN ? */
 130                                 ? -ENOSR  /* hc couldn't read data */
 131                                 : -ECOMM; /* hc couldn't write data */
 132                 } else if (token & QTD_STS_XACT) {
 133                         /* timeout, bad crc, wrong PID, etc; retried */
 134                         if (QTD_CERR (token))
 135                                 urb->status = -EPIPE;
 136                         else {
 137                                 ehci_dbg (ehci, "devpath %s ep%d%s 3strikes\n",
 138                                         urb->dev->devpath,
 139                                         usb_pipeendpoint (urb->pipe),
 140                                         usb_pipein (urb->pipe) ? "in" : "out");
 141                                 urb->status = -EPROTO;
 142                         }
 143                 /* CERR nonzero + no errors + halt --> stall */
 144                 } else if (QTD_CERR (token))
 145                         urb->status = -EPIPE;
 146                 else    /* unknown */
 147                         urb->status = -EPROTO;
 148
 149                 ehci_vdbg (ehci,
 150                         "dev%d ep%d%s qtd token %08x --> status %d\n",
 151                         usb_pipedevice (urb->pipe),
 152                         usb_pipeendpoint (urb->pipe),
 153                         usb_pipein (urb->pipe) ? "in" : "out",
 154                         token, urb->status);
 155
 156                 /* if async CSPLIT failed, try cleaning out the TT buffer */
 157                 if (urb->status != -EPIPE
 158                                 && urb->dev->tt && !usb_pipeint (urb->pipe)
 159                                 && ((token & QTD_STS_MMF) != 0
 160                                         || QTD_CERR(token) == 0)
 161                                 && (!ehci_is_ARC(ehci)
 162                                         || urb->dev->tt->hub !=
 163                                                 ehci->hcd.self.root_hub)) {
 164 #ifdef DEBUG
 165                         struct usb_device *tt = urb->dev->tt->hub;
 166                         dev_dbg (&tt->dev,
 167                                 "clear tt buffer port %d, a%d ep%d t%08x\n",
 168                                 urb->dev->ttport, urb->dev->devnum,
 169                                 usb_pipeendpoint (urb->pipe), token);
 170 #endif /* DEBUG */
 171                         usb_hub_tt_clear_buffer (urb->dev, urb->pipe);
 172                 }
 173         }
 174 }
 175
 176 static void
 177 ehci_urb_done (struct ehci_hcd *ehci, struct urb *urb, struct pt_regs *regs)
 178 {
 179         if (likely (urb->hcpriv != 0)) {
 180                 struct ehci_qh  *qh = (struct ehci_qh *) urb->hcpriv;
 181
 182                 /* S-mask in a QH means it's an interrupt urb */
 183                 if ((qh->hw_info2 & __constant_cpu_to_le32 (0x00ff)) != 0) {
 184
 185                         /* ... update hc-wide periodic stats (for usbfs) */
 186                         hcd_to_bus (&ehci->hcd)->bandwidth_int_reqs--;
 187                 }
 188                 qh_put (qh);
 189         }
 190
 191         spin_lock (&urb->lock);
 192         urb->hcpriv = NULL;
 193         switch (urb->status) {
 194         case -EINPROGRESS:              /* success */
 195                 urb->status = 0;
 196         default:                        /* fault */
 197                 COUNT (ehci->stats.complete);
 198                 break;
 199         case -EREMOTEIO:                /* fault or normal */
 200                 if (!(urb->transfer_flags & URB_SHORT_NOT_OK))
 201                         urb->status = 0;
 202                 COUNT (ehci->stats.complete);
 203                 break;
 204         case -ECONNRESET:               /* canceled */
 205         case -ENOENT:
 206                 COUNT (ehci->stats.unlink);
 207                 break;
 208         }
 209         spin_unlock (&urb->lock);
 210
 211 #ifdef EHCI_URB_TRACE
 212         ehci_dbg (ehci,
 213                 "%s %s urb %p ep%d%s status %d len %d/%d\n",
 214                 __FUNCTION__, urb->dev->devpath, urb,
 215                 usb_pipeendpoint (urb->pipe),
 216                 usb_pipein (urb->pipe) ? "in" : "out",
 217                 urb->status,
 218                 urb->actual_length, urb->transfer_buffer_length);
 219 #endif
 220
 221         /* complete() can reenter this HCD */
 222         spin_unlock (&ehci->lock);
 223         usb_hcd_giveback_urb (&ehci->hcd, urb, regs);
 224         spin_lock (&ehci->lock);
 225 }
 226
 227
 228 /*
 229  * Process and free completed qtds for a qh, returning URBs to drivers.
 230  * Chases up to qh->hw_current.  Returns number of completions called,
 231  * indicating how much "real" work we did.
 232  */
 233 #define HALT_BIT __constant_cpu_to_le32(QTD_STS_HALT)
 234 static unsigned
 235 qh_completions (struct ehci_hcd *ehci, struct ehci_qh *qh, struct pt_regs *regs)
 236 {
 237         struct ehci_qtd         *last = NULL, *end = qh->dummy;
 238         struct list_head        *entry, *tmp;
 239         int                     stopped;
 240         unsigned                count = 0;
 241         int                     do_status = 0;
 242         u8                      state;
 243
 244         if (unlikely (list_empty (&qh->qtd_list)))
 245                 return count;
 246
 247         /* completions (or tasks on other cpus) must never clobber HALT
 248          * till we've gone through and cleaned everything up, even when
 249          * they add urbs to this qh's queue or mark them for unlinking.
 250          *
 251          * NOTE:  unlinking expects to be done in queue order.
 252          */
 253         state = qh->qh_state;
 254         qh->qh_state = QH_STATE_COMPLETING;
 255         stopped = (state == QH_STATE_IDLE);
 256
 257         /* remove de-activated QTDs from front of queue.
 258          * after faults (including short reads), cleanup this urb
 259          * then let the queue advance.
 260          * if queue is stopped, handles unlinks.
 261          */
 262         list_for_each_safe (entry, tmp, &qh->qtd_list) {
 263                 struct ehci_qtd *qtd;
 264                 struct urb      *urb;
 265                 u32             token = 0;
 266
 267                 qtd = list_entry (entry, struct ehci_qtd, qtd_list);
 268                 urb = qtd->urb;
 269
 270                 /* clean up any state from previous QTD ...*/
 271                 if (last) {
 272                         if (likely (last->urb != urb)) {
 273                                 ehci_urb_done (ehci, last->urb, regs);
 274                                 count++;
 275                         }
 276                         ehci_qtd_free (ehci, last);
 277                         last = NULL;
 278                 }
 279
 280                 /* ignore urbs submitted during completions we reported */
 281                 if (qtd == end)
 282                         break;
 283
 284                 /* hardware copies qtd out of qh overlay */
 285                 rmb ();
 286                 token = le32_to_cpu (qtd->hw_token);
 287
 288                 /* always clean up qtds the hc de-activated */
 289                 if ((token & QTD_STS_ACTIVE) == 0) {
 290
 291                         if ((token & QTD_STS_HALT) != 0) {
 292                                 stopped = 1;
 293
 294                         /* magic dummy for some short reads; qh won't advance */
 295                         } else if (IS_SHORT_READ (token)
 296                                         && (qh->hw_alt_next & QTD_MASK)
 297                                                 == ehci->async->hw_alt_next) {
 298                                 stopped = 1;
 299                                 goto halt;
 300                         }
 301
 302                 /* stop scanning when we reach qtds the hc is using */
 303                 } else if (likely (!stopped
 304                                 && HCD_IS_RUNNING (ehci->hcd.state))) {
 305                         break;
 306
 307                 } else {
 308                         stopped = 1;
 309
 310                         /* ignore active urbs unless some previous qtd
 311                          * for the urb faulted (including short read) or
 312                          * its urb was canceled.  we may patch qh or qtds.
 313                          */
 314                         if (likely (urb->status == -EINPROGRESS))
 315                                 continue;
 316
 317                         /* issue status after short control reads */
 318                         if (unlikely (do_status != 0)
 319                                         && QTD_PID (token) == 0 /* OUT */) {
 320                                 do_status = 0;
 321                                 continue;
 322                         }
 323
 324                         /* token in overlay may be most current */
 325                         if (state == QH_STATE_IDLE
 326                                         && cpu_to_le32 (qtd->qtd_dma)
 327                                                 == qh->hw_current)
 328                                 token = le32_to_cpu (qh->hw_token);
 329
 330                         /* force halt for unlinked or blocked qh, so we'll
 331                          * patch the qh later and so that completions can't
 332                          * activate it while we "know" it's stopped.
 333                          */
 334                         if ((HALT_BIT & qh->hw_token) == 0) {
 335 halt:
 336                                 qh->hw_token |= HALT_BIT;
 337                                 wmb ();
 338                         }
 339                 }
 340
 341                 /* remove it from the queue */
 342                 spin_lock (&urb->lock);
 343                 qtd_copy_status (ehci, urb, qtd->length, token);
 344                 do_status = (urb->status == -EREMOTEIO)
 345                                 && usb_pipecontrol (urb->pipe);
 346                 spin_unlock (&urb->lock);
 347
 348                 if (stopped && qtd->qtd_list.prev != &qh->qtd_list) {
 349                         last = list_entry (qtd->qtd_list.prev,
 350                                         struct ehci_qtd, qtd_list);
 351                         last->hw_next = qtd->hw_next;
 352                 }
 353                 list_del (&qtd->qtd_list);
 354                 last = qtd;
 355         }
 356
 357         /* last urb's completion might still need calling */
 358         if (likely (last != 0)) {
 359                 ehci_urb_done (ehci, last->urb, regs);
 360                 count++;
 361                 ehci_qtd_free (ehci, last);
 362         }
 363
 364         /* restore original state; caller must unlink or relink */
 365         qh->qh_state = state;
 366
 367         /* update qh after fault cleanup */
 368         if (unlikely (stopped != 0)
 369                         /* some EHCI 0.95 impls will overlay dummy qtds */
 370                         || qh->hw_qtd_next == EHCI_LIST_END) {
 371                 if (list_empty (&qh->qtd_list))
 372                         end = qh->dummy;
 373                 else {
 374                         end = list_entry (qh->qtd_list.next,
 375                                         struct ehci_qtd, qtd_list);
 376                         /* first qtd may already be partially processed */
 377                         if (cpu_to_le32 (end->qtd_dma) == qh->hw_current)
 378                                 end = NULL;
 379                 }
 380                 if (end)
 381                         qh_update (ehci, qh, end);
 382         }
 383
 384         return count;
 385 }
 386
 387 /*-------------------------------------------------------------------------*/
 388
 389 // high bandwidth multiplier, as encoded in highspeed endpoint descriptors
 390 #define hb_mult(wMaxPacketSize) (1 + (((wMaxPacketSize) >> 11) & 0x03))
 391 // ... and packet size, for any kind of endpoint descriptor
 392 #define max_packet(wMaxPacketSize) ((wMaxPacketSize) & 0x07ff)
 393
 394 /*
 395  * reverse of qh_urb_transaction:  free a list of TDs.
 396  * used for cleanup after errors, before HC sees an URB's TDs.
 397  */
 398 static void qtd_list_free (
 399         struct ehci_hcd         *ehci,
 400         struct urb              *urb,
 401         struct list_head        *qtd_list
 402 ) {
 403         struct list_head        *entry, *temp;
 404
 405         list_for_each_safe (entry, temp, qtd_list) {
 406                 struct ehci_qtd *qtd;
 407
 408                 qtd = list_entry (entry, struct ehci_qtd, qtd_list);
 409                 list_del (&qtd->qtd_list);
 410                 ehci_qtd_free (ehci, qtd);
 411         }
 412 }
 413
 414 /*
 415  * create a list of filled qtds for this URB; won't link into qh.
 416  */
 417 static struct list_head *
 418 qh_urb_transaction (
 419         struct ehci_hcd         *ehci,
 420         struct urb              *urb,
 421         struct list_head        *head,
 422         int                     flags
 423 ) {
 424         struct ehci_qtd         *qtd, *qtd_prev;
 425         dma_addr_t              buf;
 426         int                     len, maxpacket;
 427         int                     is_input;
 428         u32                     token;
 429
 430         /*
 431          * URBs map to sequences of QTDs:  one logical transaction
 432          */
 433         qtd = ehci_qtd_alloc (ehci, flags);
 434         if (unlikely (!qtd))
 435                 return NULL;
 436         list_add_tail (&qtd->qtd_list, head);
 437         qtd->urb = urb;
 438
 439         token = QTD_STS_ACTIVE;
 440         token |= (EHCI_TUNE_CERR << 10);
 441         /* for split transactions, SplitXState initialized to zero */
 442
 443         len = urb->transfer_buffer_length;
 444         is_input = usb_pipein (urb->pipe);
 445         if (usb_pipecontrol (urb->pipe)) {
 446                 /* SETUP pid */
 447                 qtd_fill (qtd, urb->setup_dma, sizeof (struct usb_ctrlrequest),
 448                         token | (2 /* "setup" */ << 8), 8);
 449
 450                 /* ... and always at least one more pid */
 451                 token ^= QTD_TOGGLE;
 452                 qtd_prev = qtd;
 453                 qtd = ehci_qtd_alloc (ehci, flags);
 454                 if (unlikely (!qtd))
 455                         goto cleanup;
 456                 qtd->urb = urb;
 457                 qtd_prev->hw_next = QTD_NEXT (qtd->qtd_dma);
 458                 list_add_tail (&qtd->qtd_list, head);
 459         }
 460
 461         /*
 462          * data transfer stage:  buffer setup
 463          */
 464         if (likely (len > 0))
 465                 buf = urb->transfer_dma;
 466         else
 467                 buf = 0;
 468
 469         // FIXME this 'buf' check break some zlps...
 470         if (!buf || is_input)
 471                 token |= (1 /* "in" */ << 8);
 472         /* else it's already initted to "out" pid (0 << 8) */
 473
 474         maxpacket = max_packet(usb_maxpacket(urb->dev, urb->pipe, !is_input));
 475
 476         /*
 477          * buffer gets wrapped in one or more qtds;
 478          * last one may be "short" (including zero len)
 479          * and may serve as a control status ack
 480          */
 481         for (;;) {
 482                 int this_qtd_len;
 483
 484                 this_qtd_len = qtd_fill (qtd, buf, len, token, maxpacket);
 485                 len -= this_qtd_len;
 486                 buf += this_qtd_len;
 487                 if (is_input)
 488                         qtd->hw_alt_next = ehci->async->hw_alt_next;
 489
 490                 /* qh makes control packets use qtd toggle; maybe switch it */
 491                 if ((maxpacket & (this_qtd_len + (maxpacket - 1))) == 0)
 492                         token ^= QTD_TOGGLE;
 493
 494                 if (likely (len <= 0))
 495                         break;
 496
 497                 qtd_prev = qtd;
 498                 qtd = ehci_qtd_alloc (ehci, flags);
 499                 if (unlikely (!qtd))
 500                         goto cleanup;
 501                 qtd->urb = urb;
 502                 qtd_prev->hw_next = QTD_NEXT (qtd->qtd_dma);
 503                 list_add_tail (&qtd->qtd_list, head);
 504         }
 505
 506         /* unless the bulk/interrupt caller wants a chance to clean
 507          * up after short reads, hc should advance qh past this urb
 508          */
 509         if (likely ((urb->transfer_flags & URB_SHORT_NOT_OK) == 0
 510                                 || usb_pipecontrol (urb->pipe)))
 511                 qtd->hw_alt_next = EHCI_LIST_END;
 512
 513         /*
 514          * control requests may need a terminating data "status" ack;
 515          * bulk ones may need a terminating short packet (zero length).
 516          */
 517         if (likely (buf != 0)) {
 518                 int     one_more = 0;
 519
 520                 if (usb_pipecontrol (urb->pipe)) {
 521                         one_more = 1;
 522                         token ^= 0x0100;        /* "in" <--> "out"  */
 523                         token |= QTD_TOGGLE;    /* force DATA1 */
 524                 } else if (usb_pipebulk (urb->pipe)
 525                                 && (urb->transfer_flags & URB_ZERO_PACKET)
 526                                 && !(urb->transfer_buffer_length % maxpacket)) {
 527                         one_more = 1;
 528                 }
 529                 if (one_more) {
 530                         qtd_prev = qtd;
 531                         qtd = ehci_qtd_alloc (ehci, flags);
 532                         if (unlikely (!qtd))
 533                                 goto cleanup;
 534                         qtd->urb = urb;
 535                         qtd_prev->hw_next = QTD_NEXT (qtd->qtd_dma);
 536                         list_add_tail (&qtd->qtd_list, head);
 537
 538                         /* never any data in such packets */
 539                         qtd_fill (qtd, 0, 0, token, 0);
 540                 }
 541         }
 542
 543         /* by default, enable interrupt on urb completion */
 544         if (likely (!(urb->transfer_flags & URB_NO_INTERRUPT)))
 545                 qtd->hw_token |= __constant_cpu_to_le32 (QTD_IOC);
 546         return head;
 547
 548 cleanup:
 549         qtd_list_free (ehci, urb, head);
 550         return NULL;
 551 }
 552
 553 /*-------------------------------------------------------------------------*/
 554
 555 /*
 556  * Hardware maintains data toggle (like OHCI) ... here we (re)initialize
 557  * the hardware data toggle in the QH, and set the pseudo-toggle in udev
 558  * so we can see if usb_clear_halt() was called.  NOP for control, since
 559  * we set up qh->hw_info1 to always use the QTD toggle bits.
 560  */
 561 static inline void
 562 clear_toggle (struct usb_device *udev, int ep, int is_out, struct ehci_qh *qh)
 563 {
 564         vdbg ("clear toggle, dev %d ep 0x%x-%s",
 565                 udev->devnum, ep, is_out ? "out" : "in");
 566         qh->hw_token &= ~__constant_cpu_to_le32 (QTD_TOGGLE);
 567         usb_settoggle (udev, ep, is_out, 1);
 568 }
 569
 570 // Would be best to create all qh's from config descriptors,
 571 // when each interface/altsetting is established.  Unlink
 572 // any previous qh and cancel its urbs first; endpoints are
 573 // implicitly reset then (data toggle too).
 574 // That'd mean updating how usbcore talks to HCDs. (2.7?)
 575
 576
 577 /*
 578  * Each QH holds a qtd list; a QH is used for everything except iso.
 579  *
 580  * For interrupt urbs, the scheduler must set the microframe scheduling
 581  * mask(s) each time the QH gets scheduled.  For highspeed, that's
 582  * just one microframe in the s-mask.  For split interrupt transactions
 583  * there are additional complications: c-mask, maybe FSTNs.
 584  */
 585 static struct ehci_qh *
 586 qh_make (
 587         struct ehci_hcd         *ehci,
 588         struct urb              *urb,
 589         int                     flags
 590 ) {
 591         struct ehci_qh          *qh = ehci_qh_alloc (ehci, flags);
 592         u32                     info1 = 0, info2 = 0;
 593         int                     is_input, type;
 594         int                     maxp = 0;
 595
 596         if (!qh)
 597                 return qh;
 598
 599         /*
 600          * init endpoint/device data for this QH
 601          */
 602         info1 |= usb_pipeendpoint (urb->pipe) << 8;
 603         info1 |= usb_pipedevice (urb->pipe) << 0;
 604
 605         is_input = usb_pipein (urb->pipe);
 606         type = usb_pipetype (urb->pipe);
 607         maxp = usb_maxpacket (urb->dev, urb->pipe, !is_input);
 608
 609         /* Compute interrupt scheduling parameters just once, and save.
 610          * - allowing for high bandwidth, how many nsec/uframe are used?
 611          * - split transactions need a second CSPLIT uframe; same question
 612          * - splits also need a schedule gap (for full/low speed I/O)
 613          * - qh has a polling interval
 614          *
 615          * For control/bulk requests, the HC or TT handles these.
 616          */
 617         if (type == PIPE_INTERRUPT) {
 618                 qh->usecs = usb_calc_bus_time (USB_SPEED_HIGH, is_input, 0,
 619                                 hb_mult (maxp) * max_packet (maxp));
 620                 qh->start = NO_FRAME;
 621
 622                 if (urb->dev->speed == USB_SPEED_HIGH) {
 623                         qh->c_usecs = 0;
 624                         qh->gap_uf = 0;
 625
 626                         /* FIXME handle HS periods of less than 1 frame. */
 627                         qh->period = urb->interval >> 3;
 628                         if (qh->period < 1) {
 629                                 dbg ("intr period %d uframes, NYET!",
 630                                                 urb->interval);
 631                                 goto done;
 632                         }
 633                 } else {
 634                         /* gap is f(FS/LS transfer times) */
 635                         qh->gap_uf = 1 + usb_calc_bus_time (urb->dev->speed,
 636                                         is_input, 0, maxp) / (125 * 1000);
 637
 638                         /* FIXME this just approximates SPLIT/CSPLIT times */
 639                         if (is_input) {         // SPLIT, gap, CSPLIT+DATA
 640                                 qh->c_usecs = qh->usecs + HS_USECS (0);
 641                                 qh->usecs = HS_USECS (1);
 642                         } else {                // SPLIT+DATA, gap, CSPLIT
 643                                 qh->usecs += HS_USECS (1);
 644                                 qh->c_usecs = HS_USECS (0);
 645                         }
 646
 647                         qh->period = urb->interval;
 648                 }
 649
 650                 /* support for tt scheduling */
 651                 qh->dev = usb_get_dev (urb->dev);
 652         }
 653
 654         /* using TT? */
 655         switch (urb->dev->speed) {
 656         case USB_SPEED_LOW:
 657                 info1 |= (1 << 12);     /* EPS "low" */
 658                 /* FALL THROUGH */
 659
 660         case USB_SPEED_FULL:
 661                 /* EPS 0 means "full" */
 662                 if (type != PIPE_INTERRUPT)
 663                         info1 |= (EHCI_TUNE_RL_TT << 28);
 664                 if (type == PIPE_CONTROL) {
 665                         info1 |= (1 << 27);     /* for TT */
 666                         info1 |= 1 << 14;       /* toggle from qtd */
 667                 }
 668                 info1 |= maxp << 16;
 669
 670                 info2 |= (EHCI_TUNE_MULT_TT << 30);
 671                 info2 |= urb->dev->ttport << 23;
 672
 673                 /* set the address of the TT; for ARC's integrated
 674                  * root hub tt, leave it zeroed.
 675                  */
 676                 if (!ehci_is_ARC(ehci)
 677                                 || urb->dev->tt->hub != ehci->hcd.self.root_hub)
 678                         info2 |= urb->dev->tt->hub->devnum << 16;
 679
 680                 /* NOTE:  if (PIPE_INTERRUPT) { scheduler sets c-mask } */
 681
 682                 break;
 683
 684         case USB_SPEED_HIGH:            /* no TT involved */
 685                 info1 |= (2 << 12);     /* EPS "high" */
 686                 if (type == PIPE_CONTROL) {
 687                         info1 |= (EHCI_TUNE_RL_HS << 28);
 688                         info1 |= 64 << 16;      /* usb2 fixed maxpacket */
 689                         info1 |= 1 << 14;       /* toggle from qtd */
 690                         info2 |= (EHCI_TUNE_MULT_HS << 30);
 691                 } else if (type == PIPE_BULK) {
 692                         info1 |= (EHCI_TUNE_RL_HS << 28);
 693                         info1 |= 512 << 16;     /* usb2 fixed maxpacket */
 694                         info2 |= (EHCI_TUNE_MULT_HS << 30);
 695                 } else {                /* PIPE_INTERRUPT */
 696                         info1 |= max_packet (maxp) << 16;
 697                         info2 |= hb_mult (maxp) << 30;
 698                 }
 699                 break;
 700         default:
 701                 dbg ("bogus dev %p speed %d", urb->dev, urb->dev->speed);
 702 done:
 703                 qh_put (qh);
 704                 return NULL;
 705         }
 706
 707         /* NOTE:  if (PIPE_INTERRUPT) { scheduler sets s-mask } */
 708
 709         /* init as live, toggle clear, advance to dummy */
 710         qh->qh_state = QH_STATE_IDLE;
 711         qh->hw_info1 = cpu_to_le32 (info1);
 712         qh->hw_info2 = cpu_to_le32 (info2);
 713         qh_update (ehci, qh, qh->dummy);
 714         usb_settoggle (urb->dev, usb_pipeendpoint (urb->pipe), !is_input, 1);
 715         return qh;
 716 }
 717
 718 /*-------------------------------------------------------------------------*/
 719
 720 /* move qh (and its qtds) onto async queue; maybe enable queue.  */
 721
 722 static void qh_link_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
 723 {
 724         __le32          dma = QH_NEXT (qh->qh_dma);
 725         struct ehci_qh  *head;
 726
 727         /* (re)start the async schedule? */
 728         head = ehci->async;
 729         timer_action_done (ehci, TIMER_ASYNC_OFF);
 730         if (!head->qh_next.qh) {
 731                 u32     cmd = readl (&ehci->regs->command);
 732
 733                 if (!(cmd & CMD_ASE)) {
 734                         /* in case a clear of CMD_ASE didn't take yet */
 735                         (void) handshake (&ehci->regs->status, STS_ASS, 0, 150);
 736                         cmd |= CMD_ASE | CMD_RUN;
 737                         writel (cmd, &ehci->regs->command);
 738                         ehci->hcd.state = USB_STATE_RUNNING;
 739                         /* posted write need not be known to HC yet ... */
 740                 }
 741         }
 742
 743         qh->hw_token &= ~HALT_BIT;
 744
 745         /* splice right after start */
 746         qh->qh_next = head->qh_next;
 747         qh->hw_next = head->hw_next;
 748         wmb ();
 749
 750         head->qh_next.qh = qh;
 751         head->hw_next = dma;
 752
 753         qh->qh_state = QH_STATE_LINKED;
 754         /* qtd completions reported later by interrupt */
 755 }
 756
 757 /*-------------------------------------------------------------------------*/
 758
 759 #define QH_ADDR_MASK    __constant_cpu_to_le32(0x7f)
 760
 761 /*
 762  * For control/bulk/interrupt, return QH with these TDs appended.
 763  * Allocates and initializes the QH if necessary.
 764  * Returns null if it can't allocate a QH it needs to.
 765  * If the QH has TDs (urbs) already, that's great.
 766  */
 767 static struct ehci_qh *qh_append_tds (
 768         struct ehci_hcd         *ehci,
 769         struct urb              *urb,
 770         struct list_head        *qtd_list,
 771         int                     epnum,
 772         void                    **ptr
 773 )
 774 {
 775         struct ehci_qh          *qh = NULL;
 776
 777         qh = (struct ehci_qh *) *ptr;
 778         if (unlikely (qh == NULL)) {
 779                 /* can't sleep here, we have ehci->lock... */
 780                 qh = qh_make (ehci, urb, GFP_ATOMIC);
 781                 *ptr = qh;
 782         }
 783         if (likely (qh != NULL)) {
 784                 struct ehci_qtd *qtd;
 785
 786                 if (unlikely (list_empty (qtd_list)))
 787                         qtd = NULL;
 788                 else
 789                         qtd = list_entry (qtd_list->next, struct ehci_qtd,
 790                                         qtd_list);
 791
 792                 /* control qh may need patching after enumeration */
 793                 if (unlikely (epnum == 0)) {
 794                         /* set_address changes the address */
 795                         if ((qh->hw_info1 & QH_ADDR_MASK) == 0)
 796                                 qh->hw_info1 |= cpu_to_le32 (
 797                                                 usb_pipedevice (urb->pipe));
 798
 799                         /* for full speed, ep0 maxpacket can grow */
 800                         else if (!(qh->hw_info1
 801                                         & __constant_cpu_to_le32 (0x3 << 12))) {
 802                                 u32     info, max;
 803
 804                                 info = le32_to_cpu (qh->hw_info1);
 805                                 max = urb->dev->descriptor.bMaxPacketSize0;
 806                                 if (max > (0x07ff & (info >> 16))) {
 807                                         info &= ~(0x07ff << 16);
 808                                         info |= max << 16;
 809                                         qh->hw_info1 = cpu_to_le32 (info);
 810                                 }
 811                         }
 812
 813                         /* usb_reset_device() briefly reverts to address 0 */
 814                         if (usb_pipedevice (urb->pipe) == 0)
 815                                 qh->hw_info1 &= ~QH_ADDR_MASK;
 816                 }
 817
 818                 /* usb_clear_halt() means qh data toggle gets reset */
 819                 if (unlikely (!usb_gettoggle (urb->dev,
 820                                         (epnum & 0x0f), !(epnum & 0x10)))
 821                                 && !usb_pipecontrol (urb->pipe)) {
 822                         /* "never happens": drivers do stall cleanup right */
 823                         if (qh->qh_state != QH_STATE_IDLE
 824                                         && !list_empty (&qh->qtd_list)
 825                                         && qh->qh_state != QH_STATE_COMPLETING)
 826                                 ehci_warn (ehci, "clear toggle dev%d "
 827                                                 "ep%d%s: not idle\n",
 828                                                 usb_pipedevice (urb->pipe),
 829                                                 epnum & 0x0f,
 830                                                 usb_pipein (urb->pipe)
 831                                                         ? "in" : "out");
 832                         /* else we know this overlay write is safe */
 833                         clear_toggle (urb->dev,
 834                                 epnum & 0x0f, !(epnum & 0x10), qh);
 835                 }
 836
 837                 /* just one way to queue requests: swap with the dummy qtd.
 838                  * only hc or qh_completions() usually modify the overlay.
 839                  */
 840                 if (likely (qtd != 0)) {
 841                         struct ehci_qtd         *dummy;
 842                         dma_addr_t              dma;
 843                         __le32                  token;
 844
 845                         /* to avoid racing the HC, use the dummy td instead of
 846                          * the first td of our list (becomes new dummy).  both
 847                          * tds stay deactivated until we're done, when the
 848                          * HC is allowed to fetch the old dummy (4.10.2).
 849                          */
 850                         token = qtd->hw_token;
 851                         qtd->hw_token = HALT_BIT;
 852                         wmb ();
 853                         dummy = qh->dummy;
 854
 855                         dma = dummy->qtd_dma;
 856                         *dummy = *qtd;
 857                         dummy->qtd_dma = dma;
 858
 859                         list_del (&qtd->qtd_list);
 860                         list_add (&dummy->qtd_list, qtd_list);
 861                         __list_splice (qtd_list, qh->qtd_list.prev);
 862
 863                         ehci_qtd_init (qtd, qtd->qtd_dma);
 864                         qh->dummy = qtd;
 865
 866                         /* hc must see the new dummy at list end */
 867                         dma = qtd->qtd_dma;
 868                         qtd = list_entry (qh->qtd_list.prev,
 869                                         struct ehci_qtd, qtd_list);
 870                         qtd->hw_next = QTD_NEXT (dma);
 871
 872                         /* let the hc process these next qtds */
 873                         wmb ();
 874                         dummy->hw_token = token;
 875
 876                         urb->hcpriv = qh_get (qh);
 877                 }
 878         }
 879         return qh;
 880 }
 881
 882 /*-------------------------------------------------------------------------*/
 883
 884 static int
 885 submit_async (
 886         struct ehci_hcd         *ehci,
 887         struct urb              *urb,
 888         struct list_head        *qtd_list,
 889         int                     mem_flags
 890 ) {
 891         struct ehci_qtd         *qtd;
 892         struct hcd_dev          *dev;
 893         int                     epnum;
 894         unsigned long           flags;
 895         struct ehci_qh          *qh = NULL;
 896
 897         qtd = list_entry (qtd_list->next, struct ehci_qtd, qtd_list);
 898         dev = (struct hcd_dev *)urb->dev->hcpriv;
 899         epnum = usb_pipeendpoint (urb->pipe);
 900         if (usb_pipein (urb->pipe) && !usb_pipecontrol (urb->pipe))
 901                 epnum |= 0x10;
 902
 903 #ifdef EHCI_URB_TRACE
 904         ehci_dbg (ehci,
 905                 "%s %s urb %p ep%d%s len %d, qtd %p [qh %p]\n",
 906                 __FUNCTION__, urb->dev->devpath, urb,
 907                 epnum & 0x0f, usb_pipein (urb->pipe) ? "in" : "out",
 908                 urb->transfer_buffer_length,
 909                 qtd, dev ? dev->ep [epnum] : (void *)~0);
 910 #endif
 911
 912         spin_lock_irqsave (&ehci->lock, flags);
 913         qh = qh_append_tds (ehci, urb, qtd_list, epnum, &dev->ep [epnum]);
 914
 915         /* Control/bulk operations through TTs don't need scheduling,
 916          * the HC and TT handle it when the TT has a buffer ready.
 917          */
 918         if (likely (qh != 0)) {
 919                 if (likely (qh->qh_state == QH_STATE_IDLE))
 920                         qh_link_async (ehci, qh_get (qh));
 921         }
 922         spin_unlock_irqrestore (&ehci->lock, flags);
 923         if (unlikely (qh == 0)) {
 924                 qtd_list_free (ehci, urb, qtd_list);
 925                 return -ENOMEM;
 926         }
 927         return 0;
 928 }
 929
 930 /*-------------------------------------------------------------------------*/
 931
 932 /* the async qh for the qtds being reclaimed are now unlinked from the HC */
 933
 934 static void start_unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh);
 935
 936 static void end_unlink_async (struct ehci_hcd *ehci, struct pt_regs *regs)
 937 {
 938         struct ehci_qh          *qh = ehci->reclaim;
 939         struct ehci_qh          *next;
 940
 941         timer_action_done (ehci, TIMER_IAA_WATCHDOG);
 942
 943         // qh->hw_next = cpu_to_le32 (qh->qh_dma);
 944         qh->qh_state = QH_STATE_IDLE;
 945         qh->qh_next.qh = NULL;
 946         qh_put (qh);                    // refcount from reclaim
 947
 948         /* other unlink(s) may be pending (in QH_STATE_UNLINK_WAIT) */
 949         next = qh->reclaim;
 950         ehci->reclaim = next;
 951         ehci->reclaim_ready = 0;
 952         qh->reclaim = NULL;
 953
 954         qh_completions (ehci, qh, regs);
 955
 956         if (!list_empty (&qh->qtd_list)
 957                         && HCD_IS_RUNNING (ehci->hcd.state))
 958                 qh_link_async (ehci, qh);
 959         else {
 960                 qh_put (qh);            // refcount from async list
 961
 962                 /* it's not free to turn the async schedule on/off; leave it
 963                  * active but idle for a while once it empties.
 964                  */
 965                 if (HCD_IS_RUNNING (ehci->hcd.state)
 966                                 && ehci->async->qh_next.qh == 0)
 967                         timer_action (ehci, TIMER_ASYNC_OFF);
 968         }
 969
 970         if (next) {
 971                 ehci->reclaim = NULL;
 972                 start_unlink_async (ehci, next);
 973         }
 974 }
 975
 976 /* makes sure the async qh will become idle */
 977 /* caller must own ehci->lock */
 978
 979 static void start_unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
 980 {
 981         int             cmd = readl (&ehci->regs->command);
 982         struct ehci_qh  *prev;
 983
 984 #ifdef DEBUG
 985         if (ehci->reclaim
 986                         || (qh->qh_state != QH_STATE_LINKED
 987                                 && qh->qh_state != QH_STATE_UNLINK_WAIT)
 988 #ifdef CONFIG_SMP
 989 // this macro lies except on SMP compiles
 990                         || !spin_is_locked (&ehci->lock)
 991 #endif
 992                         )
 993                 BUG ();
 994 #endif
 995
 996         /* stop async schedule right now? */
 997         if (unlikely (qh == ehci->async)) {
 998                 /* can't get here without STS_ASS set */
 999                 if (ehci->hcd.state != USB_STATE_HALT) {
1000                         writel (cmd & ~CMD_ASE, &ehci->regs->command);
1001                         wmb ();
1002                         // handshake later, if we need to
1003                 }
1004                 timer_action_done (ehci, TIMER_ASYNC_OFF);
1005                 return;
1006         }
1007
1008         qh->qh_state = QH_STATE_UNLINK;
1009         ehci->reclaim = qh = qh_get (qh);
1010
1011         prev = ehci->async;
1012         while (prev->qh_next.qh != qh)
1013                 prev = prev->qh_next.qh;
1014
1015         prev->hw_next = qh->hw_next;
1016         prev->qh_next = qh->qh_next;
1017         wmb ();
1018
1019         if (unlikely (ehci->hcd.state == USB_STATE_HALT)) {
1020                 /* if (unlikely (qh->reclaim != 0))
1021                  *      this will recurse, probably not much
1022                  */
1023                 end_unlink_async (ehci, NULL);
1024                 return;
1025         }
1026
1027         ehci->reclaim_ready = 0;
1028         cmd |= CMD_IAAD;
1029         writel (cmd, &ehci->regs->command);
1030         (void) readl (&ehci->regs->command);
1031         timer_action (ehci, TIMER_IAA_WATCHDOG);
1032 }
1033
1034 /*-------------------------------------------------------------------------*/
1035
1036 static void
1037 scan_async (struct ehci_hcd *ehci, struct pt_regs *regs)
1038 {
1039         struct ehci_qh          *qh;
1040         enum ehci_timer_action  action = TIMER_IO_WATCHDOG;
1041
1042         if (!++(ehci->stamp))
1043                 ehci->stamp++;
1044         timer_action_done (ehci, TIMER_ASYNC_SHRINK);
1045 rescan:
1046         qh = ehci->async->qh_next.qh;
1047         if (likely (qh != 0)) {
1048                 do {
1049                         /* clean any finished work for this qh */
1050                         if (!list_empty (&qh->qtd_list)
1051                                         && qh->stamp != ehci->stamp) {
1052                                 int temp;
1053
1054                                 /* unlinks could happen here; completion
1055                                  * reporting drops the lock.  rescan using
1056                                  * the latest schedule, but don't rescan
1057                                  * qhs we already finished (no looping).
1058                                  */
1059                                 qh = qh_get (qh);
1060                                 qh->stamp = ehci->stamp;
1061                                 temp = qh_completions (ehci, qh, regs);
1062                                 qh_put (qh);
1063                                 if (temp != 0) {
1064                                         goto rescan;
1065                                 }
1066                         }
1067
1068                         /* unlink idle entries, reducing HC PCI usage as well
1069                          * as HCD schedule-scanning costs.  delay for any qh
1070                          * we just scanned, there's a not-unusual case that it
1071                          * doesn't stay idle for long.
1072                          * (plus, avoids some kind of re-activation race.)
1073                          */
1074                         if (list_empty (&qh->qtd_list)) {
1075                                 if (qh->stamp == ehci->stamp)
1076                                         action = TIMER_ASYNC_SHRINK;
1077                                 else if (!ehci->reclaim
1078                                             && qh->qh_state == QH_STATE_LINKED)
1079                                         start_unlink_async (ehci, qh);
1080                         }
1081
1082                         qh = qh->qh_next.qh;
1083                 } while (qh);
1084         }
1085         if (action == TIMER_ASYNC_SHRINK)
1086                 timer_action (ehci, TIMER_ASYNC_SHRINK);
1087 }