1 /* $NetBSD: ehci.c,v 1.91 2005/02/27 00:27:51 perry Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/ehci.c,v 1.36.2.3 2006/09/24 13:39:04 iedowse Exp $ */
3 /* $DragonFly: src/sys/bus/usb/ehci.c,v 1.28 2006/12/22 23:12:17 swildner Exp $ */
6 * Copyright (c) 2004 The NetBSD Foundation, Inc.
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Lennart Augustsson (lennart@augustsson.net) and by Charles M. Hannum.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
42 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
44 * The EHCI 1.0 spec can be found at
45 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
46 * and the USB 2.0 spec at
47 * http://www.usb.org/developers/docs/usb_20.zip
53 * 1) The EHCI driver lacks support for isochronous transfers, so
54 * devices using them don't work.
56 * 2) Interrupt transfer scheduling does not manage the time available
57 * in each frame, so it is possible for the transfers to overrun
58 * the end of the frame.
60 * 3) Command failures are not recovered correctly.
63 #include <sys/param.h>
64 #include <sys/systm.h>
65 #include <sys/malloc.h>
66 #include <sys/kernel.h>
67 #include <sys/endian.h>
68 #include <sys/module.h>
72 #include <sys/queue.h>
73 #include <sys/sysctl.h>
75 #include <sys/thread2.h>
78 #include <machine/cpu.h>
79 #include <machine/endian.h>
81 #include <bus/usb/usb.h>
82 #include <bus/usb/usbdi.h>
83 #include <bus/usb/usbdivar.h>
84 #include <bus/usb/usb_mem.h>
85 #include <bus/usb/usb_quirks.h>
87 #include <bus/usb/ehcireg.h>
88 #include <bus/usb/ehcivar.h>
90 #if defined(__FreeBSD__) || defined(__DragonFly__)
91 #define delay(d) DELAY(d)
95 #define EHCI_DEBUG USB_DEBUG
96 #define DPRINTF(x) do { if (ehcidebug) logprintf x; } while (0)
97 #define DPRINTFN(n,x) do { if (ehcidebug>(n)) logprintf x; } while (0)
99 SYSCTL_NODE(_hw_usb, OID_AUTO, ehci, CTLFLAG_RW, 0, "USB ehci");
100 SYSCTL_INT(_hw_usb_ehci, OID_AUTO, debug, CTLFLAG_RW,
101 &ehcidebug, 0, "ehci debug level");
103 #define bitmask_snprintf(q,f,b,l) ksnprintf((b), (l), "%b", (q), (f))
107 #define DPRINTFN(n,x)
111 struct usbd_pipe pipe;
115 ehci_soft_qtd_t *qtd;
116 /* ehci_soft_itd_t *itd; */
123 /*ehci_soft_qtd_t *setup, *data, *stat;*/
138 Static usbd_status ehci_open(usbd_pipe_handle);
139 Static void ehci_poll(struct usbd_bus *);
140 Static void ehci_softintr(void *);
141 Static int ehci_intr1(ehci_softc_t *);
142 Static void ehci_waitintr(ehci_softc_t *, usbd_xfer_handle);
143 Static void ehci_check_intr(ehci_softc_t *, struct ehci_xfer *);
144 Static void ehci_idone(struct ehci_xfer *);
145 Static void ehci_timeout(void *);
146 Static void ehci_timeout_task(void *);
147 Static void ehci_intrlist_timeout(void *);
149 Static usbd_status ehci_allocm(struct usbd_bus *, usb_dma_t *, u_int32_t);
150 Static void ehci_freem(struct usbd_bus *, usb_dma_t *);
152 Static usbd_xfer_handle ehci_allocx(struct usbd_bus *);
153 Static void ehci_freex(struct usbd_bus *, usbd_xfer_handle);
155 Static usbd_status ehci_root_ctrl_transfer(usbd_xfer_handle);
156 Static usbd_status ehci_root_ctrl_start(usbd_xfer_handle);
157 Static void ehci_root_ctrl_abort(usbd_xfer_handle);
158 Static void ehci_root_ctrl_close(usbd_pipe_handle);
159 Static void ehci_root_ctrl_done(usbd_xfer_handle);
161 Static usbd_status ehci_root_intr_transfer(usbd_xfer_handle);
162 Static usbd_status ehci_root_intr_start(usbd_xfer_handle);
163 Static void ehci_root_intr_abort(usbd_xfer_handle);
164 Static void ehci_root_intr_close(usbd_pipe_handle);
165 Static void ehci_root_intr_done(usbd_xfer_handle);
167 Static usbd_status ehci_device_ctrl_transfer(usbd_xfer_handle);
168 Static usbd_status ehci_device_ctrl_start(usbd_xfer_handle);
169 Static void ehci_device_ctrl_abort(usbd_xfer_handle);
170 Static void ehci_device_ctrl_close(usbd_pipe_handle);
171 Static void ehci_device_ctrl_done(usbd_xfer_handle);
173 Static usbd_status ehci_device_bulk_transfer(usbd_xfer_handle);
174 Static usbd_status ehci_device_bulk_start(usbd_xfer_handle);
175 Static void ehci_device_bulk_abort(usbd_xfer_handle);
176 Static void ehci_device_bulk_close(usbd_pipe_handle);
177 Static void ehci_device_bulk_done(usbd_xfer_handle);
179 Static usbd_status ehci_device_intr_transfer(usbd_xfer_handle);
180 Static usbd_status ehci_device_intr_start(usbd_xfer_handle);
181 Static void ehci_device_intr_abort(usbd_xfer_handle);
182 Static void ehci_device_intr_close(usbd_pipe_handle);
183 Static void ehci_device_intr_done(usbd_xfer_handle);
185 Static usbd_status ehci_device_isoc_transfer(usbd_xfer_handle);
186 Static usbd_status ehci_device_isoc_start(usbd_xfer_handle);
187 Static void ehci_device_isoc_abort(usbd_xfer_handle);
188 Static void ehci_device_isoc_close(usbd_pipe_handle);
189 Static void ehci_device_isoc_done(usbd_xfer_handle);
191 Static void ehci_device_clear_toggle(usbd_pipe_handle pipe);
192 Static void ehci_noop(usbd_pipe_handle pipe);
194 Static int ehci_str(usb_string_descriptor_t *, int, char *);
195 Static void ehci_pcd(ehci_softc_t *, usbd_xfer_handle);
196 Static void ehci_pcd_able(ehci_softc_t *, int);
197 Static void ehci_pcd_enable(void *);
198 Static void ehci_disown(ehci_softc_t *, int, int);
200 Static ehci_soft_qh_t *ehci_alloc_sqh(ehci_softc_t *);
201 Static void ehci_free_sqh(ehci_softc_t *, ehci_soft_qh_t *);
203 Static ehci_soft_qtd_t *ehci_alloc_sqtd(ehci_softc_t *);
204 Static void ehci_free_sqtd(ehci_softc_t *, ehci_soft_qtd_t *);
205 Static usbd_status ehci_alloc_sqtd_chain(struct ehci_pipe *,
206 ehci_softc_t *, int, int, usbd_xfer_handle,
207 ehci_soft_qtd_t **, ehci_soft_qtd_t **);
208 Static void ehci_free_sqtd_chain(ehci_softc_t *, ehci_soft_qtd_t *,
211 Static usbd_status ehci_device_request(usbd_xfer_handle xfer);
213 Static usbd_status ehci_device_setintr(ehci_softc_t *, ehci_soft_qh_t *,
216 Static void ehci_add_qh(ehci_soft_qh_t *, ehci_soft_qh_t *);
217 Static void ehci_rem_qh(ehci_softc_t *, ehci_soft_qh_t *,
219 Static void ehci_set_qh_qtd(ehci_soft_qh_t *, ehci_soft_qtd_t *);
220 Static void ehci_sync_hc(ehci_softc_t *);
222 Static void ehci_close_pipe(usbd_pipe_handle, ehci_soft_qh_t *);
223 Static void ehci_abort_xfer(usbd_xfer_handle, usbd_status);
226 Static void ehci_dump_regs(ehci_softc_t *);
227 void ehci_dump(void);
228 Static ehci_softc_t *theehci;
229 Static void ehci_dump_link(ehci_link_t, int);
230 Static void ehci_dump_sqtds(ehci_soft_qtd_t *);
231 Static void ehci_dump_sqtd(ehci_soft_qtd_t *);
232 Static void ehci_dump_qtd(ehci_qtd_t *);
233 Static void ehci_dump_sqh(ehci_soft_qh_t *);
235 Static void ehci_dump_exfer(struct ehci_xfer *);
239 #define EHCI_NULL htole32(EHCI_LINK_TERMINATE)
241 #define EHCI_INTR_ENDPT 1
243 #define ehci_add_intr_list(sc, ex) \
244 LIST_INSERT_HEAD(&(sc)->sc_intrhead, (ex), inext);
245 #define ehci_del_intr_list(ex) \
247 LIST_REMOVE((ex), inext); \
248 (ex)->inext.le_prev = NULL; \
250 #define ehci_active_intr_list(ex) ((ex)->inext.le_prev != NULL)
252 Static struct usbd_bus_methods ehci_bus_methods = {
262 Static struct usbd_pipe_methods ehci_root_ctrl_methods = {
263 ehci_root_ctrl_transfer,
264 ehci_root_ctrl_start,
265 ehci_root_ctrl_abort,
266 ehci_root_ctrl_close,
271 Static struct usbd_pipe_methods ehci_root_intr_methods = {
272 ehci_root_intr_transfer,
273 ehci_root_intr_start,
274 ehci_root_intr_abort,
275 ehci_root_intr_close,
280 Static struct usbd_pipe_methods ehci_device_ctrl_methods = {
281 ehci_device_ctrl_transfer,
282 ehci_device_ctrl_start,
283 ehci_device_ctrl_abort,
284 ehci_device_ctrl_close,
286 ehci_device_ctrl_done,
289 Static struct usbd_pipe_methods ehci_device_intr_methods = {
290 ehci_device_intr_transfer,
291 ehci_device_intr_start,
292 ehci_device_intr_abort,
293 ehci_device_intr_close,
294 ehci_device_clear_toggle,
295 ehci_device_intr_done,
298 Static struct usbd_pipe_methods ehci_device_bulk_methods = {
299 ehci_device_bulk_transfer,
300 ehci_device_bulk_start,
301 ehci_device_bulk_abort,
302 ehci_device_bulk_close,
303 ehci_device_clear_toggle,
304 ehci_device_bulk_done,
307 Static struct usbd_pipe_methods ehci_device_isoc_methods = {
308 ehci_device_isoc_transfer,
309 ehci_device_isoc_start,
310 ehci_device_isoc_abort,
311 ehci_device_isoc_close,
313 ehci_device_isoc_done,
317 ehci_init(ehci_softc_t *sc)
319 u_int32_t vers, sparams, cparams, hcr;
326 DPRINTF(("ehci_init: start\n"));
331 sc->sc_offs = EREAD1(sc, EHCI_CAPLENGTH);
333 vers = EREAD2(sc, EHCI_HCIVERSION);
334 kprintf("%s: EHCI version %x.%x\n", USBDEVNAME(sc->sc_bus.bdev),
335 vers >> 8, vers & 0xff);
337 sparams = EREAD4(sc, EHCI_HCSPARAMS);
338 DPRINTF(("ehci_init: sparams=0x%x\n", sparams));
339 sc->sc_npcomp = EHCI_HCS_N_PCC(sparams);
340 ncomp = EHCI_HCS_N_CC(sparams);
341 if (ncomp != sc->sc_ncomp) {
342 kprintf("%s: wrong number of companions (%d != %d)\n",
343 USBDEVNAME(sc->sc_bus.bdev),
344 ncomp, sc->sc_ncomp);
345 if (ncomp < sc->sc_ncomp)
346 sc->sc_ncomp = ncomp;
348 if (sc->sc_ncomp > 0) {
349 kprintf("%s: companion controller%s, %d port%s each:",
350 USBDEVNAME(sc->sc_bus.bdev), sc->sc_ncomp!=1 ? "s" : "",
351 EHCI_HCS_N_PCC(sparams),
352 EHCI_HCS_N_PCC(sparams)!=1 ? "s" : "");
353 for (i = 0; i < sc->sc_ncomp; i++)
354 kprintf(" %s", USBDEVNAME(sc->sc_comps[i]->bdev));
357 sc->sc_noport = EHCI_HCS_N_PORTS(sparams);
358 cparams = EREAD4(sc, EHCI_HCCPARAMS);
359 DPRINTF(("ehci_init: cparams=0x%x\n", cparams));
361 if (EHCI_HCC_64BIT(cparams)) {
362 /* MUST clear segment register if 64 bit capable. */
363 EWRITE4(sc, EHCI_CTRLDSSEGMENT, 0);
366 sc->sc_bus.usbrev = USBREV_2_0;
368 /* Reset the controller */
369 DPRINTF(("%s: resetting\n", USBDEVNAME(sc->sc_bus.bdev)));
370 EOWRITE4(sc, EHCI_USBCMD, 0); /* Halt controller */
371 usb_delay_ms(&sc->sc_bus, 1);
372 EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
373 for (i = 0; i < 100; i++) {
374 usb_delay_ms(&sc->sc_bus, 1);
375 hcr = EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_HCRESET;
380 kprintf("%s: reset timeout\n",
381 USBDEVNAME(sc->sc_bus.bdev));
382 return (USBD_IOERROR);
385 /* frame list size at default, read back what we got and use that */
386 switch (EHCI_CMD_FLS(EOREAD4(sc, EHCI_USBCMD))) {
387 case 0: sc->sc_flsize = 1024; break;
388 case 1: sc->sc_flsize = 512; break;
389 case 2: sc->sc_flsize = 256; break;
390 case 3: return (USBD_IOERROR);
392 err = usb_allocmem(&sc->sc_bus, sc->sc_flsize * sizeof(ehci_link_t),
393 EHCI_FLALIGN_ALIGN, &sc->sc_fldma);
396 DPRINTF(("%s: flsize=%d\n", USBDEVNAME(sc->sc_bus.bdev),sc->sc_flsize));
397 sc->sc_flist = KERNADDR(&sc->sc_fldma, 0);
398 EOWRITE4(sc, EHCI_PERIODICLISTBASE, DMAADDR(&sc->sc_fldma, 0));
400 /* Set up the bus struct. */
401 sc->sc_bus.methods = &ehci_bus_methods;
402 sc->sc_bus.pipe_size = sizeof(struct ehci_pipe);
404 #if defined(__NetBSD__) || defined(__OpenBSD__)
405 sc->sc_powerhook = powerhook_establish(ehci_power, sc);
406 sc->sc_shutdownhook = shutdownhook_establish(ehci_shutdown, sc);
409 sc->sc_eintrs = EHCI_NORMAL_INTRS;
412 * Allocate the interrupt dummy QHs. These are arranged to give
413 * poll intervals that are powers of 2 times 1ms.
415 for (i = 0; i < EHCI_INTRQHS; i++) {
416 sqh = ehci_alloc_sqh(sc);
421 sc->sc_islots[i].sqh = sqh;
424 for (i = 0; i < EHCI_INTRQHS; i++) {
425 if (i == EHCI_IQHIDX(lev + 1, 0))
427 sqh = sc->sc_islots[i].sqh;
429 /* The last (1ms) QH terminates. */
430 sqh->qh.qh_link = EHCI_NULL;
433 /* Otherwise the next QH has half the poll interval */
435 sc->sc_islots[EHCI_IQHIDX(lev - 1, i + 1)].sqh;
436 sqh->qh.qh_link = htole32(sqh->next->physaddr |
439 sqh->qh.qh_endp = htole32(EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH));
440 sqh->qh.qh_endphub = htole32(EHCI_QH_SET_MULT(1));
441 sqh->qh.qh_curqtd = EHCI_NULL;
442 sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
443 sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
444 sqh->qh.qh_qtd.qtd_status = htole32(EHCI_QTD_HALTED);
447 /* Point the frame list at the last level (128ms). */
448 for (i = 0; i < sc->sc_flsize; i++) {
449 sc->sc_flist[i] = htole32(EHCI_LINK_QH |
450 sc->sc_islots[EHCI_IQHIDX(EHCI_IPOLLRATES - 1,
454 /* Allocate dummy QH that starts the async list. */
455 sqh = ehci_alloc_sqh(sc);
462 htole32(EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH) | EHCI_QH_HRECL);
464 htole32(sqh->physaddr | EHCI_LINK_QH);
465 sqh->qh.qh_curqtd = EHCI_NULL;
466 sqh->prev = sqh; /*It's a circular list.. */
468 /* Fill the overlay qTD */
469 sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
470 sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
471 sqh->qh.qh_qtd.qtd_status = htole32(EHCI_QTD_HALTED);
479 /* Point to async list */
480 sc->sc_async_head = sqh;
481 EOWRITE4(sc, EHCI_ASYNCLISTADDR, sqh->physaddr | EHCI_LINK_QH);
483 usb_callout_init(sc->sc_tmo_pcd);
484 usb_callout_init(sc->sc_tmo_intrlist);
486 lockinit(&sc->sc_doorbell_lock, "ehcidb", 0, 0);
488 /* Enable interrupts */
489 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
491 /* Turn on controller */
492 EOWRITE4(sc, EHCI_USBCMD,
493 EHCI_CMD_ITC_2 | /* 2 microframes interrupt delay */
494 (EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_FLS_M) |
499 /* Take over port ownership */
500 EOWRITE4(sc, EHCI_CONFIGFLAG, EHCI_CONF_CF);
502 for (i = 0; i < 100; i++) {
503 usb_delay_ms(&sc->sc_bus, 1);
504 hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
509 kprintf("%s: run timeout\n", USBDEVNAME(sc->sc_bus.bdev));
510 return (USBD_IOERROR);
513 return (USBD_NORMAL_COMPLETION);
517 ehci_free_sqh(sc, sc->sc_async_head);
520 usb_freemem(&sc->sc_bus, &sc->sc_fldma);
527 ehci_softc_t *sc = v;
529 if (sc->sc_dying || (sc->sc_flags & EHCI_SCFLG_DONEINIT) == 0)
532 /* If we get an interrupt while polling, then just ignore it. */
533 if (sc->sc_bus.use_polling) {
534 u_int32_t intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
537 EOWRITE4(sc, EHCI_USBSTS, intrs); /* Acknowledge */
539 DPRINTFN(16, ("ehci_intr: ignored interrupt while polling\n"));
544 return (ehci_intr1(sc));
548 ehci_intr1(ehci_softc_t *sc)
550 u_int32_t intrs, eintrs;
552 DPRINTFN(20,("ehci_intr1: enter\n"));
554 intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
558 eintrs = intrs & sc->sc_eintrs;
559 DPRINTFN(7, ("ehci_intr1: sc=%p intrs=0x%x(0x%x) eintrs=0x%x\n",
560 sc, (u_int)intrs, EOREAD4(sc, EHCI_USBSTS),
565 EOWRITE4(sc, EHCI_USBSTS, intrs); /* Acknowledge */
566 sc->sc_bus.intr_context++;
567 sc->sc_bus.no_intrs++;
568 if (eintrs & EHCI_STS_IAA) {
569 DPRINTF(("ehci_intr1: door bell\n"));
570 wakeup(&sc->sc_async_head);
571 eintrs &= ~EHCI_STS_IAA;
573 if (eintrs & (EHCI_STS_INT | EHCI_STS_ERRINT)) {
574 DPRINTFN(5,("ehci_intr1: %s %s\n",
575 eintrs & EHCI_STS_INT ? "INT" : "",
576 eintrs & EHCI_STS_ERRINT ? "ERRINT" : ""));
577 usb_schedsoftintr(&sc->sc_bus);
578 eintrs &= ~(EHCI_STS_INT | EHCI_STS_ERRINT);
580 if (eintrs & EHCI_STS_HSE) {
581 kprintf("%s: unrecoverable error, controller halted\n",
582 USBDEVNAME(sc->sc_bus.bdev));
585 if (eintrs & EHCI_STS_PCD) {
586 ehci_pcd(sc, sc->sc_intrxfer);
588 * Disable PCD interrupt for now, because it will be
589 * on until the port has been reset.
591 ehci_pcd_able(sc, 0);
592 /* Do not allow RHSC interrupts > 1 per second */
593 usb_callout(sc->sc_tmo_pcd, hz, ehci_pcd_enable, sc);
594 eintrs &= ~EHCI_STS_PCD;
597 sc->sc_bus.intr_context--;
600 /* Block unprocessed interrupts. */
601 sc->sc_eintrs &= ~eintrs;
602 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
603 kprintf("%s: blocking intrs 0x%x\n",
604 USBDEVNAME(sc->sc_bus.bdev), eintrs);
611 ehci_pcd_able(ehci_softc_t *sc, int on)
613 DPRINTFN(4, ("ehci_pcd_able: on=%d\n", on));
615 sc->sc_eintrs |= EHCI_STS_PCD;
617 sc->sc_eintrs &= ~EHCI_STS_PCD;
618 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
622 ehci_pcd_enable(void *v_sc)
624 ehci_softc_t *sc = v_sc;
626 ehci_pcd_able(sc, 1);
630 ehci_pcd(ehci_softc_t *sc, usbd_xfer_handle xfer)
632 usbd_pipe_handle pipe;
637 /* Just ignore the change. */
643 p = KERNADDR(&xfer->dmabuf, 0);
644 m = min(sc->sc_noport, xfer->length * 8 - 1);
645 memset(p, 0, xfer->length);
646 for (i = 1; i <= m; i++) {
647 /* Pick out CHANGE bits from the status reg. */
648 if (EOREAD4(sc, EHCI_PORTSC(i)) & EHCI_PS_CLEAR)
649 p[i/8] |= 1 << (i%8);
651 DPRINTF(("ehci_pcd: change=0x%02x\n", *p));
652 xfer->actlen = xfer->length;
653 xfer->status = USBD_NORMAL_COMPLETION;
655 usb_transfer_complete(xfer);
659 ehci_softintr(void *v)
661 ehci_softc_t *sc = v;
662 struct ehci_xfer *ex, *nextex;
664 DPRINTFN(10,("%s: ehci_softintr (%d)\n", USBDEVNAME(sc->sc_bus.bdev),
665 sc->sc_bus.intr_context));
667 sc->sc_bus.intr_context++;
670 * The only explanation I can think of for why EHCI is as brain dead
671 * as UHCI interrupt-wise is that Intel was involved in both.
672 * An interrupt just tells us that something is done, we have no
673 * clue what, so we need to scan through all active transfers. :-(
675 for (ex = LIST_FIRST(&sc->sc_intrhead); ex; ex = nextex) {
676 nextex = LIST_NEXT(ex, inext);
677 ehci_check_intr(sc, ex);
680 /* Schedule a callout to catch any dropped transactions. */
681 if ((sc->sc_flags & EHCI_SCFLG_LOSTINTRBUG) &&
682 !LIST_EMPTY(&sc->sc_intrhead))
683 usb_callout(sc->sc_tmo_intrlist, hz / 5, ehci_intrlist_timeout,
686 #ifdef USB_USE_SOFTINTR
687 if (sc->sc_softwake) {
689 wakeup(&sc->sc_softwake);
691 #endif /* USB_USE_SOFTINTR */
693 sc->sc_bus.intr_context--;
696 /* Check for an interrupt. */
698 ehci_check_intr(ehci_softc_t *sc, struct ehci_xfer *ex)
700 ehci_soft_qtd_t *sqtd, *lsqtd;
703 DPRINTFN(/*15*/2, ("ehci_check_intr: ex=%p\n", ex));
705 if (ex->sqtdstart == NULL) {
706 kprintf("ehci_check_intr: sqtdstart=NULL\n");
712 kprintf("ehci_check_intr: lsqtd==0\n");
717 * If the last TD is still active we need to check whether there
718 * is a an error somewhere in the middle, or whether there was a
719 * short packet (SPD and not ACTIVE).
721 if (le32toh(lsqtd->qtd.qtd_status) & EHCI_QTD_ACTIVE) {
722 DPRINTFN(12, ("ehci_check_intr: active ex=%p\n", ex));
723 for (sqtd = ex->sqtdstart; sqtd != lsqtd; sqtd=sqtd->nextqtd) {
724 status = le32toh(sqtd->qtd.qtd_status);
725 /* If there's an active QTD the xfer isn't done. */
726 if (status & EHCI_QTD_ACTIVE)
728 /* Any kind of error makes the xfer done. */
729 if (status & EHCI_QTD_HALTED)
731 /* We want short packets, and it is short: it's done */
732 if (EHCI_QTD_GET_BYTES(status) != 0)
735 DPRINTFN(12, ("ehci_check_intr: ex=%p std=%p still active\n",
740 DPRINTFN(12, ("ehci_check_intr: ex=%p done\n", ex));
741 usb_uncallout(ex->xfer.timeout_handle, ehci_timeout, ex);
742 usb_rem_task(ex->xfer.pipe->device, &ex->abort_task);
747 ehci_idone(struct ehci_xfer *ex)
749 usbd_xfer_handle xfer = &ex->xfer;
751 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
753 ehci_soft_qtd_t *sqtd, *lsqtd;
754 u_int32_t status = 0, nstatus = 0;
757 DPRINTFN(/*12*/2, ("ehci_idone: ex=%p\n", ex));
764 kprintf("ehci_idone: ex is done!\n ");
767 kprintf("ehci_idone: ex=%p is done!\n", ex);
776 if (xfer->status == USBD_CANCELLED ||
777 xfer->status == USBD_TIMEOUT) {
778 DPRINTF(("ehci_idone: aborted xfer=%p\n", xfer));
783 DPRINTFN(/*10*/2, ("ehci_idone: xfer=%p, pipe=%p ready\n", xfer, epipe));
785 ehci_dump_sqtds(ex->sqtdstart);
788 /* The transfer is done, compute actual length and status. */
791 for (sqtd = ex->sqtdstart; sqtd != lsqtd->nextqtd; sqtd=sqtd->nextqtd) {
792 nstatus = le32toh(sqtd->qtd.qtd_status);
793 if (nstatus & EHCI_QTD_ACTIVE)
797 /* halt is ok if descriptor is last, and complete */
798 if (sqtd->qtd.qtd_next == EHCI_NULL &&
799 EHCI_QTD_GET_BYTES(status) == 0)
800 status &= ~EHCI_QTD_HALTED;
801 if (EHCI_QTD_GET_PID(status) != EHCI_QTD_PID_SETUP)
802 actlen += sqtd->len - EHCI_QTD_GET_BYTES(status);
805 cerr = EHCI_QTD_GET_CERR(status);
806 DPRINTFN(/*10*/2, ("ehci_idone: len=%d, actlen=%d, cerr=%d, "
807 "status=0x%x\n", xfer->length, actlen, cerr, status));
808 xfer->actlen = actlen;
809 if ((status & EHCI_QTD_HALTED) != 0) {
813 bitmask_snprintf((u_int32_t)status,
814 "\20\7HALTED\6BUFERR\5BABBLE\4XACTERR"
815 "\3MISSED\2SPLIT\1PING", sbuf, sizeof(sbuf));
818 ("ehci_idone: error, addr=%d, endpt=0x%02x, "
820 xfer->pipe->device->address,
821 xfer->pipe->endpoint->edesc->bEndpointAddress,
824 ehci_dump_sqh(epipe->sqh);
825 ehci_dump_sqtds(ex->sqtdstart);
828 if ((status & EHCI_QTD_BABBLE) == 0 && cerr > 0)
829 xfer->status = USBD_STALLED;
831 xfer->status = USBD_IOERROR; /* more info XXX */
833 xfer->status = USBD_NORMAL_COMPLETION;
836 usb_transfer_complete(xfer);
837 DPRINTFN(/*12*/2, ("ehci_idone: ex=%p done\n", ex));
841 * Wait here until controller claims to have an interrupt.
842 * Then call ehci_intr and return. Use timeout to avoid waiting
846 ehci_waitintr(ehci_softc_t *sc, usbd_xfer_handle xfer)
848 int timo = xfer->timeout;
852 xfer->status = USBD_IN_PROGRESS;
853 for (usecs = timo * 1000000 / hz; usecs > 0; usecs -= 1000) {
854 usb_delay_ms(&sc->sc_bus, 1);
857 intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS)) &
859 DPRINTFN(15,("ehci_waitintr: 0x%04x\n", intrs));
866 if (xfer->status != USBD_IN_PROGRESS)
872 DPRINTF(("ehci_waitintr: timeout\n"));
873 xfer->status = USBD_TIMEOUT;
874 usb_transfer_complete(xfer);
875 /* XXX should free TD */
879 ehci_poll(struct usbd_bus *bus)
881 ehci_softc_t *sc = (ehci_softc_t *)bus;
885 new = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
887 DPRINTFN(10,("ehci_poll: intrs=0x%04x\n", new));
892 if (EOREAD4(sc, EHCI_USBSTS) & sc->sc_eintrs)
897 ehci_detach(struct ehci_softc *sc, int flags)
901 #if defined(__NetBSD__) || defined(__OpenBSD__)
902 if (sc->sc_child != NULL)
903 rv = config_detach(sc->sc_child, flags);
911 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
912 EOWRITE4(sc, EHCI_USBCMD, 0);
913 EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
914 usb_uncallout(sc->sc_tmo_intrlist, ehci_intrlist_timeout, sc);
915 usb_uncallout(sc->sc_tmo_pcd, ehci_pcd_enable, sc);
917 #if defined(__NetBSD__) || defined(__OpenBSD__)
918 if (sc->sc_powerhook != NULL)
919 powerhook_disestablish(sc->sc_powerhook);
920 if (sc->sc_shutdownhook != NULL)
921 shutdownhook_disestablish(sc->sc_shutdownhook);
924 usb_delay_ms(&sc->sc_bus, 300); /* XXX let stray task complete */
926 usb_freemem(&sc->sc_bus, &sc->sc_fldma);
927 /* XXX free other data structures XXX */
932 #if defined(__NetBSD__) || defined(__OpenBSD__)
934 ehci_activate(device_ptr_t self, enum devact act)
936 struct ehci_softc *sc = (struct ehci_softc *)self;
943 case DVACT_DEACTIVATE:
944 if (sc->sc_child != NULL)
945 rv = config_deactivate(sc->sc_child);
954 * Handle suspend/resume.
956 * We need to switch to polling mode here, because this routine is
957 * called from an interrupt context. This is all right since we
958 * are almost suspended anyway.
961 ehci_power(int why, void *v)
963 ehci_softc_t *sc = v;
968 DPRINTF(("ehci_power: sc=%p, why=%d\n", sc, why));
977 #if defined(__NetBSD__) || defined(__OpenBSD__)
980 sc->sc_bus.use_polling++;
982 for (i = 1; i <= sc->sc_noport; i++) {
983 cmd = EOREAD4(sc, EHCI_PORTSC(i));
984 if ((cmd & EHCI_PS_PO) == 0 &&
985 (cmd & EHCI_PS_PE) == EHCI_PS_PE)
986 EOWRITE4(sc, EHCI_PORTSC(i),
990 sc->sc_cmd = EOREAD4(sc, EHCI_USBCMD);
992 cmd = sc->sc_cmd & ~(EHCI_CMD_ASE | EHCI_CMD_PSE);
993 EOWRITE4(sc, EHCI_USBCMD, cmd);
995 for (i = 0; i < 100; i++) {
996 hcr = EOREAD4(sc, EHCI_USBSTS) &
997 (EHCI_STS_ASS | EHCI_STS_PSS);
1001 usb_delay_ms(&sc->sc_bus, 1);
1004 kprintf("%s: reset timeout\n",
1005 USBDEVNAME(sc->sc_bus.bdev));
1008 cmd &= ~EHCI_CMD_RS;
1009 EOWRITE4(sc, EHCI_USBCMD, cmd);
1011 for (i = 0; i < 100; i++) {
1012 hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
1013 if (hcr == EHCI_STS_HCH)
1016 usb_delay_ms(&sc->sc_bus, 1);
1018 if (hcr != EHCI_STS_HCH) {
1019 kprintf("%s: config timeout\n",
1020 USBDEVNAME(sc->sc_bus.bdev));
1023 sc->sc_bus.use_polling--;
1027 sc->sc_bus.use_polling++;
1029 /* restore things in case the bios sucks */
1030 EOWRITE4(sc, EHCI_CTRLDSSEGMENT, 0);
1031 EOWRITE4(sc, EHCI_PERIODICLISTBASE, DMAADDR(&sc->sc_fldma, 0));
1032 EOWRITE4(sc, EHCI_ASYNCLISTADDR,
1033 sc->sc_async_head->physaddr | EHCI_LINK_QH);
1034 EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
1037 for (i = 1; i <= sc->sc_noport; i++) {
1038 cmd = EOREAD4(sc, EHCI_PORTSC(i));
1039 if ((cmd & EHCI_PS_PO) == 0 &&
1040 (cmd & EHCI_PS_SUSP) == EHCI_PS_SUSP) {
1041 EOWRITE4(sc, EHCI_PORTSC(i),
1048 usb_delay_ms(&sc->sc_bus, USB_RESUME_WAIT);
1050 for (i = 1; i <= sc->sc_noport; i++) {
1051 cmd = EOREAD4(sc, EHCI_PORTSC(i));
1052 if ((cmd & EHCI_PS_PO) == 0 &&
1053 (cmd & EHCI_PS_SUSP) == EHCI_PS_SUSP)
1054 EOWRITE4(sc, EHCI_PORTSC(i),
1055 cmd & ~EHCI_PS_FPR);
1059 EOWRITE4(sc, EHCI_USBCMD, sc->sc_cmd);
1061 for (i = 0; i < 100; i++) {
1062 hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
1063 if (hcr != EHCI_STS_HCH)
1066 usb_delay_ms(&sc->sc_bus, 1);
1068 if (hcr == EHCI_STS_HCH) {
1069 kprintf("%s: config timeout\n",
1070 USBDEVNAME(sc->sc_bus.bdev));
1073 usb_delay_ms(&sc->sc_bus, USB_RESUME_WAIT);
1075 sc->sc_bus.use_polling--;
1077 #if defined(__NetBSD__) || defined(__OpenBSD__)
1078 case PWR_SOFTSUSPEND:
1079 case PWR_SOFTSTANDBY:
1080 case PWR_SOFTRESUME:
1087 DPRINTF(("ehci_power: sc=%p\n", sc));
1094 * Shut down the controller when the system is going down.
1097 ehci_shutdown(void *v)
1099 ehci_softc_t *sc = v;
1101 DPRINTF(("ehci_shutdown: stopping the HC\n"));
1102 EOWRITE4(sc, EHCI_USBCMD, 0); /* Halt controller */
1103 EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
1107 ehci_allocm(struct usbd_bus *bus, usb_dma_t *dma, u_int32_t size)
1111 err = usb_allocmem(bus, size, 0, dma);
1114 kprintf("ehci_allocm: usb_allocmem()=%d\n", err);
1120 ehci_freem(struct usbd_bus *bus, usb_dma_t *dma)
1122 usb_freemem(bus, dma);
1126 ehci_allocx(struct usbd_bus *bus)
1128 struct ehci_softc *sc = (struct ehci_softc *)bus;
1129 usbd_xfer_handle xfer;
1131 xfer = SIMPLEQ_FIRST(&sc->sc_free_xfers);
1133 SIMPLEQ_REMOVE_HEAD(&sc->sc_free_xfers, next);
1135 if (xfer->busy_free != XFER_FREE) {
1136 kprintf("ehci_allocx: xfer=%p not free, 0x%08x\n", xfer,
1141 xfer = kmalloc(sizeof(struct ehci_xfer), M_USB, M_INTWAIT);
1144 memset(xfer, 0, sizeof(struct ehci_xfer));
1145 usb_init_task(&EXFER(xfer)->abort_task, ehci_timeout_task,
1147 EXFER(xfer)->ehci_xfer_flags = 0;
1149 EXFER(xfer)->isdone = 1;
1150 xfer->busy_free = XFER_BUSY;
1157 ehci_freex(struct usbd_bus *bus, usbd_xfer_handle xfer)
1159 struct ehci_softc *sc = (struct ehci_softc *)bus;
1162 if (xfer->busy_free != XFER_BUSY) {
1163 kprintf("ehci_freex: xfer=%p not busy, 0x%08x\n", xfer,
1167 xfer->busy_free = XFER_FREE;
1168 if (!EXFER(xfer)->isdone) {
1169 kprintf("ehci_freex: !isdone\n");
1173 SIMPLEQ_INSERT_HEAD(&sc->sc_free_xfers, xfer, next);
1177 ehci_device_clear_toggle(usbd_pipe_handle pipe)
1179 struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
1181 DPRINTF(("ehci_device_clear_toggle: epipe=%p status=0x%x\n",
1182 epipe, epipe->sqh->qh.qh_qtd.qtd_status));
1185 usbd_dump_pipe(pipe);
1187 KASSERT((epipe->sqh->qh.qh_qtd.qtd_status &
1188 htole32(EHCI_QTD_ACTIVE)) == 0,
1189 ("ehci_device_clear_toggle: queue active"));
1190 epipe->sqh->qh.qh_qtd.qtd_status &= htole32(~EHCI_QTD_TOGGLE_MASK);
1194 ehci_noop(usbd_pipe_handle pipe)
1200 ehci_dump_regs(ehci_softc_t *sc)
1203 kprintf("cmd=0x%08x, sts=0x%08x, ien=0x%08x\n",
1204 EOREAD4(sc, EHCI_USBCMD),
1205 EOREAD4(sc, EHCI_USBSTS),
1206 EOREAD4(sc, EHCI_USBINTR));
1207 kprintf("frindex=0x%08x ctrdsegm=0x%08x periodic=0x%08x async=0x%08x\n",
1208 EOREAD4(sc, EHCI_FRINDEX),
1209 EOREAD4(sc, EHCI_CTRLDSSEGMENT),
1210 EOREAD4(sc, EHCI_PERIODICLISTBASE),
1211 EOREAD4(sc, EHCI_ASYNCLISTADDR));
1212 for (i = 1; i <= sc->sc_noport; i++)
1213 kprintf("port %d status=0x%08x\n", i,
1214 EOREAD4(sc, EHCI_PORTSC(i)));
1218 * Unused function - this is meant to be called from a kernel
1224 ehci_dump_regs(theehci);
1228 ehci_dump_link(ehci_link_t link, int type)
1230 link = le32toh(link);
1231 kprintf("0x%08x", link);
1232 if (link & EHCI_LINK_TERMINATE)
1237 switch (EHCI_LINK_TYPE(link)) {
1238 case EHCI_LINK_ITD: kprintf("ITD"); break;
1239 case EHCI_LINK_QH: kprintf("QH"); break;
1240 case EHCI_LINK_SITD: kprintf("SITD"); break;
1241 case EHCI_LINK_FSTN: kprintf("FSTN"); break;
1249 ehci_dump_sqtds(ehci_soft_qtd_t *sqtd)
1255 for (i = 0; sqtd && i < 20 && !stop; sqtd = sqtd->nextqtd, i++) {
1256 ehci_dump_sqtd(sqtd);
1257 stop = sqtd->qtd.qtd_next & htole32(EHCI_LINK_TERMINATE);
1260 kprintf("dump aborted, too many TDs\n");
1264 ehci_dump_sqtd(ehci_soft_qtd_t *sqtd)
1266 kprintf("QTD(%p) at 0x%08x:\n", sqtd, sqtd->physaddr);
1267 ehci_dump_qtd(&sqtd->qtd);
1271 ehci_dump_qtd(ehci_qtd_t *qtd)
1276 kprintf(" next="); ehci_dump_link(qtd->qtd_next, 0);
1277 kprintf(" altnext="); ehci_dump_link(qtd->qtd_altnext, 0);
1279 s = le32toh(qtd->qtd_status);
1280 bitmask_snprintf(EHCI_QTD_GET_STATUS(s),
1281 "\20\10ACTIVE\7HALTED\6BUFERR\5BABBLE\4XACTERR"
1282 "\3MISSED\2SPLIT\1PING", sbuf, sizeof(sbuf));
1283 kprintf(" status=0x%08x: toggle=%d bytes=0x%x ioc=%d c_page=0x%x\n",
1284 s, EHCI_QTD_GET_TOGGLE(s), EHCI_QTD_GET_BYTES(s),
1285 EHCI_QTD_GET_IOC(s), EHCI_QTD_GET_C_PAGE(s));
1286 kprintf(" cerr=%d pid=%d stat=0x%s\n", EHCI_QTD_GET_CERR(s),
1287 EHCI_QTD_GET_PID(s), sbuf);
1288 for (s = 0; s < 5; s++)
1289 kprintf(" buffer[%d]=0x%08x\n", s, le32toh(qtd->qtd_buffer[s]));
1293 ehci_dump_sqh(ehci_soft_qh_t *sqh)
1295 ehci_qh_t *qh = &sqh->qh;
1296 u_int32_t endp, endphub;
1298 kprintf("QH(%p) at 0x%08x:\n", sqh, sqh->physaddr);
1299 kprintf(" link="); ehci_dump_link(qh->qh_link, 1); kprintf("\n");
1300 endp = le32toh(qh->qh_endp);
1301 kprintf(" endp=0x%08x\n", endp);
1302 kprintf(" addr=0x%02x inact=%d endpt=%d eps=%d dtc=%d hrecl=%d\n",
1303 EHCI_QH_GET_ADDR(endp), EHCI_QH_GET_INACT(endp),
1304 EHCI_QH_GET_ENDPT(endp), EHCI_QH_GET_EPS(endp),
1305 EHCI_QH_GET_DTC(endp), EHCI_QH_GET_HRECL(endp));
1306 kprintf(" mpl=0x%x ctl=%d nrl=%d\n",
1307 EHCI_QH_GET_MPL(endp), EHCI_QH_GET_CTL(endp),
1308 EHCI_QH_GET_NRL(endp));
1309 endphub = le32toh(qh->qh_endphub);
1310 kprintf(" endphub=0x%08x\n", endphub);
1311 kprintf(" smask=0x%02x cmask=0x%02x huba=0x%02x port=%d mult=%d\n",
1312 EHCI_QH_GET_SMASK(endphub), EHCI_QH_GET_CMASK(endphub),
1313 EHCI_QH_GET_HUBA(endphub), EHCI_QH_GET_PORT(endphub),
1314 EHCI_QH_GET_MULT(endphub));
1315 kprintf(" curqtd="); ehci_dump_link(qh->qh_curqtd, 0); kprintf("\n");
1316 kprintf("Overlay qTD:\n");
1317 ehci_dump_qtd(&qh->qh_qtd);
1322 ehci_dump_exfer(struct ehci_xfer *ex)
1324 kprintf("ehci_dump_exfer: ex=%p\n", ex);
1330 ehci_open(usbd_pipe_handle pipe)
1332 usbd_device_handle dev = pipe->device;
1333 ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
1334 usb_endpoint_descriptor_t *ed = pipe->endpoint->edesc;
1335 u_int8_t addr = dev->address;
1336 u_int8_t xfertype = ed->bmAttributes & UE_XFERTYPE;
1337 struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
1338 ehci_soft_qh_t *sqh;
1340 int ival, speed, naks;
1341 int hshubaddr, hshubport;
1343 DPRINTFN(1, ("ehci_open: pipe=%p, addr=%d, endpt=%d (%d)\n",
1344 pipe, addr, ed->bEndpointAddress, sc->sc_addr));
1346 if (dev->myhsport) {
1347 hshubaddr = dev->myhsport->parent->address;
1348 hshubport = dev->myhsport->portno;
1355 return (USBD_IOERROR);
1357 if (addr == sc->sc_addr) {
1358 switch (ed->bEndpointAddress) {
1359 case USB_CONTROL_ENDPOINT:
1360 pipe->methods = &ehci_root_ctrl_methods;
1362 case UE_DIR_IN | EHCI_INTR_ENDPT:
1363 pipe->methods = &ehci_root_intr_methods;
1366 return (USBD_INVAL);
1368 return (USBD_NORMAL_COMPLETION);
1371 /* XXX All this stuff is only valid for async. */
1372 switch (dev->speed) {
1373 case USB_SPEED_LOW: speed = EHCI_QH_SPEED_LOW; break;
1374 case USB_SPEED_FULL: speed = EHCI_QH_SPEED_FULL; break;
1375 case USB_SPEED_HIGH: speed = EHCI_QH_SPEED_HIGH; break;
1376 default: panic("ehci_open: bad device speed %d", dev->speed);
1378 if (speed != EHCI_QH_SPEED_HIGH && xfertype == UE_ISOCHRONOUS) {
1379 kprintf("%s: *** WARNING: opening low/full speed device, this "
1380 "does not work yet.\n",
1381 USBDEVNAME(sc->sc_bus.bdev));
1382 DPRINTFN(1,("ehci_open: hshubaddr=%d hshubport=%d\n",
1383 hshubaddr, hshubport));
1388 sqh = ehci_alloc_sqh(sc);
1391 /* qh_link filled when the QH is added */
1392 sqh->qh.qh_endp = htole32(
1393 EHCI_QH_SET_ADDR(addr) |
1394 EHCI_QH_SET_ENDPT(UE_GET_ADDR(ed->bEndpointAddress)) |
1395 EHCI_QH_SET_EPS(speed) |
1396 (xfertype == UE_CONTROL ? EHCI_QH_DTC : 0) |
1397 EHCI_QH_SET_MPL(UGETW(ed->wMaxPacketSize)) |
1398 (speed != EHCI_QH_SPEED_HIGH && xfertype == UE_CONTROL ?
1400 EHCI_QH_SET_NRL(naks)
1402 sqh->qh.qh_endphub = htole32(
1403 EHCI_QH_SET_MULT(1) |
1404 EHCI_QH_SET_HUBA(hshubaddr) |
1405 EHCI_QH_SET_PORT(hshubport) |
1406 EHCI_QH_SET_CMASK(0x1c) |
1407 EHCI_QH_SET_SMASK(xfertype == UE_INTERRUPT ? 0x01 : 0)
1409 sqh->qh.qh_curqtd = EHCI_NULL;
1410 /* Fill the overlay qTD */
1411 sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
1412 sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
1413 sqh->qh.qh_qtd.qtd_status =
1414 htole32(EHCI_QTD_SET_TOGGLE(pipe->endpoint->savedtoggle));
1420 err = usb_allocmem(&sc->sc_bus, sizeof(usb_device_request_t),
1421 0, &epipe->u.ctl.reqdma);
1424 kprintf("ehci_open: usb_allocmem()=%d\n", err);
1428 pipe->methods = &ehci_device_ctrl_methods;
1430 ehci_add_qh(sqh, sc->sc_async_head);
1434 pipe->methods = &ehci_device_bulk_methods;
1436 ehci_add_qh(sqh, sc->sc_async_head);
1440 pipe->methods = &ehci_device_intr_methods;
1441 ival = pipe->interval;
1442 if (ival == USBD_DEFAULT_INTERVAL)
1443 ival = ed->bInterval;
1444 return (ehci_device_setintr(sc, sqh, ival));
1445 case UE_ISOCHRONOUS:
1446 pipe->methods = &ehci_device_isoc_methods;
1447 return (USBD_INVAL);
1449 return (USBD_INVAL);
1451 return (USBD_NORMAL_COMPLETION);
1454 ehci_free_sqh(sc, sqh);
1456 return (USBD_NOMEM);
1460 * Add an ED to the schedule. Called while in a critical section.
1461 * If in the async schedule, it will always have a next.
1462 * If in the intr schedule it may not.
1465 ehci_add_qh(ehci_soft_qh_t *sqh, ehci_soft_qh_t *head)
1467 sqh->next = head->next;
1469 sqh->qh.qh_link = head->qh.qh_link;
1472 sqh->next->prev = sqh;
1473 head->qh.qh_link = htole32(sqh->physaddr | EHCI_LINK_QH);
1476 if (ehcidebug > 5) {
1477 kprintf("ehci_add_qh:\n");
1484 * Remove an ED from the schedule. Called while in a critical section.
1485 * Will always have a 'next' if it's in the async list as it's circular.
1488 ehci_rem_qh(ehci_softc_t *sc, ehci_soft_qh_t *sqh, ehci_soft_qh_t *head)
1491 sqh->prev->qh.qh_link = sqh->qh.qh_link;
1492 sqh->prev->next = sqh->next;
1494 sqh->next->prev = sqh->prev;
1499 ehci_set_qh_qtd(ehci_soft_qh_t *sqh, ehci_soft_qtd_t *sqtd)
1504 /* Save toggle bit and ping status. */
1505 status = sqh->qh.qh_qtd.qtd_status &
1506 htole32(EHCI_QTD_TOGGLE_MASK |
1507 EHCI_QTD_SET_STATUS(EHCI_QTD_PINGSTATE));
1508 /* Set HALTED to make hw leave it alone. */
1509 sqh->qh.qh_qtd.qtd_status =
1510 htole32(EHCI_QTD_SET_STATUS(EHCI_QTD_HALTED));
1511 sqh->qh.qh_curqtd = 0;
1512 sqh->qh.qh_qtd.qtd_next = htole32(sqtd->physaddr);
1513 sqh->qh.qh_qtd.qtd_altnext = 0;
1514 for (i = 0; i < EHCI_QTD_NBUFFERS; i++)
1515 sqh->qh.qh_qtd.qtd_buffer[i] = 0;
1517 /* Set !HALTED && !ACTIVE to start execution, preserve some fields */
1518 sqh->qh.qh_qtd.qtd_status = status;
1522 * Ensure that the HC has released all references to the QH. We do this
1523 * by asking for a Async Advance Doorbell interrupt and then we wait for
1525 * To make this easier we first obtain exclusive use of the doorbell.
1528 ehci_sync_hc(ehci_softc_t *sc)
1533 DPRINTFN(2,("ehci_sync_hc: dying\n"));
1536 DPRINTFN(2,("ehci_sync_hc: enter\n"));
1538 lockmgr(&sc->sc_doorbell_lock, LK_EXCLUSIVE);
1540 /* ask for doorbell */
1541 EOWRITE4(sc, EHCI_USBCMD, EOREAD4(sc, EHCI_USBCMD) | EHCI_CMD_IAAD);
1542 DPRINTFN(1,("ehci_sync_hc: cmd=0x%08x sts=0x%08x\n",
1543 EOREAD4(sc, EHCI_USBCMD), EOREAD4(sc, EHCI_USBSTS)));
1544 error = tsleep(&sc->sc_async_head, 0, "ehcidi", hz); /* bell wait */
1545 DPRINTFN(1,("ehci_sync_hc: cmd=0x%08x sts=0x%08x\n",
1546 EOREAD4(sc, EHCI_USBCMD), EOREAD4(sc, EHCI_USBSTS)));
1548 /* release doorbell */
1549 lockmgr(&sc->sc_doorbell_lock, LK_RELEASE);
1552 kprintf("ehci_sync_hc: tsleep() = %d\n", error);
1554 DPRINTFN(2,("ehci_sync_hc: exit\n"));
1560 * Data structures and routines to emulate the root hub.
1562 Static usb_device_descriptor_t ehci_devd = {
1563 USB_DEVICE_DESCRIPTOR_SIZE,
1564 UDESC_DEVICE, /* type */
1565 {0x00, 0x02}, /* USB version */
1566 UDCLASS_HUB, /* class */
1567 UDSUBCLASS_HUB, /* subclass */
1568 UDPROTO_HSHUBSTT, /* protocol */
1569 64, /* max packet */
1570 {0},{0},{0x00,0x01}, /* device id */
1571 1,2,0, /* string indicies */
1572 1 /* # of configurations */
1575 Static usb_device_qualifier_t ehci_odevd = {
1576 USB_DEVICE_DESCRIPTOR_SIZE,
1577 UDESC_DEVICE_QUALIFIER, /* type */
1578 {0x00, 0x02}, /* USB version */
1579 UDCLASS_HUB, /* class */
1580 UDSUBCLASS_HUB, /* subclass */
1581 UDPROTO_FSHUB, /* protocol */
1582 64, /* max packet */
1583 1, /* # of configurations */
1587 Static usb_config_descriptor_t ehci_confd = {
1588 USB_CONFIG_DESCRIPTOR_SIZE,
1590 {USB_CONFIG_DESCRIPTOR_SIZE +
1591 USB_INTERFACE_DESCRIPTOR_SIZE +
1592 USB_ENDPOINT_DESCRIPTOR_SIZE},
1600 Static usb_interface_descriptor_t ehci_ifcd = {
1601 USB_INTERFACE_DESCRIPTOR_SIZE,
1612 Static usb_endpoint_descriptor_t ehci_endpd = {
1613 USB_ENDPOINT_DESCRIPTOR_SIZE,
1615 UE_DIR_IN | EHCI_INTR_ENDPT,
1617 {8, 0}, /* max packet */
1621 Static usb_hub_descriptor_t ehci_hubd = {
1622 USB_HUB_DESCRIPTOR_SIZE,
1632 ehci_str(usb_string_descriptor_t *p, int l, char *s)
1638 p->bLength = 2 * strlen(s) + 2;
1641 p->bDescriptorType = UDESC_STRING;
1643 for (i = 0; s[i] && l > 1; i++, l -= 2)
1644 USETW2(p->bString[i], 0, s[i]);
1649 * Simulate a hardware hub by handling all the necessary requests.
1652 ehci_root_ctrl_transfer(usbd_xfer_handle xfer)
1656 /* Insert last in queue. */
1657 err = usb_insert_transfer(xfer);
1661 /* Pipe isn't running, start first */
1662 return (ehci_root_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
1666 ehci_root_ctrl_start(usbd_xfer_handle xfer)
1668 ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
1669 usb_device_request_t *req;
1672 int len, value, index, l, totlen = 0;
1673 usb_port_status_t ps;
1674 usb_hub_descriptor_t hubd;
1679 return (USBD_IOERROR);
1682 if (!(xfer->rqflags & URQ_REQUEST))
1684 return (USBD_INVAL);
1686 req = &xfer->request;
1688 DPRINTFN(4,("ehci_root_ctrl_start: type=0x%02x request=%02x\n",
1689 req->bmRequestType, req->bRequest));
1691 len = UGETW(req->wLength);
1692 value = UGETW(req->wValue);
1693 index = UGETW(req->wIndex);
1696 buf = KERNADDR(&xfer->dmabuf, 0);
1698 #define C(x,y) ((x) | ((y) << 8))
1699 switch(C(req->bRequest, req->bmRequestType)) {
1700 case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
1701 case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
1702 case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
1704 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
1705 * for the integrated root hub.
1708 case C(UR_GET_CONFIG, UT_READ_DEVICE):
1710 *(u_int8_t *)buf = sc->sc_conf;
1714 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
1715 DPRINTFN(8,("ehci_root_ctrl_start: wValue=0x%04x\n", value));
1716 switch(value >> 8) {
1718 if ((value & 0xff) != 0) {
1722 totlen = l = min(len, USB_DEVICE_DESCRIPTOR_SIZE);
1723 USETW(ehci_devd.idVendor, sc->sc_id_vendor);
1724 memcpy(buf, &ehci_devd, l);
1727 * We can't really operate at another speed, but the spec says
1728 * we need this descriptor.
1730 case UDESC_DEVICE_QUALIFIER:
1731 if ((value & 0xff) != 0) {
1735 totlen = l = min(len, USB_DEVICE_DESCRIPTOR_SIZE);
1736 memcpy(buf, &ehci_odevd, l);
1739 * We can't really operate at another speed, but the spec says
1740 * we need this descriptor.
1742 case UDESC_OTHER_SPEED_CONFIGURATION:
1744 if ((value & 0xff) != 0) {
1748 totlen = l = min(len, USB_CONFIG_DESCRIPTOR_SIZE);
1749 memcpy(buf, &ehci_confd, l);
1750 ((usb_config_descriptor_t *)buf)->bDescriptorType =
1752 buf = (char *)buf + l;
1754 l = min(len, USB_INTERFACE_DESCRIPTOR_SIZE);
1756 memcpy(buf, &ehci_ifcd, l);
1757 buf = (char *)buf + l;
1759 l = min(len, USB_ENDPOINT_DESCRIPTOR_SIZE);
1761 memcpy(buf, &ehci_endpd, l);
1766 *(u_int8_t *)buf = 0;
1768 switch (value & 0xff) {
1769 case 0: /* Language table */
1770 totlen = ehci_str(buf, len, "\001");
1772 case 1: /* Vendor */
1773 totlen = ehci_str(buf, len, sc->sc_vendor);
1775 case 2: /* Product */
1776 totlen = ehci_str(buf, len, "EHCI root hub");
1785 case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
1787 *(u_int8_t *)buf = 0;
1791 case C(UR_GET_STATUS, UT_READ_DEVICE):
1793 USETW(((usb_status_t *)buf)->wStatus,UDS_SELF_POWERED);
1797 case C(UR_GET_STATUS, UT_READ_INTERFACE):
1798 case C(UR_GET_STATUS, UT_READ_ENDPOINT):
1800 USETW(((usb_status_t *)buf)->wStatus, 0);
1804 case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
1805 if (value >= USB_MAX_DEVICES) {
1809 sc->sc_addr = value;
1811 case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
1812 if (value != 0 && value != 1) {
1816 sc->sc_conf = value;
1818 case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
1820 case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
1821 case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
1822 case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
1825 case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
1827 case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
1830 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
1832 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
1833 DPRINTFN(8, ("ehci_root_ctrl_start: UR_CLEAR_PORT_FEATURE "
1834 "port=%d feature=%d\n",
1836 if (index < 1 || index > sc->sc_noport) {
1840 port = EHCI_PORTSC(index);
1841 v = EOREAD4(sc, port) &~ EHCI_PS_CLEAR;
1843 case UHF_PORT_ENABLE:
1844 EOWRITE4(sc, port, v &~ EHCI_PS_PE);
1846 case UHF_PORT_SUSPEND:
1847 EOWRITE4(sc, port, v &~ EHCI_PS_SUSP);
1849 case UHF_PORT_POWER:
1850 EOWRITE4(sc, port, v &~ EHCI_PS_PP);
1853 DPRINTFN(2,("ehci_root_ctrl_start: clear port test "
1856 case UHF_PORT_INDICATOR:
1857 DPRINTFN(2,("ehci_root_ctrl_start: clear port ind "
1859 EOWRITE4(sc, port, v &~ EHCI_PS_PIC);
1861 case UHF_C_PORT_CONNECTION:
1862 EOWRITE4(sc, port, v | EHCI_PS_CSC);
1864 case UHF_C_PORT_ENABLE:
1865 EOWRITE4(sc, port, v | EHCI_PS_PEC);
1867 case UHF_C_PORT_SUSPEND:
1870 case UHF_C_PORT_OVER_CURRENT:
1871 EOWRITE4(sc, port, v | EHCI_PS_OCC);
1873 case UHF_C_PORT_RESET:
1882 case UHF_C_PORT_CONNECTION:
1883 case UHF_C_PORT_ENABLE:
1884 case UHF_C_PORT_SUSPEND:
1885 case UHF_C_PORT_OVER_CURRENT:
1886 case UHF_C_PORT_RESET:
1887 /* Enable RHSC interrupt if condition is cleared. */
1888 if ((OREAD4(sc, port) >> 16) == 0)
1889 ehci_pcd_able(sc, 1);
1896 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
1897 if ((value & 0xff) != 0) {
1902 hubd.bNbrPorts = sc->sc_noport;
1903 v = EOREAD4(sc, EHCI_HCSPARAMS);
1904 USETW(hubd.wHubCharacteristics,
1905 EHCI_HCS_PPC(v) ? UHD_PWR_INDIVIDUAL : UHD_PWR_NO_SWITCH |
1906 EHCI_HCS_P_INDICATOR(EREAD4(sc, EHCI_HCSPARAMS))
1907 ? UHD_PORT_IND : 0);
1908 hubd.bPwrOn2PwrGood = 200; /* XXX can't find out? */
1909 for (i = 0, l = sc->sc_noport; l > 0; i++, l -= 8, v >>= 8)
1910 hubd.DeviceRemovable[i++] = 0; /* XXX can't find out? */
1911 hubd.bDescLength = USB_HUB_DESCRIPTOR_SIZE + i;
1912 l = min(len, hubd.bDescLength);
1914 memcpy(buf, &hubd, l);
1916 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
1921 memset(buf, 0, len); /* ? XXX */
1924 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
1925 DPRINTFN(8,("ehci_root_ctrl_start: get port status i=%d\n",
1927 if (index < 1 || index > sc->sc_noport) {
1935 v = EOREAD4(sc, EHCI_PORTSC(index));
1936 DPRINTFN(8,("ehci_root_ctrl_start: port status=0x%04x\n", v));
1938 if (v & EHCI_PS_CS) i |= UPS_CURRENT_CONNECT_STATUS;
1939 if (v & EHCI_PS_PE) i |= UPS_PORT_ENABLED;
1940 if (v & EHCI_PS_SUSP) i |= UPS_SUSPEND;
1941 if (v & EHCI_PS_OCA) i |= UPS_OVERCURRENT_INDICATOR;
1942 if (v & EHCI_PS_PR) i |= UPS_RESET;
1943 if (v & EHCI_PS_PP) i |= UPS_PORT_POWER;
1944 USETW(ps.wPortStatus, i);
1946 if (v & EHCI_PS_CSC) i |= UPS_C_CONNECT_STATUS;
1947 if (v & EHCI_PS_PEC) i |= UPS_C_PORT_ENABLED;
1948 if (v & EHCI_PS_OCC) i |= UPS_C_OVERCURRENT_INDICATOR;
1949 if (sc->sc_isreset) i |= UPS_C_PORT_RESET;
1950 USETW(ps.wPortChange, i);
1951 l = min(len, sizeof ps);
1952 memcpy(buf, &ps, l);
1955 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
1958 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
1960 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
1961 if (index < 1 || index > sc->sc_noport) {
1965 port = EHCI_PORTSC(index);
1966 v = EOREAD4(sc, port) &~ EHCI_PS_CLEAR;
1968 case UHF_PORT_ENABLE:
1969 EOWRITE4(sc, port, v | EHCI_PS_PE);
1971 case UHF_PORT_SUSPEND:
1972 EOWRITE4(sc, port, v | EHCI_PS_SUSP);
1974 case UHF_PORT_RESET:
1975 DPRINTFN(5,("ehci_root_ctrl_start: reset port %d\n",
1977 if (EHCI_PS_IS_LOWSPEED(v)) {
1978 /* Low speed device, give up ownership. */
1979 ehci_disown(sc, index, 1);
1982 /* Start reset sequence. */
1983 v &= ~ (EHCI_PS_PE | EHCI_PS_PR);
1984 EOWRITE4(sc, port, v | EHCI_PS_PR);
1985 /* Wait for reset to complete. */
1986 usb_delay_ms(&sc->sc_bus, USB_PORT_ROOT_RESET_DELAY);
1991 /* Terminate reset sequence. */
1992 EOWRITE4(sc, port, v);
1993 /* Wait for HC to complete reset. */
1994 usb_delay_ms(&sc->sc_bus, EHCI_PORT_RESET_COMPLETE);
1999 v = EOREAD4(sc, port);
2000 DPRINTF(("ehci after reset, status=0x%08x\n", v));
2001 if (v & EHCI_PS_PR) {
2002 kprintf("%s: port reset timeout\n",
2003 USBDEVNAME(sc->sc_bus.bdev));
2004 return (USBD_TIMEOUT);
2006 if (!(v & EHCI_PS_PE)) {
2007 /* Not a high speed device, give up ownership.*/
2008 ehci_disown(sc, index, 0);
2012 DPRINTF(("ehci port %d reset, status = 0x%08x\n",
2015 case UHF_PORT_POWER:
2016 DPRINTFN(2,("ehci_root_ctrl_start: set port power "
2018 EOWRITE4(sc, port, v | EHCI_PS_PP);
2021 DPRINTFN(2,("ehci_root_ctrl_start: set port test "
2024 case UHF_PORT_INDICATOR:
2025 DPRINTFN(2,("ehci_root_ctrl_start: set port ind "
2027 EOWRITE4(sc, port, v | EHCI_PS_PIC);
2034 case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER):
2035 case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER):
2036 case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER):
2037 case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER):
2043 xfer->actlen = totlen;
2044 err = USBD_NORMAL_COMPLETION;
2048 usb_transfer_complete(xfer);
2050 return (USBD_IN_PROGRESS);
2054 ehci_disown(ehci_softc_t *sc, int index, int lowspeed)
2059 DPRINTF(("ehci_disown: index=%d lowspeed=%d\n", index, lowspeed));
2061 if (sc->sc_npcomp != 0) {
2062 int i = (index-1) / sc->sc_npcomp;
2063 if (i >= sc->sc_ncomp)
2064 kprintf("%s: strange port\n",
2065 USBDEVNAME(sc->sc_bus.bdev));
2067 kprintf("%s: handing over %s speed device on "
2069 USBDEVNAME(sc->sc_bus.bdev),
2070 lowspeed ? "low" : "full",
2071 index, USBDEVNAME(sc->sc_comps[i]->bdev));
2073 kprintf("%s: npcomp == 0\n", USBDEVNAME(sc->sc_bus.bdev));
2076 port = EHCI_PORTSC(index);
2077 v = EOREAD4(sc, port) &~ EHCI_PS_CLEAR;
2078 EOWRITE4(sc, port, v | EHCI_PS_PO);
2081 /* Abort a root control request. */
2083 ehci_root_ctrl_abort(usbd_xfer_handle xfer)
2085 /* Nothing to do, all transfers are synchronous. */
2088 /* Close the root pipe. */
2090 ehci_root_ctrl_close(usbd_pipe_handle pipe)
2092 DPRINTF(("ehci_root_ctrl_close\n"));
2093 /* Nothing to do. */
2097 ehci_root_intr_done(usbd_xfer_handle xfer)
2102 ehci_root_intr_transfer(usbd_xfer_handle xfer)
2106 /* Insert last in queue. */
2107 err = usb_insert_transfer(xfer);
2111 /* Pipe isn't running, start first */
2112 return (ehci_root_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2116 ehci_root_intr_start(usbd_xfer_handle xfer)
2118 usbd_pipe_handle pipe = xfer->pipe;
2119 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2122 return (USBD_IOERROR);
2124 sc->sc_intrxfer = xfer;
2126 return (USBD_IN_PROGRESS);
2129 /* Abort a root interrupt request. */
2131 ehci_root_intr_abort(usbd_xfer_handle xfer)
2133 if (xfer->pipe->intrxfer == xfer) {
2134 DPRINTF(("ehci_root_intr_abort: remove\n"));
2135 xfer->pipe->intrxfer = NULL;
2137 xfer->status = USBD_CANCELLED;
2139 usb_transfer_complete(xfer);
2143 /* Close the root pipe. */
2145 ehci_root_intr_close(usbd_pipe_handle pipe)
2147 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2149 DPRINTF(("ehci_root_intr_close\n"));
2151 sc->sc_intrxfer = NULL;
2155 ehci_root_ctrl_done(usbd_xfer_handle xfer)
2159 /************************/
2162 ehci_alloc_sqh(ehci_softc_t *sc)
2164 ehci_soft_qh_t *sqh;
2169 if (sc->sc_freeqhs == NULL) {
2170 DPRINTFN(2, ("ehci_alloc_sqh: allocating chunk\n"));
2171 err = usb_allocmem(&sc->sc_bus, EHCI_SQH_SIZE * EHCI_SQH_CHUNK,
2172 EHCI_PAGE_SIZE, &dma);
2175 kprintf("ehci_alloc_sqh: usb_allocmem()=%d\n", err);
2179 for(i = 0; i < EHCI_SQH_CHUNK; i++) {
2180 offs = i * EHCI_SQH_SIZE;
2181 sqh = KERNADDR(&dma, offs);
2182 sqh->physaddr = DMAADDR(&dma, offs);
2183 sqh->next = sc->sc_freeqhs;
2184 sc->sc_freeqhs = sqh;
2187 sqh = sc->sc_freeqhs;
2188 sc->sc_freeqhs = sqh->next;
2189 memset(&sqh->qh, 0, sizeof(ehci_qh_t));
2196 ehci_free_sqh(ehci_softc_t *sc, ehci_soft_qh_t *sqh)
2198 sqh->next = sc->sc_freeqhs;
2199 sc->sc_freeqhs = sqh;
2203 ehci_alloc_sqtd(ehci_softc_t *sc)
2205 ehci_soft_qtd_t *sqtd;
2210 if (sc->sc_freeqtds == NULL) {
2211 DPRINTFN(2, ("ehci_alloc_sqtd: allocating chunk\n"));
2212 err = usb_allocmem(&sc->sc_bus, EHCI_SQTD_SIZE*EHCI_SQTD_CHUNK,
2213 EHCI_PAGE_SIZE, &dma);
2216 kprintf("ehci_alloc_sqtd: usb_allocmem()=%d\n", err);
2221 for(i = 0; i < EHCI_SQTD_CHUNK; i++) {
2222 offs = i * EHCI_SQTD_SIZE;
2223 sqtd = KERNADDR(&dma, offs);
2224 sqtd->physaddr = DMAADDR(&dma, offs);
2225 sqtd->nextqtd = sc->sc_freeqtds;
2226 sc->sc_freeqtds = sqtd;
2232 sqtd = sc->sc_freeqtds;
2233 sc->sc_freeqtds = sqtd->nextqtd;
2234 memset(&sqtd->qtd, 0, sizeof(ehci_qtd_t));
2235 sqtd->nextqtd = NULL;
2243 ehci_free_sqtd(ehci_softc_t *sc, ehci_soft_qtd_t *sqtd)
2246 sqtd->nextqtd = sc->sc_freeqtds;
2247 sc->sc_freeqtds = sqtd;
2252 ehci_alloc_sqtd_chain(struct ehci_pipe *epipe, ehci_softc_t *sc,
2253 int alen, int rd, usbd_xfer_handle xfer,
2254 ehci_soft_qtd_t **sp, ehci_soft_qtd_t **ep)
2256 ehci_soft_qtd_t *next, *cur;
2257 ehci_physaddr_t dataphys, dataphyspage, dataphyslastpage, nextphys;
2258 u_int32_t qtdstatus;
2259 int len, curlen, mps, offset;
2261 usb_dma_t *dma = &xfer->dmabuf;
2263 DPRINTFN(alen<4*4096,("ehci_alloc_sqtd_chain: start len=%d\n", alen));
2267 iscontrol = (epipe->pipe.endpoint->edesc->bmAttributes & UE_XFERTYPE) ==
2269 dataphys = DMAADDR(dma, 0);
2270 dataphyslastpage = EHCI_PAGE(DMAADDR(dma, len - 1));
2271 qtdstatus = EHCI_QTD_ACTIVE |
2272 EHCI_QTD_SET_PID(rd ? EHCI_QTD_PID_IN : EHCI_QTD_PID_OUT) |
2273 EHCI_QTD_SET_CERR(3)
2275 /* BYTES set below */
2277 mps = UGETW(epipe->pipe.endpoint->edesc->wMaxPacketSize);
2279 * The control transfer data stage always starts with a toggle of 1.
2280 * For other transfers we let the hardware track the toggle state.
2283 qtdstatus |= EHCI_QTD_SET_TOGGLE(1);
2285 cur = ehci_alloc_sqtd(sc);
2290 dataphyspage = EHCI_PAGE(dataphys);
2291 /* The EHCI hardware can handle at most 5 pages. */
2292 #if defined(__NetBSD__) || defined(__OpenBSD__)
2293 if (dataphyslastpage - dataphyspage <
2294 EHCI_QTD_NBUFFERS * EHCI_PAGE_SIZE) {
2295 /* we can handle it in this QTD */
2298 #elif defined(__FreeBSD__) || defined(__DragonFly__)
2299 /* XXX This is pretty broken: Because we do not allocate
2300 * a contiguous buffer (contiguous in physical pages) we
2301 * can only transfer one page in one go.
2302 * So check whether the start and end of the buffer are on
2305 if (dataphyspage == dataphyslastpage) {
2310 #if defined(__NetBSD__) || defined(__OpenBSD__)
2311 /* must use multiple TDs, fill as much as possible. */
2312 curlen = EHCI_QTD_NBUFFERS * EHCI_PAGE_SIZE -
2313 EHCI_PAGE_OFFSET(dataphys);
2316 kprintf("ehci_alloc_sqtd_chain: curlen=0x%x "
2317 "len=0x%x offs=0x%x\n", curlen, len,
2318 EHCI_PAGE_OFFSET(dataphys));
2319 kprintf("lastpage=0x%x page=0x%x phys=0x%x\n",
2320 dataphyslastpage, dataphyspage,
2325 #elif defined(__FreeBSD__) || defined(__DragonFly__)
2326 /* See comment above (XXX) */
2327 curlen = EHCI_PAGE_SIZE -
2328 EHCI_PAGE_MASK(dataphys);
2330 /* the length must be a multiple of the max size */
2331 curlen -= curlen % mps;
2332 DPRINTFN(1,("ehci_alloc_sqtd_chain: multiple QTDs, "
2333 "curlen=%d\n", curlen));
2334 KASSERT(curlen != 0, ("ehci_alloc_std: curlen == 0"));
2336 DPRINTFN(4,("ehci_alloc_sqtd_chain: dataphys=0x%08x "
2337 "dataphyslastpage=0x%08x len=%d curlen=%d\n",
2338 dataphys, dataphyslastpage,
2343 next = ehci_alloc_sqtd(sc);
2346 nextphys = htole32(next->physaddr);
2349 nextphys = EHCI_NULL;
2352 for (i = 0; i * EHCI_PAGE_SIZE < curlen; i++) {
2353 ehci_physaddr_t a = dataphys + i * EHCI_PAGE_SIZE;
2354 if (i != 0) /* use offset only in first buffer */
2356 cur->qtd.qtd_buffer[i] = htole32(a);
2357 cur->qtd.qtd_buffer_hi[i] = 0;
2359 if (i >= EHCI_QTD_NBUFFERS) {
2360 kprintf("ehci_alloc_sqtd_chain: i=%d\n", i);
2365 cur->nextqtd = next;
2366 cur->qtd.qtd_next = cur->qtd.qtd_altnext = nextphys;
2367 cur->qtd.qtd_status =
2368 htole32(qtdstatus | EHCI_QTD_SET_BYTES(curlen));
2371 DPRINTFN(10,("ehci_alloc_sqtd_chain: cbp=0x%08x end=0x%08x\n",
2372 dataphys, dataphys + curlen));
2375 * adjust the toggle based on the number of packets
2378 if (((curlen + mps - 1) / mps) & 1)
2379 qtdstatus ^= EHCI_QTD_TOGGLE_MASK;
2383 DPRINTFN(10,("ehci_alloc_sqtd_chain: extend chain\n"));
2385 dataphys = DMAADDR(dma, offset);
2388 cur->qtd.qtd_status |= htole32(EHCI_QTD_IOC);
2391 DPRINTFN(10,("ehci_alloc_sqtd_chain: return sqtd=%p sqtdend=%p\n",
2394 return (USBD_NORMAL_COMPLETION);
2397 /* XXX free chain */
2398 DPRINTFN(-1,("ehci_alloc_sqtd_chain: no memory\n"));
2399 return (USBD_NOMEM);
2403 ehci_free_sqtd_chain(ehci_softc_t *sc, ehci_soft_qtd_t *sqtd,
2404 ehci_soft_qtd_t *sqtdend)
2409 DPRINTFN(10,("ehci_free_sqtd_chain: sqtd=%p sqtdend=%p\n",
2412 for (i = 0; sqtd != sqtdend; sqtd = p, i++) {
2414 ehci_free_sqtd(sc, sqtd);
2421 * Close a reqular pipe.
2422 * Assumes that there are no pending transactions.
2425 ehci_close_pipe(usbd_pipe_handle pipe, ehci_soft_qh_t *head)
2427 struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
2428 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2429 ehci_soft_qh_t *sqh = epipe->sqh;
2432 ehci_rem_qh(sc, sqh, head);
2434 pipe->endpoint->savedtoggle =
2435 EHCI_QTD_GET_TOGGLE(le32toh(sqh->qh.qh_qtd.qtd_status));
2436 ehci_free_sqh(sc, epipe->sqh);
2440 * Abort a device request.
2441 * If this routine is called from a critical section it guarantees that the
2442 * request will be removed from the hardware scheduling and that the callback
2443 * for it will be called with USBD_CANCELLED status.
2444 * It's impossible to guarantee that the requested transfer will not
2445 * have happened since the hardware runs concurrently.
2446 * If the transaction has already happened we rely on the ordinary
2447 * interrupt processing to process it.
2448 * XXX This is most probably wrong.
2451 ehci_abort_xfer(usbd_xfer_handle xfer, usbd_status status)
2453 #define exfer EXFER(xfer)
2454 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2455 ehci_softc_t *sc = (ehci_softc_t *)epipe->pipe.device->bus;
2456 ehci_soft_qh_t *sqh = epipe->sqh;
2457 ehci_soft_qtd_t *sqtd, *snext, **psqtd;
2458 ehci_physaddr_t cur, us, next;
2460 /* int count = 0; */
2461 ehci_soft_qh_t *psqh;
2463 DPRINTF(("ehci_abort_xfer: xfer=%p pipe=%p\n", xfer, epipe));
2466 /* If we're dying, just do the software part. */
2468 xfer->status = status; /* make software ignore it */
2469 usb_uncallout(xfer->timeout_handle, ehci_timeout, xfer);
2470 usb_rem_task(epipe->pipe.device, &exfer->abort_task);
2471 usb_transfer_complete(xfer);
2476 if (xfer->device->bus->intr_context /* || !curproc REMOVED DFly */)
2477 panic("ehci_abort_xfer: not in process context");
2480 * If an abort is already in progress then just wait for it to
2481 * complete and return.
2483 if (exfer->ehci_xfer_flags & EHCI_XFER_ABORTING) {
2484 DPRINTFN(2, ("ehci_abort_xfer: already aborting\n"));
2485 /* No need to wait if we're aborting from a timeout. */
2486 if (status == USBD_TIMEOUT)
2488 /* Override the status which might be USBD_TIMEOUT. */
2489 xfer->status = status;
2490 DPRINTFN(2, ("ehci_abort_xfer: waiting for abort to finish\n"));
2491 exfer->ehci_xfer_flags |= EHCI_XFER_ABORTWAIT;
2492 while (exfer->ehci_xfer_flags & EHCI_XFER_ABORTING)
2493 tsleep(&exfer->ehci_xfer_flags, 0, "ehciaw", 0);
2498 * Step 1: Make interrupt routine and timeouts ignore xfer.
2501 exfer->ehci_xfer_flags |= EHCI_XFER_ABORTING;
2502 xfer->status = status; /* make software ignore it */
2503 usb_uncallout(xfer->timeout_handle, ehci_timeout, xfer);
2504 usb_rem_task(epipe->pipe.device, &exfer->abort_task);
2508 * Step 2: Wait until we know hardware has finished any possible
2509 * use of the xfer. We do this by removing the entire
2510 * queue from the async schedule and waiting for the doorbell.
2511 * Nothing else should be touching the queue now.
2514 ehci_rem_qh(sc, sqh, psqh);
2517 * Step 3: make sure the soft interrupt routine
2518 * has run. This should remove any completed items off the queue.
2519 * The hardware has no reference to completed items (TDs).
2520 * It's safe to remove them at any time.
2523 #ifdef USB_USE_SOFTINTR
2524 sc->sc_softwake = 1;
2525 #endif /* USB_USE_SOFTINTR */
2526 usb_schedsoftintr(&sc->sc_bus);
2527 #ifdef USB_USE_SOFTINTR
2528 tsleep(&sc->sc_softwake, 0, "ehciab", 0);
2529 #endif /* USB_USE_SOFTINTR */
2532 * Step 4: Remove any vestiges of the xfer from the hardware.
2533 * The complication here is that the hardware may have executed
2534 * into or even beyond the xfer we're trying to abort.
2535 * So as we're scanning the TDs of this xfer we check if
2536 * the hardware points to any of them.
2538 * first we need to see if there are any transfers
2539 * on this queue before the xfer we are aborting.. we need
2540 * to update any pointers that point to us to point past
2541 * the aborting xfer. (If there is something past us).
2542 * Hardware and software.
2544 cur = EHCI_LINK_ADDR(le32toh(sqh->qh.qh_curqtd));
2547 /* If they initially point here. */
2548 us = exfer->sqtdstart->physaddr;
2550 /* We will change them to point here */
2551 snext = exfer->sqtdend->nextqtd;
2552 next = snext ? htole32(snext->physaddr) : EHCI_NULL;
2555 * Now loop through any qTDs before us and keep track of the pointer
2556 * that points to us for the end.
2560 while (sqtd && sqtd != exfer->sqtdstart) {
2561 hit |= (cur == sqtd->physaddr);
2562 if (EHCI_LINK_ADDR(le32toh(sqtd->qtd.qtd_next)) == us)
2563 sqtd->qtd.qtd_next = next;
2564 if (EHCI_LINK_ADDR(le32toh(sqtd->qtd.qtd_altnext)) == us)
2565 sqtd->qtd.qtd_altnext = next;
2566 psqtd = &sqtd->nextqtd;
2567 sqtd = sqtd->nextqtd;
2569 /* make the software pointer bypass us too */
2570 *psqtd = exfer->sqtdend->nextqtd;
2573 * If we already saw the active one then we are pretty much done.
2574 * We've done all the relinking we need to do.
2579 * Now reinitialise the QH to point to the next qTD
2580 * (if there is one). We only need to do this if
2581 * it was previously pointing to us.
2583 sqtd = exfer->sqtdstart;
2584 for (sqtd = exfer->sqtdstart; ; sqtd = sqtd->nextqtd) {
2585 if (cur == sqtd->physaddr) {
2588 if (sqtd == exfer->sqtdend)
2591 sqtd = sqtd->nextqtd;
2593 * Only need to alter the QH if it was pointing at a qTD
2594 * that we are removing.
2598 ehci_set_qh_qtd(sqh, snext);
2601 sqh->qh.qh_curqtd = 0; /* unlink qTDs */
2602 sqh->qh.qh_qtd.qtd_status &=
2603 htole32(EHCI_QTD_TOGGLE_MASK);
2604 sqh->qh.qh_qtd.qtd_next =
2605 sqh->qh.qh_qtd.qtd_altnext
2607 DPRINTFN(1,("ehci_abort_xfer: no hit\n"));
2611 ehci_add_qh(sqh, psqh);
2613 * Step 5: Execute callback.
2618 /* Do the wakeup first to avoid touching the xfer after the callback. */
2619 exfer->ehci_xfer_flags &= ~EHCI_XFER_ABORTING;
2620 if (exfer->ehci_xfer_flags & EHCI_XFER_ABORTWAIT) {
2621 exfer->ehci_xfer_flags &= ~EHCI_XFER_ABORTWAIT;
2622 wakeup(&exfer->ehci_xfer_flags);
2624 usb_transfer_complete(xfer);
2626 /* kprintf("%s: %d TDs aborted\n", __func__, count); */
2632 ehci_timeout(void *addr)
2634 struct ehci_xfer *exfer = addr;
2635 struct ehci_pipe *epipe = (struct ehci_pipe *)exfer->xfer.pipe;
2636 ehci_softc_t *sc = (ehci_softc_t *)epipe->pipe.device->bus;
2638 DPRINTF(("ehci_timeout: exfer=%p\n", exfer));
2641 usbd_dump_pipe(exfer->xfer.pipe);
2645 ehci_abort_xfer(&exfer->xfer, USBD_TIMEOUT);
2649 /* Execute the abort in a process context. */
2650 usb_add_task(exfer->xfer.pipe->device, &exfer->abort_task,
2655 ehci_timeout_task(void *addr)
2657 usbd_xfer_handle xfer = addr;
2659 DPRINTF(("ehci_timeout_task: xfer=%p\n", xfer));
2661 ehci_abort_xfer(xfer, USBD_TIMEOUT);
2666 * Some EHCI chips from VIA / ATI seem to trigger interrupts before writing
2667 * back the qTD status, or miss signalling occasionally under heavy load.
2668 * If the host machine is too fast, we can miss transaction completion - when
2669 * we scan the active list the transaction still seems to be active. This
2670 * generally exhibits itself as a umass stall that never recovers.
2672 * We work around this behaviour by setting up this callback after any softintr
2673 * that completes with transactions still pending, giving us another chance to
2674 * check for completion after the writeback has taken place.
2677 ehci_intrlist_timeout(void *arg)
2679 ehci_softc_t *sc = arg;
2681 DPRINTFN(3, ("ehci_intrlist_timeout\n"));
2682 usb_schedsoftintr(&sc->sc_bus);
2685 /************************/
2688 ehci_device_ctrl_transfer(usbd_xfer_handle xfer)
2692 /* Insert last in queue. */
2693 err = usb_insert_transfer(xfer);
2697 /* Pipe isn't running, start first */
2698 return (ehci_device_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2702 ehci_device_ctrl_start(usbd_xfer_handle xfer)
2704 ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
2708 return (USBD_IOERROR);
2711 if (!(xfer->rqflags & URQ_REQUEST)) {
2713 kprintf("ehci_device_ctrl_transfer: not a request\n");
2714 return (USBD_INVAL);
2718 err = ehci_device_request(xfer);
2722 if (sc->sc_bus.use_polling)
2723 ehci_waitintr(sc, xfer);
2724 return (USBD_IN_PROGRESS);
2728 ehci_device_ctrl_done(usbd_xfer_handle xfer)
2730 struct ehci_xfer *ex = EXFER(xfer);
2731 ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
2732 /*struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;*/
2734 DPRINTFN(10,("ehci_ctrl_done: xfer=%p\n", xfer));
2737 if (!(xfer->rqflags & URQ_REQUEST)) {
2738 panic("ehci_ctrl_done: not a request");
2742 if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
2743 ehci_del_intr_list(ex); /* remove from active list */
2744 ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
2747 DPRINTFN(5, ("ehci_ctrl_done: length=%d\n", xfer->actlen));
2750 /* Abort a device control request. */
2752 ehci_device_ctrl_abort(usbd_xfer_handle xfer)
2754 DPRINTF(("ehci_device_ctrl_abort: xfer=%p\n", xfer));
2755 ehci_abort_xfer(xfer, USBD_CANCELLED);
2758 /* Close a device control pipe. */
2760 ehci_device_ctrl_close(usbd_pipe_handle pipe)
2762 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2763 /*struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;*/
2765 DPRINTF(("ehci_device_ctrl_close: pipe=%p\n", pipe));
2766 ehci_close_pipe(pipe, sc->sc_async_head);
2770 ehci_device_request(usbd_xfer_handle xfer)
2772 #define exfer EXFER(xfer)
2773 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2774 usb_device_request_t *req = &xfer->request;
2775 usbd_device_handle dev = epipe->pipe.device;
2776 ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
2777 int addr = dev->address;
2778 ehci_soft_qtd_t *setup, *stat, *next;
2779 ehci_soft_qh_t *sqh;
2784 isread = req->bmRequestType & UT_READ;
2785 len = UGETW(req->wLength);
2787 DPRINTFN(3,("ehci_device_request: type=0x%02x, request=0x%02x, "
2788 "wValue=0x%04x, wIndex=0x%04x len=%d, addr=%d, endpt=%d\n",
2789 req->bmRequestType, req->bRequest, UGETW(req->wValue),
2790 UGETW(req->wIndex), len, addr,
2791 epipe->pipe.endpoint->edesc->bEndpointAddress));
2793 setup = ehci_alloc_sqtd(sc);
2794 if (setup == NULL) {
2798 stat = ehci_alloc_sqtd(sc);
2805 epipe->u.ctl.length = len;
2807 /* Update device address and length since they may have changed
2808 during the setup of the control pipe in usbd_new_device(). */
2809 /* XXX This only needs to be done once, but it's too early in open. */
2810 /* XXXX Should not touch ED here! */
2812 (sqh->qh.qh_endp & htole32(~(EHCI_QH_ADDRMASK | EHCI_QH_MPLMASK))) |
2814 EHCI_QH_SET_ADDR(addr) |
2815 EHCI_QH_SET_MPL(UGETW(epipe->pipe.endpoint->edesc->wMaxPacketSize))
2818 /* Set up data transaction */
2820 ehci_soft_qtd_t *end;
2822 err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer,
2826 end->qtd.qtd_status &= htole32(~EHCI_QTD_IOC);
2827 end->nextqtd = stat;
2829 end->qtd.qtd_altnext = htole32(stat->physaddr);
2834 memcpy(KERNADDR(&epipe->u.ctl.reqdma, 0), req, sizeof *req);
2837 setup->qtd.qtd_status = htole32(
2839 EHCI_QTD_SET_PID(EHCI_QTD_PID_SETUP) |
2840 EHCI_QTD_SET_CERR(3) |
2841 EHCI_QTD_SET_TOGGLE(0) |
2842 EHCI_QTD_SET_BYTES(sizeof *req)
2844 setup->qtd.qtd_buffer[0] = htole32(DMAADDR(&epipe->u.ctl.reqdma, 0));
2845 setup->qtd.qtd_buffer_hi[0] = 0;
2846 setup->nextqtd = next;
2847 setup->qtd.qtd_next = setup->qtd.qtd_altnext = htole32(next->physaddr);
2849 setup->len = sizeof *req;
2851 stat->qtd.qtd_status = htole32(
2853 EHCI_QTD_SET_PID(isread ? EHCI_QTD_PID_OUT : EHCI_QTD_PID_IN) |
2854 EHCI_QTD_SET_CERR(3) |
2855 EHCI_QTD_SET_TOGGLE(1) |
2858 stat->qtd.qtd_buffer[0] = 0; /* XXX not needed? */
2859 stat->qtd.qtd_buffer_hi[0] = 0; /* XXX not needed? */
2860 stat->nextqtd = NULL;
2861 stat->qtd.qtd_next = stat->qtd.qtd_altnext = EHCI_NULL;
2866 if (ehcidebug > 5) {
2867 DPRINTF(("ehci_device_request:\n"));
2869 ehci_dump_sqtds(setup);
2873 exfer->sqtdstart = setup;
2874 exfer->sqtdend = stat;
2876 if (!exfer->isdone) {
2877 kprintf("ehci_device_request: not done, exfer=%p\n", exfer);
2882 /* Insert qTD in QH list. */
2884 ehci_set_qh_qtd(sqh, setup);
2885 if (xfer->timeout && !sc->sc_bus.use_polling) {
2886 usb_callout(xfer->timeout_handle, MS_TO_TICKS(xfer->timeout),
2887 ehci_timeout, xfer);
2889 ehci_add_intr_list(sc, exfer);
2890 xfer->status = USBD_IN_PROGRESS;
2894 if (ehcidebug > 10) {
2895 DPRINTF(("ehci_device_request: status=%x\n",
2896 EOREAD4(sc, EHCI_USBSTS)));
2899 ehci_dump_sqh(sc->sc_async_head);
2901 ehci_dump_sqtds(setup);
2905 return (USBD_NORMAL_COMPLETION);
2908 ehci_free_sqtd(sc, stat);
2910 ehci_free_sqtd(sc, setup);
2912 DPRINTFN(-1,("ehci_device_request: no memory\n"));
2914 usb_transfer_complete(xfer);
2919 /************************/
2922 ehci_device_bulk_transfer(usbd_xfer_handle xfer)
2926 /* Insert last in queue. */
2927 err = usb_insert_transfer(xfer);
2931 /* Pipe isn't running, start first */
2932 return (ehci_device_bulk_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2936 ehci_device_bulk_start(usbd_xfer_handle xfer)
2938 #define exfer EXFER(xfer)
2939 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2940 usbd_device_handle dev = epipe->pipe.device;
2941 ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
2942 ehci_soft_qtd_t *data, *dataend;
2943 ehci_soft_qh_t *sqh;
2945 int len, isread, endpt;
2947 DPRINTFN(2, ("ehci_device_bulk_start: xfer=%p len=%d flags=%d\n",
2948 xfer, xfer->length, xfer->flags));
2951 return (USBD_IOERROR);
2954 if (xfer->rqflags & URQ_REQUEST)
2955 panic("ehci_device_bulk_start: a request");
2959 endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
2960 isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2963 epipe->u.bulk.length = len;
2965 err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer, &data,
2968 DPRINTFN(-1,("ehci_device_bulk_start: no memory\n"));
2970 usb_transfer_complete(xfer);
2975 if (ehcidebug > 5) {
2976 DPRINTF(("ehci_device_bulk_start: data(1)\n"));
2978 ehci_dump_sqtds(data);
2982 /* Set up interrupt info. */
2983 exfer->sqtdstart = data;
2984 exfer->sqtdend = dataend;
2986 if (!exfer->isdone) {
2987 kprintf("ehci_device_bulk_start: not done, ex=%p\n", exfer);
2993 ehci_set_qh_qtd(sqh, data);
2994 if (xfer->timeout && !sc->sc_bus.use_polling) {
2995 usb_callout(xfer->timeout_handle, MS_TO_TICKS(xfer->timeout),
2996 ehci_timeout, xfer);
2998 ehci_add_intr_list(sc, exfer);
2999 xfer->status = USBD_IN_PROGRESS;
3003 if (ehcidebug > 10) {
3004 DPRINTF(("ehci_device_bulk_start: data(2)\n"));
3006 DPRINTF(("ehci_device_bulk_start: data(3)\n"));
3009 kprintf("async_head:\n");
3010 ehci_dump_sqh(sc->sc_async_head);
3014 ehci_dump_sqtds(data);
3018 if (sc->sc_bus.use_polling)
3019 ehci_waitintr(sc, xfer);
3021 return (USBD_IN_PROGRESS);
3026 ehci_device_bulk_abort(usbd_xfer_handle xfer)
3028 DPRINTF(("ehci_device_bulk_abort: xfer=%p\n", xfer));
3029 ehci_abort_xfer(xfer, USBD_CANCELLED);
3033 * Close a device bulk pipe.
3036 ehci_device_bulk_close(usbd_pipe_handle pipe)
3038 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
3040 DPRINTF(("ehci_device_bulk_close: pipe=%p\n", pipe));
3041 ehci_close_pipe(pipe, sc->sc_async_head);
3045 ehci_device_bulk_done(usbd_xfer_handle xfer)
3047 struct ehci_xfer *ex = EXFER(xfer);
3048 ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
3049 /*struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;*/
3051 DPRINTFN(10,("ehci_bulk_done: xfer=%p, actlen=%d\n",
3052 xfer, xfer->actlen));
3054 if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
3055 ehci_del_intr_list(ex); /* remove from active list */
3056 ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
3059 DPRINTFN(5, ("ehci_bulk_done: length=%d\n", xfer->actlen));
3062 /************************/
3065 ehci_device_setintr(ehci_softc_t *sc, ehci_soft_qh_t *sqh, int ival)
3067 struct ehci_soft_islot *isp;
3070 /* Find a poll rate that is large enough. */
3071 for (lev = EHCI_IPOLLRATES - 1; lev > 0; lev--)
3072 if (EHCI_ILEV_IVAL(lev) <= ival)
3075 /* Pick an interrupt slot at the right level. */
3076 /* XXX could do better than picking at random. */
3077 islot = EHCI_IQHIDX(lev, karc4random());
3080 isp = &sc->sc_islots[islot];
3081 ehci_add_qh(sqh, isp->sqh);
3083 return (USBD_NORMAL_COMPLETION);
3087 ehci_device_intr_transfer(usbd_xfer_handle xfer)
3091 /* Insert last in queue. */
3092 err = usb_insert_transfer(xfer);
3097 * Pipe isn't running (otherwise err would be USBD_INPROG),
3098 * so start it first.
3100 return (ehci_device_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
3104 ehci_device_intr_start(usbd_xfer_handle xfer)
3106 #define exfer EXFER(xfer)
3107 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
3108 usbd_device_handle dev = xfer->pipe->device;
3109 ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
3110 ehci_soft_qtd_t *data, *dataend;
3111 ehci_soft_qh_t *sqh;
3113 int len, isread, endpt;
3115 DPRINTFN(2, ("ehci_device_intr_start: xfer=%p len=%d flags=%d\n",
3116 xfer, xfer->length, xfer->flags));
3119 return (USBD_IOERROR);
3122 if (xfer->rqflags & URQ_REQUEST)
3123 panic("ehci_device_intr_start: a request");
3127 endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
3128 isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3131 epipe->u.intr.length = len;
3133 err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer, &data,
3136 DPRINTFN(-1, ("ehci_device_intr_start: no memory\n"));
3138 usb_transfer_complete(xfer);
3143 if (ehcidebug > 5) {
3144 DPRINTF(("ehci_device_intr_start: data(1)\n"));
3146 ehci_dump_sqtds(data);
3150 /* Set up interrupt info. */
3151 exfer->sqtdstart = data;
3152 exfer->sqtdend = dataend;
3154 if (!exfer->isdone) {
3155 kprintf("ehci_device_intr_start: not done, ex=%p\n", exfer);
3161 ehci_set_qh_qtd(sqh, data);
3162 if (xfer->timeout && !sc->sc_bus.use_polling) {
3163 usb_callout(xfer->timeout_handle, MS_TO_TICKS(xfer->timeout),
3164 ehci_timeout, xfer);
3166 ehci_add_intr_list(sc, exfer);
3167 xfer->status = USBD_IN_PROGRESS;
3171 if (ehcidebug > 10) {
3172 DPRINTF(("ehci_device_intr_start: data(2)\n"));
3174 DPRINTF(("ehci_device_intr_start: data(3)\n"));
3178 ehci_dump_sqtds(data);
3182 if (sc->sc_bus.use_polling)
3183 ehci_waitintr(sc, xfer);
3185 return (USBD_IN_PROGRESS);
3190 ehci_device_intr_abort(usbd_xfer_handle xfer)
3192 DPRINTFN(1, ("ehci_device_intr_abort: xfer=%p\n", xfer));
3193 if (xfer->pipe->intrxfer == xfer) {
3194 DPRINTFN(1, ("ehci_device_intr_abort: remove\n"));
3195 xfer->pipe->intrxfer = NULL;
3197 ehci_abort_xfer(xfer, USBD_CANCELLED);
3201 ehci_device_intr_close(usbd_pipe_handle pipe)
3203 ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
3204 struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
3205 struct ehci_soft_islot *isp;
3207 isp = &sc->sc_islots[epipe->sqh->islot];
3208 ehci_close_pipe(pipe, isp->sqh);
3212 ehci_device_intr_done(usbd_xfer_handle xfer)
3214 #define exfer EXFER(xfer)
3215 struct ehci_xfer *ex = EXFER(xfer);
3216 ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
3217 struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
3218 ehci_soft_qtd_t *data, *dataend;
3219 ehci_soft_qh_t *sqh;
3221 int len, isread, endpt;
3223 DPRINTFN(10, ("ehci_device_intr_done: xfer=%p, actlen=%d\n",
3224 xfer, xfer->actlen));
3226 if (xfer->pipe->repeat) {
3227 ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
3229 len = epipe->u.intr.length;
3231 endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
3232 isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3235 err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer,
3238 DPRINTFN(-1, ("ehci_device_intr_done: no memory\n"));
3243 /* Set up interrupt info. */
3244 exfer->sqtdstart = data;
3245 exfer->sqtdend = dataend;
3247 if (!exfer->isdone) {
3248 kprintf("ehci_device_intr_done: not done, ex=%p\n",
3255 ehci_set_qh_qtd(sqh, data);
3256 if (xfer->timeout && !sc->sc_bus.use_polling) {
3257 usb_callout(xfer->timeout_handle,
3258 MS_TO_TICKS(xfer->timeout), ehci_timeout, xfer);
3262 xfer->status = USBD_IN_PROGRESS;
3263 } else if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
3264 ehci_del_intr_list(ex); /* remove from active list */
3265 ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
3270 /************************/
3273 ehci_device_isoc_transfer(usbd_xfer_handle xfer)
3275 return USBD_IOERROR;
3279 ehci_device_isoc_start(usbd_xfer_handle xfer)
3281 return USBD_IOERROR;
3285 ehci_device_isoc_abort(usbd_xfer_handle xfer)
3290 ehci_device_isoc_close(usbd_pipe_handle pipe)
3295 ehci_device_isoc_done(usbd_xfer_handle xfer)