3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 * Copyright (c) 2004 The NetBSD Foundation, Inc. All rights reserved.
5 * Copyright (c) 2004 Lennart Augustsson. All rights reserved.
6 * Copyright (c) 2004 Charles M. Hannum. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
33 * The EHCI 0.96 spec can be found at
34 * http://developer.intel.com/technology/usb/download/ehci-r096.pdf
35 * The EHCI 1.0 spec can be found at
36 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
37 * and the USB 2.0 spec at
38 * http://www.usb.org/developers/docs/usb_20.zip
44 * 1) command failures are not recovered correctly
47 #ifdef USB_GLOBAL_INCLUDE_FILE
48 #include USB_GLOBAL_INCLUDE_FILE
50 #include <sys/stdint.h>
51 #include <sys/stddef.h>
52 #include <sys/param.h>
53 #include <sys/queue.h>
54 #include <sys/types.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
58 #include <sys/module.h>
60 #include <sys/mutex.h>
61 #include <sys/condvar.h>
62 #include <sys/sysctl.h>
64 #include <sys/unistd.h>
65 #include <sys/callout.h>
66 #include <sys/malloc.h>
69 #include <dev/usb/usb.h>
70 #include <dev/usb/usbdi.h>
72 #define USB_DEBUG_VAR ehcidebug
74 #include <dev/usb/usb_core.h>
75 #include <dev/usb/usb_debug.h>
76 #include <dev/usb/usb_busdma.h>
77 #include <dev/usb/usb_process.h>
78 #include <dev/usb/usb_transfer.h>
79 #include <dev/usb/usb_device.h>
80 #include <dev/usb/usb_hub.h>
81 #include <dev/usb/usb_util.h>
83 #include <dev/usb/usb_controller.h>
84 #include <dev/usb/usb_bus.h>
85 #endif /* USB_GLOBAL_INCLUDE_FILE */
87 #include <dev/usb/controller/ehci.h>
88 #include <dev/usb/controller/ehcireg.h>
90 #define EHCI_BUS2SC(bus) \
91 ((ehci_softc_t *)(((uint8_t *)(bus)) - \
92 ((uint8_t *)&(((ehci_softc_t *)0)->sc_bus))))
95 static int ehcidebug = 0;
96 static int ehcinohighspeed = 0;
97 static int ehciiaadbug = 0;
98 static int ehcilostintrbug = 0;
100 static SYSCTL_NODE(_hw_usb, OID_AUTO, ehci, CTLFLAG_RW, 0, "USB ehci");
101 SYSCTL_INT(_hw_usb_ehci, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN,
102 &ehcidebug, 0, "Debug level");
103 TUNABLE_INT("hw.usb.ehci.debug", &ehcidebug);
104 SYSCTL_INT(_hw_usb_ehci, OID_AUTO, no_hs, CTLFLAG_RW | CTLFLAG_TUN,
105 &ehcinohighspeed, 0, "Disable High Speed USB");
106 TUNABLE_INT("hw.usb.ehci.no_hs", &ehcinohighspeed);
107 SYSCTL_INT(_hw_usb_ehci, OID_AUTO, iaadbug, CTLFLAG_RW | CTLFLAG_TUN,
108 &ehciiaadbug, 0, "Enable doorbell bug workaround");
109 TUNABLE_INT("hw.usb.ehci.iaadbug", &ehciiaadbug);
110 SYSCTL_INT(_hw_usb_ehci, OID_AUTO, lostintrbug, CTLFLAG_RW | CTLFLAG_TUN,
111 &ehcilostintrbug, 0, "Enable lost interrupt bug workaround");
112 TUNABLE_INT("hw.usb.ehci.lostintrbug", &ehcilostintrbug);
115 static void ehci_dump_regs(ehci_softc_t *sc);
116 static void ehci_dump_sqh(ehci_softc_t *sc, ehci_qh_t *sqh);
120 #define EHCI_INTR_ENDPT 1
122 extern struct usb_bus_methods ehci_bus_methods;
123 extern struct usb_pipe_methods ehci_device_bulk_methods;
124 extern struct usb_pipe_methods ehci_device_ctrl_methods;
125 extern struct usb_pipe_methods ehci_device_intr_methods;
126 extern struct usb_pipe_methods ehci_device_isoc_fs_methods;
127 extern struct usb_pipe_methods ehci_device_isoc_hs_methods;
129 static void ehci_do_poll(struct usb_bus *);
130 static void ehci_device_done(struct usb_xfer *, usb_error_t);
131 static uint8_t ehci_check_transfer(struct usb_xfer *);
132 static void ehci_timeout(void *);
133 static void ehci_poll_timeout(void *);
135 static void ehci_root_intr(ehci_softc_t *sc);
137 struct ehci_std_temp {
139 struct usb_page_cache *pc;
145 uint16_t max_frame_size;
147 uint8_t auto_data_toggle;
148 uint8_t setup_alt_next;
153 ehci_iterate_hw_softc(struct usb_bus *bus, usb_bus_mem_sub_cb_t *cb)
155 ehci_softc_t *sc = EHCI_BUS2SC(bus);
158 cb(bus, &sc->sc_hw.pframes_pc, &sc->sc_hw.pframes_pg,
159 sizeof(uint32_t) * EHCI_FRAMELIST_COUNT, EHCI_FRAMELIST_ALIGN);
161 cb(bus, &sc->sc_hw.terminate_pc, &sc->sc_hw.terminate_pg,
162 sizeof(struct ehci_qh_sub), EHCI_QH_ALIGN);
164 cb(bus, &sc->sc_hw.async_start_pc, &sc->sc_hw.async_start_pg,
165 sizeof(ehci_qh_t), EHCI_QH_ALIGN);
167 for (i = 0; i != EHCI_VIRTUAL_FRAMELIST_COUNT; i++) {
168 cb(bus, sc->sc_hw.intr_start_pc + i,
169 sc->sc_hw.intr_start_pg + i,
170 sizeof(ehci_qh_t), EHCI_QH_ALIGN);
173 for (i = 0; i != EHCI_VIRTUAL_FRAMELIST_COUNT; i++) {
174 cb(bus, sc->sc_hw.isoc_hs_start_pc + i,
175 sc->sc_hw.isoc_hs_start_pg + i,
176 sizeof(ehci_itd_t), EHCI_ITD_ALIGN);
179 for (i = 0; i != EHCI_VIRTUAL_FRAMELIST_COUNT; i++) {
180 cb(bus, sc->sc_hw.isoc_fs_start_pc + i,
181 sc->sc_hw.isoc_fs_start_pg + i,
182 sizeof(ehci_sitd_t), EHCI_SITD_ALIGN);
187 ehci_reset(ehci_softc_t *sc)
192 EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
193 for (i = 0; i < 100; i++) {
194 usb_pause_mtx(NULL, hz / 128);
195 hcr = EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_HCRESET;
197 if (sc->sc_flags & (EHCI_SCFLG_SETMODE | EHCI_SCFLG_BIGEMMIO)) {
199 * Force USBMODE as requested. Controllers
200 * may have multiple operating modes.
202 uint32_t usbmode = EOREAD4(sc, EHCI_USBMODE);
203 if (sc->sc_flags & EHCI_SCFLG_SETMODE) {
204 usbmode = (usbmode &~ EHCI_UM_CM) | EHCI_UM_CM_HOST;
205 device_printf(sc->sc_bus.bdev,
206 "set host controller mode\n");
208 if (sc->sc_flags & EHCI_SCFLG_BIGEMMIO) {
209 usbmode = (usbmode &~ EHCI_UM_ES) | EHCI_UM_ES_BE;
210 device_printf(sc->sc_bus.bdev,
211 "set big-endian mode\n");
213 EOWRITE4(sc, EHCI_USBMODE, usbmode);
218 device_printf(sc->sc_bus.bdev, "Reset timeout\n");
219 return (USB_ERR_IOERROR);
223 ehci_hcreset(ehci_softc_t *sc)
228 EOWRITE4(sc, EHCI_USBCMD, 0); /* Halt controller */
229 for (i = 0; i < 100; i++) {
230 usb_pause_mtx(NULL, hz / 128);
231 hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
237 * Fall through and try reset anyway even though
238 * Table 2-9 in the EHCI spec says this will result
239 * in undefined behavior.
241 device_printf(sc->sc_bus.bdev, "stop timeout\n");
243 return (ehci_reset(sc));
247 ehci_init_sub(struct ehci_softc *sc)
249 struct usb_page_search buf_res;
254 cparams = EREAD4(sc, EHCI_HCCPARAMS);
256 DPRINTF("cparams=0x%x\n", cparams);
258 if (EHCI_HCC_64BIT(cparams)) {
259 DPRINTF("HCC uses 64-bit structures\n");
261 /* MUST clear segment register if 64 bit capable */
262 EOWRITE4(sc, EHCI_CTRLDSSEGMENT, 0);
265 usbd_get_page(&sc->sc_hw.pframes_pc, 0, &buf_res);
266 EOWRITE4(sc, EHCI_PERIODICLISTBASE, buf_res.physaddr);
268 usbd_get_page(&sc->sc_hw.async_start_pc, 0, &buf_res);
269 EOWRITE4(sc, EHCI_ASYNCLISTADDR, buf_res.physaddr | EHCI_LINK_QH);
271 /* enable interrupts */
272 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
274 /* turn on controller */
275 EOWRITE4(sc, EHCI_USBCMD,
276 EHCI_CMD_ITC_1 | /* 1 microframes interrupt delay */
277 (EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_FLS_M) |
282 /* Take over port ownership */
283 EOWRITE4(sc, EHCI_CONFIGFLAG, EHCI_CONF_CF);
285 for (i = 0; i < 100; i++) {
286 usb_pause_mtx(NULL, hz / 128);
287 hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
293 device_printf(sc->sc_bus.bdev, "Run timeout\n");
294 return (USB_ERR_IOERROR);
296 return (USB_ERR_NORMAL_COMPLETION);
300 ehci_init(ehci_softc_t *sc)
302 struct usb_page_search buf_res;
313 usb_callout_init_mtx(&sc->sc_tmo_pcd, &sc->sc_bus.bus_mtx, 0);
314 usb_callout_init_mtx(&sc->sc_tmo_poll, &sc->sc_bus.bus_mtx, 0);
316 sc->sc_offs = EHCI_CAPLENGTH(EREAD4(sc, EHCI_CAPLEN_HCIVERSION));
320 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
322 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
328 version = EHCI_HCIVERSION(EREAD4(sc, EHCI_CAPLEN_HCIVERSION));
329 device_printf(sc->sc_bus.bdev, "EHCI version %x.%x\n",
330 version >> 8, version & 0xff);
332 sparams = EREAD4(sc, EHCI_HCSPARAMS);
333 DPRINTF("sparams=0x%x\n", sparams);
335 sc->sc_noport = EHCI_HCS_N_PORTS(sparams);
336 sc->sc_bus.usbrev = USB_REV_2_0;
338 if (!(sc->sc_flags & EHCI_SCFLG_DONTRESET)) {
339 /* Reset the controller */
340 DPRINTF("%s: resetting\n",
341 device_get_nameunit(sc->sc_bus.bdev));
343 err = ehci_hcreset(sc);
345 device_printf(sc->sc_bus.bdev, "reset timeout\n");
351 * use current frame-list-size selection 0: 1024*4 bytes 1: 512*4
352 * bytes 2: 256*4 bytes 3: unknown
354 if (EHCI_CMD_FLS(EOREAD4(sc, EHCI_USBCMD)) == 3) {
355 device_printf(sc->sc_bus.bdev, "invalid frame-list-size\n");
356 return (USB_ERR_IOERROR);
358 /* set up the bus struct */
359 sc->sc_bus.methods = &ehci_bus_methods;
361 sc->sc_eintrs = EHCI_NORMAL_INTRS;
364 struct ehci_qh_sub *qh;
366 usbd_get_page(&sc->sc_hw.terminate_pc, 0, &buf_res);
370 sc->sc_terminate_self = htohc32(sc, buf_res.physaddr);
372 /* init terminate TD */
374 htohc32(sc, EHCI_LINK_TERMINATE);
376 htohc32(sc, EHCI_LINK_TERMINATE);
378 htohc32(sc, EHCI_QTD_HALTED);
381 for (i = 0; i < EHCI_VIRTUAL_FRAMELIST_COUNT; i++) {
384 usbd_get_page(sc->sc_hw.intr_start_pc + i, 0, &buf_res);
388 /* initialize page cache pointer */
390 qh->page_cache = sc->sc_hw.intr_start_pc + i;
392 /* store a pointer to queue head */
394 sc->sc_intr_p_last[i] = qh;
397 htohc32(sc, buf_res.physaddr) |
398 htohc32(sc, EHCI_LINK_QH);
401 htohc32(sc, EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH));
403 htohc32(sc, EHCI_QH_SET_MULT(1));
406 qh->qh_qtd.qtd_next =
407 htohc32(sc, EHCI_LINK_TERMINATE);
408 qh->qh_qtd.qtd_altnext =
409 htohc32(sc, EHCI_LINK_TERMINATE);
410 qh->qh_qtd.qtd_status =
411 htohc32(sc, EHCI_QTD_HALTED);
415 * the QHs are arranged to give poll intervals that are
416 * powers of 2 times 1ms
418 bit = EHCI_VIRTUAL_FRAMELIST_COUNT / 2;
425 y = (x ^ bit) | (bit / 2);
427 qh_x = sc->sc_intr_p_last[x];
428 qh_y = sc->sc_intr_p_last[y];
431 * the next QH has half the poll interval
433 qh_x->qh_link = qh_y->qh_self;
443 qh = sc->sc_intr_p_last[0];
445 /* the last (1ms) QH terminates */
446 qh->qh_link = htohc32(sc, EHCI_LINK_TERMINATE);
448 for (i = 0; i < EHCI_VIRTUAL_FRAMELIST_COUNT; i++) {
452 usbd_get_page(sc->sc_hw.isoc_fs_start_pc + i, 0, &buf_res);
454 sitd = buf_res.buffer;
456 /* initialize page cache pointer */
458 sitd->page_cache = sc->sc_hw.isoc_fs_start_pc + i;
460 /* store a pointer to the transfer descriptor */
462 sc->sc_isoc_fs_p_last[i] = sitd;
464 /* initialize full speed isochronous */
467 htohc32(sc, buf_res.physaddr) |
468 htohc32(sc, EHCI_LINK_SITD);
471 htohc32(sc, EHCI_LINK_TERMINATE);
474 sc->sc_intr_p_last[i | (EHCI_VIRTUAL_FRAMELIST_COUNT / 2)]->qh_self;
477 usbd_get_page(sc->sc_hw.isoc_hs_start_pc + i, 0, &buf_res);
479 itd = buf_res.buffer;
481 /* initialize page cache pointer */
483 itd->page_cache = sc->sc_hw.isoc_hs_start_pc + i;
485 /* store a pointer to the transfer descriptor */
487 sc->sc_isoc_hs_p_last[i] = itd;
489 /* initialize high speed isochronous */
492 htohc32(sc, buf_res.physaddr) |
493 htohc32(sc, EHCI_LINK_ITD);
499 usbd_get_page(&sc->sc_hw.pframes_pc, 0, &buf_res);
504 pframes = buf_res.buffer;
508 * pframes -> high speed isochronous ->
509 * full speed isochronous -> interrupt QH's
511 for (i = 0; i < EHCI_FRAMELIST_COUNT; i++) {
512 pframes[i] = sc->sc_isoc_hs_p_last
513 [i & (EHCI_VIRTUAL_FRAMELIST_COUNT - 1)]->itd_self;
516 usbd_get_page(&sc->sc_hw.async_start_pc, 0, &buf_res);
524 /* initialize page cache pointer */
526 qh->page_cache = &sc->sc_hw.async_start_pc;
528 /* store a pointer to the queue head */
530 sc->sc_async_p_last = qh;
532 /* init dummy QH that starts the async list */
535 htohc32(sc, buf_res.physaddr) |
536 htohc32(sc, EHCI_LINK_QH);
540 htohc32(sc, EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH) | EHCI_QH_HRECL);
541 qh->qh_endphub = htohc32(sc, EHCI_QH_SET_MULT(1));
542 qh->qh_link = qh->qh_self;
545 /* fill the overlay qTD */
546 qh->qh_qtd.qtd_next = htohc32(sc, EHCI_LINK_TERMINATE);
547 qh->qh_qtd.qtd_altnext = htohc32(sc, EHCI_LINK_TERMINATE);
548 qh->qh_qtd.qtd_status = htohc32(sc, EHCI_QTD_HALTED);
550 /* flush all cache into memory */
552 usb_bus_mem_flush_all(&sc->sc_bus, &ehci_iterate_hw_softc);
556 ehci_dump_sqh(sc, sc->sc_async_p_last);
561 err = ehci_init_sub(sc);
564 /* catch any lost interrupts */
565 ehci_do_poll(&sc->sc_bus);
571 * shut down the controller when the system is going down
574 ehci_detach(ehci_softc_t *sc)
576 USB_BUS_LOCK(&sc->sc_bus);
578 usb_callout_stop(&sc->sc_tmo_pcd);
579 usb_callout_stop(&sc->sc_tmo_poll);
581 EOWRITE4(sc, EHCI_USBINTR, 0);
582 USB_BUS_UNLOCK(&sc->sc_bus);
584 if (ehci_hcreset(sc)) {
585 DPRINTF("reset failed!\n");
588 /* XXX let stray task complete */
589 usb_pause_mtx(NULL, hz / 20);
591 usb_callout_drain(&sc->sc_tmo_pcd);
592 usb_callout_drain(&sc->sc_tmo_poll);
596 ehci_suspend(ehci_softc_t *sc)
598 DPRINTF("stopping the HC\n");
605 ehci_resume(ehci_softc_t *sc)
613 /* catch any lost interrupts */
614 ehci_do_poll(&sc->sc_bus);
619 ehci_dump_regs(ehci_softc_t *sc)
623 i = EOREAD4(sc, EHCI_USBCMD);
624 printf("cmd=0x%08x\n", i);
626 if (i & EHCI_CMD_ITC_1)
627 printf(" EHCI_CMD_ITC_1\n");
628 if (i & EHCI_CMD_ITC_2)
629 printf(" EHCI_CMD_ITC_2\n");
630 if (i & EHCI_CMD_ITC_4)
631 printf(" EHCI_CMD_ITC_4\n");
632 if (i & EHCI_CMD_ITC_8)
633 printf(" EHCI_CMD_ITC_8\n");
634 if (i & EHCI_CMD_ITC_16)
635 printf(" EHCI_CMD_ITC_16\n");
636 if (i & EHCI_CMD_ITC_32)
637 printf(" EHCI_CMD_ITC_32\n");
638 if (i & EHCI_CMD_ITC_64)
639 printf(" EHCI_CMD_ITC_64\n");
640 if (i & EHCI_CMD_ASPME)
641 printf(" EHCI_CMD_ASPME\n");
642 if (i & EHCI_CMD_ASPMC)
643 printf(" EHCI_CMD_ASPMC\n");
644 if (i & EHCI_CMD_LHCR)
645 printf(" EHCI_CMD_LHCR\n");
646 if (i & EHCI_CMD_IAAD)
647 printf(" EHCI_CMD_IAAD\n");
648 if (i & EHCI_CMD_ASE)
649 printf(" EHCI_CMD_ASE\n");
650 if (i & EHCI_CMD_PSE)
651 printf(" EHCI_CMD_PSE\n");
652 if (i & EHCI_CMD_FLS_M)
653 printf(" EHCI_CMD_FLS_M\n");
654 if (i & EHCI_CMD_HCRESET)
655 printf(" EHCI_CMD_HCRESET\n");
657 printf(" EHCI_CMD_RS\n");
659 i = EOREAD4(sc, EHCI_USBSTS);
661 printf("sts=0x%08x\n", i);
663 if (i & EHCI_STS_ASS)
664 printf(" EHCI_STS_ASS\n");
665 if (i & EHCI_STS_PSS)
666 printf(" EHCI_STS_PSS\n");
667 if (i & EHCI_STS_REC)
668 printf(" EHCI_STS_REC\n");
669 if (i & EHCI_STS_HCH)
670 printf(" EHCI_STS_HCH\n");
671 if (i & EHCI_STS_IAA)
672 printf(" EHCI_STS_IAA\n");
673 if (i & EHCI_STS_HSE)
674 printf(" EHCI_STS_HSE\n");
675 if (i & EHCI_STS_FLR)
676 printf(" EHCI_STS_FLR\n");
677 if (i & EHCI_STS_PCD)
678 printf(" EHCI_STS_PCD\n");
679 if (i & EHCI_STS_ERRINT)
680 printf(" EHCI_STS_ERRINT\n");
681 if (i & EHCI_STS_INT)
682 printf(" EHCI_STS_INT\n");
684 printf("ien=0x%08x\n",
685 EOREAD4(sc, EHCI_USBINTR));
686 printf("frindex=0x%08x ctrdsegm=0x%08x periodic=0x%08x async=0x%08x\n",
687 EOREAD4(sc, EHCI_FRINDEX),
688 EOREAD4(sc, EHCI_CTRLDSSEGMENT),
689 EOREAD4(sc, EHCI_PERIODICLISTBASE),
690 EOREAD4(sc, EHCI_ASYNCLISTADDR));
691 for (i = 1; i <= sc->sc_noport; i++) {
692 printf("port %d status=0x%08x\n", i,
693 EOREAD4(sc, EHCI_PORTSC(i)));
698 ehci_dump_link(ehci_softc_t *sc, uint32_t link, int type)
700 link = hc32toh(sc, link);
701 printf("0x%08x", link);
702 if (link & EHCI_LINK_TERMINATE)
707 switch (EHCI_LINK_TYPE(link)) {
727 ehci_dump_qtd(ehci_softc_t *sc, ehci_qtd_t *qtd)
732 ehci_dump_link(sc, qtd->qtd_next, 0);
734 ehci_dump_link(sc, qtd->qtd_altnext, 0);
736 s = hc32toh(sc, qtd->qtd_status);
737 printf(" status=0x%08x: toggle=%d bytes=0x%x ioc=%d c_page=0x%x\n",
738 s, EHCI_QTD_GET_TOGGLE(s), EHCI_QTD_GET_BYTES(s),
739 EHCI_QTD_GET_IOC(s), EHCI_QTD_GET_C_PAGE(s));
740 printf(" cerr=%d pid=%d stat=%s%s%s%s%s%s%s%s\n",
741 EHCI_QTD_GET_CERR(s), EHCI_QTD_GET_PID(s),
742 (s & EHCI_QTD_ACTIVE) ? "ACTIVE" : "NOT_ACTIVE",
743 (s & EHCI_QTD_HALTED) ? "-HALTED" : "",
744 (s & EHCI_QTD_BUFERR) ? "-BUFERR" : "",
745 (s & EHCI_QTD_BABBLE) ? "-BABBLE" : "",
746 (s & EHCI_QTD_XACTERR) ? "-XACTERR" : "",
747 (s & EHCI_QTD_MISSEDMICRO) ? "-MISSED" : "",
748 (s & EHCI_QTD_SPLITXSTATE) ? "-SPLIT" : "",
749 (s & EHCI_QTD_PINGSTATE) ? "-PING" : "");
751 for (s = 0; s < 5; s++) {
752 printf(" buffer[%d]=0x%08x\n", s,
753 hc32toh(sc, qtd->qtd_buffer[s]));
755 for (s = 0; s < 5; s++) {
756 printf(" buffer_hi[%d]=0x%08x\n", s,
757 hc32toh(sc, qtd->qtd_buffer_hi[s]));
762 ehci_dump_sqtd(ehci_softc_t *sc, ehci_qtd_t *sqtd)
766 usb_pc_cpu_invalidate(sqtd->page_cache);
767 printf("QTD(%p) at 0x%08x:\n", sqtd, hc32toh(sc, sqtd->qtd_self));
768 ehci_dump_qtd(sc, sqtd);
769 temp = (sqtd->qtd_next & htohc32(sc, EHCI_LINK_TERMINATE)) ? 1 : 0;
774 ehci_dump_sqtds(ehci_softc_t *sc, ehci_qtd_t *sqtd)
780 for (i = 0; sqtd && (i < 20) && !stop; sqtd = sqtd->obj_next, i++) {
781 stop = ehci_dump_sqtd(sc, sqtd);
784 printf("dump aborted, too many TDs\n");
789 ehci_dump_sqh(ehci_softc_t *sc, ehci_qh_t *qh)
794 usb_pc_cpu_invalidate(qh->page_cache);
795 printf("QH(%p) at 0x%08x:\n", qh, hc32toh(sc, qh->qh_self) & ~0x1F);
797 ehci_dump_link(sc, qh->qh_link, 1);
799 endp = hc32toh(sc, qh->qh_endp);
800 printf(" endp=0x%08x\n", endp);
801 printf(" addr=0x%02x inact=%d endpt=%d eps=%d dtc=%d hrecl=%d\n",
802 EHCI_QH_GET_ADDR(endp), EHCI_QH_GET_INACT(endp),
803 EHCI_QH_GET_ENDPT(endp), EHCI_QH_GET_EPS(endp),
804 EHCI_QH_GET_DTC(endp), EHCI_QH_GET_HRECL(endp));
805 printf(" mpl=0x%x ctl=%d nrl=%d\n",
806 EHCI_QH_GET_MPL(endp), EHCI_QH_GET_CTL(endp),
807 EHCI_QH_GET_NRL(endp));
808 endphub = hc32toh(sc, qh->qh_endphub);
809 printf(" endphub=0x%08x\n", endphub);
810 printf(" smask=0x%02x cmask=0x%02x huba=0x%02x port=%d mult=%d\n",
811 EHCI_QH_GET_SMASK(endphub), EHCI_QH_GET_CMASK(endphub),
812 EHCI_QH_GET_HUBA(endphub), EHCI_QH_GET_PORT(endphub),
813 EHCI_QH_GET_MULT(endphub));
815 ehci_dump_link(sc, qh->qh_curqtd, 0);
817 printf("Overlay qTD:\n");
818 ehci_dump_qtd(sc, (void *)&qh->qh_qtd);
822 ehci_dump_sitd(ehci_softc_t *sc, ehci_sitd_t *sitd)
824 usb_pc_cpu_invalidate(sitd->page_cache);
825 printf("SITD(%p) at 0x%08x\n", sitd, hc32toh(sc, sitd->sitd_self) & ~0x1F);
826 printf(" next=0x%08x\n", hc32toh(sc, sitd->sitd_next));
827 printf(" portaddr=0x%08x dir=%s addr=%d endpt=0x%x port=0x%x huba=0x%x\n",
828 hc32toh(sc, sitd->sitd_portaddr),
829 (sitd->sitd_portaddr & htohc32(sc, EHCI_SITD_SET_DIR_IN))
831 EHCI_SITD_GET_ADDR(hc32toh(sc, sitd->sitd_portaddr)),
832 EHCI_SITD_GET_ENDPT(hc32toh(sc, sitd->sitd_portaddr)),
833 EHCI_SITD_GET_PORT(hc32toh(sc, sitd->sitd_portaddr)),
834 EHCI_SITD_GET_HUBA(hc32toh(sc, sitd->sitd_portaddr)));
835 printf(" mask=0x%08x\n", hc32toh(sc, sitd->sitd_mask));
836 printf(" status=0x%08x <%s> len=0x%x\n", hc32toh(sc, sitd->sitd_status),
837 (sitd->sitd_status & htohc32(sc, EHCI_SITD_ACTIVE)) ? "ACTIVE" : "",
838 EHCI_SITD_GET_LEN(hc32toh(sc, sitd->sitd_status)));
839 printf(" back=0x%08x, bp=0x%08x,0x%08x,0x%08x,0x%08x\n",
840 hc32toh(sc, sitd->sitd_back),
841 hc32toh(sc, sitd->sitd_bp[0]),
842 hc32toh(sc, sitd->sitd_bp[1]),
843 hc32toh(sc, sitd->sitd_bp_hi[0]),
844 hc32toh(sc, sitd->sitd_bp_hi[1]));
848 ehci_dump_itd(ehci_softc_t *sc, ehci_itd_t *itd)
850 usb_pc_cpu_invalidate(itd->page_cache);
851 printf("ITD(%p) at 0x%08x\n", itd, hc32toh(sc, itd->itd_self) & ~0x1F);
852 printf(" next=0x%08x\n", hc32toh(sc, itd->itd_next));
853 printf(" status[0]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[0]),
854 (itd->itd_status[0] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
855 printf(" status[1]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[1]),
856 (itd->itd_status[1] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
857 printf(" status[2]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[2]),
858 (itd->itd_status[2] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
859 printf(" status[3]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[3]),
860 (itd->itd_status[3] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
861 printf(" status[4]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[4]),
862 (itd->itd_status[4] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
863 printf(" status[5]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[5]),
864 (itd->itd_status[5] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
865 printf(" status[6]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[6]),
866 (itd->itd_status[6] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
867 printf(" status[7]=0x%08x; <%s>\n", hc32toh(sc, itd->itd_status[7]),
868 (itd->itd_status[7] & htohc32(sc, EHCI_ITD_ACTIVE)) ? "ACTIVE" : "");
869 printf(" bp[0]=0x%08x\n", hc32toh(sc, itd->itd_bp[0]));
870 printf(" addr=0x%02x; endpt=0x%01x\n",
871 EHCI_ITD_GET_ADDR(hc32toh(sc, itd->itd_bp[0])),
872 EHCI_ITD_GET_ENDPT(hc32toh(sc, itd->itd_bp[0])));
873 printf(" bp[1]=0x%08x\n", hc32toh(sc, itd->itd_bp[1]));
874 printf(" dir=%s; mpl=0x%02x\n",
875 (hc32toh(sc, itd->itd_bp[1]) & EHCI_ITD_SET_DIR_IN) ? "in" : "out",
876 EHCI_ITD_GET_MPL(hc32toh(sc, itd->itd_bp[1])));
877 printf(" bp[2..6]=0x%08x,0x%08x,0x%08x,0x%08x,0x%08x\n",
878 hc32toh(sc, itd->itd_bp[2]),
879 hc32toh(sc, itd->itd_bp[3]),
880 hc32toh(sc, itd->itd_bp[4]),
881 hc32toh(sc, itd->itd_bp[5]),
882 hc32toh(sc, itd->itd_bp[6]));
883 printf(" bp_hi=0x%08x,0x%08x,0x%08x,0x%08x,\n"
884 " 0x%08x,0x%08x,0x%08x\n",
885 hc32toh(sc, itd->itd_bp_hi[0]),
886 hc32toh(sc, itd->itd_bp_hi[1]),
887 hc32toh(sc, itd->itd_bp_hi[2]),
888 hc32toh(sc, itd->itd_bp_hi[3]),
889 hc32toh(sc, itd->itd_bp_hi[4]),
890 hc32toh(sc, itd->itd_bp_hi[5]),
891 hc32toh(sc, itd->itd_bp_hi[6]));
895 ehci_dump_isoc(ehci_softc_t *sc)
902 pos = (EOREAD4(sc, EHCI_FRINDEX) / 8) &
903 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
905 printf("%s: isochronous dump from frame 0x%03x:\n",
908 itd = sc->sc_isoc_hs_p_last[pos];
909 sitd = sc->sc_isoc_fs_p_last[pos];
911 while (itd && max && max--) {
912 ehci_dump_itd(sc, itd);
916 while (sitd && max && max--) {
917 ehci_dump_sitd(sc, sitd);
925 ehci_transfer_intr_enqueue(struct usb_xfer *xfer)
927 /* check for early completion */
928 if (ehci_check_transfer(xfer)) {
931 /* put transfer on interrupt queue */
932 usbd_transfer_enqueue(&xfer->xroot->bus->intr_q, xfer);
934 /* start timeout, if any */
935 if (xfer->timeout != 0) {
936 usbd_transfer_timeout_ms(xfer, &ehci_timeout, xfer->timeout);
940 #define EHCI_APPEND_FS_TD(std,last) (last) = _ehci_append_fs_td(std,last)
942 _ehci_append_fs_td(ehci_sitd_t *std, ehci_sitd_t *last)
944 DPRINTFN(11, "%p to %p\n", std, last);
946 /* (sc->sc_bus.mtx) must be locked */
948 std->next = last->next;
949 std->sitd_next = last->sitd_next;
953 usb_pc_cpu_flush(std->page_cache);
956 * the last->next->prev is never followed: std->next->prev = std;
959 last->sitd_next = std->sitd_self;
961 usb_pc_cpu_flush(last->page_cache);
966 #define EHCI_APPEND_HS_TD(std,last) (last) = _ehci_append_hs_td(std,last)
968 _ehci_append_hs_td(ehci_itd_t *std, ehci_itd_t *last)
970 DPRINTFN(11, "%p to %p\n", std, last);
972 /* (sc->sc_bus.mtx) must be locked */
974 std->next = last->next;
975 std->itd_next = last->itd_next;
979 usb_pc_cpu_flush(std->page_cache);
982 * the last->next->prev is never followed: std->next->prev = std;
985 last->itd_next = std->itd_self;
987 usb_pc_cpu_flush(last->page_cache);
992 #define EHCI_APPEND_QH(sqh,last) (last) = _ehci_append_qh(sqh,last)
994 _ehci_append_qh(ehci_qh_t *sqh, ehci_qh_t *last)
996 DPRINTFN(11, "%p to %p\n", sqh, last);
998 if (sqh->prev != NULL) {
999 /* should not happen */
1000 DPRINTFN(0, "QH already linked!\n");
1003 /* (sc->sc_bus.mtx) must be locked */
1005 sqh->next = last->next;
1006 sqh->qh_link = last->qh_link;
1010 usb_pc_cpu_flush(sqh->page_cache);
1013 * the last->next->prev is never followed: sqh->next->prev = sqh;
1017 last->qh_link = sqh->qh_self;
1019 usb_pc_cpu_flush(last->page_cache);
1024 #define EHCI_REMOVE_FS_TD(std,last) (last) = _ehci_remove_fs_td(std,last)
1025 static ehci_sitd_t *
1026 _ehci_remove_fs_td(ehci_sitd_t *std, ehci_sitd_t *last)
1028 DPRINTFN(11, "%p from %p\n", std, last);
1030 /* (sc->sc_bus.mtx) must be locked */
1032 std->prev->next = std->next;
1033 std->prev->sitd_next = std->sitd_next;
1035 usb_pc_cpu_flush(std->prev->page_cache);
1038 std->next->prev = std->prev;
1039 usb_pc_cpu_flush(std->next->page_cache);
1041 return ((last == std) ? std->prev : last);
1044 #define EHCI_REMOVE_HS_TD(std,last) (last) = _ehci_remove_hs_td(std,last)
1046 _ehci_remove_hs_td(ehci_itd_t *std, ehci_itd_t *last)
1048 DPRINTFN(11, "%p from %p\n", std, last);
1050 /* (sc->sc_bus.mtx) must be locked */
1052 std->prev->next = std->next;
1053 std->prev->itd_next = std->itd_next;
1055 usb_pc_cpu_flush(std->prev->page_cache);
1058 std->next->prev = std->prev;
1059 usb_pc_cpu_flush(std->next->page_cache);
1061 return ((last == std) ? std->prev : last);
1064 #define EHCI_REMOVE_QH(sqh,last) (last) = _ehci_remove_qh(sqh,last)
1066 _ehci_remove_qh(ehci_qh_t *sqh, ehci_qh_t *last)
1068 DPRINTFN(11, "%p from %p\n", sqh, last);
1070 /* (sc->sc_bus.mtx) must be locked */
1072 /* only remove if not removed from a queue */
1075 sqh->prev->next = sqh->next;
1076 sqh->prev->qh_link = sqh->qh_link;
1078 usb_pc_cpu_flush(sqh->prev->page_cache);
1081 sqh->next->prev = sqh->prev;
1082 usb_pc_cpu_flush(sqh->next->page_cache);
1084 last = ((last == sqh) ? sqh->prev : last);
1088 usb_pc_cpu_flush(sqh->page_cache);
1094 ehci_data_toggle_update(struct usb_xfer *xfer, uint16_t actlen, uint16_t xlen)
1099 /* count number of full packets */
1100 dt = (actlen / xfer->max_packet_size) & 1;
1102 /* compute remainder */
1103 rem = actlen % xfer->max_packet_size;
1106 dt ^= 1; /* short packet at the end */
1107 else if (actlen != xlen)
1108 dt ^= 1; /* zero length packet at the end */
1110 dt ^= 1; /* zero length transfer */
1112 xfer->endpoint->toggle_next ^= dt;
1116 ehci_non_isoc_done_sub(struct usb_xfer *xfer)
1118 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
1120 ehci_qtd_t *td_alt_next;
1124 td = xfer->td_transfer_cache;
1125 td_alt_next = td->alt_next;
1127 if (xfer->aframes != xfer->nframes) {
1128 usbd_xfer_set_frame_len(xfer, xfer->aframes, 0);
1132 usb_pc_cpu_invalidate(td->page_cache);
1133 status = hc32toh(sc, td->qtd_status);
1135 len = EHCI_QTD_GET_BYTES(status);
1138 * Verify the status length and
1139 * add the length to "frlengths[]":
1141 if (len > td->len) {
1142 /* should not happen */
1143 DPRINTF("Invalid status length, "
1144 "0x%04x/0x%04x bytes\n", len, td->len);
1145 status |= EHCI_QTD_HALTED;
1146 } else if (xfer->aframes != xfer->nframes) {
1147 xfer->frlengths[xfer->aframes] += td->len - len;
1148 /* manually update data toggle */
1149 ehci_data_toggle_update(xfer, td->len - len, td->len);
1152 /* Check for last transfer */
1153 if (((void *)td) == xfer->td_transfer_last) {
1157 /* Check for transfer error */
1158 if (status & EHCI_QTD_HALTED) {
1159 /* the transfer is finished */
1163 /* Check for short transfer */
1165 if (xfer->flags_int.short_frames_ok) {
1166 /* follow alt next */
1169 /* the transfer is finished */
1176 if (td->alt_next != td_alt_next) {
1177 /* this USB frame is complete */
1182 /* update transfer cache */
1184 xfer->td_transfer_cache = td;
1187 if (status & EHCI_QTD_STATERRS) {
1188 DPRINTFN(11, "error, addr=%d, endpt=0x%02x, frame=0x%02x"
1189 "status=%s%s%s%s%s%s%s%s\n",
1190 xfer->address, xfer->endpointno, xfer->aframes,
1191 (status & EHCI_QTD_ACTIVE) ? "[ACTIVE]" : "[NOT_ACTIVE]",
1192 (status & EHCI_QTD_HALTED) ? "[HALTED]" : "",
1193 (status & EHCI_QTD_BUFERR) ? "[BUFERR]" : "",
1194 (status & EHCI_QTD_BABBLE) ? "[BABBLE]" : "",
1195 (status & EHCI_QTD_XACTERR) ? "[XACTERR]" : "",
1196 (status & EHCI_QTD_MISSEDMICRO) ? "[MISSED]" : "",
1197 (status & EHCI_QTD_SPLITXSTATE) ? "[SPLIT]" : "",
1198 (status & EHCI_QTD_PINGSTATE) ? "[PING]" : "");
1201 if (status & EHCI_QTD_HALTED) {
1202 if ((xfer->xroot->udev->parent_hs_hub != NULL) ||
1203 (xfer->xroot->udev->address != 0)) {
1204 /* try to separate I/O errors from STALL */
1205 if (EHCI_QTD_GET_CERR(status) == 0)
1206 return (USB_ERR_IOERROR);
1208 return (USB_ERR_STALLED);
1210 return (USB_ERR_NORMAL_COMPLETION);
1214 ehci_non_isoc_done(struct usb_xfer *xfer)
1216 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
1219 usb_error_t err = 0;
1221 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
1222 xfer, xfer->endpoint);
1225 if (ehcidebug > 10) {
1226 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
1228 ehci_dump_sqtds(sc, xfer->td_transfer_first);
1232 /* extract data toggle directly from the QH's overlay area */
1234 qh = xfer->qh_start[xfer->flags_int.curr_dma_set];
1236 usb_pc_cpu_invalidate(qh->page_cache);
1238 status = hc32toh(sc, qh->qh_qtd.qtd_status);
1242 xfer->td_transfer_cache = xfer->td_transfer_first;
1244 if (xfer->flags_int.control_xfr) {
1246 if (xfer->flags_int.control_hdr) {
1248 err = ehci_non_isoc_done_sub(xfer);
1252 if (xfer->td_transfer_cache == NULL) {
1256 while (xfer->aframes != xfer->nframes) {
1258 err = ehci_non_isoc_done_sub(xfer);
1261 if (xfer->td_transfer_cache == NULL) {
1266 if (xfer->flags_int.control_xfr &&
1267 !xfer->flags_int.control_act) {
1269 err = ehci_non_isoc_done_sub(xfer);
1272 ehci_device_done(xfer, err);
1275 /*------------------------------------------------------------------------*
1276 * ehci_check_transfer
1279 * 0: USB transfer is not finished
1280 * Else: USB transfer is finished
1281 *------------------------------------------------------------------------*/
1283 ehci_check_transfer(struct usb_xfer *xfer)
1285 struct usb_pipe_methods *methods = xfer->endpoint->methods;
1286 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
1290 DPRINTFN(13, "xfer=%p checking transfer\n", xfer);
1292 if (methods == &ehci_device_isoc_fs_methods) {
1295 /* isochronous full speed transfer */
1297 td = xfer->td_transfer_last;
1298 usb_pc_cpu_invalidate(td->page_cache);
1299 status = hc32toh(sc, td->sitd_status);
1301 /* also check if first is complete */
1303 td = xfer->td_transfer_first;
1304 usb_pc_cpu_invalidate(td->page_cache);
1305 status |= hc32toh(sc, td->sitd_status);
1307 if (!(status & EHCI_SITD_ACTIVE)) {
1308 ehci_device_done(xfer, USB_ERR_NORMAL_COMPLETION);
1311 } else if (methods == &ehci_device_isoc_hs_methods) {
1314 /* isochronous high speed transfer */
1316 /* check last transfer */
1317 td = xfer->td_transfer_last;
1318 usb_pc_cpu_invalidate(td->page_cache);
1319 status = td->itd_status[0];
1320 status |= td->itd_status[1];
1321 status |= td->itd_status[2];
1322 status |= td->itd_status[3];
1323 status |= td->itd_status[4];
1324 status |= td->itd_status[5];
1325 status |= td->itd_status[6];
1326 status |= td->itd_status[7];
1328 /* also check first transfer */
1329 td = xfer->td_transfer_first;
1330 usb_pc_cpu_invalidate(td->page_cache);
1331 status |= td->itd_status[0];
1332 status |= td->itd_status[1];
1333 status |= td->itd_status[2];
1334 status |= td->itd_status[3];
1335 status |= td->itd_status[4];
1336 status |= td->itd_status[5];
1337 status |= td->itd_status[6];
1338 status |= td->itd_status[7];
1340 /* if no transactions are active we continue */
1341 if (!(status & htohc32(sc, EHCI_ITD_ACTIVE))) {
1342 ehci_device_done(xfer, USB_ERR_NORMAL_COMPLETION);
1349 /* non-isochronous transfer */
1352 * check whether there is an error somewhere in the middle,
1353 * or whether there was a short packet (SPD and not ACTIVE)
1355 td = xfer->td_transfer_cache;
1357 qh = xfer->qh_start[xfer->flags_int.curr_dma_set];
1359 usb_pc_cpu_invalidate(qh->page_cache);
1361 status = hc32toh(sc, qh->qh_qtd.qtd_status);
1362 if (status & EHCI_QTD_ACTIVE) {
1363 /* transfer is pending */
1368 usb_pc_cpu_invalidate(td->page_cache);
1369 status = hc32toh(sc, td->qtd_status);
1372 * Check if there is an active TD which
1373 * indicates that the transfer isn't done.
1375 if (status & EHCI_QTD_ACTIVE) {
1377 xfer->td_transfer_cache = td;
1381 * last transfer descriptor makes the transfer done
1383 if (((void *)td) == xfer->td_transfer_last) {
1387 * any kind of error makes the transfer done
1389 if (status & EHCI_QTD_HALTED) {
1393 * if there is no alternate next transfer, a short
1394 * packet also makes the transfer done
1396 if (EHCI_QTD_GET_BYTES(status)) {
1397 if (xfer->flags_int.short_frames_ok) {
1398 /* follow alt next */
1404 /* transfer is done */
1409 ehci_non_isoc_done(xfer);
1414 DPRINTFN(13, "xfer=%p is still active\n", xfer);
1422 ehci_pcd_enable(ehci_softc_t *sc)
1424 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
1426 sc->sc_eintrs |= EHCI_STS_PCD;
1427 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
1429 /* acknowledge any PCD interrupt */
1430 EOWRITE4(sc, EHCI_USBSTS, EHCI_STS_PCD);
1436 ehci_interrupt_poll(ehci_softc_t *sc)
1438 struct usb_xfer *xfer;
1441 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
1443 * check if transfer is transferred
1445 if (ehci_check_transfer(xfer)) {
1446 /* queue has been modified */
1453 * Some EHCI chips from VIA / ATI seem to trigger interrupts before
1454 * writing back the qTD status, or miss signalling occasionally under
1455 * heavy load. If the host machine is too fast, we can miss
1456 * transaction completion - when we scan the active list the
1457 * transaction still seems to be active. This generally exhibits
1458 * itself as a umass stall that never recovers.
1460 * We work around this behaviour by setting up this callback after any
1461 * softintr that completes with transactions still pending, giving us
1462 * another chance to check for completion after the writeback has
1466 ehci_poll_timeout(void *arg)
1468 ehci_softc_t *sc = arg;
1471 ehci_interrupt_poll(sc);
1474 /*------------------------------------------------------------------------*
1475 * ehci_interrupt - EHCI interrupt handler
1477 * NOTE: Do not access "sc->sc_bus.bdev" inside the interrupt handler,
1478 * hence the interrupt handler will be setup before "sc->sc_bus.bdev"
1480 *------------------------------------------------------------------------*/
1482 ehci_interrupt(ehci_softc_t *sc)
1486 USB_BUS_LOCK(&sc->sc_bus);
1488 DPRINTFN(16, "real interrupt\n");
1491 if (ehcidebug > 15) {
1496 status = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
1498 /* the interrupt was not for us */
1501 if (!(status & sc->sc_eintrs)) {
1504 EOWRITE4(sc, EHCI_USBSTS, status); /* acknowledge */
1506 status &= sc->sc_eintrs;
1508 if (status & EHCI_STS_HSE) {
1509 printf("%s: unrecoverable error, "
1510 "controller halted\n", __FUNCTION__);
1516 if (status & EHCI_STS_PCD) {
1518 * Disable PCD interrupt for now, because it will be
1519 * on until the port has been reset.
1521 sc->sc_eintrs &= ~EHCI_STS_PCD;
1522 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
1526 /* do not allow RHSC interrupts > 1 per second */
1527 usb_callout_reset(&sc->sc_tmo_pcd, hz,
1528 (void *)&ehci_pcd_enable, sc);
1530 status &= ~(EHCI_STS_INT | EHCI_STS_ERRINT | EHCI_STS_PCD | EHCI_STS_IAA);
1533 /* block unprocessed interrupts */
1534 sc->sc_eintrs &= ~status;
1535 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
1536 printf("%s: blocking interrupts 0x%x\n", __FUNCTION__, status);
1538 /* poll all the USB transfers */
1539 ehci_interrupt_poll(sc);
1541 if (sc->sc_flags & EHCI_SCFLG_LOSTINTRBUG) {
1542 usb_callout_reset(&sc->sc_tmo_poll, hz / 128,
1543 (void *)&ehci_poll_timeout, sc);
1547 USB_BUS_UNLOCK(&sc->sc_bus);
1551 * called when a request does not complete
1554 ehci_timeout(void *arg)
1556 struct usb_xfer *xfer = arg;
1558 DPRINTF("xfer=%p\n", xfer);
1560 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1562 /* transfer is transferred */
1563 ehci_device_done(xfer, USB_ERR_TIMEOUT);
1567 ehci_do_poll(struct usb_bus *bus)
1569 ehci_softc_t *sc = EHCI_BUS2SC(bus);
1571 USB_BUS_LOCK(&sc->sc_bus);
1572 ehci_interrupt_poll(sc);
1573 USB_BUS_UNLOCK(&sc->sc_bus);
1577 ehci_setup_standard_chain_sub(struct ehci_std_temp *temp)
1579 struct usb_page_search buf_res;
1581 ehci_qtd_t *td_next;
1582 ehci_qtd_t *td_alt_next;
1583 uint32_t buf_offset;
1587 uint32_t qtd_altnext;
1588 uint8_t shortpkt_old;
1591 terminate = temp->sc->sc_terminate_self;
1592 qtd_altnext = temp->sc->sc_terminate_self;
1595 shortpkt_old = temp->shortpkt;
1596 len_old = temp->len;
1602 td_next = temp->td_next;
1606 if (temp->len == 0) {
1608 if (temp->shortpkt) {
1611 /* send a Zero Length Packet, ZLP, last */
1618 average = temp->average;
1620 if (temp->len < average) {
1621 if (temp->len % temp->max_frame_size) {
1624 average = temp->len;
1628 if (td_next == NULL) {
1629 panic("%s: out of EHCI transfer descriptors!", __FUNCTION__);
1634 td_next = td->obj_next;
1636 /* check if we are pre-computing */
1640 /* update remaining length */
1642 temp->len -= average;
1646 /* fill out current TD */
1650 htohc32(temp->sc, EHCI_QTD_IOC |
1651 EHCI_QTD_SET_BYTES(average));
1655 if (temp->auto_data_toggle == 0) {
1657 /* update data toggle, ZLP case */
1660 htohc32(temp->sc, EHCI_QTD_TOGGLE_MASK);
1664 /* properly reset reserved fields */
1665 td->qtd_buffer[0] = 0;
1666 td->qtd_buffer[1] = 0;
1667 td->qtd_buffer[2] = 0;
1668 td->qtd_buffer[3] = 0;
1669 td->qtd_buffer[4] = 0;
1670 td->qtd_buffer_hi[0] = 0;
1671 td->qtd_buffer_hi[1] = 0;
1672 td->qtd_buffer_hi[2] = 0;
1673 td->qtd_buffer_hi[3] = 0;
1674 td->qtd_buffer_hi[4] = 0;
1679 if (temp->auto_data_toggle == 0) {
1681 /* update data toggle */
1683 if (((average + temp->max_frame_size - 1) /
1684 temp->max_frame_size) & 1) {
1686 htohc32(temp->sc, EHCI_QTD_TOGGLE_MASK);
1691 /* update remaining length */
1693 temp->len -= average;
1695 /* fill out buffer pointers */
1697 usbd_get_page(temp->pc, buf_offset, &buf_res);
1699 htohc32(temp->sc, buf_res.physaddr);
1700 td->qtd_buffer_hi[0] = 0;
1704 while (average > EHCI_PAGE_SIZE) {
1705 average -= EHCI_PAGE_SIZE;
1706 buf_offset += EHCI_PAGE_SIZE;
1707 usbd_get_page(temp->pc, buf_offset, &buf_res);
1710 buf_res.physaddr & (~0xFFF));
1711 td->qtd_buffer_hi[x] = 0;
1716 * NOTE: The "average" variable is never zero after
1717 * exiting the loop above !
1719 * NOTE: We have to subtract one from the offset to
1720 * ensure that we are computing the physical address
1723 buf_offset += average;
1724 usbd_get_page(temp->pc, buf_offset - 1, &buf_res);
1727 buf_res.physaddr & (~0xFFF));
1728 td->qtd_buffer_hi[x] = 0;
1730 /* properly reset reserved fields */
1731 while (++x < EHCI_QTD_NBUFFERS) {
1732 td->qtd_buffer[x] = 0;
1733 td->qtd_buffer_hi[x] = 0;
1738 /* link the current TD with the next one */
1739 td->qtd_next = td_next->qtd_self;
1741 td->qtd_altnext = qtd_altnext;
1742 td->alt_next = td_alt_next;
1744 usb_pc_cpu_flush(td->page_cache);
1750 /* setup alt next pointer, if any */
1751 if (temp->last_frame) {
1753 qtd_altnext = terminate;
1755 /* we use this field internally */
1756 td_alt_next = td_next;
1757 if (temp->setup_alt_next) {
1758 qtd_altnext = td_next->qtd_self;
1760 qtd_altnext = terminate;
1765 temp->shortpkt = shortpkt_old;
1766 temp->len = len_old;
1770 temp->td_next = td_next;
1774 ehci_setup_standard_chain(struct usb_xfer *xfer, ehci_qh_t **qh_last)
1776 struct ehci_std_temp temp;
1777 struct usb_pipe_methods *methods;
1781 uint32_t qh_endphub;
1784 DPRINTFN(9, "addr=%d endpt=%d sumlen=%d speed=%d\n",
1785 xfer->address, UE_GET_ADDR(xfer->endpointno),
1786 xfer->sumlen, usbd_get_speed(xfer->xroot->udev));
1788 temp.average = xfer->max_hc_frame_size;
1789 temp.max_frame_size = xfer->max_frame_size;
1790 temp.sc = EHCI_BUS2SC(xfer->xroot->bus);
1792 /* toggle the DMA set we are using */
1793 xfer->flags_int.curr_dma_set ^= 1;
1795 /* get next DMA set */
1796 td = xfer->td_start[xfer->flags_int.curr_dma_set];
1798 xfer->td_transfer_first = td;
1799 xfer->td_transfer_cache = td;
1803 temp.qtd_status = 0;
1804 temp.last_frame = 0;
1805 temp.setup_alt_next = xfer->flags_int.short_frames_ok;
1807 if (xfer->flags_int.control_xfr) {
1808 if (xfer->endpoint->toggle_next) {
1811 htohc32(temp.sc, EHCI_QTD_SET_TOGGLE(1));
1813 temp.auto_data_toggle = 0;
1815 temp.auto_data_toggle = 1;
1818 if ((xfer->xroot->udev->parent_hs_hub != NULL) ||
1819 (xfer->xroot->udev->address != 0)) {
1822 htohc32(temp.sc, EHCI_QTD_SET_CERR(3));
1824 /* check if we should prepend a setup message */
1826 if (xfer->flags_int.control_xfr) {
1827 if (xfer->flags_int.control_hdr) {
1829 xfer->endpoint->toggle_next = 0;
1832 htohc32(temp.sc, EHCI_QTD_SET_CERR(3));
1833 temp.qtd_status |= htohc32(temp.sc,
1835 EHCI_QTD_SET_PID(EHCI_QTD_PID_SETUP) |
1836 EHCI_QTD_SET_TOGGLE(0));
1838 temp.len = xfer->frlengths[0];
1839 temp.pc = xfer->frbuffers + 0;
1840 temp.shortpkt = temp.len ? 1 : 0;
1841 /* check for last frame */
1842 if (xfer->nframes == 1) {
1843 /* no STATUS stage yet, SETUP is last */
1844 if (xfer->flags_int.control_act) {
1845 temp.last_frame = 1;
1846 temp.setup_alt_next = 0;
1849 ehci_setup_standard_chain_sub(&temp);
1856 while (x != xfer->nframes) {
1858 /* DATA0 / DATA1 message */
1860 temp.len = xfer->frlengths[x];
1861 temp.pc = xfer->frbuffers + x;
1865 if (x == xfer->nframes) {
1866 if (xfer->flags_int.control_xfr) {
1867 /* no STATUS stage yet, DATA is last */
1868 if (xfer->flags_int.control_act) {
1869 temp.last_frame = 1;
1870 temp.setup_alt_next = 0;
1873 temp.last_frame = 1;
1874 temp.setup_alt_next = 0;
1877 /* keep previous data toggle and error count */
1880 htohc32(temp.sc, EHCI_QTD_SET_CERR(3) |
1881 EHCI_QTD_SET_TOGGLE(1));
1883 if (temp.len == 0) {
1885 /* make sure that we send an USB packet */
1891 /* regular data transfer */
1893 temp.shortpkt = (xfer->flags.force_short_xfer) ? 0 : 1;
1896 /* set endpoint direction */
1899 (UE_GET_DIR(xfer->endpointno) == UE_DIR_IN) ?
1900 htohc32(temp.sc, EHCI_QTD_ACTIVE |
1901 EHCI_QTD_SET_PID(EHCI_QTD_PID_IN)) :
1902 htohc32(temp.sc, EHCI_QTD_ACTIVE |
1903 EHCI_QTD_SET_PID(EHCI_QTD_PID_OUT));
1905 ehci_setup_standard_chain_sub(&temp);
1908 /* check if we should append a status stage */
1910 if (xfer->flags_int.control_xfr &&
1911 !xfer->flags_int.control_act) {
1914 * Send a DATA1 message and invert the current endpoint
1918 temp.qtd_status &= htohc32(temp.sc, EHCI_QTD_SET_CERR(3) |
1919 EHCI_QTD_SET_TOGGLE(1));
1921 (UE_GET_DIR(xfer->endpointno) == UE_DIR_OUT) ?
1922 htohc32(temp.sc, EHCI_QTD_ACTIVE |
1923 EHCI_QTD_SET_PID(EHCI_QTD_PID_IN) |
1924 EHCI_QTD_SET_TOGGLE(1)) :
1925 htohc32(temp.sc, EHCI_QTD_ACTIVE |
1926 EHCI_QTD_SET_PID(EHCI_QTD_PID_OUT) |
1927 EHCI_QTD_SET_TOGGLE(1));
1932 temp.last_frame = 1;
1933 temp.setup_alt_next = 0;
1935 ehci_setup_standard_chain_sub(&temp);
1939 /* the last TD terminates the transfer: */
1940 td->qtd_next = htohc32(temp.sc, EHCI_LINK_TERMINATE);
1941 td->qtd_altnext = htohc32(temp.sc, EHCI_LINK_TERMINATE);
1943 usb_pc_cpu_flush(td->page_cache);
1945 /* must have at least one frame! */
1947 xfer->td_transfer_last = td;
1950 if (ehcidebug > 8) {
1951 DPRINTF("nexttog=%d; data before transfer:\n",
1952 xfer->endpoint->toggle_next);
1953 ehci_dump_sqtds(temp.sc,
1954 xfer->td_transfer_first);
1958 methods = xfer->endpoint->methods;
1960 qh = xfer->qh_start[xfer->flags_int.curr_dma_set];
1962 /* the "qh_link" field is filled when the QH is added */
1965 (EHCI_QH_SET_ADDR(xfer->address) |
1966 EHCI_QH_SET_ENDPT(UE_GET_ADDR(xfer->endpointno)) |
1967 EHCI_QH_SET_MPL(xfer->max_packet_size));
1969 if (usbd_get_speed(xfer->xroot->udev) == USB_SPEED_HIGH) {
1970 qh_endp |= EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH);
1971 if (methods != &ehci_device_intr_methods)
1972 qh_endp |= EHCI_QH_SET_NRL(8);
1975 if (usbd_get_speed(xfer->xroot->udev) == USB_SPEED_FULL) {
1976 qh_endp |= EHCI_QH_SET_EPS(EHCI_QH_SPEED_FULL);
1978 qh_endp |= EHCI_QH_SET_EPS(EHCI_QH_SPEED_LOW);
1981 if (methods == &ehci_device_ctrl_methods) {
1982 qh_endp |= EHCI_QH_CTL;
1984 if (methods != &ehci_device_intr_methods) {
1985 /* Only try one time per microframe! */
1986 qh_endp |= EHCI_QH_SET_NRL(1);
1990 if (temp.auto_data_toggle == 0) {
1991 /* software computes the data toggle */
1992 qh_endp |= EHCI_QH_DTC;
1995 qh->qh_endp = htohc32(temp.sc, qh_endp);
1998 (EHCI_QH_SET_MULT(xfer->max_packet_count & 3) |
1999 EHCI_QH_SET_CMASK(xfer->endpoint->usb_cmask) |
2000 EHCI_QH_SET_SMASK(xfer->endpoint->usb_smask) |
2001 EHCI_QH_SET_HUBA(xfer->xroot->udev->hs_hub_addr) |
2002 EHCI_QH_SET_PORT(xfer->xroot->udev->hs_port_no));
2004 qh->qh_endphub = htohc32(temp.sc, qh_endphub);
2007 /* fill the overlay qTD */
2009 if (temp.auto_data_toggle && xfer->endpoint->toggle_next) {
2011 qh->qh_qtd.qtd_status = htohc32(temp.sc, EHCI_QTD_SET_TOGGLE(1));
2013 qh->qh_qtd.qtd_status = 0;
2016 td = xfer->td_transfer_first;
2018 qh->qh_qtd.qtd_next = td->qtd_self;
2019 qh->qh_qtd.qtd_altnext =
2020 htohc32(temp.sc, EHCI_LINK_TERMINATE);
2022 /* properly reset reserved fields */
2023 qh->qh_qtd.qtd_buffer[0] = 0;
2024 qh->qh_qtd.qtd_buffer[1] = 0;
2025 qh->qh_qtd.qtd_buffer[2] = 0;
2026 qh->qh_qtd.qtd_buffer[3] = 0;
2027 qh->qh_qtd.qtd_buffer[4] = 0;
2028 qh->qh_qtd.qtd_buffer_hi[0] = 0;
2029 qh->qh_qtd.qtd_buffer_hi[1] = 0;
2030 qh->qh_qtd.qtd_buffer_hi[2] = 0;
2031 qh->qh_qtd.qtd_buffer_hi[3] = 0;
2032 qh->qh_qtd.qtd_buffer_hi[4] = 0;
2034 usb_pc_cpu_flush(qh->page_cache);
2036 if (xfer->xroot->udev->flags.self_suspended == 0) {
2037 EHCI_APPEND_QH(qh, *qh_last);
2042 ehci_root_intr(ehci_softc_t *sc)
2047 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
2049 /* clear any old interrupt data */
2050 memset(sc->sc_hub_idata, 0, sizeof(sc->sc_hub_idata));
2053 m = (sc->sc_noport + 1);
2054 if (m > (8 * sizeof(sc->sc_hub_idata))) {
2055 m = (8 * sizeof(sc->sc_hub_idata));
2057 for (i = 1; i < m; i++) {
2058 /* pick out CHANGE bits from the status register */
2059 if (EOREAD4(sc, EHCI_PORTSC(i)) & EHCI_PS_CLEAR) {
2060 sc->sc_hub_idata[i / 8] |= 1 << (i % 8);
2061 DPRINTF("port %d changed\n", i);
2064 uhub_root_intr(&sc->sc_bus, sc->sc_hub_idata,
2065 sizeof(sc->sc_hub_idata));
2069 ehci_isoc_fs_done(ehci_softc_t *sc, struct usb_xfer *xfer)
2071 uint32_t nframes = xfer->nframes;
2073 uint32_t *plen = xfer->frlengths;
2075 ehci_sitd_t *td = xfer->td_transfer_first;
2076 ehci_sitd_t **pp_last = &sc->sc_isoc_fs_p_last[xfer->qh_pos];
2078 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
2079 xfer, xfer->endpoint);
2083 panic("%s:%d: out of TD's\n",
2084 __FUNCTION__, __LINE__);
2086 if (pp_last >= &sc->sc_isoc_fs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT]) {
2087 pp_last = &sc->sc_isoc_fs_p_last[0];
2090 if (ehcidebug > 15) {
2091 DPRINTF("isoc FS-TD\n");
2092 ehci_dump_sitd(sc, td);
2095 usb_pc_cpu_invalidate(td->page_cache);
2096 status = hc32toh(sc, td->sitd_status);
2098 len = EHCI_SITD_GET_LEN(status);
2100 DPRINTFN(2, "status=0x%08x, rem=%u\n", status, len);
2110 /* remove FS-TD from schedule */
2111 EHCI_REMOVE_FS_TD(td, *pp_last);
2118 xfer->aframes = xfer->nframes;
2122 ehci_isoc_hs_done(ehci_softc_t *sc, struct usb_xfer *xfer)
2124 uint32_t nframes = xfer->nframes;
2126 uint32_t *plen = xfer->frlengths;
2129 ehci_itd_t *td = xfer->td_transfer_first;
2130 ehci_itd_t **pp_last = &sc->sc_isoc_hs_p_last[xfer->qh_pos];
2132 DPRINTFN(13, "xfer=%p endpoint=%p transfer done\n",
2133 xfer, xfer->endpoint);
2137 panic("%s:%d: out of TD's\n",
2138 __FUNCTION__, __LINE__);
2140 if (pp_last >= &sc->sc_isoc_hs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT]) {
2141 pp_last = &sc->sc_isoc_hs_p_last[0];
2144 if (ehcidebug > 15) {
2145 DPRINTF("isoc HS-TD\n");
2146 ehci_dump_itd(sc, td);
2150 usb_pc_cpu_invalidate(td->page_cache);
2151 status = hc32toh(sc, td->itd_status[td_no]);
2153 len = EHCI_ITD_GET_LEN(status);
2155 DPRINTFN(2, "status=0x%08x, len=%u\n", status, len);
2157 if (xfer->endpoint->usb_smask & (1 << td_no)) {
2161 * The length is valid. NOTE: The
2162 * complete length is written back
2163 * into the status field, and not the
2164 * remainder like with other transfer
2168 /* Invalid length - truncate */
2179 if ((td_no == 8) || (nframes == 0)) {
2180 /* remove HS-TD from schedule */
2181 EHCI_REMOVE_HS_TD(td, *pp_last);
2188 xfer->aframes = xfer->nframes;
2191 /* NOTE: "done" can be run two times in a row,
2192 * from close and from interrupt
2195 ehci_device_done(struct usb_xfer *xfer, usb_error_t error)
2197 struct usb_pipe_methods *methods = xfer->endpoint->methods;
2198 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2200 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
2202 DPRINTFN(2, "xfer=%p, endpoint=%p, error=%d\n",
2203 xfer, xfer->endpoint, error);
2205 if ((methods == &ehci_device_bulk_methods) ||
2206 (methods == &ehci_device_ctrl_methods)) {
2208 if (ehcidebug > 8) {
2209 DPRINTF("nexttog=%d; data after transfer:\n",
2210 xfer->endpoint->toggle_next);
2212 xfer->td_transfer_first);
2216 EHCI_REMOVE_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
2217 sc->sc_async_p_last);
2219 if (methods == &ehci_device_intr_methods) {
2220 EHCI_REMOVE_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
2221 sc->sc_intr_p_last[xfer->qh_pos]);
2224 * Only finish isochronous transfers once which will update
2225 * "xfer->frlengths".
2227 if (xfer->td_transfer_first &&
2228 xfer->td_transfer_last) {
2229 if (methods == &ehci_device_isoc_fs_methods) {
2230 ehci_isoc_fs_done(sc, xfer);
2232 if (methods == &ehci_device_isoc_hs_methods) {
2233 ehci_isoc_hs_done(sc, xfer);
2235 xfer->td_transfer_first = NULL;
2236 xfer->td_transfer_last = NULL;
2238 /* dequeue transfer and start next transfer */
2239 usbd_transfer_done(xfer, error);
2242 /*------------------------------------------------------------------------*
2244 *------------------------------------------------------------------------*/
2246 ehci_device_bulk_open(struct usb_xfer *xfer)
2252 ehci_device_bulk_close(struct usb_xfer *xfer)
2254 ehci_device_done(xfer, USB_ERR_CANCELLED);
2258 ehci_device_bulk_enter(struct usb_xfer *xfer)
2264 ehci_device_bulk_start(struct usb_xfer *xfer)
2266 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2269 /* setup TD's and QH */
2270 ehci_setup_standard_chain(xfer, &sc->sc_async_p_last);
2272 /* put transfer on interrupt queue */
2273 ehci_transfer_intr_enqueue(xfer);
2276 * XXX Certain nVidia chipsets choke when using the IAAD
2277 * feature too frequently.
2279 if (sc->sc_flags & EHCI_SCFLG_IAADBUG)
2282 /* XXX Performance quirk: Some Host Controllers have a too low
2283 * interrupt rate. Issue an IAAD to stimulate the Host
2284 * Controller after queueing the BULK transfer.
2286 temp = EOREAD4(sc, EHCI_USBCMD);
2287 if (!(temp & EHCI_CMD_IAAD))
2288 EOWRITE4(sc, EHCI_USBCMD, temp | EHCI_CMD_IAAD);
2291 struct usb_pipe_methods ehci_device_bulk_methods =
2293 .open = ehci_device_bulk_open,
2294 .close = ehci_device_bulk_close,
2295 .enter = ehci_device_bulk_enter,
2296 .start = ehci_device_bulk_start,
2299 /*------------------------------------------------------------------------*
2300 * ehci control support
2301 *------------------------------------------------------------------------*/
2303 ehci_device_ctrl_open(struct usb_xfer *xfer)
2309 ehci_device_ctrl_close(struct usb_xfer *xfer)
2311 ehci_device_done(xfer, USB_ERR_CANCELLED);
2315 ehci_device_ctrl_enter(struct usb_xfer *xfer)
2321 ehci_device_ctrl_start(struct usb_xfer *xfer)
2323 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2325 /* setup TD's and QH */
2326 ehci_setup_standard_chain(xfer, &sc->sc_async_p_last);
2328 /* put transfer on interrupt queue */
2329 ehci_transfer_intr_enqueue(xfer);
2332 struct usb_pipe_methods ehci_device_ctrl_methods =
2334 .open = ehci_device_ctrl_open,
2335 .close = ehci_device_ctrl_close,
2336 .enter = ehci_device_ctrl_enter,
2337 .start = ehci_device_ctrl_start,
2340 /*------------------------------------------------------------------------*
2341 * ehci interrupt support
2342 *------------------------------------------------------------------------*/
2344 ehci_device_intr_open(struct usb_xfer *xfer)
2346 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2351 usb_hs_bandwidth_alloc(xfer);
2354 * Find the best QH position corresponding to the given interval:
2358 bit = EHCI_VIRTUAL_FRAMELIST_COUNT / 2;
2360 if (xfer->interval >= bit) {
2364 if (sc->sc_intr_stat[x] <
2365 sc->sc_intr_stat[best]) {
2375 sc->sc_intr_stat[best]++;
2376 xfer->qh_pos = best;
2378 DPRINTFN(3, "best=%d interval=%d\n",
2379 best, xfer->interval);
2383 ehci_device_intr_close(struct usb_xfer *xfer)
2385 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2387 sc->sc_intr_stat[xfer->qh_pos]--;
2389 ehci_device_done(xfer, USB_ERR_CANCELLED);
2391 /* bandwidth must be freed after device done */
2392 usb_hs_bandwidth_free(xfer);
2396 ehci_device_intr_enter(struct usb_xfer *xfer)
2402 ehci_device_intr_start(struct usb_xfer *xfer)
2404 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2406 /* setup TD's and QH */
2407 ehci_setup_standard_chain(xfer, &sc->sc_intr_p_last[xfer->qh_pos]);
2409 /* put transfer on interrupt queue */
2410 ehci_transfer_intr_enqueue(xfer);
2413 struct usb_pipe_methods ehci_device_intr_methods =
2415 .open = ehci_device_intr_open,
2416 .close = ehci_device_intr_close,
2417 .enter = ehci_device_intr_enter,
2418 .start = ehci_device_intr_start,
2421 /*------------------------------------------------------------------------*
2422 * ehci full speed isochronous support
2423 *------------------------------------------------------------------------*/
2425 ehci_device_isoc_fs_open(struct usb_xfer *xfer)
2427 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2429 uint32_t sitd_portaddr;
2433 EHCI_SITD_SET_ADDR(xfer->address) |
2434 EHCI_SITD_SET_ENDPT(UE_GET_ADDR(xfer->endpointno)) |
2435 EHCI_SITD_SET_HUBA(xfer->xroot->udev->hs_hub_addr) |
2436 EHCI_SITD_SET_PORT(xfer->xroot->udev->hs_port_no);
2438 if (UE_GET_DIR(xfer->endpointno) == UE_DIR_IN)
2439 sitd_portaddr |= EHCI_SITD_SET_DIR_IN;
2441 sitd_portaddr = htohc32(sc, sitd_portaddr);
2443 /* initialize all TD's */
2445 for (ds = 0; ds != 2; ds++) {
2447 for (td = xfer->td_start[ds]; td; td = td->obj_next) {
2449 td->sitd_portaddr = sitd_portaddr;
2452 * TODO: make some kind of automatic
2453 * SMASK/CMASK selection based on micro-frame
2456 * micro-frame usage (8 microframes per 1ms)
2458 td->sitd_back = htohc32(sc, EHCI_LINK_TERMINATE);
2460 usb_pc_cpu_flush(td->page_cache);
2466 ehci_device_isoc_fs_close(struct usb_xfer *xfer)
2468 ehci_device_done(xfer, USB_ERR_CANCELLED);
2472 ehci_device_isoc_fs_enter(struct usb_xfer *xfer)
2474 struct usb_page_search buf_res;
2475 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2477 ehci_sitd_t *td_last = NULL;
2478 ehci_sitd_t **pp_last;
2480 uint32_t buf_offset;
2493 DPRINTFN(6, "xfer=%p next=%d nframes=%d\n",
2494 xfer, xfer->endpoint->isoc_next, xfer->nframes);
2496 /* get the current frame index */
2498 nframes = EOREAD4(sc, EHCI_FRINDEX) / 8;
2501 * check if the frame index is within the window where the frames
2504 buf_offset = (nframes - xfer->endpoint->isoc_next) &
2505 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2507 if ((xfer->endpoint->is_synced == 0) ||
2508 (buf_offset < xfer->nframes)) {
2510 * If there is data underflow or the pipe queue is empty we
2511 * schedule the transfer a few frames ahead of the current
2512 * frame position. Else two isochronous transfers might
2515 xfer->endpoint->isoc_next = (nframes + 3) &
2516 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2517 xfer->endpoint->is_synced = 1;
2518 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next);
2521 * compute how many milliseconds the insertion is ahead of the
2522 * current frame position:
2524 buf_offset = (xfer->endpoint->isoc_next - nframes) &
2525 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2528 * pre-compute when the isochronous transfer will be finished:
2530 xfer->isoc_time_complete =
2531 usb_isoc_time_expand(&sc->sc_bus, nframes) +
2532 buf_offset + xfer->nframes;
2534 /* get the real number of frames */
2536 nframes = xfer->nframes;
2540 plen = xfer->frlengths;
2542 /* toggle the DMA set we are using */
2543 xfer->flags_int.curr_dma_set ^= 1;
2545 /* get next DMA set */
2546 td = xfer->td_start[xfer->flags_int.curr_dma_set];
2547 xfer->td_transfer_first = td;
2549 pp_last = &sc->sc_isoc_fs_p_last[xfer->endpoint->isoc_next];
2551 /* store starting position */
2553 xfer->qh_pos = xfer->endpoint->isoc_next;
2557 panic("%s:%d: out of TD's\n",
2558 __FUNCTION__, __LINE__);
2560 if (pp_last >= &sc->sc_isoc_fs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT])
2561 pp_last = &sc->sc_isoc_fs_p_last[0];
2563 /* reuse sitd_portaddr and sitd_back from last transfer */
2565 if (*plen > xfer->max_frame_size) {
2569 printf("%s: frame length(%d) exceeds %d "
2570 "bytes (frame truncated)\n",
2571 __FUNCTION__, *plen,
2572 xfer->max_frame_size);
2575 *plen = xfer->max_frame_size;
2578 /* allocate a slot */
2580 sa = usbd_fs_isoc_schedule_alloc_slot(xfer,
2581 xfer->isoc_time_complete - nframes - 1);
2585 * Schedule is FULL, set length to zero:
2589 sa = USB_FS_ISOC_UFRAME_MAX - 1;
2593 * only call "usbd_get_page()" when we have a
2596 usbd_get_page(xfer->frbuffers, buf_offset, &buf_res);
2597 td->sitd_bp[0] = htohc32(sc, buf_res.physaddr);
2598 buf_offset += *plen;
2600 * NOTE: We need to subtract one from the offset so
2601 * that we are on a valid page!
2603 usbd_get_page(xfer->frbuffers, buf_offset - 1,
2605 temp = buf_res.physaddr & ~0xFFF;
2611 if (UE_GET_DIR(xfer->endpointno) == UE_DIR_OUT) {
2614 temp |= 1; /* T-count = 1, TP = ALL */
2619 temp |= tlen; /* T-count = [1..6] */
2620 temp |= 8; /* TP = Begin */
2632 sa = (sb - sa) & 0x3F;
2635 sb = (-(4 << sa)) & 0xFE;
2636 sa = (1 << sa) & 0x3F;
2639 sitd_mask = (EHCI_SITD_SET_SMASK(sa) |
2640 EHCI_SITD_SET_CMASK(sb));
2642 td->sitd_bp[1] = htohc32(sc, temp);
2644 td->sitd_mask = htohc32(sc, sitd_mask);
2647 td->sitd_status = htohc32(sc,
2650 EHCI_SITD_SET_LEN(*plen));
2652 td->sitd_status = htohc32(sc,
2654 EHCI_SITD_SET_LEN(*plen));
2656 usb_pc_cpu_flush(td->page_cache);
2659 if (ehcidebug > 15) {
2660 DPRINTF("FS-TD %d\n", nframes);
2661 ehci_dump_sitd(sc, td);
2664 /* insert TD into schedule */
2665 EHCI_APPEND_FS_TD(td, *pp_last);
2673 xfer->td_transfer_last = td_last;
2675 /* update isoc_next */
2676 xfer->endpoint->isoc_next = (pp_last - &sc->sc_isoc_fs_p_last[0]) &
2677 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2680 * We don't allow cancelling of the SPLIT transaction USB FULL
2681 * speed transfer, because it disturbs the bandwidth
2682 * computation algorithm.
2684 xfer->flags_int.can_cancel_immed = 0;
2688 ehci_device_isoc_fs_start(struct usb_xfer *xfer)
2691 * We don't allow cancelling of the SPLIT transaction USB FULL
2692 * speed transfer, because it disturbs the bandwidth
2693 * computation algorithm.
2695 xfer->flags_int.can_cancel_immed = 0;
2697 /* set a default timeout */
2698 if (xfer->timeout == 0)
2699 xfer->timeout = 500; /* ms */
2701 /* put transfer on interrupt queue */
2702 ehci_transfer_intr_enqueue(xfer);
2705 struct usb_pipe_methods ehci_device_isoc_fs_methods =
2707 .open = ehci_device_isoc_fs_open,
2708 .close = ehci_device_isoc_fs_close,
2709 .enter = ehci_device_isoc_fs_enter,
2710 .start = ehci_device_isoc_fs_start,
2713 /*------------------------------------------------------------------------*
2714 * ehci high speed isochronous support
2715 *------------------------------------------------------------------------*/
2717 ehci_device_isoc_hs_open(struct usb_xfer *xfer)
2719 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2724 usb_hs_bandwidth_alloc(xfer);
2726 /* initialize all TD's */
2728 for (ds = 0; ds != 2; ds++) {
2730 for (td = xfer->td_start[ds]; td; td = td->obj_next) {
2732 /* set TD inactive */
2733 td->itd_status[0] = 0;
2734 td->itd_status[1] = 0;
2735 td->itd_status[2] = 0;
2736 td->itd_status[3] = 0;
2737 td->itd_status[4] = 0;
2738 td->itd_status[5] = 0;
2739 td->itd_status[6] = 0;
2740 td->itd_status[7] = 0;
2742 /* set endpoint and address */
2743 td->itd_bp[0] = htohc32(sc,
2744 EHCI_ITD_SET_ADDR(xfer->address) |
2745 EHCI_ITD_SET_ENDPT(UE_GET_ADDR(xfer->endpointno)));
2748 EHCI_ITD_SET_MPL(xfer->max_packet_size & 0x7FF);
2751 if (UE_GET_DIR(xfer->endpointno) == UE_DIR_IN) {
2752 temp |= EHCI_ITD_SET_DIR_IN;
2754 /* set maximum packet size */
2755 td->itd_bp[1] = htohc32(sc, temp);
2757 /* set transfer multiplier */
2758 td->itd_bp[2] = htohc32(sc, xfer->max_packet_count & 3);
2760 usb_pc_cpu_flush(td->page_cache);
2766 ehci_device_isoc_hs_close(struct usb_xfer *xfer)
2768 ehci_device_done(xfer, USB_ERR_CANCELLED);
2770 /* bandwidth must be freed after device done */
2771 usb_hs_bandwidth_free(xfer);
2775 ehci_device_isoc_hs_enter(struct usb_xfer *xfer)
2777 struct usb_page_search buf_res;
2778 ehci_softc_t *sc = EHCI_BUS2SC(xfer->xroot->bus);
2780 ehci_itd_t *td_last = NULL;
2781 ehci_itd_t **pp_last;
2782 bus_size_t page_addr;
2785 uint32_t buf_offset;
2787 uint32_t itd_offset[8 + 1];
2791 uint8_t shift = usbd_xfer_get_fps_shift(xfer);
2798 DPRINTFN(6, "xfer=%p next=%d nframes=%d shift=%d\n",
2799 xfer, xfer->endpoint->isoc_next, xfer->nframes, (int)shift);
2801 /* get the current frame index */
2803 nframes = EOREAD4(sc, EHCI_FRINDEX) / 8;
2806 * check if the frame index is within the window where the frames
2809 buf_offset = (nframes - xfer->endpoint->isoc_next) &
2810 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2812 if ((xfer->endpoint->is_synced == 0) ||
2813 (buf_offset < (((xfer->nframes << shift) + 7) / 8))) {
2815 * If there is data underflow or the pipe queue is empty we
2816 * schedule the transfer a few frames ahead of the current
2817 * frame position. Else two isochronous transfers might
2820 xfer->endpoint->isoc_next = (nframes + 3) &
2821 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2822 xfer->endpoint->is_synced = 1;
2823 DPRINTFN(3, "start next=%d\n", xfer->endpoint->isoc_next);
2826 * compute how many milliseconds the insertion is ahead of the
2827 * current frame position:
2829 buf_offset = (xfer->endpoint->isoc_next - nframes) &
2830 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2833 * pre-compute when the isochronous transfer will be finished:
2835 xfer->isoc_time_complete =
2836 usb_isoc_time_expand(&sc->sc_bus, nframes) + buf_offset +
2837 (((xfer->nframes << shift) + 7) / 8);
2839 /* get the real number of frames */
2841 nframes = xfer->nframes;
2846 plen = xfer->frlengths;
2848 /* toggle the DMA set we are using */
2849 xfer->flags_int.curr_dma_set ^= 1;
2851 /* get next DMA set */
2852 td = xfer->td_start[xfer->flags_int.curr_dma_set];
2853 xfer->td_transfer_first = td;
2855 pp_last = &sc->sc_isoc_hs_p_last[xfer->endpoint->isoc_next];
2857 /* store starting position */
2859 xfer->qh_pos = xfer->endpoint->isoc_next;
2863 panic("%s:%d: out of TD's\n",
2864 __FUNCTION__, __LINE__);
2866 if (pp_last >= &sc->sc_isoc_hs_p_last[EHCI_VIRTUAL_FRAMELIST_COUNT]) {
2867 pp_last = &sc->sc_isoc_hs_p_last[0];
2870 if (*plen > xfer->max_frame_size) {
2874 printf("%s: frame length(%d) exceeds %d bytes "
2875 "(frame truncated)\n",
2876 __FUNCTION__, *plen, xfer->max_frame_size);
2879 *plen = xfer->max_frame_size;
2882 if (xfer->endpoint->usb_smask & (1 << td_no)) {
2883 status = (EHCI_ITD_SET_LEN(*plen) |
2885 EHCI_ITD_SET_PG(0));
2886 td->itd_status[td_no] = htohc32(sc, status);
2887 itd_offset[td_no] = buf_offset;
2888 buf_offset += *plen;
2892 td->itd_status[td_no] = 0; /* not active */
2893 itd_offset[td_no] = buf_offset;
2898 if ((td_no == 8) || (nframes == 0)) {
2900 /* the rest of the transfers are not active, if any */
2901 for (x = td_no; x != 8; x++) {
2902 td->itd_status[x] = 0; /* not active */
2905 /* check if there is any data to be transferred */
2906 if (itd_offset[0] != buf_offset) {
2908 itd_offset[td_no] = buf_offset;
2910 /* get first page offset */
2911 usbd_get_page(xfer->frbuffers, itd_offset[0], &buf_res);
2912 /* get page address */
2913 page_addr = buf_res.physaddr & ~0xFFF;
2914 /* update page address */
2915 td->itd_bp[0] &= htohc32(sc, 0xFFF);
2916 td->itd_bp[0] |= htohc32(sc, page_addr);
2918 for (x = 0; x != td_no; x++) {
2919 /* set page number and page offset */
2920 status = (EHCI_ITD_SET_PG(page_no) |
2921 (buf_res.physaddr & 0xFFF));
2922 td->itd_status[x] |= htohc32(sc, status);
2924 /* get next page offset */
2925 if (itd_offset[x + 1] == buf_offset) {
2927 * We subtract one so that
2928 * we don't go off the last
2931 usbd_get_page(xfer->frbuffers, buf_offset - 1, &buf_res);
2933 usbd_get_page(xfer->frbuffers, itd_offset[x + 1], &buf_res);
2936 /* check if we need a new page */
2937 if ((buf_res.physaddr ^ page_addr) & ~0xFFF) {
2938 /* new page needed */
2939 page_addr = buf_res.physaddr & ~0xFFF;
2941 panic("%s: too many pages\n", __FUNCTION__);
2944 /* update page address */
2945 td->itd_bp[page_no] &= htohc32(sc, 0xFFF);
2946 td->itd_bp[page_no] |= htohc32(sc, page_addr);
2950 /* set IOC bit if we are complete */
2952 td->itd_status[td_no - 1] |= htohc32(sc, EHCI_ITD_IOC);
2954 usb_pc_cpu_flush(td->page_cache);
2956 if (ehcidebug > 15) {
2957 DPRINTF("HS-TD %d\n", nframes);
2958 ehci_dump_itd(sc, td);
2961 /* insert TD into schedule */
2962 EHCI_APPEND_HS_TD(td, *pp_last);
2971 xfer->td_transfer_last = td_last;
2973 /* update isoc_next */
2974 xfer->endpoint->isoc_next = (pp_last - &sc->sc_isoc_hs_p_last[0]) &
2975 (EHCI_VIRTUAL_FRAMELIST_COUNT - 1);
2979 ehci_device_isoc_hs_start(struct usb_xfer *xfer)
2981 /* put transfer on interrupt queue */
2982 ehci_transfer_intr_enqueue(xfer);
2985 struct usb_pipe_methods ehci_device_isoc_hs_methods =
2987 .open = ehci_device_isoc_hs_open,
2988 .close = ehci_device_isoc_hs_close,
2989 .enter = ehci_device_isoc_hs_enter,
2990 .start = ehci_device_isoc_hs_start,
2993 /*------------------------------------------------------------------------*
2994 * ehci root control support
2995 *------------------------------------------------------------------------*
2996 * Simulate a hardware hub by handling all the necessary requests.
2997 *------------------------------------------------------------------------*/
3000 struct usb_device_descriptor ehci_devd =
3002 sizeof(struct usb_device_descriptor),
3003 UDESC_DEVICE, /* type */
3004 {0x00, 0x02}, /* USB version */
3005 UDCLASS_HUB, /* class */
3006 UDSUBCLASS_HUB, /* subclass */
3007 UDPROTO_HSHUBSTT, /* protocol */
3008 64, /* max packet */
3009 {0}, {0}, {0x00, 0x01}, /* device id */
3010 1, 2, 0, /* string indicies */
3011 1 /* # of configurations */
3015 struct usb_device_qualifier ehci_odevd =
3017 sizeof(struct usb_device_qualifier),
3018 UDESC_DEVICE_QUALIFIER, /* type */
3019 {0x00, 0x02}, /* USB version */
3020 UDCLASS_HUB, /* class */
3021 UDSUBCLASS_HUB, /* subclass */
3022 UDPROTO_FSHUB, /* protocol */
3024 0, /* # of configurations */
3028 static const struct ehci_config_desc ehci_confd = {
3030 .bLength = sizeof(struct usb_config_descriptor),
3031 .bDescriptorType = UDESC_CONFIG,
3032 .wTotalLength[0] = sizeof(ehci_confd),
3034 .bConfigurationValue = 1,
3035 .iConfiguration = 0,
3036 .bmAttributes = UC_SELF_POWERED,
3037 .bMaxPower = 0 /* max power */
3040 .bLength = sizeof(struct usb_interface_descriptor),
3041 .bDescriptorType = UDESC_INTERFACE,
3043 .bInterfaceClass = UICLASS_HUB,
3044 .bInterfaceSubClass = UISUBCLASS_HUB,
3045 .bInterfaceProtocol = 0,
3048 .bLength = sizeof(struct usb_endpoint_descriptor),
3049 .bDescriptorType = UDESC_ENDPOINT,
3050 .bEndpointAddress = UE_DIR_IN | EHCI_INTR_ENDPT,
3051 .bmAttributes = UE_INTERRUPT,
3052 .wMaxPacketSize[0] = 8, /* max packet (63 ports) */
3058 struct usb_hub_descriptor ehci_hubd =
3060 .bDescLength = 0, /* dynamic length */
3061 .bDescriptorType = UDESC_HUB,
3065 ehci_disown(ehci_softc_t *sc, uint16_t index, uint8_t lowspeed)
3070 DPRINTF("index=%d lowspeed=%d\n", index, lowspeed);
3072 port = EHCI_PORTSC(index);
3073 v = EOREAD4(sc, port) & ~EHCI_PS_CLEAR;
3074 EOWRITE4(sc, port, v | EHCI_PS_PO);
3078 ehci_roothub_exec(struct usb_device *udev,
3079 struct usb_device_request *req, const void **pptr, uint16_t *plength)
3081 ehci_softc_t *sc = EHCI_BUS2SC(udev->bus);
3082 const char *str_ptr;
3092 USB_BUS_LOCK_ASSERT(&sc->sc_bus, MA_OWNED);
3095 ptr = (const void *)&sc->sc_hub_desc;
3099 value = UGETW(req->wValue);
3100 index = UGETW(req->wIndex);
3102 DPRINTFN(3, "type=0x%02x request=0x%02x wLen=0x%04x "
3103 "wValue=0x%04x wIndex=0x%04x\n",
3104 req->bmRequestType, req->bRequest,
3105 UGETW(req->wLength), value, index);
3107 #define C(x,y) ((x) | ((y) << 8))
3108 switch (C(req->bRequest, req->bmRequestType)) {
3109 case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
3110 case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
3111 case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
3113 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
3114 * for the integrated root hub.
3117 case C(UR_GET_CONFIG, UT_READ_DEVICE):
3119 sc->sc_hub_desc.temp[0] = sc->sc_conf;
3121 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
3122 switch (value >> 8) {
3124 if ((value & 0xff) != 0) {
3125 err = USB_ERR_IOERROR;
3128 len = sizeof(ehci_devd);
3129 ptr = (const void *)&ehci_devd;
3132 * We can't really operate at another speed,
3133 * but the specification says we need this
3136 case UDESC_DEVICE_QUALIFIER:
3137 if ((value & 0xff) != 0) {
3138 err = USB_ERR_IOERROR;
3141 len = sizeof(ehci_odevd);
3142 ptr = (const void *)&ehci_odevd;
3146 if ((value & 0xff) != 0) {
3147 err = USB_ERR_IOERROR;
3150 len = sizeof(ehci_confd);
3151 ptr = (const void *)&ehci_confd;
3155 switch (value & 0xff) {
3156 case 0: /* Language table */
3160 case 1: /* Vendor */
3161 str_ptr = sc->sc_vendor;
3164 case 2: /* Product */
3165 str_ptr = "EHCI root HUB";
3173 len = usb_make_str_desc(
3174 sc->sc_hub_desc.temp,
3175 sizeof(sc->sc_hub_desc.temp),
3179 err = USB_ERR_IOERROR;
3183 case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
3185 sc->sc_hub_desc.temp[0] = 0;
3187 case C(UR_GET_STATUS, UT_READ_DEVICE):
3189 USETW(sc->sc_hub_desc.stat.wStatus, UDS_SELF_POWERED);
3191 case C(UR_GET_STATUS, UT_READ_INTERFACE):
3192 case C(UR_GET_STATUS, UT_READ_ENDPOINT):
3194 USETW(sc->sc_hub_desc.stat.wStatus, 0);
3196 case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
3197 if (value >= EHCI_MAX_DEVICES) {
3198 err = USB_ERR_IOERROR;
3201 sc->sc_addr = value;
3203 case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
3204 if ((value != 0) && (value != 1)) {
3205 err = USB_ERR_IOERROR;
3208 sc->sc_conf = value;
3210 case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
3212 case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
3213 case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
3214 case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
3215 err = USB_ERR_IOERROR;
3217 case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
3219 case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
3222 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
3224 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
3225 DPRINTFN(9, "UR_CLEAR_PORT_FEATURE\n");
3228 (index > sc->sc_noport)) {
3229 err = USB_ERR_IOERROR;
3232 port = EHCI_PORTSC(index);
3233 v = EOREAD4(sc, port) & ~EHCI_PS_CLEAR;
3235 case UHF_PORT_ENABLE:
3236 EOWRITE4(sc, port, v & ~EHCI_PS_PE);
3238 case UHF_PORT_SUSPEND:
3239 if ((v & EHCI_PS_SUSP) && (!(v & EHCI_PS_FPR))) {
3242 * waking up a High Speed device is rather
3245 EOWRITE4(sc, port, v | EHCI_PS_FPR);
3247 /* wait 20ms for resume sequence to complete */
3248 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 50);
3250 EOWRITE4(sc, port, v & ~(EHCI_PS_SUSP |
3251 EHCI_PS_FPR | (3 << 10) /* High Speed */ ));
3253 /* 4ms settle time */
3254 usb_pause_mtx(&sc->sc_bus.bus_mtx, hz / 250);
3256 case UHF_PORT_POWER:
3257 EOWRITE4(sc, port, v & ~EHCI_PS_PP);
3260 DPRINTFN(3, "clear port test "
3263 case UHF_PORT_INDICATOR:
3264 DPRINTFN(3, "clear port ind "
3266 EOWRITE4(sc, port, v & ~EHCI_PS_PIC);
3268 case UHF_C_PORT_CONNECTION:
3269 EOWRITE4(sc, port, v | EHCI_PS_CSC);
3271 case UHF_C_PORT_ENABLE:
3272 EOWRITE4(sc, port, v | EHCI_PS_PEC);
3274 case UHF_C_PORT_SUSPEND:
3275 EOWRITE4(sc, port, v | EHCI_PS_SUSP);
3277 case UHF_C_PORT_OVER_CURRENT:
3278 EOWRITE4(sc, port, v | EHCI_PS_OCC);
3280 case UHF_C_PORT_RESET:
3284 err = USB_ERR_IOERROR;
3288 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
3289 if ((value & 0xff) != 0) {
3290 err = USB_ERR_IOERROR;
3293 v = EREAD4(sc, EHCI_HCSPARAMS);
3295 sc->sc_hub_desc.hubd = ehci_hubd;
3296 sc->sc_hub_desc.hubd.bNbrPorts = sc->sc_noport;
3298 if (EHCI_HCS_PPC(v))
3299 i = UHD_PWR_INDIVIDUAL;
3301 i = UHD_PWR_NO_SWITCH;
3303 if (EHCI_HCS_P_INDICATOR(v))
3306 USETW(sc->sc_hub_desc.hubd.wHubCharacteristics, i);
3307 /* XXX can't find out? */
3308 sc->sc_hub_desc.hubd.bPwrOn2PwrGood = 200;
3309 /* XXX don't know if ports are removable or not */
3310 sc->sc_hub_desc.hubd.bDescLength =
3311 8 + ((sc->sc_noport + 7) / 8);
3312 len = sc->sc_hub_desc.hubd.bDescLength;
3314 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
3316 memset(sc->sc_hub_desc.temp, 0, 16);
3318 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
3319 DPRINTFN(9, "get port status i=%d\n",
3322 (index > sc->sc_noport)) {
3323 err = USB_ERR_IOERROR;
3326 v = EOREAD4(sc, EHCI_PORTSC(index));
3327 DPRINTFN(9, "port status=0x%04x\n", v);
3328 if (sc->sc_flags & (EHCI_SCFLG_FORCESPEED | EHCI_SCFLG_TT)) {
3329 if ((v & 0xc000000) == 0x8000000)
3331 else if ((v & 0xc000000) == 0x4000000)
3339 i |= UPS_CURRENT_CONNECT_STATUS;
3341 i |= UPS_PORT_ENABLED;
3342 if ((v & EHCI_PS_SUSP) && !(v & EHCI_PS_FPR))
3344 if (v & EHCI_PS_OCA)
3345 i |= UPS_OVERCURRENT_INDICATOR;
3349 i |= UPS_PORT_POWER;
3350 USETW(sc->sc_hub_desc.ps.wPortStatus, i);
3352 if (v & EHCI_PS_CSC)
3353 i |= UPS_C_CONNECT_STATUS;
3354 if (v & EHCI_PS_PEC)
3355 i |= UPS_C_PORT_ENABLED;
3356 if (v & EHCI_PS_OCC)
3357 i |= UPS_C_OVERCURRENT_INDICATOR;
3358 if (v & EHCI_PS_FPR)
3361 i |= UPS_C_PORT_RESET;
3362 USETW(sc->sc_hub_desc.ps.wPortChange, i);
3363 len = sizeof(sc->sc_hub_desc.ps);
3365 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
3366 err = USB_ERR_IOERROR;
3368 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
3370 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
3372 (index > sc->sc_noport)) {
3373 err = USB_ERR_IOERROR;
3376 port = EHCI_PORTSC(index);
3377 v = EOREAD4(sc, port) & ~EHCI_PS_CLEAR;
3379 case UHF_PORT_ENABLE:
3380 EOWRITE4(sc, port, v | EHCI_PS_PE);
3382 case UHF_PORT_SUSPEND:
3383 EOWRITE4(sc, port, v | EHCI_PS_SUSP);
3385 case UHF_PORT_RESET:
3386 DPRINTFN(6, "reset port %d\n", index);
3388 if (ehcinohighspeed) {
3390 * Connect USB device to companion
3393 ehci_disown(sc, index, 1);
3397 if (EHCI_PS_IS_LOWSPEED(v) &&
3398 (sc->sc_flags & EHCI_SCFLG_TT) == 0) {
3399 /* Low speed device, give up ownership. */
3400 ehci_disown(sc, index, 1);
3403 /* Start reset sequence. */
3404 v &= ~(EHCI_PS_PE | EHCI_PS_PR);
3405 EOWRITE4(sc, port, v | EHCI_PS_PR);
3407 /* Wait for reset to complete. */
3408 usb_pause_mtx(&sc->sc_bus.bus_mtx,
3409 USB_MS_TO_TICKS(usb_port_root_reset_delay));
3411 /* Terminate reset sequence. */
3412 if (!(sc->sc_flags & EHCI_SCFLG_NORESTERM))
3413 EOWRITE4(sc, port, v);
3415 /* Wait for HC to complete reset. */
3416 usb_pause_mtx(&sc->sc_bus.bus_mtx,
3417 USB_MS_TO_TICKS(EHCI_PORT_RESET_COMPLETE));
3419 v = EOREAD4(sc, port);
3420 DPRINTF("ehci after reset, status=0x%08x\n", v);
3421 if (v & EHCI_PS_PR) {
3422 device_printf(sc->sc_bus.bdev,
3423 "port reset timeout\n");
3424 err = USB_ERR_TIMEOUT;
3427 if (!(v & EHCI_PS_PE) &&
3428 (sc->sc_flags & EHCI_SCFLG_TT) == 0) {
3429 /* Not a high speed device, give up ownership.*/
3430 ehci_disown(sc, index, 0);
3434 DPRINTF("ehci port %d reset, status = 0x%08x\n",
3438 case UHF_PORT_POWER:
3439 DPRINTFN(3, "set port power %d\n", index);
3440 EOWRITE4(sc, port, v | EHCI_PS_PP);
3444 DPRINTFN(3, "set port test %d\n", index);
3447 case UHF_PORT_INDICATOR:
3448 DPRINTFN(3, "set port ind %d\n", index);
3449 EOWRITE4(sc, port, v | EHCI_PS_PIC);
3453 err = USB_ERR_IOERROR;
3457 case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER):
3458 case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER):
3459 case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER):
3460 case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER):
3463 err = USB_ERR_IOERROR;
3473 ehci_xfer_setup(struct usb_setup_params *parm)
3475 struct usb_page_search page_info;
3476 struct usb_page_cache *pc;
3478 struct usb_xfer *xfer;
3486 sc = EHCI_BUS2SC(parm->udev->bus);
3487 xfer = parm->curr_xfer;
3495 * compute maximum number of some structures
3497 if (parm->methods == &ehci_device_ctrl_methods) {
3500 * The proof for the "nqtd" formula is illustrated like
3503 * +------------------------------------+
3507 * | | xxx | x | frm 0 |
3509 * | | xxx | xx | frm 1 |
3512 * +------------------------------------+
3514 * "xxx" means a completely full USB transfer descriptor
3516 * "x" and "xx" means a short USB packet
3518 * For the remainder of an USB transfer modulo
3519 * "max_data_length" we need two USB transfer descriptors.
3520 * One to transfer the remaining data and one to finalise
3521 * with a zero length packet in case the "force_short_xfer"
3522 * flag is set. We only need two USB transfer descriptors in
3523 * the case where the transfer length of the first one is a
3524 * factor of "max_frame_size". The rest of the needed USB
3525 * transfer descriptors is given by the buffer size divided
3526 * by the maximum data payload.
3528 parm->hc_max_packet_size = 0x400;
3529 parm->hc_max_packet_count = 1;
3530 parm->hc_max_frame_size = EHCI_QTD_PAYLOAD_MAX;
3531 xfer->flags_int.bdma_enable = 1;
3533 usbd_transfer_setup_sub(parm);
3536 nqtd = ((2 * xfer->nframes) + 1 /* STATUS */
3537 + (xfer->max_data_length / xfer->max_hc_frame_size));
3539 } else if (parm->methods == &ehci_device_bulk_methods) {
3541 parm->hc_max_packet_size = 0x400;
3542 parm->hc_max_packet_count = 1;
3543 parm->hc_max_frame_size = EHCI_QTD_PAYLOAD_MAX;
3544 xfer->flags_int.bdma_enable = 1;
3546 usbd_transfer_setup_sub(parm);
3549 nqtd = ((2 * xfer->nframes)
3550 + (xfer->max_data_length / xfer->max_hc_frame_size));
3552 } else if (parm->methods == &ehci_device_intr_methods) {
3554 if (parm->speed == USB_SPEED_HIGH) {
3555 parm->hc_max_packet_size = 0x400;
3556 parm->hc_max_packet_count = 3;
3557 } else if (parm->speed == USB_SPEED_FULL) {
3558 parm->hc_max_packet_size = USB_FS_BYTES_PER_HS_UFRAME;
3559 parm->hc_max_packet_count = 1;
3561 parm->hc_max_packet_size = USB_FS_BYTES_PER_HS_UFRAME / 8;
3562 parm->hc_max_packet_count = 1;
3565 parm->hc_max_frame_size = EHCI_QTD_PAYLOAD_MAX;
3566 xfer->flags_int.bdma_enable = 1;
3568 usbd_transfer_setup_sub(parm);
3571 nqtd = ((2 * xfer->nframes)
3572 + (xfer->max_data_length / xfer->max_hc_frame_size));
3574 } else if (parm->methods == &ehci_device_isoc_fs_methods) {
3576 parm->hc_max_packet_size = 0x3FF;
3577 parm->hc_max_packet_count = 1;
3578 parm->hc_max_frame_size = 0x3FF;
3579 xfer->flags_int.bdma_enable = 1;
3581 usbd_transfer_setup_sub(parm);
3583 nsitd = xfer->nframes;
3585 } else if (parm->methods == &ehci_device_isoc_hs_methods) {
3587 parm->hc_max_packet_size = 0x400;
3588 parm->hc_max_packet_count = 3;
3589 parm->hc_max_frame_size = 0xC00;
3590 xfer->flags_int.bdma_enable = 1;
3592 usbd_transfer_setup_sub(parm);
3594 nitd = ((xfer->nframes + 7) / 8) <<
3595 usbd_xfer_get_fps_shift(xfer);
3599 parm->hc_max_packet_size = 0x400;
3600 parm->hc_max_packet_count = 1;
3601 parm->hc_max_frame_size = 0x400;
3603 usbd_transfer_setup_sub(parm);
3612 * Allocate queue heads and transfer descriptors
3616 if (usbd_transfer_setup_sub_malloc(
3617 parm, &pc, sizeof(ehci_itd_t),
3618 EHCI_ITD_ALIGN, nitd)) {
3619 parm->err = USB_ERR_NOMEM;
3623 for (n = 0; n != nitd; n++) {
3626 usbd_get_page(pc + n, 0, &page_info);
3628 td = page_info.buffer;
3631 td->itd_self = htohc32(sc, page_info.physaddr | EHCI_LINK_ITD);
3632 td->obj_next = last_obj;
3633 td->page_cache = pc + n;
3637 usb_pc_cpu_flush(pc + n);
3640 if (usbd_transfer_setup_sub_malloc(
3641 parm, &pc, sizeof(ehci_sitd_t),
3642 EHCI_SITD_ALIGN, nsitd)) {
3643 parm->err = USB_ERR_NOMEM;
3647 for (n = 0; n != nsitd; n++) {
3650 usbd_get_page(pc + n, 0, &page_info);
3652 td = page_info.buffer;
3655 td->sitd_self = htohc32(sc, page_info.physaddr | EHCI_LINK_SITD);
3656 td->obj_next = last_obj;
3657 td->page_cache = pc + n;
3661 usb_pc_cpu_flush(pc + n);
3664 if (usbd_transfer_setup_sub_malloc(
3665 parm, &pc, sizeof(ehci_qtd_t),
3666 EHCI_QTD_ALIGN, nqtd)) {
3667 parm->err = USB_ERR_NOMEM;
3671 for (n = 0; n != nqtd; n++) {
3674 usbd_get_page(pc + n, 0, &page_info);
3676 qtd = page_info.buffer;
3679 qtd->qtd_self = htohc32(sc, page_info.physaddr);
3680 qtd->obj_next = last_obj;
3681 qtd->page_cache = pc + n;
3685 usb_pc_cpu_flush(pc + n);
3688 xfer->td_start[xfer->flags_int.curr_dma_set] = last_obj;
3692 if (usbd_transfer_setup_sub_malloc(
3693 parm, &pc, sizeof(ehci_qh_t),
3694 EHCI_QH_ALIGN, nqh)) {
3695 parm->err = USB_ERR_NOMEM;
3699 for (n = 0; n != nqh; n++) {
3702 usbd_get_page(pc + n, 0, &page_info);
3704 qh = page_info.buffer;
3707 qh->qh_self = htohc32(sc, page_info.physaddr | EHCI_LINK_QH);
3708 qh->obj_next = last_obj;
3709 qh->page_cache = pc + n;
3713 usb_pc_cpu_flush(pc + n);
3716 xfer->qh_start[xfer->flags_int.curr_dma_set] = last_obj;
3718 if (!xfer->flags_int.curr_dma_set) {
3719 xfer->flags_int.curr_dma_set = 1;
3725 ehci_xfer_unsetup(struct usb_xfer *xfer)
3731 ehci_ep_init(struct usb_device *udev, struct usb_endpoint_descriptor *edesc,
3732 struct usb_endpoint *ep)
3734 ehci_softc_t *sc = EHCI_BUS2SC(udev->bus);
3736 DPRINTFN(2, "endpoint=%p, addr=%d, endpt=%d, mode=%d (%d)\n",
3738 edesc->bEndpointAddress, udev->flags.usb_mode,
3741 if (udev->device_index != sc->sc_addr) {
3743 if ((udev->speed != USB_SPEED_HIGH) &&
3744 ((udev->hs_hub_addr == 0) ||
3745 (udev->hs_port_no == 0) ||
3746 (udev->parent_hs_hub == NULL) ||
3747 (udev->parent_hs_hub->hub == NULL))) {
3748 /* We need a transaction translator */
3751 switch (edesc->bmAttributes & UE_XFERTYPE) {
3753 ep->methods = &ehci_device_ctrl_methods;
3756 ep->methods = &ehci_device_intr_methods;
3758 case UE_ISOCHRONOUS:
3759 if (udev->speed == USB_SPEED_HIGH) {
3760 ep->methods = &ehci_device_isoc_hs_methods;
3761 } else if (udev->speed == USB_SPEED_FULL) {
3762 ep->methods = &ehci_device_isoc_fs_methods;
3766 ep->methods = &ehci_device_bulk_methods;
3778 ehci_get_dma_delay(struct usb_device *udev, uint32_t *pus)
3781 * Wait until the hardware has finished any possible use of
3782 * the transfer descriptor(s) and QH
3784 *pus = (1125); /* microseconds */
3788 ehci_device_resume(struct usb_device *udev)
3790 ehci_softc_t *sc = EHCI_BUS2SC(udev->bus);
3791 struct usb_xfer *xfer;
3792 struct usb_pipe_methods *methods;
3796 USB_BUS_LOCK(udev->bus);
3798 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3800 if (xfer->xroot->udev == udev) {
3802 methods = xfer->endpoint->methods;
3804 if ((methods == &ehci_device_bulk_methods) ||
3805 (methods == &ehci_device_ctrl_methods)) {
3806 EHCI_APPEND_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
3807 sc->sc_async_p_last);
3809 if (methods == &ehci_device_intr_methods) {
3810 EHCI_APPEND_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
3811 sc->sc_intr_p_last[xfer->qh_pos]);
3816 USB_BUS_UNLOCK(udev->bus);
3822 ehci_device_suspend(struct usb_device *udev)
3824 ehci_softc_t *sc = EHCI_BUS2SC(udev->bus);
3825 struct usb_xfer *xfer;
3826 struct usb_pipe_methods *methods;
3830 USB_BUS_LOCK(udev->bus);
3832 TAILQ_FOREACH(xfer, &sc->sc_bus.intr_q.head, wait_entry) {
3834 if (xfer->xroot->udev == udev) {
3836 methods = xfer->endpoint->methods;
3838 if ((methods == &ehci_device_bulk_methods) ||
3839 (methods == &ehci_device_ctrl_methods)) {
3840 EHCI_REMOVE_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
3841 sc->sc_async_p_last);
3843 if (methods == &ehci_device_intr_methods) {
3844 EHCI_REMOVE_QH(xfer->qh_start[xfer->flags_int.curr_dma_set],
3845 sc->sc_intr_p_last[xfer->qh_pos]);
3850 USB_BUS_UNLOCK(udev->bus);
3854 ehci_set_hw_power_sleep(struct usb_bus *bus, uint32_t state)
3856 struct ehci_softc *sc = EHCI_BUS2SC(bus);
3859 case USB_HW_POWER_SUSPEND:
3860 case USB_HW_POWER_SHUTDOWN:
3863 case USB_HW_POWER_RESUME:
3872 ehci_set_hw_power(struct usb_bus *bus)
3874 ehci_softc_t *sc = EHCI_BUS2SC(bus);
3882 flags = bus->hw_power_state;
3884 temp = EOREAD4(sc, EHCI_USBCMD);
3886 temp &= ~(EHCI_CMD_ASE | EHCI_CMD_PSE);
3888 if (flags & (USB_HW_POWER_CONTROL |
3889 USB_HW_POWER_BULK)) {
3890 DPRINTF("Async is active\n");
3891 temp |= EHCI_CMD_ASE;
3893 if (flags & (USB_HW_POWER_INTERRUPT |
3894 USB_HW_POWER_ISOC)) {
3895 DPRINTF("Periodic is active\n");
3896 temp |= EHCI_CMD_PSE;
3898 EOWRITE4(sc, EHCI_USBCMD, temp);
3900 USB_BUS_UNLOCK(bus);
3905 struct usb_bus_methods ehci_bus_methods =
3907 .endpoint_init = ehci_ep_init,
3908 .xfer_setup = ehci_xfer_setup,
3909 .xfer_unsetup = ehci_xfer_unsetup,
3910 .get_dma_delay = ehci_get_dma_delay,
3911 .device_resume = ehci_device_resume,
3912 .device_suspend = ehci_device_suspend,
3913 .set_hw_power = ehci_set_hw_power,
3914 .set_hw_power_sleep = ehci_set_hw_power_sleep,
3915 .roothub_exec = ehci_roothub_exec,
3916 .xfer_poll = ehci_do_poll,