Context Navigation

source: mainline/uspace/drv/bus/usb/xhci/hc.c@ 77ded647

Visit:

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export

Last change on this file since 77ded647 was 77ded647, checked in by Ondřej Hlavatý <aearsis@…>, 8 years ago
xhci: do not avoid 64-bit writes
Property mode set to `100644`
File size: 29.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/endpoint.h>
40	#include "debug.h"
41	#include "hc.h"
42	#include "rh.h"
43	#include "hw_struct/trb.h"
44	#include "hw_struct/context.h"
45	#include "endpoint.h"
46	#include "transfers.h"
47	#include "trb_ring.h"
48
49	/**
50	* Default USB Speed ID mapping: Table 157
51	*/
52	#define PSI_TO_BPS(psie, psim) (((uint64_t) psim) << (10 * psie))
53	#define PORT_SPEED(usb, mjr, psie, psim) { \
54	.name = "USB ", \
55	.major = mjr, \
56	.minor = 0, \
57	.usb_speed = USB_SPEED_##usb, \
58	.rx_bps = PSI_TO_BPS(psie, psim), \
59	.tx_bps = PSI_TO_BPS(psie, psim) \
60	}
61
62	static const xhci_port_speed_t default_psiv_to_port_speed [] = {
63	[1] = PORT_SPEED(FULL, 2, 2, 12),
64	[2] = PORT_SPEED(LOW, 2, 1, 1500),
65	[3] = PORT_SPEED(HIGH, 2, 2, 480),
66	[4] = PORT_SPEED(SUPER, 3, 3, 5),
67	};
68
69	static const unsigned usb_speed_to_psiv [] = {
70	[USB_SPEED_FULL] = 1,
71	[USB_SPEED_LOW] = 2,
72	[USB_SPEED_HIGH] = 3,
73	[USB_SPEED_SUPER] = 4,
74	};
75
76	/**
77	* Walk the list of extended capabilities.
78	*
79	* The most interesting thing hidden in extended capabilities is the mapping of
80	* ports to protocol versions and speeds.
81	*/
82	static int hc_parse_ec(xhci_hc_t *hc)
83	{
84	unsigned psic, major, minor;
85	xhci_sp_name_t name;
86
87	xhci_port_speed_t *speeds = hc->speeds;
88
89	for (xhci_extcap_t *ec = hc->xecp; ec; ec = xhci_extcap_next(ec)) {
90	xhci_dump_extcap(ec);
91	switch (XHCI_REG_RD(ec, XHCI_EC_CAP_ID)) {
92	case XHCI_EC_USB_LEGACY:
93	assert(hc->legsup == NULL);
94	hc->legsup = (xhci_legsup_t *) ec;
95	break;
96	case XHCI_EC_SUPPORTED_PROTOCOL:
97	psic = XHCI_REG_RD(ec, XHCI_EC_SP_PSIC);
98	major = XHCI_REG_RD(ec, XHCI_EC_SP_MAJOR);
99	minor = XHCI_REG_RD(ec, XHCI_EC_SP_MINOR);
100	name.packed = host2uint32_t_le(XHCI_REG_RD(ec, XHCI_EC_SP_NAME));
101
102	if (name.packed != xhci_name_usb.packed) {
103	/**
104	* The detection of such protocol would work,
105	* but the rest of the implementation is made
106	* for the USB protocol only.
107	*/
108	usb_log_error("Unknown protocol %.4s.", name.str);
109	return ENOTSUP;
110	}
111
112	unsigned offset = XHCI_REG_RD(ec, XHCI_EC_SP_CP_OFF);
113	unsigned count = XHCI_REG_RD(ec, XHCI_EC_SP_CP_COUNT);
114	xhci_rh_set_ports_protocol(&hc->rh, offset, count, major);
115
116	// "Implied" speed
117	if (psic == 0) {
118	assert(minor == 0);
119
120	if (major == 2) {
121	speeds[1] = default_psiv_to_port_speed[1];
122	speeds[2] = default_psiv_to_port_speed[2];
123	speeds[3] = default_psiv_to_port_speed[3];
124	} else if (major == 3) {
125	speeds[4] = default_psiv_to_port_speed[4];
126	} else {
127	return EINVAL;
128	}
129
130	usb_log_debug("Implied speed of USB %u.0 set up.", major);
131	} else {
132	for (unsigned i = 0; i < psic; i++) {
133	xhci_psi_t *psi = xhci_extcap_psi(ec, i);
134	unsigned sim = XHCI_REG_RD(psi, XHCI_PSI_PSIM);
135	unsigned psiv = XHCI_REG_RD(psi, XHCI_PSI_PSIV);
136	unsigned psie = XHCI_REG_RD(psi, XHCI_PSI_PSIE);
137	unsigned psim = XHCI_REG_RD(psi, XHCI_PSI_PSIM);
138	uint64_t bps = PSI_TO_BPS(psie, psim);
139
140	/*
141	* Speed is not implied, but using one of default PSIV. This
142	* is not clearly stated in xHCI spec. There is a clear
143	* intention to allow xHCI to specify its own speed
144	* parameters, but throughout the document, they used fixed
145	* values for e.g. High-speed (3), without stating the
146	* controller shall have implied default speeds - and for
147	* instance Intel controllers do not. So let's check if the
148	* values match and if so, accept the implied USB speed too.
149	*
150	* The main reason we need this is the usb_speed to have
151	* mapping also for devices connected to hubs.
152	*/
153	if (psiv < ARRAY_SIZE(default_psiv_to_port_speed)
154	&& default_psiv_to_port_speed[psiv].major == major
155	&& default_psiv_to_port_speed[psiv].minor == minor
156	&& default_psiv_to_port_speed[psiv].rx_bps == bps
157	&& default_psiv_to_port_speed[psiv].tx_bps == bps) {
158	speeds[psiv] = default_psiv_to_port_speed[psiv];
159	usb_log_debug("Assumed default %s speed of USB %u.",
160	usb_str_speed(speeds[psiv].usb_speed), major);
161	continue;
162	}
163
164	// Custom speed
165	speeds[psiv].major = major;
166	speeds[psiv].minor = minor;
167	str_ncpy(speeds[psiv].name, 4, name.str, 4);
168	speeds[psiv].usb_speed = USB_SPEED_MAX;
169
170	if (sim == XHCI_PSI_PLT_SYMM \|\| sim == XHCI_PSI_PLT_RX)
171	speeds[psiv].rx_bps = bps;
172	if (sim == XHCI_PSI_PLT_SYMM \|\| sim == XHCI_PSI_PLT_TX) {
173	speeds[psiv].tx_bps = bps;
174	usb_log_debug("Speed %u set up for bps %" PRIu64
175	" / %" PRIu64 ".", psiv, speeds[psiv].rx_bps,
176	speeds[psiv].tx_bps);
177	}
178	}
179	}
180	}
181	}
182	return EOK;
183	}
184
185	/**
186	* Initialize MMIO spaces of xHC.
187	*/
188	int hc_init_mmio(xhci_hc_t hc, const hw_res_list_parsed_t hw_res)
189	{
190	int err;
191
192	if (hw_res->mem_ranges.count != 1) {
193	usb_log_error("Unexpected MMIO area, bailing out.");
194	return EINVAL;
195	}
196
197	hc->mmio_range = hw_res->mem_ranges.ranges[0];
198
199	usb_log_debug("MMIO area at %p (size %zu), IRQ %d.",
200	RNGABSPTR(hc->mmio_range), RNGSZ(hc->mmio_range), hw_res->irqs.irqs[0]);
201
202	if (RNGSZ(hc->mmio_range) < sizeof(xhci_cap_regs_t))
203	return EOVERFLOW;
204
205	void *base;
206	if ((err = pio_enable_range(&hc->mmio_range, &base)))
207	return err;
208
209	hc->reg_base = base;
210	hc->cap_regs = (xhci_cap_regs_t *) base;
211	hc->op_regs = (xhci_op_regs_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_LENGTH));
212	hc->rt_regs = (xhci_rt_regs_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_RTSOFF));
213	hc->db_arry = (xhci_doorbell_t *) (base + XHCI_REG_RD(hc->cap_regs, XHCI_CAP_DBOFF));
214
215	uintptr_t xec_offset = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_XECP) * sizeof(xhci_dword_t);
216	if (xec_offset > 0)
217	hc->xecp = (xhci_extcap_t *) (base + xec_offset);
218
219	usb_log_debug("Initialized MMIO reg areas:");
220	usb_log_debug("\tCapability regs: %p", hc->cap_regs);
221	usb_log_debug("\tOperational regs: %p", hc->op_regs);
222	usb_log_debug("\tRuntime regs: %p", hc->rt_regs);
223	usb_log_debug("\tDoorbell array base: %p", hc->db_arry);
224
225	xhci_dump_cap_regs(hc->cap_regs);
226
227	hc->ac64 = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_AC64);
228	hc->csz = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_CSZ);
229	hc->max_slots = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_MAX_SLOTS);
230
231	struct timeval tv;
232	getuptime(&tv);
233	hc->wrap_time = tv.tv_sec * 1000000 + tv.tv_usec;
234	hc->wrap_count = 0;
235
236	unsigned ist = XHCI_REG_RD(hc->cap_regs, XHCI_CAP_IST);
237	hc->ist = (ist & 0x10 >> 1) * (ist & 0xf);
238
239	if ((err = xhci_rh_init(&hc->rh, hc)))
240	goto err_pio;
241
242	if ((err = hc_parse_ec(hc)))
243	goto err_rh;
244
245	return EOK;
246
247	err_rh:
248	xhci_rh_fini(&hc->rh);
249	err_pio:
250	pio_disable(hc->reg_base, RNGSZ(hc->mmio_range));
251	return err;
252	}
253
254	static int event_worker(void *arg);
255
256	/**
257	* Initialize structures kept in allocated memory.
258	*/
259	int hc_init_memory(xhci_hc_t hc, ddf_dev_t device)
260	{
261	int err = ENOMEM;
262
263	if (dma_buffer_alloc(&hc->dcbaa_dma, (1 + hc->max_slots) * sizeof(uint64_t)))
264	return ENOMEM;
265	hc->dcbaa = hc->dcbaa_dma.virt;
266
267	hc->event_worker = joinable_fibril_create(&event_worker, hc);
268	if (!hc->event_worker)
269	goto err_dcbaa;
270
271	if ((err = xhci_event_ring_init(&hc->event_ring, 1)))
272	goto err_worker;
273
274	if ((err = xhci_scratchpad_alloc(hc)))
275	goto err_event_ring;
276
277	if ((err = xhci_init_commands(hc)))
278	goto err_scratch;
279
280	if ((err = xhci_bus_init(&hc->bus, hc)))
281	goto err_cmd;
282
283	xhci_sw_ring_init(&hc->sw_ring, PAGE_SIZE / sizeof(xhci_trb_t));
284
285	return EOK;
286
287	err_cmd:
288	xhci_fini_commands(hc);
289	err_scratch:
290	xhci_scratchpad_free(hc);
291	err_event_ring:
292	xhci_event_ring_fini(&hc->event_ring);
293	err_worker:
294	joinable_fibril_destroy(hc->event_worker);
295	err_dcbaa:
296	hc->dcbaa = NULL;
297	dma_buffer_free(&hc->dcbaa_dma);
298	return err;
299	}
300
301	/*
302	* Pseudocode:
303	* ip = read(intr[0].iman)
304	* if (ip) {
305	* status = read(usbsts)
306	* assert status
307	* assert ip
308	* accept (passing status)
309	* }
310	* decline
311	*/
312	static const irq_cmd_t irq_commands[] = {
313	{
314	.cmd = CMD_PIO_READ_32,
315	.dstarg = 3,
316	.addr = NULL /* intr[0].iman */
317	},
318	{
319	.cmd = CMD_AND,
320	.srcarg = 3,
321	.dstarg = 4,
322	.value = 0 /* host2xhci(32, 1) */
323	},
324	{
325	.cmd = CMD_PREDICATE,
326	.srcarg = 4,
327	.value = 5
328	},
329	{
330	.cmd = CMD_PIO_READ_32,
331	.dstarg = 1,
332	.addr = NULL /* usbsts */
333	},
334	{
335	.cmd = CMD_AND,
336	.srcarg = 1,
337	.dstarg = 2,
338	.value = 0 /* host2xhci(32, XHCI_STATUS_ACK_MASK) */
339	},
340	{
341	.cmd = CMD_PIO_WRITE_A_32,
342	.srcarg = 2,
343	.addr = NULL /* usbsts */
344	},
345	{
346	.cmd = CMD_PIO_WRITE_A_32,
347	.srcarg = 3,
348	.addr = NULL /* intr[0].iman */
349	},
350	{
351	.cmd = CMD_ACCEPT
352	},
353	{
354	.cmd = CMD_DECLINE
355	}
356	};
357
358
359	/**
360	* Generates code to accept interrupts. The xHCI is designed primarily for
361	* MSI/MSI-X, but we use PCI Interrupt Pin. In this mode, all the Interrupters
362	* (except 0) are disabled.
363	*/
364	int hc_irq_code_gen(irq_code_t code, xhci_hc_t hc, const hw_res_list_parsed_t hw_res, int irq)
365	{
366	assert(code);
367	assert(hw_res);
368
369	if (hw_res->irqs.count != 1) {
370	usb_log_info("Unexpected HW resources to enable interrupts.");
371	return EINVAL;
372	}
373
374	code->ranges = malloc(sizeof(irq_pio_range_t));
375	if (code->ranges == NULL)
376	return ENOMEM;
377
378	code->cmds = malloc(sizeof(irq_commands));
379	if (code->cmds == NULL) {
380	free(code->ranges);
381	return ENOMEM;
382	}
383
384	code->rangecount = 1;
385	code->ranges[0] = (irq_pio_range_t) {
386	.base = RNGABS(hc->mmio_range),
387	.size = RNGSZ(hc->mmio_range),
388	};
389
390	code->cmdcount = ARRAY_SIZE(irq_commands);
391	memcpy(code->cmds, irq_commands, sizeof(irq_commands));
392
393	void *intr0_iman = RNGABSPTR(hc->mmio_range)
394	+ XHCI_REG_RD(hc->cap_regs, XHCI_CAP_RTSOFF)
395	+ offsetof(xhci_rt_regs_t, ir[0]);
396	void *usbsts = RNGABSPTR(hc->mmio_range)
397	+ XHCI_REG_RD(hc->cap_regs, XHCI_CAP_LENGTH)
398	+ offsetof(xhci_op_regs_t, usbsts);
399
400	code->cmds[0].addr = intr0_iman;
401	code->cmds[1].value = host2xhci(32, 1);
402	code->cmds[3].addr = usbsts;
403	code->cmds[4].value = host2xhci(32, XHCI_STATUS_ACK_MASK);
404	code->cmds[5].addr = usbsts;
405	code->cmds[6].addr = intr0_iman;
406
407	*irq = hw_res->irqs.irqs[0];
408	return EOK;
409	}
410
411	/**
412	* Claim xHC from BIOS. Implements handoff as per Section 4.22.1 of xHCI spec.
413	*/
414	int hc_claim(xhci_hc_t hc, ddf_dev_t dev)
415	{
416	/* No legacy support capability, the controller is solely for us */
417	if (!hc->legsup)
418	return EOK;
419
420	if (xhci_reg_wait(&hc->op_regs->usbsts, XHCI_REG_MASK(XHCI_OP_CNR), 0))
421	return ETIMEOUT;
422
423	usb_log_debug("LEGSUP: bios: %x, os: %x", hc->legsup->sem_bios, hc->legsup->sem_os);
424	XHCI_REG_SET(hc->legsup, XHCI_LEGSUP_SEM_OS, 1);
425	for (int i = 0; i <= (XHCI_LEGSUP_BIOS_TIMEOUT_US / XHCI_LEGSUP_POLLING_DELAY_1MS); i++) {
426	usb_log_debug("LEGSUP: elapsed: %i ms, bios: %x, os: %x", i,
427	XHCI_REG_RD(hc->legsup, XHCI_LEGSUP_SEM_BIOS),
428	XHCI_REG_RD(hc->legsup, XHCI_LEGSUP_SEM_OS));
429	if (XHCI_REG_RD(hc->legsup, XHCI_LEGSUP_SEM_BIOS) == 0) {
430	return XHCI_REG_RD(hc->legsup, XHCI_LEGSUP_SEM_OS) == 1 ? EOK : EIO;
431	}
432	async_usleep(XHCI_LEGSUP_POLLING_DELAY_1MS);
433	}
434	usb_log_error("BIOS did not release XHCI legacy hold!");
435
436	return ENOTSUP;
437	}
438
439	/**
440	* Ask the xHC to reset its state. Implements sequence
441	*/
442	static int hc_reset(xhci_hc_t *hc)
443	{
444	if (xhci_reg_wait(&hc->op_regs->usbsts, XHCI_REG_MASK(XHCI_OP_CNR), 0))
445	return ETIMEOUT;
446
447	/* Stop the HC: set R/S to 0 */
448	XHCI_REG_CLR(hc->op_regs, XHCI_OP_RS, 1);
449
450	/* Wait until the HC is halted - it shall take at most 16 ms */
451	if (xhci_reg_wait(&hc->op_regs->usbsts, XHCI_REG_MASK(XHCI_OP_HCH),
452	XHCI_REG_MASK(XHCI_OP_HCH)))
453	return ETIMEOUT;
454
455	/* Reset */
456	XHCI_REG_SET(hc->op_regs, XHCI_OP_HCRST, 1);
457
458	/* Wait until the reset is complete */
459	if (xhci_reg_wait(&hc->op_regs->usbcmd, XHCI_REG_MASK(XHCI_OP_HCRST), 0))
460	return ETIMEOUT;
461
462	return EOK;
463	}
464
465	/**
466	* Initialize the HC: section 4.2
467	*/
468	int hc_start(xhci_hc_t *hc)
469	{
470	int err;
471
472	if ((err = hc_reset(hc)))
473	return err;
474
475	if (xhci_reg_wait(&hc->op_regs->usbsts, XHCI_REG_MASK(XHCI_OP_CNR), 0))
476	return ETIMEOUT;
477
478	uint64_t dcbaaptr = hc->dcbaa_dma.phys;
479	XHCI_REG_WR(hc->op_regs, XHCI_OP_DCBAAP, dcbaaptr);
480	XHCI_REG_WR(hc->op_regs, XHCI_OP_MAX_SLOTS_EN, hc->max_slots);
481
482	uintptr_t crcr;
483	xhci_trb_ring_reset_dequeue_state(&hc->cr.trb_ring, &crcr);
484	XHCI_REG_WR(hc->op_regs, XHCI_OP_CRCR, crcr);
485
486	XHCI_REG_SET(hc->op_regs, XHCI_OP_EWE, 1);
487
488	xhci_event_ring_reset(&hc->event_ring);
489
490	xhci_interrupter_regs_t *intr0 = &hc->rt_regs->ir[0];
491	XHCI_REG_WR(intr0, XHCI_INTR_ERSTSZ, hc->event_ring.segment_count);
492	XHCI_REG_WR(intr0, XHCI_INTR_ERDP, hc->event_ring.dequeue_ptr);
493	XHCI_REG_WR(intr0, XHCI_INTR_ERSTBA, hc->event_ring.erst.phys);
494
495	if (hc->base.irq_cap > 0) {
496	XHCI_REG_SET(intr0, XHCI_INTR_IE, 1);
497	XHCI_REG_SET(hc->op_regs, XHCI_OP_INTE, 1);
498	}
499
500	XHCI_REG_SET(hc->op_regs, XHCI_OP_HSEE, 1);
501
502	xhci_sw_ring_restart(&hc->sw_ring);
503	joinable_fibril_start(hc->event_worker);
504
505	xhci_start_command_ring(hc);
506
507	XHCI_REG_SET(hc->op_regs, XHCI_OP_RS, 1);
508
509	/* RH needs to access port states on startup */
510	xhci_rh_start(&hc->rh);
511
512	return EOK;
513	}
514
515	static void hc_stop(xhci_hc_t *hc)
516	{
517	/* Stop the HC in hardware. */
518	XHCI_REG_CLR(hc->op_regs, XHCI_OP_RS, 1);
519
520	/*
521	* Wait until the HC is halted - it shall take at most 16 ms.
522	* Note that we ignore the return value here.
523	*/
524	xhci_reg_wait(&hc->op_regs->usbsts, XHCI_REG_MASK(XHCI_OP_HCH),
525	XHCI_REG_MASK(XHCI_OP_HCH));
526
527	/* Make sure commands will not block other fibrils. */
528	xhci_nuke_command_ring(hc);
529
530	/* Stop the event worker fibril to restart it */
531	xhci_sw_ring_stop(&hc->sw_ring);
532	joinable_fibril_join(hc->event_worker);
533
534	/* Then, disconnect all roothub devices, which shall trigger
535	* disconnection of everything */
536	xhci_rh_stop(&hc->rh);
537	}
538
539	static void hc_reinitialize(xhci_hc_t *hc)
540	{
541	/* Stop everything. */
542	hc_stop(hc);
543
544	usb_log_info("HC stopped. Starting again...");
545
546	/* The worker fibrils need to be started again */
547	joinable_fibril_recreate(hc->event_worker);
548	joinable_fibril_recreate(hc->rh.event_worker);
549
550	/* Now, the HC shall be stopped and software shall be clean. */
551	hc_start(hc);
552	}
553
554	static bool hc_is_broken(xhci_hc_t *hc)
555	{
556	const uint32_t usbcmd = XHCI_REG_RD_FIELD(&hc->op_regs->usbcmd, 32);
557	const uint32_t usbsts = XHCI_REG_RD_FIELD(&hc->op_regs->usbsts, 32);
558
559	return !(usbcmd & XHCI_REG_MASK(XHCI_OP_RS))
560	\|\| (usbsts & XHCI_REG_MASK(XHCI_OP_HCE))
561	\|\| (usbsts & XHCI_REG_MASK(XHCI_OP_HSE));
562	}
563
564	/**
565	* Used only when polling. Shall supplement the irq_commands.
566	*/
567	int hc_status(bus_t bus, uint32_t status)
568	{
569	xhci_hc_t *hc = bus_to_hc(bus);
570	int ip = XHCI_REG_RD(hc->rt_regs->ir, XHCI_INTR_IP);
571	if (ip) {
572	*status = XHCI_REG_RD(hc->op_regs, XHCI_OP_STATUS);
573	XHCI_REG_WR(hc->op_regs, XHCI_OP_STATUS, *status & XHCI_STATUS_ACK_MASK);
574	XHCI_REG_WR(hc->rt_regs->ir, XHCI_INTR_IP, 1);
575
576	/* interrupt handler expects status from irq_commands, which is
577	* in xhci order. */
578	status = host2xhci(32, status);
579	}
580
581	usb_log_debug("Polled status: %x", *status);
582	return EOK;
583	}
584
585	static int xhci_handle_mfindex_wrap_event(xhci_hc_t hc, xhci_trb_t trb)
586	{
587	struct timeval tv;
588	getuptime(&tv);
589	usb_log_debug("Microframe index wrapped (@%lu.%li, %"PRIu64" total).",
590	tv.tv_sec, tv.tv_usec, hc->wrap_count);
591	hc->wrap_time = ((uint64_t) tv.tv_sec) * 1000000 + ((uint64_t) tv.tv_usec);
592	++hc->wrap_count;
593	return EOK;
594	}
595
596	typedef int (event_handler) (xhci_hc_t , xhci_trb_t *trb);
597
598	/**
599	* These events are handled by separate event handling fibril.
600	*/
601	static event_handler event_handlers [] = {
602	[XHCI_TRB_TYPE_TRANSFER_EVENT] = &xhci_handle_transfer_event,
603	};
604
605	/**
606	* These events are handled directly in the interrupt handler, thus they must
607	* not block waiting for another interrupt.
608	*/
609	static event_handler event_handlers_fast [] = {
610	[XHCI_TRB_TYPE_COMMAND_COMPLETION_EVENT] = &xhci_handle_command_completion,
611	[XHCI_TRB_TYPE_MFINDEX_WRAP_EVENT] = &xhci_handle_mfindex_wrap_event,
612	};
613
614	static int hc_handle_event(xhci_hc_t hc, xhci_trb_t trb)
615	{
616	const unsigned type = TRB_TYPE(*trb);
617
618	if (type <= ARRAY_SIZE(event_handlers_fast) && event_handlers_fast[type])
619	return event_handlers_fast[type](hc, trb);
620
621	if (type <= ARRAY_SIZE(event_handlers) && event_handlers[type])
622	return xhci_sw_ring_enqueue(&hc->sw_ring, trb);
623
624	if (type == XHCI_TRB_TYPE_PORT_STATUS_CHANGE_EVENT)
625	return xhci_sw_ring_enqueue(&hc->rh.event_ring, trb);
626
627	return ENOTSUP;
628	}
629
630	static int event_worker(void *arg)
631	{
632	int err;
633	xhci_trb_t trb;
634	xhci_hc_t * const hc = arg;
635	assert(hc);
636
637	while (xhci_sw_ring_dequeue(&hc->sw_ring, &trb) != EINTR) {
638	const unsigned type = TRB_TYPE(trb);
639
640	if ((err = event_handlers[type](hc, &trb)))
641	usb_log_error("Failed to handle event: %s", str_error(err));
642	}
643
644	return 0;
645	}
646
647	/**
648	* Dequeue from event ring and handle dequeued events.
649	*
650	* As there can be events, that blocks on waiting for subsequent events,
651	* we solve this problem by deferring some types of events to separate fibrils.
652	*/
653	static void hc_run_event_ring(xhci_hc_t hc, xhci_event_ring_t event_ring,
654	xhci_interrupter_regs_t *intr)
655	{
656	int err;
657
658	xhci_trb_t trb;
659	hc->event_handler = fibril_get_id();
660
661	while ((err = xhci_event_ring_dequeue(event_ring, &trb)) != ENOENT) {
662	if ((err = hc_handle_event(hc, &trb)) != EOK) {
663	usb_log_error("Failed to handle event in interrupt: %s", str_error(err));
664	}
665
666	XHCI_REG_WR(intr, XHCI_INTR_ERDP, hc->event_ring.dequeue_ptr);
667	}
668
669	hc->event_handler = 0;
670
671	uint64_t erdp = hc->event_ring.dequeue_ptr;
672	erdp \|= XHCI_REG_MASK(XHCI_INTR_ERDP_EHB);
673	XHCI_REG_WR(intr, XHCI_INTR_ERDP, erdp);
674
675	usb_log_debug2("Event ring run finished.");
676	}
677
678	/**
679	* Handle an interrupt request from xHC. Resolve all situations that trigger an
680	* interrupt separately.
681	*
682	* Note that all RW1C bits in USBSTS register are cleared at the time of
683	* handling the interrupt in irq_code. This method is the top-half.
684	*
685	* @param status contents of USBSTS register at the time of the interrupt.
686	*/
687	void hc_interrupt(bus_t *bus, uint32_t status)
688	{
689	xhci_hc_t *hc = bus_to_hc(bus);
690	status = xhci2host(32, status);
691
692	if (status & XHCI_REG_MASK(XHCI_OP_HSE)) {
693	usb_log_error("Host system error occured. Aren't we supposed to be dead already?");
694	return;
695	}
696
697	if (status & XHCI_REG_MASK(XHCI_OP_HCE)) {
698	usb_log_error("Host controller error occured. Reinitializing...");
699	hc_reinitialize(hc);
700	return;
701	}
702
703	if (status & XHCI_REG_MASK(XHCI_OP_EINT)) {
704	usb_log_debug2("Event interrupt, running the event ring.");
705	hc_run_event_ring(hc, &hc->event_ring, &hc->rt_regs->ir[0]);
706	status &= ~XHCI_REG_MASK(XHCI_OP_EINT);
707	}
708
709	if (status & XHCI_REG_MASK(XHCI_OP_SRE)) {
710	usb_log_error("Save/Restore error occured. WTF, "
711	"S/R mechanism not implemented!");
712	status &= ~XHCI_REG_MASK(XHCI_OP_SRE);
713	}
714
715	/* According to Note on p. 302, we may safely ignore the PCD bit. */
716	status &= ~XHCI_REG_MASK(XHCI_OP_PCD);
717
718	if (status) {
719	usb_log_error("Non-zero status after interrupt handling (%08x) "
720	" - missing something?", status);
721	}
722	}
723
724	/**
725	* Tear down all in-memory structures.
726	*/
727	void hc_fini(xhci_hc_t *hc)
728	{
729	hc_stop(hc);
730
731	xhci_sw_ring_fini(&hc->sw_ring);
732	joinable_fibril_destroy(hc->event_worker);
733	xhci_bus_fini(&hc->bus);
734	xhci_event_ring_fini(&hc->event_ring);
735	xhci_scratchpad_free(hc);
736	dma_buffer_free(&hc->dcbaa_dma);
737	xhci_fini_commands(hc);
738	xhci_rh_fini(&hc->rh);
739	pio_disable(hc->reg_base, RNGSZ(hc->mmio_range));
740	usb_log_info("Finalized.");
741	}
742
743	unsigned hc_speed_to_psiv(usb_speed_t speed)
744	{
745	assert(speed < ARRAY_SIZE(usb_speed_to_psiv));
746	return usb_speed_to_psiv[speed];
747	}
748
749	/**
750	* Ring a xHC Doorbell. Implements section 4.7.
751	*/
752	void hc_ring_doorbell(xhci_hc_t *hc, unsigned doorbell, unsigned target)
753	{
754	assert(hc);
755	uint32_t v = host2xhci(32, target & BIT_RRANGE(uint32_t, 7));
756	pio_write_32(&hc->db_arry[doorbell], v);
757	usb_log_debug2("Ringing doorbell %d (target: %d)", doorbell, target);
758	}
759
760	/**
761	* Return an index to device context.
762	*/
763	static uint8_t endpoint_dci(xhci_endpoint_t *ep)
764	{
765	return (2 * ep->base.endpoint) +
766	(ep->base.transfer_type == USB_TRANSFER_CONTROL
767	\|\| ep->base.direction == USB_DIRECTION_IN);
768	}
769
770	void hc_ring_ep_doorbell(xhci_endpoint_t *ep, uint32_t stream_id)
771	{
772	xhci_device_t * const dev = xhci_ep_to_dev(ep);
773	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
774	const uint8_t dci = endpoint_dci(ep);
775	const uint32_t target = (stream_id << 16) \| (dci & 0x1ff);
776	hc_ring_doorbell(hc, dev->slot_id, target);
777	}
778
779	/**
780	* Issue an Enable Slot command. Allocate memory for the slot and fill the
781	* DCBAA with the newly created slot.
782	*/
783	int hc_enable_slot(xhci_device_t *dev)
784	{
785	int err;
786	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
787
788	/* Prepare memory for the context */
789	if ((err = dma_buffer_alloc(&dev->dev_ctx, XHCI_DEVICE_CTX_SIZE(hc))))
790	return err;
791	memset(dev->dev_ctx.virt, 0, XHCI_DEVICE_CTX_SIZE(hc));
792
793	/* Get the slot number */
794	xhci_cmd_t cmd;
795	xhci_cmd_init(&cmd, XHCI_CMD_ENABLE_SLOT);
796
797	err = xhci_cmd_sync(hc, &cmd);
798
799	/* Link them together */
800	if (err == EOK) {
801	dev->slot_id = cmd.slot_id;
802	hc->dcbaa[dev->slot_id] = host2xhci(64, dev->dev_ctx.phys);
803	}
804
805	xhci_cmd_fini(&cmd);
806
807	if (err)
808	dma_buffer_free(&dev->dev_ctx);
809
810	return err;
811	}
812
813	/**
814	* Issue a Disable Slot command for a slot occupied by device.
815	* Frees the device context.
816	*/
817	int hc_disable_slot(xhci_device_t *dev)
818	{
819	int err;
820	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
821
822	if ((err = xhci_cmd_sync_inline(hc, DISABLE_SLOT, .slot_id = dev->slot_id))) {
823	return err;
824	}
825
826	/* Free the device context. */
827	hc->dcbaa[dev->slot_id] = 0;
828	dma_buffer_free(&dev->dev_ctx);
829
830	/* Mark the slot as invalid. */
831	dev->slot_id = 0;
832
833	return EOK;
834	}
835
836	/**
837	* Prepare an empty Endpoint Input Context inside a dma buffer.
838	*/
839	static int create_configure_ep_input_ctx(xhci_device_t dev, dma_buffer_t dma_buf)
840	{
841	const xhci_hc_t * hc = bus_to_hc(dev->base.bus);
842	const int err = dma_buffer_alloc(dma_buf, XHCI_INPUT_CTX_SIZE(hc));
843	if (err)
844	return err;
845
846	xhci_input_ctx_t *ictx = dma_buf->virt;
847	memset(ictx, 0, XHCI_INPUT_CTX_SIZE(hc));
848
849	// Quoting sec. 4.6.5 and 4.6.6: A1, D0, D1 are down (already zeroed), A0 is up.
850	XHCI_INPUT_CTRL_CTX_ADD_SET(*XHCI_GET_CTRL_CTX(ictx, hc), 0);
851	xhci_slot_ctx_t *slot_ctx = XHCI_GET_SLOT_CTX(XHCI_GET_DEVICE_CTX(ictx, hc), hc);
852	xhci_setup_slot_context(dev, slot_ctx);
853
854	return EOK;
855	}
856
857	/**
858	* Initialize a device, assigning it an address. Implements section 4.3.4.
859	*
860	* @param dev Device to assing an address (unconfigured yet)
861	*/
862	int hc_address_device(xhci_device_t *dev)
863	{
864	int err = ENOMEM;
865	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
866	xhci_endpoint_t *ep0 = xhci_endpoint_get(dev->base.endpoints[0]);
867
868	/* Although we have the precise PSIV value on devices of tier 1,
869	* we have to rely on reverse mapping on others. */
870	if (!usb_speed_to_psiv[dev->base.speed]) {
871	usb_log_error("Device reported an USB speed (%s) that cannot be mapped "
872	"to HC port speed.", usb_str_speed(dev->base.speed));
873	return EINVAL;
874	}
875
876	/* Issue configure endpoint command (sec 4.3.5). */
877	dma_buffer_t ictx_dma_buf;
878	if ((err = create_configure_ep_input_ctx(dev, &ictx_dma_buf)))
879	return err;
880	xhci_input_ctx_t *ictx = ictx_dma_buf.virt;
881
882	/* Copy endpoint 0 context and set A1 flag. */
883	XHCI_INPUT_CTRL_CTX_ADD_SET(*XHCI_GET_CTRL_CTX(ictx, hc), 1);
884	xhci_ep_ctx_t *ep_ctx = XHCI_GET_EP_CTX(XHCI_GET_DEVICE_CTX(ictx, hc), hc, 1);
885	xhci_setup_endpoint_context(ep0, ep_ctx);
886
887	/* Address device needs Ctx entries set to 1 only */
888	xhci_slot_ctx_t *slot_ctx = XHCI_GET_SLOT_CTX(XHCI_GET_DEVICE_CTX(ictx, hc), hc);
889	XHCI_SLOT_CTX_ENTRIES_SET(*slot_ctx, 1);
890
891	/* Issue Address Device command. */
892	if ((err = xhci_cmd_sync_inline(hc, ADDRESS_DEVICE,
893	.slot_id = dev->slot_id,
894	.input_ctx = ictx_dma_buf
895	)))
896	return err;
897
898	xhci_device_ctx_t *device_ctx = dev->dev_ctx.virt;
899	dev->base.address = XHCI_SLOT_DEVICE_ADDRESS(*XHCI_GET_SLOT_CTX(device_ctx, hc));
900	usb_log_debug("Obtained USB address: %d.", dev->base.address);
901
902	return EOK;
903	}
904
905	/**
906	* Issue a Configure Device command for a device in slot.
907	*
908	* @param slot_id Slot ID assigned to the device.
909	*/
910	int hc_configure_device(xhci_device_t *dev)
911	{
912	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
913
914	/* Issue configure endpoint command (sec 4.3.5). */
915	dma_buffer_t ictx_dma_buf;
916	const int err = create_configure_ep_input_ctx(dev, &ictx_dma_buf);
917	if (err)
918	return err;
919
920	return xhci_cmd_sync_inline(hc, CONFIGURE_ENDPOINT,
921	.slot_id = dev->slot_id,
922	.input_ctx = ictx_dma_buf
923	);
924	}
925
926	/**
927	* Issue a Deconfigure Device command for a device in slot.
928	*
929	* @param dev The owner of the device
930	*/
931	int hc_deconfigure_device(xhci_device_t *dev)
932	{
933	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
934
935	if (hc_is_broken(hc))
936	return EOK;
937
938	/* Issue configure endpoint command (sec 4.3.5) with the DC flag. */
939	return xhci_cmd_sync_inline(hc, CONFIGURE_ENDPOINT,
940	.slot_id = dev->slot_id,
941	.deconfigure = true
942	);
943	}
944
945	/**
946	* Instruct xHC to add an endpoint with supplied endpoint context.
947	*
948	* @param dev The owner of the device
949	* @param ep_idx Endpoint DCI in question
950	* @param ep_ctx Endpoint context of the endpoint
951	*/
952	int hc_add_endpoint(xhci_endpoint_t *ep)
953	{
954	xhci_device_t * const dev = xhci_ep_to_dev(ep);
955	const unsigned dci = endpoint_dci(ep);
956
957	/* Issue configure endpoint command (sec 4.3.5). */
958	dma_buffer_t ictx_dma_buf;
959	const int err = create_configure_ep_input_ctx(dev, &ictx_dma_buf);
960	if (err)
961	return err;
962
963	xhci_input_ctx_t *ictx = ictx_dma_buf.virt;
964
965	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
966	XHCI_INPUT_CTRL_CTX_ADD_SET(*XHCI_GET_CTRL_CTX(ictx, hc), dci);
967
968	xhci_ep_ctx_t *ep_ctx = XHCI_GET_EP_CTX(XHCI_GET_DEVICE_CTX(ictx, hc), hc, dci);
969	xhci_setup_endpoint_context(ep, ep_ctx);
970
971	return xhci_cmd_sync_inline(hc, CONFIGURE_ENDPOINT,
972	.slot_id = dev->slot_id,
973	.input_ctx = ictx_dma_buf
974	);
975	}
976
977	/**
978	* Instruct xHC to drop an endpoint.
979	*
980	* @param dev The owner of the endpoint
981	* @param ep_idx Endpoint DCI in question
982	*/
983	int hc_drop_endpoint(xhci_endpoint_t *ep)
984	{
985	xhci_device_t * const dev = xhci_ep_to_dev(ep);
986	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
987	const unsigned dci = endpoint_dci(ep);
988
989	if (hc_is_broken(hc))
990	return EOK;
991
992	/* Issue configure endpoint command (sec 4.3.5). */
993	dma_buffer_t ictx_dma_buf;
994	const int err = create_configure_ep_input_ctx(dev, &ictx_dma_buf);
995	if (err)
996	return err;
997
998	xhci_input_ctx_t *ictx = ictx_dma_buf.virt;
999	XHCI_INPUT_CTRL_CTX_DROP_SET(*XHCI_GET_CTRL_CTX(ictx, hc), dci);
1000
1001	return xhci_cmd_sync_inline(hc, CONFIGURE_ENDPOINT,
1002	.slot_id = dev->slot_id,
1003	.input_ctx = ictx_dma_buf
1004	);
1005	}
1006
1007	/**
1008	* Instruct xHC to update information about an endpoint, using supplied
1009	* endpoint context.
1010	*
1011	* @param dev The owner of the endpoint
1012	* @param ep_idx Endpoint DCI in question
1013	* @param ep_ctx Endpoint context of the endpoint
1014	*/
1015	int hc_update_endpoint(xhci_endpoint_t *ep)
1016	{
1017	xhci_device_t * const dev = xhci_ep_to_dev(ep);
1018	const unsigned dci = endpoint_dci(ep);
1019
1020	dma_buffer_t ictx_dma_buf;
1021	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
1022
1023	const int err = dma_buffer_alloc(&ictx_dma_buf, XHCI_INPUT_CTX_SIZE(hc));
1024	if (err)
1025	return err;
1026
1027	xhci_input_ctx_t *ictx = ictx_dma_buf.virt;
1028	memset(ictx, 0, XHCI_INPUT_CTX_SIZE(hc));
1029
1030	XHCI_INPUT_CTRL_CTX_ADD_SET(*XHCI_GET_CTRL_CTX(ictx, hc), dci);
1031	xhci_ep_ctx_t *ep_ctx = XHCI_GET_EP_CTX(XHCI_GET_DEVICE_CTX(ictx, hc), hc, dci);
1032	xhci_setup_endpoint_context(ep, ep_ctx);
1033
1034	return xhci_cmd_sync_inline(hc, EVALUATE_CONTEXT,
1035	.slot_id = dev->slot_id,
1036	.input_ctx = ictx_dma_buf
1037	);
1038	}
1039
1040	/**
1041	* Instruct xHC to stop running a transfer ring on an endpoint.
1042	*
1043	* @param dev The owner of the endpoint
1044	* @param ep_idx Endpoint DCI in question
1045	*/
1046	int hc_stop_endpoint(xhci_endpoint_t *ep)
1047	{
1048	xhci_device_t * const dev = xhci_ep_to_dev(ep);
1049	const unsigned dci = endpoint_dci(ep);
1050	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
1051
1052	if (hc_is_broken(hc))
1053	return EOK;
1054
1055	return xhci_cmd_sync_inline(hc, STOP_ENDPOINT,
1056	.slot_id = dev->slot_id,
1057	.endpoint_id = dci
1058	);
1059	}
1060
1061	/**
1062	* Instruct xHC to reset halted endpoint.
1063	*
1064	* @param dev The owner of the endpoint
1065	* @param ep_idx Endpoint DCI in question
1066	*/
1067	int hc_reset_endpoint(xhci_endpoint_t *ep)
1068	{
1069	xhci_device_t * const dev = xhci_ep_to_dev(ep);
1070	const unsigned dci = endpoint_dci(ep);
1071	xhci_hc_t * const hc = bus_to_hc(dev->base.bus);
1072	return xhci_cmd_sync_inline(hc, RESET_ENDPOINT,
1073	.slot_id = dev->slot_id,
1074	.endpoint_id = dci
1075	);
1076	}
1077
1078	/**
1079	* Reset a ring position in both software and hardware.
1080	*
1081	* @param dev The owner of the endpoint
1082	*/
1083	int hc_reset_ring(xhci_endpoint_t *ep, uint32_t stream_id)
1084	{
1085	xhci_device_t * const dev = xhci_ep_to_dev(ep);
1086	const unsigned dci = endpoint_dci(ep);
1087	uintptr_t addr;
1088
1089	xhci_trb_ring_t *ring = xhci_endpoint_get_ring(ep, stream_id);
1090	xhci_trb_ring_reset_dequeue_state(ring, &addr);
1091
1092	xhci_hc_t * const hc = bus_to_hc(endpoint_get_bus(&ep->base));
1093	return xhci_cmd_sync_inline(hc, SET_TR_DEQUEUE_POINTER,
1094	.slot_id = dev->slot_id,
1095	.endpoint_id = dci,
1096	.stream_id = stream_id,
1097	.dequeue_ptr = addr,
1098	);
1099	}
1100
1101	/**
1102	* @}
1103	*/

Note: See TracBrowser for help on using the repository browser.

Download in other formats: