drivers/usb/host/xhci-mem.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * USB HOST XHCI Controller stack
   4  *
   5  * Based on xHCI host controller driver in linux-kernel
   6  * by Sarah Sharp.
   7  *
   8  * Copyright (C) 2008 Intel Corp.
   9  * Author: Sarah Sharp
  10  *
  11  * Copyright (C) 2013 Samsung Electronics Co.Ltd
  12  * Authors: Vivek Gautam <gautam.vivek@samsung.com>
  13  *          Vikas Sajjan <vikas.sajjan@samsung.com>
  14  */
  15
  16 #include <common.h>
  17 #include <cpu_func.h>
  18 #include <dm.h>
  19 #include <log.h>
  20 #include <asm/byteorder.h>
  21 #include <usb.h>
  22 #include <malloc.h>
  23 #include <asm/cache.h>
  24 #include <linux/bug.h>
  25 #include <linux/errno.h>
  26
  27 #include <usb/xhci.h>
  28
  29 #define CACHELINE_SIZE          CONFIG_SYS_CACHELINE_SIZE
  30 /**
  31  * flushes the address passed till the length
  32  *
  33  * @param addr  pointer to memory region to be flushed
  34  * @param len   the length of the cache line to be flushed
  35  * @return none
  36  */
  37 void xhci_flush_cache(uintptr_t addr, u32 len)
  38 {
  39         BUG_ON((void *)addr == NULL || len == 0);
  40
  41         flush_dcache_range(addr & ~(CACHELINE_SIZE - 1),
  42                                 ALIGN(addr + len, CACHELINE_SIZE));
  43 }
  44
  45 /**
  46  * invalidates the address passed till the length
  47  *
  48  * @param addr  pointer to memory region to be invalidates
  49  * @param len   the length of the cache line to be invalidated
  50  * @return none
  51  */
  52 void xhci_inval_cache(uintptr_t addr, u32 len)
  53 {
  54         BUG_ON((void *)addr == NULL || len == 0);
  55
  56         invalidate_dcache_range(addr & ~(CACHELINE_SIZE - 1),
  57                                 ALIGN(addr + len, CACHELINE_SIZE));
  58 }
  59
  60
  61 /**
  62  * frees the "segment" pointer passed
  63  *
  64  * @param ptr   pointer to "segement" to be freed
  65  * @return none
  66  */
  67 static void xhci_segment_free(struct xhci_segment *seg)
  68 {
  69         free(seg->trbs);
  70         seg->trbs = NULL;
  71
  72         free(seg);
  73 }
  74
  75 /**
  76  * frees the "ring" pointer passed
  77  *
  78  * @param ptr   pointer to "ring" to be freed
  79  * @return none
  80  */
  81 static void xhci_ring_free(struct xhci_ring *ring)
  82 {
  83         struct xhci_segment *seg;
  84         struct xhci_segment *first_seg;
  85
  86         BUG_ON(!ring);
  87
  88         first_seg = ring->first_seg;
  89         seg = first_seg->next;
  90         while (seg != first_seg) {
  91                 struct xhci_segment *next = seg->next;
  92                 xhci_segment_free(seg);
  93                 seg = next;
  94         }
  95         xhci_segment_free(first_seg);
  96
  97         free(ring);
  98 }
  99
 100 /**
 101  * Free the scratchpad buffer array and scratchpad buffers
 102  *
 103  * @ctrl        host controller data structure
 104  * @return      none
 105  */
 106 static void xhci_scratchpad_free(struct xhci_ctrl *ctrl)
 107 {
 108         if (!ctrl->scratchpad)
 109                 return;
 110
 111         ctrl->dcbaa->dev_context_ptrs[0] = 0;
 112
 113         free((void *)(uintptr_t)ctrl->scratchpad->sp_array[0]);
 114         free(ctrl->scratchpad->sp_array);
 115         free(ctrl->scratchpad);
 116         ctrl->scratchpad = NULL;
 117 }
 118
 119 /**
 120  * frees the "xhci_container_ctx" pointer passed
 121  *
 122  * @param ptr   pointer to "xhci_container_ctx" to be freed
 123  * @return none
 124  */
 125 static void xhci_free_container_ctx(struct xhci_container_ctx *ctx)
 126 {
 127         free(ctx->bytes);
 128         free(ctx);
 129 }
 130
 131 /**
 132  * frees the virtual devices for "xhci_ctrl" pointer passed
 133  *
 134  * @param ptr   pointer to "xhci_ctrl" whose virtual devices are to be freed
 135  * @return none
 136  */
 137 static void xhci_free_virt_devices(struct xhci_ctrl *ctrl)
 138 {
 139         int i;
 140         int slot_id;
 141         struct xhci_virt_device *virt_dev;
 142
 143         /*
 144          * refactored here to loop through all virt_dev
 145          * Slot ID 0 is reserved
 146          */
 147         for (slot_id = 0; slot_id < MAX_HC_SLOTS; slot_id++) {
 148                 virt_dev = ctrl->devs[slot_id];
 149                 if (!virt_dev)
 150                         continue;
 151
 152                 ctrl->dcbaa->dev_context_ptrs[slot_id] = 0;
 153
 154                 for (i = 0; i < 31; ++i)
 155                         if (virt_dev->eps[i].ring)
 156                                 xhci_ring_free(virt_dev->eps[i].ring);
 157
 158                 if (virt_dev->in_ctx)
 159                         xhci_free_container_ctx(virt_dev->in_ctx);
 160                 if (virt_dev->out_ctx)
 161                         xhci_free_container_ctx(virt_dev->out_ctx);
 162
 163                 free(virt_dev);
 164                 /* make sure we are pointing to NULL */
 165                 ctrl->devs[slot_id] = NULL;
 166         }
 167 }
 168
 169 /**
 170  * frees all the memory allocated
 171  *
 172  * @param ptr   pointer to "xhci_ctrl" to be cleaned up
 173  * @return none
 174  */
 175 void xhci_cleanup(struct xhci_ctrl *ctrl)
 176 {
 177         xhci_ring_free(ctrl->event_ring);
 178         xhci_ring_free(ctrl->cmd_ring);
 179         xhci_scratchpad_free(ctrl);
 180         xhci_free_virt_devices(ctrl);
 181         free(ctrl->erst.entries);
 182         free(ctrl->dcbaa);
 183         memset(ctrl, '\0', sizeof(struct xhci_ctrl));
 184 }
 185
 186 /**
 187  * Malloc the aligned memory
 188  *
 189  * @param size  size of memory to be allocated
 190  * @return allocates the memory and returns the aligned pointer
 191  */
 192 static void *xhci_malloc(unsigned int size)
 193 {
 194         void *ptr;
 195         size_t cacheline_size = max(XHCI_ALIGNMENT, CACHELINE_SIZE);
 196
 197         ptr = memalign(cacheline_size, ALIGN(size, cacheline_size));
 198         BUG_ON(!ptr);
 199         memset(ptr, '\0', size);
 200
 201         xhci_flush_cache((uintptr_t)ptr, size);
 202
 203         return ptr;
 204 }
 205
 206 /**
 207  * Make the prev segment point to the next segment.
 208  * Change the last TRB in the prev segment to be a Link TRB which points to the
 209  * address of the next segment.  The caller needs to set any Link TRB
 210  * related flags, such as End TRB, Toggle Cycle, and no snoop.
 211  *
 212  * @param prev  pointer to the previous segment
 213  * @param next  pointer to the next segment
 214  * @param link_trbs     flag to indicate whether to link the trbs or NOT
 215  * @return none
 216  */
 217 static void xhci_link_segments(struct xhci_segment *prev,
 218                                 struct xhci_segment *next, bool link_trbs)
 219 {
 220         u32 val;
 221         u64 val_64 = 0;
 222
 223         if (!prev || !next)
 224                 return;
 225         prev->next = next;
 226         if (link_trbs) {
 227                 val_64 = (uintptr_t)next->trbs;
 228                 prev->trbs[TRBS_PER_SEGMENT-1].link.segment_ptr = val_64;
 229
 230                 /*
 231                  * Set the last TRB in the segment to
 232                  * have a TRB type ID of Link TRB
 233                  */
 234                 val = le32_to_cpu(prev->trbs[TRBS_PER_SEGMENT-1].link.control);
 235                 val &= ~TRB_TYPE_BITMASK;
 236                 val |= (TRB_LINK << TRB_TYPE_SHIFT);
 237
 238                 prev->trbs[TRBS_PER_SEGMENT-1].link.control = cpu_to_le32(val);
 239         }
 240 }
 241
 242 /**
 243  * Initialises the Ring's enqueue,dequeue,enq_seg pointers
 244  *
 245  * @param ring  pointer to the RING to be intialised
 246  * @return none
 247  */
 248 static void xhci_initialize_ring_info(struct xhci_ring *ring)
 249 {
 250         /*
 251          * The ring is empty, so the enqueue pointer == dequeue pointer
 252          */
 253         ring->enqueue = ring->first_seg->trbs;
 254         ring->enq_seg = ring->first_seg;
 255         ring->dequeue = ring->enqueue;
 256         ring->deq_seg = ring->first_seg;
 257
 258         /*
 259          * The ring is initialized to 0. The producer must write 1 to the
 260          * cycle bit to handover ownership of the TRB, so PCS = 1.
 261          * The consumer must compare CCS to the cycle bit to
 262          * check ownership, so CCS = 1.
 263          */
 264         ring->cycle_state = 1;
 265 }
 266
 267 /**
 268  * Allocates a generic ring segment from the ring pool, sets the dma address,
 269  * initializes the segment to zero, and sets the private next pointer to NULL.
 270  * Section 4.11.1.1:
 271  * "All components of all Command and Transfer TRBs shall be initialized to '0'"
 272  *
 273  * @param       none
 274  * @return pointer to the newly allocated SEGMENT
 275  */
 276 static struct xhci_segment *xhci_segment_alloc(void)
 277 {
 278         struct xhci_segment *seg;
 279
 280         seg = (struct xhci_segment *)malloc(sizeof(struct xhci_segment));
 281         BUG_ON(!seg);
 282
 283         seg->trbs = (union xhci_trb *)xhci_malloc(SEGMENT_SIZE);
 284
 285         seg->next = NULL;
 286
 287         return seg;
 288 }
 289
 290 /**
 291  * Create a new ring with zero or more segments.
 292  * TODO: current code only uses one-time-allocated single-segment rings
 293  * of 1KB anyway, so we might as well get rid of all the segment and
 294  * linking code (and maybe increase the size a bit, e.g. 4KB).
 295  *
 296  *
 297  * Link each segment together into a ring.
 298  * Set the end flag and the cycle toggle bit on the last segment.
 299  * See section 4.9.2 and figures 15 and 16 of XHCI spec rev1.0.
 300  *
 301  * @param num_segs      number of segments in the ring
 302  * @param link_trbs     flag to indicate whether to link the trbs or NOT
 303  * @return pointer to the newly created RING
 304  */
 305 struct xhci_ring *xhci_ring_alloc(unsigned int num_segs, bool link_trbs)
 306 {
 307         struct xhci_ring *ring;
 308         struct xhci_segment *prev;
 309
 310         ring = (struct xhci_ring *)malloc(sizeof(struct xhci_ring));
 311         BUG_ON(!ring);
 312
 313         if (num_segs == 0)
 314                 return ring;
 315
 316         ring->first_seg = xhci_segment_alloc();
 317         BUG_ON(!ring->first_seg);
 318
 319         num_segs--;
 320
 321         prev = ring->first_seg;
 322         while (num_segs > 0) {
 323                 struct xhci_segment *next;
 324
 325                 next = xhci_segment_alloc();
 326                 BUG_ON(!next);
 327
 328                 xhci_link_segments(prev, next, link_trbs);
 329
 330                 prev = next;
 331                 num_segs--;
 332         }
 333         xhci_link_segments(prev, ring->first_seg, link_trbs);
 334         if (link_trbs) {
 335                 /* See section 4.9.2.1 and 6.4.4.1 */
 336                 prev->trbs[TRBS_PER_SEGMENT-1].link.control |=
 337                                         cpu_to_le32(LINK_TOGGLE);
 338         }
 339         xhci_initialize_ring_info(ring);
 340
 341         return ring;
 342 }
 343
 344 /**
 345  * Set up the scratchpad buffer array and scratchpad buffers
 346  *
 347  * @ctrl        host controller data structure
 348  * @return      -ENOMEM if buffer allocation fails, 0 on success
 349  */
 350 static int xhci_scratchpad_alloc(struct xhci_ctrl *ctrl)
 351 {
 352         struct xhci_hccr *hccr = ctrl->hccr;
 353         struct xhci_hcor *hcor = ctrl->hcor;
 354         struct xhci_scratchpad *scratchpad;
 355         int num_sp;
 356         uint32_t page_size;
 357         void *buf;
 358         int i;
 359
 360         num_sp = HCS_MAX_SCRATCHPAD(xhci_readl(&hccr->cr_hcsparams2));
 361         if (!num_sp)
 362                 return 0;
 363
 364         scratchpad = malloc(sizeof(*scratchpad));
 365         if (!scratchpad)
 366                 goto fail_sp;
 367         ctrl->scratchpad = scratchpad;
 368
 369         scratchpad->sp_array = xhci_malloc(num_sp * sizeof(u64));
 370         if (!scratchpad->sp_array)
 371                 goto fail_sp2;
 372         ctrl->dcbaa->dev_context_ptrs[0] =
 373                 cpu_to_le64((uintptr_t)scratchpad->sp_array);
 374
 375         xhci_flush_cache((uintptr_t)&ctrl->dcbaa->dev_context_ptrs[0],
 376                 sizeof(ctrl->dcbaa->dev_context_ptrs[0]));
 377
 378         page_size = xhci_readl(&hcor->or_pagesize) & 0xffff;
 379         for (i = 0; i < 16; i++) {
 380                 if ((0x1 & page_size) != 0)
 381                         break;
 382                 page_size = page_size >> 1;
 383         }
 384         BUG_ON(i == 16);
 385
 386         page_size = 1 << (i + 12);
 387         buf = memalign(page_size, num_sp * page_size);
 388         if (!buf)
 389                 goto fail_sp3;
 390         memset(buf, '\0', num_sp * page_size);
 391         xhci_flush_cache((uintptr_t)buf, num_sp * page_size);
 392
 393         for (i = 0; i < num_sp; i++) {
 394                 uintptr_t ptr = (uintptr_t)buf + i * page_size;
 395                 scratchpad->sp_array[i] = cpu_to_le64(ptr);
 396         }
 397
 398         return 0;
 399
 400 fail_sp3:
 401         free(scratchpad->sp_array);
 402
 403 fail_sp2:
 404         free(scratchpad);
 405         ctrl->scratchpad = NULL;
 406
 407 fail_sp:
 408         return -ENOMEM;
 409 }
 410
 411 /**
 412  * Allocates the Container context
 413  *
 414  * @param ctrl  Host controller data structure
 415  * @param type type of XHCI Container Context
 416  * @return NULL if failed else pointer to the context on success
 417  */
 418 static struct xhci_container_ctx
 419                 *xhci_alloc_container_ctx(struct xhci_ctrl *ctrl, int type)
 420 {
 421         struct xhci_container_ctx *ctx;
 422
 423         ctx = (struct xhci_container_ctx *)
 424                 malloc(sizeof(struct xhci_container_ctx));
 425         BUG_ON(!ctx);
 426
 427         BUG_ON((type != XHCI_CTX_TYPE_DEVICE) && (type != XHCI_CTX_TYPE_INPUT));
 428         ctx->type = type;
 429         ctx->size = (MAX_EP_CTX_NUM + 1) *
 430                         CTX_SIZE(readl(&ctrl->hccr->cr_hccparams));
 431         if (type == XHCI_CTX_TYPE_INPUT)
 432                 ctx->size += CTX_SIZE(readl(&ctrl->hccr->cr_hccparams));
 433
 434         ctx->bytes = (u8 *)xhci_malloc(ctx->size);
 435
 436         return ctx;
 437 }
 438
 439 /**
 440  * Allocating virtual device
 441  *
 442  * @param udev  pointer to USB deivce structure
 443  * @return 0 on success else -1 on failure
 444  */
 445 int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id)
 446 {
 447         u64 byte_64 = 0;
 448         struct xhci_virt_device *virt_dev;
 449
 450         /* Slot ID 0 is reserved */
 451         if (ctrl->devs[slot_id]) {
 452                 printf("Virt dev for slot[%d] already allocated\n", slot_id);
 453                 return -EEXIST;
 454         }
 455
 456         ctrl->devs[slot_id] = (struct xhci_virt_device *)
 457                                         malloc(sizeof(struct xhci_virt_device));
 458
 459         if (!ctrl->devs[slot_id]) {
 460                 puts("Failed to allocate virtual device\n");
 461                 return -ENOMEM;
 462         }
 463
 464         memset(ctrl->devs[slot_id], 0, sizeof(struct xhci_virt_device));
 465         virt_dev = ctrl->devs[slot_id];
 466
 467         /* Allocate the (output) device context that will be used in the HC. */
 468         virt_dev->out_ctx = xhci_alloc_container_ctx(ctrl,
 469                                         XHCI_CTX_TYPE_DEVICE);
 470         if (!virt_dev->out_ctx) {
 471                 puts("Failed to allocate out context for virt dev\n");
 472                 return -ENOMEM;
 473         }
 474
 475         /* Allocate the (input) device context for address device command */
 476         virt_dev->in_ctx = xhci_alloc_container_ctx(ctrl,
 477                                         XHCI_CTX_TYPE_INPUT);
 478         if (!virt_dev->in_ctx) {
 479                 puts("Failed to allocate in context for virt dev\n");
 480                 return -ENOMEM;
 481         }
 482
 483         /* Allocate endpoint 0 ring */
 484         virt_dev->eps[0].ring = xhci_ring_alloc(1, true);
 485
 486         byte_64 = (uintptr_t)(virt_dev->out_ctx->bytes);
 487
 488         /* Point to output device context in dcbaa. */
 489         ctrl->dcbaa->dev_context_ptrs[slot_id] = byte_64;
 490
 491         xhci_flush_cache((uintptr_t)&ctrl->dcbaa->dev_context_ptrs[slot_id],
 492                          sizeof(__le64));
 493         return 0;
 494 }
 495
 496 /**
 497  * Allocates the necessary data structures
 498  * for XHCI host controller
 499  *
 500  * @param ctrl  Host controller data structure
 501  * @param hccr  pointer to HOST Controller Control Registers
 502  * @param hcor  pointer to HOST Controller Operational Registers
 503  * @return 0 if successful else -1 on failure
 504  */
 505 int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr,
 506                                         struct xhci_hcor *hcor)
 507 {
 508         uint64_t val_64;
 509         uint64_t trb_64;
 510         uint32_t val;
 511         unsigned long deq;
 512         int i;
 513         struct xhci_segment *seg;
 514
 515         /* DCBAA initialization */
 516         ctrl->dcbaa = (struct xhci_device_context_array *)
 517                         xhci_malloc(sizeof(struct xhci_device_context_array));
 518         if (ctrl->dcbaa == NULL) {
 519                 puts("unable to allocate DCBA\n");
 520                 return -ENOMEM;
 521         }
 522
 523         val_64 = (uintptr_t)ctrl->dcbaa;
 524         /* Set the pointer in DCBAA register */
 525         xhci_writeq(&hcor->or_dcbaap, val_64);
 526
 527         /* Command ring control pointer register initialization */
 528         ctrl->cmd_ring = xhci_ring_alloc(1, true);
 529
 530         /* Set the address in the Command Ring Control register */
 531         trb_64 = (uintptr_t)ctrl->cmd_ring->first_seg->trbs;
 532         val_64 = xhci_readq(&hcor->or_crcr);
 533         val_64 = (val_64 & (u64) CMD_RING_RSVD_BITS) |
 534                 (trb_64 & (u64) ~CMD_RING_RSVD_BITS) |
 535                 ctrl->cmd_ring->cycle_state;
 536         xhci_writeq(&hcor->or_crcr, val_64);
 537
 538         /* write the address of db register */
 539         val = xhci_readl(&hccr->cr_dboff);
 540         val &= DBOFF_MASK;
 541         ctrl->dba = (struct xhci_doorbell_array *)((char *)hccr + val);
 542
 543         /* write the address of runtime register */
 544         val = xhci_readl(&hccr->cr_rtsoff);
 545         val &= RTSOFF_MASK;
 546         ctrl->run_regs = (struct xhci_run_regs *)((char *)hccr + val);
 547
 548         /* writting the address of ir_set structure */
 549         ctrl->ir_set = &ctrl->run_regs->ir_set[0];
 550
 551         /* Event ring does not maintain link TRB */
 552         ctrl->event_ring = xhci_ring_alloc(ERST_NUM_SEGS, false);
 553         ctrl->erst.entries = (struct xhci_erst_entry *)
 554                 xhci_malloc(sizeof(struct xhci_erst_entry) * ERST_NUM_SEGS);
 555
 556         ctrl->erst.num_entries = ERST_NUM_SEGS;
 557
 558         for (val = 0, seg = ctrl->event_ring->first_seg;
 559                         val < ERST_NUM_SEGS;
 560                         val++) {
 561                 trb_64 = 0;
 562                 trb_64 = (uintptr_t)seg->trbs;
 563                 struct xhci_erst_entry *entry = &ctrl->erst.entries[val];
 564                 xhci_writeq(&entry->seg_addr, trb_64);
 565                 entry->seg_size = cpu_to_le32(TRBS_PER_SEGMENT);
 566                 entry->rsvd = 0;
 567                 seg = seg->next;
 568         }
 569         xhci_flush_cache((uintptr_t)ctrl->erst.entries,
 570                          ERST_NUM_SEGS * sizeof(struct xhci_erst_entry));
 571
 572         deq = (unsigned long)ctrl->event_ring->dequeue;
 573
 574         /* Update HC event ring dequeue pointer */
 575         xhci_writeq(&ctrl->ir_set->erst_dequeue,
 576                                 (u64)deq & (u64)~ERST_PTR_MASK);
 577
 578         /* set ERST count with the number of entries in the segment table */
 579         val = xhci_readl(&ctrl->ir_set->erst_size);
 580         val &= ERST_SIZE_MASK;
 581         val |= ERST_NUM_SEGS;
 582         xhci_writel(&ctrl->ir_set->erst_size, val);
 583
 584         /* this is the event ring segment table pointer */
 585         val_64 = xhci_readq(&ctrl->ir_set->erst_base);
 586         val_64 &= ERST_PTR_MASK;
 587         val_64 |= ((uintptr_t)(ctrl->erst.entries) & ~ERST_PTR_MASK);
 588
 589         xhci_writeq(&ctrl->ir_set->erst_base, val_64);
 590
 591         /* set up the scratchpad buffer array and scratchpad buffers */
 592         xhci_scratchpad_alloc(ctrl);
 593
 594         /* initializing the virtual devices to NULL */
 595         for (i = 0; i < MAX_HC_SLOTS; ++i)
 596                 ctrl->devs[i] = NULL;
 597
 598         /*
 599          * Just Zero'ing this register completely,
 600          * or some spurious Device Notification Events
 601          * might screw things here.
 602          */
 603         xhci_writel(&hcor->or_dnctrl, 0x0);
 604
 605         return 0;
 606 }
 607
 608 /**
 609  * Give the input control context for the passed container context
 610  *
 611  * @param ctx   pointer to the context
 612  * @return pointer to the Input control context data
 613  */
 614 struct xhci_input_control_ctx
 615                 *xhci_get_input_control_ctx(struct xhci_container_ctx *ctx)
 616 {
 617         BUG_ON(ctx->type != XHCI_CTX_TYPE_INPUT);
 618         return (struct xhci_input_control_ctx *)ctx->bytes;
 619 }
 620
 621 /**
 622  * Give the slot context for the passed container context
 623  *
 624  * @param ctrl  Host controller data structure
 625  * @param ctx   pointer to the context
 626  * @return pointer to the slot control context data
 627  */
 628 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl,
 629                                 struct xhci_container_ctx *ctx)
 630 {
 631         if (ctx->type == XHCI_CTX_TYPE_DEVICE)
 632                 return (struct xhci_slot_ctx *)ctx->bytes;
 633
 634         return (struct xhci_slot_ctx *)
 635                 (ctx->bytes + CTX_SIZE(readl(&ctrl->hccr->cr_hccparams)));
 636 }
 637
 638 /**
 639  * Gets the EP context from based on the ep_index
 640  *
 641  * @param ctrl  Host controller data structure
 642  * @param ctx   context container
 643  * @param ep_index      index of the endpoint
 644  * @return pointer to the End point context
 645  */
 646 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl,
 647                                     struct xhci_container_ctx *ctx,
 648                                     unsigned int ep_index)
 649 {
 650         /* increment ep index by offset of start of ep ctx array */
 651         ep_index++;
 652         if (ctx->type == XHCI_CTX_TYPE_INPUT)
 653                 ep_index++;
 654
 655         return (struct xhci_ep_ctx *)
 656                 (ctx->bytes +
 657                 (ep_index * CTX_SIZE(readl(&ctrl->hccr->cr_hccparams))));
 658 }
 659
 660 /**
 661  * Copy output xhci_ep_ctx to the input xhci_ep_ctx copy.
 662  * Useful when you want to change one particular aspect of the endpoint
 663  * and then issue a configure endpoint command.
 664  *
 665  * @param ctrl  Host controller data structure
 666  * @param in_ctx contains the input context
 667  * @param out_ctx contains the input context
 668  * @param ep_index index of the end point
 669  * @return none
 670  */
 671 void xhci_endpoint_copy(struct xhci_ctrl *ctrl,
 672                         struct xhci_container_ctx *in_ctx,
 673                         struct xhci_container_ctx *out_ctx,
 674                         unsigned int ep_index)
 675 {
 676         struct xhci_ep_ctx *out_ep_ctx;
 677         struct xhci_ep_ctx *in_ep_ctx;
 678
 679         out_ep_ctx = xhci_get_ep_ctx(ctrl, out_ctx, ep_index);
 680         in_ep_ctx = xhci_get_ep_ctx(ctrl, in_ctx, ep_index);
 681
 682         in_ep_ctx->ep_info = out_ep_ctx->ep_info;
 683         in_ep_ctx->ep_info2 = out_ep_ctx->ep_info2;
 684         in_ep_ctx->deq = out_ep_ctx->deq;
 685         in_ep_ctx->tx_info = out_ep_ctx->tx_info;
 686 }
 687
 688 /**
 689  * Copy output xhci_slot_ctx to the input xhci_slot_ctx.
 690  * Useful when you want to change one particular aspect of the endpoint
 691  * and then issue a configure endpoint command.
 692  * Only the context entries field matters, but
 693  * we'll copy the whole thing anyway.
 694  *
 695  * @param ctrl  Host controller data structure
 696  * @param in_ctx contains the inpout context
 697  * @param out_ctx contains the inpout context
 698  * @return none
 699  */
 700 void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx,
 701                                         struct xhci_container_ctx *out_ctx)
 702 {
 703         struct xhci_slot_ctx *in_slot_ctx;
 704         struct xhci_slot_ctx *out_slot_ctx;
 705
 706         in_slot_ctx = xhci_get_slot_ctx(ctrl, in_ctx);
 707         out_slot_ctx = xhci_get_slot_ctx(ctrl, out_ctx);
 708
 709         in_slot_ctx->dev_info = out_slot_ctx->dev_info;
 710         in_slot_ctx->dev_info2 = out_slot_ctx->dev_info2;
 711         in_slot_ctx->tt_info = out_slot_ctx->tt_info;
 712         in_slot_ctx->dev_state = out_slot_ctx->dev_state;
 713 }
 714
 715 /**
 716  * Setup an xHCI virtual device for a Set Address command
 717  *
 718  * @param udev pointer to the Device Data Structure
 719  * @return returns negative value on failure else 0 on success
 720  */
 721 void xhci_setup_addressable_virt_dev(struct xhci_ctrl *ctrl,
 722                                      struct usb_device *udev, int hop_portnr)
 723 {
 724         struct xhci_virt_device *virt_dev;
 725         struct xhci_ep_ctx *ep0_ctx;
 726         struct xhci_slot_ctx *slot_ctx;
 727         u32 port_num = 0;
 728         u64 trb_64 = 0;
 729         int slot_id = udev->slot_id;
 730         int speed = udev->speed;
 731         int route = 0;
 732 #if CONFIG_IS_ENABLED(DM_USB)
 733         struct usb_device *dev = udev;
 734         struct usb_hub_device *hub;
 735 #endif
 736
 737         virt_dev = ctrl->devs[slot_id];
 738
 739         BUG_ON(!virt_dev);
 740
 741         /* Extract the EP0 and Slot Ctrl */
 742         ep0_ctx = xhci_get_ep_ctx(ctrl, virt_dev->in_ctx, 0);
 743         slot_ctx = xhci_get_slot_ctx(ctrl, virt_dev->in_ctx);
 744
 745         /* Only the control endpoint is valid - one endpoint context */
 746         slot_ctx->dev_info |= cpu_to_le32(LAST_CTX(1));
 747
 748 #if CONFIG_IS_ENABLED(DM_USB)
 749         /* Calculate the route string for this device */
 750         port_num = dev->portnr;
 751         while (!usb_hub_is_root_hub(dev->dev)) {
 752                 hub = dev_get_uclass_priv(dev->dev);
 753                 /*
 754                  * Each hub in the topology is expected to have no more than
 755                  * 15 ports in order for the route string of a device to be
 756                  * unique. SuperSpeed hubs are restricted to only having 15
 757                  * ports, but FS/LS/HS hubs are not. The xHCI specification
 758                  * says that if the port number the device is greater than 15,
 759                  * that portion of the route string shall be set to 15.
 760                  */
 761                 if (port_num > 15)
 762                         port_num = 15;
 763                 route |= port_num << (hub->hub_depth * 4);
 764                 dev = dev_get_parent_priv(dev->dev);
 765                 port_num = dev->portnr;
 766                 dev = dev_get_parent_priv(dev->dev->parent);
 767         }
 768
 769         debug("route string %x\n", route);
 770 #endif
 771         slot_ctx->dev_info |= route;
 772
 773         switch (speed) {
 774         case USB_SPEED_SUPER:
 775                 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_SS);
 776                 break;
 777         case USB_SPEED_HIGH:
 778                 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_HS);
 779                 break;
 780         case USB_SPEED_FULL:
 781                 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_FS);
 782                 break;
 783         case USB_SPEED_LOW:
 784                 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_LS);
 785                 break;
 786         default:
 787                 /* Speed was set earlier, this shouldn't happen. */
 788                 BUG();
 789         }
 790
 791 #if CONFIG_IS_ENABLED(DM_USB)
 792         /* Set up TT fields to support FS/LS devices */
 793         if (speed == USB_SPEED_LOW || speed == USB_SPEED_FULL) {
 794                 struct udevice *parent = udev->dev;
 795
 796                 dev = udev;
 797                 do {
 798                         port_num = dev->portnr;
 799                         dev = dev_get_parent_priv(parent);
 800                         if (usb_hub_is_root_hub(dev->dev))
 801                                 break;
 802                         parent = dev->dev->parent;
 803                 } while (dev->speed != USB_SPEED_HIGH);
 804
 805                 if (!usb_hub_is_root_hub(dev->dev)) {
 806                         hub = dev_get_uclass_priv(dev->dev);
 807                         if (hub->tt.multi)
 808                                 slot_ctx->dev_info |= cpu_to_le32(DEV_MTT);
 809                         slot_ctx->tt_info |= cpu_to_le32(TT_PORT(port_num));
 810                         slot_ctx->tt_info |= cpu_to_le32(TT_SLOT(dev->slot_id));
 811                 }
 812         }
 813 #endif
 814
 815         port_num = hop_portnr;
 816         debug("port_num = %d\n", port_num);
 817
 818         slot_ctx->dev_info2 |=
 819                         cpu_to_le32(((port_num & ROOT_HUB_PORT_MASK) <<
 820                                 ROOT_HUB_PORT_SHIFT));
 821
 822         /* Step 4 - ring already allocated */
 823         /* Step 5 */
 824         ep0_ctx->ep_info2 = cpu_to_le32(CTRL_EP << EP_TYPE_SHIFT);
 825         debug("SPEED = %d\n", speed);
 826
 827         switch (speed) {
 828         case USB_SPEED_SUPER:
 829                 ep0_ctx->ep_info2 |= cpu_to_le32(((512 & MAX_PACKET_MASK) <<
 830                                         MAX_PACKET_SHIFT));
 831                 debug("Setting Packet size = 512bytes\n");
 832                 break;
 833         case USB_SPEED_HIGH:
 834         /* USB core guesses at a 64-byte max packet first for FS devices */
 835         case USB_SPEED_FULL:
 836                 ep0_ctx->ep_info2 |= cpu_to_le32(((64 & MAX_PACKET_MASK) <<
 837                                         MAX_PACKET_SHIFT));
 838                 debug("Setting Packet size = 64bytes\n");
 839                 break;
 840         case USB_SPEED_LOW:
 841                 ep0_ctx->ep_info2 |= cpu_to_le32(((8 & MAX_PACKET_MASK) <<
 842                                         MAX_PACKET_SHIFT));
 843                 debug("Setting Packet size = 8bytes\n");
 844                 break;
 845         default:
 846                 /* New speed? */
 847                 BUG();
 848         }
 849
 850         /* EP 0 can handle "burst" sizes of 1, so Max Burst Size field is 0 */
 851         ep0_ctx->ep_info2 |=
 852                         cpu_to_le32(((0 & MAX_BURST_MASK) << MAX_BURST_SHIFT) |
 853                         ((3 & ERROR_COUNT_MASK) << ERROR_COUNT_SHIFT));
 854
 855         trb_64 = (uintptr_t)virt_dev->eps[0].ring->first_seg->trbs;
 856         ep0_ctx->deq = cpu_to_le64(trb_64 | virt_dev->eps[0].ring->cycle_state);
 857
 858         /*
 859          * xHCI spec 6.2.3:
 860          * software shall set 'Average TRB Length' to 8 for control endpoints.
 861          */
 862         ep0_ctx->tx_info = cpu_to_le32(EP_AVG_TRB_LENGTH(8));
 863
 864         /* Steps 7 and 8 were done in xhci_alloc_virt_device() */
 865
 866         xhci_flush_cache((uintptr_t)ep0_ctx, sizeof(struct xhci_ep_ctx));
 867         xhci_flush_cache((uintptr_t)slot_ctx, sizeof(struct xhci_slot_ctx));
 868 }