drivers/usb/host/xhci-ring.c

   1 /*
   2  * xHCI host controller driver
   3  *
   4  * Copyright (C) 2008 Intel Corp.
   5  *
   6  * Author: Sarah Sharp
   7  * Some code borrowed from the Linux EHCI driver.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 /*
  24  * Ring initialization rules:
  25  * 1. Each segment is initialized to zero, except for link TRBs.
  26  * 2. Ring cycle state = 0.  This represents Producer Cycle State (PCS) or
  27  *    Consumer Cycle State (CCS), depending on ring function.
  28  * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
  29  *
  30  * Ring behavior rules:
  31  * 1. A ring is empty if enqueue == dequeue.  This means there will always be at
  32  *    least one free TRB in the ring.  This is useful if you want to turn that
  33  *    into a link TRB and expand the ring.
  34  * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
  35  *    link TRB, then load the pointer with the address in the link TRB.  If the
  36  *    link TRB had its toggle bit set, you may need to update the ring cycle
  37  *    state (see cycle bit rules).  You may have to do this multiple times
  38  *    until you reach a non-link TRB.
  39  * 3. A ring is full if enqueue++ (for the definition of increment above)
  40  *    equals the dequeue pointer.
  41  *
  42  * Cycle bit rules:
  43  * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
  44  *    in a link TRB, it must toggle the ring cycle state.
  45  * 2. When a producer increments an enqueue pointer and encounters a toggle bit
  46  *    in a link TRB, it must toggle the ring cycle state.
  47  *
  48  * Producer rules:
  49  * 1. Check if ring is full before you enqueue.
  50  * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
  51  *    Update enqueue pointer between each write (which may update the ring
  52  *    cycle state).
  53  * 3. Notify consumer.  If SW is producer, it rings the doorbell for command
  54  *    and endpoint rings.  If HC is the producer for the event ring,
  55  *    and it generates an interrupt according to interrupt modulation rules.
  56  *
  57  * Consumer rules:
  58  * 1. Check if TRB belongs to you.  If the cycle bit == your ring cycle state,
  59  *    the TRB is owned by the consumer.
  60  * 2. Update dequeue pointer (which may update the ring cycle state) and
  61  *    continue processing TRBs until you reach a TRB which is not owned by you.
  62  * 3. Notify the producer.  SW is the consumer for the event ring, and it
  63  *   updates event ring dequeue pointer.  HC is the consumer for the command and
  64  *   endpoint rings; it generates events on the event ring for these.
  65  */
  66
  67 #include <linux/scatterlist.h>
  68 #include "xhci.h"
  69
  70 /*
  71  * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
  72  * address of the TRB.
  73  */
  74 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
  75                 union xhci_trb *trb)
  76 {
  77         unsigned long segment_offset;
  78
  79         if (!seg || !trb || trb < seg->trbs)
  80                 return 0;
  81         /* offset in TRBs */
  82         segment_offset = trb - seg->trbs;
  83         if (segment_offset > TRBS_PER_SEGMENT)
  84                 return 0;
  85         return seg->dma + (segment_offset * sizeof(*trb));
  86 }
  87
  88 /* Does this link TRB point to the first segment in a ring,
  89  * or was the previous TRB the last TRB on the last segment in the ERST?
  90  */
  91 static inline bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
  92                 struct xhci_segment *seg, union xhci_trb *trb)
  93 {
  94         if (ring == xhci->event_ring)
  95                 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
  96                         (seg->next == xhci->event_ring->first_seg);
  97         else
  98                 return trb->link.control & LINK_TOGGLE;
  99 }
 100
 101 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
 102  * segment?  I.e. would the updated event TRB pointer step off the end of the
 103  * event seg?
 104  */
 105 static inline int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
 106                 struct xhci_segment *seg, union xhci_trb *trb)
 107 {
 108         if (ring == xhci->event_ring)
 109                 return trb == &seg->trbs[TRBS_PER_SEGMENT];
 110         else
 111                 return (trb->link.control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK);
 112 }
 113
 114 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
 115  * TRB is in a new segment.  This does not skip over link TRBs, and it does not
 116  * effect the ring dequeue or enqueue pointers.
 117  */
 118 static void next_trb(struct xhci_hcd *xhci,
 119                 struct xhci_ring *ring,
 120                 struct xhci_segment **seg,
 121                 union xhci_trb **trb)
 122 {
 123         if (last_trb(xhci, ring, *seg, *trb)) {
 124                 *seg = (*seg)->next;
 125                 *trb = ((*seg)->trbs);
 126         } else {
 127                 *trb = (*trb)++;
 128         }
 129 }
 130
 131 /*
 132  * See Cycle bit rules. SW is the consumer for the event ring only.
 133  * Don't make a ring full of link TRBs.  That would be dumb and this would loop.
 134  */
 135 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
 136 {
 137         union xhci_trb *next = ++(ring->dequeue);
 138         unsigned long long addr;
 139
 140         ring->deq_updates++;
 141         /* Update the dequeue pointer further if that was a link TRB or we're at
 142          * the end of an event ring segment (which doesn't have link TRBS)
 143          */
 144         while (last_trb(xhci, ring, ring->deq_seg, next)) {
 145                 if (consumer && last_trb_on_last_seg(xhci, ring, ring->deq_seg, next)) {
 146                         ring->cycle_state = (ring->cycle_state ? 0 : 1);
 147                         if (!in_interrupt())
 148                                 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
 149                                                 ring,
 150                                                 (unsigned int) ring->cycle_state);
 151                 }
 152                 ring->deq_seg = ring->deq_seg->next;
 153                 ring->dequeue = ring->deq_seg->trbs;
 154                 next = ring->dequeue;
 155         }
 156         addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
 157         if (ring == xhci->event_ring)
 158                 xhci_dbg(xhci, "Event ring deq = 0x%llx (DMA)\n", addr);
 159         else if (ring == xhci->cmd_ring)
 160                 xhci_dbg(xhci, "Command ring deq = 0x%llx (DMA)\n", addr);
 161         else
 162                 xhci_dbg(xhci, "Ring deq = 0x%llx (DMA)\n", addr);
 163 }
 164
 165 /*
 166  * See Cycle bit rules. SW is the consumer for the event ring only.
 167  * Don't make a ring full of link TRBs.  That would be dumb and this would loop.
 168  *
 169  * If we've just enqueued a TRB that is in the middle of a TD (meaning the
 170  * chain bit is set), then set the chain bit in all the following link TRBs.
 171  * If we've enqueued the last TRB in a TD, make sure the following link TRBs
 172  * have their chain bit cleared (so that each Link TRB is a separate TD).
 173  *
 174  * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
 175  * set, but other sections talk about dealing with the chain bit set.  This was
 176  * fixed in the 0.96 specification errata, but we have to assume that all 0.95
 177  * xHCI hardware can't handle the chain bit being cleared on a link TRB.
 178  */
 179 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
 180 {
 181         u32 chain;
 182         union xhci_trb *next;
 183         unsigned long long addr;
 184
 185         chain = ring->enqueue->generic.field[3] & TRB_CHAIN;
 186         next = ++(ring->enqueue);
 187
 188         ring->enq_updates++;
 189         /* Update the dequeue pointer further if that was a link TRB or we're at
 190          * the end of an event ring segment (which doesn't have link TRBS)
 191          */
 192         while (last_trb(xhci, ring, ring->enq_seg, next)) {
 193                 if (!consumer) {
 194                         if (ring != xhci->event_ring) {
 195                                 /* If we're not dealing with 0.95 hardware,
 196                                  * carry over the chain bit of the previous TRB
 197                                  * (which may mean the chain bit is cleared).
 198                                  */
 199                                 if (!xhci_link_trb_quirk(xhci)) {
 200                                         next->link.control &= ~TRB_CHAIN;
 201                                         next->link.control |= chain;
 202                                 }
 203                                 /* Give this link TRB to the hardware */
 204                                 wmb();
 205                                 if (next->link.control & TRB_CYCLE)
 206                                         next->link.control &= (u32) ~TRB_CYCLE;
 207                                 else
 208                                         next->link.control |= (u32) TRB_CYCLE;
 209                         }
 210                         /* Toggle the cycle bit after the last ring segment. */
 211                         if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
 212                                 ring->cycle_state = (ring->cycle_state ? 0 : 1);
 213                                 if (!in_interrupt())
 214                                         xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
 215                                                         ring,
 216                                                         (unsigned int) ring->cycle_state);
 217                         }
 218                 }
 219                 ring->enq_seg = ring->enq_seg->next;
 220                 ring->enqueue = ring->enq_seg->trbs;
 221                 next = ring->enqueue;
 222         }
 223         addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
 224         if (ring == xhci->event_ring)
 225                 xhci_dbg(xhci, "Event ring enq = 0x%llx (DMA)\n", addr);
 226         else if (ring == xhci->cmd_ring)
 227                 xhci_dbg(xhci, "Command ring enq = 0x%llx (DMA)\n", addr);
 228         else
 229                 xhci_dbg(xhci, "Ring enq = 0x%llx (DMA)\n", addr);
 230 }
 231
 232 /*
 233  * Check to see if there's room to enqueue num_trbs on the ring.  See rules
 234  * above.
 235  * FIXME: this would be simpler and faster if we just kept track of the number
 236  * of free TRBs in a ring.
 237  */
 238 static int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
 239                 unsigned int num_trbs)
 240 {
 241         int i;
 242         union xhci_trb *enq = ring->enqueue;
 243         struct xhci_segment *enq_seg = ring->enq_seg;
 244
 245         /* Check if ring is empty */
 246         if (enq == ring->dequeue)
 247                 return 1;
 248         /* Make sure there's an extra empty TRB available */
 249         for (i = 0; i <= num_trbs; ++i) {
 250                 if (enq == ring->dequeue)
 251                         return 0;
 252                 enq++;
 253                 while (last_trb(xhci, ring, enq_seg, enq)) {
 254                         enq_seg = enq_seg->next;
 255                         enq = enq_seg->trbs;
 256                 }
 257         }
 258         return 1;
 259 }
 260
 261 void xhci_set_hc_event_deq(struct xhci_hcd *xhci)
 262 {
 263         u64 temp;
 264         dma_addr_t deq;
 265
 266         deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
 267                         xhci->event_ring->dequeue);
 268         if (deq == 0 && !in_interrupt())
 269                 xhci_warn(xhci, "WARN something wrong with SW event ring "
 270                                 "dequeue ptr.\n");
 271         /* Update HC event ring dequeue pointer */
 272         temp = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
 273         temp &= ERST_PTR_MASK;
 274         /* Don't clear the EHB bit (which is RW1C) because
 275          * there might be more events to service.
 276          */
 277         temp &= ~ERST_EHB;
 278         xhci_dbg(xhci, "// Write event ring dequeue pointer, preserving EHB bit\n");
 279         xhci_write_64(xhci, ((u64) deq & (u64) ~ERST_PTR_MASK) | temp,
 280                         &xhci->ir_set->erst_dequeue);
 281 }
 282
 283 /* Ring the host controller doorbell after placing a command on the ring */
 284 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
 285 {
 286         u32 temp;
 287
 288         xhci_dbg(xhci, "// Ding dong!\n");
 289         temp = xhci_readl(xhci, &xhci->dba->doorbell[0]) & DB_MASK;
 290         xhci_writel(xhci, temp | DB_TARGET_HOST, &xhci->dba->doorbell[0]);
 291         /* Flush PCI posted writes */
 292         xhci_readl(xhci, &xhci->dba->doorbell[0]);
 293 }
 294
 295 static void ring_ep_doorbell(struct xhci_hcd *xhci,
 296                 unsigned int slot_id,
 297                 unsigned int ep_index)
 298 {
 299         struct xhci_virt_ep *ep;
 300         unsigned int ep_state;
 301         u32 field;
 302         __u32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
 303
 304         ep = &xhci->devs[slot_id]->eps[ep_index];
 305         ep_state = ep->ep_state;
 306         /* Don't ring the doorbell for this endpoint if there are pending
 307          * cancellations because the we don't want to interrupt processing.
 308          */
 309         if (!ep->cancels_pending && !(ep_state & SET_DEQ_PENDING)
 310                         && !(ep_state & EP_HALTED)) {
 311                 field = xhci_readl(xhci, db_addr) & DB_MASK;
 312                 xhci_writel(xhci, field | EPI_TO_DB(ep_index), db_addr);
 313                 /* Flush PCI posted writes - FIXME Matthew Wilcox says this
 314                  * isn't time-critical and we shouldn't make the CPU wait for
 315                  * the flush.
 316                  */
 317                 xhci_readl(xhci, db_addr);
 318         }
 319 }
 320
 321 /*
 322  * Find the segment that trb is in.  Start searching in start_seg.
 323  * If we must move past a segment that has a link TRB with a toggle cycle state
 324  * bit set, then we will toggle the value pointed at by cycle_state.
 325  */
 326 static struct xhci_segment *find_trb_seg(
 327                 struct xhci_segment *start_seg,
 328                 union xhci_trb  *trb, int *cycle_state)
 329 {
 330         struct xhci_segment *cur_seg = start_seg;
 331         struct xhci_generic_trb *generic_trb;
 332
 333         while (cur_seg->trbs > trb ||
 334                         &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
 335                 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
 336                 if (TRB_TYPE(generic_trb->field[3]) == TRB_LINK &&
 337                                 (generic_trb->field[3] & LINK_TOGGLE))
 338                         *cycle_state = ~(*cycle_state) & 0x1;
 339                 cur_seg = cur_seg->next;
 340                 if (cur_seg == start_seg)
 341                         /* Looped over the entire list.  Oops! */
 342                         return 0;
 343         }
 344         return cur_seg;
 345 }
 346
 347 /*
 348  * Move the xHC's endpoint ring dequeue pointer past cur_td.
 349  * Record the new state of the xHC's endpoint ring dequeue segment,
 350  * dequeue pointer, and new consumer cycle state in state.
 351  * Update our internal representation of the ring's dequeue pointer.
 352  *
 353  * We do this in three jumps:
 354  *  - First we update our new ring state to be the same as when the xHC stopped.
 355  *  - Then we traverse the ring to find the segment that contains
 356  *    the last TRB in the TD.  We toggle the xHC's new cycle state when we pass
 357  *    any link TRBs with the toggle cycle bit set.
 358  *  - Finally we move the dequeue state one TRB further, toggling the cycle bit
 359  *    if we've moved it past a link TRB with the toggle cycle bit set.
 360  */
 361 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
 362                 unsigned int slot_id, unsigned int ep_index,
 363                 struct xhci_td *cur_td, struct xhci_dequeue_state *state)
 364 {
 365         struct xhci_virt_device *dev = xhci->devs[slot_id];
 366         struct xhci_ring *ep_ring = dev->eps[ep_index].ring;
 367         struct xhci_generic_trb *trb;
 368         struct xhci_ep_ctx *ep_ctx;
 369         dma_addr_t addr;
 370
 371         state->new_cycle_state = 0;
 372         xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
 373         state->new_deq_seg = find_trb_seg(cur_td->start_seg,
 374                         dev->eps[ep_index].stopped_trb,
 375                         &state->new_cycle_state);
 376         if (!state->new_deq_seg)
 377                 BUG();
 378         /* Dig out the cycle state saved by the xHC during the stop ep cmd */
 379         xhci_dbg(xhci, "Finding endpoint context\n");
 380         ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
 381         state->new_cycle_state = 0x1 & ep_ctx->deq;
 382
 383         state->new_deq_ptr = cur_td->last_trb;
 384         xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
 385         state->new_deq_seg = find_trb_seg(state->new_deq_seg,
 386                         state->new_deq_ptr,
 387                         &state->new_cycle_state);
 388         if (!state->new_deq_seg)
 389                 BUG();
 390
 391         trb = &state->new_deq_ptr->generic;
 392         if (TRB_TYPE(trb->field[3]) == TRB_LINK &&
 393                                 (trb->field[3] & LINK_TOGGLE))
 394                 state->new_cycle_state = ~(state->new_cycle_state) & 0x1;
 395         next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
 396
 397         /* Don't update the ring cycle state for the producer (us). */
 398         xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
 399                         state->new_deq_seg);
 400         addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
 401         xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
 402                         (unsigned long long) addr);
 403         xhci_dbg(xhci, "Setting dequeue pointer in internal ring state.\n");
 404         ep_ring->dequeue = state->new_deq_ptr;
 405         ep_ring->deq_seg = state->new_deq_seg;
 406 }
 407
 408 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
 409                 struct xhci_td *cur_td)
 410 {
 411         struct xhci_segment *cur_seg;
 412         union xhci_trb *cur_trb;
 413
 414         for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
 415                         true;
 416                         next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
 417                 if ((cur_trb->generic.field[3] & TRB_TYPE_BITMASK) ==
 418                                 TRB_TYPE(TRB_LINK)) {
 419                         /* Unchain any chained Link TRBs, but
 420                          * leave the pointers intact.
 421                          */
 422                         cur_trb->generic.field[3] &= ~TRB_CHAIN;
 423                         xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
 424                         xhci_dbg(xhci, "Address = %p (0x%llx dma); "
 425                                         "in seg %p (0x%llx dma)\n",
 426                                         cur_trb,
 427                                         (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
 428                                         cur_seg,
 429                                         (unsigned long long)cur_seg->dma);
 430                 } else {
 431                         cur_trb->generic.field[0] = 0;
 432                         cur_trb->generic.field[1] = 0;
 433                         cur_trb->generic.field[2] = 0;
 434                         /* Preserve only the cycle bit of this TRB */
 435                         cur_trb->generic.field[3] &= TRB_CYCLE;
 436                         cur_trb->generic.field[3] |= TRB_TYPE(TRB_TR_NOOP);
 437                         xhci_dbg(xhci, "Cancel TRB %p (0x%llx dma) "
 438                                         "in seg %p (0x%llx dma)\n",
 439                                         cur_trb,
 440                                         (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
 441                                         cur_seg,
 442                                         (unsigned long long)cur_seg->dma);
 443                 }
 444                 if (cur_trb == cur_td->last_trb)
 445                         break;
 446         }
 447 }
 448
 449 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
 450                 unsigned int ep_index, struct xhci_segment *deq_seg,
 451                 union xhci_trb *deq_ptr, u32 cycle_state);
 452
 453 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
 454                 unsigned int slot_id, unsigned int ep_index,
 455                 struct xhci_dequeue_state *deq_state)
 456 {
 457         struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
 458
 459         xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
 460                         "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
 461                         deq_state->new_deq_seg,
 462                         (unsigned long long)deq_state->new_deq_seg->dma,
 463                         deq_state->new_deq_ptr,
 464                         (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
 465                         deq_state->new_cycle_state);
 466         queue_set_tr_deq(xhci, slot_id, ep_index,
 467                         deq_state->new_deq_seg,
 468                         deq_state->new_deq_ptr,
 469                         (u32) deq_state->new_cycle_state);
 470         /* Stop the TD queueing code from ringing the doorbell until
 471          * this command completes.  The HC won't set the dequeue pointer
 472          * if the ring is running, and ringing the doorbell starts the
 473          * ring running.
 474          */
 475         ep->ep_state |= SET_DEQ_PENDING;
 476 }
 477
 478 /*
 479  * When we get a command completion for a Stop Endpoint Command, we need to
 480  * unlink any cancelled TDs from the ring.  There are two ways to do that:
 481  *
 482  *  1. If the HW was in the middle of processing the TD that needs to be
 483  *     cancelled, then we must move the ring's dequeue pointer past the last TRB
 484  *     in the TD with a Set Dequeue Pointer Command.
 485  *  2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
 486  *     bit cleared) so that the HW will skip over them.
 487  */
 488 static void handle_stopped_endpoint(struct xhci_hcd *xhci,
 489                 union xhci_trb *trb)
 490 {
 491         unsigned int slot_id;
 492         unsigned int ep_index;
 493         struct xhci_ring *ep_ring;
 494         struct xhci_virt_ep *ep;
 495         struct list_head *entry;
 496         struct xhci_td *cur_td = 0;
 497         struct xhci_td *last_unlinked_td;
 498
 499         struct xhci_dequeue_state deq_state;
 500 #ifdef CONFIG_USB_HCD_STAT
 501         ktime_t stop_time = ktime_get();
 502 #endif
 503
 504         memset(&deq_state, 0, sizeof(deq_state));
 505         slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
 506         ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
 507         ep = &xhci->devs[slot_id]->eps[ep_index];
 508         ep_ring = ep->ring;
 509
 510         if (list_empty(&ep->cancelled_td_list))
 511                 return;
 512
 513         /* Fix up the ep ring first, so HW stops executing cancelled TDs.
 514          * We have the xHCI lock, so nothing can modify this list until we drop
 515          * it.  We're also in the event handler, so we can't get re-interrupted
 516          * if another Stop Endpoint command completes
 517          */
 518         list_for_each(entry, &ep->cancelled_td_list) {
 519                 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
 520                 xhci_dbg(xhci, "Cancelling TD starting at %p, 0x%llx (dma).\n",
 521                                 cur_td->first_trb,
 522                                 (unsigned long long)xhci_trb_virt_to_dma(cur_td->start_seg, cur_td->first_trb));
 523                 /*
 524                  * If we stopped on the TD we need to cancel, then we have to
 525                  * move the xHC endpoint ring dequeue pointer past this TD.
 526                  */
 527                 if (cur_td == ep->stopped_td)
 528                         xhci_find_new_dequeue_state(xhci, slot_id, ep_index, cur_td,
 529                                         &deq_state);
 530                 else
 531                         td_to_noop(xhci, ep_ring, cur_td);
 532                 /*
 533                  * The event handler won't see a completion for this TD anymore,
 534                  * so remove it from the endpoint ring's TD list.  Keep it in
 535                  * the cancelled TD list for URB completion later.
 536                  */
 537                 list_del(&cur_td->td_list);
 538                 ep->cancels_pending--;
 539         }
 540         last_unlinked_td = cur_td;
 541
 542         /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
 543         if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
 544                 xhci_queue_new_dequeue_state(xhci,
 545                                 slot_id, ep_index, &deq_state);
 546                 xhci_ring_cmd_db(xhci);
 547         } else {
 548                 /* Otherwise just ring the doorbell to restart the ring */
 549                 ring_ep_doorbell(xhci, slot_id, ep_index);
 550         }
 551
 552         /*
 553          * Drop the lock and complete the URBs in the cancelled TD list.
 554          * New TDs to be cancelled might be added to the end of the list before
 555          * we can complete all the URBs for the TDs we already unlinked.
 556          * So stop when we've completed the URB for the last TD we unlinked.
 557          */
 558         do {
 559                 cur_td = list_entry(ep->cancelled_td_list.next,
 560                                 struct xhci_td, cancelled_td_list);
 561                 list_del(&cur_td->cancelled_td_list);
 562
 563                 /* Clean up the cancelled URB */
 564 #ifdef CONFIG_USB_HCD_STAT
 565                 hcd_stat_update(xhci->tp_stat, cur_td->urb->actual_length,
 566                                 ktime_sub(stop_time, cur_td->start_time));
 567 #endif
 568                 cur_td->urb->hcpriv = NULL;
 569                 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), cur_td->urb);
 570
 571                 xhci_dbg(xhci, "Giveback cancelled URB %p\n", cur_td->urb);
 572                 spin_unlock(&xhci->lock);
 573                 /* Doesn't matter what we pass for status, since the core will
 574                  * just overwrite it (because the URB has been unlinked).
 575                  */
 576                 usb_hcd_giveback_urb(xhci_to_hcd(xhci), cur_td->urb, 0);
 577                 kfree(cur_td);
 578
 579                 spin_lock(&xhci->lock);
 580         } while (cur_td != last_unlinked_td);
 581
 582         /* Return to the event handler with xhci->lock re-acquired */
 583 }
 584
 585 /*
 586  * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
 587  * we need to clear the set deq pending flag in the endpoint ring state, so that
 588  * the TD queueing code can ring the doorbell again.  We also need to ring the
 589  * endpoint doorbell to restart the ring, but only if there aren't more
 590  * cancellations pending.
 591  */
 592 static void handle_set_deq_completion(struct xhci_hcd *xhci,
 593                 struct xhci_event_cmd *event,
 594                 union xhci_trb *trb)
 595 {
 596         unsigned int slot_id;
 597         unsigned int ep_index;
 598         struct xhci_ring *ep_ring;
 599         struct xhci_virt_device *dev;
 600         struct xhci_ep_ctx *ep_ctx;
 601         struct xhci_slot_ctx *slot_ctx;
 602
 603         slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
 604         ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
 605         dev = xhci->devs[slot_id];
 606         ep_ring = dev->eps[ep_index].ring;
 607         ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
 608         slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
 609
 610         if (GET_COMP_CODE(event->status) != COMP_SUCCESS) {
 611                 unsigned int ep_state;
 612                 unsigned int slot_state;
 613
 614                 switch (GET_COMP_CODE(event->status)) {
 615                 case COMP_TRB_ERR:
 616                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
 617                                         "of stream ID configuration\n");
 618                         break;
 619                 case COMP_CTX_STATE:
 620                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
 621                                         "to incorrect slot or ep state.\n");
 622                         ep_state = ep_ctx->ep_info;
 623                         ep_state &= EP_STATE_MASK;
 624                         slot_state = slot_ctx->dev_state;
 625                         slot_state = GET_SLOT_STATE(slot_state);
 626                         xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
 627                                         slot_state, ep_state);
 628                         break;
 629                 case COMP_EBADSLT:
 630                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
 631                                         "slot %u was not enabled.\n", slot_id);
 632                         break;
 633                 default:
 634                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
 635                                         "completion code of %u.\n",
 636                                         GET_COMP_CODE(event->status));
 637                         break;
 638                 }
 639                 /* OK what do we do now?  The endpoint state is hosed, and we
 640                  * should never get to this point if the synchronization between
 641                  * queueing, and endpoint state are correct.  This might happen
 642                  * if the device gets disconnected after we've finished
 643                  * cancelling URBs, which might not be an error...
 644                  */
 645         } else {
 646                 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
 647                                 ep_ctx->deq);
 648         }
 649
 650         dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
 651         ring_ep_doorbell(xhci, slot_id, ep_index);
 652 }
 653
 654 static void handle_reset_ep_completion(struct xhci_hcd *xhci,
 655                 struct xhci_event_cmd *event,
 656                 union xhci_trb *trb)
 657 {
 658         int slot_id;
 659         unsigned int ep_index;
 660         struct xhci_ring *ep_ring;
 661
 662         slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
 663         ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
 664         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
 665         /* This command will only fail if the endpoint wasn't halted,
 666          * but we don't care.
 667          */
 668         xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
 669                         (unsigned int) GET_COMP_CODE(event->status));
 670
 671         /* HW with the reset endpoint quirk needs to have a configure endpoint
 672          * command complete before the endpoint can be used.  Queue that here
 673          * because the HW can't handle two commands being queued in a row.
 674          */
 675         if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
 676                 xhci_dbg(xhci, "Queueing configure endpoint command\n");
 677                 xhci_queue_configure_endpoint(xhci,
 678                                 xhci->devs[slot_id]->in_ctx->dma, slot_id,
 679                                 false);
 680                 xhci_ring_cmd_db(xhci);
 681         } else {
 682                 /* Clear our internal halted state and restart the ring */
 683                 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
 684                 ring_ep_doorbell(xhci, slot_id, ep_index);
 685         }
 686 }
 687
 688 static void handle_cmd_completion(struct xhci_hcd *xhci,
 689                 struct xhci_event_cmd *event)
 690 {
 691         int slot_id = TRB_TO_SLOT_ID(event->flags);
 692         u64 cmd_dma;
 693         dma_addr_t cmd_dequeue_dma;
 694         struct xhci_input_control_ctx *ctrl_ctx;
 695         struct xhci_virt_device *virt_dev;
 696         unsigned int ep_index;
 697         struct xhci_ring *ep_ring;
 698         unsigned int ep_state;
 699
 700         cmd_dma = event->cmd_trb;
 701         cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
 702                         xhci->cmd_ring->dequeue);
 703         /* Is the command ring deq ptr out of sync with the deq seg ptr? */
 704         if (cmd_dequeue_dma == 0) {
 705                 xhci->error_bitmask |= 1 << 4;
 706                 return;
 707         }
 708         /* Does the DMA address match our internal dequeue pointer address? */
 709         if (cmd_dma != (u64) cmd_dequeue_dma) {
 710                 xhci->error_bitmask |= 1 << 5;
 711                 return;
 712         }
 713         switch (xhci->cmd_ring->dequeue->generic.field[3] & TRB_TYPE_BITMASK) {
 714         case TRB_TYPE(TRB_ENABLE_SLOT):
 715                 if (GET_COMP_CODE(event->status) == COMP_SUCCESS)
 716                         xhci->slot_id = slot_id;
 717                 else
 718                         xhci->slot_id = 0;
 719                 complete(&xhci->addr_dev);
 720                 break;
 721         case TRB_TYPE(TRB_DISABLE_SLOT):
 722                 if (xhci->devs[slot_id])
 723                         xhci_free_virt_device(xhci, slot_id);
 724                 break;
 725         case TRB_TYPE(TRB_CONFIG_EP):
 726                 virt_dev = xhci->devs[slot_id];
 727                 /* Check to see if a command in the device's command queue
 728                  * matches this one.  Signal the completion or free the command.
 729                  */
 730                 if (!list_empty(&virt_dev->cmd_list)) {
 731                         struct xhci_command *command;
 732                         command = list_entry(virt_dev->cmd_list.next,
 733                                         struct xhci_command, cmd_list);
 734                         if (xhci->cmd_ring->dequeue == command->command_trb) {
 735                                 command->status =
 736                                         GET_COMP_CODE(event->status);
 737                                 list_del(&command->cmd_list);
 738                                 if (command->completion)
 739                                         complete(command->completion);
 740                                 else
 741                                         xhci_free_command(xhci, command);
 742                         }
 743                         break;
 744                 }
 745                 /*
 746                  * Configure endpoint commands can come from the USB core
 747                  * configuration or alt setting changes, or because the HW
 748                  * needed an extra configure endpoint command after a reset
 749                  * endpoint command.  In the latter case, the xHCI driver is
 750                  * not waiting on the configure endpoint command.
 751                  */
 752                 ctrl_ctx = xhci_get_input_control_ctx(xhci,
 753                                 virt_dev->in_ctx);
 754                 /* Input ctx add_flags are the endpoint index plus one */
 755                 ep_index = xhci_last_valid_endpoint(ctrl_ctx->add_flags) - 1;
 756                 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
 757                 if (!ep_ring) {
 758                         /* This must have been an initial configure endpoint */
 759                         xhci->devs[slot_id]->cmd_status =
 760                                 GET_COMP_CODE(event->status);
 761                         complete(&xhci->devs[slot_id]->cmd_completion);
 762                         break;
 763                 }
 764                 ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
 765                 xhci_dbg(xhci, "Completed config ep cmd - last ep index = %d, "
 766                                 "state = %d\n", ep_index, ep_state);
 767                 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
 768                                 ep_state & EP_HALTED) {
 769                         /* Clear our internal halted state and restart ring */
 770                         xhci->devs[slot_id]->eps[ep_index].ep_state &=
 771                                 ~EP_HALTED;
 772                         ring_ep_doorbell(xhci, slot_id, ep_index);
 773                 } else {
 774                         xhci->devs[slot_id]->cmd_status =
 775                                 GET_COMP_CODE(event->status);
 776                         complete(&xhci->devs[slot_id]->cmd_completion);
 777                 }
 778                 break;
 779         case TRB_TYPE(TRB_EVAL_CONTEXT):
 780                 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
 781                 complete(&xhci->devs[slot_id]->cmd_completion);
 782                 break;
 783         case TRB_TYPE(TRB_ADDR_DEV):
 784                 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
 785                 complete(&xhci->addr_dev);
 786                 break;
 787         case TRB_TYPE(TRB_STOP_RING):
 788                 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue);
 789                 break;
 790         case TRB_TYPE(TRB_SET_DEQ):
 791                 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
 792                 break;
 793         case TRB_TYPE(TRB_CMD_NOOP):
 794                 ++xhci->noops_handled;
 795                 break;
 796         case TRB_TYPE(TRB_RESET_EP):
 797                 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
 798                 break;
 799         default:
 800                 /* Skip over unknown commands on the event ring */
 801                 xhci->error_bitmask |= 1 << 6;
 802                 break;
 803         }
 804         inc_deq(xhci, xhci->cmd_ring, false);
 805 }
 806
 807 static void handle_port_status(struct xhci_hcd *xhci,
 808                 union xhci_trb *event)
 809 {
 810         u32 port_id;
 811
 812         /* Port status change events always have a successful completion code */
 813         if (GET_COMP_CODE(event->generic.field[2]) != COMP_SUCCESS) {
 814                 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
 815                 xhci->error_bitmask |= 1 << 8;
 816         }
 817         /* FIXME: core doesn't care about all port link state changes yet */
 818         port_id = GET_PORT_ID(event->generic.field[0]);
 819         xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
 820
 821         /* Update event ring dequeue pointer before dropping the lock */
 822         inc_deq(xhci, xhci->event_ring, true);
 823         xhci_set_hc_event_deq(xhci);
 824
 825         spin_unlock(&xhci->lock);
 826         /* Pass this up to the core */
 827         usb_hcd_poll_rh_status(xhci_to_hcd(xhci));
 828         spin_lock(&xhci->lock);
 829 }
 830
 831 /*
 832  * This TD is defined by the TRBs starting at start_trb in start_seg and ending
 833  * at end_trb, which may be in another segment.  If the suspect DMA address is a
 834  * TRB in this TD, this function returns that TRB's segment.  Otherwise it
 835  * returns 0.
 836  */
 837 static struct xhci_segment *trb_in_td(
 838                 struct xhci_segment *start_seg,
 839                 union xhci_trb  *start_trb,
 840                 union xhci_trb  *end_trb,
 841                 dma_addr_t      suspect_dma)
 842 {
 843         dma_addr_t start_dma;
 844         dma_addr_t end_seg_dma;
 845         dma_addr_t end_trb_dma;
 846         struct xhci_segment *cur_seg;
 847
 848         start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
 849         cur_seg = start_seg;
 850
 851         do {
 852                 /* We may get an event for a Link TRB in the middle of a TD */
 853                 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
 854                                 &start_seg->trbs[TRBS_PER_SEGMENT - 1]);
 855                 /* If the end TRB isn't in this segment, this is set to 0 */
 856                 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
 857
 858                 if (end_trb_dma > 0) {
 859                         /* The end TRB is in this segment, so suspect should be here */
 860                         if (start_dma <= end_trb_dma) {
 861                                 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
 862                                         return cur_seg;
 863                         } else {
 864                                 /* Case for one segment with
 865                                  * a TD wrapped around to the top
 866                                  */
 867                                 if ((suspect_dma >= start_dma &&
 868                                                         suspect_dma <= end_seg_dma) ||
 869                                                 (suspect_dma >= cur_seg->dma &&
 870                                                  suspect_dma <= end_trb_dma))
 871                                         return cur_seg;
 872                         }
 873                         return 0;
 874                 } else {
 875                         /* Might still be somewhere in this segment */
 876                         if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
 877                                 return cur_seg;
 878                 }
 879                 cur_seg = cur_seg->next;
 880                 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
 881         } while (1);
 882
 883 }
 884
 885 /*
 886  * If this function returns an error condition, it means it got a Transfer
 887  * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
 888  * At this point, the host controller is probably hosed and should be reset.
 889  */
 890 static int handle_tx_event(struct xhci_hcd *xhci,
 891                 struct xhci_transfer_event *event)
 892 {
 893         struct xhci_virt_device *xdev;
 894         struct xhci_virt_ep *ep;
 895         struct xhci_ring *ep_ring;
 896         unsigned int slot_id;
 897         int ep_index;
 898         struct xhci_td *td = 0;
 899         dma_addr_t event_dma;
 900         struct xhci_segment *event_seg;
 901         union xhci_trb *event_trb;
 902         struct urb *urb = 0;
 903         int status = -EINPROGRESS;
 904         struct xhci_ep_ctx *ep_ctx;
 905         u32 trb_comp_code;
 906
 907         xhci_dbg(xhci, "In %s\n", __func__);
 908         slot_id = TRB_TO_SLOT_ID(event->flags);
 909         xdev = xhci->devs[slot_id];
 910         if (!xdev) {
 911                 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
 912                 return -ENODEV;
 913         }
 914
 915         /* Endpoint ID is 1 based, our index is zero based */
 916         ep_index = TRB_TO_EP_ID(event->flags) - 1;
 917         xhci_dbg(xhci, "%s - ep index = %d\n", __func__, ep_index);
 918         ep = &xdev->eps[ep_index];
 919         ep_ring = ep->ring;
 920         ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
 921         if (!ep_ring || (ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_DISABLED) {
 922                 xhci_err(xhci, "ERROR Transfer event pointed to disabled endpoint\n");
 923                 return -ENODEV;
 924         }
 925
 926         event_dma = event->buffer;
 927         /* This TRB should be in the TD at the head of this ring's TD list */
 928         xhci_dbg(xhci, "%s - checking for list empty\n", __func__);
 929         if (list_empty(&ep_ring->td_list)) {
 930                 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
 931                                 TRB_TO_SLOT_ID(event->flags), ep_index);
 932                 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
 933                                 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
 934                 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
 935                 urb = NULL;
 936                 goto cleanup;
 937         }
 938         xhci_dbg(xhci, "%s - getting list entry\n", __func__);
 939         td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
 940
 941         /* Is this a TRB in the currently executing TD? */
 942         xhci_dbg(xhci, "%s - looking for TD\n", __func__);
 943         event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
 944                         td->last_trb, event_dma);
 945         xhci_dbg(xhci, "%s - found event_seg = %p\n", __func__, event_seg);
 946         if (!event_seg) {
 947                 /* HC is busted, give up! */
 948                 xhci_err(xhci, "ERROR Transfer event TRB DMA ptr not part of current TD\n");
 949                 return -ESHUTDOWN;
 950         }
 951         event_trb = &event_seg->trbs[(event_dma - event_seg->dma) / sizeof(*event_trb)];
 952         xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
 953                         (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
 954         xhci_dbg(xhci, "Offset 0x00 (buffer lo) = 0x%x\n",
 955                         lower_32_bits(event->buffer));
 956         xhci_dbg(xhci, "Offset 0x04 (buffer hi) = 0x%x\n",
 957                         upper_32_bits(event->buffer));
 958         xhci_dbg(xhci, "Offset 0x08 (transfer length) = 0x%x\n",
 959                         (unsigned int) event->transfer_len);
 960         xhci_dbg(xhci, "Offset 0x0C (flags) = 0x%x\n",
 961                         (unsigned int) event->flags);
 962
 963         /* Look for common error cases */
 964         trb_comp_code = GET_COMP_CODE(event->transfer_len);
 965         switch (trb_comp_code) {
 966         /* Skip codes that require special handling depending on
 967          * transfer type
 968          */
 969         case COMP_SUCCESS:
 970         case COMP_SHORT_TX:
 971                 break;
 972         case COMP_STOP:
 973                 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
 974                 break;
 975         case COMP_STOP_INVAL:
 976                 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
 977                 break;
 978         case COMP_STALL:
 979                 xhci_warn(xhci, "WARN: Stalled endpoint\n");
 980                 ep->ep_state |= EP_HALTED;
 981                 status = -EPIPE;
 982                 break;
 983         case COMP_TRB_ERR:
 984                 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
 985                 status = -EILSEQ;
 986                 break;
 987         case COMP_TX_ERR:
 988                 xhci_warn(xhci, "WARN: transfer error on endpoint\n");
 989                 status = -EPROTO;
 990                 break;
 991         case COMP_BABBLE:
 992                 xhci_warn(xhci, "WARN: babble error on endpoint\n");
 993                 status = -EOVERFLOW;
 994                 break;
 995         case COMP_DB_ERR:
 996                 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
 997                 status = -ENOSR;
 998                 break;
 999         default:
1000                 xhci_warn(xhci, "ERROR Unknown event condition, HC probably busted\n");
1001                 urb = NULL;
1002                 goto cleanup;
1003         }
1004         /* Now update the urb's actual_length and give back to the core */
1005         /* Was this a control transfer? */
1006         if (usb_endpoint_xfer_control(&td->urb->ep->desc)) {
1007                 xhci_debug_trb(xhci, xhci->event_ring->dequeue);
1008                 switch (trb_comp_code) {
1009                 case COMP_SUCCESS:
1010                         if (event_trb == ep_ring->dequeue) {
1011                                 xhci_warn(xhci, "WARN: Success on ctrl setup TRB without IOC set??\n");
1012                                 status = -ESHUTDOWN;
1013                         } else if (event_trb != td->last_trb) {
1014                                 xhci_warn(xhci, "WARN: Success on ctrl data TRB without IOC set??\n");
1015                                 status = -ESHUTDOWN;
1016                         } else {
1017                                 xhci_dbg(xhci, "Successful control transfer!\n");
1018                                 status = 0;
1019                         }
1020                         break;
1021                 case COMP_SHORT_TX:
1022                         xhci_warn(xhci, "WARN: short transfer on control ep\n");
1023                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1024                                 status = -EREMOTEIO;
1025                         else
1026                                 status = 0;
1027                         break;
1028                 case COMP_BABBLE:
1029                         /* The 0.96 spec says a babbling control endpoint
1030                          * is not halted. The 0.96 spec says it is.  Some HW
1031                          * claims to be 0.95 compliant, but it halts the control
1032                          * endpoint anyway.  Check if a babble halted the
1033                          * endpoint.
1034                          */
1035                         if (ep_ctx->ep_info != EP_STATE_HALTED)
1036                                 break;
1037                         /* else fall through */
1038                 case COMP_STALL:
1039                         /* Did we transfer part of the data (middle) phase? */
1040                         if (event_trb != ep_ring->dequeue &&
1041                                         event_trb != td->last_trb)
1042                                 td->urb->actual_length =
1043                                         td->urb->transfer_buffer_length
1044                                         - TRB_LEN(event->transfer_len);
1045                         else
1046                                 td->urb->actual_length = 0;
1047
1048                         ep->stopped_td = td;
1049                         ep->stopped_trb = event_trb;
1050                         xhci_queue_reset_ep(xhci, slot_id, ep_index);
1051                         xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1052                         xhci_ring_cmd_db(xhci);
1053                         goto td_cleanup;
1054                 default:
1055                         /* Others already handled above */
1056                         break;
1057                 }
1058                 /*
1059                  * Did we transfer any data, despite the errors that might have
1060                  * happened?  I.e. did we get past the setup stage?
1061                  */
1062                 if (event_trb != ep_ring->dequeue) {
1063                         /* The event was for the status stage */
1064                         if (event_trb == td->last_trb) {
1065                                 if (td->urb->actual_length != 0) {
1066                                         /* Don't overwrite a previously set error code */
1067                                         if ((status == -EINPROGRESS ||
1068                                                                 status == 0) &&
1069                                                         (td->urb->transfer_flags
1070                                                          & URB_SHORT_NOT_OK))
1071                                                 /* Did we already see a short data stage? */
1072                                                 status = -EREMOTEIO;
1073                                 } else {
1074                                         td->urb->actual_length =
1075                                                 td->urb->transfer_buffer_length;
1076                                 }
1077                         } else {
1078                         /* Maybe the event was for the data stage? */
1079                                 if (trb_comp_code != COMP_STOP_INVAL) {
1080                                         /* We didn't stop on a link TRB in the middle */
1081                                         td->urb->actual_length =
1082                                                 td->urb->transfer_buffer_length -
1083                                                 TRB_LEN(event->transfer_len);
1084                                         xhci_dbg(xhci, "Waiting for status stage event\n");
1085                                         urb = NULL;
1086                                         goto cleanup;
1087                                 }
1088                         }
1089                 }
1090         } else {
1091                 switch (trb_comp_code) {
1092                 case COMP_SUCCESS:
1093                         /* Double check that the HW transferred everything. */
1094                         if (event_trb != td->last_trb) {
1095                                 xhci_warn(xhci, "WARN Successful completion "
1096                                                 "on short TX\n");
1097                                 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1098                                         status = -EREMOTEIO;
1099                                 else
1100                                         status = 0;
1101                         } else {
1102                                 if (usb_endpoint_xfer_bulk(&td->urb->ep->desc))
1103                                         xhci_dbg(xhci, "Successful bulk "
1104                                                         "transfer!\n");
1105                                 else
1106                                         xhci_dbg(xhci, "Successful interrupt "
1107                                                         "transfer!\n");
1108                                 status = 0;
1109                         }
1110                         break;
1111                 case COMP_SHORT_TX:
1112                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1113                                 status = -EREMOTEIO;
1114                         else
1115                                 status = 0;
1116                         break;
1117                 default:
1118                         /* Others already handled above */
1119                         break;
1120                 }
1121                 dev_dbg(&td->urb->dev->dev,
1122                                 "ep %#x - asked for %d bytes, "
1123                                 "%d bytes untransferred\n",
1124                                 td->urb->ep->desc.bEndpointAddress,
1125                                 td->urb->transfer_buffer_length,
1126                                 TRB_LEN(event->transfer_len));
1127                 /* Fast path - was this the last TRB in the TD for this URB? */
1128                 if (event_trb == td->last_trb) {
1129                         if (TRB_LEN(event->transfer_len) != 0) {
1130                                 td->urb->actual_length =
1131                                         td->urb->transfer_buffer_length -
1132                                         TRB_LEN(event->transfer_len);
1133                                 if (td->urb->transfer_buffer_length <
1134                                                 td->urb->actual_length) {
1135                                         xhci_warn(xhci, "HC gave bad length "
1136                                                         "of %d bytes left\n",
1137                                                         TRB_LEN(event->transfer_len));
1138                                         td->urb->actual_length = 0;
1139                                         if (td->urb->transfer_flags &
1140                                                         URB_SHORT_NOT_OK)
1141                                                 status = -EREMOTEIO;
1142                                         else
1143                                                 status = 0;
1144                                 }
1145                                 /* Don't overwrite a previously set error code */
1146                                 if (status == -EINPROGRESS) {
1147                                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1148                                                 status = -EREMOTEIO;
1149                                         else
1150                                                 status = 0;
1151                                 }
1152                         } else {
1153                                 td->urb->actual_length = td->urb->transfer_buffer_length;
1154                                 /* Ignore a short packet completion if the
1155                                  * untransferred length was zero.
1156                                  */
1157                                 if (status == -EREMOTEIO)
1158                                         status = 0;
1159                         }
1160                 } else {
1161                         /* Slow path - walk the list, starting from the dequeue
1162                          * pointer, to get the actual length transferred.
1163                          */
1164                         union xhci_trb *cur_trb;
1165                         struct xhci_segment *cur_seg;
1166
1167                         td->urb->actual_length = 0;
1168                         for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
1169                                         cur_trb != event_trb;
1170                                         next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1171                                 if (TRB_TYPE(cur_trb->generic.field[3]) != TRB_TR_NOOP &&
1172                                                 TRB_TYPE(cur_trb->generic.field[3]) != TRB_LINK)
1173                                         td->urb->actual_length +=
1174                                                 TRB_LEN(cur_trb->generic.field[2]);
1175                         }
1176                         /* If the ring didn't stop on a Link or No-op TRB, add
1177                          * in the actual bytes transferred from the Normal TRB
1178                          */
1179                         if (trb_comp_code != COMP_STOP_INVAL)
1180                                 td->urb->actual_length +=
1181                                         TRB_LEN(cur_trb->generic.field[2]) -
1182                                         TRB_LEN(event->transfer_len);
1183                 }
1184         }
1185         if (trb_comp_code == COMP_STOP_INVAL ||
1186                         trb_comp_code == COMP_STOP) {
1187                 /* The Endpoint Stop Command completion will take care of any
1188                  * stopped TDs.  A stopped TD may be restarted, so don't update
1189                  * the ring dequeue pointer or take this TD off any lists yet.
1190                  */
1191                 ep->stopped_td = td;
1192                 ep->stopped_trb = event_trb;
1193         } else {
1194                 if (trb_comp_code == COMP_STALL ||
1195                                 trb_comp_code == COMP_BABBLE) {
1196                         /* The transfer is completed from the driver's
1197                          * perspective, but we need to issue a set dequeue
1198                          * command for this stalled endpoint to move the dequeue
1199                          * pointer past the TD.  We can't do that here because
1200                          * the halt condition must be cleared first.
1201                          */
1202                         ep->stopped_td = td;
1203                         ep->stopped_trb = event_trb;
1204                 } else {
1205                         /* Update ring dequeue pointer */
1206                         while (ep_ring->dequeue != td->last_trb)
1207                                 inc_deq(xhci, ep_ring, false);
1208                         inc_deq(xhci, ep_ring, false);
1209                 }
1210
1211 td_cleanup:
1212                 /* Clean up the endpoint's TD list */
1213                 urb = td->urb;
1214                 /* Do one last check of the actual transfer length.
1215                  * If the host controller said we transferred more data than
1216                  * the buffer length, urb->actual_length will be a very big
1217                  * number (since it's unsigned).  Play it safe and say we didn't
1218                  * transfer anything.
1219                  */
1220                 if (urb->actual_length > urb->transfer_buffer_length) {
1221                         xhci_warn(xhci, "URB transfer length is wrong, "
1222                                         "xHC issue? req. len = %u, "
1223                                         "act. len = %u\n",
1224                                         urb->transfer_buffer_length,
1225                                         urb->actual_length);
1226                         urb->actual_length = 0;
1227                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1228                                 status = -EREMOTEIO;
1229                         else
1230                                 status = 0;
1231                 }
1232                 list_del(&td->td_list);
1233                 /* Was this TD slated to be cancelled but completed anyway? */
1234                 if (!list_empty(&td->cancelled_td_list)) {
1235                         list_del(&td->cancelled_td_list);
1236                         ep->cancels_pending--;
1237                 }
1238                 /* Leave the TD around for the reset endpoint function to use
1239                  * (but only if it's not a control endpoint, since we already
1240                  * queued the Set TR dequeue pointer command for stalled
1241                  * control endpoints).
1242                  */
1243                 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
1244                         (trb_comp_code != COMP_STALL &&
1245                                 trb_comp_code != COMP_BABBLE)) {
1246                         kfree(td);
1247                 }
1248                 urb->hcpriv = NULL;
1249         }
1250 cleanup:
1251         inc_deq(xhci, xhci->event_ring, true);
1252         xhci_set_hc_event_deq(xhci);
1253
1254         /* FIXME for multi-TD URBs (who have buffers bigger than 64MB) */
1255         if (urb) {
1256                 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), urb);
1257                 xhci_dbg(xhci, "Giveback URB %p, len = %d, status = %d\n",
1258                                 urb, urb->actual_length, status);
1259                 spin_unlock(&xhci->lock);
1260                 usb_hcd_giveback_urb(xhci_to_hcd(xhci), urb, status);
1261                 spin_lock(&xhci->lock);
1262         }
1263         return 0;
1264 }
1265
1266 /*
1267  * This function handles all OS-owned events on the event ring.  It may drop
1268  * xhci->lock between event processing (e.g. to pass up port status changes).
1269  */
1270 void xhci_handle_event(struct xhci_hcd *xhci)
1271 {
1272         union xhci_trb *event;
1273         int update_ptrs = 1;
1274         int ret;
1275
1276         xhci_dbg(xhci, "In %s\n", __func__);
1277         if (!xhci->event_ring || !xhci->event_ring->dequeue) {
1278                 xhci->error_bitmask |= 1 << 1;
1279                 return;
1280         }
1281
1282         event = xhci->event_ring->dequeue;
1283         /* Does the HC or OS own the TRB? */
1284         if ((event->event_cmd.flags & TRB_CYCLE) !=
1285                         xhci->event_ring->cycle_state) {
1286                 xhci->error_bitmask |= 1 << 2;
1287                 return;
1288         }
1289         xhci_dbg(xhci, "%s - OS owns TRB\n", __func__);
1290
1291         /* FIXME: Handle more event types. */
1292         switch ((event->event_cmd.flags & TRB_TYPE_BITMASK)) {
1293         case TRB_TYPE(TRB_COMPLETION):
1294                 xhci_dbg(xhci, "%s - calling handle_cmd_completion\n", __func__);
1295                 handle_cmd_completion(xhci, &event->event_cmd);
1296                 xhci_dbg(xhci, "%s - returned from handle_cmd_completion\n", __func__);
1297                 break;
1298         case TRB_TYPE(TRB_PORT_STATUS):
1299                 xhci_dbg(xhci, "%s - calling handle_port_status\n", __func__);
1300                 handle_port_status(xhci, event);
1301                 xhci_dbg(xhci, "%s - returned from handle_port_status\n", __func__);
1302                 update_ptrs = 0;
1303                 break;
1304         case TRB_TYPE(TRB_TRANSFER):
1305                 xhci_dbg(xhci, "%s - calling handle_tx_event\n", __func__);
1306                 ret = handle_tx_event(xhci, &event->trans_event);
1307                 xhci_dbg(xhci, "%s - returned from handle_tx_event\n", __func__);
1308                 if (ret < 0)
1309                         xhci->error_bitmask |= 1 << 9;
1310                 else
1311                         update_ptrs = 0;
1312                 break;
1313         default:
1314                 xhci->error_bitmask |= 1 << 3;
1315         }
1316
1317         if (update_ptrs) {
1318                 /* Update SW and HC event ring dequeue pointer */
1319                 inc_deq(xhci, xhci->event_ring, true);
1320                 xhci_set_hc_event_deq(xhci);
1321         }
1322         /* Are there more items on the event ring? */
1323         xhci_handle_event(xhci);
1324 }
1325
1326 /****           Endpoint Ring Operations        ****/
1327
1328 /*
1329  * Generic function for queueing a TRB on a ring.
1330  * The caller must have checked to make sure there's room on the ring.
1331  */
1332 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
1333                 bool consumer,
1334                 u32 field1, u32 field2, u32 field3, u32 field4)
1335 {
1336         struct xhci_generic_trb *trb;
1337
1338         trb = &ring->enqueue->generic;
1339         trb->field[0] = field1;
1340         trb->field[1] = field2;
1341         trb->field[2] = field3;
1342         trb->field[3] = field4;
1343         inc_enq(xhci, ring, consumer);
1344 }
1345
1346 /*
1347  * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
1348  * FIXME allocate segments if the ring is full.
1349  */
1350 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
1351                 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
1352 {
1353         /* Make sure the endpoint has been added to xHC schedule */
1354         xhci_dbg(xhci, "Endpoint state = 0x%x\n", ep_state);
1355         switch (ep_state) {
1356         case EP_STATE_DISABLED:
1357                 /*
1358                  * USB core changed config/interfaces without notifying us,
1359                  * or hardware is reporting the wrong state.
1360                  */
1361                 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
1362                 return -ENOENT;
1363         case EP_STATE_ERROR:
1364                 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
1365                 /* FIXME event handling code for error needs to clear it */
1366                 /* XXX not sure if this should be -ENOENT or not */
1367                 return -EINVAL;
1368         case EP_STATE_HALTED:
1369                 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
1370         case EP_STATE_STOPPED:
1371         case EP_STATE_RUNNING:
1372                 break;
1373         default:
1374                 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
1375                 /*
1376                  * FIXME issue Configure Endpoint command to try to get the HC
1377                  * back into a known state.
1378                  */
1379                 return -EINVAL;
1380         }
1381         if (!room_on_ring(xhci, ep_ring, num_trbs)) {
1382                 /* FIXME allocate more room */
1383                 xhci_err(xhci, "ERROR no room on ep ring\n");
1384                 return -ENOMEM;
1385         }
1386         return 0;
1387 }
1388
1389 static int prepare_transfer(struct xhci_hcd *xhci,
1390                 struct xhci_virt_device *xdev,
1391                 unsigned int ep_index,
1392                 unsigned int num_trbs,
1393                 struct urb *urb,
1394                 struct xhci_td **td,
1395                 gfp_t mem_flags)
1396 {
1397         int ret;
1398         struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1399         ret = prepare_ring(xhci, xdev->eps[ep_index].ring,
1400                         ep_ctx->ep_info & EP_STATE_MASK,
1401                         num_trbs, mem_flags);
1402         if (ret)
1403                 return ret;
1404         *td = kzalloc(sizeof(struct xhci_td), mem_flags);
1405         if (!*td)
1406                 return -ENOMEM;
1407         INIT_LIST_HEAD(&(*td)->td_list);
1408         INIT_LIST_HEAD(&(*td)->cancelled_td_list);
1409
1410         ret = usb_hcd_link_urb_to_ep(xhci_to_hcd(xhci), urb);
1411         if (unlikely(ret)) {
1412                 kfree(*td);
1413                 return ret;
1414         }
1415
1416         (*td)->urb = urb;
1417         urb->hcpriv = (void *) (*td);
1418         /* Add this TD to the tail of the endpoint ring's TD list */
1419         list_add_tail(&(*td)->td_list, &xdev->eps[ep_index].ring->td_list);
1420         (*td)->start_seg = xdev->eps[ep_index].ring->enq_seg;
1421         (*td)->first_trb = xdev->eps[ep_index].ring->enqueue;
1422
1423         return 0;
1424 }
1425
1426 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
1427 {
1428         int num_sgs, num_trbs, running_total, temp, i;
1429         struct scatterlist *sg;
1430
1431         sg = NULL;
1432         num_sgs = urb->num_sgs;
1433         temp = urb->transfer_buffer_length;
1434
1435         xhci_dbg(xhci, "count sg list trbs: \n");
1436         num_trbs = 0;
1437         for_each_sg(urb->sg->sg, sg, num_sgs, i) {
1438                 unsigned int previous_total_trbs = num_trbs;
1439                 unsigned int len = sg_dma_len(sg);
1440
1441                 /* Scatter gather list entries may cross 64KB boundaries */
1442                 running_total = TRB_MAX_BUFF_SIZE -
1443                         (sg_dma_address(sg) & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1444                 if (running_total != 0)
1445                         num_trbs++;
1446
1447                 /* How many more 64KB chunks to transfer, how many more TRBs? */
1448                 while (running_total < sg_dma_len(sg)) {
1449                         num_trbs++;
1450                         running_total += TRB_MAX_BUFF_SIZE;
1451                 }
1452                 xhci_dbg(xhci, " sg #%d: dma = %#llx, len = %#x (%d), num_trbs = %d\n",
1453                                 i, (unsigned long long)sg_dma_address(sg),
1454                                 len, len, num_trbs - previous_total_trbs);
1455
1456                 len = min_t(int, len, temp);
1457                 temp -= len;
1458                 if (temp == 0)
1459                         break;
1460         }
1461         xhci_dbg(xhci, "\n");
1462         if (!in_interrupt())
1463                 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %d, sglist used, num_trbs = %d\n",
1464                                 urb->ep->desc.bEndpointAddress,
1465                                 urb->transfer_buffer_length,
1466                                 num_trbs);
1467         return num_trbs;
1468 }
1469
1470 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
1471 {
1472         if (num_trbs != 0)
1473                 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
1474                                 "TRBs, %d left\n", __func__,
1475                                 urb->ep->desc.bEndpointAddress, num_trbs);
1476         if (running_total != urb->transfer_buffer_length)
1477                 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
1478                                 "queued %#x (%d), asked for %#x (%d)\n",
1479                                 __func__,
1480                                 urb->ep->desc.bEndpointAddress,
1481                                 running_total, running_total,
1482                                 urb->transfer_buffer_length,
1483                                 urb->transfer_buffer_length);
1484 }
1485
1486 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
1487                 unsigned int ep_index, int start_cycle,
1488                 struct xhci_generic_trb *start_trb, struct xhci_td *td)
1489 {
1490         /*
1491          * Pass all the TRBs to the hardware at once and make sure this write
1492          * isn't reordered.
1493          */
1494         wmb();
1495         start_trb->field[3] |= start_cycle;
1496         ring_ep_doorbell(xhci, slot_id, ep_index);
1497 }
1498
1499 /*
1500  * xHCI uses normal TRBs for both bulk and interrupt.  When the interrupt
1501  * endpoint is to be serviced, the xHC will consume (at most) one TD.  A TD
1502  * (comprised of sg list entries) can take several service intervals to
1503  * transmit.
1504  */
1505 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
1506                 struct urb *urb, int slot_id, unsigned int ep_index)
1507 {
1508         struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
1509                         xhci->devs[slot_id]->out_ctx, ep_index);
1510         int xhci_interval;
1511         int ep_interval;
1512
1513         xhci_interval = EP_INTERVAL_TO_UFRAMES(ep_ctx->ep_info);
1514         ep_interval = urb->interval;
1515         /* Convert to microframes */
1516         if (urb->dev->speed == USB_SPEED_LOW ||
1517                         urb->dev->speed == USB_SPEED_FULL)
1518                 ep_interval *= 8;
1519         /* FIXME change this to a warning and a suggestion to use the new API
1520          * to set the polling interval (once the API is added).
1521          */
1522         if (xhci_interval != ep_interval) {
1523                 if (!printk_ratelimit())
1524                         dev_dbg(&urb->dev->dev, "Driver uses different interval"
1525                                         " (%d microframe%s) than xHCI "
1526                                         "(%d microframe%s)\n",
1527                                         ep_interval,
1528                                         ep_interval == 1 ? "" : "s",
1529                                         xhci_interval,
1530                                         xhci_interval == 1 ? "" : "s");
1531                 urb->interval = xhci_interval;
1532                 /* Convert back to frames for LS/FS devices */
1533                 if (urb->dev->speed == USB_SPEED_LOW ||
1534                                 urb->dev->speed == USB_SPEED_FULL)
1535                         urb->interval /= 8;
1536         }
1537         return xhci_queue_bulk_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
1538 }
1539
1540 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
1541                 struct urb *urb, int slot_id, unsigned int ep_index)
1542 {
1543         struct xhci_ring *ep_ring;
1544         unsigned int num_trbs;
1545         struct xhci_td *td;
1546         struct scatterlist *sg;
1547         int num_sgs;
1548         int trb_buff_len, this_sg_len, running_total;
1549         bool first_trb;
1550         u64 addr;
1551
1552         struct xhci_generic_trb *start_trb;
1553         int start_cycle;
1554
1555         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1556         num_trbs = count_sg_trbs_needed(xhci, urb);
1557         num_sgs = urb->num_sgs;
1558
1559         trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
1560                         ep_index, num_trbs, urb, &td, mem_flags);
1561         if (trb_buff_len < 0)
1562                 return trb_buff_len;
1563         /*
1564          * Don't give the first TRB to the hardware (by toggling the cycle bit)
1565          * until we've finished creating all the other TRBs.  The ring's cycle
1566          * state may change as we enqueue the other TRBs, so save it too.
1567          */
1568         start_trb = &ep_ring->enqueue->generic;
1569         start_cycle = ep_ring->cycle_state;
1570
1571         running_total = 0;
1572         /*
1573          * How much data is in the first TRB?
1574          *
1575          * There are three forces at work for TRB buffer pointers and lengths:
1576          * 1. We don't want to walk off the end of this sg-list entry buffer.
1577          * 2. The transfer length that the driver requested may be smaller than
1578          *    the amount of memory allocated for this scatter-gather list.
1579          * 3. TRBs buffers can't cross 64KB boundaries.
1580          */
1581         sg = urb->sg->sg;
1582         addr = (u64) sg_dma_address(sg);
1583         this_sg_len = sg_dma_len(sg);
1584         trb_buff_len = TRB_MAX_BUFF_SIZE -
1585                 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1586         trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
1587         if (trb_buff_len > urb->transfer_buffer_length)
1588                 trb_buff_len = urb->transfer_buffer_length;
1589         xhci_dbg(xhci, "First length to xfer from 1st sglist entry = %u\n",
1590                         trb_buff_len);
1591
1592         first_trb = true;
1593         /* Queue the first TRB, even if it's zero-length */
1594         do {
1595                 u32 field = 0;
1596                 u32 length_field = 0;
1597
1598                 /* Don't change the cycle bit of the first TRB until later */
1599                 if (first_trb)
1600                         first_trb = false;
1601                 else
1602                         field |= ep_ring->cycle_state;
1603
1604                 /* Chain all the TRBs together; clear the chain bit in the last
1605                  * TRB to indicate it's the last TRB in the chain.
1606                  */
1607                 if (num_trbs > 1) {
1608                         field |= TRB_CHAIN;
1609                 } else {
1610                         /* FIXME - add check for ZERO_PACKET flag before this */
1611                         td->last_trb = ep_ring->enqueue;
1612                         field |= TRB_IOC;
1613                 }
1614                 xhci_dbg(xhci, " sg entry: dma = %#x, len = %#x (%d), "
1615                                 "64KB boundary at %#x, end dma = %#x\n",
1616                                 (unsigned int) addr, trb_buff_len, trb_buff_len,
1617                                 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
1618                                 (unsigned int) addr + trb_buff_len);
1619                 if (TRB_MAX_BUFF_SIZE -
1620                                 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1)) < trb_buff_len) {
1621                         xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
1622                         xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
1623                                         (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
1624                                         (unsigned int) addr + trb_buff_len);
1625                 }
1626                 length_field = TRB_LEN(trb_buff_len) |
1627                         TD_REMAINDER(urb->transfer_buffer_length - running_total) |
1628                         TRB_INTR_TARGET(0);
1629                 queue_trb(xhci, ep_ring, false,
1630                                 lower_32_bits(addr),
1631                                 upper_32_bits(addr),
1632                                 length_field,
1633                                 /* We always want to know if the TRB was short,
1634                                  * or we won't get an event when it completes.
1635                                  * (Unless we use event data TRBs, which are a
1636                                  * waste of space and HC resources.)
1637                                  */
1638                                 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
1639                 --num_trbs;
1640                 running_total += trb_buff_len;
1641
1642                 /* Calculate length for next transfer --
1643                  * Are we done queueing all the TRBs for this sg entry?
1644                  */
1645                 this_sg_len -= trb_buff_len;
1646                 if (this_sg_len == 0) {
1647                         --num_sgs;
1648                         if (num_sgs == 0)
1649                                 break;
1650                         sg = sg_next(sg);
1651                         addr = (u64) sg_dma_address(sg);
1652                         this_sg_len = sg_dma_len(sg);
1653                 } else {
1654                         addr += trb_buff_len;
1655                 }
1656
1657                 trb_buff_len = TRB_MAX_BUFF_SIZE -
1658                         (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1659                 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
1660                 if (running_total + trb_buff_len > urb->transfer_buffer_length)
1661                         trb_buff_len =
1662                                 urb->transfer_buffer_length - running_total;
1663         } while (running_total < urb->transfer_buffer_length);
1664
1665         check_trb_math(urb, num_trbs, running_total);
1666         giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
1667         return 0;
1668 }
1669
1670 /* This is very similar to what ehci-q.c qtd_fill() does */
1671 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
1672                 struct urb *urb, int slot_id, unsigned int ep_index)
1673 {
1674         struct xhci_ring *ep_ring;
1675         struct xhci_td *td;
1676         int num_trbs;
1677         struct xhci_generic_trb *start_trb;
1678         bool first_trb;
1679         int start_cycle;
1680         u32 field, length_field;
1681
1682         int running_total, trb_buff_len, ret;
1683         u64 addr;
1684
1685         if (urb->sg)
1686                 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
1687
1688         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1689
1690         num_trbs = 0;
1691         /* How much data is (potentially) left before the 64KB boundary? */
1692         running_total = TRB_MAX_BUFF_SIZE -
1693                 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1694
1695         /* If there's some data on this 64KB chunk, or we have to send a
1696          * zero-length transfer, we need at least one TRB
1697          */
1698         if (running_total != 0 || urb->transfer_buffer_length == 0)
1699                 num_trbs++;
1700         /* How many more 64KB chunks to transfer, how many more TRBs? */
1701         while (running_total < urb->transfer_buffer_length) {
1702                 num_trbs++;
1703                 running_total += TRB_MAX_BUFF_SIZE;
1704         }
1705         /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
1706
1707         if (!in_interrupt())
1708                 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %#x (%d), addr = %#llx, num_trbs = %d\n",
1709                                 urb->ep->desc.bEndpointAddress,
1710                                 urb->transfer_buffer_length,
1711                                 urb->transfer_buffer_length,
1712                                 (unsigned long long)urb->transfer_dma,
1713                                 num_trbs);
1714
1715         ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
1716                         num_trbs, urb, &td, mem_flags);
1717         if (ret < 0)
1718                 return ret;
1719
1720         /*
1721          * Don't give the first TRB to the hardware (by toggling the cycle bit)
1722          * until we've finished creating all the other TRBs.  The ring's cycle
1723          * state may change as we enqueue the other TRBs, so save it too.
1724          */
1725         start_trb = &ep_ring->enqueue->generic;
1726         start_cycle = ep_ring->cycle_state;
1727
1728         running_total = 0;
1729         /* How much data is in the first TRB? */
1730         addr = (u64) urb->transfer_dma;
1731         trb_buff_len = TRB_MAX_BUFF_SIZE -
1732                 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1733         if (urb->transfer_buffer_length < trb_buff_len)
1734                 trb_buff_len = urb->transfer_buffer_length;
1735
1736         first_trb = true;
1737
1738         /* Queue the first TRB, even if it's zero-length */
1739         do {
1740                 field = 0;
1741
1742                 /* Don't change the cycle bit of the first TRB until later */
1743                 if (first_trb)
1744                         first_trb = false;
1745                 else
1746                         field |= ep_ring->cycle_state;
1747
1748                 /* Chain all the TRBs together; clear the chain bit in the last
1749                  * TRB to indicate it's the last TRB in the chain.
1750                  */
1751                 if (num_trbs > 1) {
1752                         field |= TRB_CHAIN;
1753                 } else {
1754                         /* FIXME - add check for ZERO_PACKET flag before this */
1755                         td->last_trb = ep_ring->enqueue;
1756                         field |= TRB_IOC;
1757                 }
1758                 length_field = TRB_LEN(trb_buff_len) |
1759                         TD_REMAINDER(urb->transfer_buffer_length - running_total) |
1760                         TRB_INTR_TARGET(0);
1761                 queue_trb(xhci, ep_ring, false,
1762                                 lower_32_bits(addr),
1763                                 upper_32_bits(addr),
1764                                 length_field,
1765                                 /* We always want to know if the TRB was short,
1766                                  * or we won't get an event when it completes.
1767                                  * (Unless we use event data TRBs, which are a
1768                                  * waste of space and HC resources.)
1769                                  */
1770                                 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
1771                 --num_trbs;
1772                 running_total += trb_buff_len;
1773
1774                 /* Calculate length for next transfer */
1775                 addr += trb_buff_len;
1776                 trb_buff_len = urb->transfer_buffer_length - running_total;
1777                 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
1778                         trb_buff_len = TRB_MAX_BUFF_SIZE;
1779         } while (running_total < urb->transfer_buffer_length);
1780
1781         check_trb_math(urb, num_trbs, running_total);
1782         giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
1783         return 0;
1784 }
1785
1786 /* Caller must have locked xhci->lock */
1787 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
1788                 struct urb *urb, int slot_id, unsigned int ep_index)
1789 {
1790         struct xhci_ring *ep_ring;
1791         int num_trbs;
1792         int ret;
1793         struct usb_ctrlrequest *setup;
1794         struct xhci_generic_trb *start_trb;
1795         int start_cycle;
1796         u32 field, length_field;
1797         struct xhci_td *td;
1798
1799         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1800
1801         /*
1802          * Need to copy setup packet into setup TRB, so we can't use the setup
1803          * DMA address.
1804          */
1805         if (!urb->setup_packet)
1806                 return -EINVAL;
1807
1808         if (!in_interrupt())
1809                 xhci_dbg(xhci, "Queueing ctrl tx for slot id %d, ep %d\n",
1810                                 slot_id, ep_index);
1811         /* 1 TRB for setup, 1 for status */
1812         num_trbs = 2;
1813         /*
1814          * Don't need to check if we need additional event data and normal TRBs,
1815          * since data in control transfers will never get bigger than 16MB
1816          * XXX: can we get a buffer that crosses 64KB boundaries?
1817          */
1818         if (urb->transfer_buffer_length > 0)
1819                 num_trbs++;
1820         ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index, num_trbs,
1821                         urb, &td, mem_flags);
1822         if (ret < 0)
1823                 return ret;
1824
1825         /*
1826          * Don't give the first TRB to the hardware (by toggling the cycle bit)
1827          * until we've finished creating all the other TRBs.  The ring's cycle
1828          * state may change as we enqueue the other TRBs, so save it too.
1829          */
1830         start_trb = &ep_ring->enqueue->generic;
1831         start_cycle = ep_ring->cycle_state;
1832
1833         /* Queue setup TRB - see section 6.4.1.2.1 */
1834         /* FIXME better way to translate setup_packet into two u32 fields? */
1835         setup = (struct usb_ctrlrequest *) urb->setup_packet;
1836         queue_trb(xhci, ep_ring, false,
1837                         /* FIXME endianness is probably going to bite my ass here. */
1838                         setup->bRequestType | setup->bRequest << 8 | setup->wValue << 16,
1839                         setup->wIndex | setup->wLength << 16,
1840                         TRB_LEN(8) | TRB_INTR_TARGET(0),
1841                         /* Immediate data in pointer */
1842                         TRB_IDT | TRB_TYPE(TRB_SETUP));
1843
1844         /* If there's data, queue data TRBs */
1845         field = 0;
1846         length_field = TRB_LEN(urb->transfer_buffer_length) |
1847                 TD_REMAINDER(urb->transfer_buffer_length) |
1848                 TRB_INTR_TARGET(0);
1849         if (urb->transfer_buffer_length > 0) {
1850                 if (setup->bRequestType & USB_DIR_IN)
1851                         field |= TRB_DIR_IN;
1852                 queue_trb(xhci, ep_ring, false,
1853                                 lower_32_bits(urb->transfer_dma),
1854                                 upper_32_bits(urb->transfer_dma),
1855                                 length_field,
1856                                 /* Event on short tx */
1857                                 field | TRB_ISP | TRB_TYPE(TRB_DATA) | ep_ring->cycle_state);
1858         }
1859
1860         /* Save the DMA address of the last TRB in the TD */
1861         td->last_trb = ep_ring->enqueue;
1862
1863         /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
1864         /* If the device sent data, the status stage is an OUT transfer */
1865         if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
1866                 field = 0;
1867         else
1868                 field = TRB_DIR_IN;
1869         queue_trb(xhci, ep_ring, false,
1870                         0,
1871                         0,
1872                         TRB_INTR_TARGET(0),
1873                         /* Event on completion */
1874                         field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
1875
1876         giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
1877         return 0;
1878 }
1879
1880 /****           Command Ring Operations         ****/
1881
1882 /* Generic function for queueing a command TRB on the command ring.
1883  * Check to make sure there's room on the command ring for one command TRB.
1884  * Also check that there's room reserved for commands that must not fail.
1885  * If this is a command that must not fail, meaning command_must_succeed = TRUE,
1886  * then only check for the number of reserved spots.
1887  * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
1888  * because the command event handler may want to resubmit a failed command.
1889  */
1890 static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
1891                 u32 field3, u32 field4, bool command_must_succeed)
1892 {
1893         int reserved_trbs = xhci->cmd_ring_reserved_trbs;
1894         if (!command_must_succeed)
1895                 reserved_trbs++;
1896
1897         if (!room_on_ring(xhci, xhci->cmd_ring, reserved_trbs)) {
1898                 if (!in_interrupt())
1899                         xhci_err(xhci, "ERR: No room for command on command ring\n");
1900                 if (command_must_succeed)
1901                         xhci_err(xhci, "ERR: Reserved TRB counting for "
1902                                         "unfailable commands failed.\n");
1903                 return -ENOMEM;
1904         }
1905         queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
1906                         field4 | xhci->cmd_ring->cycle_state);
1907         return 0;
1908 }
1909
1910 /* Queue a no-op command on the command ring */
1911 static int queue_cmd_noop(struct xhci_hcd *xhci)
1912 {
1913         return queue_command(xhci, 0, 0, 0, TRB_TYPE(TRB_CMD_NOOP), false);
1914 }
1915
1916 /*
1917  * Place a no-op command on the command ring to test the command and
1918  * event ring.
1919  */
1920 void *xhci_setup_one_noop(struct xhci_hcd *xhci)
1921 {
1922         if (queue_cmd_noop(xhci) < 0)
1923                 return NULL;
1924         xhci->noops_submitted++;
1925         return xhci_ring_cmd_db;
1926 }
1927
1928 /* Queue a slot enable or disable request on the command ring */
1929 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
1930 {
1931         return queue_command(xhci, 0, 0, 0,
1932                         TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
1933 }
1934
1935 /* Queue an address device command TRB */
1936 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1937                 u32 slot_id)
1938 {
1939         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1940                         upper_32_bits(in_ctx_ptr), 0,
1941                         TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
1942                         false);
1943 }
1944
1945 /* Queue a configure endpoint command TRB */
1946 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1947                 u32 slot_id, bool command_must_succeed)
1948 {
1949         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1950                         upper_32_bits(in_ctx_ptr), 0,
1951                         TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
1952                         command_must_succeed);
1953 }
1954
1955 /* Queue an evaluate context command TRB */
1956 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1957                 u32 slot_id)
1958 {
1959         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1960                         upper_32_bits(in_ctx_ptr), 0,
1961                         TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
1962                         false);
1963 }
1964
1965 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
1966                 unsigned int ep_index)
1967 {
1968         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
1969         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
1970         u32 type = TRB_TYPE(TRB_STOP_RING);
1971
1972         return queue_command(xhci, 0, 0, 0,
1973                         trb_slot_id | trb_ep_index | type, false);
1974 }
1975
1976 /* Set Transfer Ring Dequeue Pointer command.
1977  * This should not be used for endpoints that have streams enabled.
1978  */
1979 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
1980                 unsigned int ep_index, struct xhci_segment *deq_seg,
1981                 union xhci_trb *deq_ptr, u32 cycle_state)
1982 {
1983         dma_addr_t addr;
1984         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
1985         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
1986         u32 type = TRB_TYPE(TRB_SET_DEQ);
1987
1988         addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
1989         if (addr == 0) {
1990                 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
1991                 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
1992                                 deq_seg, deq_ptr);
1993                 return 0;
1994         }
1995         return queue_command(xhci, lower_32_bits(addr) | cycle_state,
1996                         upper_32_bits(addr), 0,
1997                         trb_slot_id | trb_ep_index | type, false);
1998 }
1999
2000 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
2001                 unsigned int ep_index)
2002 {
2003         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
2004         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
2005         u32 type = TRB_TYPE(TRB_RESET_EP);
2006
2007         return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,
2008                         false);
2009 }