drivers/usb/host/xhci-mem.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 #include <linux/usb.h>
  24 #include <linux/pci.h>
  25 #include <linux/dmapool.h>
  26
  27 #include "xhci.h"
  28
  29 /*
  30  * Allocates a generic ring segment from the ring pool, sets the dma address,
  31  * initializes the segment to zero, and sets the private next pointer to NULL.
  32  *
  33  * Section 4.11.1.1:
  34  * "All components of all Command and Transfer TRBs shall be initialized to '0'"
  35  */
  36 static struct xhci_segment *xhci_segment_alloc(struct xhci_hcd *xhci, gfp_t flags)
  37 {
  38         struct xhci_segment *seg;
  39         dma_addr_t      dma;
  40
  41         seg = kzalloc(sizeof *seg, flags);
  42         if (!seg)
  43                 return 0;
  44         xhci_dbg(xhci, "Allocating priv segment structure at %p\n", seg);
  45
  46         seg->trbs = dma_pool_alloc(xhci->segment_pool, flags, &dma);
  47         if (!seg->trbs) {
  48                 kfree(seg);
  49                 return 0;
  50         }
  51         xhci_dbg(xhci, "// Allocating segment at %p (virtual) 0x%llx (DMA)\n",
  52                         seg->trbs, (unsigned long long)dma);
  53
  54         memset(seg->trbs, 0, SEGMENT_SIZE);
  55         seg->dma = dma;
  56         seg->next = NULL;
  57
  58         return seg;
  59 }
  60
  61 static void xhci_segment_free(struct xhci_hcd *xhci, struct xhci_segment *seg)
  62 {
  63         if (!seg)
  64                 return;
  65         if (seg->trbs) {
  66                 xhci_dbg(xhci, "Freeing DMA segment at %p (virtual) 0x%llx (DMA)\n",
  67                                 seg->trbs, (unsigned long long)seg->dma);
  68                 dma_pool_free(xhci->segment_pool, seg->trbs, seg->dma);
  69                 seg->trbs = NULL;
  70         }
  71         xhci_dbg(xhci, "Freeing priv segment structure at %p\n", seg);
  72         kfree(seg);
  73 }
  74
  75 /*
  76  * Make the prev segment point to the next segment.
  77  *
  78  * Change the last TRB in the prev segment to be a Link TRB which points to the
  79  * DMA address of the next segment.  The caller needs to set any Link TRB
  80  * related flags, such as End TRB, Toggle Cycle, and no snoop.
  81  */
  82 static void xhci_link_segments(struct xhci_hcd *xhci, struct xhci_segment *prev,
  83                 struct xhci_segment *next, bool link_trbs)
  84 {
  85         u32 val;
  86
  87         if (!prev || !next)
  88                 return;
  89         prev->next = next;
  90         if (link_trbs) {
  91                 prev->trbs[TRBS_PER_SEGMENT-1].link.segment_ptr = next->dma;
  92
  93                 /* Set the last TRB in the segment to have a TRB type ID of Link TRB */
  94                 val = prev->trbs[TRBS_PER_SEGMENT-1].link.control;
  95                 val &= ~TRB_TYPE_BITMASK;
  96                 val |= TRB_TYPE(TRB_LINK);
  97                 /* Always set the chain bit with 0.95 hardware */
  98                 if (xhci_link_trb_quirk(xhci))
  99                         val |= TRB_CHAIN;
 100                 prev->trbs[TRBS_PER_SEGMENT-1].link.control = val;
 101         }
 102         xhci_dbg(xhci, "Linking segment 0x%llx to segment 0x%llx (DMA)\n",
 103                         (unsigned long long)prev->dma,
 104                         (unsigned long long)next->dma);
 105 }
 106
 107 /* XXX: Do we need the hcd structure in all these functions? */
 108 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring)
 109 {
 110         struct xhci_segment *seg;
 111         struct xhci_segment *first_seg;
 112
 113         if (!ring || !ring->first_seg)
 114                 return;
 115         first_seg = ring->first_seg;
 116         seg = first_seg->next;
 117         xhci_dbg(xhci, "Freeing ring at %p\n", ring);
 118         while (seg != first_seg) {
 119                 struct xhci_segment *next = seg->next;
 120                 xhci_segment_free(xhci, seg);
 121                 seg = next;
 122         }
 123         xhci_segment_free(xhci, first_seg);
 124         ring->first_seg = NULL;
 125         kfree(ring);
 126 }
 127
 128 static void xhci_initialize_ring_info(struct xhci_ring *ring)
 129 {
 130         /* The ring is empty, so the enqueue pointer == dequeue pointer */
 131         ring->enqueue = ring->first_seg->trbs;
 132         ring->enq_seg = ring->first_seg;
 133         ring->dequeue = ring->enqueue;
 134         ring->deq_seg = ring->first_seg;
 135         /* The ring is initialized to 0. The producer must write 1 to the cycle
 136          * bit to handover ownership of the TRB, so PCS = 1.  The consumer must
 137          * compare CCS to the cycle bit to check ownership, so CCS = 1.
 138          */
 139         ring->cycle_state = 1;
 140         /* Not necessary for new rings, but needed for re-initialized rings */
 141         ring->enq_updates = 0;
 142         ring->deq_updates = 0;
 143 }
 144
 145 /**
 146  * Create a new ring with zero or more segments.
 147  *
 148  * Link each segment together into a ring.
 149  * Set the end flag and the cycle toggle bit on the last segment.
 150  * See section 4.9.1 and figures 15 and 16.
 151  */
 152 static struct xhci_ring *xhci_ring_alloc(struct xhci_hcd *xhci,
 153                 unsigned int num_segs, bool link_trbs, gfp_t flags)
 154 {
 155         struct xhci_ring        *ring;
 156         struct xhci_segment     *prev;
 157
 158         ring = kzalloc(sizeof *(ring), flags);
 159         xhci_dbg(xhci, "Allocating ring at %p\n", ring);
 160         if (!ring)
 161                 return 0;
 162
 163         INIT_LIST_HEAD(&ring->td_list);
 164         if (num_segs == 0)
 165                 return ring;
 166
 167         ring->first_seg = xhci_segment_alloc(xhci, flags);
 168         if (!ring->first_seg)
 169                 goto fail;
 170         num_segs--;
 171
 172         prev = ring->first_seg;
 173         while (num_segs > 0) {
 174                 struct xhci_segment     *next;
 175
 176                 next = xhci_segment_alloc(xhci, flags);
 177                 if (!next)
 178                         goto fail;
 179                 xhci_link_segments(xhci, prev, next, link_trbs);
 180
 181                 prev = next;
 182                 num_segs--;
 183         }
 184         xhci_link_segments(xhci, prev, ring->first_seg, link_trbs);
 185
 186         if (link_trbs) {
 187                 /* See section 4.9.2.1 and 6.4.4.1 */
 188                 prev->trbs[TRBS_PER_SEGMENT-1].link.control |= (LINK_TOGGLE);
 189                 xhci_dbg(xhci, "Wrote link toggle flag to"
 190                                 " segment %p (virtual), 0x%llx (DMA)\n",
 191                                 prev, (unsigned long long)prev->dma);
 192         }
 193         xhci_initialize_ring_info(ring);
 194         return ring;
 195
 196 fail:
 197         xhci_ring_free(xhci, ring);
 198         return 0;
 199 }
 200
 201 void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
 202                 struct xhci_virt_device *virt_dev,
 203                 unsigned int ep_index)
 204 {
 205         int rings_cached;
 206
 207         rings_cached = virt_dev->num_rings_cached;
 208         if (rings_cached < XHCI_MAX_RINGS_CACHED) {
 209                 virt_dev->num_rings_cached++;
 210                 rings_cached = virt_dev->num_rings_cached;
 211                 virt_dev->ring_cache[rings_cached] =
 212                         virt_dev->eps[ep_index].ring;
 213                 xhci_dbg(xhci, "Cached old ring, "
 214                                 "%d ring%s cached\n",
 215                                 rings_cached,
 216                                 (rings_cached > 1) ? "s" : "");
 217         } else {
 218                 xhci_ring_free(xhci, virt_dev->eps[ep_index].ring);
 219                 xhci_dbg(xhci, "Ring cache full (%d rings), "
 220                                 "freeing ring\n",
 221                                 virt_dev->num_rings_cached);
 222         }
 223         virt_dev->eps[ep_index].ring = NULL;
 224 }
 225
 226 /* Zero an endpoint ring (except for link TRBs) and move the enqueue and dequeue
 227  * pointers to the beginning of the ring.
 228  */
 229 static void xhci_reinit_cached_ring(struct xhci_hcd *xhci,
 230                 struct xhci_ring *ring)
 231 {
 232         struct xhci_segment     *seg = ring->first_seg;
 233         do {
 234                 memset(seg->trbs, 0,
 235                                 sizeof(union xhci_trb)*TRBS_PER_SEGMENT);
 236                 /* All endpoint rings have link TRBs */
 237                 xhci_link_segments(xhci, seg, seg->next, 1);
 238                 seg = seg->next;
 239         } while (seg != ring->first_seg);
 240         xhci_initialize_ring_info(ring);
 241         /* td list should be empty since all URBs have been cancelled,
 242          * but just in case...
 243          */
 244         INIT_LIST_HEAD(&ring->td_list);
 245 }
 246
 247 #define CTX_SIZE(_hcc) (HCC_64BYTE_CONTEXT(_hcc) ? 64 : 32)
 248
 249 struct xhci_container_ctx *xhci_alloc_container_ctx(struct xhci_hcd *xhci,
 250                                                     int type, gfp_t flags)
 251 {
 252         struct xhci_container_ctx *ctx = kzalloc(sizeof(*ctx), flags);
 253         if (!ctx)
 254                 return NULL;
 255
 256         BUG_ON((type != XHCI_CTX_TYPE_DEVICE) && (type != XHCI_CTX_TYPE_INPUT));
 257         ctx->type = type;
 258         ctx->size = HCC_64BYTE_CONTEXT(xhci->hcc_params) ? 2048 : 1024;
 259         if (type == XHCI_CTX_TYPE_INPUT)
 260                 ctx->size += CTX_SIZE(xhci->hcc_params);
 261
 262         ctx->bytes = dma_pool_alloc(xhci->device_pool, flags, &ctx->dma);
 263         memset(ctx->bytes, 0, ctx->size);
 264         return ctx;
 265 }
 266
 267 void xhci_free_container_ctx(struct xhci_hcd *xhci,
 268                              struct xhci_container_ctx *ctx)
 269 {
 270         if (!ctx)
 271                 return;
 272         dma_pool_free(xhci->device_pool, ctx->bytes, ctx->dma);
 273         kfree(ctx);
 274 }
 275
 276 struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_hcd *xhci,
 277                                               struct xhci_container_ctx *ctx)
 278 {
 279         BUG_ON(ctx->type != XHCI_CTX_TYPE_INPUT);
 280         return (struct xhci_input_control_ctx *)ctx->bytes;
 281 }
 282
 283 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci,
 284                                         struct xhci_container_ctx *ctx)
 285 {
 286         if (ctx->type == XHCI_CTX_TYPE_DEVICE)
 287                 return (struct xhci_slot_ctx *)ctx->bytes;
 288
 289         return (struct xhci_slot_ctx *)
 290                 (ctx->bytes + CTX_SIZE(xhci->hcc_params));
 291 }
 292
 293 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci,
 294                                     struct xhci_container_ctx *ctx,
 295                                     unsigned int ep_index)
 296 {
 297         /* increment ep index by offset of start of ep ctx array */
 298         ep_index++;
 299         if (ctx->type == XHCI_CTX_TYPE_INPUT)
 300                 ep_index++;
 301
 302         return (struct xhci_ep_ctx *)
 303                 (ctx->bytes + (ep_index * CTX_SIZE(xhci->hcc_params)));
 304 }
 305
 306 static void xhci_init_endpoint_timer(struct xhci_hcd *xhci,
 307                 struct xhci_virt_ep *ep)
 308 {
 309         init_timer(&ep->stop_cmd_timer);
 310         ep->stop_cmd_timer.data = (unsigned long) ep;
 311         ep->stop_cmd_timer.function = xhci_stop_endpoint_command_watchdog;
 312         ep->xhci = xhci;
 313 }
 314
 315 /* All the xhci_tds in the ring's TD list should be freed at this point */
 316 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id)
 317 {
 318         struct xhci_virt_device *dev;
 319         int i;
 320
 321         /* Slot ID 0 is reserved */
 322         if (slot_id == 0 || !xhci->devs[slot_id])
 323                 return;
 324
 325         dev = xhci->devs[slot_id];
 326         xhci->dcbaa->dev_context_ptrs[slot_id] = 0;
 327         if (!dev)
 328                 return;
 329
 330         for (i = 0; i < 31; ++i)
 331                 if (dev->eps[i].ring)
 332                         xhci_ring_free(xhci, dev->eps[i].ring);
 333
 334         if (dev->ring_cache) {
 335                 for (i = 0; i < dev->num_rings_cached; i++)
 336                         xhci_ring_free(xhci, dev->ring_cache[i]);
 337                 kfree(dev->ring_cache);
 338         }
 339
 340         if (dev->in_ctx)
 341                 xhci_free_container_ctx(xhci, dev->in_ctx);
 342         if (dev->out_ctx)
 343                 xhci_free_container_ctx(xhci, dev->out_ctx);
 344
 345         kfree(xhci->devs[slot_id]);
 346         xhci->devs[slot_id] = 0;
 347 }
 348
 349 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id,
 350                 struct usb_device *udev, gfp_t flags)
 351 {
 352         struct xhci_virt_device *dev;
 353         int i;
 354
 355         /* Slot ID 0 is reserved */
 356         if (slot_id == 0 || xhci->devs[slot_id]) {
 357                 xhci_warn(xhci, "Bad Slot ID %d\n", slot_id);
 358                 return 0;
 359         }
 360
 361         xhci->devs[slot_id] = kzalloc(sizeof(*xhci->devs[slot_id]), flags);
 362         if (!xhci->devs[slot_id])
 363                 return 0;
 364         dev = xhci->devs[slot_id];
 365
 366         /* Allocate the (output) device context that will be used in the HC. */
 367         dev->out_ctx = xhci_alloc_container_ctx(xhci, XHCI_CTX_TYPE_DEVICE, flags);
 368         if (!dev->out_ctx)
 369                 goto fail;
 370
 371         xhci_dbg(xhci, "Slot %d output ctx = 0x%llx (dma)\n", slot_id,
 372                         (unsigned long long)dev->out_ctx->dma);
 373
 374         /* Allocate the (input) device context for address device command */
 375         dev->in_ctx = xhci_alloc_container_ctx(xhci, XHCI_CTX_TYPE_INPUT, flags);
 376         if (!dev->in_ctx)
 377                 goto fail;
 378
 379         xhci_dbg(xhci, "Slot %d input ctx = 0x%llx (dma)\n", slot_id,
 380                         (unsigned long long)dev->in_ctx->dma);
 381
 382         /* Initialize the cancellation list and watchdog timers for each ep */
 383         for (i = 0; i < 31; i++) {
 384                 xhci_init_endpoint_timer(xhci, &dev->eps[i]);
 385                 INIT_LIST_HEAD(&dev->eps[i].cancelled_td_list);
 386         }
 387
 388         /* Allocate endpoint 0 ring */
 389         dev->eps[0].ring = xhci_ring_alloc(xhci, 1, true, flags);
 390         if (!dev->eps[0].ring)
 391                 goto fail;
 392
 393         /* Allocate pointers to the ring cache */
 394         dev->ring_cache = kzalloc(
 395                         sizeof(struct xhci_ring *)*XHCI_MAX_RINGS_CACHED,
 396                         flags);
 397         if (!dev->ring_cache)
 398                 goto fail;
 399         dev->num_rings_cached = 0;
 400
 401         init_completion(&dev->cmd_completion);
 402         INIT_LIST_HEAD(&dev->cmd_list);
 403
 404         /* Point to output device context in dcbaa. */
 405         xhci->dcbaa->dev_context_ptrs[slot_id] = dev->out_ctx->dma;
 406         xhci_dbg(xhci, "Set slot id %d dcbaa entry %p to 0x%llx\n",
 407                         slot_id,
 408                         &xhci->dcbaa->dev_context_ptrs[slot_id],
 409                         (unsigned long long) xhci->dcbaa->dev_context_ptrs[slot_id]);
 410
 411         return 1;
 412 fail:
 413         xhci_free_virt_device(xhci, slot_id);
 414         return 0;
 415 }
 416
 417 /* Setup an xHCI virtual device for a Set Address command */
 418 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev)
 419 {
 420         struct xhci_virt_device *dev;
 421         struct xhci_ep_ctx      *ep0_ctx;
 422         struct usb_device       *top_dev;
 423         struct xhci_slot_ctx    *slot_ctx;
 424         struct xhci_input_control_ctx *ctrl_ctx;
 425
 426         dev = xhci->devs[udev->slot_id];
 427         /* Slot ID 0 is reserved */
 428         if (udev->slot_id == 0 || !dev) {
 429                 xhci_warn(xhci, "Slot ID %d is not assigned to this device\n",
 430                                 udev->slot_id);
 431                 return -EINVAL;
 432         }
 433         ep0_ctx = xhci_get_ep_ctx(xhci, dev->in_ctx, 0);
 434         ctrl_ctx = xhci_get_input_control_ctx(xhci, dev->in_ctx);
 435         slot_ctx = xhci_get_slot_ctx(xhci, dev->in_ctx);
 436
 437         /* 2) New slot context and endpoint 0 context are valid*/
 438         ctrl_ctx->add_flags = SLOT_FLAG | EP0_FLAG;
 439
 440         /* 3) Only the control endpoint is valid - one endpoint context */
 441         slot_ctx->dev_info |= LAST_CTX(1);
 442
 443         slot_ctx->dev_info |= (u32) udev->route;
 444         switch (udev->speed) {
 445         case USB_SPEED_SUPER:
 446                 slot_ctx->dev_info |= (u32) SLOT_SPEED_SS;
 447                 break;
 448         case USB_SPEED_HIGH:
 449                 slot_ctx->dev_info |= (u32) SLOT_SPEED_HS;
 450                 break;
 451         case USB_SPEED_FULL:
 452                 slot_ctx->dev_info |= (u32) SLOT_SPEED_FS;
 453                 break;
 454         case USB_SPEED_LOW:
 455                 slot_ctx->dev_info |= (u32) SLOT_SPEED_LS;
 456                 break;
 457         case USB_SPEED_WIRELESS:
 458                 xhci_dbg(xhci, "FIXME xHCI doesn't support wireless speeds\n");
 459                 return -EINVAL;
 460                 break;
 461         default:
 462                 /* Speed was set earlier, this shouldn't happen. */
 463                 BUG();
 464         }
 465         /* Find the root hub port this device is under */
 466         for (top_dev = udev; top_dev->parent && top_dev->parent->parent;
 467                         top_dev = top_dev->parent)
 468                 /* Found device below root hub */;
 469         slot_ctx->dev_info2 |= (u32) ROOT_HUB_PORT(top_dev->portnum);
 470         xhci_dbg(xhci, "Set root hub portnum to %d\n", top_dev->portnum);
 471
 472         /* Is this a LS/FS device under a HS hub? */
 473         if ((udev->speed == USB_SPEED_LOW || udev->speed == USB_SPEED_FULL) &&
 474                         udev->tt) {
 475                 slot_ctx->tt_info = udev->tt->hub->slot_id;
 476                 slot_ctx->tt_info |= udev->ttport << 8;
 477                 if (udev->tt->multi)
 478                         slot_ctx->dev_info |= DEV_MTT;
 479         }
 480         xhci_dbg(xhci, "udev->tt = %p\n", udev->tt);
 481         xhci_dbg(xhci, "udev->ttport = 0x%x\n", udev->ttport);
 482
 483         /* Step 4 - ring already allocated */
 484         /* Step 5 */
 485         ep0_ctx->ep_info2 = EP_TYPE(CTRL_EP);
 486         /*
 487          * XXX: Not sure about wireless USB devices.
 488          */
 489         switch (udev->speed) {
 490         case USB_SPEED_SUPER:
 491                 ep0_ctx->ep_info2 |= MAX_PACKET(512);
 492                 break;
 493         case USB_SPEED_HIGH:
 494         /* USB core guesses at a 64-byte max packet first for FS devices */
 495         case USB_SPEED_FULL:
 496                 ep0_ctx->ep_info2 |= MAX_PACKET(64);
 497                 break;
 498         case USB_SPEED_LOW:
 499                 ep0_ctx->ep_info2 |= MAX_PACKET(8);
 500                 break;
 501         case USB_SPEED_WIRELESS:
 502                 xhci_dbg(xhci, "FIXME xHCI doesn't support wireless speeds\n");
 503                 return -EINVAL;
 504                 break;
 505         default:
 506                 /* New speed? */
 507                 BUG();
 508         }
 509         /* EP 0 can handle "burst" sizes of 1, so Max Burst Size field is 0 */
 510         ep0_ctx->ep_info2 |= MAX_BURST(0);
 511         ep0_ctx->ep_info2 |= ERROR_COUNT(3);
 512
 513         ep0_ctx->deq =
 514                 dev->eps[0].ring->first_seg->dma;
 515         ep0_ctx->deq |= dev->eps[0].ring->cycle_state;
 516
 517         /* Steps 7 and 8 were done in xhci_alloc_virt_device() */
 518
 519         return 0;
 520 }
 521
 522 /* Return the polling or NAK interval.
 523  *
 524  * The polling interval is expressed in "microframes".  If xHCI's Interval field
 525  * is set to N, it will service the endpoint every 2^(Interval)*125us.
 526  *
 527  * The NAK interval is one NAK per 1 to 255 microframes, or no NAKs if interval
 528  * is set to 0.
 529  */
 530 static inline unsigned int xhci_get_endpoint_interval(struct usb_device *udev,
 531                 struct usb_host_endpoint *ep)
 532 {
 533         unsigned int interval = 0;
 534
 535         switch (udev->speed) {
 536         case USB_SPEED_HIGH:
 537                 /* Max NAK rate */
 538                 if (usb_endpoint_xfer_control(&ep->desc) ||
 539                                 usb_endpoint_xfer_bulk(&ep->desc))
 540                         interval = ep->desc.bInterval;
 541                 /* Fall through - SS and HS isoc/int have same decoding */
 542         case USB_SPEED_SUPER:
 543                 if (usb_endpoint_xfer_int(&ep->desc) ||
 544                                 usb_endpoint_xfer_isoc(&ep->desc)) {
 545                         if (ep->desc.bInterval == 0)
 546                                 interval = 0;
 547                         else
 548                                 interval = ep->desc.bInterval - 1;
 549                         if (interval > 15)
 550                                 interval = 15;
 551                         if (interval != ep->desc.bInterval + 1)
 552                                 dev_warn(&udev->dev, "ep %#x - rounding interval to %d microframes\n",
 553                                                 ep->desc.bEndpointAddress, 1 << interval);
 554                 }
 555                 break;
 556         /* Convert bInterval (in 1-255 frames) to microframes and round down to
 557          * nearest power of 2.
 558          */
 559         case USB_SPEED_FULL:
 560         case USB_SPEED_LOW:
 561                 if (usb_endpoint_xfer_int(&ep->desc) ||
 562                                 usb_endpoint_xfer_isoc(&ep->desc)) {
 563                         interval = fls(8*ep->desc.bInterval) - 1;
 564                         if (interval > 10)
 565                                 interval = 10;
 566                         if (interval < 3)
 567                                 interval = 3;
 568                         if ((1 << interval) != 8*ep->desc.bInterval)
 569                                 dev_warn(&udev->dev, "ep %#x - rounding interval to %d microframes\n",
 570                                                 ep->desc.bEndpointAddress, 1 << interval);
 571                 }
 572                 break;
 573         default:
 574                 BUG();
 575         }
 576         return EP_INTERVAL(interval);
 577 }
 578
 579 static inline u32 xhci_get_endpoint_type(struct usb_device *udev,
 580                 struct usb_host_endpoint *ep)
 581 {
 582         int in;
 583         u32 type;
 584
 585         in = usb_endpoint_dir_in(&ep->desc);
 586         if (usb_endpoint_xfer_control(&ep->desc)) {
 587                 type = EP_TYPE(CTRL_EP);
 588         } else if (usb_endpoint_xfer_bulk(&ep->desc)) {
 589                 if (in)
 590                         type = EP_TYPE(BULK_IN_EP);
 591                 else
 592                         type = EP_TYPE(BULK_OUT_EP);
 593         } else if (usb_endpoint_xfer_isoc(&ep->desc)) {
 594                 if (in)
 595                         type = EP_TYPE(ISOC_IN_EP);
 596                 else
 597                         type = EP_TYPE(ISOC_OUT_EP);
 598         } else if (usb_endpoint_xfer_int(&ep->desc)) {
 599                 if (in)
 600                         type = EP_TYPE(INT_IN_EP);
 601                 else
 602                         type = EP_TYPE(INT_OUT_EP);
 603         } else {
 604                 BUG();
 605         }
 606         return type;
 607 }
 608
 609 int xhci_endpoint_init(struct xhci_hcd *xhci,
 610                 struct xhci_virt_device *virt_dev,
 611                 struct usb_device *udev,
 612                 struct usb_host_endpoint *ep,
 613                 gfp_t mem_flags)
 614 {
 615         unsigned int ep_index;
 616         struct xhci_ep_ctx *ep_ctx;
 617         struct xhci_ring *ep_ring;
 618         unsigned int max_packet;
 619         unsigned int max_burst;
 620
 621         ep_index = xhci_get_endpoint_index(&ep->desc);
 622         ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->in_ctx, ep_index);
 623
 624         /* Set up the endpoint ring */
 625         virt_dev->eps[ep_index].new_ring =
 626                 xhci_ring_alloc(xhci, 1, true, mem_flags);
 627         if (!virt_dev->eps[ep_index].new_ring) {
 628                 /* Attempt to use the ring cache */
 629                 if (virt_dev->num_rings_cached == 0)
 630                         return -ENOMEM;
 631                 virt_dev->eps[ep_index].new_ring =
 632                         virt_dev->ring_cache[virt_dev->num_rings_cached];
 633                 virt_dev->ring_cache[virt_dev->num_rings_cached] = NULL;
 634                 virt_dev->num_rings_cached--;
 635                 xhci_reinit_cached_ring(xhci, virt_dev->eps[ep_index].new_ring);
 636         }
 637         ep_ring = virt_dev->eps[ep_index].new_ring;
 638         ep_ctx->deq = ep_ring->first_seg->dma | ep_ring->cycle_state;
 639
 640         ep_ctx->ep_info = xhci_get_endpoint_interval(udev, ep);
 641
 642         /* FIXME dig Mult and streams info out of ep companion desc */
 643
 644         /* Allow 3 retries for everything but isoc;
 645          * error count = 0 means infinite retries.
 646          */
 647         if (!usb_endpoint_xfer_isoc(&ep->desc))
 648                 ep_ctx->ep_info2 = ERROR_COUNT(3);
 649         else
 650                 ep_ctx->ep_info2 = ERROR_COUNT(1);
 651
 652         ep_ctx->ep_info2 |= xhci_get_endpoint_type(udev, ep);
 653
 654         /* Set the max packet size and max burst */
 655         switch (udev->speed) {
 656         case USB_SPEED_SUPER:
 657                 max_packet = ep->desc.wMaxPacketSize;
 658                 ep_ctx->ep_info2 |= MAX_PACKET(max_packet);
 659                 /* dig out max burst from ep companion desc */
 660                 if (!ep->ss_ep_comp) {
 661                         xhci_warn(xhci, "WARN no SS endpoint companion descriptor.\n");
 662                         max_packet = 0;
 663                 } else {
 664                         max_packet = ep->ss_ep_comp->desc.bMaxBurst;
 665                 }
 666                 ep_ctx->ep_info2 |= MAX_BURST(max_packet);
 667                 break;
 668         case USB_SPEED_HIGH:
 669                 /* bits 11:12 specify the number of additional transaction
 670                  * opportunities per microframe (USB 2.0, section 9.6.6)
 671                  */
 672                 if (usb_endpoint_xfer_isoc(&ep->desc) ||
 673                                 usb_endpoint_xfer_int(&ep->desc)) {
 674                         max_burst = (ep->desc.wMaxPacketSize & 0x1800) >> 11;
 675                         ep_ctx->ep_info2 |= MAX_BURST(max_burst);
 676                 }
 677                 /* Fall through */
 678         case USB_SPEED_FULL:
 679         case USB_SPEED_LOW:
 680                 max_packet = ep->desc.wMaxPacketSize & 0x3ff;
 681                 ep_ctx->ep_info2 |= MAX_PACKET(max_packet);
 682                 break;
 683         default:
 684                 BUG();
 685         }
 686         /* FIXME Debug endpoint context */
 687         return 0;
 688 }
 689
 690 void xhci_endpoint_zero(struct xhci_hcd *xhci,
 691                 struct xhci_virt_device *virt_dev,
 692                 struct usb_host_endpoint *ep)
 693 {
 694         unsigned int ep_index;
 695         struct xhci_ep_ctx *ep_ctx;
 696
 697         ep_index = xhci_get_endpoint_index(&ep->desc);
 698         ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->in_ctx, ep_index);
 699
 700         ep_ctx->ep_info = 0;
 701         ep_ctx->ep_info2 = 0;
 702         ep_ctx->deq = 0;
 703         ep_ctx->tx_info = 0;
 704         /* Don't free the endpoint ring until the set interface or configuration
 705          * request succeeds.
 706          */
 707 }
 708
 709 /* Copy output xhci_ep_ctx to the input xhci_ep_ctx copy.
 710  * Useful when you want to change one particular aspect of the endpoint and then
 711  * issue a configure endpoint command.
 712  */
 713 void xhci_endpoint_copy(struct xhci_hcd *xhci,
 714                 struct xhci_container_ctx *in_ctx,
 715                 struct xhci_container_ctx *out_ctx,
 716                 unsigned int ep_index)
 717 {
 718         struct xhci_ep_ctx *out_ep_ctx;
 719         struct xhci_ep_ctx *in_ep_ctx;
 720
 721         out_ep_ctx = xhci_get_ep_ctx(xhci, out_ctx, ep_index);
 722         in_ep_ctx = xhci_get_ep_ctx(xhci, in_ctx, ep_index);
 723
 724         in_ep_ctx->ep_info = out_ep_ctx->ep_info;
 725         in_ep_ctx->ep_info2 = out_ep_ctx->ep_info2;
 726         in_ep_ctx->deq = out_ep_ctx->deq;
 727         in_ep_ctx->tx_info = out_ep_ctx->tx_info;
 728 }
 729
 730 /* Copy output xhci_slot_ctx to the input xhci_slot_ctx.
 731  * Useful when you want to change one particular aspect of the endpoint and then
 732  * issue a configure endpoint command.  Only the context entries field matters,
 733  * but we'll copy the whole thing anyway.
 734  */
 735 void xhci_slot_copy(struct xhci_hcd *xhci,
 736                 struct xhci_container_ctx *in_ctx,
 737                 struct xhci_container_ctx *out_ctx)
 738 {
 739         struct xhci_slot_ctx *in_slot_ctx;
 740         struct xhci_slot_ctx *out_slot_ctx;
 741
 742         in_slot_ctx = xhci_get_slot_ctx(xhci, in_ctx);
 743         out_slot_ctx = xhci_get_slot_ctx(xhci, out_ctx);
 744
 745         in_slot_ctx->dev_info = out_slot_ctx->dev_info;
 746         in_slot_ctx->dev_info2 = out_slot_ctx->dev_info2;
 747         in_slot_ctx->tt_info = out_slot_ctx->tt_info;
 748         in_slot_ctx->dev_state = out_slot_ctx->dev_state;
 749 }
 750
 751 /* Set up the scratchpad buffer array and scratchpad buffers, if needed. */
 752 static int scratchpad_alloc(struct xhci_hcd *xhci, gfp_t flags)
 753 {
 754         int i;
 755         struct device *dev = xhci_to_hcd(xhci)->self.controller;
 756         int num_sp = HCS_MAX_SCRATCHPAD(xhci->hcs_params2);
 757
 758         xhci_dbg(xhci, "Allocating %d scratchpad buffers\n", num_sp);
 759
 760         if (!num_sp)
 761                 return 0;
 762
 763         xhci->scratchpad = kzalloc(sizeof(*xhci->scratchpad), flags);
 764         if (!xhci->scratchpad)
 765                 goto fail_sp;
 766
 767         xhci->scratchpad->sp_array =
 768                 pci_alloc_consistent(to_pci_dev(dev),
 769                                      num_sp * sizeof(u64),
 770                                      &xhci->scratchpad->sp_dma);
 771         if (!xhci->scratchpad->sp_array)
 772                 goto fail_sp2;
 773
 774         xhci->scratchpad->sp_buffers = kzalloc(sizeof(void *) * num_sp, flags);
 775         if (!xhci->scratchpad->sp_buffers)
 776                 goto fail_sp3;
 777
 778         xhci->scratchpad->sp_dma_buffers =
 779                 kzalloc(sizeof(dma_addr_t) * num_sp, flags);
 780
 781         if (!xhci->scratchpad->sp_dma_buffers)
 782                 goto fail_sp4;
 783
 784         xhci->dcbaa->dev_context_ptrs[0] = xhci->scratchpad->sp_dma;
 785         for (i = 0; i < num_sp; i++) {
 786                 dma_addr_t dma;
 787                 void *buf = pci_alloc_consistent(to_pci_dev(dev),
 788                                                  xhci->page_size, &dma);
 789                 if (!buf)
 790                         goto fail_sp5;
 791
 792                 xhci->scratchpad->sp_array[i] = dma;
 793                 xhci->scratchpad->sp_buffers[i] = buf;
 794                 xhci->scratchpad->sp_dma_buffers[i] = dma;
 795         }
 796
 797         return 0;
 798
 799  fail_sp5:
 800         for (i = i - 1; i >= 0; i--) {
 801                 pci_free_consistent(to_pci_dev(dev), xhci->page_size,
 802                                     xhci->scratchpad->sp_buffers[i],
 803                                     xhci->scratchpad->sp_dma_buffers[i]);
 804         }
 805         kfree(xhci->scratchpad->sp_dma_buffers);
 806
 807  fail_sp4:
 808         kfree(xhci->scratchpad->sp_buffers);
 809
 810  fail_sp3:
 811         pci_free_consistent(to_pci_dev(dev), num_sp * sizeof(u64),
 812                             xhci->scratchpad->sp_array,
 813                             xhci->scratchpad->sp_dma);
 814
 815  fail_sp2:
 816         kfree(xhci->scratchpad);
 817         xhci->scratchpad = NULL;
 818
 819  fail_sp:
 820         return -ENOMEM;
 821 }
 822
 823 static void scratchpad_free(struct xhci_hcd *xhci)
 824 {
 825         int num_sp;
 826         int i;
 827         struct pci_dev  *pdev = to_pci_dev(xhci_to_hcd(xhci)->self.controller);
 828
 829         if (!xhci->scratchpad)
 830                 return;
 831
 832         num_sp = HCS_MAX_SCRATCHPAD(xhci->hcs_params2);
 833
 834         for (i = 0; i < num_sp; i++) {
 835                 pci_free_consistent(pdev, xhci->page_size,
 836                                     xhci->scratchpad->sp_buffers[i],
 837                                     xhci->scratchpad->sp_dma_buffers[i]);
 838         }
 839         kfree(xhci->scratchpad->sp_dma_buffers);
 840         kfree(xhci->scratchpad->sp_buffers);
 841         pci_free_consistent(pdev, num_sp * sizeof(u64),
 842                             xhci->scratchpad->sp_array,
 843                             xhci->scratchpad->sp_dma);
 844         kfree(xhci->scratchpad);
 845         xhci->scratchpad = NULL;
 846 }
 847
 848 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
 849                 bool allocate_in_ctx, bool allocate_completion,
 850                 gfp_t mem_flags)
 851 {
 852         struct xhci_command *command;
 853
 854         command = kzalloc(sizeof(*command), mem_flags);
 855         if (!command)
 856                 return NULL;
 857
 858         if (allocate_in_ctx) {
 859                 command->in_ctx =
 860                         xhci_alloc_container_ctx(xhci, XHCI_CTX_TYPE_INPUT,
 861                                         mem_flags);
 862                 if (!command->in_ctx) {
 863                         kfree(command);
 864                         return NULL;
 865                 }
 866         }
 867
 868         if (allocate_completion) {
 869                 command->completion =
 870                         kzalloc(sizeof(struct completion), mem_flags);
 871                 if (!command->completion) {
 872                         xhci_free_container_ctx(xhci, command->in_ctx);
 873                         kfree(command);
 874                         return NULL;
 875                 }
 876                 init_completion(command->completion);
 877         }
 878
 879         command->status = 0;
 880         INIT_LIST_HEAD(&command->cmd_list);
 881         return command;
 882 }
 883
 884 void xhci_free_command(struct xhci_hcd *xhci,
 885                 struct xhci_command *command)
 886 {
 887         xhci_free_container_ctx(xhci,
 888                         command->in_ctx);
 889         kfree(command->completion);
 890         kfree(command);
 891 }
 892
 893 void xhci_mem_cleanup(struct xhci_hcd *xhci)
 894 {
 895         struct pci_dev  *pdev = to_pci_dev(xhci_to_hcd(xhci)->self.controller);
 896         int size;
 897         int i;
 898
 899         /* Free the Event Ring Segment Table and the actual Event Ring */
 900         if (xhci->ir_set) {
 901                 xhci_writel(xhci, 0, &xhci->ir_set->erst_size);
 902                 xhci_write_64(xhci, 0, &xhci->ir_set->erst_base);
 903                 xhci_write_64(xhci, 0, &xhci->ir_set->erst_dequeue);
 904         }
 905         size = sizeof(struct xhci_erst_entry)*(xhci->erst.num_entries);
 906         if (xhci->erst.entries)
 907                 pci_free_consistent(pdev, size,
 908                                 xhci->erst.entries, xhci->erst.erst_dma_addr);
 909         xhci->erst.entries = NULL;
 910         xhci_dbg(xhci, "Freed ERST\n");
 911         if (xhci->event_ring)
 912                 xhci_ring_free(xhci, xhci->event_ring);
 913         xhci->event_ring = NULL;
 914         xhci_dbg(xhci, "Freed event ring\n");
 915
 916         xhci_write_64(xhci, 0, &xhci->op_regs->cmd_ring);
 917         if (xhci->cmd_ring)
 918                 xhci_ring_free(xhci, xhci->cmd_ring);
 919         xhci->cmd_ring = NULL;
 920         xhci_dbg(xhci, "Freed command ring\n");
 921
 922         for (i = 1; i < MAX_HC_SLOTS; ++i)
 923                 xhci_free_virt_device(xhci, i);
 924
 925         if (xhci->segment_pool)
 926                 dma_pool_destroy(xhci->segment_pool);
 927         xhci->segment_pool = NULL;
 928         xhci_dbg(xhci, "Freed segment pool\n");
 929
 930         if (xhci->device_pool)
 931                 dma_pool_destroy(xhci->device_pool);
 932         xhci->device_pool = NULL;
 933         xhci_dbg(xhci, "Freed device context pool\n");
 934
 935         xhci_write_64(xhci, 0, &xhci->op_regs->dcbaa_ptr);
 936         if (xhci->dcbaa)
 937                 pci_free_consistent(pdev, sizeof(*xhci->dcbaa),
 938                                 xhci->dcbaa, xhci->dcbaa->dma);
 939         xhci->dcbaa = NULL;
 940
 941         scratchpad_free(xhci);
 942         xhci->page_size = 0;
 943         xhci->page_shift = 0;
 944 }
 945
 946 static int xhci_test_trb_in_td(struct xhci_hcd *xhci,
 947                 struct xhci_segment *input_seg,
 948                 union xhci_trb *start_trb,
 949                 union xhci_trb *end_trb,
 950                 dma_addr_t input_dma,
 951                 struct xhci_segment *result_seg,
 952                 char *test_name, int test_number)
 953 {
 954         unsigned long long start_dma;
 955         unsigned long long end_dma;
 956         struct xhci_segment *seg;
 957
 958         start_dma = xhci_trb_virt_to_dma(input_seg, start_trb);
 959         end_dma = xhci_trb_virt_to_dma(input_seg, end_trb);
 960
 961         seg = trb_in_td(input_seg, start_trb, end_trb, input_dma);
 962         if (seg != result_seg) {
 963                 xhci_warn(xhci, "WARN: %s TRB math test %d failed!\n",
 964                                 test_name, test_number);
 965                 xhci_warn(xhci, "Tested TRB math w/ seg %p and "
 966                                 "input DMA 0x%llx\n",
 967                                 input_seg,
 968                                 (unsigned long long) input_dma);
 969                 xhci_warn(xhci, "starting TRB %p (0x%llx DMA), "
 970                                 "ending TRB %p (0x%llx DMA)\n",
 971                                 start_trb, start_dma,
 972                                 end_trb, end_dma);
 973                 xhci_warn(xhci, "Expected seg %p, got seg %p\n",
 974                                 result_seg, seg);
 975                 return -1;
 976         }
 977         return 0;
 978 }
 979
 980 /* TRB math checks for xhci_trb_in_td(), using the command and event rings. */
 981 static int xhci_check_trb_in_td_math(struct xhci_hcd *xhci, gfp_t mem_flags)
 982 {
 983         struct {
 984                 dma_addr_t              input_dma;
 985                 struct xhci_segment     *result_seg;
 986         } simple_test_vector [] = {
 987                 /* A zeroed DMA field should fail */
 988                 { 0, NULL },
 989                 /* One TRB before the ring start should fail */
 990                 { xhci->event_ring->first_seg->dma - 16, NULL },
 991                 /* One byte before the ring start should fail */
 992                 { xhci->event_ring->first_seg->dma - 1, NULL },
 993                 /* Starting TRB should succeed */
 994                 { xhci->event_ring->first_seg->dma, xhci->event_ring->first_seg },
 995                 /* Ending TRB should succeed */
 996                 { xhci->event_ring->first_seg->dma + (TRBS_PER_SEGMENT - 1)*16,
 997                         xhci->event_ring->first_seg },
 998                 /* One byte after the ring end should fail */
 999                 { xhci->event_ring->first_seg->dma + (TRBS_PER_SEGMENT - 1)*16 + 1, NULL },
1000                 /* One TRB after the ring end should fail */
1001                 { xhci->event_ring->first_seg->dma + (TRBS_PER_SEGMENT)*16, NULL },
1002                 /* An address of all ones should fail */
1003                 { (dma_addr_t) (~0), NULL },
1004         };
1005         struct {
1006                 struct xhci_segment     *input_seg;
1007                 union xhci_trb          *start_trb;
1008                 union xhci_trb          *end_trb;
1009                 dma_addr_t              input_dma;
1010                 struct xhci_segment     *result_seg;
1011         } complex_test_vector [] = {
1012                 /* Test feeding a valid DMA address from a different ring */
1013                 {       .input_seg = xhci->event_ring->first_seg,
1014                         .start_trb = xhci->event_ring->first_seg->trbs,
1015                         .end_trb = &xhci->event_ring->first_seg->trbs[TRBS_PER_SEGMENT - 1],
1016                         .input_dma = xhci->cmd_ring->first_seg->dma,
1017                         .result_seg = NULL,
1018                 },
1019                 /* Test feeding a valid end TRB from a different ring */
1020                 {       .input_seg = xhci->event_ring->first_seg,
1021                         .start_trb = xhci->event_ring->first_seg->trbs,
1022                         .end_trb = &xhci->cmd_ring->first_seg->trbs[TRBS_PER_SEGMENT - 1],
1023                         .input_dma = xhci->cmd_ring->first_seg->dma,
1024                         .result_seg = NULL,
1025                 },
1026                 /* Test feeding a valid start and end TRB from a different ring */
1027                 {       .input_seg = xhci->event_ring->first_seg,
1028                         .start_trb = xhci->cmd_ring->first_seg->trbs,
1029                         .end_trb = &xhci->cmd_ring->first_seg->trbs[TRBS_PER_SEGMENT - 1],
1030                         .input_dma = xhci->cmd_ring->first_seg->dma,
1031                         .result_seg = NULL,
1032                 },
1033                 /* TRB in this ring, but after this TD */
1034                 {       .input_seg = xhci->event_ring->first_seg,
1035                         .start_trb = &xhci->event_ring->first_seg->trbs[0],
1036                         .end_trb = &xhci->event_ring->first_seg->trbs[3],
1037                         .input_dma = xhci->event_ring->first_seg->dma + 4*16,
1038                         .result_seg = NULL,
1039                 },
1040                 /* TRB in this ring, but before this TD */
1041                 {       .input_seg = xhci->event_ring->first_seg,
1042                         .start_trb = &xhci->event_ring->first_seg->trbs[3],
1043                         .end_trb = &xhci->event_ring->first_seg->trbs[6],
1044                         .input_dma = xhci->event_ring->first_seg->dma + 2*16,
1045                         .result_seg = NULL,
1046                 },
1047                 /* TRB in this ring, but after this wrapped TD */
1048                 {       .input_seg = xhci->event_ring->first_seg,
1049                         .start_trb = &xhci->event_ring->first_seg->trbs[TRBS_PER_SEGMENT - 3],
1050                         .end_trb = &xhci->event_ring->first_seg->trbs[1],
1051                         .input_dma = xhci->event_ring->first_seg->dma + 2*16,
1052                         .result_seg = NULL,
1053                 },
1054                 /* TRB in this ring, but before this wrapped TD */
1055                 {       .input_seg = xhci->event_ring->first_seg,
1056                         .start_trb = &xhci->event_ring->first_seg->trbs[TRBS_PER_SEGMENT - 3],
1057                         .end_trb = &xhci->event_ring->first_seg->trbs[1],
1058                         .input_dma = xhci->event_ring->first_seg->dma + (TRBS_PER_SEGMENT - 4)*16,
1059                         .result_seg = NULL,
1060                 },
1061                 /* TRB not in this ring, and we have a wrapped TD */
1062                 {       .input_seg = xhci->event_ring->first_seg,
1063                         .start_trb = &xhci->event_ring->first_seg->trbs[TRBS_PER_SEGMENT - 3],
1064                         .end_trb = &xhci->event_ring->first_seg->trbs[1],
1065                         .input_dma = xhci->cmd_ring->first_seg->dma + 2*16,
1066                         .result_seg = NULL,
1067                 },
1068         };
1069
1070         unsigned int num_tests;
1071         int i, ret;
1072
1073         num_tests = sizeof(simple_test_vector) / sizeof(simple_test_vector[0]);
1074         for (i = 0; i < num_tests; i++) {
1075                 ret = xhci_test_trb_in_td(xhci,
1076                                 xhci->event_ring->first_seg,
1077                                 xhci->event_ring->first_seg->trbs,
1078                                 &xhci->event_ring->first_seg->trbs[TRBS_PER_SEGMENT - 1],
1079                                 simple_test_vector[i].input_dma,
1080                                 simple_test_vector[i].result_seg,
1081                                 "Simple", i);
1082                 if (ret < 0)
1083                         return ret;
1084         }
1085
1086         num_tests = sizeof(complex_test_vector) / sizeof(complex_test_vector[0]);
1087         for (i = 0; i < num_tests; i++) {
1088                 ret = xhci_test_trb_in_td(xhci,
1089                                 complex_test_vector[i].input_seg,
1090                                 complex_test_vector[i].start_trb,
1091                                 complex_test_vector[i].end_trb,
1092                                 complex_test_vector[i].input_dma,
1093                                 complex_test_vector[i].result_seg,
1094                                 "Complex", i);
1095                 if (ret < 0)
1096                         return ret;
1097         }
1098         xhci_dbg(xhci, "TRB math tests passed.\n");
1099         return 0;
1100 }
1101
1102
1103 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags)
1104 {
1105         dma_addr_t      dma;
1106         struct device   *dev = xhci_to_hcd(xhci)->self.controller;
1107         unsigned int    val, val2;
1108         u64             val_64;
1109         struct xhci_segment     *seg;
1110         u32 page_size;
1111         int i;
1112
1113         page_size = xhci_readl(xhci, &xhci->op_regs->page_size);
1114         xhci_dbg(xhci, "Supported page size register = 0x%x\n", page_size);
1115         for (i = 0; i < 16; i++) {
1116                 if ((0x1 & page_size) != 0)
1117                         break;
1118                 page_size = page_size >> 1;
1119         }
1120         if (i < 16)
1121                 xhci_dbg(xhci, "Supported page size of %iK\n", (1 << (i+12)) / 1024);
1122         else
1123                 xhci_warn(xhci, "WARN: no supported page size\n");
1124         /* Use 4K pages, since that's common and the minimum the HC supports */
1125         xhci->page_shift = 12;
1126         xhci->page_size = 1 << xhci->page_shift;
1127         xhci_dbg(xhci, "HCD page size set to %iK\n", xhci->page_size / 1024);
1128
1129         /*
1130          * Program the Number of Device Slots Enabled field in the CONFIG
1131          * register with the max value of slots the HC can handle.
1132          */
1133         val = HCS_MAX_SLOTS(xhci_readl(xhci, &xhci->cap_regs->hcs_params1));
1134         xhci_dbg(xhci, "// xHC can handle at most %d device slots.\n",
1135                         (unsigned int) val);
1136         val2 = xhci_readl(xhci, &xhci->op_regs->config_reg);
1137         val |= (val2 & ~HCS_SLOTS_MASK);
1138         xhci_dbg(xhci, "// Setting Max device slots reg = 0x%x.\n",
1139                         (unsigned int) val);
1140         xhci_writel(xhci, val, &xhci->op_regs->config_reg);
1141
1142         /*
1143          * Section 5.4.8 - doorbell array must be
1144          * "physically contiguous and 64-byte (cache line) aligned".
1145          */
1146         xhci->dcbaa = pci_alloc_consistent(to_pci_dev(dev),
1147                         sizeof(*xhci->dcbaa), &dma);
1148         if (!xhci->dcbaa)
1149                 goto fail;
1150         memset(xhci->dcbaa, 0, sizeof *(xhci->dcbaa));
1151         xhci->dcbaa->dma = dma;
1152         xhci_dbg(xhci, "// Device context base array address = 0x%llx (DMA), %p (virt)\n",
1153                         (unsigned long long)xhci->dcbaa->dma, xhci->dcbaa);
1154         xhci_write_64(xhci, dma, &xhci->op_regs->dcbaa_ptr);
1155
1156         /*
1157          * Initialize the ring segment pool.  The ring must be a contiguous
1158          * structure comprised of TRBs.  The TRBs must be 16 byte aligned,
1159          * however, the command ring segment needs 64-byte aligned segments,
1160          * so we pick the greater alignment need.
1161          */
1162         xhci->segment_pool = dma_pool_create("xHCI ring segments", dev,
1163                         SEGMENT_SIZE, 64, xhci->page_size);
1164
1165         /* See Table 46 and Note on Figure 55 */
1166         xhci->device_pool = dma_pool_create("xHCI input/output contexts", dev,
1167                         2112, 64, xhci->page_size);
1168         if (!xhci->segment_pool || !xhci->device_pool)
1169                 goto fail;
1170
1171         /* Set up the command ring to have one segments for now. */
1172         xhci->cmd_ring = xhci_ring_alloc(xhci, 1, true, flags);
1173         if (!xhci->cmd_ring)
1174                 goto fail;
1175         xhci_dbg(xhci, "Allocated command ring at %p\n", xhci->cmd_ring);
1176         xhci_dbg(xhci, "First segment DMA is 0x%llx\n",
1177                         (unsigned long long)xhci->cmd_ring->first_seg->dma);
1178
1179         /* Set the address in the Command Ring Control register */
1180         val_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
1181         val_64 = (val_64 & (u64) CMD_RING_RSVD_BITS) |
1182                 (xhci->cmd_ring->first_seg->dma & (u64) ~CMD_RING_RSVD_BITS) |
1183                 xhci->cmd_ring->cycle_state;
1184         xhci_dbg(xhci, "// Setting command ring address to 0x%x\n", val);
1185         xhci_write_64(xhci, val_64, &xhci->op_regs->cmd_ring);
1186         xhci_dbg_cmd_ptrs(xhci);
1187
1188         val = xhci_readl(xhci, &xhci->cap_regs->db_off);
1189         val &= DBOFF_MASK;
1190         xhci_dbg(xhci, "// Doorbell array is located at offset 0x%x"
1191                         " from cap regs base addr\n", val);
1192         xhci->dba = (void *) xhci->cap_regs + val;
1193         xhci_dbg_regs(xhci);
1194         xhci_print_run_regs(xhci);
1195         /* Set ir_set to interrupt register set 0 */
1196         xhci->ir_set = (void *) xhci->run_regs->ir_set;
1197
1198         /*
1199          * Event ring setup: Allocate a normal ring, but also setup
1200          * the event ring segment table (ERST).  Section 4.9.3.
1201          */
1202         xhci_dbg(xhci, "// Allocating event ring\n");
1203         xhci->event_ring = xhci_ring_alloc(xhci, ERST_NUM_SEGS, false, flags);
1204         if (!xhci->event_ring)
1205                 goto fail;
1206         if (xhci_check_trb_in_td_math(xhci, flags) < 0)
1207                 goto fail;
1208
1209         xhci->erst.entries = pci_alloc_consistent(to_pci_dev(dev),
1210                         sizeof(struct xhci_erst_entry)*ERST_NUM_SEGS, &dma);
1211         if (!xhci->erst.entries)
1212                 goto fail;
1213         xhci_dbg(xhci, "// Allocated event ring segment table at 0x%llx\n",
1214                         (unsigned long long)dma);
1215
1216         memset(xhci->erst.entries, 0, sizeof(struct xhci_erst_entry)*ERST_NUM_SEGS);
1217         xhci->erst.num_entries = ERST_NUM_SEGS;
1218         xhci->erst.erst_dma_addr = dma;
1219         xhci_dbg(xhci, "Set ERST to 0; private num segs = %i, virt addr = %p, dma addr = 0x%llx\n",
1220                         xhci->erst.num_entries,
1221                         xhci->erst.entries,
1222                         (unsigned long long)xhci->erst.erst_dma_addr);
1223
1224         /* set ring base address and size for each segment table entry */
1225         for (val = 0, seg = xhci->event_ring->first_seg; val < ERST_NUM_SEGS; val++) {
1226                 struct xhci_erst_entry *entry = &xhci->erst.entries[val];
1227                 entry->seg_addr = seg->dma;
1228                 entry->seg_size = TRBS_PER_SEGMENT;
1229                 entry->rsvd = 0;
1230                 seg = seg->next;
1231         }
1232
1233         /* set ERST count with the number of entries in the segment table */
1234         val = xhci_readl(xhci, &xhci->ir_set->erst_size);
1235         val &= ERST_SIZE_MASK;
1236         val |= ERST_NUM_SEGS;
1237         xhci_dbg(xhci, "// Write ERST size = %i to ir_set 0 (some bits preserved)\n",
1238                         val);
1239         xhci_writel(xhci, val, &xhci->ir_set->erst_size);
1240
1241         xhci_dbg(xhci, "// Set ERST entries to point to event ring.\n");
1242         /* set the segment table base address */
1243         xhci_dbg(xhci, "// Set ERST base address for ir_set 0 = 0x%llx\n",
1244                         (unsigned long long)xhci->erst.erst_dma_addr);
1245         val_64 = xhci_read_64(xhci, &xhci->ir_set->erst_base);
1246         val_64 &= ERST_PTR_MASK;
1247         val_64 |= (xhci->erst.erst_dma_addr & (u64) ~ERST_PTR_MASK);
1248         xhci_write_64(xhci, val_64, &xhci->ir_set->erst_base);
1249
1250         /* Set the event ring dequeue address */
1251         xhci_set_hc_event_deq(xhci);
1252         xhci_dbg(xhci, "Wrote ERST address to ir_set 0.\n");
1253         xhci_print_ir_set(xhci, xhci->ir_set, 0);
1254
1255         /*
1256          * XXX: Might need to set the Interrupter Moderation Register to
1257          * something other than the default (~1ms minimum between interrupts).
1258          * See section 5.5.1.2.
1259          */
1260         init_completion(&xhci->addr_dev);
1261         for (i = 0; i < MAX_HC_SLOTS; ++i)
1262                 xhci->devs[i] = 0;
1263
1264         if (scratchpad_alloc(xhci, flags))
1265                 goto fail;
1266
1267         return 0;
1268
1269 fail:
1270         xhci_warn(xhci, "Couldn't initialize memory\n");
1271         xhci_mem_cleanup(xhci);
1272         return -ENOMEM;
1273 }