xref: /netbsd-src/sys/dev/usb/ehci.c (revision e6d6e05cb173f30287ab619b21120b27baa66ad6)
1 /*	$NetBSD: ehci.c,v 1.132 2008/02/22 23:07:12 dyoung Exp $ */
2 
3 /*
4  * Copyright (c) 2004,2005 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net) and by Charles M. Hannum.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
41  *
42  * The EHCI 1.0 spec can be found at
43  * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
44  * and the USB 2.0 spec at
45  * http://www.usb.org/developers/docs/usb_20.zip
46  *
47  */
48 
49 /*
50  * TODO:
51  * 1) hold off explorations by companion controllers until ehci has started.
52  *
53  * 2) The EHCI driver lacks support for isochronous transfers, so
54  *    devices using them don't work.
55  *
56  * 3) The hub driver needs to handle and schedule the transaction translator,
57  *    to assign place in frame where different devices get to go. See chapter
58  *    on hubs in USB 2.0 for details.
59  *
60  * 4) command failures are not recovered correctly
61 */
62 
63 #include <sys/cdefs.h>
64 __KERNEL_RCSID(0, "$NetBSD: ehci.c,v 1.132 2008/02/22 23:07:12 dyoung Exp $");
65 
66 #include "ohci.h"
67 #include "uhci.h"
68 
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/kernel.h>
72 #include <sys/malloc.h>
73 #include <sys/device.h>
74 #include <sys/select.h>
75 #include <sys/proc.h>
76 #include <sys/queue.h>
77 #include <sys/mutex.h>
78 #include <sys/bus.h>
79 
80 #include <machine/endian.h>
81 
82 #include <dev/usb/usb.h>
83 #include <dev/usb/usbdi.h>
84 #include <dev/usb/usbdivar.h>
85 #include <dev/usb/usb_mem.h>
86 #include <dev/usb/usb_quirks.h>
87 
88 #include <dev/usb/ehcireg.h>
89 #include <dev/usb/ehcivar.h>
90 #include <dev/usb/usbroothub_subr.h>
91 
92 #ifdef EHCI_DEBUG
93 #define DPRINTF(x)	do { if (ehcidebug) printf x; } while(0)
94 #define DPRINTFN(n,x)	do { if (ehcidebug>(n)) printf x; } while (0)
95 int ehcidebug = 0;
96 #ifndef __NetBSD__
97 #define bitmask_snprintf(q,f,b,l) snprintf((b), (l), "%b", (q), (f))
98 #endif
99 #else
100 #define DPRINTF(x)
101 #define DPRINTFN(n,x)
102 #endif
103 
104 struct ehci_pipe {
105 	struct usbd_pipe pipe;
106 	int nexttoggle;
107 
108 	ehci_soft_qh_t *sqh;
109 	union {
110 		ehci_soft_qtd_t *qtd;
111 		/* ehci_soft_itd_t *itd; */
112 	} tail;
113 	union {
114 		/* Control pipe */
115 		struct {
116 			usb_dma_t reqdma;
117 			u_int length;
118 		} ctl;
119 		/* Interrupt pipe */
120 		struct {
121 			u_int length;
122 		} intr;
123 		/* Bulk pipe */
124 		struct {
125 			u_int length;
126 		} bulk;
127 		/* Iso pipe */
128 		/* XXX */
129 	} u;
130 };
131 
132 Static void		ehci_shutdown(void *);
133 
134 Static usbd_status	ehci_open(usbd_pipe_handle);
135 Static void		ehci_poll(struct usbd_bus *);
136 Static void		ehci_softintr(void *);
137 Static int		ehci_intr1(ehci_softc_t *);
138 Static void		ehci_waitintr(ehci_softc_t *, usbd_xfer_handle);
139 Static void		ehci_check_intr(ehci_softc_t *, struct ehci_xfer *);
140 Static void		ehci_idone(struct ehci_xfer *);
141 Static void		ehci_timeout(void *);
142 Static void		ehci_timeout_task(void *);
143 Static void		ehci_intrlist_timeout(void *);
144 
145 Static usbd_status	ehci_allocm(struct usbd_bus *, usb_dma_t *, u_int32_t);
146 Static void		ehci_freem(struct usbd_bus *, usb_dma_t *);
147 
148 Static usbd_xfer_handle	ehci_allocx(struct usbd_bus *);
149 Static void		ehci_freex(struct usbd_bus *, usbd_xfer_handle);
150 
151 Static usbd_status	ehci_root_ctrl_transfer(usbd_xfer_handle);
152 Static usbd_status	ehci_root_ctrl_start(usbd_xfer_handle);
153 Static void		ehci_root_ctrl_abort(usbd_xfer_handle);
154 Static void		ehci_root_ctrl_close(usbd_pipe_handle);
155 Static void		ehci_root_ctrl_done(usbd_xfer_handle);
156 
157 Static usbd_status	ehci_root_intr_transfer(usbd_xfer_handle);
158 Static usbd_status	ehci_root_intr_start(usbd_xfer_handle);
159 Static void		ehci_root_intr_abort(usbd_xfer_handle);
160 Static void		ehci_root_intr_close(usbd_pipe_handle);
161 Static void		ehci_root_intr_done(usbd_xfer_handle);
162 
163 Static usbd_status	ehci_device_ctrl_transfer(usbd_xfer_handle);
164 Static usbd_status	ehci_device_ctrl_start(usbd_xfer_handle);
165 Static void		ehci_device_ctrl_abort(usbd_xfer_handle);
166 Static void		ehci_device_ctrl_close(usbd_pipe_handle);
167 Static void		ehci_device_ctrl_done(usbd_xfer_handle);
168 
169 Static usbd_status	ehci_device_bulk_transfer(usbd_xfer_handle);
170 Static usbd_status	ehci_device_bulk_start(usbd_xfer_handle);
171 Static void		ehci_device_bulk_abort(usbd_xfer_handle);
172 Static void		ehci_device_bulk_close(usbd_pipe_handle);
173 Static void		ehci_device_bulk_done(usbd_xfer_handle);
174 
175 Static usbd_status	ehci_device_intr_transfer(usbd_xfer_handle);
176 Static usbd_status	ehci_device_intr_start(usbd_xfer_handle);
177 Static void		ehci_device_intr_abort(usbd_xfer_handle);
178 Static void		ehci_device_intr_close(usbd_pipe_handle);
179 Static void		ehci_device_intr_done(usbd_xfer_handle);
180 
181 Static usbd_status	ehci_device_isoc_transfer(usbd_xfer_handle);
182 Static usbd_status	ehci_device_isoc_start(usbd_xfer_handle);
183 Static void		ehci_device_isoc_abort(usbd_xfer_handle);
184 Static void		ehci_device_isoc_close(usbd_pipe_handle);
185 Static void		ehci_device_isoc_done(usbd_xfer_handle);
186 
187 Static void		ehci_device_clear_toggle(usbd_pipe_handle pipe);
188 Static void		ehci_noop(usbd_pipe_handle pipe);
189 
190 Static void		ehci_pcd(ehci_softc_t *, usbd_xfer_handle);
191 Static void		ehci_disown(ehci_softc_t *, int, int);
192 
193 Static ehci_soft_qh_t  *ehci_alloc_sqh(ehci_softc_t *);
194 Static void		ehci_free_sqh(ehci_softc_t *, ehci_soft_qh_t *);
195 
196 Static ehci_soft_qtd_t  *ehci_alloc_sqtd(ehci_softc_t *);
197 Static void		ehci_free_sqtd(ehci_softc_t *, ehci_soft_qtd_t *);
198 Static usbd_status	ehci_alloc_sqtd_chain(struct ehci_pipe *,
199 			    ehci_softc_t *, int, int, usbd_xfer_handle,
200 			    ehci_soft_qtd_t **, ehci_soft_qtd_t **);
201 Static void		ehci_free_sqtd_chain(ehci_softc_t *, ehci_soft_qtd_t *,
202 					    ehci_soft_qtd_t *);
203 
204 Static usbd_status	ehci_device_request(usbd_xfer_handle xfer);
205 
206 Static usbd_status	ehci_device_setintr(ehci_softc_t *, ehci_soft_qh_t *,
207 			    int ival);
208 
209 Static void		ehci_add_qh(ehci_soft_qh_t *, ehci_soft_qh_t *);
210 Static void		ehci_rem_qh(ehci_softc_t *, ehci_soft_qh_t *,
211 				    ehci_soft_qh_t *);
212 Static void		ehci_set_qh_qtd(ehci_soft_qh_t *, ehci_soft_qtd_t *);
213 Static void		ehci_sync_hc(ehci_softc_t *);
214 
215 Static void		ehci_close_pipe(usbd_pipe_handle, ehci_soft_qh_t *);
216 Static void		ehci_abort_xfer(usbd_xfer_handle, usbd_status);
217 
218 #ifdef EHCI_DEBUG
219 Static void		ehci_dump_regs(ehci_softc_t *);
220 void			ehci_dump(void);
221 Static ehci_softc_t 	*theehci;
222 Static void		ehci_dump_link(ehci_link_t, int);
223 Static void		ehci_dump_sqtds(ehci_soft_qtd_t *);
224 Static void		ehci_dump_sqtd(ehci_soft_qtd_t *);
225 Static void		ehci_dump_qtd(ehci_qtd_t *);
226 Static void		ehci_dump_sqh(ehci_soft_qh_t *);
227 #ifdef DIAGNOSTIC
228 Static void		ehci_dump_exfer(struct ehci_xfer *);
229 #endif
230 #endif
231 
232 #define EHCI_NULL htole32(EHCI_LINK_TERMINATE)
233 
234 #define EHCI_INTR_ENDPT 1
235 
236 #define ehci_add_intr_list(sc, ex) \
237 	LIST_INSERT_HEAD(&(sc)->sc_intrhead, (ex), inext);
238 #define ehci_del_intr_list(ex) \
239 	do { \
240 		LIST_REMOVE((ex), inext); \
241 		(ex)->inext.le_prev = NULL; \
242 	} while (0)
243 #define ehci_active_intr_list(ex) ((ex)->inext.le_prev != NULL)
244 
245 Static const struct usbd_bus_methods ehci_bus_methods = {
246 	ehci_open,
247 	ehci_softintr,
248 	ehci_poll,
249 	ehci_allocm,
250 	ehci_freem,
251 	ehci_allocx,
252 	ehci_freex,
253 };
254 
255 Static const struct usbd_pipe_methods ehci_root_ctrl_methods = {
256 	ehci_root_ctrl_transfer,
257 	ehci_root_ctrl_start,
258 	ehci_root_ctrl_abort,
259 	ehci_root_ctrl_close,
260 	ehci_noop,
261 	ehci_root_ctrl_done,
262 };
263 
264 Static const struct usbd_pipe_methods ehci_root_intr_methods = {
265 	ehci_root_intr_transfer,
266 	ehci_root_intr_start,
267 	ehci_root_intr_abort,
268 	ehci_root_intr_close,
269 	ehci_noop,
270 	ehci_root_intr_done,
271 };
272 
273 Static const struct usbd_pipe_methods ehci_device_ctrl_methods = {
274 	ehci_device_ctrl_transfer,
275 	ehci_device_ctrl_start,
276 	ehci_device_ctrl_abort,
277 	ehci_device_ctrl_close,
278 	ehci_noop,
279 	ehci_device_ctrl_done,
280 };
281 
282 Static const struct usbd_pipe_methods ehci_device_intr_methods = {
283 	ehci_device_intr_transfer,
284 	ehci_device_intr_start,
285 	ehci_device_intr_abort,
286 	ehci_device_intr_close,
287 	ehci_device_clear_toggle,
288 	ehci_device_intr_done,
289 };
290 
291 Static const struct usbd_pipe_methods ehci_device_bulk_methods = {
292 	ehci_device_bulk_transfer,
293 	ehci_device_bulk_start,
294 	ehci_device_bulk_abort,
295 	ehci_device_bulk_close,
296 	ehci_device_clear_toggle,
297 	ehci_device_bulk_done,
298 };
299 
300 Static const struct usbd_pipe_methods ehci_device_isoc_methods = {
301 	ehci_device_isoc_transfer,
302 	ehci_device_isoc_start,
303 	ehci_device_isoc_abort,
304 	ehci_device_isoc_close,
305 	ehci_noop,
306 	ehci_device_isoc_done,
307 };
308 
309 static const uint8_t revbits[EHCI_MAX_POLLRATE] = {
310 0x00,0x40,0x20,0x60,0x10,0x50,0x30,0x70,0x08,0x48,0x28,0x68,0x18,0x58,0x38,0x78,
311 0x04,0x44,0x24,0x64,0x14,0x54,0x34,0x74,0x0c,0x4c,0x2c,0x6c,0x1c,0x5c,0x3c,0x7c,
312 0x02,0x42,0x22,0x62,0x12,0x52,0x32,0x72,0x0a,0x4a,0x2a,0x6a,0x1a,0x5a,0x3a,0x7a,
313 0x06,0x46,0x26,0x66,0x16,0x56,0x36,0x76,0x0e,0x4e,0x2e,0x6e,0x1e,0x5e,0x3e,0x7e,
314 0x01,0x41,0x21,0x61,0x11,0x51,0x31,0x71,0x09,0x49,0x29,0x69,0x19,0x59,0x39,0x79,
315 0x05,0x45,0x25,0x65,0x15,0x55,0x35,0x75,0x0d,0x4d,0x2d,0x6d,0x1d,0x5d,0x3d,0x7d,
316 0x03,0x43,0x23,0x63,0x13,0x53,0x33,0x73,0x0b,0x4b,0x2b,0x6b,0x1b,0x5b,0x3b,0x7b,
317 0x07,0x47,0x27,0x67,0x17,0x57,0x37,0x77,0x0f,0x4f,0x2f,0x6f,0x1f,0x5f,0x3f,0x7f,
318 };
319 
320 usbd_status
321 ehci_init(ehci_softc_t *sc)
322 {
323 	u_int32_t vers, sparams, cparams, hcr;
324 	u_int i;
325 	usbd_status err;
326 	ehci_soft_qh_t *sqh;
327 	u_int ncomp;
328 
329 	DPRINTF(("ehci_init: start\n"));
330 #ifdef EHCI_DEBUG
331 	theehci = sc;
332 #endif
333 
334 	sc->sc_offs = EREAD1(sc, EHCI_CAPLENGTH);
335 
336 	vers = EREAD2(sc, EHCI_HCIVERSION);
337 	aprint_verbose("%s: EHCI version %x.%x\n", USBDEVNAME(sc->sc_bus.bdev),
338 	       vers >> 8, vers & 0xff);
339 
340 	sparams = EREAD4(sc, EHCI_HCSPARAMS);
341 	DPRINTF(("ehci_init: sparams=0x%x\n", sparams));
342 	sc->sc_npcomp = EHCI_HCS_N_PCC(sparams);
343 	ncomp = EHCI_HCS_N_CC(sparams);
344 	if (ncomp != sc->sc_ncomp) {
345 		aprint_verbose("%s: wrong number of companions (%d != %d)\n",
346 		       USBDEVNAME(sc->sc_bus.bdev),
347 		       ncomp, sc->sc_ncomp);
348 #if NOHCI == 0 || NUHCI == 0
349 		aprint_error("%s: ohci or uhci probably not configured\n",
350 			     USBDEVNAME(sc->sc_bus.bdev));
351 #endif
352 		if (ncomp < sc->sc_ncomp)
353 			sc->sc_ncomp = ncomp;
354 	}
355 	if (sc->sc_ncomp > 0) {
356 		aprint_normal("%s: companion controller%s, %d port%s each:",
357 		    USBDEVNAME(sc->sc_bus.bdev), sc->sc_ncomp!=1 ? "s" : "",
358 		    EHCI_HCS_N_PCC(sparams),
359 		    EHCI_HCS_N_PCC(sparams)!=1 ? "s" : "");
360 		for (i = 0; i < sc->sc_ncomp; i++)
361 			aprint_normal(" %s", USBDEVNAME(sc->sc_comps[i]->bdev));
362 		aprint_normal("\n");
363 	}
364 	sc->sc_noport = EHCI_HCS_N_PORTS(sparams);
365 	cparams = EREAD4(sc, EHCI_HCCPARAMS);
366 	DPRINTF(("ehci_init: cparams=0x%x\n", cparams));
367 	sc->sc_hasppc = EHCI_HCS_PPC(sparams);
368 
369 	if (EHCI_HCC_64BIT(cparams)) {
370 		/* MUST clear segment register if 64 bit capable. */
371 		EWRITE4(sc, EHCI_CTRLDSSEGMENT, 0);
372 	}
373 
374 	sc->sc_bus.usbrev = USBREV_2_0;
375 
376 	usb_setup_reserve(sc, &sc->sc_dma_reserve, sc->sc_bus.dmatag,
377 	    USB_MEM_RESERVE);
378 
379 	/* Reset the controller */
380 	DPRINTF(("%s: resetting\n", USBDEVNAME(sc->sc_bus.bdev)));
381 	EOWRITE4(sc, EHCI_USBCMD, 0);	/* Halt controller */
382 	usb_delay_ms(&sc->sc_bus, 1);
383 	EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
384 	for (i = 0; i < 100; i++) {
385 		usb_delay_ms(&sc->sc_bus, 1);
386 		hcr = EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_HCRESET;
387 		if (!hcr)
388 			break;
389 	}
390 	if (hcr) {
391 		aprint_error("%s: reset timeout\n",
392 		    USBDEVNAME(sc->sc_bus.bdev));
393 		return (USBD_IOERROR);
394 	}
395 
396 	/* XXX need proper intr scheduling */
397 	sc->sc_rand = 96;
398 
399 	/* frame list size at default, read back what we got and use that */
400 	switch (EHCI_CMD_FLS(EOREAD4(sc, EHCI_USBCMD))) {
401 	case 0: sc->sc_flsize = 1024; break;
402 	case 1: sc->sc_flsize = 512; break;
403 	case 2: sc->sc_flsize = 256; break;
404 	case 3: return (USBD_IOERROR);
405 	}
406 	err = usb_allocmem(&sc->sc_bus, sc->sc_flsize * sizeof(ehci_link_t),
407 	    EHCI_FLALIGN_ALIGN, &sc->sc_fldma);
408 	if (err)
409 		return (err);
410 	DPRINTF(("%s: flsize=%d\n", USBDEVNAME(sc->sc_bus.bdev),sc->sc_flsize));
411 	sc->sc_flist = KERNADDR(&sc->sc_fldma, 0);
412 	EOWRITE4(sc, EHCI_PERIODICLISTBASE, DMAADDR(&sc->sc_fldma, 0));
413 
414 	/* Set up the bus struct. */
415 	sc->sc_bus.methods = &ehci_bus_methods;
416 	sc->sc_bus.pipe_size = sizeof(struct ehci_pipe);
417 
418 	sc->sc_shutdownhook = shutdownhook_establish(ehci_shutdown, sc);
419 
420 	sc->sc_eintrs = EHCI_NORMAL_INTRS;
421 
422 	/*
423 	 * Allocate the interrupt dummy QHs. These are arranged to give poll
424 	 * intervals that are powers of 2 times 1ms.
425 	 */
426 	for (i = 0; i < EHCI_INTRQHS; i++) {
427 		sqh = ehci_alloc_sqh(sc);
428 		if (sqh == NULL) {
429 			err = USBD_NOMEM;
430 			goto bad1;
431 		}
432 		sc->sc_islots[i].sqh = sqh;
433 	}
434 	for (i = 0; i < EHCI_INTRQHS; i++) {
435 		sqh = sc->sc_islots[i].sqh;
436 		if (i == 0) {
437 			/* The last (1ms) QH terminates. */
438 			sqh->qh.qh_link = EHCI_NULL;
439 			sqh->next = NULL;
440 		} else {
441 			/* Otherwise the next QH has half the poll interval */
442 			sqh->next = sc->sc_islots[(i + 1) / 2 - 1].sqh;
443 			sqh->qh.qh_link = htole32(sqh->next->physaddr |
444 			    EHCI_LINK_QH);
445 		}
446 		sqh->qh.qh_endp = htole32(EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH));
447 		sqh->qh.qh_curqtd = EHCI_NULL;
448 		sqh->next = NULL;
449 		sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
450 		sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
451 		sqh->qh.qh_qtd.qtd_status = htole32(EHCI_QTD_HALTED);
452 		sqh->sqtd = NULL;
453 	}
454 	/* Point the frame list at the last level (128ms). */
455 	for (i = 0; i < sc->sc_flsize; i++) {
456 		int j;
457 
458 		j = (i & ~(EHCI_MAX_POLLRATE-1)) |
459 		    revbits[i & (EHCI_MAX_POLLRATE-1)];
460 		sc->sc_flist[j] = htole32(EHCI_LINK_QH |
461 		    sc->sc_islots[EHCI_IQHIDX(EHCI_IPOLLRATES - 1,
462 		    i)].sqh->physaddr);
463 	}
464 
465 	/* Allocate dummy QH that starts the async list. */
466 	sqh = ehci_alloc_sqh(sc);
467 	if (sqh == NULL) {
468 		err = USBD_NOMEM;
469 		goto bad1;
470 	}
471 	/* Fill the QH */
472 	sqh->qh.qh_endp =
473 	    htole32(EHCI_QH_SET_EPS(EHCI_QH_SPEED_HIGH) | EHCI_QH_HRECL);
474 	sqh->qh.qh_link =
475 	    htole32(sqh->physaddr | EHCI_LINK_QH);
476 	sqh->qh.qh_curqtd = EHCI_NULL;
477 	sqh->next = NULL;
478 	/* Fill the overlay qTD */
479 	sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
480 	sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
481 	sqh->qh.qh_qtd.qtd_status = htole32(EHCI_QTD_HALTED);
482 	sqh->sqtd = NULL;
483 #ifdef EHCI_DEBUG
484 	if (ehcidebug) {
485 		ehci_dump_sqh(sqh);
486 	}
487 #endif
488 
489 	/* Point to async list */
490 	sc->sc_async_head = sqh;
491 	EOWRITE4(sc, EHCI_ASYNCLISTADDR, sqh->physaddr | EHCI_LINK_QH);
492 
493 	usb_callout_init(sc->sc_tmo_intrlist);
494 
495 	mutex_init(&sc->sc_doorbell_lock, MUTEX_DEFAULT, IPL_NONE);
496 
497 	/* Turn on controller */
498 	EOWRITE4(sc, EHCI_USBCMD,
499 		 EHCI_CMD_ITC_2 | /* 2 microframes interrupt delay */
500 		 (EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_FLS_M) |
501 		 EHCI_CMD_ASE |
502 		 EHCI_CMD_PSE |
503 		 EHCI_CMD_RS);
504 
505 	/* Take over port ownership */
506 	EOWRITE4(sc, EHCI_CONFIGFLAG, EHCI_CONF_CF);
507 
508 	for (i = 0; i < 100; i++) {
509 		usb_delay_ms(&sc->sc_bus, 1);
510 		hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
511 		if (!hcr)
512 			break;
513 	}
514 	if (hcr) {
515 		aprint_error("%s: run timeout\n", USBDEVNAME(sc->sc_bus.bdev));
516 		return (USBD_IOERROR);
517 	}
518 
519 	/* Enable interrupts */
520 	DPRINTFN(1,("ehci_init: enabling\n"));
521 	EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
522 
523 	return (USBD_NORMAL_COMPLETION);
524 
525 #if 0
526  bad2:
527 	ehci_free_sqh(sc, sc->sc_async_head);
528 #endif
529  bad1:
530 	usb_freemem(&sc->sc_bus, &sc->sc_fldma);
531 	return (err);
532 }
533 
534 int
535 ehci_intr(void *v)
536 {
537 	ehci_softc_t *sc = v;
538 
539 	if (sc == NULL || sc->sc_dying || !device_has_power(&sc->sc_bus.bdev))
540 		return (0);
541 
542 	/* If we get an interrupt while polling, then just ignore it. */
543 	if (sc->sc_bus.use_polling) {
544 		u_int32_t intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
545 
546 		if (intrs)
547 			EOWRITE4(sc, EHCI_USBSTS, intrs); /* Acknowledge */
548 #ifdef DIAGNOSTIC
549 		DPRINTFN(16, ("ehci_intr: ignored interrupt while polling\n"));
550 #endif
551 		return (0);
552 	}
553 
554 	return (ehci_intr1(sc));
555 }
556 
557 Static int
558 ehci_intr1(ehci_softc_t *sc)
559 {
560 	u_int32_t intrs, eintrs;
561 
562 	DPRINTFN(20,("ehci_intr1: enter\n"));
563 
564 	/* In case the interrupt occurs before initialization has completed. */
565 	if (sc == NULL) {
566 #ifdef DIAGNOSTIC
567 		printf("ehci_intr1: sc == NULL\n");
568 #endif
569 		return (0);
570 	}
571 
572 	intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
573 	if (!intrs)
574 		return (0);
575 
576 	eintrs = intrs & sc->sc_eintrs;
577 	DPRINTFN(7, ("ehci_intr1: sc=%p intrs=0x%x(0x%x) eintrs=0x%x\n",
578 		     sc, (u_int)intrs, EOREAD4(sc, EHCI_USBSTS),
579 		     (u_int)eintrs));
580 	if (!eintrs)
581 		return (0);
582 
583 	EOWRITE4(sc, EHCI_USBSTS, intrs); /* Acknowledge */
584 	sc->sc_bus.intr_context++;
585 	sc->sc_bus.no_intrs++;
586 	if (eintrs & EHCI_STS_IAA) {
587 		DPRINTF(("ehci_intr1: door bell\n"));
588 		wakeup(&sc->sc_async_head);
589 		eintrs &= ~EHCI_STS_IAA;
590 	}
591 	if (eintrs & (EHCI_STS_INT | EHCI_STS_ERRINT)) {
592 		DPRINTFN(5,("ehci_intr1: %s %s\n",
593 			    eintrs & EHCI_STS_INT ? "INT" : "",
594 			    eintrs & EHCI_STS_ERRINT ? "ERRINT" : ""));
595 		usb_schedsoftintr(&sc->sc_bus);
596 		eintrs &= ~(EHCI_STS_INT | EHCI_STS_ERRINT);
597 	}
598 	if (eintrs & EHCI_STS_HSE) {
599 		printf("%s: unrecoverable error, controller halted\n",
600 		       USBDEVNAME(sc->sc_bus.bdev));
601 		/* XXX what else */
602 	}
603 	if (eintrs & EHCI_STS_PCD) {
604 		ehci_pcd(sc, sc->sc_intrxfer);
605 		eintrs &= ~EHCI_STS_PCD;
606 	}
607 
608 	sc->sc_bus.intr_context--;
609 
610 	if (eintrs != 0) {
611 		/* Block unprocessed interrupts. */
612 		sc->sc_eintrs &= ~eintrs;
613 		EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
614 		printf("%s: blocking intrs 0x%x\n",
615 		       USBDEVNAME(sc->sc_bus.bdev), eintrs);
616 	}
617 
618 	return (1);
619 }
620 
621 
622 void
623 ehci_pcd(ehci_softc_t *sc, usbd_xfer_handle xfer)
624 {
625 	usbd_pipe_handle pipe;
626 	u_char *p;
627 	int i, m;
628 
629 	if (xfer == NULL) {
630 		/* Just ignore the change. */
631 		return;
632 	}
633 
634 	pipe = xfer->pipe;
635 
636 	p = KERNADDR(&xfer->dmabuf, 0);
637 	m = min(sc->sc_noport, xfer->length * 8 - 1);
638 	memset(p, 0, xfer->length);
639 	for (i = 1; i <= m; i++) {
640 		/* Pick out CHANGE bits from the status reg. */
641 		if (EOREAD4(sc, EHCI_PORTSC(i)) & EHCI_PS_CLEAR)
642 			p[i/8] |= 1 << (i%8);
643 	}
644 	DPRINTF(("ehci_pcd: change=0x%02x\n", *p));
645 	xfer->actlen = xfer->length;
646 	xfer->status = USBD_NORMAL_COMPLETION;
647 
648 	usb_transfer_complete(xfer);
649 }
650 
651 void
652 ehci_softintr(void *v)
653 {
654 	ehci_softc_t *sc = v;
655 	struct ehci_xfer *ex, *nextex;
656 
657 	DPRINTFN(10,("%s: ehci_softintr (%d)\n", USBDEVNAME(sc->sc_bus.bdev),
658 		     sc->sc_bus.intr_context));
659 
660 	sc->sc_bus.intr_context++;
661 
662 	/*
663 	 * The only explanation I can think of for why EHCI is as brain dead
664 	 * as UHCI interrupt-wise is that Intel was involved in both.
665 	 * An interrupt just tells us that something is done, we have no
666 	 * clue what, so we need to scan through all active transfers. :-(
667 	 */
668 	for (ex = LIST_FIRST(&sc->sc_intrhead); ex; ex = nextex) {
669 		nextex = LIST_NEXT(ex, inext);
670 		ehci_check_intr(sc, ex);
671 	}
672 
673 	/* Schedule a callout to catch any dropped transactions. */
674 	if ((sc->sc_flags & EHCIF_DROPPED_INTR_WORKAROUND) &&
675 	    !LIST_EMPTY(&sc->sc_intrhead))
676 		usb_callout(sc->sc_tmo_intrlist, hz,
677 		    ehci_intrlist_timeout, sc);
678 
679 #ifdef USB_USE_SOFTINTR
680 	if (sc->sc_softwake) {
681 		sc->sc_softwake = 0;
682 		wakeup(&sc->sc_softwake);
683 	}
684 #endif /* USB_USE_SOFTINTR */
685 
686 	sc->sc_bus.intr_context--;
687 }
688 
689 /* Check for an interrupt. */
690 void
691 ehci_check_intr(ehci_softc_t *sc, struct ehci_xfer *ex)
692 {
693 	ehci_soft_qtd_t *sqtd, *lsqtd;
694 	u_int32_t status;
695 
696 	DPRINTFN(/*15*/2, ("ehci_check_intr: ex=%p\n", ex));
697 
698 	if (ex->sqtdstart == NULL) {
699 		printf("ehci_check_intr: sqtdstart=NULL\n");
700 		return;
701 	}
702 	lsqtd = ex->sqtdend;
703 #ifdef DIAGNOSTIC
704 	if (lsqtd == NULL) {
705 		printf("ehci_check_intr: lsqtd==0\n");
706 		return;
707 	}
708 #endif
709 	/*
710 	 * If the last TD is still active we need to check whether there
711 	 * is a an error somewhere in the middle, or whether there was a
712 	 * short packet (SPD and not ACTIVE).
713 	 */
714 	if (le32toh(lsqtd->qtd.qtd_status) & EHCI_QTD_ACTIVE) {
715 		DPRINTFN(12, ("ehci_check_intr: active ex=%p\n", ex));
716 		for (sqtd = ex->sqtdstart; sqtd != lsqtd; sqtd=sqtd->nextqtd) {
717 			status = le32toh(sqtd->qtd.qtd_status);
718 			/* If there's an active QTD the xfer isn't done. */
719 			if (status & EHCI_QTD_ACTIVE)
720 				break;
721 			/* Any kind of error makes the xfer done. */
722 			if (status & EHCI_QTD_HALTED)
723 				goto done;
724 			/* We want short packets, and it is short: it's done */
725 			if (EHCI_QTD_GET_BYTES(status) != 0)
726 				goto done;
727 		}
728 		DPRINTFN(12, ("ehci_check_intr: ex=%p std=%p still active\n",
729 			      ex, ex->sqtdstart));
730 		return;
731 	}
732  done:
733 	DPRINTFN(12, ("ehci_check_intr: ex=%p done\n", ex));
734 	usb_uncallout(ex->xfer.timeout_handle, ehci_timeout, ex);
735 	ehci_idone(ex);
736 }
737 
738 void
739 ehci_idone(struct ehci_xfer *ex)
740 {
741 	usbd_xfer_handle xfer = &ex->xfer;
742 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
743 	ehci_soft_qtd_t *sqtd, *lsqtd;
744 	u_int32_t status = 0, nstatus = 0;
745 	int actlen;
746 
747 	DPRINTFN(/*12*/2, ("ehci_idone: ex=%p\n", ex));
748 #ifdef DIAGNOSTIC
749 	{
750 		int s = splhigh();
751 		if (ex->isdone) {
752 			splx(s);
753 #ifdef EHCI_DEBUG
754 			printf("ehci_idone: ex is done!\n   ");
755 			ehci_dump_exfer(ex);
756 #else
757 			printf("ehci_idone: ex=%p is done!\n", ex);
758 #endif
759 			return;
760 		}
761 		ex->isdone = 1;
762 		splx(s);
763 	}
764 #endif
765 
766 	if (xfer->status == USBD_CANCELLED ||
767 	    xfer->status == USBD_TIMEOUT) {
768 		DPRINTF(("ehci_idone: aborted xfer=%p\n", xfer));
769 		return;
770 	}
771 
772 #ifdef EHCI_DEBUG
773 	DPRINTFN(/*10*/2, ("ehci_idone: xfer=%p, pipe=%p ready\n", xfer, epipe));
774 	if (ehcidebug > 10)
775 		ehci_dump_sqtds(ex->sqtdstart);
776 #endif
777 
778 	/* The transfer is done, compute actual length and status. */
779 	lsqtd = ex->sqtdend;
780 	actlen = 0;
781 	for (sqtd = ex->sqtdstart; sqtd != lsqtd->nextqtd; sqtd=sqtd->nextqtd) {
782 		nstatus = le32toh(sqtd->qtd.qtd_status);
783 		if (nstatus & EHCI_QTD_ACTIVE)
784 			break;
785 
786 		status = nstatus;
787 		if (EHCI_QTD_GET_PID(status) !=	EHCI_QTD_PID_SETUP)
788 			actlen += sqtd->len - EHCI_QTD_GET_BYTES(status);
789 	}
790 
791 	/*
792 	 * If there are left over TDs we need to update the toggle.
793 	 * The default pipe doesn't need it since control transfers
794 	 * start the toggle at 0 every time.
795 	 * For a short transfer we need to update the toggle for the missing
796 	 * packets within the qTD.
797 	 */
798 	if ((sqtd != lsqtd->nextqtd || EHCI_QTD_GET_BYTES(status)) &&
799 	    xfer->pipe->device->default_pipe != xfer->pipe) {
800 		DPRINTFN(2, ("ehci_idone: need toggle update "
801 			     "status=%08x nstatus=%08x\n", status, nstatus));
802 #if 0
803 		ehci_dump_sqh(epipe->sqh);
804 		ehci_dump_sqtds(ex->sqtdstart);
805 #endif
806 		epipe->nexttoggle = EHCI_QTD_GET_TOGGLE(nstatus);
807 	}
808 
809 	DPRINTFN(/*10*/2, ("ehci_idone: len=%d, actlen=%d, status=0x%x\n",
810 			   xfer->length, actlen, status));
811 	xfer->actlen = actlen;
812 	if (status & EHCI_QTD_HALTED) {
813 #ifdef EHCI_DEBUG
814 		char sbuf[128];
815 
816 		bitmask_snprintf((u_int32_t)status,
817 				 "\20\7HALTED\6BUFERR\5BABBLE\4XACTERR"
818 				 "\3MISSED\1PINGSTATE", sbuf, sizeof(sbuf));
819 
820 		DPRINTFN(2, ("ehci_idone: error, addr=%d, endpt=0x%02x, "
821 			  "status 0x%s\n",
822 			  xfer->pipe->device->address,
823 			  xfer->pipe->endpoint->edesc->bEndpointAddress,
824 			  sbuf));
825 		if (ehcidebug > 2) {
826 			ehci_dump_sqh(epipe->sqh);
827 			ehci_dump_sqtds(ex->sqtdstart);
828 		}
829 #endif
830 		/* low&full speed has an extra error flag */
831 		if (EHCI_QH_GET_EPS(epipe->sqh->qh.qh_endp) !=
832 		    EHCI_QH_SPEED_HIGH)
833 			status &= EHCI_QTD_STATERRS | EHCI_QTD_PINGSTATE;
834 		else
835 			status &= EHCI_QTD_STATERRS;
836 		if (status == 0) /* no other errors means a stall */
837 			xfer->status = USBD_STALLED;
838 		else
839 			xfer->status = USBD_IOERROR; /* more info XXX */
840 		/* XXX need to reset TT on missed microframe */
841 		if (status & EHCI_QTD_MISSEDMICRO) {
842 			ehci_softc_t *sc = (ehci_softc_t *)
843 			    xfer->pipe->device->bus;
844 
845 			printf("%s: missed microframe, TT reset not "
846 			    "implemented, hub might be inoperational\n",
847 			    USBDEVNAME(sc->sc_bus.bdev));
848 		}
849 	} else {
850 		xfer->status = USBD_NORMAL_COMPLETION;
851 	}
852 
853 	usb_transfer_complete(xfer);
854 	DPRINTFN(/*12*/2, ("ehci_idone: ex=%p done\n", ex));
855 }
856 
857 /*
858  * Wait here until controller claims to have an interrupt.
859  * Then call ehci_intr and return.  Use timeout to avoid waiting
860  * too long.
861  */
862 void
863 ehci_waitintr(ehci_softc_t *sc, usbd_xfer_handle xfer)
864 {
865 	int timo;
866 	u_int32_t intrs;
867 
868 	xfer->status = USBD_IN_PROGRESS;
869 	for (timo = xfer->timeout; timo >= 0; timo--) {
870 		usb_delay_ms(&sc->sc_bus, 1);
871 		if (sc->sc_dying)
872 			break;
873 		intrs = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS)) &
874 			sc->sc_eintrs;
875 		DPRINTFN(15,("ehci_waitintr: 0x%04x\n", intrs));
876 #ifdef EHCI_DEBUG
877 		if (ehcidebug > 15)
878 			ehci_dump_regs(sc);
879 #endif
880 		if (intrs) {
881 			ehci_intr1(sc);
882 			if (xfer->status != USBD_IN_PROGRESS)
883 				return;
884 		}
885 	}
886 
887 	/* Timeout */
888 	DPRINTF(("ehci_waitintr: timeout\n"));
889 	xfer->status = USBD_TIMEOUT;
890 	usb_transfer_complete(xfer);
891 	/* XXX should free TD */
892 }
893 
894 void
895 ehci_poll(struct usbd_bus *bus)
896 {
897 	ehci_softc_t *sc = (ehci_softc_t *)bus;
898 #ifdef EHCI_DEBUG
899 	static int last;
900 	int new;
901 	new = EHCI_STS_INTRS(EOREAD4(sc, EHCI_USBSTS));
902 	if (new != last) {
903 		DPRINTFN(10,("ehci_poll: intrs=0x%04x\n", new));
904 		last = new;
905 	}
906 #endif
907 
908 	if (EOREAD4(sc, EHCI_USBSTS) & sc->sc_eintrs)
909 		ehci_intr1(sc);
910 }
911 
912 void
913 ehci_childdet(device_t self, device_t child)
914 {
915 	struct ehci_softc *sc = device_private(self);
916 
917 	KASSERT(sc->sc_child == child);
918 	sc->sc_child = NULL;
919 }
920 
921 int
922 ehci_detach(struct ehci_softc *sc, int flags)
923 {
924 	int rv = 0;
925 
926 	if (sc->sc_child != NULL)
927 		rv = config_detach(sc->sc_child, flags);
928 
929 	if (rv != 0)
930 		return (rv);
931 
932 	usb_uncallout(sc->sc_tmo_intrlist, ehci_intrlist_timeout, sc);
933 
934 	if (sc->sc_shutdownhook != NULL)
935 		shutdownhook_disestablish(sc->sc_shutdownhook);
936 
937 	usb_delay_ms(&sc->sc_bus, 300); /* XXX let stray task complete */
938 
939 	/* XXX free other data structures XXX */
940 	mutex_destroy(&sc->sc_doorbell_lock);
941 
942 	EOWRITE4(sc, EHCI_CONFIGFLAG, 0);
943 
944 	return (rv);
945 }
946 
947 
948 int
949 ehci_activate(device_t self, enum devact act)
950 {
951 	struct ehci_softc *sc = device_private(self);
952 	int rv = 0;
953 
954 	switch (act) {
955 	case DVACT_ACTIVATE:
956 		return (EOPNOTSUPP);
957 
958 	case DVACT_DEACTIVATE:
959 		sc->sc_dying = 1;
960 		if (sc->sc_child != NULL)
961 			rv = config_deactivate(sc->sc_child);
962 		break;
963 	}
964 	return (rv);
965 }
966 
967 /*
968  * Handle suspend/resume.
969  *
970  * We need to switch to polling mode here, because this routine is
971  * called from an interrupt context.  This is all right since we
972  * are almost suspended anyway.
973  *
974  * Note that this power handler isn't to be registered directly; the
975  * bus glue needs to call out to it.
976  */
977 bool
978 ehci_suspend(device_t dv PMF_FN_ARGS)
979 {
980 	ehci_softc_t *sc = device_private(dv);
981 	int i, s;
982 	uint32_t cmd, hcr;
983 
984 	s = splhardusb();
985 
986 	sc->sc_bus.use_polling++;
987 
988 	for (i = 1; i <= sc->sc_noport; i++) {
989 		cmd = EOREAD4(sc, EHCI_PORTSC(i)) & ~EHCI_PS_CLEAR;
990 		if ((cmd & EHCI_PS_PO) == 0 && (cmd & EHCI_PS_PE) == EHCI_PS_PE)
991 			EOWRITE4(sc, EHCI_PORTSC(i), cmd | EHCI_PS_SUSP);
992 	}
993 
994 	sc->sc_cmd = EOREAD4(sc, EHCI_USBCMD);
995 
996 	cmd = sc->sc_cmd & ~(EHCI_CMD_ASE | EHCI_CMD_PSE);
997 	EOWRITE4(sc, EHCI_USBCMD, cmd);
998 
999 	for (i = 0; i < 100; i++) {
1000 		hcr = EOREAD4(sc, EHCI_USBSTS) & (EHCI_STS_ASS | EHCI_STS_PSS);
1001 		if (hcr == 0)
1002 			break;
1003 
1004 		usb_delay_ms(&sc->sc_bus, 1);
1005 	}
1006 	if (hcr != 0)
1007 		printf("%s: reset timeout\n", USBDEVNAME(sc->sc_bus.bdev));
1008 
1009 	cmd &= ~EHCI_CMD_RS;
1010 	EOWRITE4(sc, EHCI_USBCMD, cmd);
1011 
1012 	for (i = 0; i < 100; i++) {
1013 		hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
1014 		if (hcr == EHCI_STS_HCH)
1015 			break;
1016 
1017 		usb_delay_ms(&sc->sc_bus, 1);
1018 	}
1019 	if (hcr != EHCI_STS_HCH)
1020 		printf("%s: config timeout\n", USBDEVNAME(sc->sc_bus.bdev));
1021 
1022 	sc->sc_bus.use_polling--;
1023 	splx(s);
1024 
1025 	return true;
1026 }
1027 
1028 bool
1029 ehci_resume(device_t dv PMF_FN_ARGS)
1030 {
1031 	ehci_softc_t *sc = device_private(dv);
1032 	int i;
1033 	uint32_t cmd, hcr;
1034 
1035 	/* restore things in case the bios sucks */
1036 	EOWRITE4(sc, EHCI_CTRLDSSEGMENT, 0);
1037 	EOWRITE4(sc, EHCI_PERIODICLISTBASE, DMAADDR(&sc->sc_fldma, 0));
1038 	EOWRITE4(sc, EHCI_ASYNCLISTADDR,
1039 	    sc->sc_async_head->physaddr | EHCI_LINK_QH);
1040 
1041 	EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs & ~EHCI_INTR_PCIE);
1042 
1043 	EOWRITE4(sc, EHCI_USBCMD, sc->sc_cmd);
1044 
1045 	hcr = 0;
1046 	for (i = 1; i <= sc->sc_noport; i++) {
1047 		cmd = EOREAD4(sc, EHCI_PORTSC(i)) & ~EHCI_PS_CLEAR;
1048 		if ((cmd & EHCI_PS_PO) == 0 &&
1049 		    (cmd & EHCI_PS_SUSP) == EHCI_PS_SUSP) {
1050 			EOWRITE4(sc, EHCI_PORTSC(i), cmd | EHCI_PS_FPR);
1051 			hcr = 1;
1052 		}
1053 	}
1054 
1055 	if (hcr) {
1056 		usb_delay_ms(&sc->sc_bus, USB_RESUME_WAIT);
1057 
1058 		for (i = 1; i <= sc->sc_noport; i++) {
1059 			cmd = EOREAD4(sc, EHCI_PORTSC(i)) & ~EHCI_PS_CLEAR;
1060 			if ((cmd & EHCI_PS_PO) == 0 &&
1061 			    (cmd & EHCI_PS_SUSP) == EHCI_PS_SUSP)
1062 				EOWRITE4(sc, EHCI_PORTSC(i),
1063 				    cmd & ~EHCI_PS_FPR);
1064 		}
1065 	}
1066 
1067 	EOWRITE4(sc, EHCI_USBCMD, sc->sc_cmd);
1068 	EOWRITE4(sc, EHCI_USBINTR, sc->sc_eintrs);
1069 
1070 	for (i = 0; i < 100; i++) {
1071 		hcr = EOREAD4(sc, EHCI_USBSTS) & EHCI_STS_HCH;
1072 		if (hcr != EHCI_STS_HCH)
1073 			break;
1074 
1075 		usb_delay_ms(&sc->sc_bus, 1);
1076 	}
1077 	if (hcr == EHCI_STS_HCH)
1078 		printf("%s: config timeout\n", USBDEVNAME(sc->sc_bus.bdev));
1079 
1080 	return true;
1081 }
1082 
1083 /*
1084  * Shut down the controller when the system is going down.
1085  */
1086 void
1087 ehci_shutdown(void *v)
1088 {
1089 	ehci_softc_t *sc = v;
1090 
1091 	DPRINTF(("ehci_shutdown: stopping the HC\n"));
1092 	EOWRITE4(sc, EHCI_USBCMD, 0);	/* Halt controller */
1093 	EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
1094 }
1095 
1096 usbd_status
1097 ehci_allocm(struct usbd_bus *bus, usb_dma_t *dma, u_int32_t size)
1098 {
1099 	struct ehci_softc *sc = (struct ehci_softc *)bus;
1100 	usbd_status err;
1101 
1102 	err = usb_allocmem(&sc->sc_bus, size, 0, dma);
1103 	if (err == USBD_NOMEM)
1104 		err = usb_reserve_allocm(&sc->sc_dma_reserve, dma, size);
1105 #ifdef EHCI_DEBUG
1106 	if (err)
1107 		printf("ehci_allocm: usb_allocmem()=%d\n", err);
1108 #endif
1109 	return (err);
1110 }
1111 
1112 void
1113 ehci_freem(struct usbd_bus *bus, usb_dma_t *dma)
1114 {
1115 	struct ehci_softc *sc = (struct ehci_softc *)bus;
1116 
1117 	if (dma->block->flags & USB_DMA_RESERVE) {
1118 		usb_reserve_freem(&((struct ehci_softc *)bus)->sc_dma_reserve,
1119 		    dma);
1120 		return;
1121 	}
1122 	usb_freemem(&sc->sc_bus, dma);
1123 }
1124 
1125 usbd_xfer_handle
1126 ehci_allocx(struct usbd_bus *bus)
1127 {
1128 	struct ehci_softc *sc = (struct ehci_softc *)bus;
1129 	usbd_xfer_handle xfer;
1130 
1131 	xfer = SIMPLEQ_FIRST(&sc->sc_free_xfers);
1132 	if (xfer != NULL) {
1133 		SIMPLEQ_REMOVE_HEAD(&sc->sc_free_xfers, next);
1134 #ifdef DIAGNOSTIC
1135 		if (xfer->busy_free != XFER_FREE) {
1136 			printf("ehci_allocx: xfer=%p not free, 0x%08x\n", xfer,
1137 			       xfer->busy_free);
1138 		}
1139 #endif
1140 	} else {
1141 		xfer = malloc(sizeof(struct ehci_xfer), M_USB, M_NOWAIT);
1142 	}
1143 	if (xfer != NULL) {
1144 		memset(xfer, 0, sizeof(struct ehci_xfer));
1145 #ifdef DIAGNOSTIC
1146 		EXFER(xfer)->isdone = 1;
1147 		xfer->busy_free = XFER_BUSY;
1148 #endif
1149 	}
1150 	return (xfer);
1151 }
1152 
1153 void
1154 ehci_freex(struct usbd_bus *bus, usbd_xfer_handle xfer)
1155 {
1156 	struct ehci_softc *sc = (struct ehci_softc *)bus;
1157 
1158 #ifdef DIAGNOSTIC
1159 	if (xfer->busy_free != XFER_BUSY) {
1160 		printf("ehci_freex: xfer=%p not busy, 0x%08x\n", xfer,
1161 		       xfer->busy_free);
1162 	}
1163 	xfer->busy_free = XFER_FREE;
1164 	if (!EXFER(xfer)->isdone) {
1165 		printf("ehci_freex: !isdone\n");
1166 	}
1167 #endif
1168 	SIMPLEQ_INSERT_HEAD(&sc->sc_free_xfers, xfer, next);
1169 }
1170 
1171 Static void
1172 ehci_device_clear_toggle(usbd_pipe_handle pipe)
1173 {
1174 	struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
1175 
1176 	DPRINTF(("ehci_device_clear_toggle: epipe=%p status=0x%x\n",
1177 		 epipe, epipe->sqh->qh.qh_qtd.qtd_status));
1178 #ifdef USB_DEBUG
1179 	if (ehcidebug)
1180 		usbd_dump_pipe(pipe);
1181 #endif
1182 	epipe->nexttoggle = 0;
1183 }
1184 
1185 Static void
1186 ehci_noop(usbd_pipe_handle pipe)
1187 {
1188 }
1189 
1190 #ifdef EHCI_DEBUG
1191 void
1192 ehci_dump_regs(ehci_softc_t *sc)
1193 {
1194 	int i;
1195 	printf("cmd=0x%08x, sts=0x%08x, ien=0x%08x\n",
1196 	       EOREAD4(sc, EHCI_USBCMD),
1197 	       EOREAD4(sc, EHCI_USBSTS),
1198 	       EOREAD4(sc, EHCI_USBINTR));
1199 	printf("frindex=0x%08x ctrdsegm=0x%08x periodic=0x%08x async=0x%08x\n",
1200 	       EOREAD4(sc, EHCI_FRINDEX),
1201 	       EOREAD4(sc, EHCI_CTRLDSSEGMENT),
1202 	       EOREAD4(sc, EHCI_PERIODICLISTBASE),
1203 	       EOREAD4(sc, EHCI_ASYNCLISTADDR));
1204 	for (i = 1; i <= sc->sc_noport; i++)
1205 		printf("port %d status=0x%08x\n", i,
1206 		       EOREAD4(sc, EHCI_PORTSC(i)));
1207 }
1208 
1209 /*
1210  * Unused function - this is meant to be called from a kernel
1211  * debugger.
1212  */
1213 void
1214 ehci_dump()
1215 {
1216 	ehci_dump_regs(theehci);
1217 }
1218 
1219 void
1220 ehci_dump_link(ehci_link_t link, int type)
1221 {
1222 	link = le32toh(link);
1223 	printf("0x%08x", link);
1224 	if (link & EHCI_LINK_TERMINATE)
1225 		printf("<T>");
1226 	else {
1227 		printf("<");
1228 		if (type) {
1229 			switch (EHCI_LINK_TYPE(link)) {
1230 			case EHCI_LINK_ITD: printf("ITD"); break;
1231 			case EHCI_LINK_QH: printf("QH"); break;
1232 			case EHCI_LINK_SITD: printf("SITD"); break;
1233 			case EHCI_LINK_FSTN: printf("FSTN"); break;
1234 			}
1235 		}
1236 		printf(">");
1237 	}
1238 }
1239 
1240 void
1241 ehci_dump_sqtds(ehci_soft_qtd_t *sqtd)
1242 {
1243 	int i;
1244 	u_int32_t stop;
1245 
1246 	stop = 0;
1247 	for (i = 0; sqtd && i < 20 && !stop; sqtd = sqtd->nextqtd, i++) {
1248 		ehci_dump_sqtd(sqtd);
1249 		stop = sqtd->qtd.qtd_next & htole32(EHCI_LINK_TERMINATE);
1250 	}
1251 	if (sqtd)
1252 		printf("dump aborted, too many TDs\n");
1253 }
1254 
1255 void
1256 ehci_dump_sqtd(ehci_soft_qtd_t *sqtd)
1257 {
1258 	printf("QTD(%p) at 0x%08x:\n", sqtd, sqtd->physaddr);
1259 	ehci_dump_qtd(&sqtd->qtd);
1260 }
1261 
1262 void
1263 ehci_dump_qtd(ehci_qtd_t *qtd)
1264 {
1265 	u_int32_t s;
1266 	char sbuf[128];
1267 
1268 	printf("  next="); ehci_dump_link(qtd->qtd_next, 0);
1269 	printf(" altnext="); ehci_dump_link(qtd->qtd_altnext, 0);
1270 	printf("\n");
1271 	s = le32toh(qtd->qtd_status);
1272 	bitmask_snprintf(EHCI_QTD_GET_STATUS(s),
1273 			 "\20\10ACTIVE\7HALTED\6BUFERR\5BABBLE\4XACTERR"
1274 			 "\3MISSED\2SPLIT\1PING", sbuf, sizeof(sbuf));
1275 	printf("  status=0x%08x: toggle=%d bytes=0x%x ioc=%d c_page=0x%x\n",
1276 	       s, EHCI_QTD_GET_TOGGLE(s), EHCI_QTD_GET_BYTES(s),
1277 	       EHCI_QTD_GET_IOC(s), EHCI_QTD_GET_C_PAGE(s));
1278 	printf("    cerr=%d pid=%d stat=0x%s\n", EHCI_QTD_GET_CERR(s),
1279 	       EHCI_QTD_GET_PID(s), sbuf);
1280 	for (s = 0; s < 5; s++)
1281 		printf("  buffer[%d]=0x%08x\n", s, le32toh(qtd->qtd_buffer[s]));
1282 }
1283 
1284 void
1285 ehci_dump_sqh(ehci_soft_qh_t *sqh)
1286 {
1287 	ehci_qh_t *qh = &sqh->qh;
1288 	u_int32_t endp, endphub;
1289 
1290 	printf("QH(%p) at 0x%08x:\n", sqh, sqh->physaddr);
1291 	printf("  link="); ehci_dump_link(qh->qh_link, 1); printf("\n");
1292 	endp = le32toh(qh->qh_endp);
1293 	printf("  endp=0x%08x\n", endp);
1294 	printf("    addr=0x%02x inact=%d endpt=%d eps=%d dtc=%d hrecl=%d\n",
1295 	       EHCI_QH_GET_ADDR(endp), EHCI_QH_GET_INACT(endp),
1296 	       EHCI_QH_GET_ENDPT(endp),  EHCI_QH_GET_EPS(endp),
1297 	       EHCI_QH_GET_DTC(endp), EHCI_QH_GET_HRECL(endp));
1298 	printf("    mpl=0x%x ctl=%d nrl=%d\n",
1299 	       EHCI_QH_GET_MPL(endp), EHCI_QH_GET_CTL(endp),
1300 	       EHCI_QH_GET_NRL(endp));
1301 	endphub = le32toh(qh->qh_endphub);
1302 	printf("  endphub=0x%08x\n", endphub);
1303 	printf("    smask=0x%02x cmask=0x%02x huba=0x%02x port=%d mult=%d\n",
1304 	       EHCI_QH_GET_SMASK(endphub), EHCI_QH_GET_CMASK(endphub),
1305 	       EHCI_QH_GET_HUBA(endphub), EHCI_QH_GET_PORT(endphub),
1306 	       EHCI_QH_GET_MULT(endphub));
1307 	printf("  curqtd="); ehci_dump_link(qh->qh_curqtd, 0); printf("\n");
1308 	printf("Overlay qTD:\n");
1309 	ehci_dump_qtd(&qh->qh_qtd);
1310 }
1311 
1312 #ifdef DIAGNOSTIC
1313 Static void
1314 ehci_dump_exfer(struct ehci_xfer *ex)
1315 {
1316 	printf("ehci_dump_exfer: ex=%p\n", ex);
1317 }
1318 #endif
1319 #endif
1320 
1321 usbd_status
1322 ehci_open(usbd_pipe_handle pipe)
1323 {
1324 	usbd_device_handle dev = pipe->device;
1325 	ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
1326 	usb_endpoint_descriptor_t *ed = pipe->endpoint->edesc;
1327 	u_int8_t addr = dev->address;
1328 	u_int8_t xfertype = ed->bmAttributes & UE_XFERTYPE;
1329 	struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
1330 	ehci_soft_qh_t *sqh;
1331 	usbd_status err;
1332 	int s;
1333 	int ival, speed, naks;
1334 	int hshubaddr, hshubport;
1335 
1336 	DPRINTFN(1, ("ehci_open: pipe=%p, addr=%d, endpt=%d (%d)\n",
1337 		     pipe, addr, ed->bEndpointAddress, sc->sc_addr));
1338 
1339 	if (dev->myhsport) {
1340 		hshubaddr = dev->myhsport->parent->address;
1341 		hshubport = dev->myhsport->portno;
1342 	} else {
1343 		hshubaddr = 0;
1344 		hshubport = 0;
1345 	}
1346 
1347 	if (sc->sc_dying)
1348 		return (USBD_IOERROR);
1349 
1350 	epipe->nexttoggle = 0;
1351 
1352 	if (addr == sc->sc_addr) {
1353 		switch (ed->bEndpointAddress) {
1354 		case USB_CONTROL_ENDPOINT:
1355 			pipe->methods = &ehci_root_ctrl_methods;
1356 			break;
1357 		case UE_DIR_IN | EHCI_INTR_ENDPT:
1358 			pipe->methods = &ehci_root_intr_methods;
1359 			break;
1360 		default:
1361 			return (USBD_INVAL);
1362 		}
1363 		return (USBD_NORMAL_COMPLETION);
1364 	}
1365 
1366 	/* XXX All this stuff is only valid for async. */
1367 	switch (dev->speed) {
1368 	case USB_SPEED_LOW:  speed = EHCI_QH_SPEED_LOW;  break;
1369 	case USB_SPEED_FULL: speed = EHCI_QH_SPEED_FULL; break;
1370 	case USB_SPEED_HIGH: speed = EHCI_QH_SPEED_HIGH; break;
1371 	default: panic("ehci_open: bad device speed %d", dev->speed);
1372 	}
1373 	if (speed != EHCI_QH_SPEED_HIGH && xfertype == UE_ISOCHRONOUS) {
1374 		printf("%s: *** WARNING: opening low/full speed isoc device, "
1375 		       "this does not work yet.\n",
1376 		       USBDEVNAME(sc->sc_bus.bdev));
1377 		DPRINTFN(1,("ehci_open: hshubaddr=%d hshubport=%d\n",
1378 			    hshubaddr, hshubport));
1379 		return USBD_INVAL;
1380 	}
1381 
1382 	naks = 8;		/* XXX */
1383 	sqh = ehci_alloc_sqh(sc);
1384 	if (sqh == NULL)
1385 		return (USBD_NOMEM);
1386 	/* qh_link filled when the QH is added */
1387 	sqh->qh.qh_endp = htole32(
1388 		EHCI_QH_SET_ADDR(addr) |
1389 		EHCI_QH_SET_ENDPT(UE_GET_ADDR(ed->bEndpointAddress)) |
1390 		EHCI_QH_SET_EPS(speed) |
1391 		EHCI_QH_DTC |
1392 		EHCI_QH_SET_MPL(UGETW(ed->wMaxPacketSize)) |
1393 		(speed != EHCI_QH_SPEED_HIGH && xfertype == UE_CONTROL ?
1394 		 EHCI_QH_CTL : 0) |
1395 		EHCI_QH_SET_NRL(naks)
1396 		);
1397 	sqh->qh.qh_endphub = htole32(
1398 		EHCI_QH_SET_MULT(1) |
1399 		EHCI_QH_SET_HUBA(hshubaddr) |
1400 		EHCI_QH_SET_PORT(hshubport) |
1401 		EHCI_QH_SET_CMASK(0x08) | /* XXX */
1402 		EHCI_QH_SET_SMASK(xfertype == UE_INTERRUPT ? 0x02 : 0)
1403 		);
1404 	sqh->qh.qh_curqtd = EHCI_NULL;
1405 	/* Fill the overlay qTD */
1406 	sqh->qh.qh_qtd.qtd_next = EHCI_NULL;
1407 	sqh->qh.qh_qtd.qtd_altnext = EHCI_NULL;
1408 	sqh->qh.qh_qtd.qtd_status = htole32(0);
1409 
1410 	epipe->sqh = sqh;
1411 
1412 	switch (xfertype) {
1413 	case UE_CONTROL:
1414 		err = usb_allocmem(&sc->sc_bus, sizeof(usb_device_request_t),
1415 				   0, &epipe->u.ctl.reqdma);
1416 #ifdef EHCI_DEBUG
1417 		if (err)
1418 			printf("ehci_open: usb_allocmem()=%d\n", err);
1419 #endif
1420 		if (err)
1421 			goto bad;
1422 		pipe->methods = &ehci_device_ctrl_methods;
1423 		s = splusb();
1424 		ehci_add_qh(sqh, sc->sc_async_head);
1425 		splx(s);
1426 		break;
1427 	case UE_BULK:
1428 		pipe->methods = &ehci_device_bulk_methods;
1429 		s = splusb();
1430 		ehci_add_qh(sqh, sc->sc_async_head);
1431 		splx(s);
1432 		break;
1433 	case UE_INTERRUPT:
1434 		pipe->methods = &ehci_device_intr_methods;
1435 		ival = pipe->interval;
1436 		if (ival == USBD_DEFAULT_INTERVAL) {
1437 			if (speed == EHCI_QH_SPEED_HIGH) {
1438 				if (ed->bInterval > 16) {
1439 					/*
1440 					 * illegal with high-speed, but there
1441 					 * were documentation bugs in the spec,
1442 					 * so be generous
1443 					 */
1444 					ival = 256;
1445 				} else
1446 					ival = (1 << (ed->bInterval - 1)) / 8;
1447 			} else
1448 				ival = ed->bInterval;
1449 		}
1450 		err = ehci_device_setintr(sc, sqh, ival);
1451 		if (err)
1452 			goto bad;
1453 		break;
1454 	case UE_ISOCHRONOUS:
1455 		pipe->methods = &ehci_device_isoc_methods;
1456 		/* FALLTHROUGH */
1457 	default:
1458 		err = USBD_INVAL;
1459 		goto bad;
1460 	}
1461 	return (USBD_NORMAL_COMPLETION);
1462 
1463  bad:
1464 	ehci_free_sqh(sc, sqh);
1465 	return (err);
1466 }
1467 
1468 /*
1469  * Add an ED to the schedule.  Called at splusb().
1470  */
1471 void
1472 ehci_add_qh(ehci_soft_qh_t *sqh, ehci_soft_qh_t *head)
1473 {
1474 	SPLUSBCHECK;
1475 
1476 	sqh->next = head->next;
1477 	sqh->qh.qh_link = head->qh.qh_link;
1478 	head->next = sqh;
1479 	head->qh.qh_link = htole32(sqh->physaddr | EHCI_LINK_QH);
1480 
1481 #ifdef EHCI_DEBUG
1482 	if (ehcidebug > 5) {
1483 		printf("ehci_add_qh:\n");
1484 		ehci_dump_sqh(sqh);
1485 	}
1486 #endif
1487 }
1488 
1489 /*
1490  * Remove an ED from the schedule.  Called at splusb().
1491  */
1492 void
1493 ehci_rem_qh(ehci_softc_t *sc, ehci_soft_qh_t *sqh, ehci_soft_qh_t *head)
1494 {
1495 	ehci_soft_qh_t *p;
1496 
1497 	SPLUSBCHECK;
1498 	/* XXX */
1499 	for (p = head; p != NULL && p->next != sqh; p = p->next)
1500 		;
1501 	if (p == NULL)
1502 		panic("ehci_rem_qh: ED not found");
1503 	p->next = sqh->next;
1504 	p->qh.qh_link = sqh->qh.qh_link;
1505 
1506 	ehci_sync_hc(sc);
1507 }
1508 
1509 void
1510 ehci_set_qh_qtd(ehci_soft_qh_t *sqh, ehci_soft_qtd_t *sqtd)
1511 {
1512 	int i;
1513 	u_int32_t status;
1514 
1515 	/* Save toggle bit and ping status. */
1516 	status = sqh->qh.qh_qtd.qtd_status &
1517 	    htole32(EHCI_QTD_TOGGLE_MASK |
1518 		    EHCI_QTD_SET_STATUS(EHCI_QTD_PINGSTATE));
1519 	/* Set HALTED to make hw leave it alone. */
1520 	sqh->qh.qh_qtd.qtd_status =
1521 	    htole32(EHCI_QTD_SET_STATUS(EHCI_QTD_HALTED));
1522 	sqh->qh.qh_curqtd = 0;
1523 	sqh->qh.qh_qtd.qtd_next = htole32(sqtd->physaddr);
1524 	sqh->qh.qh_qtd.qtd_altnext = 0;
1525 	for (i = 0; i < EHCI_QTD_NBUFFERS; i++)
1526 		sqh->qh.qh_qtd.qtd_buffer[i] = 0;
1527 	sqh->sqtd = sqtd;
1528 	/* Set !HALTED && !ACTIVE to start execution, preserve some fields */
1529 	sqh->qh.qh_qtd.qtd_status = status;
1530 }
1531 
1532 /*
1533  * Ensure that the HC has released all references to the QH.  We do this
1534  * by asking for a Async Advance Doorbell interrupt and then we wait for
1535  * the interrupt.
1536  * To make this easier we first obtain exclusive use of the doorbell.
1537  */
1538 void
1539 ehci_sync_hc(ehci_softc_t *sc)
1540 {
1541 	int s, error;
1542 
1543 	if (sc->sc_dying) {
1544 		DPRINTFN(2,("ehci_sync_hc: dying\n"));
1545 		return;
1546 	}
1547 	DPRINTFN(2,("ehci_sync_hc: enter\n"));
1548 	mutex_enter(&sc->sc_doorbell_lock);	/* get doorbell */
1549 	s = splhardusb();
1550 	/* ask for doorbell */
1551 	EOWRITE4(sc, EHCI_USBCMD, EOREAD4(sc, EHCI_USBCMD) | EHCI_CMD_IAAD);
1552 	DPRINTFN(1,("ehci_sync_hc: cmd=0x%08x sts=0x%08x\n",
1553 		    EOREAD4(sc, EHCI_USBCMD), EOREAD4(sc, EHCI_USBSTS)));
1554 	error = tsleep(&sc->sc_async_head, PZERO, "ehcidi", hz); /* bell wait */
1555 	DPRINTFN(1,("ehci_sync_hc: cmd=0x%08x sts=0x%08x\n",
1556 		    EOREAD4(sc, EHCI_USBCMD), EOREAD4(sc, EHCI_USBSTS)));
1557 	splx(s);
1558 	mutex_exit(&sc->sc_doorbell_lock);	/* release doorbell */
1559 #ifdef DIAGNOSTIC
1560 	if (error)
1561 		printf("ehci_sync_hc: tsleep() = %d\n", error);
1562 #endif
1563 	DPRINTFN(2,("ehci_sync_hc: exit\n"));
1564 }
1565 
1566 /***********/
1567 
1568 /*
1569  * Data structures and routines to emulate the root hub.
1570  */
1571 Static usb_device_descriptor_t ehci_devd = {
1572 	USB_DEVICE_DESCRIPTOR_SIZE,
1573 	UDESC_DEVICE,		/* type */
1574 	{0x00, 0x02},		/* USB version */
1575 	UDCLASS_HUB,		/* class */
1576 	UDSUBCLASS_HUB,		/* subclass */
1577 	UDPROTO_HSHUBSTT,	/* protocol */
1578 	64,			/* max packet */
1579 	{0},{0},{0x00,0x01},	/* device id */
1580 	1,2,0,			/* string indicies */
1581 	1			/* # of configurations */
1582 };
1583 
1584 Static const usb_device_qualifier_t ehci_odevd = {
1585 	USB_DEVICE_DESCRIPTOR_SIZE,
1586 	UDESC_DEVICE_QUALIFIER,	/* type */
1587 	{0x00, 0x02},		/* USB version */
1588 	UDCLASS_HUB,		/* class */
1589 	UDSUBCLASS_HUB,		/* subclass */
1590 	UDPROTO_FSHUB,		/* protocol */
1591 	64,			/* max packet */
1592 	1,			/* # of configurations */
1593 	0
1594 };
1595 
1596 Static const usb_config_descriptor_t ehci_confd = {
1597 	USB_CONFIG_DESCRIPTOR_SIZE,
1598 	UDESC_CONFIG,
1599 	{USB_CONFIG_DESCRIPTOR_SIZE +
1600 	 USB_INTERFACE_DESCRIPTOR_SIZE +
1601 	 USB_ENDPOINT_DESCRIPTOR_SIZE},
1602 	1,
1603 	1,
1604 	0,
1605 	UC_ATTR_MBO | UC_SELF_POWERED,
1606 	0			/* max power */
1607 };
1608 
1609 Static const usb_interface_descriptor_t ehci_ifcd = {
1610 	USB_INTERFACE_DESCRIPTOR_SIZE,
1611 	UDESC_INTERFACE,
1612 	0,
1613 	0,
1614 	1,
1615 	UICLASS_HUB,
1616 	UISUBCLASS_HUB,
1617 	UIPROTO_HSHUBSTT,
1618 	0
1619 };
1620 
1621 Static const usb_endpoint_descriptor_t ehci_endpd = {
1622 	USB_ENDPOINT_DESCRIPTOR_SIZE,
1623 	UDESC_ENDPOINT,
1624 	UE_DIR_IN | EHCI_INTR_ENDPT,
1625 	UE_INTERRUPT,
1626 	{8, 0},			/* max packet */
1627 	12
1628 };
1629 
1630 Static const usb_hub_descriptor_t ehci_hubd = {
1631 	USB_HUB_DESCRIPTOR_SIZE,
1632 	UDESC_HUB,
1633 	0,
1634 	{0,0},
1635 	0,
1636 	0,
1637 	{""},
1638 	{""},
1639 };
1640 
1641 /*
1642  * Simulate a hardware hub by handling all the necessary requests.
1643  */
1644 Static usbd_status
1645 ehci_root_ctrl_transfer(usbd_xfer_handle xfer)
1646 {
1647 	usbd_status err;
1648 
1649 	/* Insert last in queue. */
1650 	err = usb_insert_transfer(xfer);
1651 	if (err)
1652 		return (err);
1653 
1654 	/* Pipe isn't running, start first */
1655 	return (ehci_root_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
1656 }
1657 
1658 Static usbd_status
1659 ehci_root_ctrl_start(usbd_xfer_handle xfer)
1660 {
1661 	ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
1662 	usb_device_request_t *req;
1663 	void *buf = NULL;
1664 	int port, i;
1665 	int s, len, value, index, l, totlen = 0;
1666 	usb_port_status_t ps;
1667 	usb_hub_descriptor_t hubd;
1668 	usbd_status err;
1669 	u_int32_t v;
1670 
1671 	if (sc->sc_dying)
1672 		return (USBD_IOERROR);
1673 
1674 #ifdef DIAGNOSTIC
1675 	if (!(xfer->rqflags & URQ_REQUEST))
1676 		/* XXX panic */
1677 		return (USBD_INVAL);
1678 #endif
1679 	req = &xfer->request;
1680 
1681 	DPRINTFN(4,("ehci_root_ctrl_start: type=0x%02x request=%02x\n",
1682 		    req->bmRequestType, req->bRequest));
1683 
1684 	len = UGETW(req->wLength);
1685 	value = UGETW(req->wValue);
1686 	index = UGETW(req->wIndex);
1687 
1688 	if (len != 0)
1689 		buf = KERNADDR(&xfer->dmabuf, 0);
1690 
1691 #define C(x,y) ((x) | ((y) << 8))
1692 	switch(C(req->bRequest, req->bmRequestType)) {
1693 	case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
1694 	case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
1695 	case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
1696 		/*
1697 		 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
1698 		 * for the integrated root hub.
1699 		 */
1700 		break;
1701 	case C(UR_GET_CONFIG, UT_READ_DEVICE):
1702 		if (len > 0) {
1703 			*(u_int8_t *)buf = sc->sc_conf;
1704 			totlen = 1;
1705 		}
1706 		break;
1707 	case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
1708 		DPRINTFN(8,("ehci_root_ctrl_start: wValue=0x%04x\n", value));
1709 		if (len == 0)
1710 			break;
1711 		switch(value >> 8) {
1712 		case UDESC_DEVICE:
1713 			if ((value & 0xff) != 0) {
1714 				err = USBD_IOERROR;
1715 				goto ret;
1716 			}
1717 			totlen = l = min(len, USB_DEVICE_DESCRIPTOR_SIZE);
1718 			USETW(ehci_devd.idVendor, sc->sc_id_vendor);
1719 			memcpy(buf, &ehci_devd, l);
1720 			break;
1721 		/*
1722 		 * We can't really operate at another speed, but the spec says
1723 		 * we need this descriptor.
1724 		 */
1725 		case UDESC_DEVICE_QUALIFIER:
1726 			if ((value & 0xff) != 0) {
1727 				err = USBD_IOERROR;
1728 				goto ret;
1729 			}
1730 			totlen = l = min(len, USB_DEVICE_DESCRIPTOR_SIZE);
1731 			memcpy(buf, &ehci_odevd, l);
1732 			break;
1733 		/*
1734 		 * We can't really operate at another speed, but the spec says
1735 		 * we need this descriptor.
1736 		 */
1737 		case UDESC_OTHER_SPEED_CONFIGURATION:
1738 		case UDESC_CONFIG:
1739 			if ((value & 0xff) != 0) {
1740 				err = USBD_IOERROR;
1741 				goto ret;
1742 			}
1743 			totlen = l = min(len, USB_CONFIG_DESCRIPTOR_SIZE);
1744 			memcpy(buf, &ehci_confd, l);
1745 			((usb_config_descriptor_t *)buf)->bDescriptorType =
1746 				value >> 8;
1747 			buf = (char *)buf + l;
1748 			len -= l;
1749 			l = min(len, USB_INTERFACE_DESCRIPTOR_SIZE);
1750 			totlen += l;
1751 			memcpy(buf, &ehci_ifcd, l);
1752 			buf = (char *)buf + l;
1753 			len -= l;
1754 			l = min(len, USB_ENDPOINT_DESCRIPTOR_SIZE);
1755 			totlen += l;
1756 			memcpy(buf, &ehci_endpd, l);
1757 			break;
1758 		case UDESC_STRING:
1759 #define sd ((usb_string_descriptor_t *)buf)
1760 			switch (value & 0xff) {
1761 			case 0: /* Language table */
1762 				totlen = usb_makelangtbl(sd, len);
1763 				break;
1764 			case 1: /* Vendor */
1765 				totlen = usb_makestrdesc(sd, len,
1766 							 sc->sc_vendor);
1767 				break;
1768 			case 2: /* Product */
1769 				totlen = usb_makestrdesc(sd, len,
1770 							 "EHCI root hub");
1771 				break;
1772 			}
1773 #undef sd
1774 			break;
1775 		default:
1776 			err = USBD_IOERROR;
1777 			goto ret;
1778 		}
1779 		break;
1780 	case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
1781 		if (len > 0) {
1782 			*(u_int8_t *)buf = 0;
1783 			totlen = 1;
1784 		}
1785 		break;
1786 	case C(UR_GET_STATUS, UT_READ_DEVICE):
1787 		if (len > 1) {
1788 			USETW(((usb_status_t *)buf)->wStatus,UDS_SELF_POWERED);
1789 			totlen = 2;
1790 		}
1791 		break;
1792 	case C(UR_GET_STATUS, UT_READ_INTERFACE):
1793 	case C(UR_GET_STATUS, UT_READ_ENDPOINT):
1794 		if (len > 1) {
1795 			USETW(((usb_status_t *)buf)->wStatus, 0);
1796 			totlen = 2;
1797 		}
1798 		break;
1799 	case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
1800 		if (value >= USB_MAX_DEVICES) {
1801 			err = USBD_IOERROR;
1802 			goto ret;
1803 		}
1804 		sc->sc_addr = value;
1805 		break;
1806 	case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
1807 		if (value != 0 && value != 1) {
1808 			err = USBD_IOERROR;
1809 			goto ret;
1810 		}
1811 		sc->sc_conf = value;
1812 		break;
1813 	case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
1814 		break;
1815 	case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
1816 	case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
1817 	case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
1818 		err = USBD_IOERROR;
1819 		goto ret;
1820 	case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
1821 		break;
1822 	case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
1823 		break;
1824 	/* Hub requests */
1825 	case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
1826 		break;
1827 	case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
1828 		DPRINTFN(4, ("ehci_root_ctrl_start: UR_CLEAR_PORT_FEATURE "
1829 			     "port=%d feature=%d\n",
1830 			     index, value));
1831 		if (index < 1 || index > sc->sc_noport) {
1832 			err = USBD_IOERROR;
1833 			goto ret;
1834 		}
1835 		port = EHCI_PORTSC(index);
1836 		v = EOREAD4(sc, port);
1837 		DPRINTFN(4, ("ehci_root_ctrl_start: portsc=0x%08x\n", v));
1838 		v &= ~EHCI_PS_CLEAR;
1839 		switch(value) {
1840 		case UHF_PORT_ENABLE:
1841 			EOWRITE4(sc, port, v &~ EHCI_PS_PE);
1842 			break;
1843 		case UHF_PORT_SUSPEND:
1844 			EOWRITE4(sc, port, v &~ EHCI_PS_SUSP);
1845 			break;
1846 		case UHF_PORT_POWER:
1847 			if (sc->sc_hasppc)
1848 				EOWRITE4(sc, port, v &~ EHCI_PS_PP);
1849 			break;
1850 		case UHF_PORT_TEST:
1851 			DPRINTFN(2,("ehci_root_ctrl_start: clear port test "
1852 				    "%d\n", index));
1853 			break;
1854 		case UHF_PORT_INDICATOR:
1855 			DPRINTFN(2,("ehci_root_ctrl_start: clear port ind "
1856 				    "%d\n", index));
1857 			EOWRITE4(sc, port, v &~ EHCI_PS_PIC);
1858 			break;
1859 		case UHF_C_PORT_CONNECTION:
1860 			EOWRITE4(sc, port, v | EHCI_PS_CSC);
1861 			break;
1862 		case UHF_C_PORT_ENABLE:
1863 			EOWRITE4(sc, port, v | EHCI_PS_PEC);
1864 			break;
1865 		case UHF_C_PORT_SUSPEND:
1866 			/* how? */
1867 			break;
1868 		case UHF_C_PORT_OVER_CURRENT:
1869 			EOWRITE4(sc, port, v | EHCI_PS_OCC);
1870 			break;
1871 		case UHF_C_PORT_RESET:
1872 			sc->sc_isreset[index] = 0;
1873 			break;
1874 		default:
1875 			err = USBD_IOERROR;
1876 			goto ret;
1877 		}
1878 #if 0
1879 		switch(value) {
1880 		case UHF_C_PORT_CONNECTION:
1881 		case UHF_C_PORT_ENABLE:
1882 		case UHF_C_PORT_SUSPEND:
1883 		case UHF_C_PORT_OVER_CURRENT:
1884 		case UHF_C_PORT_RESET:
1885 		default:
1886 			break;
1887 		}
1888 #endif
1889 		break;
1890 	case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
1891 		if (len == 0)
1892 			break;
1893 		if ((value & 0xff) != 0) {
1894 			err = USBD_IOERROR;
1895 			goto ret;
1896 		}
1897 		hubd = ehci_hubd;
1898 		hubd.bNbrPorts = sc->sc_noport;
1899 		v = EOREAD4(sc, EHCI_HCSPARAMS);
1900 		USETW(hubd.wHubCharacteristics,
1901 		    EHCI_HCS_PPC(v) ? UHD_PWR_INDIVIDUAL : UHD_PWR_NO_SWITCH |
1902 		    EHCI_HCS_P_INDICATOR(EREAD4(sc, EHCI_HCSPARAMS))
1903 		        ? UHD_PORT_IND : 0);
1904 		hubd.bPwrOn2PwrGood = 200; /* XXX can't find out? */
1905 		for (i = 0, l = sc->sc_noport; l > 0; i++, l -= 8, v >>= 8)
1906 			hubd.DeviceRemovable[i++] = 0; /* XXX can't find out? */
1907 		hubd.bDescLength = USB_HUB_DESCRIPTOR_SIZE + i;
1908 		l = min(len, hubd.bDescLength);
1909 		totlen = l;
1910 		memcpy(buf, &hubd, l);
1911 		break;
1912 	case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
1913 		if (len != 4) {
1914 			err = USBD_IOERROR;
1915 			goto ret;
1916 		}
1917 		memset(buf, 0, len); /* ? XXX */
1918 		totlen = len;
1919 		break;
1920 	case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
1921 		DPRINTFN(8,("ehci_root_ctrl_start: get port status i=%d\n",
1922 			    index));
1923 		if (index < 1 || index > sc->sc_noport) {
1924 			err = USBD_IOERROR;
1925 			goto ret;
1926 		}
1927 		if (len != 4) {
1928 			err = USBD_IOERROR;
1929 			goto ret;
1930 		}
1931 		v = EOREAD4(sc, EHCI_PORTSC(index));
1932 		DPRINTFN(8,("ehci_root_ctrl_start: port status=0x%04x\n",
1933 			    v));
1934 		i = UPS_HIGH_SPEED;
1935 		if (v & EHCI_PS_CS)	i |= UPS_CURRENT_CONNECT_STATUS;
1936 		if (v & EHCI_PS_PE)	i |= UPS_PORT_ENABLED;
1937 		if (v & EHCI_PS_SUSP)	i |= UPS_SUSPEND;
1938 		if (v & EHCI_PS_OCA)	i |= UPS_OVERCURRENT_INDICATOR;
1939 		if (v & EHCI_PS_PR)	i |= UPS_RESET;
1940 		if (v & EHCI_PS_PP)	i |= UPS_PORT_POWER;
1941 		USETW(ps.wPortStatus, i);
1942 		i = 0;
1943 		if (v & EHCI_PS_CSC)	i |= UPS_C_CONNECT_STATUS;
1944 		if (v & EHCI_PS_PEC)	i |= UPS_C_PORT_ENABLED;
1945 		if (v & EHCI_PS_OCC)	i |= UPS_C_OVERCURRENT_INDICATOR;
1946 		if (sc->sc_isreset[index]) i |= UPS_C_PORT_RESET;
1947 		USETW(ps.wPortChange, i);
1948 		l = min(len, sizeof ps);
1949 		memcpy(buf, &ps, l);
1950 		totlen = l;
1951 		break;
1952 	case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
1953 		err = USBD_IOERROR;
1954 		goto ret;
1955 	case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
1956 		break;
1957 	case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
1958 		if (index < 1 || index > sc->sc_noport) {
1959 			err = USBD_IOERROR;
1960 			goto ret;
1961 		}
1962 		port = EHCI_PORTSC(index);
1963 		v = EOREAD4(sc, port);
1964 		DPRINTFN(4, ("ehci_root_ctrl_start: portsc=0x%08x\n", v));
1965 		v &= ~EHCI_PS_CLEAR;
1966 		switch(value) {
1967 		case UHF_PORT_ENABLE:
1968 			EOWRITE4(sc, port, v | EHCI_PS_PE);
1969 			break;
1970 		case UHF_PORT_SUSPEND:
1971 			EOWRITE4(sc, port, v | EHCI_PS_SUSP);
1972 			break;
1973 		case UHF_PORT_RESET:
1974 			DPRINTFN(5,("ehci_root_ctrl_start: reset port %d\n",
1975 				    index));
1976 			if (EHCI_PS_IS_LOWSPEED(v)) {
1977 				/* Low speed device, give up ownership. */
1978 				ehci_disown(sc, index, 1);
1979 				break;
1980 			}
1981 			/* Start reset sequence. */
1982 			v &= ~ (EHCI_PS_PE | EHCI_PS_PR);
1983 			EOWRITE4(sc, port, v | EHCI_PS_PR);
1984 			/* Wait for reset to complete. */
1985 			usb_delay_ms(&sc->sc_bus, USB_PORT_ROOT_RESET_DELAY);
1986 			if (sc->sc_dying) {
1987 				err = USBD_IOERROR;
1988 				goto ret;
1989 			}
1990 			/* Terminate reset sequence. */
1991 			EOWRITE4(sc, port, v);
1992 			/* Wait for HC to complete reset. */
1993 			usb_delay_ms(&sc->sc_bus, EHCI_PORT_RESET_COMPLETE);
1994 			if (sc->sc_dying) {
1995 				err = USBD_IOERROR;
1996 				goto ret;
1997 			}
1998 			v = EOREAD4(sc, port);
1999 			DPRINTF(("ehci after reset, status=0x%08x\n", v));
2000 			if (v & EHCI_PS_PR) {
2001 				printf("%s: port reset timeout\n",
2002 				       USBDEVNAME(sc->sc_bus.bdev));
2003 				return (USBD_TIMEOUT);
2004 			}
2005 			if (!(v & EHCI_PS_PE)) {
2006 				/* Not a high speed device, give up ownership.*/
2007 				ehci_disown(sc, index, 0);
2008 				break;
2009 			}
2010 			sc->sc_isreset[index] = 1;
2011 			DPRINTF(("ehci port %d reset, status = 0x%08x\n",
2012 				 index, v));
2013 			break;
2014 		case UHF_PORT_POWER:
2015 			DPRINTFN(2,("ehci_root_ctrl_start: set port power "
2016 				    "%d (has PPC = %d)\n", index,
2017 				    sc->sc_hasppc));
2018 			if (sc->sc_hasppc)
2019 				EOWRITE4(sc, port, v | EHCI_PS_PP);
2020 			break;
2021 		case UHF_PORT_TEST:
2022 			DPRINTFN(2,("ehci_root_ctrl_start: set port test "
2023 				    "%d\n", index));
2024 			break;
2025 		case UHF_PORT_INDICATOR:
2026 			DPRINTFN(2,("ehci_root_ctrl_start: set port ind "
2027 				    "%d\n", index));
2028 			EOWRITE4(sc, port, v | EHCI_PS_PIC);
2029 			break;
2030 		default:
2031 			err = USBD_IOERROR;
2032 			goto ret;
2033 		}
2034 		break;
2035 	case C(UR_CLEAR_TT_BUFFER, UT_WRITE_CLASS_OTHER):
2036 	case C(UR_RESET_TT, UT_WRITE_CLASS_OTHER):
2037 	case C(UR_GET_TT_STATE, UT_READ_CLASS_OTHER):
2038 	case C(UR_STOP_TT, UT_WRITE_CLASS_OTHER):
2039 		break;
2040 	default:
2041 		err = USBD_IOERROR;
2042 		goto ret;
2043 	}
2044 	xfer->actlen = totlen;
2045 	err = USBD_NORMAL_COMPLETION;
2046  ret:
2047 	xfer->status = err;
2048 	s = splusb();
2049 	usb_transfer_complete(xfer);
2050 	splx(s);
2051 	return (USBD_IN_PROGRESS);
2052 }
2053 
2054 void
2055 ehci_disown(ehci_softc_t *sc, int index, int lowspeed)
2056 {
2057 	int port;
2058 	u_int32_t v;
2059 
2060 	DPRINTF(("ehci_disown: index=%d lowspeed=%d\n", index, lowspeed));
2061 #ifdef DIAGNOSTIC
2062 	if (sc->sc_npcomp != 0) {
2063 		int i = (index-1) / sc->sc_npcomp;
2064 		if (i >= sc->sc_ncomp)
2065 			printf("%s: strange port\n",
2066 			       USBDEVNAME(sc->sc_bus.bdev));
2067 		else
2068 			printf("%s: handing over %s speed device on "
2069 			       "port %d to %s\n",
2070 			       USBDEVNAME(sc->sc_bus.bdev),
2071 			       lowspeed ? "low" : "full",
2072 			       index, USBDEVNAME(sc->sc_comps[i]->bdev));
2073 	} else {
2074 		printf("%s: npcomp == 0\n", USBDEVNAME(sc->sc_bus.bdev));
2075 	}
2076 #endif
2077 	port = EHCI_PORTSC(index);
2078 	v = EOREAD4(sc, port) &~ EHCI_PS_CLEAR;
2079 	EOWRITE4(sc, port, v | EHCI_PS_PO);
2080 }
2081 
2082 /* Abort a root control request. */
2083 Static void
2084 ehci_root_ctrl_abort(usbd_xfer_handle xfer)
2085 {
2086 	/* Nothing to do, all transfers are synchronous. */
2087 }
2088 
2089 /* Close the root pipe. */
2090 Static void
2091 ehci_root_ctrl_close(usbd_pipe_handle pipe)
2092 {
2093 	DPRINTF(("ehci_root_ctrl_close\n"));
2094 	/* Nothing to do. */
2095 }
2096 
2097 void
2098 ehci_root_intr_done(usbd_xfer_handle xfer)
2099 {
2100 	xfer->hcpriv = NULL;
2101 }
2102 
2103 Static usbd_status
2104 ehci_root_intr_transfer(usbd_xfer_handle xfer)
2105 {
2106 	usbd_status err;
2107 
2108 	/* Insert last in queue. */
2109 	err = usb_insert_transfer(xfer);
2110 	if (err)
2111 		return (err);
2112 
2113 	/* Pipe isn't running, start first */
2114 	return (ehci_root_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2115 }
2116 
2117 Static usbd_status
2118 ehci_root_intr_start(usbd_xfer_handle xfer)
2119 {
2120 	usbd_pipe_handle pipe = xfer->pipe;
2121 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2122 
2123 	if (sc->sc_dying)
2124 		return (USBD_IOERROR);
2125 
2126 	sc->sc_intrxfer = xfer;
2127 
2128 	return (USBD_IN_PROGRESS);
2129 }
2130 
2131 /* Abort a root interrupt request. */
2132 Static void
2133 ehci_root_intr_abort(usbd_xfer_handle xfer)
2134 {
2135 	int s;
2136 
2137 	if (xfer->pipe->intrxfer == xfer) {
2138 		DPRINTF(("ehci_root_intr_abort: remove\n"));
2139 		xfer->pipe->intrxfer = NULL;
2140 	}
2141 	xfer->status = USBD_CANCELLED;
2142 	s = splusb();
2143 	usb_transfer_complete(xfer);
2144 	splx(s);
2145 }
2146 
2147 /* Close the root pipe. */
2148 Static void
2149 ehci_root_intr_close(usbd_pipe_handle pipe)
2150 {
2151 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2152 
2153 	DPRINTF(("ehci_root_intr_close\n"));
2154 
2155 	sc->sc_intrxfer = NULL;
2156 }
2157 
2158 void
2159 ehci_root_ctrl_done(usbd_xfer_handle xfer)
2160 {
2161 	xfer->hcpriv = NULL;
2162 }
2163 
2164 /************************/
2165 
2166 ehci_soft_qh_t *
2167 ehci_alloc_sqh(ehci_softc_t *sc)
2168 {
2169 	ehci_soft_qh_t *sqh;
2170 	usbd_status err;
2171 	int i, offs;
2172 	usb_dma_t dma;
2173 
2174 	if (sc->sc_freeqhs == NULL) {
2175 		DPRINTFN(2, ("ehci_alloc_sqh: allocating chunk\n"));
2176 		err = usb_allocmem(&sc->sc_bus, EHCI_SQH_SIZE * EHCI_SQH_CHUNK,
2177 			  EHCI_PAGE_SIZE, &dma);
2178 #ifdef EHCI_DEBUG
2179 		if (err)
2180 			printf("ehci_alloc_sqh: usb_allocmem()=%d\n", err);
2181 #endif
2182 		if (err)
2183 			return (NULL);
2184 		for(i = 0; i < EHCI_SQH_CHUNK; i++) {
2185 			offs = i * EHCI_SQH_SIZE;
2186 			sqh = KERNADDR(&dma, offs);
2187 			sqh->physaddr = DMAADDR(&dma, offs);
2188 			sqh->next = sc->sc_freeqhs;
2189 			sc->sc_freeqhs = sqh;
2190 		}
2191 	}
2192 	sqh = sc->sc_freeqhs;
2193 	sc->sc_freeqhs = sqh->next;
2194 	memset(&sqh->qh, 0, sizeof(ehci_qh_t));
2195 	sqh->next = NULL;
2196 	return (sqh);
2197 }
2198 
2199 void
2200 ehci_free_sqh(ehci_softc_t *sc, ehci_soft_qh_t *sqh)
2201 {
2202 	sqh->next = sc->sc_freeqhs;
2203 	sc->sc_freeqhs = sqh;
2204 }
2205 
2206 ehci_soft_qtd_t *
2207 ehci_alloc_sqtd(ehci_softc_t *sc)
2208 {
2209 	ehci_soft_qtd_t *sqtd;
2210 	usbd_status err;
2211 	int i, offs;
2212 	usb_dma_t dma;
2213 	int s;
2214 
2215 	if (sc->sc_freeqtds == NULL) {
2216 		DPRINTFN(2, ("ehci_alloc_sqtd: allocating chunk\n"));
2217 		err = usb_allocmem(&sc->sc_bus, EHCI_SQTD_SIZE*EHCI_SQTD_CHUNK,
2218 			  EHCI_PAGE_SIZE, &dma);
2219 #ifdef EHCI_DEBUG
2220 		if (err)
2221 			printf("ehci_alloc_sqtd: usb_allocmem()=%d\n", err);
2222 #endif
2223 		if (err)
2224 			return (NULL);
2225 		s = splusb();
2226 		for(i = 0; i < EHCI_SQTD_CHUNK; i++) {
2227 			offs = i * EHCI_SQTD_SIZE;
2228 			sqtd = KERNADDR(&dma, offs);
2229 			sqtd->physaddr = DMAADDR(&dma, offs);
2230 			sqtd->nextqtd = sc->sc_freeqtds;
2231 			sc->sc_freeqtds = sqtd;
2232 		}
2233 		splx(s);
2234 	}
2235 
2236 	s = splusb();
2237 	sqtd = sc->sc_freeqtds;
2238 	sc->sc_freeqtds = sqtd->nextqtd;
2239 	memset(&sqtd->qtd, 0, sizeof(ehci_qtd_t));
2240 	sqtd->nextqtd = NULL;
2241 	sqtd->xfer = NULL;
2242 	splx(s);
2243 
2244 	return (sqtd);
2245 }
2246 
2247 void
2248 ehci_free_sqtd(ehci_softc_t *sc, ehci_soft_qtd_t *sqtd)
2249 {
2250 	int s;
2251 
2252 	s = splusb();
2253 	sqtd->nextqtd = sc->sc_freeqtds;
2254 	sc->sc_freeqtds = sqtd;
2255 	splx(s);
2256 }
2257 
2258 usbd_status
2259 ehci_alloc_sqtd_chain(struct ehci_pipe *epipe, ehci_softc_t *sc,
2260 		     int alen, int rd, usbd_xfer_handle xfer,
2261 		     ehci_soft_qtd_t **sp, ehci_soft_qtd_t **ep)
2262 {
2263 	ehci_soft_qtd_t *next, *cur;
2264 	ehci_physaddr_t dataphys, dataphyspage, dataphyslastpage, nextphys;
2265 	u_int32_t qtdstatus;
2266 	int len, curlen, mps;
2267 	int i, tog;
2268 	usb_dma_t *dma = &xfer->dmabuf;
2269 	u_int16_t flags = xfer->flags;
2270 
2271 	DPRINTFN(alen<4*4096,("ehci_alloc_sqtd_chain: start len=%d\n", alen));
2272 
2273 	len = alen;
2274 	dataphys = DMAADDR(dma, 0);
2275 	dataphyslastpage = EHCI_PAGE(dataphys + len - 1);
2276 	qtdstatus = EHCI_QTD_ACTIVE |
2277 	    EHCI_QTD_SET_PID(rd ? EHCI_QTD_PID_IN : EHCI_QTD_PID_OUT) |
2278 	    EHCI_QTD_SET_CERR(3)
2279 	    /* IOC set below */
2280 	    /* BYTES set below */
2281 	    ;
2282 	mps = UGETW(epipe->pipe.endpoint->edesc->wMaxPacketSize);
2283 	tog = epipe->nexttoggle;
2284 	qtdstatus |= EHCI_QTD_SET_TOGGLE(tog);
2285 
2286 	cur = ehci_alloc_sqtd(sc);
2287 	*sp = cur;
2288 	if (cur == NULL)
2289 		goto nomem;
2290 	for (;;) {
2291 		dataphyspage = EHCI_PAGE(dataphys);
2292 		/* The EHCI hardware can handle at most 5 pages. */
2293 		if (dataphyslastpage - dataphyspage <
2294 		    EHCI_QTD_NBUFFERS * EHCI_PAGE_SIZE) {
2295 			/* we can handle it in this QTD */
2296 			curlen = len;
2297 		} else {
2298 			/* must use multiple TDs, fill as much as possible. */
2299 			curlen = EHCI_QTD_NBUFFERS * EHCI_PAGE_SIZE -
2300 				 EHCI_PAGE_OFFSET(dataphys);
2301 #ifdef DIAGNOSTIC
2302 			if (curlen > len) {
2303 				printf("ehci_alloc_sqtd_chain: curlen=0x%x "
2304 				       "len=0x%x offs=0x%x\n", curlen, len,
2305 				       EHCI_PAGE_OFFSET(dataphys));
2306 				printf("lastpage=0x%x page=0x%x phys=0x%x\n",
2307 				       dataphyslastpage, dataphyspage,
2308 				       dataphys);
2309 				curlen = len;
2310 			}
2311 #endif
2312 			/* the length must be a multiple of the max size */
2313 			curlen -= curlen % mps;
2314 			DPRINTFN(1,("ehci_alloc_sqtd_chain: multiple QTDs, "
2315 				    "curlen=%d\n", curlen));
2316 #ifdef DIAGNOSTIC
2317 			if (curlen == 0)
2318 				panic("ehci_alloc_sqtd_chain: curlen == 0");
2319 #endif
2320 		}
2321 		DPRINTFN(4,("ehci_alloc_sqtd_chain: dataphys=0x%08x "
2322 			    "dataphyslastpage=0x%08x len=%d curlen=%d\n",
2323 			    dataphys, dataphyslastpage,
2324 			    len, curlen));
2325 		len -= curlen;
2326 
2327 		/*
2328 		 * Allocate another transfer if there's more data left,
2329 		 * or if force last short transfer flag is set and we're
2330 		 * allocating a multiple of the max packet size.
2331 		 */
2332 		if (len != 0 ||
2333 		    ((curlen % mps) == 0 && !rd && curlen != 0 &&
2334 		     (flags & USBD_FORCE_SHORT_XFER))) {
2335 			next = ehci_alloc_sqtd(sc);
2336 			if (next == NULL)
2337 				goto nomem;
2338 			nextphys = htole32(next->physaddr);
2339 		} else {
2340 			next = NULL;
2341 			nextphys = EHCI_NULL;
2342 		}
2343 
2344 		for (i = 0; i * EHCI_PAGE_SIZE <
2345 		            curlen + EHCI_PAGE_OFFSET(dataphys); i++) {
2346 			ehci_physaddr_t a = dataphys + i * EHCI_PAGE_SIZE;
2347 			if (i != 0) /* use offset only in first buffer */
2348 				a = EHCI_PAGE(a);
2349 			cur->qtd.qtd_buffer[i] = htole32(a);
2350 			cur->qtd.qtd_buffer_hi[i] = 0;
2351 #ifdef DIAGNOSTIC
2352 			if (i >= EHCI_QTD_NBUFFERS) {
2353 				printf("ehci_alloc_sqtd_chain: i=%d\n", i);
2354 				goto nomem;
2355 			}
2356 #endif
2357 		}
2358 		cur->nextqtd = next;
2359 		cur->qtd.qtd_next = cur->qtd.qtd_altnext = nextphys;
2360 		cur->qtd.qtd_status =
2361 		    htole32(qtdstatus | EHCI_QTD_SET_BYTES(curlen));
2362 		cur->xfer = xfer;
2363 		cur->len = curlen;
2364 		DPRINTFN(10,("ehci_alloc_sqtd_chain: cbp=0x%08x end=0x%08x\n",
2365 			    dataphys, dataphys + curlen));
2366 		/* adjust the toggle based on the number of packets in this
2367 		   qtd */
2368 		if (((curlen + mps - 1) / mps) & 1) {
2369 			tog ^= 1;
2370 			qtdstatus ^= EHCI_QTD_TOGGLE_MASK;
2371 		}
2372 		if (next == NULL)
2373 			break;
2374 		DPRINTFN(10,("ehci_alloc_sqtd_chain: extend chain\n"));
2375 		dataphys += curlen;
2376 		cur = next;
2377 	}
2378 	cur->qtd.qtd_status |= htole32(EHCI_QTD_IOC);
2379 	*ep = cur;
2380 	epipe->nexttoggle = tog;
2381 
2382 	DPRINTFN(10,("ehci_alloc_sqtd_chain: return sqtd=%p sqtdend=%p\n",
2383 		     *sp, *ep));
2384 
2385 	return (USBD_NORMAL_COMPLETION);
2386 
2387  nomem:
2388 	/* XXX free chain */
2389 	DPRINTFN(-1,("ehci_alloc_sqtd_chain: no memory\n"));
2390 	return (USBD_NOMEM);
2391 }
2392 
2393 Static void
2394 ehci_free_sqtd_chain(ehci_softc_t *sc, ehci_soft_qtd_t *sqtd,
2395 		    ehci_soft_qtd_t *sqtdend)
2396 {
2397 	ehci_soft_qtd_t *p;
2398 	int i;
2399 
2400 	DPRINTFN(10,("ehci_free_sqtd_chain: sqtd=%p sqtdend=%p\n",
2401 		     sqtd, sqtdend));
2402 
2403 	for (i = 0; sqtd != sqtdend; sqtd = p, i++) {
2404 		p = sqtd->nextqtd;
2405 		ehci_free_sqtd(sc, sqtd);
2406 	}
2407 }
2408 
2409 /****************/
2410 
2411 /*
2412  * Close a reqular pipe.
2413  * Assumes that there are no pending transactions.
2414  */
2415 void
2416 ehci_close_pipe(usbd_pipe_handle pipe, ehci_soft_qh_t *head)
2417 {
2418 	struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
2419 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2420 	ehci_soft_qh_t *sqh = epipe->sqh;
2421 	int s;
2422 
2423 	s = splusb();
2424 	ehci_rem_qh(sc, sqh, head);
2425 	splx(s);
2426 	ehci_free_sqh(sc, epipe->sqh);
2427 }
2428 
2429 /*
2430  * Abort a device request.
2431  * If this routine is called at splusb() it guarantees that the request
2432  * will be removed from the hardware scheduling and that the callback
2433  * for it will be called with USBD_CANCELLED status.
2434  * It's impossible to guarantee that the requested transfer will not
2435  * have happened since the hardware runs concurrently.
2436  * If the transaction has already happened we rely on the ordinary
2437  * interrupt processing to process it.
2438  * XXX This is most probably wrong.
2439  */
2440 void
2441 ehci_abort_xfer(usbd_xfer_handle xfer, usbd_status status)
2442 {
2443 #define exfer EXFER(xfer)
2444 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2445 	ehci_softc_t *sc = (ehci_softc_t *)epipe->pipe.device->bus;
2446 	ehci_soft_qh_t *sqh = epipe->sqh;
2447 	ehci_soft_qtd_t *sqtd;
2448 	ehci_physaddr_t cur;
2449 	u_int32_t qhstatus;
2450 	int s;
2451 	int hit;
2452 	int wake;
2453 
2454 	DPRINTF(("ehci_abort_xfer: xfer=%p pipe=%p\n", xfer, epipe));
2455 
2456 	if (sc->sc_dying) {
2457 		/* If we're dying, just do the software part. */
2458 		s = splusb();
2459 		xfer->status = status;	/* make software ignore it */
2460 		usb_uncallout(xfer->timeout_handle, ehci_timeout, xfer);
2461 		usb_transfer_complete(xfer);
2462 		splx(s);
2463 		return;
2464 	}
2465 
2466 	if (xfer->device->bus->intr_context || !curproc)
2467 		panic("ehci_abort_xfer: not in process context");
2468 
2469 	/*
2470 	 * If an abort is already in progress then just wait for it to
2471 	 * complete and return.
2472 	 */
2473 	if (xfer->hcflags & UXFER_ABORTING) {
2474 		DPRINTFN(2, ("ehci_abort_xfer: already aborting\n"));
2475 #ifdef DIAGNOSTIC
2476 		if (status == USBD_TIMEOUT)
2477 			printf("ehci_abort_xfer: TIMEOUT while aborting\n");
2478 #endif
2479 		/* Override the status which might be USBD_TIMEOUT. */
2480 		xfer->status = status;
2481 		DPRINTFN(2, ("ehci_abort_xfer: waiting for abort to finish\n"));
2482 		xfer->hcflags |= UXFER_ABORTWAIT;
2483 		while (xfer->hcflags & UXFER_ABORTING)
2484 			tsleep(&xfer->hcflags, PZERO, "ehciaw", 0);
2485 		return;
2486 	}
2487 	xfer->hcflags |= UXFER_ABORTING;
2488 
2489 	/*
2490 	 * Step 1: Make interrupt routine and hardware ignore xfer.
2491 	 */
2492 	s = splusb();
2493 	xfer->status = status;	/* make software ignore it */
2494 	usb_uncallout(xfer->timeout_handle, ehci_timeout, xfer);
2495 	qhstatus = sqh->qh.qh_qtd.qtd_status;
2496 	sqh->qh.qh_qtd.qtd_status = qhstatus | htole32(EHCI_QTD_HALTED);
2497 	for (sqtd = exfer->sqtdstart; ; sqtd = sqtd->nextqtd) {
2498 		sqtd->qtd.qtd_status |= htole32(EHCI_QTD_HALTED);
2499 		if (sqtd == exfer->sqtdend)
2500 			break;
2501 	}
2502 	splx(s);
2503 
2504 	/*
2505 	 * Step 2: Wait until we know hardware has finished any possible
2506 	 * use of the xfer.  Also make sure the soft interrupt routine
2507 	 * has run.
2508 	 */
2509 	ehci_sync_hc(sc);
2510 	s = splusb();
2511 #ifdef USB_USE_SOFTINTR
2512 	sc->sc_softwake = 1;
2513 #endif /* USB_USE_SOFTINTR */
2514 	usb_schedsoftintr(&sc->sc_bus);
2515 #ifdef USB_USE_SOFTINTR
2516 	tsleep(&sc->sc_softwake, PZERO, "ehciab", 0);
2517 #endif /* USB_USE_SOFTINTR */
2518 	splx(s);
2519 
2520 	/*
2521 	 * Step 3: Remove any vestiges of the xfer from the hardware.
2522 	 * The complication here is that the hardware may have executed
2523 	 * beyond the xfer we're trying to abort.  So as we're scanning
2524 	 * the TDs of this xfer we check if the hardware points to
2525 	 * any of them.
2526 	 */
2527 	s = splusb();		/* XXX why? */
2528 	cur = EHCI_LINK_ADDR(le32toh(sqh->qh.qh_curqtd));
2529 	hit = 0;
2530 	for (sqtd = exfer->sqtdstart; ; sqtd = sqtd->nextqtd) {
2531 		hit |= cur == sqtd->physaddr;
2532 		if (sqtd == exfer->sqtdend)
2533 			break;
2534 	}
2535 	sqtd = sqtd->nextqtd;
2536 	/* Zap curqtd register if hardware pointed inside the xfer. */
2537 	if (hit && sqtd != NULL) {
2538 		DPRINTFN(1,("ehci_abort_xfer: cur=0x%08x\n", sqtd->physaddr));
2539 		sqh->qh.qh_curqtd = htole32(sqtd->physaddr); /* unlink qTDs */
2540 		sqh->qh.qh_qtd.qtd_status = qhstatus;
2541 	} else {
2542 		DPRINTFN(1,("ehci_abort_xfer: no hit\n"));
2543 	}
2544 
2545 	/*
2546 	 * Step 4: Execute callback.
2547 	 */
2548 #ifdef DIAGNOSTIC
2549 	exfer->isdone = 1;
2550 #endif
2551 	wake = xfer->hcflags & UXFER_ABORTWAIT;
2552 	xfer->hcflags &= ~(UXFER_ABORTING | UXFER_ABORTWAIT);
2553 	usb_transfer_complete(xfer);
2554 	if (wake)
2555 		wakeup(&xfer->hcflags);
2556 
2557 	splx(s);
2558 #undef exfer
2559 }
2560 
2561 void
2562 ehci_timeout(void *addr)
2563 {
2564 	struct ehci_xfer *exfer = addr;
2565 	struct ehci_pipe *epipe = (struct ehci_pipe *)exfer->xfer.pipe;
2566 	ehci_softc_t *sc = (ehci_softc_t *)epipe->pipe.device->bus;
2567 
2568 	DPRINTF(("ehci_timeout: exfer=%p\n", exfer));
2569 #ifdef USB_DEBUG
2570 	if (ehcidebug > 1)
2571 		usbd_dump_pipe(exfer->xfer.pipe);
2572 #endif
2573 
2574 	if (sc->sc_dying) {
2575 		ehci_abort_xfer(&exfer->xfer, USBD_TIMEOUT);
2576 		return;
2577 	}
2578 
2579 	/* Execute the abort in a process context. */
2580 	usb_init_task(&exfer->abort_task, ehci_timeout_task, addr);
2581 	usb_add_task(exfer->xfer.pipe->device, &exfer->abort_task,
2582 	    USB_TASKQ_HC);
2583 }
2584 
2585 void
2586 ehci_timeout_task(void *addr)
2587 {
2588 	usbd_xfer_handle xfer = addr;
2589 	int s;
2590 
2591 	DPRINTF(("ehci_timeout_task: xfer=%p\n", xfer));
2592 
2593 	s = splusb();
2594 	ehci_abort_xfer(xfer, USBD_TIMEOUT);
2595 	splx(s);
2596 }
2597 
2598 /************************/
2599 
2600 Static usbd_status
2601 ehci_device_ctrl_transfer(usbd_xfer_handle xfer)
2602 {
2603 	usbd_status err;
2604 
2605 	/* Insert last in queue. */
2606 	err = usb_insert_transfer(xfer);
2607 	if (err)
2608 		return (err);
2609 
2610 	/* Pipe isn't running, start first */
2611 	return (ehci_device_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2612 }
2613 
2614 Static usbd_status
2615 ehci_device_ctrl_start(usbd_xfer_handle xfer)
2616 {
2617 	ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
2618 	usbd_status err;
2619 
2620 	if (sc->sc_dying)
2621 		return (USBD_IOERROR);
2622 
2623 #ifdef DIAGNOSTIC
2624 	if (!(xfer->rqflags & URQ_REQUEST)) {
2625 		/* XXX panic */
2626 		printf("ehci_device_ctrl_transfer: not a request\n");
2627 		return (USBD_INVAL);
2628 	}
2629 #endif
2630 
2631 	err = ehci_device_request(xfer);
2632 	if (err)
2633 		return (err);
2634 
2635 	if (sc->sc_bus.use_polling)
2636 		ehci_waitintr(sc, xfer);
2637 	return (USBD_IN_PROGRESS);
2638 }
2639 
2640 void
2641 ehci_device_ctrl_done(usbd_xfer_handle xfer)
2642 {
2643 	struct ehci_xfer *ex = EXFER(xfer);
2644 	ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
2645 	/*struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;*/
2646 
2647 	DPRINTFN(10,("ehci_ctrl_done: xfer=%p\n", xfer));
2648 
2649 #ifdef DIAGNOSTIC
2650 	if (!(xfer->rqflags & URQ_REQUEST)) {
2651 		panic("ehci_ctrl_done: not a request");
2652 	}
2653 #endif
2654 
2655 	if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
2656 		ehci_del_intr_list(ex);	/* remove from active list */
2657 		ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
2658 	}
2659 
2660 	DPRINTFN(5, ("ehci_ctrl_done: length=%d\n", xfer->actlen));
2661 }
2662 
2663 /* Abort a device control request. */
2664 Static void
2665 ehci_device_ctrl_abort(usbd_xfer_handle xfer)
2666 {
2667 	DPRINTF(("ehci_device_ctrl_abort: xfer=%p\n", xfer));
2668 	ehci_abort_xfer(xfer, USBD_CANCELLED);
2669 }
2670 
2671 /* Close a device control pipe. */
2672 Static void
2673 ehci_device_ctrl_close(usbd_pipe_handle pipe)
2674 {
2675 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2676 	/*struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;*/
2677 
2678 	DPRINTF(("ehci_device_ctrl_close: pipe=%p\n", pipe));
2679 	ehci_close_pipe(pipe, sc->sc_async_head);
2680 }
2681 
2682 usbd_status
2683 ehci_device_request(usbd_xfer_handle xfer)
2684 {
2685 #define exfer EXFER(xfer)
2686 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2687 	usb_device_request_t *req = &xfer->request;
2688 	usbd_device_handle dev = epipe->pipe.device;
2689 	ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
2690 	int addr = dev->address;
2691 	ehci_soft_qtd_t *setup, *stat, *next;
2692 	ehci_soft_qh_t *sqh;
2693 	int isread;
2694 	int len;
2695 	usbd_status err;
2696 	int s;
2697 
2698 	isread = req->bmRequestType & UT_READ;
2699 	len = UGETW(req->wLength);
2700 
2701 	DPRINTFN(3,("ehci_device_request: type=0x%02x, request=0x%02x, "
2702 		    "wValue=0x%04x, wIndex=0x%04x len=%d, addr=%d, endpt=%d\n",
2703 		    req->bmRequestType, req->bRequest, UGETW(req->wValue),
2704 		    UGETW(req->wIndex), len, addr,
2705 		    epipe->pipe.endpoint->edesc->bEndpointAddress));
2706 
2707 	setup = ehci_alloc_sqtd(sc);
2708 	if (setup == NULL) {
2709 		err = USBD_NOMEM;
2710 		goto bad1;
2711 	}
2712 	stat = ehci_alloc_sqtd(sc);
2713 	if (stat == NULL) {
2714 		err = USBD_NOMEM;
2715 		goto bad2;
2716 	}
2717 
2718 	sqh = epipe->sqh;
2719 	epipe->u.ctl.length = len;
2720 
2721 	/* Update device address and length since they may have changed
2722 	   during the setup of the control pipe in usbd_new_device(). */
2723 	/* XXX This only needs to be done once, but it's too early in open. */
2724 	/* XXXX Should not touch ED here! */
2725 	sqh->qh.qh_endp =
2726 	    (sqh->qh.qh_endp & htole32(~(EHCI_QH_ADDRMASK | EHCI_QH_MPLMASK))) |
2727 	    htole32(
2728 	     EHCI_QH_SET_ADDR(addr) |
2729 	     EHCI_QH_SET_MPL(UGETW(epipe->pipe.endpoint->edesc->wMaxPacketSize))
2730 	    );
2731 
2732 	/* Set up data transaction */
2733 	if (len != 0) {
2734 		ehci_soft_qtd_t *end;
2735 
2736 		/* Start toggle at 1. */
2737 		epipe->nexttoggle = 1;
2738 		err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer,
2739 			  &next, &end);
2740 		if (err)
2741 			goto bad3;
2742 		end->qtd.qtd_status &= htole32(~EHCI_QTD_IOC);
2743 		end->nextqtd = stat;
2744 		end->qtd.qtd_next =
2745 		end->qtd.qtd_altnext = htole32(stat->physaddr);
2746 	} else {
2747 		next = stat;
2748 	}
2749 
2750 	memcpy(KERNADDR(&epipe->u.ctl.reqdma, 0), req, sizeof *req);
2751 
2752 	/* Clear toggle */
2753 	setup->qtd.qtd_status = htole32(
2754 	    EHCI_QTD_ACTIVE |
2755 	    EHCI_QTD_SET_PID(EHCI_QTD_PID_SETUP) |
2756 	    EHCI_QTD_SET_CERR(3) |
2757 	    EHCI_QTD_SET_TOGGLE(0) |
2758 	    EHCI_QTD_SET_BYTES(sizeof *req)
2759 	    );
2760 	setup->qtd.qtd_buffer[0] = htole32(DMAADDR(&epipe->u.ctl.reqdma, 0));
2761 	setup->qtd.qtd_buffer_hi[0] = 0;
2762 	setup->nextqtd = next;
2763 	setup->qtd.qtd_next = setup->qtd.qtd_altnext = htole32(next->physaddr);
2764 	setup->xfer = xfer;
2765 	setup->len = sizeof *req;
2766 
2767 	stat->qtd.qtd_status = htole32(
2768 	    EHCI_QTD_ACTIVE |
2769 	    EHCI_QTD_SET_PID(isread ? EHCI_QTD_PID_OUT : EHCI_QTD_PID_IN) |
2770 	    EHCI_QTD_SET_CERR(3) |
2771 	    EHCI_QTD_SET_TOGGLE(1) |
2772 	    EHCI_QTD_IOC
2773 	    );
2774 	stat->qtd.qtd_buffer[0] = 0; /* XXX not needed? */
2775 	stat->qtd.qtd_buffer_hi[0] = 0; /* XXX not needed? */
2776 	stat->nextqtd = NULL;
2777 	stat->qtd.qtd_next = stat->qtd.qtd_altnext = EHCI_NULL;
2778 	stat->xfer = xfer;
2779 	stat->len = 0;
2780 
2781 #ifdef EHCI_DEBUG
2782 	if (ehcidebug > 5) {
2783 		DPRINTF(("ehci_device_request:\n"));
2784 		ehci_dump_sqh(sqh);
2785 		ehci_dump_sqtds(setup);
2786 	}
2787 #endif
2788 
2789 	exfer->sqtdstart = setup;
2790 	exfer->sqtdend = stat;
2791 #ifdef DIAGNOSTIC
2792 	if (!exfer->isdone) {
2793 		printf("ehci_device_request: not done, exfer=%p\n", exfer);
2794 	}
2795 	exfer->isdone = 0;
2796 #endif
2797 
2798 	/* Insert qTD in QH list. */
2799 	s = splusb();
2800 	ehci_set_qh_qtd(sqh, setup);
2801 	if (xfer->timeout && !sc->sc_bus.use_polling) {
2802                 usb_callout(xfer->timeout_handle, mstohz(xfer->timeout),
2803 			    ehci_timeout, xfer);
2804 	}
2805 	ehci_add_intr_list(sc, exfer);
2806 	xfer->status = USBD_IN_PROGRESS;
2807 	splx(s);
2808 
2809 #ifdef EHCI_DEBUG
2810 	if (ehcidebug > 10) {
2811 		DPRINTF(("ehci_device_request: status=%x\n",
2812 			 EOREAD4(sc, EHCI_USBSTS)));
2813 		delay(10000);
2814 		ehci_dump_regs(sc);
2815 		ehci_dump_sqh(sc->sc_async_head);
2816 		ehci_dump_sqh(sqh);
2817 		ehci_dump_sqtds(setup);
2818 	}
2819 #endif
2820 
2821 	return (USBD_NORMAL_COMPLETION);
2822 
2823  bad3:
2824 	ehci_free_sqtd(sc, stat);
2825  bad2:
2826 	ehci_free_sqtd(sc, setup);
2827  bad1:
2828 	DPRINTFN(-1,("ehci_device_request: no memory\n"));
2829 	xfer->status = err;
2830 	usb_transfer_complete(xfer);
2831 	return (err);
2832 #undef exfer
2833 }
2834 
2835 /*
2836  * Some EHCI chips from VIA seem to trigger interrupts before writing back the
2837  * qTD status, or miss signalling occasionally under heavy load.  If the host
2838  * machine is too fast, we we can miss transaction completion - when we scan
2839  * the active list the transaction still seems to be active.  This generally
2840  * exhibits itself as a umass stall that never recovers.
2841  *
2842  * We work around this behaviour by setting up this callback after any softintr
2843  * that completes with transactions still pending, giving us another chance to
2844  * check for completion after the writeback has taken place.
2845  */
2846 void
2847 ehci_intrlist_timeout(void *arg)
2848 {
2849 	ehci_softc_t *sc = arg;
2850 	int s = splusb();
2851 
2852 	DPRINTF(("ehci_intrlist_timeout\n"));
2853 	usb_schedsoftintr(&sc->sc_bus);
2854 
2855 	splx(s);
2856 }
2857 
2858 /************************/
2859 
2860 Static usbd_status
2861 ehci_device_bulk_transfer(usbd_xfer_handle xfer)
2862 {
2863 	usbd_status err;
2864 
2865 	/* Insert last in queue. */
2866 	err = usb_insert_transfer(xfer);
2867 	if (err)
2868 		return (err);
2869 
2870 	/* Pipe isn't running, start first */
2871 	return (ehci_device_bulk_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2872 }
2873 
2874 usbd_status
2875 ehci_device_bulk_start(usbd_xfer_handle xfer)
2876 {
2877 #define exfer EXFER(xfer)
2878 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
2879 	usbd_device_handle dev = epipe->pipe.device;
2880 	ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
2881 	ehci_soft_qtd_t *data, *dataend;
2882 	ehci_soft_qh_t *sqh;
2883 	usbd_status err;
2884 	int len, isread, endpt;
2885 	int s;
2886 
2887 	DPRINTFN(2, ("ehci_device_bulk_start: xfer=%p len=%d flags=%d\n",
2888 		     xfer, xfer->length, xfer->flags));
2889 
2890 	if (sc->sc_dying)
2891 		return (USBD_IOERROR);
2892 
2893 #ifdef DIAGNOSTIC
2894 	if (xfer->rqflags & URQ_REQUEST)
2895 		panic("ehci_device_bulk_start: a request");
2896 #endif
2897 
2898 	len = xfer->length;
2899 	endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
2900 	isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2901 	sqh = epipe->sqh;
2902 
2903 	epipe->u.bulk.length = len;
2904 
2905 	err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer, &data,
2906 				   &dataend);
2907 	if (err) {
2908 		DPRINTFN(-1,("ehci_device_bulk_transfer: no memory\n"));
2909 		xfer->status = err;
2910 		usb_transfer_complete(xfer);
2911 		return (err);
2912 	}
2913 
2914 #ifdef EHCI_DEBUG
2915 	if (ehcidebug > 5) {
2916 		DPRINTF(("ehci_device_bulk_start: data(1)\n"));
2917 		ehci_dump_sqh(sqh);
2918 		ehci_dump_sqtds(data);
2919 	}
2920 #endif
2921 
2922 	/* Set up interrupt info. */
2923 	exfer->sqtdstart = data;
2924 	exfer->sqtdend = dataend;
2925 #ifdef DIAGNOSTIC
2926 	if (!exfer->isdone) {
2927 		printf("ehci_device_bulk_start: not done, ex=%p\n", exfer);
2928 	}
2929 	exfer->isdone = 0;
2930 #endif
2931 
2932 	s = splusb();
2933 	ehci_set_qh_qtd(sqh, data);
2934 	if (xfer->timeout && !sc->sc_bus.use_polling) {
2935 		usb_callout(xfer->timeout_handle, mstohz(xfer->timeout),
2936 			    ehci_timeout, xfer);
2937 	}
2938 	ehci_add_intr_list(sc, exfer);
2939 	xfer->status = USBD_IN_PROGRESS;
2940 	splx(s);
2941 
2942 #ifdef EHCI_DEBUG
2943 	if (ehcidebug > 10) {
2944 		DPRINTF(("ehci_device_bulk_start: data(2)\n"));
2945 		delay(10000);
2946 		DPRINTF(("ehci_device_bulk_start: data(3)\n"));
2947 		ehci_dump_regs(sc);
2948 #if 0
2949 		printf("async_head:\n");
2950 		ehci_dump_sqh(sc->sc_async_head);
2951 #endif
2952 		printf("sqh:\n");
2953 		ehci_dump_sqh(sqh);
2954 		ehci_dump_sqtds(data);
2955 	}
2956 #endif
2957 
2958 	if (sc->sc_bus.use_polling)
2959 		ehci_waitintr(sc, xfer);
2960 
2961 	return (USBD_IN_PROGRESS);
2962 #undef exfer
2963 }
2964 
2965 Static void
2966 ehci_device_bulk_abort(usbd_xfer_handle xfer)
2967 {
2968 	DPRINTF(("ehci_device_bulk_abort: xfer=%p\n", xfer));
2969 	ehci_abort_xfer(xfer, USBD_CANCELLED);
2970 }
2971 
2972 /*
2973  * Close a device bulk pipe.
2974  */
2975 Static void
2976 ehci_device_bulk_close(usbd_pipe_handle pipe)
2977 {
2978 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
2979 
2980 	DPRINTF(("ehci_device_bulk_close: pipe=%p\n", pipe));
2981 	ehci_close_pipe(pipe, sc->sc_async_head);
2982 }
2983 
2984 void
2985 ehci_device_bulk_done(usbd_xfer_handle xfer)
2986 {
2987 	struct ehci_xfer *ex = EXFER(xfer);
2988 	ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
2989 	/*struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;*/
2990 
2991 	DPRINTFN(10,("ehci_bulk_done: xfer=%p, actlen=%d\n",
2992 		     xfer, xfer->actlen));
2993 
2994 	if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
2995 		ehci_del_intr_list(ex);	/* remove from active list */
2996 		ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
2997 	}
2998 
2999 	DPRINTFN(5, ("ehci_bulk_done: length=%d\n", xfer->actlen));
3000 }
3001 
3002 /************************/
3003 
3004 Static usbd_status
3005 ehci_device_setintr(ehci_softc_t *sc, ehci_soft_qh_t *sqh, int ival)
3006 {
3007 	struct ehci_soft_islot *isp;
3008 	int islot, lev;
3009 
3010 	/* Find a poll rate that is large enough. */
3011 	for (lev = EHCI_IPOLLRATES - 1; lev > 0; lev--)
3012 		if (EHCI_ILEV_IVAL(lev) <= ival)
3013 			break;
3014 
3015 	/* Pick an interrupt slot at the right level. */
3016 	/* XXX could do better than picking at random */
3017 	sc->sc_rand = (sc->sc_rand + 191) % sc->sc_flsize;
3018 	islot = EHCI_IQHIDX(lev, sc->sc_rand);
3019 
3020 	sqh->islot = islot;
3021 	isp = &sc->sc_islots[islot];
3022 	ehci_add_qh(sqh, isp->sqh);
3023 
3024 	return (USBD_NORMAL_COMPLETION);
3025 }
3026 
3027 Static usbd_status
3028 ehci_device_intr_transfer(usbd_xfer_handle xfer)
3029 {
3030 	usbd_status err;
3031 
3032 	/* Insert last in queue. */
3033 	err = usb_insert_transfer(xfer);
3034 	if (err)
3035 		return (err);
3036 
3037 	/*
3038 	 * Pipe isn't running (otherwise err would be USBD_INPROG),
3039 	 * so start it first.
3040 	 */
3041 	return (ehci_device_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
3042 }
3043 
3044 Static usbd_status
3045 ehci_device_intr_start(usbd_xfer_handle xfer)
3046 {
3047 #define exfer EXFER(xfer)
3048 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
3049 	usbd_device_handle dev = xfer->pipe->device;
3050 	ehci_softc_t *sc = (ehci_softc_t *)dev->bus;
3051 	ehci_soft_qtd_t *data, *dataend;
3052 	ehci_soft_qh_t *sqh;
3053 	usbd_status err;
3054 	int len, isread, endpt;
3055 	int s;
3056 
3057 	DPRINTFN(2, ("ehci_device_intr_start: xfer=%p len=%d flags=%d\n",
3058 	    xfer, xfer->length, xfer->flags));
3059 
3060 	if (sc->sc_dying)
3061 		return (USBD_IOERROR);
3062 
3063 #ifdef DIAGNOSTIC
3064 	if (xfer->rqflags & URQ_REQUEST)
3065 		panic("ehci_device_intr_start: a request");
3066 #endif
3067 
3068 	len = xfer->length;
3069 	endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
3070 	isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3071 	sqh = epipe->sqh;
3072 
3073 	epipe->u.intr.length = len;
3074 
3075 	err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer, &data,
3076 	    &dataend);
3077 	if (err) {
3078 		DPRINTFN(-1, ("ehci_device_intr_start: no memory\n"));
3079 		xfer->status = err;
3080 		usb_transfer_complete(xfer);
3081 		return (err);
3082 	}
3083 
3084 #ifdef EHCI_DEBUG
3085 	if (ehcidebug > 5) {
3086 		DPRINTF(("ehci_device_intr_start: data(1)\n"));
3087 		ehci_dump_sqh(sqh);
3088 		ehci_dump_sqtds(data);
3089 	}
3090 #endif
3091 
3092 	/* Set up interrupt info. */
3093 	exfer->sqtdstart = data;
3094 	exfer->sqtdend = dataend;
3095 #ifdef DIAGNOSTIC
3096 	if (!exfer->isdone) {
3097 		printf("ehci_device_intr_start: not done, ex=%p\n", exfer);
3098 	}
3099 	exfer->isdone = 0;
3100 #endif
3101 
3102 	s = splusb();
3103 	ehci_set_qh_qtd(sqh, data);
3104 	if (xfer->timeout && !sc->sc_bus.use_polling) {
3105 		usb_callout(xfer->timeout_handle, mstohz(xfer->timeout),
3106 		    ehci_timeout, xfer);
3107 	}
3108 	ehci_add_intr_list(sc, exfer);
3109 	xfer->status = USBD_IN_PROGRESS;
3110 	splx(s);
3111 
3112 #ifdef EHCI_DEBUG
3113 	if (ehcidebug > 10) {
3114 		DPRINTF(("ehci_device_intr_start: data(2)\n"));
3115 		delay(10000);
3116 		DPRINTF(("ehci_device_intr_start: data(3)\n"));
3117 		ehci_dump_regs(sc);
3118 		printf("sqh:\n");
3119 		ehci_dump_sqh(sqh);
3120 		ehci_dump_sqtds(data);
3121 	}
3122 #endif
3123 
3124 	if (sc->sc_bus.use_polling)
3125 		ehci_waitintr(sc, xfer);
3126 
3127 	return (USBD_IN_PROGRESS);
3128 #undef exfer
3129 }
3130 
3131 Static void
3132 ehci_device_intr_abort(usbd_xfer_handle xfer)
3133 {
3134 	DPRINTFN(1, ("ehci_device_intr_abort: xfer=%p\n", xfer));
3135 	if (xfer->pipe->intrxfer == xfer) {
3136 		DPRINTFN(1, ("echi_device_intr_abort: remove\n"));
3137 		xfer->pipe->intrxfer = NULL;
3138 	}
3139 	ehci_abort_xfer(xfer, USBD_CANCELLED);
3140 }
3141 
3142 Static void
3143 ehci_device_intr_close(usbd_pipe_handle pipe)
3144 {
3145 	ehci_softc_t *sc = (ehci_softc_t *)pipe->device->bus;
3146 	struct ehci_pipe *epipe = (struct ehci_pipe *)pipe;
3147 	struct ehci_soft_islot *isp;
3148 
3149 	isp = &sc->sc_islots[epipe->sqh->islot];
3150 	ehci_close_pipe(pipe, isp->sqh);
3151 }
3152 
3153 Static void
3154 ehci_device_intr_done(usbd_xfer_handle xfer)
3155 {
3156 #define exfer EXFER(xfer)
3157 	struct ehci_xfer *ex = EXFER(xfer);
3158 	ehci_softc_t *sc = (ehci_softc_t *)xfer->pipe->device->bus;
3159 	struct ehci_pipe *epipe = (struct ehci_pipe *)xfer->pipe;
3160 	ehci_soft_qtd_t *data, *dataend;
3161 	ehci_soft_qh_t *sqh;
3162 	usbd_status err;
3163 	int len, isread, endpt, s;
3164 
3165 	DPRINTFN(10, ("ehci_device_intr_done: xfer=%p, actlen=%d\n",
3166 	    xfer, xfer->actlen));
3167 
3168 	if (xfer->pipe->repeat) {
3169 		ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
3170 
3171 		len = epipe->u.intr.length;
3172 		xfer->length = len;
3173 		endpt = epipe->pipe.endpoint->edesc->bEndpointAddress;
3174 		isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3175 		sqh = epipe->sqh;
3176 
3177 		err = ehci_alloc_sqtd_chain(epipe, sc, len, isread, xfer,
3178 		    &data, &dataend);
3179 		if (err) {
3180 			DPRINTFN(-1, ("ehci_device_intr_done: no memory\n"));
3181 			xfer->status = err;
3182 			return;
3183 		}
3184 
3185 		/* Set up interrupt info. */
3186 		exfer->sqtdstart = data;
3187 		exfer->sqtdend = dataend;
3188 #ifdef DIAGNOSTIC
3189 		if (!exfer->isdone) {
3190 			printf("ehci_device_intr_done: not done, ex=%p\n",
3191 			    exfer);
3192 		}
3193 		exfer->isdone = 0;
3194 #endif
3195 
3196 		s = splusb();
3197 		ehci_set_qh_qtd(sqh, data);
3198 		if (xfer->timeout && !sc->sc_bus.use_polling) {
3199 			usb_callout(xfer->timeout_handle,
3200 			    mstohz(xfer->timeout), ehci_timeout, xfer);
3201 		}
3202 		splx(s);
3203 
3204 		xfer->status = USBD_IN_PROGRESS;
3205 	} else if (xfer->status != USBD_NOMEM && ehci_active_intr_list(ex)) {
3206 		ehci_del_intr_list(ex); /* remove from active list */
3207 		ehci_free_sqtd_chain(sc, ex->sqtdstart, NULL);
3208 	}
3209 #undef exfer
3210 }
3211 
3212 /************************/
3213 
3214 Static usbd_status
3215 ehci_device_isoc_transfer(usbd_xfer_handle xfer)
3216 {
3217 	return USBD_IOERROR;
3218 }
3219 Static usbd_status
3220 ehci_device_isoc_start(usbd_xfer_handle xfer)
3221 {
3222 	return USBD_IOERROR;
3223 }
3224 Static void
3225 ehci_device_isoc_abort(usbd_xfer_handle xfer)
3226 {
3227 }
3228 Static void
3229 ehci_device_isoc_close(usbd_pipe_handle pipe)
3230 {
3231 }
3232 Static void
3233 ehci_device_isoc_done(usbd_xfer_handle xfer)
3234 {
3235 }
3236