uhci.c revision 1.264.4.79 1 /* $NetBSD: uhci.c,v 1.264.4.79 2016/12/28 10:25:06 skrll Exp $ */
2
3 /*
4 * Copyright (c) 1998, 2004, 2011, 2012 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (lennart (at) augustsson.net) at
9 * Carlstedt Research & Technology, Jared D. McNeill (jmcneill (at) invisible.ca)
10 * and Matthew R. Green (mrg (at) eterna.com.au).
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 *
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 /*
35 * USB Universal Host Controller driver.
36 * Handles e.g. PIIX3 and PIIX4.
37 *
38 * UHCI spec: http://www.intel.com/technology/usb/spec.htm
39 * USB spec: http://www.usb.org/developers/docs/
40 * PIIXn spec: ftp://download.intel.com/design/intarch/datashts/29055002.pdf
41 * ftp://download.intel.com/design/intarch/datashts/29056201.pdf
42 */
43
44 #include <sys/cdefs.h>
45 __KERNEL_RCSID(0, "$NetBSD: uhci.c,v 1.264.4.79 2016/12/28 10:25:06 skrll Exp $");
46
47 #ifdef _KERNEL_OPT
48 #include "opt_usb.h"
49 #endif
50
51 #include <sys/param.h>
52
53 #include <sys/bus.h>
54 #include <sys/cpu.h>
55 #include <sys/device.h>
56 #include <sys/kernel.h>
57 #include <sys/kmem.h>
58 #include <sys/mutex.h>
59 #include <sys/proc.h>
60 #include <sys/queue.h>
61 #include <sys/select.h>
62 #include <sys/sysctl.h>
63 #include <sys/systm.h>
64
65 #include <machine/endian.h>
66
67 #include <dev/usb/usb.h>
68 #include <dev/usb/usbdi.h>
69 #include <dev/usb/usbdivar.h>
70 #include <dev/usb/usb_mem.h>
71
72 #include <dev/usb/uhcireg.h>
73 #include <dev/usb/uhcivar.h>
74 #include <dev/usb/usbroothub.h>
75 #include <dev/usb/usbhist.h>
76
77 /* Use bandwidth reclamation for control transfers. Some devices choke on it. */
78 /*#define UHCI_CTL_LOOP */
79
80 #ifdef UHCI_DEBUG
81 uhci_softc_t *thesc;
82 int uhcinoloop = 0;
83 #endif
84
85 #ifdef USB_DEBUG
86 #ifndef UHCI_DEBUG
87 #define uhcidebug 0
88 #else
89 static int uhcidebug = 0;
90
91 SYSCTL_SETUP(sysctl_hw_uhci_setup, "sysctl hw.uhci setup")
92 {
93 int err;
94 const struct sysctlnode *rnode;
95 const struct sysctlnode *cnode;
96
97 err = sysctl_createv(clog, 0, NULL, &rnode,
98 CTLFLAG_PERMANENT, CTLTYPE_NODE, "uhci",
99 SYSCTL_DESCR("uhci global controls"),
100 NULL, 0, NULL, 0, CTL_HW, CTL_CREATE, CTL_EOL);
101
102 if (err)
103 goto fail;
104
105 /* control debugging printfs */
106 err = sysctl_createv(clog, 0, &rnode, &cnode,
107 CTLFLAG_PERMANENT|CTLFLAG_READWRITE, CTLTYPE_INT,
108 "debug", SYSCTL_DESCR("Enable debugging output"),
109 NULL, 0, &uhcidebug, sizeof(uhcidebug), CTL_CREATE, CTL_EOL);
110 if (err)
111 goto fail;
112
113 return;
114 fail:
115 aprint_error("%s: sysctl_createv failed (err = %d)\n", __func__, err);
116 }
117
118 #endif /* UHCI_DEBUG */
119 #endif /* USB_DEBUG */
120
121 #define DPRINTF(FMT,A,B,C,D) USBHIST_LOGN(uhcidebug,1,FMT,A,B,C,D)
122 #define DPRINTFN(N,FMT,A,B,C,D) USBHIST_LOGN(uhcidebug,N,FMT,A,B,C,D)
123 #define UHCIHIST_FUNC() USBHIST_FUNC()
124 #define UHCIHIST_CALLED(name) USBHIST_CALLED(uhcidebug)
125
126 /*
127 * The UHCI controller is little endian, so on big endian machines
128 * the data stored in memory needs to be swapped.
129 */
130
131 struct uhci_pipe {
132 struct usbd_pipe pipe;
133 int nexttoggle;
134
135 u_char aborting;
136 struct usbd_xfer *abortstart, abortend;
137
138 /* Info needed for different pipe kinds. */
139 union {
140 /* Control pipe */
141 struct {
142 uhci_soft_qh_t *sqh;
143 usb_dma_t reqdma;
144 uhci_soft_td_t *setup;
145 uhci_soft_td_t *stat;
146 } ctrl;
147 /* Interrupt pipe */
148 struct {
149 int npoll;
150 uhci_soft_qh_t **qhs;
151 } intr;
152 /* Bulk pipe */
153 struct {
154 uhci_soft_qh_t *sqh;
155 } bulk;
156 /* Isochronous pipe */
157 struct isoc {
158 uhci_soft_td_t **stds;
159 int next, inuse;
160 } isoc;
161 };
162 };
163
164 typedef TAILQ_HEAD(ux_completeq, uhci_xfer) ux_completeq_t;
165
166 Static void uhci_globalreset(uhci_softc_t *);
167 Static usbd_status uhci_portreset(uhci_softc_t*, int);
168 Static void uhci_reset(uhci_softc_t *);
169 Static usbd_status uhci_run(uhci_softc_t *, int, int);
170 Static uhci_soft_td_t *uhci_alloc_std(uhci_softc_t *);
171 Static void uhci_free_std(uhci_softc_t *, uhci_soft_td_t *);
172 Static void uhci_free_std_locked(uhci_softc_t *, uhci_soft_td_t *);
173 Static uhci_soft_qh_t *uhci_alloc_sqh(uhci_softc_t *);
174 Static void uhci_free_sqh(uhci_softc_t *, uhci_soft_qh_t *);
175 #if 0
176 Static void uhci_enter_ctl_q(uhci_softc_t *, uhci_soft_qh_t *,
177 uhci_intr_info_t *);
178 Static void uhci_exit_ctl_q(uhci_softc_t *, uhci_soft_qh_t *);
179 #endif
180
181 #if 0
182 Static void uhci_free_std_chain(uhci_softc_t *, uhci_soft_td_t *,
183 uhci_soft_td_t *);
184 #endif
185 Static int uhci_alloc_std_chain(uhci_softc_t *, struct usbd_xfer *,
186 int, int, uhci_soft_td_t **);
187 Static void uhci_free_stds(uhci_softc_t *, struct uhci_xfer *);
188
189 Static void uhci_reset_std_chain(uhci_softc_t *, struct usbd_xfer *,
190 int, int, int *, uhci_soft_td_t **);
191
192 Static void uhci_poll_hub(void *);
193 Static void uhci_check_intr(uhci_softc_t *, struct uhci_xfer *,
194 ux_completeq_t *);
195 Static void uhci_idone(struct uhci_xfer *, ux_completeq_t *);
196
197 Static void uhci_abort_xfer(struct usbd_xfer *, usbd_status);
198
199 Static void uhci_timeout(void *);
200 Static void uhci_timeout_task(void *);
201 Static void uhci_add_ls_ctrl(uhci_softc_t *, uhci_soft_qh_t *);
202 Static void uhci_add_hs_ctrl(uhci_softc_t *, uhci_soft_qh_t *);
203 Static void uhci_add_bulk(uhci_softc_t *, uhci_soft_qh_t *);
204 Static void uhci_remove_ls_ctrl(uhci_softc_t *,uhci_soft_qh_t *);
205 Static void uhci_remove_hs_ctrl(uhci_softc_t *,uhci_soft_qh_t *);
206 Static void uhci_remove_bulk(uhci_softc_t *,uhci_soft_qh_t *);
207 Static void uhci_add_loop(uhci_softc_t *);
208 Static void uhci_rem_loop(uhci_softc_t *);
209
210 Static usbd_status uhci_setup_isoc(struct usbd_pipe *);
211
212 Static struct usbd_xfer *
213 uhci_allocx(struct usbd_bus *, unsigned int);
214 Static void uhci_freex(struct usbd_bus *, struct usbd_xfer *);
215 Static void uhci_get_lock(struct usbd_bus *, kmutex_t **);
216 Static int uhci_roothub_ctrl(struct usbd_bus *,
217 usb_device_request_t *, void *, int);
218
219 Static int uhci_device_ctrl_init(struct usbd_xfer *);
220 Static void uhci_device_ctrl_fini(struct usbd_xfer *);
221 Static usbd_status uhci_device_ctrl_transfer(struct usbd_xfer *);
222 Static usbd_status uhci_device_ctrl_start(struct usbd_xfer *);
223 Static void uhci_device_ctrl_abort(struct usbd_xfer *);
224 Static void uhci_device_ctrl_close(struct usbd_pipe *);
225 Static void uhci_device_ctrl_done(struct usbd_xfer *);
226
227 Static int uhci_device_intr_init(struct usbd_xfer *);
228 Static void uhci_device_intr_fini(struct usbd_xfer *);
229 Static usbd_status uhci_device_intr_transfer(struct usbd_xfer *);
230 Static usbd_status uhci_device_intr_start(struct usbd_xfer *);
231 Static void uhci_device_intr_abort(struct usbd_xfer *);
232 Static void uhci_device_intr_close(struct usbd_pipe *);
233 Static void uhci_device_intr_done(struct usbd_xfer *);
234
235 Static int uhci_device_bulk_init(struct usbd_xfer *);
236 Static void uhci_device_bulk_fini(struct usbd_xfer *);
237 Static usbd_status uhci_device_bulk_transfer(struct usbd_xfer *);
238 Static usbd_status uhci_device_bulk_start(struct usbd_xfer *);
239 Static void uhci_device_bulk_abort(struct usbd_xfer *);
240 Static void uhci_device_bulk_close(struct usbd_pipe *);
241 Static void uhci_device_bulk_done(struct usbd_xfer *);
242
243 Static int uhci_device_isoc_init(struct usbd_xfer *);
244 Static void uhci_device_isoc_fini(struct usbd_xfer *);
245 Static usbd_status uhci_device_isoc_transfer(struct usbd_xfer *);
246 Static void uhci_device_isoc_abort(struct usbd_xfer *);
247 Static void uhci_device_isoc_close(struct usbd_pipe *);
248 Static void uhci_device_isoc_done(struct usbd_xfer *);
249
250 Static usbd_status uhci_root_intr_transfer(struct usbd_xfer *);
251 Static usbd_status uhci_root_intr_start(struct usbd_xfer *);
252 Static void uhci_root_intr_abort(struct usbd_xfer *);
253 Static void uhci_root_intr_close(struct usbd_pipe *);
254 Static void uhci_root_intr_done(struct usbd_xfer *);
255
256 Static usbd_status uhci_open(struct usbd_pipe *);
257 Static void uhci_poll(struct usbd_bus *);
258 Static void uhci_softintr(void *);
259
260 Static void uhci_add_intr(uhci_softc_t *, uhci_soft_qh_t *);
261 Static void uhci_remove_intr(uhci_softc_t *, uhci_soft_qh_t *);
262 Static usbd_status uhci_device_setintr(uhci_softc_t *,
263 struct uhci_pipe *, int);
264
265 Static void uhci_device_clear_toggle(struct usbd_pipe *);
266 Static void uhci_noop(struct usbd_pipe *);
267
268 static inline uhci_soft_qh_t *
269 uhci_find_prev_qh(uhci_soft_qh_t *, uhci_soft_qh_t *);
270
271 #ifdef UHCI_DEBUG
272 Static void uhci_dump_all(uhci_softc_t *);
273 Static void uhci_dumpregs(uhci_softc_t *);
274 Static void uhci_dump_qhs(uhci_soft_qh_t *);
275 Static void uhci_dump_qh(uhci_soft_qh_t *);
276 Static void uhci_dump_tds(uhci_soft_td_t *);
277 Static void uhci_dump_td(uhci_soft_td_t *);
278 Static void uhci_dump_ii(struct uhci_xfer *);
279 void uhci_dump(void);
280 #endif
281
282 #define UBARR(sc) bus_space_barrier((sc)->iot, (sc)->ioh, 0, (sc)->sc_size, \
283 BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE)
284 #define UWRITE1(sc, r, x) \
285 do { UBARR(sc); bus_space_write_1((sc)->iot, (sc)->ioh, (r), (x)); \
286 } while (/*CONSTCOND*/0)
287 #define UWRITE2(sc, r, x) \
288 do { UBARR(sc); bus_space_write_2((sc)->iot, (sc)->ioh, (r), (x)); \
289 } while (/*CONSTCOND*/0)
290 #define UWRITE4(sc, r, x) \
291 do { UBARR(sc); bus_space_write_4((sc)->iot, (sc)->ioh, (r), (x)); \
292 } while (/*CONSTCOND*/0)
293
294 static __inline uint8_t
295 UREAD1(uhci_softc_t *sc, bus_size_t r)
296 {
297
298 UBARR(sc);
299 return bus_space_read_1(sc->iot, sc->ioh, r);
300 }
301
302 static __inline uint16_t
303 UREAD2(uhci_softc_t *sc, bus_size_t r)
304 {
305
306 UBARR(sc);
307 return bus_space_read_2(sc->iot, sc->ioh, r);
308 }
309
310 #ifdef UHCI_DEBUG
311 static __inline uint32_t
312 UREAD4(uhci_softc_t *sc, bus_size_t r)
313 {
314
315 UBARR(sc);
316 return bus_space_read_4(sc->iot, sc->ioh, r);
317 }
318 #endif
319
320 #define UHCICMD(sc, cmd) UWRITE2(sc, UHCI_CMD, cmd)
321 #define UHCISTS(sc) UREAD2(sc, UHCI_STS)
322
323 #define UHCI_RESET_TIMEOUT 100 /* ms, reset timeout */
324
325 #define UHCI_CURFRAME(sc) (UREAD2(sc, UHCI_FRNUM) & UHCI_FRNUM_MASK)
326
327 const struct usbd_bus_methods uhci_bus_methods = {
328 .ubm_open = uhci_open,
329 .ubm_softint = uhci_softintr,
330 .ubm_dopoll = uhci_poll,
331 .ubm_allocx = uhci_allocx,
332 .ubm_freex = uhci_freex,
333 .ubm_getlock = uhci_get_lock,
334 .ubm_rhctrl = uhci_roothub_ctrl,
335 };
336
337 const struct usbd_pipe_methods uhci_root_intr_methods = {
338 .upm_transfer = uhci_root_intr_transfer,
339 .upm_start = uhci_root_intr_start,
340 .upm_abort = uhci_root_intr_abort,
341 .upm_close = uhci_root_intr_close,
342 .upm_cleartoggle = uhci_noop,
343 .upm_done = uhci_root_intr_done,
344 };
345
346 const struct usbd_pipe_methods uhci_device_ctrl_methods = {
347 .upm_init = uhci_device_ctrl_init,
348 .upm_fini = uhci_device_ctrl_fini,
349 .upm_transfer = uhci_device_ctrl_transfer,
350 .upm_start = uhci_device_ctrl_start,
351 .upm_abort = uhci_device_ctrl_abort,
352 .upm_close = uhci_device_ctrl_close,
353 .upm_cleartoggle = uhci_noop,
354 .upm_done = uhci_device_ctrl_done,
355 };
356
357 const struct usbd_pipe_methods uhci_device_intr_methods = {
358 .upm_init = uhci_device_intr_init,
359 .upm_fini = uhci_device_intr_fini,
360 .upm_transfer = uhci_device_intr_transfer,
361 .upm_start = uhci_device_intr_start,
362 .upm_abort = uhci_device_intr_abort,
363 .upm_close = uhci_device_intr_close,
364 .upm_cleartoggle = uhci_device_clear_toggle,
365 .upm_done = uhci_device_intr_done,
366 };
367
368 const struct usbd_pipe_methods uhci_device_bulk_methods = {
369 .upm_init = uhci_device_bulk_init,
370 .upm_fini = uhci_device_bulk_fini,
371 .upm_transfer = uhci_device_bulk_transfer,
372 .upm_start = uhci_device_bulk_start,
373 .upm_abort = uhci_device_bulk_abort,
374 .upm_close = uhci_device_bulk_close,
375 .upm_cleartoggle = uhci_device_clear_toggle,
376 .upm_done = uhci_device_bulk_done,
377 };
378
379 const struct usbd_pipe_methods uhci_device_isoc_methods = {
380 .upm_init = uhci_device_isoc_init,
381 .upm_fini = uhci_device_isoc_fini,
382 .upm_transfer = uhci_device_isoc_transfer,
383 .upm_abort = uhci_device_isoc_abort,
384 .upm_close = uhci_device_isoc_close,
385 .upm_cleartoggle = uhci_noop,
386 .upm_done = uhci_device_isoc_done,
387 };
388
389 static inline void
390 uhci_add_intr_list(uhci_softc_t *sc, struct uhci_xfer *ux)
391 {
392
393 TAILQ_INSERT_TAIL(&sc->sc_intrhead, ux, ux_list);
394 }
395
396 static inline void
397 uhci_del_intr_list(uhci_softc_t *sc, struct uhci_xfer *ux)
398 {
399
400 TAILQ_REMOVE(&sc->sc_intrhead, ux, ux_list);
401 }
402
403 static inline uhci_soft_qh_t *
404 uhci_find_prev_qh(uhci_soft_qh_t *pqh, uhci_soft_qh_t *sqh)
405 {
406 UHCIHIST_FUNC(); UHCIHIST_CALLED();
407 DPRINTFN(15, "pqh=%p sqh=%p", pqh, sqh, 0, 0);
408
409 for (; pqh->hlink != sqh; pqh = pqh->hlink) {
410 #if defined(DIAGNOSTIC) || defined(UHCI_DEBUG)
411 usb_syncmem(&pqh->dma,
412 pqh->offs + offsetof(uhci_qh_t, qh_hlink),
413 sizeof(pqh->qh.qh_hlink),
414 BUS_DMASYNC_POSTWRITE);
415 if (le32toh(pqh->qh.qh_hlink) & UHCI_PTR_T) {
416 printf("%s: QH not found\n", __func__);
417 return NULL;
418 }
419 #endif
420 }
421 return pqh;
422 }
423
424 void
425 uhci_globalreset(uhci_softc_t *sc)
426 {
427 UHCICMD(sc, UHCI_CMD_GRESET); /* global reset */
428 usb_delay_ms(&sc->sc_bus, USB_BUS_RESET_DELAY); /* wait a little */
429 UHCICMD(sc, 0); /* do nothing */
430 }
431
432 int
433 uhci_init(uhci_softc_t *sc)
434 {
435 usbd_status err;
436 int i, j;
437 uhci_soft_qh_t *clsqh, *chsqh, *bsqh, *sqh, *lsqh;
438 uhci_soft_td_t *std;
439
440 UHCIHIST_FUNC(); UHCIHIST_CALLED();
441
442 #ifdef UHCI_DEBUG
443 thesc = sc;
444
445 if (uhcidebug >= 2)
446 uhci_dumpregs(sc);
447 #endif
448
449 sc->sc_suspend = PWR_RESUME;
450
451 UWRITE2(sc, UHCI_INTR, 0); /* disable interrupts */
452 uhci_globalreset(sc); /* reset the controller */
453 uhci_reset(sc);
454
455 /* Allocate and initialize real frame array. */
456 err = usb_allocmem(&sc->sc_bus,
457 UHCI_FRAMELIST_COUNT * sizeof(uhci_physaddr_t),
458 UHCI_FRAMELIST_ALIGN, &sc->sc_dma);
459 if (err)
460 return err;
461 sc->sc_pframes = KERNADDR(&sc->sc_dma, 0);
462 UWRITE2(sc, UHCI_FRNUM, 0); /* set frame number to 0 */
463 UWRITE4(sc, UHCI_FLBASEADDR, DMAADDR(&sc->sc_dma, 0)); /* set frame list*/
464
465 /* Initialise mutex early for uhci_alloc_* */
466 mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);
467 mutex_init(&sc->sc_intr_lock, MUTEX_DEFAULT, IPL_USB);
468
469 /*
470 * Allocate a TD, inactive, that hangs from the last QH.
471 * This is to avoid a bug in the PIIX that makes it run berserk
472 * otherwise.
473 */
474 std = uhci_alloc_std(sc);
475 if (std == NULL)
476 return ENOMEM;
477 std->link.std = NULL;
478 std->td.td_link = htole32(UHCI_PTR_T);
479 std->td.td_status = htole32(0); /* inactive */
480 std->td.td_token = htole32(0);
481 std->td.td_buffer = htole32(0);
482 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
483 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
484
485 /* Allocate the dummy QH marking the end and used for looping the QHs.*/
486 lsqh = uhci_alloc_sqh(sc);
487 if (lsqh == NULL)
488 goto fail1;
489 lsqh->hlink = NULL;
490 lsqh->qh.qh_hlink = htole32(UHCI_PTR_T); /* end of QH chain */
491 lsqh->elink = std;
492 lsqh->qh.qh_elink = htole32(std->physaddr | UHCI_PTR_TD);
493 sc->sc_last_qh = lsqh;
494 usb_syncmem(&lsqh->dma, lsqh->offs, sizeof(lsqh->qh),
495 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
496
497 /* Allocate the dummy QH where bulk traffic will be queued. */
498 bsqh = uhci_alloc_sqh(sc);
499 if (bsqh == NULL)
500 goto fail2;
501 bsqh->hlink = lsqh;
502 bsqh->qh.qh_hlink = htole32(lsqh->physaddr | UHCI_PTR_QH);
503 bsqh->elink = NULL;
504 bsqh->qh.qh_elink = htole32(UHCI_PTR_T);
505 sc->sc_bulk_start = sc->sc_bulk_end = bsqh;
506 usb_syncmem(&bsqh->dma, bsqh->offs, sizeof(bsqh->qh),
507 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
508
509 /* Allocate dummy QH where high speed control traffic will be queued. */
510 chsqh = uhci_alloc_sqh(sc);
511 if (chsqh == NULL)
512 goto fail3;
513 chsqh->hlink = bsqh;
514 chsqh->qh.qh_hlink = htole32(bsqh->physaddr | UHCI_PTR_QH);
515 chsqh->elink = NULL;
516 chsqh->qh.qh_elink = htole32(UHCI_PTR_T);
517 sc->sc_hctl_start = sc->sc_hctl_end = chsqh;
518 usb_syncmem(&chsqh->dma, chsqh->offs, sizeof(chsqh->qh),
519 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
520
521 /* Allocate dummy QH where control traffic will be queued. */
522 clsqh = uhci_alloc_sqh(sc);
523 if (clsqh == NULL)
524 goto fail4;
525 clsqh->hlink = chsqh;
526 clsqh->qh.qh_hlink = htole32(chsqh->physaddr | UHCI_PTR_QH);
527 clsqh->elink = NULL;
528 clsqh->qh.qh_elink = htole32(UHCI_PTR_T);
529 sc->sc_lctl_start = sc->sc_lctl_end = clsqh;
530 usb_syncmem(&clsqh->dma, clsqh->offs, sizeof(clsqh->qh),
531 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
532
533 /*
534 * Make all (virtual) frame list pointers point to the interrupt
535 * queue heads and the interrupt queue heads at the control
536 * queue head and point the physical frame list to the virtual.
537 */
538 for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
539 std = uhci_alloc_std(sc);
540 sqh = uhci_alloc_sqh(sc);
541 if (std == NULL || sqh == NULL)
542 return USBD_NOMEM;
543 std->link.sqh = sqh;
544 std->td.td_link = htole32(sqh->physaddr | UHCI_PTR_QH);
545 std->td.td_status = htole32(UHCI_TD_IOS); /* iso, inactive */
546 std->td.td_token = htole32(0);
547 std->td.td_buffer = htole32(0);
548 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
549 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
550 sqh->hlink = clsqh;
551 sqh->qh.qh_hlink = htole32(clsqh->physaddr | UHCI_PTR_QH);
552 sqh->elink = NULL;
553 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
554 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
555 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
556 sc->sc_vframes[i].htd = std;
557 sc->sc_vframes[i].etd = std;
558 sc->sc_vframes[i].hqh = sqh;
559 sc->sc_vframes[i].eqh = sqh;
560 for (j = i;
561 j < UHCI_FRAMELIST_COUNT;
562 j += UHCI_VFRAMELIST_COUNT)
563 sc->sc_pframes[j] = htole32(std->physaddr);
564 }
565 usb_syncmem(&sc->sc_dma, 0,
566 UHCI_FRAMELIST_COUNT * sizeof(uhci_physaddr_t),
567 BUS_DMASYNC_PREWRITE);
568
569
570 TAILQ_INIT(&sc->sc_intrhead);
571
572 sc->sc_xferpool = pool_cache_init(sizeof(struct uhci_xfer), 0, 0, 0,
573 "uhcixfer", NULL, IPL_USB, NULL, NULL, NULL);
574
575 callout_init(&sc->sc_poll_handle, CALLOUT_MPSAFE);
576
577 /* Set up the bus struct. */
578 sc->sc_bus.ub_methods = &uhci_bus_methods;
579 sc->sc_bus.ub_pipesize = sizeof(struct uhci_pipe);
580 sc->sc_bus.ub_usedma = true;
581
582 UHCICMD(sc, UHCI_CMD_MAXP); /* Assume 64 byte packets at frame end */
583
584 DPRINTF("Enabling...", 0, 0, 0, 0);
585
586 err = uhci_run(sc, 1, 0); /* and here we go... */
587 UWRITE2(sc, UHCI_INTR, UHCI_INTR_TOCRCIE | UHCI_INTR_RIE |
588 UHCI_INTR_IOCE | UHCI_INTR_SPIE); /* enable interrupts */
589 return err;
590
591 fail4:
592 uhci_free_sqh(sc, chsqh);
593 fail3:
594 uhci_free_sqh(sc, lsqh);
595 fail2:
596 uhci_free_sqh(sc, lsqh);
597 fail1:
598 uhci_free_std(sc, std);
599
600 return ENOMEM;
601 }
602
603 int
604 uhci_activate(device_t self, enum devact act)
605 {
606 struct uhci_softc *sc = device_private(self);
607
608 switch (act) {
609 case DVACT_DEACTIVATE:
610 sc->sc_dying = 1;
611 return 0;
612 default:
613 return EOPNOTSUPP;
614 }
615 }
616
617 void
618 uhci_childdet(device_t self, device_t child)
619 {
620 struct uhci_softc *sc = device_private(self);
621
622 KASSERT(sc->sc_child == child);
623 sc->sc_child = NULL;
624 }
625
626 int
627 uhci_detach(struct uhci_softc *sc, int flags)
628 {
629 int rv = 0;
630
631 if (sc->sc_child != NULL)
632 rv = config_detach(sc->sc_child, flags);
633
634 if (rv != 0)
635 return rv;
636
637 callout_halt(&sc->sc_poll_handle, NULL);
638 callout_destroy(&sc->sc_poll_handle);
639
640 mutex_destroy(&sc->sc_lock);
641 mutex_destroy(&sc->sc_intr_lock);
642
643 pool_cache_destroy(sc->sc_xferpool);
644
645 /* XXX free other data structures XXX */
646
647 return rv;
648 }
649
650 struct usbd_xfer *
651 uhci_allocx(struct usbd_bus *bus, unsigned int nframes)
652 {
653 struct uhci_softc *sc = UHCI_BUS2SC(bus);
654 struct usbd_xfer *xfer;
655
656 xfer = pool_cache_get(sc->sc_xferpool, PR_NOWAIT);
657 if (xfer != NULL) {
658 memset(xfer, 0, sizeof(struct uhci_xfer));
659
660 #ifdef DIAGNOSTIC
661 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
662 uxfer->ux_isdone = true;
663 xfer->ux_state = XFER_BUSY;
664 #endif
665 }
666 return xfer;
667 }
668
669 void
670 uhci_freex(struct usbd_bus *bus, struct usbd_xfer *xfer)
671 {
672 struct uhci_softc *sc = UHCI_BUS2SC(bus);
673 struct uhci_xfer *uxfer __diagused = UHCI_XFER2UXFER(xfer);
674
675 KASSERTMSG(xfer->ux_state == XFER_BUSY, "xfer %p state %d\n", xfer,
676 xfer->ux_state);
677 KASSERTMSG(uxfer->ux_isdone, "xfer %p not done\n", xfer);
678 #ifdef DIAGNOSTIC
679 xfer->ux_state = XFER_FREE;
680 #endif
681 pool_cache_put(sc->sc_xferpool, xfer);
682 }
683
684 Static void
685 uhci_get_lock(struct usbd_bus *bus, kmutex_t **lock)
686 {
687 struct uhci_softc *sc = UHCI_BUS2SC(bus);
688
689 *lock = &sc->sc_lock;
690 }
691
692
693 /*
694 * Handle suspend/resume.
695 *
696 * We need to switch to polling mode here, because this routine is
697 * called from an interrupt context. This is all right since we
698 * are almost suspended anyway.
699 */
700 bool
701 uhci_resume(device_t dv, const pmf_qual_t *qual)
702 {
703 uhci_softc_t *sc = device_private(dv);
704 int cmd;
705
706 mutex_spin_enter(&sc->sc_intr_lock);
707
708 cmd = UREAD2(sc, UHCI_CMD);
709 sc->sc_bus.ub_usepolling++;
710 UWRITE2(sc, UHCI_INTR, 0);
711 uhci_globalreset(sc);
712 uhci_reset(sc);
713 if (cmd & UHCI_CMD_RS)
714 uhci_run(sc, 0, 1);
715
716 /* restore saved state */
717 UWRITE4(sc, UHCI_FLBASEADDR, DMAADDR(&sc->sc_dma, 0));
718 UWRITE2(sc, UHCI_FRNUM, sc->sc_saved_frnum);
719 UWRITE1(sc, UHCI_SOF, sc->sc_saved_sof);
720
721 UHCICMD(sc, cmd | UHCI_CMD_FGR); /* force resume */
722 usb_delay_ms_locked(&sc->sc_bus, USB_RESUME_DELAY, &sc->sc_intr_lock);
723 UHCICMD(sc, cmd & ~UHCI_CMD_EGSM); /* back to normal */
724 UWRITE2(sc, UHCI_INTR, UHCI_INTR_TOCRCIE |
725 UHCI_INTR_RIE | UHCI_INTR_IOCE | UHCI_INTR_SPIE);
726 UHCICMD(sc, UHCI_CMD_MAXP);
727 uhci_run(sc, 1, 1); /* and start traffic again */
728 usb_delay_ms_locked(&sc->sc_bus, USB_RESUME_RECOVERY, &sc->sc_intr_lock);
729 sc->sc_bus.ub_usepolling--;
730 if (sc->sc_intr_xfer != NULL)
731 callout_reset(&sc->sc_poll_handle, sc->sc_ival, uhci_poll_hub,
732 sc->sc_intr_xfer);
733 #ifdef UHCI_DEBUG
734 if (uhcidebug >= 2)
735 uhci_dumpregs(sc);
736 #endif
737
738 sc->sc_suspend = PWR_RESUME;
739 mutex_spin_exit(&sc->sc_intr_lock);
740
741 return true;
742 }
743
744 bool
745 uhci_suspend(device_t dv, const pmf_qual_t *qual)
746 {
747 uhci_softc_t *sc = device_private(dv);
748 int cmd;
749
750 mutex_spin_enter(&sc->sc_intr_lock);
751
752 cmd = UREAD2(sc, UHCI_CMD);
753
754 #ifdef UHCI_DEBUG
755 if (uhcidebug >= 2)
756 uhci_dumpregs(sc);
757 #endif
758 if (sc->sc_intr_xfer != NULL)
759 callout_stop(&sc->sc_poll_handle);
760 sc->sc_suspend = PWR_SUSPEND;
761 sc->sc_bus.ub_usepolling++;
762
763 uhci_run(sc, 0, 1); /* stop the controller */
764 cmd &= ~UHCI_CMD_RS;
765
766 /* save some state if BIOS doesn't */
767 sc->sc_saved_frnum = UREAD2(sc, UHCI_FRNUM);
768 sc->sc_saved_sof = UREAD1(sc, UHCI_SOF);
769
770 UWRITE2(sc, UHCI_INTR, 0); /* disable intrs */
771
772 UHCICMD(sc, cmd | UHCI_CMD_EGSM); /* enter suspend */
773 usb_delay_ms_locked(&sc->sc_bus, USB_RESUME_WAIT, &sc->sc_intr_lock);
774 sc->sc_bus.ub_usepolling--;
775
776 mutex_spin_exit(&sc->sc_intr_lock);
777
778 return true;
779 }
780
781 #ifdef UHCI_DEBUG
782 Static void
783 uhci_dumpregs(uhci_softc_t *sc)
784 {
785 UHCIHIST_FUNC(); UHCIHIST_CALLED();
786 DPRINTF("cmd =%04x sts =%04x intr =%04x frnum =%04x",
787 UREAD2(sc, UHCI_CMD), UREAD2(sc, UHCI_STS),
788 UREAD2(sc, UHCI_INTR), UREAD2(sc, UHCI_FRNUM));
789 DPRINTF("sof =%04x portsc1=%04x portsc2=%04x flbase=%08x",
790 UREAD1(sc, UHCI_SOF), UREAD2(sc, UHCI_PORTSC1),
791 UREAD2(sc, UHCI_PORTSC2), UREAD4(sc, UHCI_FLBASEADDR));
792 }
793
794 void
795 uhci_dump_td(uhci_soft_td_t *p)
796 {
797 UHCIHIST_FUNC(); UHCIHIST_CALLED();
798
799 usb_syncmem(&p->dma, p->offs, sizeof(p->td),
800 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
801
802 DPRINTF("TD(%p) at 0x%08x", p, p->physaddr, 0, 0);
803 DPRINTF(" link=0x%08x status=0x%08x "
804 "token=0x%08x buffer=0x%08x",
805 le32toh(p->td.td_link),
806 le32toh(p->td.td_status),
807 le32toh(p->td.td_token),
808 le32toh(p->td.td_buffer));
809
810 DPRINTF("bitstuff=%d crcto =%d nak =%d babble =%d",
811 !!(le32toh(p->td.td_status) & UHCI_TD_BITSTUFF),
812 !!(le32toh(p->td.td_status) & UHCI_TD_CRCTO),
813 !!(le32toh(p->td.td_status) & UHCI_TD_NAK),
814 !!(le32toh(p->td.td_status) & UHCI_TD_BABBLE));
815 DPRINTF("dbuffer =%d stalled =%d active =%d ioc =%d",
816 !!(le32toh(p->td.td_status) & UHCI_TD_DBUFFER),
817 !!(le32toh(p->td.td_status) & UHCI_TD_STALLED),
818 !!(le32toh(p->td.td_status) & UHCI_TD_ACTIVE),
819 !!(le32toh(p->td.td_status) & UHCI_TD_IOC));
820 DPRINTF("ios =%d ls =%d spd =%d",
821 !!(le32toh(p->td.td_status) & UHCI_TD_IOS),
822 !!(le32toh(p->td.td_status) & UHCI_TD_LS),
823 !!(le32toh(p->td.td_status) & UHCI_TD_SPD), 0);
824 DPRINTF("errcnt =%d actlen =%d pid=%02x",
825 UHCI_TD_GET_ERRCNT(le32toh(p->td.td_status)),
826 UHCI_TD_GET_ACTLEN(le32toh(p->td.td_status)),
827 UHCI_TD_GET_PID(le32toh(p->td.td_token)), 0);
828 DPRINTF("addr=%d endpt=%d D=%d maxlen=%d,",
829 UHCI_TD_GET_DEVADDR(le32toh(p->td.td_token)),
830 UHCI_TD_GET_ENDPT(le32toh(p->td.td_token)),
831 UHCI_TD_GET_DT(le32toh(p->td.td_token)),
832 UHCI_TD_GET_MAXLEN(le32toh(p->td.td_token)));
833 }
834
835 void
836 uhci_dump_qh(uhci_soft_qh_t *sqh)
837 {
838 UHCIHIST_FUNC(); UHCIHIST_CALLED();
839
840 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
841 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
842
843 DPRINTF("QH(%p) at 0x%08x: hlink=%08x elink=%08x", sqh,
844 (int)sqh->physaddr, le32toh(sqh->qh.qh_hlink),
845 le32toh(sqh->qh.qh_elink));
846
847 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh), BUS_DMASYNC_PREREAD);
848 }
849
850
851 #if 1
852 void
853 uhci_dump(void)
854 {
855 uhci_dump_all(thesc);
856 }
857 #endif
858
859 void
860 uhci_dump_all(uhci_softc_t *sc)
861 {
862 uhci_dumpregs(sc);
863 /*printf("framelist[i].link = %08x\n", sc->sc_framelist[0].link);*/
864 uhci_dump_qhs(sc->sc_lctl_start);
865 }
866
867
868 void
869 uhci_dump_qhs(uhci_soft_qh_t *sqh)
870 {
871 UHCIHIST_FUNC(); UHCIHIST_CALLED();
872
873 uhci_dump_qh(sqh);
874
875 /*
876 * uhci_dump_qhs displays all the QHs and TDs from the given QH onwards
877 * Traverses sideways first, then down.
878 *
879 * QH1
880 * QH2
881 * No QH
882 * TD2.1
883 * TD2.2
884 * TD1.1
885 * etc.
886 *
887 * TD2.x being the TDs queued at QH2 and QH1 being referenced from QH1.
888 */
889
890 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
891 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
892 if (sqh->hlink != NULL && !(le32toh(sqh->qh.qh_hlink) & UHCI_PTR_T))
893 uhci_dump_qhs(sqh->hlink);
894 else
895 DPRINTF("No QH", 0, 0, 0, 0);
896 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh), BUS_DMASYNC_PREREAD);
897
898 if (sqh->elink != NULL && !(le32toh(sqh->qh.qh_elink) & UHCI_PTR_T))
899 uhci_dump_tds(sqh->elink);
900 else
901 DPRINTF("No QH", 0, 0, 0, 0);
902 }
903
904 void
905 uhci_dump_tds(uhci_soft_td_t *std)
906 {
907 uhci_soft_td_t *td;
908 int stop;
909
910 for (td = std; td != NULL; td = td->link.std) {
911 uhci_dump_td(td);
912
913 /*
914 * Check whether the link pointer in this TD marks
915 * the link pointer as end of queue. This avoids
916 * printing the free list in case the queue/TD has
917 * already been moved there (seatbelt).
918 */
919 usb_syncmem(&td->dma, td->offs + offsetof(uhci_td_t, td_link),
920 sizeof(td->td.td_link),
921 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
922 stop = (le32toh(td->td.td_link) & UHCI_PTR_T ||
923 le32toh(td->td.td_link) == 0);
924 usb_syncmem(&td->dma, td->offs + offsetof(uhci_td_t, td_link),
925 sizeof(td->td.td_link), BUS_DMASYNC_PREREAD);
926 if (stop)
927 break;
928 }
929 }
930
931 Static void
932 uhci_dump_ii(struct uhci_xfer *ux)
933 {
934 struct usbd_pipe *pipe;
935 usb_endpoint_descriptor_t *ed;
936 struct usbd_device *dev;
937
938 if (ux == NULL) {
939 printf("ux NULL\n");
940 return;
941 }
942 pipe = ux->ux_xfer.ux_pipe;
943 if (pipe == NULL) {
944 printf("ux %p: done=%d pipe=NULL\n", ux, ux->ux_isdone);
945 return;
946 }
947 if (pipe->up_endpoint == NULL) {
948 printf("ux %p: done=%d pipe=%p pipe->up_endpoint=NULL\n",
949 ux, ux->ux_isdone, pipe);
950 return;
951 }
952 if (pipe->up_dev == NULL) {
953 printf("ux %p: done=%d pipe=%p pipe->up_dev=NULL\n",
954 ux, ux->ux_isdone, pipe);
955 return;
956 }
957 ed = pipe->up_endpoint->ue_edesc;
958 dev = pipe->up_dev;
959 printf("ux %p: done=%d dev=%p vid=0x%04x pid=0x%04x addr=%d pipe=%p ep=0x%02x attr=0x%02x\n",
960 ux, ux->ux_isdone, dev,
961 UGETW(dev->ud_ddesc.idVendor),
962 UGETW(dev->ud_ddesc.idProduct),
963 dev->ud_addr, pipe,
964 ed->bEndpointAddress, ed->bmAttributes);
965 }
966
967 void uhci_dump_iis(struct uhci_softc *sc);
968 void
969 uhci_dump_iis(struct uhci_softc *sc)
970 {
971 struct uhci_xfer *ux;
972
973 printf("interrupt list:\n");
974 TAILQ_FOREACH(ux, &sc->sc_intrhead, ux_list)
975 uhci_dump_ii(ux);
976 }
977
978 void iidump(void);
979 void iidump(void) { uhci_dump_iis(thesc); }
980
981 #endif
982
983 /*
984 * This routine is executed periodically and simulates interrupts
985 * from the root controller interrupt pipe for port status change.
986 */
987 void
988 uhci_poll_hub(void *addr)
989 {
990 struct usbd_xfer *xfer = addr;
991 struct usbd_pipe *pipe = xfer->ux_pipe;
992 uhci_softc_t *sc;
993 u_char *p;
994
995 UHCIHIST_FUNC(); UHCIHIST_CALLED();
996
997 if (__predict_false(pipe->up_dev == NULL || pipe->up_dev->ud_bus == NULL))
998 return; /* device has detached */
999 sc = UHCI_PIPE2SC(pipe);
1000 callout_reset(&sc->sc_poll_handle, sc->sc_ival, uhci_poll_hub, xfer);
1001
1002 p = xfer->ux_buf;
1003 p[0] = 0;
1004 if (UREAD2(sc, UHCI_PORTSC1) & (UHCI_PORTSC_CSC|UHCI_PORTSC_OCIC))
1005 p[0] |= 1<<1;
1006 if (UREAD2(sc, UHCI_PORTSC2) & (UHCI_PORTSC_CSC|UHCI_PORTSC_OCIC))
1007 p[0] |= 1<<2;
1008 if (p[0] == 0)
1009 /* No change, try again in a while */
1010 return;
1011
1012 xfer->ux_actlen = 1;
1013 xfer->ux_status = USBD_NORMAL_COMPLETION;
1014 mutex_enter(&sc->sc_lock);
1015 usb_transfer_complete(xfer);
1016 mutex_exit(&sc->sc_lock);
1017 }
1018
1019 void
1020 uhci_root_intr_done(struct usbd_xfer *xfer)
1021 {
1022 }
1023
1024 /*
1025 * Let the last QH loop back to the high speed control transfer QH.
1026 * This is what intel calls "bandwidth reclamation" and improves
1027 * USB performance a lot for some devices.
1028 * If we are already looping, just count it.
1029 */
1030 void
1031 uhci_add_loop(uhci_softc_t *sc)
1032 {
1033 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1034
1035 #ifdef UHCI_DEBUG
1036 if (uhcinoloop)
1037 return;
1038 #endif
1039 if (++sc->sc_loops == 1) {
1040 DPRINTFN(5, "add loop", 0, 0, 0, 0);
1041 /* Note, we don't loop back the soft pointer. */
1042 sc->sc_last_qh->qh.qh_hlink =
1043 htole32(sc->sc_hctl_start->physaddr | UHCI_PTR_QH);
1044 usb_syncmem(&sc->sc_last_qh->dma,
1045 sc->sc_last_qh->offs + offsetof(uhci_qh_t, qh_hlink),
1046 sizeof(sc->sc_last_qh->qh.qh_hlink),
1047 BUS_DMASYNC_PREWRITE);
1048 }
1049 }
1050
1051 void
1052 uhci_rem_loop(uhci_softc_t *sc)
1053 {
1054 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1055
1056 #ifdef UHCI_DEBUG
1057 if (uhcinoloop)
1058 return;
1059 #endif
1060 if (--sc->sc_loops == 0) {
1061 DPRINTFN(5, "remove loop", 0, 0, 0, 0);
1062 sc->sc_last_qh->qh.qh_hlink = htole32(UHCI_PTR_T);
1063 usb_syncmem(&sc->sc_last_qh->dma,
1064 sc->sc_last_qh->offs + offsetof(uhci_qh_t, qh_hlink),
1065 sizeof(sc->sc_last_qh->qh.qh_hlink),
1066 BUS_DMASYNC_PREWRITE);
1067 }
1068 }
1069
1070 /* Add high speed control QH, called with lock held. */
1071 void
1072 uhci_add_hs_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1073 {
1074 uhci_soft_qh_t *eqh;
1075
1076 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1077
1078 KASSERT(mutex_owned(&sc->sc_lock));
1079
1080 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1081 eqh = sc->sc_hctl_end;
1082 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1083 sizeof(eqh->qh.qh_hlink),
1084 BUS_DMASYNC_POSTWRITE);
1085 sqh->hlink = eqh->hlink;
1086 sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1087 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
1088 BUS_DMASYNC_PREWRITE);
1089 eqh->hlink = sqh;
1090 eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1091 sc->sc_hctl_end = sqh;
1092 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1093 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
1094 #ifdef UHCI_CTL_LOOP
1095 uhci_add_loop(sc);
1096 #endif
1097 }
1098
1099 /* Remove high speed control QH, called with lock held. */
1100 void
1101 uhci_remove_hs_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1102 {
1103 uhci_soft_qh_t *pqh;
1104 uint32_t elink;
1105
1106 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
1107
1108 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1109 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1110 #ifdef UHCI_CTL_LOOP
1111 uhci_rem_loop(sc);
1112 #endif
1113 /*
1114 * The T bit should be set in the elink of the QH so that the HC
1115 * doesn't follow the pointer. This condition may fail if the
1116 * the transferred packet was short so that the QH still points
1117 * at the last used TD.
1118 * In this case we set the T bit and wait a little for the HC
1119 * to stop looking at the TD.
1120 * Note that if the TD chain is large enough, the controller
1121 * may still be looking at the chain at the end of this function.
1122 * uhci_free_std_chain() will make sure the controller stops
1123 * looking at it quickly, but until then we should not change
1124 * sqh->hlink.
1125 */
1126 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
1127 sizeof(sqh->qh.qh_elink),
1128 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1129 elink = le32toh(sqh->qh.qh_elink);
1130 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
1131 sizeof(sqh->qh.qh_elink), BUS_DMASYNC_PREREAD);
1132 if (!(elink & UHCI_PTR_T)) {
1133 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1134 usb_syncmem(&sqh->dma,
1135 sqh->offs + offsetof(uhci_qh_t, qh_elink),
1136 sizeof(sqh->qh.qh_elink),
1137 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
1138 delay(UHCI_QH_REMOVE_DELAY);
1139 }
1140
1141 pqh = uhci_find_prev_qh(sc->sc_hctl_start, sqh);
1142 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_hlink),
1143 sizeof(sqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
1144 pqh->hlink = sqh->hlink;
1145 pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1146 usb_syncmem(&pqh->dma, pqh->offs + offsetof(uhci_qh_t, qh_hlink),
1147 sizeof(pqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
1148 delay(UHCI_QH_REMOVE_DELAY);
1149 if (sc->sc_hctl_end == sqh)
1150 sc->sc_hctl_end = pqh;
1151 }
1152
1153 /* Add low speed control QH, called with lock held. */
1154 void
1155 uhci_add_ls_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1156 {
1157 uhci_soft_qh_t *eqh;
1158
1159 KASSERT(mutex_owned(&sc->sc_lock));
1160
1161 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1162 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1163
1164 eqh = sc->sc_lctl_end;
1165 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1166 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
1167 sqh->hlink = eqh->hlink;
1168 sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1169 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
1170 BUS_DMASYNC_PREWRITE);
1171 eqh->hlink = sqh;
1172 eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1173 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1174 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
1175 sc->sc_lctl_end = sqh;
1176 }
1177
1178 /* Remove low speed control QH, called with lock held. */
1179 void
1180 uhci_remove_ls_ctrl(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1181 {
1182 uhci_soft_qh_t *pqh;
1183 uint32_t elink;
1184
1185 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
1186
1187 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1188 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1189
1190 /* See comment in uhci_remove_hs_ctrl() */
1191 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
1192 sizeof(sqh->qh.qh_elink),
1193 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1194 elink = le32toh(sqh->qh.qh_elink);
1195 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
1196 sizeof(sqh->qh.qh_elink), BUS_DMASYNC_PREREAD);
1197 if (!(elink & UHCI_PTR_T)) {
1198 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1199 usb_syncmem(&sqh->dma,
1200 sqh->offs + offsetof(uhci_qh_t, qh_elink),
1201 sizeof(sqh->qh.qh_elink),
1202 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
1203 delay(UHCI_QH_REMOVE_DELAY);
1204 }
1205 pqh = uhci_find_prev_qh(sc->sc_lctl_start, sqh);
1206 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_hlink),
1207 sizeof(sqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
1208 pqh->hlink = sqh->hlink;
1209 pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1210 usb_syncmem(&pqh->dma, pqh->offs + offsetof(uhci_qh_t, qh_hlink),
1211 sizeof(pqh->qh.qh_hlink),
1212 BUS_DMASYNC_PREWRITE);
1213 delay(UHCI_QH_REMOVE_DELAY);
1214 if (sc->sc_lctl_end == sqh)
1215 sc->sc_lctl_end = pqh;
1216 }
1217
1218 /* Add bulk QH, called with lock held. */
1219 void
1220 uhci_add_bulk(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1221 {
1222 uhci_soft_qh_t *eqh;
1223
1224 KASSERT(mutex_owned(&sc->sc_lock));
1225
1226 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1227 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1228
1229 eqh = sc->sc_bulk_end;
1230 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1231 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
1232 sqh->hlink = eqh->hlink;
1233 sqh->qh.qh_hlink = eqh->qh.qh_hlink;
1234 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
1235 BUS_DMASYNC_PREWRITE);
1236 eqh->hlink = sqh;
1237 eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
1238 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
1239 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
1240 sc->sc_bulk_end = sqh;
1241 uhci_add_loop(sc);
1242 }
1243
1244 /* Remove bulk QH, called with lock held. */
1245 void
1246 uhci_remove_bulk(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1247 {
1248 uhci_soft_qh_t *pqh;
1249
1250 KASSERT(mutex_owned(&sc->sc_lock));
1251
1252 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1253 DPRINTFN(10, "sqh %p", sqh, 0, 0, 0);
1254
1255 uhci_rem_loop(sc);
1256 /* See comment in uhci_remove_hs_ctrl() */
1257 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
1258 sizeof(sqh->qh.qh_elink),
1259 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1260 if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
1261 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
1262 usb_syncmem(&sqh->dma,
1263 sqh->offs + offsetof(uhci_qh_t, qh_elink),
1264 sizeof(sqh->qh.qh_elink),
1265 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
1266 delay(UHCI_QH_REMOVE_DELAY);
1267 }
1268 pqh = uhci_find_prev_qh(sc->sc_bulk_start, sqh);
1269 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_hlink),
1270 sizeof(sqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
1271 pqh->hlink = sqh->hlink;
1272 pqh->qh.qh_hlink = sqh->qh.qh_hlink;
1273 usb_syncmem(&pqh->dma, pqh->offs + offsetof(uhci_qh_t, qh_hlink),
1274 sizeof(pqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
1275 delay(UHCI_QH_REMOVE_DELAY);
1276 if (sc->sc_bulk_end == sqh)
1277 sc->sc_bulk_end = pqh;
1278 }
1279
1280 Static int uhci_intr1(uhci_softc_t *);
1281
1282 int
1283 uhci_intr(void *arg)
1284 {
1285 uhci_softc_t *sc = arg;
1286 int ret = 0;
1287
1288 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1289
1290 mutex_spin_enter(&sc->sc_intr_lock);
1291
1292 if (sc->sc_dying || !device_has_power(sc->sc_dev))
1293 goto done;
1294
1295 if (sc->sc_bus.ub_usepolling || UREAD2(sc, UHCI_INTR) == 0) {
1296 DPRINTFN(16, "ignored interrupt while polling", 0, 0, 0, 0);
1297 goto done;
1298 }
1299
1300 ret = uhci_intr1(sc);
1301
1302 done:
1303 mutex_spin_exit(&sc->sc_intr_lock);
1304 return ret;
1305 }
1306
1307 int
1308 uhci_intr1(uhci_softc_t *sc)
1309 {
1310 int status;
1311 int ack;
1312
1313 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1314
1315 #ifdef UHCI_DEBUG
1316 if (uhcidebug >= 15) {
1317 DPRINTF("sc %p", sc, 0, 0, 0);
1318 uhci_dumpregs(sc);
1319 }
1320 #endif
1321
1322 KASSERT(mutex_owned(&sc->sc_intr_lock));
1323
1324 status = UREAD2(sc, UHCI_STS) & UHCI_STS_ALLINTRS;
1325 /* Check if the interrupt was for us. */
1326 if (status == 0)
1327 return 0;
1328
1329 if (sc->sc_suspend != PWR_RESUME) {
1330 #ifdef DIAGNOSTIC
1331 printf("%s: interrupt while not operating ignored\n",
1332 device_xname(sc->sc_dev));
1333 #endif
1334 UWRITE2(sc, UHCI_STS, status); /* acknowledge the ints */
1335 return 0;
1336 }
1337
1338 ack = 0;
1339 if (status & UHCI_STS_USBINT)
1340 ack |= UHCI_STS_USBINT;
1341 if (status & UHCI_STS_USBEI)
1342 ack |= UHCI_STS_USBEI;
1343 if (status & UHCI_STS_RD) {
1344 ack |= UHCI_STS_RD;
1345 #ifdef UHCI_DEBUG
1346 printf("%s: resume detect\n", device_xname(sc->sc_dev));
1347 #endif
1348 }
1349 if (status & UHCI_STS_HSE) {
1350 ack |= UHCI_STS_HSE;
1351 printf("%s: host system error\n", device_xname(sc->sc_dev));
1352 }
1353 if (status & UHCI_STS_HCPE) {
1354 ack |= UHCI_STS_HCPE;
1355 printf("%s: host controller process error\n",
1356 device_xname(sc->sc_dev));
1357 }
1358
1359 /* When HCHalted=1 and Run/Stop=0 , it is normal */
1360 if ((status & UHCI_STS_HCH) && (UREAD2(sc, UHCI_CMD) & UHCI_CMD_RS)) {
1361 /* no acknowledge needed */
1362 if (!sc->sc_dying) {
1363 printf("%s: host controller halted\n",
1364 device_xname(sc->sc_dev));
1365 #ifdef UHCI_DEBUG
1366 uhci_dump_all(sc);
1367 #endif
1368 }
1369 sc->sc_dying = 1;
1370 }
1371
1372 if (!ack)
1373 return 0; /* nothing to acknowledge */
1374 UWRITE2(sc, UHCI_STS, ack); /* acknowledge the ints */
1375
1376 usb_schedsoftintr(&sc->sc_bus);
1377
1378 DPRINTFN(15, "sc %p done", sc, 0, 0, 0);
1379
1380 return 1;
1381 }
1382
1383 void
1384 uhci_softintr(void *v)
1385 {
1386 struct usbd_bus *bus = v;
1387 uhci_softc_t *sc = UHCI_BUS2SC(bus);
1388 struct uhci_xfer *ux, *nextux;
1389 ux_completeq_t cq;
1390
1391 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1392 DPRINTF("sc %p", sc, 0, 0, 0);
1393
1394 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
1395
1396 TAILQ_INIT(&cq);
1397 /*
1398 * Interrupts on UHCI really suck. When the host controller
1399 * interrupts because a transfer is completed there is no
1400 * way of knowing which transfer it was. You can scan down
1401 * the TDs and QHs of the previous frame to limit the search,
1402 * but that assumes that the interrupt was not delayed by more
1403 * than 1 ms, which may not always be true (e.g. after debug
1404 * output on a slow console).
1405 * We scan all interrupt descriptors to see if any have
1406 * completed.
1407 */
1408 TAILQ_FOREACH_SAFE(ux, &sc->sc_intrhead, ux_list, nextux) {
1409 uhci_check_intr(sc, ux, &cq);
1410 }
1411
1412 /*
1413 * We abuse ux_list for the interrupt and complete lists and
1414 * interrupt transfers will get re-added here so use
1415 * the _SAFE version of TAILQ_FOREACH.
1416 */
1417 TAILQ_FOREACH_SAFE(ux, &cq, ux_list, nextux) {
1418 DPRINTF("ux %p", ux, 0, 0, 0);
1419 usb_transfer_complete(&ux->ux_xfer);
1420 }
1421 }
1422
1423 /* Check for an interrupt. */
1424 void
1425 uhci_check_intr(uhci_softc_t *sc, struct uhci_xfer *ux, ux_completeq_t *cqp)
1426 {
1427 uhci_soft_td_t *std, *fstd = NULL, *lstd = NULL;
1428 uint32_t status;
1429
1430 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1431 DPRINTFN(15, "ux %p", ux, 0, 0, 0);
1432
1433 KASSERT(ux != NULL);
1434
1435 struct usbd_xfer *xfer = &ux->ux_xfer;
1436 if (xfer->ux_status == USBD_CANCELLED ||
1437 xfer->ux_status == USBD_TIMEOUT) {
1438 DPRINTF("aborted xfer %p", xfer, 0, 0, 0);
1439 return;
1440 }
1441
1442 switch (ux->ux_type) {
1443 case UX_CTRL:
1444 fstd = ux->ux_setup;
1445 lstd = ux->ux_stat;
1446 break;
1447 case UX_BULK:
1448 case UX_INTR:
1449 case UX_ISOC:
1450 fstd = ux->ux_stdstart;
1451 lstd = ux->ux_stdend;
1452 break;
1453 default:
1454 KASSERT(false);
1455 break;
1456 }
1457 if (fstd == NULL)
1458 return;
1459
1460 KASSERT(lstd != NULL);
1461
1462 usb_syncmem(&lstd->dma,
1463 lstd->offs + offsetof(uhci_td_t, td_status),
1464 sizeof(lstd->td.td_status),
1465 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1466 status = le32toh(lstd->td.td_status);
1467 usb_syncmem(&lstd->dma,
1468 lstd->offs + offsetof(uhci_td_t, td_status),
1469 sizeof(lstd->td.td_status),
1470 BUS_DMASYNC_PREREAD);
1471
1472 /* If the last TD is not marked active we can complete */
1473 if (!(status & UHCI_TD_ACTIVE)) {
1474 done:
1475 DPRINTFN(12, "ux=%p done", ux, 0, 0, 0);
1476 uhci_idone(ux, cqp);
1477 return;
1478 }
1479
1480 /*
1481 * If the last TD is still active we need to check whether there
1482 * is an error somewhere in the middle, or whether there was a
1483 * short packet (SPD and not ACTIVE).
1484 */
1485 DPRINTFN(12, "active ux=%p", ux, 0, 0, 0);
1486 for (std = fstd; std != lstd; std = std->link.std) {
1487 usb_syncmem(&std->dma,
1488 std->offs + offsetof(uhci_td_t, td_status),
1489 sizeof(std->td.td_status),
1490 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1491 status = le32toh(std->td.td_status);
1492 usb_syncmem(&std->dma,
1493 std->offs + offsetof(uhci_td_t, td_status),
1494 sizeof(std->td.td_status), BUS_DMASYNC_PREREAD);
1495
1496 /* If there's an active TD the xfer isn't done. */
1497 if (status & UHCI_TD_ACTIVE) {
1498 DPRINTFN(12, "ux=%p std=%p still active",
1499 ux, std, 0, 0);
1500 return;
1501 }
1502
1503 /* Any kind of error makes the xfer done. */
1504 if (status & UHCI_TD_STALLED)
1505 goto done;
1506
1507 /*
1508 * If the data phase of a control transfer is short, we need
1509 * to complete the status stage
1510 */
1511
1512 if ((status & UHCI_TD_SPD) && ux->ux_type == UX_CTRL) {
1513 struct uhci_pipe *upipe =
1514 UHCI_PIPE2UPIPE(xfer->ux_pipe);
1515 uhci_soft_qh_t *sqh = upipe->ctrl.sqh;
1516 uhci_soft_td_t *stat = upipe->ctrl.stat;
1517
1518 DPRINTFN(12, "ux=%p std=%p control status"
1519 "phase needs completion", ux, ux->ux_stdstart, 0, 0);
1520
1521 sqh->qh.qh_elink =
1522 htole32(stat->physaddr | UHCI_PTR_TD);
1523 usb_syncmem(&sqh->dma, sqh->offs, sizeof(sqh->qh),
1524 BUS_DMASYNC_PREWRITE);
1525 break;
1526 }
1527
1528 /* We want short packets, and it is short: it's done */
1529 usb_syncmem(&std->dma,
1530 std->offs + offsetof(uhci_td_t, td_token),
1531 sizeof(std->td.td_token),
1532 BUS_DMASYNC_POSTWRITE);
1533
1534 if ((status & UHCI_TD_SPD) &&
1535 UHCI_TD_GET_ACTLEN(status) <
1536 UHCI_TD_GET_MAXLEN(le32toh(std->td.td_token))) {
1537 goto done;
1538 }
1539 }
1540 }
1541
1542 /* Called with USB lock held. */
1543 void
1544 uhci_idone(struct uhci_xfer *ux, ux_completeq_t *cqp)
1545 {
1546 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1547 struct usbd_xfer *xfer = &ux->ux_xfer;
1548 uhci_softc_t *sc __diagused = UHCI_XFER2SC(xfer);
1549 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
1550 uhci_soft_td_t *std;
1551 uint32_t status = 0, nstatus;
1552 bool polling = sc->sc_bus.ub_usepolling;
1553 int actlen;
1554
1555 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
1556
1557 DPRINTFN(12, "ux=%p", ux, 0, 0, 0);
1558
1559 /*
1560 * Make sure the timeout handler didn't run or ran to the end
1561 * and set the transfer status.
1562 */
1563 callout_halt(&xfer->ux_callout, polling ? NULL : &sc->sc_lock);
1564 if (xfer->ux_status == USBD_CANCELLED ||
1565 xfer->ux_status == USBD_TIMEOUT) {
1566 DPRINTF("aborted xfer=%p", xfer, 0, 0, 0);
1567 return;
1568 }
1569
1570 #ifdef DIAGNOSTIC
1571 #ifdef UHCI_DEBUG
1572 if (ux->ux_isdone) {
1573 DPRINTF("--- dump start ---", 0, 0, 0, 0);
1574 uhci_dump_ii(ux);
1575 DPRINTF("--- dump end ---", 0, 0, 0, 0);
1576 }
1577 #endif
1578 KASSERT(!ux->ux_isdone);
1579 KASSERTMSG(!ux->ux_isdone, "xfer %p type %d status %d", xfer,
1580 ux->ux_type, xfer->ux_status);
1581 ux->ux_isdone = true;
1582 #endif
1583
1584 if (xfer->ux_nframes != 0) {
1585 /* Isoc transfer, do things differently. */
1586 uhci_soft_td_t **stds = upipe->isoc.stds;
1587 int i, n, nframes, len;
1588
1589 DPRINTFN(5, "ux=%p isoc ready", ux, 0, 0, 0);
1590
1591 nframes = xfer->ux_nframes;
1592 actlen = 0;
1593 n = ux->ux_curframe;
1594 for (i = 0; i < nframes; i++) {
1595 std = stds[n];
1596 #ifdef UHCI_DEBUG
1597 if (uhcidebug >= 5) {
1598 DPRINTF("isoc TD %d", i, 0, 0, 0);
1599 DPRINTF("--- dump start ---", 0, 0, 0, 0);
1600 uhci_dump_td(std);
1601 DPRINTF("--- dump end ---", 0, 0, 0, 0);
1602 }
1603 #endif
1604 if (++n >= UHCI_VFRAMELIST_COUNT)
1605 n = 0;
1606 usb_syncmem(&std->dma,
1607 std->offs + offsetof(uhci_td_t, td_status),
1608 sizeof(std->td.td_status),
1609 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1610 status = le32toh(std->td.td_status);
1611 len = UHCI_TD_GET_ACTLEN(status);
1612 xfer->ux_frlengths[i] = len;
1613 actlen += len;
1614 }
1615 upipe->isoc.inuse -= nframes;
1616 xfer->ux_actlen = actlen;
1617 xfer->ux_status = USBD_NORMAL_COMPLETION;
1618 goto end;
1619 }
1620
1621 #ifdef UHCI_DEBUG
1622 DPRINTFN(10, "ux=%p, xfer=%p, pipe=%p ready", ux, xfer, upipe, 0);
1623 if (uhcidebug >= 10) {
1624 DPRINTF("--- dump start ---", 0, 0, 0, 0);
1625 uhci_dump_tds(ux->ux_stdstart);
1626 DPRINTF("--- dump end ---", 0, 0, 0, 0);
1627 }
1628 #endif
1629
1630 /* The transfer is done, compute actual length and status. */
1631 actlen = 0;
1632 for (std = ux->ux_stdstart; std != NULL; std = std->link.std) {
1633 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
1634 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1635 nstatus = le32toh(std->td.td_status);
1636 if (nstatus & UHCI_TD_ACTIVE)
1637 break;
1638
1639 status = nstatus;
1640 if (UHCI_TD_GET_PID(le32toh(std->td.td_token)) !=
1641 UHCI_TD_PID_SETUP)
1642 actlen += UHCI_TD_GET_ACTLEN(status);
1643 else {
1644 /*
1645 * UHCI will report CRCTO in addition to a STALL or NAK
1646 * for a SETUP transaction. See section 3.2.2, "TD
1647 * CONTROL AND STATUS".
1648 */
1649 if (status & (UHCI_TD_STALLED | UHCI_TD_NAK))
1650 status &= ~UHCI_TD_CRCTO;
1651 }
1652 }
1653 /* If there are left over TDs we need to update the toggle. */
1654 if (std != NULL)
1655 upipe->nexttoggle = UHCI_TD_GET_DT(le32toh(std->td.td_token));
1656
1657 status &= UHCI_TD_ERROR;
1658 DPRINTFN(10, "actlen=%d, status=0x%x", actlen, status, 0, 0);
1659 xfer->ux_actlen = actlen;
1660 if (status != 0) {
1661
1662 DPRINTFN((status == UHCI_TD_STALLED) * 10,
1663 "error, addr=%d, endpt=0x%02x",
1664 xfer->ux_pipe->up_dev->ud_addr,
1665 xfer->ux_pipe->up_endpoint->ue_edesc->bEndpointAddress,
1666 0, 0);
1667 DPRINTFN((status == UHCI_TD_STALLED) * 10,
1668 "bitstuff=%d crcto =%d nak =%d babble =%d",
1669 !!(status & UHCI_TD_BITSTUFF),
1670 !!(status & UHCI_TD_CRCTO),
1671 !!(status & UHCI_TD_NAK),
1672 !!(status & UHCI_TD_BABBLE));
1673 DPRINTFN((status == UHCI_TD_STALLED) * 10,
1674 "dbuffer =%d stalled =%d active =%d",
1675 !!(status & UHCI_TD_DBUFFER),
1676 !!(status & UHCI_TD_STALLED),
1677 !!(status & UHCI_TD_ACTIVE),
1678 0);
1679
1680 if (status == UHCI_TD_STALLED)
1681 xfer->ux_status = USBD_STALLED;
1682 else
1683 xfer->ux_status = USBD_IOERROR; /* more info XXX */
1684 } else {
1685 xfer->ux_status = USBD_NORMAL_COMPLETION;
1686 }
1687
1688 end:
1689 uhci_del_intr_list(sc, ux);
1690 if (cqp)
1691 TAILQ_INSERT_TAIL(cqp, ux, ux_list);
1692
1693 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
1694 DPRINTFN(12, "ux=%p done", ux, 0, 0, 0);
1695 }
1696
1697 /*
1698 * Called when a request does not complete.
1699 */
1700 void
1701 uhci_timeout(void *addr)
1702 {
1703 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1704 struct usbd_xfer *xfer = addr;
1705 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
1706 bool timeout = false;
1707
1708 DPRINTF("xfer %p", xfer, 0, 0, 0);
1709
1710 mutex_enter(&sc->sc_lock);
1711 if (sc->sc_dying) {
1712 mutex_exit(&sc->sc_lock);
1713 return;
1714 }
1715 if (xfer->ux_status != USBD_CANCELLED) {
1716 xfer->ux_status = USBD_TIMEOUT;
1717 timeout = true;
1718 }
1719 mutex_exit(&sc->sc_lock);
1720
1721 if (timeout) {
1722 struct usbd_device *dev = xfer->ux_pipe->up_dev;
1723
1724 /* Execute the abort in a process context. */
1725 usb_init_task(&xfer->ux_aborttask, uhci_timeout_task, xfer,
1726 USB_TASKQ_MPSAFE);
1727 usb_add_task(dev, &xfer->ux_aborttask, USB_TASKQ_HC);
1728 }
1729 }
1730
1731 void
1732 uhci_timeout_task(void *addr)
1733 {
1734 struct usbd_xfer *xfer = addr;
1735 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
1736
1737 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1738
1739 DPRINTF("xfer=%p", xfer, 0, 0, 0);
1740
1741 mutex_enter(&sc->sc_lock);
1742 KASSERT(xfer->ux_status == USBD_TIMEOUT);
1743 uhci_abort_xfer(xfer, USBD_TIMEOUT);
1744 mutex_exit(&sc->sc_lock);
1745 }
1746
1747 void
1748 uhci_poll(struct usbd_bus *bus)
1749 {
1750 uhci_softc_t *sc = UHCI_BUS2SC(bus);
1751
1752 if (UREAD2(sc, UHCI_STS) & UHCI_STS_USBINT) {
1753 mutex_spin_enter(&sc->sc_intr_lock);
1754 uhci_intr1(sc);
1755 mutex_spin_exit(&sc->sc_intr_lock);
1756 }
1757 }
1758
1759 void
1760 uhci_reset(uhci_softc_t *sc)
1761 {
1762 int n;
1763
1764 UHCICMD(sc, UHCI_CMD_HCRESET);
1765 /* The reset bit goes low when the controller is done. */
1766 for (n = 0; n < UHCI_RESET_TIMEOUT &&
1767 (UREAD2(sc, UHCI_CMD) & UHCI_CMD_HCRESET); n++)
1768 usb_delay_ms(&sc->sc_bus, 1);
1769 if (n >= UHCI_RESET_TIMEOUT)
1770 printf("%s: controller did not reset\n",
1771 device_xname(sc->sc_dev));
1772 }
1773
1774 usbd_status
1775 uhci_run(uhci_softc_t *sc, int run, int locked)
1776 {
1777 int n, running;
1778 uint16_t cmd;
1779
1780 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1781
1782 run = run != 0;
1783 if (!locked)
1784 mutex_spin_enter(&sc->sc_intr_lock);
1785
1786 DPRINTF("setting run=%d", run, 0, 0, 0);
1787 cmd = UREAD2(sc, UHCI_CMD);
1788 if (run)
1789 cmd |= UHCI_CMD_RS;
1790 else
1791 cmd &= ~UHCI_CMD_RS;
1792 UHCICMD(sc, cmd);
1793 for (n = 0; n < 10; n++) {
1794 running = !(UREAD2(sc, UHCI_STS) & UHCI_STS_HCH);
1795 /* return when we've entered the state we want */
1796 if (run == running) {
1797 if (!locked)
1798 mutex_spin_exit(&sc->sc_intr_lock);
1799 DPRINTF("done cmd=0x%x sts=0x%x",
1800 UREAD2(sc, UHCI_CMD), UREAD2(sc, UHCI_STS), 0, 0);
1801 return USBD_NORMAL_COMPLETION;
1802 }
1803 usb_delay_ms_locked(&sc->sc_bus, 1, &sc->sc_intr_lock);
1804 }
1805 if (!locked)
1806 mutex_spin_exit(&sc->sc_intr_lock);
1807 printf("%s: cannot %s\n", device_xname(sc->sc_dev),
1808 run ? "start" : "stop");
1809 return USBD_IOERROR;
1810 }
1811
1812 /*
1813 * Memory management routines.
1814 * uhci_alloc_std allocates TDs
1815 * uhci_alloc_sqh allocates QHs
1816 * These two routines do their own free list management,
1817 * partly for speed, partly because allocating DMAable memory
1818 * has page size granularity so much memory would be wasted if
1819 * only one TD/QH (32 bytes) was placed in each allocated chunk.
1820 */
1821
1822 uhci_soft_td_t *
1823 uhci_alloc_std(uhci_softc_t *sc)
1824 {
1825 uhci_soft_td_t *std;
1826 usbd_status err;
1827 int i, offs;
1828 usb_dma_t dma;
1829
1830 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1831
1832 mutex_enter(&sc->sc_lock);
1833 if (sc->sc_freetds == NULL) {
1834 DPRINTFN(2, "allocating chunk", 0, 0, 0, 0);
1835 mutex_exit(&sc->sc_lock);
1836
1837 err = usb_allocmem(&sc->sc_bus, UHCI_STD_SIZE * UHCI_STD_CHUNK,
1838 UHCI_TD_ALIGN, &dma);
1839 if (err)
1840 return NULL;
1841
1842 mutex_enter(&sc->sc_lock);
1843 for (i = 0; i < UHCI_STD_CHUNK; i++) {
1844 offs = i * UHCI_STD_SIZE;
1845 std = KERNADDR(&dma, offs);
1846 std->physaddr = DMAADDR(&dma, offs);
1847 std->dma = dma;
1848 std->offs = offs;
1849 std->link.std = sc->sc_freetds;
1850 sc->sc_freetds = std;
1851 }
1852 }
1853 std = sc->sc_freetds;
1854 sc->sc_freetds = std->link.std;
1855 mutex_exit(&sc->sc_lock);
1856
1857 memset(&std->td, 0, sizeof(uhci_td_t));
1858
1859 return std;
1860 }
1861
1862 #define TD_IS_FREE 0x12345678
1863
1864 void
1865 uhci_free_std_locked(uhci_softc_t *sc, uhci_soft_td_t *std)
1866 {
1867 KASSERT(mutex_owned(&sc->sc_lock));
1868
1869 #ifdef DIAGNOSTIC
1870 if (le32toh(std->td.td_token) == TD_IS_FREE) {
1871 printf("%s: freeing free TD %p\n", __func__, std);
1872 return;
1873 }
1874 std->td.td_token = htole32(TD_IS_FREE);
1875 #endif
1876
1877 std->link.std = sc->sc_freetds;
1878 sc->sc_freetds = std;
1879 }
1880
1881 void
1882 uhci_free_std(uhci_softc_t *sc, uhci_soft_td_t *std)
1883 {
1884 mutex_enter(&sc->sc_lock);
1885 uhci_free_std_locked(sc, std);
1886 mutex_exit(&sc->sc_lock);
1887 }
1888
1889 uhci_soft_qh_t *
1890 uhci_alloc_sqh(uhci_softc_t *sc)
1891 {
1892 uhci_soft_qh_t *sqh;
1893 usbd_status err;
1894 int i, offs;
1895 usb_dma_t dma;
1896
1897 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1898
1899 mutex_enter(&sc->sc_lock);
1900 if (sc->sc_freeqhs == NULL) {
1901 DPRINTFN(2, "allocating chunk", 0, 0, 0, 0);
1902 mutex_exit(&sc->sc_lock);
1903
1904 err = usb_allocmem(&sc->sc_bus, UHCI_SQH_SIZE * UHCI_SQH_CHUNK,
1905 UHCI_QH_ALIGN, &dma);
1906 if (err)
1907 return NULL;
1908
1909 mutex_enter(&sc->sc_lock);
1910 for (i = 0; i < UHCI_SQH_CHUNK; i++) {
1911 offs = i * UHCI_SQH_SIZE;
1912 sqh = KERNADDR(&dma, offs);
1913 sqh->physaddr = DMAADDR(&dma, offs);
1914 sqh->dma = dma;
1915 sqh->offs = offs;
1916 sqh->hlink = sc->sc_freeqhs;
1917 sc->sc_freeqhs = sqh;
1918 }
1919 }
1920 sqh = sc->sc_freeqhs;
1921 sc->sc_freeqhs = sqh->hlink;
1922 mutex_exit(&sc->sc_lock);
1923
1924 memset(&sqh->qh, 0, sizeof(uhci_qh_t));
1925
1926 return sqh;
1927 }
1928
1929 void
1930 uhci_free_sqh(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
1931 {
1932 KASSERT(mutex_owned(&sc->sc_lock));
1933
1934 sqh->hlink = sc->sc_freeqhs;
1935 sc->sc_freeqhs = sqh;
1936 }
1937
1938 #if 0
1939 void
1940 uhci_free_std_chain(uhci_softc_t *sc, uhci_soft_td_t *std,
1941 uhci_soft_td_t *stdend)
1942 {
1943 uhci_soft_td_t *p;
1944 uint32_t td_link;
1945
1946 /*
1947 * to avoid race condition with the controller which may be looking
1948 * at this chain, we need to first invalidate all links, and
1949 * then wait for the controller to move to another queue
1950 */
1951 for (p = std; p != stdend; p = p->link.std) {
1952 usb_syncmem(&p->dma,
1953 p->offs + offsetof(uhci_td_t, td_link),
1954 sizeof(p->td.td_link),
1955 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
1956 td_link = le32toh(p->td.td_link);
1957 usb_syncmem(&p->dma,
1958 p->offs + offsetof(uhci_td_t, td_link),
1959 sizeof(p->td.td_link),
1960 BUS_DMASYNC_PREREAD);
1961 if ((td_link & UHCI_PTR_T) == 0) {
1962 p->td.td_link = htole32(UHCI_PTR_T);
1963 usb_syncmem(&p->dma,
1964 p->offs + offsetof(uhci_td_t, td_link),
1965 sizeof(p->td.td_link),
1966 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
1967 }
1968 }
1969 delay(UHCI_QH_REMOVE_DELAY);
1970
1971 for (; std != stdend; std = p) {
1972 p = std->link.std;
1973 uhci_free_std(sc, std);
1974 }
1975 }
1976 #endif
1977
1978 int
1979 uhci_alloc_std_chain(uhci_softc_t *sc, struct usbd_xfer *xfer, int len,
1980 int rd, uhci_soft_td_t **sp)
1981 {
1982 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
1983 uint16_t flags = xfer->ux_flags;
1984 uhci_soft_td_t *p;
1985
1986 UHCIHIST_FUNC(); UHCIHIST_CALLED();
1987
1988 DPRINTFN(8, "xfer=%p pipe=%p", xfer, xfer->ux_pipe, 0, 0);
1989
1990 ASSERT_SLEEPABLE();
1991 KASSERT(sp);
1992
1993 int maxp = UGETW(xfer->ux_pipe->up_endpoint->ue_edesc->wMaxPacketSize);
1994 if (maxp == 0) {
1995 printf("%s: maxp=0\n", __func__);
1996 return EINVAL;
1997 }
1998 size_t ntd = (len + maxp - 1) / maxp;
1999 if (!rd && (flags & USBD_FORCE_SHORT_XFER)) {
2000 ntd++;
2001 }
2002 DPRINTFN(10, "maxp=%d ntd=%d", maxp, ntd, 0, 0);
2003
2004 uxfer->ux_stds = NULL;
2005 uxfer->ux_nstd = ntd;
2006 p = NULL;
2007 if (ntd == 0) {
2008 *sp = NULL;
2009 DPRINTF("ntd=0", 0, 0, 0, 0);
2010 return 0;
2011 }
2012 uxfer->ux_stds = kmem_alloc(sizeof(uhci_soft_td_t *) * ntd,
2013 KM_SLEEP);
2014
2015 ntd--;
2016 for (int i = ntd; i >= 0; i--) {
2017 p = uhci_alloc_std(sc);
2018 if (p == NULL) {
2019 uhci_free_stds(sc, uxfer);
2020 kmem_free(uxfer->ux_stds,
2021 sizeof(uhci_soft_td_t *) * ntd);
2022 return ENOMEM;
2023 }
2024 uxfer->ux_stds[i] = p;
2025 }
2026
2027 *sp = uxfer->ux_stds[0];
2028
2029 return 0;
2030 }
2031
2032 Static void
2033 uhci_free_stds(uhci_softc_t *sc, struct uhci_xfer *ux)
2034 {
2035 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2036
2037 DPRINTFN(8, "ux=%p", ux, 0, 0, 0);
2038
2039 mutex_enter(&sc->sc_lock);
2040 for (size_t i = 0; i < ux->ux_nstd; i++) {
2041 uhci_soft_td_t *std = ux->ux_stds[i];
2042 #ifdef DIAGNOSTIC
2043 if (le32toh(std->td.td_token) == TD_IS_FREE) {
2044 printf("%s: freeing free TD %p\n", __func__, std);
2045 return;
2046 }
2047 std->td.td_token = htole32(TD_IS_FREE);
2048 #endif
2049 ux->ux_stds[i]->link.std = sc->sc_freetds;
2050 sc->sc_freetds = std;
2051 }
2052 mutex_exit(&sc->sc_lock);
2053 }
2054
2055
2056 Static void
2057 uhci_reset_std_chain(uhci_softc_t *sc, struct usbd_xfer *xfer,
2058 int length, int isread, int *toggle, uhci_soft_td_t **lstd)
2059 {
2060 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
2061 struct usbd_pipe *pipe = xfer->ux_pipe;
2062 usb_dma_t *dma = &xfer->ux_dmabuf;
2063 uint16_t flags = xfer->ux_flags;
2064 uhci_soft_td_t *std, *prev;
2065 int len = length;
2066 int tog = *toggle;
2067 int maxp;
2068 uint32_t status;
2069 size_t i;
2070
2071 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2072 DPRINTFN(8, "xfer=%p len %d isread %d toggle %d", xfer,
2073 len, isread, *toggle);
2074
2075 KASSERT(len != 0 || (!isread && (flags & USBD_FORCE_SHORT_XFER)));
2076
2077 maxp = UGETW(pipe->up_endpoint->ue_edesc->wMaxPacketSize);
2078 KASSERT(maxp != 0);
2079
2080 int addr = xfer->ux_pipe->up_dev->ud_addr;
2081 int endpt = xfer->ux_pipe->up_endpoint->ue_edesc->bEndpointAddress;
2082
2083 status = UHCI_TD_ZERO_ACTLEN(UHCI_TD_SET_ERRCNT(3) | UHCI_TD_ACTIVE);
2084 if (pipe->up_dev->ud_speed == USB_SPEED_LOW)
2085 status |= UHCI_TD_LS;
2086 if (flags & USBD_SHORT_XFER_OK)
2087 status |= UHCI_TD_SPD;
2088 usb_syncmem(dma, 0, len,
2089 isread ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
2090 std = prev = NULL;
2091 for (i = 0; len != 0 && i < uxfer->ux_nstd; i++, prev = std) {
2092 int l = len;
2093 std = uxfer->ux_stds[i];
2094 if (l > maxp)
2095 l = maxp;
2096
2097 if (prev) {
2098 prev->link.std = std;
2099 prev->td.td_link = htole32(
2100 std->physaddr | UHCI_PTR_VF | UHCI_PTR_TD
2101 );
2102 usb_syncmem(&prev->dma, prev->offs, sizeof(prev->td),
2103 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2104 }
2105
2106 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
2107 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
2108
2109 std->td.td_link = htole32(UHCI_PTR_T | UHCI_PTR_VF | UHCI_PTR_TD);
2110 std->td.td_status = htole32(status);
2111 std->td.td_token = htole32(
2112 UHCI_TD_SET_ENDPT(UE_GET_ADDR(endpt)) |
2113 UHCI_TD_SET_DEVADDR(addr) |
2114 UHCI_TD_SET_PID(isread ? UHCI_TD_PID_IN : UHCI_TD_PID_OUT) |
2115 UHCI_TD_SET_DT(tog) |
2116 UHCI_TD_SET_MAXLEN(l)
2117 );
2118 std->td.td_buffer = htole32(DMAADDR(dma, i * maxp));
2119
2120 std->link.std = NULL;
2121
2122 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
2123 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2124 tog ^= 1;
2125
2126 len -= l;
2127 }
2128 KASSERTMSG(len == 0, "xfer %p alen %d len %d mps %d ux_nqtd %zu i %zu",
2129 xfer, length, len, maxp, uxfer->ux_nstd, i);
2130
2131 if (!isread &&
2132 (flags & USBD_FORCE_SHORT_XFER) &&
2133 length % maxp == 0) {
2134 /* Force a 0 length transfer at the end. */
2135 KASSERTMSG(i < uxfer->ux_nstd, "i=%zu nstd=%zu", i,
2136 uxfer->ux_nstd);
2137 std = uxfer->ux_stds[i++];
2138
2139 std->td.td_link = htole32(UHCI_PTR_T | UHCI_PTR_VF | UHCI_PTR_TD);
2140 std->td.td_status = htole32(status);
2141 std->td.td_token = htole32(
2142 UHCI_TD_SET_ENDPT(UE_GET_ADDR(endpt)) |
2143 UHCI_TD_SET_DEVADDR(addr) |
2144 UHCI_TD_SET_PID(UHCI_TD_PID_OUT) |
2145 UHCI_TD_SET_DT(tog) |
2146 UHCI_TD_SET_MAXLEN(0)
2147 );
2148 std->td.td_buffer = 0;
2149 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
2150 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2151
2152 std->link.std = NULL;
2153 if (prev) {
2154 prev->link.std = std;
2155 prev->td.td_link = htole32(
2156 std->physaddr | UHCI_PTR_VF | UHCI_PTR_TD
2157 );
2158 usb_syncmem(&prev->dma, prev->offs, sizeof(prev->td),
2159 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2160 }
2161 tog ^= 1;
2162 }
2163 *lstd = std;
2164 *toggle = tog;
2165 }
2166
2167 void
2168 uhci_device_clear_toggle(struct usbd_pipe *pipe)
2169 {
2170 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
2171 upipe->nexttoggle = 0;
2172 }
2173
2174 void
2175 uhci_noop(struct usbd_pipe *pipe)
2176 {
2177 }
2178
2179 int
2180 uhci_device_bulk_init(struct usbd_xfer *xfer)
2181 {
2182 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2183 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
2184 usb_endpoint_descriptor_t *ed = xfer->ux_pipe->up_endpoint->ue_edesc;
2185 int endpt = ed->bEndpointAddress;
2186 int isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2187 int len = xfer->ux_bufsize;
2188 int err = 0;
2189
2190
2191 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2192 DPRINTFN(3, "xfer=%p len=%d flags=%d", xfer, len, xfer->ux_flags, 0);
2193
2194 if (sc->sc_dying)
2195 return USBD_IOERROR;
2196
2197 KASSERT(!(xfer->ux_rqflags & URQ_REQUEST));
2198
2199 uxfer->ux_type = UX_BULK;
2200 err = uhci_alloc_std_chain(sc, xfer, len, isread, &uxfer->ux_stdstart);
2201 if (err)
2202 return err;
2203
2204 #ifdef UHCI_DEBUG
2205 if (uhcidebug >= 10) {
2206 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2207 uhci_dump_tds(uxfer->ux_stdstart);
2208 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2209 }
2210 #endif
2211
2212 return 0;
2213 }
2214
2215 Static void
2216 uhci_device_bulk_fini(struct usbd_xfer *xfer)
2217 {
2218 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2219 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2220
2221 KASSERT(ux->ux_type == UX_BULK);
2222
2223 uhci_free_stds(sc, ux);
2224 if (ux->ux_nstd)
2225 kmem_free(ux->ux_stds, sizeof(uhci_soft_td_t *) * ux->ux_nstd);
2226 }
2227
2228 usbd_status
2229 uhci_device_bulk_transfer(struct usbd_xfer *xfer)
2230 {
2231 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2232 usbd_status err;
2233
2234 /* Insert last in queue. */
2235 mutex_enter(&sc->sc_lock);
2236 err = usb_insert_transfer(xfer);
2237 mutex_exit(&sc->sc_lock);
2238 if (err)
2239 return err;
2240
2241 /*
2242 * Pipe isn't running (otherwise err would be USBD_INPROG),
2243 * so start it first.
2244 */
2245 return uhci_device_bulk_start(SIMPLEQ_FIRST(&xfer->ux_pipe->up_queue));
2246 }
2247
2248 usbd_status
2249 uhci_device_bulk_start(struct usbd_xfer *xfer)
2250 {
2251 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2252 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2253 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2254 uhci_soft_td_t *data, *dataend;
2255 uhci_soft_qh_t *sqh;
2256 int len;
2257 int endpt;
2258 int isread;
2259
2260 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2261 DPRINTFN(3, "xfer=%p len=%d flags=%d", xfer, xfer->ux_length,
2262 xfer->ux_flags, 0);
2263
2264 if (sc->sc_dying)
2265 return USBD_IOERROR;
2266
2267 KASSERT(!(xfer->ux_rqflags & URQ_REQUEST));
2268 KASSERT(xfer->ux_length <= xfer->ux_bufsize);
2269
2270 len = xfer->ux_length;
2271 endpt = upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress;
2272 isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2273 sqh = upipe->bulk.sqh;
2274
2275 /* Take lock here to protect nexttoggle */
2276 mutex_enter(&sc->sc_lock);
2277
2278 uhci_reset_std_chain(sc, xfer, len, isread, &upipe->nexttoggle,
2279 &dataend);
2280
2281 data = ux->ux_stdstart;
2282 ux->ux_stdend = dataend;
2283 dataend->td.td_status |= htole32(UHCI_TD_IOC);
2284 usb_syncmem(&dataend->dma,
2285 dataend->offs + offsetof(uhci_td_t, td_status),
2286 sizeof(dataend->td.td_status),
2287 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2288
2289 #ifdef UHCI_DEBUG
2290 if (uhcidebug >= 10) {
2291 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2292 DPRINTFN(10, "before transfer", 0, 0, 0, 0);
2293 uhci_dump_tds(data);
2294 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2295 }
2296 #endif
2297
2298 KASSERT(ux->ux_isdone);
2299 #ifdef DIAGNOSTIC
2300 ux->ux_isdone = false;
2301 #endif
2302
2303 sqh->elink = data;
2304 sqh->qh.qh_elink = htole32(data->physaddr | UHCI_PTR_TD);
2305 /* uhci_add_bulk() will do usb_syncmem(sqh) */
2306
2307 uhci_add_bulk(sc, sqh);
2308 uhci_add_intr_list(sc, ux);
2309
2310 if (xfer->ux_timeout && !sc->sc_bus.ub_usepolling) {
2311 callout_reset(&xfer->ux_callout, mstohz(xfer->ux_timeout),
2312 uhci_timeout, xfer);
2313 }
2314 xfer->ux_status = USBD_IN_PROGRESS;
2315 mutex_exit(&sc->sc_lock);
2316
2317 return USBD_IN_PROGRESS;
2318 }
2319
2320 /* Abort a device bulk request. */
2321 void
2322 uhci_device_bulk_abort(struct usbd_xfer *xfer)
2323 {
2324 uhci_softc_t *sc __diagused = UHCI_XFER2SC(xfer);
2325
2326 KASSERT(mutex_owned(&sc->sc_lock));
2327
2328 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2329
2330 uhci_abort_xfer(xfer, USBD_CANCELLED);
2331 }
2332
2333 /*
2334 * Cancel or timeout a device request. We have two cases to deal with
2335 *
2336 * 1) A driver wants to stop scheduled or inflight transfers
2337 * 2) A transfer has timed out
2338 *
2339 * It's impossible to guarantee that the requested transfer will not
2340 * have (partially) happened since the hardware runs concurrently.
2341 *
2342 * Transfer state is protected by the bus lock and we set the transfer status
2343 * as soon as either of the above happens (with bus lock held).
2344 *
2345 * To allow the hardware time to notice we simply wait.
2346 */
2347 void
2348 uhci_abort_xfer(struct usbd_xfer *xfer, usbd_status status)
2349 {
2350 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2351 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2352 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2353 uhci_soft_td_t *std;
2354 int wake;
2355
2356 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2357 DPRINTFN(1,"xfer=%p, status=%d", xfer, status, 0, 0);
2358
2359 KASSERT(mutex_owned(&sc->sc_lock));
2360 ASSERT_SLEEPABLE();
2361
2362 if (sc->sc_dying) {
2363 /* If we're dying, just do the software part. */
2364 xfer->ux_status = status; /* make software ignore it */
2365 callout_stop(&xfer->ux_callout);
2366 usb_transfer_complete(xfer);
2367 return;
2368 }
2369
2370 /*
2371 * If an abort is already in progress then just wait for it to
2372 * complete and return.
2373 */
2374 if (xfer->ux_hcflags & UXFER_ABORTING) {
2375 DPRINTFN(2, "already aborting", 0, 0, 0, 0);
2376 #ifdef DIAGNOSTIC
2377 if (status == USBD_TIMEOUT)
2378 printf("%s: TIMEOUT while aborting\n", __func__);
2379 #endif
2380 /* Override the status which might be USBD_TIMEOUT. */
2381 xfer->ux_status = status;
2382 DPRINTFN(2, "waiting for abort to finish", 0, 0, 0, 0);
2383 xfer->ux_hcflags |= UXFER_ABORTWAIT;
2384 while (xfer->ux_hcflags & UXFER_ABORTING)
2385 cv_wait(&xfer->ux_hccv, &sc->sc_lock);
2386 goto done;
2387 }
2388 xfer->ux_hcflags |= UXFER_ABORTING;
2389
2390 /*
2391 * Step 1: When cancelling a transfer make sure the timeout handler
2392 * didn't run or ran to the end and saw the USBD_CANCELLED status.
2393 * Otherwise we must have got here via a timeout.
2394 */
2395 if (status == USBD_CANCELLED) {
2396 xfer->ux_status = status;
2397 callout_halt(&xfer->ux_callout, &sc->sc_lock);
2398 } else {
2399 KASSERT(xfer->ux_status == USBD_TIMEOUT);
2400 }
2401
2402 /*
2403 * Step 2: Make interrupt routine and hardware ignore xfer.
2404 */
2405 uhci_del_intr_list(sc, ux);
2406
2407 DPRINTF("stop ux=%p", ux, 0, 0, 0);
2408 for (std = ux->ux_stdstart; std != NULL; std = std->link.std) {
2409 usb_syncmem(&std->dma,
2410 std->offs + offsetof(uhci_td_t, td_status),
2411 sizeof(std->td.td_status),
2412 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
2413 std->td.td_status &= htole32(~(UHCI_TD_ACTIVE | UHCI_TD_IOC));
2414 usb_syncmem(&std->dma,
2415 std->offs + offsetof(uhci_td_t, td_status),
2416 sizeof(std->td.td_status),
2417 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2418 }
2419
2420 /*
2421 * Step 3: Wait until we know hardware has finished any possible
2422 * use of the xfer. Also make sure the soft interrupt routine
2423 * has run.
2424 */
2425 /* Hardware finishes in 1ms */
2426 usb_delay_ms_locked(upipe->pipe.up_dev->ud_bus, 2, &sc->sc_lock);
2427
2428 /*
2429 * Step 4: Execute callback.
2430 */
2431 DPRINTF("callback", 0, 0, 0, 0);
2432 #ifdef DIAGNOSTIC
2433 ux->ux_isdone = true;
2434 #endif
2435 wake = xfer->ux_hcflags & UXFER_ABORTWAIT;
2436 xfer->ux_hcflags &= ~(UXFER_ABORTING | UXFER_ABORTWAIT);
2437 usb_transfer_complete(xfer);
2438 if (wake)
2439 cv_broadcast(&xfer->ux_hccv);
2440 done:
2441 KASSERT(mutex_owned(&sc->sc_lock));
2442 }
2443
2444 /* Close a device bulk pipe. */
2445 void
2446 uhci_device_bulk_close(struct usbd_pipe *pipe)
2447 {
2448 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
2449 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
2450
2451 KASSERT(mutex_owned(&sc->sc_lock));
2452
2453 uhci_free_sqh(sc, upipe->bulk.sqh);
2454
2455 pipe->up_endpoint->ue_toggle = upipe->nexttoggle;
2456 }
2457
2458 int
2459 uhci_device_ctrl_init(struct usbd_xfer *xfer)
2460 {
2461 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
2462 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2463 usb_device_request_t *req = &xfer->ux_request;
2464 struct usbd_device *dev = upipe->pipe.up_dev;
2465 uhci_softc_t *sc = dev->ud_bus->ub_hcpriv;
2466 uhci_soft_td_t *data = NULL;
2467 int len;
2468 usbd_status err;
2469 int isread;
2470
2471 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2472 DPRINTFN(3, "xfer=%p len=%d, addr=%d, endpt=%d", xfer, xfer->ux_bufsize,
2473 dev->ud_addr, upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress);
2474
2475 isread = req->bmRequestType & UT_READ;
2476 len = xfer->ux_bufsize;
2477
2478 uxfer->ux_type = UX_CTRL;
2479 /* Set up data transaction */
2480 if (len != 0) {
2481 err = uhci_alloc_std_chain(sc, xfer, len, isread, &data);
2482 if (err)
2483 return err;
2484 }
2485 /* Set up interrupt info. */
2486 uxfer->ux_setup = upipe->ctrl.setup;
2487 uxfer->ux_stat = upipe->ctrl.stat;
2488 uxfer->ux_data = data;
2489
2490 return 0;
2491 }
2492
2493 Static void
2494 uhci_device_ctrl_fini(struct usbd_xfer *xfer)
2495 {
2496 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2497 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2498
2499 KASSERT(ux->ux_type == UX_CTRL);
2500
2501 uhci_free_stds(sc, ux);
2502 if (ux->ux_nstd)
2503 kmem_free(ux->ux_stds, sizeof(uhci_soft_td_t *) * ux->ux_nstd);
2504 }
2505
2506 usbd_status
2507 uhci_device_ctrl_transfer(struct usbd_xfer *xfer)
2508 {
2509 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2510 usbd_status err;
2511
2512 /* Insert last in queue. */
2513 mutex_enter(&sc->sc_lock);
2514 err = usb_insert_transfer(xfer);
2515 mutex_exit(&sc->sc_lock);
2516 if (err)
2517 return err;
2518
2519 /*
2520 * Pipe isn't running (otherwise err would be USBD_INPROG),
2521 * so start it first.
2522 */
2523 return uhci_device_ctrl_start(SIMPLEQ_FIRST(&xfer->ux_pipe->up_queue));
2524 }
2525
2526 usbd_status
2527 uhci_device_ctrl_start(struct usbd_xfer *xfer)
2528 {
2529 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2530 struct uhci_xfer *uxfer = UHCI_XFER2UXFER(xfer);
2531 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2532 usb_device_request_t *req = &xfer->ux_request;
2533 struct usbd_device *dev = upipe->pipe.up_dev;
2534 int addr = dev->ud_addr;
2535 int endpt = upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress;
2536 uhci_soft_td_t *setup, *stat, *next, *dataend;
2537 uhci_soft_qh_t *sqh;
2538 int len;
2539 int isread;
2540
2541 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2542
2543 if (sc->sc_dying)
2544 return USBD_IOERROR;
2545
2546 KASSERT(xfer->ux_rqflags & URQ_REQUEST);
2547
2548 DPRINTFN(3, "type=0x%02x, request=0x%02x, "
2549 "wValue=0x%04x, wIndex=0x%04x",
2550 req->bmRequestType, req->bRequest, UGETW(req->wValue),
2551 UGETW(req->wIndex));
2552 DPRINTFN(3, "len=%d, addr=%d, endpt=%d",
2553 UGETW(req->wLength), dev->ud_addr, endpt, 0);
2554
2555 isread = req->bmRequestType & UT_READ;
2556 len = UGETW(req->wLength);
2557
2558 setup = upipe->ctrl.setup;
2559 stat = upipe->ctrl.stat;
2560 sqh = upipe->ctrl.sqh;
2561
2562 memcpy(KERNADDR(&upipe->ctrl.reqdma, 0), req, sizeof(*req));
2563 usb_syncmem(&upipe->ctrl.reqdma, 0, sizeof(*req), BUS_DMASYNC_PREWRITE);
2564
2565 mutex_enter(&sc->sc_lock);
2566
2567 /* Set up data transaction */
2568 if (len != 0) {
2569 upipe->nexttoggle = 1;
2570 next = uxfer->ux_data;
2571 uhci_reset_std_chain(sc, xfer, len, isread,
2572 &upipe->nexttoggle, &dataend);
2573 dataend->link.std = stat;
2574 dataend->td.td_link = htole32(stat->physaddr | UHCI_PTR_TD);
2575 usb_syncmem(&dataend->dma,
2576 dataend->offs + offsetof(uhci_td_t, td_link),
2577 sizeof(dataend->td.td_link),
2578 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2579 } else {
2580 next = stat;
2581 }
2582
2583 const uint32_t status = UHCI_TD_ZERO_ACTLEN(
2584 UHCI_TD_SET_ERRCNT(3) |
2585 UHCI_TD_ACTIVE |
2586 (dev->ud_speed == USB_SPEED_LOW ? UHCI_TD_LS : 0)
2587 );
2588 setup->link.std = next;
2589 setup->td.td_link = htole32(next->physaddr | UHCI_PTR_TD);
2590 setup->td.td_status = htole32(status);
2591 setup->td.td_token = htole32(UHCI_TD_SETUP(sizeof(*req), endpt, addr));
2592 setup->td.td_buffer = htole32(DMAADDR(&upipe->ctrl.reqdma, 0));
2593
2594 usb_syncmem(&setup->dma, setup->offs, sizeof(setup->td),
2595 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2596
2597 stat->link.std = NULL;
2598 stat->td.td_link = htole32(UHCI_PTR_T);
2599 stat->td.td_status = htole32(status | UHCI_TD_IOC);
2600 stat->td.td_token =
2601 htole32(isread ? UHCI_TD_OUT(0, endpt, addr, 1) :
2602 UHCI_TD_IN (0, endpt, addr, 1));
2603 stat->td.td_buffer = htole32(0);
2604 usb_syncmem(&stat->dma, stat->offs, sizeof(stat->td),
2605 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2606
2607 #ifdef UHCI_DEBUG
2608 if (uhcidebug >= 10) {
2609 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2610 DPRINTF("before transfer", 0, 0, 0, 0);
2611 uhci_dump_tds(setup);
2612 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2613 }
2614 #endif
2615
2616 /* Set up interrupt info. */
2617 uxfer->ux_setup = setup;
2618 uxfer->ux_stat = stat;
2619 KASSERT(uxfer->ux_isdone);
2620 #ifdef DIAGNOSTIC
2621 uxfer->ux_isdone = false;
2622 #endif
2623
2624 sqh->elink = setup;
2625 sqh->qh.qh_elink = htole32(setup->physaddr | UHCI_PTR_TD);
2626 /* uhci_add_?s_ctrl() will do usb_syncmem(sqh) */
2627
2628 if (dev->ud_speed == USB_SPEED_LOW)
2629 uhci_add_ls_ctrl(sc, sqh);
2630 else
2631 uhci_add_hs_ctrl(sc, sqh);
2632 uhci_add_intr_list(sc, uxfer);
2633 #ifdef UHCI_DEBUG
2634 if (uhcidebug >= 12) {
2635 uhci_soft_td_t *std;
2636 uhci_soft_qh_t *xqh;
2637 uhci_soft_qh_t *sxqh;
2638 int maxqh = 0;
2639 uhci_physaddr_t link;
2640 DPRINTFN(12, "--- dump start ---", 0, 0, 0, 0);
2641 DPRINTFN(12, "follow from [0]", 0, 0, 0, 0);
2642 for (std = sc->sc_vframes[0].htd, link = 0;
2643 (link & UHCI_PTR_QH) == 0;
2644 std = std->link.std) {
2645 link = le32toh(std->td.td_link);
2646 uhci_dump_td(std);
2647 }
2648 sxqh = (uhci_soft_qh_t *)std;
2649 uhci_dump_qh(sxqh);
2650 for (xqh = sxqh;
2651 xqh != NULL;
2652 xqh = (maxqh++ == 5 || xqh->hlink == sxqh ||
2653 xqh->hlink == xqh ? NULL : xqh->hlink)) {
2654 uhci_dump_qh(xqh);
2655 }
2656 DPRINTFN(12, "Enqueued QH:", 0, 0, 0, 0);
2657 uhci_dump_qh(sqh);
2658 uhci_dump_tds(sqh->elink);
2659 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2660 }
2661 #endif
2662 if (xfer->ux_timeout && !sc->sc_bus.ub_usepolling) {
2663 callout_reset(&xfer->ux_callout, mstohz(xfer->ux_timeout),
2664 uhci_timeout, xfer);
2665 }
2666 xfer->ux_status = USBD_IN_PROGRESS;
2667 mutex_exit(&sc->sc_lock);
2668
2669 return USBD_IN_PROGRESS;
2670 }
2671
2672 int
2673 uhci_device_intr_init(struct usbd_xfer *xfer)
2674 {
2675 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2676 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2677 usb_endpoint_descriptor_t *ed = xfer->ux_pipe->up_endpoint->ue_edesc;
2678 int endpt = ed->bEndpointAddress;
2679 int isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2680 int len = xfer->ux_bufsize;
2681 int err;
2682
2683 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2684
2685 DPRINTFN(3, "xfer=%p len=%d flags=%d", xfer, xfer->ux_length,
2686 xfer->ux_flags, 0);
2687
2688 KASSERT(!(xfer->ux_rqflags & URQ_REQUEST));
2689 KASSERT(len != 0);
2690
2691 ux->ux_type = UX_INTR;
2692 ux->ux_nstd = 0;
2693 err = uhci_alloc_std_chain(sc, xfer, len, isread, &ux->ux_stdstart);
2694
2695 return err;
2696 }
2697
2698 Static void
2699 uhci_device_intr_fini(struct usbd_xfer *xfer)
2700 {
2701 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2702 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2703
2704 KASSERT(ux->ux_type == UX_INTR);
2705
2706 uhci_free_stds(sc, ux);
2707 if (ux->ux_nstd)
2708 kmem_free(ux->ux_stds, sizeof(uhci_soft_td_t *) * ux->ux_nstd);
2709 }
2710
2711 usbd_status
2712 uhci_device_intr_transfer(struct usbd_xfer *xfer)
2713 {
2714 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2715 usbd_status err;
2716
2717 /* Insert last in queue. */
2718 mutex_enter(&sc->sc_lock);
2719 err = usb_insert_transfer(xfer);
2720 mutex_exit(&sc->sc_lock);
2721 if (err)
2722 return err;
2723
2724 /*
2725 * Pipe isn't running (otherwise err would be USBD_INPROG),
2726 * so start it first.
2727 */
2728 return uhci_device_intr_start(SIMPLEQ_FIRST(&xfer->ux_pipe->up_queue));
2729 }
2730
2731 usbd_status
2732 uhci_device_intr_start(struct usbd_xfer *xfer)
2733 {
2734 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2735 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2736 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2737 uhci_soft_td_t *data, *dataend;
2738 uhci_soft_qh_t *sqh;
2739 int isread, endpt;
2740 int i;
2741
2742 if (sc->sc_dying)
2743 return USBD_IOERROR;
2744
2745 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2746
2747 DPRINTFN(3, "xfer=%p len=%d flags=%d", xfer, xfer->ux_length,
2748 xfer->ux_flags, 0);
2749
2750 KASSERT(!(xfer->ux_rqflags & URQ_REQUEST));
2751 KASSERT(xfer->ux_length <= xfer->ux_bufsize);
2752
2753 endpt = upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress;
2754 isread = UE_GET_DIR(endpt) == UE_DIR_IN;
2755
2756 data = ux->ux_stdstart;
2757
2758 KASSERT(ux->ux_isdone);
2759 #ifdef DIAGNOSTIC
2760 ux->ux_isdone = false;
2761 #endif
2762
2763 /* Take lock to protect nexttoggle */
2764 mutex_enter(&sc->sc_lock);
2765 uhci_reset_std_chain(sc, xfer, xfer->ux_length, isread,
2766 &upipe->nexttoggle, &dataend);
2767
2768 dataend->td.td_status |= htole32(UHCI_TD_IOC);
2769 usb_syncmem(&dataend->dma,
2770 dataend->offs + offsetof(uhci_td_t, td_status),
2771 sizeof(dataend->td.td_status),
2772 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2773 ux->ux_stdend = dataend;
2774
2775 #ifdef UHCI_DEBUG
2776 if (uhcidebug >= 10) {
2777 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2778 uhci_dump_tds(data);
2779 uhci_dump_qh(upipe->intr.qhs[0]);
2780 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2781 }
2782 #endif
2783
2784 DPRINTFN(10, "qhs[0]=%p", upipe->intr.qhs[0], 0, 0, 0);
2785 for (i = 0; i < upipe->intr.npoll; i++) {
2786 sqh = upipe->intr.qhs[i];
2787 sqh->elink = data;
2788 sqh->qh.qh_elink = htole32(data->physaddr | UHCI_PTR_TD);
2789 usb_syncmem(&sqh->dma,
2790 sqh->offs + offsetof(uhci_qh_t, qh_elink),
2791 sizeof(sqh->qh.qh_elink),
2792 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2793 }
2794 uhci_add_intr_list(sc, ux);
2795 xfer->ux_status = USBD_IN_PROGRESS;
2796 mutex_exit(&sc->sc_lock);
2797
2798 #ifdef UHCI_DEBUG
2799 if (uhcidebug >= 10) {
2800 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2801 uhci_dump_tds(data);
2802 uhci_dump_qh(upipe->intr.qhs[0]);
2803 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2804 }
2805 #endif
2806
2807 return USBD_IN_PROGRESS;
2808 }
2809
2810 /* Abort a device control request. */
2811 void
2812 uhci_device_ctrl_abort(struct usbd_xfer *xfer)
2813 {
2814 uhci_softc_t *sc __diagused = UHCI_XFER2SC(xfer);
2815
2816 KASSERT(mutex_owned(&sc->sc_lock));
2817
2818 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2819 uhci_abort_xfer(xfer, USBD_CANCELLED);
2820 }
2821
2822 /* Close a device control pipe. */
2823 void
2824 uhci_device_ctrl_close(struct usbd_pipe *pipe)
2825 {
2826 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
2827 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
2828
2829 uhci_free_sqh(sc, upipe->ctrl.sqh);
2830 uhci_free_std_locked(sc, upipe->ctrl.setup);
2831 uhci_free_std_locked(sc, upipe->ctrl.stat);
2832
2833 }
2834
2835 /* Abort a device interrupt request. */
2836 void
2837 uhci_device_intr_abort(struct usbd_xfer *xfer)
2838 {
2839 uhci_softc_t *sc __diagused = UHCI_XFER2SC(xfer);
2840
2841 KASSERT(mutex_owned(&sc->sc_lock));
2842 KASSERT(xfer->ux_pipe->up_intrxfer == xfer);
2843
2844 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2845 DPRINTF("xfer=%p", xfer, 0, 0, 0);
2846
2847 uhci_abort_xfer(xfer, USBD_CANCELLED);
2848 }
2849
2850 /* Close a device interrupt pipe. */
2851 void
2852 uhci_device_intr_close(struct usbd_pipe *pipe)
2853 {
2854 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
2855 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
2856 int i, npoll;
2857
2858 KASSERT(mutex_owned(&sc->sc_lock));
2859
2860 /* Unlink descriptors from controller data structures. */
2861 npoll = upipe->intr.npoll;
2862 for (i = 0; i < npoll; i++)
2863 uhci_remove_intr(sc, upipe->intr.qhs[i]);
2864
2865 /*
2866 * We now have to wait for any activity on the physical
2867 * descriptors to stop.
2868 */
2869 usb_delay_ms_locked(&sc->sc_bus, 2, &sc->sc_lock);
2870
2871 for (i = 0; i < npoll; i++)
2872 uhci_free_sqh(sc, upipe->intr.qhs[i]);
2873 kmem_free(upipe->intr.qhs, npoll * sizeof(uhci_soft_qh_t *));
2874 }
2875
2876 int
2877 uhci_device_isoc_init(struct usbd_xfer *xfer)
2878 {
2879 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2880
2881 KASSERT(!(xfer->ux_rqflags & URQ_REQUEST));
2882 KASSERT(xfer->ux_nframes != 0);
2883 KASSERT(ux->ux_isdone);
2884
2885 ux->ux_type = UX_ISOC;
2886 return 0;
2887 }
2888
2889 Static void
2890 uhci_device_isoc_fini(struct usbd_xfer *xfer)
2891 {
2892 struct uhci_xfer *ux __diagused = UHCI_XFER2UXFER(xfer);
2893
2894 KASSERT(ux->ux_type == UX_ISOC);
2895 }
2896
2897 usbd_status
2898 uhci_device_isoc_transfer(struct usbd_xfer *xfer)
2899 {
2900 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
2901 usbd_status err __diagused;
2902
2903 UHCIHIST_FUNC(); UHCIHIST_CALLED();
2904 DPRINTFN(5, "xfer=%p", xfer, 0, 0, 0);
2905
2906 /* Put it on our queue, */
2907 mutex_enter(&sc->sc_lock);
2908 err = usb_insert_transfer(xfer);
2909 mutex_exit(&sc->sc_lock);
2910
2911 KASSERT(err == USBD_NORMAL_COMPLETION);
2912
2913 /* insert into schedule, */
2914
2915 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
2916 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
2917 struct isoc *isoc = &upipe->isoc;
2918 uhci_soft_td_t *std = NULL;
2919 uint32_t buf, len, status, offs;
2920 int i, next, nframes;
2921 int rd = UE_GET_DIR(upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress) == UE_DIR_IN;
2922
2923 DPRINTFN(5, "used=%d next=%d xfer=%p nframes=%d",
2924 isoc->inuse, isoc->next, xfer, xfer->ux_nframes);
2925
2926 if (sc->sc_dying)
2927 return USBD_IOERROR;
2928
2929 if (xfer->ux_status == USBD_IN_PROGRESS) {
2930 /* This request has already been entered into the frame list */
2931 printf("%s: xfer=%p in frame list\n", __func__, xfer);
2932 /* XXX */
2933 }
2934
2935 #ifdef DIAGNOSTIC
2936 if (isoc->inuse >= UHCI_VFRAMELIST_COUNT)
2937 printf("%s: overflow!\n", __func__);
2938 #endif
2939
2940 KASSERT(xfer->ux_nframes != 0);
2941
2942 mutex_enter(&sc->sc_lock);
2943 next = isoc->next;
2944 if (next == -1) {
2945 /* Not in use yet, schedule it a few frames ahead. */
2946 next = (UREAD2(sc, UHCI_FRNUM) + 3) % UHCI_VFRAMELIST_COUNT;
2947 DPRINTFN(2, "start next=%d", next, 0, 0, 0);
2948 }
2949
2950 xfer->ux_status = USBD_IN_PROGRESS;
2951 ux->ux_curframe = next;
2952
2953 buf = DMAADDR(&xfer->ux_dmabuf, 0);
2954 offs = 0;
2955 status = UHCI_TD_ZERO_ACTLEN(UHCI_TD_SET_ERRCNT(0) |
2956 UHCI_TD_ACTIVE |
2957 UHCI_TD_IOS);
2958 nframes = xfer->ux_nframes;
2959 for (i = 0; i < nframes; i++) {
2960 std = isoc->stds[next];
2961 if (++next >= UHCI_VFRAMELIST_COUNT)
2962 next = 0;
2963 len = xfer->ux_frlengths[i];
2964 std->td.td_buffer = htole32(buf);
2965 usb_syncmem(&xfer->ux_dmabuf, offs, len,
2966 rd ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
2967 if (i == nframes - 1)
2968 status |= UHCI_TD_IOC;
2969 std->td.td_status = htole32(status);
2970 std->td.td_token &= htole32(~UHCI_TD_MAXLEN_MASK);
2971 std->td.td_token |= htole32(UHCI_TD_SET_MAXLEN(len));
2972 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
2973 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
2974 #ifdef UHCI_DEBUG
2975 if (uhcidebug >= 5) {
2976 DPRINTF("--- dump start ---", 0, 0, 0, 0);
2977 DPRINTF("TD %d", i, 0, 0, 0);
2978 uhci_dump_td(std);
2979 DPRINTF("--- dump end ---", 0, 0, 0, 0);
2980 }
2981 #endif
2982 buf += len;
2983 offs += len;
2984 }
2985 isoc->next = next;
2986 isoc->inuse += xfer->ux_nframes;
2987
2988 /* Set up interrupt info. */
2989 ux->ux_stdstart = std;
2990 ux->ux_stdend = std;
2991
2992 KASSERT(ux->ux_isdone);
2993 #ifdef DIAGNOSTIC
2994 ux->ux_isdone = false;
2995 #endif
2996 uhci_add_intr_list(sc, ux);
2997
2998 mutex_exit(&sc->sc_lock);
2999
3000 return USBD_IN_PROGRESS;
3001 }
3002
3003 void
3004 uhci_device_isoc_abort(struct usbd_xfer *xfer)
3005 {
3006 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
3007 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
3008 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
3009 uhci_soft_td_t **stds = upipe->isoc.stds;
3010 uhci_soft_td_t *std;
3011 int i, n, nframes, maxlen, len;
3012
3013 KASSERT(mutex_owned(&sc->sc_lock));
3014
3015 /* Transfer is already done. */
3016 if (xfer->ux_status != USBD_NOT_STARTED &&
3017 xfer->ux_status != USBD_IN_PROGRESS) {
3018 return;
3019 }
3020
3021 /* Give xfer the requested abort code. */
3022 xfer->ux_status = USBD_CANCELLED;
3023
3024 /* make hardware ignore it, */
3025 nframes = xfer->ux_nframes;
3026 n = ux->ux_curframe;
3027 maxlen = 0;
3028 for (i = 0; i < nframes; i++) {
3029 std = stds[n];
3030 usb_syncmem(&std->dma,
3031 std->offs + offsetof(uhci_td_t, td_status),
3032 sizeof(std->td.td_status),
3033 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
3034 std->td.td_status &= htole32(~(UHCI_TD_ACTIVE | UHCI_TD_IOC));
3035 usb_syncmem(&std->dma,
3036 std->offs + offsetof(uhci_td_t, td_status),
3037 sizeof(std->td.td_status),
3038 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3039 usb_syncmem(&std->dma,
3040 std->offs + offsetof(uhci_td_t, td_token),
3041 sizeof(std->td.td_token),
3042 BUS_DMASYNC_POSTWRITE);
3043 len = UHCI_TD_GET_MAXLEN(le32toh(std->td.td_token));
3044 if (len > maxlen)
3045 maxlen = len;
3046 if (++n >= UHCI_VFRAMELIST_COUNT)
3047 n = 0;
3048 }
3049
3050 /* and wait until we are sure the hardware has finished. */
3051 delay(maxlen);
3052
3053 #ifdef DIAGNOSTIC
3054 ux->ux_isdone = true;
3055 #endif
3056 /* Remove from interrupt list. */
3057 uhci_del_intr_list(sc, ux);
3058
3059 /* Run callback. */
3060 usb_transfer_complete(xfer);
3061
3062 KASSERT(mutex_owned(&sc->sc_lock));
3063 }
3064
3065 void
3066 uhci_device_isoc_close(struct usbd_pipe *pipe)
3067 {
3068 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
3069 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
3070 uhci_soft_td_t *std, *vstd;
3071 struct isoc *isoc;
3072 int i;
3073
3074 KASSERT(mutex_owned(&sc->sc_lock));
3075
3076 /*
3077 * Make sure all TDs are marked as inactive.
3078 * Wait for completion.
3079 * Unschedule.
3080 * Deallocate.
3081 */
3082 isoc = &upipe->isoc;
3083
3084 for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
3085 std = isoc->stds[i];
3086 usb_syncmem(&std->dma,
3087 std->offs + offsetof(uhci_td_t, td_status),
3088 sizeof(std->td.td_status),
3089 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
3090 std->td.td_status &= htole32(~UHCI_TD_ACTIVE);
3091 usb_syncmem(&std->dma,
3092 std->offs + offsetof(uhci_td_t, td_status),
3093 sizeof(std->td.td_status),
3094 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3095 }
3096 /* wait for completion */
3097 usb_delay_ms_locked(&sc->sc_bus, 2, &sc->sc_lock);
3098
3099 for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
3100 std = isoc->stds[i];
3101 for (vstd = sc->sc_vframes[i].htd;
3102 vstd != NULL && vstd->link.std != std;
3103 vstd = vstd->link.std)
3104 ;
3105 if (vstd == NULL) {
3106 /*panic*/
3107 printf("%s: %p not found\n", __func__, std);
3108 mutex_exit(&sc->sc_lock);
3109 return;
3110 }
3111 vstd->link = std->link;
3112 usb_syncmem(&std->dma,
3113 std->offs + offsetof(uhci_td_t, td_link),
3114 sizeof(std->td.td_link),
3115 BUS_DMASYNC_POSTWRITE);
3116 vstd->td.td_link = std->td.td_link;
3117 usb_syncmem(&vstd->dma,
3118 vstd->offs + offsetof(uhci_td_t, td_link),
3119 sizeof(vstd->td.td_link),
3120 BUS_DMASYNC_PREWRITE);
3121 uhci_free_std_locked(sc, std);
3122 }
3123
3124 kmem_free(isoc->stds, UHCI_VFRAMELIST_COUNT * sizeof(uhci_soft_td_t *));
3125 }
3126
3127 usbd_status
3128 uhci_setup_isoc(struct usbd_pipe *pipe)
3129 {
3130 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
3131 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
3132 int addr = upipe->pipe.up_dev->ud_addr;
3133 int endpt = upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress;
3134 int rd = UE_GET_DIR(endpt) == UE_DIR_IN;
3135 uhci_soft_td_t *std, *vstd;
3136 uint32_t token;
3137 struct isoc *isoc;
3138 int i;
3139
3140 isoc = &upipe->isoc;
3141
3142 isoc->stds = kmem_alloc(
3143 UHCI_VFRAMELIST_COUNT * sizeof(uhci_soft_td_t *), KM_SLEEP);
3144 if (isoc->stds == NULL)
3145 return USBD_NOMEM;
3146
3147 token = rd ? UHCI_TD_IN (0, endpt, addr, 0) :
3148 UHCI_TD_OUT(0, endpt, addr, 0);
3149
3150 /* Allocate the TDs and mark as inactive; */
3151 for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
3152 std = uhci_alloc_std(sc);
3153 if (std == 0)
3154 goto bad;
3155 std->td.td_status = htole32(UHCI_TD_IOS); /* iso, inactive */
3156 std->td.td_token = htole32(token);
3157 usb_syncmem(&std->dma, std->offs, sizeof(std->td),
3158 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3159 isoc->stds[i] = std;
3160 }
3161
3162 mutex_enter(&sc->sc_lock);
3163
3164 /* Insert TDs into schedule. */
3165 for (i = 0; i < UHCI_VFRAMELIST_COUNT; i++) {
3166 std = isoc->stds[i];
3167 vstd = sc->sc_vframes[i].htd;
3168 usb_syncmem(&vstd->dma,
3169 vstd->offs + offsetof(uhci_td_t, td_link),
3170 sizeof(vstd->td.td_link),
3171 BUS_DMASYNC_POSTWRITE);
3172 std->link = vstd->link;
3173 std->td.td_link = vstd->td.td_link;
3174 usb_syncmem(&std->dma,
3175 std->offs + offsetof(uhci_td_t, td_link),
3176 sizeof(std->td.td_link),
3177 BUS_DMASYNC_PREWRITE);
3178 vstd->link.std = std;
3179 vstd->td.td_link = htole32(std->physaddr | UHCI_PTR_TD);
3180 usb_syncmem(&vstd->dma,
3181 vstd->offs + offsetof(uhci_td_t, td_link),
3182 sizeof(vstd->td.td_link),
3183 BUS_DMASYNC_PREWRITE);
3184 }
3185 mutex_exit(&sc->sc_lock);
3186
3187 isoc->next = -1;
3188 isoc->inuse = 0;
3189
3190 return USBD_NORMAL_COMPLETION;
3191
3192 bad:
3193 while (--i >= 0)
3194 uhci_free_std(sc, isoc->stds[i]);
3195 kmem_free(isoc->stds, UHCI_VFRAMELIST_COUNT * sizeof(uhci_soft_td_t *));
3196 return USBD_NOMEM;
3197 }
3198
3199 void
3200 uhci_device_isoc_done(struct usbd_xfer *xfer)
3201 {
3202 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
3203 struct uhci_xfer *ux = UHCI_XFER2UXFER(xfer);
3204 int i, offs;
3205 int rd = UE_GET_DIR(upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress) == UE_DIR_IN;
3206
3207 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3208 DPRINTFN(4, "length=%d, ux_state=0x%08x",
3209 xfer->ux_actlen, xfer->ux_state, 0, 0);
3210
3211 #ifdef DIAGNOSTIC
3212 if (ux->ux_stdend == NULL) {
3213 printf("%s: xfer=%p stdend==NULL\n", __func__, xfer);
3214 #ifdef UHCI_DEBUG
3215 DPRINTF("--- dump start ---", 0, 0, 0, 0);
3216 uhci_dump_ii(ux);
3217 DPRINTF("--- dump end ---", 0, 0, 0, 0);
3218 #endif
3219 return;
3220 }
3221 #endif
3222
3223 /* Turn off the interrupt since it is active even if the TD is not. */
3224 usb_syncmem(&ux->ux_stdend->dma,
3225 ux->ux_stdend->offs + offsetof(uhci_td_t, td_status),
3226 sizeof(ux->ux_stdend->td.td_status),
3227 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
3228 ux->ux_stdend->td.td_status &= htole32(~UHCI_TD_IOC);
3229 usb_syncmem(&ux->ux_stdend->dma,
3230 ux->ux_stdend->offs + offsetof(uhci_td_t, td_status),
3231 sizeof(ux->ux_stdend->td.td_status),
3232 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3233
3234 offs = 0;
3235 for (i = 0; i < xfer->ux_nframes; i++) {
3236 usb_syncmem(&xfer->ux_dmabuf, offs, xfer->ux_frlengths[i],
3237 rd ? BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
3238 offs += xfer->ux_frlengths[i];
3239 }
3240 }
3241
3242 void
3243 uhci_device_intr_done(struct usbd_xfer *xfer)
3244 {
3245 uhci_softc_t *sc __diagused = UHCI_XFER2SC(xfer);
3246 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
3247 uhci_soft_qh_t *sqh;
3248 int i, npoll;
3249
3250 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3251 DPRINTFN(5, "length=%d", xfer->ux_actlen, 0, 0, 0);
3252
3253 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
3254
3255 npoll = upipe->intr.npoll;
3256 for (i = 0; i < npoll; i++) {
3257 sqh = upipe->intr.qhs[i];
3258 sqh->elink = NULL;
3259 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
3260 usb_syncmem(&sqh->dma,
3261 sqh->offs + offsetof(uhci_qh_t, qh_elink),
3262 sizeof(sqh->qh.qh_elink),
3263 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3264 }
3265 const int endpt = upipe->pipe.up_endpoint->ue_edesc->bEndpointAddress;
3266 const bool isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3267 usb_syncmem(&xfer->ux_dmabuf, 0, xfer->ux_length,
3268 isread ? BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
3269 }
3270
3271 /* Deallocate request data structures */
3272 void
3273 uhci_device_ctrl_done(struct usbd_xfer *xfer)
3274 {
3275 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
3276 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
3277 int len = UGETW(xfer->ux_request.wLength);
3278 int isread = (xfer->ux_request.bmRequestType & UT_READ);
3279
3280 KASSERT(sc->sc_bus.ub_usepolling || mutex_owned(&sc->sc_lock));
3281
3282 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3283
3284 KASSERT(xfer->ux_rqflags & URQ_REQUEST);
3285
3286 /* XXXNH move to uhci_idone??? */
3287 if (upipe->pipe.up_dev->ud_speed == USB_SPEED_LOW)
3288 uhci_remove_ls_ctrl(sc, upipe->ctrl.sqh);
3289 else
3290 uhci_remove_hs_ctrl(sc, upipe->ctrl.sqh);
3291
3292 if (len) {
3293 usb_syncmem(&xfer->ux_dmabuf, 0, len,
3294 isread ? BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
3295 }
3296 usb_syncmem(&upipe->ctrl.reqdma, 0,
3297 sizeof(usb_device_request_t), BUS_DMASYNC_POSTWRITE);
3298
3299 DPRINTF("length=%d", xfer->ux_actlen, 0, 0, 0);
3300 }
3301
3302 /* Deallocate request data structures */
3303 void
3304 uhci_device_bulk_done(struct usbd_xfer *xfer)
3305 {
3306 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
3307 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(xfer->ux_pipe);
3308 usb_endpoint_descriptor_t *ed = xfer->ux_pipe->up_endpoint->ue_edesc;
3309 int endpt = ed->bEndpointAddress;
3310 int isread = UE_GET_DIR(endpt) == UE_DIR_IN;
3311
3312 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3313 DPRINTFN(5, "xfer=%p sc=%p upipe=%p", xfer, sc, upipe, 0);
3314
3315 KASSERT(mutex_owned(&sc->sc_lock));
3316
3317 uhci_remove_bulk(sc, upipe->bulk.sqh);
3318
3319 if (xfer->ux_length) {
3320 usb_syncmem(&xfer->ux_dmabuf, 0, xfer->ux_length,
3321 isread ? BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
3322 }
3323
3324 DPRINTFN(5, "length=%d", xfer->ux_actlen, 0, 0, 0);
3325 }
3326
3327 /* Add interrupt QH, called with vflock. */
3328 void
3329 uhci_add_intr(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
3330 {
3331 struct uhci_vframe *vf = &sc->sc_vframes[sqh->pos];
3332 uhci_soft_qh_t *eqh;
3333
3334 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3335 DPRINTFN(4, "n=%d sqh=%p", sqh->pos, sqh, 0, 0);
3336
3337 eqh = vf->eqh;
3338 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
3339 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_POSTWRITE);
3340 sqh->hlink = eqh->hlink;
3341 sqh->qh.qh_hlink = eqh->qh.qh_hlink;
3342 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_hlink),
3343 sizeof(sqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
3344 eqh->hlink = sqh;
3345 eqh->qh.qh_hlink = htole32(sqh->physaddr | UHCI_PTR_QH);
3346 usb_syncmem(&eqh->dma, eqh->offs + offsetof(uhci_qh_t, qh_hlink),
3347 sizeof(eqh->qh.qh_hlink), BUS_DMASYNC_PREWRITE);
3348 vf->eqh = sqh;
3349 vf->bandwidth++;
3350 }
3351
3352 /* Remove interrupt QH. */
3353 void
3354 uhci_remove_intr(uhci_softc_t *sc, uhci_soft_qh_t *sqh)
3355 {
3356 struct uhci_vframe *vf = &sc->sc_vframes[sqh->pos];
3357 uhci_soft_qh_t *pqh;
3358
3359 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3360 DPRINTFN(4, "n=%d sqh=%p", sqh->pos, sqh, 0, 0);
3361
3362 /* See comment in uhci_remove_ctrl() */
3363
3364 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_elink),
3365 sizeof(sqh->qh.qh_elink),
3366 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
3367 if (!(sqh->qh.qh_elink & htole32(UHCI_PTR_T))) {
3368 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
3369 usb_syncmem(&sqh->dma,
3370 sqh->offs + offsetof(uhci_qh_t, qh_elink),
3371 sizeof(sqh->qh.qh_elink),
3372 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3373 delay(UHCI_QH_REMOVE_DELAY);
3374 }
3375
3376 pqh = uhci_find_prev_qh(vf->hqh, sqh);
3377 usb_syncmem(&sqh->dma, sqh->offs + offsetof(uhci_qh_t, qh_hlink),
3378 sizeof(sqh->qh.qh_hlink),
3379 BUS_DMASYNC_POSTWRITE | BUS_DMASYNC_POSTREAD);
3380 pqh->hlink = sqh->hlink;
3381 pqh->qh.qh_hlink = sqh->qh.qh_hlink;
3382 usb_syncmem(&pqh->dma, pqh->offs + offsetof(uhci_qh_t, qh_hlink),
3383 sizeof(pqh->qh.qh_hlink),
3384 BUS_DMASYNC_PREWRITE);
3385 delay(UHCI_QH_REMOVE_DELAY);
3386 if (vf->eqh == sqh)
3387 vf->eqh = pqh;
3388 vf->bandwidth--;
3389 }
3390
3391 usbd_status
3392 uhci_device_setintr(uhci_softc_t *sc, struct uhci_pipe *upipe, int ival)
3393 {
3394 uhci_soft_qh_t *sqh;
3395 int i, npoll;
3396 u_int bestbw, bw, bestoffs, offs;
3397
3398 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3399 DPRINTFN(2, "pipe=%p", upipe, 0, 0, 0);
3400 if (ival == 0) {
3401 printf("%s: 0 interval\n", __func__);
3402 return USBD_INVAL;
3403 }
3404
3405 if (ival > UHCI_VFRAMELIST_COUNT)
3406 ival = UHCI_VFRAMELIST_COUNT;
3407 npoll = (UHCI_VFRAMELIST_COUNT + ival - 1) / ival;
3408 DPRINTF("ival=%d npoll=%d", ival, npoll, 0, 0);
3409
3410 upipe->intr.npoll = npoll;
3411 upipe->intr.qhs =
3412 kmem_alloc(npoll * sizeof(uhci_soft_qh_t *), KM_SLEEP);
3413 if (upipe->intr.qhs == NULL)
3414 return USBD_NOMEM;
3415
3416 /*
3417 * Figure out which offset in the schedule that has most
3418 * bandwidth left over.
3419 */
3420 #define MOD(i) ((i) & (UHCI_VFRAMELIST_COUNT-1))
3421 for (bestoffs = offs = 0, bestbw = ~0; offs < ival; offs++) {
3422 for (bw = i = 0; i < npoll; i++)
3423 bw += sc->sc_vframes[MOD(i * ival + offs)].bandwidth;
3424 if (bw < bestbw) {
3425 bestbw = bw;
3426 bestoffs = offs;
3427 }
3428 }
3429 DPRINTF("bw=%d offs=%d", bestbw, bestoffs, 0, 0);
3430 for (i = 0; i < npoll; i++) {
3431 upipe->intr.qhs[i] = sqh = uhci_alloc_sqh(sc);
3432 sqh->elink = NULL;
3433 sqh->qh.qh_elink = htole32(UHCI_PTR_T);
3434 usb_syncmem(&sqh->dma,
3435 sqh->offs + offsetof(uhci_qh_t, qh_elink),
3436 sizeof(sqh->qh.qh_elink),
3437 BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD);
3438 sqh->pos = MOD(i * ival + bestoffs);
3439 }
3440 #undef MOD
3441
3442 mutex_enter(&sc->sc_lock);
3443 /* Enter QHs into the controller data structures. */
3444 for (i = 0; i < npoll; i++)
3445 uhci_add_intr(sc, upipe->intr.qhs[i]);
3446 mutex_exit(&sc->sc_lock);
3447
3448 DPRINTFN(5, "returns %p", upipe, 0, 0, 0);
3449
3450 return USBD_NORMAL_COMPLETION;
3451 }
3452
3453 /* Open a new pipe. */
3454 usbd_status
3455 uhci_open(struct usbd_pipe *pipe)
3456 {
3457 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
3458 struct usbd_bus *bus = pipe->up_dev->ud_bus;
3459 struct uhci_pipe *upipe = UHCI_PIPE2UPIPE(pipe);
3460 usb_endpoint_descriptor_t *ed = pipe->up_endpoint->ue_edesc;
3461 usbd_status err = USBD_NOMEM;
3462 int ival;
3463
3464 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3465 DPRINTF("pipe=%p, addr=%d, endpt=%d (%d)",
3466 pipe, pipe->up_dev->ud_addr, ed->bEndpointAddress, bus->ub_rhaddr);
3467
3468 if (sc->sc_dying)
3469 return USBD_IOERROR;
3470
3471 upipe->aborting = 0;
3472 /* toggle state needed for bulk endpoints */
3473 upipe->nexttoggle = pipe->up_endpoint->ue_toggle;
3474
3475 if (pipe->up_dev->ud_addr == bus->ub_rhaddr) {
3476 switch (ed->bEndpointAddress) {
3477 case USB_CONTROL_ENDPOINT:
3478 pipe->up_methods = &roothub_ctrl_methods;
3479 break;
3480 case UE_DIR_IN | USBROOTHUB_INTR_ENDPT:
3481 pipe->up_methods = &uhci_root_intr_methods;
3482 break;
3483 default:
3484 return USBD_INVAL;
3485 }
3486 } else {
3487 switch (ed->bmAttributes & UE_XFERTYPE) {
3488 case UE_CONTROL:
3489 pipe->up_methods = &uhci_device_ctrl_methods;
3490 upipe->ctrl.sqh = uhci_alloc_sqh(sc);
3491 if (upipe->ctrl.sqh == NULL)
3492 goto bad;
3493 upipe->ctrl.setup = uhci_alloc_std(sc);
3494 if (upipe->ctrl.setup == NULL) {
3495 uhci_free_sqh(sc, upipe->ctrl.sqh);
3496 goto bad;
3497 }
3498 upipe->ctrl.stat = uhci_alloc_std(sc);
3499 if (upipe->ctrl.stat == NULL) {
3500 uhci_free_sqh(sc, upipe->ctrl.sqh);
3501 uhci_free_std(sc, upipe->ctrl.setup);
3502 goto bad;
3503 }
3504 err = usb_allocmem(&sc->sc_bus,
3505 sizeof(usb_device_request_t),
3506 0, &upipe->ctrl.reqdma);
3507 if (err) {
3508 uhci_free_sqh(sc, upipe->ctrl.sqh);
3509 uhci_free_std(sc, upipe->ctrl.setup);
3510 uhci_free_std(sc, upipe->ctrl.stat);
3511 goto bad;
3512 }
3513 break;
3514 case UE_INTERRUPT:
3515 pipe->up_methods = &uhci_device_intr_methods;
3516 ival = pipe->up_interval;
3517 if (ival == USBD_DEFAULT_INTERVAL)
3518 ival = ed->bInterval;
3519 return uhci_device_setintr(sc, upipe, ival);
3520 case UE_ISOCHRONOUS:
3521 pipe->up_serialise = false;
3522 pipe->up_methods = &uhci_device_isoc_methods;
3523 return uhci_setup_isoc(pipe);
3524 case UE_BULK:
3525 pipe->up_methods = &uhci_device_bulk_methods;
3526 upipe->bulk.sqh = uhci_alloc_sqh(sc);
3527 if (upipe->bulk.sqh == NULL)
3528 goto bad;
3529 break;
3530 }
3531 }
3532 return USBD_NORMAL_COMPLETION;
3533
3534 bad:
3535 return USBD_NOMEM;
3536 }
3537
3538 /*
3539 * Data structures and routines to emulate the root hub.
3540 */
3541 /*
3542 * The USB hub protocol requires that SET_FEATURE(PORT_RESET) also
3543 * enables the port, and also states that SET_FEATURE(PORT_ENABLE)
3544 * should not be used by the USB subsystem. As we cannot issue a
3545 * SET_FEATURE(PORT_ENABLE) externally, we must ensure that the port
3546 * will be enabled as part of the reset.
3547 *
3548 * On the VT83C572, the port cannot be successfully enabled until the
3549 * outstanding "port enable change" and "connection status change"
3550 * events have been reset.
3551 */
3552 Static usbd_status
3553 uhci_portreset(uhci_softc_t *sc, int index)
3554 {
3555 int lim, port, x;
3556 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3557
3558 if (index == 1)
3559 port = UHCI_PORTSC1;
3560 else if (index == 2)
3561 port = UHCI_PORTSC2;
3562 else
3563 return USBD_IOERROR;
3564
3565 x = URWMASK(UREAD2(sc, port));
3566 UWRITE2(sc, port, x | UHCI_PORTSC_PR);
3567
3568 usb_delay_ms(&sc->sc_bus, USB_PORT_ROOT_RESET_DELAY);
3569
3570 DPRINTF("uhci port %d reset, status0 = 0x%04x", index,
3571 UREAD2(sc, port), 0, 0);
3572
3573 x = URWMASK(UREAD2(sc, port));
3574 UWRITE2(sc, port, x & ~(UHCI_PORTSC_PR | UHCI_PORTSC_SUSP));
3575
3576 delay(100);
3577
3578 DPRINTF("uhci port %d reset, status1 = 0x%04x", index,
3579 UREAD2(sc, port), 0, 0);
3580
3581 x = URWMASK(UREAD2(sc, port));
3582 UWRITE2(sc, port, x | UHCI_PORTSC_PE);
3583
3584 for (lim = 10; --lim > 0;) {
3585 usb_delay_ms(&sc->sc_bus, USB_PORT_RESET_DELAY);
3586
3587 x = UREAD2(sc, port);
3588 DPRINTF("uhci port %d iteration %u, status = 0x%04x", index,
3589 lim, x, 0);
3590
3591 if (!(x & UHCI_PORTSC_CCS)) {
3592 /*
3593 * No device is connected (or was disconnected
3594 * during reset). Consider the port reset.
3595 * The delay must be long enough to ensure on
3596 * the initial iteration that the device
3597 * connection will have been registered. 50ms
3598 * appears to be sufficient, but 20ms is not.
3599 */
3600 DPRINTFN(3, "uhci port %d loop %u, device detached",
3601 index, lim, 0, 0);
3602 break;
3603 }
3604
3605 if (x & (UHCI_PORTSC_POEDC | UHCI_PORTSC_CSC)) {
3606 /*
3607 * Port enabled changed and/or connection
3608 * status changed were set. Reset either or
3609 * both raised flags (by writing a 1 to that
3610 * bit), and wait again for state to settle.
3611 */
3612 UWRITE2(sc, port, URWMASK(x) |
3613 (x & (UHCI_PORTSC_POEDC | UHCI_PORTSC_CSC)));
3614 continue;
3615 }
3616
3617 if (x & UHCI_PORTSC_PE)
3618 /* Port is enabled */
3619 break;
3620
3621 UWRITE2(sc, port, URWMASK(x) | UHCI_PORTSC_PE);
3622 }
3623
3624 DPRINTFN(3, "uhci port %d reset, status2 = 0x%04x", index,
3625 UREAD2(sc, port), 0, 0);
3626
3627 if (lim <= 0) {
3628 DPRINTF("uhci port %d reset timed out", index,
3629 0, 0, 0);
3630 return USBD_TIMEOUT;
3631 }
3632
3633 sc->sc_isreset = 1;
3634 return USBD_NORMAL_COMPLETION;
3635 }
3636
3637 Static int
3638 uhci_roothub_ctrl(struct usbd_bus *bus, usb_device_request_t *req,
3639 void *buf, int buflen)
3640 {
3641 uhci_softc_t *sc = UHCI_BUS2SC(bus);
3642 int port, x;
3643 int status, change, totlen = 0;
3644 uint16_t len, value, index;
3645 usb_port_status_t ps;
3646 usbd_status err;
3647
3648 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3649
3650 if (sc->sc_dying)
3651 return -1;
3652
3653 DPRINTF("type=0x%02x request=%02x", req->bmRequestType,
3654 req->bRequest, 0, 0);
3655
3656 len = UGETW(req->wLength);
3657 value = UGETW(req->wValue);
3658 index = UGETW(req->wIndex);
3659
3660 #define C(x,y) ((x) | ((y) << 8))
3661 switch (C(req->bRequest, req->bmRequestType)) {
3662 case C(UR_GET_DESCRIPTOR, UT_READ_DEVICE):
3663 DPRINTF("wValue=0x%04x", value, 0, 0, 0);
3664 if (len == 0)
3665 break;
3666 switch (value) {
3667 case C(0, UDESC_DEVICE): {
3668 usb_device_descriptor_t devd;
3669
3670 totlen = min(buflen, sizeof(devd));
3671 memcpy(&devd, buf, totlen);
3672 USETW(devd.idVendor, sc->sc_id_vendor);
3673 memcpy(buf, &devd, totlen);
3674 break;
3675 }
3676 case C(1, UDESC_STRING):
3677 #define sd ((usb_string_descriptor_t *)buf)
3678 /* Vendor */
3679 totlen = usb_makestrdesc(sd, len, sc->sc_vendor);
3680 break;
3681 case C(2, UDESC_STRING):
3682 /* Product */
3683 totlen = usb_makestrdesc(sd, len, "UHCI root hub");
3684 break;
3685 #undef sd
3686 default:
3687 /* default from usbroothub */
3688 return buflen;
3689 }
3690 break;
3691
3692 /* Hub requests */
3693 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_DEVICE):
3694 break;
3695 case C(UR_CLEAR_FEATURE, UT_WRITE_CLASS_OTHER):
3696 DPRINTF("UR_CLEAR_PORT_FEATURE port=%d feature=%d", index,
3697 value, 0, 0);
3698 if (index == 1)
3699 port = UHCI_PORTSC1;
3700 else if (index == 2)
3701 port = UHCI_PORTSC2;
3702 else {
3703 return -1;
3704 }
3705 switch(value) {
3706 case UHF_PORT_ENABLE:
3707 x = URWMASK(UREAD2(sc, port));
3708 UWRITE2(sc, port, x & ~UHCI_PORTSC_PE);
3709 break;
3710 case UHF_PORT_SUSPEND:
3711 x = URWMASK(UREAD2(sc, port));
3712 if (!(x & UHCI_PORTSC_SUSP)) /* not suspended */
3713 break;
3714 UWRITE2(sc, port, x | UHCI_PORTSC_RD);
3715 /* see USB2 spec ch. 7.1.7.7 */
3716 usb_delay_ms(&sc->sc_bus, 20);
3717 UWRITE2(sc, port, x & ~UHCI_PORTSC_SUSP);
3718 /* 10ms resume delay must be provided by caller */
3719 break;
3720 case UHF_PORT_RESET:
3721 x = URWMASK(UREAD2(sc, port));
3722 UWRITE2(sc, port, x & ~UHCI_PORTSC_PR);
3723 break;
3724 case UHF_C_PORT_CONNECTION:
3725 x = URWMASK(UREAD2(sc, port));
3726 UWRITE2(sc, port, x | UHCI_PORTSC_CSC);
3727 break;
3728 case UHF_C_PORT_ENABLE:
3729 x = URWMASK(UREAD2(sc, port));
3730 UWRITE2(sc, port, x | UHCI_PORTSC_POEDC);
3731 break;
3732 case UHF_C_PORT_OVER_CURRENT:
3733 x = URWMASK(UREAD2(sc, port));
3734 UWRITE2(sc, port, x | UHCI_PORTSC_OCIC);
3735 break;
3736 case UHF_C_PORT_RESET:
3737 sc->sc_isreset = 0;
3738 break;
3739 case UHF_PORT_CONNECTION:
3740 case UHF_PORT_OVER_CURRENT:
3741 case UHF_PORT_POWER:
3742 case UHF_PORT_LOW_SPEED:
3743 case UHF_C_PORT_SUSPEND:
3744 default:
3745 return -1;
3746 }
3747 break;
3748 case C(UR_GET_BUS_STATE, UT_READ_CLASS_OTHER):
3749 if (index == 1)
3750 port = UHCI_PORTSC1;
3751 else if (index == 2)
3752 port = UHCI_PORTSC2;
3753 else {
3754 return -1;
3755 }
3756 if (len > 0) {
3757 *(uint8_t *)buf =
3758 UHCI_PORTSC_GET_LS(UREAD2(sc, port));
3759 totlen = 1;
3760 }
3761 break;
3762 case C(UR_GET_DESCRIPTOR, UT_READ_CLASS_DEVICE):
3763 if (len == 0)
3764 break;
3765 if ((value & 0xff) != 0) {
3766 return -1;
3767 }
3768 usb_hub_descriptor_t hubd;
3769
3770 totlen = min(buflen, sizeof(hubd));
3771 memcpy(&hubd, buf, totlen);
3772 hubd.bNbrPorts = 2;
3773 memcpy(buf, &hubd, totlen);
3774 break;
3775 case C(UR_GET_STATUS, UT_READ_CLASS_DEVICE):
3776 if (len != 4) {
3777 return -1;
3778 }
3779 memset(buf, 0, len);
3780 totlen = len;
3781 break;
3782 case C(UR_GET_STATUS, UT_READ_CLASS_OTHER):
3783 if (index == 1)
3784 port = UHCI_PORTSC1;
3785 else if (index == 2)
3786 port = UHCI_PORTSC2;
3787 else {
3788 return -1;
3789 }
3790 if (len != 4) {
3791 return -1;
3792 }
3793 x = UREAD2(sc, port);
3794 status = change = 0;
3795 if (x & UHCI_PORTSC_CCS)
3796 status |= UPS_CURRENT_CONNECT_STATUS;
3797 if (x & UHCI_PORTSC_CSC)
3798 change |= UPS_C_CONNECT_STATUS;
3799 if (x & UHCI_PORTSC_PE)
3800 status |= UPS_PORT_ENABLED;
3801 if (x & UHCI_PORTSC_POEDC)
3802 change |= UPS_C_PORT_ENABLED;
3803 if (x & UHCI_PORTSC_OCI)
3804 status |= UPS_OVERCURRENT_INDICATOR;
3805 if (x & UHCI_PORTSC_OCIC)
3806 change |= UPS_C_OVERCURRENT_INDICATOR;
3807 if (x & UHCI_PORTSC_SUSP)
3808 status |= UPS_SUSPEND;
3809 if (x & UHCI_PORTSC_LSDA)
3810 status |= UPS_LOW_SPEED;
3811 status |= UPS_PORT_POWER;
3812 if (sc->sc_isreset)
3813 change |= UPS_C_PORT_RESET;
3814 USETW(ps.wPortStatus, status);
3815 USETW(ps.wPortChange, change);
3816 totlen = min(len, sizeof(ps));
3817 memcpy(buf, &ps, totlen);
3818 break;
3819 case C(UR_SET_DESCRIPTOR, UT_WRITE_CLASS_DEVICE):
3820 return -1;
3821 case C(UR_SET_FEATURE, UT_WRITE_CLASS_DEVICE):
3822 break;
3823 case C(UR_SET_FEATURE, UT_WRITE_CLASS_OTHER):
3824 if (index == 1)
3825 port = UHCI_PORTSC1;
3826 else if (index == 2)
3827 port = UHCI_PORTSC2;
3828 else {
3829 return -1;
3830 }
3831 switch(value) {
3832 case UHF_PORT_ENABLE:
3833 x = URWMASK(UREAD2(sc, port));
3834 UWRITE2(sc, port, x | UHCI_PORTSC_PE);
3835 break;
3836 case UHF_PORT_SUSPEND:
3837 x = URWMASK(UREAD2(sc, port));
3838 UWRITE2(sc, port, x | UHCI_PORTSC_SUSP);
3839 break;
3840 case UHF_PORT_RESET:
3841 err = uhci_portreset(sc, index);
3842 if (err != USBD_NORMAL_COMPLETION)
3843 return -1;
3844 return 0;
3845 case UHF_PORT_POWER:
3846 /* Pretend we turned on power */
3847 return 0;
3848 case UHF_C_PORT_CONNECTION:
3849 case UHF_C_PORT_ENABLE:
3850 case UHF_C_PORT_OVER_CURRENT:
3851 case UHF_PORT_CONNECTION:
3852 case UHF_PORT_OVER_CURRENT:
3853 case UHF_PORT_LOW_SPEED:
3854 case UHF_C_PORT_SUSPEND:
3855 case UHF_C_PORT_RESET:
3856 default:
3857 return -1;
3858 }
3859 break;
3860 default:
3861 /* default from usbroothub */
3862 DPRINTF("returning %d (usbroothub default)",
3863 buflen, 0, 0, 0);
3864 return buflen;
3865 }
3866
3867 DPRINTF("returning %d", totlen, 0, 0, 0);
3868
3869 return totlen;
3870 }
3871
3872 /* Abort a root interrupt request. */
3873 void
3874 uhci_root_intr_abort(struct usbd_xfer *xfer)
3875 {
3876 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
3877
3878 KASSERT(mutex_owned(&sc->sc_lock));
3879 KASSERT(xfer->ux_pipe->up_intrxfer == xfer);
3880
3881 callout_stop(&sc->sc_poll_handle);
3882 sc->sc_intr_xfer = NULL;
3883
3884 xfer->ux_status = USBD_CANCELLED;
3885 #ifdef DIAGNOSTIC
3886 UHCI_XFER2UXFER(xfer)->ux_isdone = true;
3887 #endif
3888 usb_transfer_complete(xfer);
3889 }
3890
3891 usbd_status
3892 uhci_root_intr_transfer(struct usbd_xfer *xfer)
3893 {
3894 uhci_softc_t *sc = UHCI_XFER2SC(xfer);
3895 usbd_status err;
3896
3897 /* Insert last in queue. */
3898 mutex_enter(&sc->sc_lock);
3899 err = usb_insert_transfer(xfer);
3900 mutex_exit(&sc->sc_lock);
3901 if (err)
3902 return err;
3903
3904 /*
3905 * Pipe isn't running (otherwise err would be USBD_INPROG),
3906 * start first
3907 */
3908 return uhci_root_intr_start(SIMPLEQ_FIRST(&xfer->ux_pipe->up_queue));
3909 }
3910
3911 /* Start a transfer on the root interrupt pipe */
3912 usbd_status
3913 uhci_root_intr_start(struct usbd_xfer *xfer)
3914 {
3915 struct usbd_pipe *pipe = xfer->ux_pipe;
3916 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
3917 unsigned int ival;
3918
3919 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3920 DPRINTF("xfer=%p len=%d flags=%d", xfer, xfer->ux_length,
3921 xfer->ux_flags, 0);
3922
3923 if (sc->sc_dying)
3924 return USBD_IOERROR;
3925
3926 /* XXX temporary variable needed to avoid gcc3 warning */
3927 ival = xfer->ux_pipe->up_endpoint->ue_edesc->bInterval;
3928 sc->sc_ival = mstohz(ival);
3929 callout_reset(&sc->sc_poll_handle, sc->sc_ival, uhci_poll_hub, xfer);
3930 sc->sc_intr_xfer = xfer;
3931 return USBD_IN_PROGRESS;
3932 }
3933
3934 /* Close the root interrupt pipe. */
3935 void
3936 uhci_root_intr_close(struct usbd_pipe *pipe)
3937 {
3938 uhci_softc_t *sc = UHCI_PIPE2SC(pipe);
3939 UHCIHIST_FUNC(); UHCIHIST_CALLED();
3940
3941 KASSERT(mutex_owned(&sc->sc_lock));
3942
3943 callout_stop(&sc->sc_poll_handle);
3944 sc->sc_intr_xfer = NULL;
3945 }
3946