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 <linux/slab.h>
  69 #include "xhci.h"
  70
  71 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
  72                 struct xhci_virt_device *virt_dev,
  73                 struct xhci_event_cmd *event);
  74
  75 /*
  76  * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
  77  * address of the TRB.
  78  */
  79 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
  80                 union xhci_trb *trb)
  81 {
  82         unsigned long segment_offset;
  83
  84         if (!seg || !trb || trb < seg->trbs)
  85                 return 0;
  86         /* offset in TRBs */
  87         segment_offset = trb - seg->trbs;
  88         if (segment_offset > TRBS_PER_SEGMENT)
  89                 return 0;
  90         return seg->dma + (segment_offset * sizeof(*trb));
  91 }
  92
  93 /* Does this link TRB point to the first segment in a ring,
  94  * or was the previous TRB the last TRB on the last segment in the ERST?
  95  */
  96 static bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
  97                 struct xhci_segment *seg, union xhci_trb *trb)
  98 {
  99         if (ring == xhci->event_ring)
 100                 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
 101                         (seg->next == xhci->event_ring->first_seg);
 102         else
 103                 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
 104 }
 105
 106 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
 107  * segment?  I.e. would the updated event TRB pointer step off the end of the
 108  * event seg?
 109  */
 110 static int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
 111                 struct xhci_segment *seg, union xhci_trb *trb)
 112 {
 113         if (ring == xhci->event_ring)
 114                 return trb == &seg->trbs[TRBS_PER_SEGMENT];
 115         else
 116                 return TRB_TYPE_LINK_LE32(trb->link.control);
 117 }
 118
 119 static int enqueue_is_link_trb(struct xhci_ring *ring)
 120 {
 121         struct xhci_link_trb *link = &ring->enqueue->link;
 122         return TRB_TYPE_LINK_LE32(link->control);
 123 }
 124
 125 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
 126  * TRB is in a new segment.  This does not skip over link TRBs, and it does not
 127  * effect the ring dequeue or enqueue pointers.
 128  */
 129 static void next_trb(struct xhci_hcd *xhci,
 130                 struct xhci_ring *ring,
 131                 struct xhci_segment **seg,
 132                 union xhci_trb **trb)
 133 {
 134         if (last_trb(xhci, ring, *seg, *trb)) {
 135                 *seg = (*seg)->next;
 136                 *trb = ((*seg)->trbs);
 137         } else {
 138                 (*trb)++;
 139         }
 140 }
 141
 142 /*
 143  * See Cycle bit rules. SW is the consumer for the event ring only.
 144  * Don't make a ring full of link TRBs.  That would be dumb and this would loop.
 145  */
 146 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring)
 147 {
 148         unsigned long long addr;
 149
 150         ring->deq_updates++;
 151
 152         /*
 153          * If this is not event ring, and the dequeue pointer
 154          * is not on a link TRB, there is one more usable TRB
 155          */
 156         if (ring->type != TYPE_EVENT &&
 157                         !last_trb(xhci, ring, ring->deq_seg, ring->dequeue))
 158                 ring->num_trbs_free++;
 159
 160         do {
 161                 /*
 162                  * Update the dequeue pointer further if that was a link TRB or
 163                  * we're at the end of an event ring segment (which doesn't have
 164                  * link TRBS)
 165                  */
 166                 if (last_trb(xhci, ring, ring->deq_seg, ring->dequeue)) {
 167                         if (ring->type == TYPE_EVENT &&
 168                                         last_trb_on_last_seg(xhci, ring,
 169                                                 ring->deq_seg, ring->dequeue)) {
 170                                 ring->cycle_state = (ring->cycle_state ? 0 : 1);
 171                         }
 172                         ring->deq_seg = ring->deq_seg->next;
 173                         ring->dequeue = ring->deq_seg->trbs;
 174                 } else {
 175                         ring->dequeue++;
 176                 }
 177         } while (last_trb(xhci, ring, ring->deq_seg, ring->dequeue));
 178
 179         addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
 180 }
 181
 182 /*
 183  * See Cycle bit rules. SW is the consumer for the event ring only.
 184  * Don't make a ring full of link TRBs.  That would be dumb and this would loop.
 185  *
 186  * If we've just enqueued a TRB that is in the middle of a TD (meaning the
 187  * chain bit is set), then set the chain bit in all the following link TRBs.
 188  * If we've enqueued the last TRB in a TD, make sure the following link TRBs
 189  * have their chain bit cleared (so that each Link TRB is a separate TD).
 190  *
 191  * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
 192  * set, but other sections talk about dealing with the chain bit set.  This was
 193  * fixed in the 0.96 specification errata, but we have to assume that all 0.95
 194  * xHCI hardware can't handle the chain bit being cleared on a link TRB.
 195  *
 196  * @more_trbs_coming:   Will you enqueue more TRBs before calling
 197  *                      prepare_transfer()?
 198  */
 199 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
 200                         bool more_trbs_coming)
 201 {
 202         u32 chain;
 203         union xhci_trb *next;
 204         unsigned long long addr;
 205
 206         chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
 207         /* If this is not event ring, there is one less usable TRB */
 208         if (ring->type != TYPE_EVENT &&
 209                         !last_trb(xhci, ring, ring->enq_seg, ring->enqueue))
 210                 ring->num_trbs_free--;
 211         next = ++(ring->enqueue);
 212
 213         ring->enq_updates++;
 214         /* Update the dequeue pointer further if that was a link TRB or we're at
 215          * the end of an event ring segment (which doesn't have link TRBS)
 216          */
 217         while (last_trb(xhci, ring, ring->enq_seg, next)) {
 218                 if (ring->type != TYPE_EVENT) {
 219                         /*
 220                          * If the caller doesn't plan on enqueueing more
 221                          * TDs before ringing the doorbell, then we
 222                          * don't want to give the link TRB to the
 223                          * hardware just yet.  We'll give the link TRB
 224                          * back in prepare_ring() just before we enqueue
 225                          * the TD at the top of the ring.
 226                          */
 227                         if (!chain && !more_trbs_coming)
 228                                 break;
 229
 230                         /* If we're not dealing with 0.95 hardware or
 231                          * isoc rings on AMD 0.96 host,
 232                          * carry over the chain bit of the previous TRB
 233                          * (which may mean the chain bit is cleared).
 234                          */
 235                         if (!(ring->type == TYPE_ISOC &&
 236                                         (xhci->quirks & XHCI_AMD_0x96_HOST))
 237                                                 && !xhci_link_trb_quirk(xhci)) {
 238                                 next->link.control &=
 239                                         cpu_to_le32(~TRB_CHAIN);
 240                                 next->link.control |=
 241                                         cpu_to_le32(chain);
 242                         }
 243                         /* Give this link TRB to the hardware */
 244                         wmb();
 245                         next->link.control ^= cpu_to_le32(TRB_CYCLE);
 246
 247                         /* Toggle the cycle bit after the last ring segment. */
 248                         if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
 249                                 ring->cycle_state = (ring->cycle_state ? 0 : 1);
 250                         }
 251                 }
 252                 ring->enq_seg = ring->enq_seg->next;
 253                 ring->enqueue = ring->enq_seg->trbs;
 254                 next = ring->enqueue;
 255         }
 256         addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
 257 }
 258
 259 /*
 260  * Check to see if there's room to enqueue num_trbs on the ring and make sure
 261  * enqueue pointer will not advance into dequeue segment. See rules above.
 262  */
 263 static inline int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
 264                 unsigned int num_trbs)
 265 {
 266         int num_trbs_in_deq_seg;
 267
 268         if (ring->num_trbs_free < num_trbs)
 269                 return 0;
 270
 271         if (ring->type != TYPE_COMMAND && ring->type != TYPE_EVENT) {
 272                 num_trbs_in_deq_seg = ring->dequeue - ring->deq_seg->trbs;
 273                 if (ring->num_trbs_free < num_trbs + num_trbs_in_deq_seg)
 274                         return 0;
 275         }
 276
 277         return 1;
 278 }
 279
 280 /* Ring the host controller doorbell after placing a command on the ring */
 281 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
 282 {
 283         if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING))
 284                 return;
 285
 286         xhci_dbg(xhci, "// Ding dong!\n");
 287         xhci_writel(xhci, DB_VALUE_HOST, &xhci->dba->doorbell[0]);
 288         /* Flush PCI posted writes */
 289         xhci_readl(xhci, &xhci->dba->doorbell[0]);
 290 }
 291
 292 static int xhci_abort_cmd_ring(struct xhci_hcd *xhci)
 293 {
 294         u64 temp_64;
 295         int ret;
 296
 297         xhci_dbg(xhci, "Abort command ring\n");
 298
 299         if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING)) {
 300                 xhci_dbg(xhci, "The command ring isn't running, "
 301                                 "Have the command ring been stopped?\n");
 302                 return 0;
 303         }
 304
 305         temp_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
 306         if (!(temp_64 & CMD_RING_RUNNING)) {
 307                 xhci_dbg(xhci, "Command ring had been stopped\n");
 308                 return 0;
 309         }
 310         xhci->cmd_ring_state = CMD_RING_STATE_ABORTED;
 311         xhci_write_64(xhci, temp_64 | CMD_RING_ABORT,
 312                         &xhci->op_regs->cmd_ring);
 313
 314         /* Section 4.6.1.2 of xHCI 1.0 spec says software should
 315          * time the completion od all xHCI commands, including
 316          * the Command Abort operation. If software doesn't see
 317          * CRR negated in a timely manner (e.g. longer than 5
 318          * seconds), then it should assume that the there are
 319          * larger problems with the xHC and assert HCRST.
 320          */
 321         ret = xhci_handshake(xhci, &xhci->op_regs->cmd_ring,
 322                         CMD_RING_RUNNING, 0, 5 * 1000 * 1000);
 323         if (ret < 0) {
 324                 xhci_err(xhci, "Stopped the command ring failed, "
 325                                 "maybe the host is dead\n");
 326                 xhci->xhc_state |= XHCI_STATE_DYING;
 327                 xhci_quiesce(xhci);
 328                 xhci_halt(xhci);
 329                 return -ESHUTDOWN;
 330         }
 331
 332         return 0;
 333 }
 334
 335 static int xhci_queue_cd(struct xhci_hcd *xhci,
 336                 struct xhci_command *command,
 337                 union xhci_trb *cmd_trb)
 338 {
 339         struct xhci_cd *cd;
 340         cd = kzalloc(sizeof(struct xhci_cd), GFP_ATOMIC);
 341         if (!cd)
 342                 return -ENOMEM;
 343         INIT_LIST_HEAD(&cd->cancel_cmd_list);
 344
 345         cd->command = command;
 346         cd->cmd_trb = cmd_trb;
 347         list_add_tail(&cd->cancel_cmd_list, &xhci->cancel_cmd_list);
 348
 349         return 0;
 350 }
 351
 352 /*
 353  * Cancel the command which has issue.
 354  *
 355  * Some commands may hang due to waiting for acknowledgement from
 356  * usb device. It is outside of the xHC's ability to control and
 357  * will cause the command ring is blocked. When it occurs software
 358  * should intervene to recover the command ring.
 359  * See Section 4.6.1.1 and 4.6.1.2
 360  */
 361 int xhci_cancel_cmd(struct xhci_hcd *xhci, struct xhci_command *command,
 362                 union xhci_trb *cmd_trb)
 363 {
 364         int retval = 0;
 365         unsigned long flags;
 366
 367         spin_lock_irqsave(&xhci->lock, flags);
 368
 369         if (xhci->xhc_state & XHCI_STATE_DYING) {
 370                 xhci_warn(xhci, "Abort the command ring,"
 371                                 " but the xHCI is dead.\n");
 372                 retval = -ESHUTDOWN;
 373                 goto fail;
 374         }
 375
 376         /* queue the cmd desriptor to cancel_cmd_list */
 377         retval = xhci_queue_cd(xhci, command, cmd_trb);
 378         if (retval) {
 379                 xhci_warn(xhci, "Queuing command descriptor failed.\n");
 380                 goto fail;
 381         }
 382
 383         /* abort command ring */
 384         retval = xhci_abort_cmd_ring(xhci);
 385         if (retval) {
 386                 xhci_err(xhci, "Abort command ring failed\n");
 387                 if (unlikely(retval == -ESHUTDOWN)) {
 388                         spin_unlock_irqrestore(&xhci->lock, flags);
 389                         usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
 390                         xhci_dbg(xhci, "xHCI host controller is dead.\n");
 391                         return retval;
 392                 }
 393         }
 394
 395 fail:
 396         spin_unlock_irqrestore(&xhci->lock, flags);
 397         return retval;
 398 }
 399
 400 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
 401                 unsigned int slot_id,
 402                 unsigned int ep_index,
 403                 unsigned int stream_id)
 404 {
 405         __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
 406         struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
 407         unsigned int ep_state = ep->ep_state;
 408
 409         /* Don't ring the doorbell for this endpoint if there are pending
 410          * cancellations because we don't want to interrupt processing.
 411          * We don't want to restart any stream rings if there's a set dequeue
 412          * pointer command pending because the device can choose to start any
 413          * stream once the endpoint is on the HW schedule.
 414          * FIXME - check all the stream rings for pending cancellations.
 415          */
 416         if ((ep_state & EP_HALT_PENDING) || (ep_state & SET_DEQ_PENDING) ||
 417             (ep_state & EP_HALTED))
 418                 return;
 419         xhci_writel(xhci, DB_VALUE(ep_index, stream_id), db_addr);
 420         /* The CPU has better things to do at this point than wait for a
 421          * write-posting flush.  It'll get there soon enough.
 422          */
 423 }
 424
 425 /* Ring the doorbell for any rings with pending URBs */
 426 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
 427                 unsigned int slot_id,
 428                 unsigned int ep_index)
 429 {
 430         unsigned int stream_id;
 431         struct xhci_virt_ep *ep;
 432
 433         ep = &xhci->devs[slot_id]->eps[ep_index];
 434
 435         /* A ring has pending URBs if its TD list is not empty */
 436         if (!(ep->ep_state & EP_HAS_STREAMS)) {
 437                 if (!(list_empty(&ep->ring->td_list)))
 438                         xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
 439                 return;
 440         }
 441
 442         for (stream_id = 1; stream_id < ep->stream_info->num_streams;
 443                         stream_id++) {
 444                 struct xhci_stream_info *stream_info = ep->stream_info;
 445                 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
 446                         xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
 447                                                 stream_id);
 448         }
 449 }
 450
 451 /*
 452  * Find the segment that trb is in.  Start searching in start_seg.
 453  * If we must move past a segment that has a link TRB with a toggle cycle state
 454  * bit set, then we will toggle the value pointed at by cycle_state.
 455  */
 456 static struct xhci_segment *find_trb_seg(
 457                 struct xhci_segment *start_seg,
 458                 union xhci_trb  *trb, int *cycle_state)
 459 {
 460         struct xhci_segment *cur_seg = start_seg;
 461         struct xhci_generic_trb *generic_trb;
 462
 463         while (cur_seg->trbs > trb ||
 464                         &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
 465                 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
 466                 if (generic_trb->field[3] & cpu_to_le32(LINK_TOGGLE))
 467                         *cycle_state ^= 0x1;
 468                 cur_seg = cur_seg->next;
 469                 if (cur_seg == start_seg)
 470                         /* Looped over the entire list.  Oops! */
 471                         return NULL;
 472         }
 473         return cur_seg;
 474 }
 475
 476
 477 static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
 478                 unsigned int slot_id, unsigned int ep_index,
 479                 unsigned int stream_id)
 480 {
 481         struct xhci_virt_ep *ep;
 482
 483         ep = &xhci->devs[slot_id]->eps[ep_index];
 484         /* Common case: no streams */
 485         if (!(ep->ep_state & EP_HAS_STREAMS))
 486                 return ep->ring;
 487
 488         if (stream_id == 0) {
 489                 xhci_warn(xhci,
 490                                 "WARN: Slot ID %u, ep index %u has streams, "
 491                                 "but URB has no stream ID.\n",
 492                                 slot_id, ep_index);
 493                 return NULL;
 494         }
 495
 496         if (stream_id < ep->stream_info->num_streams)
 497                 return ep->stream_info->stream_rings[stream_id];
 498
 499         xhci_warn(xhci,
 500                         "WARN: Slot ID %u, ep index %u has "
 501                         "stream IDs 1 to %u allocated, "
 502                         "but stream ID %u is requested.\n",
 503                         slot_id, ep_index,
 504                         ep->stream_info->num_streams - 1,
 505                         stream_id);
 506         return NULL;
 507 }
 508
 509 /* Get the right ring for the given URB.
 510  * If the endpoint supports streams, boundary check the URB's stream ID.
 511  * If the endpoint doesn't support streams, return the singular endpoint ring.
 512  */
 513 static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
 514                 struct urb *urb)
 515 {
 516         return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
 517                 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
 518 }
 519
 520 /*
 521  * Move the xHC's endpoint ring dequeue pointer past cur_td.
 522  * Record the new state of the xHC's endpoint ring dequeue segment,
 523  * dequeue pointer, and new consumer cycle state in state.
 524  * Update our internal representation of the ring's dequeue pointer.
 525  *
 526  * We do this in three jumps:
 527  *  - First we update our new ring state to be the same as when the xHC stopped.
 528  *  - Then we traverse the ring to find the segment that contains
 529  *    the last TRB in the TD.  We toggle the xHC's new cycle state when we pass
 530  *    any link TRBs with the toggle cycle bit set.
 531  *  - Finally we move the dequeue state one TRB further, toggling the cycle bit
 532  *    if we've moved it past a link TRB with the toggle cycle bit set.
 533  *
 534  * Some of the uses of xhci_generic_trb are grotty, but if they're done
 535  * with correct __le32 accesses they should work fine.  Only users of this are
 536  * in here.
 537  */
 538 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
 539                 unsigned int slot_id, unsigned int ep_index,
 540                 unsigned int stream_id, struct xhci_td *cur_td,
 541                 struct xhci_dequeue_state *state)
 542 {
 543         struct xhci_virt_device *dev = xhci->devs[slot_id];
 544         struct xhci_ring *ep_ring;
 545         struct xhci_generic_trb *trb;
 546         struct xhci_ep_ctx *ep_ctx;
 547         dma_addr_t addr;
 548
 549         ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
 550                         ep_index, stream_id);
 551         if (!ep_ring) {
 552                 xhci_warn(xhci, "WARN can't find new dequeue state "
 553                                 "for invalid stream ID %u.\n",
 554                                 stream_id);
 555                 return;
 556         }
 557         state->new_cycle_state = 0;
 558         xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
 559         state->new_deq_seg = find_trb_seg(cur_td->start_seg,
 560                         dev->eps[ep_index].stopped_trb,
 561                         &state->new_cycle_state);
 562         if (!state->new_deq_seg) {
 563                 WARN_ON(1);
 564                 return;
 565         }
 566
 567         /* Dig out the cycle state saved by the xHC during the stop ep cmd */
 568         xhci_dbg(xhci, "Finding endpoint context\n");
 569         ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
 570         state->new_cycle_state = 0x1 & le64_to_cpu(ep_ctx->deq);
 571
 572         state->new_deq_ptr = cur_td->last_trb;
 573         xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
 574         state->new_deq_seg = find_trb_seg(state->new_deq_seg,
 575                         state->new_deq_ptr,
 576                         &state->new_cycle_state);
 577         if (!state->new_deq_seg) {
 578                 WARN_ON(1);
 579                 return;
 580         }
 581
 582         trb = &state->new_deq_ptr->generic;
 583         if (TRB_TYPE_LINK_LE32(trb->field[3]) &&
 584             (trb->field[3] & cpu_to_le32(LINK_TOGGLE)))
 585                 state->new_cycle_state ^= 0x1;
 586         next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
 587
 588         /*
 589          * If there is only one segment in a ring, find_trb_seg()'s while loop
 590          * will not run, and it will return before it has a chance to see if it
 591          * needs to toggle the cycle bit.  It can't tell if the stalled transfer
 592          * ended just before the link TRB on a one-segment ring, or if the TD
 593          * wrapped around the top of the ring, because it doesn't have the TD in
 594          * question.  Look for the one-segment case where stalled TRB's address
 595          * is greater than the new dequeue pointer address.
 596          */
 597         if (ep_ring->first_seg == ep_ring->first_seg->next &&
 598                         state->new_deq_ptr < dev->eps[ep_index].stopped_trb)
 599                 state->new_cycle_state ^= 0x1;
 600         xhci_dbg(xhci, "Cycle state = 0x%x\n", state->new_cycle_state);
 601
 602         /* Don't update the ring cycle state for the producer (us). */
 603         xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
 604                         state->new_deq_seg);
 605         addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
 606         xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
 607                         (unsigned long long) addr);
 608 }
 609
 610 /* flip_cycle means flip the cycle bit of all but the first and last TRB.
 611  * (The last TRB actually points to the ring enqueue pointer, which is not part
 612  * of this TD.)  This is used to remove partially enqueued isoc TDs from a ring.
 613  */
 614 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
 615                 struct xhci_td *cur_td, bool flip_cycle)
 616 {
 617         struct xhci_segment *cur_seg;
 618         union xhci_trb *cur_trb;
 619
 620         for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
 621                         true;
 622                         next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
 623                 if (TRB_TYPE_LINK_LE32(cur_trb->generic.field[3])) {
 624                         /* Unchain any chained Link TRBs, but
 625                          * leave the pointers intact.
 626                          */
 627                         cur_trb->generic.field[3] &= cpu_to_le32(~TRB_CHAIN);
 628                         /* Flip the cycle bit (link TRBs can't be the first
 629                          * or last TRB).
 630                          */
 631                         if (flip_cycle)
 632                                 cur_trb->generic.field[3] ^=
 633                                         cpu_to_le32(TRB_CYCLE);
 634                         xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
 635                         xhci_dbg(xhci, "Address = %p (0x%llx dma); "
 636                                         "in seg %p (0x%llx dma)\n",
 637                                         cur_trb,
 638                                         (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
 639                                         cur_seg,
 640                                         (unsigned long long)cur_seg->dma);
 641                 } else {
 642                         cur_trb->generic.field[0] = 0;
 643                         cur_trb->generic.field[1] = 0;
 644                         cur_trb->generic.field[2] = 0;
 645                         /* Preserve only the cycle bit of this TRB */
 646                         cur_trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
 647                         /* Flip the cycle bit except on the first or last TRB */
 648                         if (flip_cycle && cur_trb != cur_td->first_trb &&
 649                                         cur_trb != cur_td->last_trb)
 650                                 cur_trb->generic.field[3] ^=
 651                                         cpu_to_le32(TRB_CYCLE);
 652                         cur_trb->generic.field[3] |= cpu_to_le32(
 653                                 TRB_TYPE(TRB_TR_NOOP));
 654                         xhci_dbg(xhci, "TRB to noop at offset 0x%llx\n",
 655                                         (unsigned long long)
 656                                         xhci_trb_virt_to_dma(cur_seg, cur_trb));
 657                 }
 658                 if (cur_trb == cur_td->last_trb)
 659                         break;
 660         }
 661 }
 662
 663 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
 664                 unsigned int ep_index, unsigned int stream_id,
 665                 struct xhci_segment *deq_seg,
 666                 union xhci_trb *deq_ptr, u32 cycle_state);
 667
 668 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
 669                 unsigned int slot_id, unsigned int ep_index,
 670                 unsigned int stream_id,
 671                 struct xhci_dequeue_state *deq_state)
 672 {
 673         struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
 674
 675         xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
 676                         "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
 677                         deq_state->new_deq_seg,
 678                         (unsigned long long)deq_state->new_deq_seg->dma,
 679                         deq_state->new_deq_ptr,
 680                         (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
 681                         deq_state->new_cycle_state);
 682         queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
 683                         deq_state->new_deq_seg,
 684                         deq_state->new_deq_ptr,
 685                         (u32) deq_state->new_cycle_state);
 686         /* Stop the TD queueing code from ringing the doorbell until
 687          * this command completes.  The HC won't set the dequeue pointer
 688          * if the ring is running, and ringing the doorbell starts the
 689          * ring running.
 690          */
 691         ep->ep_state |= SET_DEQ_PENDING;
 692 }
 693
 694 static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
 695                 struct xhci_virt_ep *ep)
 696 {
 697         ep->ep_state &= ~EP_HALT_PENDING;
 698         /* Can't del_timer_sync in interrupt, so we attempt to cancel.  If the
 699          * timer is running on another CPU, we don't decrement stop_cmds_pending
 700          * (since we didn't successfully stop the watchdog timer).
 701          */
 702         if (del_timer(&ep->stop_cmd_timer))
 703                 ep->stop_cmds_pending--;
 704 }
 705
 706 /* Must be called with xhci->lock held in interrupt context */
 707 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
 708                 struct xhci_td *cur_td, int status, char *adjective)
 709 {
 710         struct usb_hcd *hcd;
 711         struct urb      *urb;
 712         struct urb_priv *urb_priv;
 713
 714         urb = cur_td->urb;
 715         urb_priv = urb->hcpriv;
 716         urb_priv->td_cnt++;
 717         hcd = bus_to_hcd(urb->dev->bus);
 718
 719         /* Only giveback urb when this is the last td in urb */
 720         if (urb_priv->td_cnt == urb_priv->length) {
 721                 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
 722                         xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
 723                         if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
 724                                 if (xhci->quirks & XHCI_AMD_PLL_FIX)
 725                                         usb_amd_quirk_pll_enable();
 726                         }
 727                 }
 728                 usb_hcd_unlink_urb_from_ep(hcd, urb);
 729
 730                 spin_unlock(&xhci->lock);
 731                 usb_hcd_giveback_urb(hcd, urb, status);
 732                 xhci_urb_free_priv(xhci, urb_priv);
 733                 spin_lock(&xhci->lock);
 734         }
 735 }
 736
 737 /*
 738  * When we get a command completion for a Stop Endpoint Command, we need to
 739  * unlink any cancelled TDs from the ring.  There are two ways to do that:
 740  *
 741  *  1. If the HW was in the middle of processing the TD that needs to be
 742  *     cancelled, then we must move the ring's dequeue pointer past the last TRB
 743  *     in the TD with a Set Dequeue Pointer Command.
 744  *  2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
 745  *     bit cleared) so that the HW will skip over them.
 746  */
 747 static void handle_stopped_endpoint(struct xhci_hcd *xhci,
 748                 union xhci_trb *trb, struct xhci_event_cmd *event)
 749 {
 750         unsigned int slot_id;
 751         unsigned int ep_index;
 752         struct xhci_virt_device *virt_dev;
 753         struct xhci_ring *ep_ring;
 754         struct xhci_virt_ep *ep;
 755         struct list_head *entry;
 756         struct xhci_td *cur_td = NULL;
 757         struct xhci_td *last_unlinked_td;
 758
 759         struct xhci_dequeue_state deq_state;
 760
 761         if (unlikely(TRB_TO_SUSPEND_PORT(
 762                              le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])))) {
 763                 slot_id = TRB_TO_SLOT_ID(
 764                         le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
 765                 virt_dev = xhci->devs[slot_id];
 766                 if (virt_dev)
 767                         handle_cmd_in_cmd_wait_list(xhci, virt_dev,
 768                                 event);
 769                 else
 770                         xhci_warn(xhci, "Stop endpoint command "
 771                                 "completion for disabled slot %u\n",
 772                                 slot_id);
 773                 return;
 774         }
 775
 776         memset(&deq_state, 0, sizeof(deq_state));
 777         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
 778         ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
 779         ep = &xhci->devs[slot_id]->eps[ep_index];
 780
 781         if (list_empty(&ep->cancelled_td_list)) {
 782                 xhci_stop_watchdog_timer_in_irq(xhci, ep);
 783                 ep->stopped_td = NULL;
 784                 ep->stopped_trb = NULL;
 785                 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
 786                 return;
 787         }
 788
 789         /* Fix up the ep ring first, so HW stops executing cancelled TDs.
 790          * We have the xHCI lock, so nothing can modify this list until we drop
 791          * it.  We're also in the event handler, so we can't get re-interrupted
 792          * if another Stop Endpoint command completes
 793          */
 794         list_for_each(entry, &ep->cancelled_td_list) {
 795                 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
 796                 xhci_dbg(xhci, "Removing canceled TD starting at 0x%llx (dma).\n",
 797                                 (unsigned long long)xhci_trb_virt_to_dma(
 798                                         cur_td->start_seg, cur_td->first_trb));
 799                 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
 800                 if (!ep_ring) {
 801                         /* This shouldn't happen unless a driver is mucking
 802                          * with the stream ID after submission.  This will
 803                          * leave the TD on the hardware ring, and the hardware
 804                          * will try to execute it, and may access a buffer
 805                          * that has already been freed.  In the best case, the
 806                          * hardware will execute it, and the event handler will
 807                          * ignore the completion event for that TD, since it was
 808                          * removed from the td_list for that endpoint.  In
 809                          * short, don't muck with the stream ID after
 810                          * submission.
 811                          */
 812                         xhci_warn(xhci, "WARN Cancelled URB %p "
 813                                         "has invalid stream ID %u.\n",
 814                                         cur_td->urb,
 815                                         cur_td->urb->stream_id);
 816                         goto remove_finished_td;
 817                 }
 818                 /*
 819                  * If we stopped on the TD we need to cancel, then we have to
 820                  * move the xHC endpoint ring dequeue pointer past this TD.
 821                  */
 822                 if (cur_td == ep->stopped_td)
 823                         xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
 824                                         cur_td->urb->stream_id,
 825                                         cur_td, &deq_state);
 826                 else
 827                         td_to_noop(xhci, ep_ring, cur_td, false);
 828 remove_finished_td:
 829                 /*
 830                  * The event handler won't see a completion for this TD anymore,
 831                  * so remove it from the endpoint ring's TD list.  Keep it in
 832                  * the cancelled TD list for URB completion later.
 833                  */
 834                 list_del_init(&cur_td->td_list);
 835         }
 836         last_unlinked_td = cur_td;
 837         xhci_stop_watchdog_timer_in_irq(xhci, ep);
 838
 839         /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
 840         if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
 841                 xhci_queue_new_dequeue_state(xhci,
 842                                 slot_id, ep_index,
 843                                 ep->stopped_td->urb->stream_id,
 844                                 &deq_state);
 845                 xhci_ring_cmd_db(xhci);
 846         } else {
 847                 /* Otherwise ring the doorbell(s) to restart queued transfers */
 848                 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
 849         }
 850         ep->stopped_td = NULL;
 851         ep->stopped_trb = NULL;
 852
 853         /*
 854          * Drop the lock and complete the URBs in the cancelled TD list.
 855          * New TDs to be cancelled might be added to the end of the list before
 856          * we can complete all the URBs for the TDs we already unlinked.
 857          * So stop when we've completed the URB for the last TD we unlinked.
 858          */
 859         do {
 860                 cur_td = list_entry(ep->cancelled_td_list.next,
 861                                 struct xhci_td, cancelled_td_list);
 862                 list_del_init(&cur_td->cancelled_td_list);
 863
 864                 /* Clean up the cancelled URB */
 865                 /* Doesn't matter what we pass for status, since the core will
 866                  * just overwrite it (because the URB has been unlinked).
 867                  */
 868                 xhci_giveback_urb_in_irq(xhci, cur_td, 0, "cancelled");
 869
 870                 /* Stop processing the cancelled list if the watchdog timer is
 871                  * running.
 872                  */
 873                 if (xhci->xhc_state & XHCI_STATE_DYING)
 874                         return;
 875         } while (cur_td != last_unlinked_td);
 876
 877         /* Return to the event handler with xhci->lock re-acquired */
 878 }
 879
 880 /* Watchdog timer function for when a stop endpoint command fails to complete.
 881  * In this case, we assume the host controller is broken or dying or dead.  The
 882  * host may still be completing some other events, so we have to be careful to
 883  * let the event ring handler and the URB dequeueing/enqueueing functions know
 884  * through xhci->state.
 885  *
 886  * The timer may also fire if the host takes a very long time to respond to the
 887  * command, and the stop endpoint command completion handler cannot delete the
 888  * timer before the timer function is called.  Another endpoint cancellation may
 889  * sneak in before the timer function can grab the lock, and that may queue
 890  * another stop endpoint command and add the timer back.  So we cannot use a
 891  * simple flag to say whether there is a pending stop endpoint command for a
 892  * particular endpoint.
 893  *
 894  * Instead we use a combination of that flag and a counter for the number of
 895  * pending stop endpoint commands.  If the timer is the tail end of the last
 896  * stop endpoint command, and the endpoint's command is still pending, we assume
 897  * the host is dying.
 898  */
 899 void xhci_stop_endpoint_command_watchdog(unsigned long arg)
 900 {
 901         struct xhci_hcd *xhci;
 902         struct xhci_virt_ep *ep;
 903         struct xhci_virt_ep *temp_ep;
 904         struct xhci_ring *ring;
 905         struct xhci_td *cur_td;
 906         int ret, i, j;
 907         unsigned long flags;
 908
 909         ep = (struct xhci_virt_ep *) arg;
 910         xhci = ep->xhci;
 911
 912         spin_lock_irqsave(&xhci->lock, flags);
 913
 914         ep->stop_cmds_pending--;
 915         if (xhci->xhc_state & XHCI_STATE_DYING) {
 916                 xhci_dbg(xhci, "Stop EP timer ran, but another timer marked "
 917                                 "xHCI as DYING, exiting.\n");
 918                 spin_unlock_irqrestore(&xhci->lock, flags);
 919                 return;
 920         }
 921         if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
 922                 xhci_dbg(xhci, "Stop EP timer ran, but no command pending, "
 923                                 "exiting.\n");
 924                 spin_unlock_irqrestore(&xhci->lock, flags);
 925                 return;
 926         }
 927
 928         xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
 929         xhci_warn(xhci, "Assuming host is dying, halting host.\n");
 930         /* Oops, HC is dead or dying or at least not responding to the stop
 931          * endpoint command.
 932          */
 933         xhci->xhc_state |= XHCI_STATE_DYING;
 934         /* Disable interrupts from the host controller and start halting it */
 935         xhci_quiesce(xhci);
 936         spin_unlock_irqrestore(&xhci->lock, flags);
 937
 938         ret = xhci_halt(xhci);
 939
 940         spin_lock_irqsave(&xhci->lock, flags);
 941         if (ret < 0) {
 942                 /* This is bad; the host is not responding to commands and it's
 943                  * not allowing itself to be halted.  At least interrupts are
 944                  * disabled. If we call usb_hc_died(), it will attempt to
 945                  * disconnect all device drivers under this host.  Those
 946                  * disconnect() methods will wait for all URBs to be unlinked,
 947                  * so we must complete them.
 948                  */
 949                 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
 950                 xhci_warn(xhci, "Completing active URBs anyway.\n");
 951                 /* We could turn all TDs on the rings to no-ops.  This won't
 952                  * help if the host has cached part of the ring, and is slow if
 953                  * we want to preserve the cycle bit.  Skip it and hope the host
 954                  * doesn't touch the memory.
 955                  */
 956         }
 957         for (i = 0; i < MAX_HC_SLOTS; i++) {
 958                 if (!xhci->devs[i])
 959                         continue;
 960                 for (j = 0; j < 31; j++) {
 961                         temp_ep = &xhci->devs[i]->eps[j];
 962                         ring = temp_ep->ring;
 963                         if (!ring)
 964                                 continue;
 965                         xhci_dbg(xhci, "Killing URBs for slot ID %u, "
 966                                         "ep index %u\n", i, j);
 967                         while (!list_empty(&ring->td_list)) {
 968                                 cur_td = list_first_entry(&ring->td_list,
 969                                                 struct xhci_td,
 970                                                 td_list);
 971                                 list_del_init(&cur_td->td_list);
 972                                 if (!list_empty(&cur_td->cancelled_td_list))
 973                                         list_del_init(&cur_td->cancelled_td_list);
 974                                 xhci_giveback_urb_in_irq(xhci, cur_td,
 975                                                 -ESHUTDOWN, "killed");
 976                         }
 977                         while (!list_empty(&temp_ep->cancelled_td_list)) {
 978                                 cur_td = list_first_entry(
 979                                                 &temp_ep->cancelled_td_list,
 980                                                 struct xhci_td,
 981                                                 cancelled_td_list);
 982                                 list_del_init(&cur_td->cancelled_td_list);
 983                                 xhci_giveback_urb_in_irq(xhci, cur_td,
 984                                                 -ESHUTDOWN, "killed");
 985                         }
 986                 }
 987         }
 988         spin_unlock_irqrestore(&xhci->lock, flags);
 989         xhci_dbg(xhci, "Calling usb_hc_died()\n");
 990         usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
 991         xhci_dbg(xhci, "xHCI host controller is dead.\n");
 992 }
 993
 994
 995 static void update_ring_for_set_deq_completion(struct xhci_hcd *xhci,
 996                 struct xhci_virt_device *dev,
 997                 struct xhci_ring *ep_ring,
 998                 unsigned int ep_index)
 999 {
1000         union xhci_trb *dequeue_temp;
1001         int num_trbs_free_temp;
1002         bool revert = false;
1003
1004         num_trbs_free_temp = ep_ring->num_trbs_free;
1005         dequeue_temp = ep_ring->dequeue;
1006
1007         /* If we get two back-to-back stalls, and the first stalled transfer
1008          * ends just before a link TRB, the dequeue pointer will be left on
1009          * the link TRB by the code in the while loop.  So we have to update
1010          * the dequeue pointer one segment further, or we'll jump off
1011          * the segment into la-la-land.
1012          */
1013         if (last_trb(xhci, ep_ring, ep_ring->deq_seg, ep_ring->dequeue)) {
1014                 ep_ring->deq_seg = ep_ring->deq_seg->next;
1015                 ep_ring->dequeue = ep_ring->deq_seg->trbs;
1016         }
1017
1018         while (ep_ring->dequeue != dev->eps[ep_index].queued_deq_ptr) {
1019                 /* We have more usable TRBs */
1020                 ep_ring->num_trbs_free++;
1021                 ep_ring->dequeue++;
1022                 if (last_trb(xhci, ep_ring, ep_ring->deq_seg,
1023                                 ep_ring->dequeue)) {
1024                         if (ep_ring->dequeue ==
1025                                         dev->eps[ep_index].queued_deq_ptr)
1026                                 break;
1027                         ep_ring->deq_seg = ep_ring->deq_seg->next;
1028                         ep_ring->dequeue = ep_ring->deq_seg->trbs;
1029                 }
1030                 if (ep_ring->dequeue == dequeue_temp) {
1031                         revert = true;
1032                         break;
1033                 }
1034         }
1035
1036         if (revert) {
1037                 xhci_dbg(xhci, "Unable to find new dequeue pointer\n");
1038                 ep_ring->num_trbs_free = num_trbs_free_temp;
1039         }
1040 }
1041
1042 /*
1043  * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
1044  * we need to clear the set deq pending flag in the endpoint ring state, so that
1045  * the TD queueing code can ring the doorbell again.  We also need to ring the
1046  * endpoint doorbell to restart the ring, but only if there aren't more
1047  * cancellations pending.
1048  */
1049 static void handle_set_deq_completion(struct xhci_hcd *xhci,
1050                 struct xhci_event_cmd *event,
1051                 union xhci_trb *trb)
1052 {
1053         unsigned int slot_id;
1054         unsigned int ep_index;
1055         unsigned int stream_id;
1056         struct xhci_ring *ep_ring;
1057         struct xhci_virt_device *dev;
1058         struct xhci_ep_ctx *ep_ctx;
1059         struct xhci_slot_ctx *slot_ctx;
1060
1061         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
1062         ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1063         stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
1064         dev = xhci->devs[slot_id];
1065
1066         ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
1067         if (!ep_ring) {
1068                 xhci_warn(xhci, "WARN Set TR deq ptr command for "
1069                                 "freed stream ID %u\n",
1070                                 stream_id);
1071                 /* XXX: Harmless??? */
1072                 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1073                 return;
1074         }
1075
1076         ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
1077         slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
1078
1079         if (GET_COMP_CODE(le32_to_cpu(event->status)) != COMP_SUCCESS) {
1080                 unsigned int ep_state;
1081                 unsigned int slot_state;
1082
1083                 switch (GET_COMP_CODE(le32_to_cpu(event->status))) {
1084                 case COMP_TRB_ERR:
1085                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
1086                                         "of stream ID configuration\n");
1087                         break;
1088                 case COMP_CTX_STATE:
1089                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
1090                                         "to incorrect slot or ep state.\n");
1091                         ep_state = le32_to_cpu(ep_ctx->ep_info);
1092                         ep_state &= EP_STATE_MASK;
1093                         slot_state = le32_to_cpu(slot_ctx->dev_state);
1094                         slot_state = GET_SLOT_STATE(slot_state);
1095                         xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
1096                                         slot_state, ep_state);
1097                         break;
1098                 case COMP_EBADSLT:
1099                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
1100                                         "slot %u was not enabled.\n", slot_id);
1101                         break;
1102                 default:
1103                         xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
1104                                         "completion code of %u.\n",
1105                                   GET_COMP_CODE(le32_to_cpu(event->status)));
1106                         break;
1107                 }
1108                 /* OK what do we do now?  The endpoint state is hosed, and we
1109                  * should never get to this point if the synchronization between
1110                  * queueing, and endpoint state are correct.  This might happen
1111                  * if the device gets disconnected after we've finished
1112                  * cancelling URBs, which might not be an error...
1113                  */
1114         } else {
1115                 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
1116                          le64_to_cpu(ep_ctx->deq));
1117                 if (xhci_trb_virt_to_dma(dev->eps[ep_index].queued_deq_seg,
1118                                          dev->eps[ep_index].queued_deq_ptr) ==
1119                     (le64_to_cpu(ep_ctx->deq) & ~(EP_CTX_CYCLE_MASK))) {
1120                         /* Update the ring's dequeue segment and dequeue pointer
1121                          * to reflect the new position.
1122                          */
1123                         update_ring_for_set_deq_completion(xhci, dev,
1124                                 ep_ring, ep_index);
1125                 } else {
1126                         xhci_warn(xhci, "Mismatch between completed Set TR Deq "
1127                                         "Ptr command & xHCI internal state.\n");
1128                         xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
1129                                         dev->eps[ep_index].queued_deq_seg,
1130                                         dev->eps[ep_index].queued_deq_ptr);
1131                 }
1132         }
1133
1134         dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1135         dev->eps[ep_index].queued_deq_seg = NULL;
1136         dev->eps[ep_index].queued_deq_ptr = NULL;
1137         /* Restart any rings with pending URBs */
1138         ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1139 }
1140
1141 static void handle_reset_ep_completion(struct xhci_hcd *xhci,
1142                 struct xhci_event_cmd *event,
1143                 union xhci_trb *trb)
1144 {
1145         int slot_id;
1146         unsigned int ep_index;
1147
1148         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
1149         ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1150         /* This command will only fail if the endpoint wasn't halted,
1151          * but we don't care.
1152          */
1153         xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
1154                  GET_COMP_CODE(le32_to_cpu(event->status)));
1155
1156         /* HW with the reset endpoint quirk needs to have a configure endpoint
1157          * command complete before the endpoint can be used.  Queue that here
1158          * because the HW can't handle two commands being queued in a row.
1159          */
1160         if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
1161                 xhci_dbg(xhci, "Queueing configure endpoint command\n");
1162                 xhci_queue_configure_endpoint(xhci,
1163                                 xhci->devs[slot_id]->in_ctx->dma, slot_id,
1164                                 false);
1165                 xhci_ring_cmd_db(xhci);
1166         } else {
1167                 /* Clear our internal halted state and restart the ring(s) */
1168                 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
1169                 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1170         }
1171 }
1172
1173 /* Complete the command and detele it from the devcie's command queue.
1174  */
1175 static void xhci_complete_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1176                 struct xhci_command *command, u32 status)
1177 {
1178         command->status = status;
1179         list_del(&command->cmd_list);
1180         if (command->completion)
1181                 complete(command->completion);
1182         else
1183                 xhci_free_command(xhci, command);
1184 }
1185
1186
1187 /* Check to see if a command in the device's command queue matches this one.
1188  * Signal the completion or free the command, and return 1.  Return 0 if the
1189  * completed command isn't at the head of the command list.
1190  */
1191 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1192                 struct xhci_virt_device *virt_dev,
1193                 struct xhci_event_cmd *event)
1194 {
1195         struct xhci_command *command;
1196
1197         if (list_empty(&virt_dev->cmd_list))
1198                 return 0;
1199
1200         command = list_entry(virt_dev->cmd_list.next,
1201                         struct xhci_command, cmd_list);
1202         if (xhci->cmd_ring->dequeue != command->command_trb)
1203                 return 0;
1204
1205         xhci_complete_cmd_in_cmd_wait_list(xhci, command,
1206                         GET_COMP_CODE(le32_to_cpu(event->status)));
1207         return 1;
1208 }
1209
1210 /*
1211  * Finding the command trb need to be cancelled and modifying it to
1212  * NO OP command. And if the command is in device's command wait
1213  * list, finishing and freeing it.
1214  *
1215  * If we can't find the command trb, we think it had already been
1216  * executed.
1217  */
1218 static void xhci_cmd_to_noop(struct xhci_hcd *xhci, struct xhci_cd *cur_cd)
1219 {
1220         struct xhci_segment *cur_seg;
1221         union xhci_trb *cmd_trb;
1222         u32 cycle_state;
1223
1224         if (xhci->cmd_ring->dequeue == xhci->cmd_ring->enqueue)
1225                 return;
1226
1227         /* find the current segment of command ring */
1228         cur_seg = find_trb_seg(xhci->cmd_ring->first_seg,
1229                         xhci->cmd_ring->dequeue, &cycle_state);
1230
1231         if (!cur_seg) {
1232                 xhci_warn(xhci, "Command ring mismatch, dequeue = %p %llx (dma)\n",
1233                                 xhci->cmd_ring->dequeue,
1234                                 (unsigned long long)
1235                                 xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1236                                         xhci->cmd_ring->dequeue));
1237                 xhci_debug_ring(xhci, xhci->cmd_ring);
1238                 xhci_dbg_ring_ptrs(xhci, xhci->cmd_ring);
1239                 return;
1240         }
1241
1242         /* find the command trb matched by cd from command ring */
1243         for (cmd_trb = xhci->cmd_ring->dequeue;
1244                         cmd_trb != xhci->cmd_ring->enqueue;
1245                         next_trb(xhci, xhci->cmd_ring, &cur_seg, &cmd_trb)) {
1246                 /* If the trb is link trb, continue */
1247                 if (TRB_TYPE_LINK_LE32(cmd_trb->generic.field[3]))
1248                         continue;
1249
1250                 if (cur_cd->cmd_trb == cmd_trb) {
1251
1252                         /* If the command in device's command list, we should
1253                          * finish it and free the command structure.
1254                          */
1255                         if (cur_cd->command)
1256                                 xhci_complete_cmd_in_cmd_wait_list(xhci,
1257                                         cur_cd->command, COMP_CMD_STOP);
1258
1259                         /* get cycle state from the origin command trb */
1260                         cycle_state = le32_to_cpu(cmd_trb->generic.field[3])
1261                                 & TRB_CYCLE;
1262
1263                         /* modify the command trb to NO OP command */
1264                         cmd_trb->generic.field[0] = 0;
1265                         cmd_trb->generic.field[1] = 0;
1266                         cmd_trb->generic.field[2] = 0;
1267                         cmd_trb->generic.field[3] = cpu_to_le32(
1268                                         TRB_TYPE(TRB_CMD_NOOP) | cycle_state);
1269                         break;
1270                 }
1271         }
1272 }
1273
1274 static void xhci_cancel_cmd_in_cd_list(struct xhci_hcd *xhci)
1275 {
1276         struct xhci_cd *cur_cd, *next_cd;
1277
1278         if (list_empty(&xhci->cancel_cmd_list))
1279                 return;
1280
1281         list_for_each_entry_safe(cur_cd, next_cd,
1282                         &xhci->cancel_cmd_list, cancel_cmd_list) {
1283                 xhci_cmd_to_noop(xhci, cur_cd);
1284                 list_del(&cur_cd->cancel_cmd_list);
1285                 kfree(cur_cd);
1286         }
1287 }
1288
1289 /*
1290  * traversing the cancel_cmd_list. If the command descriptor according
1291  * to cmd_trb is found, the function free it and return 1, otherwise
1292  * return 0.
1293  */
1294 static int xhci_search_cmd_trb_in_cd_list(struct xhci_hcd *xhci,
1295                 union xhci_trb *cmd_trb)
1296 {
1297         struct xhci_cd *cur_cd, *next_cd;
1298
1299         if (list_empty(&xhci->cancel_cmd_list))
1300                 return 0;
1301
1302         list_for_each_entry_safe(cur_cd, next_cd,
1303                         &xhci->cancel_cmd_list, cancel_cmd_list) {
1304                 if (cur_cd->cmd_trb == cmd_trb) {
1305                         if (cur_cd->command)
1306                                 xhci_complete_cmd_in_cmd_wait_list(xhci,
1307                                         cur_cd->command, COMP_CMD_STOP);
1308                         list_del(&cur_cd->cancel_cmd_list);
1309                         kfree(cur_cd);
1310                         return 1;
1311                 }
1312         }
1313
1314         return 0;
1315 }
1316
1317 /*
1318  * If the cmd_trb_comp_code is COMP_CMD_ABORT, we just check whether the
1319  * trb pointed by the command ring dequeue pointer is the trb we want to
1320  * cancel or not. And if the cmd_trb_comp_code is COMP_CMD_STOP, we will
1321  * traverse the cancel_cmd_list to trun the all of the commands according
1322  * to command descriptor to NO-OP trb.
1323  */
1324 static int handle_stopped_cmd_ring(struct xhci_hcd *xhci,
1325                 int cmd_trb_comp_code)
1326 {
1327         int cur_trb_is_good = 0;
1328
1329         /* Searching the cmd trb pointed by the command ring dequeue
1330          * pointer in command descriptor list. If it is found, free it.
1331          */
1332         cur_trb_is_good = xhci_search_cmd_trb_in_cd_list(xhci,
1333                         xhci->cmd_ring->dequeue);
1334
1335         if (cmd_trb_comp_code == COMP_CMD_ABORT)
1336                 xhci->cmd_ring_state = CMD_RING_STATE_STOPPED;
1337         else if (cmd_trb_comp_code == COMP_CMD_STOP) {
1338                 /* traversing the cancel_cmd_list and canceling
1339                  * the command according to command descriptor
1340                  */
1341                 xhci_cancel_cmd_in_cd_list(xhci);
1342
1343                 xhci->cmd_ring_state = CMD_RING_STATE_RUNNING;
1344                 /*
1345                  * ring command ring doorbell again to restart the
1346                  * command ring
1347                  */
1348                 if (xhci->cmd_ring->dequeue != xhci->cmd_ring->enqueue)
1349                         xhci_ring_cmd_db(xhci);
1350         }
1351         return cur_trb_is_good;
1352 }
1353
1354 static void handle_cmd_completion(struct xhci_hcd *xhci,
1355                 struct xhci_event_cmd *event)
1356 {
1357         int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1358         u64 cmd_dma;
1359         dma_addr_t cmd_dequeue_dma;
1360         struct xhci_input_control_ctx *ctrl_ctx;
1361         struct xhci_virt_device *virt_dev;
1362         unsigned int ep_index;
1363         struct xhci_ring *ep_ring;
1364         unsigned int ep_state;
1365
1366         cmd_dma = le64_to_cpu(event->cmd_trb);
1367         cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1368                         xhci->cmd_ring->dequeue);
1369         /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1370         if (cmd_dequeue_dma == 0) {
1371                 xhci->error_bitmask |= 1 << 4;
1372                 return;
1373         }
1374         /* Does the DMA address match our internal dequeue pointer address? */
1375         if (cmd_dma != (u64) cmd_dequeue_dma) {
1376                 xhci->error_bitmask |= 1 << 5;
1377                 return;
1378         }
1379
1380         if ((GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_CMD_ABORT) ||
1381                 (GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_CMD_STOP)) {
1382                 /* If the return value is 0, we think the trb pointed by
1383                  * command ring dequeue pointer is a good trb. The good
1384                  * trb means we don't want to cancel the trb, but it have
1385                  * been stopped by host. So we should handle it normally.
1386                  * Otherwise, driver should invoke inc_deq() and return.
1387                  */
1388                 if (handle_stopped_cmd_ring(xhci,
1389                                 GET_COMP_CODE(le32_to_cpu(event->status)))) {
1390                         inc_deq(xhci, xhci->cmd_ring);
1391                         return;
1392                 }
1393         }
1394
1395         switch (le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])
1396                 & TRB_TYPE_BITMASK) {
1397         case TRB_TYPE(TRB_ENABLE_SLOT):
1398                 if (GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_SUCCESS)
1399                         xhci->slot_id = slot_id;
1400                 else
1401                         xhci->slot_id = 0;
1402                 complete(&xhci->addr_dev);
1403                 break;
1404         case TRB_TYPE(TRB_DISABLE_SLOT):
1405                 if (xhci->devs[slot_id]) {
1406                         if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1407                                 /* Delete default control endpoint resources */
1408                                 xhci_free_device_endpoint_resources(xhci,
1409                                                 xhci->devs[slot_id], true);
1410                         xhci_free_virt_device(xhci, slot_id);
1411                 }
1412                 break;
1413         case TRB_TYPE(TRB_CONFIG_EP):
1414                 virt_dev = xhci->devs[slot_id];
1415                 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1416                         break;
1417                 /*
1418                  * Configure endpoint commands can come from the USB core
1419                  * configuration or alt setting changes, or because the HW
1420                  * needed an extra configure endpoint command after a reset
1421                  * endpoint command or streams were being configured.
1422                  * If the command was for a halted endpoint, the xHCI driver
1423                  * is not waiting on the configure endpoint command.
1424                  */
1425                 ctrl_ctx = xhci_get_input_control_ctx(xhci,
1426                                 virt_dev->in_ctx);
1427                 /* Input ctx add_flags are the endpoint index plus one */
1428                 ep_index = xhci_last_valid_endpoint(le32_to_cpu(ctrl_ctx->add_flags)) - 1;
1429                 /* A usb_set_interface() call directly after clearing a halted
1430                  * condition may race on this quirky hardware.  Not worth
1431                  * worrying about, since this is prototype hardware.  Not sure
1432                  * if this will work for streams, but streams support was
1433                  * untested on this prototype.
1434                  */
1435                 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1436                                 ep_index != (unsigned int) -1 &&
1437                     le32_to_cpu(ctrl_ctx->add_flags) - SLOT_FLAG ==
1438                     le32_to_cpu(ctrl_ctx->drop_flags)) {
1439                         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1440                         ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
1441                         if (!(ep_state & EP_HALTED))
1442                                 goto bandwidth_change;
1443                         xhci_dbg(xhci, "Completed config ep cmd - "
1444                                         "last ep index = %d, state = %d\n",
1445                                         ep_index, ep_state);
1446                         /* Clear internal halted state and restart ring(s) */
1447                         xhci->devs[slot_id]->eps[ep_index].ep_state &=
1448                                 ~EP_HALTED;
1449                         ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1450                         break;
1451                 }
1452 bandwidth_change:
1453                 xhci_dbg(xhci, "Completed config ep cmd\n");
1454                 xhci->devs[slot_id]->cmd_status =
1455                         GET_COMP_CODE(le32_to_cpu(event->status));
1456                 complete(&xhci->devs[slot_id]->cmd_completion);
1457                 break;
1458         case TRB_TYPE(TRB_EVAL_CONTEXT):
1459                 virt_dev = xhci->devs[slot_id];
1460                 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1461                         break;
1462                 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1463                 complete(&xhci->devs[slot_id]->cmd_completion);
1464                 break;
1465         case TRB_TYPE(TRB_ADDR_DEV):
1466                 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1467                 complete(&xhci->addr_dev);
1468                 break;
1469         case TRB_TYPE(TRB_STOP_RING):
1470                 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue, event);
1471                 break;
1472         case TRB_TYPE(TRB_SET_DEQ):
1473                 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
1474                 break;
1475         case TRB_TYPE(TRB_CMD_NOOP):
1476                 break;
1477         case TRB_TYPE(TRB_RESET_EP):
1478                 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
1479                 break;
1480         case TRB_TYPE(TRB_RESET_DEV):
1481                 xhci_dbg(xhci, "Completed reset device command.\n");
1482                 slot_id = TRB_TO_SLOT_ID(
1483                         le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
1484                 virt_dev = xhci->devs[slot_id];
1485                 if (virt_dev)
1486                         handle_cmd_in_cmd_wait_list(xhci, virt_dev, event);
1487                 else
1488                         xhci_warn(xhci, "Reset device command completion "
1489                                         "for disabled slot %u\n", slot_id);
1490                 break;
1491         case TRB_TYPE(TRB_NEC_GET_FW):
1492                 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1493                         xhci->error_bitmask |= 1 << 6;
1494                         break;
1495                 }
1496                 xhci_dbg(xhci, "NEC firmware version %2x.%02x\n",
1497                          NEC_FW_MAJOR(le32_to_cpu(event->status)),
1498                          NEC_FW_MINOR(le32_to_cpu(event->status)));
1499                 break;
1500         default:
1501                 /* Skip over unknown commands on the event ring */
1502                 xhci->error_bitmask |= 1 << 6;
1503                 break;
1504         }
1505         inc_deq(xhci, xhci->cmd_ring);
1506 }
1507
1508 static void handle_vendor_event(struct xhci_hcd *xhci,
1509                 union xhci_trb *event)
1510 {
1511         u32 trb_type;
1512
1513         trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->generic.field[3]));
1514         xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1515         if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1516                 handle_cmd_completion(xhci, &event->event_cmd);
1517 }
1518
1519 /* @port_id: the one-based port ID from the hardware (indexed from array of all
1520  * port registers -- USB 3.0 and USB 2.0).
1521  *
1522  * Returns a zero-based port number, which is suitable for indexing into each of
1523  * the split roothubs' port arrays and bus state arrays.
1524  * Add one to it in order to call xhci_find_slot_id_by_port.
1525  */
1526 static unsigned int find_faked_portnum_from_hw_portnum(struct usb_hcd *hcd,
1527                 struct xhci_hcd *xhci, u32 port_id)
1528 {
1529         unsigned int i;
1530         unsigned int num_similar_speed_ports = 0;
1531
1532         /* port_id from the hardware is 1-based, but port_array[], usb3_ports[],
1533          * and usb2_ports are 0-based indexes.  Count the number of similar
1534          * speed ports, up to 1 port before this port.
1535          */
1536         for (i = 0; i < (port_id - 1); i++) {
1537                 u8 port_speed = xhci->port_array[i];
1538
1539                 /*
1540                  * Skip ports that don't have known speeds, or have duplicate
1541                  * Extended Capabilities port speed entries.
1542                  */
1543                 if (port_speed == 0 || port_speed == DUPLICATE_ENTRY)
1544                         continue;
1545
1546                 /*
1547                  * USB 3.0 ports are always under a USB 3.0 hub.  USB 2.0 and
1548                  * 1.1 ports are under the USB 2.0 hub.  If the port speed
1549                  * matches the device speed, it's a similar speed port.
1550                  */
1551                 if ((port_speed == 0x03) == (hcd->speed == HCD_USB3))
1552                         num_similar_speed_ports++;
1553         }
1554         return num_similar_speed_ports;
1555 }
1556
1557 static void handle_device_notification(struct xhci_hcd *xhci,
1558                 union xhci_trb *event)
1559 {
1560         u32 slot_id;
1561         struct usb_device *udev;
1562
1563         slot_id = TRB_TO_SLOT_ID(event->generic.field[3]);
1564         if (!xhci->devs[slot_id]) {
1565                 xhci_warn(xhci, "Device Notification event for "
1566                                 "unused slot %u\n", slot_id);
1567                 return;
1568         }
1569
1570         xhci_dbg(xhci, "Device Wake Notification event for slot ID %u\n",
1571                         slot_id);
1572         udev = xhci->devs[slot_id]->udev;
1573         if (udev && udev->parent)
1574                 usb_wakeup_notification(udev->parent, udev->portnum);
1575 }
1576
1577 static void handle_port_status(struct xhci_hcd *xhci,
1578                 union xhci_trb *event)
1579 {
1580         struct usb_hcd *hcd;
1581         u32 port_id;
1582         u32 temp, temp1;
1583         int max_ports;
1584         int slot_id;
1585         unsigned int faked_port_index;
1586         u8 major_revision;
1587         struct xhci_bus_state *bus_state;
1588         __le32 __iomem **port_array;
1589         bool bogus_port_status = false;
1590
1591         /* Port status change events always have a successful completion code */
1592         if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS) {
1593                 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1594                 xhci->error_bitmask |= 1 << 8;
1595         }
1596         port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
1597         xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1598
1599         max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1600         if ((port_id <= 0) || (port_id > max_ports)) {
1601                 xhci_warn(xhci, "Invalid port id %d\n", port_id);
1602                 inc_deq(xhci, xhci->event_ring);
1603                 return;
1604         }
1605
1606         /* Figure out which usb_hcd this port is attached to:
1607          * is it a USB 3.0 port or a USB 2.0/1.1 port?
1608          */
1609         major_revision = xhci->port_array[port_id - 1];
1610
1611         /* Find the right roothub. */
1612         hcd = xhci_to_hcd(xhci);
1613         if ((major_revision == 0x03) != (hcd->speed == HCD_USB3))
1614                 hcd = xhci->shared_hcd;
1615
1616         if (major_revision == 0) {
1617                 xhci_warn(xhci, "Event for port %u not in "
1618                                 "Extended Capabilities, ignoring.\n",
1619                                 port_id);
1620                 bogus_port_status = true;
1621                 goto cleanup;
1622         }
1623         if (major_revision == DUPLICATE_ENTRY) {
1624                 xhci_warn(xhci, "Event for port %u duplicated in"
1625                                 "Extended Capabilities, ignoring.\n",
1626                                 port_id);
1627                 bogus_port_status = true;
1628                 goto cleanup;
1629         }
1630
1631         /*
1632          * Hardware port IDs reported by a Port Status Change Event include USB
1633          * 3.0 and USB 2.0 ports.  We want to check if the port has reported a
1634          * resume event, but we first need to translate the hardware port ID
1635          * into the index into the ports on the correct split roothub, and the
1636          * correct bus_state structure.
1637          */
1638         bus_state = &xhci->bus_state[hcd_index(hcd)];
1639         if (hcd->speed == HCD_USB3)
1640                 port_array = xhci->usb3_ports;
1641         else
1642                 port_array = xhci->usb2_ports;
1643         /* Find the faked port hub number */
1644         faked_port_index = find_faked_portnum_from_hw_portnum(hcd, xhci,
1645                         port_id);
1646
1647         temp = xhci_readl(xhci, port_array[faked_port_index]);
1648         if (hcd->state == HC_STATE_SUSPENDED) {
1649                 xhci_dbg(xhci, "resume root hub\n");
1650                 usb_hcd_resume_root_hub(hcd);
1651         }
1652
1653         if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1654                 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1655
1656                 temp1 = xhci_readl(xhci, &xhci->op_regs->command);
1657                 if (!(temp1 & CMD_RUN)) {
1658                         xhci_warn(xhci, "xHC is not running.\n");
1659                         goto cleanup;
1660                 }
1661
1662                 if (DEV_SUPERSPEED(temp)) {
1663                         xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
1664                         /* Set a flag to say the port signaled remote wakeup,
1665                          * so we can tell the difference between the end of
1666                          * device and host initiated resume.
1667                          */
1668                         bus_state->port_remote_wakeup |= 1 << faked_port_index;
1669                         xhci_test_and_clear_bit(xhci, port_array,
1670                                         faked_port_index, PORT_PLC);
1671                         xhci_set_link_state(xhci, port_array, faked_port_index,
1672                                                 XDEV_U0);
1673                         /* Need to wait until the next link state change
1674                          * indicates the device is actually in U0.
1675                          */
1676                         bogus_port_status = true;
1677                         goto cleanup;
1678                 } else {
1679                         xhci_dbg(xhci, "resume HS port %d\n", port_id);
1680                         bus_state->resume_done[faked_port_index] = jiffies +
1681                                 msecs_to_jiffies(20);
1682                         set_bit(faked_port_index, &bus_state->resuming_ports);
1683                         mod_timer(&hcd->rh_timer,
1684                                   bus_state->resume_done[faked_port_index]);
1685                         /* Do the rest in GetPortStatus */
1686                 }
1687         }
1688
1689         if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_U0 &&
1690                         DEV_SUPERSPEED(temp)) {
1691                 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1692                 /* We've just brought the device into U0 through either the
1693                  * Resume state after a device remote wakeup, or through the
1694                  * U3Exit state after a host-initiated resume.  If it's a device
1695                  * initiated remote wake, don't pass up the link state change,
1696                  * so the roothub behavior is consistent with external
1697                  * USB 3.0 hub behavior.
1698                  */
1699                 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1700                                 faked_port_index + 1);
1701                 if (slot_id && xhci->devs[slot_id])
1702                         xhci_ring_device(xhci, slot_id);
1703                 if (bus_state->port_remote_wakeup & (1 << faked_port_index)) {
1704                         bus_state->port_remote_wakeup &=
1705                                 ~(1 << faked_port_index);
1706                         xhci_test_and_clear_bit(xhci, port_array,
1707                                         faked_port_index, PORT_PLC);
1708                         usb_wakeup_notification(hcd->self.root_hub,
1709                                         faked_port_index + 1);
1710                         bogus_port_status = true;
1711                         goto cleanup;
1712                 }
1713         }
1714
1715         if (hcd->speed != HCD_USB3)
1716                 xhci_test_and_clear_bit(xhci, port_array, faked_port_index,
1717                                         PORT_PLC);
1718
1719 cleanup:
1720         /* Update event ring dequeue pointer before dropping the lock */
1721         inc_deq(xhci, xhci->event_ring);
1722
1723         /* Don't make the USB core poll the roothub if we got a bad port status
1724          * change event.  Besides, at that point we can't tell which roothub
1725          * (USB 2.0 or USB 3.0) to kick.
1726          */
1727         if (bogus_port_status)
1728                 return;
1729
1730         /*
1731          * xHCI port-status-change events occur when the "or" of all the
1732          * status-change bits in the portsc register changes from 0 to 1.
1733          * New status changes won't cause an event if any other change
1734          * bits are still set.  When an event occurs, switch over to
1735          * polling to avoid losing status changes.
1736          */
1737         xhci_dbg(xhci, "%s: starting port polling.\n", __func__);
1738         set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1739         spin_unlock(&xhci->lock);
1740         /* Pass this up to the core */
1741         usb_hcd_poll_rh_status(hcd);
1742         spin_lock(&xhci->lock);
1743 }
1744
1745 /*
1746  * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1747  * at end_trb, which may be in another segment.  If the suspect DMA address is a
1748  * TRB in this TD, this function returns that TRB's segment.  Otherwise it
1749  * returns 0.
1750  */
1751 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1752                 union xhci_trb  *start_trb,
1753                 union xhci_trb  *end_trb,
1754                 dma_addr_t      suspect_dma)
1755 {
1756         dma_addr_t start_dma;
1757         dma_addr_t end_seg_dma;
1758         dma_addr_t end_trb_dma;
1759         struct xhci_segment *cur_seg;
1760
1761         start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1762         cur_seg = start_seg;
1763
1764         do {
1765                 if (start_dma == 0)
1766                         return NULL;
1767                 /* We may get an event for a Link TRB in the middle of a TD */
1768                 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
1769                                 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
1770                 /* If the end TRB isn't in this segment, this is set to 0 */
1771                 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
1772
1773                 if (end_trb_dma > 0) {
1774                         /* The end TRB is in this segment, so suspect should be here */
1775                         if (start_dma <= end_trb_dma) {
1776                                 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1777                                         return cur_seg;
1778                         } else {
1779                                 /* Case for one segment with
1780                                  * a TD wrapped around to the top
1781                                  */
1782                                 if ((suspect_dma >= start_dma &&
1783                                                         suspect_dma <= end_seg_dma) ||
1784                                                 (suspect_dma >= cur_seg->dma &&
1785                                                  suspect_dma <= end_trb_dma))
1786                                         return cur_seg;
1787                         }
1788                         return NULL;
1789                 } else {
1790                         /* Might still be somewhere in this segment */
1791                         if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1792                                 return cur_seg;
1793                 }
1794                 cur_seg = cur_seg->next;
1795                 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
1796         } while (cur_seg != start_seg);
1797
1798         return NULL;
1799 }
1800
1801 static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1802                 unsigned int slot_id, unsigned int ep_index,
1803                 unsigned int stream_id,
1804                 struct xhci_td *td, union xhci_trb *event_trb)
1805 {
1806         struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1807         ep->ep_state |= EP_HALTED;
1808         ep->stopped_td = td;
1809         ep->stopped_trb = event_trb;
1810         ep->stopped_stream = stream_id;
1811
1812         xhci_queue_reset_ep(xhci, slot_id, ep_index);
1813         xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1814
1815         ep->stopped_td = NULL;
1816         ep->stopped_trb = NULL;
1817         ep->stopped_stream = 0;
1818
1819         xhci_ring_cmd_db(xhci);
1820 }
1821
1822 /* Check if an error has halted the endpoint ring.  The class driver will
1823  * cleanup the halt for a non-default control endpoint if we indicate a stall.
1824  * However, a babble and other errors also halt the endpoint ring, and the class
1825  * driver won't clear the halt in that case, so we need to issue a Set Transfer
1826  * Ring Dequeue Pointer command manually.
1827  */
1828 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1829                 struct xhci_ep_ctx *ep_ctx,
1830                 unsigned int trb_comp_code)
1831 {
1832         /* TRB completion codes that may require a manual halt cleanup */
1833         if (trb_comp_code == COMP_TX_ERR ||
1834                         trb_comp_code == COMP_BABBLE ||
1835                         trb_comp_code == COMP_SPLIT_ERR)
1836                 /* The 0.96 spec says a babbling control endpoint
1837                  * is not halted. The 0.96 spec says it is.  Some HW
1838                  * claims to be 0.95 compliant, but it halts the control
1839                  * endpoint anyway.  Check if a babble halted the
1840                  * endpoint.
1841                  */
1842                 if ((ep_ctx->ep_info & cpu_to_le32(EP_STATE_MASK)) ==
1843                     cpu_to_le32(EP_STATE_HALTED))
1844                         return 1;
1845
1846         return 0;
1847 }
1848
1849 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1850 {
1851         if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1852                 /* Vendor defined "informational" completion code,
1853                  * treat as not-an-error.
1854                  */
1855                 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1856                                 trb_comp_code);
1857                 xhci_dbg(xhci, "Treating code as success.\n");
1858                 return 1;
1859         }
1860         return 0;
1861 }
1862
1863 /*
1864  * Finish the td processing, remove the td from td list;
1865  * Return 1 if the urb can be given back.
1866  */
1867 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1868         union xhci_trb *event_trb, struct xhci_transfer_event *event,
1869         struct xhci_virt_ep *ep, int *status, bool skip)
1870 {
1871         struct xhci_virt_device *xdev;
1872         struct xhci_ring *ep_ring;
1873         unsigned int slot_id;
1874         int ep_index;
1875         struct urb *urb = NULL;
1876         struct xhci_ep_ctx *ep_ctx;
1877         int ret = 0;
1878         struct urb_priv *urb_priv;
1879         u32 trb_comp_code;
1880
1881         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1882         xdev = xhci->devs[slot_id];
1883         ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1884         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1885         ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1886         trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1887
1888         if (skip)
1889                 goto td_cleanup;
1890
1891         if (trb_comp_code == COMP_STOP_INVAL ||
1892                         trb_comp_code == COMP_STOP) {
1893                 /* The Endpoint Stop Command completion will take care of any
1894                  * stopped TDs.  A stopped TD may be restarted, so don't update
1895                  * the ring dequeue pointer or take this TD off any lists yet.
1896                  */
1897                 ep->stopped_td = td;
1898                 ep->stopped_trb = event_trb;
1899                 return 0;
1900         } else {
1901                 if (trb_comp_code == COMP_STALL) {
1902                         /* The transfer is completed from the driver's
1903                          * perspective, but we need to issue a set dequeue
1904                          * command for this stalled endpoint to move the dequeue
1905                          * pointer past the TD.  We can't do that here because
1906                          * the halt condition must be cleared first.  Let the
1907                          * USB class driver clear the stall later.
1908                          */
1909                         ep->stopped_td = td;
1910                         ep->stopped_trb = event_trb;
1911                         ep->stopped_stream = ep_ring->stream_id;
1912                 } else if (xhci_requires_manual_halt_cleanup(xhci,
1913                                         ep_ctx, trb_comp_code)) {
1914                         /* Other types of errors halt the endpoint, but the
1915                          * class driver doesn't call usb_reset_endpoint() unless
1916                          * the error is -EPIPE.  Clear the halted status in the
1917                          * xHCI hardware manually.
1918                          */
1919                         xhci_cleanup_halted_endpoint(xhci,
1920                                         slot_id, ep_index, ep_ring->stream_id,
1921                                         td, event_trb);
1922                 } else {
1923                         /* Update ring dequeue pointer */
1924                         while (ep_ring->dequeue != td->last_trb)
1925                                 inc_deq(xhci, ep_ring);
1926                         inc_deq(xhci, ep_ring);
1927                 }
1928
1929 td_cleanup:
1930                 /* Clean up the endpoint's TD list */
1931                 urb = td->urb;
1932                 urb_priv = urb->hcpriv;
1933
1934                 /* Do one last check of the actual transfer length.
1935                  * If the host controller said we transferred more data than
1936                  * the buffer length, urb->actual_length will be a very big
1937                  * number (since it's unsigned).  Play it safe and say we didn't
1938                  * transfer anything.
1939                  */
1940                 if (urb->actual_length > urb->transfer_buffer_length) {
1941                         xhci_warn(xhci, "URB transfer length is wrong, "
1942                                         "xHC issue? req. len = %u, "
1943                                         "act. len = %u\n",
1944                                         urb->transfer_buffer_length,
1945                                         urb->actual_length);
1946                         urb->actual_length = 0;
1947                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1948                                 *status = -EREMOTEIO;
1949                         else
1950                                 *status = 0;
1951                 }
1952                 list_del_init(&td->td_list);
1953                 /* Was this TD slated to be cancelled but completed anyway? */
1954                 if (!list_empty(&td->cancelled_td_list))
1955                         list_del_init(&td->cancelled_td_list);
1956
1957                 urb_priv->td_cnt++;
1958                 /* Giveback the urb when all the tds are completed */
1959                 if (urb_priv->td_cnt == urb_priv->length) {
1960                         ret = 1;
1961                         if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
1962                                 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
1963                                 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs
1964                                         == 0) {
1965                                         if (xhci->quirks & XHCI_AMD_PLL_FIX)
1966                                                 usb_amd_quirk_pll_enable();
1967                                 }
1968                         }
1969                 }
1970         }
1971
1972         return ret;
1973 }
1974
1975 /*
1976  * Process control tds, update urb status and actual_length.
1977  */
1978 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1979         union xhci_trb *event_trb, struct xhci_transfer_event *event,
1980         struct xhci_virt_ep *ep, int *status)
1981 {
1982         struct xhci_virt_device *xdev;
1983         struct xhci_ring *ep_ring;
1984         unsigned int slot_id;
1985         int ep_index;
1986         struct xhci_ep_ctx *ep_ctx;
1987         u32 trb_comp_code;
1988
1989         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1990         xdev = xhci->devs[slot_id];
1991         ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1992         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1993         ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1994         trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1995
1996         switch (trb_comp_code) {
1997         case COMP_SUCCESS:
1998                 if (event_trb == ep_ring->dequeue) {
1999                         xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
2000                                         "without IOC set??\n");
2001                         *status = -ESHUTDOWN;
2002                 } else if (event_trb != td->last_trb) {
2003                         xhci_warn(xhci, "WARN: Success on ctrl data TRB "
2004                                         "without IOC set??\n");
2005                         *status = -ESHUTDOWN;
2006                 } else {
2007                         *status = 0;
2008                 }
2009                 break;
2010         case COMP_SHORT_TX:
2011                 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2012                         *status = -EREMOTEIO;
2013                 else
2014                         *status = 0;
2015                 break;
2016         case COMP_STOP_INVAL:
2017         case COMP_STOP:
2018                 return finish_td(xhci, td, event_trb, event, ep, status, false);
2019         default:
2020                 if (!xhci_requires_manual_halt_cleanup(xhci,
2021                                         ep_ctx, trb_comp_code))
2022                         break;
2023                 xhci_dbg(xhci, "TRB error code %u, "
2024                                 "halted endpoint index = %u\n",
2025                                 trb_comp_code, ep_index);
2026                 /* else fall through */
2027         case COMP_STALL:
2028                 /* Did we transfer part of the data (middle) phase? */
2029                 if (event_trb != ep_ring->dequeue &&
2030                                 event_trb != td->last_trb)
2031                         td->urb->actual_length =
2032                                 td->urb->transfer_buffer_length -
2033                                 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2034                 else
2035                         td->urb->actual_length = 0;
2036
2037                 xhci_cleanup_halted_endpoint(xhci,
2038                         slot_id, ep_index, 0, td, event_trb);
2039                 return finish_td(xhci, td, event_trb, event, ep, status, true);
2040         }
2041         /*
2042          * Did we transfer any data, despite the errors that might have
2043          * happened?  I.e. did we get past the setup stage?
2044          */
2045         if (event_trb != ep_ring->dequeue) {
2046                 /* The event was for the status stage */
2047                 if (event_trb == td->last_trb) {
2048                         if (td->urb->actual_length != 0) {
2049                                 /* Don't overwrite a previously set error code
2050                                  */
2051                                 if ((*status == -EINPROGRESS || *status == 0) &&
2052                                                 (td->urb->transfer_flags
2053                                                  & URB_SHORT_NOT_OK))
2054                                         /* Did we already see a short data
2055                                          * stage? */
2056                                         *status = -EREMOTEIO;
2057                         } else {
2058                                 td->urb->actual_length =
2059                                         td->urb->transfer_buffer_length;
2060                         }
2061                 } else {
2062                 /* Maybe the event was for the data stage? */
2063                         td->urb->actual_length =
2064                                 td->urb->transfer_buffer_length -
2065                                 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2066                         xhci_dbg(xhci, "Waiting for status "
2067                                         "stage event\n");
2068                         return 0;
2069                 }
2070         }
2071
2072         return finish_td(xhci, td, event_trb, event, ep, status, false);
2073 }
2074
2075 /*
2076  * Process isochronous tds, update urb packet status and actual_length.
2077  */
2078 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2079         union xhci_trb *event_trb, struct xhci_transfer_event *event,
2080         struct xhci_virt_ep *ep, int *status)
2081 {
2082         struct xhci_ring *ep_ring;
2083         struct urb_priv *urb_priv;
2084         int idx;
2085         int len = 0;
2086         union xhci_trb *cur_trb;
2087         struct xhci_segment *cur_seg;
2088         struct usb_iso_packet_descriptor *frame;
2089         u32 trb_comp_code;
2090         bool skip_td = false;
2091
2092         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2093         trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2094         urb_priv = td->urb->hcpriv;
2095         idx = urb_priv->td_cnt;
2096         frame = &td->urb->iso_frame_desc[idx];
2097
2098         /* handle completion code */
2099         switch (trb_comp_code) {
2100         case COMP_SUCCESS:
2101                 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) {
2102                         frame->status = 0;
2103                         break;
2104                 }
2105                 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2106                         trb_comp_code = COMP_SHORT_TX;
2107         case COMP_SHORT_TX:
2108                 frame->status = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
2109                                 -EREMOTEIO : 0;
2110                 break;
2111         case COMP_BW_OVER:
2112                 frame->status = -ECOMM;
2113                 skip_td = true;
2114                 break;
2115         case COMP_BUFF_OVER:
2116         case COMP_BABBLE:
2117                 frame->status = -EOVERFLOW;
2118                 skip_td = true;
2119                 break;
2120         case COMP_DEV_ERR:
2121         case COMP_STALL:
2122         case COMP_TX_ERR:
2123                 frame->status = -EPROTO;
2124                 skip_td = true;
2125                 break;
2126         case COMP_STOP:
2127         case COMP_STOP_INVAL:
2128                 break;
2129         default:
2130                 frame->status = -1;
2131                 break;
2132         }
2133
2134         if (trb_comp_code == COMP_SUCCESS || skip_td) {
2135                 frame->actual_length = frame->length;
2136                 td->urb->actual_length += frame->length;
2137         } else {
2138                 for (cur_trb = ep_ring->dequeue,
2139                      cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
2140                      next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2141                         if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2142                             !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2143                                 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2144                 }
2145                 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2146                         EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2147
2148                 if (trb_comp_code != COMP_STOP_INVAL) {
2149                         frame->actual_length = len;
2150                         td->urb->actual_length += len;
2151                 }
2152         }
2153
2154         return finish_td(xhci, td, event_trb, event, ep, status, false);
2155 }
2156
2157 static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2158                         struct xhci_transfer_event *event,
2159                         struct xhci_virt_ep *ep, int *status)
2160 {
2161         struct xhci_ring *ep_ring;
2162         struct urb_priv *urb_priv;
2163         struct usb_iso_packet_descriptor *frame;
2164         int idx;
2165
2166         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2167         urb_priv = td->urb->hcpriv;
2168         idx = urb_priv->td_cnt;
2169         frame = &td->urb->iso_frame_desc[idx];
2170
2171         /* The transfer is partly done. */
2172         frame->status = -EXDEV;
2173
2174         /* calc actual length */
2175         frame->actual_length = 0;
2176
2177         /* Update ring dequeue pointer */
2178         while (ep_ring->dequeue != td->last_trb)
2179                 inc_deq(xhci, ep_ring);
2180         inc_deq(xhci, ep_ring);
2181
2182         return finish_td(xhci, td, NULL, event, ep, status, true);
2183 }
2184
2185 /*
2186  * Process bulk and interrupt tds, update urb status and actual_length.
2187  */
2188 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
2189         union xhci_trb *event_trb, struct xhci_transfer_event *event,
2190         struct xhci_virt_ep *ep, int *status)
2191 {
2192         struct xhci_ring *ep_ring;
2193         union xhci_trb *cur_trb;
2194         struct xhci_segment *cur_seg;
2195         u32 trb_comp_code;
2196
2197         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2198         trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2199
2200         switch (trb_comp_code) {
2201         case COMP_SUCCESS:
2202                 /* Double check that the HW transferred everything. */
2203                 if (event_trb != td->last_trb ||
2204                     EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2205                         xhci_warn(xhci, "WARN Successful completion "
2206                                         "on short TX\n");
2207                         if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2208                                 *status = -EREMOTEIO;
2209                         else
2210                                 *status = 0;
2211                         if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2212                                 trb_comp_code = COMP_SHORT_TX;
2213                 } else {
2214                         *status = 0;
2215                 }
2216                 break;
2217         case COMP_SHORT_TX:
2218                 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2219                         *status = -EREMOTEIO;
2220                 else
2221                         *status = 0;
2222                 break;
2223         default:
2224                 /* Others already handled above */
2225                 break;
2226         }
2227         if (trb_comp_code == COMP_SHORT_TX)
2228                 xhci_dbg(xhci, "ep %#x - asked for %d bytes, "
2229                                 "%d bytes untransferred\n",
2230                                 td->urb->ep->desc.bEndpointAddress,
2231                                 td->urb->transfer_buffer_length,
2232                                 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
2233         /* Fast path - was this the last TRB in the TD for this URB? */
2234         if (event_trb == td->last_trb) {
2235                 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2236                         td->urb->actual_length =
2237                                 td->urb->transfer_buffer_length -
2238                                 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2239                         if (td->urb->transfer_buffer_length <
2240                                         td->urb->actual_length) {
2241                                 xhci_warn(xhci, "HC gave bad length "
2242                                                 "of %d bytes left\n",
2243                                           EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
2244                                 td->urb->actual_length = 0;
2245                                 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2246                                         *status = -EREMOTEIO;
2247                                 else
2248                                         *status = 0;
2249                         }
2250                         /* Don't overwrite a previously set error code */
2251                         if (*status == -EINPROGRESS) {
2252                                 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2253                                         *status = -EREMOTEIO;
2254                                 else
2255                                         *status = 0;
2256                         }
2257                 } else {
2258                         td->urb->actual_length =
2259                                 td->urb->transfer_buffer_length;
2260                         /* Ignore a short packet completion if the
2261                          * untransferred length was zero.
2262                          */
2263                         if (*status == -EREMOTEIO)
2264                                 *status = 0;
2265                 }
2266         } else {
2267                 /* Slow path - walk the list, starting from the dequeue
2268                  * pointer, to get the actual length transferred.
2269                  */
2270                 td->urb->actual_length = 0;
2271                 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
2272                                 cur_trb != event_trb;
2273                                 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2274                         if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2275                             !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2276                                 td->urb->actual_length +=
2277                                         TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2278                 }
2279                 /* If the ring didn't stop on a Link or No-op TRB, add
2280                  * in the actual bytes transferred from the Normal TRB
2281                  */
2282                 if (trb_comp_code != COMP_STOP_INVAL)
2283                         td->urb->actual_length +=
2284                                 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2285                                 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2286         }
2287
2288         return finish_td(xhci, td, event_trb, event, ep, status, false);
2289 }
2290
2291 /*
2292  * If this function returns an error condition, it means it got a Transfer
2293  * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
2294  * At this point, the host controller is probably hosed and should be reset.
2295  */
2296 static int handle_tx_event(struct xhci_hcd *xhci,
2297                 struct xhci_transfer_event *event)
2298         __releases(&xhci->lock)
2299         __acquires(&xhci->lock)
2300 {
2301         struct xhci_virt_device *xdev;
2302         struct xhci_virt_ep *ep;
2303         struct xhci_ring *ep_ring;
2304         unsigned int slot_id;
2305         int ep_index;
2306         struct xhci_td *td = NULL;
2307         dma_addr_t event_dma;
2308         struct xhci_segment *event_seg;
2309         union xhci_trb *event_trb;
2310         struct urb *urb = NULL;
2311         int status = -EINPROGRESS;
2312         struct urb_priv *urb_priv;
2313         struct xhci_ep_ctx *ep_ctx;
2314         struct list_head *tmp;
2315         u32 trb_comp_code;
2316         int ret = 0;
2317         int td_num = 0;
2318
2319         slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
2320         xdev = xhci->devs[slot_id];
2321         if (!xdev) {
2322                 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
2323                 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2324                          (unsigned long long) xhci_trb_virt_to_dma(
2325                                  xhci->event_ring->deq_seg,
2326                                  xhci->event_ring->dequeue),
2327                          lower_32_bits(le64_to_cpu(event->buffer)),
2328                          upper_32_bits(le64_to_cpu(event->buffer)),
2329                          le32_to_cpu(event->transfer_len),
2330                          le32_to_cpu(event->flags));
2331                 xhci_dbg(xhci, "Event ring:\n");
2332                 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2333                 return -ENODEV;
2334         }
2335
2336         /* Endpoint ID is 1 based, our index is zero based */
2337         ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
2338         ep = &xdev->eps[ep_index];
2339         ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2340         ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2341         if (!ep_ring ||
2342             (le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK) ==
2343             EP_STATE_DISABLED) {
2344                 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
2345                                 "or incorrect stream ring\n");
2346                 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2347                          (unsigned long long) xhci_trb_virt_to_dma(
2348                                  xhci->event_ring->deq_seg,
2349                                  xhci->event_ring->dequeue),
2350                          lower_32_bits(le64_to_cpu(event->buffer)),
2351                          upper_32_bits(le64_to_cpu(event->buffer)),
2352                          le32_to_cpu(event->transfer_len),
2353                          le32_to_cpu(event->flags));
2354                 xhci_dbg(xhci, "Event ring:\n");
2355                 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2356                 return -ENODEV;
2357         }
2358
2359         /* Count current td numbers if ep->skip is set */
2360         if (ep->skip) {
2361                 list_for_each(tmp, &ep_ring->td_list)
2362                         td_num++;
2363         }
2364
2365         event_dma = le64_to_cpu(event->buffer);
2366         trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2367         /* Look for common error cases */
2368         switch (trb_comp_code) {
2369         /* Skip codes that require special handling depending on
2370          * transfer type
2371          */
2372         case COMP_SUCCESS:
2373                 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0)
2374                         break;
2375                 if (xhci->quirks & XHCI_TRUST_TX_LENGTH)
2376                         trb_comp_code = COMP_SHORT_TX;
2377                 else
2378                         xhci_warn_ratelimited(xhci,
2379                                         "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n");
2380         case COMP_SHORT_TX:
2381                 break;
2382         case COMP_STOP:
2383                 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
2384                 break;
2385         case COMP_STOP_INVAL:
2386                 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
2387                 break;
2388         case COMP_STALL:
2389                 xhci_dbg(xhci, "Stalled endpoint\n");
2390                 ep->ep_state |= EP_HALTED;
2391                 status = -EPIPE;
2392                 break;
2393         case COMP_TRB_ERR:
2394                 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
2395                 status = -EILSEQ;
2396                 break;
2397         case COMP_SPLIT_ERR:
2398         case COMP_TX_ERR:
2399                 xhci_dbg(xhci, "Transfer error on endpoint\n");
2400                 status = -EPROTO;
2401                 break;
2402         case COMP_BABBLE:
2403                 xhci_dbg(xhci, "Babble error on endpoint\n");
2404                 status = -EOVERFLOW;
2405                 break;
2406         case COMP_DB_ERR:
2407                 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
2408                 status = -ENOSR;
2409                 break;
2410         case COMP_BW_OVER:
2411                 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
2412                 break;
2413         case COMP_BUFF_OVER:
2414                 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
2415                 break;
2416         case COMP_UNDERRUN:
2417                 /*
2418                  * When the Isoch ring is empty, the xHC will generate
2419                  * a Ring Overrun Event for IN Isoch endpoint or Ring
2420                  * Underrun Event for OUT Isoch endpoint.
2421                  */
2422                 xhci_dbg(xhci, "underrun event on endpoint\n");
2423                 if (!list_empty(&ep_ring->td_list))
2424                         xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2425                                         "still with TDs queued?\n",
2426                                  TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2427                                  ep_index);
2428                 goto cleanup;
2429         case COMP_OVERRUN:
2430                 xhci_dbg(xhci, "overrun event on endpoint\n");
2431                 if (!list_empty(&ep_ring->td_list))
2432                         xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2433                                         "still with TDs queued?\n",
2434                                  TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2435                                  ep_index);
2436                 goto cleanup;
2437         case COMP_DEV_ERR:
2438                 xhci_warn(xhci, "WARN: detect an incompatible device");
2439                 status = -EPROTO;
2440                 break;
2441         case COMP_MISSED_INT:
2442                 /*
2443                  * When encounter missed service error, one or more isoc tds
2444                  * may be missed by xHC.
2445                  * Set skip flag of the ep_ring; Complete the missed tds as
2446                  * short transfer when process the ep_ring next time.
2447                  */
2448                 ep->skip = true;
2449                 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
2450                 goto cleanup;
2451         default:
2452                 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
2453                         status = 0;
2454                         break;
2455                 }
2456                 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
2457                                 "busted\n");
2458                 goto cleanup;
2459         }
2460
2461         do {
2462                 /* This TRB should be in the TD at the head of this ring's
2463                  * TD list.
2464                  */
2465                 if (list_empty(&ep_ring->td_list)) {
2466                         /*
2467                          * A stopped endpoint may generate an extra completion
2468                          * event if the device was suspended.  Don't print
2469                          * warnings.
2470                          */
2471                         if (!(trb_comp_code == COMP_STOP ||
2472                                                 trb_comp_code == COMP_STOP_INVAL)) {
2473                                 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
2474                                                 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2475                                                 ep_index);
2476                                 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
2477                                                 (le32_to_cpu(event->flags) &
2478                                                  TRB_TYPE_BITMASK)>>10);
2479                                 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
2480                         }
2481                         if (ep->skip) {
2482                                 ep->skip = false;
2483                                 xhci_dbg(xhci, "td_list is empty while skip "
2484                                                 "flag set. Clear skip flag.\n");
2485                         }
2486                         ret = 0;
2487                         goto cleanup;
2488                 }
2489
2490                 /* We've skipped all the TDs on the ep ring when ep->skip set */
2491                 if (ep->skip && td_num == 0) {
2492                         ep->skip = false;
2493                         xhci_dbg(xhci, "All tds on the ep_ring skipped. "
2494                                                 "Clear skip flag.\n");
2495                         ret = 0;
2496                         goto cleanup;
2497                 }
2498
2499                 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
2500                 if (ep->skip)
2501                         td_num--;
2502
2503                 /* Is this a TRB in the currently executing TD? */
2504                 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
2505                                 td->last_trb, event_dma);
2506
2507                 /*
2508                  * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2509                  * is not in the current TD pointed by ep_ring->dequeue because
2510                  * that the hardware dequeue pointer still at the previous TRB
2511                  * of the current TD. The previous TRB maybe a Link TD or the
2512                  * last TRB of the previous TD. The command completion handle
2513                  * will take care the rest.
2514                  */
2515                 if (!event_seg && trb_comp_code == COMP_STOP_INVAL) {
2516                         ret = 0;
2517                         goto cleanup;
2518                 }
2519
2520                 if (!event_seg) {
2521                         if (!ep->skip ||
2522                             !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
2523                                 /* Some host controllers give a spurious
2524                                  * successful event after a short transfer.
2525                                  * Ignore it.
2526                                  */
2527                                 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
2528                                                 ep_ring->last_td_was_short) {
2529                                         ep_ring->last_td_was_short = false;
2530                                         ret = 0;
2531                                         goto cleanup;
2532                                 }
2533                                 /* HC is busted, give up! */
2534                                 xhci_err(xhci,
2535                                         "ERROR Transfer event TRB DMA ptr not "
2536                                         "part of current TD\n");
2537                                 return -ESHUTDOWN;
2538                         }
2539
2540                         ret = skip_isoc_td(xhci, td, event, ep, &status);
2541                         goto cleanup;
2542                 }
2543                 if (trb_comp_code == COMP_SHORT_TX)
2544                         ep_ring->last_td_was_short = true;
2545                 else
2546                         ep_ring->last_td_was_short = false;
2547
2548                 if (ep->skip) {
2549                         xhci_dbg(xhci, "Found td. Clear skip flag.\n");
2550                         ep->skip = false;
2551                 }
2552
2553                 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) /
2554                                                 sizeof(*event_trb)];
2555                 /*
2556                  * No-op TRB should not trigger interrupts.
2557                  * If event_trb is a no-op TRB, it means the
2558                  * corresponding TD has been cancelled. Just ignore
2559                  * the TD.
2560                  */
2561                 if (TRB_TYPE_NOOP_LE32(event_trb->generic.field[3])) {
2562                         xhci_dbg(xhci,
2563                                  "event_trb is a no-op TRB. Skip it\n");
2564                         goto cleanup;
2565                 }
2566
2567                 /* Now update the urb's actual_length and give back to
2568                  * the core
2569                  */
2570                 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2571                         ret = process_ctrl_td(xhci, td, event_trb, event, ep,
2572                                                  &status);
2573                 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2574                         ret = process_isoc_td(xhci, td, event_trb, event, ep,
2575                                                  &status);
2576                 else
2577                         ret = process_bulk_intr_td(xhci, td, event_trb, event,
2578                                                  ep, &status);
2579
2580 cleanup:
2581                 /*
2582                  * Do not update event ring dequeue pointer if ep->skip is set.
2583                  * Will roll back to continue process missed tds.
2584                  */
2585                 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
2586                         inc_deq(xhci, xhci->event_ring);
2587                 }
2588
2589                 if (ret) {
2590                         urb = td->urb;
2591                         urb_priv = urb->hcpriv;
2592                         /* Leave the TD around for the reset endpoint function
2593                          * to use(but only if it's not a control endpoint,
2594                          * since we already queued the Set TR dequeue pointer
2595                          * command for stalled control endpoints).
2596                          */
2597                         if (usb_endpoint_xfer_control(&urb->ep->desc) ||
2598                                 (trb_comp_code != COMP_STALL &&
2599                                         trb_comp_code != COMP_BABBLE))
2600                                 xhci_urb_free_priv(xhci, urb_priv);
2601                         else
2602                                 kfree(urb_priv);
2603
2604                         usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
2605                         if ((urb->actual_length != urb->transfer_buffer_length &&
2606                                                 (urb->transfer_flags &
2607                                                  URB_SHORT_NOT_OK)) ||
2608                                         (status != 0 &&
2609                                          !usb_endpoint_xfer_isoc(&urb->ep->desc)))
2610                                 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
2611                                                 "expected = %d, status = %d\n",
2612                                                 urb, urb->actual_length,
2613                                                 urb->transfer_buffer_length,
2614                                                 status);
2615                         spin_unlock(&xhci->lock);
2616                         /* EHCI, UHCI, and OHCI always unconditionally set the
2617                          * urb->status of an isochronous endpoint to 0.
2618                          */
2619                         if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
2620                                 status = 0;
2621                         usb_hcd_giveback_urb(bus_to_hcd(urb->dev->bus), urb, status);
2622                         spin_lock(&xhci->lock);
2623                 }
2624
2625         /*
2626          * If ep->skip is set, it means there are missed tds on the
2627          * endpoint ring need to take care of.
2628          * Process them as short transfer until reach the td pointed by
2629          * the event.
2630          */
2631         } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2632
2633         return 0;
2634 }
2635
2636 /*
2637  * This function handles all OS-owned events on the event ring.  It may drop
2638  * xhci->lock between event processing (e.g. to pass up port status changes).
2639  * Returns >0 for "possibly more events to process" (caller should call again),
2640  * otherwise 0 if done.  In future, <0 returns should indicate error code.
2641  */
2642 static int xhci_handle_event(struct xhci_hcd *xhci)
2643 {
2644         union xhci_trb *event;
2645         int update_ptrs = 1;
2646         int ret;
2647
2648         if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2649                 xhci->error_bitmask |= 1 << 1;
2650                 return 0;
2651         }
2652
2653         event = xhci->event_ring->dequeue;
2654         /* Does the HC or OS own the TRB? */
2655         if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2656             xhci->event_ring->cycle_state) {
2657                 xhci->error_bitmask |= 1 << 2;
2658                 return 0;
2659         }
2660
2661         /*
2662          * Barrier between reading the TRB_CYCLE (valid) flag above and any
2663          * speculative reads of the event's flags/data below.
2664          */
2665         rmb();
2666         /* FIXME: Handle more event types. */
2667         switch ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK)) {
2668         case TRB_TYPE(TRB_COMPLETION):
2669                 handle_cmd_completion(xhci, &event->event_cmd);
2670                 break;
2671         case TRB_TYPE(TRB_PORT_STATUS):
2672                 handle_port_status(xhci, event);
2673                 update_ptrs = 0;
2674                 break;
2675         case TRB_TYPE(TRB_TRANSFER):
2676                 ret = handle_tx_event(xhci, &event->trans_event);
2677                 if (ret < 0)
2678                         xhci->error_bitmask |= 1 << 9;
2679                 else
2680                         update_ptrs = 0;
2681                 break;
2682         case TRB_TYPE(TRB_DEV_NOTE):
2683                 handle_device_notification(xhci, event);
2684                 break;
2685         default:
2686                 if ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK) >=
2687                     TRB_TYPE(48))
2688                         handle_vendor_event(xhci, event);
2689                 else
2690                         xhci->error_bitmask |= 1 << 3;
2691         }
2692         /* Any of the above functions may drop and re-acquire the lock, so check
2693          * to make sure a watchdog timer didn't mark the host as non-responsive.
2694          */
2695         if (xhci->xhc_state & XHCI_STATE_DYING) {
2696                 xhci_dbg(xhci, "xHCI host dying, returning from "
2697                                 "event handler.\n");
2698                 return 0;
2699         }
2700
2701         if (update_ptrs)
2702                 /* Update SW event ring dequeue pointer */
2703                 inc_deq(xhci, xhci->event_ring);
2704
2705         /* Are there more items on the event ring?  Caller will call us again to
2706          * check.
2707          */
2708         return 1;
2709 }
2710
2711 /*
2712  * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2713  * we might get bad data out of the event ring.  Section 4.10.2.7 has a list of
2714  * indicators of an event TRB error, but we check the status *first* to be safe.
2715  */
2716 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2717 {
2718         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2719         u32 status;
2720         u64 temp_64;
2721         union xhci_trb *event_ring_deq;
2722         dma_addr_t deq;
2723
2724         spin_lock(&xhci->lock);
2725         /* Check if the xHC generated the interrupt, or the irq is shared */
2726         status = xhci_readl(xhci, &xhci->op_regs->status);
2727         if (status == 0xffffffff)
2728                 goto hw_died;
2729
2730         if (!(status & STS_EINT)) {
2731                 spin_unlock(&xhci->lock);
2732                 return IRQ_NONE;
2733         }
2734         if (status & STS_FATAL) {
2735                 xhci_warn(xhci, "WARNING: Host System Error\n");
2736                 xhci_halt(xhci);
2737 hw_died:
2738                 spin_unlock(&xhci->lock);
2739                 return -ESHUTDOWN;
2740         }
2741
2742         /*
2743          * Clear the op reg interrupt status first,
2744          * so we can receive interrupts from other MSI-X interrupters.
2745          * Write 1 to clear the interrupt status.
2746          */
2747         status |= STS_EINT;
2748         xhci_writel(xhci, status, &xhci->op_regs->status);
2749         /* FIXME when MSI-X is supported and there are multiple vectors */
2750         /* Clear the MSI-X event interrupt status */
2751
2752         if (hcd->irq) {
2753                 u32 irq_pending;
2754                 /* Acknowledge the PCI interrupt */
2755                 irq_pending = xhci_readl(xhci, &xhci->ir_set->irq_pending);
2756                 irq_pending |= IMAN_IP;
2757                 xhci_writel(xhci, irq_pending, &xhci->ir_set->irq_pending);
2758         }
2759
2760         if (xhci->xhc_state & XHCI_STATE_DYING) {
2761                 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2762                                 "Shouldn't IRQs be disabled?\n");
2763                 /* Clear the event handler busy flag (RW1C);
2764                  * the event ring should be empty.
2765                  */
2766                 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2767                 xhci_write_64(xhci, temp_64 | ERST_EHB,
2768                                 &xhci->ir_set->erst_dequeue);
2769                 spin_unlock(&xhci->lock);
2770
2771                 return IRQ_HANDLED;
2772         }
2773
2774         event_ring_deq = xhci->event_ring->dequeue;
2775         /* FIXME this should be a delayed service routine
2776          * that clears the EHB.
2777          */
2778         while (xhci_handle_event(xhci) > 0) {}
2779
2780         temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2781         /* If necessary, update the HW's version of the event ring deq ptr. */
2782         if (event_ring_deq != xhci->event_ring->dequeue) {
2783                 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2784                                 xhci->event_ring->dequeue);
2785                 if (deq == 0)
2786                         xhci_warn(xhci, "WARN something wrong with SW event "
2787                                         "ring dequeue ptr.\n");
2788                 /* Update HC event ring dequeue pointer */
2789                 temp_64 &= ERST_PTR_MASK;
2790                 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2791         }
2792
2793         /* Clear the event handler busy flag (RW1C); event ring is empty. */
2794         temp_64 |= ERST_EHB;
2795         xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2796
2797         spin_unlock(&xhci->lock);
2798
2799         return IRQ_HANDLED;
2800 }
2801
2802 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd)
2803 {
2804         return xhci_irq(hcd);
2805 }
2806
2807 /****           Endpoint Ring Operations        ****/
2808
2809 /*
2810  * Generic function for queueing a TRB on a ring.
2811  * The caller must have checked to make sure there's room on the ring.
2812  *
2813  * @more_trbs_coming:   Will you enqueue more TRBs before calling
2814  *                      prepare_transfer()?
2815  */
2816 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
2817                 bool more_trbs_coming,
2818                 u32 field1, u32 field2, u32 field3, u32 field4)
2819 {
2820         struct xhci_generic_trb *trb;
2821
2822         trb = &ring->enqueue->generic;
2823         trb->field[0] = cpu_to_le32(field1);
2824         trb->field[1] = cpu_to_le32(field2);
2825         trb->field[2] = cpu_to_le32(field3);
2826         trb->field[3] = cpu_to_le32(field4);
2827         inc_enq(xhci, ring, more_trbs_coming);
2828 }
2829
2830 /*
2831  * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2832  * FIXME allocate segments if the ring is full.
2833  */
2834 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
2835                 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
2836 {
2837         unsigned int num_trbs_needed;
2838
2839         /* Make sure the endpoint has been added to xHC schedule */
2840         switch (ep_state) {
2841         case EP_STATE_DISABLED:
2842                 /*
2843                  * USB core changed config/interfaces without notifying us,
2844                  * or hardware is reporting the wrong state.
2845                  */
2846                 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2847                 return -ENOENT;
2848         case EP_STATE_ERROR:
2849                 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
2850                 /* FIXME event handling code for error needs to clear it */
2851                 /* XXX not sure if this should be -ENOENT or not */
2852                 return -EINVAL;
2853         case EP_STATE_HALTED:
2854                 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
2855         case EP_STATE_STOPPED:
2856         case EP_STATE_RUNNING:
2857                 break;
2858         default:
2859                 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2860                 /*
2861                  * FIXME issue Configure Endpoint command to try to get the HC
2862                  * back into a known state.
2863                  */
2864                 return -EINVAL;
2865         }
2866
2867         while (1) {
2868                 if (room_on_ring(xhci, ep_ring, num_trbs))
2869                         break;
2870
2871                 if (ep_ring == xhci->cmd_ring) {
2872                         xhci_err(xhci, "Do not support expand command ring\n");
2873                         return -ENOMEM;
2874                 }
2875
2876                 xhci_dbg(xhci, "ERROR no room on ep ring, "
2877                                         "try ring expansion\n");
2878                 num_trbs_needed = num_trbs - ep_ring->num_trbs_free;
2879                 if (xhci_ring_expansion(xhci, ep_ring, num_trbs_needed,
2880                                         mem_flags)) {
2881                         xhci_err(xhci, "Ring expansion failed\n");
2882                         return -ENOMEM;
2883                 }
2884         }
2885
2886         if (enqueue_is_link_trb(ep_ring)) {
2887                 struct xhci_ring *ring = ep_ring;
2888                 union xhci_trb *next;
2889
2890                 next = ring->enqueue;
2891
2892                 while (last_trb(xhci, ring, ring->enq_seg, next)) {
2893                         /* If we're not dealing with 0.95 hardware or isoc rings
2894                          * on AMD 0.96 host, clear the chain bit.
2895                          */
2896                         if (!xhci_link_trb_quirk(xhci) &&
2897                                         !(ring->type == TYPE_ISOC &&
2898                                          (xhci->quirks & XHCI_AMD_0x96_HOST)))
2899                                 next->link.control &= cpu_to_le32(~TRB_CHAIN);
2900                         else
2901                                 next->link.control |= cpu_to_le32(TRB_CHAIN);
2902
2903                         wmb();
2904                         next->link.control ^= cpu_to_le32(TRB_CYCLE);
2905
2906                         /* Toggle the cycle bit after the last ring segment. */
2907                         if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2908                                 ring->cycle_state = (ring->cycle_state ? 0 : 1);
2909                         }
2910                         ring->enq_seg = ring->enq_seg->next;
2911                         ring->enqueue = ring->enq_seg->trbs;
2912                         next = ring->enqueue;
2913                 }
2914         }
2915
2916         return 0;
2917 }
2918
2919 static int prepare_transfer(struct xhci_hcd *xhci,
2920                 struct xhci_virt_device *xdev,
2921                 unsigned int ep_index,
2922                 unsigned int stream_id,
2923                 unsigned int num_trbs,
2924                 struct urb *urb,
2925                 unsigned int td_index,
2926                 gfp_t mem_flags)
2927 {
2928         int ret;
2929         struct urb_priv *urb_priv;
2930         struct xhci_td  *td;
2931         struct xhci_ring *ep_ring;
2932         struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2933
2934         ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2935         if (!ep_ring) {
2936                 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2937                                 stream_id);
2938                 return -EINVAL;
2939         }
2940
2941         ret = prepare_ring(xhci, ep_ring,
2942                            le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
2943                            num_trbs, mem_flags);
2944         if (ret)
2945                 return ret;
2946
2947         urb_priv = urb->hcpriv;
2948         td = urb_priv->td[td_index];
2949
2950         INIT_LIST_HEAD(&td->td_list);
2951         INIT_LIST_HEAD(&td->cancelled_td_list);
2952
2953         if (td_index == 0) {
2954                 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
2955                 if (unlikely(ret))
2956                         return ret;
2957         }
2958
2959         td->urb = urb;
2960         /* Add this TD to the tail of the endpoint ring's TD list */
2961         list_add_tail(&td->td_list, &ep_ring->td_list);
2962         td->start_seg = ep_ring->enq_seg;
2963         td->first_trb = ep_ring->enqueue;
2964
2965         urb_priv->td[td_index] = td;
2966
2967         return 0;
2968 }
2969
2970 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
2971 {
2972         int num_sgs, num_trbs, running_total, temp, i;
2973         struct scatterlist *sg;
2974
2975         sg = NULL;
2976         num_sgs = urb->num_mapped_sgs;
2977         temp = urb->transfer_buffer_length;
2978
2979         num_trbs = 0;
2980         for_each_sg(urb->sg, sg, num_sgs, i) {
2981                 unsigned int len = sg_dma_len(sg);
2982
2983                 /* Scatter gather list entries may cross 64KB boundaries */
2984                 running_total = TRB_MAX_BUFF_SIZE -
2985                         (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
2986                 running_total &= TRB_MAX_BUFF_SIZE - 1;
2987                 if (running_total != 0)
2988                         num_trbs++;
2989
2990                 /* How many more 64KB chunks to transfer, how many more TRBs? */
2991                 while (running_total < sg_dma_len(sg) && running_total < temp) {
2992                         num_trbs++;
2993                         running_total += TRB_MAX_BUFF_SIZE;
2994                 }
2995                 len = min_t(int, len, temp);
2996                 temp -= len;
2997                 if (temp == 0)
2998                         break;
2999         }
3000         return num_trbs;
3001 }
3002
3003 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
3004 {
3005         if (num_trbs != 0)
3006                 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
3007                                 "TRBs, %d left\n", __func__,
3008                                 urb->ep->desc.bEndpointAddress, num_trbs);
3009         if (running_total != urb->transfer_buffer_length)
3010                 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
3011                                 "queued %#x (%d), asked for %#x (%d)\n",
3012                                 __func__,
3013                                 urb->ep->desc.bEndpointAddress,
3014                                 running_total, running_total,
3015                                 urb->transfer_buffer_length,
3016                                 urb->transfer_buffer_length);
3017 }
3018
3019 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
3020                 unsigned int ep_index, unsigned int stream_id, int start_cycle,
3021                 struct xhci_generic_trb *start_trb)
3022 {
3023         /*
3024          * Pass all the TRBs to the hardware at once and make sure this write
3025          * isn't reordered.
3026          */
3027         wmb();
3028         if (start_cycle)
3029                 start_trb->field[3] |= cpu_to_le32(start_cycle);
3030         else
3031                 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
3032         xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
3033 }
3034
3035 /*
3036  * xHCI uses normal TRBs for both bulk and interrupt.  When the interrupt
3037  * endpoint is to be serviced, the xHC will consume (at most) one TD.  A TD
3038  * (comprised of sg list entries) can take several service intervals to
3039  * transmit.
3040  */
3041 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3042                 struct urb *urb, int slot_id, unsigned int ep_index)
3043 {
3044         struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
3045                         xhci->devs[slot_id]->out_ctx, ep_index);
3046         int xhci_interval;
3047         int ep_interval;
3048
3049         xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3050         ep_interval = urb->interval;
3051         /* Convert to microframes */
3052         if (urb->dev->speed == USB_SPEED_LOW ||
3053                         urb->dev->speed == USB_SPEED_FULL)
3054                 ep_interval *= 8;
3055         /* FIXME change this to a warning and a suggestion to use the new API
3056          * to set the polling interval (once the API is added).
3057          */
3058         if (xhci_interval != ep_interval) {
3059                 if (printk_ratelimit())
3060                         dev_dbg(&urb->dev->dev, "Driver uses different interval"
3061                                         " (%d microframe%s) than xHCI "
3062                                         "(%d microframe%s)\n",
3063                                         ep_interval,
3064                                         ep_interval == 1 ? "" : "s",
3065                                         xhci_interval,
3066                                         xhci_interval == 1 ? "" : "s");
3067                 urb->interval = xhci_interval;
3068                 /* Convert back to frames for LS/FS devices */
3069                 if (urb->dev->speed == USB_SPEED_LOW ||
3070                                 urb->dev->speed == USB_SPEED_FULL)
3071                         urb->interval /= 8;
3072         }
3073         return xhci_queue_bulk_tx(xhci, mem_flags, urb, slot_id, ep_index);
3074 }
3075
3076 /*
3077  * The TD size is the number of bytes remaining in the TD (including this TRB),
3078  * right shifted by 10.
3079  * It must fit in bits 21:17, so it can't be bigger than 31.
3080  */
3081 static u32 xhci_td_remainder(unsigned int remainder)
3082 {
3083         u32 max = (1 << (21 - 17 + 1)) - 1;
3084
3085         if ((remainder >> 10) >= max)
3086                 return max << 17;
3087         else
3088                 return (remainder >> 10) << 17;
3089 }
3090
3091 /*
3092  * For xHCI 1.0 host controllers, TD size is the number of max packet sized
3093  * packets remaining in the TD (*not* including this TRB).
3094  *
3095  * Total TD packet count = total_packet_count =
3096  *     DIV_ROUND_UP(TD size in bytes / wMaxPacketSize)
3097  *
3098  * Packets transferred up to and including this TRB = packets_transferred =
3099  *     rounddown(total bytes transferred including this TRB / wMaxPacketSize)
3100  *
3101  * TD size = total_packet_count - packets_transferred
3102  *
3103  * It must fit in bits 21:17, so it can't be bigger than 31.
3104  * The last TRB in a TD must have the TD size set to zero.
3105  */
3106 static u32 xhci_v1_0_td_remainder(int running_total, int trb_buff_len,
3107                 unsigned int total_packet_count, struct urb *urb,
3108                 unsigned int num_trbs_left)
3109 {
3110         int packets_transferred;
3111
3112         /* One TRB with a zero-length data packet. */
3113         if (num_trbs_left == 0 || (running_total == 0 && trb_buff_len == 0))
3114                 return 0;
3115
3116         /* All the TRB queueing functions don't count the current TRB in
3117          * running_total.
3118          */
3119         packets_transferred = (running_total + trb_buff_len) /
3120                 GET_MAX_PACKET(usb_endpoint_maxp(&urb->ep->desc));
3121
3122         if ((total_packet_count - packets_transferred) > 31)
3123                 return 31 << 17;
3124         return (total_packet_count - packets_transferred) << 17;
3125 }
3126
3127 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3128                 struct urb *urb, int slot_id, unsigned int ep_index)
3129 {
3130         struct xhci_ring *ep_ring;
3131         unsigned int num_trbs;
3132         struct urb_priv *urb_priv;
3133         struct xhci_td *td;
3134         struct scatterlist *sg;
3135         int num_sgs;
3136         int trb_buff_len, this_sg_len, running_total;
3137         unsigned int total_packet_count;
3138         bool first_trb;
3139         u64 addr;
3140         bool more_trbs_coming;
3141
3142         struct xhci_generic_trb *start_trb;
3143         int start_cycle;
3144
3145         ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3146         if (!ep_ring)
3147                 return -EINVAL;
3148
3149         num_trbs = count_sg_trbs_needed(xhci, urb);
3150         num_sgs = urb->num_mapped_sgs;
3151         total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3152                         usb_endpoint_maxp(&urb->ep->desc));
3153
3154         trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
3155                         ep_index, urb->stream_id,
3156                         num_trbs, urb, 0, mem_flags);
3157         if (trb_buff_len < 0)
3158                 return trb_buff_len;
3159
3160         urb_priv = urb->hcpriv;
3161         td = urb_priv->td[0];
3162
3163         /*
3164          * Don't give the first TRB to the hardware (by toggling the cycle bit)
3165          * until we've finished creating all the other TRBs.  The ring's cycle
3166          * state may change as we enqueue the other TRBs, so save it too.
3167          */
3168         start_trb = &ep_ring->enqueue->generic;
3169         start_cycle = ep_ring->cycle_state;
3170
3171         running_total = 0;
3172         /*
3173          * How much data is in the first TRB?
3174          *
3175          * There are three forces at work for TRB buffer pointers and lengths:
3176          * 1. We don't want to walk off the end of this sg-list entry buffer.
3177          * 2. The transfer length that the driver requested may be smaller than
3178          *    the amount of memory allocated for this scatter-gather list.
3179          * 3. TRBs buffers can't cross 64KB boundaries.
3180          */
3181         sg = urb->sg;
3182         addr = (u64) sg_dma_address(sg);
3183         this_sg_len = sg_dma_len(sg);
3184         trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
3185         trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3186         if (trb_buff_len > urb->transfer_buffer_length)
3187                 trb_buff_len = urb->transfer_buffer_length;
3188
3189         first_trb = true;
3190         /* Queue the first TRB, even if it's zero-length */
3191         do {
3192                 u32 field = 0;
3193                 u32 length_field = 0;
3194                 u32 remainder = 0;
3195
3196                 /* Don't change the cycle bit of the first TRB until later */
3197                 if (first_trb) {
3198                         first_trb = false;
3199                         if (start_cycle == 0)
3200                                 field |= 0x1;
3201                 } else
3202                         field |= ep_ring->cycle_state;
3203
3204                 /* Chain all the TRBs together; clear the chain bit in the last
3205                  * TRB to indicate it's the last TRB in the chain.
3206                  */
3207                 if (num_trbs > 1) {
3208                         field |= TRB_CHAIN;
3209                 } else {
3210                         /* FIXME - add check for ZERO_PACKET flag before this */
3211                         td->last_trb = ep_ring->enqueue;
3212                         field |= TRB_IOC;
3213                 }
3214
3215                 /* Only set interrupt on short packet for IN endpoints */
3216                 if (usb_urb_dir_in(urb))
3217                         field |= TRB_ISP;
3218
3219                 if (TRB_MAX_BUFF_SIZE -
3220                                 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
3221                         xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
3222                         xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
3223                                         (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
3224                                         (unsigned int) addr + trb_buff_len);
3225                 }
3226
3227                 /* Set the TRB length, TD size, and interrupter fields. */
3228                 if (xhci->hci_version < 0x100) {
3229                         remainder = xhci_td_remainder(
3230                                         urb->transfer_buffer_length -
3231                                         running_total);
3232                 } else {
3233                         remainder = xhci_v1_0_td_remainder(running_total,
3234                                         trb_buff_len, total_packet_count, urb,
3235                                         num_trbs - 1);
3236                 }
3237                 length_field = TRB_LEN(trb_buff_len) |
3238                         remainder |
3239                         TRB_INTR_TARGET(0);
3240
3241                 if (num_trbs > 1)
3242                         more_trbs_coming = true;
3243                 else
3244                         more_trbs_coming = false;
3245                 queue_trb(xhci, ep_ring, more_trbs_coming,
3246                                 lower_32_bits(addr),
3247                                 upper_32_bits(addr),
3248                                 length_field,
3249                                 field | TRB_TYPE(TRB_NORMAL));
3250                 --num_trbs;
3251                 running_total += trb_buff_len;
3252
3253                 /* Calculate length for next transfer --
3254                  * Are we done queueing all the TRBs for this sg entry?
3255                  */
3256                 this_sg_len -= trb_buff_len;
3257                 if (this_sg_len == 0) {
3258                         --num_sgs;
3259                         if (num_sgs == 0)
3260                                 break;
3261                         sg = sg_next(sg);
3262                         addr = (u64) sg_dma_address(sg);
3263                         this_sg_len = sg_dma_len(sg);
3264                 } else {
3265                         addr += trb_buff_len;
3266                 }
3267
3268                 trb_buff_len = TRB_MAX_BUFF_SIZE -
3269                         (addr & (TRB_MAX_BUFF_SIZE - 1));
3270                 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3271                 if (running_total + trb_buff_len > urb->transfer_buffer_length)
3272                         trb_buff_len =
3273                                 urb->transfer_buffer_length - running_total;
3274         } while (running_total < urb->transfer_buffer_length);
3275
3276         check_trb_math(urb, num_trbs, running_total);
3277         giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3278                         start_cycle, start_trb);
3279         return 0;
3280 }
3281
3282 /* This is very similar to what ehci-q.c qtd_fill() does */
3283 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3284                 struct urb *urb, int slot_id, unsigned int ep_index)
3285 {
3286         struct xhci_ring *ep_ring;
3287         struct urb_priv *urb_priv;
3288         struct xhci_td *td;
3289         int num_trbs;
3290         struct xhci_generic_trb *start_trb;
3291         bool first_trb;
3292         bool more_trbs_coming;
3293         int start_cycle;
3294         u32 field, length_field;
3295
3296         int running_total, trb_buff_len, ret;
3297         unsigned int total_packet_count;
3298         u64 addr;
3299
3300         if (urb->num_sgs)
3301                 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
3302
3303         ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3304         if (!ep_ring)
3305                 return -EINVAL;
3306
3307         num_trbs = 0;
3308         /* How much data is (potentially) left before the 64KB boundary? */
3309         running_total = TRB_MAX_BUFF_SIZE -
3310                 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3311         running_total &= TRB_MAX_BUFF_SIZE - 1;
3312
3313         /* If there's some data on this 64KB chunk, or we have to send a
3314          * zero-length transfer, we need at least one TRB
3315          */
3316         if (running_total != 0 || urb->transfer_buffer_length == 0)
3317                 num_trbs++;
3318         /* How many more 64KB chunks to transfer, how many more TRBs? */
3319         while (running_total < urb->transfer_buffer_length) {
3320                 num_trbs++;
3321                 running_total += TRB_MAX_BUFF_SIZE;
3322         }
3323         /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
3324
3325         ret = prepare_transfer(xhci, xhci->devs[slot_id],
3326                         ep_index, urb->stream_id,
3327                         num_trbs, urb, 0, mem_flags);
3328         if (ret < 0)
3329                 return ret;
3330
3331         urb_priv = urb->hcpriv;
3332         td = urb_priv->td[0];
3333
3334         /*
3335          * Don't give the first TRB to the hardware (by toggling the cycle bit)
3336          * until we've finished creating all the other TRBs.  The ring's cycle
3337          * state may change as we enqueue the other TRBs, so save it too.
3338          */
3339         start_trb = &ep_ring->enqueue->generic;
3340         start_cycle = ep_ring->cycle_state;
3341
3342         running_total = 0;
3343         total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3344                         usb_endpoint_maxp(&urb->ep->desc));
3345         /* How much data is in the first TRB? */
3346         addr = (u64) urb->transfer_dma;
3347         trb_buff_len = TRB_MAX_BUFF_SIZE -
3348                 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3349         if (trb_buff_len > urb->transfer_buffer_length)
3350                 trb_buff_len = urb->transfer_buffer_length;
3351
3352         first_trb = true;
3353
3354         /* Queue the first TRB, even if it's zero-length */
3355         do {
3356                 u32 remainder = 0;
3357                 field = 0;
3358
3359                 /* Don't change the cycle bit of the first TRB until later */
3360                 if (first_trb) {
3361                         first_trb = false;
3362                         if (start_cycle == 0)
3363                                 field |= 0x1;
3364                 } else
3365                         field |= ep_ring->cycle_state;
3366
3367                 /* Chain all the TRBs together; clear the chain bit in the last
3368                  * TRB to indicate it's the last TRB in the chain.
3369                  */
3370                 if (num_trbs > 1) {
3371                         field |= TRB_CHAIN;
3372                 } else {
3373                         /* FIXME - add check for ZERO_PACKET flag before this */
3374                         td->last_trb = ep_ring->enqueue;
3375                         field |= TRB_IOC;
3376                 }
3377
3378                 /* Only set interrupt on short packet for IN endpoints */
3379                 if (usb_urb_dir_in(urb))
3380                         field |= TRB_ISP;
3381
3382                 /* Set the TRB length, TD size, and interrupter fields. */
3383                 if (xhci->hci_version < 0x100) {
3384                         remainder = xhci_td_remainder(
3385                                         urb->transfer_buffer_length -
3386                                         running_total);
3387                 } else {
3388                         remainder = xhci_v1_0_td_remainder(running_total,
3389                                         trb_buff_len, total_packet_count, urb,
3390                                         num_trbs - 1);
3391                 }
3392                 length_field = TRB_LEN(trb_buff_len) |
3393                         remainder |
3394                         TRB_INTR_TARGET(0);
3395
3396                 if (num_trbs > 1)
3397                         more_trbs_coming = true;
3398                 else
3399                         more_trbs_coming = false;
3400                 queue_trb(xhci, ep_ring, more_trbs_coming,
3401                                 lower_32_bits(addr),
3402                                 upper_32_bits(addr),
3403                                 length_field,
3404                                 field | TRB_TYPE(TRB_NORMAL));
3405                 --num_trbs;
3406                 running_total += trb_buff_len;
3407
3408                 /* Calculate length for next transfer */
3409                 addr += trb_buff_len;
3410                 trb_buff_len = urb->transfer_buffer_length - running_total;
3411                 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
3412                         trb_buff_len = TRB_MAX_BUFF_SIZE;
3413         } while (running_total < urb->transfer_buffer_length);
3414
3415         check_trb_math(urb, num_trbs, running_total);
3416         giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3417                         start_cycle, start_trb);
3418         return 0;
3419 }
3420
3421 /* Caller must have locked xhci->lock */
3422 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3423                 struct urb *urb, int slot_id, unsigned int ep_index)
3424 {
3425         struct xhci_ring *ep_ring;
3426         int num_trbs;
3427         int ret;
3428         struct usb_ctrlrequest *setup;
3429         struct xhci_generic_trb *start_trb;
3430         int start_cycle;
3431         u32 field, length_field;
3432         struct urb_priv *urb_priv;
3433         struct xhci_td *td;
3434
3435         ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3436         if (!ep_ring)
3437                 return -EINVAL;
3438
3439         /*
3440          * Need to copy setup packet into setup TRB, so we can't use the setup
3441          * DMA address.
3442          */
3443         if (!urb->setup_packet)
3444                 return -EINVAL;
3445
3446         /* 1 TRB for setup, 1 for status */
3447         num_trbs = 2;
3448         /*
3449          * Don't need to check if we need additional event data and normal TRBs,
3450          * since data in control transfers will never get bigger than 16MB
3451          * XXX: can we get a buffer that crosses 64KB boundaries?
3452          */
3453         if (urb->transfer_buffer_length > 0)
3454                 num_trbs++;
3455         ret = prepare_transfer(xhci, xhci->devs[slot_id],
3456                         ep_index, urb->stream_id,
3457                         num_trbs, urb, 0, mem_flags);
3458         if (ret < 0)
3459                 return ret;
3460
3461         urb_priv = urb->hcpriv;
3462         td = urb_priv->td[0];
3463
3464         /*
3465          * Don't give the first TRB to the hardware (by toggling the cycle bit)
3466          * until we've finished creating all the other TRBs.  The ring's cycle
3467          * state may change as we enqueue the other TRBs, so save it too.
3468          */
3469         start_trb = &ep_ring->enqueue->generic;
3470         start_cycle = ep_ring->cycle_state;
3471
3472         /* Queue setup TRB - see section 6.4.1.2.1 */
3473         /* FIXME better way to translate setup_packet into two u32 fields? */
3474         setup = (struct usb_ctrlrequest *) urb->setup_packet;
3475         field = 0;
3476         field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3477         if (start_cycle == 0)
3478                 field |= 0x1;
3479
3480         /* xHCI 1.0 6.4.1.2.1: Transfer Type field */
3481         if (xhci->hci_version == 0x100) {
3482                 if (urb->transfer_buffer_length > 0) {
3483                         if (setup->bRequestType & USB_DIR_IN)
3484                                 field |= TRB_TX_TYPE(TRB_DATA_IN);
3485                         else
3486                                 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3487                 }
3488         }
3489
3490         queue_trb(xhci, ep_ring, true,
3491                   setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3492                   le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3493                   TRB_LEN(8) | TRB_INTR_TARGET(0),
3494                   /* Immediate data in pointer */
3495                   field);
3496
3497         /* If there's data, queue data TRBs */
3498         /* Only set interrupt on short packet for IN endpoints */
3499         if (usb_urb_dir_in(urb))
3500                 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3501         else
3502                 field = TRB_TYPE(TRB_DATA);
3503
3504         length_field = TRB_LEN(urb->transfer_buffer_length) |
3505                 xhci_td_remainder(urb->transfer_buffer_length) |
3506                 TRB_INTR_TARGET(0);
3507         if (urb->transfer_buffer_length > 0) {
3508                 if (setup->bRequestType & USB_DIR_IN)
3509                         field |= TRB_DIR_IN;
3510                 queue_trb(xhci, ep_ring, true,
3511                                 lower_32_bits(urb->transfer_dma),
3512                                 upper_32_bits(urb->transfer_dma),
3513                                 length_field,
3514                                 field | ep_ring->cycle_state);
3515         }
3516
3517         /* Save the DMA address of the last TRB in the TD */
3518         td->last_trb = ep_ring->enqueue;
3519
3520         /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3521         /* If the device sent data, the status stage is an OUT transfer */
3522         if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3523                 field = 0;
3524         else
3525                 field = TRB_DIR_IN;
3526         queue_trb(xhci, ep_ring, false,
3527                         0,
3528                         0,
3529                         TRB_INTR_TARGET(0),
3530                         /* Event on completion */
3531                         field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3532
3533         giveback_first_trb(xhci, slot_id, ep_index, 0,
3534                         start_cycle, start_trb);
3535         return 0;
3536 }
3537
3538 static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
3539                 struct urb *urb, int i)
3540 {
3541         int num_trbs = 0;
3542         u64 addr, td_len;
3543
3544         addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3545         td_len = urb->iso_frame_desc[i].length;
3546
3547         num_trbs = DIV_ROUND_UP(td_len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3548                         TRB_MAX_BUFF_SIZE);
3549         if (num_trbs == 0)
3550                 num_trbs++;
3551
3552         return num_trbs;
3553 }
3554
3555 /*
3556  * The transfer burst count field of the isochronous TRB defines the number of
3557  * bursts that are required to move all packets in this TD.  Only SuperSpeed
3558  * devices can burst up to bMaxBurst number of packets per service interval.
3559  * This field is zero based, meaning a value of zero in the field means one
3560  * burst.  Basically, for everything but SuperSpeed devices, this field will be
3561  * zero.  Only xHCI 1.0 host controllers support this field.
3562  */
3563 static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3564                 struct usb_device *udev,
3565                 struct urb *urb, unsigned int total_packet_count)
3566 {
3567         unsigned int max_burst;
3568
3569         if (xhci->hci_version < 0x100 || udev->speed != USB_SPEED_SUPER)
3570                 return 0;
3571
3572         max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3573         return roundup(total_packet_count, max_burst + 1) - 1;
3574 }
3575
3576 /*
3577  * Returns the number of packets in the last "burst" of packets.  This field is
3578  * valid for all speeds of devices.  USB 2.0 devices can only do one "burst", so
3579  * the last burst packet count is equal to the total number of packets in the
3580  * TD.  SuperSpeed endpoints can have up to 3 bursts.  All but the last burst
3581  * must contain (bMaxBurst + 1) number of packets, but the last burst can
3582  * contain 1 to (bMaxBurst + 1) packets.
3583  */
3584 static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3585                 struct usb_device *udev,
3586                 struct urb *urb, unsigned int total_packet_count)
3587 {
3588         unsigned int max_burst;
3589         unsigned int residue;
3590
3591         if (xhci->hci_version < 0x100)
3592                 return 0;
3593
3594         switch (udev->speed) {
3595         case USB_SPEED_SUPER:
3596                 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3597                 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3598                 residue = total_packet_count % (max_burst + 1);
3599                 /* If residue is zero, the last burst contains (max_burst + 1)
3600                  * number of packets, but the TLBPC field is zero-based.
3601                  */
3602                 if (residue == 0)
3603                         return max_burst;
3604                 return residue - 1;
3605         default:
3606                 if (total_packet_count == 0)
3607                         return 0;
3608                 return total_packet_count - 1;
3609         }
3610 }
3611
3612 /* This is for isoc transfer */
3613 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3614                 struct urb *urb, int slot_id, unsigned int ep_index)
3615 {
3616         struct xhci_ring *ep_ring;
3617         struct urb_priv *urb_priv;
3618         struct xhci_td *td;
3619         int num_tds, trbs_per_td;
3620         struct xhci_generic_trb *start_trb;
3621         bool first_trb;
3622         int start_cycle;
3623         u32 field, length_field;
3624         int running_total, trb_buff_len, td_len, td_remain_len, ret;
3625         u64 start_addr, addr;
3626         int i, j;
3627         bool more_trbs_coming;
3628
3629         ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3630
3631         num_tds = urb->number_of_packets;
3632         if (num_tds < 1) {
3633                 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3634                 return -EINVAL;
3635         }
3636
3637         start_addr = (u64) urb->transfer_dma;
3638         start_trb = &ep_ring->enqueue->generic;
3639         start_cycle = ep_ring->cycle_state;
3640
3641         urb_priv = urb->hcpriv;
3642         /* Queue the first TRB, even if it's zero-length */
3643         for (i = 0; i < num_tds; i++) {
3644                 unsigned int total_packet_count;
3645                 unsigned int burst_count;
3646                 unsigned int residue;
3647
3648                 first_trb = true;
3649                 running_total = 0;
3650                 addr = start_addr + urb->iso_frame_desc[i].offset;
3651                 td_len = urb->iso_frame_desc[i].length;
3652                 td_remain_len = td_len;
3653                 total_packet_count = DIV_ROUND_UP(td_len,
3654                                 GET_MAX_PACKET(
3655                                         usb_endpoint_maxp(&urb->ep->desc)));
3656                 /* A zero-length transfer still involves at least one packet. */
3657                 if (total_packet_count == 0)
3658                         total_packet_count++;
3659                 burst_count = xhci_get_burst_count(xhci, urb->dev, urb,
3660                                 total_packet_count);
3661                 residue = xhci_get_last_burst_packet_count(xhci,
3662                                 urb->dev, urb, total_packet_count);
3663
3664                 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
3665
3666                 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3667                                 urb->stream_id, trbs_per_td, urb, i, mem_flags);
3668                 if (ret < 0) {
3669                         if (i == 0)
3670                                 return ret;
3671                         goto cleanup;
3672                 }
3673
3674                 td = urb_priv->td[i];
3675                 for (j = 0; j < trbs_per_td; j++) {
3676                         u32 remainder = 0;
3677                         field = 0;
3678
3679                         if (first_trb) {
3680                                 field = TRB_TBC(burst_count) |
3681                                         TRB_TLBPC(residue);
3682                                 /* Queue the isoc TRB */
3683                                 field |= TRB_TYPE(TRB_ISOC);
3684                                 /* Assume URB_ISO_ASAP is set */
3685                                 field |= TRB_SIA;
3686                                 if (i == 0) {
3687                                         if (start_cycle == 0)
3688                                                 field |= 0x1;
3689                                 } else
3690                                         field |= ep_ring->cycle_state;
3691                                 first_trb = false;
3692                         } else {
3693                                 /* Queue other normal TRBs */
3694                                 field |= TRB_TYPE(TRB_NORMAL);
3695                                 field |= ep_ring->cycle_state;
3696                         }
3697
3698                         /* Only set interrupt on short packet for IN EPs */
3699                         if (usb_urb_dir_in(urb))
3700                                 field |= TRB_ISP;
3701
3702                         /* Chain all the TRBs together; clear the chain bit in
3703                          * the last TRB to indicate it's the last TRB in the
3704                          * chain.
3705                          */
3706                         if (j < trbs_per_td - 1) {
3707                                 field |= TRB_CHAIN;
3708                                 more_trbs_coming = true;
3709                         } else {
3710                                 td->last_trb = ep_ring->enqueue;
3711                                 field |= TRB_IOC;
3712                                 if (xhci->hci_version == 0x100 &&
3713                                                 !(xhci->quirks &
3714                                                         XHCI_AVOID_BEI)) {
3715                                         /* Set BEI bit except for the last td */
3716                                         if (i < num_tds - 1)
3717                                                 field |= TRB_BEI;
3718                                 }
3719                                 more_trbs_coming = false;
3720                         }
3721
3722                         /* Calculate TRB length */
3723                         trb_buff_len = TRB_MAX_BUFF_SIZE -
3724                                 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
3725                         if (trb_buff_len > td_remain_len)
3726                                 trb_buff_len = td_remain_len;
3727
3728                         /* Set the TRB length, TD size, & interrupter fields. */
3729                         if (xhci->hci_version < 0x100) {
3730                                 remainder = xhci_td_remainder(
3731                                                 td_len - running_total);
3732                         } else {
3733                                 remainder = xhci_v1_0_td_remainder(
3734                                                 running_total, trb_buff_len,
3735                                                 total_packet_count, urb,
3736                                                 (trbs_per_td - j - 1));
3737                         }
3738                         length_field = TRB_LEN(trb_buff_len) |
3739                                 remainder |
3740                                 TRB_INTR_TARGET(0);
3741
3742                         queue_trb(xhci, ep_ring, more_trbs_coming,
3743                                 lower_32_bits(addr),
3744                                 upper_32_bits(addr),
3745                                 length_field,
3746                                 field);
3747                         running_total += trb_buff_len;
3748
3749                         addr += trb_buff_len;
3750                         td_remain_len -= trb_buff_len;
3751                 }
3752
3753                 /* Check TD length */
3754                 if (running_total != td_len) {
3755                         xhci_err(xhci, "ISOC TD length unmatch\n");
3756                         ret = -EINVAL;
3757                         goto cleanup;
3758                 }
3759         }
3760
3761         if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
3762                 if (xhci->quirks & XHCI_AMD_PLL_FIX)
3763                         usb_amd_quirk_pll_disable();
3764         }
3765         xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
3766
3767         giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3768                         start_cycle, start_trb);
3769         return 0;
3770 cleanup:
3771         /* Clean up a partially enqueued isoc transfer. */
3772
3773         for (i--; i >= 0; i--)
3774                 list_del_init(&urb_priv->td[i]->td_list);
3775
3776         /* Use the first TD as a temporary variable to turn the TDs we've queued
3777          * into No-ops with a software-owned cycle bit. That way the hardware
3778          * won't accidentally start executing bogus TDs when we partially
3779          * overwrite them.  td->first_trb and td->start_seg are already set.
3780          */
3781         urb_priv->td[0]->last_trb = ep_ring->enqueue;
3782         /* Every TRB except the first & last will have its cycle bit flipped. */
3783         td_to_noop(xhci, ep_ring, urb_priv->td[0], true);
3784
3785         /* Reset the ring enqueue back to the first TRB and its cycle bit. */
3786         ep_ring->enqueue = urb_priv->td[0]->first_trb;
3787         ep_ring->enq_seg = urb_priv->td[0]->start_seg;
3788         ep_ring->cycle_state = start_cycle;
3789         ep_ring->num_trbs_free = ep_ring->num_trbs_free_temp;
3790         usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
3791         return ret;
3792 }
3793
3794 /*
3795  * Check transfer ring to guarantee there is enough room for the urb.
3796  * Update ISO URB start_frame and interval.
3797  * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3798  * update the urb->start_frame by now.
3799  * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3800  */
3801 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3802                 struct urb *urb, int slot_id, unsigned int ep_index)
3803 {
3804         struct xhci_virt_device *xdev;
3805         struct xhci_ring *ep_ring;
3806         struct xhci_ep_ctx *ep_ctx;
3807         int start_frame;
3808         int xhci_interval;
3809         int ep_interval;
3810         int num_tds, num_trbs, i;
3811         int ret;
3812
3813         xdev = xhci->devs[slot_id];
3814         ep_ring = xdev->eps[ep_index].ring;
3815         ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3816
3817         num_trbs = 0;
3818         num_tds = urb->number_of_packets;
3819         for (i = 0; i < num_tds; i++)
3820                 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3821
3822         /* Check the ring to guarantee there is enough room for the whole urb.
3823          * Do not insert any td of the urb to the ring if the check failed.
3824          */
3825         ret = prepare_ring(xhci, ep_ring, le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3826                            num_trbs, mem_flags);
3827         if (ret)
3828                 return ret;
3829
3830         start_frame = xhci_readl(xhci, &xhci->run_regs->microframe_index);
3831         start_frame &= 0x3fff;
3832
3833         urb->start_frame = start_frame;
3834         if (urb->dev->speed == USB_SPEED_LOW ||
3835                         urb->dev->speed == USB_SPEED_FULL)
3836                 urb->start_frame >>= 3;
3837
3838         xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3839         ep_interval = urb->interval;
3840         /* Convert to microframes */
3841         if (urb->dev->speed == USB_SPEED_LOW ||
3842                         urb->dev->speed == USB_SPEED_FULL)
3843                 ep_interval *= 8;
3844         /* FIXME change this to a warning and a suggestion to use the new API
3845          * to set the polling interval (once the API is added).
3846          */
3847         if (xhci_interval != ep_interval) {
3848                 if (printk_ratelimit())
3849                         dev_dbg(&urb->dev->dev, "Driver uses different interval"
3850                                         " (%d microframe%s) than xHCI "
3851                                         "(%d microframe%s)\n",
3852                                         ep_interval,
3853                                         ep_interval == 1 ? "" : "s",
3854                                         xhci_interval,
3855                                         xhci_interval == 1 ? "" : "s");
3856                 urb->interval = xhci_interval;
3857                 /* Convert back to frames for LS/FS devices */
3858                 if (urb->dev->speed == USB_SPEED_LOW ||
3859                                 urb->dev->speed == USB_SPEED_FULL)
3860                         urb->interval /= 8;
3861         }
3862         ep_ring->num_trbs_free_temp = ep_ring->num_trbs_free;
3863
3864         return xhci_queue_isoc_tx(xhci, mem_flags, urb, slot_id, ep_index);
3865 }
3866
3867 /****           Command Ring Operations         ****/
3868
3869 /* Generic function for queueing a command TRB on the command ring.
3870  * Check to make sure there's room on the command ring for one command TRB.
3871  * Also check that there's room reserved for commands that must not fail.
3872  * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3873  * then only check for the number of reserved spots.
3874  * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3875  * because the command event handler may want to resubmit a failed command.
3876  */
3877 static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
3878                 u32 field3, u32 field4, bool command_must_succeed)
3879 {
3880         int reserved_trbs = xhci->cmd_ring_reserved_trbs;
3881         int ret;
3882
3883         if (!command_must_succeed)
3884                 reserved_trbs++;
3885
3886         ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3887                         reserved_trbs, GFP_ATOMIC);
3888         if (ret < 0) {
3889                 xhci_err(xhci, "ERR: No room for command on command ring\n");
3890                 if (command_must_succeed)
3891                         xhci_err(xhci, "ERR: Reserved TRB counting for "
3892                                         "unfailable commands failed.\n");
3893                 return ret;
3894         }
3895         queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
3896                         field4 | xhci->cmd_ring->cycle_state);
3897         return 0;
3898 }
3899
3900 /* Queue a slot enable or disable request on the command ring */
3901 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
3902 {
3903         return queue_command(xhci, 0, 0, 0,
3904                         TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3905 }
3906
3907 /* Queue an address device command TRB */
3908 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3909                 u32 slot_id)
3910 {
3911         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3912                         upper_32_bits(in_ctx_ptr), 0,
3913                         TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
3914                         false);
3915 }
3916
3917 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
3918                 u32 field1, u32 field2, u32 field3, u32 field4)
3919 {
3920         return queue_command(xhci, field1, field2, field3, field4, false);
3921 }
3922
3923 /* Queue a reset device command TRB */
3924 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id)
3925 {
3926         return queue_command(xhci, 0, 0, 0,
3927                         TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
3928                         false);
3929 }
3930
3931 /* Queue a configure endpoint command TRB */
3932 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3933                 u32 slot_id, bool command_must_succeed)
3934 {
3935         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3936                         upper_32_bits(in_ctx_ptr), 0,
3937                         TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3938                         command_must_succeed);
3939 }
3940
3941 /* Queue an evaluate context command TRB */
3942 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3943                 u32 slot_id, bool command_must_succeed)
3944 {
3945         return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3946                         upper_32_bits(in_ctx_ptr), 0,
3947                         TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
3948                         command_must_succeed);
3949 }
3950
3951 /*
3952  * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3953  * activity on an endpoint that is about to be suspended.
3954  */
3955 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
3956                 unsigned int ep_index, int suspend)
3957 {
3958         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3959         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3960         u32 type = TRB_TYPE(TRB_STOP_RING);
3961         u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
3962
3963         return queue_command(xhci, 0, 0, 0,
3964                         trb_slot_id | trb_ep_index | type | trb_suspend, false);
3965 }
3966
3967 /* Set Transfer Ring Dequeue Pointer command.
3968  * This should not be used for endpoints that have streams enabled.
3969  */
3970 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
3971                 unsigned int ep_index, unsigned int stream_id,
3972                 struct xhci_segment *deq_seg,
3973                 union xhci_trb *deq_ptr, u32 cycle_state)
3974 {
3975         dma_addr_t addr;
3976         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3977         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3978         u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
3979         u32 type = TRB_TYPE(TRB_SET_DEQ);
3980         struct xhci_virt_ep *ep;
3981
3982         addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
3983         if (addr == 0) {
3984                 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3985                 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3986                                 deq_seg, deq_ptr);
3987                 return 0;
3988         }
3989         ep = &xhci->devs[slot_id]->eps[ep_index];
3990         if ((ep->ep_state & SET_DEQ_PENDING)) {
3991                 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3992                 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
3993                 return 0;
3994         }
3995         ep->queued_deq_seg = deq_seg;
3996         ep->queued_deq_ptr = deq_ptr;
3997         return queue_command(xhci, lower_32_bits(addr) | cycle_state,
3998                         upper_32_bits(addr), trb_stream_id,
3999                         trb_slot_id | trb_ep_index | type, false);
4000 }
4001
4002 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
4003                 unsigned int ep_index)
4004 {
4005         u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
4006         u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
4007         u32 type = TRB_TYPE(TRB_RESET_EP);
4008
4009         return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,
4010                         false);
4011 }