source: mainline/uspace/drv/bus/usb/xhci/hc.c@ 275f529

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 275f529 was 275f529, checked in by Petr Manek <petr.manek@…>, 8 years ago

Detecting transfer types.
  • Property mode set to 100644
File size: 13.7 KB
Line 
1/*
2 * Copyright (c) 2017 Ondrej Hlavaty
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup drvusbxhci
30 * @{
31 */
32/** @file
33 * @brief The host controller data bookkeeping.
34 */
35
36#include <errno.h>
37#include <str_error.h>
38#include <usb/debug.h>
39#include <usb/host/utils/malloc32.h>
40#include "debug.h"
41#include "hc.h"
42#include "rh.h"
43#include "hw_struct/trb.h"
44#include "commands.h"
45
46static const irq_cmd_t irq_commands[] = {
47 {
48 .cmd = CMD_PIO_READ_32,
49 .dstarg = 1,
50 .addr = NULL
51 },
52 {
53 .cmd = CMD_AND,
54 .srcarg = 1,
55 .dstarg = 2,
56 .value = 0
57 },
58 {
59 .cmd = CMD_PREDICATE,
60 .srcarg = 2,
61 .value = 2
62 },
63 {
64 .cmd = CMD_PIO_WRITE_A_32,
65 .srcarg = 1,
66 .addr = NULL
67 },
68 {
69 .cmd = CMD_ACCEPT
70 }
71};
72
73/**
74 * Default USB Speed ID mapping: Table 157
75 */
76#define PSI_TO_BPS(psie, psim) (((uint64_t) psim) << (10 * psie))
77#define PORT_SPEED(psie, psim) { \
78 .rx_bps = PSI_TO_BPS(psie, psim), \
79 .tx_bps = PSI_TO_BPS(psie, psim) \
80}
81static const xhci_port_speed_t ps_default_full = PORT_SPEED(2, 12);
82static const xhci_port_speed_t ps_default_low = PORT_SPEED(1, 1500);
83static const xhci_port_speed_t ps_default_high = PORT_SPEED(2, 480);
84static const xhci_port_speed_t ps_default_super = PORT_SPEED(3, 5);
85
86/**
87 * Walk the list of extended capabilities.
88 */
89static int hc_parse_ec(xhci_hc_t *hc)
90{
91 unsigned psic, major;
92
93 for (xhci_extcap_t *ec = hc->xecp; ec; ec = xhci_extcap_next(ec)) {
94 xhci_dump_extcap(ec);
95 switch (XHCI_REG_RD(ec, XHCI_EC_CAP_ID)) {
96 case XHCI_EC_USB_LEGACY:
97 assert(hc->legsup == NULL);
98 hc->legsup = (xhci_legsup_t *) ec;
99 break;
100 case XHCI_EC_SUPPORTED_PROTOCOL:
101 psic = XHCI_REG_RD(ec, XHCI_EC_SP_PSIC);
102 major = XHCI_REG_RD(ec, XHCI_EC_SP_MAJOR);
103
104 // "Implied" speed
105 if (psic == 0) {
106 /*
107 * According to section 7.2.2.1.2, only USB 2.0
108 * and USB 3.0 can have psic == 0. So we
109 * blindly assume the name == "USB " and minor
110 * == 0.
111 */
112 if (major == 2) {
113 hc->speeds[1] = ps_default_full;
114 hc->speeds[2] = ps_default_low;
115 hc->speeds[3] = ps_default_high;
116 } else if (major == 3) {
117 hc->speeds[4] = ps_default_super;
118 } else {
119 return EINVAL;
120 }
121
122 usb_log_debug2("Implied speed of USB %u set up.", major);
123 } else {
124 for (unsigned i = 0; i < psic; i++) {
125 xhci_psi_t *psi = xhci_extcap_psi(ec, i);
126 unsigned sim = XHCI_REG_RD(psi, XHCI_PSI_PSIM);
127 unsigned psiv = XHCI_REG_RD(psi, XHCI_PSI_PSIV);
128 unsigned psie = XHCI_REG_RD(psi, XHCI_PSI_PSIE);
129 unsigned psim = XHCI_REG_RD(psi, XHCI_PSI_PSIM);
130
131 uint64_t bps = PSI_TO_BPS(psie, psim);
132
133 if (sim == XHCI_PSI_PLT_SYMM || sim == XHCI_PSI_PLT_RX)
134 hc->speeds[psiv].rx_bps = bps;
135 if (sim == XHCI_PSI_PLT_SYMM || sim == XHCI_PSI_PLT_TX) {
136 hc->speeds[psiv].tx_bps = bps;
137 usb_log_debug2("Speed %u set up for bps %" PRIu64 " / %" PRIu64 ".", psiv, hc->speeds[psiv].rx_bps, hc->speeds[psiv].tx_bps);
138 }
139 }
140 }
141 }
142 }
143 return EOK;
144}
145
146int hc_init_mmio(xhci_hc_t *hc, const hw_res_list_parsed_t *hw_res)
147{
148 int err;
149
150 if (hw_res->mem_ranges.count != 1) {
151 usb_log_error("Unexpected MMIO area, bailing out.");
152 return EINVAL;
153 }
154
155 hc->mmio_range = hw_res->mem_ranges.ranges[0];
156
157 usb_log_debug("MMIO area at %p (size %zu), IRQ %d.\n",
158 RNGABSPTR(hc->mmio_range), RNGSZ(hc->mmio_range), hw_res->irqs.irqs[0]);
159
160 if (RNGSZ(hc->mmio_range) < sizeof(xhci_cap_regs_t))
161 return EOVERFLOW;
162
163 void *base;
164 if ((err = pio_enable_range(&hc->mmio_range, &base)))
165 return err;
166
167 hc->base = base;
168 hc->cap_regs = (xhci_cap_regs_t *) base;
169 hc->op_regs = (xhci_op_regs_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_LENGTH));
170 hc->rt_regs = (xhci_rt_regs_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_RTSOFF));
171 hc->db_arry = (xhci_doorbell_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_DBOFF));
172
173 uintptr_t xec_offset = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_XECP) * sizeof(xhci_dword_t);
174 if (xec_offset > 0)
175 hc->xecp = (xhci_extcap_t *) (base + xec_offset);
176
177 usb_log_debug2("Initialized MMIO reg areas:");
178 usb_log_debug2("\tCapability regs: %p", hc->cap_regs);
179 usb_log_debug2("\tOperational regs: %p", hc->op_regs);
180 usb_log_debug2("\tRuntime regs: %p", hc->rt_regs);
181 usb_log_debug2("\tDoorbell array base: %p", hc->db_arry);
182
183 xhci_dump_cap_regs(hc->cap_regs);
184
185 hc->ac64 = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_AC64);
186 hc->max_slots = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_MAX_SLOTS);
187
188 if ((err = hc_parse_ec(hc))) {
189 pio_disable(hc->base, RNGSZ(hc->mmio_range));
190 return err;
191 }
192
193 return EOK;
194}
195
196int hc_init_memory(xhci_hc_t *hc)
197{
198 int err;
199
200 hc->dcbaa = malloc32((1 + hc->max_slots) * sizeof(uint64_t));
201 if (!hc->dcbaa)
202 return ENOMEM;
203
204 hc->dcbaa_virt = malloc32((1 + hc->max_slots) * sizeof(xhci_device_ctx_t*));
205 if (!hc->dcbaa_virt) {
206 err = ENOMEM;
207 goto err_dcbaa;
208 }
209
210 if ((err = xhci_trb_ring_init(&hc->command_ring, hc)))
211 goto err_dcbaa_virt;
212
213 if ((err = xhci_event_ring_init(&hc->event_ring, hc)))
214 goto err_cmd_ring;
215
216 if ((err = xhci_scratchpad_alloc(hc)))
217 goto err_event_ring;
218
219 if ((err = xhci_init_commands(hc)))
220 goto err_event_ring;
221
222 return EOK;
223
224err_event_ring:
225 xhci_event_ring_fini(&hc->event_ring);
226err_cmd_ring:
227 xhci_trb_ring_fini(&hc->command_ring);
228err_dcbaa_virt:
229 free32(hc->dcbaa_virt);
230err_dcbaa:
231 free32(hc->dcbaa);
232 return err;
233}
234
235
236/**
237 * Generates code to accept interrupts. The xHCI is designed primarily for
238 * MSI/MSI-X, but we use PCI Interrupt Pin. In this mode, all the Interrupters
239 * (except 0) are disabled.
240 */
241int hc_irq_code_gen(irq_code_t *code, xhci_hc_t *hc, const hw_res_list_parsed_t *hw_res)
242{
243 assert(code);
244 assert(hw_res);
245
246 if (hw_res->irqs.count != 1) {
247 usb_log_info("Unexpected HW resources to enable interrupts.");
248 return EINVAL;
249 }
250
251 code->ranges = malloc(sizeof(irq_pio_range_t));
252 if (code->ranges == NULL)
253 return ENOMEM;
254
255 code->cmds = malloc(sizeof(irq_commands));
256 if (code->cmds == NULL) {
257 free(code->ranges);
258 return ENOMEM;
259 }
260
261 code->rangecount = 1;
262 code->ranges[0] = (irq_pio_range_t) {
263 .base = RNGABS(hc->mmio_range),
264 .size = RNGSZ(hc->mmio_range),
265 };
266
267 code->cmdcount = ARRAY_SIZE(irq_commands);
268 memcpy(code->cmds, irq_commands, sizeof(irq_commands));
269
270 void *intr0_iman = RNGABSPTR(hc->mmio_range) + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_RTSOFF) + offsetof(xhci_rt_regs_t, ir[0]);
271 code->cmds[0].addr = intr0_iman;
272 code->cmds[3].addr = intr0_iman;
273 code->cmds[1].value = host2xhci(32, 1);
274
275 return hw_res->irqs.irqs[0];
276}
277
278int hc_claim(xhci_hc_t *hc, ddf_dev_t *dev)
279{
280 /* No legacy support capability, the controller is solely for us */
281 if (!hc->legsup)
282 return EOK;
283
284 /*
285 * TODO: Implement handoff from BIOS, section 4.22.1
286 * QEMU does not support this, so we have to test on real HW.
287 */
288 return ENOTSUP;
289}
290
291static int hc_reset(xhci_hc_t *hc)
292{
293 /* Stop the HC: set R/S to 0 */
294 XHCI_REG_CLR(hc->op_regs, XHCI_OP_RS, 1);
295
296 /* Wait 16 ms until the HC is halted */
297 async_usleep(16000);
298 assert(XHCI_REG_RD(hc->op_regs, XHCI_OP_HCH));
299
300 /* Reset */
301 XHCI_REG_SET(hc->op_regs, XHCI_OP_HCRST, 1);
302
303 /* Wait until the reset is complete */
304 while (XHCI_REG_RD(hc->op_regs, XHCI_OP_HCRST))
305 async_usleep(1000);
306
307 return EOK;
308}
309
310/**
311 * Initialize the HC: section 4.2
312 */
313int hc_start(xhci_hc_t *hc, bool irq)
314{
315 int err;
316
317 if ((err = hc_reset(hc)))
318 return err;
319
320 while (XHCI_REG_RD(hc->op_regs, XHCI_OP_CNR))
321 async_usleep(1000);
322
323 uint64_t dcbaaptr = addr_to_phys(hc->dcbaa);
324 XHCI_REG_WR(hc->op_regs, XHCI_OP_DCBAAP_LO, LOWER32(dcbaaptr));
325 XHCI_REG_WR(hc->op_regs, XHCI_OP_DCBAAP_HI, UPPER32(dcbaaptr));
326 XHCI_REG_WR(hc->op_regs, XHCI_OP_MAX_SLOTS_EN, 0);
327
328 uint64_t crptr = xhci_trb_ring_get_dequeue_ptr(&hc->command_ring);
329 XHCI_REG_WR(hc->op_regs, XHCI_OP_CRCR_LO, LOWER32(crptr) >> 6);
330 XHCI_REG_WR(hc->op_regs, XHCI_OP_CRCR_HI, UPPER32(crptr));
331
332 uint64_t erstptr = addr_to_phys(hc->event_ring.erst);
333 uint64_t erdp = hc->event_ring.dequeue_ptr;
334 xhci_interrupter_regs_t *intr0 = &hc->rt_regs->ir[0];
335 XHCI_REG_WR(intr0, XHCI_INTR_ERSTSZ, hc->event_ring.segment_count);
336 XHCI_REG_WR(intr0, XHCI_INTR_ERDP_LO, LOWER32(erdp));
337 XHCI_REG_WR(intr0, XHCI_INTR_ERDP_HI, UPPER32(erdp));
338 XHCI_REG_WR(intr0, XHCI_INTR_ERSTBA_LO, LOWER32(erstptr));
339 XHCI_REG_WR(intr0, XHCI_INTR_ERSTBA_HI, UPPER32(erstptr));
340
341 if (irq) {
342 XHCI_REG_SET(intr0, XHCI_INTR_IE, 1);
343 XHCI_REG_SET(hc->op_regs, XHCI_OP_INTE, 1);
344 }
345
346 XHCI_REG_SET(hc->op_regs, XHCI_OP_RS, 1);
347
348 return EOK;
349}
350
351int hc_status(xhci_hc_t *hc, uint32_t *status)
352{
353 *status = XHCI_REG_RD(hc->op_regs, XHCI_OP_STATUS);
354 XHCI_REG_WR(hc->op_regs, XHCI_OP_STATUS, *status & XHCI_STATUS_ACK_MASK);
355
356 usb_log_debug2("HC(%p): Read status: %x", hc, *status);
357 return EOK;
358}
359
360int hc_schedule(xhci_hc_t *hc, usb_transfer_batch_t *batch)
361{
362 assert(batch);
363
364 usb_log_debug2("EP(%d:%d) started %s transfer of size %lu.",
365 batch->ep->address, batch->ep->endpoint,
366 usb_str_transfer_type(batch->ep->transfer_type),
367 batch->buffer_size);
368
369 switch (batch->ep->transfer_type) {
370 case USB_TRANSFER_CONTROL:
371 /* TODO: Send setup stage TRB. */
372 /* TODO: Optionally, send data stage TRB followed by zero or
373 more normal TRB's. */
374 /* TODO: Send status stage TRB. */
375 /* TODO: Ring the appropriate doorbell. */
376 break;
377 case USB_TRANSFER_ISOCHRONOUS:
378 /* TODO: Implement me. */
379 break;
380 case USB_TRANSFER_BULK:
381 /* TODO: Implement me. */
382 break;
383 case USB_TRANSFER_INTERRUPT:
384 /* TODO: Implement me. */
385 break;
386 }
387
388 return ENAK;
389}
390
391static void hc_handle_event(xhci_hc_t *hc, xhci_trb_t *trb)
392{
393 usb_log_debug2("TRB event encountered.");
394 switch (TRB_TYPE(*trb)) {
395 case XHCI_TRB_TYPE_COMMAND_COMPLETION_EVENT:
396 xhci_handle_command_completion(hc, trb);
397 break;
398 case XHCI_TRB_TYPE_PORT_STATUS_CHANGE_EVENT:
399 xhci_handle_port_status_change_event(hc, trb);
400 break;
401 default:
402 usb_log_debug2("Event type handling not implemented.");
403 break;
404 }
405}
406
407static void hc_run_event_ring(xhci_hc_t *hc, xhci_event_ring_t *event_ring, xhci_interrupter_regs_t *intr)
408{
409 int err;
410 xhci_trb_t trb;
411
412 err = xhci_event_ring_dequeue(event_ring, &trb);;
413
414 while (err != ENOENT) {
415 if (err == EOK) {
416 usb_log_debug2("Dequeued trb from event ring: %s",
417 xhci_trb_str_type(TRB_TYPE(trb)));
418
419 hc_handle_event(hc, &trb);
420 } else {
421 usb_log_warning("Error while accessing event ring: %s", str_error(err));
422 break;
423 }
424
425 err = xhci_event_ring_dequeue(event_ring, &trb);;
426 }
427 usb_log_debug2("Event ring processing finished.");
428
429 /* Update the ERDP to make room in the ring */
430 hc->event_ring.dequeue_ptr = host2xhci(64, addr_to_phys(hc->event_ring.dequeue_trb));
431 uint64_t erdp = hc->event_ring.dequeue_ptr;
432 XHCI_REG_WR(intr, XHCI_INTR_ERDP_LO, LOWER32(erdp));
433 XHCI_REG_WR(intr, XHCI_INTR_ERDP_HI, UPPER32(erdp));
434 XHCI_REG_SET(intr, XHCI_INTR_ERDP_EHB, 1);
435}
436
437void hc_interrupt(xhci_hc_t *hc, uint32_t status)
438{
439 /**
440 * TODO: This is a temporary workaround, when an event interrupt
441 * happens, status has the value of 3, which is equal to
442 * XHCI_REG_SHIFT(XHCI_OP_EINT), intstead to the correct
443 * XHCI_REG_MASK(XHCI_OP_EINT), which has the value of 8 (1 << 3).
444 * This is how e.g. FreeBSD does it.
445 */
446 status = hc->op_regs->usbsts;
447
448 if (status & XHCI_REG_MASK(XHCI_OP_HSE)) {
449 usb_log_error("Host controller error occured. Bad things gonna happen...");
450 }
451
452 if (status & XHCI_REG_MASK(XHCI_OP_EINT)) {
453 usb_log_debug2("Event interrupt.");
454
455 xhci_interrupter_regs_t *intr0 = &hc->rt_regs->ir[0];
456
457 /**
458 * EINT has to be cleared before IP, but we also need to
459 * handle the event before clearing EINT.
460 */
461 uint32_t ip = XHCI_REG_RD(intr0, XHCI_INTR_IP);
462
463 if (ip | 1) { // TODO: IP is being cleared right after it is set by the xHC.
464 hc_run_event_ring(hc, &hc->event_ring, intr0);
465 }
466
467 XHCI_REG_SET(hc->op_regs, XHCI_OP_EINT, 1);
468
469 if (ip) {
470 XHCI_REG_SET(intr0, XHCI_INTR_IP, 1);
471 }
472 }
473
474 if (status & XHCI_REG_MASK(XHCI_OP_PCD)) {
475 usb_log_error("Port change detected. Not implemented yet!");
476 }
477
478 if (status & XHCI_REG_MASK(XHCI_OP_SRE)) {
479 usb_log_error("Save/Restore error occured. WTF, S/R mechanism not implemented!");
480 }
481}
482
483static void hc_dcbaa_fini(xhci_hc_t *hc)
484{
485 xhci_scratchpad_free(hc);
486
487 /* Idx 0 already deallocated by xhci_scratchpad_free. */
488 for (unsigned i = 1; i < hc->max_slots + 1; ++i) {
489 if (hc->dcbaa_virt[i] != NULL) {
490 free32(hc->dcbaa_virt[i]);
491 hc->dcbaa_virt[i] = NULL;
492 }
493 }
494
495 free32(hc->dcbaa);
496 free32(hc->dcbaa_virt);
497}
498
499void hc_fini(xhci_hc_t *hc)
500{
501 xhci_trb_ring_fini(&hc->command_ring);
502 xhci_event_ring_fini(&hc->event_ring);
503 hc_dcbaa_fini(hc);
504 xhci_fini_commands(hc);
505 pio_disable(hc->base, RNGSZ(hc->mmio_range));
506 usb_log_info("HC(%p): Finalized.", hc);
507}
508
509
510
511/**
512 * @}
513 */
Note: See TracBrowser for help on using the repository browser.