2 * $NetBSD: usbdi.c,v 1.103 2002/09/27 15:37:38 provos Exp $
3 * $FreeBSD: src/sys/dev/usb/usbdi.c,v 1.84 2003/11/09 23:56:19 joe Exp $
4 * $DragonFly: src/sys/bus/usb/usbdi.c,v 1.10 2006/09/05 00:55:36 dillon Exp $
8 * Copyright (c) 1998 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net) at
13 * Carlstedt Research & Technology.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. All advertising materials mentioning features or use of this software
24 * must display the following acknowledgement:
25 * This product includes software developed by the NetBSD
26 * Foundation, Inc. and its contributors.
27 * 4. Neither the name of The NetBSD Foundation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #if defined(__NetBSD__) || defined(__OpenBSD__)
47 #include <sys/device.h>
48 #elif defined(__FreeBSD__) || defined(__DragonFly__)
49 #include <sys/module.h>
52 #if defined(DIAGNOSTIC) && defined(__i386__)
53 #include <machine/cpu.h>
56 #include <sys/malloc.h>
58 #include <sys/thread2.h>
60 #include <machine/bus.h>
64 #include "usbdi_util.h"
68 #if defined(__FreeBSD__) || defined(__DragonFly__)
70 #include <machine/clock.h>
71 #define delay(d) DELAY(d)
75 #define DPRINTF(x) if (usbdebug) logprintf x
76 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x
83 Static usbd_status usbd_ar_pipe(usbd_pipe_handle pipe);
84 Static void usbd_do_request_async_cb
85 (usbd_xfer_handle, usbd_private_handle, usbd_status);
86 Static void usbd_start_next(usbd_pipe_handle pipe);
87 Static usbd_status usbd_open_pipe_ival
88 (usbd_interface_handle, u_int8_t, u_int8_t, usbd_pipe_handle *, int);
89 Static int usbd_xfer_isread(usbd_xfer_handle xfer);
91 Static int usbd_nbuses = 0;
106 usbd_xfer_isread(usbd_xfer_handle xfer)
108 if (xfer->rqflags & URQ_REQUEST)
109 return (xfer->request.bmRequestType & UT_READ);
111 return (xfer->pipe->endpoint->edesc->bEndpointAddress &
117 usbd_dump_iface(struct usbd_interface *iface)
119 printf("usbd_dump_iface: iface=%p\n", iface);
122 printf(" device=%p idesc=%p index=%d altindex=%d priv=%p\n",
123 iface->device, iface->idesc, iface->index, iface->altindex,
128 usbd_dump_device(struct usbd_device *dev)
130 printf("usbd_dump_device: dev=%p\n", dev);
133 printf(" bus=%p default_pipe=%p\n", dev->bus, dev->default_pipe);
134 printf(" address=%d config=%d depth=%d speed=%d self_powered=%d "
135 "power=%d langid=%d\n",
136 dev->address, dev->config, dev->depth, dev->speed,
137 dev->self_powered, dev->power, dev->langid);
141 usbd_dump_endpoint(struct usbd_endpoint *endp)
143 printf("usbd_dump_endpoint: endp=%p\n", endp);
146 printf(" edesc=%p refcnt=%d\n", endp->edesc, endp->refcnt);
148 printf(" bEndpointAddress=0x%02x\n",
149 endp->edesc->bEndpointAddress);
153 usbd_dump_queue(usbd_pipe_handle pipe)
155 usbd_xfer_handle xfer;
157 printf("usbd_dump_queue: pipe=%p\n", pipe);
158 SIMPLEQ_FOREACH(xfer, &pipe->queue, next) {
159 printf(" xfer=%p\n", xfer);
164 usbd_dump_pipe(usbd_pipe_handle pipe)
166 printf("usbd_dump_pipe: pipe=%p\n", pipe);
169 usbd_dump_iface(pipe->iface);
170 usbd_dump_device(pipe->device);
171 usbd_dump_endpoint(pipe->endpoint);
172 printf(" (usbd_dump_pipe:)\n refcnt=%d running=%d aborting=%d\n",
173 pipe->refcnt, pipe->running, pipe->aborting);
174 printf(" intrxfer=%p, repeat=%d, interval=%d\n",
175 pipe->intrxfer, pipe->repeat, pipe->interval);
180 usbd_open_pipe(usbd_interface_handle iface, u_int8_t address,
181 u_int8_t flags, usbd_pipe_handle *pipe)
183 return (usbd_open_pipe_ival(iface, address, flags, pipe,
184 USBD_DEFAULT_INTERVAL));
188 usbd_open_pipe_ival(usbd_interface_handle iface, u_int8_t address,
189 u_int8_t flags, usbd_pipe_handle *pipe, int ival)
192 struct usbd_endpoint *ep;
196 DPRINTFN(3,("usbd_open_pipe: iface=%p address=0x%x flags=0x%x\n",
197 iface, address, flags));
199 for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
200 ep = &iface->endpoints[i];
201 if (ep->edesc == NULL)
202 return (USBD_IOERROR);
203 if (ep->edesc->bEndpointAddress == address)
206 return (USBD_BAD_ADDRESS);
208 if ((flags & USBD_EXCLUSIVE_USE) && ep->refcnt != 0)
209 return (USBD_IN_USE);
210 err = usbd_setup_pipe(iface->device, iface, ep, ival, &p);
213 LIST_INSERT_HEAD(&iface->pipes, p, next);
215 return (USBD_NORMAL_COMPLETION);
219 usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address,
220 u_int8_t flags, usbd_pipe_handle *pipe,
221 usbd_private_handle priv, void *buffer, u_int32_t len,
222 usbd_callback cb, int ival)
225 usbd_xfer_handle xfer;
226 usbd_pipe_handle ipipe;
228 DPRINTFN(3,("usbd_open_pipe_intr: address=0x%x flags=0x%x len=%d\n",
229 address, flags, len));
231 err = usbd_open_pipe_ival(iface, address, USBD_EXCLUSIVE_USE,
235 xfer = usbd_alloc_xfer(iface->device);
240 usbd_setup_xfer(xfer, ipipe, priv, buffer, len, flags,
241 USBD_NO_TIMEOUT, cb);
242 ipipe->intrxfer = xfer;
244 err = usbd_transfer(xfer);
246 if (err != USBD_IN_PROGRESS)
248 return (USBD_NORMAL_COMPLETION);
251 ipipe->intrxfer = NULL;
253 usbd_free_xfer(xfer);
255 usbd_close_pipe(ipipe);
260 usbd_close_pipe(usbd_pipe_handle pipe)
264 printf("usbd_close_pipe: pipe==NULL\n");
265 return (USBD_NORMAL_COMPLETION);
269 if (--pipe->refcnt != 0)
270 return (USBD_NORMAL_COMPLETION);
271 if (! SIMPLEQ_EMPTY(&pipe->queue))
272 return (USBD_PENDING_REQUESTS);
273 LIST_REMOVE(pipe, next);
274 pipe->endpoint->refcnt--;
275 pipe->methods->close(pipe);
276 if (pipe->intrxfer != NULL)
277 usbd_free_xfer(pipe->intrxfer);
279 return (USBD_NORMAL_COMPLETION);
283 usbd_transfer(usbd_xfer_handle xfer)
285 usbd_pipe_handle pipe = xfer->pipe;
286 usb_dma_t *dmap = &xfer->dmabuf;
290 DPRINTFN(5,("usbd_transfer: xfer=%p, flags=%d, pipe=%p, running=%d\n",
291 xfer, xfer->flags, pipe, pipe->running));
294 usbd_dump_queue(pipe);
299 return (USBD_CANCELLED);
302 /* If there is no buffer, allocate one. */
303 if (!(xfer->rqflags & URQ_DEV_DMABUF) && size != 0) {
304 struct usbd_bus *bus = pipe->device->bus;
307 if (xfer->rqflags & URQ_AUTO_DMABUF)
308 printf("usbd_transfer: has old buffer!\n");
310 err = bus->methods->allocm(bus, dmap, size);
313 xfer->rqflags |= URQ_AUTO_DMABUF;
316 /* Copy data if going out. */
317 if (!(xfer->flags & USBD_NO_COPY) && size != 0 &&
318 !usbd_xfer_isread(xfer))
319 memcpy(KERNADDR(dmap, 0), xfer->buffer, size);
321 err = pipe->methods->transfer(xfer);
323 if (err != USBD_IN_PROGRESS && err) {
324 /* The transfer has not been queued, so free buffer. */
325 if (xfer->rqflags & URQ_AUTO_DMABUF) {
326 struct usbd_bus *bus = pipe->device->bus;
328 bus->methods->freem(bus, &xfer->dmabuf);
329 xfer->rqflags &= ~URQ_AUTO_DMABUF;
333 if (!(xfer->flags & USBD_SYNCHRONOUS))
336 /* Sync transfer, wait for completion. */
337 if (err != USBD_IN_PROGRESS)
341 if (pipe->device->bus->use_polling)
342 panic("usbd_transfer: not done\n");
343 tsleep(xfer, 0, "usbsyn", 0);
346 return (xfer->status);
349 /* Like usbd_transfer(), but waits for completion. */
351 usbd_sync_transfer(usbd_xfer_handle xfer)
353 xfer->flags |= USBD_SYNCHRONOUS;
354 return (usbd_transfer(xfer));
358 usbd_alloc_buffer(usbd_xfer_handle xfer, u_int32_t size)
360 struct usbd_bus *bus = xfer->device->bus;
364 if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
365 printf("usbd_alloc_buffer: xfer already has a buffer\n");
367 err = bus->methods->allocm(bus, &xfer->dmabuf, size);
370 xfer->rqflags |= URQ_DEV_DMABUF;
371 return (KERNADDR(&xfer->dmabuf, 0));
375 usbd_free_buffer(usbd_xfer_handle xfer)
378 if (!(xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))) {
379 printf("usbd_free_buffer: no buffer\n");
383 xfer->rqflags &= ~(URQ_DEV_DMABUF | URQ_AUTO_DMABUF);
384 xfer->device->bus->methods->freem(xfer->device->bus, &xfer->dmabuf);
388 usbd_get_buffer(usbd_xfer_handle xfer)
390 if (!(xfer->rqflags & URQ_DEV_DMABUF))
392 return (KERNADDR(&xfer->dmabuf, 0));
396 usbd_alloc_xfer(usbd_device_handle dev)
398 usbd_xfer_handle xfer;
400 xfer = dev->bus->methods->allocx(dev->bus);
404 usb_callout_init(xfer->timeout_handle);
405 DPRINTFN(5,("usbd_alloc_xfer() = %p\n", xfer));
410 usbd_free_xfer(usbd_xfer_handle xfer)
412 DPRINTFN(5,("usbd_free_xfer: %p\n", xfer));
413 if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
414 usbd_free_buffer(xfer);
415 #if defined(__NetBSD__) && defined(DIAGNOSTIC)
416 if (callout_pending(&xfer->timeout_handle)) {
417 callout_stop(&xfer->timeout_handle);
418 printf("usbd_free_xfer: timout_handle pending");
421 xfer->device->bus->methods->freex(xfer->device->bus, xfer);
422 return (USBD_NORMAL_COMPLETION);
426 usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
427 usbd_private_handle priv, void *buffer, u_int32_t length,
428 u_int16_t flags, u_int32_t timeout,
429 usbd_callback callback)
433 xfer->buffer = buffer;
434 xfer->length = length;
437 xfer->timeout = timeout;
438 xfer->status = USBD_NOT_STARTED;
439 xfer->callback = callback;
440 xfer->rqflags &= ~URQ_REQUEST;
445 usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev,
446 usbd_private_handle priv, u_int32_t timeout,
447 usb_device_request_t *req, void *buffer,
448 u_int32_t length, u_int16_t flags,
449 usbd_callback callback)
451 xfer->pipe = dev->default_pipe;
453 xfer->buffer = buffer;
454 xfer->length = length;
457 xfer->timeout = timeout;
458 xfer->status = USBD_NOT_STARTED;
459 xfer->callback = callback;
460 xfer->request = *req;
461 xfer->rqflags |= URQ_REQUEST;
466 usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
467 usbd_private_handle priv, u_int16_t *frlengths,
468 u_int32_t nframes, u_int16_t flags, usbd_callback callback)
476 xfer->timeout = USBD_NO_TIMEOUT;
477 xfer->status = USBD_NOT_STARTED;
478 xfer->callback = callback;
479 xfer->rqflags &= ~URQ_REQUEST;
480 xfer->frlengths = frlengths;
481 xfer->nframes = nframes;
485 usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv,
486 void **buffer, u_int32_t *count, usbd_status *status)
491 *buffer = xfer->buffer;
493 *count = xfer->actlen;
495 *status = xfer->status;
498 usb_config_descriptor_t *
499 usbd_get_config_descriptor(usbd_device_handle dev)
503 printf("usbd_get_config_descriptor: dev == NULL\n");
510 usb_interface_descriptor_t *
511 usbd_get_interface_descriptor(usbd_interface_handle iface)
515 printf("usbd_get_interface_descriptor: dev == NULL\n");
519 return (iface->idesc);
522 usb_device_descriptor_t *
523 usbd_get_device_descriptor(usbd_device_handle dev)
525 return (&dev->ddesc);
528 usb_endpoint_descriptor_t *
529 usbd_interface2endpoint_descriptor(usbd_interface_handle iface, u_int8_t index)
531 if (index >= iface->idesc->bNumEndpoints)
533 return (iface->endpoints[index].edesc);
537 usbd_abort_pipe(usbd_pipe_handle pipe)
543 printf("usbd_close_pipe: pipe==NULL\n");
544 return (USBD_NORMAL_COMPLETION);
548 err = usbd_ar_pipe(pipe);
554 usbd_clear_endpoint_stall(usbd_pipe_handle pipe)
556 usbd_device_handle dev = pipe->device;
557 usb_device_request_t req;
560 DPRINTFN(8, ("usbd_clear_endpoint_stall\n"));
563 * Clearing en endpoint stall resets the endpoint toggle, so
564 * do the same to the HC toggle.
566 pipe->methods->cleartoggle(pipe);
568 req.bmRequestType = UT_WRITE_ENDPOINT;
569 req.bRequest = UR_CLEAR_FEATURE;
570 USETW(req.wValue, UF_ENDPOINT_HALT);
571 USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
572 USETW(req.wLength, 0);
573 err = usbd_do_request(dev, &req, 0);
575 XXX should we do this?
577 pipe->state = USBD_PIPE_ACTIVE;
578 /* XXX activate pipe */
585 usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe)
587 usbd_device_handle dev = pipe->device;
588 usb_device_request_t req;
591 pipe->methods->cleartoggle(pipe);
593 req.bmRequestType = UT_WRITE_ENDPOINT;
594 req.bRequest = UR_CLEAR_FEATURE;
595 USETW(req.wValue, UF_ENDPOINT_HALT);
596 USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
597 USETW(req.wLength, 0);
598 err = usbd_do_request_async(dev, &req, 0);
603 usbd_clear_endpoint_toggle(usbd_pipe_handle pipe)
605 pipe->methods->cleartoggle(pipe);
609 usbd_endpoint_count(usbd_interface_handle iface, u_int8_t *count)
612 if (iface == NULL || iface->idesc == NULL) {
613 printf("usbd_endpoint_count: NULL pointer\n");
617 *count = iface->idesc->bNumEndpoints;
618 return (USBD_NORMAL_COMPLETION);
622 usbd_interface_count(usbd_device_handle dev, u_int8_t *count)
624 if (dev->cdesc == NULL)
625 return (USBD_NOT_CONFIGURED);
626 *count = dev->cdesc->bNumInterface;
627 return (USBD_NORMAL_COMPLETION);
631 usbd_interface2device_handle(usbd_interface_handle iface,
632 usbd_device_handle *dev)
634 *dev = iface->device;
638 usbd_device2interface_handle(usbd_device_handle dev,
639 u_int8_t ifaceno, usbd_interface_handle *iface)
641 if (dev->cdesc == NULL)
642 return (USBD_NOT_CONFIGURED);
643 if (ifaceno >= dev->cdesc->bNumInterface)
645 *iface = &dev->ifaces[ifaceno];
646 return (USBD_NORMAL_COMPLETION);
650 usbd_pipe2device_handle(usbd_pipe_handle pipe)
652 return (pipe->device);
657 usbd_set_interface(usbd_interface_handle iface, int altidx)
659 usb_device_request_t req;
663 if (LIST_FIRST(&iface->pipes) != 0)
664 return (USBD_IN_USE);
666 endpoints = iface->endpoints;
667 err = usbd_fill_iface_data(iface->device, iface->index, altidx);
671 /* new setting works, we can free old endpoints */
672 if (endpoints != NULL)
673 kfree(endpoints, M_USB);
676 if (iface->idesc == NULL) {
677 printf("usbd_set_interface: NULL pointer\n");
682 req.bmRequestType = UT_WRITE_INTERFACE;
683 req.bRequest = UR_SET_INTERFACE;
684 USETW(req.wValue, iface->idesc->bAlternateSetting);
685 USETW(req.wIndex, iface->idesc->bInterfaceNumber);
686 USETW(req.wLength, 0);
687 return (usbd_do_request(iface->device, &req, 0));
691 usbd_get_no_alts(usb_config_descriptor_t *cdesc, int ifaceno)
693 char *p = (char *)cdesc;
694 char *end = p + UGETW(cdesc->wTotalLength);
695 usb_interface_descriptor_t *d;
698 for (n = 0; p < end; p += d->bLength) {
699 d = (usb_interface_descriptor_t *)p;
700 if (p + d->bLength <= end &&
701 d->bDescriptorType == UDESC_INTERFACE &&
702 d->bInterfaceNumber == ifaceno)
709 usbd_get_interface_altindex(usbd_interface_handle iface)
711 return (iface->altindex);
715 usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface)
717 usb_device_request_t req;
719 req.bmRequestType = UT_READ_INTERFACE;
720 req.bRequest = UR_GET_INTERFACE;
721 USETW(req.wValue, 0);
722 USETW(req.wIndex, iface->idesc->bInterfaceNumber);
723 USETW(req.wLength, 1);
724 return (usbd_do_request(iface->device, &req, aiface));
727 /*** Internal routines ***/
729 /* Dequeue all pipe operations, called from a critical section. */
731 usbd_ar_pipe(usbd_pipe_handle pipe)
733 usbd_xfer_handle xfer;
735 DPRINTFN(2,("usbd_ar_pipe: pipe=%p\n", pipe));
738 usbd_dump_queue(pipe);
742 while ((xfer = SIMPLEQ_FIRST(&pipe->queue)) != NULL) {
743 DPRINTFN(2,("usbd_ar_pipe: pipe=%p xfer=%p (methods=%p)\n",
744 pipe, xfer, pipe->methods));
745 /* Make the HC abort it (and invoke the callback). */
746 pipe->methods->abort(xfer);
747 /* XXX only for non-0 usbd_clear_endpoint_stall(pipe); */
750 return (USBD_NORMAL_COMPLETION);
753 /* Called from a critical section. */
755 usb_transfer_complete(usbd_xfer_handle xfer)
757 usbd_pipe_handle pipe = xfer->pipe;
758 usb_dma_t *dmap = &xfer->dmabuf;
759 int repeat = pipe->repeat;
762 DPRINTFN(5, ("usb_transfer_complete: pipe=%p xfer=%p status=%d "
763 "actlen=%d\n", pipe, xfer, xfer->status, xfer->actlen));
765 if (xfer->busy_free != XFER_ONQU) {
766 printf("usb_transfer_complete: xfer=%p not busy 0x%08x\n",
767 xfer, xfer->busy_free);
774 printf("usbd_transfer_cb: pipe==0, xfer=%p\n", xfer);
778 polling = pipe->device->bus->use_polling;
783 if (!(xfer->flags & USBD_NO_COPY) && xfer->actlen != 0 &&
784 usbd_xfer_isread(xfer)) {
786 if (xfer->actlen > xfer->length) {
787 printf("usb_transfer_complete: actlen > len %d > %d\n",
788 xfer->actlen, xfer->length);
789 xfer->actlen = xfer->length;
792 memcpy(xfer->buffer, KERNADDR(dmap, 0), xfer->actlen);
795 /* if we allocated the buffer in usbd_transfer() we free it here. */
796 if (xfer->rqflags & URQ_AUTO_DMABUF) {
798 struct usbd_bus *bus = pipe->device->bus;
799 bus->methods->freem(bus, dmap);
800 xfer->rqflags &= ~URQ_AUTO_DMABUF;
805 /* Remove request from queue. */
807 if (xfer != SIMPLEQ_FIRST(&pipe->queue))
808 printf("usb_transfer_complete: bad dequeue %p != %p\n",
809 xfer, SIMPLEQ_FIRST(&pipe->queue));
810 xfer->busy_free = XFER_BUSY;
812 SIMPLEQ_REMOVE_HEAD(&pipe->queue, next);
814 DPRINTFN(5,("usb_transfer_complete: repeat=%d new head=%p\n",
815 repeat, SIMPLEQ_FIRST(&pipe->queue)));
817 /* Count completed transfers. */
818 ++pipe->device->bus->stats.uds_requests
819 [pipe->endpoint->edesc->bmAttributes & UE_XFERTYPE];
822 if (!xfer->status && xfer->actlen < xfer->length &&
823 !(xfer->flags & USBD_SHORT_XFER_OK)) {
824 DPRINTFN(-1,("usbd_transfer_cb: short transfer %d<%d\n",
825 xfer->actlen, xfer->length));
826 xfer->status = USBD_SHORT_XFER;
830 xfer->callback(xfer, xfer->priv, xfer->status);
833 if (pipe->methods->done != NULL)
834 pipe->methods->done(xfer);
836 printf("usb_transfer_complete: pipe->methods->done == NULL\n");
838 pipe->methods->done(xfer);
841 if ((xfer->flags & USBD_SYNCHRONOUS) && !polling)
845 /* XXX should we stop the queue on all errors? */
846 if ((xfer->status == USBD_CANCELLED ||
847 xfer->status == USBD_TIMEOUT) &&
848 pipe->iface != NULL) /* not control pipe */
851 usbd_start_next(pipe);
856 usb_insert_transfer(usbd_xfer_handle xfer)
858 usbd_pipe_handle pipe = xfer->pipe;
861 DPRINTFN(5,("usb_insert_transfer: pipe=%p running=%d timeout=%d\n",
862 pipe, pipe->running, xfer->timeout));
864 if (xfer->busy_free != XFER_BUSY) {
865 printf("usb_insert_transfer: xfer=%p not busy 0x%08x\n",
866 xfer, xfer->busy_free);
869 xfer->busy_free = XFER_ONQU;
872 SIMPLEQ_INSERT_TAIL(&pipe->queue, xfer, next);
874 err = USBD_IN_PROGRESS;
877 err = USBD_NORMAL_COMPLETION;
883 /* Called from a critical section. */
885 usbd_start_next(usbd_pipe_handle pipe)
887 usbd_xfer_handle xfer;
892 printf("usbd_start_next: pipe == NULL\n");
895 if (pipe->methods == NULL || pipe->methods->start == NULL) {
896 printf("usbd_start_next: pipe=%p no start method\n", pipe);
901 /* Get next request in queue. */
902 xfer = SIMPLEQ_FIRST(&pipe->queue);
903 DPRINTFN(5, ("usbd_start_next: pipe=%p, xfer=%p\n", pipe, xfer));
907 err = pipe->methods->start(xfer);
908 if (err != USBD_IN_PROGRESS) {
909 printf("usbd_start_next: error=%d\n", err);
918 usbd_do_request(usbd_device_handle dev, usb_device_request_t *req, void *data)
920 return (usbd_do_request_flags(dev, req, data, 0, 0,
921 USBD_DEFAULT_TIMEOUT));
925 usbd_do_request_flags(usbd_device_handle dev, usb_device_request_t *req,
926 void *data, u_int16_t flags, int *actlen, u_int32_t timo)
928 return (usbd_do_request_flags_pipe(dev, dev->default_pipe, req,
929 data, flags, actlen, timo));
933 usbd_do_request_flags_pipe(usbd_device_handle dev, usbd_pipe_handle pipe,
934 usb_device_request_t *req, void *data, u_int16_t flags, int *actlen,
937 usbd_xfer_handle xfer;
941 #if defined(__i386__) && (defined(__FreeBSD__) || defined(__DragonFly__))
942 KASSERT(mycpu->gd_intr_nesting_level == 0,
943 ("usbd_do_request: in interrupt context"));
945 if (dev->bus->intr_context) {
946 printf("usbd_do_request: not in process context\n");
951 xfer = usbd_alloc_xfer(dev);
954 usbd_setup_default_xfer(xfer, dev, 0, timeout, req,
955 data, UGETW(req->wLength), flags, 0);
957 err = usbd_sync_transfer(xfer);
958 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
959 if (xfer->actlen > xfer->length)
960 DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
961 "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
962 dev->address, xfer->request.bmRequestType,
963 xfer->request.bRequest, UGETW(xfer->request.wValue),
964 UGETW(xfer->request.wIndex),
965 UGETW(xfer->request.wLength),
966 xfer->length, xfer->actlen));
969 *actlen = xfer->actlen;
970 if (err == USBD_STALLED) {
972 * The control endpoint has stalled. Control endpoints
973 * should not halt, but some may do so anyway so clear
974 * any halt condition.
976 usb_device_request_t treq;
981 treq.bmRequestType = UT_READ_ENDPOINT;
982 treq.bRequest = UR_GET_STATUS;
983 USETW(treq.wValue, 0);
984 USETW(treq.wIndex, 0);
985 USETW(treq.wLength, sizeof(usb_status_t));
986 usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
987 &treq, &status,sizeof(usb_status_t),
989 nerr = usbd_sync_transfer(xfer);
992 s = UGETW(status.wStatus);
993 DPRINTF(("usbd_do_request: status = 0x%04x\n", s));
996 treq.bmRequestType = UT_WRITE_ENDPOINT;
997 treq.bRequest = UR_CLEAR_FEATURE;
998 USETW(treq.wValue, UF_ENDPOINT_HALT);
999 USETW(treq.wIndex, 0);
1000 USETW(treq.wLength, 0);
1001 usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
1002 &treq, &status, 0, 0, 0);
1003 nerr = usbd_sync_transfer(xfer);
1009 usbd_free_xfer(xfer);
1014 usbd_do_request_async_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
1017 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
1018 if (xfer->actlen > xfer->length)
1019 DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
1020 "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
1021 xfer->pipe->device->address,
1022 xfer->request.bmRequestType,
1023 xfer->request.bRequest, UGETW(xfer->request.wValue),
1024 UGETW(xfer->request.wIndex),
1025 UGETW(xfer->request.wLength),
1026 xfer->length, xfer->actlen));
1028 usbd_free_xfer(xfer);
1032 * Execute a request without waiting for completion.
1033 * Can be used from interrupt context.
1036 usbd_do_request_async(usbd_device_handle dev, usb_device_request_t *req,
1039 usbd_xfer_handle xfer;
1042 xfer = usbd_alloc_xfer(dev);
1044 return (USBD_NOMEM);
1045 usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT, req,
1046 data, UGETW(req->wLength), 0, usbd_do_request_async_cb);
1047 err = usbd_transfer(xfer);
1048 if (err != USBD_IN_PROGRESS) {
1049 usbd_free_xfer(xfer);
1052 return (USBD_NORMAL_COMPLETION);
1055 const struct usbd_quirks *
1056 usbd_get_quirks(usbd_device_handle dev)
1060 printf("usbd_get_quirks: dev == NULL\n");
1064 return (dev->quirks);
1067 /* XXX do periodic free() of free list */
1070 * Called from keyboard driver when in polling mode.
1073 usbd_dopoll(usbd_interface_handle iface)
1075 iface->device->bus->methods->do_poll(iface->device->bus);
1079 usbd_set_polling(usbd_device_handle dev, int on)
1082 dev->bus->use_polling++;
1084 dev->bus->use_polling--;
1085 /* When polling we need to make sure there is nothing pending to do. */
1086 if (dev->bus->use_polling)
1087 dev->bus->methods->soft_intr(dev->bus);
1091 usb_endpoint_descriptor_t *
1092 usbd_get_endpoint_descriptor(usbd_interface_handle iface, u_int8_t address)
1094 struct usbd_endpoint *ep;
1097 for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
1098 ep = &iface->endpoints[i];
1099 if (ep->edesc->bEndpointAddress == address)
1100 return (iface->endpoints[i].edesc);
1106 * usbd_ratecheck() can limit the number of error messages that occurs.
1107 * When a device is unplugged it may take up to 0.25s for the hub driver
1108 * to notice it. If the driver continuosly tries to do I/O operations
1109 * this can generate a large number of messages.
1112 usbd_ratecheck(struct timeval *last)
1115 static struct timeval errinterval = { 0, 250000 }; /* 0.25 s*/
1117 return (ratecheck(last, &errinterval));
1123 * Search for a vendor/product pair in an array. The item size is
1124 * given as an argument.
1126 const struct usb_devno *
1127 usb_match_device(const struct usb_devno *tbl, u_int nentries, u_int sz,
1128 u_int16_t vendor, u_int16_t product)
1130 while (nentries-- > 0) {
1131 u_int16_t tproduct = tbl->ud_product;
1132 if (tbl->ud_vendor == vendor &&
1133 (tproduct == product || tproduct == USB_PRODUCT_ANY))
1135 tbl = (const struct usb_devno *)((const char *)tbl + sz);
1140 #if defined(__FreeBSD__) || defined(__DragonFly__)
1142 usbd_driver_load(module_t mod, int what, void *arg)
1144 /* XXX should implement something like a function that removes all generic devices */