1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 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. 13 * 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 24 * SUCH DAMAGE. 25 */ 26 27 /* 28 * USB eXtensible Host Controller Interface, a.k.a. USB 3.0 controller. 29 * 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 34 */ 35 36 /* 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. 41 */ 42 43 #ifdef USB_GLOBAL_INCLUDE_FILE 44 #include USB_GLOBAL_INCLUDE_FILE 45 #else 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> 53 #include <sys/bus.h> 54 #include <sys/module.h> 55 #include <sys/lock.h> 56 #include <sys/mutex.h> 57 #include <sys/condvar.h> 58 #include <sys/sysctl.h> 59 #include <sys/sx.h> 60 #include <sys/unistd.h> 61 #include <sys/callout.h> 62 #include <sys/malloc.h> 63 #include <sys/priv.h> 64 65 #include <dev/usb/usb.h> 66 #include <dev/usb/usbdi.h> 67 68 #define USB_DEBUG_VAR xhcidebug 69 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> 78 79 #include <dev/usb/usb_controller.h> 80 #include <dev/usb/usb_bus.h> 81 #endif /* USB_GLOBAL_INCLUDE_FILE */ 82 83 #include <dev/usb/controller/xhci.h> 84 #include <dev/usb/controller/xhcireg.h> 85 86 #define XHCI_BUS2SC(bus) \ 87 ((struct xhci_softc *)(((uint8_t *)(bus)) - \ 88 ((uint8_t *)&(((struct xhci_softc *)0)->sc_bus)))) 89 90 static SYSCTL_NODE(_hw_usb, OID_AUTO, xhci, CTLFLAG_RW, 0, "USB XHCI"); 91 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); 96 97 #ifdef USB_DEBUG 98 static int xhcidebug; 99 static int xhciroute; 100 static int xhcipolling; 101 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); 111 #else 112 #define xhciroute 0 113 #endif 114 115 #define XHCI_INTR_ENDPT 1 116 117 struct xhci_std_temp { 118 struct xhci_softc *sc; 119 struct usb_page_cache *pc; 120 struct xhci_td *td; 121 struct xhci_td *td_next; 122 uint32_t len; 123 uint32_t offset; 124 uint32_t max_packet_size; 125 uint32_t average; 126 uint16_t isoc_delta; 127 uint16_t isoc_frame; 128 uint8_t shortpkt; 129 uint8_t multishort; 130 uint8_t last_frame; 131 uint8_t trb_type; 132 uint8_t direction; 133 uint8_t tbc; 134 uint8_t tlbpc; 135 uint8_t step_td; 136 uint8_t do_isoc_sync; 137 }; 138 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, 150 uint8_t); 151 static usb_error_t xhci_configure_mask(struct usb_device *, 152 uint32_t, uint8_t); 153 static usb_error_t xhci_cmd_evaluate_ctx(struct xhci_softc *, 154 uint64_t, uint8_t); 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); 159 #ifdef USB_DEBUG 160 static uint64_t xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr); 161 #endif 162 163 static const struct usb_bus_methods xhci_bus_methods; 164 165 #ifdef USB_DEBUG 166 static void 167 xhci_dump_trb(struct xhci_trb *trb) 168 { 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)); 173 } 174 175 static void 176 xhci_dump_endpoint(struct xhci_softc *sc, struct xhci_endp_ctx *pep) 177 { 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)); 186 } 187 188 static void 189 xhci_dump_device(struct xhci_softc *sc, struct xhci_slot_ctx *psl) 190 { 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)); 196 } 197 #endif 198 199 uint8_t 200 xhci_use_polling(void) 201 { 202 #ifdef USB_DEBUG 203 return (xhcipolling != 0); 204 #else 205 return (0); 206 #endif 207 } 208 209 static void 210 xhci_iterate_hw_softc(struct usb_bus *bus, usb_bus_mem_sub_cb_t *cb) 211 { 212 struct xhci_softc *sc = XHCI_BUS2SC(bus); 213 uint8_t i; 214 215 cb(bus, &sc->sc_hw.root_pc, &sc->sc_hw.root_pg, 216 sizeof(struct xhci_hw_root), XHCI_PAGE_SIZE); 217 218 cb(bus, &sc->sc_hw.ctx_pc, &sc->sc_hw.ctx_pg, 219 sizeof(struct xhci_dev_ctx_addr), XHCI_PAGE_SIZE); 220 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); 224 } 225 } 226 227 static void 228 xhci_ctx_set_le32(struct xhci_softc *sc, volatile uint32_t *ptr, uint32_t val) 229 { 230 if (sc->sc_ctx_is_64_byte) { 231 uint32_t offset; 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); 236 } 237 *ptr = htole32(val); 238 } 239 240 static uint32_t 241 xhci_ctx_get_le32(struct xhci_softc *sc, volatile uint32_t *ptr) 242 { 243 if (sc->sc_ctx_is_64_byte) { 244 uint32_t offset; 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); 249 } 250 return (le32toh(*ptr)); 251 } 252 253 static void 254 xhci_ctx_set_le64(struct xhci_softc *sc, volatile uint64_t *ptr, uint64_t val) 255 { 256 if (sc->sc_ctx_is_64_byte) { 257 uint32_t offset; 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); 262 } 263 *ptr = htole64(val); 264 } 265 266 #ifdef USB_DEBUG 267 static uint64_t 268 xhci_ctx_get_le64(struct xhci_softc *sc, volatile uint64_t *ptr) 269 { 270 if (sc->sc_ctx_is_64_byte) { 271 uint32_t offset; 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); 276 } 277 return (le64toh(*ptr)); 278 } 279 #endif 280 281 static int 282 xhci_reset_command_queue_locked(struct xhci_softc *sc) 283 { 284 struct usb_page_search buf_res; 285 struct xhci_hw_root *phwr; 286 uint64_t addr; 287 uint32_t temp; 288 289 DPRINTF("\n"); 290 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); 295 296 /* 297 * Try to abort the last command as per section 298 * 4.6.1.2 "Aborting a Command" of the XHCI 299 * specification: 300 */ 301 302 /* stop and cancel */ 303 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CS); 304 XWRITE4(sc, oper, XHCI_CRCR_HI, 0); 305 306 XWRITE4(sc, oper, XHCI_CRCR_LO, temp | XHCI_CRCR_LO_CA); 307 XWRITE4(sc, oper, XHCI_CRCR_HI, 0); 308 309 /* wait 250ms */ 310 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 4); 311 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); 317 } 318 } 319 320 /* reset command ring */ 321 sc->sc_command_ccs = 1; 322 sc->sc_command_idx = 0; 323 324 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res); 325 326 /* setup 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]; 330 331 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr); 332 333 memset(phwr->hwr_commands, 0, sizeof(phwr->hwr_commands)); 334 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr); 335 336 usb_pc_cpu_flush(&sc->sc_hw.root_pc); 337 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)); 340 341 return (0); 342 } 343 344 usb_error_t 345 xhci_start_controller(struct xhci_softc *sc) 346 { 347 struct usb_page_search buf_res; 348 struct xhci_hw_root *phwr; 349 struct xhci_dev_ctx_addr *pdctxa; 350 uint64_t addr; 351 uint32_t temp; 352 uint16_t i; 353 354 DPRINTF("\n"); 355 356 sc->sc_capa_off = 0; 357 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH); 358 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0x1F; 359 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3; 360 361 DPRINTF("CAPLENGTH=0x%x\n", sc->sc_oper_off); 362 DPRINTF("RUNTIMEOFFSET=0x%x\n", sc->sc_runt_off); 363 DPRINTF("DOOROFFSET=0x%x\n", sc->sc_door_off); 364 365 sc->sc_event_ccs = 1; 366 sc->sc_event_idx = 0; 367 sc->sc_command_ccs = 1; 368 sc->sc_command_idx = 0; 369 370 DPRINTF("xHCI version = 0x%04x\n", XREAD2(sc, capa, XHCI_HCIVERSION)); 371 372 temp = XREAD4(sc, capa, XHCI_HCSPARAMS0); 373 374 DPRINTF("HCS0 = 0x%08x\n", temp); 375 376 if (XHCI_HCS0_CSZ(temp)) { 377 sc->sc_ctx_is_64_byte = 1; 378 device_printf(sc->sc_bus.parent, "64 byte context size.\n"); 379 } else { 380 sc->sc_ctx_is_64_byte = 0; 381 device_printf(sc->sc_bus.parent, "32 byte context size.\n"); 382 } 383 384 /* Reset controller */ 385 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_HCRST); 386 387 for (i = 0; i != 100; i++) { 388 usb_pause_mtx(NULL, hz / 100); 389 temp = (XREAD4(sc, oper, XHCI_USBCMD) & XHCI_CMD_HCRST) | 390 (XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_CNR); 391 if (!temp) 392 break; 393 } 394 395 if (temp) { 396 device_printf(sc->sc_bus.parent, "Controller " 397 "reset timeout.\n"); 398 return (USB_ERR_IOERROR); 399 } 400 401 if (!(XREAD4(sc, oper, XHCI_PAGESIZE) & XHCI_PAGESIZE_4K)) { 402 device_printf(sc->sc_bus.parent, "Controller does " 403 "not support 4K page size.\n"); 404 return (USB_ERR_IOERROR); 405 } 406 407 temp = XREAD4(sc, capa, XHCI_HCSPARAMS1); 408 409 i = XHCI_HCS1_N_PORTS(temp); 410 411 if (i == 0) { 412 device_printf(sc->sc_bus.parent, "Invalid number " 413 "of ports: %u\n", i); 414 return (USB_ERR_IOERROR); 415 } 416 417 sc->sc_noport = i; 418 sc->sc_noslot = XHCI_HCS1_DEVSLOT_MAX(temp); 419 420 if (sc->sc_noslot > XHCI_MAX_DEVICES) 421 sc->sc_noslot = XHCI_MAX_DEVICES; 422 423 /* setup number of device slots */ 424 425 DPRINTF("CONFIG=0x%08x -> 0x%08x\n", 426 XREAD4(sc, oper, XHCI_CONFIG), sc->sc_noslot); 427 428 XWRITE4(sc, oper, XHCI_CONFIG, sc->sc_noslot); 429 430 DPRINTF("Max slots: %u\n", sc->sc_noslot); 431 432 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2); 433 434 sc->sc_noscratch = XHCI_HCS2_SPB_MAX(temp); 435 436 if (sc->sc_noscratch > XHCI_MAX_SCRATCHPADS) { 437 device_printf(sc->sc_bus.parent, "XHCI request " 438 "too many scratchpads\n"); 439 return (USB_ERR_NOMEM); 440 } 441 442 DPRINTF("Max scratch: %u\n", sc->sc_noscratch); 443 444 temp = XREAD4(sc, capa, XHCI_HCSPARAMS3); 445 446 sc->sc_exit_lat_max = XHCI_HCS3_U1_DEL(temp) + 447 XHCI_HCS3_U2_DEL(temp) + 250 /* us */; 448 449 temp = XREAD4(sc, oper, XHCI_USBSTS); 450 451 /* clear interrupts */ 452 XWRITE4(sc, oper, XHCI_USBSTS, temp); 453 /* disable all device notifications */ 454 XWRITE4(sc, oper, XHCI_DNCTRL, 0); 455 456 /* setup device context base address */ 457 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res); 458 pdctxa = buf_res.buffer; 459 memset(pdctxa, 0, sizeof(*pdctxa)); 460 461 addr = buf_res.physaddr; 462 addr += (uintptr_t)&((struct xhci_dev_ctx_addr *)0)->qwSpBufPtr[0]; 463 464 /* slot 0 points to the table of scratchpad pointers */ 465 pdctxa->qwBaaDevCtxAddr[0] = htole64(addr); 466 467 for (i = 0; i != sc->sc_noscratch; i++) { 468 struct usb_page_search buf_scp; 469 usbd_get_page(&sc->sc_hw.scratch_pc[i], 0, &buf_scp); 470 pdctxa->qwSpBufPtr[i] = htole64((uint64_t)buf_scp.physaddr); 471 } 472 473 addr = buf_res.physaddr; 474 475 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr); 476 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32)); 477 XWRITE4(sc, oper, XHCI_DCBAAP_LO, (uint32_t)addr); 478 XWRITE4(sc, oper, XHCI_DCBAAP_HI, (uint32_t)(addr >> 32)); 479 480 /* Setup event table size */ 481 482 temp = XREAD4(sc, capa, XHCI_HCSPARAMS2); 483 484 DPRINTF("HCS2=0x%08x\n", temp); 485 486 temp = XHCI_HCS2_ERST_MAX(temp); 487 temp = 1U << temp; 488 if (temp > XHCI_MAX_RSEG) 489 temp = XHCI_MAX_RSEG; 490 491 sc->sc_erst_max = temp; 492 493 DPRINTF("ERSTSZ=0x%08x -> 0x%08x\n", 494 XREAD4(sc, runt, XHCI_ERSTSZ(0)), temp); 495 496 XWRITE4(sc, runt, XHCI_ERSTSZ(0), XHCI_ERSTS_SET(temp)); 497 498 /* Setup interrupt rate */ 499 XWRITE4(sc, runt, XHCI_IMOD(0), XHCI_IMOD_DEFAULT); 500 501 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res); 502 503 phwr = buf_res.buffer; 504 addr = buf_res.physaddr; 505 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[0]; 506 507 /* reset hardware root structure */ 508 memset(phwr, 0, sizeof(*phwr)); 509 510 phwr->hwr_ring_seg[0].qwEvrsTablePtr = htole64(addr); 511 phwr->hwr_ring_seg[0].dwEvrsTableSize = htole32(XHCI_MAX_EVENTS); 512 513 DPRINTF("ERDP(0)=0x%016llx\n", (unsigned long long)addr); 514 515 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr); 516 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32)); 517 518 addr = (uint64_t)buf_res.physaddr; 519 520 DPRINTF("ERSTBA(0)=0x%016llx\n", (unsigned long long)addr); 521 522 XWRITE4(sc, runt, XHCI_ERSTBA_LO(0), (uint32_t)addr); 523 XWRITE4(sc, runt, XHCI_ERSTBA_HI(0), (uint32_t)(addr >> 32)); 524 525 /* Setup interrupter registers */ 526 527 temp = XREAD4(sc, runt, XHCI_IMAN(0)); 528 temp |= XHCI_IMAN_INTR_ENA; 529 XWRITE4(sc, runt, XHCI_IMAN(0), temp); 530 531 /* setup command ring control base address */ 532 addr = buf_res.physaddr; 533 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[0]; 534 535 DPRINTF("CRCR=0x%016llx\n", (unsigned long long)addr); 536 537 XWRITE4(sc, oper, XHCI_CRCR_LO, ((uint32_t)addr) | XHCI_CRCR_LO_RCS); 538 XWRITE4(sc, oper, XHCI_CRCR_HI, (uint32_t)(addr >> 32)); 539 540 phwr->hwr_commands[XHCI_MAX_COMMANDS - 1].qwTrb0 = htole64(addr); 541 542 usb_bus_mem_flush_all(&sc->sc_bus, &xhci_iterate_hw_softc); 543 544 /* Go! */ 545 XWRITE4(sc, oper, XHCI_USBCMD, XHCI_CMD_RS | 546 XHCI_CMD_INTE | XHCI_CMD_HSEE); 547 548 for (i = 0; i != 100; i++) { 549 usb_pause_mtx(NULL, hz / 100); 550 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH; 551 if (!temp) 552 break; 553 } 554 if (temp) { 555 XWRITE4(sc, oper, XHCI_USBCMD, 0); 556 device_printf(sc->sc_bus.parent, "Run timeout.\n"); 557 return (USB_ERR_IOERROR); 558 } 559 560 /* catch any lost interrupts */ 561 xhci_do_poll(&sc->sc_bus); 562 563 if (sc->sc_port_route != NULL) { 564 /* Route all ports to the XHCI by default */ 565 sc->sc_port_route(sc->sc_bus.parent, 566 ~xhciroute, xhciroute); 567 } 568 return (0); 569 } 570 571 usb_error_t 572 xhci_halt_controller(struct xhci_softc *sc) 573 { 574 uint32_t temp; 575 uint16_t i; 576 577 DPRINTF("\n"); 578 579 sc->sc_capa_off = 0; 580 sc->sc_oper_off = XREAD1(sc, capa, XHCI_CAPLENGTH); 581 sc->sc_runt_off = XREAD4(sc, capa, XHCI_RTSOFF) & ~0xF; 582 sc->sc_door_off = XREAD4(sc, capa, XHCI_DBOFF) & ~0x3; 583 584 /* Halt controller */ 585 XWRITE4(sc, oper, XHCI_USBCMD, 0); 586 587 for (i = 0; i != 100; i++) { 588 usb_pause_mtx(NULL, hz / 100); 589 temp = XREAD4(sc, oper, XHCI_USBSTS) & XHCI_STS_HCH; 590 if (temp) 591 break; 592 } 593 594 if (!temp) { 595 device_printf(sc->sc_bus.parent, "Controller halt timeout.\n"); 596 return (USB_ERR_IOERROR); 597 } 598 return (0); 599 } 600 601 usb_error_t 602 xhci_init(struct xhci_softc *sc, device_t self) 603 { 604 /* initialise some bus fields */ 605 sc->sc_bus.parent = self; 606 607 /* set the bus revision */ 608 sc->sc_bus.usbrev = USB_REV_3_0; 609 610 /* set up the bus struct */ 611 sc->sc_bus.methods = &xhci_bus_methods; 612 613 /* setup devices array */ 614 sc->sc_bus.devices = sc->sc_devices; 615 sc->sc_bus.devices_max = XHCI_MAX_DEVICES; 616 617 /* setup command queue mutex and condition varible */ 618 cv_init(&sc->sc_cmd_cv, "CMDQ"); 619 sx_init(&sc->sc_cmd_sx, "CMDQ lock"); 620 621 /* get all DMA memory */ 622 if (usb_bus_mem_alloc_all(&sc->sc_bus, 623 USB_GET_DMA_TAG(self), &xhci_iterate_hw_softc)) { 624 return (ENOMEM); 625 } 626 627 sc->sc_config_msg[0].hdr.pm_callback = &xhci_configure_msg; 628 sc->sc_config_msg[0].bus = &sc->sc_bus; 629 sc->sc_config_msg[1].hdr.pm_callback = &xhci_configure_msg; 630 sc->sc_config_msg[1].bus = &sc->sc_bus; 631 632 return (0); 633 } 634 635 void 636 xhci_uninit(struct xhci_softc *sc) 637 { 638 /* 639 * NOTE: At this point the control transfer process is gone 640 * and "xhci_configure_msg" is no longer called. Consequently 641 * waiting for the configuration messages to complete is not 642 * needed. 643 */ 644 usb_bus_mem_free_all(&sc->sc_bus, &xhci_iterate_hw_softc); 645 646 cv_destroy(&sc->sc_cmd_cv); 647 sx_destroy(&sc->sc_cmd_sx); 648 } 649 650 static void 651 xhci_set_hw_power_sleep(struct usb_bus *bus, uint32_t state) 652 { 653 struct xhci_softc *sc = XHCI_BUS2SC(bus); 654 655 switch (state) { 656 case USB_HW_POWER_SUSPEND: 657 DPRINTF("Stopping the XHCI\n"); 658 xhci_halt_controller(sc); 659 break; 660 case USB_HW_POWER_SHUTDOWN: 661 DPRINTF("Stopping the XHCI\n"); 662 xhci_halt_controller(sc); 663 break; 664 case USB_HW_POWER_RESUME: 665 DPRINTF("Starting the XHCI\n"); 666 xhci_start_controller(sc); 667 break; 668 default: 669 break; 670 } 671 } 672 673 static usb_error_t 674 xhci_generic_done_sub(struct usb_xfer *xfer) 675 { 676 struct xhci_td *td; 677 struct xhci_td *td_alt_next; 678 uint32_t len; 679 uint8_t status; 680 681 td = xfer->td_transfer_cache; 682 td_alt_next = td->alt_next; 683 684 if (xfer->aframes != xfer->nframes) 685 usbd_xfer_set_frame_len(xfer, xfer->aframes, 0); 686 687 while (1) { 688 689 usb_pc_cpu_invalidate(td->page_cache); 690 691 status = td->status; 692 len = td->remainder; 693 694 DPRINTFN(4, "xfer=%p[%u/%u] rem=%u/%u status=%u\n", 695 xfer, (unsigned int)xfer->aframes, 696 (unsigned int)xfer->nframes, 697 (unsigned int)len, (unsigned int)td->len, 698 (unsigned int)status); 699 700 /* 701 * Verify the status length and 702 * add the length to "frlengths[]": 703 */ 704 if (len > td->len) { 705 /* should not happen */ 706 DPRINTF("Invalid status length, " 707 "0x%04x/0x%04x bytes\n", len, td->len); 708 status = XHCI_TRB_ERROR_LENGTH; 709 } else if (xfer->aframes != xfer->nframes) { 710 xfer->frlengths[xfer->aframes] += td->len - len; 711 } 712 /* Check for last transfer */ 713 if (((void *)td) == xfer->td_transfer_last) { 714 td = NULL; 715 break; 716 } 717 /* Check for transfer error */ 718 if (status != XHCI_TRB_ERROR_SHORT_PKT && 719 status != XHCI_TRB_ERROR_SUCCESS) { 720 /* the transfer is finished */ 721 td = NULL; 722 break; 723 } 724 /* Check for short transfer */ 725 if (len > 0) { 726 if (xfer->flags_int.short_frames_ok || 727 xfer->flags_int.isochronous_xfr || 728 xfer->flags_int.control_xfr) { 729 /* follow alt next */ 730 td = td->alt_next; 731 } else { 732 /* the transfer is finished */ 733 td = NULL; 734 } 735 break; 736 } 737 td = td->obj_next; 738 739 if (td->alt_next != td_alt_next) { 740 /* this USB frame is complete */ 741 break; 742 } 743 } 744 745 /* update transfer cache */ 746 747 xfer->td_transfer_cache = td; 748 749 return ((status == XHCI_TRB_ERROR_STALL) ? USB_ERR_STALLED : 750 (status != XHCI_TRB_ERROR_SHORT_PKT && 751 status != XHCI_TRB_ERROR_SUCCESS) ? USB_ERR_IOERROR : 752 USB_ERR_NORMAL_COMPLETION); 753 } 754 755 static void 756 xhci_generic_done(struct usb_xfer *xfer) 757 { 758 usb_error_t err = 0; 759 760 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n", 761 xfer, xfer->endpoint); 762 763 /* reset scanner */ 764 765 xfer->td_transfer_cache = xfer->td_transfer_first; 766 767 if (xfer->flags_int.control_xfr) { 768 769 if (xfer->flags_int.control_hdr) 770 err = xhci_generic_done_sub(xfer); 771 772 xfer->aframes = 1; 773 774 if (xfer->td_transfer_cache == NULL) 775 goto done; 776 } 777 778 while (xfer->aframes != xfer->nframes) { 779 780 err = xhci_generic_done_sub(xfer); 781 xfer->aframes++; 782 783 if (xfer->td_transfer_cache == NULL) 784 goto done; 785 } 786 787 if (xfer->flags_int.control_xfr && 788 !xfer->flags_int.control_act) 789 err = xhci_generic_done_sub(xfer); 790 done: 791 /* transfer is complete */ 792 xhci_device_done(xfer, err); 793 } 794 795 static void 796 xhci_activate_transfer(struct usb_xfer *xfer) 797 { 798 struct xhci_td *td; 799 800 td = xfer->td_transfer_cache; 801 802 usb_pc_cpu_invalidate(td->page_cache); 803 804 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) { 805 806 /* activate the transfer */ 807 808 td->td_trb[0].dwTrb3 |= htole32(XHCI_TRB_3_CYCLE_BIT); 809 usb_pc_cpu_flush(td->page_cache); 810 811 xhci_endpoint_doorbell(xfer); 812 } 813 } 814 815 static void 816 xhci_skip_transfer(struct usb_xfer *xfer) 817 { 818 struct xhci_td *td; 819 struct xhci_td *td_last; 820 821 td = xfer->td_transfer_cache; 822 td_last = xfer->td_transfer_last; 823 824 td = td->alt_next; 825 826 usb_pc_cpu_invalidate(td->page_cache); 827 828 if (!(td->td_trb[0].dwTrb3 & htole32(XHCI_TRB_3_CYCLE_BIT))) { 829 830 usb_pc_cpu_invalidate(td_last->page_cache); 831 832 /* copy LINK TRB to current waiting location */ 833 834 td->td_trb[0].qwTrb0 = td_last->td_trb[td_last->ntrb].qwTrb0; 835 td->td_trb[0].dwTrb2 = td_last->td_trb[td_last->ntrb].dwTrb2; 836 usb_pc_cpu_flush(td->page_cache); 837 838 td->td_trb[0].dwTrb3 = td_last->td_trb[td_last->ntrb].dwTrb3; 839 usb_pc_cpu_flush(td->page_cache); 840 841 xhci_endpoint_doorbell(xfer); 842 } 843 } 844 845 /*------------------------------------------------------------------------* 846 * xhci_check_transfer 847 *------------------------------------------------------------------------*/ 848 static void 849 xhci_check_transfer(struct xhci_softc *sc, struct xhci_trb *trb) 850 { 851 struct xhci_endpoint_ext *pepext; 852 int64_t offset; 853 uint64_t td_event; 854 uint32_t temp; 855 uint32_t remainder; 856 uint16_t stream_id; 857 uint16_t i; 858 uint8_t status; 859 uint8_t halted; 860 uint8_t epno; 861 uint8_t index; 862 863 /* decode TRB */ 864 td_event = le64toh(trb->qwTrb0); 865 temp = le32toh(trb->dwTrb2); 866 867 remainder = XHCI_TRB_2_REM_GET(temp); 868 status = XHCI_TRB_2_ERROR_GET(temp); 869 stream_id = XHCI_TRB_2_STREAM_GET(temp); 870 871 temp = le32toh(trb->dwTrb3); 872 epno = XHCI_TRB_3_EP_GET(temp); 873 index = XHCI_TRB_3_SLOT_GET(temp); 874 875 /* check if error means halted */ 876 halted = (status != XHCI_TRB_ERROR_SHORT_PKT && 877 status != XHCI_TRB_ERROR_SUCCESS); 878 879 DPRINTF("slot=%u epno=%u stream=%u remainder=%u status=%u\n", 880 index, epno, stream_id, remainder, status); 881 882 if (index > sc->sc_noslot) { 883 DPRINTF("Invalid slot.\n"); 884 return; 885 } 886 887 if ((epno == 0) || (epno >= XHCI_MAX_ENDPOINTS)) { 888 DPRINTF("Invalid endpoint.\n"); 889 return; 890 } 891 892 pepext = &sc->sc_hw.devs[index].endp[epno]; 893 894 if (pepext->trb_ep_mode != USB_EP_MODE_STREAMS) { 895 stream_id = 0; 896 DPRINTF("stream_id=0\n"); 897 } else if (stream_id >= XHCI_MAX_STREAMS) { 898 DPRINTF("Invalid stream ID.\n"); 899 return; 900 } 901 902 /* try to find the USB transfer that generated the event */ 903 for (i = 0; i != (XHCI_MAX_TRANSFERS - 1); i++) { 904 struct usb_xfer *xfer; 905 struct xhci_td *td; 906 907 xfer = pepext->xfer[i + (XHCI_MAX_TRANSFERS * stream_id)]; 908 if (xfer == NULL) 909 continue; 910 911 td = xfer->td_transfer_cache; 912 913 DPRINTFN(5, "Checking if 0x%016llx == (0x%016llx .. 0x%016llx)\n", 914 (long long)td_event, 915 (long long)td->td_self, 916 (long long)td->td_self + sizeof(td->td_trb)); 917 918 /* 919 * NOTE: Some XHCI implementations might not trigger 920 * an event on the last LINK TRB so we need to 921 * consider both the last and second last event 922 * address as conditions for a successful transfer. 923 * 924 * NOTE: We assume that the XHCI will only trigger one 925 * event per chain of TRBs. 926 */ 927 928 offset = td_event - td->td_self; 929 930 if (offset >= 0 && 931 offset < (int64_t)sizeof(td->td_trb)) { 932 933 usb_pc_cpu_invalidate(td->page_cache); 934 935 /* compute rest of remainder, if any */ 936 for (i = (offset / 16) + 1; i < td->ntrb; i++) { 937 temp = le32toh(td->td_trb[i].dwTrb2); 938 remainder += XHCI_TRB_2_BYTES_GET(temp); 939 } 940 941 DPRINTFN(5, "New remainder: %u\n", remainder); 942 943 /* clear isochronous transfer errors */ 944 if (xfer->flags_int.isochronous_xfr) { 945 if (halted) { 946 halted = 0; 947 status = XHCI_TRB_ERROR_SUCCESS; 948 remainder = td->len; 949 } 950 } 951 952 /* "td->remainder" is verified later */ 953 td->remainder = remainder; 954 td->status = status; 955 956 usb_pc_cpu_flush(td->page_cache); 957 958 /* 959 * 1) Last transfer descriptor makes the 960 * transfer done 961 */ 962 if (((void *)td) == xfer->td_transfer_last) { 963 DPRINTF("TD is last\n"); 964 xhci_generic_done(xfer); 965 break; 966 } 967 968 /* 969 * 2) Any kind of error makes the transfer 970 * done 971 */ 972 if (halted) { 973 DPRINTF("TD has I/O error\n"); 974 xhci_generic_done(xfer); 975 break; 976 } 977 978 /* 979 * 3) If there is no alternate next transfer, 980 * a short packet also makes the transfer done 981 */ 982 if (td->remainder > 0) { 983 if (td->alt_next == NULL) { 984 DPRINTF( 985 "short TD has no alternate next\n"); 986 xhci_generic_done(xfer); 987 break; 988 } 989 DPRINTF("TD has short pkt\n"); 990 if (xfer->flags_int.short_frames_ok || 991 xfer->flags_int.isochronous_xfr || 992 xfer->flags_int.control_xfr) { 993 /* follow the alt next */ 994 xfer->td_transfer_cache = td->alt_next; 995 xhci_activate_transfer(xfer); 996 break; 997 } 998 xhci_skip_transfer(xfer); 999 xhci_generic_done(xfer); 1000 break; 1001 } 1002 1003 /* 1004 * 4) Transfer complete - go to next TD 1005 */ 1006 DPRINTF("Following next TD\n"); 1007 xfer->td_transfer_cache = td->obj_next; 1008 xhci_activate_transfer(xfer); 1009 break; /* there should only be one match */ 1010 } 1011 } 1012 } 1013 1014 static int 1015 xhci_check_command(struct xhci_softc *sc, struct xhci_trb *trb) 1016 { 1017 if (sc->sc_cmd_addr == trb->qwTrb0) { 1018 DPRINTF("Received command event\n"); 1019 sc->sc_cmd_result[0] = trb->dwTrb2; 1020 sc->sc_cmd_result[1] = trb->dwTrb3; 1021 cv_signal(&sc->sc_cmd_cv); 1022 return (1); /* command match */ 1023 } 1024 return (0); 1025 } 1026 1027 static int 1028 xhci_interrupt_poll(struct xhci_softc *sc) 1029 { 1030 struct usb_page_search buf_res; 1031 struct xhci_hw_root *phwr; 1032 uint64_t addr; 1033 uint32_t temp; 1034 int retval = 0; 1035 uint16_t i; 1036 uint8_t event; 1037 uint8_t j; 1038 uint8_t k; 1039 uint8_t t; 1040 1041 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res); 1042 1043 phwr = buf_res.buffer; 1044 1045 /* Receive any events */ 1046 1047 usb_pc_cpu_invalidate(&sc->sc_hw.root_pc); 1048 1049 i = sc->sc_event_idx; 1050 j = sc->sc_event_ccs; 1051 t = 2; 1052 1053 while (1) { 1054 1055 temp = le32toh(phwr->hwr_events[i].dwTrb3); 1056 1057 k = (temp & XHCI_TRB_3_CYCLE_BIT) ? 1 : 0; 1058 1059 if (j != k) 1060 break; 1061 1062 event = XHCI_TRB_3_TYPE_GET(temp); 1063 1064 DPRINTFN(10, "event[%u] = %u (0x%016llx 0x%08lx 0x%08lx)\n", 1065 i, event, (long long)le64toh(phwr->hwr_events[i].qwTrb0), 1066 (long)le32toh(phwr->hwr_events[i].dwTrb2), 1067 (long)le32toh(phwr->hwr_events[i].dwTrb3)); 1068 1069 switch (event) { 1070 case XHCI_TRB_EVENT_TRANSFER: 1071 xhci_check_transfer(sc, &phwr->hwr_events[i]); 1072 break; 1073 case XHCI_TRB_EVENT_CMD_COMPLETE: 1074 retval |= xhci_check_command(sc, &phwr->hwr_events[i]); 1075 break; 1076 default: 1077 DPRINTF("Unhandled event = %u\n", event); 1078 break; 1079 } 1080 1081 i++; 1082 1083 if (i == XHCI_MAX_EVENTS) { 1084 i = 0; 1085 j ^= 1; 1086 1087 /* check for timeout */ 1088 if (!--t) 1089 break; 1090 } 1091 } 1092 1093 sc->sc_event_idx = i; 1094 sc->sc_event_ccs = j; 1095 1096 /* 1097 * NOTE: The Event Ring Dequeue Pointer Register is 64-bit 1098 * latched. That means to activate the register we need to 1099 * write both the low and high double word of the 64-bit 1100 * register. 1101 */ 1102 1103 addr = (uint32_t)buf_res.physaddr; 1104 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_events[i]; 1105 1106 /* try to clear busy bit */ 1107 addr |= XHCI_ERDP_LO_BUSY; 1108 1109 XWRITE4(sc, runt, XHCI_ERDP_LO(0), (uint32_t)addr); 1110 XWRITE4(sc, runt, XHCI_ERDP_HI(0), (uint32_t)(addr >> 32)); 1111 1112 return (retval); 1113 } 1114 1115 static usb_error_t 1116 xhci_do_command(struct xhci_softc *sc, struct xhci_trb *trb, 1117 uint16_t timeout_ms) 1118 { 1119 struct usb_page_search buf_res; 1120 struct xhci_hw_root *phwr; 1121 uint64_t addr; 1122 uint32_t temp; 1123 uint8_t i; 1124 uint8_t j; 1125 uint8_t timeout = 0; 1126 int err; 1127 1128 XHCI_CMD_ASSERT_LOCKED(sc); 1129 1130 /* get hardware root structure */ 1131 1132 usbd_get_page(&sc->sc_hw.root_pc, 0, &buf_res); 1133 1134 phwr = buf_res.buffer; 1135 1136 /* Queue command */ 1137 1138 USB_BUS_LOCK(&sc->sc_bus); 1139 retry: 1140 i = sc->sc_command_idx; 1141 j = sc->sc_command_ccs; 1142 1143 DPRINTFN(10, "command[%u] = %u (0x%016llx, 0x%08lx, 0x%08lx)\n", 1144 i, XHCI_TRB_3_TYPE_GET(le32toh(trb->dwTrb3)), 1145 (long long)le64toh(trb->qwTrb0), 1146 (long)le32toh(trb->dwTrb2), 1147 (long)le32toh(trb->dwTrb3)); 1148 1149 phwr->hwr_commands[i].qwTrb0 = trb->qwTrb0; 1150 phwr->hwr_commands[i].dwTrb2 = trb->dwTrb2; 1151 1152 usb_pc_cpu_flush(&sc->sc_hw.root_pc); 1153 1154 temp = trb->dwTrb3; 1155 1156 if (j) 1157 temp |= htole32(XHCI_TRB_3_CYCLE_BIT); 1158 else 1159 temp &= ~htole32(XHCI_TRB_3_CYCLE_BIT); 1160 1161 temp &= ~htole32(XHCI_TRB_3_TC_BIT); 1162 1163 phwr->hwr_commands[i].dwTrb3 = temp; 1164 1165 usb_pc_cpu_flush(&sc->sc_hw.root_pc); 1166 1167 addr = buf_res.physaddr; 1168 addr += (uintptr_t)&((struct xhci_hw_root *)0)->hwr_commands[i]; 1169 1170 sc->sc_cmd_addr = htole64(addr); 1171 1172 i++; 1173 1174 if (i == (XHCI_MAX_COMMANDS - 1)) { 1175 1176 if (j) { 1177 temp = htole32(XHCI_TRB_3_TC_BIT | 1178 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) | 1179 XHCI_TRB_3_CYCLE_BIT); 1180 } else { 1181 temp = htole32(XHCI_TRB_3_TC_BIT | 1182 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK)); 1183 } 1184 1185 phwr->hwr_commands[i].dwTrb3 = temp; 1186 1187 usb_pc_cpu_flush(&sc->sc_hw.root_pc); 1188 1189 i = 0; 1190 j ^= 1; 1191 } 1192 1193 sc->sc_command_idx = i; 1194 sc->sc_command_ccs = j; 1195 1196 XWRITE4(sc, door, XHCI_DOORBELL(0), 0); 1197 1198 err = cv_timedwait(&sc->sc_cmd_cv, &sc->sc_bus.bus_mtx, 1199 USB_MS_TO_TICKS(timeout_ms)); 1200 1201 /* 1202 * In some error cases event interrupts are not generated. 1203 * Poll one time to see if the command has completed. 1204 */ 1205 if (err != 0 && xhci_interrupt_poll(sc) != 0) { 1206 DPRINTF("Command was completed when polling\n"); 1207 err = 0; 1208 } 1209 if (err != 0) { 1210 DPRINTF("Command timeout!\n"); 1211 /* 1212 * After some weeks of continuous operation, it has 1213 * been observed that the ASMedia Technology, ASM1042 1214 * SuperSpeed USB Host Controller can suddenly stop 1215 * accepting commands via the command queue. Try to 1216 * first reset the command queue. If that fails do a 1217 * host controller reset. 1218 */ 1219 if (timeout == 0 && 1220 xhci_reset_command_queue_locked(sc) == 0) { 1221 timeout = 1; 1222 goto retry; 1223 } else { 1224 DPRINTF("Controller reset!\n"); 1225 usb_bus_reset_async_locked(&sc->sc_bus); 1226 } 1227 err = USB_ERR_TIMEOUT; 1228 trb->dwTrb2 = 0; 1229 trb->dwTrb3 = 0; 1230 } else { 1231 temp = le32toh(sc->sc_cmd_result[0]); 1232 if (XHCI_TRB_2_ERROR_GET(temp) != XHCI_TRB_ERROR_SUCCESS) 1233 err = USB_ERR_IOERROR; 1234 1235 trb->dwTrb2 = sc->sc_cmd_result[0]; 1236 trb->dwTrb3 = sc->sc_cmd_result[1]; 1237 } 1238 1239 USB_BUS_UNLOCK(&sc->sc_bus); 1240 1241 return (err); 1242 } 1243 1244 #if 0 1245 static usb_error_t 1246 xhci_cmd_nop(struct xhci_softc *sc) 1247 { 1248 struct xhci_trb trb; 1249 uint32_t temp; 1250 1251 DPRINTF("\n"); 1252 1253 trb.qwTrb0 = 0; 1254 trb.dwTrb2 = 0; 1255 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NOOP); 1256 1257 trb.dwTrb3 = htole32(temp); 1258 1259 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1260 } 1261 #endif 1262 1263 static usb_error_t 1264 xhci_cmd_enable_slot(struct xhci_softc *sc, uint8_t *pslot) 1265 { 1266 struct xhci_trb trb; 1267 uint32_t temp; 1268 usb_error_t err; 1269 1270 DPRINTF("\n"); 1271 1272 trb.qwTrb0 = 0; 1273 trb.dwTrb2 = 0; 1274 trb.dwTrb3 = htole32(XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ENABLE_SLOT)); 1275 1276 err = xhci_do_command(sc, &trb, 100 /* ms */); 1277 if (err) 1278 goto done; 1279 1280 temp = le32toh(trb.dwTrb3); 1281 1282 *pslot = XHCI_TRB_3_SLOT_GET(temp); 1283 1284 done: 1285 return (err); 1286 } 1287 1288 static usb_error_t 1289 xhci_cmd_disable_slot(struct xhci_softc *sc, uint8_t slot_id) 1290 { 1291 struct xhci_trb trb; 1292 uint32_t temp; 1293 1294 DPRINTF("\n"); 1295 1296 trb.qwTrb0 = 0; 1297 trb.dwTrb2 = 0; 1298 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DISABLE_SLOT) | 1299 XHCI_TRB_3_SLOT_SET(slot_id); 1300 1301 trb.dwTrb3 = htole32(temp); 1302 1303 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1304 } 1305 1306 static usb_error_t 1307 xhci_cmd_set_address(struct xhci_softc *sc, uint64_t input_ctx, 1308 uint8_t bsr, uint8_t slot_id) 1309 { 1310 struct xhci_trb trb; 1311 uint32_t temp; 1312 1313 DPRINTF("\n"); 1314 1315 trb.qwTrb0 = htole64(input_ctx); 1316 trb.dwTrb2 = 0; 1317 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ADDRESS_DEVICE) | 1318 XHCI_TRB_3_SLOT_SET(slot_id); 1319 1320 if (bsr) 1321 temp |= XHCI_TRB_3_BSR_BIT; 1322 1323 trb.dwTrb3 = htole32(temp); 1324 1325 return (xhci_do_command(sc, &trb, 500 /* ms */)); 1326 } 1327 1328 static usb_error_t 1329 xhci_set_address(struct usb_device *udev, struct mtx *mtx, uint16_t address) 1330 { 1331 struct usb_page_search buf_inp; 1332 struct usb_page_search buf_dev; 1333 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 1334 struct xhci_hw_dev *hdev; 1335 struct xhci_dev_ctx *pdev; 1336 struct xhci_endpoint_ext *pepext; 1337 uint32_t temp; 1338 uint16_t mps; 1339 usb_error_t err; 1340 uint8_t index; 1341 1342 /* the root HUB case is not handled here */ 1343 if (udev->parent_hub == NULL) 1344 return (USB_ERR_INVAL); 1345 1346 index = udev->controller_slot_id; 1347 1348 hdev = &sc->sc_hw.devs[index]; 1349 1350 if (mtx != NULL) 1351 mtx_unlock(mtx); 1352 1353 XHCI_CMD_LOCK(sc); 1354 1355 switch (hdev->state) { 1356 case XHCI_ST_DEFAULT: 1357 case XHCI_ST_ENABLED: 1358 1359 hdev->state = XHCI_ST_ENABLED; 1360 1361 /* set configure mask to slot and EP0 */ 1362 xhci_configure_mask(udev, 3, 0); 1363 1364 /* configure input slot context structure */ 1365 err = xhci_configure_device(udev); 1366 1367 if (err != 0) { 1368 DPRINTF("Could not configure device\n"); 1369 break; 1370 } 1371 1372 /* configure input endpoint context structure */ 1373 switch (udev->speed) { 1374 case USB_SPEED_LOW: 1375 case USB_SPEED_FULL: 1376 mps = 8; 1377 break; 1378 case USB_SPEED_HIGH: 1379 mps = 64; 1380 break; 1381 default: 1382 mps = 512; 1383 break; 1384 } 1385 1386 pepext = xhci_get_endpoint_ext(udev, 1387 &udev->ctrl_ep_desc); 1388 err = xhci_configure_endpoint(udev, 1389 &udev->ctrl_ep_desc, pepext, 1390 0, 1, 1, 0, mps, mps, USB_EP_MODE_DEFAULT); 1391 1392 if (err != 0) { 1393 DPRINTF("Could not configure default endpoint\n"); 1394 break; 1395 } 1396 1397 /* execute set address command */ 1398 usbd_get_page(&hdev->input_pc, 0, &buf_inp); 1399 1400 err = xhci_cmd_set_address(sc, buf_inp.physaddr, 1401 (address == 0), index); 1402 1403 if (err != 0) { 1404 temp = le32toh(sc->sc_cmd_result[0]); 1405 if (address == 0 && sc->sc_port_route != NULL && 1406 XHCI_TRB_2_ERROR_GET(temp) == 1407 XHCI_TRB_ERROR_PARAMETER) { 1408 /* LynxPoint XHCI - ports are not switchable */ 1409 /* Un-route all ports from the XHCI */ 1410 sc->sc_port_route(sc->sc_bus.parent, 0, ~0); 1411 } 1412 DPRINTF("Could not set address " 1413 "for slot %u.\n", index); 1414 if (address != 0) 1415 break; 1416 } 1417 1418 /* update device address to new value */ 1419 1420 usbd_get_page(&hdev->device_pc, 0, &buf_dev); 1421 pdev = buf_dev.buffer; 1422 usb_pc_cpu_invalidate(&hdev->device_pc); 1423 1424 temp = xhci_ctx_get_le32(sc, &pdev->ctx_slot.dwSctx3); 1425 udev->address = XHCI_SCTX_3_DEV_ADDR_GET(temp); 1426 1427 /* update device state to new value */ 1428 1429 if (address != 0) 1430 hdev->state = XHCI_ST_ADDRESSED; 1431 else 1432 hdev->state = XHCI_ST_DEFAULT; 1433 break; 1434 1435 default: 1436 DPRINTF("Wrong state for set address.\n"); 1437 err = USB_ERR_IOERROR; 1438 break; 1439 } 1440 XHCI_CMD_UNLOCK(sc); 1441 1442 if (mtx != NULL) 1443 mtx_lock(mtx); 1444 1445 return (err); 1446 } 1447 1448 static usb_error_t 1449 xhci_cmd_configure_ep(struct xhci_softc *sc, uint64_t input_ctx, 1450 uint8_t deconfigure, uint8_t slot_id) 1451 { 1452 struct xhci_trb trb; 1453 uint32_t temp; 1454 1455 DPRINTF("\n"); 1456 1457 trb.qwTrb0 = htole64(input_ctx); 1458 trb.dwTrb2 = 0; 1459 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_CONFIGURE_EP) | 1460 XHCI_TRB_3_SLOT_SET(slot_id); 1461 1462 if (deconfigure) 1463 temp |= XHCI_TRB_3_DCEP_BIT; 1464 1465 trb.dwTrb3 = htole32(temp); 1466 1467 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1468 } 1469 1470 static usb_error_t 1471 xhci_cmd_evaluate_ctx(struct xhci_softc *sc, uint64_t input_ctx, 1472 uint8_t slot_id) 1473 { 1474 struct xhci_trb trb; 1475 uint32_t temp; 1476 1477 DPRINTF("\n"); 1478 1479 trb.qwTrb0 = htole64(input_ctx); 1480 trb.dwTrb2 = 0; 1481 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_EVALUATE_CTX) | 1482 XHCI_TRB_3_SLOT_SET(slot_id); 1483 trb.dwTrb3 = htole32(temp); 1484 1485 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1486 } 1487 1488 static usb_error_t 1489 xhci_cmd_reset_ep(struct xhci_softc *sc, uint8_t preserve, 1490 uint8_t ep_id, uint8_t slot_id) 1491 { 1492 struct xhci_trb trb; 1493 uint32_t temp; 1494 1495 DPRINTF("\n"); 1496 1497 trb.qwTrb0 = 0; 1498 trb.dwTrb2 = 0; 1499 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_EP) | 1500 XHCI_TRB_3_SLOT_SET(slot_id) | 1501 XHCI_TRB_3_EP_SET(ep_id); 1502 1503 if (preserve) 1504 temp |= XHCI_TRB_3_PRSV_BIT; 1505 1506 trb.dwTrb3 = htole32(temp); 1507 1508 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1509 } 1510 1511 static usb_error_t 1512 xhci_cmd_set_tr_dequeue_ptr(struct xhci_softc *sc, uint64_t dequeue_ptr, 1513 uint16_t stream_id, uint8_t ep_id, uint8_t slot_id) 1514 { 1515 struct xhci_trb trb; 1516 uint32_t temp; 1517 1518 DPRINTF("\n"); 1519 1520 trb.qwTrb0 = htole64(dequeue_ptr); 1521 1522 temp = XHCI_TRB_2_STREAM_SET(stream_id); 1523 trb.dwTrb2 = htole32(temp); 1524 1525 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SET_TR_DEQUEUE) | 1526 XHCI_TRB_3_SLOT_SET(slot_id) | 1527 XHCI_TRB_3_EP_SET(ep_id); 1528 trb.dwTrb3 = htole32(temp); 1529 1530 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1531 } 1532 1533 static usb_error_t 1534 xhci_cmd_stop_ep(struct xhci_softc *sc, uint8_t suspend, 1535 uint8_t ep_id, uint8_t slot_id) 1536 { 1537 struct xhci_trb trb; 1538 uint32_t temp; 1539 1540 DPRINTF("\n"); 1541 1542 trb.qwTrb0 = 0; 1543 trb.dwTrb2 = 0; 1544 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STOP_EP) | 1545 XHCI_TRB_3_SLOT_SET(slot_id) | 1546 XHCI_TRB_3_EP_SET(ep_id); 1547 1548 if (suspend) 1549 temp |= XHCI_TRB_3_SUSP_EP_BIT; 1550 1551 trb.dwTrb3 = htole32(temp); 1552 1553 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1554 } 1555 1556 static usb_error_t 1557 xhci_cmd_reset_dev(struct xhci_softc *sc, uint8_t slot_id) 1558 { 1559 struct xhci_trb trb; 1560 uint32_t temp; 1561 1562 DPRINTF("\n"); 1563 1564 trb.qwTrb0 = 0; 1565 trb.dwTrb2 = 0; 1566 temp = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_RESET_DEVICE) | 1567 XHCI_TRB_3_SLOT_SET(slot_id); 1568 1569 trb.dwTrb3 = htole32(temp); 1570 1571 return (xhci_do_command(sc, &trb, 100 /* ms */)); 1572 } 1573 1574 /*------------------------------------------------------------------------* 1575 * xhci_interrupt - XHCI interrupt handler 1576 *------------------------------------------------------------------------*/ 1577 void 1578 xhci_interrupt(struct xhci_softc *sc) 1579 { 1580 uint32_t status; 1581 1582 USB_BUS_LOCK(&sc->sc_bus); 1583 1584 status = XREAD4(sc, oper, XHCI_USBSTS); 1585 1586 /* acknowledge interrupts */ 1587 1588 XWRITE4(sc, oper, XHCI_USBSTS, status); 1589 1590 DPRINTFN(16, "real interrupt (status=0x%08x)\n", status); 1591 1592 /* check for event(s) */ 1593 xhci_interrupt_poll(sc); 1594 1595 if (status & (XHCI_STS_PCD | XHCI_STS_HCH | 1596 XHCI_STS_HSE | XHCI_STS_HCE)) { 1597 1598 if (status & XHCI_STS_PCD) { 1599 xhci_root_intr(sc); 1600 } 1601 1602 if (status & XHCI_STS_HCH) { 1603 printf("%s: host controller halted\n", 1604 __FUNCTION__); 1605 } 1606 1607 if (status & XHCI_STS_HSE) { 1608 printf("%s: host system error\n", 1609 __FUNCTION__); 1610 } 1611 1612 if (status & XHCI_STS_HCE) { 1613 printf("%s: host controller error\n", 1614 __FUNCTION__); 1615 } 1616 } 1617 USB_BUS_UNLOCK(&sc->sc_bus); 1618 } 1619 1620 /*------------------------------------------------------------------------* 1621 * xhci_timeout - XHCI timeout handler 1622 *------------------------------------------------------------------------*/ 1623 static void 1624 xhci_timeout(void *arg) 1625 { 1626 struct usb_xfer *xfer = arg; 1627 1628 DPRINTF("xfer=%p\n", xfer); 1629 1630 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1631 1632 /* transfer is transferred */ 1633 xhci_device_done(xfer, USB_ERR_TIMEOUT); 1634 } 1635 1636 static void 1637 xhci_do_poll(struct usb_bus *bus) 1638 { 1639 struct xhci_softc *sc = XHCI_BUS2SC(bus); 1640 1641 USB_BUS_LOCK(&sc->sc_bus); 1642 xhci_interrupt_poll(sc); 1643 USB_BUS_UNLOCK(&sc->sc_bus); 1644 } 1645 1646 static void 1647 xhci_setup_generic_chain_sub(struct xhci_std_temp *temp) 1648 { 1649 struct usb_page_search buf_res; 1650 struct xhci_td *td; 1651 struct xhci_td *td_next; 1652 struct xhci_td *td_alt_next; 1653 struct xhci_td *td_first; 1654 uint32_t buf_offset; 1655 uint32_t average; 1656 uint32_t len_old; 1657 uint32_t npkt_off; 1658 uint32_t dword; 1659 uint8_t shortpkt_old; 1660 uint8_t precompute; 1661 uint8_t x; 1662 1663 td_alt_next = NULL; 1664 buf_offset = 0; 1665 shortpkt_old = temp->shortpkt; 1666 len_old = temp->len; 1667 npkt_off = 0; 1668 precompute = 1; 1669 1670 restart: 1671 1672 td = temp->td; 1673 td_next = td_first = temp->td_next; 1674 1675 while (1) { 1676 1677 if (temp->len == 0) { 1678 1679 if (temp->shortpkt) 1680 break; 1681 1682 /* send a Zero Length Packet, ZLP, last */ 1683 1684 temp->shortpkt = 1; 1685 average = 0; 1686 1687 } else { 1688 1689 average = temp->average; 1690 1691 if (temp->len < average) { 1692 if (temp->len % temp->max_packet_size) { 1693 temp->shortpkt = 1; 1694 } 1695 average = temp->len; 1696 } 1697 } 1698 1699 if (td_next == NULL) 1700 panic("%s: out of XHCI transfer descriptors!", __FUNCTION__); 1701 1702 /* get next TD */ 1703 1704 td = td_next; 1705 td_next = td->obj_next; 1706 1707 /* check if we are pre-computing */ 1708 1709 if (precompute) { 1710 1711 /* update remaining length */ 1712 1713 temp->len -= average; 1714 1715 continue; 1716 } 1717 /* fill out current TD */ 1718 1719 td->len = average; 1720 td->remainder = 0; 1721 td->status = 0; 1722 1723 /* update remaining length */ 1724 1725 temp->len -= average; 1726 1727 /* reset TRB index */ 1728 1729 x = 0; 1730 1731 if (temp->trb_type == XHCI_TRB_TYPE_SETUP_STAGE) { 1732 /* immediate data */ 1733 1734 if (average > 8) 1735 average = 8; 1736 1737 td->td_trb[0].qwTrb0 = 0; 1738 1739 usbd_copy_out(temp->pc, temp->offset + buf_offset, 1740 (uint8_t *)(uintptr_t)&td->td_trb[0].qwTrb0, 1741 average); 1742 1743 dword = XHCI_TRB_2_BYTES_SET(8) | 1744 XHCI_TRB_2_TDSZ_SET(0) | 1745 XHCI_TRB_2_IRQ_SET(0); 1746 1747 td->td_trb[0].dwTrb2 = htole32(dword); 1748 1749 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_SETUP_STAGE) | 1750 XHCI_TRB_3_IDT_BIT | XHCI_TRB_3_CYCLE_BIT; 1751 1752 /* check wLength */ 1753 if (td->td_trb[0].qwTrb0 & 1754 htole64(XHCI_TRB_0_WLENGTH_MASK)) { 1755 if (td->td_trb[0].qwTrb0 & htole64(1)) 1756 dword |= XHCI_TRB_3_TRT_IN; 1757 else 1758 dword |= XHCI_TRB_3_TRT_OUT; 1759 } 1760 1761 td->td_trb[0].dwTrb3 = htole32(dword); 1762 #ifdef USB_DEBUG 1763 xhci_dump_trb(&td->td_trb[x]); 1764 #endif 1765 x++; 1766 1767 } else do { 1768 1769 uint32_t npkt; 1770 1771 /* fill out buffer pointers */ 1772 1773 if (average == 0) { 1774 memset(&buf_res, 0, sizeof(buf_res)); 1775 } else { 1776 usbd_get_page(temp->pc, temp->offset + 1777 buf_offset, &buf_res); 1778 1779 /* get length to end of page */ 1780 if (buf_res.length > average) 1781 buf_res.length = average; 1782 1783 /* check for maximum length */ 1784 if (buf_res.length > XHCI_TD_PAGE_SIZE) 1785 buf_res.length = XHCI_TD_PAGE_SIZE; 1786 1787 npkt_off += buf_res.length; 1788 } 1789 1790 /* setup npkt */ 1791 npkt = (len_old - npkt_off + temp->max_packet_size - 1) / 1792 temp->max_packet_size; 1793 1794 if (npkt == 0) 1795 npkt = 1; 1796 else if (npkt > 31) 1797 npkt = 31; 1798 1799 /* fill out TRB's */ 1800 td->td_trb[x].qwTrb0 = 1801 htole64((uint64_t)buf_res.physaddr); 1802 1803 dword = 1804 XHCI_TRB_2_BYTES_SET(buf_res.length) | 1805 XHCI_TRB_2_TDSZ_SET(npkt) | 1806 XHCI_TRB_2_IRQ_SET(0); 1807 1808 td->td_trb[x].dwTrb2 = htole32(dword); 1809 1810 switch (temp->trb_type) { 1811 case XHCI_TRB_TYPE_ISOCH: 1812 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT | 1813 XHCI_TRB_3_TBC_SET(temp->tbc) | 1814 XHCI_TRB_3_TLBPC_SET(temp->tlbpc); 1815 if (td != td_first) { 1816 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL); 1817 } else if (temp->do_isoc_sync != 0) { 1818 temp->do_isoc_sync = 0; 1819 /* wait until "isoc_frame" */ 1820 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) | 1821 XHCI_TRB_3_FRID_SET(temp->isoc_frame / 8); 1822 } else { 1823 /* start data transfer at next interval */ 1824 dword |= XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_ISOCH) | 1825 XHCI_TRB_3_ISO_SIA_BIT; 1826 } 1827 if (temp->direction == UE_DIR_IN) 1828 dword |= XHCI_TRB_3_DIR_IN | XHCI_TRB_3_ISP_BIT; 1829 break; 1830 case XHCI_TRB_TYPE_DATA_STAGE: 1831 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT | 1832 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_DATA_STAGE) | 1833 XHCI_TRB_3_TBC_SET(temp->tbc) | 1834 XHCI_TRB_3_TLBPC_SET(temp->tlbpc); 1835 if (temp->direction == UE_DIR_IN) 1836 dword |= XHCI_TRB_3_DIR_IN | XHCI_TRB_3_ISP_BIT; 1837 break; 1838 case XHCI_TRB_TYPE_STATUS_STAGE: 1839 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT | 1840 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_STATUS_STAGE) | 1841 XHCI_TRB_3_TBC_SET(temp->tbc) | 1842 XHCI_TRB_3_TLBPC_SET(temp->tlbpc); 1843 if (temp->direction == UE_DIR_IN) 1844 dword |= XHCI_TRB_3_DIR_IN; 1845 break; 1846 default: /* XHCI_TRB_TYPE_NORMAL */ 1847 dword = XHCI_TRB_3_CHAIN_BIT | XHCI_TRB_3_CYCLE_BIT | 1848 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_NORMAL) | 1849 XHCI_TRB_3_TBC_SET(temp->tbc) | 1850 XHCI_TRB_3_TLBPC_SET(temp->tlbpc); 1851 if (temp->direction == UE_DIR_IN) 1852 dword |= XHCI_TRB_3_DIR_IN | XHCI_TRB_3_ISP_BIT; 1853 break; 1854 } 1855 td->td_trb[x].dwTrb3 = htole32(dword); 1856 1857 average -= buf_res.length; 1858 buf_offset += buf_res.length; 1859 #ifdef USB_DEBUG 1860 xhci_dump_trb(&td->td_trb[x]); 1861 #endif 1862 x++; 1863 1864 } while (average != 0); 1865 1866 td->td_trb[x-1].dwTrb3 |= htole32(XHCI_TRB_3_IOC_BIT); 1867 1868 /* store number of data TRB's */ 1869 1870 td->ntrb = x; 1871 1872 DPRINTF("NTRB=%u\n", x); 1873 1874 /* fill out link TRB */ 1875 1876 if (td_next != NULL) { 1877 /* link the current TD with the next one */ 1878 td->td_trb[x].qwTrb0 = htole64((uint64_t)td_next->td_self); 1879 DPRINTF("LINK=0x%08llx\n", (long long)td_next->td_self); 1880 } else { 1881 /* this field will get updated later */ 1882 DPRINTF("NOLINK\n"); 1883 } 1884 1885 dword = XHCI_TRB_2_IRQ_SET(0); 1886 1887 td->td_trb[x].dwTrb2 = htole32(dword); 1888 1889 dword = XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK) | 1890 XHCI_TRB_3_CYCLE_BIT | XHCI_TRB_3_IOC_BIT | 1891 /* 1892 * CHAIN-BIT: Ensure that a multi-TRB IN-endpoint 1893 * frame only receives a single short packet event 1894 * by setting the CHAIN bit in the LINK field. In 1895 * addition some XHCI controllers have problems 1896 * sending a ZLP unless the CHAIN-BIT is set in 1897 * the LINK TRB. 1898 */ 1899 XHCI_TRB_3_CHAIN_BIT; 1900 1901 td->td_trb[x].dwTrb3 = htole32(dword); 1902 1903 td->alt_next = td_alt_next; 1904 #ifdef USB_DEBUG 1905 xhci_dump_trb(&td->td_trb[x]); 1906 #endif 1907 usb_pc_cpu_flush(td->page_cache); 1908 } 1909 1910 if (precompute) { 1911 precompute = 0; 1912 1913 /* setup alt next pointer, if any */ 1914 if (temp->last_frame) { 1915 td_alt_next = NULL; 1916 } else { 1917 /* we use this field internally */ 1918 td_alt_next = td_next; 1919 } 1920 1921 /* restore */ 1922 temp->shortpkt = shortpkt_old; 1923 temp->len = len_old; 1924 goto restart; 1925 } 1926 1927 /* 1928 * Remove cycle bit from the first TRB if we are 1929 * stepping them: 1930 */ 1931 if (temp->step_td != 0) { 1932 td_first->td_trb[0].dwTrb3 &= ~htole32(XHCI_TRB_3_CYCLE_BIT); 1933 usb_pc_cpu_flush(td_first->page_cache); 1934 } 1935 1936 /* clear TD SIZE to zero, hence this is the last TRB */ 1937 /* remove chain bit because this is the last data TRB in the chain */ 1938 td->td_trb[td->ntrb - 1].dwTrb2 &= ~htole32(XHCI_TRB_2_TDSZ_SET(15)); 1939 td->td_trb[td->ntrb - 1].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT); 1940 /* remove CHAIN-BIT from last LINK TRB */ 1941 td->td_trb[td->ntrb].dwTrb3 &= ~htole32(XHCI_TRB_3_CHAIN_BIT); 1942 1943 usb_pc_cpu_flush(td->page_cache); 1944 1945 temp->td = td; 1946 temp->td_next = td_next; 1947 } 1948 1949 static void 1950 xhci_setup_generic_chain(struct usb_xfer *xfer) 1951 { 1952 struct xhci_std_temp temp; 1953 struct xhci_td *td; 1954 uint32_t x; 1955 uint32_t y; 1956 uint8_t mult; 1957 1958 temp.do_isoc_sync = 0; 1959 temp.step_td = 0; 1960 temp.tbc = 0; 1961 temp.tlbpc = 0; 1962 temp.average = xfer->max_hc_frame_size; 1963 temp.max_packet_size = xfer->max_packet_size; 1964 temp.sc = XHCI_BUS2SC(xfer->xroot->bus); 1965 temp.pc = NULL; 1966 temp.last_frame = 0; 1967 temp.offset = 0; 1968 temp.multishort = xfer->flags_int.isochronous_xfr || 1969 xfer->flags_int.control_xfr || 1970 xfer->flags_int.short_frames_ok; 1971 1972 /* toggle the DMA set we are using */ 1973 xfer->flags_int.curr_dma_set ^= 1; 1974 1975 /* get next DMA set */ 1976 td = xfer->td_start[xfer->flags_int.curr_dma_set]; 1977 1978 temp.td = NULL; 1979 temp.td_next = td; 1980 1981 xfer->td_transfer_first = td; 1982 xfer->td_transfer_cache = td; 1983 1984 if (xfer->flags_int.isochronous_xfr) { 1985 uint8_t shift; 1986 1987 /* compute multiplier for ISOCHRONOUS transfers */ 1988 mult = xfer->endpoint->ecomp ? 1989 UE_GET_SS_ISO_MULT(xfer->endpoint->ecomp->bmAttributes) 1990 : 0; 1991 /* check for USB 2.0 multiplier */ 1992 if (mult == 0) { 1993 mult = (xfer->endpoint->edesc-> 1994 wMaxPacketSize[1] >> 3) & 3; 1995 } 1996 /* range check */ 1997 if (mult > 2) 1998 mult = 3; 1999 else 2000 mult++; 2001 2002 x = XREAD4(temp.sc, runt, XHCI_MFINDEX); 2003 2004 DPRINTF("MFINDEX=0x%08x\n", x); 2005 2006 switch (usbd_get_speed(xfer->xroot->udev)) { 2007 case USB_SPEED_FULL: 2008 shift = 3; 2009 temp.isoc_delta = 8; /* 1ms */ 2010 x += temp.isoc_delta - 1; 2011 x &= ~(temp.isoc_delta - 1); 2012 break; 2013 default: 2014 shift = usbd_xfer_get_fps_shift(xfer); 2015 temp.isoc_delta = 1U << shift; 2016 x += temp.isoc_delta - 1; 2017 x &= ~(temp.isoc_delta - 1); 2018 /* simple frame load balancing */ 2019 x += xfer->endpoint->usb_uframe; 2020 break; 2021 } 2022 2023 y = XHCI_MFINDEX_GET(x - xfer->endpoint->isoc_next); 2024 2025 if ((xfer->endpoint->is_synced == 0) || 2026 (y < (xfer->nframes << shift)) || 2027 (XHCI_MFINDEX_GET(-y) >= (128 * 8))) { 2028 /* 2029 * If there is data underflow or the pipe 2030 * queue is empty we schedule the transfer a 2031 * few frames ahead of the current frame 2032 * position. Else two isochronous transfers 2033 * might overlap. 2034 */ 2035 xfer->endpoint->isoc_next = XHCI_MFINDEX_GET(x + (3 * 8)); 2036 xfer->endpoint->is_synced = 1; 2037 temp.do_isoc_sync = 1; 2038 2039 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next); 2040 } 2041 2042 /* compute isochronous completion time */ 2043 2044 y = XHCI_MFINDEX_GET(xfer->endpoint->isoc_next - (x & ~7)); 2045 2046 xfer->isoc_time_complete = 2047 usb_isoc_time_expand(&temp.sc->sc_bus, x / 8) + 2048 (y / 8) + (((xfer->nframes << shift) + 7) / 8); 2049 2050 x = 0; 2051 temp.isoc_frame = xfer->endpoint->isoc_next; 2052 temp.trb_type = XHCI_TRB_TYPE_ISOCH; 2053 2054 xfer->endpoint->isoc_next += xfer->nframes << shift; 2055 2056 } else if (xfer->flags_int.control_xfr) { 2057 2058 /* check if we should prepend a setup message */ 2059 2060 if (xfer->flags_int.control_hdr) { 2061 2062 temp.len = xfer->frlengths[0]; 2063 temp.pc = xfer->frbuffers + 0; 2064 temp.shortpkt = temp.len ? 1 : 0; 2065 temp.trb_type = XHCI_TRB_TYPE_SETUP_STAGE; 2066 temp.direction = 0; 2067 2068 /* check for last frame */ 2069 if (xfer->nframes == 1) { 2070 /* no STATUS stage yet, SETUP is last */ 2071 if (xfer->flags_int.control_act) 2072 temp.last_frame = 1; 2073 } 2074 2075 xhci_setup_generic_chain_sub(&temp); 2076 } 2077 x = 1; 2078 mult = 1; 2079 temp.isoc_delta = 0; 2080 temp.isoc_frame = 0; 2081 temp.trb_type = XHCI_TRB_TYPE_DATA_STAGE; 2082 } else { 2083 x = 0; 2084 mult = 1; 2085 temp.isoc_delta = 0; 2086 temp.isoc_frame = 0; 2087 temp.trb_type = XHCI_TRB_TYPE_NORMAL; 2088 } 2089 2090 if (x != xfer->nframes) { 2091 /* setup page_cache pointer */ 2092 temp.pc = xfer->frbuffers + x; 2093 /* set endpoint direction */ 2094 temp.direction = UE_GET_DIR(xfer->endpointno); 2095 } 2096 2097 while (x != xfer->nframes) { 2098 2099 /* DATA0 / DATA1 message */ 2100 2101 temp.len = xfer->frlengths[x]; 2102 temp.step_td = ((xfer->endpointno & UE_DIR_IN) && 2103 x != 0 && temp.multishort == 0); 2104 2105 x++; 2106 2107 if (x == xfer->nframes) { 2108 if (xfer->flags_int.control_xfr) { 2109 /* no STATUS stage yet, DATA is last */ 2110 if (xfer->flags_int.control_act) 2111 temp.last_frame = 1; 2112 } else { 2113 temp.last_frame = 1; 2114 } 2115 } 2116 if (temp.len == 0) { 2117 2118 /* make sure that we send an USB packet */ 2119 2120 temp.shortpkt = 0; 2121 2122 temp.tbc = 0; 2123 temp.tlbpc = mult - 1; 2124 2125 } else if (xfer->flags_int.isochronous_xfr) { 2126 2127 uint8_t tdpc; 2128 2129 /* 2130 * Isochronous transfers don't have short 2131 * packet termination: 2132 */ 2133 2134 temp.shortpkt = 1; 2135 2136 /* isochronous transfers have a transfer limit */ 2137 2138 if (temp.len > xfer->max_frame_size) 2139 temp.len = xfer->max_frame_size; 2140 2141 /* compute TD packet count */ 2142 tdpc = (temp.len + xfer->max_packet_size - 1) / 2143 xfer->max_packet_size; 2144 2145 temp.tbc = ((tdpc + mult - 1) / mult) - 1; 2146 temp.tlbpc = (tdpc % mult); 2147 2148 if (temp.tlbpc == 0) 2149 temp.tlbpc = mult - 1; 2150 else 2151 temp.tlbpc--; 2152 } else { 2153 2154 /* regular data transfer */ 2155 2156 temp.shortpkt = xfer->flags.force_short_xfer ? 0 : 1; 2157 } 2158 2159 xhci_setup_generic_chain_sub(&temp); 2160 2161 if (xfer->flags_int.isochronous_xfr) { 2162 temp.offset += xfer->frlengths[x - 1]; 2163 temp.isoc_frame += temp.isoc_delta; 2164 } else { 2165 /* get next Page Cache pointer */ 2166 temp.pc = xfer->frbuffers + x; 2167 } 2168 } 2169 2170 /* check if we should append a status stage */ 2171 2172 if (xfer->flags_int.control_xfr && 2173 !xfer->flags_int.control_act) { 2174 2175 /* 2176 * Send a DATA1 message and invert the current 2177 * endpoint direction. 2178 */ 2179 temp.step_td = (xfer->nframes != 0); 2180 temp.direction = UE_GET_DIR(xfer->endpointno) ^ UE_DIR_IN; 2181 temp.len = 0; 2182 temp.pc = NULL; 2183 temp.shortpkt = 0; 2184 temp.last_frame = 1; 2185 temp.trb_type = XHCI_TRB_TYPE_STATUS_STAGE; 2186 2187 xhci_setup_generic_chain_sub(&temp); 2188 } 2189 2190 td = temp.td; 2191 2192 /* must have at least one frame! */ 2193 2194 xfer->td_transfer_last = td; 2195 2196 DPRINTF("first=%p last=%p\n", xfer->td_transfer_first, td); 2197 } 2198 2199 static void 2200 xhci_set_slot_pointer(struct xhci_softc *sc, uint8_t index, uint64_t dev_addr) 2201 { 2202 struct usb_page_search buf_res; 2203 struct xhci_dev_ctx_addr *pdctxa; 2204 2205 usbd_get_page(&sc->sc_hw.ctx_pc, 0, &buf_res); 2206 2207 pdctxa = buf_res.buffer; 2208 2209 DPRINTF("addr[%u]=0x%016llx\n", index, (long long)dev_addr); 2210 2211 pdctxa->qwBaaDevCtxAddr[index] = htole64(dev_addr); 2212 2213 usb_pc_cpu_flush(&sc->sc_hw.ctx_pc); 2214 } 2215 2216 static usb_error_t 2217 xhci_configure_mask(struct usb_device *udev, uint32_t mask, uint8_t drop) 2218 { 2219 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2220 struct usb_page_search buf_inp; 2221 struct xhci_input_dev_ctx *pinp; 2222 uint32_t temp; 2223 uint8_t index; 2224 uint8_t x; 2225 2226 index = udev->controller_slot_id; 2227 2228 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp); 2229 2230 pinp = buf_inp.buffer; 2231 2232 if (drop) { 2233 mask &= XHCI_INCTX_NON_CTRL_MASK; 2234 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0, mask); 2235 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, 0); 2236 } else { 2237 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx0, 0); 2238 xhci_ctx_set_le32(sc, &pinp->ctx_input.dwInCtx1, mask); 2239 2240 /* find most significant set bit */ 2241 for (x = 31; x != 1; x--) { 2242 if (mask & (1 << x)) 2243 break; 2244 } 2245 2246 /* adjust */ 2247 x--; 2248 2249 /* figure out maximum */ 2250 if (x > sc->sc_hw.devs[index].context_num) { 2251 sc->sc_hw.devs[index].context_num = x; 2252 temp = xhci_ctx_get_le32(sc, &pinp->ctx_slot.dwSctx0); 2253 temp &= ~XHCI_SCTX_0_CTX_NUM_SET(31); 2254 temp |= XHCI_SCTX_0_CTX_NUM_SET(x + 1); 2255 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp); 2256 } 2257 } 2258 return (0); 2259 } 2260 2261 static usb_error_t 2262 xhci_configure_endpoint(struct usb_device *udev, 2263 struct usb_endpoint_descriptor *edesc, struct xhci_endpoint_ext *pepext, 2264 uint16_t interval, uint8_t max_packet_count, 2265 uint8_t mult, uint8_t fps_shift, uint16_t max_packet_size, 2266 uint16_t max_frame_size, uint8_t ep_mode) 2267 { 2268 struct usb_page_search buf_inp; 2269 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2270 struct xhci_input_dev_ctx *pinp; 2271 uint64_t ring_addr = pepext->physaddr; 2272 uint32_t temp; 2273 uint8_t index; 2274 uint8_t epno; 2275 uint8_t type; 2276 2277 index = udev->controller_slot_id; 2278 2279 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp); 2280 2281 pinp = buf_inp.buffer; 2282 2283 epno = edesc->bEndpointAddress; 2284 type = edesc->bmAttributes & UE_XFERTYPE; 2285 2286 if (type == UE_CONTROL) 2287 epno |= UE_DIR_IN; 2288 2289 epno = XHCI_EPNO2EPID(epno); 2290 2291 if (epno == 0) 2292 return (USB_ERR_NO_PIPE); /* invalid */ 2293 2294 if (max_packet_count == 0) 2295 return (USB_ERR_BAD_BUFSIZE); 2296 2297 max_packet_count--; 2298 2299 if (mult == 0) 2300 return (USB_ERR_BAD_BUFSIZE); 2301 2302 /* store endpoint mode */ 2303 pepext->trb_ep_mode = ep_mode; 2304 usb_pc_cpu_flush(pepext->page_cache); 2305 2306 if (ep_mode == USB_EP_MODE_STREAMS) { 2307 temp = XHCI_EPCTX_0_EPSTATE_SET(0) | 2308 XHCI_EPCTX_0_MAXP_STREAMS_SET(XHCI_MAX_STREAMS_LOG - 1) | 2309 XHCI_EPCTX_0_LSA_SET(1); 2310 2311 ring_addr += sizeof(struct xhci_trb) * 2312 XHCI_MAX_TRANSFERS * XHCI_MAX_STREAMS; 2313 } else { 2314 temp = XHCI_EPCTX_0_EPSTATE_SET(0) | 2315 XHCI_EPCTX_0_MAXP_STREAMS_SET(0) | 2316 XHCI_EPCTX_0_LSA_SET(0); 2317 2318 ring_addr |= XHCI_EPCTX_2_DCS_SET(1); 2319 } 2320 2321 switch (udev->speed) { 2322 case USB_SPEED_FULL: 2323 case USB_SPEED_LOW: 2324 /* 1ms -> 125us */ 2325 fps_shift += 3; 2326 break; 2327 default: 2328 break; 2329 } 2330 2331 switch (type) { 2332 case UE_INTERRUPT: 2333 if (fps_shift > 3) 2334 fps_shift--; 2335 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift); 2336 break; 2337 case UE_ISOCHRONOUS: 2338 temp |= XHCI_EPCTX_0_IVAL_SET(fps_shift); 2339 2340 switch (udev->speed) { 2341 case USB_SPEED_SUPER: 2342 if (mult > 3) 2343 mult = 3; 2344 temp |= XHCI_EPCTX_0_MULT_SET(mult - 1); 2345 max_packet_count /= mult; 2346 break; 2347 default: 2348 break; 2349 } 2350 break; 2351 default: 2352 break; 2353 } 2354 2355 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx0, temp); 2356 2357 temp = 2358 XHCI_EPCTX_1_HID_SET(0) | 2359 XHCI_EPCTX_1_MAXB_SET(max_packet_count) | 2360 XHCI_EPCTX_1_MAXP_SIZE_SET(max_packet_size); 2361 2362 if ((udev->parent_hs_hub != NULL) || (udev->address != 0)) { 2363 if (type != UE_ISOCHRONOUS) 2364 temp |= XHCI_EPCTX_1_CERR_SET(3); 2365 } 2366 2367 switch (type) { 2368 case UE_CONTROL: 2369 temp |= XHCI_EPCTX_1_EPTYPE_SET(4); 2370 break; 2371 case UE_ISOCHRONOUS: 2372 temp |= XHCI_EPCTX_1_EPTYPE_SET(1); 2373 break; 2374 case UE_BULK: 2375 temp |= XHCI_EPCTX_1_EPTYPE_SET(2); 2376 break; 2377 default: 2378 temp |= XHCI_EPCTX_1_EPTYPE_SET(3); 2379 break; 2380 } 2381 2382 /* check for IN direction */ 2383 if (epno & 1) 2384 temp |= XHCI_EPCTX_1_EPTYPE_SET(4); 2385 2386 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx1, temp); 2387 xhci_ctx_set_le64(sc, &pinp->ctx_ep[epno - 1].qwEpCtx2, ring_addr); 2388 2389 switch (edesc->bmAttributes & UE_XFERTYPE) { 2390 case UE_INTERRUPT: 2391 case UE_ISOCHRONOUS: 2392 temp = XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_SET(max_frame_size) | 2393 XHCI_EPCTX_4_AVG_TRB_LEN_SET(MIN(XHCI_PAGE_SIZE, 2394 max_frame_size)); 2395 break; 2396 case UE_CONTROL: 2397 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(8); 2398 break; 2399 default: 2400 temp = XHCI_EPCTX_4_AVG_TRB_LEN_SET(XHCI_PAGE_SIZE); 2401 break; 2402 } 2403 2404 xhci_ctx_set_le32(sc, &pinp->ctx_ep[epno - 1].dwEpCtx4, temp); 2405 2406 #ifdef USB_DEBUG 2407 xhci_dump_endpoint(sc, &pinp->ctx_ep[epno - 1]); 2408 #endif 2409 usb_pc_cpu_flush(&sc->sc_hw.devs[index].input_pc); 2410 2411 return (0); /* success */ 2412 } 2413 2414 static usb_error_t 2415 xhci_configure_endpoint_by_xfer(struct usb_xfer *xfer) 2416 { 2417 struct xhci_endpoint_ext *pepext; 2418 struct usb_endpoint_ss_comp_descriptor *ecomp; 2419 usb_stream_t x; 2420 2421 pepext = xhci_get_endpoint_ext(xfer->xroot->udev, 2422 xfer->endpoint->edesc); 2423 2424 ecomp = xfer->endpoint->ecomp; 2425 2426 for (x = 0; x != XHCI_MAX_STREAMS; x++) { 2427 uint64_t temp; 2428 2429 /* halt any transfers */ 2430 pepext->trb[x * XHCI_MAX_TRANSFERS].dwTrb3 = 0; 2431 2432 /* compute start of TRB ring for stream "x" */ 2433 temp = pepext->physaddr + 2434 (x * XHCI_MAX_TRANSFERS * sizeof(struct xhci_trb)) + 2435 XHCI_SCTX_0_SCT_SEC_TR_RING; 2436 2437 /* make tree structure */ 2438 pepext->trb[(XHCI_MAX_TRANSFERS * 2439 XHCI_MAX_STREAMS) + x].qwTrb0 = htole64(temp); 2440 2441 /* reserved fields */ 2442 pepext->trb[(XHCI_MAX_TRANSFERS * 2443 XHCI_MAX_STREAMS) + x].dwTrb2 = 0; 2444 pepext->trb[(XHCI_MAX_TRANSFERS * 2445 XHCI_MAX_STREAMS) + x].dwTrb3 = 0; 2446 } 2447 usb_pc_cpu_flush(pepext->page_cache); 2448 2449 return (xhci_configure_endpoint(xfer->xroot->udev, 2450 xfer->endpoint->edesc, pepext, 2451 xfer->interval, xfer->max_packet_count, 2452 (ecomp != NULL) ? UE_GET_SS_ISO_MULT(ecomp->bmAttributes) + 1 : 1, 2453 usbd_xfer_get_fps_shift(xfer), xfer->max_packet_size, 2454 xfer->max_frame_size, xfer->endpoint->ep_mode)); 2455 } 2456 2457 static usb_error_t 2458 xhci_configure_device(struct usb_device *udev) 2459 { 2460 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2461 struct usb_page_search buf_inp; 2462 struct usb_page_cache *pcinp; 2463 struct xhci_input_dev_ctx *pinp; 2464 struct usb_device *hubdev; 2465 uint32_t temp; 2466 uint32_t route; 2467 uint32_t rh_port; 2468 uint8_t is_hub; 2469 uint8_t index; 2470 uint8_t depth; 2471 2472 index = udev->controller_slot_id; 2473 2474 DPRINTF("index=%u\n", index); 2475 2476 pcinp = &sc->sc_hw.devs[index].input_pc; 2477 2478 usbd_get_page(pcinp, 0, &buf_inp); 2479 2480 pinp = buf_inp.buffer; 2481 2482 rh_port = 0; 2483 route = 0; 2484 2485 /* figure out route string and root HUB port number */ 2486 2487 for (hubdev = udev; hubdev != NULL; hubdev = hubdev->parent_hub) { 2488 2489 if (hubdev->parent_hub == NULL) 2490 break; 2491 2492 depth = hubdev->parent_hub->depth; 2493 2494 /* 2495 * NOTE: HS/FS/LS devices and the SS root HUB can have 2496 * more than 15 ports 2497 */ 2498 2499 rh_port = hubdev->port_no; 2500 2501 if (depth == 0) 2502 break; 2503 2504 if (rh_port > 15) 2505 rh_port = 15; 2506 2507 if (depth < 6) 2508 route |= rh_port << (4 * (depth - 1)); 2509 } 2510 2511 DPRINTF("Route=0x%08x\n", route); 2512 2513 temp = XHCI_SCTX_0_ROUTE_SET(route) | 2514 XHCI_SCTX_0_CTX_NUM_SET( 2515 sc->sc_hw.devs[index].context_num + 1); 2516 2517 switch (udev->speed) { 2518 case USB_SPEED_LOW: 2519 temp |= XHCI_SCTX_0_SPEED_SET(2); 2520 if (udev->parent_hs_hub != NULL && 2521 udev->parent_hs_hub->ddesc.bDeviceProtocol == 2522 UDPROTO_HSHUBMTT) { 2523 DPRINTF("Device inherits MTT\n"); 2524 temp |= XHCI_SCTX_0_MTT_SET(1); 2525 } 2526 break; 2527 case USB_SPEED_HIGH: 2528 temp |= XHCI_SCTX_0_SPEED_SET(3); 2529 if (sc->sc_hw.devs[index].nports != 0 && 2530 udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBMTT) { 2531 DPRINTF("HUB supports MTT\n"); 2532 temp |= XHCI_SCTX_0_MTT_SET(1); 2533 } 2534 break; 2535 case USB_SPEED_FULL: 2536 temp |= XHCI_SCTX_0_SPEED_SET(1); 2537 if (udev->parent_hs_hub != NULL && 2538 udev->parent_hs_hub->ddesc.bDeviceProtocol == 2539 UDPROTO_HSHUBMTT) { 2540 DPRINTF("Device inherits MTT\n"); 2541 temp |= XHCI_SCTX_0_MTT_SET(1); 2542 } 2543 break; 2544 default: 2545 temp |= XHCI_SCTX_0_SPEED_SET(4); 2546 break; 2547 } 2548 2549 is_hub = sc->sc_hw.devs[index].nports != 0 && 2550 (udev->speed == USB_SPEED_SUPER || 2551 udev->speed == USB_SPEED_HIGH); 2552 2553 if (is_hub) 2554 temp |= XHCI_SCTX_0_HUB_SET(1); 2555 2556 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx0, temp); 2557 2558 temp = XHCI_SCTX_1_RH_PORT_SET(rh_port); 2559 2560 if (is_hub) { 2561 temp |= XHCI_SCTX_1_NUM_PORTS_SET( 2562 sc->sc_hw.devs[index].nports); 2563 } 2564 2565 switch (udev->speed) { 2566 case USB_SPEED_SUPER: 2567 switch (sc->sc_hw.devs[index].state) { 2568 case XHCI_ST_ADDRESSED: 2569 case XHCI_ST_CONFIGURED: 2570 /* enable power save */ 2571 temp |= XHCI_SCTX_1_MAX_EL_SET(sc->sc_exit_lat_max); 2572 break; 2573 default: 2574 /* disable power save */ 2575 break; 2576 } 2577 break; 2578 default: 2579 break; 2580 } 2581 2582 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx1, temp); 2583 2584 temp = XHCI_SCTX_2_IRQ_TARGET_SET(0); 2585 2586 if (is_hub) { 2587 temp |= XHCI_SCTX_2_TT_THINK_TIME_SET( 2588 sc->sc_hw.devs[index].tt); 2589 } 2590 2591 hubdev = udev->parent_hs_hub; 2592 2593 /* check if we should activate the transaction translator */ 2594 switch (udev->speed) { 2595 case USB_SPEED_FULL: 2596 case USB_SPEED_LOW: 2597 if (hubdev != NULL) { 2598 temp |= XHCI_SCTX_2_TT_HUB_SID_SET( 2599 hubdev->controller_slot_id); 2600 temp |= XHCI_SCTX_2_TT_PORT_NUM_SET( 2601 udev->hs_port_no); 2602 } 2603 break; 2604 default: 2605 break; 2606 } 2607 2608 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx2, temp); 2609 2610 /* 2611 * These fields should be initialized to zero, according to 2612 * XHCI section 6.2.2 - slot context: 2613 */ 2614 temp = XHCI_SCTX_3_DEV_ADDR_SET(0) | 2615 XHCI_SCTX_3_SLOT_STATE_SET(0); 2616 2617 xhci_ctx_set_le32(sc, &pinp->ctx_slot.dwSctx3, temp); 2618 2619 #ifdef USB_DEBUG 2620 xhci_dump_device(sc, &pinp->ctx_slot); 2621 #endif 2622 usb_pc_cpu_flush(pcinp); 2623 2624 return (0); /* success */ 2625 } 2626 2627 static usb_error_t 2628 xhci_alloc_device_ext(struct usb_device *udev) 2629 { 2630 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2631 struct usb_page_search buf_dev; 2632 struct usb_page_search buf_ep; 2633 struct xhci_trb *trb; 2634 struct usb_page_cache *pc; 2635 struct usb_page *pg; 2636 uint64_t addr; 2637 uint8_t index; 2638 uint8_t i; 2639 2640 index = udev->controller_slot_id; 2641 2642 pc = &sc->sc_hw.devs[index].device_pc; 2643 pg = &sc->sc_hw.devs[index].device_pg; 2644 2645 /* need to initialize the page cache */ 2646 pc->tag_parent = sc->sc_bus.dma_parent_tag; 2647 2648 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ? 2649 (2 * sizeof(struct xhci_dev_ctx)) : 2650 sizeof(struct xhci_dev_ctx), XHCI_PAGE_SIZE)) 2651 goto error; 2652 2653 usbd_get_page(pc, 0, &buf_dev); 2654 2655 pc = &sc->sc_hw.devs[index].input_pc; 2656 pg = &sc->sc_hw.devs[index].input_pg; 2657 2658 /* need to initialize the page cache */ 2659 pc->tag_parent = sc->sc_bus.dma_parent_tag; 2660 2661 if (usb_pc_alloc_mem(pc, pg, sc->sc_ctx_is_64_byte ? 2662 (2 * sizeof(struct xhci_input_dev_ctx)) : 2663 sizeof(struct xhci_input_dev_ctx), XHCI_PAGE_SIZE)) { 2664 goto error; 2665 } 2666 2667 pc = &sc->sc_hw.devs[index].endpoint_pc; 2668 pg = &sc->sc_hw.devs[index].endpoint_pg; 2669 2670 /* need to initialize the page cache */ 2671 pc->tag_parent = sc->sc_bus.dma_parent_tag; 2672 2673 if (usb_pc_alloc_mem(pc, pg, 2674 sizeof(struct xhci_dev_endpoint_trbs), XHCI_PAGE_SIZE)) { 2675 goto error; 2676 } 2677 2678 /* initialise all endpoint LINK TRBs */ 2679 2680 for (i = 0; i != XHCI_MAX_ENDPOINTS; i++) { 2681 2682 /* lookup endpoint TRB ring */ 2683 usbd_get_page(pc, (uintptr_t)& 2684 ((struct xhci_dev_endpoint_trbs *)0)->trb[i][0], &buf_ep); 2685 2686 /* get TRB pointer */ 2687 trb = buf_ep.buffer; 2688 trb += XHCI_MAX_TRANSFERS - 1; 2689 2690 /* get TRB start address */ 2691 addr = buf_ep.physaddr; 2692 2693 /* create LINK TRB */ 2694 trb->qwTrb0 = htole64(addr); 2695 trb->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0)); 2696 trb->dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT | 2697 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK)); 2698 } 2699 2700 usb_pc_cpu_flush(pc); 2701 2702 xhci_set_slot_pointer(sc, index, buf_dev.physaddr); 2703 2704 return (0); 2705 2706 error: 2707 xhci_free_device_ext(udev); 2708 2709 return (USB_ERR_NOMEM); 2710 } 2711 2712 static void 2713 xhci_free_device_ext(struct usb_device *udev) 2714 { 2715 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2716 uint8_t index; 2717 2718 index = udev->controller_slot_id; 2719 xhci_set_slot_pointer(sc, index, 0); 2720 2721 usb_pc_free_mem(&sc->sc_hw.devs[index].device_pc); 2722 usb_pc_free_mem(&sc->sc_hw.devs[index].input_pc); 2723 usb_pc_free_mem(&sc->sc_hw.devs[index].endpoint_pc); 2724 } 2725 2726 static struct xhci_endpoint_ext * 2727 xhci_get_endpoint_ext(struct usb_device *udev, struct usb_endpoint_descriptor *edesc) 2728 { 2729 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 2730 struct xhci_endpoint_ext *pepext; 2731 struct usb_page_cache *pc; 2732 struct usb_page_search buf_ep; 2733 uint8_t epno; 2734 uint8_t index; 2735 2736 epno = edesc->bEndpointAddress; 2737 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL) 2738 epno |= UE_DIR_IN; 2739 2740 epno = XHCI_EPNO2EPID(epno); 2741 2742 index = udev->controller_slot_id; 2743 2744 pc = &sc->sc_hw.devs[index].endpoint_pc; 2745 2746 usbd_get_page(pc, (uintptr_t)&((struct xhci_dev_endpoint_trbs *)0)-> 2747 trb[epno][0], &buf_ep); 2748 2749 pepext = &sc->sc_hw.devs[index].endp[epno]; 2750 pepext->page_cache = pc; 2751 pepext->trb = buf_ep.buffer; 2752 pepext->physaddr = buf_ep.physaddr; 2753 2754 return (pepext); 2755 } 2756 2757 static void 2758 xhci_endpoint_doorbell(struct usb_xfer *xfer) 2759 { 2760 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus); 2761 uint8_t epno; 2762 uint8_t index; 2763 2764 epno = xfer->endpointno; 2765 if (xfer->flags_int.control_xfr) 2766 epno |= UE_DIR_IN; 2767 2768 epno = XHCI_EPNO2EPID(epno); 2769 index = xfer->xroot->udev->controller_slot_id; 2770 2771 if (xfer->xroot->udev->flags.self_suspended == 0) { 2772 XWRITE4(sc, door, XHCI_DOORBELL(index), 2773 epno | XHCI_DB_SID_SET(xfer->stream_id)); 2774 } 2775 } 2776 2777 static void 2778 xhci_transfer_remove(struct usb_xfer *xfer, usb_error_t error) 2779 { 2780 struct xhci_endpoint_ext *pepext; 2781 2782 if (xfer->flags_int.bandwidth_reclaimed) { 2783 xfer->flags_int.bandwidth_reclaimed = 0; 2784 2785 pepext = xhci_get_endpoint_ext(xfer->xroot->udev, 2786 xfer->endpoint->edesc); 2787 2788 pepext->trb_used[xfer->stream_id]--; 2789 2790 pepext->xfer[xfer->qh_pos] = NULL; 2791 2792 if (error && pepext->trb_running != 0) { 2793 pepext->trb_halted = 1; 2794 pepext->trb_running = 0; 2795 } 2796 } 2797 } 2798 2799 static usb_error_t 2800 xhci_transfer_insert(struct usb_xfer *xfer) 2801 { 2802 struct xhci_td *td_first; 2803 struct xhci_td *td_last; 2804 struct xhci_trb *trb_link; 2805 struct xhci_endpoint_ext *pepext; 2806 uint64_t addr; 2807 usb_stream_t id; 2808 uint8_t i; 2809 uint8_t inext; 2810 uint8_t trb_limit; 2811 2812 DPRINTFN(8, "\n"); 2813 2814 id = xfer->stream_id; 2815 2816 /* check if already inserted */ 2817 if (xfer->flags_int.bandwidth_reclaimed) { 2818 DPRINTFN(8, "Already in schedule\n"); 2819 return (0); 2820 } 2821 2822 pepext = xhci_get_endpoint_ext(xfer->xroot->udev, 2823 xfer->endpoint->edesc); 2824 2825 td_first = xfer->td_transfer_first; 2826 td_last = xfer->td_transfer_last; 2827 addr = pepext->physaddr; 2828 2829 switch (xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE) { 2830 case UE_CONTROL: 2831 case UE_INTERRUPT: 2832 /* single buffered */ 2833 trb_limit = 1; 2834 break; 2835 default: 2836 /* multi buffered */ 2837 trb_limit = (XHCI_MAX_TRANSFERS - 2); 2838 break; 2839 } 2840 2841 if (pepext->trb_used[id] >= trb_limit) { 2842 DPRINTFN(8, "Too many TDs queued.\n"); 2843 return (USB_ERR_NOMEM); 2844 } 2845 2846 /* check for stopped condition, after putting transfer on interrupt queue */ 2847 if (pepext->trb_running == 0) { 2848 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus); 2849 2850 DPRINTFN(8, "Not running\n"); 2851 2852 /* start configuration */ 2853 (void)usb_proc_msignal(USB_BUS_CONTROL_XFER_PROC(&sc->sc_bus), 2854 &sc->sc_config_msg[0], &sc->sc_config_msg[1]); 2855 return (0); 2856 } 2857 2858 pepext->trb_used[id]++; 2859 2860 /* get current TRB index */ 2861 i = pepext->trb_index[id]; 2862 2863 /* get next TRB index */ 2864 inext = (i + 1); 2865 2866 /* the last entry of the ring is a hardcoded link TRB */ 2867 if (inext >= (XHCI_MAX_TRANSFERS - 1)) 2868 inext = 0; 2869 2870 /* store next TRB index, before stream ID offset is added */ 2871 pepext->trb_index[id] = inext; 2872 2873 /* offset for stream */ 2874 i += id * XHCI_MAX_TRANSFERS; 2875 inext += id * XHCI_MAX_TRANSFERS; 2876 2877 /* compute terminating return address */ 2878 addr += (inext * sizeof(struct xhci_trb)); 2879 2880 /* compute link TRB pointer */ 2881 trb_link = td_last->td_trb + td_last->ntrb; 2882 2883 /* update next pointer of last link TRB */ 2884 trb_link->qwTrb0 = htole64(addr); 2885 trb_link->dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0)); 2886 trb_link->dwTrb3 = htole32(XHCI_TRB_3_IOC_BIT | 2887 XHCI_TRB_3_CYCLE_BIT | 2888 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK)); 2889 2890 #ifdef USB_DEBUG 2891 xhci_dump_trb(&td_last->td_trb[td_last->ntrb]); 2892 #endif 2893 usb_pc_cpu_flush(td_last->page_cache); 2894 2895 /* write ahead chain end marker */ 2896 2897 pepext->trb[inext].qwTrb0 = 0; 2898 pepext->trb[inext].dwTrb2 = 0; 2899 pepext->trb[inext].dwTrb3 = 0; 2900 2901 /* update next pointer of link TRB */ 2902 2903 pepext->trb[i].qwTrb0 = htole64((uint64_t)td_first->td_self); 2904 pepext->trb[i].dwTrb2 = htole32(XHCI_TRB_2_IRQ_SET(0)); 2905 2906 #ifdef USB_DEBUG 2907 xhci_dump_trb(&pepext->trb[i]); 2908 #endif 2909 usb_pc_cpu_flush(pepext->page_cache); 2910 2911 /* toggle cycle bit which activates the transfer chain */ 2912 2913 pepext->trb[i].dwTrb3 = htole32(XHCI_TRB_3_CYCLE_BIT | 2914 XHCI_TRB_3_TYPE_SET(XHCI_TRB_TYPE_LINK)); 2915 2916 usb_pc_cpu_flush(pepext->page_cache); 2917 2918 DPRINTF("qh_pos = %u\n", i); 2919 2920 pepext->xfer[i] = xfer; 2921 2922 xfer->qh_pos = i; 2923 2924 xfer->flags_int.bandwidth_reclaimed = 1; 2925 2926 xhci_endpoint_doorbell(xfer); 2927 2928 return (0); 2929 } 2930 2931 static void 2932 xhci_root_intr(struct xhci_softc *sc) 2933 { 2934 uint16_t i; 2935 2936 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED); 2937 2938 /* clear any old interrupt data */ 2939 memset(sc->sc_hub_idata, 0, sizeof(sc->sc_hub_idata)); 2940 2941 for (i = 1; i <= sc->sc_noport; i++) { 2942 /* pick out CHANGE bits from the status register */ 2943 if (XREAD4(sc, oper, XHCI_PORTSC(i)) & ( 2944 XHCI_PS_CSC | XHCI_PS_PEC | 2945 XHCI_PS_OCC | XHCI_PS_WRC | 2946 XHCI_PS_PRC | XHCI_PS_PLC | 2947 XHCI_PS_CEC)) { 2948 sc->sc_hub_idata[i / 8] |= 1 << (i % 8); 2949 DPRINTF("port %d changed\n", i); 2950 } 2951 } 2952 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata, 2953 sizeof(sc->sc_hub_idata)); 2954 } 2955 2956 /*------------------------------------------------------------------------* 2957 * xhci_device_done - XHCI done handler 2958 * 2959 * NOTE: This function can be called two times in a row on 2960 * the same USB transfer. From close and from interrupt. 2961 *------------------------------------------------------------------------*/ 2962 static void 2963 xhci_device_done(struct usb_xfer *xfer, usb_error_t error) 2964 { 2965 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n", 2966 xfer, xfer->endpoint, error); 2967 2968 /* remove transfer from HW queue */ 2969 xhci_transfer_remove(xfer, error); 2970 2971 /* dequeue transfer and start next transfer */ 2972 usbd_transfer_done(xfer, error); 2973 } 2974 2975 /*------------------------------------------------------------------------* 2976 * XHCI data transfer support (generic type) 2977 *------------------------------------------------------------------------*/ 2978 static void 2979 xhci_device_generic_open(struct usb_xfer *xfer) 2980 { 2981 if (xfer->flags_int.isochronous_xfr) { 2982 switch (xfer->xroot->udev->speed) { 2983 case USB_SPEED_FULL: 2984 break; 2985 default: 2986 usb_hs_bandwidth_alloc(xfer); 2987 break; 2988 } 2989 } 2990 } 2991 2992 static void 2993 xhci_device_generic_close(struct usb_xfer *xfer) 2994 { 2995 DPRINTF("\n"); 2996 2997 xhci_device_done(xfer, USB_ERR_CANCELLED); 2998 2999 if (xfer->flags_int.isochronous_xfr) { 3000 switch (xfer->xroot->udev->speed) { 3001 case USB_SPEED_FULL: 3002 break; 3003 default: 3004 usb_hs_bandwidth_free(xfer); 3005 break; 3006 } 3007 } 3008 } 3009 3010 static void 3011 xhci_device_generic_multi_enter(struct usb_endpoint *ep, 3012 usb_stream_t stream_id, struct usb_xfer *enter_xfer) 3013 { 3014 struct usb_xfer *xfer; 3015 3016 /* check if there is a current transfer */ 3017 xfer = ep->endpoint_q[stream_id].curr; 3018 if (xfer == NULL) 3019 return; 3020 3021 /* 3022 * Check if the current transfer is started and then pickup 3023 * the next one, if any. Else wait for next start event due to 3024 * block on failure feature. 3025 */ 3026 if (!xfer->flags_int.bandwidth_reclaimed) 3027 return; 3028 3029 xfer = TAILQ_FIRST(&ep->endpoint_q[stream_id].head); 3030 if (xfer == NULL) { 3031 /* 3032 * In case of enter we have to consider that the 3033 * transfer is queued by the USB core after the enter 3034 * method is called. 3035 */ 3036 xfer = enter_xfer; 3037 3038 if (xfer == NULL) 3039 return; 3040 } 3041 3042 /* try to multi buffer */ 3043 xhci_transfer_insert(xfer); 3044 } 3045 3046 static void 3047 xhci_device_generic_enter(struct usb_xfer *xfer) 3048 { 3049 DPRINTF("\n"); 3050 3051 /* setup TD's and QH */ 3052 xhci_setup_generic_chain(xfer); 3053 3054 xhci_device_generic_multi_enter(xfer->endpoint, 3055 xfer->stream_id, xfer); 3056 } 3057 3058 static void 3059 xhci_device_generic_start(struct usb_xfer *xfer) 3060 { 3061 DPRINTF("\n"); 3062 3063 /* try to insert xfer on HW queue */ 3064 xhci_transfer_insert(xfer); 3065 3066 /* try to multi buffer */ 3067 xhci_device_generic_multi_enter(xfer->endpoint, 3068 xfer->stream_id, NULL); 3069 3070 /* add transfer last on interrupt queue */ 3071 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer); 3072 3073 /* start timeout, if any */ 3074 if (xfer->timeout != 0) 3075 usbd_transfer_timeout_ms(xfer, &xhci_timeout, xfer->timeout); 3076 } 3077 3078 static const struct usb_pipe_methods xhci_device_generic_methods = 3079 { 3080 .open = xhci_device_generic_open, 3081 .close = xhci_device_generic_close, 3082 .enter = xhci_device_generic_enter, 3083 .start = xhci_device_generic_start, 3084 }; 3085 3086 /*------------------------------------------------------------------------* 3087 * xhci root HUB support 3088 *------------------------------------------------------------------------* 3089 * Simulate a hardware HUB by handling all the necessary requests. 3090 *------------------------------------------------------------------------*/ 3091 3092 #define HSETW(ptr, val) ptr = { (uint8_t)(val), (uint8_t)((val) >> 8) } 3093 3094 static const 3095 struct usb_device_descriptor xhci_devd = 3096 { 3097 .bLength = sizeof(xhci_devd), 3098 .bDescriptorType = UDESC_DEVICE, /* type */ 3099 HSETW(.bcdUSB, 0x0300), /* USB version */ 3100 .bDeviceClass = UDCLASS_HUB, /* class */ 3101 .bDeviceSubClass = UDSUBCLASS_HUB, /* subclass */ 3102 .bDeviceProtocol = UDPROTO_SSHUB, /* protocol */ 3103 .bMaxPacketSize = 9, /* max packet size */ 3104 HSETW(.idVendor, 0x0000), /* vendor */ 3105 HSETW(.idProduct, 0x0000), /* product */ 3106 HSETW(.bcdDevice, 0x0100), /* device version */ 3107 .iManufacturer = 1, 3108 .iProduct = 2, 3109 .iSerialNumber = 0, 3110 .bNumConfigurations = 1, /* # of configurations */ 3111 }; 3112 3113 static const 3114 struct xhci_bos_desc xhci_bosd = { 3115 .bosd = { 3116 .bLength = sizeof(xhci_bosd.bosd), 3117 .bDescriptorType = UDESC_BOS, 3118 HSETW(.wTotalLength, sizeof(xhci_bosd)), 3119 .bNumDeviceCaps = 3, 3120 }, 3121 .usb2extd = { 3122 .bLength = sizeof(xhci_bosd.usb2extd), 3123 .bDescriptorType = 1, 3124 .bDevCapabilityType = 2, 3125 .bmAttributes[0] = 2, 3126 }, 3127 .usbdcd = { 3128 .bLength = sizeof(xhci_bosd.usbdcd), 3129 .bDescriptorType = UDESC_DEVICE_CAPABILITY, 3130 .bDevCapabilityType = 3, 3131 .bmAttributes = 0, /* XXX */ 3132 HSETW(.wSpeedsSupported, 0x000C), 3133 .bFunctionalitySupport = 8, 3134 .bU1DevExitLat = 255, /* dummy - not used */ 3135 .wU2DevExitLat = { 0x00, 0x08 }, 3136 }, 3137 .cidd = { 3138 .bLength = sizeof(xhci_bosd.cidd), 3139 .bDescriptorType = 1, 3140 .bDevCapabilityType = 4, 3141 .bReserved = 0, 3142 .bContainerID = 0, /* XXX */ 3143 }, 3144 }; 3145 3146 static const 3147 struct xhci_config_desc xhci_confd = { 3148 .confd = { 3149 .bLength = sizeof(xhci_confd.confd), 3150 .bDescriptorType = UDESC_CONFIG, 3151 .wTotalLength[0] = sizeof(xhci_confd), 3152 .bNumInterface = 1, 3153 .bConfigurationValue = 1, 3154 .iConfiguration = 0, 3155 .bmAttributes = UC_SELF_POWERED, 3156 .bMaxPower = 0 /* max power */ 3157 }, 3158 .ifcd = { 3159 .bLength = sizeof(xhci_confd.ifcd), 3160 .bDescriptorType = UDESC_INTERFACE, 3161 .bNumEndpoints = 1, 3162 .bInterfaceClass = UICLASS_HUB, 3163 .bInterfaceSubClass = UISUBCLASS_HUB, 3164 .bInterfaceProtocol = 0, 3165 }, 3166 .endpd = { 3167 .bLength = sizeof(xhci_confd.endpd), 3168 .bDescriptorType = UDESC_ENDPOINT, 3169 .bEndpointAddress = UE_DIR_IN | XHCI_INTR_ENDPT, 3170 .bmAttributes = UE_INTERRUPT, 3171 .wMaxPacketSize[0] = 2, /* max 15 ports */ 3172 .bInterval = 255, 3173 }, 3174 .endpcd = { 3175 .bLength = sizeof(xhci_confd.endpcd), 3176 .bDescriptorType = UDESC_ENDPOINT_SS_COMP, 3177 .bMaxBurst = 0, 3178 .bmAttributes = 0, 3179 }, 3180 }; 3181 3182 static const 3183 struct usb_hub_ss_descriptor xhci_hubd = { 3184 .bLength = sizeof(xhci_hubd), 3185 .bDescriptorType = UDESC_SS_HUB, 3186 }; 3187 3188 static usb_error_t 3189 xhci_roothub_exec(struct usb_device *udev, 3190 struct usb_device_request *req, const void **pptr, uint16_t *plength) 3191 { 3192 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 3193 const char *str_ptr; 3194 const void *ptr; 3195 uint32_t port; 3196 uint32_t v; 3197 uint16_t len; 3198 uint16_t i; 3199 uint16_t value; 3200 uint16_t index; 3201 uint8_t j; 3202 usb_error_t err; 3203 3204 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED); 3205 3206 /* buffer reset */ 3207 ptr = (const void *)&sc->sc_hub_desc; 3208 len = 0; 3209 err = 0; 3210 3211 value = UGETW(req->wValue); 3212 index = UGETW(req->wIndex); 3213 3214 DPRINTFN(3, "type=0x%02x request=0x%02x wLen=0x%04x " 3215 "wValue=0x%04x wIndex=0x%04x\n", 3216 req->bmRequestType, req->bRequest, 3217 UGETW(req->wLength), value, index); 3218 3219 #define C(x,y) ((x) | ((y) << 8)) 3220 switch (C(req->bRequest, req->bmRequestType)) { 3221 case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE): 3222 case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE): 3223 case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT): 3224 /* 3225 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops 3226 * for the integrated root hub. 3227 */ 3228 break; 3229 case C(UR_GET_CONFIG, UT_READ_DEVICE): 3230 len = 1; 3231 sc->sc_hub_desc.temp[0] = sc->sc_conf; 3232 break; 3233 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE): 3234 switch (value >> 8) { 3235 case UDESC_DEVICE: 3236 if ((value & 0xff) != 0) { 3237 err = USB_ERR_IOERROR; 3238 goto done; 3239 } 3240 len = sizeof(xhci_devd); 3241 ptr = (const void *)&xhci_devd; 3242 break; 3243 3244 case UDESC_BOS: 3245 if ((value & 0xff) != 0) { 3246 err = USB_ERR_IOERROR; 3247 goto done; 3248 } 3249 len = sizeof(xhci_bosd); 3250 ptr = (const void *)&xhci_bosd; 3251 break; 3252 3253 case UDESC_CONFIG: 3254 if ((value & 0xff) != 0) { 3255 err = USB_ERR_IOERROR; 3256 goto done; 3257 } 3258 len = sizeof(xhci_confd); 3259 ptr = (const void *)&xhci_confd; 3260 break; 3261 3262 case UDESC_STRING: 3263 switch (value & 0xff) { 3264 case 0: /* Language table */ 3265 str_ptr = "\001"; 3266 break; 3267 3268 case 1: /* Vendor */ 3269 str_ptr = sc->sc_vendor; 3270 break; 3271 3272 case 2: /* Product */ 3273 str_ptr = "XHCI root HUB"; 3274 break; 3275 3276 default: 3277 str_ptr = ""; 3278 break; 3279 } 3280 3281 len = usb_make_str_desc( 3282 sc->sc_hub_desc.temp, 3283 sizeof(sc->sc_hub_desc.temp), 3284 str_ptr); 3285 break; 3286 3287 default: 3288 err = USB_ERR_IOERROR; 3289 goto done; 3290 } 3291 break; 3292 case C(UR_GET_INTERFACE, UT_READ_INTERFACE): 3293 len = 1; 3294 sc->sc_hub_desc.temp[0] = 0; 3295 break; 3296 case C(UR_GET_STATUS, UT_READ_DEVICE): 3297 len = 2; 3298 USETW(sc->sc_hub_desc.stat.wStatus, UDS_SELF_POWERED); 3299 break; 3300 case C(UR_GET_STATUS, UT_READ_INTERFACE): 3301 case C(UR_GET_STATUS, UT_READ_ENDPOINT): 3302 len = 2; 3303 USETW(sc->sc_hub_desc.stat.wStatus, 0); 3304 break; 3305 case C(UR_SET_ADDRESS, UT_WRITE_DEVICE): 3306 if (value >= XHCI_MAX_DEVICES) { 3307 err = USB_ERR_IOERROR; 3308 goto done; 3309 } 3310 break; 3311 case C(UR_SET_CONFIG, UT_WRITE_DEVICE): 3312 if (value != 0 && value != 1) { 3313 err = USB_ERR_IOERROR; 3314 goto done; 3315 } 3316 sc->sc_conf = value; 3317 break; 3318 case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE): 3319 break; 3320 case C(UR_SET_FEATURE, UT_WRITE_DEVICE): 3321 case C(UR_SET_FEATURE, UT_WRITE_INTERFACE): 3322 case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT): 3323 err = USB_ERR_IOERROR; 3324 goto done; 3325 case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE): 3326 break; 3327 case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT): 3328 break; 3329 /* Hub requests */ 3330 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE): 3331 break; 3332 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER): 3333 DPRINTFN(9, "UR_CLEAR_PORT_FEATURE\n"); 3334 3335 if ((index < 1) || 3336 (index > sc->sc_noport)) { 3337 err = USB_ERR_IOERROR; 3338 goto done; 3339 } 3340 port = XHCI_PORTSC(index); 3341 3342 v = XREAD4(sc, oper, port); 3343 i = XHCI_PS_PLS_GET(v); 3344 v &= ~XHCI_PS_CLEAR; 3345 3346 switch (value) { 3347 case UHF_C_BH_PORT_RESET: 3348 XWRITE4(sc, oper, port, v | XHCI_PS_WRC); 3349 break; 3350 case UHF_C_PORT_CONFIG_ERROR: 3351 XWRITE4(sc, oper, port, v | XHCI_PS_CEC); 3352 break; 3353 case UHF_C_PORT_SUSPEND: 3354 case UHF_C_PORT_LINK_STATE: 3355 XWRITE4(sc, oper, port, v | XHCI_PS_PLC); 3356 break; 3357 case UHF_C_PORT_CONNECTION: 3358 XWRITE4(sc, oper, port, v | XHCI_PS_CSC); 3359 break; 3360 case UHF_C_PORT_ENABLE: 3361 XWRITE4(sc, oper, port, v | XHCI_PS_PEC); 3362 break; 3363 case UHF_C_PORT_OVER_CURRENT: 3364 XWRITE4(sc, oper, port, v | XHCI_PS_OCC); 3365 break; 3366 case UHF_C_PORT_RESET: 3367 XWRITE4(sc, oper, port, v | XHCI_PS_PRC); 3368 break; 3369 case UHF_PORT_ENABLE: 3370 XWRITE4(sc, oper, port, v | XHCI_PS_PED); 3371 break; 3372 case UHF_PORT_POWER: 3373 XWRITE4(sc, oper, port, v & ~XHCI_PS_PP); 3374 break; 3375 case UHF_PORT_INDICATOR: 3376 XWRITE4(sc, oper, port, v & ~XHCI_PS_PIC_SET(3)); 3377 break; 3378 case UHF_PORT_SUSPEND: 3379 3380 /* U3 -> U15 */ 3381 if (i == 3) { 3382 XWRITE4(sc, oper, port, v | 3383 XHCI_PS_PLS_SET(0xF) | XHCI_PS_LWS); 3384 } 3385 3386 /* wait 20ms for resume sequence to complete */ 3387 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 50); 3388 3389 /* U0 */ 3390 XWRITE4(sc, oper, port, v | 3391 XHCI_PS_PLS_SET(0) | XHCI_PS_LWS); 3392 break; 3393 default: 3394 err = USB_ERR_IOERROR; 3395 goto done; 3396 } 3397 break; 3398 3399 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE): 3400 if ((value & 0xff) != 0) { 3401 err = USB_ERR_IOERROR; 3402 goto done; 3403 } 3404 3405 v = XREAD4(sc, capa, XHCI_HCSPARAMS0); 3406 3407 sc->sc_hub_desc.hubd = xhci_hubd; 3408 3409 sc->sc_hub_desc.hubd.bNbrPorts = sc->sc_noport; 3410 3411 if (XHCI_HCS0_PPC(v)) 3412 i = UHD_PWR_INDIVIDUAL; 3413 else 3414 i = UHD_PWR_GANGED; 3415 3416 if (XHCI_HCS0_PIND(v)) 3417 i |= UHD_PORT_IND; 3418 3419 i |= UHD_OC_INDIVIDUAL; 3420 3421 USETW(sc->sc_hub_desc.hubd.wHubCharacteristics, i); 3422 3423 /* see XHCI section 5.4.9: */ 3424 sc->sc_hub_desc.hubd.bPwrOn2PwrGood = 10; 3425 3426 for (j = 1; j <= sc->sc_noport; j++) { 3427 3428 v = XREAD4(sc, oper, XHCI_PORTSC(j)); 3429 if (v & XHCI_PS_DR) { 3430 sc->sc_hub_desc.hubd. 3431 DeviceRemovable[j / 8] |= 1U << (j % 8); 3432 } 3433 } 3434 len = sc->sc_hub_desc.hubd.bLength; 3435 break; 3436 3437 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE): 3438 len = 16; 3439 memset(sc->sc_hub_desc.temp, 0, 16); 3440 break; 3441 3442 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER): 3443 DPRINTFN(9, "UR_GET_STATUS i=%d\n", index); 3444 3445 if ((index < 1) || 3446 (index > sc->sc_noport)) { 3447 err = USB_ERR_IOERROR; 3448 goto done; 3449 } 3450 3451 v = XREAD4(sc, oper, XHCI_PORTSC(index)); 3452 3453 DPRINTFN(9, "port status=0x%08x\n", v); 3454 3455 i = UPS_PORT_LINK_STATE_SET(XHCI_PS_PLS_GET(v)); 3456 3457 switch (XHCI_PS_SPEED_GET(v)) { 3458 case 3: 3459 i |= UPS_HIGH_SPEED; 3460 break; 3461 case 2: 3462 i |= UPS_LOW_SPEED; 3463 break; 3464 case 1: 3465 /* FULL speed */ 3466 break; 3467 default: 3468 i |= UPS_OTHER_SPEED; 3469 break; 3470 } 3471 3472 if (v & XHCI_PS_CCS) 3473 i |= UPS_CURRENT_CONNECT_STATUS; 3474 if (v & XHCI_PS_PED) 3475 i |= UPS_PORT_ENABLED; 3476 if (v & XHCI_PS_OCA) 3477 i |= UPS_OVERCURRENT_INDICATOR; 3478 if (v & XHCI_PS_PR) 3479 i |= UPS_RESET; 3480 if (v & XHCI_PS_PP) { 3481 /* 3482 * The USB 3.0 RH is using the 3483 * USB 2.0's power bit 3484 */ 3485 i |= UPS_PORT_POWER; 3486 } 3487 USETW(sc->sc_hub_desc.ps.wPortStatus, i); 3488 3489 i = 0; 3490 if (v & XHCI_PS_CSC) 3491 i |= UPS_C_CONNECT_STATUS; 3492 if (v & XHCI_PS_PEC) 3493 i |= UPS_C_PORT_ENABLED; 3494 if (v & XHCI_PS_OCC) 3495 i |= UPS_C_OVERCURRENT_INDICATOR; 3496 if (v & XHCI_PS_WRC) 3497 i |= UPS_C_BH_PORT_RESET; 3498 if (v & XHCI_PS_PRC) 3499 i |= UPS_C_PORT_RESET; 3500 if (v & XHCI_PS_PLC) 3501 i |= UPS_C_PORT_LINK_STATE; 3502 if (v & XHCI_PS_CEC) 3503 i |= UPS_C_PORT_CONFIG_ERROR; 3504 3505 USETW(sc->sc_hub_desc.ps.wPortChange, i); 3506 len = sizeof(sc->sc_hub_desc.ps); 3507 break; 3508 3509 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE): 3510 err = USB_ERR_IOERROR; 3511 goto done; 3512 3513 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE): 3514 break; 3515 3516 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER): 3517 3518 i = index >> 8; 3519 index &= 0x00FF; 3520 3521 if ((index < 1) || 3522 (index > sc->sc_noport)) { 3523 err = USB_ERR_IOERROR; 3524 goto done; 3525 } 3526 3527 port = XHCI_PORTSC(index); 3528 v = XREAD4(sc, oper, port) & ~XHCI_PS_CLEAR; 3529 3530 switch (value) { 3531 case UHF_PORT_U1_TIMEOUT: 3532 if (XHCI_PS_SPEED_GET(v) != 4) { 3533 err = USB_ERR_IOERROR; 3534 goto done; 3535 } 3536 port = XHCI_PORTPMSC(index); 3537 v = XREAD4(sc, oper, port); 3538 v &= ~XHCI_PM3_U1TO_SET(0xFF); 3539 v |= XHCI_PM3_U1TO_SET(i); 3540 XWRITE4(sc, oper, port, v); 3541 break; 3542 case UHF_PORT_U2_TIMEOUT: 3543 if (XHCI_PS_SPEED_GET(v) != 4) { 3544 err = USB_ERR_IOERROR; 3545 goto done; 3546 } 3547 port = XHCI_PORTPMSC(index); 3548 v = XREAD4(sc, oper, port); 3549 v &= ~XHCI_PM3_U2TO_SET(0xFF); 3550 v |= XHCI_PM3_U2TO_SET(i); 3551 XWRITE4(sc, oper, port, v); 3552 break; 3553 case UHF_BH_PORT_RESET: 3554 XWRITE4(sc, oper, port, v | XHCI_PS_WPR); 3555 break; 3556 case UHF_PORT_LINK_STATE: 3557 XWRITE4(sc, oper, port, v | 3558 XHCI_PS_PLS_SET(i) | XHCI_PS_LWS); 3559 /* 4ms settle time */ 3560 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 250); 3561 break; 3562 case UHF_PORT_ENABLE: 3563 DPRINTFN(3, "set port enable %d\n", index); 3564 break; 3565 case UHF_PORT_SUSPEND: 3566 DPRINTFN(6, "suspend port %u (LPM=%u)\n", index, i); 3567 j = XHCI_PS_SPEED_GET(v); 3568 if ((j < 1) || (j > 3)) { 3569 /* non-supported speed */ 3570 err = USB_ERR_IOERROR; 3571 goto done; 3572 } 3573 XWRITE4(sc, oper, port, v | 3574 XHCI_PS_PLS_SET(i ? 2 /* LPM */ : 3) | XHCI_PS_LWS); 3575 break; 3576 case UHF_PORT_RESET: 3577 DPRINTFN(6, "reset port %d\n", index); 3578 XWRITE4(sc, oper, port, v | XHCI_PS_PR); 3579 break; 3580 case UHF_PORT_POWER: 3581 DPRINTFN(3, "set port power %d\n", index); 3582 XWRITE4(sc, oper, port, v | XHCI_PS_PP); 3583 break; 3584 case UHF_PORT_TEST: 3585 DPRINTFN(3, "set port test %d\n", index); 3586 break; 3587 case UHF_PORT_INDICATOR: 3588 DPRINTFN(3, "set port indicator %d\n", index); 3589 3590 v &= ~XHCI_PS_PIC_SET(3); 3591 v |= XHCI_PS_PIC_SET(1); 3592 3593 XWRITE4(sc, oper, port, v); 3594 break; 3595 default: 3596 err = USB_ERR_IOERROR; 3597 goto done; 3598 } 3599 break; 3600 3601 case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER): 3602 case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER): 3603 case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER): 3604 case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER): 3605 break; 3606 default: 3607 err = USB_ERR_IOERROR; 3608 goto done; 3609 } 3610 done: 3611 *plength = len; 3612 *pptr = ptr; 3613 return (err); 3614 } 3615 3616 static void 3617 xhci_xfer_setup(struct usb_setup_params *parm) 3618 { 3619 struct usb_page_search page_info; 3620 struct usb_page_cache *pc; 3621 struct xhci_softc *sc; 3622 struct usb_xfer *xfer; 3623 void *last_obj; 3624 uint32_t ntd; 3625 uint32_t n; 3626 3627 sc = XHCI_BUS2SC(parm->udev->bus); 3628 xfer = parm->curr_xfer; 3629 3630 /* 3631 * The proof for the "ntd" formula is illustrated like this: 3632 * 3633 * +------------------------------------+ 3634 * | | 3635 * | |remainder -> | 3636 * | +-----+---+ | 3637 * | | xxx | x | frm 0 | 3638 * | +-----+---++ | 3639 * | | xxx | xx | frm 1 | 3640 * | +-----+----+ | 3641 * | ... | 3642 * +------------------------------------+ 3643 * 3644 * "xxx" means a completely full USB transfer descriptor 3645 * 3646 * "x" and "xx" means a short USB packet 3647 * 3648 * For the remainder of an USB transfer modulo 3649 * "max_data_length" we need two USB transfer descriptors. 3650 * One to transfer the remaining data and one to finalise with 3651 * a zero length packet in case the "force_short_xfer" flag is 3652 * set. We only need two USB transfer descriptors in the case 3653 * where the transfer length of the first one is a factor of 3654 * "max_frame_size". The rest of the needed USB transfer 3655 * descriptors is given by the buffer size divided by the 3656 * maximum data payload. 3657 */ 3658 parm->hc_max_packet_size = 0x400; 3659 parm->hc_max_packet_count = 16 * 3; 3660 parm->hc_max_frame_size = XHCI_TD_PAYLOAD_MAX; 3661 3662 xfer->flags_int.bdma_enable = 1; 3663 3664 usbd_transfer_setup_sub(parm); 3665 3666 if (xfer->flags_int.isochronous_xfr) { 3667 ntd = ((1 * xfer->nframes) 3668 + (xfer->max_data_length / xfer->max_hc_frame_size)); 3669 } else if (xfer->flags_int.control_xfr) { 3670 ntd = ((2 * xfer->nframes) + 1 /* STATUS */ 3671 + (xfer->max_data_length / xfer->max_hc_frame_size)); 3672 } else { 3673 ntd = ((2 * xfer->nframes) 3674 + (xfer->max_data_length / xfer->max_hc_frame_size)); 3675 } 3676 3677 alloc_dma_set: 3678 3679 if (parm->err) 3680 return; 3681 3682 /* 3683 * Allocate queue heads and transfer descriptors 3684 */ 3685 last_obj = NULL; 3686 3687 if (usbd_transfer_setup_sub_malloc( 3688 parm, &pc, sizeof(struct xhci_td), 3689 XHCI_TD_ALIGN, ntd)) { 3690 parm->err = USB_ERR_NOMEM; 3691 return; 3692 } 3693 if (parm->buf) { 3694 for (n = 0; n != ntd; n++) { 3695 struct xhci_td *td; 3696 3697 usbd_get_page(pc + n, 0, &page_info); 3698 3699 td = page_info.buffer; 3700 3701 /* init TD */ 3702 td->td_self = page_info.physaddr; 3703 td->obj_next = last_obj; 3704 td->page_cache = pc + n; 3705 3706 last_obj = td; 3707 3708 usb_pc_cpu_flush(pc + n); 3709 } 3710 } 3711 xfer->td_start[xfer->flags_int.curr_dma_set] = last_obj; 3712 3713 if (!xfer->flags_int.curr_dma_set) { 3714 xfer->flags_int.curr_dma_set = 1; 3715 goto alloc_dma_set; 3716 } 3717 } 3718 3719 static usb_error_t 3720 xhci_configure_reset_endpoint(struct usb_xfer *xfer) 3721 { 3722 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus); 3723 struct usb_page_search buf_inp; 3724 struct usb_device *udev; 3725 struct xhci_endpoint_ext *pepext; 3726 struct usb_endpoint_descriptor *edesc; 3727 struct usb_page_cache *pcinp; 3728 usb_error_t err; 3729 usb_stream_t stream_id; 3730 uint8_t index; 3731 uint8_t epno; 3732 3733 pepext = xhci_get_endpoint_ext(xfer->xroot->udev, 3734 xfer->endpoint->edesc); 3735 3736 udev = xfer->xroot->udev; 3737 index = udev->controller_slot_id; 3738 3739 pcinp = &sc->sc_hw.devs[index].input_pc; 3740 3741 usbd_get_page(pcinp, 0, &buf_inp); 3742 3743 edesc = xfer->endpoint->edesc; 3744 3745 epno = edesc->bEndpointAddress; 3746 stream_id = xfer->stream_id; 3747 3748 if ((edesc->bmAttributes & UE_XFERTYPE) == UE_CONTROL) 3749 epno |= UE_DIR_IN; 3750 3751 epno = XHCI_EPNO2EPID(epno); 3752 3753 if (epno == 0) 3754 return (USB_ERR_NO_PIPE); /* invalid */ 3755 3756 XHCI_CMD_LOCK(sc); 3757 3758 /* configure endpoint */ 3759 3760 err = xhci_configure_endpoint_by_xfer(xfer); 3761 3762 if (err != 0) { 3763 XHCI_CMD_UNLOCK(sc); 3764 return (err); 3765 } 3766 3767 /* 3768 * Get the endpoint into the stopped state according to the 3769 * endpoint context state diagram in the XHCI specification: 3770 */ 3771 3772 err = xhci_cmd_stop_ep(sc, 0, epno, index); 3773 3774 if (err != 0) 3775 DPRINTF("Could not stop endpoint %u\n", epno); 3776 3777 err = xhci_cmd_reset_ep(sc, 0, epno, index); 3778 3779 if (err != 0) 3780 DPRINTF("Could not reset endpoint %u\n", epno); 3781 3782 err = xhci_cmd_set_tr_dequeue_ptr(sc, 3783 (pepext->physaddr + (stream_id * sizeof(struct xhci_trb) * 3784 XHCI_MAX_TRANSFERS)) | XHCI_EPCTX_2_DCS_SET(1), 3785 stream_id, epno, index); 3786 3787 if (err != 0) 3788 DPRINTF("Could not set dequeue ptr for endpoint %u\n", epno); 3789 3790 /* 3791 * Get the endpoint into the running state according to the 3792 * endpoint context state diagram in the XHCI specification: 3793 */ 3794 3795 xhci_configure_mask(udev, (1U << epno) | 1U, 0); 3796 3797 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index); 3798 3799 if (err != 0) 3800 DPRINTF("Could not configure endpoint %u\n", epno); 3801 3802 err = xhci_cmd_configure_ep(sc, buf_inp.physaddr, 0, index); 3803 3804 if (err != 0) 3805 DPRINTF("Could not configure endpoint %u\n", epno); 3806 3807 XHCI_CMD_UNLOCK(sc); 3808 3809 return (0); 3810 } 3811 3812 static void 3813 xhci_xfer_unsetup(struct usb_xfer *xfer) 3814 { 3815 return; 3816 } 3817 3818 static void 3819 xhci_start_dma_delay(struct usb_xfer *xfer) 3820 { 3821 struct xhci_softc *sc = XHCI_BUS2SC(xfer->xroot->bus); 3822 3823 /* put transfer on interrupt queue (again) */ 3824 usbd_transfer_enqueue(&sc->sc_bus.intr_q, xfer); 3825 3826 (void)usb_proc_msignal(USB_BUS_CONTROL_XFER_PROC(&sc->sc_bus), 3827 &sc->sc_config_msg[0], &sc->sc_config_msg[1]); 3828 } 3829 3830 static void 3831 xhci_configure_msg(struct usb_proc_msg *pm) 3832 { 3833 struct xhci_softc *sc; 3834 struct xhci_endpoint_ext *pepext; 3835 struct usb_xfer *xfer; 3836 3837 sc = XHCI_BUS2SC(((struct usb_bus_msg *)pm)->bus); 3838 3839 restart: 3840 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) { 3841 3842 pepext = xhci_get_endpoint_ext(xfer->xroot->udev, 3843 xfer->endpoint->edesc); 3844 3845 if ((pepext->trb_halted != 0) || 3846 (pepext->trb_running == 0)) { 3847 3848 uint16_t i; 3849 3850 /* clear halted and running */ 3851 pepext->trb_halted = 0; 3852 pepext->trb_running = 0; 3853 3854 /* nuke remaining buffered transfers */ 3855 3856 for (i = 0; i != (XHCI_MAX_TRANSFERS * 3857 XHCI_MAX_STREAMS); i++) { 3858 /* 3859 * NOTE: We need to use the timeout 3860 * error code here else existing 3861 * isochronous clients can get 3862 * confused: 3863 */ 3864 if (pepext->xfer[i] != NULL) { 3865 xhci_device_done(pepext->xfer[i], 3866 USB_ERR_TIMEOUT); 3867 } 3868 } 3869 3870 /* 3871 * NOTE: The USB transfer cannot vanish in 3872 * this state! 3873 */ 3874 3875 USB_BUS_UNLOCK(&sc->sc_bus); 3876 3877 xhci_configure_reset_endpoint(xfer); 3878 3879 USB_BUS_LOCK(&sc->sc_bus); 3880 3881 /* check if halted is still cleared */ 3882 if (pepext->trb_halted == 0) { 3883 pepext->trb_running = 1; 3884 memset(pepext->trb_index, 0, 3885 sizeof(pepext->trb_index)); 3886 } 3887 goto restart; 3888 } 3889 3890 if (xfer->flags_int.did_dma_delay) { 3891 3892 /* remove transfer from interrupt queue (again) */ 3893 usbd_transfer_dequeue(xfer); 3894 3895 /* we are finally done */ 3896 usb_dma_delay_done_cb(xfer); 3897 3898 /* queue changed - restart */ 3899 goto restart; 3900 } 3901 } 3902 3903 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) { 3904 3905 /* try to insert xfer on HW queue */ 3906 xhci_transfer_insert(xfer); 3907 3908 /* try to multi buffer */ 3909 xhci_device_generic_multi_enter(xfer->endpoint, 3910 xfer->stream_id, NULL); 3911 } 3912 } 3913 3914 static void 3915 xhci_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc, 3916 struct usb_endpoint *ep) 3917 { 3918 struct xhci_endpoint_ext *pepext; 3919 3920 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d\n", 3921 ep, udev->address, edesc->bEndpointAddress, udev->flags.usb_mode); 3922 3923 if (udev->parent_hub == NULL) { 3924 /* root HUB has special endpoint handling */ 3925 return; 3926 } 3927 3928 ep->methods = &xhci_device_generic_methods; 3929 3930 pepext = xhci_get_endpoint_ext(udev, edesc); 3931 3932 USB_BUS_LOCK(udev->bus); 3933 pepext->trb_halted = 1; 3934 pepext->trb_running = 0; 3935 USB_BUS_UNLOCK(udev->bus); 3936 } 3937 3938 static void 3939 xhci_ep_uninit(struct usb_device *udev, struct usb_endpoint *ep) 3940 { 3941 3942 } 3943 3944 static void 3945 xhci_ep_clear_stall(struct usb_device *udev, struct usb_endpoint *ep) 3946 { 3947 struct xhci_endpoint_ext *pepext; 3948 3949 DPRINTF("\n"); 3950 3951 if (udev->flags.usb_mode != USB_MODE_HOST) { 3952 /* not supported */ 3953 return; 3954 } 3955 if (udev->parent_hub == NULL) { 3956 /* root HUB has special endpoint handling */ 3957 return; 3958 } 3959 3960 pepext = xhci_get_endpoint_ext(udev, ep->edesc); 3961 3962 USB_BUS_LOCK(udev->bus); 3963 pepext->trb_halted = 1; 3964 pepext->trb_running = 0; 3965 USB_BUS_UNLOCK(udev->bus); 3966 } 3967 3968 static usb_error_t 3969 xhci_device_init(struct usb_device *udev) 3970 { 3971 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 3972 usb_error_t err; 3973 uint8_t temp; 3974 3975 /* no init for root HUB */ 3976 if (udev->parent_hub == NULL) 3977 return (0); 3978 3979 XHCI_CMD_LOCK(sc); 3980 3981 /* set invalid default */ 3982 3983 udev->controller_slot_id = sc->sc_noslot + 1; 3984 3985 /* try to get a new slot ID from the XHCI */ 3986 3987 err = xhci_cmd_enable_slot(sc, &temp); 3988 3989 if (err) { 3990 XHCI_CMD_UNLOCK(sc); 3991 return (err); 3992 } 3993 3994 if (temp > sc->sc_noslot) { 3995 XHCI_CMD_UNLOCK(sc); 3996 return (USB_ERR_BAD_ADDRESS); 3997 } 3998 3999 if (sc->sc_hw.devs[temp].state != XHCI_ST_DISABLED) { 4000 DPRINTF("slot %u already allocated.\n", temp); 4001 XHCI_CMD_UNLOCK(sc); 4002 return (USB_ERR_BAD_ADDRESS); 4003 } 4004 4005 /* store slot ID for later reference */ 4006 4007 udev->controller_slot_id = temp; 4008 4009 /* reset data structure */ 4010 4011 memset(&sc->sc_hw.devs[temp], 0, sizeof(sc->sc_hw.devs[0])); 4012 4013 /* set mark slot allocated */ 4014 4015 sc->sc_hw.devs[temp].state = XHCI_ST_ENABLED; 4016 4017 err = xhci_alloc_device_ext(udev); 4018 4019 XHCI_CMD_UNLOCK(sc); 4020 4021 /* get device into default state */ 4022 4023 if (err == 0) 4024 err = xhci_set_address(udev, NULL, 0); 4025 4026 return (err); 4027 } 4028 4029 static void 4030 xhci_device_uninit(struct usb_device *udev) 4031 { 4032 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 4033 uint8_t index; 4034 4035 /* no init for root HUB */ 4036 if (udev->parent_hub == NULL) 4037 return; 4038 4039 XHCI_CMD_LOCK(sc); 4040 4041 index = udev->controller_slot_id; 4042 4043 if (index <= sc->sc_noslot) { 4044 xhci_cmd_disable_slot(sc, index); 4045 sc->sc_hw.devs[index].state = XHCI_ST_DISABLED; 4046 4047 /* free device extension */ 4048 xhci_free_device_ext(udev); 4049 } 4050 4051 XHCI_CMD_UNLOCK(sc); 4052 } 4053 4054 static void 4055 xhci_get_dma_delay(struct usb_device *udev, uint32_t *pus) 4056 { 4057 /* 4058 * Wait until the hardware has finished any possible use of 4059 * the transfer descriptor(s) 4060 */ 4061 *pus = 2048; /* microseconds */ 4062 } 4063 4064 static void 4065 xhci_device_resume(struct usb_device *udev) 4066 { 4067 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 4068 uint8_t index; 4069 uint8_t n; 4070 uint8_t p; 4071 4072 DPRINTF("\n"); 4073 4074 /* check for root HUB */ 4075 if (udev->parent_hub == NULL) 4076 return; 4077 4078 index = udev->controller_slot_id; 4079 4080 XHCI_CMD_LOCK(sc); 4081 4082 /* blindly resume all endpoints */ 4083 4084 USB_BUS_LOCK(udev->bus); 4085 4086 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) { 4087 for (p = 0; p != XHCI_MAX_STREAMS; p++) { 4088 XWRITE4(sc, door, XHCI_DOORBELL(index), 4089 n | XHCI_DB_SID_SET(p)); 4090 } 4091 } 4092 4093 USB_BUS_UNLOCK(udev->bus); 4094 4095 XHCI_CMD_UNLOCK(sc); 4096 } 4097 4098 static void 4099 xhci_device_suspend(struct usb_device *udev) 4100 { 4101 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 4102 uint8_t index; 4103 uint8_t n; 4104 usb_error_t err; 4105 4106 DPRINTF("\n"); 4107 4108 /* check for root HUB */ 4109 if (udev->parent_hub == NULL) 4110 return; 4111 4112 index = udev->controller_slot_id; 4113 4114 XHCI_CMD_LOCK(sc); 4115 4116 /* blindly suspend all endpoints */ 4117 4118 for (n = 1; n != XHCI_MAX_ENDPOINTS; n++) { 4119 err = xhci_cmd_stop_ep(sc, 1, n, index); 4120 if (err != 0) { 4121 DPRINTF("Failed to suspend endpoint " 4122 "%u on slot %u (ignored).\n", n, index); 4123 } 4124 } 4125 4126 XHCI_CMD_UNLOCK(sc); 4127 } 4128 4129 static void 4130 xhci_set_hw_power(struct usb_bus *bus) 4131 { 4132 DPRINTF("\n"); 4133 } 4134 4135 static void 4136 xhci_device_state_change(struct usb_device *udev) 4137 { 4138 struct xhci_softc *sc = XHCI_BUS2SC(udev->bus); 4139 struct usb_page_search buf_inp; 4140 usb_error_t err; 4141 uint8_t index; 4142 4143 /* check for root HUB */ 4144 if (udev->parent_hub == NULL) 4145 return; 4146 4147 index = udev->controller_slot_id; 4148 4149 DPRINTF("\n"); 4150 4151 if (usb_get_device_state(udev) == USB_STATE_CONFIGURED) { 4152 err = uhub_query_info(udev, &sc->sc_hw.devs[index].nports, 4153 &sc->sc_hw.devs[index].tt); 4154 if (err != 0) 4155 sc->sc_hw.devs[index].nports = 0; 4156 } 4157 4158 XHCI_CMD_LOCK(sc); 4159 4160 switch (usb_get_device_state(udev)) { 4161 case USB_STATE_POWERED: 4162 if (sc->sc_hw.devs[index].state == XHCI_ST_DEFAULT) 4163 break; 4164 4165 /* set default state */ 4166 sc->sc_hw.devs[index].state = XHCI_ST_DEFAULT; 4167 4168 /* reset number of contexts */ 4169 sc->sc_hw.devs[index].context_num = 0; 4170 4171 err = xhci_cmd_reset_dev(sc, index); 4172 4173 if (err != 0) { 4174 DPRINTF("Device reset failed " 4175 "for slot %u.\n", index); 4176 } 4177 break; 4178 4179 case USB_STATE_ADDRESSED: 4180 if (sc->sc_hw.devs[index].state == XHCI_ST_ADDRESSED) 4181 break; 4182 4183 sc->sc_hw.devs[index].state = XHCI_ST_ADDRESSED; 4184 4185 err = xhci_cmd_configure_ep(sc, 0, 1, index); 4186 4187 if (err) { 4188 DPRINTF("Failed to deconfigure " 4189 "slot %u.\n", index); 4190 } 4191 break; 4192 4193 case USB_STATE_CONFIGURED: 4194 if (sc->sc_hw.devs[index].state == XHCI_ST_CONFIGURED) 4195 break; 4196 4197 /* set configured state */ 4198 sc->sc_hw.devs[index].state = XHCI_ST_CONFIGURED; 4199 4200 /* reset number of contexts */ 4201 sc->sc_hw.devs[index].context_num = 0; 4202 4203 usbd_get_page(&sc->sc_hw.devs[index].input_pc, 0, &buf_inp); 4204 4205 xhci_configure_mask(udev, 3, 0); 4206 4207 err = xhci_configure_device(udev); 4208 if (err != 0) { 4209 DPRINTF("Could not configure device " 4210 "at slot %u.\n", index); 4211 } 4212 4213 err = xhci_cmd_evaluate_ctx(sc, buf_inp.physaddr, index); 4214 if (err != 0) { 4215 DPRINTF("Could not evaluate device " 4216 "context at slot %u.\n", index); 4217 } 4218 break; 4219 4220 default: 4221 break; 4222 } 4223 XHCI_CMD_UNLOCK(sc); 4224 } 4225 4226 static usb_error_t 4227 xhci_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep, 4228 uint8_t ep_mode) 4229 { 4230 switch (ep_mode) { 4231 case USB_EP_MODE_DEFAULT: 4232 return (0); 4233 case USB_EP_MODE_STREAMS: 4234 if (xhcistreams == 0 || 4235 (ep->edesc->bmAttributes & UE_XFERTYPE) != UE_BULK || 4236 udev->speed != USB_SPEED_SUPER) 4237 return (USB_ERR_INVAL); 4238 return (0); 4239 default: 4240 return (USB_ERR_INVAL); 4241 } 4242 } 4243 4244 static const struct usb_bus_methods xhci_bus_methods = { 4245 .endpoint_init = xhci_ep_init, 4246 .endpoint_uninit = xhci_ep_uninit, 4247 .xfer_setup = xhci_xfer_setup, 4248 .xfer_unsetup = xhci_xfer_unsetup, 4249 .get_dma_delay = xhci_get_dma_delay, 4250 .device_init = xhci_device_init, 4251 .device_uninit = xhci_device_uninit, 4252 .device_resume = xhci_device_resume, 4253 .device_suspend = xhci_device_suspend, 4254 .set_hw_power = xhci_set_hw_power, 4255 .roothub_exec = xhci_roothub_exec, 4256 .xfer_poll = xhci_do_poll, 4257 .start_dma_delay = xhci_start_dma_delay, 4258 .set_address = xhci_set_address, 4259 .clear_stall = xhci_ep_clear_stall, 4260 .device_state_change = xhci_device_state_change, 4261 .set_hw_power_sleep = xhci_set_hw_power_sleep, 4262 .set_endpoint_mode = xhci_set_endpoint_mode, 4263 }; 4264