blob: 108f4bd8cfd9033baee89ad419f4fba98a295d45 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Vivek Gautam4912dcc2013-09-14 14:02:45 +05302/*
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>
Vivek Gautam4912dcc2013-09-14 14:02:45 +053014 */
15
16#include <common.h>
Simon Glass63334482019-11-14 12:57:39 -070017#include <cpu_func.h>
Simon Glass49b41832015-03-25 12:22:53 -060018#include <dm.h>
Simon Glass0f2af882020-05-10 11:40:05 -060019#include <log.h>
Vivek Gautam4912dcc2013-09-14 14:02:45 +053020#include <asm/byteorder.h>
21#include <usb.h>
22#include <malloc.h>
23#include <asm/cache.h>
Simon Glassc06c1be2020-05-10 11:40:08 -060024#include <linux/bug.h>
Masahiro Yamada64e4f7f2016-09-21 11:28:57 +090025#include <linux/errno.h>
Vivek Gautam4912dcc2013-09-14 14:02:45 +053026
Jean-Jacques Hiblotad4142b2019-09-11 11:33:46 +020027#include <usb/xhci.h>
Vivek Gautam4912dcc2013-09-14 14:02:45 +053028
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 */
Sergey Temerkhanov38593462015-04-01 17:18:45 +030037void xhci_flush_cache(uintptr_t addr, u32 len)
Vivek Gautam4912dcc2013-09-14 14:02:45 +053038{
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 */
Sergey Temerkhanov38593462015-04-01 17:18:45 +030052void xhci_inval_cache(uintptr_t addr, u32 len)
Vivek Gautam4912dcc2013-09-14 14:02:45 +053053{
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 */
67static 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 */
81static 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/**
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800101 * Free the scratchpad buffer array and scratchpad buffers
102 *
103 * @ctrl host controller data structure
104 * @return none
105 */
106static 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/**
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530120 * frees the "xhci_container_ctx" pointer passed
121 *
122 * @param ptr pointer to "xhci_container_ctx" to be freed
123 * @return none
124 */
125static 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 */
137static 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 */
175void xhci_cleanup(struct xhci_ctrl *ctrl)
176{
177 xhci_ring_free(ctrl->event_ring);
178 xhci_ring_free(ctrl->cmd_ring);
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800179 xhci_scratchpad_free(ctrl);
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530180 xhci_free_virt_devices(ctrl);
181 free(ctrl->erst.entries);
182 free(ctrl->dcbaa);
Nicolas Saenz Julienne566107e2020-06-29 18:37:25 +0200183 if (reset_valid(&ctrl->reset))
184 reset_free(&ctrl->reset);
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530185 memset(ctrl, '\0', sizeof(struct xhci_ctrl));
186}
187
188/**
189 * Malloc the aligned memory
190 *
191 * @param size size of memory to be allocated
192 * @return allocates the memory and returns the aligned pointer
193 */
194static void *xhci_malloc(unsigned int size)
195{
196 void *ptr;
197 size_t cacheline_size = max(XHCI_ALIGNMENT, CACHELINE_SIZE);
198
199 ptr = memalign(cacheline_size, ALIGN(size, cacheline_size));
200 BUG_ON(!ptr);
201 memset(ptr, '\0', size);
202
Sergey Temerkhanov38593462015-04-01 17:18:45 +0300203 xhci_flush_cache((uintptr_t)ptr, size);
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530204
205 return ptr;
206}
207
208/**
209 * Make the prev segment point to the next segment.
210 * Change the last TRB in the prev segment to be a Link TRB which points to the
211 * address of the next segment. The caller needs to set any Link TRB
212 * related flags, such as End TRB, Toggle Cycle, and no snoop.
213 *
214 * @param prev pointer to the previous segment
215 * @param next pointer to the next segment
216 * @param link_trbs flag to indicate whether to link the trbs or NOT
217 * @return none
218 */
219static void xhci_link_segments(struct xhci_segment *prev,
220 struct xhci_segment *next, bool link_trbs)
221{
222 u32 val;
223 u64 val_64 = 0;
224
225 if (!prev || !next)
226 return;
227 prev->next = next;
228 if (link_trbs) {
229 val_64 = (uintptr_t)next->trbs;
230 prev->trbs[TRBS_PER_SEGMENT-1].link.segment_ptr = val_64;
231
232 /*
233 * Set the last TRB in the segment to
234 * have a TRB type ID of Link TRB
235 */
236 val = le32_to_cpu(prev->trbs[TRBS_PER_SEGMENT-1].link.control);
237 val &= ~TRB_TYPE_BITMASK;
238 val |= (TRB_LINK << TRB_TYPE_SHIFT);
239
240 prev->trbs[TRBS_PER_SEGMENT-1].link.control = cpu_to_le32(val);
241 }
242}
243
244/**
245 * Initialises the Ring's enqueue,dequeue,enq_seg pointers
246 *
247 * @param ring pointer to the RING to be intialised
248 * @return none
249 */
250static void xhci_initialize_ring_info(struct xhci_ring *ring)
251{
252 /*
253 * The ring is empty, so the enqueue pointer == dequeue pointer
254 */
255 ring->enqueue = ring->first_seg->trbs;
256 ring->enq_seg = ring->first_seg;
257 ring->dequeue = ring->enqueue;
258 ring->deq_seg = ring->first_seg;
259
260 /*
261 * The ring is initialized to 0. The producer must write 1 to the
262 * cycle bit to handover ownership of the TRB, so PCS = 1.
263 * The consumer must compare CCS to the cycle bit to
264 * check ownership, so CCS = 1.
265 */
266 ring->cycle_state = 1;
267}
268
269/**
270 * Allocates a generic ring segment from the ring pool, sets the dma address,
271 * initializes the segment to zero, and sets the private next pointer to NULL.
272 * Section 4.11.1.1:
273 * "All components of all Command and Transfer TRBs shall be initialized to '0'"
274 *
275 * @param none
276 * @return pointer to the newly allocated SEGMENT
277 */
278static struct xhci_segment *xhci_segment_alloc(void)
279{
280 struct xhci_segment *seg;
281
282 seg = (struct xhci_segment *)malloc(sizeof(struct xhci_segment));
283 BUG_ON(!seg);
284
285 seg->trbs = (union xhci_trb *)xhci_malloc(SEGMENT_SIZE);
286
287 seg->next = NULL;
288
289 return seg;
290}
291
292/**
293 * Create a new ring with zero or more segments.
294 * TODO: current code only uses one-time-allocated single-segment rings
295 * of 1KB anyway, so we might as well get rid of all the segment and
296 * linking code (and maybe increase the size a bit, e.g. 4KB).
297 *
298 *
299 * Link each segment together into a ring.
300 * Set the end flag and the cycle toggle bit on the last segment.
301 * See section 4.9.2 and figures 15 and 16 of XHCI spec rev1.0.
302 *
303 * @param num_segs number of segments in the ring
304 * @param link_trbs flag to indicate whether to link the trbs or NOT
305 * @return pointer to the newly created RING
306 */
307struct xhci_ring *xhci_ring_alloc(unsigned int num_segs, bool link_trbs)
308{
309 struct xhci_ring *ring;
310 struct xhci_segment *prev;
311
312 ring = (struct xhci_ring *)malloc(sizeof(struct xhci_ring));
313 BUG_ON(!ring);
314
315 if (num_segs == 0)
316 return ring;
317
318 ring->first_seg = xhci_segment_alloc();
319 BUG_ON(!ring->first_seg);
320
321 num_segs--;
322
323 prev = ring->first_seg;
324 while (num_segs > 0) {
325 struct xhci_segment *next;
326
327 next = xhci_segment_alloc();
328 BUG_ON(!next);
329
330 xhci_link_segments(prev, next, link_trbs);
331
332 prev = next;
333 num_segs--;
334 }
335 xhci_link_segments(prev, ring->first_seg, link_trbs);
336 if (link_trbs) {
337 /* See section 4.9.2.1 and 6.4.4.1 */
338 prev->trbs[TRBS_PER_SEGMENT-1].link.control |=
339 cpu_to_le32(LINK_TOGGLE);
340 }
341 xhci_initialize_ring_info(ring);
342
343 return ring;
344}
345
346/**
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800347 * Set up the scratchpad buffer array and scratchpad buffers
348 *
349 * @ctrl host controller data structure
350 * @return -ENOMEM if buffer allocation fails, 0 on success
351 */
352static int xhci_scratchpad_alloc(struct xhci_ctrl *ctrl)
353{
354 struct xhci_hccr *hccr = ctrl->hccr;
355 struct xhci_hcor *hcor = ctrl->hcor;
356 struct xhci_scratchpad *scratchpad;
357 int num_sp;
358 uint32_t page_size;
359 void *buf;
360 int i;
361
362 num_sp = HCS_MAX_SCRATCHPAD(xhci_readl(&hccr->cr_hcsparams2));
363 if (!num_sp)
364 return 0;
365
366 scratchpad = malloc(sizeof(*scratchpad));
367 if (!scratchpad)
368 goto fail_sp;
369 ctrl->scratchpad = scratchpad;
370
371 scratchpad->sp_array = xhci_malloc(num_sp * sizeof(u64));
372 if (!scratchpad->sp_array)
373 goto fail_sp2;
374 ctrl->dcbaa->dev_context_ptrs[0] =
375 cpu_to_le64((uintptr_t)scratchpad->sp_array);
376
Ye Li4bda7182019-01-07 02:45:46 +0000377 xhci_flush_cache((uintptr_t)&ctrl->dcbaa->dev_context_ptrs[0],
378 sizeof(ctrl->dcbaa->dev_context_ptrs[0]));
379
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800380 page_size = xhci_readl(&hcor->or_pagesize) & 0xffff;
381 for (i = 0; i < 16; i++) {
382 if ((0x1 & page_size) != 0)
383 break;
384 page_size = page_size >> 1;
385 }
386 BUG_ON(i == 16);
387
388 page_size = 1 << (i + 12);
389 buf = memalign(page_size, num_sp * page_size);
390 if (!buf)
391 goto fail_sp3;
392 memset(buf, '\0', num_sp * page_size);
393 xhci_flush_cache((uintptr_t)buf, num_sp * page_size);
394
395 for (i = 0; i < num_sp; i++) {
396 uintptr_t ptr = (uintptr_t)buf + i * page_size;
397 scratchpad->sp_array[i] = cpu_to_le64(ptr);
398 }
399
Sylwester Nawrockiffedc752020-05-25 13:39:51 +0200400 xhci_flush_cache((uintptr_t)scratchpad->sp_array,
401 sizeof(u64) * num_sp);
402
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800403 return 0;
404
405fail_sp3:
406 free(scratchpad->sp_array);
407
408fail_sp2:
409 free(scratchpad);
410 ctrl->scratchpad = NULL;
411
412fail_sp:
413 return -ENOMEM;
414}
415
416/**
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530417 * Allocates the Container context
418 *
419 * @param ctrl Host controller data structure
420 * @param type type of XHCI Container Context
421 * @return NULL if failed else pointer to the context on success
422 */
423static struct xhci_container_ctx
424 *xhci_alloc_container_ctx(struct xhci_ctrl *ctrl, int type)
425{
426 struct xhci_container_ctx *ctx;
427
428 ctx = (struct xhci_container_ctx *)
429 malloc(sizeof(struct xhci_container_ctx));
430 BUG_ON(!ctx);
431
432 BUG_ON((type != XHCI_CTX_TYPE_DEVICE) && (type != XHCI_CTX_TYPE_INPUT));
433 ctx->type = type;
434 ctx->size = (MAX_EP_CTX_NUM + 1) *
435 CTX_SIZE(readl(&ctrl->hccr->cr_hccparams));
436 if (type == XHCI_CTX_TYPE_INPUT)
437 ctx->size += CTX_SIZE(readl(&ctrl->hccr->cr_hccparams));
438
439 ctx->bytes = (u8 *)xhci_malloc(ctx->size);
440
441 return ctx;
442}
443
444/**
445 * Allocating virtual device
446 *
447 * @param udev pointer to USB deivce structure
448 * @return 0 on success else -1 on failure
449 */
Simon Glass88a37842015-03-25 12:22:50 -0600450int xhci_alloc_virt_device(struct xhci_ctrl *ctrl, unsigned int slot_id)
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530451{
452 u64 byte_64 = 0;
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530453 struct xhci_virt_device *virt_dev;
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530454
455 /* Slot ID 0 is reserved */
456 if (ctrl->devs[slot_id]) {
457 printf("Virt dev for slot[%d] already allocated\n", slot_id);
458 return -EEXIST;
459 }
460
461 ctrl->devs[slot_id] = (struct xhci_virt_device *)
462 malloc(sizeof(struct xhci_virt_device));
463
464 if (!ctrl->devs[slot_id]) {
465 puts("Failed to allocate virtual device\n");
466 return -ENOMEM;
467 }
468
469 memset(ctrl->devs[slot_id], 0, sizeof(struct xhci_virt_device));
470 virt_dev = ctrl->devs[slot_id];
471
472 /* Allocate the (output) device context that will be used in the HC. */
473 virt_dev->out_ctx = xhci_alloc_container_ctx(ctrl,
474 XHCI_CTX_TYPE_DEVICE);
475 if (!virt_dev->out_ctx) {
476 puts("Failed to allocate out context for virt dev\n");
477 return -ENOMEM;
478 }
479
480 /* Allocate the (input) device context for address device command */
481 virt_dev->in_ctx = xhci_alloc_container_ctx(ctrl,
482 XHCI_CTX_TYPE_INPUT);
483 if (!virt_dev->in_ctx) {
484 puts("Failed to allocate in context for virt dev\n");
485 return -ENOMEM;
486 }
487
488 /* Allocate endpoint 0 ring */
489 virt_dev->eps[0].ring = xhci_ring_alloc(1, true);
490
491 byte_64 = (uintptr_t)(virt_dev->out_ctx->bytes);
492
493 /* Point to output device context in dcbaa. */
494 ctrl->dcbaa->dev_context_ptrs[slot_id] = byte_64;
495
Sergey Temerkhanov38593462015-04-01 17:18:45 +0300496 xhci_flush_cache((uintptr_t)&ctrl->dcbaa->dev_context_ptrs[slot_id],
497 sizeof(__le64));
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530498 return 0;
499}
500
501/**
502 * Allocates the necessary data structures
503 * for XHCI host controller
504 *
505 * @param ctrl Host controller data structure
506 * @param hccr pointer to HOST Controller Control Registers
507 * @param hcor pointer to HOST Controller Operational Registers
508 * @return 0 if successful else -1 on failure
509 */
510int xhci_mem_init(struct xhci_ctrl *ctrl, struct xhci_hccr *hccr,
511 struct xhci_hcor *hcor)
512{
513 uint64_t val_64;
514 uint64_t trb_64;
515 uint32_t val;
516 unsigned long deq;
517 int i;
518 struct xhci_segment *seg;
519
520 /* DCBAA initialization */
521 ctrl->dcbaa = (struct xhci_device_context_array *)
522 xhci_malloc(sizeof(struct xhci_device_context_array));
523 if (ctrl->dcbaa == NULL) {
524 puts("unable to allocate DCBA\n");
525 return -ENOMEM;
526 }
527
528 val_64 = (uintptr_t)ctrl->dcbaa;
529 /* Set the pointer in DCBAA register */
530 xhci_writeq(&hcor->or_dcbaap, val_64);
531
532 /* Command ring control pointer register initialization */
533 ctrl->cmd_ring = xhci_ring_alloc(1, true);
534
535 /* Set the address in the Command Ring Control register */
536 trb_64 = (uintptr_t)ctrl->cmd_ring->first_seg->trbs;
537 val_64 = xhci_readq(&hcor->or_crcr);
538 val_64 = (val_64 & (u64) CMD_RING_RSVD_BITS) |
539 (trb_64 & (u64) ~CMD_RING_RSVD_BITS) |
540 ctrl->cmd_ring->cycle_state;
541 xhci_writeq(&hcor->or_crcr, val_64);
542
543 /* write the address of db register */
544 val = xhci_readl(&hccr->cr_dboff);
545 val &= DBOFF_MASK;
546 ctrl->dba = (struct xhci_doorbell_array *)((char *)hccr + val);
547
548 /* write the address of runtime register */
549 val = xhci_readl(&hccr->cr_rtsoff);
550 val &= RTSOFF_MASK;
551 ctrl->run_regs = (struct xhci_run_regs *)((char *)hccr + val);
552
553 /* writting the address of ir_set structure */
554 ctrl->ir_set = &ctrl->run_regs->ir_set[0];
555
556 /* Event ring does not maintain link TRB */
557 ctrl->event_ring = xhci_ring_alloc(ERST_NUM_SEGS, false);
558 ctrl->erst.entries = (struct xhci_erst_entry *)
559 xhci_malloc(sizeof(struct xhci_erst_entry) * ERST_NUM_SEGS);
560
561 ctrl->erst.num_entries = ERST_NUM_SEGS;
562
563 for (val = 0, seg = ctrl->event_ring->first_seg;
564 val < ERST_NUM_SEGS;
565 val++) {
566 trb_64 = 0;
567 trb_64 = (uintptr_t)seg->trbs;
568 struct xhci_erst_entry *entry = &ctrl->erst.entries[val];
569 xhci_writeq(&entry->seg_addr, trb_64);
570 entry->seg_size = cpu_to_le32(TRBS_PER_SEGMENT);
571 entry->rsvd = 0;
572 seg = seg->next;
573 }
Sergey Temerkhanov38593462015-04-01 17:18:45 +0300574 xhci_flush_cache((uintptr_t)ctrl->erst.entries,
575 ERST_NUM_SEGS * sizeof(struct xhci_erst_entry));
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530576
577 deq = (unsigned long)ctrl->event_ring->dequeue;
578
579 /* Update HC event ring dequeue pointer */
580 xhci_writeq(&ctrl->ir_set->erst_dequeue,
581 (u64)deq & (u64)~ERST_PTR_MASK);
582
583 /* set ERST count with the number of entries in the segment table */
584 val = xhci_readl(&ctrl->ir_set->erst_size);
585 val &= ERST_SIZE_MASK;
586 val |= ERST_NUM_SEGS;
587 xhci_writel(&ctrl->ir_set->erst_size, val);
588
589 /* this is the event ring segment table pointer */
590 val_64 = xhci_readq(&ctrl->ir_set->erst_base);
591 val_64 &= ERST_PTR_MASK;
Sergey Temerkhanov38593462015-04-01 17:18:45 +0300592 val_64 |= ((uintptr_t)(ctrl->erst.entries) & ~ERST_PTR_MASK);
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530593
594 xhci_writeq(&ctrl->ir_set->erst_base, val_64);
595
Bin Meng8a3f9cf2017-07-19 21:49:55 +0800596 /* set up the scratchpad buffer array and scratchpad buffers */
597 xhci_scratchpad_alloc(ctrl);
598
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530599 /* initializing the virtual devices to NULL */
600 for (i = 0; i < MAX_HC_SLOTS; ++i)
601 ctrl->devs[i] = NULL;
602
603 /*
604 * Just Zero'ing this register completely,
605 * or some spurious Device Notification Events
606 * might screw things here.
607 */
608 xhci_writel(&hcor->or_dnctrl, 0x0);
609
610 return 0;
611}
612
613/**
614 * Give the input control context for the passed container context
615 *
616 * @param ctx pointer to the context
617 * @return pointer to the Input control context data
618 */
619struct xhci_input_control_ctx
620 *xhci_get_input_control_ctx(struct xhci_container_ctx *ctx)
621{
622 BUG_ON(ctx->type != XHCI_CTX_TYPE_INPUT);
623 return (struct xhci_input_control_ctx *)ctx->bytes;
624}
625
626/**
627 * Give the slot context for the passed container context
628 *
629 * @param ctrl Host controller data structure
630 * @param ctx pointer to the context
631 * @return pointer to the slot control context data
632 */
633struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_ctrl *ctrl,
634 struct xhci_container_ctx *ctx)
635{
636 if (ctx->type == XHCI_CTX_TYPE_DEVICE)
637 return (struct xhci_slot_ctx *)ctx->bytes;
638
639 return (struct xhci_slot_ctx *)
640 (ctx->bytes + CTX_SIZE(readl(&ctrl->hccr->cr_hccparams)));
641}
642
643/**
644 * Gets the EP context from based on the ep_index
645 *
646 * @param ctrl Host controller data structure
647 * @param ctx context container
648 * @param ep_index index of the endpoint
649 * @return pointer to the End point context
650 */
651struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_ctrl *ctrl,
652 struct xhci_container_ctx *ctx,
653 unsigned int ep_index)
654{
655 /* increment ep index by offset of start of ep ctx array */
656 ep_index++;
657 if (ctx->type == XHCI_CTX_TYPE_INPUT)
658 ep_index++;
659
660 return (struct xhci_ep_ctx *)
661 (ctx->bytes +
662 (ep_index * CTX_SIZE(readl(&ctrl->hccr->cr_hccparams))));
663}
664
665/**
666 * Copy output xhci_ep_ctx to the input xhci_ep_ctx copy.
667 * Useful when you want to change one particular aspect of the endpoint
668 * and then issue a configure endpoint command.
669 *
670 * @param ctrl Host controller data structure
671 * @param in_ctx contains the input context
672 * @param out_ctx contains the input context
673 * @param ep_index index of the end point
674 * @return none
675 */
676void xhci_endpoint_copy(struct xhci_ctrl *ctrl,
677 struct xhci_container_ctx *in_ctx,
678 struct xhci_container_ctx *out_ctx,
679 unsigned int ep_index)
680{
681 struct xhci_ep_ctx *out_ep_ctx;
682 struct xhci_ep_ctx *in_ep_ctx;
683
684 out_ep_ctx = xhci_get_ep_ctx(ctrl, out_ctx, ep_index);
685 in_ep_ctx = xhci_get_ep_ctx(ctrl, in_ctx, ep_index);
686
687 in_ep_ctx->ep_info = out_ep_ctx->ep_info;
688 in_ep_ctx->ep_info2 = out_ep_ctx->ep_info2;
689 in_ep_ctx->deq = out_ep_ctx->deq;
690 in_ep_ctx->tx_info = out_ep_ctx->tx_info;
691}
692
693/**
694 * Copy output xhci_slot_ctx to the input xhci_slot_ctx.
695 * Useful when you want to change one particular aspect of the endpoint
696 * and then issue a configure endpoint command.
697 * Only the context entries field matters, but
698 * we'll copy the whole thing anyway.
699 *
700 * @param ctrl Host controller data structure
701 * @param in_ctx contains the inpout context
702 * @param out_ctx contains the inpout context
703 * @return none
704 */
705void xhci_slot_copy(struct xhci_ctrl *ctrl, struct xhci_container_ctx *in_ctx,
706 struct xhci_container_ctx *out_ctx)
707{
708 struct xhci_slot_ctx *in_slot_ctx;
709 struct xhci_slot_ctx *out_slot_ctx;
710
711 in_slot_ctx = xhci_get_slot_ctx(ctrl, in_ctx);
712 out_slot_ctx = xhci_get_slot_ctx(ctrl, out_ctx);
713
714 in_slot_ctx->dev_info = out_slot_ctx->dev_info;
715 in_slot_ctx->dev_info2 = out_slot_ctx->dev_info2;
716 in_slot_ctx->tt_info = out_slot_ctx->tt_info;
717 in_slot_ctx->dev_state = out_slot_ctx->dev_state;
718}
719
720/**
721 * Setup an xHCI virtual device for a Set Address command
722 *
723 * @param udev pointer to the Device Data Structure
724 * @return returns negative value on failure else 0 on success
725 */
Bin Meng1459ce62017-07-19 21:51:14 +0800726void xhci_setup_addressable_virt_dev(struct xhci_ctrl *ctrl,
727 struct usb_device *udev, int hop_portnr)
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530728{
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530729 struct xhci_virt_device *virt_dev;
730 struct xhci_ep_ctx *ep0_ctx;
731 struct xhci_slot_ctx *slot_ctx;
732 u32 port_num = 0;
733 u64 trb_64 = 0;
Bin Meng1459ce62017-07-19 21:51:14 +0800734 int slot_id = udev->slot_id;
735 int speed = udev->speed;
Bin Meng63c3b3b2017-07-19 21:51:15 +0800736 int route = 0;
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100737#if CONFIG_IS_ENABLED(DM_USB)
Bin Meng63c3b3b2017-07-19 21:51:15 +0800738 struct usb_device *dev = udev;
739 struct usb_hub_device *hub;
740#endif
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530741
Simon Glass4ec422c2015-03-25 12:22:51 -0600742 virt_dev = ctrl->devs[slot_id];
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530743
744 BUG_ON(!virt_dev);
745
746 /* Extract the EP0 and Slot Ctrl */
747 ep0_ctx = xhci_get_ep_ctx(ctrl, virt_dev->in_ctx, 0);
748 slot_ctx = xhci_get_slot_ctx(ctrl, virt_dev->in_ctx);
749
750 /* Only the control endpoint is valid - one endpoint context */
Bin Meng63c3b3b2017-07-19 21:51:15 +0800751 slot_ctx->dev_info |= cpu_to_le32(LAST_CTX(1));
752
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100753#if CONFIG_IS_ENABLED(DM_USB)
Bin Meng63c3b3b2017-07-19 21:51:15 +0800754 /* Calculate the route string for this device */
755 port_num = dev->portnr;
756 while (!usb_hub_is_root_hub(dev->dev)) {
757 hub = dev_get_uclass_priv(dev->dev);
758 /*
759 * Each hub in the topology is expected to have no more than
760 * 15 ports in order for the route string of a device to be
761 * unique. SuperSpeed hubs are restricted to only having 15
762 * ports, but FS/LS/HS hubs are not. The xHCI specification
763 * says that if the port number the device is greater than 15,
764 * that portion of the route string shall be set to 15.
765 */
766 if (port_num > 15)
767 port_num = 15;
768 route |= port_num << (hub->hub_depth * 4);
769 dev = dev_get_parent_priv(dev->dev);
770 port_num = dev->portnr;
771 dev = dev_get_parent_priv(dev->dev->parent);
772 }
773
774 debug("route string %x\n", route);
775#endif
776 slot_ctx->dev_info |= route;
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530777
Simon Glass4ec422c2015-03-25 12:22:51 -0600778 switch (speed) {
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530779 case USB_SPEED_SUPER:
780 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_SS);
781 break;
782 case USB_SPEED_HIGH:
783 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_HS);
784 break;
785 case USB_SPEED_FULL:
786 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_FS);
787 break;
788 case USB_SPEED_LOW:
789 slot_ctx->dev_info |= cpu_to_le32(SLOT_SPEED_LS);
790 break;
791 default:
792 /* Speed was set earlier, this shouldn't happen. */
793 BUG();
794 }
795
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100796#if CONFIG_IS_ENABLED(DM_USB)
Bin Mengfe3327f2017-07-19 21:51:21 +0800797 /* Set up TT fields to support FS/LS devices */
798 if (speed == USB_SPEED_LOW || speed == USB_SPEED_FULL) {
Bin Mengbb4b1052017-09-18 06:40:39 -0700799 struct udevice *parent = udev->dev;
800
801 dev = udev;
802 do {
803 port_num = dev->portnr;
804 dev = dev_get_parent_priv(parent);
805 if (usb_hub_is_root_hub(dev->dev))
806 break;
807 parent = dev->dev->parent;
808 } while (dev->speed != USB_SPEED_HIGH);
809
810 if (!usb_hub_is_root_hub(dev->dev)) {
811 hub = dev_get_uclass_priv(dev->dev);
Bin Mengfe3327f2017-07-19 21:51:21 +0800812 if (hub->tt.multi)
813 slot_ctx->dev_info |= cpu_to_le32(DEV_MTT);
Bin Mengbb4b1052017-09-18 06:40:39 -0700814 slot_ctx->tt_info |= cpu_to_le32(TT_PORT(port_num));
Bin Mengfe3327f2017-07-19 21:51:21 +0800815 slot_ctx->tt_info |= cpu_to_le32(TT_SLOT(dev->slot_id));
816 }
817 }
818#endif
819
Simon Glass4ec422c2015-03-25 12:22:51 -0600820 port_num = hop_portnr;
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530821 debug("port_num = %d\n", port_num);
822
823 slot_ctx->dev_info2 |=
824 cpu_to_le32(((port_num & ROOT_HUB_PORT_MASK) <<
825 ROOT_HUB_PORT_SHIFT));
826
827 /* Step 4 - ring already allocated */
828 /* Step 5 */
829 ep0_ctx->ep_info2 = cpu_to_le32(CTRL_EP << EP_TYPE_SHIFT);
Simon Glass4ec422c2015-03-25 12:22:51 -0600830 debug("SPEED = %d\n", speed);
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530831
Simon Glass4ec422c2015-03-25 12:22:51 -0600832 switch (speed) {
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530833 case USB_SPEED_SUPER:
834 ep0_ctx->ep_info2 |= cpu_to_le32(((512 & MAX_PACKET_MASK) <<
835 MAX_PACKET_SHIFT));
836 debug("Setting Packet size = 512bytes\n");
837 break;
838 case USB_SPEED_HIGH:
839 /* USB core guesses at a 64-byte max packet first for FS devices */
840 case USB_SPEED_FULL:
841 ep0_ctx->ep_info2 |= cpu_to_le32(((64 & MAX_PACKET_MASK) <<
842 MAX_PACKET_SHIFT));
843 debug("Setting Packet size = 64bytes\n");
844 break;
845 case USB_SPEED_LOW:
846 ep0_ctx->ep_info2 |= cpu_to_le32(((8 & MAX_PACKET_MASK) <<
847 MAX_PACKET_SHIFT));
848 debug("Setting Packet size = 8bytes\n");
849 break;
850 default:
851 /* New speed? */
852 BUG();
853 }
854
855 /* EP 0 can handle "burst" sizes of 1, so Max Burst Size field is 0 */
856 ep0_ctx->ep_info2 |=
857 cpu_to_le32(((0 & MAX_BURST_MASK) << MAX_BURST_SHIFT) |
858 ((3 & ERROR_COUNT_MASK) << ERROR_COUNT_SHIFT));
859
860 trb_64 = (uintptr_t)virt_dev->eps[0].ring->first_seg->trbs;
861 ep0_ctx->deq = cpu_to_le64(trb_64 | virt_dev->eps[0].ring->cycle_state);
862
Bin Mengc03fb202017-09-18 06:40:50 -0700863 /*
864 * xHCI spec 6.2.3:
865 * software shall set 'Average TRB Length' to 8 for control endpoints.
866 */
867 ep0_ctx->tx_info = cpu_to_le32(EP_AVG_TRB_LENGTH(8));
868
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530869 /* Steps 7 and 8 were done in xhci_alloc_virt_device() */
870
Sergey Temerkhanov38593462015-04-01 17:18:45 +0300871 xhci_flush_cache((uintptr_t)ep0_ctx, sizeof(struct xhci_ep_ctx));
872 xhci_flush_cache((uintptr_t)slot_ctx, sizeof(struct xhci_slot_ctx));
Vivek Gautam4912dcc2013-09-14 14:02:45 +0530873}