drivers/usb/host/ehci-q.c

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