drivers/usb/host/ehci-sched.c

   1 /*
   2  * Copyright (c) 2001-2003 by David Brownell
   3  * Copyright (c) 2003 Michal Sojka, for high-speed iso transfers
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software Foundation,
  17  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 /* this file is part of ehci-hcd.c */
  21
  22 /*-------------------------------------------------------------------------*/
  23
  24 /*
  25  * EHCI scheduled transaction support:  interrupt, iso, split iso
  26  * These are called "periodic" transactions in the EHCI spec.
  27  *
  28  * Note that for interrupt transfers, the QH/QTD manipulation is shared
  29  * with the "asynchronous" transaction support (control/bulk transfers).
  30  * The only real difference is in how interrupt transfers are scheduled.
  31  *
  32  * For ISO, we make an "iso_stream" head to serve the same role as a QH.
  33  * It keeps track of every ITD (or SITD) that's linked, and holds enough
  34  * pre-calculated schedule data to make appending to the queue be quick.
  35  */
  36
  37 static int ehci_get_frame (struct usb_hcd *hcd);
  38
  39 /*-------------------------------------------------------------------------*/
  40
  41 /*
  42  * periodic_next_shadow - return "next" pointer on shadow list
  43  * @periodic: host pointer to qh/itd/sitd
  44  * @tag: hardware tag for type of this record
  45  */
  46 static union ehci_shadow *
  47 periodic_next_shadow (union ehci_shadow *periodic, __le32 tag)
  48 {
  49         switch (tag) {
  50         case Q_TYPE_QH:
  51                 return &periodic->qh->qh_next;
  52         case Q_TYPE_FSTN:
  53                 return &periodic->fstn->fstn_next;
  54         case Q_TYPE_ITD:
  55                 return &periodic->itd->itd_next;
  56         // case Q_TYPE_SITD:
  57         default:
  58                 return &periodic->sitd->sitd_next;
  59         }
  60 }
  61
  62 /* returns true after successful unlink */
  63 /* caller must hold ehci->lock */
  64 static int periodic_unlink (struct ehci_hcd *ehci, unsigned frame, void *ptr)
  65 {
  66         union ehci_shadow       *prev_p = &ehci->pshadow [frame];
  67         __le32                  *hw_p = &ehci->periodic [frame];
  68         union ehci_shadow       here = *prev_p;
  69         union ehci_shadow       *next_p;
  70
  71         /* find predecessor of "ptr"; hw and shadow lists are in sync */
  72         while (here.ptr && here.ptr != ptr) {
  73                 prev_p = periodic_next_shadow (prev_p, Q_NEXT_TYPE (*hw_p));
  74                 hw_p = &here.qh->hw_next;
  75                 here = *prev_p;
  76         }
  77         /* an interrupt entry (at list end) could have been shared */
  78         if (!here.ptr) {
  79                 dbg ("entry %p no longer on frame [%d]", ptr, frame);
  80                 return 0;
  81         }
  82         // vdbg ("periodic unlink %p from frame %d", ptr, frame);
  83
  84         /* update hardware list ... HC may still know the old structure, so
  85          * don't change hw_next until it'll have purged its cache
  86          */
  87         next_p = periodic_next_shadow (&here, Q_NEXT_TYPE (*hw_p));
  88         *hw_p = here.qh->hw_next;
  89
  90         /* unlink from shadow list; HCD won't see old structure again */
  91         *prev_p = *next_p;
  92         next_p->ptr = NULL;
  93
  94         return 1;
  95 }
  96
  97 /* how many of the uframe's 125 usecs are allocated? */
  98 static unsigned short
  99 periodic_usecs (struct ehci_hcd *ehci, unsigned frame, unsigned uframe)
 100 {
 101         __le32                  *hw_p = &ehci->periodic [frame];
 102         union ehci_shadow       *q = &ehci->pshadow [frame];
 103         unsigned                usecs = 0;
 104
 105         while (q->ptr) {
 106                 switch (Q_NEXT_TYPE (*hw_p)) {
 107                 case Q_TYPE_QH:
 108                         /* is it in the S-mask? */
 109                         if (q->qh->hw_info2 & cpu_to_le32 (1 << uframe))
 110                                 usecs += q->qh->usecs;
 111                         /* ... or C-mask? */
 112                         if (q->qh->hw_info2 & cpu_to_le32 (1 << (8 + uframe)))
 113                                 usecs += q->qh->c_usecs;
 114                         hw_p = &q->qh->hw_next;
 115                         q = &q->qh->qh_next;
 116                         break;
 117                 case Q_TYPE_FSTN:
 118                         /* for "save place" FSTNs, count the relevant INTR
 119                          * bandwidth from the previous frame
 120                          */
 121                         if (q->fstn->hw_prev != EHCI_LIST_END) {
 122                                 ehci_dbg (ehci, "ignoring FSTN cost ...\n");
 123                         }
 124                         hw_p = &q->fstn->hw_next;
 125                         q = &q->fstn->fstn_next;
 126                         break;
 127                 case Q_TYPE_ITD:
 128                         usecs += q->itd->usecs [uframe];
 129                         hw_p = &q->itd->hw_next;
 130                         q = &q->itd->itd_next;
 131                         break;
 132                 case Q_TYPE_SITD:
 133                         /* is it in the S-mask?  (count SPLIT, DATA) */
 134                         if (q->sitd->hw_uframe & cpu_to_le32 (1 << uframe)) {
 135                                 if (q->sitd->hw_fullspeed_ep &
 136                                                 __constant_cpu_to_le32 (1<<31))
 137                                         usecs += q->sitd->stream->usecs;
 138                                 else    /* worst case for OUT start-split */
 139                                         usecs += HS_USECS_ISO (188);
 140                         }
 141
 142                         /* ... C-mask?  (count CSPLIT, DATA) */
 143                         if (q->sitd->hw_uframe &
 144                                         cpu_to_le32 (1 << (8 + uframe))) {
 145                                 /* worst case for IN complete-split */
 146                                 usecs += q->sitd->stream->c_usecs;
 147                         }
 148
 149                         hw_p = &q->sitd->hw_next;
 150                         q = &q->sitd->sitd_next;
 151                         break;
 152                 default:
 153                         BUG ();
 154                 }
 155         }
 156 #ifdef  DEBUG
 157         if (usecs > 100)
 158                 err ("overallocated uframe %d, periodic is %d usecs",
 159                         frame * 8 + uframe, usecs);
 160 #endif
 161         return usecs;
 162 }
 163
 164 /*-------------------------------------------------------------------------*/
 165
 166 static int same_tt (struct usb_device *dev1, struct usb_device *dev2)
 167 {
 168         if (!dev1->tt || !dev2->tt)
 169                 return 0;
 170         if (dev1->tt != dev2->tt)
 171                 return 0;
 172         if (dev1->tt->multi)
 173                 return dev1->ttport == dev2->ttport;
 174         else
 175                 return 1;
 176 }
 177
 178 /* return true iff the device's transaction translator is available
 179  * for a periodic transfer starting at the specified frame, using
 180  * all the uframes in the mask.
 181  */
 182 static int tt_no_collision (
 183         struct ehci_hcd         *ehci,
 184         unsigned                period,
 185         struct usb_device       *dev,
 186         unsigned                frame,
 187         u32                     uf_mask
 188 )
 189 {
 190         if (period == 0)        /* error */
 191                 return 0;
 192
 193         /* note bandwidth wastage:  split never follows csplit
 194          * (different dev or endpoint) until the next uframe.
 195          * calling convention doesn't make that distinction.
 196          */
 197         for (; frame < ehci->periodic_size; frame += period) {
 198                 union ehci_shadow       here;
 199                 __le32                  type;
 200
 201                 here = ehci->pshadow [frame];
 202                 type = Q_NEXT_TYPE (ehci->periodic [frame]);
 203                 while (here.ptr) {
 204                         switch (type) {
 205                         case Q_TYPE_ITD:
 206                                 type = Q_NEXT_TYPE (here.itd->hw_next);
 207                                 here = here.itd->itd_next;
 208                                 continue;
 209                         case Q_TYPE_QH:
 210                                 if (same_tt (dev, here.qh->dev)) {
 211                                         u32             mask;
 212
 213                                         mask = le32_to_cpu (here.qh->hw_info2);
 214                                         /* "knows" no gap is needed */
 215                                         mask |= mask >> 8;
 216                                         if (mask & uf_mask)
 217                                                 break;
 218                                 }
 219                                 type = Q_NEXT_TYPE (here.qh->hw_next);
 220                                 here = here.qh->qh_next;
 221                                 continue;
 222                         case Q_TYPE_SITD:
 223                                 if (same_tt (dev, here.itd->urb->dev)) {
 224                                         u16             mask;
 225
 226                                         mask = le32_to_cpu (here.sitd
 227                                                                 ->hw_uframe);
 228                                         /* FIXME assumes no gap for IN! */
 229                                         mask |= mask >> 8;
 230                                         if (mask & uf_mask)
 231                                                 break;
 232                                 }
 233                                 type = Q_NEXT_TYPE (here.qh->hw_next);
 234                                 here = here.sitd->sitd_next;
 235                                 continue;
 236                         // case Q_TYPE_FSTN:
 237                         default:
 238                                 ehci_dbg (ehci,
 239                                         "periodic frame %d bogus type %d\n",
 240                                         frame, type);
 241                         }
 242
 243                         /* collision or error */
 244                         return 0;
 245                 }
 246         }
 247
 248         /* no collision */
 249         return 1;
 250 }
 251
 252 /*-------------------------------------------------------------------------*/
 253
 254 static int enable_periodic (struct ehci_hcd *ehci)
 255 {
 256         u32     cmd;
 257         int     status;
 258
 259         /* did clearing PSE did take effect yet?
 260          * takes effect only at frame boundaries...
 261          */
 262         status = handshake (&ehci->regs->status, STS_PSS, 0, 9 * 125);
 263         if (status != 0) {
 264                 ehci->hcd.state = USB_STATE_HALT;
 265                 return status;
 266         }
 267
 268         cmd = readl (&ehci->regs->command) | CMD_PSE;
 269         writel (cmd, &ehci->regs->command);
 270         /* posted write ... PSS happens later */
 271         ehci->hcd.state = USB_STATE_RUNNING;
 272
 273         /* make sure ehci_work scans these */
 274         ehci->next_uframe = readl (&ehci->regs->frame_index)
 275                                 % (ehci->periodic_size << 3);
 276         return 0;
 277 }
 278
 279 static int disable_periodic (struct ehci_hcd *ehci)
 280 {
 281         u32     cmd;
 282         int     status;
 283
 284         /* did setting PSE not take effect yet?
 285          * takes effect only at frame boundaries...
 286          */
 287         status = handshake (&ehci->regs->status, STS_PSS, STS_PSS, 9 * 125);
 288         if (status != 0) {
 289                 ehci->hcd.state = USB_STATE_HALT;
 290                 return status;
 291         }
 292
 293         cmd = readl (&ehci->regs->command) & ~CMD_PSE;
 294         writel (cmd, &ehci->regs->command);
 295         /* posted write ... */
 296
 297         ehci->next_uframe = -1;
 298         return 0;
 299 }
 300
 301 /*-------------------------------------------------------------------------*/
 302
 303 // FIXME microframe periods not yet handled
 304
 305 static void intr_deschedule (
 306         struct ehci_hcd *ehci,
 307         struct ehci_qh  *qh,
 308         int             wait
 309 ) {
 310         int             status;
 311         unsigned        frame = qh->start;
 312
 313         do {
 314                 periodic_unlink (ehci, frame, qh);
 315                 qh_put (qh);
 316                 frame += qh->period;
 317         } while (frame < ehci->periodic_size);
 318
 319         qh->qh_state = QH_STATE_UNLINK;
 320         qh->qh_next.ptr = NULL;
 321         ehci->periodic_sched--;
 322
 323         /* maybe turn off periodic schedule */
 324         if (!ehci->periodic_sched)
 325                 status = disable_periodic (ehci);
 326         else {
 327                 status = 0;
 328                 vdbg ("periodic schedule still enabled");
 329         }
 330
 331         /*
 332          * If the hc may be looking at this qh, then delay a uframe
 333          * (yeech!) to be sure it's done.
 334          * No other threads may be mucking with this qh.
 335          */
 336         if (((ehci_get_frame (&ehci->hcd) - frame) % qh->period) == 0) {
 337                 if (wait) {
 338                         udelay (125);
 339                         qh->hw_next = EHCI_LIST_END;
 340                 } else {
 341                         /* we may not be IDLE yet, but if the qh is empty
 342                          * the race is very short.  then if qh also isn't
 343                          * rescheduled soon, it won't matter.  otherwise...
 344                          */
 345                         vdbg ("intr_deschedule...");
 346                 }
 347         } else
 348                 qh->hw_next = EHCI_LIST_END;
 349
 350         qh->qh_state = QH_STATE_IDLE;
 351
 352         /* update per-qh bandwidth utilization (for usbfs) */
 353         hcd_to_bus (&ehci->hcd)->bandwidth_allocated -=
 354                 (qh->usecs + qh->c_usecs) / qh->period;
 355
 356         dbg ("descheduled qh %p, period = %d frame = %d count = %d, urbs = %d",
 357                 qh, qh->period, frame,
 358                 atomic_read (&qh->kref.refcount), ehci->periodic_sched);
 359 }
 360
 361 static int check_period (
 362         struct ehci_hcd *ehci,
 363         unsigned        frame,
 364         unsigned        uframe,
 365         unsigned        period,
 366         unsigned        usecs
 367 ) {
 368         /* complete split running into next frame?
 369          * given FSTN support, we could sometimes check...
 370          */
 371         if (uframe >= 8)
 372                 return 0;
 373
 374         /*
 375          * 80% periodic == 100 usec/uframe available
 376          * convert "usecs we need" to "max already claimed"
 377          */
 378         usecs = 100 - usecs;
 379
 380         do {
 381                 int     claimed;
 382
 383 // FIXME delete when intr_submit handles non-empty queues
 384 // this gives us a one intr/frame limit (vs N/uframe)
 385 // ... and also lets us avoid tracking split transactions
 386 // that might collide at a given TT/hub.
 387                 if (ehci->pshadow [frame].ptr)
 388                         return 0;
 389
 390                 claimed = periodic_usecs (ehci, frame, uframe);
 391                 if (claimed > usecs)
 392                         return 0;
 393
 394 // FIXME update to handle sub-frame periods
 395         } while ((frame += period) < ehci->periodic_size);
 396
 397         // success!
 398         return 1;
 399 }
 400
 401 static int check_intr_schedule (
 402         struct ehci_hcd         *ehci,
 403         unsigned                frame,
 404         unsigned                uframe,
 405         const struct ehci_qh    *qh,
 406         __le32                  *c_maskp
 407 )
 408 {
 409         int             retval = -ENOSPC;
 410
 411         if (!check_period (ehci, frame, uframe, qh->period, qh->usecs))
 412                 goto done;
 413         if (!qh->c_usecs) {
 414                 retval = 0;
 415                 *c_maskp = 0;
 416                 goto done;
 417         }
 418
 419         /* This is a split transaction; check the bandwidth available for
 420          * the completion too.  Check both worst and best case gaps: worst
 421          * case is SPLIT near uframe end, and CSPLIT near start ... best is
 422          * vice versa.  Difference can be almost two uframe times, but we
 423          * reserve unnecessary bandwidth (waste it) this way.  (Actually
 424          * even better cases exist, like immediate device NAK.)
 425          *
 426          * FIXME don't even bother unless we know this TT is idle in that
 427          * range of uframes ... for now, check_period() allows only one
 428          * interrupt transfer per frame, so needn't check "TT busy" status
 429          * when scheduling a split (QH, SITD, or FSTN).
 430          *
 431          * FIXME ehci 0.96 and above can use FSTNs
 432          */
 433         if (!check_period (ehci, frame, uframe + qh->gap_uf + 1,
 434                                 qh->period, qh->c_usecs))
 435                 goto done;
 436         if (!check_period (ehci, frame, uframe + qh->gap_uf,
 437                                 qh->period, qh->c_usecs))
 438                 goto done;
 439
 440         *c_maskp = cpu_to_le32 (0x03 << (8 + uframe + qh->gap_uf));
 441         retval = 0;
 442 done:
 443         return retval;
 444 }
 445
 446 static int qh_schedule (struct ehci_hcd *ehci, struct ehci_qh *qh)
 447 {
 448         int             status;
 449         unsigned        uframe;
 450         __le32          c_mask;
 451         unsigned        frame;          /* 0..(qh->period - 1), or NO_FRAME */
 452
 453         qh->hw_next = EHCI_LIST_END;
 454         frame = qh->start;
 455
 456         /* reuse the previous schedule slots, if we can */
 457         if (frame < qh->period) {
 458                 uframe = ffs (le32_to_cpup (&qh->hw_info2) & 0x00ff);
 459                 status = check_intr_schedule (ehci, frame, --uframe,
 460                                 qh, &c_mask);
 461         } else {
 462                 uframe = 0;
 463                 c_mask = 0;
 464                 status = -ENOSPC;
 465         }
 466
 467         /* else scan the schedule to find a group of slots such that all
 468          * uframes have enough periodic bandwidth available.
 469          */
 470         if (status) {
 471                 frame = qh->period - 1;
 472                 do {
 473                         for (uframe = 0; uframe < 8; uframe++) {
 474                                 status = check_intr_schedule (ehci,
 475                                                 frame, uframe, qh,
 476                                                 &c_mask);
 477                                 if (status == 0)
 478                                         break;
 479                         }
 480                 } while (status && frame--);
 481                 if (status)
 482                         goto done;
 483                 qh->start = frame;
 484
 485                 /* reset S-frame and (maybe) C-frame masks */
 486                 qh->hw_info2 &= ~__constant_cpu_to_le32(0xffff);
 487                 qh->hw_info2 |= cpu_to_le32 (1 << uframe) | c_mask;
 488         } else
 489                 dbg ("reused previous qh %p schedule", qh);
 490
 491         /* stuff into the periodic schedule */
 492         qh->qh_state = QH_STATE_LINKED;
 493         dbg ("scheduled qh %p usecs %d/%d period %d.0 starting %d.%d (gap %d)",
 494                 qh, qh->usecs, qh->c_usecs,
 495                 qh->period, frame, uframe, qh->gap_uf);
 496         do {
 497                 if (unlikely (ehci->pshadow [frame].ptr != 0)) {
 498
 499 // FIXME -- just link toward the end, before any qh with a shorter period,
 500 // AND accommodate it already having been linked here (after some other qh)
 501 // AS WELL AS updating the schedule checking logic
 502
 503                         BUG ();
 504                 } else {
 505                         ehci->pshadow [frame].qh = qh_get (qh);
 506                         ehci->periodic [frame] =
 507                                 QH_NEXT (qh->qh_dma);
 508                 }
 509                 wmb ();
 510                 frame += qh->period;
 511         } while (frame < ehci->periodic_size);
 512
 513         /* update per-qh bandwidth for usbfs */
 514         hcd_to_bus (&ehci->hcd)->bandwidth_allocated +=
 515                 (qh->usecs + qh->c_usecs) / qh->period;
 516
 517         /* maybe enable periodic schedule processing */
 518         if (!ehci->periodic_sched++)
 519                 status = enable_periodic (ehci);
 520 done:
 521         return status;
 522 }
 523
 524 static int intr_submit (
 525         struct ehci_hcd         *ehci,
 526         struct urb              *urb,
 527         struct list_head        *qtd_list,
 528         int                     mem_flags
 529 ) {
 530         unsigned                epnum;
 531         unsigned long           flags;
 532         struct ehci_qh          *qh;
 533         struct hcd_dev          *dev;
 534         int                     is_input;
 535         int                     status = 0;
 536         struct list_head        empty;
 537
 538         /* get endpoint and transfer/schedule data */
 539         epnum = usb_pipeendpoint (urb->pipe);
 540         is_input = usb_pipein (urb->pipe);
 541         if (is_input)
 542                 epnum |= 0x10;
 543
 544         spin_lock_irqsave (&ehci->lock, flags);
 545         dev = (struct hcd_dev *)urb->dev->hcpriv;
 546
 547         /* get qh and force any scheduling errors */
 548         INIT_LIST_HEAD (&empty);
 549         qh = qh_append_tds (ehci, urb, &empty, epnum, &dev->ep [epnum]);
 550         if (qh == 0) {
 551                 status = -ENOMEM;
 552                 goto done;
 553         }
 554         if (qh->qh_state == QH_STATE_IDLE) {
 555                 if ((status = qh_schedule (ehci, qh)) != 0)
 556                         goto done;
 557         }
 558
 559         /* then queue the urb's tds to the qh */
 560         qh = qh_append_tds (ehci, urb, qtd_list, epnum, &dev->ep [epnum]);
 561         BUG_ON (qh == 0);
 562
 563         /* ... update usbfs periodic stats */
 564         hcd_to_bus (&ehci->hcd)->bandwidth_int_reqs++;
 565
 566 done:
 567         spin_unlock_irqrestore (&ehci->lock, flags);
 568         if (status)
 569                 qtd_list_free (ehci, urb, qtd_list);
 570
 571         return status;
 572 }
 573
 574 /*-------------------------------------------------------------------------*/
 575
 576 /* ehci_iso_stream ops work with both ITD and SITD */
 577
 578 static struct ehci_iso_stream *
 579 iso_stream_alloc (int mem_flags)
 580 {
 581         struct ehci_iso_stream *stream;
 582
 583         stream = kmalloc(sizeof *stream, mem_flags);
 584         if (likely (stream != 0)) {
 585                 memset (stream, 0, sizeof(*stream));
 586                 INIT_LIST_HEAD(&stream->td_list);
 587                 INIT_LIST_HEAD(&stream->free_list);
 588                 stream->next_uframe = -1;
 589                 stream->refcount = 1;
 590         }
 591         return stream;
 592 }
 593
 594 static void
 595 iso_stream_init (
 596         struct ehci_iso_stream  *stream,
 597         struct usb_device       *dev,
 598         int                     pipe,
 599         unsigned                interval
 600 )
 601 {
 602         static const u8 smask_out [] = { 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f };
 603
 604         u32                     buf1;
 605         unsigned                epnum, maxp;
 606         int                     is_input;
 607         long                    bandwidth;
 608
 609         /*
 610          * this might be a "high bandwidth" highspeed endpoint,
 611          * as encoded in the ep descriptor's wMaxPacket field
 612          */
 613         epnum = usb_pipeendpoint (pipe);
 614         is_input = usb_pipein (pipe) ? USB_DIR_IN : 0;
 615         if (is_input) {
 616                 maxp = dev->epmaxpacketin [epnum];
 617                 buf1 = (1 << 11);
 618         } else {
 619                 maxp = dev->epmaxpacketout [epnum];
 620                 buf1 = 0;
 621         }
 622
 623         /* knows about ITD vs SITD */
 624         if (dev->speed == USB_SPEED_HIGH) {
 625                 unsigned multi = hb_mult(maxp);
 626
 627                 stream->highspeed = 1;
 628
 629                 maxp = max_packet(maxp);
 630                 buf1 |= maxp;
 631                 maxp *= multi;
 632
 633                 stream->buf0 = cpu_to_le32 ((epnum << 8) | dev->devnum);
 634                 stream->buf1 = cpu_to_le32 (buf1);
 635                 stream->buf2 = cpu_to_le32 (multi);
 636
 637                 /* usbfs wants to report the average usecs per frame tied up
 638                  * when transfers on this endpoint are scheduled ...
 639                  */
 640                 stream->usecs = HS_USECS_ISO (maxp);
 641                 bandwidth = stream->usecs * 8;
 642                 bandwidth /= 1 << (interval - 1);
 643
 644         } else {
 645                 u32             addr;
 646
 647                 addr = dev->ttport << 24;
 648                 addr |= dev->tt->hub->devnum << 16;
 649                 addr |= epnum << 8;
 650                 addr |= dev->devnum;
 651                 stream->usecs = HS_USECS_ISO (maxp);
 652                 if (is_input) {
 653                         u32     tmp;
 654
 655                         addr |= 1 << 31;
 656                         stream->c_usecs = stream->usecs;
 657                         stream->usecs = HS_USECS_ISO (1);
 658                         stream->raw_mask = 1;
 659
 660                         /* pessimistic c-mask */
 661                         tmp = usb_calc_bus_time (USB_SPEED_FULL, 1, 0, maxp)
 662                                         / (125 * 1000);
 663                         stream->raw_mask |= 3 << (tmp + 9);
 664                 } else
 665                         stream->raw_mask = smask_out [maxp / 188];
 666                 bandwidth = stream->usecs + stream->c_usecs;
 667                 bandwidth /= 1 << (interval + 2);
 668
 669                 /* stream->splits gets created from raw_mask later */
 670                 stream->address = cpu_to_le32 (addr);
 671         }
 672         stream->bandwidth = bandwidth;
 673
 674         stream->udev = dev;
 675
 676         stream->bEndpointAddress = is_input | epnum;
 677         stream->interval = interval;
 678         stream->maxp = maxp;
 679 }
 680
 681 static void
 682 iso_stream_put(struct ehci_hcd *ehci, struct ehci_iso_stream *stream)
 683 {
 684         stream->refcount--;
 685
 686         /* free whenever just a dev->ep reference remains.
 687          * not like a QH -- no persistent state (toggle, halt)
 688          */
 689         if (stream->refcount == 1) {
 690                 int             is_in;
 691                 struct hcd_dev  *dev = stream->udev->hcpriv;
 692
 693                 // BUG_ON (!list_empty(&stream->td_list));
 694
 695                 while (!list_empty (&stream->free_list)) {
 696                         struct list_head        *entry;
 697
 698                         entry = stream->free_list.next;
 699                         list_del (entry);
 700
 701                         /* knows about ITD vs SITD */
 702                         if (stream->highspeed) {
 703                                 struct ehci_itd         *itd;
 704
 705                                 itd = list_entry (entry, struct ehci_itd,
 706                                                 itd_list);
 707                                 dma_pool_free (ehci->itd_pool, itd,
 708                                                 itd->itd_dma);
 709                         } else {
 710                                 struct ehci_sitd        *sitd;
 711
 712                                 sitd = list_entry (entry, struct ehci_sitd,
 713                                                 sitd_list);
 714                                 dma_pool_free (ehci->sitd_pool, sitd,
 715                                                 sitd->sitd_dma);
 716                         }
 717                 }
 718
 719                 is_in = (stream->bEndpointAddress & USB_DIR_IN) ? 0x10 : 0;
 720                 stream->bEndpointAddress &= 0x0f;
 721                 dev->ep[is_in + stream->bEndpointAddress] = NULL;
 722
 723                 if (stream->rescheduled) {
 724                         ehci_info (ehci, "ep%d%s-iso rescheduled "
 725                                 "%lu times in %lu seconds\n",
 726                                 stream->bEndpointAddress, is_in ? "in" : "out",
 727                                 stream->rescheduled,
 728                                 ((jiffies - stream->start)/HZ)
 729                                 );
 730                 }
 731
 732                 kfree(stream);
 733         }
 734 }
 735
 736 static inline struct ehci_iso_stream *
 737 iso_stream_get (struct ehci_iso_stream *stream)
 738 {
 739         if (likely (stream != 0))
 740                 stream->refcount++;
 741         return stream;
 742 }
 743
 744 static struct ehci_iso_stream *
 745 iso_stream_find (struct ehci_hcd *ehci, struct urb *urb)
 746 {
 747         unsigned                epnum;
 748         struct hcd_dev          *dev;
 749         struct ehci_iso_stream  *stream;
 750         unsigned long           flags;
 751
 752         epnum = usb_pipeendpoint (urb->pipe);
 753         if (usb_pipein(urb->pipe))
 754                 epnum += 0x10;
 755
 756         spin_lock_irqsave (&ehci->lock, flags);
 757
 758         dev = (struct hcd_dev *)urb->dev->hcpriv;
 759         stream = dev->ep [epnum];
 760
 761         if (unlikely (stream == 0)) {
 762                 stream = iso_stream_alloc(GFP_ATOMIC);
 763                 if (likely (stream != 0)) {
 764                         /* dev->ep owns the initial refcount */
 765                         dev->ep[epnum] = stream;
 766                         iso_stream_init(stream, urb->dev, urb->pipe,
 767                                         urb->interval);
 768                 }
 769
 770         /* if dev->ep [epnum] is a QH, info1.maxpacket is nonzero */
 771         } else if (unlikely (stream->hw_info1 != 0)) {
 772                 ehci_dbg (ehci, "dev %s ep%d%s, not iso??\n",
 773                         urb->dev->devpath, epnum & 0x0f,
 774                         (epnum & 0x10) ? "in" : "out");
 775                 stream = NULL;
 776         }
 777
 778         /* caller guarantees an eventual matching iso_stream_put */
 779         stream = iso_stream_get (stream);
 780
 781         spin_unlock_irqrestore (&ehci->lock, flags);
 782         return stream;
 783 }
 784
 785 /*-------------------------------------------------------------------------*/
 786
 787 /* ehci_iso_sched ops can be shared, ITD-only, or SITD-only */
 788
 789 static struct ehci_iso_sched *
 790 iso_sched_alloc (unsigned packets, int mem_flags)
 791 {
 792         struct ehci_iso_sched   *iso_sched;
 793         int                     size = sizeof *iso_sched;
 794
 795         size += packets * sizeof (struct ehci_iso_packet);
 796         iso_sched = kmalloc (size, mem_flags);
 797         if (likely (iso_sched != 0)) {
 798                 memset(iso_sched, 0, size);
 799                 INIT_LIST_HEAD (&iso_sched->td_list);
 800         }
 801         return iso_sched;
 802 }
 803
 804 static inline void
 805 itd_sched_init (
 806         struct ehci_iso_sched   *iso_sched,
 807         struct ehci_iso_stream  *stream,
 808         struct urb              *urb
 809 )
 810 {
 811         unsigned        i;
 812         dma_addr_t      dma = urb->transfer_dma;
 813
 814         /* how many uframes are needed for these transfers */
 815         iso_sched->span = urb->number_of_packets * stream->interval;
 816
 817         /* figure out per-uframe itd fields that we'll need later
 818          * when we fit new itds into the schedule.
 819          */
 820         for (i = 0; i < urb->number_of_packets; i++) {
 821                 struct ehci_iso_packet  *uframe = &iso_sched->packet [i];
 822                 unsigned                length;
 823                 dma_addr_t              buf;
 824                 u32                     trans;
 825
 826                 length = urb->iso_frame_desc [i].length;
 827                 buf = dma + urb->iso_frame_desc [i].offset;
 828
 829                 trans = EHCI_ISOC_ACTIVE;
 830                 trans |= buf & 0x0fff;
 831                 if (unlikely (((i + 1) == urb->number_of_packets))
 832                                 && !(urb->transfer_flags & URB_NO_INTERRUPT))
 833                         trans |= EHCI_ITD_IOC;
 834                 trans |= length << 16;
 835                 uframe->transaction = cpu_to_le32 (trans);
 836
 837                 /* might need to cross a buffer page within a td */
 838                 uframe->bufp = (buf & ~(u64)0x0fff);
 839                 buf += length;
 840                 if (unlikely ((uframe->bufp != (buf & ~(u64)0x0fff))))
 841                         uframe->cross = 1;
 842         }
 843 }
 844
 845 static void
 846 iso_sched_free (
 847         struct ehci_iso_stream  *stream,
 848         struct ehci_iso_sched   *iso_sched
 849 )
 850 {
 851         if (!iso_sched)
 852                 return;
 853         // caller must hold ehci->lock!
 854         list_splice (&iso_sched->td_list, &stream->free_list);
 855         kfree (iso_sched);
 856 }
 857
 858 static int
 859 itd_urb_transaction (
 860         struct ehci_iso_stream  *stream,
 861         struct ehci_hcd         *ehci,
 862         struct urb              *urb,
 863         int                     mem_flags
 864 )
 865 {
 866         struct ehci_itd         *itd;
 867         dma_addr_t              itd_dma;
 868         int                     i;
 869         unsigned                num_itds;
 870         struct ehci_iso_sched   *sched;
 871         unsigned long           flags;
 872
 873         sched = iso_sched_alloc (urb->number_of_packets, mem_flags);
 874         if (unlikely (sched == 0))
 875                 return -ENOMEM;
 876
 877         itd_sched_init (sched, stream, urb);
 878
 879         if (urb->interval < 8)
 880                 num_itds = 1 + (sched->span + 7) / 8;
 881         else
 882                 num_itds = urb->number_of_packets;
 883
 884         /* allocate/init ITDs */
 885         spin_lock_irqsave (&ehci->lock, flags);
 886         for (i = 0; i < num_itds; i++) {
 887
 888                 /* free_list.next might be cache-hot ... but maybe
 889                  * the HC caches it too. avoid that issue for now.
 890                  */
 891
 892                 /* prefer previously-allocated itds */
 893                 if (likely (!list_empty(&stream->free_list))) {
 894                         itd = list_entry (stream->free_list.prev,
 895                                          struct ehci_itd, itd_list);
 896                         list_del (&itd->itd_list);
 897                         itd_dma = itd->itd_dma;
 898                 } else
 899                         itd = NULL;
 900
 901                 if (!itd) {
 902                         spin_unlock_irqrestore (&ehci->lock, flags);
 903                         itd = dma_pool_alloc (ehci->itd_pool, mem_flags,
 904                                         &itd_dma);
 905                         spin_lock_irqsave (&ehci->lock, flags);
 906                 }
 907
 908                 if (unlikely (0 == itd)) {
 909                         iso_sched_free (stream, sched);
 910                         return -ENOMEM;
 911                 }
 912                 memset (itd, 0, sizeof *itd);
 913                 itd->itd_dma = itd_dma;
 914                 list_add (&itd->itd_list, &sched->td_list);
 915         }
 916         spin_unlock_irqrestore (&ehci->lock, flags);
 917
 918         /* temporarily store schedule info in hcpriv */
 919         urb->hcpriv = sched;
 920         urb->error_count = 0;
 921         return 0;
 922 }
 923
 924 /*-------------------------------------------------------------------------*/
 925
 926 static inline int
 927 itd_slot_ok (
 928         struct ehci_hcd         *ehci,
 929         u32                     mod,
 930         u32                     uframe,
 931         u8                      usecs,
 932         u32                     period
 933 )
 934 {
 935         uframe %= period;
 936         do {
 937                 /* can't commit more than 80% periodic == 100 usec */
 938                 if (periodic_usecs (ehci, uframe >> 3, uframe & 0x7)
 939                                 > (100 - usecs))
 940                         return 0;
 941
 942                 /* we know urb->interval is 2^N uframes */
 943                 uframe += period;
 944         } while (uframe < mod);
 945         return 1;
 946 }
 947
 948 static inline int
 949 sitd_slot_ok (
 950         struct ehci_hcd         *ehci,
 951         u32                     mod,
 952         struct ehci_iso_stream  *stream,
 953         u32                     uframe,
 954         struct ehci_iso_sched   *sched,
 955         u32                     period_uframes
 956 )
 957 {
 958         u32                     mask, tmp;
 959         u32                     frame, uf;
 960
 961         mask = stream->raw_mask << (uframe & 7);
 962
 963         /* for IN, don't wrap CSPLIT into the next frame */
 964         if (mask & ~0xffff)
 965                 return 0;
 966
 967         /* this multi-pass logic is simple, but performance may
 968          * suffer when the schedule data isn't cached.
 969          */
 970
 971         /* check bandwidth */
 972         uframe %= period_uframes;
 973         do {
 974                 u32             max_used;
 975
 976                 frame = uframe >> 3;
 977                 uf = uframe & 7;
 978
 979                 /* tt must be idle for start(s), any gap, and csplit.
 980                  * assume scheduling slop leaves 10+% for control/bulk.
 981                  */
 982                 if (!tt_no_collision (ehci, period_uframes << 3,
 983                                 stream->udev, frame, mask))
 984                         return 0;
 985
 986                 /* check starts (OUT uses more than one) */
 987                 max_used = 100 - stream->usecs;
 988                 for (tmp = stream->raw_mask & 0xff; tmp; tmp >>= 1, uf++) {
 989                         if (periodic_usecs (ehci, frame, uf) > max_used)
 990                                 return 0;
 991                 }
 992
 993                 /* for IN, check CSPLIT */
 994                 if (stream->c_usecs) {
 995                         max_used = 100 - stream->c_usecs;
 996                         do {
 997                                 tmp = 1 << uf;
 998                                 tmp <<= 8;
 999                                 if ((stream->raw_mask & tmp) == 0)
1000                                         continue;
1001                                 if (periodic_usecs (ehci, frame, uf)
1002                                                 > max_used)
1003                                         return 0;
1004                         } while (++uf < 8);
1005                 }
1006
1007                 /* we know urb->interval is 2^N uframes */
1008                 uframe += period_uframes;
1009         } while (uframe < mod);
1010
1011         stream->splits = cpu_to_le32(stream->raw_mask << (uframe & 7));
1012         return 1;
1013 }
1014
1015 /*
1016  * This scheduler plans almost as far into the future as it has actual
1017  * periodic schedule slots.  (Affected by TUNE_FLS, which defaults to
1018  * "as small as possible" to be cache-friendlier.)  That limits the size
1019  * transfers you can stream reliably; avoid more than 64 msec per urb.
1020  * Also avoid queue depths of less than ehci's worst irq latency (affected
1021  * by the per-urb URB_NO_INTERRUPT hint, the log2_irq_thresh module parameter,
1022  * and other factors); or more than about 230 msec total (for portability,
1023  * given EHCI_TUNE_FLS and the slop).  Or, write a smarter scheduler!
1024  */
1025
1026 #define SCHEDULE_SLOP   10      /* frames */
1027
1028 static int
1029 iso_stream_schedule (
1030         struct ehci_hcd         *ehci,
1031         struct urb              *urb,
1032         struct ehci_iso_stream  *stream
1033 )
1034 {
1035         u32                     now, start, max, period;
1036         int                     status;
1037         unsigned                mod = ehci->periodic_size << 3;
1038         struct ehci_iso_sched   *sched = urb->hcpriv;
1039
1040         if (sched->span > (mod - 8 * SCHEDULE_SLOP)) {
1041                 ehci_dbg (ehci, "iso request %p too long\n", urb);
1042                 status = -EFBIG;
1043                 goto fail;
1044         }
1045
1046         if ((stream->depth + sched->span) > mod) {
1047                 ehci_dbg (ehci, "request %p would overflow (%d+%d>%d)\n",
1048                         urb, stream->depth, sched->span, mod);
1049                 status = -EFBIG;
1050                 goto fail;
1051         }
1052
1053         now = readl (&ehci->regs->frame_index) % mod;
1054
1055         /* when's the last uframe this urb could start? */
1056         max = now + mod;
1057
1058         /* typical case: reuse current schedule. stream is still active,
1059          * and no gaps from host falling behind (irq delays etc)
1060          */
1061         if (likely (!list_empty (&stream->td_list))) {
1062                 start = stream->next_uframe;
1063                 if (start < now)
1064                         start += mod;
1065                 if (likely ((start + sched->span) < max))
1066                         goto ready;
1067                 /* else fell behind; someday, try to reschedule */
1068                 status = -EL2NSYNC;
1069                 goto fail;
1070         }
1071
1072         /* need to schedule; when's the next (u)frame we could start?
1073          * this is bigger than ehci->i_thresh allows; scheduling itself
1074          * isn't free, the slop should handle reasonably slow cpus.  it
1075          * can also help high bandwidth if the dma and irq loads don't
1076          * jump until after the queue is primed.
1077          */
1078         start = SCHEDULE_SLOP * 8 + (now & ~0x07);
1079         start %= mod;
1080         stream->next_uframe = start;
1081
1082         /* NOTE:  assumes URB_ISO_ASAP, to limit complexity/bugs */
1083
1084         period = urb->interval;
1085         if (!stream->highspeed)
1086                 period <<= 3;
1087
1088         /* find a uframe slot with enough bandwidth */
1089         for (; start < (stream->next_uframe + period); start++) {
1090                 int             enough_space;
1091
1092                 /* check schedule: enough space? */
1093                 if (stream->highspeed)
1094                         enough_space = itd_slot_ok (ehci, mod, start,
1095                                         stream->usecs, period);
1096                 else {
1097                         if ((start % 8) >= 6)
1098                                 continue;
1099                         enough_space = sitd_slot_ok (ehci, mod, stream,
1100                                         start, sched, period);
1101                 }
1102
1103                 /* schedule it here if there's enough bandwidth */
1104                 if (enough_space) {
1105                         stream->next_uframe = start % mod;
1106                         goto ready;
1107                 }
1108         }
1109
1110         /* no room in the schedule */
1111         ehci_dbg (ehci, "iso %ssched full %p (now %d max %d)\n",
1112                 list_empty (&stream->td_list) ? "" : "re",
1113                 urb, now, max);
1114         status = -ENOSPC;
1115
1116 fail:
1117         iso_sched_free (stream, sched);
1118         urb->hcpriv = NULL;
1119         return status;
1120
1121 ready:
1122         urb->start_frame = stream->next_uframe;
1123         return 0;
1124 }
1125
1126 /*-------------------------------------------------------------------------*/
1127
1128 static inline void
1129 itd_init (struct ehci_iso_stream *stream, struct ehci_itd *itd)
1130 {
1131         int i;
1132
1133         itd->hw_next = EHCI_LIST_END;
1134         itd->hw_bufp [0] = stream->buf0;
1135         itd->hw_bufp [1] = stream->buf1;
1136         itd->hw_bufp [2] = stream->buf2;
1137
1138         for (i = 0; i < 8; i++)
1139                 itd->index[i] = -1;
1140
1141         /* All other fields are filled when scheduling */
1142 }
1143
1144 static inline void
1145 itd_patch (
1146         struct ehci_itd         *itd,
1147         struct ehci_iso_sched   *iso_sched,
1148         unsigned                index,
1149         u16                     uframe,
1150         int                     first
1151 )
1152 {
1153         struct ehci_iso_packet  *uf = &iso_sched->packet [index];
1154         unsigned                pg = itd->pg;
1155
1156         // BUG_ON (pg == 6 && uf->cross);
1157
1158         uframe &= 0x07;
1159         itd->index [uframe] = index;
1160
1161         itd->hw_transaction [uframe] = uf->transaction;
1162         itd->hw_transaction [uframe] |= cpu_to_le32 (pg << 12);
1163         itd->hw_bufp [pg] |= cpu_to_le32 (uf->bufp & ~(u32)0);
1164         itd->hw_bufp_hi [pg] |= cpu_to_le32 ((u32)(uf->bufp >> 32));
1165
1166         /* iso_frame_desc[].offset must be strictly increasing */
1167         if (unlikely (!first && uf->cross)) {
1168                 u64     bufp = uf->bufp + 4096;
1169                 itd->pg = ++pg;
1170                 itd->hw_bufp [pg] |= cpu_to_le32 (bufp & ~(u32)0);
1171                 itd->hw_bufp_hi [pg] |= cpu_to_le32 ((u32)(bufp >> 32));
1172         }
1173 }
1174
1175 static inline void
1176 itd_link (struct ehci_hcd *ehci, unsigned frame, struct ehci_itd *itd)
1177 {
1178         /* always prepend ITD/SITD ... only QH tree is order-sensitive */
1179         itd->itd_next = ehci->pshadow [frame];
1180         itd->hw_next = ehci->periodic [frame];
1181         ehci->pshadow [frame].itd = itd;
1182         itd->frame = frame;
1183         wmb ();
1184         ehci->periodic [frame] = cpu_to_le32 (itd->itd_dma) | Q_TYPE_ITD;
1185 }
1186
1187 /* fit urb's itds into the selected schedule slot; activate as needed */
1188 static int
1189 itd_link_urb (
1190         struct ehci_hcd         *ehci,
1191         struct urb              *urb,
1192         unsigned                mod,
1193         struct ehci_iso_stream  *stream
1194 )
1195 {
1196         int                     packet, first = 1;
1197         unsigned                next_uframe, uframe, frame;
1198         struct ehci_iso_sched   *iso_sched = urb->hcpriv;
1199         struct ehci_itd         *itd;
1200
1201         next_uframe = stream->next_uframe % mod;
1202
1203         if (unlikely (list_empty(&stream->td_list))) {
1204                 hcd_to_bus (&ehci->hcd)->bandwidth_allocated
1205                                 += stream->bandwidth;
1206                 ehci_vdbg (ehci,
1207                         "schedule devp %s ep%d%s-iso period %d start %d.%d\n",
1208                         urb->dev->devpath, stream->bEndpointAddress & 0x0f,
1209                         (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
1210                         urb->interval,
1211                         next_uframe >> 3, next_uframe & 0x7);
1212                 stream->start = jiffies;
1213         }
1214         hcd_to_bus (&ehci->hcd)->bandwidth_isoc_reqs++;
1215
1216         /* fill iTDs uframe by uframe */
1217         for (packet = 0, itd = NULL; packet < urb->number_of_packets; ) {
1218                 if (itd == NULL) {
1219                         /* ASSERT:  we have all necessary itds */
1220                         // BUG_ON (list_empty (&iso_sched->td_list));
1221
1222                         /* ASSERT:  no itds for this endpoint in this uframe */
1223
1224                         itd = list_entry (iso_sched->td_list.next,
1225                                         struct ehci_itd, itd_list);
1226                         list_move_tail (&itd->itd_list, &stream->td_list);
1227                         itd->stream = iso_stream_get (stream);
1228                         itd->urb = usb_get_urb (urb);
1229                         first = 1;
1230                         itd_init (stream, itd);
1231                 }
1232
1233                 uframe = next_uframe & 0x07;
1234                 frame = next_uframe >> 3;
1235
1236                 itd->usecs [uframe] = stream->usecs;
1237                 itd_patch (itd, iso_sched, packet, uframe, first);
1238                 first = 0;
1239
1240                 next_uframe += stream->interval;
1241                 stream->depth += stream->interval;
1242                 next_uframe %= mod;
1243                 packet++;
1244
1245                 /* link completed itds into the schedule */
1246                 if (((next_uframe >> 3) != frame)
1247                                 || packet == urb->number_of_packets) {
1248                         itd_link (ehci, frame % ehci->periodic_size, itd);
1249                         itd = NULL;
1250                 }
1251         }
1252         stream->next_uframe = next_uframe;
1253
1254         /* don't need that schedule data any more */
1255         iso_sched_free (stream, iso_sched);
1256         urb->hcpriv = NULL;
1257
1258         timer_action (ehci, TIMER_IO_WATCHDOG);
1259         if (unlikely (!ehci->periodic_sched++))
1260                 return enable_periodic (ehci);
1261         return 0;
1262 }
1263
1264 #define ISO_ERRS (EHCI_ISOC_BUF_ERR | EHCI_ISOC_BABBLE | EHCI_ISOC_XACTERR)
1265
1266 static unsigned
1267 itd_complete (
1268         struct ehci_hcd *ehci,
1269         struct ehci_itd *itd,
1270         struct pt_regs  *regs
1271 ) {
1272         struct urb                              *urb = itd->urb;
1273         struct usb_iso_packet_descriptor        *desc;
1274         u32                                     t;
1275         unsigned                                uframe;
1276         int                                     urb_index = -1;
1277         struct ehci_iso_stream                  *stream = itd->stream;
1278         struct usb_device                       *dev;
1279
1280         /* for each uframe with a packet */
1281         for (uframe = 0; uframe < 8; uframe++) {
1282                 if (likely (itd->index[uframe] == -1))
1283                         continue;
1284                 urb_index = itd->index[uframe];
1285                 desc = &urb->iso_frame_desc [urb_index];
1286
1287                 t = le32_to_cpup (&itd->hw_transaction [uframe]);
1288                 itd->hw_transaction [uframe] = 0;
1289                 stream->depth -= stream->interval;
1290
1291                 /* report transfer status */
1292                 if (unlikely (t & ISO_ERRS)) {
1293                         urb->error_count++;
1294                         if (t & EHCI_ISOC_BUF_ERR)
1295                                 desc->status = usb_pipein (urb->pipe)
1296                                         ? -ENOSR  /* hc couldn't read */
1297                                         : -ECOMM; /* hc couldn't write */
1298                         else if (t & EHCI_ISOC_BABBLE)
1299                                 desc->status = -EOVERFLOW;
1300                         else /* (t & EHCI_ISOC_XACTERR) */
1301                                 desc->status = -EPROTO;
1302
1303                         /* HC need not update length with this error */
1304                         if (!(t & EHCI_ISOC_BABBLE))
1305                                 desc->actual_length = EHCI_ITD_LENGTH (t);
1306                 } else if (likely ((t & EHCI_ISOC_ACTIVE) == 0)) {
1307                         desc->status = 0;
1308                         desc->actual_length = EHCI_ITD_LENGTH (t);
1309                 }
1310         }
1311
1312         usb_put_urb (urb);
1313         itd->urb = NULL;
1314         itd->stream = NULL;
1315         list_move (&itd->itd_list, &stream->free_list);
1316         iso_stream_put (ehci, stream);
1317
1318         /* handle completion now? */
1319         if (likely ((urb_index + 1) != urb->number_of_packets))
1320                 return 0;
1321
1322         /* ASSERT: it's really the last itd for this urb
1323         list_for_each_entry (itd, &stream->td_list, itd_list)
1324                 BUG_ON (itd->urb == urb);
1325          */
1326
1327         /* give urb back to the driver ... can be out-of-order */
1328         dev = usb_get_dev (urb->dev);
1329         ehci_urb_done (ehci, urb, regs);
1330         urb = NULL;
1331
1332         /* defer stopping schedule; completion can submit */
1333         ehci->periodic_sched--;
1334         if (unlikely (!ehci->periodic_sched))
1335                 (void) disable_periodic (ehci);
1336         hcd_to_bus (&ehci->hcd)->bandwidth_isoc_reqs--;
1337
1338         if (unlikely (list_empty (&stream->td_list))) {
1339                 hcd_to_bus (&ehci->hcd)->bandwidth_allocated
1340                                 -= stream->bandwidth;
1341                 ehci_vdbg (ehci,
1342                         "deschedule devp %s ep%d%s-iso\n",
1343                         dev->devpath, stream->bEndpointAddress & 0x0f,
1344                         (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out");
1345         }
1346         iso_stream_put (ehci, stream);
1347         usb_put_dev (dev);
1348
1349         return 1;
1350 }
1351
1352 /*-------------------------------------------------------------------------*/
1353
1354 static int itd_submit (struct ehci_hcd *ehci, struct urb *urb, int mem_flags)
1355 {
1356         int                     status = -EINVAL;
1357         unsigned long           flags;
1358         struct ehci_iso_stream  *stream;
1359
1360         /* Get iso_stream head */
1361         stream = iso_stream_find (ehci, urb);
1362         if (unlikely (stream == 0)) {
1363                 ehci_dbg (ehci, "can't get iso stream\n");
1364                 return -ENOMEM;
1365         }
1366         if (unlikely (urb->interval != stream->interval)) {
1367                 ehci_dbg (ehci, "can't change iso interval %d --> %d\n",
1368                         stream->interval, urb->interval);
1369                 goto done;
1370         }
1371
1372 #ifdef EHCI_URB_TRACE
1373         ehci_dbg (ehci,
1374                 "%s %s urb %p ep%d%s len %d, %d pkts %d uframes [%p]\n",
1375                 __FUNCTION__, urb->dev->devpath, urb,
1376                 usb_pipeendpoint (urb->pipe),
1377                 usb_pipein (urb->pipe) ? "in" : "out",
1378                 urb->transfer_buffer_length,
1379                 urb->number_of_packets, urb->interval,
1380                 stream);
1381 #endif
1382
1383         /* allocate ITDs w/o locking anything */
1384         status = itd_urb_transaction (stream, ehci, urb, mem_flags);
1385         if (unlikely (status < 0)) {
1386                 ehci_dbg (ehci, "can't init itds\n");
1387                 goto done;
1388         }
1389
1390         /* schedule ... need to lock */
1391         spin_lock_irqsave (&ehci->lock, flags);
1392         status = iso_stream_schedule (ehci, urb, stream);
1393         if (likely (status == 0))
1394                 itd_link_urb (ehci, urb, ehci->periodic_size << 3, stream);
1395         spin_unlock_irqrestore (&ehci->lock, flags);
1396
1397 done:
1398         if (unlikely (status < 0))
1399                 iso_stream_put (ehci, stream);
1400         return status;
1401 }
1402
1403 #ifdef CONFIG_USB_EHCI_SPLIT_ISO
1404
1405 /*-------------------------------------------------------------------------*/
1406
1407 /*
1408  * "Split ISO TDs" ... used for USB 1.1 devices going through the
1409  * TTs in USB 2.0 hubs.  These need microframe scheduling.
1410  */
1411
1412 static inline void
1413 sitd_sched_init (
1414         struct ehci_iso_sched   *iso_sched,
1415         struct ehci_iso_stream  *stream,
1416         struct urb              *urb
1417 )
1418 {
1419         unsigned        i;
1420         dma_addr_t      dma = urb->transfer_dma;
1421
1422         /* how many frames are needed for these transfers */
1423         iso_sched->span = urb->number_of_packets * stream->interval;
1424
1425         /* figure out per-frame sitd fields that we'll need later
1426          * when we fit new sitds into the schedule.
1427          */
1428         for (i = 0; i < urb->number_of_packets; i++) {
1429                 struct ehci_iso_packet  *packet = &iso_sched->packet [i];
1430                 unsigned                length;
1431                 dma_addr_t              buf;
1432                 u32                     trans;
1433
1434                 length = urb->iso_frame_desc [i].length & 0x03ff;
1435                 buf = dma + urb->iso_frame_desc [i].offset;
1436
1437                 trans = SITD_STS_ACTIVE;
1438                 if (((i + 1) == urb->number_of_packets)
1439                                 && !(urb->transfer_flags & URB_NO_INTERRUPT))
1440                         trans |= SITD_IOC;
1441                 trans |= length << 16;
1442                 packet->transaction = cpu_to_le32 (trans);
1443
1444                 /* might need to cross a buffer page within a td */
1445                 packet->bufp = buf;
1446                 buf += length;
1447                 packet->buf1 = buf & ~0x0fff;
1448                 if (packet->buf1 != (buf & ~(u64)0x0fff))
1449                         packet->cross = 1;
1450
1451                 /* OUT uses multiple start-splits */
1452                 if (stream->bEndpointAddress & USB_DIR_IN)
1453                         continue;
1454                 length = 1 + (length / 188);
1455                 packet->buf1 |= length;
1456                 if (length > 1) /* BEGIN vs ALL */
1457                         packet->buf1 |= 1 << 3;
1458         }
1459 }
1460
1461 static int
1462 sitd_urb_transaction (
1463         struct ehci_iso_stream  *stream,
1464         struct ehci_hcd         *ehci,
1465         struct urb              *urb,
1466         int                     mem_flags
1467 )
1468 {
1469         struct ehci_sitd        *sitd;
1470         dma_addr_t              sitd_dma;
1471         int                     i;
1472         struct ehci_iso_sched   *iso_sched;
1473         unsigned long           flags;
1474
1475         iso_sched = iso_sched_alloc (urb->number_of_packets, mem_flags);
1476         if (iso_sched == 0)
1477                 return -ENOMEM;
1478
1479         sitd_sched_init (iso_sched, stream, urb);
1480
1481         /* allocate/init sITDs */
1482         spin_lock_irqsave (&ehci->lock, flags);
1483         for (i = 0; i < urb->number_of_packets; i++) {
1484
1485                 /* NOTE:  for now, we don't try to handle wraparound cases
1486                  * for IN (using sitd->hw_backpointer, like a FSTN), which
1487                  * means we never need two sitds for full speed packets.
1488                  */
1489
1490                 /* free_list.next might be cache-hot ... but maybe
1491                  * the HC caches it too. avoid that issue for now.
1492                  */
1493
1494                 /* prefer previously-allocated sitds */
1495                 if (!list_empty(&stream->free_list)) {
1496                         sitd = list_entry (stream->free_list.prev,
1497                                          struct ehci_sitd, sitd_list);
1498                         list_del (&sitd->sitd_list);
1499                         sitd_dma = sitd->sitd_dma;
1500                 } else
1501                         sitd = NULL;
1502
1503                 if (!sitd) {
1504                         spin_unlock_irqrestore (&ehci->lock, flags);
1505                         sitd = dma_pool_alloc (ehci->sitd_pool, mem_flags,
1506                                         &sitd_dma);
1507                         spin_lock_irqsave (&ehci->lock, flags);
1508                 }
1509
1510                 if (!sitd) {
1511                         iso_sched_free (stream, iso_sched);
1512                         spin_unlock_irqrestore (&ehci->lock, flags);
1513                         return -ENOMEM;
1514                 }
1515                 memset (sitd, 0, sizeof *sitd);
1516                 sitd->sitd_dma = sitd_dma;
1517                 list_add (&sitd->sitd_list, &iso_sched->td_list);
1518         }
1519
1520         /* temporarily store schedule info in hcpriv */
1521         urb->hcpriv = iso_sched;
1522         urb->error_count = 0;
1523
1524         spin_unlock_irqrestore (&ehci->lock, flags);
1525         return 0;
1526 }
1527
1528 /*-------------------------------------------------------------------------*/
1529
1530 static inline void
1531 sitd_patch (
1532         struct ehci_iso_stream  *stream,
1533         struct ehci_sitd        *sitd,
1534         struct ehci_iso_sched   *iso_sched,
1535         unsigned                index
1536 )
1537 {
1538         struct ehci_iso_packet  *uf = &iso_sched->packet [index];
1539         u64                     bufp = uf->bufp;
1540
1541         sitd->hw_next = EHCI_LIST_END;
1542         sitd->hw_fullspeed_ep = stream->address;
1543         sitd->hw_uframe = stream->splits;
1544         sitd->hw_results = uf->transaction;
1545         sitd->hw_backpointer = EHCI_LIST_END;
1546
1547         bufp = uf->bufp;
1548         sitd->hw_buf [0] = cpu_to_le32 (bufp);
1549         sitd->hw_buf_hi [0] = cpu_to_le32 (bufp >> 32);
1550
1551         sitd->hw_buf [1] = cpu_to_le32 (uf->buf1);
1552         if (uf->cross) {
1553                 bufp += 4096;
1554                 sitd->hw_buf_hi [1] = cpu_to_le32 (bufp >> 32);
1555         }
1556         sitd->index = index;
1557 }
1558
1559 static inline void
1560 sitd_link (struct ehci_hcd *ehci, unsigned frame, struct ehci_sitd *sitd)
1561 {
1562         /* note: sitd ordering could matter (CSPLIT then SSPLIT) */
1563         sitd->sitd_next = ehci->pshadow [frame];
1564         sitd->hw_next = ehci->periodic [frame];
1565         ehci->pshadow [frame].sitd = sitd;
1566         sitd->frame = frame;
1567         wmb ();
1568         ehci->periodic [frame] = cpu_to_le32 (sitd->sitd_dma) | Q_TYPE_SITD;
1569 }
1570
1571 /* fit urb's sitds into the selected schedule slot; activate as needed */
1572 static int
1573 sitd_link_urb (
1574         struct ehci_hcd         *ehci,
1575         struct urb              *urb,
1576         unsigned                mod,
1577         struct ehci_iso_stream  *stream
1578 )
1579 {
1580         int                     packet;
1581         unsigned                next_uframe;
1582         struct ehci_iso_sched   *sched = urb->hcpriv;
1583         struct ehci_sitd        *sitd;
1584
1585         next_uframe = stream->next_uframe;
1586
1587         if (list_empty(&stream->td_list)) {
1588                 /* usbfs ignores TT bandwidth */
1589                 hcd_to_bus (&ehci->hcd)->bandwidth_allocated
1590                                 += stream->bandwidth;
1591                 ehci_vdbg (ehci,
1592                         "sched dev%s ep%d%s-iso [%d] %dms/%04x\n",
1593                         urb->dev->devpath, stream->bEndpointAddress & 0x0f,
1594                         (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
1595                         (next_uframe >> 3) % ehci->periodic_size,
1596                         stream->interval, le32_to_cpu (stream->splits));
1597                 stream->start = jiffies;
1598         }
1599         hcd_to_bus (&ehci->hcd)->bandwidth_isoc_reqs++;
1600
1601         /* fill sITDs frame by frame */
1602         for (packet = 0, sitd = NULL;
1603                         packet < urb->number_of_packets;
1604                         packet++) {
1605
1606                 /* ASSERT:  we have all necessary sitds */
1607                 BUG_ON (list_empty (&sched->td_list));
1608
1609                 /* ASSERT:  no itds for this endpoint in this frame */
1610
1611                 sitd = list_entry (sched->td_list.next,
1612                                 struct ehci_sitd, sitd_list);
1613                 list_move_tail (&sitd->sitd_list, &stream->td_list);
1614                 sitd->stream = iso_stream_get (stream);
1615                 sitd->urb = usb_get_urb (urb);
1616
1617                 sitd_patch (stream, sitd, sched, packet);
1618                 sitd_link (ehci, (next_uframe >> 3) % ehci->periodic_size,
1619                                 sitd);
1620
1621                 next_uframe += stream->interval << 3;
1622                 stream->depth += stream->interval << 3;
1623         }
1624         stream->next_uframe = next_uframe % mod;
1625
1626         /* don't need that schedule data any more */
1627         iso_sched_free (stream, sched);
1628         urb->hcpriv = NULL;
1629
1630         timer_action (ehci, TIMER_IO_WATCHDOG);
1631         if (!ehci->periodic_sched++)
1632                 return enable_periodic (ehci);
1633         return 0;
1634 }
1635
1636 /*-------------------------------------------------------------------------*/
1637
1638 #define SITD_ERRS (SITD_STS_ERR | SITD_STS_DBE | SITD_STS_BABBLE \
1639                         | SITD_STS_XACT | SITD_STS_MMF | SITD_STS_STS)
1640
1641 static unsigned
1642 sitd_complete (
1643         struct ehci_hcd         *ehci,
1644         struct ehci_sitd        *sitd,
1645         struct pt_regs          *regs
1646 ) {
1647         struct urb                              *urb = sitd->urb;
1648         struct usb_iso_packet_descriptor        *desc;
1649         u32                                     t;
1650         int                                     urb_index = -1;
1651         struct ehci_iso_stream                  *stream = sitd->stream;
1652         struct usb_device                       *dev;
1653
1654         urb_index = sitd->index;
1655         desc = &urb->iso_frame_desc [urb_index];
1656         t = le32_to_cpup (&sitd->hw_results);
1657
1658         /* report transfer status */
1659         if (t & SITD_ERRS) {
1660                 urb->error_count++;
1661                 if (t & SITD_STS_DBE)
1662                         desc->status = usb_pipein (urb->pipe)
1663                                 ? -ENOSR  /* hc couldn't read */
1664                                 : -ECOMM; /* hc couldn't write */
1665                 else if (t & SITD_STS_BABBLE)
1666                         desc->status = -EOVERFLOW;
1667                 else /* XACT, MMF, etc */
1668                         desc->status = -EPROTO;
1669         } else {
1670                 desc->status = 0;
1671                 desc->actual_length = desc->length - SITD_LENGTH (t);
1672         }
1673
1674         usb_put_urb (urb);
1675         sitd->urb = NULL;
1676         sitd->stream = NULL;
1677         list_move (&sitd->sitd_list, &stream->free_list);
1678         stream->depth -= stream->interval << 3;
1679         iso_stream_put (ehci, stream);
1680
1681         /* handle completion now? */
1682         if ((urb_index + 1) != urb->number_of_packets)
1683                 return 0;
1684
1685         /* ASSERT: it's really the last sitd for this urb
1686         list_for_each_entry (sitd, &stream->td_list, sitd_list)
1687                 BUG_ON (sitd->urb == urb);
1688          */
1689
1690         /* give urb back to the driver */
1691         dev = usb_get_dev (urb->dev);
1692         ehci_urb_done (ehci, urb, regs);
1693         urb = NULL;
1694
1695         /* defer stopping schedule; completion can submit */
1696         ehci->periodic_sched--;
1697         if (!ehci->periodic_sched)
1698                 (void) disable_periodic (ehci);
1699         hcd_to_bus (&ehci->hcd)->bandwidth_isoc_reqs--;
1700
1701         if (list_empty (&stream->td_list)) {
1702                 hcd_to_bus (&ehci->hcd)->bandwidth_allocated
1703                                 -= stream->bandwidth;
1704                 ehci_vdbg (ehci,
1705                         "deschedule devp %s ep%d%s-iso\n",
1706                         dev->devpath, stream->bEndpointAddress & 0x0f,
1707                         (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out");
1708         }
1709         iso_stream_put (ehci, stream);
1710         usb_put_dev (dev);
1711
1712         return 1;
1713 }
1714
1715
1716 static int sitd_submit (struct ehci_hcd *ehci, struct urb *urb, int mem_flags)
1717 {
1718         int                     status = -EINVAL;
1719         unsigned long           flags;
1720         struct ehci_iso_stream  *stream;
1721
1722         // FIXME remove when csplits behave
1723         if (usb_pipein(urb->pipe)) {
1724                 ehci_dbg (ehci, "no iso-IN split transactions yet\n");
1725                 return -ENOMEM;
1726         }
1727
1728         /* Get iso_stream head */
1729         stream = iso_stream_find (ehci, urb);
1730         if (stream == 0) {
1731                 ehci_dbg (ehci, "can't get iso stream\n");
1732                 return -ENOMEM;
1733         }
1734         if (urb->interval != stream->interval) {
1735                 ehci_dbg (ehci, "can't change iso interval %d --> %d\n",
1736                         stream->interval, urb->interval);
1737                 goto done;
1738         }
1739
1740 #ifdef EHCI_URB_TRACE
1741         ehci_dbg (ehci,
1742                 "submit %p dev%s ep%d%s-iso len %d\n",
1743                 urb, urb->dev->devpath,
1744                 usb_pipeendpoint (urb->pipe),
1745                 usb_pipein (urb->pipe) ? "in" : "out",
1746                 urb->transfer_buffer_length);
1747 #endif
1748
1749         /* allocate SITDs */
1750         status = sitd_urb_transaction (stream, ehci, urb, mem_flags);
1751         if (status < 0) {
1752                 ehci_dbg (ehci, "can't init sitds\n");
1753                 goto done;
1754         }
1755
1756         /* schedule ... need to lock */
1757         spin_lock_irqsave (&ehci->lock, flags);
1758         status = iso_stream_schedule (ehci, urb, stream);
1759         if (status == 0)
1760                 sitd_link_urb (ehci, urb, ehci->periodic_size << 3, stream);
1761         spin_unlock_irqrestore (&ehci->lock, flags);
1762
1763 done:
1764         if (status < 0)
1765                 iso_stream_put (ehci, stream);
1766         return status;
1767 }
1768
1769 #else
1770
1771 static inline int
1772 sitd_submit (struct ehci_hcd *ehci, struct urb *urb, int mem_flags)
1773 {
1774         ehci_dbg (ehci, "split iso support is disabled\n");
1775         return -ENOSYS;
1776 }
1777
1778 static inline unsigned
1779 sitd_complete (
1780         struct ehci_hcd         *ehci,
1781         struct ehci_sitd        *sitd,
1782         struct pt_regs          *regs
1783 ) {
1784         ehci_err (ehci, "sitd_complete %p?\n", sitd);
1785         return 0;
1786 }
1787
1788 #endif /* USB_EHCI_SPLIT_ISO */
1789
1790 /*-------------------------------------------------------------------------*/
1791
1792 static void
1793 scan_periodic (struct ehci_hcd *ehci, struct pt_regs *regs)
1794 {
1795         unsigned        frame, clock, now_uframe, mod;
1796         unsigned        modified;
1797
1798         mod = ehci->periodic_size << 3;
1799
1800         /*
1801          * When running, scan from last scan point up to "now"
1802          * else clean up by scanning everything that's left.
1803          * Touches as few pages as possible:  cache-friendly.
1804          */
1805         now_uframe = ehci->next_uframe;
1806         if (HCD_IS_RUNNING (ehci->hcd.state))
1807                 clock = readl (&ehci->regs->frame_index);
1808         else
1809                 clock = now_uframe + mod - 1;
1810         clock %= mod;
1811
1812         for (;;) {
1813                 union ehci_shadow       q, *q_p;
1814                 __le32                  type, *hw_p;
1815                 unsigned                uframes;
1816
1817                 /* don't scan past the live uframe */
1818                 frame = now_uframe >> 3;
1819                 if (frame == (clock >> 3))
1820                         uframes = now_uframe & 0x07;
1821                 else {
1822                         /* safe to scan the whole frame at once */
1823                         now_uframe |= 0x07;
1824                         uframes = 8;
1825                 }
1826
1827 restart:
1828                 /* scan each element in frame's queue for completions */
1829                 q_p = &ehci->pshadow [frame];
1830                 hw_p = &ehci->periodic [frame];
1831                 q.ptr = q_p->ptr;
1832                 type = Q_NEXT_TYPE (*hw_p);
1833                 modified = 0;
1834
1835                 while (q.ptr != 0) {
1836                         unsigned                uf;
1837                         union ehci_shadow       temp;
1838
1839                         switch (type) {
1840                         case Q_TYPE_QH:
1841                                 /* handle any completions */
1842                                 temp.qh = qh_get (q.qh);
1843                                 type = Q_NEXT_TYPE (q.qh->hw_next);
1844                                 q = q.qh->qh_next;
1845                                 modified = qh_completions (ehci, temp.qh, regs);
1846                                 if (unlikely (list_empty (&temp.qh->qtd_list)))
1847                                         intr_deschedule (ehci, temp.qh, 0);
1848                                 qh_put (temp.qh);
1849                                 break;
1850                         case Q_TYPE_FSTN:
1851                                 /* for "save place" FSTNs, look at QH entries
1852                                  * in the previous frame for completions.
1853                                  */
1854                                 if (q.fstn->hw_prev != EHCI_LIST_END) {
1855                                         dbg ("ignoring completions from FSTNs");
1856                                 }
1857                                 type = Q_NEXT_TYPE (q.fstn->hw_next);
1858                                 q = q.fstn->fstn_next;
1859                                 break;
1860                         case Q_TYPE_ITD:
1861                                 /* skip itds for later in the frame */
1862                                 rmb ();
1863                                 for (uf = uframes; uf < 8; uf++) {
1864                                         if (0 == (q.itd->hw_transaction [uf]
1865                                                         & ITD_ACTIVE))
1866                                                 continue;
1867                                         q_p = &q.itd->itd_next;
1868                                         hw_p = &q.itd->hw_next;
1869                                         type = Q_NEXT_TYPE (q.itd->hw_next);
1870                                         q = *q_p;
1871                                         break;
1872                                 }
1873                                 if (uf != 8)
1874                                         break;
1875
1876                                 /* this one's ready ... HC won't cache the
1877                                  * pointer for much longer, if at all.
1878                                  */
1879                                 *q_p = q.itd->itd_next;
1880                                 *hw_p = q.itd->hw_next;
1881                                 type = Q_NEXT_TYPE (q.itd->hw_next);
1882                                 wmb();
1883                                 modified = itd_complete (ehci, q.itd, regs);
1884                                 q = *q_p;
1885                                 break;
1886                         case Q_TYPE_SITD:
1887                                 if (q.sitd->hw_results & SITD_ACTIVE) {
1888                                         q_p = &q.sitd->sitd_next;
1889                                         hw_p = &q.sitd->hw_next;
1890                                         type = Q_NEXT_TYPE (q.sitd->hw_next);
1891                                         q = *q_p;
1892                                         break;
1893                                 }
1894                                 *q_p = q.sitd->sitd_next;
1895                                 *hw_p = q.sitd->hw_next;
1896                                 type = Q_NEXT_TYPE (q.sitd->hw_next);
1897                                 wmb();
1898                                 modified = sitd_complete (ehci, q.sitd, regs);
1899                                 q = *q_p;
1900                                 break;
1901                         default:
1902                                 dbg ("corrupt type %d frame %d shadow %p",
1903                                         type, frame, q.ptr);
1904                                 // BUG ();
1905                                 q.ptr = NULL;
1906                         }
1907
1908                         /* assume completion callbacks modify the queue */
1909                         if (unlikely (modified))
1910                                 goto restart;
1911                 }
1912
1913                 /* stop when we catch up to the HC */
1914
1915                 // FIXME:  this assumes we won't get lapped when
1916                 // latencies climb; that should be rare, but...
1917                 // detect it, and just go all the way around.
1918                 // FLR might help detect this case, so long as latencies
1919                 // don't exceed periodic_size msec (default 1.024 sec).
1920
1921                 // FIXME:  likewise assumes HC doesn't halt mid-scan
1922
1923                 if (now_uframe == clock) {
1924                         unsigned        now;
1925
1926                         if (!HCD_IS_RUNNING (ehci->hcd.state))
1927                                 break;
1928                         ehci->next_uframe = now_uframe;
1929                         now = readl (&ehci->regs->frame_index) % mod;
1930                         if (now_uframe == now)
1931                                 break;
1932
1933                         /* rescan the rest of this frame, then ... */
1934                         clock = now;
1935                 } else {
1936                         now_uframe++;
1937                         now_uframe %= mod;
1938                 }
1939         }
1940 }