2 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * USB eXtensible Host Controller Interface, a.k.a. USB 3.0 controller.
29 * The XHCI 1.0 spec can be found at
30 * http://www.intel.com/technology/usb/download/xHCI_Specification_for_USB.pdf
31 * and the USB 3.0 spec at
32 * http://www.usb.org/developers/docs/usb_30_spec_060910.zip
36 * A few words about the design implementation: This driver emulates
37 * the concept about TDs which is found in EHCI specification. This
38 * way we avoid too much diveration among USB drivers.
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/stdint.h>
45 #include <sys/stddef.h>
46 #include <sys/param.h>
47 #include <sys/queue.h>
48 #include <sys/types.h>
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
52 #include <sys/module.h>
54 #include <sys/mutex.h>
55 #include <sys/condvar.h>
56 #include <sys/sysctl.h>
58 #include <sys/unistd.h>
59 #include <sys/callout.h>
60 #include <sys/malloc.h>
63 #include <dev/usb/usb.h>
64 #include <dev/usb/usbdi.h>
66 #define USB_DEBUG_VAR xhcidebug
68 #include <dev/usb/usb_core.h>
69 #include <dev/usb/usb_debug.h>
70 #include <dev/usb/usb_busdma.h>
71 #include <dev/usb/usb_process.h>
72 #include <dev/usb/usb_transfer.h>
73 #include <dev/usb/usb_device.h>
74 #include <dev/usb/usb_hub.h>
75 #include <dev/usb/usb_util.h>
77 #include <dev/usb/usb_controller.h>
78 #include <dev/usb/usb_bus.h>
79 #include <dev/usb/controller/xhci.h>
80 #include <dev/usb/controller/xhcireg.h>
82 #define XHCI_BUS2SC(bus) \
83 ((struct xhci_softc *)(((uint8_t *)(bus)) - \
84 ((uint8_t *)&(((struct xhci_softc *)0)->sc_bus))))
89 static int xhcipolling;
91 static SYSCTL_NODE(_hw_usb, OID_AUTO, xhci, CTLFLAG_RW, 0, "USB XHCI");
92 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN,
93 &xhcidebug, 0, "Debug level");
94 TUNABLE_INT("hw.usb.xhci.debug", &xhcidebug);
95 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, xhci_port_route, CTLFLAG_RW | CTLFLAG_TUN,
96 &xhciroute, 0, "Routing bitmap for switching EHCI ports to XHCI controller");
97 TUNABLE_INT("hw.usb.xhci.xhci_port_route", &xhciroute);
98 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, use_polling, CTLFLAG_RW | CTLFLAG_TUN,
99 &xhcipolling, 0, "Set to enable software interrupt polling for XHCI controller");
100 TUNABLE_INT("hw.usb.xhci.use_polling", &xhcipolling);
105 #define XHCI_INTR_ENDPT 1
107 struct xhci_std_temp {
108 struct xhci_softc *sc;
109 struct usb_page_cache *pc;
111 struct xhci_td *td_next;
114 uint32_t max_packet_size;
126 uint8_t do_isoc_sync;
129 static void xhci_do_poll(struct usb_bus *);
130 static void xhci_device_done(struct usb_xfer *, usb_error_t);
131 static void xhci_root_intr(struct xhci_softc *);
132 static void xhci_free_device_ext(struct usb_device *);
133 static struct xhci_endpoint_ext *xhci_get_endpoint_ext(struct usb_device *,
134 struct usb_endpoint_descriptor *);
135 static usb_proc_callback_t xhci_configure_msg;
136 static usb_error_t xhci_configure_device(struct usb_device *);
137 static usb_error_t xhci_configure_endpoint(struct usb_device *,
138 struct usb_endpoint_descriptor *, uint64_t, uint16_t,
139 uint8_t, uint8_t, uint8_t, uint16_t, uint16_t);
140 static usb_error_t xhci_configure_mask(struct usb_device *,
142 static usb_error_t xhci_cmd_evaluate_ctx(struct xhci_softc *,
144 static void xhci_endpoint_doorbell(struct usb_xfer *);
145 static void xhci_ctx_set_le32(struct xhci_softc *sc, volatile uint32_t *ptr, uint32_t val);
146 static uint32_t xhci_ctx_get_le32(struct xhci_softc *sc, volatile uint32_t *ptr);
147 static void xhci_ctx_set_le64(struct xhci_softc *sc, volatile uint64_t *ptr, uint64_t val);
149 static uint64_t xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr);
152 extern struct usb_bus_methods xhci_bus_methods;
156 xhci_dump_trb(struct xhci_trb *trb)
158 DPRINTFN(5, "trb = %p\n", trb);
159 DPRINTFN(5, "qwTrb0 = 0x%016llx\n", (long long)le64toh(trb->qwTrb0));
160 DPRINTFN(5, "dwTrb2 = 0x%08x\n", le32toh(trb->dwTrb2));
161 DPRINTFN(5, "dwTrb3 = 0x%08x\n", le32toh(trb->dwTrb3));
165 xhci_dump_endpoint(struct xhci_softc *sc, struct xhci_endp_ctx *pep)
167 DPRINTFN(5, "pep = %p\n", pep);
168 DPRINTFN(5, "dwEpCtx0=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx0));
169 DPRINTFN(5, "dwEpCtx1=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx1));
170 DPRINTFN(5, "qwEpCtx2=0x%016llx\n", (long long)xhci_ctx_get_le64(sc, &pep->qwEpCtx2));
171 DPRINTFN(5, "dwEpCtx4=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx4));
172 DPRINTFN(5, "dwEpCtx5=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx5));
173 DPRINTFN(5, "dwEpCtx6=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx6));
174 DPRINTFN(5, "dwEpCtx7=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx7));
178 xhci_dump_device(struct xhci_softc *sc, struct xhci_slot_ctx *psl)
180 DPRINTFN(5, "psl = %p\n", psl);
181 DPRINTFN(5, "dwSctx0=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx0));
182 DPRINTFN(5, "dwSctx1=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx1));
183 DPRINTFN(5, "dwSctx2=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx2));
184 DPRINTFN(5, "dwSctx3=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx3));
189 xhci_use_polling(void)
192 return (xhcipolling != 0);
199 xhci_iterate_hw_softc(struct usb_bus *bus, usb_bus_mem_sub_cb_t *cb)
201 struct xhci_softc *sc = XHCI_BUS2SC(bus);
204 cb(bus, &sc->sc_hw.root_pc, &sc->sc_hw.root_pg,
205 sizeof(struct xhci_hw_root), XHCI_PAGE_SIZE);
207 cb(bus, &sc->sc_hw.ctx_pc, &sc->sc_hw.ctx_pg,
208 sizeof(struct xhci_dev_ctx_addr), XHCI_PAGE_SIZE);
210 for (i = 0; i != XHCI_MAX_SCRATCHPADS; i++) {
211 cb(bus, &sc->sc_hw.scratch_pc[i], &sc->sc_hw.scratch_pg[i],
212 XHCI_PAGE_SIZE, XHCI_PAGE_SIZE);
217 xhci_ctx_set_le32(struct xhci_softc *sc, volatile uint32_t *ptr, uint32_t val)
219 if (sc->sc_ctx_is_64_byte) {
221 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
222 /* all contexts are initially 32-bytes */
223 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
224 ptr = (volatile uint32_t *)(((volatile uint8_t *)ptr) + offset);
230 xhci_ctx_get_le32(struct xhci_softc *sc, volatile uint32_t *ptr)
232 if (sc->sc_ctx_is_64_byte) {
234 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
235 /* all contexts are initially 32-bytes */
236 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
237 ptr = (volatile uint32_t *)(((volatile uint8_t *)ptr) + offset);
239 return (le32toh(*ptr));
243 xhci_ctx_set_le64(struct xhci_softc *sc, volatile uint64_t *ptr, uint64_t val)
245 if (sc->sc_ctx_is_64_byte) {
247 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
248 /* all contexts are initially 32-bytes */
249 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
250 ptr = (volatile uint64_t *)(((volatile uint8_t *)ptr) + offset);
257 xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr)
259 if (sc->sc_ctx_is_64_byte) {
261 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
262 /* all contexts are initially 32-bytes */
263 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
264 ptr = (volatile uint64_t *)(((volatile uint8_t *)ptr) + offset);
266 return (le64toh(*ptr));
271 xhci_reset_command_queue_locked(struct xhci_softc *sc)
273 struct usb_page_search buf_res;
274 struct xhci_hw_root *phwr;
280 temp = XREAD4(sc, oper, XHCI_CRCR_LO);
281 if (temp & XHCI_CRCR_LO_CRR) {
282 DPRINTF("Command ring running\n");
283 temp &= ~(XHCI_CRCR_LO_CS | XHCI_CRCR_LO_CA);
286 * Try to abort the last command as per section
287 * 4.6.1.2 "Aborting a Command" of the XHCI
291 /* stop and cancel */
292 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CS);
293 XWRITE4(sc, oper, XHCI_CRCR_HI, 0);
295 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CA);
296 XWRITE4(sc, oper, XHCI_CRCR_HI, 0);
299 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 4);
301 /* check if command ring is still running */
302 temp = XREAD4(sc, oper, XHCI_CRCR_LO);
303 if (temp & XHCI_CRCR_LO_CRR) {
304 DPRINTF("Comand ring still running\n");
305 return (USB_ERR_IOERROR);
309 /* reset command ring */
310 sc->sc_command_ccs = 1;
311 sc->sc_command_idx = 0;
313 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
315 /* setup command ring control base address */
316 addr = buf_res.physaddr;
317 phwr = buf_res.buffer;
318 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[0];
320 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr);
322 memset(phwr->hwr_commands, 0, sizeof(phwr->hwr_commands));
323 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr);
325 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
327 XWRITE4(sc, oper, XHCI_CRCR_LO, ((uint32_t)addr) | XHCI_CRCR_LO_RCS);
328 XWRITE4(sc, oper, XHCI_CRCR_HI, (uint32_t)(addr >> 32));
334 xhci_start_controller(struct xhci_softc *sc)
336 struct usb_page_search buf_res;
337 struct xhci_hw_root *phwr;
338 struct xhci_dev_ctx_addr *pdctxa;
346 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH);
347 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0x1F;
348 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3;
350 DPRINTF("CAPLENGTH=0x%x\n", sc->sc_oper_off);
351 DPRINTF("RUNTIMEOFFSET=0x%x\n", sc->sc_runt_off);
352 DPRINTF("DOOROFFSET=0x%x\n", sc->sc_door_off);
354 sc->sc_event_ccs = 1;
355 sc->sc_event_idx = 0;
356 sc->sc_command_ccs = 1;
357 sc->sc_command_idx = 0;
359 DPRINTF("xHCI version = 0x%04x\n", XREAD2(sc, capa, XHCI_HCIVERSION));
361 temp = XREAD4(sc, capa, XHCI_HCSPARAMS0);
363 DPRINTF("HCS0 = 0x%08x\n", temp);
365 if (XHCI_HCS0_CSZ(temp)) {
366 sc->sc_ctx_is_64_byte = 1;
367 device_printf(sc->sc_bus.parent, "64 byte context size.\n");
369 sc->sc_ctx_is_64_byte = 0;
370 device_printf(sc->sc_bus.parent, "32 byte context size.\n");
373 /* Reset controller */
374 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_HCRST);
376 for (i = 0; i != 100; i++) {
377 usb_pause_mtx(NULL, hz / 100);
378 temp = (XREAD4(sc, oper, XHCI_USBCMD) & XHCI_CMD_HCRST) |
379 (XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_CNR);
385 device_printf(sc->sc_bus.parent, "Controller "
387 return (USB_ERR_IOERROR);
390 if (!(XREAD4(sc, oper, XHCI_PAGESIZE) & XHCI_PAGESIZE_4K)) {
391 device_printf(sc->sc_bus.parent, "Controller does "
392 "not support 4K page size.\n");
393 return (USB_ERR_IOERROR);
396 temp = XREAD4(sc, capa, XHCI_HCSPARAMS1);
398 i = XHCI_HCS1_N_PORTS(temp);
401 device_printf(sc->sc_bus.parent, "Invalid number "
402 "of ports: %u\n", i);
403 return (USB_ERR_IOERROR);
407 sc->sc_noslot = XHCI_HCS1_DEVSLOT_MAX(temp);
409 if (sc->sc_noslot > XHCI_MAX_DEVICES)
410 sc->sc_noslot = XHCI_MAX_DEVICES;
412 /* setup number of device slots */
414 DPRINTF("CONFIG=0x%08x -> 0x%08x\n",
415 XREAD4(sc, oper, XHCI_CONFIG), sc->sc_noslot);
417 XWRITE4(sc, oper, XHCI_CONFIG, sc->sc_noslot);
419 DPRINTF("Max slots: %u\n", sc->sc_noslot);
421 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2);
423 sc->sc_noscratch = XHCI_HCS2_SPB_MAX(temp);
425 if (sc->sc_noscratch > XHCI_MAX_SCRATCHPADS) {
426 device_printf(sc->sc_bus.parent, "XHCI request "
427 "too many scratchpads\n");
428 return (USB_ERR_NOMEM);
431 DPRINTF("Max scratch: %u\n", sc->sc_noscratch);
433 temp = XREAD4(sc, capa, XHCI_HCSPARAMS3);
435 sc->sc_exit_lat_max = XHCI_HCS3_U1_DEL(temp) +
436 XHCI_HCS3_U2_DEL(temp) + 250 /* us */;
438 temp = XREAD4(sc, oper, XHCI_USBSTS);
440 /* clear interrupts */
441 XWRITE4(sc, oper, XHCI_USBSTS, temp);
442 /* disable all device notifications */
443 XWRITE4(sc, oper, XHCI_DNCTRL, 0);
445 /* setup device context base address */
446 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res);
447 pdctxa = buf_res.buffer;
448 memset(pdctxa, 0, sizeof(*pdctxa));
450 addr = buf_res.physaddr;
451 addr += (uintptr_t)&((struct xhci_dev_ctx_addr *)0)->qwSpBufPtr[0];
453 /* slot 0 points to the table of scratchpad pointers */
454 pdctxa->qwBaaDevCtxAddr[0] = htole64(addr);
456 for (i = 0; i != sc->sc_noscratch; i++) {
457 struct usb_page_search buf_scp;
458 usbd_get_page(&sc->sc_hw.scratch_pc[i], 0, &buf_scp);
459 pdctxa->qwSpBufPtr[i] = htole64((uint64_t)buf_scp.physaddr);
462 addr = buf_res.physaddr;
464 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr);
465 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32));
466 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr);
467 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32));
469 /* Setup event table size */
471 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2);
473 DPRINTF("HCS2=0x%08x\n", temp);
475 temp = XHCI_HCS2_ERST_MAX(temp);
477 if (temp > XHCI_MAX_RSEG)
478 temp = XHCI_MAX_RSEG;
480 sc->sc_erst_max = temp;
482 DPRINTF("ERSTSZ=0x%08x -> 0x%08x\n",
483 XREAD4(sc, runt, XHCI_ERSTSZ(0)), temp);
485 XWRITE4(sc, runt, XHCI_ERSTSZ(0), XHCI_ERSTS_SET(temp));
487 /* Check if we should use the default IMOD value */
488 if (sc->sc_imod_default == 0)
489 sc->sc_imod_default = XHCI_IMOD_DEFAULT;
491 /* Setup interrupt rate */
492 XWRITE4(sc, runt, XHCI_IMOD(0), sc->sc_imod_default);
494 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
496 phwr = buf_res.buffer;
497 addr = buf_res.physaddr;
498 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[0];
500 /* reset hardware root structure */
501 memset(phwr, 0, sizeof(*phwr));
503 phwr->hwr_ring_seg[0].qwEvrsTablePtr = htole64(addr);
504 phwr->hwr_ring_seg[0].dwEvrsTableSize = htole32(XHCI_MAX_EVENTS);
506 DPRINTF("ERDP(0)=0x%016llx\n", (unsigned long long)addr);
508 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr);
509 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32));
511 addr = (uint64_t)buf_res.physaddr;
513 DPRINTF("ERSTBA(0)=0x%016llx\n", (unsigned long long)addr);
515 XWRITE4(sc, runt, XHCI_ERSTBA_LO(0), (uint32_t)addr);
516 XWRITE4(sc, runt, XHCI_ERSTBA_HI(0), (uint32_t)(addr >> 32));
518 /* Setup interrupter registers */
520 temp = XREAD4(sc, runt, XHCI_IMAN(0));
521 temp |= XHCI_IMAN_INTR_ENA;
522 XWRITE4(sc, runt, XHCI_IMAN(0), temp);
524 /* setup command ring control base address */
525 addr = buf_res.physaddr;
526 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[0];
528 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr);
530 XWRITE4(sc, oper, XHCI_CRCR_LO, ((uint32_t)addr) | XHCI_CRCR_LO_RCS);
531 XWRITE4(sc, oper, XHCI_CRCR_HI, (uint32_t)(addr >> 32));
533 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr);
535 usb_bus_mem_flush_all(&sc->sc_bus, &xhci_iterate_hw_softc);
538 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_RS |
539 XHCI_CMD_INTE | XHCI_CMD_HSEE);
541 for (i = 0; i != 100; i++) {
542 usb_pause_mtx(NULL, hz / 100);
543 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH;
548 XWRITE4(sc, oper, XHCI_USBCMD, 0);
549 device_printf(sc->sc_bus.parent, "Run timeout.\n");
550 return (USB_ERR_IOERROR);
553 /* catch any lost interrupts */
554 xhci_do_poll(&sc->sc_bus);
556 if (sc->sc_port_route != NULL) {
557 /* Route all ports to the XHCI by default */
558 sc->sc_port_route(sc->sc_bus.parent,
559 ~xhciroute, xhciroute);
565 xhci_halt_controller(struct xhci_softc *sc)
573 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH);
574 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0xF;
575 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3;
577 /* Halt controller */
578 XWRITE4(sc, oper, XHCI_USBCMD, 0);
580 for (i = 0; i != 100; i++) {
581 usb_pause_mtx(NULL, hz / 100);
582 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH;
588 device_printf(sc->sc_bus.parent, "Controller halt timeout.\n");
589 return (USB_ERR_IOERROR);
595 xhci_init(struct xhci_softc *sc, device_t self)
597 /* initialise some bus fields */
598 sc->sc_bus.parent = self;
600 /* set the bus revision */
601 sc->sc_bus.usbrev = USB_REV_3_0;
603 /* set up the bus struct */
604 sc->sc_bus.methods = &xhci_bus_methods;
606 /* setup devices array */
607 sc->sc_bus.devices = sc->sc_devices;
608 sc->sc_bus.devices_max = XHCI_MAX_DEVICES;
610 /* set default cycle state in case of early interrupts */
611 sc->sc_event_ccs = 1;
612 sc->sc_command_ccs = 1;
614 /* setup command queue mutex and condition varible */
615 cv_init(&sc->sc_cmd_cv, "CMDQ");
616 sx_init(&sc->sc_cmd_sx, "CMDQ lock");
618 /* get all DMA memory */
619 if (usb_bus_mem_alloc_all(&sc->sc_bus,
620 USB_GET_DMA_TAG(self), &xhci_iterate_hw_softc)) {
624 sc->sc_config_msg[0].hdr.pm_callback = &xhci_configure_msg;
625 sc->sc_config_msg[0].bus = &sc->sc_bus;
626 sc->sc_config_msg[1].hdr.pm_callback = &xhci_configure_msg;
627 sc->sc_config_msg[1].bus = &sc->sc_bus;
629 if (usb_proc_create(&sc->sc_config_proc,
630 &sc->sc_bus.bus_mtx, device_get_nameunit(self), USB_PRI_MED)) {
631 printf("WARNING: Creation of XHCI configure "
632 "callback process failed.\n");
638 xhci_uninit(struct xhci_softc *sc)
640 usb_proc_free(&sc->sc_config_proc);
642 usb_bus_mem_free_all(&sc->sc_bus, &xhci_iterate_hw_softc);
644 cv_destroy(&sc->sc_cmd_cv);
645 sx_destroy(&sc->sc_cmd_sx);
649 xhci_set_hw_power_sleep(struct usb_bus *bus, uint32_t state)
651 struct xhci_softc *sc = XHCI_BUS2SC(bus);
654 case USB_HW_POWER_SUSPEND:
655 DPRINTF("Stopping the XHCI\n");
656 xhci_halt_controller(sc);
658 case USB_HW_POWER_SHUTDOWN:
659 DPRINTF("Stopping the XHCI\n");
660 xhci_halt_controller(sc);
662 case USB_HW_POWER_RESUME:
663 DPRINTF("Starting the XHCI\n");
664 xhci_start_controller(sc);
672 xhci_generic_done_sub(struct usb_xfer *xfer)
675 struct xhci_td *td_alt_next;
679 td = xfer->td_transfer_cache;
680 td_alt_next = td->alt_next;
682 if (xfer->aframes != xfer->nframes)
683 usbd_xfer_set_frame_len(xfer, xfer->aframes, 0);
687 usb_pc_cpu_invalidate(td->page_cache);
692 DPRINTFN(4, "xfer=%p[%u/%u] rem=%u/%u status=%u\n",
693 xfer, (unsigned int)xfer->aframes,
694 (unsigned int)xfer->nframes,
695 (unsigned int)len, (unsigned int)td->len,
696 (unsigned int)status);
699 * Verify the status length and
700 * add the length to "frlengths[]":
703 /* should not happen */
704 DPRINTF("Invalid status length, "
705 "0x%04x/0x%04x bytes\n", len, td->len);
706 status = XHCI_TRB_ERROR_LENGTH;
707 } else if (xfer->aframes != xfer->nframes) {
708 xfer->frlengths[xfer->aframes] += td->len - len;
710 /* Check for last transfer */
711 if (((void *)td) == xfer->td_transfer_last) {
715 /* Check for transfer error */
716 if (status != XHCI_TRB_ERROR_SHORT_PKT &&
717 status != XHCI_TRB_ERROR_SUCCESS) {
718 /* the transfer is finished */
722 /* Check for short transfer */
724 if (xfer->flags_int.short_frames_ok ||
725 xfer->flags_int.isochronous_xfr ||
726 xfer->flags_int.control_xfr) {
727 /* follow alt next */
730 /* the transfer is finished */
737 if (td->alt_next != td_alt_next) {
738 /* this USB frame is complete */
743 /* update transfer cache */
745 xfer->td_transfer_cache = td;
747 return ((status == XHCI_TRB_ERROR_STALL) ? USB_ERR_STALLED :
748 (status != XHCI_TRB_ERROR_SHORT_PKT &&
749 status != XHCI_TRB_ERROR_SUCCESS) ? USB_ERR_IOERROR :
750 USB_ERR_NORMAL_COMPLETION);
754 xhci_generic_done(struct usb_xfer *xfer)
758 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
759 xfer, xfer->endpoint);
763 xfer->td_transfer_cache = xfer->td_transfer_first;
765 if (xfer->flags_int.control_xfr) {
767 if (xfer->flags_int.control_hdr)
768 err = xhci_generic_done_sub(xfer);
772 if (xfer->td_transfer_cache == NULL)
776 while (xfer->aframes != xfer->nframes) {
778 err = xhci_generic_done_sub(xfer);
781 if (xfer->td_transfer_cache == NULL)
785 if (xfer->flags_int.control_xfr &&
786 !xfer->flags_int.control_act)
787 err = xhci_generic_done_sub(xfer);
789 /* transfer is complete */
790 xhci_device_done(xfer, err);
794 xhci_activate_transfer(struct usb_xfer *xfer)
798 td = xfer->td_transfer_cache;
800 usb_pc_cpu_invalidate(td->page_cache);
802 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) {
804 /* activate the transfer */
806 td->td_trb[0].dwTrb3 |= htole32(XHCI_TRB_3_CYCLE_BIT);
807 usb_pc_cpu_flush(td->page_cache);
809 xhci_endpoint_doorbell(xfer);
814 xhci_skip_transfer(struct usb_xfer *xfer)
817 struct xhci_td *td_last;
819 td = xfer->td_transfer_cache;
820 td_last = xfer->td_transfer_last;
824 usb_pc_cpu_invalidate(td->page_cache);
826 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) {
828 usb_pc_cpu_invalidate(td_last->page_cache);
830 /* copy LINK TRB to current waiting location */
832 td->td_trb[0].qwTrb0 = td_last->td_trb[td_last->ntrb].qwTrb0;
833 td->td_trb[0].dwTrb2 = td_last->td_trb[td_last->ntrb].dwTrb2;
834 usb_pc_cpu_flush(td->page_cache);
836 td->td_trb[0].dwTrb3 = td_last->td_trb[td_last->ntrb].dwTrb3;
837 usb_pc_cpu_flush(td->page_cache);
839 xhci_endpoint_doorbell(xfer);
843 /*------------------------------------------------------------------------*
844 * xhci_check_transfer
845 *------------------------------------------------------------------------*/
847 xhci_check_transfer(struct xhci_softc *sc, struct xhci_trb *trb)
860 td_event = le64toh(trb->qwTrb0);
861 temp = le32toh(trb->dwTrb2);
863 remainder = XHCI_TRB_2_REM_GET(temp);
864 status = XHCI_TRB_2_ERROR_GET(temp);
866 temp = le32toh(trb->dwTrb3);
867 epno = XHCI_TRB_3_EP_GET(temp);
868 index = XHCI_TRB_3_SLOT_GET(temp);
870 /* check if error means halted */
871 halted = (status != XHCI_TRB_ERROR_SHORT_PKT &&
872 status != XHCI_TRB_ERROR_SUCCESS);
874 DPRINTF("slot=%u epno=%u remainder=%u status=%u\n",
875 index, epno, remainder, status);
877 if (index > sc->sc_noslot) {
878 DPRINTF("Invalid slot.\n");
882 if ((epno == 0) || (epno >= XHCI_MAX_ENDPOINTS)) {
883 DPRINTF("Invalid endpoint.\n");
887 /* try to find the USB transfer that generated the event */
888 for (i = 0; i != (XHCI_MAX_TRANSFERS - 1); i++) {
889 struct usb_xfer *xfer;
891 struct xhci_endpoint_ext *pepext;
893 pepext = &sc->sc_hw.devs[index].endp[epno];
895 xfer = pepext->xfer[i];
899 td = xfer->td_transfer_cache;
901 DPRINTFN(5, "Checking if 0x%016llx == (0x%016llx .. 0x%016llx)\n",
903 (long long)td->td_self,
904 (long long)td->td_self + sizeof(td->td_trb));
907 * NOTE: Some XHCI implementations might not trigger
908 * an event on the last LINK TRB so we need to
909 * consider both the last and second last event
910 * address as conditions for a successful transfer.
912 * NOTE: We assume that the XHCI will only trigger one
913 * event per chain of TRBs.
916 offset = td_event - td->td_self;
919 offset < (int64_t)sizeof(td->td_trb)) {
921 usb_pc_cpu_invalidate(td->page_cache);
923 /* compute rest of remainder, if any */
924 for (i = (offset / 16) + 1; i < td->ntrb; i++) {
925 temp = le32toh(td->td_trb[i].dwTrb2);
926 remainder += XHCI_TRB_2_BYTES_GET(temp);
929 DPRINTFN(5, "New remainder: %u\n", remainder);
931 /* clear isochronous transfer errors */
932 if (xfer->flags_int.isochronous_xfr) {
935 status = XHCI_TRB_ERROR_SUCCESS;
940 /* "td->remainder" is verified later */
941 td->remainder = remainder;
944 usb_pc_cpu_flush(td->page_cache);
947 * 1) Last transfer descriptor makes the
950 if (((void *)td) == xfer->td_transfer_last) {
951 DPRINTF("TD is last\n");
952 xhci_generic_done(xfer);
957 * 2) Any kind of error makes the transfer
961 DPRINTF("TD has I/O error\n");
962 xhci_generic_done(xfer);
967 * 3) If there is no alternate next transfer,
968 * a short packet also makes the transfer done
970 if (td->remainder > 0) {
971 if (td->alt_next == NULL) {
973 "short TD has no alternate next\n");
974 xhci_generic_done(xfer);
977 DPRINTF("TD has short pkt\n");
978 if (xfer->flags_int.short_frames_ok ||
979 xfer->flags_int.isochronous_xfr ||
980 xfer->flags_int.control_xfr) {
981 /* follow the alt next */
982 xfer->td_transfer_cache = td->alt_next;
983 xhci_activate_transfer(xfer);
986 xhci_skip_transfer(xfer);
987 xhci_generic_done(xfer);
992 * 4) Transfer complete - go to next TD
994 DPRINTF("Following next TD\n");
995 xfer->td_transfer_cache = td->obj_next;
996 xhci_activate_transfer(xfer);
997 break; /* there should only be one match */
1003 xhci_check_command(struct xhci_softc *sc, struct xhci_trb *trb)
1005 if (sc->sc_cmd_addr == trb->qwTrb0) {
1006 DPRINTF("Received command event\n");
1007 sc->sc_cmd_result[0] = trb->dwTrb2;
1008 sc->sc_cmd_result[1] = trb->dwTrb3;
1009 cv_signal(&sc->sc_cmd_cv);
1010 return (1); /* command match */
1016 xhci_interrupt_poll(struct xhci_softc *sc)
1018 struct usb_page_search buf_res;
1019 struct xhci_hw_root *phwr;
1029 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
1031 phwr = buf_res.buffer;
1033 /* Receive any events */
1035 usb_pc_cpu_invalidate(&sc->sc_hw.root_pc);
1037 i = sc->sc_event_idx;
1038 j = sc->sc_event_ccs;
1043 temp = le32toh(phwr->hwr_events[i].dwTrb3);
1045 k = (temp & XHCI_TRB_3_CYCLE_BIT) ? 1 : 0;
1050 event = XHCI_TRB_3_TYPE_GET(temp);
1052 DPRINTFN(10, "event[%u] = %u (0x%016llx 0x%08lx 0x%08lx)\n",
1053 i, event, (long long)le64toh(phwr->hwr_events[i].qwTrb0),
1054 (long)le32toh(phwr->hwr_events[i].dwTrb2),
1055 (long)le32toh(phwr->hwr_events[i].dwTrb3));
1058 case XHCI_TRB_EVENT_TRANSFER:
1059 xhci_check_transfer(sc, &phwr->hwr_events[i]);
1061 case XHCI_TRB_EVENT_CMD_COMPLETE:
1062 retval |= xhci_check_command(sc, &phwr->hwr_events[i]);
1065 DPRINTF("Unhandled event = %u\n", event);
1071 if (i == XHCI_MAX_EVENTS) {
1075 /* check for timeout */
1081 sc->sc_event_idx = i;
1082 sc->sc_event_ccs = j;
1085 * NOTE: The Event Ring Dequeue Pointer Register is 64-bit
1086 * latched. That means to activate the register we need to
1087 * write both the low and high double word of the 64-bit
1091 addr = (uint32_t)buf_res.physaddr;
1092 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[i];
1094 /* try to clear busy bit */
1095 addr |= XHCI_ERDP_LO_BUSY;
1097 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr);
1098 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32));
1104 xhci_do_command(struct xhci_softc *sc, struct xhci_trb *trb,
1105 uint16_t timeout_ms)
1107 struct usb_page_search buf_res;
1108 struct xhci_hw_root *phwr;
1113 uint8_t timeout = 0;
1116 XHCI_CMD_ASSERT_LOCKED(sc);
1118 /* get hardware root structure */
1120 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
1122 phwr = buf_res.buffer;
1126 USB_BUS_LOCK(&sc->sc_bus);
1128 i = sc->sc_command_idx;
1129 j = sc->sc_command_ccs;
1131 DPRINTFN(10, "command[%u] = %u (0x%016llx, 0x%08lx, 0x%08lx)\n",
1132 i, XHCI_TRB_3_TYPE_GET(le32toh(trb->dwTrb3)),
1133 (long long)le64toh(trb->qwTrb0),
1134 (long)le32toh(trb->dwTrb2),
1135 (long)le32toh(trb->dwTrb3));
1137 phwr->hwr_commands[i].qwTrb0 = trb->qwTrb0;
1138 phwr->hwr_commands[i].dwTrb2 = trb->dwTrb2;
1140 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1145 temp |= htole32(XHCI_TRB_3_CYCLE_BIT);
1147 temp &= ~htole32(XHCI_TRB_3_CYCLE_BIT);
1149 temp &= ~htole32(XHCI_TRB_3_TC_BIT);
1151 phwr->hwr_commands[i].dwTrb3 = temp;
1153 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1155 addr = buf_res.physaddr;
1156 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[i];
1158 sc->sc_cmd_addr = htole64(addr);
1162 if (i == (XHCI_MAX_COMMANDS - 1)) {
1165 temp = htole32(XHCI_TRB_3_TC_BIT |
1166 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) |
1167 XHCI_TRB_3_CYCLE_BIT);
1169 temp = htole32(XHCI_TRB_3_TC_BIT |
1170 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
1173 phwr->hwr_commands[i].dwTrb3 = temp;
1175 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1181 sc->sc_command_idx = i;
1182 sc->sc_command_ccs = j;
1184 XWRITE4(sc, door, XHCI_DOORBELL(0), 0);
1186 err = cv_timedwait(&sc->sc_cmd_cv, &sc->sc_bus.bus_mtx,
1187 USB_MS_TO_TICKS(timeout_ms));
1190 * In some error cases event interrupts are not generated.
1191 * Poll one time to see if the command has completed.
1193 if (err != 0 && xhci_interrupt_poll(sc) != 0) {
1194 DPRINTF("Command was completed when polling\n");
1198 DPRINTF("Command timeout!\n");
1200 * After some weeks of continuous operation, it has
1201 * been observed that the ASMedia Technology, ASM1042
1202 * SuperSpeed USB Host Controller can suddenly stop
1203 * accepting commands via the command queue. Try to
1204 * first reset the command queue. If that fails do a
1205 * host controller reset.
1208 xhci_reset_command_queue_locked(sc) == 0) {
1209 temp = le32toh(trb->dwTrb3);
1212 * Avoid infinite XHCI reset loops if the set
1213 * address command fails to respond due to a
1214 * non-enumerating device:
1216 if (XHCI_TRB_3_TYPE_GET(temp) == XHCI_TRB_TYPE_ADDRESS_DEVICE &&
1217 (temp & XHCI_TRB_3_BSR_BIT) == 0) {
1218 DPRINTF("Set address timeout\n");
1224 DPRINTF("Controller reset!\n");
1225 usb_bus_reset_async_locked(&sc->sc_bus);
1227 err = USB_ERR_TIMEOUT;
1231 temp = le32toh(sc->sc_cmd_result[0]);
1232 if (XHCI_TRB_2_ERROR_GET(temp) != XHCI_TRB_ERROR_SUCCESS)
1233 err = USB_ERR_IOERROR;
1235 trb->dwTrb2 = sc->sc_cmd_result[0];
1236 trb->dwTrb3 = sc->sc_cmd_result[1];
1239 USB_BUS_UNLOCK(&sc->sc_bus);
1246 xhci_cmd_nop(struct xhci_softc *sc)
1248 struct xhci_trb trb;
1255 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NOOP);
1257 trb.dwTrb3 = htole32(temp);
1259 return (xhci_do_command(sc, &trb, 100 /* ms */));
1264 xhci_cmd_enable_slot(struct xhci_softc *sc, uint8_t *pslot)
1266 struct xhci_trb trb;
1274 trb.dwTrb3 = htole32(XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ENABLE_SLOT));
1276 err = xhci_do_command(sc, &trb, 100 /* ms */);
1280 temp = le32toh(trb.dwTrb3);
1282 *pslot = XHCI_TRB_3_SLOT_GET(temp);
1289 xhci_cmd_disable_slot(struct xhci_softc *sc, uint8_t slot_id)
1291 struct xhci_trb trb;
1298 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DISABLE_SLOT) |
1299 XHCI_TRB_3_SLOT_SET(slot_id);
1301 trb.dwTrb3 = htole32(temp);
1303 return (xhci_do_command(sc, &trb, 100 /* ms */));
1307 xhci_cmd_set_address(struct xhci_softc *sc, uint64_t input_ctx,
1308 uint8_t bsr, uint8_t slot_id)
1310 struct xhci_trb trb;
1315 trb.qwTrb0 = htole64(input_ctx);
1317 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ADDRESS_DEVICE) |
1318 XHCI_TRB_3_SLOT_SET(slot_id);
1321 temp |= XHCI_TRB_3_BSR_BIT;
1323 trb.dwTrb3 = htole32(temp);
1325 return (xhci_do_command(sc, &trb, 500 /* ms */));
1329 xhci_set_address(struct usb_device *udev, struct mtx *mtx, uint16_t address)
1331 struct usb_page_search buf_inp;
1332 struct usb_page_search buf_dev;
1333 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
1334 struct xhci_hw_dev *hdev;
1335 struct xhci_dev_ctx *pdev;
1336 struct xhci_endpoint_ext *pepext;
1342 /* the root HUB case is not handled here */
1343 if (udev->parent_hub == NULL)
1344 return (USB_ERR_INVAL);
1346 index = udev->controller_slot_id;
1348 hdev = &sc->sc_hw.devs[index];
1355 switch (hdev->state) {
1356 case XHCI_ST_DEFAULT:
1357 case XHCI_ST_ENABLED:
1359 hdev->state = XHCI_ST_ENABLED;
1361 /* set configure mask to slot and EP0 */
1362 xhci_configure_mask(udev, 3, 0);
1364 /* configure input slot context structure */
1365 err = xhci_configure_device(udev);
1368 DPRINTF("Could not configure device\n");
1372 /* configure input endpoint context structure */
1373 switch (udev->speed) {
1375 case USB_SPEED_FULL:
1378 case USB_SPEED_HIGH:
1386 pepext = xhci_get_endpoint_ext(udev,
1387 &udev->ctrl_ep_desc);
1388 err = xhci_configure_endpoint(udev,
1389 &udev->ctrl_ep_desc, pepext->physaddr,
1390 0, 1, 1, 0, mps, mps);
1393 DPRINTF("Could not configure default endpoint\n");
1397 /* execute set address command */
1398 usbd_get_page(&hdev->input_pc, 0, &buf_inp);
1400 err = xhci_cmd_set_address(sc, buf_inp.physaddr,
1401 (address == 0), index);
1404 temp = le32toh(sc->sc_cmd_result[0]);
1405 if (address == 0 && sc->sc_port_route != NULL &&
1406 XHCI_TRB_2_ERROR_GET(temp) ==
1407 XHCI_TRB_ERROR_PARAMETER) {
1408 /* LynxPoint XHCI - ports are not switchable */
1409 /* Un-route all ports from the XHCI */
1410 sc->sc_port_route(sc->sc_bus.parent, 0, ~0);
1412 DPRINTF("Could not set address "
1413 "for slot %u.\n", index);
1418 /* update device address to new value */
1420 usbd_get_page(&hdev->device_pc, 0, &buf_dev);
1421 pdev = buf_dev.buffer;
1422 usb_pc_cpu_invalidate(&hdev->device_pc);
1424 temp = xhci_ctx_get_le32(sc, &pdev->ctx_slot.dwSctx3);
1425 udev->address = XHCI_SCTX_3_DEV_ADDR_GET(temp);
1427 /* update device state to new value */
1430 hdev->state = XHCI_ST_ADDRESSED;
1432 hdev->state = XHCI_ST_DEFAULT;
1436 DPRINTF("Wrong state for set address.\n");
1437 err = USB_ERR_IOERROR;
1440 XHCI_CMD_UNLOCK(sc);
1449 xhci_cmd_configure_ep(struct xhci_softc *sc, uint64_t input_ctx,
1450 uint8_t deconfigure, uint8_t slot_id)
1452 struct xhci_trb trb;
1457 trb.qwTrb0 = htole64(input_ctx);
1459 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_CONFIGURE_EP) |
1460 XHCI_TRB_3_SLOT_SET(slot_id);
1463 temp |= XHCI_TRB_3_DCEP_BIT;
1465 trb.dwTrb3 = htole32(temp);
1467 return (xhci_do_command(sc, &trb, 100 /* ms */));
1471 xhci_cmd_evaluate_ctx(struct xhci_softc *sc, uint64_t input_ctx,
1474 struct xhci_trb trb;
1479 trb.qwTrb0 = htole64(input_ctx);
1481 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_EVALUATE_CTX) |
1482 XHCI_TRB_3_SLOT_SET(slot_id);
1483 trb.dwTrb3 = htole32(temp);
1485 return (xhci_do_command(sc, &trb, 100 /* ms */));
1489 xhci_cmd_reset_ep(struct xhci_softc *sc, uint8_t preserve,
1490 uint8_t ep_id, uint8_t slot_id)
1492 struct xhci_trb trb;
1499 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_EP) |
1500 XHCI_TRB_3_SLOT_SET(slot_id) |
1501 XHCI_TRB_3_EP_SET(ep_id);
1504 temp |= XHCI_TRB_3_PRSV_BIT;
1506 trb.dwTrb3 = htole32(temp);
1508 return (xhci_do_command(sc, &trb, 100 /* ms */));
1512 xhci_cmd_set_tr_dequeue_ptr(struct xhci_softc *sc, uint64_t dequeue_ptr,
1513 uint16_t stream_id, uint8_t ep_id, uint8_t slot_id)
1515 struct xhci_trb trb;
1520 trb.qwTrb0 = htole64(dequeue_ptr);
1522 temp = XHCI_TRB_2_STREAM_SET(stream_id);
1523 trb.dwTrb2 = htole32(temp);
1525 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SET_TR_DEQUEUE) |
1526 XHCI_TRB_3_SLOT_SET(slot_id) |
1527 XHCI_TRB_3_EP_SET(ep_id);
1528 trb.dwTrb3 = htole32(temp);
1530 return (xhci_do_command(sc, &trb, 100 /* ms */));
1534 xhci_cmd_stop_ep(struct xhci_softc *sc, uint8_t suspend,
1535 uint8_t ep_id, uint8_t slot_id)
1537 struct xhci_trb trb;
1544 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STOP_EP) |
1545 XHCI_TRB_3_SLOT_SET(slot_id) |
1546 XHCI_TRB_3_EP_SET(ep_id);
1549 temp |= XHCI_TRB_3_SUSP_EP_BIT;
1551 trb.dwTrb3 = htole32(temp);
1553 return (xhci_do_command(sc, &trb, 100 /* ms */));
1557 xhci_cmd_reset_dev(struct xhci_softc *sc, uint8_t slot_id)
1559 struct xhci_trb trb;
1566 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_DEVICE) |
1567 XHCI_TRB_3_SLOT_SET(slot_id);
1569 trb.dwTrb3 = htole32(temp);
1571 return (xhci_do_command(sc, &trb, 100 /* ms */));
1574 /*------------------------------------------------------------------------*
1575 * xhci_interrupt - XHCI interrupt handler
1576 *------------------------------------------------------------------------*/
1578 xhci_interrupt(struct xhci_softc *sc)
1583 USB_BUS_LOCK(&sc->sc_bus);
1585 status = XREAD4(sc, oper, XHCI_USBSTS);
1587 /* acknowledge interrupts, if any */
1589 XWRITE4(sc, oper, XHCI_USBSTS, status);
1590 DPRINTFN(16, "real interrupt (status=0x%08x)\n", status);
1593 temp = XREAD4(sc, runt, XHCI_IMAN(0));
1595 /* force clearing of pending interrupts */
1596 if (temp & XHCI_IMAN_INTR_PEND)
1597 XWRITE4(sc, runt, XHCI_IMAN(0), temp);
1599 /* check for event(s) */
1600 xhci_interrupt_poll(sc);
1602 if (status & (XHCI_STS_PCD | XHCI_STS_HCH |
1603 XHCI_STS_HSE | XHCI_STS_HCE)) {
1605 if (status & XHCI_STS_PCD) {
1609 if (status & XHCI_STS_HCH) {
1610 printf("%s: host controller halted\n",
1614 if (status & XHCI_STS_HSE) {
1615 printf("%s: host system error\n",
1619 if (status & XHCI_STS_HCE) {
1620 printf("%s: host controller error\n",
1624 USB_BUS_UNLOCK(&sc->sc_bus);
1627 /*------------------------------------------------------------------------*
1628 * xhci_timeout - XHCI timeout handler
1629 *------------------------------------------------------------------------*/
1631 xhci_timeout(void *arg)
1633 struct usb_xfer *xfer = arg;
1635 DPRINTF("xfer=%p\n", xfer);
1637 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1639 /* transfer is transferred */
1640 xhci_device_done(xfer, USB_ERR_TIMEOUT);
1644 xhci_do_poll(struct usb_bus *bus)
1646 struct xhci_softc *sc = XHCI_BUS2SC(bus);
1648 USB_BUS_LOCK(&sc->sc_bus);
1649 xhci_interrupt_poll(sc);
1650 USB_BUS_UNLOCK(&sc->sc_bus);
1654 xhci_setup_generic_chain_sub(struct xhci_std_temp *temp)
1656 struct usb_page_search buf_res;
1658 struct xhci_td *td_next;
1659 struct xhci_td *td_alt_next;
1660 struct xhci_td *td_first;
1661 uint32_t buf_offset;
1666 uint8_t shortpkt_old;
1672 shortpkt_old = temp->shortpkt;
1673 len_old = temp->len;
1680 td_next = td_first = temp->td_next;
1684 if (temp->len == 0) {
1689 /* send a Zero Length Packet, ZLP, last */
1696 average = temp->average;
1698 if (temp->len < average) {
1699 if (temp->len % temp->max_packet_size) {
1702 average = temp->len;
1706 if (td_next == NULL)
1707 panic("%s: out of XHCI transfer descriptors!", __FUNCTION__);
1712 td_next = td->obj_next;
1714 /* check if we are pre-computing */
1718 /* update remaining length */
1720 temp->len -= average;
1724 /* fill out current TD */
1730 /* update remaining length */
1732 temp->len -= average;
1734 /* reset TRB index */
1738 if (temp->trb_type == XHCI_TRB_TYPE_SETUP_STAGE) {
1739 /* immediate data */
1744 td->td_trb[0].qwTrb0 = 0;
1746 usbd_copy_out(temp->pc, temp->offset + buf_offset,
1747 (uint8_t *)(uintptr_t)&td->td_trb[0].qwTrb0,
1750 dword = XHCI_TRB_2_BYTES_SET(8) |
1751 XHCI_TRB_2_TDSZ_SET(0) |
1752 XHCI_TRB_2_IRQ_SET(0);
1754 td->td_trb[0].dwTrb2 = htole32(dword);
1756 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SETUP_STAGE) |
1757 XHCI_TRB_3_IDT_BIT | XHCI_TRB_3_CYCLE_BIT;
1760 if (td->td_trb[0].qwTrb0 &
1761 htole64(XHCI_TRB_0_WLENGTH_MASK)) {
1762 if (td->td_trb[0].qwTrb0 &
1763 htole64(XHCI_TRB_0_DIR_IN_MASK))
1764 dword |= XHCI_TRB_3_TRT_IN;
1766 dword |= XHCI_TRB_3_TRT_OUT;
1769 td->td_trb[0].dwTrb3 = htole32(dword);
1771 xhci_dump_trb(&td->td_trb[x]);
1779 /* fill out buffer pointers */
1782 memset(&buf_res, 0, sizeof(buf_res));
1784 usbd_get_page(temp->pc, temp->offset +
1785 buf_offset, &buf_res);
1787 /* get length to end of page */
1788 if (buf_res.length > average)
1789 buf_res.length = average;
1791 /* check for maximum length */
1792 if (buf_res.length > XHCI_TD_PAGE_SIZE)
1793 buf_res.length = XHCI_TD_PAGE_SIZE;
1795 npkt_off += buf_res.length;
1799 npkt = (len_old - npkt_off + temp->max_packet_size - 1) /
1800 temp->max_packet_size;
1807 /* fill out TRB's */
1808 td->td_trb[x].qwTrb0 =
1809 htole64((uint64_t)buf_res.physaddr);
1812 XHCI_TRB_2_BYTES_SET(buf_res.length) |
1813 XHCI_TRB_2_TDSZ_SET(npkt) |
1814 XHCI_TRB_2_IRQ_SET(0);
1816 td->td_trb[x].dwTrb2 = htole32(dword);
1818 switch (temp->trb_type) {
1819 case XHCI_TRB_TYPE_ISOCH:
1820 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1821 XHCI_TRB_3_TBC_SET(temp->tbc) |
1822 XHCI_TRB_3_TLBPC_SET(temp->tlbpc);
1823 if (td != td_first) {
1824 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL);
1825 } else if (temp->do_isoc_sync != 0) {
1826 temp->do_isoc_sync = 0;
1827 /* wait until "isoc_frame" */
1828 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) |
1829 XHCI_TRB_3_FRID_SET(temp->isoc_frame / 8);
1831 /* start data transfer at next interval */
1832 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) |
1833 XHCI_TRB_3_ISO_SIA_BIT;
1835 if (temp->direction == UE_DIR_IN)
1836 dword |= XHCI_TRB_3_ISP_BIT;
1838 case XHCI_TRB_TYPE_DATA_STAGE:
1839 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1840 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DATA_STAGE);
1841 if (temp->direction == UE_DIR_IN)
1842 dword |= XHCI_TRB_3_DIR_IN | XHCI_TRB_3_ISP_BIT;
1844 case XHCI_TRB_TYPE_STATUS_STAGE:
1845 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1846 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STATUS_STAGE);
1847 if (temp->direction == UE_DIR_IN)
1848 dword |= XHCI_TRB_3_DIR_IN;
1850 default: /* XHCI_TRB_TYPE_NORMAL */
1851 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1852 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL);
1853 if (temp->direction == UE_DIR_IN)
1854 dword |= XHCI_TRB_3_ISP_BIT;
1857 td->td_trb[x].dwTrb3 = htole32(dword);
1859 average -= buf_res.length;
1860 buf_offset += buf_res.length;
1862 xhci_dump_trb(&td->td_trb[x]);
1866 } while (average != 0);
1868 td->td_trb[x-1].dwTrb3 |= htole32(XHCI_TRB_3_IOC_BIT);
1870 /* store number of data TRB's */
1874 DPRINTF("NTRB=%u\n", x);
1876 /* fill out link TRB */
1878 if (td_next != NULL) {
1879 /* link the current TD with the next one */
1880 td->td_trb[x].qwTrb0 = htole64((uint64_t)td_next->td_self);
1881 DPRINTF("LINK=0x%08llx\n", (long long)td_next->td_self);
1883 /* this field will get updated later */
1884 DPRINTF("NOLINK\n");
1887 dword = XHCI_TRB_2_IRQ_SET(0);
1889 td->td_trb[x].dwTrb2 = htole32(dword);
1891 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) |
1892 XHCI_TRB_3_CYCLE_BIT | XHCI_TRB_3_IOC_BIT |
1894 * CHAIN-BIT: Ensure that a multi-TRB IN-endpoint
1895 * frame only receives a single short packet event
1896 * by setting the CHAIN bit in the LINK field. In
1897 * addition some XHCI controllers have problems
1898 * sending a ZLP unless the CHAIN-BIT is set in
1901 XHCI_TRB_3_CHAIN_BIT;
1903 td->td_trb[x].dwTrb3 = htole32(dword);
1905 td->alt_next = td_alt_next;
1907 xhci_dump_trb(&td->td_trb[x]);
1909 usb_pc_cpu_flush(td->page_cache);
1915 /* setup alt next pointer, if any */
1916 if (temp->last_frame) {
1919 /* we use this field internally */
1920 td_alt_next = td_next;
1924 temp->shortpkt = shortpkt_old;
1925 temp->len = len_old;
1930 * Remove cycle bit from the first TRB if we are
1933 if (temp->step_td != 0) {
1934 td_first->td_trb[0].dwTrb3 &= ~htole32(XHCI_TRB_3_CYCLE_BIT);
1935 usb_pc_cpu_flush(td_first->page_cache);
1938 /* clear TD SIZE to zero, hence this is the last TRB */
1939 /* remove chain bit because this is the last data TRB in the chain */
1940 td->td_trb[td->ntrb - 1].dwTrb2 &= ~htole32(XHCI_TRB_2_TDSZ_SET(15));
1941 td->td_trb[td->ntrb - 1].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT);
1942 /* remove CHAIN-BIT from last LINK TRB */
1943 td->td_trb[td->ntrb].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT);
1945 usb_pc_cpu_flush(td->page_cache);
1948 temp->td_next = td_next;
1952 xhci_setup_generic_chain(struct usb_xfer *xfer)
1954 struct xhci_std_temp temp;
1960 temp.do_isoc_sync = 0;
1964 temp.average = xfer->max_hc_frame_size;
1965 temp.max_packet_size = xfer->max_packet_size;
1966 temp.sc = XHCI_BUS2SC(xfer->xroot->bus);
1968 temp.last_frame = 0;
1970 temp.multishort = xfer->flags_int.isochronous_xfr ||
1971 xfer->flags_int.control_xfr ||
1972 xfer->flags_int.short_frames_ok;
1974 /* toggle the DMA set we are using */
1975 xfer->flags_int.curr_dma_set ^= 1;
1977 /* get next DMA set */
1978 td = xfer->td_start[xfer->flags_int.curr_dma_set];
1983 xfer->td_transfer_first = td;
1984 xfer->td_transfer_cache = td;
1986 if (xfer->flags_int.isochronous_xfr) {
1989 /* compute multiplier for ISOCHRONOUS transfers */
1990 mult = xfer->endpoint->ecomp ?
1991 (xfer->endpoint->ecomp->bmAttributes & 3) : 0;
1992 /* check for USB 2.0 multiplier */
1994 mult = (xfer->endpoint->edesc->
1995 wMaxPacketSize[1] >> 3) & 3;
2003 x = XREAD4(temp.sc, runt, XHCI_MFINDEX);
2005 DPRINTF("MFINDEX=0x%08x\n", x);
2007 switch (usbd_get_speed(xfer->xroot->udev)) {
2008 case USB_SPEED_FULL:
2010 temp.isoc_delta = 8; /* 1ms */
2011 x += temp.isoc_delta - 1;
2012 x &= ~(temp.isoc_delta - 1);
2015 shift = usbd_xfer_get_fps_shift(xfer);
2016 temp.isoc_delta = 1U << shift;
2017 x += temp.isoc_delta - 1;
2018 x &= ~(temp.isoc_delta - 1);
2019 /* simple frame load balancing */
2020 x += xfer->endpoint->usb_uframe;
2024 y = XHCI_MFINDEX_GET(x - xfer->endpoint->isoc_next);
2026 if ((xfer->endpoint->is_synced == 0) ||
2027 (y < (xfer->nframes << shift)) ||
2028 (XHCI_MFINDEX_GET(-y) >= (128 * 8))) {
2030 * If there is data underflow or the pipe
2031 * queue is empty we schedule the transfer a
2032 * few frames ahead of the current frame
2033 * position. Else two isochronous transfers
2036 xfer->endpoint->isoc_next = XHCI_MFINDEX_GET(x + (3 * 8));
2037 xfer->endpoint->is_synced = 1;
2038 temp.do_isoc_sync = 1;
2040 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next);
2043 /* compute isochronous completion time */
2045 y = XHCI_MFINDEX_GET(xfer->endpoint->isoc_next - (x & ~7));
2047 xfer->isoc_time_complete =
2048 usb_isoc_time_expand(&temp.sc->sc_bus, x / 8) +
2049 (y / 8) + (((xfer->nframes << shift) + 7) / 8);
2052 temp.isoc_frame = xfer->endpoint->isoc_next;
2053 temp.trb_type = XHCI_TRB_TYPE_ISOCH;
2055 xfer->endpoint->isoc_next += xfer->nframes << shift;
2057 } else if (xfer->flags_int.control_xfr) {
2059 /* check if we should prepend a setup message */
2061 if (xfer->flags_int.control_hdr) {
2063 temp.len = xfer->frlengths[0];
2064 temp.pc = xfer->frbuffers + 0;
2065 temp.shortpkt = temp.len ? 1 : 0;
2066 temp.trb_type = XHCI_TRB_TYPE_SETUP_STAGE;
2069 /* check for last frame */
2070 if (xfer->nframes == 1) {
2071 /* no STATUS stage yet, SETUP is last */
2072 if (xfer->flags_int.control_act)
2073 temp.last_frame = 1;
2076 xhci_setup_generic_chain_sub(&temp);
2080 temp.isoc_delta = 0;
2081 temp.isoc_frame = 0;
2082 temp.trb_type = XHCI_TRB_TYPE_DATA_STAGE;
2086 temp.isoc_delta = 0;
2087 temp.isoc_frame = 0;
2088 temp.trb_type = XHCI_TRB_TYPE_NORMAL;
2091 if (x != xfer->nframes) {
2092 /* setup page_cache pointer */
2093 temp.pc = xfer->frbuffers + x;
2094 /* set endpoint direction */
2095 temp.direction = UE_GET_DIR(xfer->endpointno);
2098 while (x != xfer->nframes) {
2100 /* DATA0 / DATA1 message */
2102 temp.len = xfer->frlengths[x];
2103 temp.step_td = ((xfer->endpointno & UE_DIR_IN) &&
2104 x != 0 && temp.multishort == 0);
2108 if (x == xfer->nframes) {
2109 if (xfer->flags_int.control_xfr) {
2110 /* no STATUS stage yet, DATA is last */
2111 if (xfer->flags_int.control_act)
2112 temp.last_frame = 1;
2114 temp.last_frame = 1;
2117 if (temp.len == 0) {
2119 /* make sure that we send an USB packet */
2124 temp.tlbpc = mult - 1;
2126 } else if (xfer->flags_int.isochronous_xfr) {
2131 * Isochronous transfers don't have short
2132 * packet termination:
2137 /* isochronous transfers have a transfer limit */
2139 if (temp.len > xfer->max_frame_size)
2140 temp.len = xfer->max_frame_size;
2142 /* compute TD packet count */
2143 tdpc = (temp.len + xfer->max_packet_size - 1) /
2144 xfer->max_packet_size;
2146 temp.tbc = ((tdpc + mult - 1) / mult) - 1;
2147 temp.tlbpc = (tdpc % mult);
2149 if (temp.tlbpc == 0)
2150 temp.tlbpc = mult - 1;
2155 /* regular data transfer */
2157 temp.shortpkt = xfer->flags.force_short_xfer ? 0 : 1;
2160 xhci_setup_generic_chain_sub(&temp);
2162 if (xfer->flags_int.isochronous_xfr) {
2163 temp.offset += xfer->frlengths[x - 1];
2164 temp.isoc_frame += temp.isoc_delta;
2166 /* get next Page Cache pointer */
2167 temp.pc = xfer->frbuffers + x;
2171 /* check if we should append a status stage */
2173 if (xfer->flags_int.control_xfr &&
2174 !xfer->flags_int.control_act) {
2177 * Send a DATA1 message and invert the current
2178 * endpoint direction.
2180 temp.step_td = (xfer->nframes != 0);
2181 temp.direction = UE_GET_DIR(xfer->endpointno) ^ UE_DIR_IN;
2185 temp.last_frame = 1;
2186 temp.trb_type = XHCI_TRB_TYPE_STATUS_STAGE;
2188 xhci_setup_generic_chain_sub(&temp);
2193 /* must have at least one frame! */
2195 xfer->td_transfer_last = td;
2197 DPRINTF("first=%p last=%p\n", xfer->td_transfer_first, td);
2201 xhci_set_slot_pointer(struct xhci_softc *sc, uint8_t index, uint64_t dev_addr)
2203 struct usb_page_search buf_res;
2204 struct xhci_dev_ctx_addr *pdctxa;
2206 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res);
2208 pdctxa = buf_res.buffer;
2210 DPRINTF("addr[%u]=0x%016llx\n", index, (long long)dev_addr);
2212 pdctxa->qwBaaDevCtxAddr[index] = htole64(dev_addr);
2214 usb_pc_cpu_flush(&sc->sc_hw.ctx_pc);
2218 xhci_configure_mask(struct usb_device *udev, uint32_t mask, uint8_t drop)
2220 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2221 struct usb_page_search buf_inp;
2222 struct xhci_input_dev_ctx *pinp;
2227 index = udev->controller_slot_id;
2229 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
2231 pinp = buf_inp.buffer;
2234 mask &= XHCI_INCTX_NON_CTRL_MASK;
2235 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0, mask);
2236 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, 0);
2239 * Some hardware requires that we drop the endpoint
2240 * context before adding it again:
2242 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0,
2243 mask & XHCI_INCTX_NON_CTRL_MASK);
2245 /* Add new endpoint context */
2246 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, mask);
2248 /* find most significant set bit */
2249 for (x = 31; x != 1; x--) {
2250 if (mask & (1 << x))
2257 /* figure out the maximum number of contexts */
2258 if (x > sc->sc_hw.devs[index].context_num)
2259 sc->sc_hw.devs[index].context_num = x;
2261 x = sc->sc_hw.devs[index].context_num;
2263 /* update number of contexts */
2264 temp = xhci_ctx_get_le32(sc, &pinp->ctx_slot.dwSctx0);
2265 temp &= ~XHCI_SCTX_0_CTX_NUM_SET(31);
2266 temp |= XHCI_SCTX_0_CTX_NUM_SET(x + 1);
2267 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp);
2269 usb_pc_cpu_flush(&sc->sc_hw.devs[index].input_pc);
2274 xhci_configure_endpoint(struct usb_device *udev,
2275 struct usb_endpoint_descriptor *edesc, uint64_t ring_addr,
2276 uint16_t interval, uint8_t max_packet_count, uint8_t mult,
2277 uint8_t fps_shift, uint16_t max_packet_size, uint16_t max_frame_size)
2279 struct usb_page_search buf_inp;
2280 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2281 struct xhci_input_dev_ctx *pinp;
2287 index = udev->controller_slot_id;
2289 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
2291 pinp = buf_inp.buffer;
2293 epno = edesc->bEndpointAddress;
2294 type = edesc->bmAttributes & UE_XFERTYPE;
2296 if (type == UE_CONTROL)
2299 epno = XHCI_EPNO2EPID(epno);
2302 return (USB_ERR_NO_PIPE); /* invalid */
2304 if (max_packet_count == 0)
2305 return (USB_ERR_BAD_BUFSIZE);
2310 return (USB_ERR_BAD_BUFSIZE);
2312 temp = XHCI_EPCTX_0_EPSTATE_SET(0) |
2313 XHCI_EPCTX_0_MAXP_STREAMS_SET(0) |
2314 XHCI_EPCTX_0_LSA_SET(0);
2316 switch (udev->speed) {
2317 case USB_SPEED_FULL:
2330 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift);
2332 case UE_ISOCHRONOUS:
2333 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift);
2335 switch (udev->speed) {
2336 case USB_SPEED_SUPER:
2339 temp |= XHCI_EPCTX_0_MULT_SET(mult - 1);
2340 max_packet_count /= mult;
2350 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx0, temp);
2353 XHCI_EPCTX_1_HID_SET(0) |
2354 XHCI_EPCTX_1_MAXB_SET(max_packet_count) |
2355 XHCI_EPCTX_1_MAXP_SIZE_SET(max_packet_size);
2358 * Always enable the "three strikes and you are gone" feature
2359 * except for ISOCHRONOUS endpoints. This is suggested by
2360 * section 4.3.3 in the XHCI specification about device slot
2363 if (type != UE_ISOCHRONOUS)
2364 temp |= XHCI_EPCTX_1_CERR_SET(3);
2368 temp |= XHCI_EPCTX_1_EPTYPE_SET(4);
2370 case UE_ISOCHRONOUS:
2371 temp |= XHCI_EPCTX_1_EPTYPE_SET(1);
2374 temp |= XHCI_EPCTX_1_EPTYPE_SET(2);
2377 temp |= XHCI_EPCTX_1_EPTYPE_SET(3);
2381 /* check for IN direction */
2383 temp |= XHCI_EPCTX_1_EPTYPE_SET(4);
2385 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx1, temp);
2387 ring_addr |= XHCI_EPCTX_2_DCS_SET(1);
2389 xhci_ctx_set_le64(sc, &pinp->ctx_ep[epno - 1].qwEpCtx2, ring_addr);
2391 switch (edesc->bmAttributes & UE_XFERTYPE) {
2393 case UE_ISOCHRONOUS:
2394 temp = XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_SET(max_frame_size) |
2395 XHCI_EPCTX_4_AVG_TRB_LEN_SET(MIN(XHCI_PAGE_SIZE,
2399 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(8);
2402 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(XHCI_PAGE_SIZE);
2406 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx4, temp);
2409 xhci_dump_endpoint(sc, &pinp->ctx_ep[epno - 1]);
2411 usb_pc_cpu_flush(&sc->sc_hw.devs[index].input_pc);
2413 return (0); /* success */
2417 xhci_configure_endpoint_by_xfer(struct usb_xfer *xfer)
2419 struct xhci_endpoint_ext *pepext;
2420 struct usb_endpoint_ss_comp_descriptor *ecomp;
2422 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2423 xfer->endpoint->edesc);
2425 ecomp = xfer->endpoint->ecomp;
2427 pepext->trb[0].dwTrb3 = 0; /* halt any transfers */
2428 usb_pc_cpu_flush(pepext->page_cache);
2430 return (xhci_configure_endpoint(xfer->xroot->udev,
2431 xfer->endpoint->edesc, pepext->physaddr,
2432 xfer->interval, xfer->max_packet_count,
2433 (ecomp != NULL) ? (ecomp->bmAttributes & 3) + 1 : 1,
2434 usbd_xfer_get_fps_shift(xfer), xfer->max_packet_size,
2435 xfer->max_frame_size));
2439 xhci_configure_device(struct usb_device *udev)
2441 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2442 struct usb_page_search buf_inp;
2443 struct usb_page_cache *pcinp;
2444 struct xhci_input_dev_ctx *pinp;
2445 struct usb_device *hubdev;
2453 index = udev->controller_slot_id;
2455 DPRINTF("index=%u\n", index);
2457 pcinp = &sc->sc_hw.devs[index].input_pc;
2459 usbd_get_page(pcinp, 0, &buf_inp);
2461 pinp = buf_inp.buffer;
2466 /* figure out route string and root HUB port number */
2468 for (hubdev = udev; hubdev != NULL; hubdev = hubdev->parent_hub) {
2470 if (hubdev->parent_hub == NULL)
2473 depth = hubdev->parent_hub->depth;
2476 * NOTE: HS/FS/LS devices and the SS root HUB can have
2477 * more than 15 ports
2480 rh_port = hubdev->port_no;
2489 route |= rh_port << (4 * (depth - 1));
2492 DPRINTF("Route=0x%08x\n", route);
2494 temp = XHCI_SCTX_0_ROUTE_SET(route) |
2495 XHCI_SCTX_0_CTX_NUM_SET(
2496 sc->sc_hw.devs[index].context_num + 1);
2498 switch (udev->speed) {
2500 temp |= XHCI_SCTX_0_SPEED_SET(2);
2501 if (udev->parent_hs_hub != NULL &&
2502 udev->parent_hs_hub->ddesc.bDeviceProtocol ==
2504 DPRINTF("Device inherits MTT\n");
2505 temp |= XHCI_SCTX_0_MTT_SET(1);
2508 case USB_SPEED_HIGH:
2509 temp |= XHCI_SCTX_0_SPEED_SET(3);
2510 if (sc->sc_hw.devs[index].nports != 0 &&
2511 udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) {
2512 DPRINTF("HUB supports MTT\n");
2513 temp |= XHCI_SCTX_0_MTT_SET(1);
2516 case USB_SPEED_FULL:
2517 temp |= XHCI_SCTX_0_SPEED_SET(1);
2518 if (udev->parent_hs_hub != NULL &&
2519 udev->parent_hs_hub->ddesc.bDeviceProtocol ==
2521 DPRINTF("Device inherits MTT\n");
2522 temp |= XHCI_SCTX_0_MTT_SET(1);
2526 temp |= XHCI_SCTX_0_SPEED_SET(4);
2530 is_hub = sc->sc_hw.devs[index].nports != 0 &&
2531 (udev->speed == USB_SPEED_SUPER ||
2532 udev->speed == USB_SPEED_HIGH);
2535 temp |= XHCI_SCTX_0_HUB_SET(1);
2537 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp);
2539 temp = XHCI_SCTX_1_RH_PORT_SET(rh_port);
2542 temp |= XHCI_SCTX_1_NUM_PORTS_SET(
2543 sc->sc_hw.devs[index].nports);
2546 switch (udev->speed) {
2547 case USB_SPEED_SUPER:
2548 switch (sc->sc_hw.devs[index].state) {
2549 case XHCI_ST_ADDRESSED:
2550 case XHCI_ST_CONFIGURED:
2551 /* enable power save */
2552 temp |= XHCI_SCTX_1_MAX_EL_SET(sc->sc_exit_lat_max);
2555 /* disable power save */
2563 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx1, temp);
2565 temp = XHCI_SCTX_2_IRQ_TARGET_SET(0);
2568 temp |= XHCI_SCTX_2_TT_THINK_TIME_SET(
2569 sc->sc_hw.devs[index].tt);
2572 hubdev = udev->parent_hs_hub;
2574 /* check if we should activate the transaction translator */
2575 switch (udev->speed) {
2576 case USB_SPEED_FULL:
2578 if (hubdev != NULL) {
2579 temp |= XHCI_SCTX_2_TT_HUB_SID_SET(
2580 hubdev->controller_slot_id);
2581 temp |= XHCI_SCTX_2_TT_PORT_NUM_SET(
2589 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx2, temp);
2592 * These fields should be initialized to zero, according to
2593 * XHCI section 6.2.2 - slot context:
2595 temp = XHCI_SCTX_3_DEV_ADDR_SET(0) |
2596 XHCI_SCTX_3_SLOT_STATE_SET(0);
2598 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx3, temp);
2601 xhci_dump_device(sc, &pinp->ctx_slot);
2603 usb_pc_cpu_flush(pcinp);
2605 return (0); /* success */
2609 xhci_alloc_device_ext(struct usb_device *udev)
2611 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2612 struct usb_page_search buf_dev;
2613 struct usb_page_search buf_ep;
2614 struct xhci_trb *trb;
2615 struct usb_page_cache *pc;
2616 struct usb_page *pg;
2621 index = udev->controller_slot_id;
2623 pc = &sc->sc_hw.devs[index].device_pc;
2624 pg = &sc->sc_hw.devs[index].device_pg;
2626 /* need to initialize the page cache */
2627 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2629 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ?
2630 (2 * sizeof(struct xhci_dev_ctx)) :
2631 sizeof(struct xhci_dev_ctx), XHCI_PAGE_SIZE))
2634 usbd_get_page(pc, 0, &buf_dev);
2636 pc = &sc->sc_hw.devs[index].input_pc;
2637 pg = &sc->sc_hw.devs[index].input_pg;
2639 /* need to initialize the page cache */
2640 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2642 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ?
2643 (2 * sizeof(struct xhci_input_dev_ctx)) :
2644 sizeof(struct xhci_input_dev_ctx), XHCI_PAGE_SIZE)) {
2648 pc = &sc->sc_hw.devs[index].endpoint_pc;
2649 pg = &sc->sc_hw.devs[index].endpoint_pg;
2651 /* need to initialize the page cache */
2652 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2654 if (usb_pc_alloc_mem(pc, pg,
2655 sizeof(struct xhci_dev_endpoint_trbs), XHCI_PAGE_SIZE)) {
2659 /* initialise all endpoint LINK TRBs */
2661 for (i = 0; i != XHCI_MAX_ENDPOINTS; i++) {
2663 /* lookup endpoint TRB ring */
2664 usbd_get_page(pc, (uintptr_t)&
2665 ((struct xhci_dev_endpoint_trbs *)0)->trb[i][0], &buf_ep);
2667 /* get TRB pointer */
2668 trb = buf_ep.buffer;
2669 trb += XHCI_MAX_TRANSFERS - 1;
2671 /* get TRB start address */
2672 addr = buf_ep.physaddr;
2674 /* create LINK TRB */
2675 trb->qwTrb0 = htole64(addr);
2676 trb->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2677 trb->dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT |
2678 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2681 usb_pc_cpu_flush(pc);
2683 xhci_set_slot_pointer(sc, index, buf_dev.physaddr);
2688 xhci_free_device_ext(udev);
2690 return (USB_ERR_NOMEM);
2694 xhci_free_device_ext(struct usb_device *udev)
2696 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2699 index = udev->controller_slot_id;
2700 xhci_set_slot_pointer(sc, index, 0);
2702 usb_pc_free_mem(&sc->sc_hw.devs[index].device_pc);
2703 usb_pc_free_mem(&sc->sc_hw.devs[index].input_pc);
2704 usb_pc_free_mem(&sc->sc_hw.devs[index].endpoint_pc);
2707 static struct xhci_endpoint_ext *
2708 xhci_get_endpoint_ext(struct usb_device *udev, struct usb_endpoint_descriptor *edesc)
2710 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2711 struct xhci_endpoint_ext *pepext;
2712 struct usb_page_cache *pc;
2713 struct usb_page_search buf_ep;
2717 epno = edesc->bEndpointAddress;
2718 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL)
2721 epno = XHCI_EPNO2EPID(epno);
2723 index = udev->controller_slot_id;
2725 pc = &sc->sc_hw.devs[index].endpoint_pc;
2727 usbd_get_page(pc, (uintptr_t)&((struct xhci_dev_endpoint_trbs *)0)->trb[epno][0], &buf_ep);
2729 pepext = &sc->sc_hw.devs[index].endp[epno];
2730 pepext->page_cache = pc;
2731 pepext->trb = buf_ep.buffer;
2732 pepext->physaddr = buf_ep.physaddr;
2738 xhci_endpoint_doorbell(struct usb_xfer *xfer)
2740 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
2744 epno = xfer->endpointno;
2745 if (xfer->flags_int.control_xfr)
2748 epno = XHCI_EPNO2EPID(epno);
2749 index = xfer->xroot->udev->controller_slot_id;
2751 if (xfer->xroot->udev->flags.self_suspended == 0) {
2752 XWRITE4(sc, door, XHCI_DOORBELL(index),
2753 epno | XHCI_DB_SID_SET(/*xfer->stream_id*/ 0));
2758 xhci_transfer_remove(struct usb_xfer *xfer, usb_error_t error)
2760 struct xhci_endpoint_ext *pepext;
2762 if (xfer->flags_int.bandwidth_reclaimed) {
2763 xfer->flags_int.bandwidth_reclaimed = 0;
2765 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2766 xfer->endpoint->edesc);
2770 pepext->xfer[xfer->qh_pos] = NULL;
2772 if (error && pepext->trb_running != 0) {
2773 pepext->trb_halted = 1;
2774 pepext->trb_running = 0;
2780 xhci_transfer_insert(struct usb_xfer *xfer)
2782 struct xhci_td *td_first;
2783 struct xhci_td *td_last;
2784 struct xhci_trb *trb_link;
2785 struct xhci_endpoint_ext *pepext;
2793 /* check if already inserted */
2794 if (xfer->flags_int.bandwidth_reclaimed) {
2795 DPRINTFN(8, "Already in schedule\n");
2799 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2800 xfer->endpoint->edesc);
2802 td_first = xfer->td_transfer_first;
2803 td_last = xfer->td_transfer_last;
2804 addr = pepext->physaddr;
2806 switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
2809 /* single buffered */
2813 /* multi buffered */
2814 trb_limit = (XHCI_MAX_TRANSFERS - 2);
2818 if (pepext->trb_used >= trb_limit) {
2819 DPRINTFN(8, "Too many TDs queued.\n");
2820 return (USB_ERR_NOMEM);
2823 /* check for stopped condition, after putting transfer on interrupt queue */
2824 if (pepext->trb_running == 0) {
2825 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
2827 DPRINTFN(8, "Not running\n");
2829 /* start configuration */
2830 (void)usb_proc_msignal(&sc->sc_config_proc,
2831 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2837 /* get current TRB index */
2838 i = pepext->trb_index;
2840 /* get next TRB index */
2843 /* the last entry of the ring is a hardcoded link TRB */
2844 if (inext >= (XHCI_MAX_TRANSFERS - 1))
2847 /* compute terminating return address */
2848 addr += inext * sizeof(struct xhci_trb);
2850 /* compute link TRB pointer */
2851 trb_link = td_last->td_trb + td_last->ntrb;
2853 /* update next pointer of last link TRB */
2854 trb_link->qwTrb0 = htole64(addr);
2855 trb_link->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2856 trb_link->dwTrb3 = htole32(XHCI_TRB_3_IOC_BIT |
2857 XHCI_TRB_3_CYCLE_BIT |
2858 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2861 xhci_dump_trb(&td_last->td_trb[td_last->ntrb]);
2863 usb_pc_cpu_flush(td_last->page_cache);
2865 /* write ahead chain end marker */
2867 pepext->trb[inext].qwTrb0 = 0;
2868 pepext->trb[inext].dwTrb2 = 0;
2869 pepext->trb[inext].dwTrb3 = 0;
2871 /* update next pointer of link TRB */
2873 pepext->trb[i].qwTrb0 = htole64((uint64_t)td_first->td_self);
2874 pepext->trb[i].dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2877 xhci_dump_trb(&pepext->trb[i]);
2879 usb_pc_cpu_flush(pepext->page_cache);
2881 /* toggle cycle bit which activates the transfer chain */
2883 pepext->trb[i].dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT |
2884 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2886 usb_pc_cpu_flush(pepext->page_cache);
2888 DPRINTF("qh_pos = %u\n", i);
2890 pepext->xfer[i] = xfer;
2894 xfer->flags_int.bandwidth_reclaimed = 1;
2896 pepext->trb_index = inext;
2898 xhci_endpoint_doorbell(xfer);
2904 xhci_root_intr(struct xhci_softc *sc)
2908 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
2910 /* clear any old interrupt data */
2911 memset(sc->sc_hub_idata, 0, sizeof(sc->sc_hub_idata));
2913 for (i = 1; i <= sc->sc_noport; i++) {
2914 /* pick out CHANGE bits from the status register */
2915 if (XREAD4(sc, oper, XHCI_PORTSC(i)) & (
2916 XHCI_PS_CSC | XHCI_PS_PEC |
2917 XHCI_PS_OCC | XHCI_PS_WRC |
2918 XHCI_PS_PRC | XHCI_PS_PLC |
2920 sc->sc_hub_idata[i / 8] |= 1 << (i % 8);
2921 DPRINTF("port %d changed\n", i);
2924 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata,
2925 sizeof(sc->sc_hub_idata));
2928 /*------------------------------------------------------------------------*
2929 * xhci_device_done - XHCI done handler
2931 * NOTE: This function can be called two times in a row on
2932 * the same USB transfer. From close and from interrupt.
2933 *------------------------------------------------------------------------*/
2935 xhci_device_done(struct usb_xfer *xfer, usb_error_t error)
2937 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n",
2938 xfer, xfer->endpoint, error);
2940 /* remove transfer from HW queue */
2941 xhci_transfer_remove(xfer, error);
2943 /* dequeue transfer and start next transfer */
2944 usbd_transfer_done(xfer, error);
2947 /*------------------------------------------------------------------------*
2948 * XHCI data transfer support (generic type)
2949 *------------------------------------------------------------------------*/
2951 xhci_device_generic_open(struct usb_xfer *xfer)
2953 if (xfer->flags_int.isochronous_xfr) {
2954 switch (xfer->xroot->udev->speed) {
2955 case USB_SPEED_FULL:
2958 usb_hs_bandwidth_alloc(xfer);
2965 xhci_device_generic_close(struct usb_xfer *xfer)
2969 xhci_device_done(xfer, USB_ERR_CANCELLED);
2971 if (xfer->flags_int.isochronous_xfr) {
2972 switch (xfer->xroot->udev->speed) {
2973 case USB_SPEED_FULL:
2976 usb_hs_bandwidth_free(xfer);
2983 xhci_device_generic_multi_enter(struct usb_endpoint *ep,
2984 struct usb_xfer *enter_xfer)
2986 struct usb_xfer *xfer;
2988 /* check if there is a current transfer */
2989 xfer = ep->endpoint_q.curr;
2994 * Check if the current transfer is started and then pickup
2995 * the next one, if any. Else wait for next start event due to
2996 * block on failure feature.
2998 if (!xfer->flags_int.bandwidth_reclaimed)
3001 xfer = TAILQ_FIRST(&ep->endpoint_q.head);
3004 * In case of enter we have to consider that the
3005 * transfer is queued by the USB core after the enter
3014 /* try to multi buffer */
3015 xhci_transfer_insert(xfer);
3019 xhci_device_generic_enter(struct usb_xfer *xfer)
3023 /* setup TD's and QH */
3024 xhci_setup_generic_chain(xfer);
3026 xhci_device_generic_multi_enter(xfer->endpoint, xfer);
3030 xhci_device_generic_start(struct usb_xfer *xfer)
3034 /* try to insert xfer on HW queue */
3035 xhci_transfer_insert(xfer);
3037 /* try to multi buffer */
3038 xhci_device_generic_multi_enter(xfer->endpoint, NULL);
3040 /* add transfer last on interrupt queue */
3041 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer);
3043 /* start timeout, if any */
3044 if (xfer->timeout != 0)
3045 usbd_transfer_timeout_ms(xfer, &xhci_timeout, xfer->timeout);
3048 struct usb_pipe_methods xhci_device_generic_methods =
3050 .open = xhci_device_generic_open,
3051 .close = xhci_device_generic_close,
3052 .enter = xhci_device_generic_enter,
3053 .start = xhci_device_generic_start,
3056 /*------------------------------------------------------------------------*
3057 * xhci root HUB support
3058 *------------------------------------------------------------------------*
3059 * Simulate a hardware HUB by handling all the necessary requests.
3060 *------------------------------------------------------------------------*/
3062 #define HSETW(ptr, val) ptr = { (uint8_t)(val), (uint8_t)((val) >> 8) }
3065 struct usb_device_descriptor xhci_devd =
3067 .bLength = sizeof(xhci_devd),
3068 .bDescriptorType = UDESC_DEVICE, /* type */
3069 HSETW(.bcdUSB, 0x0300), /* USB version */
3070 .bDeviceClass = UDCLASS_HUB, /* class */
3071 .bDeviceSubClass = UDSUBCLASS_HUB, /* subclass */
3072 .bDeviceProtocol = UDPROTO_SSHUB, /* protocol */
3073 .bMaxPacketSize = 9, /* max packet size */
3074 HSETW(.idVendor, 0x0000), /* vendor */
3075 HSETW(.idProduct, 0x0000), /* product */
3076 HSETW(.bcdDevice, 0x0100), /* device version */
3080 .bNumConfigurations = 1, /* # of configurations */
3084 struct xhci_bos_desc xhci_bosd = {
3086 .bLength = sizeof(xhci_bosd.bosd),
3087 .bDescriptorType = UDESC_BOS,
3088 HSETW(.wTotalLength, sizeof(xhci_bosd)),
3089 .bNumDeviceCaps = 3,
3092 .bLength = sizeof(xhci_bosd.usb2extd),
3093 .bDescriptorType = 1,
3094 .bDevCapabilityType = 2,
3095 .bmAttributes[0] = 2,
3098 .bLength = sizeof(xhci_bosd.usbdcd),
3099 .bDescriptorType = UDESC_DEVICE_CAPABILITY,
3100 .bDevCapabilityType = 3,
3101 .bmAttributes = 0, /* XXX */
3102 HSETW(.wSpeedsSupported, 0x000C),
3103 .bFunctionalitySupport = 8,
3104 .bU1DevExitLat = 255, /* dummy - not used */
3105 .wU2DevExitLat = { 0x00, 0x08 },
3108 .bLength = sizeof(xhci_bosd.cidd),
3109 .bDescriptorType = 1,
3110 .bDevCapabilityType = 4,
3112 .bContainerID = 0, /* XXX */
3117 struct xhci_config_desc xhci_confd = {
3119 .bLength = sizeof(xhci_confd.confd),
3120 .bDescriptorType = UDESC_CONFIG,
3121 .wTotalLength[0] = sizeof(xhci_confd),
3123 .bConfigurationValue = 1,
3124 .iConfiguration = 0,
3125 .bmAttributes = UC_SELF_POWERED,
3126 .bMaxPower = 0 /* max power */
3129 .bLength = sizeof(xhci_confd.ifcd),
3130 .bDescriptorType = UDESC_INTERFACE,
3132 .bInterfaceClass = UICLASS_HUB,
3133 .bInterfaceSubClass = UISUBCLASS_HUB,
3134 .bInterfaceProtocol = 0,
3137 .bLength = sizeof(xhci_confd.endpd),
3138 .bDescriptorType = UDESC_ENDPOINT,
3139 .bEndpointAddress = UE_DIR_IN | XHCI_INTR_ENDPT,
3140 .bmAttributes = UE_INTERRUPT,
3141 .wMaxPacketSize[0] = 2, /* max 15 ports */
3145 .bLength = sizeof(xhci_confd.endpcd),
3146 .bDescriptorType = UDESC_ENDPOINT_SS_COMP,
3153 struct usb_hub_ss_descriptor xhci_hubd = {
3154 .bLength = sizeof(xhci_hubd),
3155 .bDescriptorType = UDESC_SS_HUB,
3159 xhci_roothub_exec(struct usb_device *udev,
3160 struct usb_device_request *req, const void **pptr, uint16_t *plength)
3162 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
3163 const char *str_ptr;
3174 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
3177 ptr = (const void *)&sc->sc_hub_desc;
3181 value = UGETW(req->wValue);
3182 index = UGETW(req->wIndex);
3184 DPRINTFN(3, "type=0x%02x request=0x%02x wLen=0x%04x "
3185 "wValue=0x%04x wIndex=0x%04x\n",
3186 req->bmRequestType, req->bRequest,
3187 UGETW(req->wLength), value, index);
3189 #define C(x,y) ((x) | ((y) << 8))
3190 switch (C(req->bRequest, req->bmRequestType)) {
3191 case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
3192 case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
3193 case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
3195 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
3196 * for the integrated root hub.
3199 case C(UR_GET_CONFIG, UT_READ_DEVICE):
3201 sc->sc_hub_desc.temp[0] = sc->sc_conf;
3203 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
3204 switch (value >> 8) {
3206 if ((value & 0xff) != 0) {
3207 err = USB_ERR_IOERROR;
3210 len = sizeof(xhci_devd);
3211 ptr = (const void *)&xhci_devd;
3215 if ((value & 0xff) != 0) {
3216 err = USB_ERR_IOERROR;
3219 len = sizeof(xhci_bosd);
3220 ptr = (const void *)&xhci_bosd;
3224 if ((value & 0xff) != 0) {
3225 err = USB_ERR_IOERROR;
3228 len = sizeof(xhci_confd);
3229 ptr = (const void *)&xhci_confd;
3233 switch (value & 0xff) {
3234 case 0: /* Language table */
3238 case 1: /* Vendor */
3239 str_ptr = sc->sc_vendor;
3242 case 2: /* Product */
3243 str_ptr = "XHCI root HUB";
3251 len = usb_make_str_desc(
3252 sc->sc_hub_desc.temp,
3253 sizeof(sc->sc_hub_desc.temp),
3258 err = USB_ERR_IOERROR;
3262 case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
3264 sc->sc_hub_desc.temp[0] = 0;
3266 case C(UR_GET_STATUS, UT_READ_DEVICE):
3268 USETW(sc->sc_hub_desc.stat.wStatus, UDS_SELF_POWERED);
3270 case C(UR_GET_STATUS, UT_READ_INTERFACE):
3271 case C(UR_GET_STATUS, UT_READ_ENDPOINT):
3273 USETW(sc->sc_hub_desc.stat.wStatus, 0);
3275 case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
3276 if (value >= XHCI_MAX_DEVICES) {
3277 err = USB_ERR_IOERROR;
3281 case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
3282 if (value != 0 && value != 1) {
3283 err = USB_ERR_IOERROR;
3286 sc->sc_conf = value;
3288 case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
3290 case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
3291 case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
3292 case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
3293 err = USB_ERR_IOERROR;
3295 case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
3297 case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
3300 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
3302 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
3303 DPRINTFN(9, "UR_CLEAR_PORT_FEATURE\n");
3306 (index > sc->sc_noport)) {
3307 err = USB_ERR_IOERROR;
3310 port = XHCI_PORTSC(index);
3312 v = XREAD4(sc, oper, port);
3313 i = XHCI_PS_PLS_GET(v);
3314 v &= ~XHCI_PS_CLEAR;
3317 case UHF_C_BH_PORT_RESET:
3318 XWRITE4(sc, oper, port, v | XHCI_PS_WRC);
3320 case UHF_C_PORT_CONFIG_ERROR:
3321 XWRITE4(sc, oper, port, v | XHCI_PS_CEC);
3323 case UHF_C_PORT_SUSPEND:
3324 case UHF_C_PORT_LINK_STATE:
3325 XWRITE4(sc, oper, port, v | XHCI_PS_PLC);
3327 case UHF_C_PORT_CONNECTION:
3328 XWRITE4(sc, oper, port, v | XHCI_PS_CSC);
3330 case UHF_C_PORT_ENABLE:
3331 XWRITE4(sc, oper, port, v | XHCI_PS_PEC);
3333 case UHF_C_PORT_OVER_CURRENT:
3334 XWRITE4(sc, oper, port, v | XHCI_PS_OCC);
3336 case UHF_C_PORT_RESET:
3337 XWRITE4(sc, oper, port, v | XHCI_PS_PRC);
3339 case UHF_PORT_ENABLE:
3340 XWRITE4(sc, oper, port, v | XHCI_PS_PED);
3342 case UHF_PORT_POWER:
3343 XWRITE4(sc, oper, port, v & ~XHCI_PS_PP);
3345 case UHF_PORT_INDICATOR:
3346 XWRITE4(sc, oper, port, v & ~XHCI_PS_PIC_SET(3));
3348 case UHF_PORT_SUSPEND:
3352 XWRITE4(sc, oper, port, v |
3353 XHCI_PS_PLS_SET(0xF) | XHCI_PS_LWS);
3356 /* wait 20ms for resume sequence to complete */
3357 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 50);
3360 XWRITE4(sc, oper, port, v |
3361 XHCI_PS_PLS_SET(0) | XHCI_PS_LWS);
3364 err = USB_ERR_IOERROR;
3369 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
3370 if ((value & 0xff) != 0) {
3371 err = USB_ERR_IOERROR;
3375 v = XREAD4(sc, capa, XHCI_HCSPARAMS0);
3377 sc->sc_hub_desc.hubd = xhci_hubd;
3379 sc->sc_hub_desc.hubd.bNbrPorts = sc->sc_noport;
3381 if (XHCI_HCS0_PPC(v))
3382 i = UHD_PWR_INDIVIDUAL;
3386 if (XHCI_HCS0_PIND(v))
3389 i |= UHD_OC_INDIVIDUAL;
3391 USETW(sc->sc_hub_desc.hubd.wHubCharacteristics, i);
3393 /* see XHCI section 5.4.9: */
3394 sc->sc_hub_desc.hubd.bPwrOn2PwrGood = 10;
3396 for (j = 1; j <= sc->sc_noport; j++) {
3398 v = XREAD4(sc, oper, XHCI_PORTSC(j));
3399 if (v & XHCI_PS_DR) {
3400 sc->sc_hub_desc.hubd.
3401 DeviceRemovable[j / 8] |= 1U << (j % 8);
3404 len = sc->sc_hub_desc.hubd.bLength;
3407 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
3409 memset(sc->sc_hub_desc.temp, 0, 16);
3412 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
3413 DPRINTFN(9, "UR_GET_STATUS i=%d\n", index);
3416 (index > sc->sc_noport)) {
3417 err = USB_ERR_IOERROR;
3421 v = XREAD4(sc, oper, XHCI_PORTSC(index));
3423 DPRINTFN(9, "port status=0x%08x\n", v);
3425 i = UPS_PORT_LINK_STATE_SET(XHCI_PS_PLS_GET(v));
3427 switch (XHCI_PS_SPEED_GET(v)) {
3429 i |= UPS_HIGH_SPEED;
3438 i |= UPS_OTHER_SPEED;
3442 if (v & XHCI_PS_CCS)
3443 i |= UPS_CURRENT_CONNECT_STATUS;
3444 if (v & XHCI_PS_PED)
3445 i |= UPS_PORT_ENABLED;
3446 if (v & XHCI_PS_OCA)
3447 i |= UPS_OVERCURRENT_INDICATOR;
3450 if (v & XHCI_PS_PP) {
3452 * The USB 3.0 RH is using the
3453 * USB 2.0's power bit
3455 i |= UPS_PORT_POWER;
3457 USETW(sc->sc_hub_desc.ps.wPortStatus, i);
3460 if (v & XHCI_PS_CSC)
3461 i |= UPS_C_CONNECT_STATUS;
3462 if (v & XHCI_PS_PEC)
3463 i |= UPS_C_PORT_ENABLED;
3464 if (v & XHCI_PS_OCC)
3465 i |= UPS_C_OVERCURRENT_INDICATOR;
3466 if (v & XHCI_PS_WRC)
3467 i |= UPS_C_BH_PORT_RESET;
3468 if (v & XHCI_PS_PRC)
3469 i |= UPS_C_PORT_RESET;
3470 if (v & XHCI_PS_PLC)
3471 i |= UPS_C_PORT_LINK_STATE;
3472 if (v & XHCI_PS_CEC)
3473 i |= UPS_C_PORT_CONFIG_ERROR;
3475 USETW(sc->sc_hub_desc.ps.wPortChange, i);
3476 len = sizeof(sc->sc_hub_desc.ps);
3479 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
3480 err = USB_ERR_IOERROR;
3483 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
3486 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
3492 (index > sc->sc_noport)) {
3493 err = USB_ERR_IOERROR;
3497 port = XHCI_PORTSC(index);
3498 v = XREAD4(sc, oper, port) & ~XHCI_PS_CLEAR;
3501 case UHF_PORT_U1_TIMEOUT:
3502 if (XHCI_PS_SPEED_GET(v) != 4) {
3503 err = USB_ERR_IOERROR;
3506 port = XHCI_PORTPMSC(index);
3507 v = XREAD4(sc, oper, port);
3508 v &= ~XHCI_PM3_U1TO_SET(0xFF);
3509 v |= XHCI_PM3_U1TO_SET(i);
3510 XWRITE4(sc, oper, port, v);
3512 case UHF_PORT_U2_TIMEOUT:
3513 if (XHCI_PS_SPEED_GET(v) != 4) {
3514 err = USB_ERR_IOERROR;
3517 port = XHCI_PORTPMSC(index);
3518 v = XREAD4(sc, oper, port);
3519 v &= ~XHCI_PM3_U2TO_SET(0xFF);
3520 v |= XHCI_PM3_U2TO_SET(i);
3521 XWRITE4(sc, oper, port, v);
3523 case UHF_BH_PORT_RESET:
3524 XWRITE4(sc, oper, port, v | XHCI_PS_WPR);
3526 case UHF_PORT_LINK_STATE:
3527 XWRITE4(sc, oper, port, v |
3528 XHCI_PS_PLS_SET(i) | XHCI_PS_LWS);
3529 /* 4ms settle time */
3530 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 250);
3532 case UHF_PORT_ENABLE:
3533 DPRINTFN(3, "set port enable %d\n", index);
3535 case UHF_PORT_SUSPEND:
3536 DPRINTFN(6, "suspend port %u (LPM=%u)\n", index, i);
3537 j = XHCI_PS_SPEED_GET(v);
3538 if ((j < 1) || (j > 3)) {
3539 /* non-supported speed */
3540 err = USB_ERR_IOERROR;
3543 XWRITE4(sc, oper, port, v |
3544 XHCI_PS_PLS_SET(i ? 2 /* LPM */ : 3) | XHCI_PS_LWS);
3546 case UHF_PORT_RESET:
3547 DPRINTFN(6, "reset port %d\n", index);
3548 XWRITE4(sc, oper, port, v | XHCI_PS_PR);
3550 case UHF_PORT_POWER:
3551 DPRINTFN(3, "set port power %d\n", index);
3552 XWRITE4(sc, oper, port, v | XHCI_PS_PP);
3555 DPRINTFN(3, "set port test %d\n", index);
3557 case UHF_PORT_INDICATOR:
3558 DPRINTFN(3, "set port indicator %d\n", index);
3560 v &= ~XHCI_PS_PIC_SET(3);
3561 v |= XHCI_PS_PIC_SET(1);
3563 XWRITE4(sc, oper, port, v);
3566 err = USB_ERR_IOERROR;
3571 case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER):
3572 case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER):
3573 case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER):
3574 case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER):
3577 err = USB_ERR_IOERROR;
3587 xhci_xfer_setup(struct usb_setup_params *parm)
3589 struct usb_page_search page_info;
3590 struct usb_page_cache *pc;
3591 struct xhci_softc *sc;
3592 struct usb_xfer *xfer;
3597 sc = XHCI_BUS2SC(parm->udev->bus);
3598 xfer = parm->curr_xfer;
3601 * The proof for the "ntd" formula is illustrated like this:
3603 * +------------------------------------+
3607 * | | xxx | x | frm 0 |
3609 * | | xxx | xx | frm 1 |
3612 * +------------------------------------+
3614 * "xxx" means a completely full USB transfer descriptor
3616 * "x" and "xx" means a short USB packet
3618 * For the remainder of an USB transfer modulo
3619 * "max_data_length" we need two USB transfer descriptors.
3620 * One to transfer the remaining data and one to finalise with
3621 * a zero length packet in case the "force_short_xfer" flag is
3622 * set. We only need two USB transfer descriptors in the case
3623 * where the transfer length of the first one is a factor of
3624 * "max_frame_size". The rest of the needed USB transfer
3625 * descriptors is given by the buffer size divided by the
3626 * maximum data payload.
3628 parm->hc_max_packet_size = 0x400;
3629 parm->hc_max_packet_count = 16 * 3;
3630 parm->hc_max_frame_size = XHCI_TD_PAYLOAD_MAX;
3632 xfer->flags_int.bdma_enable = 1;
3634 usbd_transfer_setup_sub(parm);
3636 if (xfer->flags_int.isochronous_xfr) {
3637 ntd = ((1 * xfer->nframes)
3638 + (xfer->max_data_length / xfer->max_hc_frame_size));
3639 } else if (xfer->flags_int.control_xfr) {
3640 ntd = ((2 * xfer->nframes) + 1 /* STATUS */
3641 + (xfer->max_data_length / xfer->max_hc_frame_size));
3643 ntd = ((2 * xfer->nframes)
3644 + (xfer->max_data_length / xfer->max_hc_frame_size));
3653 * Allocate queue heads and transfer descriptors
3657 if (usbd_transfer_setup_sub_malloc(
3658 parm, &pc, sizeof(struct xhci_td),
3659 XHCI_TD_ALIGN, ntd)) {
3660 parm->err = USB_ERR_NOMEM;
3664 for (n = 0; n != ntd; n++) {
3667 usbd_get_page(pc + n, 0, &page_info);
3669 td = page_info.buffer;
3672 td->td_self = page_info.physaddr;
3673 td->obj_next = last_obj;
3674 td->page_cache = pc + n;
3678 usb_pc_cpu_flush(pc + n);
3681 xfer->td_start[xfer->flags_int.curr_dma_set] = last_obj;
3683 if (!xfer->flags_int.curr_dma_set) {
3684 xfer->flags_int.curr_dma_set = 1;
3690 xhci_configure_reset_endpoint(struct usb_xfer *xfer)
3692 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
3693 struct usb_page_search buf_inp;
3694 struct usb_device *udev;
3695 struct xhci_endpoint_ext *pepext;
3696 struct usb_endpoint_descriptor *edesc;
3697 struct usb_page_cache *pcinp;
3702 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
3703 xfer->endpoint->edesc);
3705 udev = xfer->xroot->udev;
3706 index = udev->controller_slot_id;
3708 pcinp = &sc->sc_hw.devs[index].input_pc;
3710 usbd_get_page(pcinp, 0, &buf_inp);
3712 edesc = xfer->endpoint->edesc;
3714 epno = edesc->bEndpointAddress;
3716 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL)
3719 epno = XHCI_EPNO2EPID(epno);
3722 return (USB_ERR_NO_PIPE); /* invalid */
3726 /* configure endpoint */
3728 err = xhci_configure_endpoint_by_xfer(xfer);
3731 XHCI_CMD_UNLOCK(sc);
3736 * Get the endpoint into the stopped state according to the
3737 * endpoint context state diagram in the XHCI specification:
3740 err = xhci_cmd_stop_ep(sc, 0, epno, index);
3743 DPRINTF("Could not stop endpoint %u\n", epno);
3745 err = xhci_cmd_reset_ep(sc, 0, epno, index);
3748 DPRINTF("Could not reset endpoint %u\n", epno);
3750 err = xhci_cmd_set_tr_dequeue_ptr(sc, pepext->physaddr |
3751 XHCI_EPCTX_2_DCS_SET(1), 0, epno, index);
3754 DPRINTF("Could not set dequeue ptr for endpoint %u\n", epno);
3757 * Get the endpoint into the running state according to the
3758 * endpoint context state diagram in the XHCI specification:
3761 xhci_configure_mask(udev, (1U << epno) | 1U, 0);
3763 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index);
3766 DPRINTF("Could not configure endpoint %u\n", epno);
3768 err = xhci_cmd_configure_ep(sc, buf_inp.physaddr, 0, index);
3771 DPRINTF("Could not configure endpoint %u\n", epno);
3773 XHCI_CMD_UNLOCK(sc);
3779 xhci_xfer_unsetup(struct usb_xfer *xfer)
3785 xhci_start_dma_delay(struct usb_xfer *xfer)
3787 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
3789 /* put transfer on interrupt queue (again) */
3790 usbd_transfer_enqueue(&sc->sc_bus.intr_q, xfer);
3792 (void)usb_proc_msignal(&sc->sc_config_proc,
3793 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
3797 xhci_configure_msg(struct usb_proc_msg *pm)
3799 struct xhci_softc *sc;
3800 struct xhci_endpoint_ext *pepext;
3801 struct usb_xfer *xfer;
3803 sc = XHCI_BUS2SC(((struct usb_bus_msg *)pm)->bus);
3806 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3808 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
3809 xfer->endpoint->edesc);
3811 if ((pepext->trb_halted != 0) ||
3812 (pepext->trb_running == 0)) {
3816 /* clear halted and running */
3817 pepext->trb_halted = 0;
3818 pepext->trb_running = 0;
3820 /* nuke remaining buffered transfers */
3822 for (i = 0; i != (XHCI_MAX_TRANSFERS - 1); i++) {
3824 * NOTE: We need to use the timeout
3825 * error code here else existing
3826 * isochronous clients can get
3829 if (pepext->xfer[i] != NULL) {
3830 xhci_device_done(pepext->xfer[i],
3836 * NOTE: The USB transfer cannot vanish in
3840 USB_BUS_UNLOCK(&sc->sc_bus);
3842 xhci_configure_reset_endpoint(xfer);
3844 USB_BUS_LOCK(&sc->sc_bus);
3846 /* check if halted is still cleared */
3847 if (pepext->trb_halted == 0) {
3848 pepext->trb_running = 1;
3849 pepext->trb_index = 0;
3854 if (xfer->flags_int.did_dma_delay) {
3856 /* remove transfer from interrupt queue (again) */
3857 usbd_transfer_dequeue(xfer);
3859 /* we are finally done */
3860 usb_dma_delay_done_cb(xfer);
3862 /* queue changed - restart */
3867 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3869 /* try to insert xfer on HW queue */
3870 xhci_transfer_insert(xfer);
3872 /* try to multi buffer */
3873 xhci_device_generic_multi_enter(xfer->endpoint, NULL);
3878 xhci_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc,
3879 struct usb_endpoint *ep)
3881 struct xhci_endpoint_ext *pepext;
3883 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d\n",
3884 ep, udev->address, edesc->bEndpointAddress, udev->flags.usb_mode);
3886 if (udev->parent_hub == NULL) {
3887 /* root HUB has special endpoint handling */
3891 ep->methods = &xhci_device_generic_methods;
3893 pepext = xhci_get_endpoint_ext(udev, edesc);
3895 USB_BUS_LOCK(udev->bus);
3896 pepext->trb_halted = 1;
3897 pepext->trb_running = 0;
3898 USB_BUS_UNLOCK(udev->bus);
3902 xhci_ep_uninit(struct usb_device *udev, struct usb_endpoint *ep)
3908 xhci_ep_clear_stall(struct usb_device *udev, struct usb_endpoint *ep)
3910 struct xhci_endpoint_ext *pepext;
3914 if (udev->flags.usb_mode != USB_MODE_HOST) {
3918 if (udev->parent_hub == NULL) {
3919 /* root HUB has special endpoint handling */
3923 pepext = xhci_get_endpoint_ext(udev, ep->edesc);
3925 USB_BUS_LOCK(udev->bus);
3926 pepext->trb_halted = 1;
3927 pepext->trb_running = 0;
3928 USB_BUS_UNLOCK(udev->bus);
3932 xhci_device_init(struct usb_device *udev)
3934 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
3938 /* no init for root HUB */
3939 if (udev->parent_hub == NULL)
3944 /* set invalid default */
3946 udev->controller_slot_id = sc->sc_noslot + 1;
3948 /* try to get a new slot ID from the XHCI */
3950 err = xhci_cmd_enable_slot(sc, &temp);
3953 XHCI_CMD_UNLOCK(sc);
3957 if (temp > sc->sc_noslot) {
3958 XHCI_CMD_UNLOCK(sc);
3959 return (USB_ERR_BAD_ADDRESS);
3962 if (sc->sc_hw.devs[temp].state != XHCI_ST_DISABLED) {
3963 DPRINTF("slot %u already allocated.\n", temp);
3964 XHCI_CMD_UNLOCK(sc);
3965 return (USB_ERR_BAD_ADDRESS);
3968 /* store slot ID for later reference */
3970 udev->controller_slot_id = temp;
3972 /* reset data structure */
3974 memset(&sc->sc_hw.devs[temp], 0, sizeof(sc->sc_hw.devs[0]));
3976 /* set mark slot allocated */
3978 sc->sc_hw.devs[temp].state = XHCI_ST_ENABLED;
3980 err = xhci_alloc_device_ext(udev);
3982 XHCI_CMD_UNLOCK(sc);
3984 /* get device into default state */
3987 err = xhci_set_address(udev, NULL, 0);
3993 xhci_device_uninit(struct usb_device *udev)
3995 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
3998 /* no init for root HUB */
3999 if (udev->parent_hub == NULL)
4004 index = udev->controller_slot_id;
4006 if (index <= sc->sc_noslot) {
4007 xhci_cmd_disable_slot(sc, index);
4008 sc->sc_hw.devs[index].state = XHCI_ST_DISABLED;
4010 /* free device extension */
4011 xhci_free_device_ext(udev);
4014 XHCI_CMD_UNLOCK(sc);
4018 xhci_get_dma_delay(struct usb_device *udev, uint32_t *pus)
4021 * Wait until the hardware has finished any possible use of
4022 * the transfer descriptor(s)
4024 *pus = 2048; /* microseconds */
4028 xhci_device_resume(struct usb_device *udev)
4030 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4037 /* check for root HUB */
4038 if (udev->parent_hub == NULL)
4041 index = udev->controller_slot_id;
4045 /* blindly resume all endpoints */
4047 USB_BUS_LOCK(udev->bus);
4049 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) {
4050 for (p = 0; p != 1 /*XHCI_MAX_STREAMS*/; p++) {
4051 XWRITE4(sc, door, XHCI_DOORBELL(index),
4052 n | XHCI_DB_SID_SET(p));
4056 USB_BUS_UNLOCK(udev->bus);
4058 XHCI_CMD_UNLOCK(sc);
4062 xhci_device_suspend(struct usb_device *udev)
4064 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4071 /* check for root HUB */
4072 if (udev->parent_hub == NULL)
4075 index = udev->controller_slot_id;
4079 /* blindly suspend all endpoints */
4081 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) {
4082 err = xhci_cmd_stop_ep(sc, 1, n, index);
4084 DPRINTF("Failed to suspend endpoint "
4085 "%u on slot %u (ignored).\n", n, index);
4089 XHCI_CMD_UNLOCK(sc);
4093 xhci_set_hw_power(struct usb_bus *bus)
4099 xhci_device_state_change(struct usb_device *udev)
4101 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4102 struct usb_page_search buf_inp;
4106 /* check for root HUB */
4107 if (udev->parent_hub == NULL)
4110 index = udev->controller_slot_id;
4114 if (usb_get_device_state(udev) == USB_STATE_CONFIGURED) {
4115 err = uhub_query_info(udev, &sc->sc_hw.devs[index].nports,
4116 &sc->sc_hw.devs[index].tt);
4118 sc->sc_hw.devs[index].nports = 0;
4123 switch (usb_get_device_state(udev)) {
4124 case USB_STATE_POWERED:
4125 if (sc->sc_hw.devs[index].state == XHCI_ST_DEFAULT)
4128 /* set default state */
4129 sc->sc_hw.devs[index].state = XHCI_ST_DEFAULT;
4131 /* reset number of contexts */
4132 sc->sc_hw.devs[index].context_num = 0;
4134 err = xhci_cmd_reset_dev(sc, index);
4137 DPRINTF("Device reset failed "
4138 "for slot %u.\n", index);
4142 case USB_STATE_ADDRESSED:
4143 if (sc->sc_hw.devs[index].state == XHCI_ST_ADDRESSED)
4146 sc->sc_hw.devs[index].state = XHCI_ST_ADDRESSED;
4148 err = xhci_cmd_configure_ep(sc, 0, 1, index);
4151 DPRINTF("Failed to deconfigure "
4152 "slot %u.\n", index);
4156 case USB_STATE_CONFIGURED:
4157 if (sc->sc_hw.devs[index].state == XHCI_ST_CONFIGURED)
4160 /* set configured state */
4161 sc->sc_hw.devs[index].state = XHCI_ST_CONFIGURED;
4163 /* reset number of contexts */
4164 sc->sc_hw.devs[index].context_num = 0;
4166 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
4168 xhci_configure_mask(udev, 3, 0);
4170 err = xhci_configure_device(udev);
4172 DPRINTF("Could not configure device "
4173 "at slot %u.\n", index);
4176 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index);
4178 DPRINTF("Could not evaluate device "
4179 "context at slot %u.\n", index);
4186 XHCI_CMD_UNLOCK(sc);
4189 struct usb_bus_methods xhci_bus_methods = {
4190 .endpoint_init = xhci_ep_init,
4191 .endpoint_uninit = xhci_ep_uninit,
4192 .xfer_setup = xhci_xfer_setup,
4193 .xfer_unsetup = xhci_xfer_unsetup,
4194 .get_dma_delay = xhci_get_dma_delay,
4195 .device_init = xhci_device_init,
4196 .device_uninit = xhci_device_uninit,
4197 .device_resume = xhci_device_resume,
4198 .device_suspend = xhci_device_suspend,
4199 .set_hw_power = xhci_set_hw_power,
4200 .roothub_exec = xhci_roothub_exec,
4201 .xfer_poll = xhci_do_poll,
4202 .start_dma_delay = xhci_start_dma_delay,
4203 .set_address = xhci_set_address,
4204 .clear_stall = xhci_ep_clear_stall,
4205 .device_state_change = xhci_device_state_change,
4206 .set_hw_power_sleep = xhci_set_hw_power_sleep,