xref: /netbsd-src/sys/dev/usb/uhci.c (revision 1ca5c1b28139779176bd5c13ad7c5f25c0bcd5f8)
1 /*	$NetBSD: uhci.c,v 1.150 2002/01/14 13:23:37 tsutsui Exp $	*/
2 /*	$FreeBSD: src/sys/dev/usb/uhci.c,v 1.33 1999/11/17 22:33:41 n_hibma Exp $	*/
3 
4 /*
5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net) at
10  * Carlstedt Research & Technology.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *        This product includes software developed by the NetBSD
23  *        Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * USB Universal Host Controller driver.
43  * Handles e.g. PIIX3 and PIIX4.
44  *
45  * UHCI spec: http://developer.intel.com/design/USB/UHCI11D.htm
46  * USB spec: http://www.usb.org/developers/data/usbspec.zip
47  * PIIXn spec: ftp://download.intel.com/design/intarch/datashts/29055002.pdf
48  *             ftp://download.intel.com/design/intarch/datashts/29056201.pdf
49  */
50 
51 #include <sys/cdefs.h>
52 __KERNEL_RCSID(0, "$NetBSD: uhci.c,v 1.150 2002/01/14 13:23:37 tsutsui Exp $");
53 
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
57 #include <sys/malloc.h>
58 #if defined(__NetBSD__) || defined(__OpenBSD__)
59 #include <sys/device.h>
60 #include <sys/select.h>
61 #elif defined(__FreeBSD__)
62 #include <sys/module.h>
63 #include <sys/bus.h>
64 #include <machine/bus_pio.h>
65 #if defined(DIAGNOSTIC) && defined(__i386__)
66 #include <machine/cpu.h>
67 #endif
68 #endif
69 #include <sys/proc.h>
70 #include <sys/queue.h>
71 
72 #include <machine/bus.h>
73 #include <machine/endian.h>
74 
75 #include <dev/usb/usb.h>
76 #include <dev/usb/usbdi.h>
77 #include <dev/usb/usbdivar.h>
78 #include <dev/usb/usb_mem.h>
79 #include <dev/usb/usb_quirks.h>
80 
81 #include <dev/usb/uhcireg.h>
82 #include <dev/usb/uhcivar.h>
83 
84 /* Use bandwidth reclamation for control transfers. Some devices choke on it. */
85 /*#define UHCI_CTL_LOOP */
86 
87 #if defined(__FreeBSD__)
88 #include <machine/clock.h>
89 
90 #define delay(d)		DELAY(d)
91 #endif
92 
93 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
94 
95 #if defined(__OpenBSD__)
96 struct cfdriver uhci_cd = {
97 	NULL, "uhci", DV_DULL
98 };
99 #endif
100 
101 #ifdef UHCI_DEBUG
102 uhci_softc_t *thesc;
103 #define DPRINTF(x)	if (uhcidebug) printf x
104 #define DPRINTFN(n,x)	if (uhcidebug>(n)) printf x
105 int uhcidebug = 0;
106 int uhcinoloop = 0;
107 #ifndef __NetBSD__
108 #define bitmask_snprintf(q,f,b,l) snprintf((b), (l), "%b", (q), (f))
109 #endif
110 #else
111 #define DPRINTF(x)
112 #define DPRINTFN(n,x)
113 #endif
114 
115 /*
116  * The UHCI controller is little endian, so on big endian machines
117  * the data strored in memory needs to be swapped.
118  */
119 #if defined(__FreeBSD__) || defined(__OpenBSD__)
120 #if BYTE_ORDER == BIG_ENDIAN
121 #define htole32(x) (bswap32(x))
122 #define le32toh(x) (bswap32(x))
123 #else
124 #define htole32(x) (x)
125 #define le32toh(x) (x)
126 #endif
127 #endif
128 
129 struct uhci_pipe {
130 	struct usbd_pipe pipe;
131 	int nexttoggle;
132 
133 	u_char aborting;
134 	usbd_xfer_handle abortstart, abortend;
135 
136 	/* Info needed for different pipe kinds. */
137 	union {
138 		/* Control pipe */
139 		struct {
140 			uhci_soft_qh_t *sqh;
141 			usb_dma_t reqdma;
142 			uhci_soft_td_t *setup, *stat;
143 			u_int length;
144 		} ctl;
145 		/* Interrupt pipe */
146 		struct {
147 			int npoll;
148 			uhci_soft_qh_t **qhs;
149 		} intr;
150 		/* Bulk pipe */
151 		struct {
152 			uhci_soft_qh_t *sqh;
153 			u_int length;
154 			int isread;
155 		} bulk;
156 		/* Iso pipe */
157 		struct iso {
158 			uhci_soft_td_t **stds;
159 			int next, inuse;
160 		} iso;
161 	} u;
162 };
163 
164 Static void		uhci_globalreset(uhci_softc_t *);
165 Static void		uhci_reset(uhci_softc_t *);
166 Static void		uhci_shutdown(void *v);
167 Static void		uhci_power(int, void *);
168 Static usbd_status	uhci_run(uhci_softc_t *, int run);
169 Static uhci_soft_td_t  *uhci_alloc_std(uhci_softc_t *);
170 Static void		uhci_free_std(uhci_softc_t *, uhci_soft_td_t *);
171 Static uhci_soft_qh_t  *uhci_alloc_sqh(uhci_softc_t *);
172 Static void		uhci_free_sqh(uhci_softc_t *, uhci_soft_qh_t *);
173 #if 0
174 Static void		uhci_enter_ctl_q(uhci_softc_t *, uhci_soft_qh_t *,
175 					 uhci_intr_info_t *);
176 Static void		uhci_exit_ctl_q(uhci_softc_t *, uhci_soft_qh_t *);
177 #endif
178 
179 Static void		uhci_free_std_chain(uhci_softc_t *,
180 					    uhci_soft_td_t *, uhci_soft_td_t *);
181 Static usbd_status	uhci_alloc_std_chain(struct uhci_pipe *,
182 			    uhci_softc_t *, int, int, u_int16_t, usb_dma_t *,
183 			    uhci_soft_td_t **, uhci_soft_td_t **);
184 Static void		uhci_poll_hub(void *);
185 Static void		uhci_waitintr(uhci_softc_t *, usbd_xfer_handle);
186 Static void		uhci_check_intr(uhci_softc_t *, uhci_intr_info_t *);
187 Static void		uhci_idone(uhci_intr_info_t *);
188 
189 Static void		uhci_abort_xfer(usbd_xfer_handle, usbd_status status);
190 
191 Static void		uhci_timeout(void *);
192 Static void		uhci_add_ls_ctrl(uhci_softc_t *, uhci_soft_qh_t *);
193 Static void		uhci_add_hs_ctrl(uhci_softc_t *, uhci_soft_qh_t *);
194 Static void		uhci_add_bulk(uhci_softc_t *, uhci_soft_qh_t *);
195 Static void		uhci_remove_ls_ctrl(uhci_softc_t *,uhci_soft_qh_t *);
196 Static void		uhci_remove_hs_ctrl(uhci_softc_t *,uhci_soft_qh_t *);
197 Static void		uhci_remove_bulk(uhci_softc_t *,uhci_soft_qh_t *);
198 Static int		uhci_str(usb_string_descriptor_t *, int, char *);
199 Static void		uhci_add_loop(uhci_softc_t *sc);
200 Static void		uhci_rem_loop(uhci_softc_t *sc);
201 
202 Static usbd_status	uhci_setup_isoc(usbd_pipe_handle pipe);
203 Static void		uhci_device_isoc_enter(usbd_xfer_handle);
204 
205 Static usbd_status	uhci_allocm(struct usbd_bus *, usb_dma_t *, u_int32_t);
206 Static void		uhci_freem(struct usbd_bus *, usb_dma_t *);
207 
208 Static usbd_xfer_handle	uhci_allocx(struct usbd_bus *);
209 Static void		uhci_freex(struct usbd_bus *, usbd_xfer_handle);
210 
211 Static usbd_status	uhci_device_ctrl_transfer(usbd_xfer_handle);
212 Static usbd_status	uhci_device_ctrl_start(usbd_xfer_handle);
213 Static void		uhci_device_ctrl_abort(usbd_xfer_handle);
214 Static void		uhci_device_ctrl_close(usbd_pipe_handle);
215 Static void		uhci_device_ctrl_done(usbd_xfer_handle);
216 
217 Static usbd_status	uhci_device_intr_transfer(usbd_xfer_handle);
218 Static usbd_status	uhci_device_intr_start(usbd_xfer_handle);
219 Static void		uhci_device_intr_abort(usbd_xfer_handle);
220 Static void		uhci_device_intr_close(usbd_pipe_handle);
221 Static void		uhci_device_intr_done(usbd_xfer_handle);
222 
223 Static usbd_status	uhci_device_bulk_transfer(usbd_xfer_handle);
224 Static usbd_status	uhci_device_bulk_start(usbd_xfer_handle);
225 Static void		uhci_device_bulk_abort(usbd_xfer_handle);
226 Static void		uhci_device_bulk_close(usbd_pipe_handle);
227 Static void		uhci_device_bulk_done(usbd_xfer_handle);
228 
229 Static usbd_status	uhci_device_isoc_transfer(usbd_xfer_handle);
230 Static usbd_status	uhci_device_isoc_start(usbd_xfer_handle);
231 Static void		uhci_device_isoc_abort(usbd_xfer_handle);
232 Static void		uhci_device_isoc_close(usbd_pipe_handle);
233 Static void		uhci_device_isoc_done(usbd_xfer_handle);
234 
235 Static usbd_status	uhci_root_ctrl_transfer(usbd_xfer_handle);
236 Static usbd_status	uhci_root_ctrl_start(usbd_xfer_handle);
237 Static void		uhci_root_ctrl_abort(usbd_xfer_handle);
238 Static void		uhci_root_ctrl_close(usbd_pipe_handle);
239 Static void		uhci_root_ctrl_done(usbd_xfer_handle);
240 
241 Static usbd_status	uhci_root_intr_transfer(usbd_xfer_handle);
242 Static usbd_status	uhci_root_intr_start(usbd_xfer_handle);
243 Static void		uhci_root_intr_abort(usbd_xfer_handle);
244 Static void		uhci_root_intr_close(usbd_pipe_handle);
245 Static void		uhci_root_intr_done(usbd_xfer_handle);
246 
247 Static usbd_status	uhci_open(usbd_pipe_handle);
248 Static void		uhci_poll(struct usbd_bus *);
249 Static void		uhci_softintr(void *);
250 
251 Static usbd_status	uhci_device_request(usbd_xfer_handle xfer);
252 
253 Static void		uhci_add_intr(uhci_softc_t *, uhci_soft_qh_t *);
254 Static void		uhci_remove_intr(uhci_softc_t*, uhci_soft_qh_t*);
255 Static usbd_status	uhci_device_setintr(uhci_softc_t *sc,
256 			    struct uhci_pipe *pipe, int ival);
257 
258 Static void		uhci_device_clear_toggle(usbd_pipe_handle pipe);
259 Static void		uhci_noop(usbd_pipe_handle pipe);
260 
261 Static __inline__ uhci_soft_qh_t *uhci_find_prev_qh(uhci_soft_qh_t *,
262 						    uhci_soft_qh_t *);
263 
264 #ifdef UHCI_DEBUG
265 Static void		uhci_dump_all(uhci_softc_t *);
266 Static void		uhci_dumpregs(uhci_softc_t *);
267 Static void		uhci_dump_qhs(uhci_soft_qh_t *);
268 Static void		uhci_dump_qh(uhci_soft_qh_t *);
269 Static void		uhci_dump_tds(uhci_soft_td_t *);
270 Static void		uhci_dump_td(uhci_soft_td_t *);
271 Static void		uhci_dump_ii(uhci_intr_info_t *ii);
272 void			uhci_dump(void);
273 #endif
274 
275 #define UBARR(sc) bus_space_barrier((sc)->iot, (sc)->ioh, 0, (sc)->sc_size, \
276 			BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE)
277 #define UWRITE1(sc, r, x) \
278  do { UBARR(sc); bus_space_write_1((sc)->iot, (sc)->ioh, (r), (x)); } while (0)
279 #define UWRITE2(sc, r, x) \
280  do { UBARR(sc); bus_space_write_2((sc)->iot, (sc)->ioh, (r), (x)); } while (0)
281 #define UWRITE4(sc, r, x) \
282  do { UBARR(sc); bus_space_write_4((sc)->iot, (sc)->ioh, (r), (x)); } while (0)
283 #define UREAD1(sc, r) (UBARR(sc), bus_space_read_1((sc)->iot, (sc)->ioh, (r)))
284 #define UREAD2(sc, r) (UBARR(sc), bus_space_read_2((sc)->iot, (sc)->ioh, (r)))
285 #define UREAD4(sc, r) (UBARR(sc), bus_space_read_4((sc)->iot, (sc)->ioh, (r)))
286 
287 #define UHCICMD(sc, cmd) UWRITE2(sc, UHCI_CMD, cmd)
288 #define UHCISTS(sc) UREAD2(sc, UHCI_STS)
289 
290 #define UHCI_RESET_TIMEOUT 100	/* ms, reset timeout */
291 
292 #define UHCI_CURFRAME(sc) (UREAD2(sc, UHCI_FRNUM) & UHCI_FRNUM_MASK)
293 
294 #define UHCI_INTR_ENDPT 1
295 
296 struct usbd_bus_methods uhci_bus_methods = {
297 	uhci_open,
298 	uhci_softintr,
299 	uhci_poll,
300 	uhci_allocm,
301 	uhci_freem,
302 	uhci_allocx,
303 	uhci_freex,
304 };
305 
306 struct usbd_pipe_methods uhci_root_ctrl_methods = {
307 	uhci_root_ctrl_transfer,
308 	uhci_root_ctrl_start,
309 	uhci_root_ctrl_abort,
310 	uhci_root_ctrl_close,
311 	uhci_noop,
312 	uhci_root_ctrl_done,
313 };
314 
315 struct usbd_pipe_methods uhci_root_intr_methods = {
316 	uhci_root_intr_transfer,
317 	uhci_root_intr_start,
318 	uhci_root_intr_abort,
319 	uhci_root_intr_close,
320 	uhci_noop,
321 	uhci_root_intr_done,
322 };
323 
324 struct usbd_pipe_methods uhci_device_ctrl_methods = {
325 	uhci_device_ctrl_transfer,
326 	uhci_device_ctrl_start,
327 	uhci_device_ctrl_abort,
328 	uhci_device_ctrl_close,
329 	uhci_noop,
330 	uhci_device_ctrl_done,
331 };
332 
333 struct usbd_pipe_methods uhci_device_intr_methods = {
334 	uhci_device_intr_transfer,
335 	uhci_device_intr_start,
336 	uhci_device_intr_abort,
337 	uhci_device_intr_close,
338 	uhci_device_clear_toggle,
339 	uhci_device_intr_done,
340 };
341 
342 struct usbd_pipe_methods uhci_device_bulk_methods = {
343 	uhci_device_bulk_transfer,
344 	uhci_device_bulk_start,
345 	uhci_device_bulk_abort,
346 	uhci_device_bulk_close,
347 	uhci_device_clear_toggle,
348 	uhci_device_bulk_done,
349 };
350 
351 struct usbd_pipe_methods uhci_device_isoc_methods = {
352 	uhci_device_isoc_transfer,
353 	uhci_device_isoc_start,
354 	uhci_device_isoc_abort,
355 	uhci_device_isoc_close,
356 	uhci_noop,
357 	uhci_device_isoc_done,
358 };
359 
360 #define uhci_add_intr_info(sc, ii) \
361 	LIST_INSERT_HEAD(&(sc)->sc_intrhead, (ii), list);
362 #define uhci_del_intr_info(ii) \
363 	LIST_REMOVE((ii), list)
364 
365 Static __inline__ uhci_soft_qh_t *
366 uhci_find_prev_qh(uhci_soft_qh_t *pqh, uhci_soft_qh_t *sqh)
367 {
368 	DPRINTFN(15,("uhci_find_prev_qh: pqh=%p sqh=%p\n", pqh, sqh));
369 
370 	for (; pqh->hlink != sqh; pqh = pqh->hlink) {
371 #if defined(DIAGNOSTIC) || defined(UHCI_DEBUG)
372 		if (le32toh(pqh->qh.qh_hlink) & UHCI_PTR_T) {
373 			printf("uhci_find_prev_qh: QH not found\n");
374 			return (NULL);
375 		}
376 #endif
377 	}
378 	return (pqh);
379 }
380 
381 void
382 uhci_globalreset(uhci_softc_t *sc)
383 {
384 	UHCICMD(sc, UHCI_CMD_GRESET);	/* global reset */
385 	usb_delay_ms(&sc->sc_bus, USB_BUS_RESET_DELAY); /* wait a little */
386 	UHCICMD(sc, 0);			/* do nothing */
387 }
388 
389 usbd_status
390 uhci_init(uhci_softc_t *sc)
391 {
392 	usbd_status err;
393 	int i, j;
394 	uhci_soft_qh_t *clsqh, *chsqh, *bsqh, *sqh, *lsqh;
395 	uhci_soft_td_t *std;
396 
397 	DPRINTFN(1,("uhci_init: start\n"));
398 
399 #ifdef UHCI_DEBUG
400 	thesc = sc;
401 
402 	if (uhcidebug > 2)
403 		uhci_dumpregs(sc);
404 #endif
405 
406 	UWRITE2(sc, UHCI_INTR, 0);		/* disable interrupts */
407 	uhci_globalreset(sc);			/* reset the controller */
408 	uhci_reset(sc);
409 
410 	/* Allocate and initialize real frame array. */
411 	err = usb_allocmem(&sc->sc_bus,
412 		  UHCI_FRAMELIST_COUNT * sizeof(uhci_physaddr_t),
413 		  UHCI_FRAMELIST_ALIGN, &sc->sc_dma);
414 	if (err)
415 		return (err);
416 	sc->sc_pframes = KERNADDR(&sc->sc_dma);
417 	UWRITE2(sc, UHCI_FRNUM, 0);		/* set frame number to 0 */
418 	UWRITE4(sc, UHCI_FLBASEADDR, DMAADDR(&sc->sc_dma)); /* set frame list*/
419 
420 	/*
421 	 * Allocate a TD, inactive, that hangs from the last QH.
422 	 * This is to avoid a bug in the PIIX that makes it run berserk
423 	 * otherwise.
424 	 */
425 	std = uhci_alloc_std(sc);
426 	if (std == NULL)
427 		return (USBD_NOMEM);
428 	std->link.std = NULL;
429 	std->td.td_link = htole32(UHCI_PTR_T);
430 	std->td.td_status = htole32(0); /* inactive */
431 	std->td.td_token = htole32(0);
432 	std->td.td_buffer = htole32(0);
433 
434 	/* Allocate the dummy QH marking the end and used for looping the QHs.*/
435 	lsqh = uhci_alloc_sqh(sc);
436 	if (lsqh == NULL)
437 		return (USBD_NOMEM);
438 	lsqh->hlink = NULL;
439 	lsqh->qh.qh_hlink = htole32(UHCI_PTR_T);	/* end of QH chain */
440 	lsqh->elink = std;
441 	lsqh->qh.qh_elink = htole32(std->physaddr | UHCI_PTR_TD);
442 	sc->sc_last_qh = lsqh;
443 
444 	/* Allocate the dummy QH where bulk traffic will be queued. */
445 	bsqh = uhci_alloc_sqh(sc);
446 	if (bsqh == NULL)
447 		return (USBD_NOMEM);
448 	bsqh->hlink = lsqh;
449 	bsqh->qh.qh_hlink = htole32(lsqh->physaddr | UHCI_PTR_QH);
450 	bsqh->elink = NULL;
451 	bsqh->qh.qh_elink = htole32(UHCI_PTR_T);
452 	sc->sc_bulk_start = sc->sc_bulk_end = bsqh;
453 
454 	/* Allocate dummy QH where high speed control traffic will be queued. */
455 	chsqh = uhci_alloc_sqh(sc);
456 	if (chsqh == NULL)
457 		return (USBD_NOMEM);
458 	chsqh->hlink = bsqh;
459 	chsqh->qh.qh_hlink = htole32(bsqh->physaddr | UHCI_PTR_QH);
460 	chsqh->elink = NULL;
461 	chsqh->qh.qh_elink = htole32(UHCI_PTR_T);
462 	sc->sc_hctl_start = sc->sc_hctl_end = chsqh;
463 
464 	/* Allocate dummy QH where control traffic will be queued. */
465 	clsqh = uhci_alloc_sqh(sc);
466 	if (clsqh == NULL)
467 		return (USBD_NOMEM);
468 	clsqh->hlink = bsqh;
469 	clsqh->qh.qh_hlink = htole32(chsqh->physaddr | UHCI_PTR_QH);
470 	clsqh->elink = NULL;
471 	clsqh->qh.qh_elink = htole32(UHCI_PTR_T);
472 	sc->sc_lctl_start = sc->sc_lctl_end = clsqh;
473 
474 	/*
475 	 * Make all (virtual) frame list pointers point to the interrupt
476 	 * queue heads and the interrupt queue heads at the control
477 	 * queue head and point the physical frame list to the virtual.
478 	 */
479 	for(i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
480 		std = uhci_alloc_std(sc);
481 		sqh = uhci_alloc_sqh(sc);
482 		if (std == NULL || sqh == NULL)
483 			return (USBD_NOMEM);
484 		std->link.sqh = sqh;
485 		std->td.td_link = htole32(sqh->physaddr | UHCI_PTR_QH);
486 		std->td.td_status = htole32(UHCI_TD_IOS); /* iso, inactive */
487 		std->td.td_token = htole32(0);
488 		std->td.td_buffer = htole32(0);
489 		sqh->hlink = clsqh;
490 		sqh->qh.qh_hlink = htole32(clsqh->physaddr | UHCI_PTR_QH);
491 		sqh->elink = NULL;
492 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
493 		sc->sc_vframes[i].htd = std;
494 		sc->sc_vframes[i].etd = std;
495 		sc->sc_vframes[i].hqh = sqh;
496 		sc->sc_vframes[i].eqh = sqh;
497 		for (j = i;
498 		     j < UHCI_FRAMELIST_COUNT;
499 		     j += UHCI_VFRAMELIST_COUNT)
500 			sc->sc_pframes[j] = htole32(std->physaddr);
501 	}
502 
503 	LIST_INIT(&sc->sc_intrhead);
504 
505 	SIMPLEQ_INIT(&sc->sc_free_xfers);
506 
507 	usb_callout_init(sc->sc_poll_handle);
508 
509 	/* Set up the bus struct. */
510 	sc->sc_bus.methods = &uhci_bus_methods;
511 	sc->sc_bus.pipe_size = sizeof(struct uhci_pipe);
512 
513 #if defined(__NetBSD__) || defined(__OpenBSD__)
514 	sc->sc_suspend = PWR_RESUME;
515 	sc->sc_powerhook = powerhook_establish(uhci_power, sc);
516 	sc->sc_shutdownhook = shutdownhook_establish(uhci_shutdown, sc);
517 #endif
518 
519 	DPRINTFN(1,("uhci_init: enabling\n"));
520 	UWRITE2(sc, UHCI_INTR, UHCI_INTR_TOCRCIE | UHCI_INTR_RIE |
521 		UHCI_INTR_IOCE | UHCI_INTR_SPIE);	/* enable interrupts */
522 
523 	UHCICMD(sc, UHCI_CMD_MAXP); /* Assume 64 byte packets at frame end */
524 
525 	return (uhci_run(sc, 1));		/* and here we go... */
526 }
527 
528 #if defined(__NetBSD__) || defined(__OpenBSD__)
529 int
530 uhci_activate(device_ptr_t self, enum devact act)
531 {
532 	struct uhci_softc *sc = (struct uhci_softc *)self;
533 	int rv = 0;
534 
535 	switch (act) {
536 	case DVACT_ACTIVATE:
537 		return (EOPNOTSUPP);
538 		break;
539 
540 	case DVACT_DEACTIVATE:
541 		if (sc->sc_child != NULL)
542 			rv = config_deactivate(sc->sc_child);
543 		break;
544 	}
545 	return (rv);
546 }
547 
548 int
549 uhci_detach(struct uhci_softc *sc, int flags)
550 {
551 	usbd_xfer_handle xfer;
552 	int rv = 0;
553 
554 	if (sc->sc_child != NULL)
555 		rv = config_detach(sc->sc_child, flags);
556 
557 	if (rv != 0)
558 		return (rv);
559 
560 #if defined(__NetBSD__) || defined(__OpenBSD__)
561 	powerhook_disestablish(sc->sc_powerhook);
562 	shutdownhook_disestablish(sc->sc_shutdownhook);
563 #endif
564 
565 	/* Free all xfers associated with this HC. */
566 	for (;;) {
567 		xfer = SIMPLEQ_FIRST(&sc->sc_free_xfers);
568 		if (xfer == NULL)
569 			break;
570 		SIMPLEQ_REMOVE_HEAD(&sc->sc_free_xfers, xfer, next);
571 		free(xfer, M_USB);
572 	}
573 
574 	/* XXX free other data structures XXX */
575 
576 	return (rv);
577 }
578 #endif
579 
580 usbd_status
581 uhci_allocm(struct usbd_bus *bus, usb_dma_t *dma, u_int32_t size)
582 {
583 	struct uhci_softc *sc = (struct uhci_softc *)bus;
584 	u_int32_t n;
585 
586 	/*
587 	 * XXX
588 	 * Since we are allocating a buffer we can assume that we will
589 	 * need TDs for it.  Since we don't want to allocate those from
590 	 * an interrupt context, we allocate them here and free them again.
591 	 * This is no guarantee that we'll get the TDs next time...
592 	 */
593 	n = size / 8;
594 	if (n > 16) {
595 		u_int32_t i;
596 		uhci_soft_td_t **stds;
597 		DPRINTF(("uhci_allocm: get %d TDs\n", n));
598 		stds = malloc(sizeof(uhci_soft_td_t *) * n, M_TEMP,
599 		    M_NOWAIT|M_ZERO);
600 		for(i=0; i < n; i++)
601 			stds[i] = uhci_alloc_std(sc);
602 		for(i=0; i < n; i++)
603 			if (stds[i] != NULL)
604 				uhci_free_std(sc, stds[i]);
605 		free(stds, M_TEMP);
606 	}
607 
608 	return (usb_allocmem(&sc->sc_bus, size, 0, dma));
609 }
610 
611 void
612 uhci_freem(struct usbd_bus *bus, usb_dma_t *dma)
613 {
614 	usb_freemem(&((struct uhci_softc *)bus)->sc_bus, dma);
615 }
616 
617 usbd_xfer_handle
618 uhci_allocx(struct usbd_bus *bus)
619 {
620 	struct uhci_softc *sc = (struct uhci_softc *)bus;
621 	usbd_xfer_handle xfer;
622 
623 	xfer = SIMPLEQ_FIRST(&sc->sc_free_xfers);
624 	if (xfer != NULL) {
625 		SIMPLEQ_REMOVE_HEAD(&sc->sc_free_xfers, xfer, next);
626 #ifdef DIAGNOSTIC
627 		if (xfer->busy_free != XFER_FREE) {
628 			printf("uhci_allocx: xfer=%p not free, 0x%08x\n", xfer,
629 			       xfer->busy_free);
630 		}
631 #endif
632 	} else {
633 		xfer = malloc(sizeof(struct uhci_xfer), M_USB, M_NOWAIT);
634 	}
635 	if (xfer != NULL) {
636 		memset(xfer, 0, sizeof (struct uhci_xfer));
637 		UXFER(xfer)->iinfo.sc = sc;
638 #ifdef DIAGNOSTIC
639 		UXFER(xfer)->iinfo.isdone = 1;
640 		xfer->busy_free = XFER_BUSY;
641 #endif
642 	}
643 	return (xfer);
644 }
645 
646 void
647 uhci_freex(struct usbd_bus *bus, usbd_xfer_handle xfer)
648 {
649 	struct uhci_softc *sc = (struct uhci_softc *)bus;
650 
651 #ifdef DIAGNOSTIC
652 	if (xfer->busy_free != XFER_BUSY) {
653 		printf("uhci_freex: xfer=%p not busy, 0x%08x\n", xfer,
654 		       xfer->busy_free);
655 		return;
656 	}
657 	xfer->busy_free = XFER_FREE;
658 	if (!UXFER(xfer)->iinfo.isdone) {
659 		printf("uhci_freex: !isdone\n");
660 		return;
661 	}
662 #endif
663 	SIMPLEQ_INSERT_HEAD(&sc->sc_free_xfers, xfer, next);
664 }
665 
666 /*
667  * Shut down the controller when the system is going down.
668  */
669 void
670 uhci_shutdown(void *v)
671 {
672 	uhci_softc_t *sc = v;
673 
674 	DPRINTF(("uhci_shutdown: stopping the HC\n"));
675 	uhci_run(sc, 0); /* stop the controller */
676 }
677 
678 /*
679  * Handle suspend/resume.
680  *
681  * We need to switch to polling mode here, because this routine is
682  * called from an interrupt context.  This is all right since we
683  * are almost suspended anyway.
684  */
685 void
686 uhci_power(int why, void *v)
687 {
688 	uhci_softc_t *sc = v;
689 	int cmd;
690 	int s;
691 
692 	s = splhardusb();
693 	cmd = UREAD2(sc, UHCI_CMD);
694 
695 	DPRINTF(("uhci_power: sc=%p, why=%d (was %d), cmd=0x%x\n",
696 		 sc, why, sc->sc_suspend, cmd));
697 
698 	switch (why) {
699 	case PWR_SUSPEND:
700 	case PWR_STANDBY:
701 #ifdef UHCI_DEBUG
702 		if (uhcidebug > 2)
703 			uhci_dumpregs(sc);
704 #endif
705 		if (sc->sc_intr_xfer != NULL)
706 			usb_uncallout(sc->sc_poll_handle, uhci_poll_hub,
707 			    sc->sc_intr_xfer);
708 		sc->sc_bus.use_polling++;
709 		uhci_run(sc, 0); /* stop the controller */
710 
711 		/* save some state if BIOS doesn't */
712 		sc->sc_saved_frnum = UREAD2(sc, UHCI_FRNUM);
713 		sc->sc_saved_sof = UREAD1(sc, UHCI_SOF);
714 
715 		UWRITE2(sc, UHCI_INTR, 0); /* disable intrs */
716 
717 		UHCICMD(sc, cmd | UHCI_CMD_EGSM); /* enter global suspend */
718 		usb_delay_ms(&sc->sc_bus, USB_RESUME_WAIT);
719 		sc->sc_suspend = why;
720 		sc->sc_bus.use_polling--;
721 		DPRINTF(("uhci_power: cmd=0x%x\n", UREAD2(sc, UHCI_CMD)));
722 		break;
723 	case PWR_RESUME:
724 #ifdef DIAGNOSTIC
725 		if (sc->sc_suspend == PWR_RESUME)
726 			printf("uhci_power: weird, resume without suspend.\n");
727 #endif
728 		sc->sc_bus.use_polling++;
729 		sc->sc_suspend = why;
730 		if (cmd & UHCI_CMD_RS)
731 			uhci_run(sc, 0); /* in case BIOS has started it */
732 
733 		/* restore saved state */
734 		UWRITE4(sc, UHCI_FLBASEADDR, DMAADDR(&sc->sc_dma));
735 		UWRITE2(sc, UHCI_FRNUM, sc->sc_saved_frnum);
736 		UWRITE1(sc, UHCI_SOF, sc->sc_saved_sof);
737 
738 		UHCICMD(sc, cmd | UHCI_CMD_FGR); /* force global resume */
739 		usb_delay_ms(&sc->sc_bus, USB_RESUME_DELAY);
740 		UHCICMD(sc, cmd & ~UHCI_CMD_EGSM); /* back to normal */
741 		UWRITE2(sc, UHCI_INTR, UHCI_INTR_TOCRCIE | UHCI_INTR_RIE |
742 			UHCI_INTR_IOCE | UHCI_INTR_SPIE); /* re-enable intrs */
743 		uhci_run(sc, 1); /* and start traffic again */
744 		usb_delay_ms(&sc->sc_bus, USB_RESUME_RECOVERY);
745 		sc->sc_bus.use_polling--;
746 		if (sc->sc_intr_xfer != NULL)
747 			usb_callout(sc->sc_poll_handle, sc->sc_ival,
748 				    uhci_poll_hub, sc->sc_intr_xfer);
749 #ifdef UHCI_DEBUG
750 		if (uhcidebug > 2)
751 			uhci_dumpregs(sc);
752 #endif
753 		break;
754 	case PWR_SOFTSUSPEND:
755 	case PWR_SOFTSTANDBY:
756 	case PWR_SOFTRESUME:
757 		break;
758 	}
759 	splx(s);
760 }
761 
762 #ifdef UHCI_DEBUG
763 Static void
764 uhci_dumpregs(uhci_softc_t *sc)
765 {
766 	DPRINTFN(-1,("%s regs: cmd=%04x, sts=%04x, intr=%04x, frnum=%04x, "
767 		     "flbase=%08x, sof=%04x, portsc1=%04x, portsc2=%04x\n",
768 		     USBDEVNAME(sc->sc_bus.bdev),
769 		     UREAD2(sc, UHCI_CMD),
770 		     UREAD2(sc, UHCI_STS),
771 		     UREAD2(sc, UHCI_INTR),
772 		     UREAD2(sc, UHCI_FRNUM),
773 		     UREAD4(sc, UHCI_FLBASEADDR),
774 		     UREAD1(sc, UHCI_SOF),
775 		     UREAD2(sc, UHCI_PORTSC1),
776 		     UREAD2(sc, UHCI_PORTSC2)));
777 }
778 
779 void
780 uhci_dump_td(uhci_soft_td_t *p)
781 {
782 	char sbuf[128], sbuf2[128];
783 
784 	DPRINTFN(-1,("TD(%p) at %08lx = link=0x%08lx status=0x%08lx "
785 		     "token=0x%08lx buffer=0x%08lx\n",
786 		     p, (long)p->physaddr,
787 		     (long)le32toh(p->td.td_link),
788 		     (long)le32toh(p->td.td_status),
789 		     (long)le32toh(p->td.td_token),
790 		     (long)le32toh(p->td.td_buffer)));
791 
792 	bitmask_snprintf((u_int32_t)le32toh(p->td.td_link), "\20\1T\2Q\3VF",
793 			 sbuf, sizeof(sbuf));
794 	bitmask_snprintf((u_int32_t)le32toh(p->td.td_status),
795 			 "\20\22BITSTUFF\23CRCTO\24NAK\25BABBLE\26DBUFFER\27"
796 			 "STALLED\30ACTIVE\31IOC\32ISO\33LS\36SPD",
797 			 sbuf2, sizeof(sbuf2));
798 
799 	DPRINTFN(-1,("  %s %s,errcnt=%d,actlen=%d pid=%02x,addr=%d,endpt=%d,"
800 		     "D=%d,maxlen=%d\n", sbuf, sbuf2,
801 		     UHCI_TD_GET_ERRCNT(le32toh(p->td.td_status)),
802 		     UHCI_TD_GET_ACTLEN(le32toh(p->td.td_status)),
803 		     UHCI_TD_GET_PID(le32toh(p->td.td_token)),
804 		     UHCI_TD_GET_DEVADDR(le32toh(p->td.td_token)),
805 		     UHCI_TD_GET_ENDPT(le32toh(p->td.td_token)),
806 		     UHCI_TD_GET_DT(le32toh(p->td.td_token)),
807 		     UHCI_TD_GET_MAXLEN(le32toh(p->td.td_token))));
808 }
809 
810 void
811 uhci_dump_qh(uhci_soft_qh_t *sqh)
812 {
813 	DPRINTFN(-1,("QH(%p) at %08x: hlink=%08x elink=%08x\n", sqh,
814 	    (int)sqh->physaddr, le32toh(sqh->qh.qh_hlink),
815 	    le32toh(sqh->qh.qh_elink)));
816 }
817 
818 
819 #if 1
820 void
821 uhci_dump(void)
822 {
823 	uhci_dump_all(thesc);
824 }
825 #endif
826 
827 void
828 uhci_dump_all(uhci_softc_t *sc)
829 {
830 	uhci_dumpregs(sc);
831 	printf("intrs=%d\n", sc->sc_bus.no_intrs);
832 	/*printf("framelist[i].link = %08x\n", sc->sc_framelist[0].link);*/
833 	uhci_dump_qh(sc->sc_lctl_start);
834 }
835 
836 
837 void
838 uhci_dump_qhs(uhci_soft_qh_t *sqh)
839 {
840 	uhci_dump_qh(sqh);
841 
842 	/* uhci_dump_qhs displays all the QHs and TDs from the given QH onwards
843 	 * Traverses sideways first, then down.
844 	 *
845 	 * QH1
846 	 * QH2
847 	 * No QH
848 	 * TD2.1
849 	 * TD2.2
850 	 * TD1.1
851 	 * etc.
852 	 *
853 	 * TD2.x being the TDs queued at QH2 and QH1 being referenced from QH1.
854 	 */
855 
856 
857 	if (sqh->hlink != NULL && !(le32toh(sqh->qh.qh_hlink) & UHCI_PTR_T))
858 		uhci_dump_qhs(sqh->hlink);
859 	else
860 		DPRINTF(("No QH\n"));
861 
862 	if (sqh->elink != NULL && !(le32toh(sqh->qh.qh_elink) & UHCI_PTR_T))
863 		uhci_dump_tds(sqh->elink);
864 	else
865 		DPRINTF(("No TD\n"));
866 }
867 
868 void
869 uhci_dump_tds(uhci_soft_td_t *std)
870 {
871 	uhci_soft_td_t *td;
872 
873 	for(td = std; td != NULL; td = td->link.std) {
874 		uhci_dump_td(td);
875 
876 		/* Check whether the link pointer in this TD marks
877 		 * the link pointer as end of queue. This avoids
878 		 * printing the free list in case the queue/TD has
879 		 * already been moved there (seatbelt).
880 		 */
881 		if (le32toh(td->td.td_link) & UHCI_PTR_T ||
882 		    le32toh(td->td.td_link) == 0)
883 			break;
884 	}
885 }
886 
887 Static void
888 uhci_dump_ii(uhci_intr_info_t *ii)
889 {
890 	usbd_pipe_handle pipe;
891 	usb_endpoint_descriptor_t *ed;
892 	usbd_device_handle dev;
893 
894 #ifdef DIAGNOSTIC
895 #define DONE ii->isdone
896 #else
897 #define DONE 0
898 #endif
899         if (ii == NULL) {
900                 printf("ii NULL\n");
901                 return;
902         }
903         if (ii->xfer == NULL) {
904 		printf("ii %p: done=%d xfer=NULL\n",
905 		       ii, DONE);
906                 return;
907         }
908         pipe = ii->xfer->pipe;
909         if (pipe == NULL) {
910 		printf("ii %p: done=%d xfer=%p pipe=NULL\n",
911 		       ii, DONE, ii->xfer);
912                 return;
913 	}
914         if (pipe->endpoint == NULL) {
915 		printf("ii %p: done=%d xfer=%p pipe=%p pipe->endpoint=NULL\n",
916 		       ii, DONE, ii->xfer, pipe);
917                 return;
918 	}
919         if (pipe->device == NULL) {
920 		printf("ii %p: done=%d xfer=%p pipe=%p pipe->device=NULL\n",
921 		       ii, DONE, ii->xfer, pipe);
922                 return;
923 	}
924         ed = pipe->endpoint->edesc;
925         dev = pipe->device;
926 	printf("ii %p: done=%d xfer=%p dev=%p vid=0x%04x pid=0x%04x addr=%d pipe=%p ep=0x%02x attr=0x%02x\n",
927 	       ii, DONE, ii->xfer, dev,
928 	       UGETW(dev->ddesc.idVendor),
929 	       UGETW(dev->ddesc.idProduct),
930 	       dev->address, pipe,
931 	       ed->bEndpointAddress, ed->bmAttributes);
932 #undef DONE
933 }
934 
935 void uhci_dump_iis(struct uhci_softc *sc);
936 void
937 uhci_dump_iis(struct uhci_softc *sc)
938 {
939 	uhci_intr_info_t *ii;
940 
941 	printf("intr_info list:\n");
942 	for (ii = LIST_FIRST(&sc->sc_intrhead); ii; ii = LIST_NEXT(ii, list))
943 		uhci_dump_ii(ii);
944 }
945 
946 void iidump(void);
947 void iidump(void) { uhci_dump_iis(thesc); }
948 
949 #endif
950 
951 /*
952  * This routine is executed periodically and simulates interrupts
953  * from the root controller interrupt pipe for port status change.
954  */
955 void
956 uhci_poll_hub(void *addr)
957 {
958 	usbd_xfer_handle xfer = addr;
959 	usbd_pipe_handle pipe = xfer->pipe;
960 	uhci_softc_t *sc = (uhci_softc_t *)pipe->device->bus;
961 	int s;
962 	u_char *p;
963 
964 	DPRINTFN(20, ("uhci_poll_hub\n"));
965 
966 	usb_callout(sc->sc_poll_handle, sc->sc_ival, uhci_poll_hub, xfer);
967 
968 	p = KERNADDR(&xfer->dmabuf);
969 	p[0] = 0;
970 	if (UREAD2(sc, UHCI_PORTSC1) & (UHCI_PORTSC_CSC|UHCI_PORTSC_OCIC))
971 		p[0] |= 1<<1;
972 	if (UREAD2(sc, UHCI_PORTSC2) & (UHCI_PORTSC_CSC|UHCI_PORTSC_OCIC))
973 		p[0] |= 1<<2;
974 	if (p[0] == 0)
975 		/* No change, try again in a while */
976 		return;
977 
978 	xfer->actlen = 1;
979 	xfer->status = USBD_NORMAL_COMPLETION;
980 	s = splusb();
981 	xfer->device->bus->intr_context++;
982 	usb_transfer_complete(xfer);
983 	xfer->device->bus->intr_context--;
984 	splx(s);
985 }
986 
987 void
988 uhci_root_intr_done(usbd_xfer_handle xfer)
989 {
990 }
991 
992 void
993 uhci_root_ctrl_done(usbd_xfer_handle xfer)
994 {
995 }
996 
997 /*
998  * Let the last QH loop back to the high speed control transfer QH.
999  * This is what intel calls "bandwidth reclamation" and improves
1000  * USB performance a lot for some devices.
1001  * If we are already looping, just count it.
1002  */
1003 void
1004 uhci_add_loop(uhci_softc_t *sc) {
1005 #ifdef UHCI_DEBUG
1006 	if (uhcinoloop)
1007 		return;
1008 #endif
1009 	if (++sc->sc_loops == 1) {
1010 		DPRINTFN(5,("uhci_start_loop: add\n"));
1011 		/* Note, we don't loop back the soft pointer. */
1012 		sc->sc_last_qh->qh.qh_hlink =
1013 		    htole32(sc->sc_hctl_start->physaddr | UHCI_PTR_QH);
1014 	}
1015 }
1016 
1017 void
1018 uhci_rem_loop(uhci_softc_t *sc) {
1019 #ifdef UHCI_DEBUG
1020 	if (uhcinoloop)
1021 		return;
1022 #endif
1023 	if (--sc->sc_loops == 0) {
1024 		DPRINTFN(5,("uhci_end_loop: remove\n"));
1025 		sc->sc_last_qh->qh.qh_hlink = htole32(UHCI_PTR_T);
1026 	}
1027 }
1028 
1029 /* Add high speed control QH, called at splusb(). */
1030 void
1031 uhci_add_hs_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1032 {
1033 	uhci_soft_qh_t *eqh;
1034 
1035 	SPLUSBCHECK;
1036 
1037 	DPRINTFN(10, ("uhci_add_ctrl: sqh=%p\n", sqh));
1038 	eqh = sc->sc_hctl_end;
1039 	sqh->hlink       = eqh->hlink;
1040 	sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1041 	eqh->hlink       = sqh;
1042 	eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1043 	sc->sc_hctl_end = sqh;
1044 #ifdef UHCI_CTL_LOOP
1045 	uhci_add_loop(sc);
1046 #endif
1047 }
1048 
1049 /* Remove high speed control QH, called at splusb(). */
1050 void
1051 uhci_remove_hs_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1052 {
1053 	uhci_soft_qh_t *pqh;
1054 
1055 	SPLUSBCHECK;
1056 
1057 	DPRINTFN(10, ("uhci_remove_hs_ctrl: sqh=%p\n", sqh));
1058 #ifdef UHCI_CTL_LOOP
1059 	uhci_rem_loop(sc);
1060 #endif
1061 	/*
1062 	 * The T bit should be set in the elink of the QH so that the HC
1063 	 * doesn't follow the pointer.  This condition may fail if the
1064 	 * the transferred packet was short so that the QH still points
1065 	 * at the last used TD.
1066 	 * In this case we set the T bit and wait a little for the HC
1067 	 * to stop looking at the TD.
1068 	 */
1069 	if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
1070 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1071 		delay(UHCI_QH_REMOVE_DELAY);
1072 	}
1073 
1074 	pqh = uhci_find_prev_qh(sc->sc_hctl_start, sqh);
1075 	pqh->hlink       = sqh->hlink;
1076 	pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1077 	delay(UHCI_QH_REMOVE_DELAY);
1078 	if (sc->sc_hctl_end == sqh)
1079 		sc->sc_hctl_end = pqh;
1080 }
1081 
1082 /* Add low speed control QH, called at splusb(). */
1083 void
1084 uhci_add_ls_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1085 {
1086 	uhci_soft_qh_t *eqh;
1087 
1088 	SPLUSBCHECK;
1089 
1090 	DPRINTFN(10, ("uhci_add_ls_ctrl: sqh=%p\n", sqh));
1091 	eqh = sc->sc_lctl_end;
1092 	sqh->hlink       = eqh->hlink;
1093 	sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1094 	eqh->hlink       = sqh;
1095 	eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1096 	sc->sc_lctl_end = sqh;
1097 }
1098 
1099 /* Remove low speed control QH, called at splusb(). */
1100 void
1101 uhci_remove_ls_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1102 {
1103 	uhci_soft_qh_t *pqh;
1104 
1105 	SPLUSBCHECK;
1106 
1107 	DPRINTFN(10, ("uhci_remove_ls_ctrl: sqh=%p\n", sqh));
1108 	/* See comment in uhci_remove_hs_ctrl() */
1109 	if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
1110 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1111 		delay(UHCI_QH_REMOVE_DELAY);
1112 	}
1113 	pqh = uhci_find_prev_qh(sc->sc_lctl_start, sqh);
1114 	pqh->hlink       = sqh->hlink;
1115 	pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1116 	delay(UHCI_QH_REMOVE_DELAY);
1117 	if (sc->sc_lctl_end == sqh)
1118 		sc->sc_lctl_end = pqh;
1119 }
1120 
1121 /* Add bulk QH, called at splusb(). */
1122 void
1123 uhci_add_bulk(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1124 {
1125 	uhci_soft_qh_t *eqh;
1126 
1127 	SPLUSBCHECK;
1128 
1129 	DPRINTFN(10, ("uhci_add_bulk: sqh=%p\n", sqh));
1130 	eqh = sc->sc_bulk_end;
1131 	sqh->hlink       = eqh->hlink;
1132 	sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1133 	eqh->hlink       = sqh;
1134 	eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1135 	sc->sc_bulk_end = sqh;
1136 	uhci_add_loop(sc);
1137 }
1138 
1139 /* Remove bulk QH, called at splusb(). */
1140 void
1141 uhci_remove_bulk(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1142 {
1143 	uhci_soft_qh_t *pqh;
1144 
1145 	SPLUSBCHECK;
1146 
1147 	DPRINTFN(10, ("uhci_remove_bulk: sqh=%p\n", sqh));
1148 	uhci_rem_loop(sc);
1149 	/* See comment in uhci_remove_hs_ctrl() */
1150 	if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
1151 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1152 		delay(UHCI_QH_REMOVE_DELAY);
1153 	}
1154 	pqh = uhci_find_prev_qh(sc->sc_bulk_start, sqh);
1155 	pqh->hlink       = sqh->hlink;
1156 	pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1157 	delay(UHCI_QH_REMOVE_DELAY);
1158 	if (sc->sc_bulk_end == sqh)
1159 		sc->sc_bulk_end = pqh;
1160 }
1161 
1162 Static int uhci_intr1(uhci_softc_t *);
1163 
1164 int
1165 uhci_intr(void *arg)
1166 {
1167 	uhci_softc_t *sc = arg;
1168 
1169 	if (sc->sc_dying)
1170 		return (0);
1171 
1172 	DPRINTFN(15,("uhci_intr: real interrupt\n"));
1173 	if (sc->sc_bus.use_polling) {
1174 #ifdef DIAGNOSTIC
1175 		printf("uhci_intr: ignored interrupt while polling\n");
1176 #endif
1177 		return (0);
1178 	}
1179 	return (uhci_intr1(sc));
1180 }
1181 
1182 int
1183 uhci_intr1(uhci_softc_t *sc)
1184 {
1185 	int status;
1186 	int ack;
1187 
1188 #ifdef UHCI_DEBUG
1189 	if (uhcidebug > 15) {
1190 		DPRINTF(("%s: uhci_intr1\n", USBDEVNAME(sc->sc_bus.bdev)));
1191 		uhci_dumpregs(sc);
1192 	}
1193 #endif
1194 
1195 	status = UREAD2(sc, UHCI_STS);
1196 	if (status == 0)	/* The interrupt was not for us. */
1197 		return (0);
1198 
1199 #if defined(DIAGNOSTIC) && defined(__NetBSD__)
1200 	if (sc->sc_suspend != PWR_RESUME)
1201 		printf("uhci_intr: suspended sts=0x%x\n", status);
1202 #endif
1203 
1204 	if (sc->sc_suspend != PWR_RESUME) {
1205 		printf("%s: interrupt while not operating ignored\n",
1206 		       USBDEVNAME(sc->sc_bus.bdev));
1207 		UWRITE2(sc, UHCI_STS, status); /* acknowledge the ints */
1208 		return (0);
1209 	}
1210 
1211 	ack = 0;
1212 	if (status & UHCI_STS_USBINT)
1213 		ack |= UHCI_STS_USBINT;
1214 	if (status & UHCI_STS_USBEI)
1215 		ack |= UHCI_STS_USBEI;
1216 	if (status & UHCI_STS_RD) {
1217 		ack |= UHCI_STS_RD;
1218 #ifdef UHCI_DEBUG
1219 		printf("%s: resume detect\n", USBDEVNAME(sc->sc_bus.bdev));
1220 #endif
1221 	}
1222 	if (status & UHCI_STS_HSE) {
1223 		ack |= UHCI_STS_HSE;
1224 		printf("%s: host system error\n", USBDEVNAME(sc->sc_bus.bdev));
1225 	}
1226 	if (status & UHCI_STS_HCPE) {
1227 		ack |= UHCI_STS_HCPE;
1228 		printf("%s: host controller process error\n",
1229 		       USBDEVNAME(sc->sc_bus.bdev));
1230 	}
1231 	if (status & UHCI_STS_HCH) {
1232 		/* no acknowledge needed */
1233 		if (!sc->sc_dying) {
1234 			printf("%s: host controller halted\n",
1235 			    USBDEVNAME(sc->sc_bus.bdev));
1236 #ifdef UHCI_DEBUG
1237 			uhci_dump_all(sc);
1238 #endif
1239 		}
1240 		sc->sc_dying = 1;
1241 	}
1242 
1243 	if (!ack)
1244 		return (0);	/* nothing to acknowledge */
1245 	UWRITE2(sc, UHCI_STS, ack); /* acknowledge the ints */
1246 
1247 	sc->sc_bus.no_intrs++;
1248 	usb_schedsoftintr(&sc->sc_bus);
1249 
1250 	DPRINTFN(10, ("%s: uhci_intr: exit\n", USBDEVNAME(sc->sc_bus.bdev)));
1251 
1252 	return (1);
1253 }
1254 
1255 void
1256 uhci_softintr(void *v)
1257 {
1258 	uhci_softc_t *sc = v;
1259 	uhci_intr_info_t *ii;
1260 
1261 	DPRINTFN(10,("%s: uhci_softintr (%d)\n", USBDEVNAME(sc->sc_bus.bdev),
1262 		     sc->sc_bus.intr_context));
1263 
1264 	sc->sc_bus.intr_context++;
1265 
1266 	/*
1267 	 * Interrupts on UHCI really suck.  When the host controller
1268 	 * interrupts because a transfer is completed there is no
1269 	 * way of knowing which transfer it was.  You can scan down
1270 	 * the TDs and QHs of the previous frame to limit the search,
1271 	 * but that assumes that the interrupt was not delayed by more
1272 	 * than 1 ms, which may not always be true (e.g. after debug
1273 	 * output on a slow console).
1274 	 * We scan all interrupt descriptors to see if any have
1275 	 * completed.
1276 	 */
1277 	for (ii = LIST_FIRST(&sc->sc_intrhead); ii; ii = LIST_NEXT(ii, list))
1278 		uhci_check_intr(sc, ii);
1279 
1280 	sc->sc_bus.intr_context--;
1281 }
1282 
1283 /* Check for an interrupt. */
1284 void
1285 uhci_check_intr(uhci_softc_t *sc, uhci_intr_info_t *ii)
1286 {
1287 	uhci_soft_td_t *std, *lstd;
1288 	u_int32_t status;
1289 
1290 	DPRINTFN(15, ("uhci_check_intr: ii=%p\n", ii));
1291 #ifdef DIAGNOSTIC
1292 	if (ii == NULL) {
1293 		printf("uhci_check_intr: no ii? %p\n", ii);
1294 		return;
1295 	}
1296 #endif
1297 	if (ii->stdstart == NULL)
1298 		return;
1299 	lstd = ii->stdend;
1300 #ifdef DIAGNOSTIC
1301 	if (lstd == NULL) {
1302 		printf("uhci_check_intr: std==0\n");
1303 		return;
1304 	}
1305 #endif
1306 	/*
1307 	 * If the last TD is still active we need to check whether there
1308 	 * is a an error somewhere in the middle, or whether there was a
1309 	 * short packet (SPD and not ACTIVE).
1310 	 */
1311 	if (le32toh(lstd->td.td_status) & UHCI_TD_ACTIVE) {
1312 		DPRINTFN(12, ("uhci_check_intr: active ii=%p\n", ii));
1313 		for (std = ii->stdstart; std != lstd; std = std->link.std) {
1314 			status = le32toh(std->td.td_status);
1315 			/* If there's an active TD the xfer isn't done. */
1316 			if (status & UHCI_TD_ACTIVE)
1317 				break;
1318 			/* Any kind of error makes the xfer done. */
1319 			if (status & UHCI_TD_STALLED)
1320 				goto done;
1321 			/* We want short packets, and it is short: it's done */
1322 			if ((status & UHCI_TD_SPD) &&
1323 			      UHCI_TD_GET_ACTLEN(status) <
1324 			      UHCI_TD_GET_MAXLEN(le32toh(std->td.td_token)))
1325 				goto done;
1326 		}
1327 		DPRINTFN(12, ("uhci_check_intr: ii=%p std=%p still active\n",
1328 			      ii, ii->stdstart));
1329 		return;
1330 	}
1331  done:
1332 	DPRINTFN(12, ("uhci_check_intr: ii=%p done\n", ii));
1333 	usb_uncallout(ii->xfer->timeout_handle, uhci_timeout, ii);
1334 	uhci_idone(ii);
1335 }
1336 
1337 /* Called at splusb() */
1338 void
1339 uhci_idone(uhci_intr_info_t *ii)
1340 {
1341 	usbd_xfer_handle xfer = ii->xfer;
1342 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
1343 	uhci_soft_td_t *std;
1344 	u_int32_t status = 0, nstatus;
1345 	int actlen;
1346 
1347 	DPRINTFN(12, ("uhci_idone: ii=%p\n", ii));
1348 #ifdef DIAGNOSTIC
1349 	{
1350 		int s = splhigh();
1351 		if (ii->isdone) {
1352 			splx(s);
1353 #ifdef UHCI_DEBUG
1354 			printf("uhci_idone: ii is done!\n   ");
1355 			uhci_dump_ii(ii);
1356 #else
1357 			printf("uhci_idone: ii=%p is done!\n", ii);
1358 #endif
1359 			return;
1360 		}
1361 		ii->isdone = 1;
1362 		splx(s);
1363 	}
1364 #endif
1365 
1366 	if (xfer->status == USBD_CANCELLED ||
1367 	    xfer->status == USBD_TIMEOUT) {
1368 		DPRINTF(("uhci_idone: aborted xfer=%p\n", xfer));
1369 		return;
1370 	}
1371 
1372 	if (xfer->nframes != 0) {
1373 		/* Isoc transfer, do things differently. */
1374 		uhci_soft_td_t **stds = upipe->u.iso.stds;
1375 		int i, n, nframes, len;
1376 
1377 		DPRINTFN(5,("uhci_idone: ii=%p isoc ready\n", ii));
1378 
1379 		nframes = xfer->nframes;
1380 		actlen = 0;
1381 		n = UXFER(xfer)->curframe;
1382 		for (i = 0; i < nframes; i++) {
1383 			std = stds[n];
1384 #ifdef UHCI_DEBUG
1385 			if (uhcidebug > 5) {
1386 				DPRINTFN(-1,("uhci_idone: isoc TD %d\n", i));
1387 				uhci_dump_td(std);
1388 			}
1389 #endif
1390 			if (++n >= UHCI_VFRAMELIST_COUNT)
1391 				n = 0;
1392 			status = le32toh(std->td.td_status);
1393 			len = UHCI_TD_GET_ACTLEN(status);
1394 			xfer->frlengths[i] = len;
1395 			actlen += len;
1396 		}
1397 		upipe->u.iso.inuse -= nframes;
1398 		xfer->actlen = actlen;
1399 		xfer->status = USBD_NORMAL_COMPLETION;
1400 		goto end;
1401 	}
1402 
1403 #ifdef UHCI_DEBUG
1404 	DPRINTFN(10, ("uhci_idone: ii=%p, xfer=%p, pipe=%p ready\n",
1405 		      ii, xfer, upipe));
1406 	if (uhcidebug > 10)
1407 		uhci_dump_tds(ii->stdstart);
1408 #endif
1409 
1410 	/* The transfer is done, compute actual length and status. */
1411 	actlen = 0;
1412 	for (std = ii->stdstart; std != NULL; std = std->link.std) {
1413 		nstatus = le32toh(std->td.td_status);
1414 		if (nstatus & UHCI_TD_ACTIVE)
1415 			break;
1416 
1417 		status = nstatus;
1418 		if (UHCI_TD_GET_PID(le32toh(std->td.td_token)) !=
1419 			UHCI_TD_PID_SETUP)
1420 			actlen += UHCI_TD_GET_ACTLEN(status);
1421 	}
1422 	/* If there are left over TDs we need to update the toggle. */
1423 	if (std != NULL)
1424 		upipe->nexttoggle = UHCI_TD_GET_DT(le32toh(std->td.td_token));
1425 
1426 	status &= UHCI_TD_ERROR;
1427 	DPRINTFN(10, ("uhci_idone: actlen=%d, status=0x%x\n",
1428 		      actlen, status));
1429 	xfer->actlen = actlen;
1430 	if (status != 0) {
1431 #ifdef UHCI_DEBUG
1432 		char sbuf[128];
1433 
1434 		bitmask_snprintf((u_int32_t)status,
1435 				 "\20\22BITSTUFF\23CRCTO\24NAK\25"
1436 				 "BABBLE\26DBUFFER\27STALLED\30ACTIVE",
1437 				 sbuf, sizeof(sbuf));
1438 
1439 		DPRINTFN((status == UHCI_TD_STALLED)*10,
1440 			 ("uhci_idone: error, addr=%d, endpt=0x%02x, "
1441 			  "status 0x%s\n",
1442 			  xfer->pipe->device->address,
1443 			  xfer->pipe->endpoint->edesc->bEndpointAddress,
1444 			  sbuf));
1445 #endif
1446 
1447 		if (status == UHCI_TD_STALLED)
1448 			xfer->status = USBD_STALLED;
1449 		else
1450 			xfer->status = USBD_IOERROR; /* more info XXX */
1451 	} else {
1452 		xfer->status = USBD_NORMAL_COMPLETION;
1453 	}
1454 
1455  end:
1456 	usb_transfer_complete(xfer);
1457 	DPRINTFN(12, ("uhci_idone: ii=%p done\n", ii));
1458 }
1459 
1460 /*
1461  * Called when a request does not complete.
1462  */
1463 void
1464 uhci_timeout(void *addr)
1465 {
1466 	uhci_intr_info_t *ii = addr;
1467 
1468 	DPRINTF(("uhci_timeout: ii=%p\n", ii));
1469 
1470 #ifdef UHCI_DEBUG
1471 	if (uhcidebug > 10)
1472 		uhci_dump_tds(ii->stdstart);
1473 #endif
1474 
1475 	ii->xfer->device->bus->intr_context++;
1476 	uhci_abort_xfer(ii->xfer, USBD_TIMEOUT);
1477 	ii->xfer->device->bus->intr_context--;
1478 }
1479 
1480 /*
1481  * Wait here until controller claims to have an interrupt.
1482  * Then call uhci_intr and return.  Use timeout to avoid waiting
1483  * too long.
1484  * Only used during boot when interrupts are not enabled yet.
1485  */
1486 void
1487 uhci_waitintr(uhci_softc_t *sc, usbd_xfer_handle xfer)
1488 {
1489 	int timo = xfer->timeout;
1490 	uhci_intr_info_t *ii;
1491 
1492 	DPRINTFN(10,("uhci_waitintr: timeout = %dms\n", timo));
1493 
1494 	xfer->status = USBD_IN_PROGRESS;
1495 	for (; timo >= 0; timo--) {
1496 		usb_delay_ms(&sc->sc_bus, 1);
1497 		DPRINTFN(20,("uhci_waitintr: 0x%04x\n", UREAD2(sc, UHCI_STS)));
1498 		if (UREAD2(sc, UHCI_STS) & UHCI_STS_USBINT) {
1499 			uhci_intr1(sc);
1500 			if (xfer->status != USBD_IN_PROGRESS)
1501 				return;
1502 		}
1503 	}
1504 
1505 	/* Timeout */
1506 	DPRINTF(("uhci_waitintr: timeout\n"));
1507 	for (ii = LIST_FIRST(&sc->sc_intrhead);
1508 	     ii != NULL && ii->xfer != xfer;
1509 	     ii = LIST_NEXT(ii, list))
1510 		;
1511 #ifdef DIAGNOSTIC
1512 	if (ii == NULL)
1513 		panic("uhci_waitintr: lost intr_info\n");
1514 #endif
1515 	uhci_idone(ii);
1516 }
1517 
1518 void
1519 uhci_poll(struct usbd_bus *bus)
1520 {
1521 	uhci_softc_t *sc = (uhci_softc_t *)bus;
1522 
1523 	if (UREAD2(sc, UHCI_STS) & UHCI_STS_USBINT)
1524 		uhci_intr1(sc);
1525 }
1526 
1527 void
1528 uhci_reset(uhci_softc_t *sc)
1529 {
1530 	int n;
1531 
1532 	UHCICMD(sc, UHCI_CMD_HCRESET);
1533 	/* The reset bit goes low when the controller is done. */
1534 	for (n = 0; n < UHCI_RESET_TIMEOUT &&
1535 		    (UREAD2(sc, UHCI_CMD) & UHCI_CMD_HCRESET); n++)
1536 		usb_delay_ms(&sc->sc_bus, 1);
1537 	if (n >= UHCI_RESET_TIMEOUT)
1538 		printf("%s: controller did not reset\n",
1539 		       USBDEVNAME(sc->sc_bus.bdev));
1540 }
1541 
1542 usbd_status
1543 uhci_run(uhci_softc_t *sc, int run)
1544 {
1545 	int s, n, running;
1546 	u_int16_t cmd;
1547 
1548 	run = run != 0;
1549 	s = splhardusb();
1550 	DPRINTF(("uhci_run: setting run=%d\n", run));
1551 	cmd = UREAD2(sc, UHCI_CMD);
1552 	if (run)
1553 		cmd |= UHCI_CMD_RS;
1554 	else
1555 		cmd &= ~UHCI_CMD_RS;
1556 	UHCICMD(sc, cmd);
1557 	for(n = 0; n < 10; n++) {
1558 		running = !(UREAD2(sc, UHCI_STS) & UHCI_STS_HCH);
1559 		/* return when we've entered the state we want */
1560 		if (run == running) {
1561 			splx(s);
1562 			DPRINTF(("uhci_run: done cmd=0x%x sts=0x%x\n",
1563 				 UREAD2(sc, UHCI_CMD), UREAD2(sc, UHCI_STS)));
1564 			return (USBD_NORMAL_COMPLETION);
1565 		}
1566 		usb_delay_ms(&sc->sc_bus, 1);
1567 	}
1568 	splx(s);
1569 	printf("%s: cannot %s\n", USBDEVNAME(sc->sc_bus.bdev),
1570 	       run ? "start" : "stop");
1571 	return (USBD_IOERROR);
1572 }
1573 
1574 /*
1575  * Memory management routines.
1576  *  uhci_alloc_std allocates TDs
1577  *  uhci_alloc_sqh allocates QHs
1578  * These two routines do their own free list management,
1579  * partly for speed, partly because allocating DMAable memory
1580  * has page size granularaity so much memory would be wasted if
1581  * only one TD/QH (32 bytes) was placed in each allocated chunk.
1582  */
1583 
1584 uhci_soft_td_t *
1585 uhci_alloc_std(uhci_softc_t *sc)
1586 {
1587 	uhci_soft_td_t *std;
1588 	usbd_status err;
1589 	int i, offs;
1590 	usb_dma_t dma;
1591 
1592 	if (sc->sc_freetds == NULL) {
1593 		DPRINTFN(2,("uhci_alloc_std: allocating chunk\n"));
1594 		err = usb_allocmem(&sc->sc_bus, UHCI_STD_SIZE * UHCI_STD_CHUNK,
1595 			  UHCI_TD_ALIGN, &dma);
1596 		if (err)
1597 			return (0);
1598 		for(i = 0; i < UHCI_STD_CHUNK; i++) {
1599 			offs = i * UHCI_STD_SIZE;
1600 			std = (uhci_soft_td_t *)((char *)KERNADDR(&dma) +offs);
1601 			std->physaddr = DMAADDR(&dma) + offs;
1602 			std->link.std = sc->sc_freetds;
1603 			sc->sc_freetds = std;
1604 		}
1605 	}
1606 	std = sc->sc_freetds;
1607 	sc->sc_freetds = std->link.std;
1608 	memset(&std->td, 0, sizeof(uhci_td_t));
1609 	return std;
1610 }
1611 
1612 void
1613 uhci_free_std(uhci_softc_t *sc, uhci_soft_td_t *std)
1614 {
1615 #ifdef DIAGNOSTIC
1616 #define TD_IS_FREE 0x12345678
1617 	if (le32toh(std->td.td_token) == TD_IS_FREE) {
1618 		printf("uhci_free_std: freeing free TD %p\n", std);
1619 		return;
1620 	}
1621 	std->td.td_token = htole32(TD_IS_FREE);
1622 #endif
1623 	std->link.std = sc->sc_freetds;
1624 	sc->sc_freetds = std;
1625 }
1626 
1627 uhci_soft_qh_t *
1628 uhci_alloc_sqh(uhci_softc_t *sc)
1629 {
1630 	uhci_soft_qh_t *sqh;
1631 	usbd_status err;
1632 	int i, offs;
1633 	usb_dma_t dma;
1634 
1635 	if (sc->sc_freeqhs == NULL) {
1636 		DPRINTFN(2, ("uhci_alloc_sqh: allocating chunk\n"));
1637 		err = usb_allocmem(&sc->sc_bus, UHCI_SQH_SIZE * UHCI_SQH_CHUNK,
1638 			  UHCI_QH_ALIGN, &dma);
1639 		if (err)
1640 			return (0);
1641 		for(i = 0; i < UHCI_SQH_CHUNK; i++) {
1642 			offs = i * UHCI_SQH_SIZE;
1643 			sqh = (uhci_soft_qh_t *)((char *)KERNADDR(&dma) +offs);
1644 			sqh->physaddr = DMAADDR(&dma) + offs;
1645 			sqh->hlink = sc->sc_freeqhs;
1646 			sc->sc_freeqhs = sqh;
1647 		}
1648 	}
1649 	sqh = sc->sc_freeqhs;
1650 	sc->sc_freeqhs = sqh->hlink;
1651 	memset(&sqh->qh, 0, sizeof(uhci_qh_t));
1652 	return (sqh);
1653 }
1654 
1655 void
1656 uhci_free_sqh(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1657 {
1658 	sqh->hlink = sc->sc_freeqhs;
1659 	sc->sc_freeqhs = sqh;
1660 }
1661 
1662 void
1663 uhci_free_std_chain(uhci_softc_t *sc, uhci_soft_td_t *std,
1664 		    uhci_soft_td_t *stdend)
1665 {
1666 	uhci_soft_td_t *p;
1667 
1668 	for (; std != stdend; std = p) {
1669 		p = std->link.std;
1670 		uhci_free_std(sc, std);
1671 	}
1672 }
1673 
1674 usbd_status
1675 uhci_alloc_std_chain(struct uhci_pipe *upipe, uhci_softc_t *sc, int len,
1676 		     int rd, u_int16_t flags, usb_dma_t *dma,
1677 		     uhci_soft_td_t **sp, uhci_soft_td_t **ep)
1678 {
1679 	uhci_soft_td_t *p, *lastp;
1680 	uhci_physaddr_t lastlink;
1681 	int i, ntd, l, tog, maxp;
1682 	u_int32_t status;
1683 	int addr = upipe->pipe.device->address;
1684 	int endpt = upipe->pipe.endpoint->edesc->bEndpointAddress;
1685 
1686 	DPRINTFN(8, ("uhci_alloc_std_chain: addr=%d endpt=%d len=%d speed=%d "
1687 		      "flags=0x%x\n", addr, UE_GET_ADDR(endpt), len,
1688 		      upipe->pipe.device->speed, flags));
1689 	maxp = UGETW(upipe->pipe.endpoint->edesc->wMaxPacketSize);
1690 	if (maxp == 0) {
1691 		printf("uhci_alloc_std_chain: maxp=0\n");
1692 		return (USBD_INVAL);
1693 	}
1694 	ntd = (len + maxp - 1) / maxp;
1695 	if ((flags & USBD_FORCE_SHORT_XFER) && len % maxp == 0)
1696 		ntd++;
1697 	DPRINTFN(10, ("uhci_alloc_std_chain: maxp=%d ntd=%d\n", maxp, ntd));
1698 	if (ntd == 0) {
1699 		*sp = *ep = 0;
1700 		DPRINTFN(-1,("uhci_alloc_std_chain: ntd=0\n"));
1701 		return (USBD_NORMAL_COMPLETION);
1702 	}
1703 	tog = upipe->nexttoggle;
1704 	if (ntd % 2 == 0)
1705 		tog ^= 1;
1706 	upipe->nexttoggle = tog ^ 1;
1707 	lastp = NULL;
1708 	lastlink = UHCI_PTR_T;
1709 	ntd--;
1710 	status = UHCI_TD_ZERO_ACTLEN(UHCI_TD_SET_ERRCNT(3) | UHCI_TD_ACTIVE);
1711 	if (upipe->pipe.device->speed == USB_SPEED_LOW)
1712 		status |= UHCI_TD_LS;
1713 	if (flags & USBD_SHORT_XFER_OK)
1714 		status |= UHCI_TD_SPD;
1715 	for (i = ntd; i >= 0; i--) {
1716 		p = uhci_alloc_std(sc);
1717 		if (p == NULL) {
1718 			uhci_free_std_chain(sc, lastp, NULL);
1719 			return (USBD_NOMEM);
1720 		}
1721 		p->link.std = lastp;
1722 		p->td.td_link = htole32(lastlink | UHCI_PTR_VF | UHCI_PTR_TD);
1723 		lastp = p;
1724 		lastlink = p->physaddr;
1725 		p->td.td_status = htole32(status);
1726 		if (i == ntd) {
1727 			/* last TD */
1728 			l = len % maxp;
1729 			if (l == 0 && !(flags & USBD_FORCE_SHORT_XFER))
1730 				l = maxp;
1731 			*ep = p;
1732 		} else
1733 			l = maxp;
1734 		p->td.td_token =
1735 		    htole32(rd ? UHCI_TD_IN (l, endpt, addr, tog) :
1736 				 UHCI_TD_OUT(l, endpt, addr, tog));
1737 		p->td.td_buffer = htole32(DMAADDR(dma) + i * maxp);
1738 		tog ^= 1;
1739 	}
1740 	*sp = lastp;
1741 	DPRINTFN(10, ("uhci_alloc_std_chain: nexttog=%d\n",
1742 		      upipe->nexttoggle));
1743 	return (USBD_NORMAL_COMPLETION);
1744 }
1745 
1746 void
1747 uhci_device_clear_toggle(usbd_pipe_handle pipe)
1748 {
1749 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
1750 	upipe->nexttoggle = 0;
1751 }
1752 
1753 void
1754 uhci_noop(usbd_pipe_handle pipe)
1755 {
1756 }
1757 
1758 usbd_status
1759 uhci_device_bulk_transfer(usbd_xfer_handle xfer)
1760 {
1761 	usbd_status err;
1762 
1763 	/* Insert last in queue. */
1764 	err = usb_insert_transfer(xfer);
1765 	if (err)
1766 		return (err);
1767 
1768 	/*
1769 	 * Pipe isn't running (otherwise err would be USBD_INPROG),
1770 	 * so start it first.
1771 	 */
1772 	return (uhci_device_bulk_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
1773 }
1774 
1775 usbd_status
1776 uhci_device_bulk_start(usbd_xfer_handle xfer)
1777 {
1778 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
1779 	usbd_device_handle dev = upipe->pipe.device;
1780 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
1781 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
1782 	uhci_soft_td_t *data, *dataend;
1783 	uhci_soft_qh_t *sqh;
1784 	usbd_status err;
1785 	int len, isread, endpt;
1786 	int s;
1787 
1788 	DPRINTFN(3, ("uhci_device_bulk_transfer: xfer=%p len=%d flags=%d\n",
1789 		     xfer, xfer->length, xfer->flags));
1790 
1791 	if (sc->sc_dying)
1792 		return (USBD_IOERROR);
1793 
1794 #ifdef DIAGNOSTIC
1795 	if (xfer->rqflags & URQ_REQUEST)
1796 		panic("uhci_device_bulk_transfer: a request\n");
1797 #endif
1798 
1799 	len = xfer->length;
1800 	endpt = upipe->pipe.endpoint->edesc->bEndpointAddress;
1801 	isread = UE_GET_DIR(endpt) == UE_DIR_IN;
1802 	sqh = upipe->u.bulk.sqh;
1803 
1804 	upipe->u.bulk.isread = isread;
1805 	upipe->u.bulk.length = len;
1806 
1807 	err = uhci_alloc_std_chain(upipe, sc, len, isread, xfer->flags,
1808 				   &xfer->dmabuf, &data, &dataend);
1809 	if (err)
1810 		return (err);
1811 	dataend->td.td_status |= htole32(UHCI_TD_IOC);
1812 
1813 #ifdef UHCI_DEBUG
1814 	if (uhcidebug > 8) {
1815 		DPRINTF(("uhci_device_bulk_transfer: data(1)\n"));
1816 		uhci_dump_tds(data);
1817 	}
1818 #endif
1819 
1820 	/* Set up interrupt info. */
1821 	ii->xfer = xfer;
1822 	ii->stdstart = data;
1823 	ii->stdend = dataend;
1824 #ifdef DIAGNOSTIC
1825 	if (!ii->isdone) {
1826 		printf("uhci_device_bulk_transfer: not done, ii=%p\n", ii);
1827 	}
1828 	ii->isdone = 0;
1829 #endif
1830 
1831 	sqh->elink = data;
1832 	sqh->qh.qh_elink = htole32(data->physaddr | UHCI_PTR_TD);
1833 
1834 	s = splusb();
1835 	uhci_add_bulk(sc, sqh);
1836 	uhci_add_intr_info(sc, ii);
1837 
1838 	if (xfer->timeout && !sc->sc_bus.use_polling) {
1839 		usb_callout(xfer->timeout_handle, MS_TO_TICKS(xfer->timeout),
1840 			    uhci_timeout, ii);
1841 	}
1842 	xfer->status = USBD_IN_PROGRESS;
1843 	splx(s);
1844 
1845 #ifdef UHCI_DEBUG
1846 	if (uhcidebug > 10) {
1847 		DPRINTF(("uhci_device_bulk_transfer: data(2)\n"));
1848 		uhci_dump_tds(data);
1849 	}
1850 #endif
1851 
1852 	if (sc->sc_bus.use_polling)
1853 		uhci_waitintr(sc, xfer);
1854 
1855 	return (USBD_IN_PROGRESS);
1856 }
1857 
1858 /* Abort a device bulk request. */
1859 void
1860 uhci_device_bulk_abort(usbd_xfer_handle xfer)
1861 {
1862 	DPRINTF(("uhci_device_bulk_abort:\n"));
1863 	uhci_abort_xfer(xfer, USBD_CANCELLED);
1864 }
1865 
1866 /*
1867  * XXX This way of aborting is neither safe, nor good.
1868  * But it will have to do until I figure out what to do.
1869  * I apologize for the delay().
1870  */
1871 void
1872 uhci_abort_xfer(usbd_xfer_handle xfer, usbd_status status)
1873 {
1874 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
1875 	uhci_soft_td_t *std;
1876 	int s;
1877 
1878 	DPRINTFN(1,("uhci_abort_xfer: xfer=%p, status=%d\n", xfer, status));
1879 
1880 	s = splusb();
1881 
1882 	/* Transfer is already done. */
1883 	if (xfer->status != USBD_NOT_STARTED &&
1884 	    xfer->status != USBD_IN_PROGRESS) {
1885 		splx(s);
1886 		return;
1887 	}
1888 
1889 	/* Make interrupt routine ignore it, */
1890 	xfer->status = status;
1891 
1892 	/* don't timeout, */
1893 	usb_uncallout(xfer->timeout_handle, uhci_timeout, ii);
1894 
1895 	/* make hardware ignore it, */
1896 	for (std = ii->stdstart; std != NULL; std = std->link.std)
1897 		std->td.td_status &= htole32(~(UHCI_TD_ACTIVE | UHCI_TD_IOC));
1898 
1899 	xfer->hcpriv = ii;
1900 
1901 	splx(s);
1902 
1903 	delay(1000);
1904 
1905 	s = splusb();
1906 #ifdef DIAGNOSTIC
1907 	ii->isdone = 1;
1908 #endif
1909 	usb_transfer_complete(xfer);
1910 	splx(s);
1911 }
1912 
1913 /* Close a device bulk pipe. */
1914 void
1915 uhci_device_bulk_close(usbd_pipe_handle pipe)
1916 {
1917 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
1918 	usbd_device_handle dev = upipe->pipe.device;
1919 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
1920 
1921 	uhci_free_sqh(sc, upipe->u.bulk.sqh);
1922 }
1923 
1924 usbd_status
1925 uhci_device_ctrl_transfer(usbd_xfer_handle xfer)
1926 {
1927 	usbd_status err;
1928 
1929 	/* Insert last in queue. */
1930 	err = usb_insert_transfer(xfer);
1931 	if (err)
1932 		return (err);
1933 
1934 	/*
1935 	 * Pipe isn't running (otherwise err would be USBD_INPROG),
1936 	 * so start it first.
1937 	 */
1938 	return (uhci_device_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
1939 }
1940 
1941 usbd_status
1942 uhci_device_ctrl_start(usbd_xfer_handle xfer)
1943 {
1944 	uhci_softc_t *sc = (uhci_softc_t *)xfer->pipe->device->bus;
1945 	usbd_status err;
1946 
1947 	if (sc->sc_dying)
1948 		return (USBD_IOERROR);
1949 
1950 #ifdef DIAGNOSTIC
1951 	if (!(xfer->rqflags & URQ_REQUEST))
1952 		panic("uhci_device_ctrl_transfer: not a request\n");
1953 #endif
1954 
1955 	err = uhci_device_request(xfer);
1956 	if (err)
1957 		return (err);
1958 
1959 	if (sc->sc_bus.use_polling)
1960 		uhci_waitintr(sc, xfer);
1961 	return (USBD_IN_PROGRESS);
1962 }
1963 
1964 usbd_status
1965 uhci_device_intr_transfer(usbd_xfer_handle xfer)
1966 {
1967 	usbd_status err;
1968 
1969 	/* Insert last in queue. */
1970 	err = usb_insert_transfer(xfer);
1971 	if (err)
1972 		return (err);
1973 
1974 	/*
1975 	 * Pipe isn't running (otherwise err would be USBD_INPROG),
1976 	 * so start it first.
1977 	 */
1978 	return (uhci_device_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
1979 }
1980 
1981 usbd_status
1982 uhci_device_intr_start(usbd_xfer_handle xfer)
1983 {
1984 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
1985 	usbd_device_handle dev = upipe->pipe.device;
1986 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
1987 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
1988 	uhci_soft_td_t *data, *dataend;
1989 	uhci_soft_qh_t *sqh;
1990 	usbd_status err;
1991 	int i, s;
1992 
1993 	if (sc->sc_dying)
1994 		return (USBD_IOERROR);
1995 
1996 	DPRINTFN(3,("uhci_device_intr_transfer: xfer=%p len=%d flags=%d\n",
1997 		    xfer, xfer->length, xfer->flags));
1998 
1999 #ifdef DIAGNOSTIC
2000 	if (xfer->rqflags & URQ_REQUEST)
2001 		panic("uhci_device_intr_transfer: a request\n");
2002 #endif
2003 
2004 	err = uhci_alloc_std_chain(upipe, sc, xfer->length, 1, xfer->flags,
2005 				   &xfer->dmabuf, &data, &dataend);
2006 	if (err)
2007 		return (err);
2008 	dataend->td.td_status |= htole32(UHCI_TD_IOC);
2009 
2010 #ifdef UHCI_DEBUG
2011 	if (uhcidebug > 10) {
2012 		DPRINTF(("uhci_device_intr_transfer: data(1)\n"));
2013 		uhci_dump_tds(data);
2014 		uhci_dump_qh(upipe->u.intr.qhs[0]);
2015 	}
2016 #endif
2017 
2018 	s = splusb();
2019 	/* Set up interrupt info. */
2020 	ii->xfer = xfer;
2021 	ii->stdstart = data;
2022 	ii->stdend = dataend;
2023 #ifdef DIAGNOSTIC
2024 	if (!ii->isdone) {
2025 		printf("uhci_device_intr_transfer: not done, ii=%p\n", ii);
2026 	}
2027 	ii->isdone = 0;
2028 #endif
2029 
2030 	DPRINTFN(10,("uhci_device_intr_transfer: qhs[0]=%p\n",
2031 		     upipe->u.intr.qhs[0]));
2032 	for (i = 0; i < upipe->u.intr.npoll; i++) {
2033 		sqh = upipe->u.intr.qhs[i];
2034 		sqh->elink = data;
2035 		sqh->qh.qh_elink = htole32(data->physaddr | UHCI_PTR_TD);
2036 	}
2037 	uhci_add_intr_info(sc, ii);
2038 	xfer->status = USBD_IN_PROGRESS;
2039 	splx(s);
2040 
2041 #ifdef UHCI_DEBUG
2042 	if (uhcidebug > 10) {
2043 		DPRINTF(("uhci_device_intr_transfer: data(2)\n"));
2044 		uhci_dump_tds(data);
2045 		uhci_dump_qh(upipe->u.intr.qhs[0]);
2046 	}
2047 #endif
2048 
2049 	return (USBD_IN_PROGRESS);
2050 }
2051 
2052 /* Abort a device control request. */
2053 void
2054 uhci_device_ctrl_abort(usbd_xfer_handle xfer)
2055 {
2056 	DPRINTF(("uhci_device_ctrl_abort:\n"));
2057 	uhci_abort_xfer(xfer, USBD_CANCELLED);
2058 }
2059 
2060 /* Close a device control pipe. */
2061 void
2062 uhci_device_ctrl_close(usbd_pipe_handle pipe)
2063 {
2064 }
2065 
2066 /* Abort a device interrupt request. */
2067 void
2068 uhci_device_intr_abort(usbd_xfer_handle xfer)
2069 {
2070 	DPRINTFN(1,("uhci_device_intr_abort: xfer=%p\n", xfer));
2071 	if (xfer->pipe->intrxfer == xfer) {
2072 		DPRINTFN(1,("uhci_device_intr_abort: remove\n"));
2073 		xfer->pipe->intrxfer = 0;
2074 	}
2075 	uhci_abort_xfer(xfer, USBD_CANCELLED);
2076 }
2077 
2078 /* Close a device interrupt pipe. */
2079 void
2080 uhci_device_intr_close(usbd_pipe_handle pipe)
2081 {
2082 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
2083 	uhci_softc_t *sc = (uhci_softc_t *)pipe->device->bus;
2084 	int i, npoll;
2085 	int s;
2086 
2087 	/* Unlink descriptors from controller data structures. */
2088 	npoll = upipe->u.intr.npoll;
2089 	s = splusb();
2090 	for (i = 0; i < npoll; i++)
2091 		uhci_remove_intr(sc, upipe->u.intr.qhs[i]);
2092 	splx(s);
2093 
2094 	/*
2095 	 * We now have to wait for any activity on the physical
2096 	 * descriptors to stop.
2097 	 */
2098 	usb_delay_ms(&sc->sc_bus, 2);
2099 
2100 	for(i = 0; i < npoll; i++)
2101 		uhci_free_sqh(sc, upipe->u.intr.qhs[i]);
2102 	free(upipe->u.intr.qhs, M_USBHC);
2103 
2104 	/* XXX free other resources */
2105 }
2106 
2107 usbd_status
2108 uhci_device_request(usbd_xfer_handle xfer)
2109 {
2110 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2111 	usb_device_request_t *req = &xfer->request;
2112 	usbd_device_handle dev = upipe->pipe.device;
2113 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
2114 	int addr = dev->address;
2115 	int endpt = upipe->pipe.endpoint->edesc->bEndpointAddress;
2116 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2117 	uhci_soft_td_t *setup, *data, *stat, *next, *dataend;
2118 	uhci_soft_qh_t *sqh;
2119 	int len;
2120 	u_int32_t ls;
2121 	usbd_status err;
2122 	int isread;
2123 	int s;
2124 
2125 	DPRINTFN(3,("uhci_device_control type=0x%02x, request=0x%02x, "
2126 		    "wValue=0x%04x, wIndex=0x%04x len=%d, addr=%d, endpt=%d\n",
2127 		    req->bmRequestType, req->bRequest, UGETW(req->wValue),
2128 		    UGETW(req->wIndex), UGETW(req->wLength),
2129 		    addr, endpt));
2130 
2131 	ls = dev->speed == USB_SPEED_LOW ? UHCI_TD_LS : 0;
2132 	isread = req->bmRequestType & UT_READ;
2133 	len = UGETW(req->wLength);
2134 
2135 	setup = upipe->u.ctl.setup;
2136 	stat = upipe->u.ctl.stat;
2137 	sqh = upipe->u.ctl.sqh;
2138 
2139 	/* Set up data transaction */
2140 	if (len != 0) {
2141 		upipe->nexttoggle = 1;
2142 		err = uhci_alloc_std_chain(upipe, sc, len, isread, xfer->flags,
2143 					   &xfer->dmabuf, &data, &dataend);
2144 		if (err)
2145 			return (err);
2146 		next = data;
2147 		dataend->link.std = stat;
2148 		dataend->td.td_link = htole32(stat->physaddr | UHCI_PTR_VF | UHCI_PTR_TD);
2149 	} else {
2150 		next = stat;
2151 	}
2152 	upipe->u.ctl.length = len;
2153 
2154 	memcpy(KERNADDR(&upipe->u.ctl.reqdma), req, sizeof *req);
2155 
2156 	setup->link.std = next;
2157 	setup->td.td_link = htole32(next->physaddr | UHCI_PTR_VF | UHCI_PTR_TD);
2158 	setup->td.td_status = htole32(UHCI_TD_SET_ERRCNT(3) | ls |
2159 		UHCI_TD_ACTIVE);
2160 	setup->td.td_token = htole32(UHCI_TD_SETUP(sizeof *req, endpt, addr));
2161 	setup->td.td_buffer = htole32(DMAADDR(&upipe->u.ctl.reqdma));
2162 
2163 	stat->link.std = NULL;
2164 	stat->td.td_link = htole32(UHCI_PTR_T);
2165 	stat->td.td_status = htole32(UHCI_TD_SET_ERRCNT(3) | ls |
2166 		UHCI_TD_ACTIVE | UHCI_TD_IOC);
2167 	stat->td.td_token =
2168 		htole32(isread ? UHCI_TD_OUT(0, endpt, addr, 1) :
2169 		                 UHCI_TD_IN (0, endpt, addr, 1));
2170 	stat->td.td_buffer = htole32(0);
2171 
2172 #ifdef UHCI_DEBUG
2173 	if (uhcidebug > 10) {
2174 		DPRINTF(("uhci_device_request: before transfer\n"));
2175 		uhci_dump_tds(setup);
2176 	}
2177 #endif
2178 
2179 	/* Set up interrupt info. */
2180 	ii->xfer = xfer;
2181 	ii->stdstart = setup;
2182 	ii->stdend = stat;
2183 #ifdef DIAGNOSTIC
2184 	if (!ii->isdone) {
2185 		printf("uhci_device_request: not done, ii=%p\n", ii);
2186 	}
2187 	ii->isdone = 0;
2188 #endif
2189 
2190 	sqh->elink = setup;
2191 	sqh->qh.qh_elink = htole32(setup->physaddr | UHCI_PTR_TD);
2192 
2193 	s = splusb();
2194 	if (dev->speed == USB_SPEED_LOW)
2195 		uhci_add_ls_ctrl(sc, sqh);
2196 	else
2197 		uhci_add_hs_ctrl(sc, sqh);
2198 	uhci_add_intr_info(sc, ii);
2199 #ifdef UHCI_DEBUG
2200 	if (uhcidebug > 12) {
2201 		uhci_soft_td_t *std;
2202 		uhci_soft_qh_t *xqh;
2203 		uhci_soft_qh_t *sxqh;
2204 		int maxqh = 0;
2205 		uhci_physaddr_t link;
2206 		DPRINTF(("uhci_enter_ctl_q: follow from [0]\n"));
2207 		for (std = sc->sc_vframes[0].htd, link = 0;
2208 		     (link & UHCI_PTR_QH) == 0;
2209 		     std = std->link.std) {
2210 			link = le32toh(std->td.td_link);
2211 			uhci_dump_td(std);
2212 		}
2213 		sxqh = (uhci_soft_qh_t *)std;
2214 		uhci_dump_qh(sxqh);
2215 		for (xqh = sxqh;
2216 		     xqh != NULL;
2217 		     xqh = (maxqh++ == 5 || xqh->hlink == sxqh ||
2218                             xqh->hlink == xqh ? NULL : xqh->hlink)) {
2219 			uhci_dump_qh(xqh);
2220 		}
2221 		DPRINTF(("Enqueued QH:\n"));
2222 		uhci_dump_qh(sqh);
2223 		uhci_dump_tds(sqh->elink);
2224 	}
2225 #endif
2226 	if (xfer->timeout && !sc->sc_bus.use_polling) {
2227 		usb_callout(xfer->timeout_handle, MS_TO_TICKS(xfer->timeout),
2228 			    uhci_timeout, ii);
2229 	}
2230 	xfer->status = USBD_IN_PROGRESS;
2231 	splx(s);
2232 
2233 	return (USBD_NORMAL_COMPLETION);
2234 }
2235 
2236 usbd_status
2237 uhci_device_isoc_transfer(usbd_xfer_handle xfer)
2238 {
2239 	usbd_status err;
2240 
2241 	DPRINTFN(5,("uhci_device_isoc_transfer: xfer=%p\n", xfer));
2242 
2243 	/* Put it on our queue, */
2244 	err = usb_insert_transfer(xfer);
2245 
2246 	/* bail out on error, */
2247 	if (err && err != USBD_IN_PROGRESS)
2248 		return (err);
2249 
2250 	/* XXX should check inuse here */
2251 
2252 	/* insert into schedule, */
2253 	uhci_device_isoc_enter(xfer);
2254 
2255 	/* and start if the pipe wasn't running */
2256 	if (!err)
2257 		uhci_device_isoc_start(SIMPLEQ_FIRST(&xfer->pipe->queue));
2258 
2259 	return (err);
2260 }
2261 
2262 void
2263 uhci_device_isoc_enter(usbd_xfer_handle xfer)
2264 {
2265 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2266 	usbd_device_handle dev = upipe->pipe.device;
2267 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
2268 	struct iso *iso = &upipe->u.iso;
2269 	uhci_soft_td_t *std;
2270 	u_int32_t buf, len, status;
2271 	int s, i, next, nframes;
2272 
2273 	DPRINTFN(5,("uhci_device_isoc_enter: used=%d next=%d xfer=%p "
2274 		    "nframes=%d\n",
2275 		    iso->inuse, iso->next, xfer, xfer->nframes));
2276 
2277 	if (sc->sc_dying)
2278 		return;
2279 
2280 	if (xfer->status == USBD_IN_PROGRESS) {
2281 		/* This request has already been entered into the frame list */
2282 		printf("uhci_device_isoc_enter: xfer=%p in frame list\n", xfer);
2283 		/* XXX */
2284 	}
2285 
2286 #ifdef DIAGNOSTIC
2287 	if (iso->inuse >= UHCI_VFRAMELIST_COUNT)
2288 		printf("uhci_device_isoc_enter: overflow!\n");
2289 #endif
2290 
2291 	next = iso->next;
2292 	if (next == -1) {
2293 		/* Not in use yet, schedule it a few frames ahead. */
2294 		next = (UREAD2(sc, UHCI_FRNUM) + 3) % UHCI_VFRAMELIST_COUNT;
2295 		DPRINTFN(2,("uhci_device_isoc_enter: start next=%d\n", next));
2296 	}
2297 
2298 	xfer->status = USBD_IN_PROGRESS;
2299 	UXFER(xfer)->curframe = next;
2300 
2301 	buf = DMAADDR(&xfer->dmabuf);
2302 	status = UHCI_TD_ZERO_ACTLEN(UHCI_TD_SET_ERRCNT(0) |
2303 				     UHCI_TD_ACTIVE |
2304 				     UHCI_TD_IOS);
2305 	nframes = xfer->nframes;
2306 	s = splusb();
2307 	for (i = 0; i < nframes; i++) {
2308 		std = iso->stds[next];
2309 		if (++next >= UHCI_VFRAMELIST_COUNT)
2310 			next = 0;
2311 		len = xfer->frlengths[i];
2312 		std->td.td_buffer = htole32(buf);
2313 		if (i == nframes - 1)
2314 			status |= UHCI_TD_IOC;
2315 		std->td.td_status = htole32(status);
2316 		std->td.td_token &= htole32(~UHCI_TD_MAXLEN_MASK);
2317 		std->td.td_token |= htole32(UHCI_TD_SET_MAXLEN(len));
2318 #ifdef UHCI_DEBUG
2319 		if (uhcidebug > 5) {
2320 			DPRINTFN(5,("uhci_device_isoc_enter: TD %d\n", i));
2321 			uhci_dump_td(std);
2322 		}
2323 #endif
2324 		buf += len;
2325 	}
2326 	iso->next = next;
2327 	iso->inuse += xfer->nframes;
2328 
2329 	splx(s);
2330 }
2331 
2332 usbd_status
2333 uhci_device_isoc_start(usbd_xfer_handle xfer)
2334 {
2335 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2336 	uhci_softc_t *sc = (uhci_softc_t *)upipe->pipe.device->bus;
2337 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2338 	uhci_soft_td_t *end;
2339 	int s, i;
2340 
2341 	DPRINTFN(5,("uhci_device_isoc_start: xfer=%p\n", xfer));
2342 
2343 	if (sc->sc_dying)
2344 		return (USBD_IOERROR);
2345 
2346 #ifdef DIAGNOSTIC
2347 	if (xfer->status != USBD_IN_PROGRESS)
2348 		printf("uhci_device_isoc_start: not in progress %p\n", xfer);
2349 #endif
2350 
2351 	/* Find the last TD */
2352 	i = UXFER(xfer)->curframe + xfer->nframes;
2353 	if (i >= UHCI_VFRAMELIST_COUNT)
2354 		i -= UHCI_VFRAMELIST_COUNT;
2355 	end = upipe->u.iso.stds[i];
2356 
2357 #ifdef DIAGNOSTIC
2358 	if (end == NULL) {
2359 		printf("uhci_device_isoc_start: end == NULL\n");
2360 		return (USBD_INVAL);
2361 	}
2362 #endif
2363 
2364 	s = splusb();
2365 
2366 	/* Set up interrupt info. */
2367 	ii->xfer = xfer;
2368 	ii->stdstart = end;
2369 	ii->stdend = end;
2370 #ifdef DIAGNOSTIC
2371 	if (!ii->isdone)
2372 		printf("uhci_device_isoc_start: not done, ii=%p\n", ii);
2373 	ii->isdone = 0;
2374 #endif
2375 	uhci_add_intr_info(sc, ii);
2376 
2377 	splx(s);
2378 
2379 	return (USBD_IN_PROGRESS);
2380 }
2381 
2382 void
2383 uhci_device_isoc_abort(usbd_xfer_handle xfer)
2384 {
2385 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2386 	uhci_soft_td_t **stds = upipe->u.iso.stds;
2387 	uhci_soft_td_t *std;
2388 	int i, n, s, nframes, maxlen, len;
2389 
2390 	s = splusb();
2391 
2392 	/* Transfer is already done. */
2393 	if (xfer->status != USBD_NOT_STARTED &&
2394 	    xfer->status != USBD_IN_PROGRESS) {
2395 		splx(s);
2396 		return;
2397 	}
2398 
2399 	/* Give xfer the requested abort code. */
2400 	xfer->status = USBD_CANCELLED;
2401 
2402 	/* make hardware ignore it, */
2403 	nframes = xfer->nframes;
2404 	n = UXFER(xfer)->curframe;
2405 	maxlen = 0;
2406 	for (i = 0; i < nframes; i++) {
2407 		std = stds[n];
2408 		std->td.td_status &= htole32(~(UHCI_TD_ACTIVE | UHCI_TD_IOC));
2409 		len = UHCI_TD_GET_MAXLEN(le32toh(std->td.td_token));
2410 		if (len > maxlen)
2411 			maxlen = len;
2412 		if (++n >= UHCI_VFRAMELIST_COUNT)
2413 			n = 0;
2414 	}
2415 
2416 	/* and wait until we are sure the hardware has finished. */
2417 	delay(maxlen);
2418 
2419 #ifdef DIAGNOSTIC
2420 	UXFER(xfer)->iinfo.isdone = 1;
2421 #endif
2422 	/* Run callback and remove from interrupt list. */
2423 	usb_transfer_complete(xfer);
2424 
2425 	splx(s);
2426 }
2427 
2428 void
2429 uhci_device_isoc_close(usbd_pipe_handle pipe)
2430 {
2431 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
2432 	usbd_device_handle dev = upipe->pipe.device;
2433 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
2434 	uhci_soft_td_t *std, *vstd;
2435 	struct iso *iso;
2436 	int i, s;
2437 
2438 	/*
2439 	 * Make sure all TDs are marked as inactive.
2440 	 * Wait for completion.
2441 	 * Unschedule.
2442 	 * Deallocate.
2443 	 */
2444 	iso = &upipe->u.iso;
2445 
2446 	for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++)
2447 		iso->stds[i]->td.td_status &= htole32(~UHCI_TD_ACTIVE);
2448 	usb_delay_ms(&sc->sc_bus, 2); /* wait for completion */
2449 
2450 	s = splusb();
2451 	for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
2452 		std = iso->stds[i];
2453 		for (vstd = sc->sc_vframes[i].htd;
2454 		     vstd != NULL && vstd->link.std != std;
2455 		     vstd = vstd->link.std)
2456 			;
2457 		if (vstd == NULL) {
2458 			/*panic*/
2459 			printf("uhci_device_isoc_close: %p not found\n", std);
2460 			splx(s);
2461 			return;
2462 		}
2463 		vstd->link = std->link;
2464 		vstd->td.td_link = std->td.td_link;
2465 		uhci_free_std(sc, std);
2466 	}
2467 	splx(s);
2468 
2469 	free(iso->stds, M_USBHC);
2470 }
2471 
2472 usbd_status
2473 uhci_setup_isoc(usbd_pipe_handle pipe)
2474 {
2475 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
2476 	usbd_device_handle dev = upipe->pipe.device;
2477 	uhci_softc_t *sc = (uhci_softc_t *)dev->bus;
2478 	int addr = upipe->pipe.device->address;
2479 	int endpt = upipe->pipe.endpoint->edesc->bEndpointAddress;
2480 	int rd = UE_GET_DIR(endpt) == UE_DIR_IN;
2481 	uhci_soft_td_t *std, *vstd;
2482 	u_int32_t token;
2483 	struct iso *iso;
2484 	int i, s;
2485 
2486 	iso = &upipe->u.iso;
2487 	iso->stds = malloc(UHCI_VFRAMELIST_COUNT * sizeof (uhci_soft_td_t *),
2488 			   M_USBHC, M_WAITOK);
2489 
2490 	token = rd ? UHCI_TD_IN (0, endpt, addr, 0) :
2491 		     UHCI_TD_OUT(0, endpt, addr, 0);
2492 
2493 	/* Allocate the TDs and mark as inactive; */
2494 	for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
2495 		std = uhci_alloc_std(sc);
2496 		if (std == 0)
2497 			goto bad;
2498 		std->td.td_status = htole32(UHCI_TD_IOS); /* iso, inactive */
2499 		std->td.td_token = htole32(token);
2500 		iso->stds[i] = std;
2501 	}
2502 
2503 	/* Insert TDs into schedule. */
2504 	s = splusb();
2505 	for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
2506 		std = iso->stds[i];
2507 		vstd = sc->sc_vframes[i].htd;
2508 		std->link = vstd->link;
2509 		std->td.td_link = vstd->td.td_link;
2510 		vstd->link.std = std;
2511 		vstd->td.td_link = htole32(std->physaddr | UHCI_PTR_TD);
2512 	}
2513 	splx(s);
2514 
2515 	iso->next = -1;
2516 	iso->inuse = 0;
2517 
2518 	return (USBD_NORMAL_COMPLETION);
2519 
2520  bad:
2521 	while (--i >= 0)
2522 		uhci_free_std(sc, iso->stds[i]);
2523 	free(iso->stds, M_USBHC);
2524 	return (USBD_NOMEM);
2525 }
2526 
2527 void
2528 uhci_device_isoc_done(usbd_xfer_handle xfer)
2529 {
2530 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2531 
2532 	DPRINTFN(4, ("uhci_isoc_done: length=%d\n", xfer->actlen));
2533 
2534 	if (ii->xfer != xfer)
2535 		/* Not on interrupt list, ignore it. */
2536 		return;
2537 
2538 #ifdef DIAGNOSTIC
2539 	if (xfer->busy_free != XFER_BUSY) {
2540 		printf("uhci_device_isoc_done: xfer=%p not busy 0x%08x\n",
2541 		       xfer, xfer->busy_free);
2542 		return;
2543 	}
2544 
2545         if (ii->stdend == NULL) {
2546                 printf("uhci_device_isoc_done: xfer=%p stdend==NULL\n", xfer);
2547 #ifdef UHCI_DEBUG
2548 		uhci_dump_ii(ii);
2549 #endif
2550 		return;
2551 	}
2552 #endif
2553 
2554 	/* Turn off the interrupt since it is active even if the TD is not. */
2555 	ii->stdend->td.td_status &= htole32(~UHCI_TD_IOC);
2556 
2557 	uhci_del_intr_info(ii);	/* remove from active list */
2558 }
2559 
2560 void
2561 uhci_device_intr_done(usbd_xfer_handle xfer)
2562 {
2563 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2564 	uhci_softc_t *sc = ii->sc;
2565 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2566 	uhci_soft_qh_t *sqh;
2567 	int i, npoll;
2568 
2569 	DPRINTFN(5, ("uhci_intr_done: length=%d\n", xfer->actlen));
2570 
2571 	npoll = upipe->u.intr.npoll;
2572 	for(i = 0; i < npoll; i++) {
2573 		sqh = upipe->u.intr.qhs[i];
2574 		sqh->elink = NULL;
2575 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
2576 	}
2577 	uhci_free_std_chain(sc, ii->stdstart, NULL);
2578 
2579 	/* XXX Wasteful. */
2580 	if (xfer->pipe->repeat) {
2581 		uhci_soft_td_t *data, *dataend;
2582 
2583 		DPRINTFN(5,("uhci_device_intr_done: requeing\n"));
2584 
2585 		/* This alloc cannot fail since we freed the chain above. */
2586 		uhci_alloc_std_chain(upipe, sc, xfer->length, 1, xfer->flags,
2587 				     &xfer->dmabuf, &data, &dataend);
2588 		dataend->td.td_status |= htole32(UHCI_TD_IOC);
2589 
2590 #ifdef UHCI_DEBUG
2591 		if (uhcidebug > 10) {
2592 			DPRINTF(("uhci_device_intr_done: data(1)\n"));
2593 			uhci_dump_tds(data);
2594 			uhci_dump_qh(upipe->u.intr.qhs[0]);
2595 		}
2596 #endif
2597 
2598 		ii->stdstart = data;
2599 		ii->stdend = dataend;
2600 #ifdef DIAGNOSTIC
2601 		if (!ii->isdone) {
2602 			printf("uhci_device_intr_done: not done, ii=%p\n", ii);
2603 		}
2604 		ii->isdone = 0;
2605 #endif
2606 		for (i = 0; i < npoll; i++) {
2607 			sqh = upipe->u.intr.qhs[i];
2608 			sqh->elink = data;
2609 			sqh->qh.qh_elink = htole32(data->physaddr | UHCI_PTR_TD);
2610 		}
2611 		xfer->status = USBD_IN_PROGRESS;
2612 		/* The ii is already on the examined list, just leave it. */
2613 	} else {
2614 		DPRINTFN(5,("uhci_device_intr_done: removing\n"));
2615 		uhci_del_intr_info(ii);
2616 	}
2617 }
2618 
2619 /* Deallocate request data structures */
2620 void
2621 uhci_device_ctrl_done(usbd_xfer_handle xfer)
2622 {
2623 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2624 	uhci_softc_t *sc = ii->sc;
2625 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2626 
2627 #ifdef DIAGNOSTIC
2628 	if (!(xfer->rqflags & URQ_REQUEST))
2629 		panic("uhci_ctrl_done: not a request\n");
2630 #endif
2631 
2632 	uhci_del_intr_info(ii);	/* remove from active list */
2633 
2634 	if (upipe->pipe.device->speed == USB_SPEED_LOW)
2635 		uhci_remove_ls_ctrl(sc, upipe->u.ctl.sqh);
2636 	else
2637 		uhci_remove_hs_ctrl(sc, upipe->u.ctl.sqh);
2638 
2639 	if (upipe->u.ctl.length != 0)
2640 		uhci_free_std_chain(sc, ii->stdstart->link.std, ii->stdend);
2641 
2642 	DPRINTFN(5, ("uhci_ctrl_done: length=%d\n", xfer->actlen));
2643 }
2644 
2645 /* Deallocate request data structures */
2646 void
2647 uhci_device_bulk_done(usbd_xfer_handle xfer)
2648 {
2649 	uhci_intr_info_t *ii = &UXFER(xfer)->iinfo;
2650 	uhci_softc_t *sc = ii->sc;
2651 	struct uhci_pipe *upipe = (struct uhci_pipe *)xfer->pipe;
2652 
2653 	uhci_del_intr_info(ii);	/* remove from active list */
2654 
2655 	uhci_remove_bulk(sc, upipe->u.bulk.sqh);
2656 
2657 	uhci_free_std_chain(sc, ii->stdstart, NULL);
2658 
2659 	DPRINTFN(5, ("uhci_bulk_done: length=%d\n", xfer->actlen));
2660 }
2661 
2662 /* Add interrupt QH, called with vflock. */
2663 void
2664 uhci_add_intr(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
2665 {
2666 	struct uhci_vframe *vf = &sc->sc_vframes[sqh->pos];
2667 	uhci_soft_qh_t *eqh;
2668 
2669 	DPRINTFN(4, ("uhci_add_intr: n=%d sqh=%p\n", sqh->pos, sqh));
2670 
2671 	eqh = vf->eqh;
2672 	sqh->hlink       = eqh->hlink;
2673 	sqh->qh.qh_hlink = eqh->qh.qh_hlink;
2674 	eqh->hlink       = sqh;
2675 	eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
2676 	vf->eqh = sqh;
2677 	vf->bandwidth++;
2678 }
2679 
2680 /* Remove interrupt QH. */
2681 void
2682 uhci_remove_intr(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
2683 {
2684 	struct uhci_vframe *vf = &sc->sc_vframes[sqh->pos];
2685 	uhci_soft_qh_t *pqh;
2686 
2687 	DPRINTFN(4, ("uhci_remove_intr: n=%d sqh=%p\n", sqh->pos, sqh));
2688 
2689 	/* See comment in uhci_remove_ctrl() */
2690 	if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
2691 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
2692 		delay(UHCI_QH_REMOVE_DELAY);
2693 	}
2694 
2695 	pqh = uhci_find_prev_qh(vf->hqh, sqh);
2696 	pqh->hlink       = sqh->hlink;
2697 	pqh->qh.qh_hlink = sqh->qh.qh_hlink;
2698 	delay(UHCI_QH_REMOVE_DELAY);
2699 	if (vf->eqh == sqh)
2700 		vf->eqh = pqh;
2701 	vf->bandwidth--;
2702 }
2703 
2704 usbd_status
2705 uhci_device_setintr(uhci_softc_t *sc, struct uhci_pipe *upipe, int ival)
2706 {
2707 	uhci_soft_qh_t *sqh;
2708 	int i, npoll, s;
2709 	u_int bestbw, bw, bestoffs, offs;
2710 
2711 	DPRINTFN(2, ("uhci_setintr: pipe=%p\n", upipe));
2712 	if (ival == 0) {
2713 		printf("uhci_setintr: 0 interval\n");
2714 		return (USBD_INVAL);
2715 	}
2716 
2717 	if (ival > UHCI_VFRAMELIST_COUNT)
2718 		ival = UHCI_VFRAMELIST_COUNT;
2719 	npoll = (UHCI_VFRAMELIST_COUNT + ival - 1) / ival;
2720 	DPRINTFN(2, ("uhci_setintr: ival=%d npoll=%d\n", ival, npoll));
2721 
2722 	upipe->u.intr.npoll = npoll;
2723 	upipe->u.intr.qhs =
2724 		malloc(npoll * sizeof(uhci_soft_qh_t *), M_USBHC, M_WAITOK);
2725 
2726 	/*
2727 	 * Figure out which offset in the schedule that has most
2728 	 * bandwidth left over.
2729 	 */
2730 #define MOD(i) ((i) & (UHCI_VFRAMELIST_COUNT-1))
2731 	for (bestoffs = offs = 0, bestbw = ~0; offs < ival; offs++) {
2732 		for (bw = i = 0; i < npoll; i++)
2733 			bw += sc->sc_vframes[MOD(i * ival + offs)].bandwidth;
2734 		if (bw < bestbw) {
2735 			bestbw = bw;
2736 			bestoffs = offs;
2737 		}
2738 	}
2739 	DPRINTFN(1, ("uhci_setintr: bw=%d offs=%d\n", bestbw, bestoffs));
2740 
2741 	for(i = 0; i < npoll; i++) {
2742 		upipe->u.intr.qhs[i] = sqh = uhci_alloc_sqh(sc);
2743 		sqh->elink = NULL;
2744 		sqh->qh.qh_elink = htole32(UHCI_PTR_T);
2745 		sqh->pos = MOD(i * ival + bestoffs);
2746 	}
2747 #undef MOD
2748 
2749 	s = splusb();
2750 	/* Enter QHs into the controller data structures. */
2751 	for(i = 0; i < npoll; i++)
2752 		uhci_add_intr(sc, upipe->u.intr.qhs[i]);
2753 	splx(s);
2754 
2755 	DPRINTFN(5, ("uhci_setintr: returns %p\n", upipe));
2756 	return (USBD_NORMAL_COMPLETION);
2757 }
2758 
2759 /* Open a new pipe. */
2760 usbd_status
2761 uhci_open(usbd_pipe_handle pipe)
2762 {
2763 	uhci_softc_t *sc = (uhci_softc_t *)pipe->device->bus;
2764 	struct uhci_pipe *upipe = (struct uhci_pipe *)pipe;
2765 	usb_endpoint_descriptor_t *ed = pipe->endpoint->edesc;
2766 	usbd_status err;
2767 	int ival;
2768 
2769 	DPRINTFN(1, ("uhci_open: pipe=%p, addr=%d, endpt=%d (%d)\n",
2770 		     pipe, pipe->device->address,
2771 		     ed->bEndpointAddress, sc->sc_addr));
2772 
2773 	upipe->aborting = 0;
2774 	upipe->nexttoggle = 0;
2775 
2776 	if (pipe->device->address == sc->sc_addr) {
2777 		switch (ed->bEndpointAddress) {
2778 		case USB_CONTROL_ENDPOINT:
2779 			pipe->methods = &uhci_root_ctrl_methods;
2780 			break;
2781 		case UE_DIR_IN | UHCI_INTR_ENDPT:
2782 			pipe->methods = &uhci_root_intr_methods;
2783 			break;
2784 		default:
2785 			return (USBD_INVAL);
2786 		}
2787 	} else {
2788 		switch (ed->bmAttributes & UE_XFERTYPE) {
2789 		case UE_CONTROL:
2790 			pipe->methods = &uhci_device_ctrl_methods;
2791 			upipe->u.ctl.sqh = uhci_alloc_sqh(sc);
2792 			if (upipe->u.ctl.sqh == NULL)
2793 				goto bad;
2794 			upipe->u.ctl.setup = uhci_alloc_std(sc);
2795 			if (upipe->u.ctl.setup == NULL) {
2796 				uhci_free_sqh(sc, upipe->u.ctl.sqh);
2797 				goto bad;
2798 			}
2799 			upipe->u.ctl.stat = uhci_alloc_std(sc);
2800 			if (upipe->u.ctl.stat == NULL) {
2801 				uhci_free_sqh(sc, upipe->u.ctl.sqh);
2802 				uhci_free_std(sc, upipe->u.ctl.setup);
2803 				goto bad;
2804 			}
2805 			err = usb_allocmem(&sc->sc_bus,
2806 				  sizeof(usb_device_request_t),
2807 				  0, &upipe->u.ctl.reqdma);
2808 			if (err) {
2809 				uhci_free_sqh(sc, upipe->u.ctl.sqh);
2810 				uhci_free_std(sc, upipe->u.ctl.setup);
2811 				uhci_free_std(sc, upipe->u.ctl.stat);
2812 				goto bad;
2813 			}
2814 			break;
2815 		case UE_INTERRUPT:
2816 			pipe->methods = &uhci_device_intr_methods;
2817 			ival = pipe->interval;
2818 			if (ival == USBD_DEFAULT_INTERVAL)
2819 				ival = ed->bInterval;
2820 			return (uhci_device_setintr(sc, upipe, ival));
2821 		case UE_ISOCHRONOUS:
2822 			pipe->methods = &uhci_device_isoc_methods;
2823 			return (uhci_setup_isoc(pipe));
2824 		case UE_BULK:
2825 			pipe->methods = &uhci_device_bulk_methods;
2826 			upipe->u.bulk.sqh = uhci_alloc_sqh(sc);
2827 			if (upipe->u.bulk.sqh == NULL)
2828 				goto bad;
2829 			break;
2830 		}
2831 	}
2832 	return (USBD_NORMAL_COMPLETION);
2833 
2834  bad:
2835 	return (USBD_NOMEM);
2836 }
2837 
2838 /*
2839  * Data structures and routines to emulate the root hub.
2840  */
2841 usb_device_descriptor_t uhci_devd = {
2842 	USB_DEVICE_DESCRIPTOR_SIZE,
2843 	UDESC_DEVICE,		/* type */
2844 	{0x00, 0x01},		/* USB version */
2845 	UDCLASS_HUB,		/* class */
2846 	UDSUBCLASS_HUB,		/* subclass */
2847 	UDPROTO_FSHUB,		/* protocol */
2848 	64,			/* max packet */
2849 	{0},{0},{0x00,0x01},	/* device id */
2850 	1,2,0,			/* string indicies */
2851 	1			/* # of configurations */
2852 };
2853 
2854 usb_config_descriptor_t uhci_confd = {
2855 	USB_CONFIG_DESCRIPTOR_SIZE,
2856 	UDESC_CONFIG,
2857 	{USB_CONFIG_DESCRIPTOR_SIZE +
2858 	 USB_INTERFACE_DESCRIPTOR_SIZE +
2859 	 USB_ENDPOINT_DESCRIPTOR_SIZE},
2860 	1,
2861 	1,
2862 	0,
2863 	UC_SELF_POWERED,
2864 	0			/* max power */
2865 };
2866 
2867 usb_interface_descriptor_t uhci_ifcd = {
2868 	USB_INTERFACE_DESCRIPTOR_SIZE,
2869 	UDESC_INTERFACE,
2870 	0,
2871 	0,
2872 	1,
2873 	UICLASS_HUB,
2874 	UISUBCLASS_HUB,
2875 	UIPROTO_FSHUB,
2876 	0
2877 };
2878 
2879 usb_endpoint_descriptor_t uhci_endpd = {
2880 	USB_ENDPOINT_DESCRIPTOR_SIZE,
2881 	UDESC_ENDPOINT,
2882 	UE_DIR_IN | UHCI_INTR_ENDPT,
2883 	UE_INTERRUPT,
2884 	{8},
2885 	255
2886 };
2887 
2888 usb_hub_descriptor_t uhci_hubd_piix = {
2889 	USB_HUB_DESCRIPTOR_SIZE,
2890 	UDESC_HUB,
2891 	2,
2892 	{ UHD_PWR_NO_SWITCH | UHD_OC_INDIVIDUAL, 0 },
2893 	50,			/* power on to power good */
2894 	0,
2895 	{ 0x00 },		/* both ports are removable */
2896 };
2897 
2898 int
2899 uhci_str(usb_string_descriptor_t *p, int l, char *s)
2900 {
2901 	int i;
2902 
2903 	if (l == 0)
2904 		return (0);
2905 	p->bLength = 2 * strlen(s) + 2;
2906 	if (l == 1)
2907 		return (1);
2908 	p->bDescriptorType = UDESC_STRING;
2909 	l -= 2;
2910 	for (i = 0; s[i] && l > 1; i++, l -= 2)
2911 		USETW2(p->bString[i], 0, s[i]);
2912 	return (2*i+2);
2913 }
2914 
2915 /*
2916  * Simulate a hardware hub by handling all the necessary requests.
2917  */
2918 usbd_status
2919 uhci_root_ctrl_transfer(usbd_xfer_handle xfer)
2920 {
2921 	usbd_status err;
2922 
2923 	/* Insert last in queue. */
2924 	err = usb_insert_transfer(xfer);
2925 	if (err)
2926 		return (err);
2927 
2928 	/*
2929 	 * Pipe isn't running (otherwise err would be USBD_INPROG),
2930 	 * so start it first.
2931 	 */
2932 	return (uhci_root_ctrl_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
2933 }
2934 
2935 usbd_status
2936 uhci_root_ctrl_start(usbd_xfer_handle xfer)
2937 {
2938 	uhci_softc_t *sc = (uhci_softc_t *)xfer->pipe->device->bus;
2939 	usb_device_request_t *req;
2940 	void *buf = NULL;
2941 	int port, x;
2942 	int s, len, value, index, status, change, l, totlen = 0;
2943 	usb_port_status_t ps;
2944 	usbd_status err;
2945 
2946 	if (sc->sc_dying)
2947 		return (USBD_IOERROR);
2948 
2949 #ifdef DIAGNOSTIC
2950 	if (!(xfer->rqflags & URQ_REQUEST))
2951 		panic("uhci_root_ctrl_transfer: not a request\n");
2952 #endif
2953 	req = &xfer->request;
2954 
2955 	DPRINTFN(2,("uhci_root_ctrl_control type=0x%02x request=%02x\n",
2956 		    req->bmRequestType, req->bRequest));
2957 
2958 	len = UGETW(req->wLength);
2959 	value = UGETW(req->wValue);
2960 	index = UGETW(req->wIndex);
2961 
2962 	if (len != 0)
2963 		buf = KERNADDR(&xfer->dmabuf);
2964 
2965 #define C(x,y) ((x) | ((y) << 8))
2966 	switch(C(req->bRequest, req->bmRequestType)) {
2967 	case C(UR_CLEAR_FEATURE, UT_WRITE_DEVICE):
2968 	case C(UR_CLEAR_FEATURE, UT_WRITE_INTERFACE):
2969 	case C(UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT):
2970 		/*
2971 		 * DEVICE_REMOTE_WAKEUP and ENDPOINT_HALT are no-ops
2972 		 * for the integrated root hub.
2973 		 */
2974 		break;
2975 	case C(UR_GET_CONFIG, UT_READ_DEVICE):
2976 		if (len > 0) {
2977 			*(u_int8_t *)buf = sc->sc_conf;
2978 			totlen = 1;
2979 		}
2980 		break;
2981 	case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
2982 		DPRINTFN(2,("uhci_root_ctrl_control wValue=0x%04x\n", value));
2983 		switch(value >> 8) {
2984 		case UDESC_DEVICE:
2985 			if ((value & 0xff) != 0) {
2986 				err = USBD_IOERROR;
2987 				goto ret;
2988 			}
2989 			totlen = l = min(len, USB_DEVICE_DESCRIPTOR_SIZE);
2990 			USETW(uhci_devd.idVendor, sc->sc_id_vendor);
2991 			memcpy(buf, &uhci_devd, l);
2992 			break;
2993 		case UDESC_CONFIG:
2994 			if ((value & 0xff) != 0) {
2995 				err = USBD_IOERROR;
2996 				goto ret;
2997 			}
2998 			totlen = l = min(len, USB_CONFIG_DESCRIPTOR_SIZE);
2999 			memcpy(buf, &uhci_confd, l);
3000 			buf = (char *)buf + l;
3001 			len -= l;
3002 			l = min(len, USB_INTERFACE_DESCRIPTOR_SIZE);
3003 			totlen += l;
3004 			memcpy(buf, &uhci_ifcd, l);
3005 			buf = (char *)buf + l;
3006 			len -= l;
3007 			l = min(len, USB_ENDPOINT_DESCRIPTOR_SIZE);
3008 			totlen += l;
3009 			memcpy(buf, &uhci_endpd, l);
3010 			break;
3011 		case UDESC_STRING:
3012 			if (len == 0)
3013 				break;
3014 			*(u_int8_t *)buf = 0;
3015 			totlen = 1;
3016 			switch (value & 0xff) {
3017 			case 1: /* Vendor */
3018 				totlen = uhci_str(buf, len, sc->sc_vendor);
3019 				break;
3020 			case 2: /* Product */
3021 				totlen = uhci_str(buf, len, "UHCI root hub");
3022 				break;
3023 			}
3024 			break;
3025 		default:
3026 			err = USBD_IOERROR;
3027 			goto ret;
3028 		}
3029 		break;
3030 	case C(UR_GET_INTERFACE, UT_READ_INTERFACE):
3031 		if (len > 0) {
3032 			*(u_int8_t *)buf = 0;
3033 			totlen = 1;
3034 		}
3035 		break;
3036 	case C(UR_GET_STATUS, UT_READ_DEVICE):
3037 		if (len > 1) {
3038 			USETW(((usb_status_t *)buf)->wStatus,UDS_SELF_POWERED);
3039 			totlen = 2;
3040 		}
3041 		break;
3042 	case C(UR_GET_STATUS, UT_READ_INTERFACE):
3043 	case C(UR_GET_STATUS, UT_READ_ENDPOINT):
3044 		if (len > 1) {
3045 			USETW(((usb_status_t *)buf)->wStatus, 0);
3046 			totlen = 2;
3047 		}
3048 		break;
3049 	case C(UR_SET_ADDRESS, UT_WRITE_DEVICE):
3050 		if (value >= USB_MAX_DEVICES) {
3051 			err = USBD_IOERROR;
3052 			goto ret;
3053 		}
3054 		sc->sc_addr = value;
3055 		break;
3056 	case C(UR_SET_CONFIG, UT_WRITE_DEVICE):
3057 		if (value != 0 && value != 1) {
3058 			err = USBD_IOERROR;
3059 			goto ret;
3060 		}
3061 		sc->sc_conf = value;
3062 		break;
3063 	case C(UR_SET_DESCRIPTOR, UT_WRITE_DEVICE):
3064 		break;
3065 	case C(UR_SET_FEATURE, UT_WRITE_DEVICE):
3066 	case C(UR_SET_FEATURE, UT_WRITE_INTERFACE):
3067 	case C(UR_SET_FEATURE, UT_WRITE_ENDPOINT):
3068 		err = USBD_IOERROR;
3069 		goto ret;
3070 	case C(UR_SET_INTERFACE, UT_WRITE_INTERFACE):
3071 		break;
3072 	case C(UR_SYNCH_FRAME, UT_WRITE_ENDPOINT):
3073 		break;
3074 	/* Hub requests */
3075 	case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
3076 		break;
3077 	case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
3078 		DPRINTFN(3, ("uhci_root_ctrl_control: UR_CLEAR_PORT_FEATURE "
3079 			     "port=%d feature=%d\n",
3080 			     index, value));
3081 		if (index == 1)
3082 			port = UHCI_PORTSC1;
3083 		else if (index == 2)
3084 			port = UHCI_PORTSC2;
3085 		else {
3086 			err = USBD_IOERROR;
3087 			goto ret;
3088 		}
3089 		switch(value) {
3090 		case UHF_PORT_ENABLE:
3091 			x = URWMASK(UREAD2(sc, port));
3092 			UWRITE2(sc, port, x & ~UHCI_PORTSC_PE);
3093 			break;
3094 		case UHF_PORT_SUSPEND:
3095 			x = URWMASK(UREAD2(sc, port));
3096 			UWRITE2(sc, port, x & ~UHCI_PORTSC_SUSP);
3097 			break;
3098 		case UHF_PORT_RESET:
3099 			x = URWMASK(UREAD2(sc, port));
3100 			UWRITE2(sc, port, x & ~UHCI_PORTSC_PR);
3101 			break;
3102 		case UHF_C_PORT_CONNECTION:
3103 			x = URWMASK(UREAD2(sc, port));
3104 			UWRITE2(sc, port, x | UHCI_PORTSC_CSC);
3105 			break;
3106 		case UHF_C_PORT_ENABLE:
3107 			x = URWMASK(UREAD2(sc, port));
3108 			UWRITE2(sc, port, x | UHCI_PORTSC_POEDC);
3109 			break;
3110 		case UHF_C_PORT_OVER_CURRENT:
3111 			x = URWMASK(UREAD2(sc, port));
3112 			UWRITE2(sc, port, x | UHCI_PORTSC_OCIC);
3113 			break;
3114 		case UHF_C_PORT_RESET:
3115 			sc->sc_isreset = 0;
3116 			err = USBD_NORMAL_COMPLETION;
3117 			goto ret;
3118 		case UHF_PORT_CONNECTION:
3119 		case UHF_PORT_OVER_CURRENT:
3120 		case UHF_PORT_POWER:
3121 		case UHF_PORT_LOW_SPEED:
3122 		case UHF_C_PORT_SUSPEND:
3123 		default:
3124 			err = USBD_IOERROR;
3125 			goto ret;
3126 		}
3127 		break;
3128 	case C(UR_GET_BUS_STATE, UT_READ_CLASS_OTHER):
3129 		if (index == 1)
3130 			port = UHCI_PORTSC1;
3131 		else if (index == 2)
3132 			port = UHCI_PORTSC2;
3133 		else {
3134 			err = USBD_IOERROR;
3135 			goto ret;
3136 		}
3137 		if (len > 0) {
3138 			*(u_int8_t *)buf =
3139 				(UREAD2(sc, port) & UHCI_PORTSC_LS) >>
3140 				UHCI_PORTSC_LS_SHIFT;
3141 			totlen = 1;
3142 		}
3143 		break;
3144 	case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
3145 		if (value != 0) {
3146 			err = USBD_IOERROR;
3147 			goto ret;
3148 		}
3149 		l = min(len, USB_HUB_DESCRIPTOR_SIZE);
3150 		totlen = l;
3151 		memcpy(buf, &uhci_hubd_piix, l);
3152 		break;
3153 	case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
3154 		if (len != 4) {
3155 			err = USBD_IOERROR;
3156 			goto ret;
3157 		}
3158 		memset(buf, 0, len);
3159 		totlen = len;
3160 		break;
3161 	case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
3162 		if (index == 1)
3163 			port = UHCI_PORTSC1;
3164 		else if (index == 2)
3165 			port = UHCI_PORTSC2;
3166 		else {
3167 			err = USBD_IOERROR;
3168 			goto ret;
3169 		}
3170 		if (len != 4) {
3171 			err = USBD_IOERROR;
3172 			goto ret;
3173 		}
3174 		x = UREAD2(sc, port);
3175 		status = change = 0;
3176 		if (x & UHCI_PORTSC_CCS)
3177 			status |= UPS_CURRENT_CONNECT_STATUS;
3178 		if (x & UHCI_PORTSC_CSC)
3179 			change |= UPS_C_CONNECT_STATUS;
3180 		if (x & UHCI_PORTSC_PE)
3181 			status |= UPS_PORT_ENABLED;
3182 		if (x & UHCI_PORTSC_POEDC)
3183 			change |= UPS_C_PORT_ENABLED;
3184 		if (x & UHCI_PORTSC_OCI)
3185 			status |= UPS_OVERCURRENT_INDICATOR;
3186 		if (x & UHCI_PORTSC_OCIC)
3187 			change |= UPS_C_OVERCURRENT_INDICATOR;
3188 		if (x & UHCI_PORTSC_SUSP)
3189 			status |= UPS_SUSPEND;
3190 		if (x & UHCI_PORTSC_LSDA)
3191 			status |= UPS_LOW_SPEED;
3192 		status |= UPS_PORT_POWER;
3193 		if (sc->sc_isreset)
3194 			change |= UPS_C_PORT_RESET;
3195 		USETW(ps.wPortStatus, status);
3196 		USETW(ps.wPortChange, change);
3197 		l = min(len, sizeof ps);
3198 		memcpy(buf, &ps, l);
3199 		totlen = l;
3200 		break;
3201 	case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
3202 		err = USBD_IOERROR;
3203 		goto ret;
3204 	case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
3205 		break;
3206 	case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
3207 		if (index == 1)
3208 			port = UHCI_PORTSC1;
3209 		else if (index == 2)
3210 			port = UHCI_PORTSC2;
3211 		else {
3212 			err = USBD_IOERROR;
3213 			goto ret;
3214 		}
3215 		switch(value) {
3216 		case UHF_PORT_ENABLE:
3217 			x = URWMASK(UREAD2(sc, port));
3218 			UWRITE2(sc, port, x | UHCI_PORTSC_PE);
3219 			break;
3220 		case UHF_PORT_SUSPEND:
3221 			x = URWMASK(UREAD2(sc, port));
3222 			UWRITE2(sc, port, x | UHCI_PORTSC_SUSP);
3223 			break;
3224 		case UHF_PORT_RESET:
3225 			x = URWMASK(UREAD2(sc, port));
3226 			UWRITE2(sc, port, x | UHCI_PORTSC_PR);
3227 			usb_delay_ms(&sc->sc_bus, USB_PORT_ROOT_RESET_DELAY);
3228 			UWRITE2(sc, port, x & ~UHCI_PORTSC_PR);
3229 			delay(100);
3230 			x = UREAD2(sc, port);
3231 			UWRITE2(sc, port, x  | UHCI_PORTSC_PE);
3232 			usb_delay_ms(&sc->sc_bus, 10); /* XXX */
3233 			DPRINTFN(3,("uhci port %d reset, status = 0x%04x\n",
3234 				    index, UREAD2(sc, port)));
3235 			sc->sc_isreset = 1;
3236 			break;
3237 		case UHF_PORT_POWER:
3238 			/* Pretend we turned on power */
3239 			err = USBD_NORMAL_COMPLETION;
3240 			goto ret;
3241 		case UHF_C_PORT_CONNECTION:
3242 		case UHF_C_PORT_ENABLE:
3243 		case UHF_C_PORT_OVER_CURRENT:
3244 		case UHF_PORT_CONNECTION:
3245 		case UHF_PORT_OVER_CURRENT:
3246 		case UHF_PORT_LOW_SPEED:
3247 		case UHF_C_PORT_SUSPEND:
3248 		case UHF_C_PORT_RESET:
3249 		default:
3250 			err = USBD_IOERROR;
3251 			goto ret;
3252 		}
3253 		break;
3254 	default:
3255 		err = USBD_IOERROR;
3256 		goto ret;
3257 	}
3258 	xfer->actlen = totlen;
3259 	err = USBD_NORMAL_COMPLETION;
3260  ret:
3261 	xfer->status = err;
3262 	s = splusb();
3263 	usb_transfer_complete(xfer);
3264 	splx(s);
3265 	return (USBD_IN_PROGRESS);
3266 }
3267 
3268 /* Abort a root control request. */
3269 void
3270 uhci_root_ctrl_abort(usbd_xfer_handle xfer)
3271 {
3272 	/* Nothing to do, all transfers are synchronous. */
3273 }
3274 
3275 /* Close the root pipe. */
3276 void
3277 uhci_root_ctrl_close(usbd_pipe_handle pipe)
3278 {
3279 	DPRINTF(("uhci_root_ctrl_close\n"));
3280 }
3281 
3282 /* Abort a root interrupt request. */
3283 void
3284 uhci_root_intr_abort(usbd_xfer_handle xfer)
3285 {
3286 	uhci_softc_t *sc = (uhci_softc_t *)xfer->pipe->device->bus;
3287 
3288 	usb_uncallout(sc->sc_poll_handle, uhci_poll_hub, xfer);
3289 	sc->sc_intr_xfer = NULL;
3290 
3291 	if (xfer->pipe->intrxfer == xfer) {
3292 		DPRINTF(("uhci_root_intr_abort: remove\n"));
3293 		xfer->pipe->intrxfer = 0;
3294 	}
3295 	xfer->status = USBD_CANCELLED;
3296 #ifdef DIAGNOSTIC
3297 	UXFER(xfer)->iinfo.isdone = 1;
3298 #endif
3299 	usb_transfer_complete(xfer);
3300 }
3301 
3302 usbd_status
3303 uhci_root_intr_transfer(usbd_xfer_handle xfer)
3304 {
3305 	usbd_status err;
3306 
3307 	/* Insert last in queue. */
3308 	err = usb_insert_transfer(xfer);
3309 	if (err)
3310 		return (err);
3311 
3312 	/* Pipe isn't running (otherwise err would be USBD_INPROG),
3313 	 * start first
3314 	 */
3315 	return (uhci_root_intr_start(SIMPLEQ_FIRST(&xfer->pipe->queue)));
3316 }
3317 
3318 /* Start a transfer on the root interrupt pipe */
3319 usbd_status
3320 uhci_root_intr_start(usbd_xfer_handle xfer)
3321 {
3322 	usbd_pipe_handle pipe = xfer->pipe;
3323 	uhci_softc_t *sc = (uhci_softc_t *)pipe->device->bus;
3324 
3325 	DPRINTFN(3, ("uhci_root_intr_transfer: xfer=%p len=%d flags=%d\n",
3326 		     xfer, xfer->length, xfer->flags));
3327 
3328 	if (sc->sc_dying)
3329 		return (USBD_IOERROR);
3330 
3331 	sc->sc_ival = MS_TO_TICKS(xfer->pipe->endpoint->edesc->bInterval);
3332 	usb_callout(sc->sc_poll_handle, sc->sc_ival, uhci_poll_hub, xfer);
3333 	sc->sc_intr_xfer = xfer;
3334 	return (USBD_IN_PROGRESS);
3335 }
3336 
3337 /* Close the root interrupt pipe. */
3338 void
3339 uhci_root_intr_close(usbd_pipe_handle pipe)
3340 {
3341 	uhci_softc_t *sc = (uhci_softc_t *)pipe->device->bus;
3342 
3343 	usb_uncallout(sc->sc_poll_handle, uhci_poll_hub, sc->sc_intr_xfer);
3344 	sc->sc_intr_xfer = NULL;
3345 	DPRINTF(("uhci_root_intr_close\n"));
3346 }
3347