root/dev/usb/usbdi.c

DEFINITIONS

1. usbd_init
2. usbd_finish
3. usbd_xfer_isread
4. usbd_dump_iface
5. usbd_dump_device
6. usbd_dump_endpoint
7. usbd_dump_queue
8. usbd_dump_pipe
9. usbd_open_pipe
10. usbd_open_pipe_ival
11. usbd_open_pipe_intr
12. usbd_close_pipe
13. usbd_transfer
14. usbd_sync_transfer
15. usbd_alloc_buffer
16. usbd_free_buffer
17. usbd_get_buffer
18. usbd_alloc_xfer
19. usbd_free_xfer
20. usbd_setup_xfer
21. usbd_setup_default_xfer
22. usbd_setup_isoc_xfer
23. usbd_get_xfer_status
24. usbd_get_config_descriptor
25. usbd_get_interface_descriptor
26. usbd_get_device_descriptor
27. usbd_interface2endpoint_descriptor
28. usbd_abort_pipe
29. usbd_clear_endpoint_stall
30. usbd_clear_endpoint_stall_async
31. usbd_clear_endpoint_toggle
32. usbd_endpoint_count
33. usbd_interface_count
34. usbd_interface2device_handle
35. usbd_device2interface_handle
36. usbd_pipe2device_handle
37. usbd_set_interface
38. usbd_get_no_alts
39. usbd_get_interface_altindex
40. usbd_get_interface
41. usbd_ar_pipe
42. usb_transfer_complete
43. usb_insert_transfer
44. usbd_start_next
45. usbd_do_request
46. usbd_do_request_flags
47. usbd_do_request_flags_pipe
48. usbd_do_request_async_cb
49. usbd_do_request_async
50. usbd_get_quirks
51. usbd_dopoll
52. usbd_set_polling
53. usbd_get_endpoint_descriptor
54. usbd_ratecheck
55. usb_match_device
56. usb_desc_iter_init
57. usb_desc_iter_next

    1 /*      $OpenBSD: usbdi.c,v 1.33 2007/06/18 11:37:04 mbalmer Exp $ */
    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.28 1999/11/17 22:33:49 n_hibma Exp $      */
    5 /*
    6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
    7  * All rights reserved.
    8  *
    9  * This code is derived from software contributed to The NetBSD Foundation
   10  * by Lennart Augustsson (lennart@augustsson.net) at
   11  * Carlstedt Research & Technology.
   12  *
   13  * Redistribution and use in source and binary forms, with or without
   14  * modification, are permitted provided that the following conditions
   15  * are met:
   16  * 1. Redistributions of source code must retain the above copyright
   17  *    notice, this list of conditions and the following disclaimer.
   18  * 2. Redistributions in binary form must reproduce the above copyright
   19  *    notice, this list of conditions and the following disclaimer in the
   20  *    documentation and/or other materials provided with the distribution.
   21  * 3. All advertising materials mentioning features or use of this software
   22  *    must display the following acknowledgement:
   23  *        This product includes software developed by the NetBSD
   24  *        Foundation, Inc. and its contributors.
   25  * 4. Neither the name of The NetBSD Foundation nor the names of its
   26  *    contributors may be used to endorse or promote products derived
   27  *    from this software without specific prior written permission.
   28  *
   29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
   30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
   33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   39  * POSSIBILITY OF SUCH DAMAGE.
   40  */
   42 #include <sys/param.h>
   43 #include <sys/systm.h>
   44 #include <sys/kernel.h>
   45 #include <sys/device.h>
   46 #include <sys/malloc.h>
   47 #include <sys/proc.h>
   49 #include <machine/bus.h>
   51 #include <dev/usb/usb.h>
   52 #include <dev/usb/usbdi.h>
   53 #include <dev/usb/usbdi_util.h>
   54 #include <dev/usb/usbdivar.h>
   55 #include <dev/usb/usb_mem.h>
   57 #ifdef USB_DEBUG
   58 #define DPRINTF(x)      do { if (usbdebug) printf x; } while (0)
   59 #define DPRINTFN(n,x)   do { if (usbdebug>(n)) printf x; } while (0)
   60 extern int usbdebug;
   61 #else
   62 #define DPRINTF(x)
   63 #define DPRINTFN(n,x)
   64 #endif
usbd_status usbd_ar_pipe(usbd_pipe_handle pipe);
   67 void usbd_do_request_async_cb(usbd_xfer_handle, usbd_private_handle,
usbd_status);
   69 void usbd_start_next(usbd_pipe_handle pipe);
usbd_status usbd_open_pipe_ival(usbd_interface_handle, u_int8_t, u_int8_t,
usbd_pipe_handle *, int);
   73 int usbd_nbuses = 0;
   75 void
usbd_init(void)
   77 {
usbd_nbuses++;
   79 }
   81 void
usbd_finish(void)
   83 {
   84         --usbd_nbuses;
   85 }
   87 static __inline int
usbd_xfer_isread(usbd_xfer_handle xfer)
   89 {
   90         if (xfer->rqflags & URQ_REQUEST)
   91                 return (xfer->request.bmRequestType & UT_READ);
   92         else
   93                 return (xfer->pipe->endpoint->edesc->bEndpointAddress &
UE_DIR_IN);
   95 }
   97 #ifdef USB_DEBUG
   98 void
usbd_dump_iface(struct usbd_interface *iface)
  100 {
printf("usbd_dump_iface: iface=%p\n", iface);
  102         if (iface == NULL)
  103                 return;
printf(" device=%p idesc=%p index=%d altindex=%d priv=%p\n",
iface->device, iface->idesc, iface->index, iface->altindex,
iface->priv);
  107 }
  109 void
usbd_dump_device(struct usbd_device *dev)
  111 {
printf("usbd_dump_device: dev=%p\n", dev);
  113         if (dev == NULL)
  114                 return;
printf(" bus=%p default_pipe=%p\n", dev->bus, dev->default_pipe);
printf(" address=%d config=%d depth=%d speed=%d self_powered=%d "
  117             "power=%d langid=%d\n", dev->address, dev->config, dev->depth,
dev->speed, dev->self_powered, dev->power, dev->langid);
  119 }
  121 void
usbd_dump_endpoint(struct usbd_endpoint *endp)
  123 {
printf("usbd_dump_endpoint: endp=%p\n", endp);
  125         if (endp == NULL)
  126                 return;
printf(" edesc=%p refcnt=%d\n", endp->edesc, endp->refcnt);
  128         if (endp->edesc)
printf(" bEndpointAddress=0x%02x\n",
endp->edesc->bEndpointAddress);
  131 }
  133 void
usbd_dump_queue(usbd_pipe_handle pipe)
  135 {
usbd_xfer_handle xfer;
printf("usbd_dump_queue: pipe=%p\n", pipe);
SIMPLEQ_FOREACH(xfer, &pipe->queue, next) {
printf("  xfer=%p\n", xfer);
  141         }
  142 }
  144 void
usbd_dump_pipe(usbd_pipe_handle pipe)
  146 {
printf("usbd_dump_pipe: pipe=%p\n", pipe);
  148         if (pipe == NULL)
  149                 return;
usbd_dump_iface(pipe->iface);
usbd_dump_device(pipe->device);
usbd_dump_endpoint(pipe->endpoint);
printf(" (usbd_dump_pipe:)\n refcnt=%d running=%d aborting=%d\n",
pipe->refcnt, pipe->running, pipe->aborting);
printf(" intrxfer=%p, repeat=%d, interval=%d\n", pipe->intrxfer,
pipe->repeat, pipe->interval);
  157 }
  158 #endif
usbd_status
usbd_open_pipe(usbd_interface_handle iface, u_int8_t address, u_int8_t flags,
usbd_pipe_handle *pipe)
  163 {
  164         return (usbd_open_pipe_ival(iface, address, flags, pipe,
USBD_DEFAULT_INTERVAL));
  166 }
usbd_status
usbd_open_pipe_ival(usbd_interface_handle iface, u_int8_t address,
u_int8_t flags, usbd_pipe_handle *pipe, int ival)
  171 {
usbd_pipe_handle p;
  173         struct usbd_endpoint *ep;
usbd_status err;
  175         int i;
DPRINTFN(3,("usbd_open_pipe: iface=%p address=0x%x flags=0x%x\n",
iface, address, flags));
  180         for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
ep = &iface->endpoints[i];
  182                 if (ep->edesc == NULL)
  183                         return (USBD_IOERROR);
  184                 if (ep->edesc->bEndpointAddress == address)
  185                         goto found;
  186         }
  187         return (USBD_BAD_ADDRESS);
found:
  189         if ((flags & USBD_EXCLUSIVE_USE) && ep->refcnt != 0)
  190                 return (USBD_IN_USE);
err = usbd_setup_pipe(iface->device, iface, ep, ival, &p);
  192         if (err)
  193                 return (err);
LIST_INSERT_HEAD(&iface->pipes, p, next);
  195         *pipe = p;
  196         return (USBD_NORMAL_COMPLETION);
  197 }
usbd_status
usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address,
u_int8_t flags, usbd_pipe_handle *pipe, usbd_private_handle priv,
  202     void *buffer, u_int32_t len, usbd_callback cb, int ival)
  203 {
usbd_status err;
usbd_xfer_handle xfer;
usbd_pipe_handle ipipe;
DPRINTFN(3,("usbd_open_pipe_intr: address=0x%x flags=0x%x len=%d\n",
address, flags, len));
err = usbd_open_pipe_ival(iface, address, USBD_EXCLUSIVE_USE, &ipipe,
ival);
  213         if (err)
  214                 return (err);
xfer = usbd_alloc_xfer(iface->device);
  216         if (xfer == NULL) {
err = USBD_NOMEM;
  218                 goto bad1;
  219         }
usbd_setup_xfer(xfer, ipipe, priv, buffer, len, flags,
USBD_NO_TIMEOUT, cb);
ipipe->intrxfer = xfer;
ipipe->repeat = 1;
err = usbd_transfer(xfer);
  225         *pipe = ipipe;
  226         if (err != USBD_IN_PROGRESS)
  227                 goto bad2;
  228         return (USBD_NORMAL_COMPLETION);
bad2:
ipipe->intrxfer = NULL;
ipipe->repeat = 0;
usbd_free_xfer(xfer);
bad1:
usbd_close_pipe(ipipe);
  236         return (err);
  237 }
usbd_status
usbd_close_pipe(usbd_pipe_handle pipe)
  241 {
  242 #ifdef DIAGNOSTIC
  243         if (pipe == NULL) {
printf("usbd_close_pipe: pipe==NULL\n");
  245                 return (USBD_NORMAL_COMPLETION);
  246         }
  247 #endif
  249         if (--pipe->refcnt != 0)
  250                 return (USBD_NORMAL_COMPLETION);
  251         if (! SIMPLEQ_EMPTY(&pipe->queue))
  252                 return (USBD_PENDING_REQUESTS);
LIST_REMOVE(pipe, next);
pipe->endpoint->refcnt--;
pipe->methods->close(pipe);
  256         if (pipe->intrxfer != NULL)
usbd_free_xfer(pipe->intrxfer);
free(pipe, M_USB);
  259         return (USBD_NORMAL_COMPLETION);
  260 }
usbd_status
usbd_transfer(usbd_xfer_handle xfer)
  264 {
usbd_pipe_handle pipe = xfer->pipe;
usb_dma_t *dmap = &xfer->dmabuf;
usbd_status err;
u_int size;
  269         int s;
DPRINTFN(5,("usbd_transfer: xfer=%p, flags=%d, pipe=%p, running=%d\n",
xfer, xfer->flags, pipe, pipe->running));
  273 #ifdef USB_DEBUG
  274         if (usbdebug > 5)
usbd_dump_queue(pipe);
  276 #endif
xfer->done = 0;
  279         if (pipe->aborting)
  280                 return (USBD_CANCELLED);
size = xfer->length;
  283         /* If there is no buffer, allocate one. */
  284         if (!(xfer->rqflags & URQ_DEV_DMABUF) && size != 0) {
  285                 struct usbd_bus *bus = pipe->device->bus;
  287 #ifdef DIAGNOSTIC
  288                 if (xfer->rqflags & URQ_AUTO_DMABUF)
printf("usbd_transfer: has old buffer!\n");
  290 #endif
err = bus->methods->allocm(bus, dmap, size);
  292                 if (err)
  293                         return (err);
xfer->rqflags |= URQ_AUTO_DMABUF;
  295         }
  297         /* Copy data if going out. */
  298         if (!(xfer->flags & USBD_NO_COPY) && size != 0 &&
  299             !usbd_xfer_isread(xfer))
memcpy(KERNADDR(dmap, 0), xfer->buffer, size);
err = pipe->methods->transfer(xfer);
  304         if (err != USBD_IN_PROGRESS && err) {
  305                 /* The transfer has not been queued, so free buffer. */
  306                 if (xfer->rqflags & URQ_AUTO_DMABUF) {
  307                         struct usbd_bus *bus = pipe->device->bus;
bus->methods->freem(bus, &xfer->dmabuf);
xfer->rqflags &= ~URQ_AUTO_DMABUF;
  311                 }
  312         }
  314         if (!(xfer->flags & USBD_SYNCHRONOUS))
  315                 return (err);
  317         /* Sync transfer, wait for completion. */
  318         if (err != USBD_IN_PROGRESS)
  319                 return (err);
s = splusb();
  321         while (!xfer->done) {
  322                 if (pipe->device->bus->use_polling)
panic("usbd_transfer: not done");
tsleep(xfer, PRIBIO, "usbsyn", 0);
  325         }
splx(s);
  327         return (xfer->status);
  328 }
  330 /* Like usbd_transfer(), but waits for completion. */
usbd_status
usbd_sync_transfer(usbd_xfer_handle xfer)
  333 {
xfer->flags |= USBD_SYNCHRONOUS;
  335         return (usbd_transfer(xfer));
  336 }
  338 void *
usbd_alloc_buffer(usbd_xfer_handle xfer, u_int32_t size)
  340 {
  341         struct usbd_bus *bus = xfer->device->bus;
usbd_status err;
  344 #ifdef DIAGNOSTIC
  345         if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
printf("usbd_alloc_buffer: xfer already has a buffer\n");
  347 #endif
err = bus->methods->allocm(bus, &xfer->dmabuf, size);
  349         if (err)
  350                 return (NULL);
xfer->rqflags |= URQ_DEV_DMABUF;
  352         return (KERNADDR(&xfer->dmabuf, 0));
  353 }
  355 void
usbd_free_buffer(usbd_xfer_handle xfer)
  357 {
  358 #ifdef DIAGNOSTIC
  359         if (!(xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))) {
printf("usbd_free_buffer: no buffer\n");
  361                 return;
  362         }
  363 #endif
xfer->rqflags &= ~(URQ_DEV_DMABUF | URQ_AUTO_DMABUF);
xfer->device->bus->methods->freem(xfer->device->bus, &xfer->dmabuf);
  366 }
  368 void *
usbd_get_buffer(usbd_xfer_handle xfer)
  370 {
  371         if (!(xfer->rqflags & URQ_DEV_DMABUF))
  372                 return (0);
  373         return (KERNADDR(&xfer->dmabuf, 0));
  374 }
usbd_xfer_handle
usbd_alloc_xfer(usbd_device_handle dev)
  378 {
usbd_xfer_handle xfer;
xfer = dev->bus->methods->allocx(dev->bus);
  382         if (xfer == NULL)
  383                 return (NULL);
xfer->device = dev;
timeout_set(&xfer->timeout_handle, NULL, NULL);
DPRINTFN(5,("usbd_alloc_xfer() = %p\n", xfer));
  387         return (xfer);
  388 }
usbd_status
usbd_free_xfer(usbd_xfer_handle xfer)
  392 {
DPRINTFN(5,("usbd_free_xfer: %p\n", xfer));
  394         if (xfer->rqflags & (URQ_DEV_DMABUF | URQ_AUTO_DMABUF))
usbd_free_buffer(xfer);
xfer->device->bus->methods->freex(xfer->device->bus, xfer);
  397         return (USBD_NORMAL_COMPLETION);
  398 }
  400 void
usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
usbd_private_handle priv, void *buffer, u_int32_t length, u_int16_t flags,
u_int32_t timeout, usbd_callback callback)
  404 {
xfer->pipe = pipe;
xfer->priv = priv;
xfer->buffer = buffer;
xfer->length = length;
xfer->actlen = 0;
xfer->flags = flags;
xfer->timeout = timeout;
xfer->status = USBD_NOT_STARTED;
xfer->callback = callback;
xfer->rqflags &= ~URQ_REQUEST;
xfer->nframes = 0;
  416 }
  418 void
usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev,
usbd_private_handle priv, u_int32_t timeout, usb_device_request_t *req,
  421     void *buffer, u_int32_t length, u_int16_t flags, usbd_callback callback)
  422 {
xfer->pipe = dev->default_pipe;
xfer->priv = priv;
xfer->buffer = buffer;
xfer->length = length;
xfer->actlen = 0;
xfer->flags = flags;
xfer->timeout = timeout;
xfer->status = USBD_NOT_STARTED;
xfer->callback = callback;
xfer->request = *req;
xfer->rqflags |= URQ_REQUEST;
xfer->nframes = 0;
  435 }
  437 void
usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
usbd_private_handle priv, u_int16_t *frlengths, u_int32_t nframes,
u_int16_t flags, usbd_callback callback)
  441 {
xfer->pipe = pipe;
xfer->priv = priv;
xfer->buffer = 0;
xfer->length = 0;
xfer->actlen = 0;
xfer->flags = flags;
xfer->timeout = USBD_NO_TIMEOUT;
xfer->status = USBD_NOT_STARTED;
xfer->callback = callback;
xfer->rqflags &= ~URQ_REQUEST;
xfer->frlengths = frlengths;
xfer->nframes = nframes;
  454 }
  456 void
usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv,
  458     void **buffer, u_int32_t *count, usbd_status *status)
  459 {
  460         if (priv != NULL)
  461                 *priv = xfer->priv;
  462         if (buffer != NULL)
  463                 *buffer = xfer->buffer;
  464         if (count != NULL)
  465                 *count = xfer->actlen;
  466         if (status != NULL)
  467                 *status = xfer->status;
  468 }
usb_config_descriptor_t *
usbd_get_config_descriptor(usbd_device_handle dev)
  472 {
  473 #ifdef DIAGNOSTIC
  474         if (dev == NULL) {
printf("usbd_get_config_descriptor: dev == NULL\n");
  476                 return (NULL);
  477         }
  478 #endif
  479         return (dev->cdesc);
  480 }
usb_interface_descriptor_t *
usbd_get_interface_descriptor(usbd_interface_handle iface)
  484 {
  485 #ifdef DIAGNOSTIC
  486         if (iface == NULL) {
printf("usbd_get_interface_descriptor: dev == NULL\n");
  488                 return (NULL);
  489         }
  490 #endif
  491         return (iface->idesc);
  492 }
usb_device_descriptor_t *
usbd_get_device_descriptor(usbd_device_handle dev)
  496 {
  497         return (&dev->ddesc);
  498 }
usb_endpoint_descriptor_t *
usbd_interface2endpoint_descriptor(usbd_interface_handle iface, u_int8_t index)
  502 {
  503         if (index >= iface->idesc->bNumEndpoints)
  504                 return (0);
  505         return (iface->endpoints[index].edesc);
  506 }
usbd_status
usbd_abort_pipe(usbd_pipe_handle pipe)
  510 {
usbd_status err;
  512         int s;
  514 #ifdef DIAGNOSTIC
  515         if (pipe == NULL) {
printf("usbd_abort_pipe: pipe==NULL\n");
  517                 return (USBD_NORMAL_COMPLETION);
  518         }
  519 #endif
s = splusb();
err = usbd_ar_pipe(pipe);
splx(s);
  523         return (err);
  524 }
usbd_status
usbd_clear_endpoint_stall(usbd_pipe_handle pipe)
  528 {
usbd_device_handle dev = pipe->device;
usb_device_request_t req;
usbd_status err;
DPRINTFN(8, ("usbd_clear_endpoint_stall\n"));
  535         /*
  536          * Clearing en endpoint stall resets the endpoint toggle, so
  537          * do the same to the HC toggle.
  538          */
pipe->methods->cleartoggle(pipe);
req.bmRequestType = UT_WRITE_ENDPOINT;
req.bRequest = UR_CLEAR_FEATURE;
USETW(req.wValue, UF_ENDPOINT_HALT);
USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
USETW(req.wLength, 0);
err = usbd_do_request(dev, &req, 0);
  547 #if 0
XXX should we do this?
  549         if (!err) {
pipe->state = USBD_PIPE_ACTIVE;
  551                 /* XXX activate pipe */
  552         }
  553 #endif
  554         return (err);
  555 }
usbd_status
usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe)
  559 {
usbd_device_handle dev = pipe->device;
usb_device_request_t req;
usbd_status err;
pipe->methods->cleartoggle(pipe);
req.bmRequestType = UT_WRITE_ENDPOINT;
req.bRequest = UR_CLEAR_FEATURE;
USETW(req.wValue, UF_ENDPOINT_HALT);
USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
USETW(req.wLength, 0);
err = usbd_do_request_async(dev, &req, 0);
  572         return (err);
  573 }
  575 void
usbd_clear_endpoint_toggle(usbd_pipe_handle pipe)
  577 {
pipe->methods->cleartoggle(pipe);
  579 }
usbd_status
usbd_endpoint_count(usbd_interface_handle iface, u_int8_t *count)
  583 {
  584 #ifdef DIAGNOSTIC
  585         if (iface == NULL || iface->idesc == NULL) {
printf("usbd_endpoint_count: NULL pointer\n");
  587                 return (USBD_INVAL);
  588         }
  589 #endif
  590         *count = iface->idesc->bNumEndpoints;
  591         return (USBD_NORMAL_COMPLETION);
  592 }
usbd_status
usbd_interface_count(usbd_device_handle dev, u_int8_t *count)
  596 {
  597         if (dev->cdesc == NULL)
  598                 return (USBD_NOT_CONFIGURED);
  599         *count = dev->cdesc->bNumInterface;
  600         return (USBD_NORMAL_COMPLETION);
  601 }
  603 void
usbd_interface2device_handle(usbd_interface_handle iface,
usbd_device_handle *dev)
  606 {
  607         *dev = iface->device;
  608 }
usbd_status
usbd_device2interface_handle(usbd_device_handle dev, u_int8_t ifaceno,
usbd_interface_handle *iface)
  613 {
  614         if (dev->cdesc == NULL)
  615                 return (USBD_NOT_CONFIGURED);
  616         if (ifaceno >= dev->cdesc->bNumInterface)
  617                 return (USBD_INVAL);
  618         *iface = &dev->ifaces[ifaceno];
  619         return (USBD_NORMAL_COMPLETION);
  620 }
usbd_device_handle
usbd_pipe2device_handle(usbd_pipe_handle pipe)
  624 {
  625         return (pipe->device);
  626 }
  628 /* XXXX use altno */
usbd_status
usbd_set_interface(usbd_interface_handle iface, int altidx)
  631 {
usb_device_request_t req;
usbd_status err;
  634         void *endpoints;
  636         if (LIST_FIRST(&iface->pipes) != 0)
  637                 return (USBD_IN_USE);
endpoints = iface->endpoints;
err = usbd_fill_iface_data(iface->device, iface->index, altidx);
  641         if (err)
  642                 return (err);
  644         /* new setting works, we can free old endpoints */
  645         if (endpoints != NULL)
free(endpoints, M_USB);
  648 #ifdef DIAGNOSTIC
  649         if (iface->idesc == NULL) {
printf("usbd_set_interface: NULL pointer\n");
  651                 return (USBD_INVAL);
  652         }
  653 #endif
req.bmRequestType = UT_WRITE_INTERFACE;
req.bRequest = UR_SET_INTERFACE;
USETW(req.wValue, iface->idesc->bAlternateSetting);
USETW(req.wIndex, iface->idesc->bInterfaceNumber);
USETW(req.wLength, 0);
  660         return (usbd_do_request(iface->device, &req, 0));
  661 }
  663 int
usbd_get_no_alts(usb_config_descriptor_t *cdesc, int ifaceno)
  665 {
  666         char *p = (char *)cdesc;
  667         char *end = p + UGETW(cdesc->wTotalLength);
usb_interface_descriptor_t *d;
  669         int n;
  671         for (n = 0; p < end; p += d->bLength) {
d = (usb_interface_descriptor_t *)p;
  673                 if (p + d->bLength <= end &&
d->bDescriptorType == UDESC_INTERFACE &&
d->bInterfaceNumber == ifaceno)
n++;
  677         }
  678         return (n);
  679 }
  681 int
usbd_get_interface_altindex(usbd_interface_handle iface)
  683 {
  684         return (iface->altindex);
  685 }
usbd_status
usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface)
  689 {
usb_device_request_t req;
req.bmRequestType = UT_READ_INTERFACE;
req.bRequest = UR_GET_INTERFACE;
USETW(req.wValue, 0);
USETW(req.wIndex, iface->idesc->bInterfaceNumber);
USETW(req.wLength, 1);
  697         return (usbd_do_request(iface->device, &req, aiface));
  698 }
  700 /*** Internal routines ***/
  702 /* Dequeue all pipe operations, called at splusb(). */
usbd_status
usbd_ar_pipe(usbd_pipe_handle pipe)
  705 {
usbd_xfer_handle xfer;
SPLUSBCHECK;
DPRINTFN(2,("usbd_ar_pipe: pipe=%p\n", pipe));
  711 #ifdef USB_DEBUG
  712         if (usbdebug > 5)
usbd_dump_queue(pipe);
  714 #endif
pipe->repeat = 0;
pipe->aborting = 1;
  717         while ((xfer = SIMPLEQ_FIRST(&pipe->queue)) != NULL) {
DPRINTFN(2,("usbd_ar_pipe: pipe=%p xfer=%p (methods=%p)\n",
pipe, xfer, pipe->methods));
  720                 /* Make the HC abort it (and invoke the callback). */
pipe->methods->abort(xfer);
  722                 /* XXX only for non-0 usbd_clear_endpoint_stall(pipe); */
  723         }
pipe->aborting = 0;
  725         return (USBD_NORMAL_COMPLETION);
  726 }
  728 /* Called at splusb() */
  729 void
usb_transfer_complete(usbd_xfer_handle xfer)
  731 {
usbd_pipe_handle pipe = xfer->pipe;
usb_dma_t *dmap = &xfer->dmabuf;
  734         int repeat = pipe->repeat;
  735         int polling;
SPLUSBCHECK;
DPRINTFN(5, ("usb_transfer_complete: pipe=%p xfer=%p status=%d "
  740                      "actlen=%d\n", pipe, xfer, xfer->status, xfer->actlen));
  741 #ifdef DIAGNOSTIC
  742         if (xfer->busy_free != XFER_ONQU) {
printf("usb_transfer_complete: xfer=%p not busy 0x%08x\n",
xfer, xfer->busy_free);
  745                 return;
  746         }
  747 #endif
  749 #ifdef DIAGNOSTIC
  750         if (pipe == NULL) {
printf("usbd_transfer_cb: pipe==0, xfer=%p\n", xfer);
  752                 return;
  753         }
  754 #endif
polling = pipe->device->bus->use_polling;
  756         /* XXXX */
  757         if (polling)
pipe->running = 0;
  760         if (!(xfer->flags & USBD_NO_COPY) && xfer->actlen != 0 &&
usbd_xfer_isread(xfer)) {
  762 #ifdef DIAGNOSTIC
  763                 if (xfer->actlen > xfer->length) {
printf("usb_transfer_complete: actlen > len %d > %d\n",
xfer->actlen, xfer->length);
xfer->actlen = xfer->length;
  767                 }
  768 #endif
memcpy(xfer->buffer, KERNADDR(dmap, 0), xfer->actlen);
  770         }
  772         /* if we allocated the buffer in usbd_transfer() we free it here. */
  773         if (xfer->rqflags & URQ_AUTO_DMABUF) {
  774                 if (!repeat) {
  775                         struct usbd_bus *bus = pipe->device->bus;
bus->methods->freem(bus, dmap);
xfer->rqflags &= ~URQ_AUTO_DMABUF;
  778                 }
  779         }
  781         if (!repeat) {
  782                 /* Remove request from queue. */
  783 #ifdef DIAGNOSTIC
  784                 if (xfer != SIMPLEQ_FIRST(&pipe->queue))
printf("usb_transfer_complete: bad dequeue %p != %p\n",
xfer, SIMPLEQ_FIRST(&pipe->queue));
xfer->busy_free = XFER_BUSY;
  788 #endif
SIMPLEQ_REMOVE_HEAD(&pipe->queue, next);
  790         }
DPRINTFN(5,("usb_transfer_complete: repeat=%d new head=%p\n", repeat,
SIMPLEQ_FIRST(&pipe->queue)));
  794         /* Count completed transfers. */
  795         ++pipe->device->bus->stats.uds_requests
  796                 [pipe->endpoint->edesc->bmAttributes & UE_XFERTYPE];
xfer->done = 1;
  799         if (!xfer->status && xfer->actlen < xfer->length &&
  800             !(xfer->flags & USBD_SHORT_XFER_OK)) {
DPRINTFN(-1,("usbd_transfer_cb: short transfer %d<%d\n",
xfer->actlen, xfer->length));
xfer->status = USBD_SHORT_XFER;
  804         }
  806         if (xfer->callback)
xfer->callback(xfer, xfer->priv, xfer->status);
  809 #ifdef DIAGNOSTIC
  810         if (pipe->methods->done != NULL)
pipe->methods->done(xfer);
  812         else
printf("usb_transfer_complete: pipe->methods->done == NULL\n");
  814 #else
pipe->methods->done(xfer);
  816 #endif
  818         if ((xfer->flags & USBD_SYNCHRONOUS) && !polling)
wakeup(xfer);
  821         if (!repeat) {
  822                 /* XXX should we stop the queue on all errors? */
  823                 if ((xfer->status == USBD_CANCELLED ||
xfer->status == USBD_TIMEOUT) &&
pipe->iface != NULL)                /* not control pipe */
pipe->running = 0;
  827                 else
usbd_start_next(pipe);
  829         }
  830 }
usbd_status
usb_insert_transfer(usbd_xfer_handle xfer)
  834 {
usbd_pipe_handle pipe = xfer->pipe;
usbd_status err;
  837         int s;
DPRINTFN(5,("usb_insert_transfer: pipe=%p running=%d timeout=%d\n",
pipe, pipe->running, xfer->timeout));
  841 #ifdef DIAGNOSTIC
  842         if (xfer->busy_free != XFER_BUSY) {
printf("usb_insert_transfer: xfer=%p not busy 0x%08x\n", xfer,
xfer->busy_free);
  845                 return (USBD_INVAL);
  846         }
xfer->busy_free = XFER_ONQU;
  848 #endif
s = splusb();
SIMPLEQ_INSERT_TAIL(&pipe->queue, xfer, next);
  851         if (pipe->running)
err = USBD_IN_PROGRESS;
  853         else {
pipe->running = 1;
err = USBD_NORMAL_COMPLETION;
  856         }
splx(s);
  858         return (err);
  859 }
  861 /* Called at splusb() */
  862 void
usbd_start_next(usbd_pipe_handle pipe)
  864 {
usbd_xfer_handle xfer;
usbd_status err;
SPLUSBCHECK;
  870 #ifdef DIAGNOSTIC
  871         if (pipe == NULL) {
printf("usbd_start_next: pipe == NULL\n");
  873                 return;
  874         }
  875         if (pipe->methods == NULL || pipe->methods->start == NULL) {
printf("usbd_start_next: pipe=%p no start method\n", pipe);
  877                 return;
  878         }
  879 #endif
  881         /* Get next request in queue. */
xfer = SIMPLEQ_FIRST(&pipe->queue);
DPRINTFN(5, ("usbd_start_next: pipe=%p, xfer=%p\n", pipe, xfer));
  884         if (xfer == NULL) {
pipe->running = 0;
  886         } else {
err = pipe->methods->start(xfer);
  888                 if (err != USBD_IN_PROGRESS) {
printf("usbd_start_next: error=%d\n", err);
pipe->running = 0;
  891                         /* XXX do what? */
  892                 }
  893         }
  894 }
usbd_status
usbd_do_request(usbd_device_handle dev, usb_device_request_t *req, void *data)
  898 {
  899         return (usbd_do_request_flags(dev, req, data, 0, 0,
USBD_DEFAULT_TIMEOUT));
  901 }
usbd_status
usbd_do_request_flags(usbd_device_handle dev, usb_device_request_t *req,
  905     void *data, u_int16_t flags, int *actlen, u_int32_t timo)
  906 {
  907         return (usbd_do_request_flags_pipe(dev, dev->default_pipe, req, data,
flags, actlen, timo));
  909 }
usbd_status
usbd_do_request_flags_pipe(usbd_device_handle dev, usbd_pipe_handle pipe,
usb_device_request_t *req, void *data, u_int16_t flags, int *actlen,
u_int32_t timeout)
  915 {
usbd_xfer_handle xfer;
usbd_status err;
  919 #ifdef DIAGNOSTIC
  920         if (dev->bus->intr_context) {
printf("usbd_do_request: not in process context\n");
  922                 return (USBD_INVAL);
  923         }
  924 #endif
xfer = usbd_alloc_xfer(dev);
  927         if (xfer == NULL)
  928                 return (USBD_NOMEM);
usbd_setup_default_xfer(xfer, dev, 0, timeout, req, data,
UGETW(req->wLength), flags, 0);
xfer->pipe = pipe;
err = usbd_sync_transfer(xfer);
  933 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
  934         if (xfer->actlen > xfer->length)
DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
  936                     "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
dev->address, xfer->request.bmRequestType,
xfer->request.bRequest, UGETW(xfer->request.wValue),
UGETW(xfer->request.wIndex), UGETW(xfer->request.wLength),
xfer->length, xfer->actlen));
  941 #endif
  942         if (actlen != NULL)
  943                 *actlen = xfer->actlen;
  944         if (err == USBD_STALLED) {
  945                 /*
  946                  * The control endpoint has stalled.  Control endpoints
  947                  * should not halt, but some may do so anyway so clear
  948                  * any halt condition.
  949                  */
usb_device_request_t treq;
usb_status_t status;
u_int16_t s;
usbd_status nerr;
treq.bmRequestType = UT_READ_ENDPOINT;
treq.bRequest = UR_GET_STATUS;
USETW(treq.wValue, 0);
USETW(treq.wIndex, 0);
USETW(treq.wLength, sizeof(usb_status_t));
usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
  961                     &treq, &status,sizeof(usb_status_t), 0, 0);
nerr = usbd_sync_transfer(xfer);
  963                 if (nerr)
  964                         goto bad;
s = UGETW(status.wStatus);
DPRINTF(("usbd_do_request: status = 0x%04x\n", s));
  967                 if (!(s & UES_HALT))
  968                         goto bad;
treq.bmRequestType = UT_WRITE_ENDPOINT;
treq.bRequest = UR_CLEAR_FEATURE;
USETW(treq.wValue, UF_ENDPOINT_HALT);
USETW(treq.wIndex, 0);
USETW(treq.wLength, 0);
usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT,
  975                     &treq, &status, 0, 0, 0);
nerr = usbd_sync_transfer(xfer);
  977                 if (nerr)
  978                         goto bad;
  979         }
bad:
usbd_free_xfer(xfer);
  983         return (err);
  984 }
  986 void
usbd_do_request_async_cb(usbd_xfer_handle xfer, usbd_private_handle priv,
usbd_status status)
  989 {
  990 #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
  991         if (xfer->actlen > xfer->length)
DPRINTF(("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
  993                     "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
xfer->pipe->device->address, xfer->request.bmRequestType,
xfer->request.bRequest, UGETW(xfer->request.wValue),
UGETW(xfer->request.wIndex), UGETW(xfer->request.wLength),
xfer->length, xfer->actlen));
  998 #endif
usbd_free_xfer(xfer);
 1000 }
 1002 /*
 1003  * Execute a request without waiting for completion.
 1004  * Can be used from interrupt context.
 1005  */
usbd_status
usbd_do_request_async(usbd_device_handle dev, usb_device_request_t *req,
 1008     void *data)
 1009 {
usbd_xfer_handle xfer;
usbd_status err;
xfer = usbd_alloc_xfer(dev);
 1014         if (xfer == NULL)
 1015                 return (USBD_NOMEM);
usbd_setup_default_xfer(xfer, dev, 0, USBD_DEFAULT_TIMEOUT, req,
data, UGETW(req->wLength), 0, usbd_do_request_async_cb);
err = usbd_transfer(xfer);
 1019         if (err != USBD_IN_PROGRESS) {
usbd_free_xfer(xfer);
 1021                 return (err);
 1022         }
 1023         return (USBD_NORMAL_COMPLETION);
 1024 }
 1026 const struct usbd_quirks *
usbd_get_quirks(usbd_device_handle dev)
 1028 {
 1029 #ifdef DIAGNOSTIC
 1030         if (dev == NULL) {
printf("usbd_get_quirks: dev == NULL\n");
 1032                 return 0;
 1033         }
 1034 #endif
 1035         return (dev->quirks);
 1036 }
 1038 /* XXX do periodic free() of free list */
 1040 /*
 1041  * Called from keyboard driver when in polling mode.
 1042  */
 1043 void
usbd_dopoll(usbd_interface_handle iface)
 1045 {
iface->device->bus->methods->do_poll(iface->device->bus);
 1047 }
 1049 void
usbd_set_polling(usbd_device_handle dev, int on)
 1051 {
 1052         if (on)
dev->bus->use_polling++;
 1054         else
dev->bus->use_polling--;
 1056         /* When polling we need to make sure there is nothing pending to do. */
 1057         if (dev->bus->use_polling)
dev->bus->methods->soft_intr(dev->bus);
 1059 }
usb_endpoint_descriptor_t *
usbd_get_endpoint_descriptor(usbd_interface_handle iface, u_int8_t address)
 1063 {
 1064         struct usbd_endpoint *ep;
 1065         int i;
 1067         for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
ep = &iface->endpoints[i];
 1069                 if (ep->edesc->bEndpointAddress == address)
 1070                         return (iface->endpoints[i].edesc);
 1071         }
 1072         return (0);
 1073 }
 1075 /*
 1076  * usbd_ratecheck() can limit the number of error messages that occurs.
 1077  * When a device is unplugged it may take up to 0.25s for the hub driver
 1078  * to notice it.  If the driver continuosly tries to do I/O operations
 1079  * this can generate a large number of messages.
 1080  */
 1081 int
usbd_ratecheck(struct timeval *last)
 1083 {
 1084         static struct timeval errinterval = { 0, 250000 }; /* 0.25 s*/
 1086         return (ratecheck(last, &errinterval));
 1087 }
 1089 /*
 1090  * Search for a vendor/product pair in an array.  The item size is
 1091  * given as an argument.
 1092  */
 1093 const struct usb_devno *
usb_match_device(const struct usb_devno *tbl, u_int nentries, u_int sz,
u_int16_t vendor, u_int16_t product)
 1096 {
 1097         while (nentries-- > 0) {
u_int16_t tproduct = tbl->ud_product;
 1099                 if (tbl->ud_vendor == vendor &&
 1100                     (tproduct == product || tproduct == USB_PRODUCT_ANY))
 1101                         return (tbl);
tbl = (const struct usb_devno *)((const char *)tbl + sz);
 1103         }
 1104         return (NULL);
 1105 }
 1107 void
usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter)
 1109 {
 1110         const usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev);
iter->cur = (const uByte *)cd;
iter->end = (const uByte *)cd + UGETW(cd->wTotalLength);
 1114 }
 1116 const usb_descriptor_t *
usb_desc_iter_next(usbd_desc_iter_t *iter)
 1118 {
 1119         const usb_descriptor_t *desc;
 1121         if (iter->cur + sizeof(usb_descriptor_t) >= iter->end) {
 1122                 if (iter->cur != iter->end)
printf("usb_desc_iter_next: bad descriptor\n");
 1124                 return NULL;
 1125         }
desc = (const usb_descriptor_t *)iter->cur;
 1127         if (desc->bLength == 0) {
printf("usb_desc_iter_next: descriptor length = 0\n");
 1129                 return NULL;
 1130         }
iter->cur += desc->bLength;
 1132         if (iter->cur > iter->end) {
printf("usb_desc_iter_next: descriptor length too large\n");
 1134                 return NULL;
 1135         }
 1136         return desc;
 1137 }