3 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * USB eXtensible Host Controller Interface, a.k.a. USB 3.0 controller.
30 * The XHCI 1.0 spec can be found at
31 * http://www.intel.com/technology/usb/download/xHCI_Specification_for_USB.pdf
32 * and the USB 3.0 spec at
33 * http://www.usb.org/developers/docs/usb_30_spec_060910.zip
37 * A few words about the design implementation: This driver emulates
38 * the concept about TDs which is found in EHCI specification. This
39 * way we achieve that the USB controller drivers look similar to
40 * eachother which makes it easier to understand the code.
43 #ifdef USB_GLOBAL_INCLUDE_FILE
44 #include USB_GLOBAL_INCLUDE_FILE
46 #include <sys/stdint.h>
47 #include <sys/stddef.h>
48 #include <sys/param.h>
49 #include <sys/queue.h>
50 #include <sys/types.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
54 #include <sys/module.h>
56 #include <sys/mutex.h>
57 #include <sys/condvar.h>
58 #include <sys/sysctl.h>
60 #include <sys/unistd.h>
61 #include <sys/callout.h>
62 #include <sys/malloc.h>
65 #include <dev/usb/usb.h>
66 #include <dev/usb/usbdi.h>
68 #define USB_DEBUG_VAR xhcidebug
70 #include <dev/usb/usb_core.h>
71 #include <dev/usb/usb_debug.h>
72 #include <dev/usb/usb_busdma.h>
73 #include <dev/usb/usb_process.h>
74 #include <dev/usb/usb_transfer.h>
75 #include <dev/usb/usb_device.h>
76 #include <dev/usb/usb_hub.h>
77 #include <dev/usb/usb_util.h>
79 #include <dev/usb/usb_controller.h>
80 #include <dev/usb/usb_bus.h>
81 #endif /* USB_GLOBAL_INCLUDE_FILE */
83 #include <dev/usb/controller/xhci.h>
84 #include <dev/usb/controller/xhcireg.h>
86 #define XHCI_BUS2SC(bus) \
87 ((struct xhci_softc *)(((uint8_t *)(bus)) - \
88 ((uint8_t *)&(((struct xhci_softc *)0)->sc_bus))))
90 static SYSCTL_NODE(_hw_usb, OID_AUTO, xhci, CTLFLAG_RW, 0, "USB XHCI");
92 static int xhcistreams;
93 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, streams, CTLFLAG_RW | CTLFLAG_TUN,
94 &xhcistreams, 0, "Set to enable streams mode support");
95 TUNABLE_INT("hw.usb.xhci.streams", &xhcistreams);
100 static int xhcipolling;
102 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN,
103 &xhcidebug, 0, "Debug level");
104 TUNABLE_INT("hw.usb.xhci.debug", &xhcidebug);
105 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, xhci_port_route, CTLFLAG_RW | CTLFLAG_TUN,
106 &xhciroute, 0, "Routing bitmap for switching EHCI ports to XHCI controller");
107 TUNABLE_INT("hw.usb.xhci.xhci_port_route", &xhciroute);
108 SYSCTL_INT(_hw_usb_xhci, OID_AUTO, use_polling, CTLFLAG_RW | CTLFLAG_TUN,
109 &xhcipolling, 0, "Set to enable software interrupt polling for XHCI controller");
110 TUNABLE_INT("hw.usb.xhci.use_polling", &xhcipolling);
115 #define XHCI_INTR_ENDPT 1
117 struct xhci_std_temp {
118 struct xhci_softc *sc;
119 struct usb_page_cache *pc;
121 struct xhci_td *td_next;
124 uint32_t max_packet_size;
136 uint8_t do_isoc_sync;
139 static void xhci_do_poll(struct usb_bus *);
140 static void xhci_device_done(struct usb_xfer *, usb_error_t);
141 static void xhci_root_intr(struct xhci_softc *);
142 static void xhci_free_device_ext(struct usb_device *);
143 static struct xhci_endpoint_ext *xhci_get_endpoint_ext(struct usb_device *,
144 struct usb_endpoint_descriptor *);
145 static usb_proc_callback_t xhci_configure_msg;
146 static usb_error_t xhci_configure_device(struct usb_device *);
147 static usb_error_t xhci_configure_endpoint(struct usb_device *,
148 struct usb_endpoint_descriptor *, struct xhci_endpoint_ext *,
149 uint16_t, uint8_t, uint8_t, uint8_t, uint16_t, uint16_t,
151 static usb_error_t xhci_configure_mask(struct usb_device *,
153 static usb_error_t xhci_cmd_evaluate_ctx(struct xhci_softc *,
155 static void xhci_endpoint_doorbell(struct usb_xfer *);
156 static void xhci_ctx_set_le32(struct xhci_softc *sc, volatile uint32_t *ptr, uint32_t val);
157 static uint32_t xhci_ctx_get_le32(struct xhci_softc *sc, volatile uint32_t *ptr);
158 static void xhci_ctx_set_le64(struct xhci_softc *sc, volatile uint64_t *ptr, uint64_t val);
160 static uint64_t xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr);
163 extern struct usb_bus_methods xhci_bus_methods;
167 xhci_dump_trb(struct xhci_trb *trb)
169 DPRINTFN(5, "trb = %p\n", trb);
170 DPRINTFN(5, "qwTrb0 = 0x%016llx\n", (long long)le64toh(trb->qwTrb0));
171 DPRINTFN(5, "dwTrb2 = 0x%08x\n", le32toh(trb->dwTrb2));
172 DPRINTFN(5, "dwTrb3 = 0x%08x\n", le32toh(trb->dwTrb3));
176 xhci_dump_endpoint(struct xhci_softc *sc, struct xhci_endp_ctx *pep)
178 DPRINTFN(5, "pep = %p\n", pep);
179 DPRINTFN(5, "dwEpCtx0=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx0));
180 DPRINTFN(5, "dwEpCtx1=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx1));
181 DPRINTFN(5, "qwEpCtx2=0x%016llx\n", (long long)xhci_ctx_get_le64(sc, &pep->qwEpCtx2));
182 DPRINTFN(5, "dwEpCtx4=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx4));
183 DPRINTFN(5, "dwEpCtx5=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx5));
184 DPRINTFN(5, "dwEpCtx6=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx6));
185 DPRINTFN(5, "dwEpCtx7=0x%08x\n", xhci_ctx_get_le32(sc, &pep->dwEpCtx7));
189 xhci_dump_device(struct xhci_softc *sc, struct xhci_slot_ctx *psl)
191 DPRINTFN(5, "psl = %p\n", psl);
192 DPRINTFN(5, "dwSctx0=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx0));
193 DPRINTFN(5, "dwSctx1=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx1));
194 DPRINTFN(5, "dwSctx2=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx2));
195 DPRINTFN(5, "dwSctx3=0x%08x\n", xhci_ctx_get_le32(sc, &psl->dwSctx3));
200 xhci_use_polling(void)
203 return (xhcipolling != 0);
210 xhci_iterate_hw_softc(struct usb_bus *bus, usb_bus_mem_sub_cb_t *cb)
212 struct xhci_softc *sc = XHCI_BUS2SC(bus);
215 cb(bus, &sc->sc_hw.root_pc, &sc->sc_hw.root_pg,
216 sizeof(struct xhci_hw_root), XHCI_PAGE_SIZE);
218 cb(bus, &sc->sc_hw.ctx_pc, &sc->sc_hw.ctx_pg,
219 sizeof(struct xhci_dev_ctx_addr), XHCI_PAGE_SIZE);
221 for (i = 0; i != XHCI_MAX_SCRATCHPADS; i++) {
222 cb(bus, &sc->sc_hw.scratch_pc[i], &sc->sc_hw.scratch_pg[i],
223 XHCI_PAGE_SIZE, XHCI_PAGE_SIZE);
228 xhci_ctx_set_le32(struct xhci_softc *sc, volatile uint32_t *ptr, uint32_t val)
230 if (sc->sc_ctx_is_64_byte) {
232 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
233 /* all contexts are initially 32-bytes */
234 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
235 ptr = (volatile uint32_t *)(((volatile uint8_t *)ptr) + offset);
241 xhci_ctx_get_le32(struct xhci_softc *sc, volatile uint32_t *ptr)
243 if (sc->sc_ctx_is_64_byte) {
245 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
246 /* all contexts are initially 32-bytes */
247 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
248 ptr = (volatile uint32_t *)(((volatile uint8_t *)ptr) + offset);
250 return (le32toh(*ptr));
254 xhci_ctx_set_le64(struct xhci_softc *sc, volatile uint64_t *ptr, uint64_t val)
256 if (sc->sc_ctx_is_64_byte) {
258 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
259 /* all contexts are initially 32-bytes */
260 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
261 ptr = (volatile uint64_t *)(((volatile uint8_t *)ptr) + offset);
268 xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr)
270 if (sc->sc_ctx_is_64_byte) {
272 /* exploit the fact that our structures are XHCI_PAGE_SIZE aligned */
273 /* all contexts are initially 32-bytes */
274 offset = ((uintptr_t)ptr) & ((XHCI_PAGE_SIZE - 1) & ~(31U));
275 ptr = (volatile uint64_t *)(((volatile uint8_t *)ptr) + offset);
277 return (le64toh(*ptr));
282 xhci_reset_command_queue_locked(struct xhci_softc *sc)
284 struct usb_page_search buf_res;
285 struct xhci_hw_root *phwr;
291 temp = XREAD4(sc, oper, XHCI_CRCR_LO);
292 if (temp & XHCI_CRCR_LO_CRR) {
293 DPRINTF("Command ring running\n");
294 temp &= ~(XHCI_CRCR_LO_CS | XHCI_CRCR_LO_CA);
297 * Try to abort the last command as per section
298 * 4.6.1.2 "Aborting a Command" of the XHCI
302 /* stop and cancel */
303 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CS);
304 XWRITE4(sc, oper, XHCI_CRCR_HI, 0);
306 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CA);
307 XWRITE4(sc, oper, XHCI_CRCR_HI, 0);
310 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 4);
312 /* check if command ring is still running */
313 temp = XREAD4(sc, oper, XHCI_CRCR_LO);
314 if (temp & XHCI_CRCR_LO_CRR) {
315 DPRINTF("Comand ring still running\n");
316 return (USB_ERR_IOERROR);
320 /* reset command ring */
321 sc->sc_command_ccs = 1;
322 sc->sc_command_idx = 0;
324 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
326 /* set up command ring control base address */
327 addr = buf_res.physaddr;
328 phwr = buf_res.buffer;
329 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[0];
331 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr);
333 memset(phwr->hwr_commands, 0, sizeof(phwr->hwr_commands));
334 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr);
336 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
338 XWRITE4(sc, oper, XHCI_CRCR_LO, ((uint32_t)addr) | XHCI_CRCR_LO_RCS);
339 XWRITE4(sc, oper, XHCI_CRCR_HI, (uint32_t)(addr >> 32));
345 xhci_start_controller(struct xhci_softc *sc)
347 struct usb_page_search buf_res;
348 struct xhci_hw_root *phwr;
349 struct xhci_dev_ctx_addr *pdctxa;
356 sc->sc_event_ccs = 1;
357 sc->sc_event_idx = 0;
358 sc->sc_command_ccs = 1;
359 sc->sc_command_idx = 0;
361 /* Reset controller */
362 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_HCRST);
364 for (i = 0; i != 100; i++) {
365 usb_pause_mtx(NULL, hz / 100);
366 temp = (XREAD4(sc, oper, XHCI_USBCMD) & XHCI_CMD_HCRST) |
367 (XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_CNR);
373 device_printf(sc->sc_bus.parent, "Controller "
375 return (USB_ERR_IOERROR);
378 if (!(XREAD4(sc, oper, XHCI_PAGESIZE) & XHCI_PAGESIZE_4K)) {
379 device_printf(sc->sc_bus.parent, "Controller does "
380 "not support 4K page size.\n");
381 return (USB_ERR_IOERROR);
384 temp = XREAD4(sc, capa, XHCI_HCSPARAMS1);
386 i = XHCI_HCS1_N_PORTS(temp);
389 device_printf(sc->sc_bus.parent, "Invalid number "
390 "of ports: %u\n", i);
391 return (USB_ERR_IOERROR);
395 sc->sc_noslot = XHCI_HCS1_DEVSLOT_MAX(temp);
397 if (sc->sc_noslot > XHCI_MAX_DEVICES)
398 sc->sc_noslot = XHCI_MAX_DEVICES;
400 /* set up number of device slots */
402 DPRINTF("CONFIG=0x%08x -> 0x%08x\n",
403 XREAD4(sc, oper, XHCI_CONFIG), sc->sc_noslot);
405 XWRITE4(sc, oper, XHCI_CONFIG, sc->sc_noslot);
407 DPRINTF("Max slots: %u\n", sc->sc_noslot);
409 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2);
411 sc->sc_noscratch = XHCI_HCS2_SPB_MAX(temp);
413 if (sc->sc_noscratch > XHCI_MAX_SCRATCHPADS) {
414 device_printf(sc->sc_bus.parent, "XHCI request "
415 "too many scratchpads\n");
416 return (USB_ERR_NOMEM);
419 DPRINTF("Max scratch: %u\n", sc->sc_noscratch);
421 temp = XREAD4(sc, capa, XHCI_HCSPARAMS3);
423 sc->sc_exit_lat_max = XHCI_HCS3_U1_DEL(temp) +
424 XHCI_HCS3_U2_DEL(temp) + 250 /* us */;
426 temp = XREAD4(sc, oper, XHCI_USBSTS);
428 /* clear interrupts */
429 XWRITE4(sc, oper, XHCI_USBSTS, temp);
430 /* disable all device notifications */
431 XWRITE4(sc, oper, XHCI_DNCTRL, 0);
433 /* set up device context base address */
434 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res);
435 pdctxa = buf_res.buffer;
436 memset(pdctxa, 0, sizeof(*pdctxa));
438 addr = buf_res.physaddr;
439 addr += (uintptr_t)&((struct xhci_dev_ctx_addr *)0)->qwSpBufPtr[0];
441 /* slot 0 points to the table of scratchpad pointers */
442 pdctxa->qwBaaDevCtxAddr[0] = htole64(addr);
444 for (i = 0; i != sc->sc_noscratch; i++) {
445 struct usb_page_search buf_scp;
446 usbd_get_page(&sc->sc_hw.scratch_pc[i], 0, &buf_scp);
447 pdctxa->qwSpBufPtr[i] = htole64((uint64_t)buf_scp.physaddr);
450 addr = buf_res.physaddr;
452 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr);
453 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32));
454 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr);
455 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32));
457 /* Setup event table size */
459 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2);
461 DPRINTF("HCS2=0x%08x\n", temp);
463 temp = XHCI_HCS2_ERST_MAX(temp);
465 if (temp > XHCI_MAX_RSEG)
466 temp = XHCI_MAX_RSEG;
468 sc->sc_erst_max = temp;
470 DPRINTF("ERSTSZ=0x%08x -> 0x%08x\n",
471 XREAD4(sc, runt, XHCI_ERSTSZ(0)), temp);
473 XWRITE4(sc, runt, XHCI_ERSTSZ(0), XHCI_ERSTS_SET(temp));
475 /* Check if we should use the default IMOD value */
476 if (sc->sc_imod_default == 0)
477 sc->sc_imod_default = XHCI_IMOD_DEFAULT;
479 /* Setup interrupt rate */
480 XWRITE4(sc, runt, XHCI_IMOD(0), sc->sc_imod_default);
482 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
484 phwr = buf_res.buffer;
485 addr = buf_res.physaddr;
486 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[0];
488 /* reset hardware root structure */
489 memset(phwr, 0, sizeof(*phwr));
491 phwr->hwr_ring_seg[0].qwEvrsTablePtr = htole64(addr);
492 phwr->hwr_ring_seg[0].dwEvrsTableSize = htole32(XHCI_MAX_EVENTS);
494 DPRINTF("ERDP(0)=0x%016llx\n", (unsigned long long)addr);
496 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr);
497 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32));
499 addr = (uint64_t)buf_res.physaddr;
501 DPRINTF("ERSTBA(0)=0x%016llx\n", (unsigned long long)addr);
503 XWRITE4(sc, runt, XHCI_ERSTBA_LO(0), (uint32_t)addr);
504 XWRITE4(sc, runt, XHCI_ERSTBA_HI(0), (uint32_t)(addr >> 32));
506 /* Setup interrupter registers */
508 temp = XREAD4(sc, runt, XHCI_IMAN(0));
509 temp |= XHCI_IMAN_INTR_ENA;
510 XWRITE4(sc, runt, XHCI_IMAN(0), temp);
512 /* set up command ring control base address */
513 addr = buf_res.physaddr;
514 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[0];
516 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr);
518 XWRITE4(sc, oper, XHCI_CRCR_LO, ((uint32_t)addr) | XHCI_CRCR_LO_RCS);
519 XWRITE4(sc, oper, XHCI_CRCR_HI, (uint32_t)(addr >> 32));
521 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr);
523 usb_bus_mem_flush_all(&sc->sc_bus, &xhci_iterate_hw_softc);
526 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_RS |
527 XHCI_CMD_INTE | XHCI_CMD_HSEE);
529 for (i = 0; i != 100; i++) {
530 usb_pause_mtx(NULL, hz / 100);
531 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH;
536 XWRITE4(sc, oper, XHCI_USBCMD, 0);
537 device_printf(sc->sc_bus.parent, "Run timeout.\n");
538 return (USB_ERR_IOERROR);
541 /* catch any lost interrupts */
542 xhci_do_poll(&sc->sc_bus);
544 if (sc->sc_port_route != NULL) {
545 /* Route all ports to the XHCI by default */
546 sc->sc_port_route(sc->sc_bus.parent,
547 ~xhciroute, xhciroute);
553 xhci_halt_controller(struct xhci_softc *sc)
561 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH);
562 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0xF;
563 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3;
565 /* Halt controller */
566 XWRITE4(sc, oper, XHCI_USBCMD, 0);
568 for (i = 0; i != 100; i++) {
569 usb_pause_mtx(NULL, hz / 100);
570 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH;
576 device_printf(sc->sc_bus.parent, "Controller halt timeout.\n");
577 return (USB_ERR_IOERROR);
583 xhci_init(struct xhci_softc *sc, device_t self)
589 /* initialize some bus fields */
590 sc->sc_bus.parent = self;
592 /* set the bus revision */
593 sc->sc_bus.usbrev = USB_REV_3_0;
595 /* set up the bus struct */
596 sc->sc_bus.methods = &xhci_bus_methods;
598 /* set up devices array */
599 sc->sc_bus.devices = sc->sc_devices;
600 sc->sc_bus.devices_max = XHCI_MAX_DEVICES;
602 /* set default cycle state in case of early interrupts */
603 sc->sc_event_ccs = 1;
604 sc->sc_command_ccs = 1;
606 /* set up bus space offsets */
608 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH);
609 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0x1F;
610 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3;
612 DPRINTF("CAPLENGTH=0x%x\n", sc->sc_oper_off);
613 DPRINTF("RUNTIMEOFFSET=0x%x\n", sc->sc_runt_off);
614 DPRINTF("DOOROFFSET=0x%x\n", sc->sc_door_off);
616 DPRINTF("xHCI version = 0x%04x\n", XREAD2(sc, capa, XHCI_HCIVERSION));
618 temp = XREAD4(sc, capa, XHCI_HCSPARAMS0);
620 DPRINTF("HCS0 = 0x%08x\n", temp);
622 /* set up context size */
623 if (XHCI_HCS0_CSZ(temp)) {
624 sc->sc_ctx_is_64_byte = 1;
626 sc->sc_ctx_is_64_byte = 0;
630 sc->sc_bus.dma_bits = XHCI_HCS0_AC64(temp) ? 64 : 32;
632 device_printf(self, "%d bytes context size, %d-bit DMA\n",
633 sc->sc_ctx_is_64_byte ? 64 : 32, (int)sc->sc_bus.dma_bits);
635 /* get all DMA memory */
636 if (usb_bus_mem_alloc_all(&sc->sc_bus,
637 USB_GET_DMA_TAG(self), &xhci_iterate_hw_softc)) {
641 /* set up command queue mutex and condition varible */
642 cv_init(&sc->sc_cmd_cv, "CMDQ");
643 sx_init(&sc->sc_cmd_sx, "CMDQ lock");
645 sc->sc_config_msg[0].hdr.pm_callback = &xhci_configure_msg;
646 sc->sc_config_msg[0].bus = &sc->sc_bus;
647 sc->sc_config_msg[1].hdr.pm_callback = &xhci_configure_msg;
648 sc->sc_config_msg[1].bus = &sc->sc_bus;
654 xhci_uninit(struct xhci_softc *sc)
657 * NOTE: At this point the control transfer process is gone
658 * and "xhci_configure_msg" is no longer called. Consequently
659 * waiting for the configuration messages to complete is not
662 usb_bus_mem_free_all(&sc->sc_bus, &xhci_iterate_hw_softc);
664 cv_destroy(&sc->sc_cmd_cv);
665 sx_destroy(&sc->sc_cmd_sx);
669 xhci_set_hw_power_sleep(struct usb_bus *bus, uint32_t state)
671 struct xhci_softc *sc = XHCI_BUS2SC(bus);
674 case USB_HW_POWER_SUSPEND:
675 DPRINTF("Stopping the XHCI\n");
676 xhci_halt_controller(sc);
678 case USB_HW_POWER_SHUTDOWN:
679 DPRINTF("Stopping the XHCI\n");
680 xhci_halt_controller(sc);
682 case USB_HW_POWER_RESUME:
683 DPRINTF("Starting the XHCI\n");
684 xhci_start_controller(sc);
692 xhci_generic_done_sub(struct usb_xfer *xfer)
695 struct xhci_td *td_alt_next;
699 td = xfer->td_transfer_cache;
700 td_alt_next = td->alt_next;
702 if (xfer->aframes != xfer->nframes)
703 usbd_xfer_set_frame_len(xfer, xfer->aframes, 0);
707 usb_pc_cpu_invalidate(td->page_cache);
712 DPRINTFN(4, "xfer=%p[%u/%u] rem=%u/%u status=%u\n",
713 xfer, (unsigned int)xfer->aframes,
714 (unsigned int)xfer->nframes,
715 (unsigned int)len, (unsigned int)td->len,
716 (unsigned int)status);
719 * Verify the status length and
720 * add the length to "frlengths[]":
723 /* should not happen */
724 DPRINTF("Invalid status length, "
725 "0x%04x/0x%04x bytes\n", len, td->len);
726 status = XHCI_TRB_ERROR_LENGTH;
727 } else if (xfer->aframes != xfer->nframes) {
728 xfer->frlengths[xfer->aframes] += td->len - len;
730 /* Check for last transfer */
731 if (((void *)td) == xfer->td_transfer_last) {
735 /* Check for transfer error */
736 if (status != XHCI_TRB_ERROR_SHORT_PKT &&
737 status != XHCI_TRB_ERROR_SUCCESS) {
738 /* the transfer is finished */
742 /* Check for short transfer */
744 if (xfer->flags_int.short_frames_ok ||
745 xfer->flags_int.isochronous_xfr ||
746 xfer->flags_int.control_xfr) {
747 /* follow alt next */
750 /* the transfer is finished */
757 if (td->alt_next != td_alt_next) {
758 /* this USB frame is complete */
763 /* update transfer cache */
765 xfer->td_transfer_cache = td;
767 return ((status == XHCI_TRB_ERROR_STALL) ? USB_ERR_STALLED :
768 (status != XHCI_TRB_ERROR_SHORT_PKT &&
769 status != XHCI_TRB_ERROR_SUCCESS) ? USB_ERR_IOERROR :
770 USB_ERR_NORMAL_COMPLETION);
774 xhci_generic_done(struct usb_xfer *xfer)
778 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
779 xfer, xfer->endpoint);
783 xfer->td_transfer_cache = xfer->td_transfer_first;
785 if (xfer->flags_int.control_xfr) {
787 if (xfer->flags_int.control_hdr)
788 err = xhci_generic_done_sub(xfer);
792 if (xfer->td_transfer_cache == NULL)
796 while (xfer->aframes != xfer->nframes) {
798 err = xhci_generic_done_sub(xfer);
801 if (xfer->td_transfer_cache == NULL)
805 if (xfer->flags_int.control_xfr &&
806 !xfer->flags_int.control_act)
807 err = xhci_generic_done_sub(xfer);
809 /* transfer is complete */
810 xhci_device_done(xfer, err);
814 xhci_activate_transfer(struct usb_xfer *xfer)
818 td = xfer->td_transfer_cache;
820 usb_pc_cpu_invalidate(td->page_cache);
822 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) {
824 /* activate the transfer */
826 td->td_trb[0].dwTrb3 |= htole32(XHCI_TRB_3_CYCLE_BIT);
827 usb_pc_cpu_flush(td->page_cache);
829 xhci_endpoint_doorbell(xfer);
834 xhci_skip_transfer(struct usb_xfer *xfer)
837 struct xhci_td *td_last;
839 td = xfer->td_transfer_cache;
840 td_last = xfer->td_transfer_last;
844 usb_pc_cpu_invalidate(td->page_cache);
846 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) {
848 usb_pc_cpu_invalidate(td_last->page_cache);
850 /* copy LINK TRB to current waiting location */
852 td->td_trb[0].qwTrb0 = td_last->td_trb[td_last->ntrb].qwTrb0;
853 td->td_trb[0].dwTrb2 = td_last->td_trb[td_last->ntrb].dwTrb2;
854 usb_pc_cpu_flush(td->page_cache);
856 td->td_trb[0].dwTrb3 = td_last->td_trb[td_last->ntrb].dwTrb3;
857 usb_pc_cpu_flush(td->page_cache);
859 xhci_endpoint_doorbell(xfer);
863 /*------------------------------------------------------------------------*
864 * xhci_check_transfer
865 *------------------------------------------------------------------------*/
867 xhci_check_transfer(struct xhci_softc *sc, struct xhci_trb *trb)
869 struct xhci_endpoint_ext *pepext;
882 td_event = le64toh(trb->qwTrb0);
883 temp = le32toh(trb->dwTrb2);
885 remainder = XHCI_TRB_2_REM_GET(temp);
886 status = XHCI_TRB_2_ERROR_GET(temp);
887 stream_id = XHCI_TRB_2_STREAM_GET(temp);
889 temp = le32toh(trb->dwTrb3);
890 epno = XHCI_TRB_3_EP_GET(temp);
891 index = XHCI_TRB_3_SLOT_GET(temp);
893 /* check if error means halted */
894 halted = (status != XHCI_TRB_ERROR_SHORT_PKT &&
895 status != XHCI_TRB_ERROR_SUCCESS);
897 DPRINTF("slot=%u epno=%u stream=%u remainder=%u status=%u\n",
898 index, epno, stream_id, remainder, status);
900 if (index > sc->sc_noslot) {
901 DPRINTF("Invalid slot.\n");
905 if ((epno == 0) || (epno >= XHCI_MAX_ENDPOINTS)) {
906 DPRINTF("Invalid endpoint.\n");
910 pepext = &sc->sc_hw.devs[index].endp[epno];
912 if (pepext->trb_ep_mode != USB_EP_MODE_STREAMS) {
914 DPRINTF("stream_id=0\n");
915 } else if (stream_id >= XHCI_MAX_STREAMS) {
916 DPRINTF("Invalid stream ID.\n");
920 /* try to find the USB transfer that generated the event */
921 for (i = 0; i != (XHCI_MAX_TRANSFERS - 1); i++) {
922 struct usb_xfer *xfer;
925 xfer = pepext->xfer[i + (XHCI_MAX_TRANSFERS * stream_id)];
929 td = xfer->td_transfer_cache;
931 DPRINTFN(5, "Checking if 0x%016llx == (0x%016llx .. 0x%016llx)\n",
933 (long long)td->td_self,
934 (long long)td->td_self + sizeof(td->td_trb));
937 * NOTE: Some XHCI implementations might not trigger
938 * an event on the last LINK TRB so we need to
939 * consider both the last and second last event
940 * address as conditions for a successful transfer.
942 * NOTE: We assume that the XHCI will only trigger one
943 * event per chain of TRBs.
946 offset = td_event - td->td_self;
949 offset < (int64_t)sizeof(td->td_trb)) {
951 usb_pc_cpu_invalidate(td->page_cache);
953 /* compute rest of remainder, if any */
954 for (i = (offset / 16) + 1; i < td->ntrb; i++) {
955 temp = le32toh(td->td_trb[i].dwTrb2);
956 remainder += XHCI_TRB_2_BYTES_GET(temp);
959 DPRINTFN(5, "New remainder: %u\n", remainder);
961 /* clear isochronous transfer errors */
962 if (xfer->flags_int.isochronous_xfr) {
965 status = XHCI_TRB_ERROR_SUCCESS;
970 /* "td->remainder" is verified later */
971 td->remainder = remainder;
974 usb_pc_cpu_flush(td->page_cache);
977 * 1) Last transfer descriptor makes the
980 if (((void *)td) == xfer->td_transfer_last) {
981 DPRINTF("TD is last\n");
982 xhci_generic_done(xfer);
987 * 2) Any kind of error makes the transfer
991 DPRINTF("TD has I/O error\n");
992 xhci_generic_done(xfer);
997 * 3) If there is no alternate next transfer,
998 * a short packet also makes the transfer done
1000 if (td->remainder > 0) {
1001 if (td->alt_next == NULL) {
1003 "short TD has no alternate next\n");
1004 xhci_generic_done(xfer);
1007 DPRINTF("TD has short pkt\n");
1008 if (xfer->flags_int.short_frames_ok ||
1009 xfer->flags_int.isochronous_xfr ||
1010 xfer->flags_int.control_xfr) {
1011 /* follow the alt next */
1012 xfer->td_transfer_cache = td->alt_next;
1013 xhci_activate_transfer(xfer);
1016 xhci_skip_transfer(xfer);
1017 xhci_generic_done(xfer);
1022 * 4) Transfer complete - go to next TD
1024 DPRINTF("Following next TD\n");
1025 xfer->td_transfer_cache = td->obj_next;
1026 xhci_activate_transfer(xfer);
1027 break; /* there should only be one match */
1033 xhci_check_command(struct xhci_softc *sc, struct xhci_trb *trb)
1035 if (sc->sc_cmd_addr == trb->qwTrb0) {
1036 DPRINTF("Received command event\n");
1037 sc->sc_cmd_result[0] = trb->dwTrb2;
1038 sc->sc_cmd_result[1] = trb->dwTrb3;
1039 cv_signal(&sc->sc_cmd_cv);
1040 return (1); /* command match */
1046 xhci_interrupt_poll(struct xhci_softc *sc)
1048 struct usb_page_search buf_res;
1049 struct xhci_hw_root *phwr;
1059 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
1061 phwr = buf_res.buffer;
1063 /* Receive any events */
1065 usb_pc_cpu_invalidate(&sc->sc_hw.root_pc);
1067 i = sc->sc_event_idx;
1068 j = sc->sc_event_ccs;
1073 temp = le32toh(phwr->hwr_events[i].dwTrb3);
1075 k = (temp & XHCI_TRB_3_CYCLE_BIT) ? 1 : 0;
1080 event = XHCI_TRB_3_TYPE_GET(temp);
1082 DPRINTFN(10, "event[%u] = %u (0x%016llx 0x%08lx 0x%08lx)\n",
1083 i, event, (long long)le64toh(phwr->hwr_events[i].qwTrb0),
1084 (long)le32toh(phwr->hwr_events[i].dwTrb2),
1085 (long)le32toh(phwr->hwr_events[i].dwTrb3));
1088 case XHCI_TRB_EVENT_TRANSFER:
1089 xhci_check_transfer(sc, &phwr->hwr_events[i]);
1091 case XHCI_TRB_EVENT_CMD_COMPLETE:
1092 retval |= xhci_check_command(sc, &phwr->hwr_events[i]);
1095 DPRINTF("Unhandled event = %u\n", event);
1101 if (i == XHCI_MAX_EVENTS) {
1105 /* check for timeout */
1111 sc->sc_event_idx = i;
1112 sc->sc_event_ccs = j;
1115 * NOTE: The Event Ring Dequeue Pointer Register is 64-bit
1116 * latched. That means to activate the register we need to
1117 * write both the low and high double word of the 64-bit
1121 addr = (uint32_t)buf_res.physaddr;
1122 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[i];
1124 /* try to clear busy bit */
1125 addr |= XHCI_ERDP_LO_BUSY;
1127 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr);
1128 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32));
1134 xhci_do_command(struct xhci_softc *sc, struct xhci_trb *trb,
1135 uint16_t timeout_ms)
1137 struct usb_page_search buf_res;
1138 struct xhci_hw_root *phwr;
1143 uint8_t timeout = 0;
1146 XHCI_CMD_ASSERT_LOCKED(sc);
1148 /* get hardware root structure */
1150 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res);
1152 phwr = buf_res.buffer;
1156 USB_BUS_LOCK(&sc->sc_bus);
1158 i = sc->sc_command_idx;
1159 j = sc->sc_command_ccs;
1161 DPRINTFN(10, "command[%u] = %u (0x%016llx, 0x%08lx, 0x%08lx)\n",
1162 i, XHCI_TRB_3_TYPE_GET(le32toh(trb->dwTrb3)),
1163 (long long)le64toh(trb->qwTrb0),
1164 (long)le32toh(trb->dwTrb2),
1165 (long)le32toh(trb->dwTrb3));
1167 phwr->hwr_commands[i].qwTrb0 = trb->qwTrb0;
1168 phwr->hwr_commands[i].dwTrb2 = trb->dwTrb2;
1170 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1175 temp |= htole32(XHCI_TRB_3_CYCLE_BIT);
1177 temp &= ~htole32(XHCI_TRB_3_CYCLE_BIT);
1179 temp &= ~htole32(XHCI_TRB_3_TC_BIT);
1181 phwr->hwr_commands[i].dwTrb3 = temp;
1183 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1185 addr = buf_res.physaddr;
1186 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[i];
1188 sc->sc_cmd_addr = htole64(addr);
1192 if (i == (XHCI_MAX_COMMANDS - 1)) {
1195 temp = htole32(XHCI_TRB_3_TC_BIT |
1196 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) |
1197 XHCI_TRB_3_CYCLE_BIT);
1199 temp = htole32(XHCI_TRB_3_TC_BIT |
1200 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
1203 phwr->hwr_commands[i].dwTrb3 = temp;
1205 usb_pc_cpu_flush(&sc->sc_hw.root_pc);
1211 sc->sc_command_idx = i;
1212 sc->sc_command_ccs = j;
1214 XWRITE4(sc, door, XHCI_DOORBELL(0), 0);
1216 err = cv_timedwait(&sc->sc_cmd_cv, &sc->sc_bus.bus_mtx,
1217 USB_MS_TO_TICKS(timeout_ms));
1220 * In some error cases event interrupts are not generated.
1221 * Poll one time to see if the command has completed.
1223 if (err != 0 && xhci_interrupt_poll(sc) != 0) {
1224 DPRINTF("Command was completed when polling\n");
1228 DPRINTF("Command timeout!\n");
1230 * After some weeks of continuous operation, it has
1231 * been observed that the ASMedia Technology, ASM1042
1232 * SuperSpeed USB Host Controller can suddenly stop
1233 * accepting commands via the command queue. Try to
1234 * first reset the command queue. If that fails do a
1235 * host controller reset.
1238 xhci_reset_command_queue_locked(sc) == 0) {
1239 temp = le32toh(trb->dwTrb3);
1242 * Avoid infinite XHCI reset loops if the set
1243 * address command fails to respond due to a
1244 * non-enumerating device:
1246 if (XHCI_TRB_3_TYPE_GET(temp) == XHCI_TRB_TYPE_ADDRESS_DEVICE &&
1247 (temp & XHCI_TRB_3_BSR_BIT) == 0) {
1248 DPRINTF("Set address timeout\n");
1254 DPRINTF("Controller reset!\n");
1255 usb_bus_reset_async_locked(&sc->sc_bus);
1257 err = USB_ERR_TIMEOUT;
1261 temp = le32toh(sc->sc_cmd_result[0]);
1262 if (XHCI_TRB_2_ERROR_GET(temp) != XHCI_TRB_ERROR_SUCCESS)
1263 err = USB_ERR_IOERROR;
1265 trb->dwTrb2 = sc->sc_cmd_result[0];
1266 trb->dwTrb3 = sc->sc_cmd_result[1];
1269 USB_BUS_UNLOCK(&sc->sc_bus);
1276 xhci_cmd_nop(struct xhci_softc *sc)
1278 struct xhci_trb trb;
1285 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NOOP);
1287 trb.dwTrb3 = htole32(temp);
1289 return (xhci_do_command(sc, &trb, 100 /* ms */));
1294 xhci_cmd_enable_slot(struct xhci_softc *sc, uint8_t *pslot)
1296 struct xhci_trb trb;
1304 trb.dwTrb3 = htole32(XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ENABLE_SLOT));
1306 err = xhci_do_command(sc, &trb, 100 /* ms */);
1310 temp = le32toh(trb.dwTrb3);
1312 *pslot = XHCI_TRB_3_SLOT_GET(temp);
1319 xhci_cmd_disable_slot(struct xhci_softc *sc, uint8_t slot_id)
1321 struct xhci_trb trb;
1328 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DISABLE_SLOT) |
1329 XHCI_TRB_3_SLOT_SET(slot_id);
1331 trb.dwTrb3 = htole32(temp);
1333 return (xhci_do_command(sc, &trb, 100 /* ms */));
1337 xhci_cmd_set_address(struct xhci_softc *sc, uint64_t input_ctx,
1338 uint8_t bsr, uint8_t slot_id)
1340 struct xhci_trb trb;
1345 trb.qwTrb0 = htole64(input_ctx);
1347 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ADDRESS_DEVICE) |
1348 XHCI_TRB_3_SLOT_SET(slot_id);
1351 temp |= XHCI_TRB_3_BSR_BIT;
1353 trb.dwTrb3 = htole32(temp);
1355 return (xhci_do_command(sc, &trb, 500 /* ms */));
1359 xhci_set_address(struct usb_device *udev, struct mtx *mtx, uint16_t address)
1361 struct usb_page_search buf_inp;
1362 struct usb_page_search buf_dev;
1363 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
1364 struct xhci_hw_dev *hdev;
1365 struct xhci_dev_ctx *pdev;
1366 struct xhci_endpoint_ext *pepext;
1372 /* the root HUB case is not handled here */
1373 if (udev->parent_hub == NULL)
1374 return (USB_ERR_INVAL);
1376 index = udev->controller_slot_id;
1378 hdev = &sc->sc_hw.devs[index];
1385 switch (hdev->state) {
1386 case XHCI_ST_DEFAULT:
1387 case XHCI_ST_ENABLED:
1389 hdev->state = XHCI_ST_ENABLED;
1391 /* set configure mask to slot and EP0 */
1392 xhci_configure_mask(udev, 3, 0);
1394 /* configure input slot context structure */
1395 err = xhci_configure_device(udev);
1398 DPRINTF("Could not configure device\n");
1402 /* configure input endpoint context structure */
1403 switch (udev->speed) {
1405 case USB_SPEED_FULL:
1408 case USB_SPEED_HIGH:
1416 pepext = xhci_get_endpoint_ext(udev,
1417 &udev->ctrl_ep_desc);
1418 err = xhci_configure_endpoint(udev,
1419 &udev->ctrl_ep_desc, pepext,
1420 0, 1, 1, 0, mps, mps, USB_EP_MODE_DEFAULT);
1423 DPRINTF("Could not configure default endpoint\n");
1427 /* execute set address command */
1428 usbd_get_page(&hdev->input_pc, 0, &buf_inp);
1430 err = xhci_cmd_set_address(sc, buf_inp.physaddr,
1431 (address == 0), index);
1434 temp = le32toh(sc->sc_cmd_result[0]);
1435 if (address == 0 && sc->sc_port_route != NULL &&
1436 XHCI_TRB_2_ERROR_GET(temp) ==
1437 XHCI_TRB_ERROR_PARAMETER) {
1438 /* LynxPoint XHCI - ports are not switchable */
1439 /* Un-route all ports from the XHCI */
1440 sc->sc_port_route(sc->sc_bus.parent, 0, ~0);
1442 DPRINTF("Could not set address "
1443 "for slot %u.\n", index);
1448 /* update device address to new value */
1450 usbd_get_page(&hdev->device_pc, 0, &buf_dev);
1451 pdev = buf_dev.buffer;
1452 usb_pc_cpu_invalidate(&hdev->device_pc);
1454 temp = xhci_ctx_get_le32(sc, &pdev->ctx_slot.dwSctx3);
1455 udev->address = XHCI_SCTX_3_DEV_ADDR_GET(temp);
1457 /* update device state to new value */
1460 hdev->state = XHCI_ST_ADDRESSED;
1462 hdev->state = XHCI_ST_DEFAULT;
1466 DPRINTF("Wrong state for set address.\n");
1467 err = USB_ERR_IOERROR;
1470 XHCI_CMD_UNLOCK(sc);
1479 xhci_cmd_configure_ep(struct xhci_softc *sc, uint64_t input_ctx,
1480 uint8_t deconfigure, uint8_t slot_id)
1482 struct xhci_trb trb;
1487 trb.qwTrb0 = htole64(input_ctx);
1489 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_CONFIGURE_EP) |
1490 XHCI_TRB_3_SLOT_SET(slot_id);
1493 temp |= XHCI_TRB_3_DCEP_BIT;
1495 trb.dwTrb3 = htole32(temp);
1497 return (xhci_do_command(sc, &trb, 100 /* ms */));
1501 xhci_cmd_evaluate_ctx(struct xhci_softc *sc, uint64_t input_ctx,
1504 struct xhci_trb trb;
1509 trb.qwTrb0 = htole64(input_ctx);
1511 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_EVALUATE_CTX) |
1512 XHCI_TRB_3_SLOT_SET(slot_id);
1513 trb.dwTrb3 = htole32(temp);
1515 return (xhci_do_command(sc, &trb, 100 /* ms */));
1519 xhci_cmd_reset_ep(struct xhci_softc *sc, uint8_t preserve,
1520 uint8_t ep_id, uint8_t slot_id)
1522 struct xhci_trb trb;
1529 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_EP) |
1530 XHCI_TRB_3_SLOT_SET(slot_id) |
1531 XHCI_TRB_3_EP_SET(ep_id);
1534 temp |= XHCI_TRB_3_PRSV_BIT;
1536 trb.dwTrb3 = htole32(temp);
1538 return (xhci_do_command(sc, &trb, 100 /* ms */));
1542 xhci_cmd_set_tr_dequeue_ptr(struct xhci_softc *sc, uint64_t dequeue_ptr,
1543 uint16_t stream_id, uint8_t ep_id, uint8_t slot_id)
1545 struct xhci_trb trb;
1550 trb.qwTrb0 = htole64(dequeue_ptr);
1552 temp = XHCI_TRB_2_STREAM_SET(stream_id);
1553 trb.dwTrb2 = htole32(temp);
1555 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SET_TR_DEQUEUE) |
1556 XHCI_TRB_3_SLOT_SET(slot_id) |
1557 XHCI_TRB_3_EP_SET(ep_id);
1558 trb.dwTrb3 = htole32(temp);
1560 return (xhci_do_command(sc, &trb, 100 /* ms */));
1564 xhci_cmd_stop_ep(struct xhci_softc *sc, uint8_t suspend,
1565 uint8_t ep_id, uint8_t slot_id)
1567 struct xhci_trb trb;
1574 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STOP_EP) |
1575 XHCI_TRB_3_SLOT_SET(slot_id) |
1576 XHCI_TRB_3_EP_SET(ep_id);
1579 temp |= XHCI_TRB_3_SUSP_EP_BIT;
1581 trb.dwTrb3 = htole32(temp);
1583 return (xhci_do_command(sc, &trb, 100 /* ms */));
1587 xhci_cmd_reset_dev(struct xhci_softc *sc, uint8_t slot_id)
1589 struct xhci_trb trb;
1596 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_DEVICE) |
1597 XHCI_TRB_3_SLOT_SET(slot_id);
1599 trb.dwTrb3 = htole32(temp);
1601 return (xhci_do_command(sc, &trb, 100 /* ms */));
1604 /*------------------------------------------------------------------------*
1605 * xhci_interrupt - XHCI interrupt handler
1606 *------------------------------------------------------------------------*/
1608 xhci_interrupt(struct xhci_softc *sc)
1613 USB_BUS_LOCK(&sc->sc_bus);
1615 status = XREAD4(sc, oper, XHCI_USBSTS);
1617 /* acknowledge interrupts, if any */
1619 XWRITE4(sc, oper, XHCI_USBSTS, status);
1620 DPRINTFN(16, "real interrupt (status=0x%08x)\n", status);
1623 temp = XREAD4(sc, runt, XHCI_IMAN(0));
1625 /* force clearing of pending interrupts */
1626 if (temp & XHCI_IMAN_INTR_PEND)
1627 XWRITE4(sc, runt, XHCI_IMAN(0), temp);
1629 /* check for event(s) */
1630 xhci_interrupt_poll(sc);
1632 if (status & (XHCI_STS_PCD | XHCI_STS_HCH |
1633 XHCI_STS_HSE | XHCI_STS_HCE)) {
1635 if (status & XHCI_STS_PCD) {
1639 if (status & XHCI_STS_HCH) {
1640 printf("%s: host controller halted\n",
1644 if (status & XHCI_STS_HSE) {
1645 printf("%s: host system error\n",
1649 if (status & XHCI_STS_HCE) {
1650 printf("%s: host controller error\n",
1654 USB_BUS_UNLOCK(&sc->sc_bus);
1657 /*------------------------------------------------------------------------*
1658 * xhci_timeout - XHCI timeout handler
1659 *------------------------------------------------------------------------*/
1661 xhci_timeout(void *arg)
1663 struct usb_xfer *xfer = arg;
1665 DPRINTF("xfer=%p\n", xfer);
1667 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1669 /* transfer is transferred */
1670 xhci_device_done(xfer, USB_ERR_TIMEOUT);
1674 xhci_do_poll(struct usb_bus *bus)
1676 struct xhci_softc *sc = XHCI_BUS2SC(bus);
1678 USB_BUS_LOCK(&sc->sc_bus);
1679 xhci_interrupt_poll(sc);
1680 USB_BUS_UNLOCK(&sc->sc_bus);
1684 xhci_setup_generic_chain_sub(struct xhci_std_temp *temp)
1686 struct usb_page_search buf_res;
1688 struct xhci_td *td_next;
1689 struct xhci_td *td_alt_next;
1690 struct xhci_td *td_first;
1691 uint32_t buf_offset;
1696 uint8_t shortpkt_old;
1702 shortpkt_old = temp->shortpkt;
1703 len_old = temp->len;
1710 td_next = td_first = temp->td_next;
1714 if (temp->len == 0) {
1719 /* send a Zero Length Packet, ZLP, last */
1726 average = temp->average;
1728 if (temp->len < average) {
1729 if (temp->len % temp->max_packet_size) {
1732 average = temp->len;
1736 if (td_next == NULL)
1737 panic("%s: out of XHCI transfer descriptors!", __FUNCTION__);
1742 td_next = td->obj_next;
1744 /* check if we are pre-computing */
1748 /* update remaining length */
1750 temp->len -= average;
1754 /* fill out current TD */
1760 /* update remaining length */
1762 temp->len -= average;
1764 /* reset TRB index */
1768 if (temp->trb_type == XHCI_TRB_TYPE_SETUP_STAGE) {
1769 /* immediate data */
1774 td->td_trb[0].qwTrb0 = 0;
1776 usbd_copy_out(temp->pc, temp->offset + buf_offset,
1777 (uint8_t *)(uintptr_t)&td->td_trb[0].qwTrb0,
1780 dword = XHCI_TRB_2_BYTES_SET(8) |
1781 XHCI_TRB_2_TDSZ_SET(0) |
1782 XHCI_TRB_2_IRQ_SET(0);
1784 td->td_trb[0].dwTrb2 = htole32(dword);
1786 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SETUP_STAGE) |
1787 XHCI_TRB_3_IDT_BIT | XHCI_TRB_3_CYCLE_BIT;
1790 if (td->td_trb[0].qwTrb0 &
1791 htole64(XHCI_TRB_0_WLENGTH_MASK)) {
1792 if (td->td_trb[0].qwTrb0 &
1793 htole64(XHCI_TRB_0_DIR_IN_MASK))
1794 dword |= XHCI_TRB_3_TRT_IN;
1796 dword |= XHCI_TRB_3_TRT_OUT;
1799 td->td_trb[0].dwTrb3 = htole32(dword);
1801 xhci_dump_trb(&td->td_trb[x]);
1809 /* fill out buffer pointers */
1812 memset(&buf_res, 0, sizeof(buf_res));
1814 usbd_get_page(temp->pc, temp->offset +
1815 buf_offset, &buf_res);
1817 /* get length to end of page */
1818 if (buf_res.length > average)
1819 buf_res.length = average;
1821 /* check for maximum length */
1822 if (buf_res.length > XHCI_TD_PAGE_SIZE)
1823 buf_res.length = XHCI_TD_PAGE_SIZE;
1825 npkt_off += buf_res.length;
1829 npkt = (len_old - npkt_off + temp->max_packet_size - 1) /
1830 temp->max_packet_size;
1837 /* fill out TRB's */
1838 td->td_trb[x].qwTrb0 =
1839 htole64((uint64_t)buf_res.physaddr);
1842 XHCI_TRB_2_BYTES_SET(buf_res.length) |
1843 XHCI_TRB_2_TDSZ_SET(npkt) |
1844 XHCI_TRB_2_IRQ_SET(0);
1846 td->td_trb[x].dwTrb2 = htole32(dword);
1848 switch (temp->trb_type) {
1849 case XHCI_TRB_TYPE_ISOCH:
1850 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1851 XHCI_TRB_3_TBC_SET(temp->tbc) |
1852 XHCI_TRB_3_TLBPC_SET(temp->tlbpc);
1853 if (td != td_first) {
1854 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL);
1855 } else if (temp->do_isoc_sync != 0) {
1856 temp->do_isoc_sync = 0;
1857 /* wait until "isoc_frame" */
1858 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) |
1859 XHCI_TRB_3_FRID_SET(temp->isoc_frame / 8);
1861 /* start data transfer at next interval */
1862 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) |
1863 XHCI_TRB_3_ISO_SIA_BIT;
1865 if (temp->direction == UE_DIR_IN)
1866 dword |= XHCI_TRB_3_ISP_BIT;
1868 case XHCI_TRB_TYPE_DATA_STAGE:
1869 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1870 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DATA_STAGE);
1871 if (temp->direction == UE_DIR_IN)
1872 dword |= XHCI_TRB_3_DIR_IN | XHCI_TRB_3_ISP_BIT;
1874 case XHCI_TRB_TYPE_STATUS_STAGE:
1875 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1876 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STATUS_STAGE);
1877 if (temp->direction == UE_DIR_IN)
1878 dword |= XHCI_TRB_3_DIR_IN;
1880 default: /* XHCI_TRB_TYPE_NORMAL */
1881 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT |
1882 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL);
1883 if (temp->direction == UE_DIR_IN)
1884 dword |= XHCI_TRB_3_ISP_BIT;
1887 td->td_trb[x].dwTrb3 = htole32(dword);
1889 average -= buf_res.length;
1890 buf_offset += buf_res.length;
1892 xhci_dump_trb(&td->td_trb[x]);
1896 } while (average != 0);
1898 td->td_trb[x-1].dwTrb3 |= htole32(XHCI_TRB_3_IOC_BIT);
1900 /* store number of data TRB's */
1904 DPRINTF("NTRB=%u\n", x);
1906 /* fill out link TRB */
1908 if (td_next != NULL) {
1909 /* link the current TD with the next one */
1910 td->td_trb[x].qwTrb0 = htole64((uint64_t)td_next->td_self);
1911 DPRINTF("LINK=0x%08llx\n", (long long)td_next->td_self);
1913 /* this field will get updated later */
1914 DPRINTF("NOLINK\n");
1917 dword = XHCI_TRB_2_IRQ_SET(0);
1919 td->td_trb[x].dwTrb2 = htole32(dword);
1921 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) |
1922 XHCI_TRB_3_CYCLE_BIT | XHCI_TRB_3_IOC_BIT |
1924 * CHAIN-BIT: Ensure that a multi-TRB IN-endpoint
1925 * frame only receives a single short packet event
1926 * by setting the CHAIN bit in the LINK field. In
1927 * addition some XHCI controllers have problems
1928 * sending a ZLP unless the CHAIN-BIT is set in
1931 XHCI_TRB_3_CHAIN_BIT;
1933 td->td_trb[x].dwTrb3 = htole32(dword);
1935 td->alt_next = td_alt_next;
1937 xhci_dump_trb(&td->td_trb[x]);
1939 usb_pc_cpu_flush(td->page_cache);
1945 /* set up alt next pointer, if any */
1946 if (temp->last_frame) {
1949 /* we use this field internally */
1950 td_alt_next = td_next;
1954 temp->shortpkt = shortpkt_old;
1955 temp->len = len_old;
1960 * Remove cycle bit from the first TRB if we are
1963 if (temp->step_td != 0) {
1964 td_first->td_trb[0].dwTrb3 &= ~htole32(XHCI_TRB_3_CYCLE_BIT);
1965 usb_pc_cpu_flush(td_first->page_cache);
1968 /* clear TD SIZE to zero, hence this is the last TRB */
1969 /* remove chain bit because this is the last data TRB in the chain */
1970 td->td_trb[td->ntrb - 1].dwTrb2 &= ~htole32(XHCI_TRB_2_TDSZ_SET(15));
1971 td->td_trb[td->ntrb - 1].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT);
1972 /* remove CHAIN-BIT from last LINK TRB */
1973 td->td_trb[td->ntrb].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT);
1975 usb_pc_cpu_flush(td->page_cache);
1978 temp->td_next = td_next;
1982 xhci_setup_generic_chain(struct usb_xfer *xfer)
1984 struct xhci_std_temp temp;
1990 temp.do_isoc_sync = 0;
1994 temp.average = xfer->max_hc_frame_size;
1995 temp.max_packet_size = xfer->max_packet_size;
1996 temp.sc = XHCI_BUS2SC(xfer->xroot->bus);
1998 temp.last_frame = 0;
2000 temp.multishort = xfer->flags_int.isochronous_xfr ||
2001 xfer->flags_int.control_xfr ||
2002 xfer->flags_int.short_frames_ok;
2004 /* toggle the DMA set we are using */
2005 xfer->flags_int.curr_dma_set ^= 1;
2007 /* get next DMA set */
2008 td = xfer->td_start[xfer->flags_int.curr_dma_set];
2013 xfer->td_transfer_first = td;
2014 xfer->td_transfer_cache = td;
2016 if (xfer->flags_int.isochronous_xfr) {
2019 /* compute multiplier for ISOCHRONOUS transfers */
2020 mult = xfer->endpoint->ecomp ?
2021 UE_GET_SS_ISO_MULT(xfer->endpoint->ecomp->bmAttributes)
2023 /* check for USB 2.0 multiplier */
2025 mult = (xfer->endpoint->edesc->
2026 wMaxPacketSize[1] >> 3) & 3;
2034 x = XREAD4(temp.sc, runt, XHCI_MFINDEX);
2036 DPRINTF("MFINDEX=0x%08x\n", x);
2038 switch (usbd_get_speed(xfer->xroot->udev)) {
2039 case USB_SPEED_FULL:
2041 temp.isoc_delta = 8; /* 1ms */
2042 x += temp.isoc_delta - 1;
2043 x &= ~(temp.isoc_delta - 1);
2046 shift = usbd_xfer_get_fps_shift(xfer);
2047 temp.isoc_delta = 1U << shift;
2048 x += temp.isoc_delta - 1;
2049 x &= ~(temp.isoc_delta - 1);
2050 /* simple frame load balancing */
2051 x += xfer->endpoint->usb_uframe;
2055 y = XHCI_MFINDEX_GET(x - xfer->endpoint->isoc_next);
2057 if ((xfer->endpoint->is_synced == 0) ||
2058 (y < (xfer->nframes << shift)) ||
2059 (XHCI_MFINDEX_GET(-y) >= (128 * 8))) {
2061 * If there is data underflow or the pipe
2062 * queue is empty we schedule the transfer a
2063 * few frames ahead of the current frame
2064 * position. Else two isochronous transfers
2067 xfer->endpoint->isoc_next = XHCI_MFINDEX_GET(x + (3 * 8));
2068 xfer->endpoint->is_synced = 1;
2069 temp.do_isoc_sync = 1;
2071 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next);
2074 /* compute isochronous completion time */
2076 y = XHCI_MFINDEX_GET(xfer->endpoint->isoc_next - (x & ~7));
2078 xfer->isoc_time_complete =
2079 usb_isoc_time_expand(&temp.sc->sc_bus, x / 8) +
2080 (y / 8) + (((xfer->nframes << shift) + 7) / 8);
2083 temp.isoc_frame = xfer->endpoint->isoc_next;
2084 temp.trb_type = XHCI_TRB_TYPE_ISOCH;
2086 xfer->endpoint->isoc_next += xfer->nframes << shift;
2088 } else if (xfer->flags_int.control_xfr) {
2090 /* check if we should prepend a setup message */
2092 if (xfer->flags_int.control_hdr) {
2094 temp.len = xfer->frlengths[0];
2095 temp.pc = xfer->frbuffers + 0;
2096 temp.shortpkt = temp.len ? 1 : 0;
2097 temp.trb_type = XHCI_TRB_TYPE_SETUP_STAGE;
2100 /* check for last frame */
2101 if (xfer->nframes == 1) {
2102 /* no STATUS stage yet, SETUP is last */
2103 if (xfer->flags_int.control_act)
2104 temp.last_frame = 1;
2107 xhci_setup_generic_chain_sub(&temp);
2111 temp.isoc_delta = 0;
2112 temp.isoc_frame = 0;
2113 temp.trb_type = XHCI_TRB_TYPE_DATA_STAGE;
2117 temp.isoc_delta = 0;
2118 temp.isoc_frame = 0;
2119 temp.trb_type = XHCI_TRB_TYPE_NORMAL;
2122 if (x != xfer->nframes) {
2123 /* set up page_cache pointer */
2124 temp.pc = xfer->frbuffers + x;
2125 /* set endpoint direction */
2126 temp.direction = UE_GET_DIR(xfer->endpointno);
2129 while (x != xfer->nframes) {
2131 /* DATA0 / DATA1 message */
2133 temp.len = xfer->frlengths[x];
2134 temp.step_td = ((xfer->endpointno & UE_DIR_IN) &&
2135 x != 0 && temp.multishort == 0);
2139 if (x == xfer->nframes) {
2140 if (xfer->flags_int.control_xfr) {
2141 /* no STATUS stage yet, DATA is last */
2142 if (xfer->flags_int.control_act)
2143 temp.last_frame = 1;
2145 temp.last_frame = 1;
2148 if (temp.len == 0) {
2150 /* make sure that we send an USB packet */
2155 temp.tlbpc = mult - 1;
2157 } else if (xfer->flags_int.isochronous_xfr) {
2162 * Isochronous transfers don't have short
2163 * packet termination:
2168 /* isochronous transfers have a transfer limit */
2170 if (temp.len > xfer->max_frame_size)
2171 temp.len = xfer->max_frame_size;
2173 /* compute TD packet count */
2174 tdpc = (temp.len + xfer->max_packet_size - 1) /
2175 xfer->max_packet_size;
2177 temp.tbc = ((tdpc + mult - 1) / mult) - 1;
2178 temp.tlbpc = (tdpc % mult);
2180 if (temp.tlbpc == 0)
2181 temp.tlbpc = mult - 1;
2186 /* regular data transfer */
2188 temp.shortpkt = xfer->flags.force_short_xfer ? 0 : 1;
2191 xhci_setup_generic_chain_sub(&temp);
2193 if (xfer->flags_int.isochronous_xfr) {
2194 temp.offset += xfer->frlengths[x - 1];
2195 temp.isoc_frame += temp.isoc_delta;
2197 /* get next Page Cache pointer */
2198 temp.pc = xfer->frbuffers + x;
2202 /* check if we should append a status stage */
2204 if (xfer->flags_int.control_xfr &&
2205 !xfer->flags_int.control_act) {
2208 * Send a DATA1 message and invert the current
2209 * endpoint direction.
2211 temp.step_td = (xfer->nframes != 0);
2212 temp.direction = UE_GET_DIR(xfer->endpointno) ^ UE_DIR_IN;
2216 temp.last_frame = 1;
2217 temp.trb_type = XHCI_TRB_TYPE_STATUS_STAGE;
2219 xhci_setup_generic_chain_sub(&temp);
2224 /* must have at least one frame! */
2226 xfer->td_transfer_last = td;
2228 DPRINTF("first=%p last=%p\n", xfer->td_transfer_first, td);
2232 xhci_set_slot_pointer(struct xhci_softc *sc, uint8_t index, uint64_t dev_addr)
2234 struct usb_page_search buf_res;
2235 struct xhci_dev_ctx_addr *pdctxa;
2237 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res);
2239 pdctxa = buf_res.buffer;
2241 DPRINTF("addr[%u]=0x%016llx\n", index, (long long)dev_addr);
2243 pdctxa->qwBaaDevCtxAddr[index] = htole64(dev_addr);
2245 usb_pc_cpu_flush(&sc->sc_hw.ctx_pc);
2249 xhci_configure_mask(struct usb_device *udev, uint32_t mask, uint8_t drop)
2251 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2252 struct usb_page_search buf_inp;
2253 struct xhci_input_dev_ctx *pinp;
2258 index = udev->controller_slot_id;
2260 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
2262 pinp = buf_inp.buffer;
2265 mask &= XHCI_INCTX_NON_CTRL_MASK;
2266 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0, mask);
2267 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, 0);
2270 * Some hardware requires that we drop the endpoint
2271 * context before adding it again:
2273 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0,
2274 mask & XHCI_INCTX_NON_CTRL_MASK);
2276 /* Add new endpoint context */
2277 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, mask);
2279 /* find most significant set bit */
2280 for (x = 31; x != 1; x--) {
2281 if (mask & (1 << x))
2288 /* figure out the maximum number of contexts */
2289 if (x > sc->sc_hw.devs[index].context_num)
2290 sc->sc_hw.devs[index].context_num = x;
2292 x = sc->sc_hw.devs[index].context_num;
2294 /* update number of contexts */
2295 temp = xhci_ctx_get_le32(sc, &pinp->ctx_slot.dwSctx0);
2296 temp &= ~XHCI_SCTX_0_CTX_NUM_SET(31);
2297 temp |= XHCI_SCTX_0_CTX_NUM_SET(x + 1);
2298 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp);
2300 usb_pc_cpu_flush(&sc->sc_hw.devs[index].input_pc);
2305 xhci_configure_endpoint(struct usb_device *udev,
2306 struct usb_endpoint_descriptor *edesc, struct xhci_endpoint_ext *pepext,
2307 uint16_t interval, uint8_t max_packet_count,
2308 uint8_t mult, uint8_t fps_shift, uint16_t max_packet_size,
2309 uint16_t max_frame_size, uint8_t ep_mode)
2311 struct usb_page_search buf_inp;
2312 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2313 struct xhci_input_dev_ctx *pinp;
2314 uint64_t ring_addr = pepext->physaddr;
2320 index = udev->controller_slot_id;
2322 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
2324 pinp = buf_inp.buffer;
2326 epno = edesc->bEndpointAddress;
2327 type = edesc->bmAttributes & UE_XFERTYPE;
2329 if (type == UE_CONTROL)
2332 epno = XHCI_EPNO2EPID(epno);
2335 return (USB_ERR_NO_PIPE); /* invalid */
2337 if (max_packet_count == 0)
2338 return (USB_ERR_BAD_BUFSIZE);
2343 return (USB_ERR_BAD_BUFSIZE);
2345 /* store endpoint mode */
2346 pepext->trb_ep_mode = ep_mode;
2347 usb_pc_cpu_flush(pepext->page_cache);
2349 if (ep_mode == USB_EP_MODE_STREAMS) {
2350 temp = XHCI_EPCTX_0_EPSTATE_SET(0) |
2351 XHCI_EPCTX_0_MAXP_STREAMS_SET(XHCI_MAX_STREAMS_LOG - 1) |
2352 XHCI_EPCTX_0_LSA_SET(1);
2354 ring_addr += sizeof(struct xhci_trb) *
2355 XHCI_MAX_TRANSFERS * XHCI_MAX_STREAMS;
2357 temp = XHCI_EPCTX_0_EPSTATE_SET(0) |
2358 XHCI_EPCTX_0_MAXP_STREAMS_SET(0) |
2359 XHCI_EPCTX_0_LSA_SET(0);
2361 ring_addr |= XHCI_EPCTX_2_DCS_SET(1);
2364 switch (udev->speed) {
2365 case USB_SPEED_FULL:
2378 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift);
2380 case UE_ISOCHRONOUS:
2381 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift);
2383 switch (udev->speed) {
2384 case USB_SPEED_SUPER:
2387 temp |= XHCI_EPCTX_0_MULT_SET(mult - 1);
2388 max_packet_count /= mult;
2398 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx0, temp);
2401 XHCI_EPCTX_1_HID_SET(0) |
2402 XHCI_EPCTX_1_MAXB_SET(max_packet_count) |
2403 XHCI_EPCTX_1_MAXP_SIZE_SET(max_packet_size);
2406 * Always enable the "three strikes and you are gone" feature
2407 * except for ISOCHRONOUS endpoints. This is suggested by
2408 * section 4.3.3 in the XHCI specification about device slot
2411 if (type != UE_ISOCHRONOUS)
2412 temp |= XHCI_EPCTX_1_CERR_SET(3);
2416 temp |= XHCI_EPCTX_1_EPTYPE_SET(4);
2418 case UE_ISOCHRONOUS:
2419 temp |= XHCI_EPCTX_1_EPTYPE_SET(1);
2422 temp |= XHCI_EPCTX_1_EPTYPE_SET(2);
2425 temp |= XHCI_EPCTX_1_EPTYPE_SET(3);
2429 /* check for IN direction */
2431 temp |= XHCI_EPCTX_1_EPTYPE_SET(4);
2433 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx1, temp);
2434 xhci_ctx_set_le64(sc, &pinp->ctx_ep[epno - 1].qwEpCtx2, ring_addr);
2436 switch (edesc->bmAttributes & UE_XFERTYPE) {
2438 case UE_ISOCHRONOUS:
2439 temp = XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_SET(max_frame_size) |
2440 XHCI_EPCTX_4_AVG_TRB_LEN_SET(MIN(XHCI_PAGE_SIZE,
2444 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(8);
2447 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(XHCI_PAGE_SIZE);
2451 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx4, temp);
2454 xhci_dump_endpoint(sc, &pinp->ctx_ep[epno - 1]);
2456 usb_pc_cpu_flush(&sc->sc_hw.devs[index].input_pc);
2458 return (0); /* success */
2462 xhci_configure_endpoint_by_xfer(struct usb_xfer *xfer)
2464 struct xhci_endpoint_ext *pepext;
2465 struct usb_endpoint_ss_comp_descriptor *ecomp;
2468 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2469 xfer->endpoint->edesc);
2471 ecomp = xfer->endpoint->ecomp;
2473 for (x = 0; x != XHCI_MAX_STREAMS; x++) {
2476 /* halt any transfers */
2477 pepext->trb[x * XHCI_MAX_TRANSFERS].dwTrb3 = 0;
2479 /* compute start of TRB ring for stream "x" */
2480 temp = pepext->physaddr +
2481 (x * XHCI_MAX_TRANSFERS * sizeof(struct xhci_trb)) +
2482 XHCI_SCTX_0_SCT_SEC_TR_RING;
2484 /* make tree structure */
2485 pepext->trb[(XHCI_MAX_TRANSFERS *
2486 XHCI_MAX_STREAMS) + x].qwTrb0 = htole64(temp);
2488 /* reserved fields */
2489 pepext->trb[(XHCI_MAX_TRANSFERS *
2490 XHCI_MAX_STREAMS) + x].dwTrb2 = 0;
2491 pepext->trb[(XHCI_MAX_TRANSFERS *
2492 XHCI_MAX_STREAMS) + x].dwTrb3 = 0;
2494 usb_pc_cpu_flush(pepext->page_cache);
2496 return (xhci_configure_endpoint(xfer->xroot->udev,
2497 xfer->endpoint->edesc, pepext,
2498 xfer->interval, xfer->max_packet_count,
2499 (ecomp != NULL) ? UE_GET_SS_ISO_MULT(ecomp->bmAttributes) + 1 : 1,
2500 usbd_xfer_get_fps_shift(xfer), xfer->max_packet_size,
2501 xfer->max_frame_size, xfer->endpoint->ep_mode));
2505 xhci_configure_device(struct usb_device *udev)
2507 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2508 struct usb_page_search buf_inp;
2509 struct usb_page_cache *pcinp;
2510 struct xhci_input_dev_ctx *pinp;
2511 struct usb_device *hubdev;
2519 index = udev->controller_slot_id;
2521 DPRINTF("index=%u\n", index);
2523 pcinp = &sc->sc_hw.devs[index].input_pc;
2525 usbd_get_page(pcinp, 0, &buf_inp);
2527 pinp = buf_inp.buffer;
2532 /* figure out route string and root HUB port number */
2534 for (hubdev = udev; hubdev != NULL; hubdev = hubdev->parent_hub) {
2536 if (hubdev->parent_hub == NULL)
2539 depth = hubdev->parent_hub->depth;
2542 * NOTE: HS/FS/LS devices and the SS root HUB can have
2543 * more than 15 ports
2546 rh_port = hubdev->port_no;
2555 route |= rh_port << (4 * (depth - 1));
2558 DPRINTF("Route=0x%08x\n", route);
2560 temp = XHCI_SCTX_0_ROUTE_SET(route) |
2561 XHCI_SCTX_0_CTX_NUM_SET(
2562 sc->sc_hw.devs[index].context_num + 1);
2564 switch (udev->speed) {
2566 temp |= XHCI_SCTX_0_SPEED_SET(2);
2567 if (udev->parent_hs_hub != NULL &&
2568 udev->parent_hs_hub->ddesc.bDeviceProtocol ==
2570 DPRINTF("Device inherits MTT\n");
2571 temp |= XHCI_SCTX_0_MTT_SET(1);
2574 case USB_SPEED_HIGH:
2575 temp |= XHCI_SCTX_0_SPEED_SET(3);
2576 if (sc->sc_hw.devs[index].nports != 0 &&
2577 udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) {
2578 DPRINTF("HUB supports MTT\n");
2579 temp |= XHCI_SCTX_0_MTT_SET(1);
2582 case USB_SPEED_FULL:
2583 temp |= XHCI_SCTX_0_SPEED_SET(1);
2584 if (udev->parent_hs_hub != NULL &&
2585 udev->parent_hs_hub->ddesc.bDeviceProtocol ==
2587 DPRINTF("Device inherits MTT\n");
2588 temp |= XHCI_SCTX_0_MTT_SET(1);
2592 temp |= XHCI_SCTX_0_SPEED_SET(4);
2596 is_hub = sc->sc_hw.devs[index].nports != 0 &&
2597 (udev->speed == USB_SPEED_SUPER ||
2598 udev->speed == USB_SPEED_HIGH);
2601 temp |= XHCI_SCTX_0_HUB_SET(1);
2603 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp);
2605 temp = XHCI_SCTX_1_RH_PORT_SET(rh_port);
2608 temp |= XHCI_SCTX_1_NUM_PORTS_SET(
2609 sc->sc_hw.devs[index].nports);
2612 switch (udev->speed) {
2613 case USB_SPEED_SUPER:
2614 switch (sc->sc_hw.devs[index].state) {
2615 case XHCI_ST_ADDRESSED:
2616 case XHCI_ST_CONFIGURED:
2617 /* enable power save */
2618 temp |= XHCI_SCTX_1_MAX_EL_SET(sc->sc_exit_lat_max);
2621 /* disable power save */
2629 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx1, temp);
2631 temp = XHCI_SCTX_2_IRQ_TARGET_SET(0);
2634 temp |= XHCI_SCTX_2_TT_THINK_TIME_SET(
2635 sc->sc_hw.devs[index].tt);
2638 hubdev = udev->parent_hs_hub;
2640 /* check if we should activate the transaction translator */
2641 switch (udev->speed) {
2642 case USB_SPEED_FULL:
2644 if (hubdev != NULL) {
2645 temp |= XHCI_SCTX_2_TT_HUB_SID_SET(
2646 hubdev->controller_slot_id);
2647 temp |= XHCI_SCTX_2_TT_PORT_NUM_SET(
2655 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx2, temp);
2658 * These fields should be initialized to zero, according to
2659 * XHCI section 6.2.2 - slot context:
2661 temp = XHCI_SCTX_3_DEV_ADDR_SET(0) |
2662 XHCI_SCTX_3_SLOT_STATE_SET(0);
2664 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx3, temp);
2667 xhci_dump_device(sc, &pinp->ctx_slot);
2669 usb_pc_cpu_flush(pcinp);
2671 return (0); /* success */
2675 xhci_alloc_device_ext(struct usb_device *udev)
2677 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2678 struct usb_page_search buf_dev;
2679 struct usb_page_search buf_ep;
2680 struct xhci_trb *trb;
2681 struct usb_page_cache *pc;
2682 struct usb_page *pg;
2687 index = udev->controller_slot_id;
2689 pc = &sc->sc_hw.devs[index].device_pc;
2690 pg = &sc->sc_hw.devs[index].device_pg;
2692 /* need to initialize the page cache */
2693 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2695 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ?
2696 (2 * sizeof(struct xhci_dev_ctx)) :
2697 sizeof(struct xhci_dev_ctx), XHCI_PAGE_SIZE))
2700 usbd_get_page(pc, 0, &buf_dev);
2702 pc = &sc->sc_hw.devs[index].input_pc;
2703 pg = &sc->sc_hw.devs[index].input_pg;
2705 /* need to initialize the page cache */
2706 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2708 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ?
2709 (2 * sizeof(struct xhci_input_dev_ctx)) :
2710 sizeof(struct xhci_input_dev_ctx), XHCI_PAGE_SIZE)) {
2714 /* initialize all endpoint LINK TRBs */
2716 for (i = 0; i != XHCI_MAX_ENDPOINTS; i++) {
2718 pc = &sc->sc_hw.devs[index].endpoint_pc[i];
2719 pg = &sc->sc_hw.devs[index].endpoint_pg[i];
2721 /* need to initialize the page cache */
2722 pc->tag_parent = sc->sc_bus.dma_parent_tag;
2724 if (usb_pc_alloc_mem(pc, pg,
2725 sizeof(struct xhci_dev_endpoint_trbs), XHCI_TRB_ALIGN)) {
2729 /* lookup endpoint TRB ring */
2730 usbd_get_page(pc, 0, &buf_ep);
2732 /* get TRB pointer */
2733 trb = buf_ep.buffer;
2734 trb += XHCI_MAX_TRANSFERS - 1;
2736 /* get TRB start address */
2737 addr = buf_ep.physaddr;
2739 /* create LINK TRB */
2740 trb->qwTrb0 = htole64(addr);
2741 trb->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2742 trb->dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT |
2743 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2745 usb_pc_cpu_flush(pc);
2748 xhci_set_slot_pointer(sc, index, buf_dev.physaddr);
2753 xhci_free_device_ext(udev);
2755 return (USB_ERR_NOMEM);
2759 xhci_free_device_ext(struct usb_device *udev)
2761 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2765 index = udev->controller_slot_id;
2766 xhci_set_slot_pointer(sc, index, 0);
2768 usb_pc_free_mem(&sc->sc_hw.devs[index].device_pc);
2769 usb_pc_free_mem(&sc->sc_hw.devs[index].input_pc);
2770 for (i = 0; i != XHCI_MAX_ENDPOINTS; i++)
2771 usb_pc_free_mem(&sc->sc_hw.devs[index].endpoint_pc[i]);
2774 static struct xhci_endpoint_ext *
2775 xhci_get_endpoint_ext(struct usb_device *udev, struct usb_endpoint_descriptor *edesc)
2777 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
2778 struct xhci_endpoint_ext *pepext;
2779 struct usb_page_cache *pc;
2780 struct usb_page_search buf_ep;
2784 epno = edesc->bEndpointAddress;
2785 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL)
2788 epno = XHCI_EPNO2EPID(epno);
2790 index = udev->controller_slot_id;
2792 pc = &sc->sc_hw.devs[index].endpoint_pc[epno];
2794 usbd_get_page(pc, 0, &buf_ep);
2796 pepext = &sc->sc_hw.devs[index].endp[epno];
2797 pepext->page_cache = pc;
2798 pepext->trb = buf_ep.buffer;
2799 pepext->physaddr = buf_ep.physaddr;
2805 xhci_endpoint_doorbell(struct usb_xfer *xfer)
2807 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
2811 epno = xfer->endpointno;
2812 if (xfer->flags_int.control_xfr)
2815 epno = XHCI_EPNO2EPID(epno);
2816 index = xfer->xroot->udev->controller_slot_id;
2818 if (xfer->xroot->udev->flags.self_suspended == 0) {
2819 XWRITE4(sc, door, XHCI_DOORBELL(index),
2820 epno | XHCI_DB_SID_SET(xfer->stream_id));
2825 xhci_transfer_remove(struct usb_xfer *xfer, usb_error_t error)
2827 struct xhci_endpoint_ext *pepext;
2829 if (xfer->flags_int.bandwidth_reclaimed) {
2830 xfer->flags_int.bandwidth_reclaimed = 0;
2832 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2833 xfer->endpoint->edesc);
2835 pepext->trb_used[xfer->stream_id]--;
2837 pepext->xfer[xfer->qh_pos] = NULL;
2839 if (error && pepext->trb_running != 0) {
2840 pepext->trb_halted = 1;
2841 pepext->trb_running = 0;
2847 xhci_transfer_insert(struct usb_xfer *xfer)
2849 struct xhci_td *td_first;
2850 struct xhci_td *td_last;
2851 struct xhci_trb *trb_link;
2852 struct xhci_endpoint_ext *pepext;
2861 id = xfer->stream_id;
2863 /* check if already inserted */
2864 if (xfer->flags_int.bandwidth_reclaimed) {
2865 DPRINTFN(8, "Already in schedule\n");
2869 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
2870 xfer->endpoint->edesc);
2872 td_first = xfer->td_transfer_first;
2873 td_last = xfer->td_transfer_last;
2874 addr = pepext->physaddr;
2876 switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) {
2879 /* single buffered */
2883 /* multi buffered */
2884 trb_limit = (XHCI_MAX_TRANSFERS - 2);
2888 if (pepext->trb_used[id] >= trb_limit) {
2889 DPRINTFN(8, "Too many TDs queued.\n");
2890 return (USB_ERR_NOMEM);
2893 /* check for stopped condition, after putting transfer on interrupt queue */
2894 if (pepext->trb_running == 0) {
2895 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
2897 DPRINTFN(8, "Not running\n");
2899 /* start configuration */
2900 (void)usb_proc_msignal(USB_BUS_CONTROL_XFER_PROC(&sc->sc_bus),
2901 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2905 pepext->trb_used[id]++;
2907 /* get current TRB index */
2908 i = pepext->trb_index[id];
2910 /* get next TRB index */
2913 /* the last entry of the ring is a hardcoded link TRB */
2914 if (inext >= (XHCI_MAX_TRANSFERS - 1))
2917 /* store next TRB index, before stream ID offset is added */
2918 pepext->trb_index[id] = inext;
2920 /* offset for stream */
2921 i += id * XHCI_MAX_TRANSFERS;
2922 inext += id * XHCI_MAX_TRANSFERS;
2924 /* compute terminating return address */
2925 addr += (inext * sizeof(struct xhci_trb));
2927 /* compute link TRB pointer */
2928 trb_link = td_last->td_trb + td_last->ntrb;
2930 /* update next pointer of last link TRB */
2931 trb_link->qwTrb0 = htole64(addr);
2932 trb_link->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2933 trb_link->dwTrb3 = htole32(XHCI_TRB_3_IOC_BIT |
2934 XHCI_TRB_3_CYCLE_BIT |
2935 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2938 xhci_dump_trb(&td_last->td_trb[td_last->ntrb]);
2940 usb_pc_cpu_flush(td_last->page_cache);
2942 /* write ahead chain end marker */
2944 pepext->trb[inext].qwTrb0 = 0;
2945 pepext->trb[inext].dwTrb2 = 0;
2946 pepext->trb[inext].dwTrb3 = 0;
2948 /* update next pointer of link TRB */
2950 pepext->trb[i].qwTrb0 = htole64((uint64_t)td_first->td_self);
2951 pepext->trb[i].dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0));
2954 xhci_dump_trb(&pepext->trb[i]);
2956 usb_pc_cpu_flush(pepext->page_cache);
2958 /* toggle cycle bit which activates the transfer chain */
2960 pepext->trb[i].dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT |
2961 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK));
2963 usb_pc_cpu_flush(pepext->page_cache);
2965 DPRINTF("qh_pos = %u\n", i);
2967 pepext->xfer[i] = xfer;
2971 xfer->flags_int.bandwidth_reclaimed = 1;
2973 xhci_endpoint_doorbell(xfer);
2979 xhci_root_intr(struct xhci_softc *sc)
2983 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
2985 /* clear any old interrupt data */
2986 memset(sc->sc_hub_idata, 0, sizeof(sc->sc_hub_idata));
2988 for (i = 1; i <= sc->sc_noport; i++) {
2989 /* pick out CHANGE bits from the status register */
2990 if (XREAD4(sc, oper, XHCI_PORTSC(i)) & (
2991 XHCI_PS_CSC | XHCI_PS_PEC |
2992 XHCI_PS_OCC | XHCI_PS_WRC |
2993 XHCI_PS_PRC | XHCI_PS_PLC |
2995 sc->sc_hub_idata[i / 8] |= 1 << (i % 8);
2996 DPRINTF("port %d changed\n", i);
2999 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata,
3000 sizeof(sc->sc_hub_idata));
3003 /*------------------------------------------------------------------------*
3004 * xhci_device_done - XHCI done handler
3006 * NOTE: This function can be called two times in a row on
3007 * the same USB transfer. From close and from interrupt.
3008 *------------------------------------------------------------------------*/
3010 xhci_device_done(struct usb_xfer *xfer, usb_error_t error)
3012 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n",
3013 xfer, xfer->endpoint, error);
3015 /* remove transfer from HW queue */
3016 xhci_transfer_remove(xfer, error);
3018 /* dequeue transfer and start next transfer */
3019 usbd_transfer_done(xfer, error);
3022 /*------------------------------------------------------------------------*
3023 * XHCI data transfer support (generic type)
3024 *------------------------------------------------------------------------*/
3026 xhci_device_generic_open(struct usb_xfer *xfer)
3028 if (xfer->flags_int.isochronous_xfr) {
3029 switch (xfer->xroot->udev->speed) {
3030 case USB_SPEED_FULL:
3033 usb_hs_bandwidth_alloc(xfer);
3040 xhci_device_generic_close(struct usb_xfer *xfer)
3044 xhci_device_done(xfer, USB_ERR_CANCELLED);
3046 if (xfer->flags_int.isochronous_xfr) {
3047 switch (xfer->xroot->udev->speed) {
3048 case USB_SPEED_FULL:
3051 usb_hs_bandwidth_free(xfer);
3058 xhci_device_generic_multi_enter(struct usb_endpoint *ep,
3059 usb_stream_t stream_id, struct usb_xfer *enter_xfer)
3061 struct usb_xfer *xfer;
3063 /* check if there is a current transfer */
3064 xfer = ep->endpoint_q[stream_id].curr;
3069 * Check if the current transfer is started and then pickup
3070 * the next one, if any. Else wait for next start event due to
3071 * block on failure feature.
3073 if (!xfer->flags_int.bandwidth_reclaimed)
3076 xfer = TAILQ_FIRST(&ep->endpoint_q[stream_id].head);
3079 * In case of enter we have to consider that the
3080 * transfer is queued by the USB core after the enter
3089 /* try to multi buffer */
3090 xhci_transfer_insert(xfer);
3094 xhci_device_generic_enter(struct usb_xfer *xfer)
3098 /* set up TD's and QH */
3099 xhci_setup_generic_chain(xfer);
3101 xhci_device_generic_multi_enter(xfer->endpoint,
3102 xfer->stream_id, xfer);
3106 xhci_device_generic_start(struct usb_xfer *xfer)
3110 /* try to insert xfer on HW queue */
3111 xhci_transfer_insert(xfer);
3113 /* try to multi buffer */
3114 xhci_device_generic_multi_enter(xfer->endpoint,
3115 xfer->stream_id, NULL);
3117 /* add transfer last on interrupt queue */
3118 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer);
3120 /* start timeout, if any */
3121 if (xfer->timeout != 0)
3122 usbd_transfer_timeout_ms(xfer, &xhci_timeout, xfer->timeout);
3125 struct usb_pipe_methods xhci_device_generic_methods =
3127 .open = xhci_device_generic_open,
3128 .close = xhci_device_generic_close,
3129 .enter = xhci_device_generic_enter,
3130 .start = xhci_device_generic_start,
3133 /*------------------------------------------------------------------------*
3134 * xhci root HUB support
3135 *------------------------------------------------------------------------*
3136 * Simulate a hardware HUB by handling all the necessary requests.
3137 *------------------------------------------------------------------------*/
3139 #define HSETW(ptr, val) ptr = { (uint8_t)(val), (uint8_t)((val) >> 8) }
3142 struct usb_device_descriptor xhci_devd =
3144 .bLength = sizeof(xhci_devd),
3145 .bDescriptorType = UDESC_DEVICE, /* type */
3146 HSETW(.bcdUSB, 0x0300), /* USB version */
3147 .bDeviceClass = UDCLASS_HUB, /* class */
3148 .bDeviceSubClass = UDSUBCLASS_HUB, /* subclass */
3149 .bDeviceProtocol = UDPROTO_SSHUB, /* protocol */
3150 .bMaxPacketSize = 9, /* max packet size */
3151 HSETW(.idVendor, 0x0000), /* vendor */
3152 HSETW(.idProduct, 0x0000), /* product */
3153 HSETW(.bcdDevice, 0x0100), /* device version */
3157 .bNumConfigurations = 1, /* # of configurations */
3161 struct xhci_bos_desc xhci_bosd = {
3163 .bLength = sizeof(xhci_bosd.bosd),
3164 .bDescriptorType = UDESC_BOS,
3165 HSETW(.wTotalLength, sizeof(xhci_bosd)),
3166 .bNumDeviceCaps = 3,
3169 .bLength = sizeof(xhci_bosd.usb2extd),
3170 .bDescriptorType = 1,
3171 .bDevCapabilityType = 2,
3172 .bmAttributes[0] = 2,
3175 .bLength = sizeof(xhci_bosd.usbdcd),
3176 .bDescriptorType = UDESC_DEVICE_CAPABILITY,
3177 .bDevCapabilityType = 3,
3178 .bmAttributes = 0, /* XXX */
3179 HSETW(.wSpeedsSupported, 0x000C),
3180 .bFunctionalitySupport = 8,
3181 .bU1DevExitLat = 255, /* dummy - not used */
3182 .wU2DevExitLat = { 0x00, 0x08 },
3185 .bLength = sizeof(xhci_bosd.cidd),
3186 .bDescriptorType = 1,
3187 .bDevCapabilityType = 4,
3189 .bContainerID = 0, /* XXX */
3194 struct xhci_config_desc xhci_confd = {
3196 .bLength = sizeof(xhci_confd.confd),
3197 .bDescriptorType = UDESC_CONFIG,
3198 .wTotalLength[0] = sizeof(xhci_confd),
3200 .bConfigurationValue = 1,
3201 .iConfiguration = 0,
3202 .bmAttributes = UC_SELF_POWERED,
3203 .bMaxPower = 0 /* max power */
3206 .bLength = sizeof(xhci_confd.ifcd),
3207 .bDescriptorType = UDESC_INTERFACE,
3209 .bInterfaceClass = UICLASS_HUB,
3210 .bInterfaceSubClass = UISUBCLASS_HUB,
3211 .bInterfaceProtocol = 0,
3214 .bLength = sizeof(xhci_confd.endpd),
3215 .bDescriptorType = UDESC_ENDPOINT,
3216 .bEndpointAddress = UE_DIR_IN | XHCI_INTR_ENDPT,
3217 .bmAttributes = UE_INTERRUPT,
3218 .wMaxPacketSize[0] = 2, /* max 15 ports */
3222 .bLength = sizeof(xhci_confd.endpcd),
3223 .bDescriptorType = UDESC_ENDPOINT_SS_COMP,
3230 struct usb_hub_ss_descriptor xhci_hubd = {
3231 .bLength = sizeof(xhci_hubd),
3232 .bDescriptorType = UDESC_SS_HUB,
3236 xhci_roothub_exec(struct usb_device *udev,
3237 struct usb_device_request *req, const void **pptr, uint16_t *plength)
3239 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
3240 const char *str_ptr;
3251 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
3254 ptr = (const void *)&sc->sc_hub_desc;
3258 value = UGETW(req->wValue);
3259 index = UGETW(req->wIndex);
3261 DPRINTFN(3, "type=0x%02x request=0x%02x wLen=0x%04x "
3262 "wValue=0x%04x wIndex=0x%04x\n",
3263 req->bmRequestType, req->bRequest,
3264 UGETW(req->wLength), value, index);
3266 #define C(x,y) ((x) | ((y) << 8))
3267 switch (C(req->bRequest, req->bmRequestType)) {
3268 case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
3269 case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
3270 case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
3272 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
3273 * for the integrated root hub.
3276 case C(UR_GET_CONFIG, UT_READ_DEVICE):
3278 sc->sc_hub_desc.temp[0] = sc->sc_conf;
3280 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
3281 switch (value >> 8) {
3283 if ((value & 0xff) != 0) {
3284 err = USB_ERR_IOERROR;
3287 len = sizeof(xhci_devd);
3288 ptr = (const void *)&xhci_devd;
3292 if ((value & 0xff) != 0) {
3293 err = USB_ERR_IOERROR;
3296 len = sizeof(xhci_bosd);
3297 ptr = (const void *)&xhci_bosd;
3301 if ((value & 0xff) != 0) {
3302 err = USB_ERR_IOERROR;
3305 len = sizeof(xhci_confd);
3306 ptr = (const void *)&xhci_confd;
3310 switch (value & 0xff) {
3311 case 0: /* Language table */
3315 case 1: /* Vendor */
3316 str_ptr = sc->sc_vendor;
3319 case 2: /* Product */
3320 str_ptr = "XHCI root HUB";
3328 len = usb_make_str_desc(
3329 sc->sc_hub_desc.temp,
3330 sizeof(sc->sc_hub_desc.temp),
3335 err = USB_ERR_IOERROR;
3339 case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
3341 sc->sc_hub_desc.temp[0] = 0;
3343 case C(UR_GET_STATUS, UT_READ_DEVICE):
3345 USETW(sc->sc_hub_desc.stat.wStatus, UDS_SELF_POWERED);
3347 case C(UR_GET_STATUS, UT_READ_INTERFACE):
3348 case C(UR_GET_STATUS, UT_READ_ENDPOINT):
3350 USETW(sc->sc_hub_desc.stat.wStatus, 0);
3352 case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
3353 if (value >= XHCI_MAX_DEVICES) {
3354 err = USB_ERR_IOERROR;
3358 case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
3359 if (value != 0 && value != 1) {
3360 err = USB_ERR_IOERROR;
3363 sc->sc_conf = value;
3365 case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
3367 case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
3368 case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
3369 case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
3370 err = USB_ERR_IOERROR;
3372 case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
3374 case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
3377 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
3379 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
3380 DPRINTFN(9, "UR_CLEAR_PORT_FEATURE\n");
3383 (index > sc->sc_noport)) {
3384 err = USB_ERR_IOERROR;
3387 port = XHCI_PORTSC(index);
3389 v = XREAD4(sc, oper, port);
3390 i = XHCI_PS_PLS_GET(v);
3391 v &= ~XHCI_PS_CLEAR;
3394 case UHF_C_BH_PORT_RESET:
3395 XWRITE4(sc, oper, port, v | XHCI_PS_WRC);
3397 case UHF_C_PORT_CONFIG_ERROR:
3398 XWRITE4(sc, oper, port, v | XHCI_PS_CEC);
3400 case UHF_C_PORT_SUSPEND:
3401 case UHF_C_PORT_LINK_STATE:
3402 XWRITE4(sc, oper, port, v | XHCI_PS_PLC);
3404 case UHF_C_PORT_CONNECTION:
3405 XWRITE4(sc, oper, port, v | XHCI_PS_CSC);
3407 case UHF_C_PORT_ENABLE:
3408 XWRITE4(sc, oper, port, v | XHCI_PS_PEC);
3410 case UHF_C_PORT_OVER_CURRENT:
3411 XWRITE4(sc, oper, port, v | XHCI_PS_OCC);
3413 case UHF_C_PORT_RESET:
3414 XWRITE4(sc, oper, port, v | XHCI_PS_PRC);
3416 case UHF_PORT_ENABLE:
3417 XWRITE4(sc, oper, port, v | XHCI_PS_PED);
3419 case UHF_PORT_POWER:
3420 XWRITE4(sc, oper, port, v & ~XHCI_PS_PP);
3422 case UHF_PORT_INDICATOR:
3423 XWRITE4(sc, oper, port, v & ~XHCI_PS_PIC_SET(3));
3425 case UHF_PORT_SUSPEND:
3429 XWRITE4(sc, oper, port, v |
3430 XHCI_PS_PLS_SET(0xF) | XHCI_PS_LWS);
3433 /* wait 20ms for resume sequence to complete */
3434 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 50);
3437 XWRITE4(sc, oper, port, v |
3438 XHCI_PS_PLS_SET(0) | XHCI_PS_LWS);
3441 err = USB_ERR_IOERROR;
3446 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
3447 if ((value & 0xff) != 0) {
3448 err = USB_ERR_IOERROR;
3452 v = XREAD4(sc, capa, XHCI_HCSPARAMS0);
3454 sc->sc_hub_desc.hubd = xhci_hubd;
3456 sc->sc_hub_desc.hubd.bNbrPorts = sc->sc_noport;
3458 if (XHCI_HCS0_PPC(v))
3459 i = UHD_PWR_INDIVIDUAL;
3463 if (XHCI_HCS0_PIND(v))
3466 i |= UHD_OC_INDIVIDUAL;
3468 USETW(sc->sc_hub_desc.hubd.wHubCharacteristics, i);
3470 /* see XHCI section 5.4.9: */
3471 sc->sc_hub_desc.hubd.bPwrOn2PwrGood = 10;
3473 for (j = 1; j <= sc->sc_noport; j++) {
3475 v = XREAD4(sc, oper, XHCI_PORTSC(j));
3476 if (v & XHCI_PS_DR) {
3477 sc->sc_hub_desc.hubd.
3478 DeviceRemovable[j / 8] |= 1U << (j % 8);
3481 len = sc->sc_hub_desc.hubd.bLength;
3484 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
3486 memset(sc->sc_hub_desc.temp, 0, 16);
3489 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
3490 DPRINTFN(9, "UR_GET_STATUS i=%d\n", index);
3493 (index > sc->sc_noport)) {
3494 err = USB_ERR_IOERROR;
3498 v = XREAD4(sc, oper, XHCI_PORTSC(index));
3500 DPRINTFN(9, "port status=0x%08x\n", v);
3502 i = UPS_PORT_LINK_STATE_SET(XHCI_PS_PLS_GET(v));
3504 switch (XHCI_PS_SPEED_GET(v)) {
3506 i |= UPS_HIGH_SPEED;
3515 i |= UPS_OTHER_SPEED;
3519 if (v & XHCI_PS_CCS)
3520 i |= UPS_CURRENT_CONNECT_STATUS;
3521 if (v & XHCI_PS_PED)
3522 i |= UPS_PORT_ENABLED;
3523 if (v & XHCI_PS_OCA)
3524 i |= UPS_OVERCURRENT_INDICATOR;
3527 if (v & XHCI_PS_PP) {
3529 * The USB 3.0 RH is using the
3530 * USB 2.0's power bit
3532 i |= UPS_PORT_POWER;
3534 USETW(sc->sc_hub_desc.ps.wPortStatus, i);
3537 if (v & XHCI_PS_CSC)
3538 i |= UPS_C_CONNECT_STATUS;
3539 if (v & XHCI_PS_PEC)
3540 i |= UPS_C_PORT_ENABLED;
3541 if (v & XHCI_PS_OCC)
3542 i |= UPS_C_OVERCURRENT_INDICATOR;
3543 if (v & XHCI_PS_WRC)
3544 i |= UPS_C_BH_PORT_RESET;
3545 if (v & XHCI_PS_PRC)
3546 i |= UPS_C_PORT_RESET;
3547 if (v & XHCI_PS_PLC)
3548 i |= UPS_C_PORT_LINK_STATE;
3549 if (v & XHCI_PS_CEC)
3550 i |= UPS_C_PORT_CONFIG_ERROR;
3552 USETW(sc->sc_hub_desc.ps.wPortChange, i);
3553 len = sizeof(sc->sc_hub_desc.ps);
3556 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
3557 err = USB_ERR_IOERROR;
3560 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
3563 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
3569 (index > sc->sc_noport)) {
3570 err = USB_ERR_IOERROR;
3574 port = XHCI_PORTSC(index);
3575 v = XREAD4(sc, oper, port) & ~XHCI_PS_CLEAR;
3578 case UHF_PORT_U1_TIMEOUT:
3579 if (XHCI_PS_SPEED_GET(v) != 4) {
3580 err = USB_ERR_IOERROR;
3583 port = XHCI_PORTPMSC(index);
3584 v = XREAD4(sc, oper, port);
3585 v &= ~XHCI_PM3_U1TO_SET(0xFF);
3586 v |= XHCI_PM3_U1TO_SET(i);
3587 XWRITE4(sc, oper, port, v);
3589 case UHF_PORT_U2_TIMEOUT:
3590 if (XHCI_PS_SPEED_GET(v) != 4) {
3591 err = USB_ERR_IOERROR;
3594 port = XHCI_PORTPMSC(index);
3595 v = XREAD4(sc, oper, port);
3596 v &= ~XHCI_PM3_U2TO_SET(0xFF);
3597 v |= XHCI_PM3_U2TO_SET(i);
3598 XWRITE4(sc, oper, port, v);
3600 case UHF_BH_PORT_RESET:
3601 XWRITE4(sc, oper, port, v | XHCI_PS_WPR);
3603 case UHF_PORT_LINK_STATE:
3604 XWRITE4(sc, oper, port, v |
3605 XHCI_PS_PLS_SET(i) | XHCI_PS_LWS);
3606 /* 4ms settle time */
3607 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 250);
3609 case UHF_PORT_ENABLE:
3610 DPRINTFN(3, "set port enable %d\n", index);
3612 case UHF_PORT_SUSPEND:
3613 DPRINTFN(6, "suspend port %u (LPM=%u)\n", index, i);
3614 j = XHCI_PS_SPEED_GET(v);
3615 if ((j < 1) || (j > 3)) {
3616 /* non-supported speed */
3617 err = USB_ERR_IOERROR;
3620 XWRITE4(sc, oper, port, v |
3621 XHCI_PS_PLS_SET(i ? 2 /* LPM */ : 3) | XHCI_PS_LWS);
3623 case UHF_PORT_RESET:
3624 DPRINTFN(6, "reset port %d\n", index);
3625 XWRITE4(sc, oper, port, v | XHCI_PS_PR);
3627 case UHF_PORT_POWER:
3628 DPRINTFN(3, "set port power %d\n", index);
3629 XWRITE4(sc, oper, port, v | XHCI_PS_PP);
3632 DPRINTFN(3, "set port test %d\n", index);
3634 case UHF_PORT_INDICATOR:
3635 DPRINTFN(3, "set port indicator %d\n", index);
3637 v &= ~XHCI_PS_PIC_SET(3);
3638 v |= XHCI_PS_PIC_SET(1);
3640 XWRITE4(sc, oper, port, v);
3643 err = USB_ERR_IOERROR;
3648 case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER):
3649 case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER):
3650 case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER):
3651 case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER):
3654 err = USB_ERR_IOERROR;
3664 xhci_xfer_setup(struct usb_setup_params *parm)
3666 struct usb_page_search page_info;
3667 struct usb_page_cache *pc;
3668 struct xhci_softc *sc;
3669 struct usb_xfer *xfer;
3674 sc = XHCI_BUS2SC(parm->udev->bus);
3675 xfer = parm->curr_xfer;
3678 * The proof for the "ntd" formula is illustrated like this:
3680 * +------------------------------------+
3684 * | | xxx | x | frm 0 |
3686 * | | xxx | xx | frm 1 |
3689 * +------------------------------------+
3691 * "xxx" means a completely full USB transfer descriptor
3693 * "x" and "xx" means a short USB packet
3695 * For the remainder of an USB transfer modulo
3696 * "max_data_length" we need two USB transfer descriptors.
3697 * One to transfer the remaining data and one to finalise with
3698 * a zero length packet in case the "force_short_xfer" flag is
3699 * set. We only need two USB transfer descriptors in the case
3700 * where the transfer length of the first one is a factor of
3701 * "max_frame_size". The rest of the needed USB transfer
3702 * descriptors is given by the buffer size divided by the
3703 * maximum data payload.
3705 parm->hc_max_packet_size = 0x400;
3706 parm->hc_max_packet_count = 16 * 3;
3707 parm->hc_max_frame_size = XHCI_TD_PAYLOAD_MAX;
3709 xfer->flags_int.bdma_enable = 1;
3711 usbd_transfer_setup_sub(parm);
3713 if (xfer->flags_int.isochronous_xfr) {
3714 ntd = ((1 * xfer->nframes)
3715 + (xfer->max_data_length / xfer->max_hc_frame_size));
3716 } else if (xfer->flags_int.control_xfr) {
3717 ntd = ((2 * xfer->nframes) + 1 /* STATUS */
3718 + (xfer->max_data_length / xfer->max_hc_frame_size));
3720 ntd = ((2 * xfer->nframes)
3721 + (xfer->max_data_length / xfer->max_hc_frame_size));
3730 * Allocate queue heads and transfer descriptors
3734 if (usbd_transfer_setup_sub_malloc(
3735 parm, &pc, sizeof(struct xhci_td),
3736 XHCI_TD_ALIGN, ntd)) {
3737 parm->err = USB_ERR_NOMEM;
3741 for (n = 0; n != ntd; n++) {
3744 usbd_get_page(pc + n, 0, &page_info);
3746 td = page_info.buffer;
3749 td->td_self = page_info.physaddr;
3750 td->obj_next = last_obj;
3751 td->page_cache = pc + n;
3755 usb_pc_cpu_flush(pc + n);
3758 xfer->td_start[xfer->flags_int.curr_dma_set] = last_obj;
3760 if (!xfer->flags_int.curr_dma_set) {
3761 xfer->flags_int.curr_dma_set = 1;
3767 xhci_configure_reset_endpoint(struct usb_xfer *xfer)
3769 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
3770 struct usb_page_search buf_inp;
3771 struct usb_device *udev;
3772 struct xhci_endpoint_ext *pepext;
3773 struct usb_endpoint_descriptor *edesc;
3774 struct usb_page_cache *pcinp;
3776 usb_stream_t stream_id;
3780 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
3781 xfer->endpoint->edesc);
3783 udev = xfer->xroot->udev;
3784 index = udev->controller_slot_id;
3786 pcinp = &sc->sc_hw.devs[index].input_pc;
3788 usbd_get_page(pcinp, 0, &buf_inp);
3790 edesc = xfer->endpoint->edesc;
3792 epno = edesc->bEndpointAddress;
3793 stream_id = xfer->stream_id;
3795 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL)
3798 epno = XHCI_EPNO2EPID(epno);
3801 return (USB_ERR_NO_PIPE); /* invalid */
3805 /* configure endpoint */
3807 err = xhci_configure_endpoint_by_xfer(xfer);
3810 XHCI_CMD_UNLOCK(sc);
3815 * Get the endpoint into the stopped state according to the
3816 * endpoint context state diagram in the XHCI specification:
3819 err = xhci_cmd_stop_ep(sc, 0, epno, index);
3822 DPRINTF("Could not stop endpoint %u\n", epno);
3824 err = xhci_cmd_reset_ep(sc, 0, epno, index);
3827 DPRINTF("Could not reset endpoint %u\n", epno);
3829 err = xhci_cmd_set_tr_dequeue_ptr(sc,
3830 (pepext->physaddr + (stream_id * sizeof(struct xhci_trb) *
3831 XHCI_MAX_TRANSFERS)) | XHCI_EPCTX_2_DCS_SET(1),
3832 stream_id, epno, index);
3835 DPRINTF("Could not set dequeue ptr for endpoint %u\n", epno);
3838 * Get the endpoint into the running state according to the
3839 * endpoint context state diagram in the XHCI specification:
3842 xhci_configure_mask(udev, (1U << epno) | 1U, 0);
3844 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index);
3847 DPRINTF("Could not configure endpoint %u\n", epno);
3849 err = xhci_cmd_configure_ep(sc, buf_inp.physaddr, 0, index);
3852 DPRINTF("Could not configure endpoint %u\n", epno);
3854 XHCI_CMD_UNLOCK(sc);
3860 xhci_xfer_unsetup(struct usb_xfer *xfer)
3866 xhci_start_dma_delay(struct usb_xfer *xfer)
3868 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus);
3870 /* put transfer on interrupt queue (again) */
3871 usbd_transfer_enqueue(&sc->sc_bus.intr_q, xfer);
3873 (void)usb_proc_msignal(USB_BUS_CONTROL_XFER_PROC(&sc->sc_bus),
3874 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
3878 xhci_configure_msg(struct usb_proc_msg *pm)
3880 struct xhci_softc *sc;
3881 struct xhci_endpoint_ext *pepext;
3882 struct usb_xfer *xfer;
3884 sc = XHCI_BUS2SC(((struct usb_bus_msg *)pm)->bus);
3887 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3889 pepext = xhci_get_endpoint_ext(xfer->xroot->udev,
3890 xfer->endpoint->edesc);
3892 if ((pepext->trb_halted != 0) ||
3893 (pepext->trb_running == 0)) {
3897 /* clear halted and running */
3898 pepext->trb_halted = 0;
3899 pepext->trb_running = 0;
3901 /* nuke remaining buffered transfers */
3903 for (i = 0; i != (XHCI_MAX_TRANSFERS *
3904 XHCI_MAX_STREAMS); i++) {
3906 * NOTE: We need to use the timeout
3907 * error code here else existing
3908 * isochronous clients can get
3911 if (pepext->xfer[i] != NULL) {
3912 xhci_device_done(pepext->xfer[i],
3918 * NOTE: The USB transfer cannot vanish in
3922 USB_BUS_UNLOCK(&sc->sc_bus);
3924 xhci_configure_reset_endpoint(xfer);
3926 USB_BUS_LOCK(&sc->sc_bus);
3928 /* check if halted is still cleared */
3929 if (pepext->trb_halted == 0) {
3930 pepext->trb_running = 1;
3931 memset(pepext->trb_index, 0,
3932 sizeof(pepext->trb_index));
3937 if (xfer->flags_int.did_dma_delay) {
3939 /* remove transfer from interrupt queue (again) */
3940 usbd_transfer_dequeue(xfer);
3942 /* we are finally done */
3943 usb_dma_delay_done_cb(xfer);
3945 /* queue changed - restart */
3950 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3952 /* try to insert xfer on HW queue */
3953 xhci_transfer_insert(xfer);
3955 /* try to multi buffer */
3956 xhci_device_generic_multi_enter(xfer->endpoint,
3957 xfer->stream_id, NULL);
3962 xhci_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc,
3963 struct usb_endpoint *ep)
3965 struct xhci_endpoint_ext *pepext;
3967 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d\n",
3968 ep, udev->address, edesc->bEndpointAddress, udev->flags.usb_mode);
3970 if (udev->parent_hub == NULL) {
3971 /* root HUB has special endpoint handling */
3975 ep->methods = &xhci_device_generic_methods;
3977 pepext = xhci_get_endpoint_ext(udev, edesc);
3979 USB_BUS_LOCK(udev->bus);
3980 pepext->trb_halted = 1;
3981 pepext->trb_running = 0;
3982 USB_BUS_UNLOCK(udev->bus);
3986 xhci_ep_uninit(struct usb_device *udev, struct usb_endpoint *ep)
3992 xhci_ep_clear_stall(struct usb_device *udev, struct usb_endpoint *ep)
3994 struct xhci_endpoint_ext *pepext;
3998 if (udev->flags.usb_mode != USB_MODE_HOST) {
4002 if (udev->parent_hub == NULL) {
4003 /* root HUB has special endpoint handling */
4007 pepext = xhci_get_endpoint_ext(udev, ep->edesc);
4009 USB_BUS_LOCK(udev->bus);
4010 pepext->trb_halted = 1;
4011 pepext->trb_running = 0;
4012 USB_BUS_UNLOCK(udev->bus);
4016 xhci_device_init(struct usb_device *udev)
4018 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4022 /* no init for root HUB */
4023 if (udev->parent_hub == NULL)
4028 /* set invalid default */
4030 udev->controller_slot_id = sc->sc_noslot + 1;
4032 /* try to get a new slot ID from the XHCI */
4034 err = xhci_cmd_enable_slot(sc, &temp);
4037 XHCI_CMD_UNLOCK(sc);
4041 if (temp > sc->sc_noslot) {
4042 XHCI_CMD_UNLOCK(sc);
4043 return (USB_ERR_BAD_ADDRESS);
4046 if (sc->sc_hw.devs[temp].state != XHCI_ST_DISABLED) {
4047 DPRINTF("slot %u already allocated.\n", temp);
4048 XHCI_CMD_UNLOCK(sc);
4049 return (USB_ERR_BAD_ADDRESS);
4052 /* store slot ID for later reference */
4054 udev->controller_slot_id = temp;
4056 /* reset data structure */
4058 memset(&sc->sc_hw.devs[temp], 0, sizeof(sc->sc_hw.devs[0]));
4060 /* set mark slot allocated */
4062 sc->sc_hw.devs[temp].state = XHCI_ST_ENABLED;
4064 err = xhci_alloc_device_ext(udev);
4066 XHCI_CMD_UNLOCK(sc);
4068 /* get device into default state */
4071 err = xhci_set_address(udev, NULL, 0);
4077 xhci_device_uninit(struct usb_device *udev)
4079 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4082 /* no init for root HUB */
4083 if (udev->parent_hub == NULL)
4088 index = udev->controller_slot_id;
4090 if (index <= sc->sc_noslot) {
4091 xhci_cmd_disable_slot(sc, index);
4092 sc->sc_hw.devs[index].state = XHCI_ST_DISABLED;
4094 /* free device extension */
4095 xhci_free_device_ext(udev);
4098 XHCI_CMD_UNLOCK(sc);
4102 xhci_get_dma_delay(struct usb_device *udev, uint32_t *pus)
4105 * Wait until the hardware has finished any possible use of
4106 * the transfer descriptor(s)
4108 *pus = 2048; /* microseconds */
4112 xhci_device_resume(struct usb_device *udev)
4114 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4121 /* check for root HUB */
4122 if (udev->parent_hub == NULL)
4125 index = udev->controller_slot_id;
4129 /* blindly resume all endpoints */
4131 USB_BUS_LOCK(udev->bus);
4133 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) {
4134 for (p = 0; p != XHCI_MAX_STREAMS; p++) {
4135 XWRITE4(sc, door, XHCI_DOORBELL(index),
4136 n | XHCI_DB_SID_SET(p));
4140 USB_BUS_UNLOCK(udev->bus);
4142 XHCI_CMD_UNLOCK(sc);
4146 xhci_device_suspend(struct usb_device *udev)
4148 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4155 /* check for root HUB */
4156 if (udev->parent_hub == NULL)
4159 index = udev->controller_slot_id;
4163 /* blindly suspend all endpoints */
4165 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) {
4166 err = xhci_cmd_stop_ep(sc, 1, n, index);
4168 DPRINTF("Failed to suspend endpoint "
4169 "%u on slot %u (ignored).\n", n, index);
4173 XHCI_CMD_UNLOCK(sc);
4177 xhci_set_hw_power(struct usb_bus *bus)
4183 xhci_device_state_change(struct usb_device *udev)
4185 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus);
4186 struct usb_page_search buf_inp;
4190 /* check for root HUB */
4191 if (udev->parent_hub == NULL)
4194 index = udev->controller_slot_id;
4198 if (usb_get_device_state(udev) == USB_STATE_CONFIGURED) {
4199 err = uhub_query_info(udev, &sc->sc_hw.devs[index].nports,
4200 &sc->sc_hw.devs[index].tt);
4202 sc->sc_hw.devs[index].nports = 0;
4207 switch (usb_get_device_state(udev)) {
4208 case USB_STATE_POWERED:
4209 if (sc->sc_hw.devs[index].state == XHCI_ST_DEFAULT)
4212 /* set default state */
4213 sc->sc_hw.devs[index].state = XHCI_ST_DEFAULT;
4215 /* reset number of contexts */
4216 sc->sc_hw.devs[index].context_num = 0;
4218 err = xhci_cmd_reset_dev(sc, index);
4221 DPRINTF("Device reset failed "
4222 "for slot %u.\n", index);
4226 case USB_STATE_ADDRESSED:
4227 if (sc->sc_hw.devs[index].state == XHCI_ST_ADDRESSED)
4230 sc->sc_hw.devs[index].state = XHCI_ST_ADDRESSED;
4232 err = xhci_cmd_configure_ep(sc, 0, 1, index);
4235 DPRINTF("Failed to deconfigure "
4236 "slot %u.\n", index);
4240 case USB_STATE_CONFIGURED:
4241 if (sc->sc_hw.devs[index].state == XHCI_ST_CONFIGURED)
4244 /* set configured state */
4245 sc->sc_hw.devs[index].state = XHCI_ST_CONFIGURED;
4247 /* reset number of contexts */
4248 sc->sc_hw.devs[index].context_num = 0;
4250 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp);
4252 xhci_configure_mask(udev, 3, 0);
4254 err = xhci_configure_device(udev);
4256 DPRINTF("Could not configure device "
4257 "at slot %u.\n", index);
4260 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index);
4262 DPRINTF("Could not evaluate device "
4263 "context at slot %u.\n", index);
4270 XHCI_CMD_UNLOCK(sc);
4274 xhci_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
4278 case USB_EP_MODE_DEFAULT:
4280 case USB_EP_MODE_STREAMS:
4281 if (xhcistreams == 0 ||
4282 (ep->edesc->bmAttributes & UE_XFERTYPE) != UE_BULK ||
4283 udev->speed != USB_SPEED_SUPER)
4284 return (USB_ERR_INVAL);
4287 return (USB_ERR_INVAL);
4291 struct usb_bus_methods xhci_bus_methods = {
4292 .endpoint_init = xhci_ep_init,
4293 .endpoint_uninit = xhci_ep_uninit,
4294 .xfer_setup = xhci_xfer_setup,
4295 .xfer_unsetup = xhci_xfer_unsetup,
4296 .get_dma_delay = xhci_get_dma_delay,
4297 .device_init = xhci_device_init,
4298 .device_uninit = xhci_device_uninit,
4299 .device_resume = xhci_device_resume,
4300 .device_suspend = xhci_device_suspend,
4301 .set_hw_power = xhci_set_hw_power,
4302 .roothub_exec = xhci_roothub_exec,
4303 .xfer_poll = xhci_do_poll,
4304 .start_dma_delay = xhci_start_dma_delay,
4305 .set_address = xhci_set_address,
4306 .clear_stall = xhci_ep_clear_stall,
4307 .device_state_change = xhci_device_state_change,
4308 .set_hw_power_sleep = xhci_set_hw_power_sleep,
4309 .set_endpoint_mode = xhci_set_endpoint_mode,