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