drivers/usb/host/ehci-q.c

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