3 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/queue.h>
37 #define libusb_device_handle libusb20_device
40 #include "libusb20_desc.h"
41 #include "libusb20_int.h"
46 libusb10_add_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd,
47 struct libusb20_device *pdev, int fd, short events)
52 if (pollfd->entry.tqe_prev != NULL)
53 return; /* already queued */
59 pollfd->pollfd.fd = fd;
60 pollfd->pollfd.events = events;
63 TAILQ_INSERT_TAIL(&ctx->pollfds, pollfd, entry);
67 ctx->fd_added_cb(fd, events, ctx->fd_cb_user_data);
71 libusb10_remove_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd)
76 if (pollfd->entry.tqe_prev == NULL)
77 return; /* already dequeued */
80 TAILQ_REMOVE(&ctx->pollfds, pollfd, entry);
81 pollfd->entry.tqe_prev = NULL;
84 if (ctx->fd_removed_cb)
85 ctx->fd_removed_cb(pollfd->pollfd.fd, ctx->fd_cb_user_data);
88 /* This function must be called locked */
91 libusb10_handle_events_sub(struct libusb_context *ctx, struct timeval *tv)
93 struct libusb_device *dev;
94 struct libusb20_device **ppdev;
95 struct libusb_super_pollfd *pfd;
97 struct libusb_super_transfer *sxfer;
98 struct libusb_transfer *uxfer;
104 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb10_handle_events_sub enter");
108 TAILQ_FOREACH(pfd, &ctx->pollfds, entry)
111 fds = alloca(sizeof(*fds) * nfds);
113 return (LIBUSB_ERROR_NO_MEM);
115 ppdev = alloca(sizeof(*ppdev) * nfds);
117 return (LIBUSB_ERROR_NO_MEM);
119 TAILQ_FOREACH(pfd, &ctx->pollfds, entry) {
120 fds[i].fd = pfd->pollfd.fd;
121 fds[i].events = pfd->pollfd.events;
123 ppdev[i] = pfd->pdev;
124 if (pfd->pdev != NULL)
125 libusb_get_device(pfd->pdev)->refcnt++;
132 timeout = (tv->tv_sec * 1000) + ((tv->tv_usec + 999) / 1000);
135 err = poll(fds, nfds, timeout);
138 if ((err == -1) && (errno == EINTR))
139 err = LIBUSB_ERROR_INTERRUPTED;
141 err = LIBUSB_ERROR_IO;
144 for (i = 0; i != (int)nfds; i++) {
145 if (ppdev[i] != NULL) {
147 libusb_unref_device(libusb_get_device(ppdev[i]));
153 for (i = 0; i != (int)nfds; i++) {
154 if (ppdev[i] != NULL) {
155 dev = libusb_get_device(ppdev[i]);
157 if (fds[i].revents == 0)
158 err = 0; /* nothing to do */
160 err = libusb20_dev_process(ppdev[i]);
163 /* cancel all transfers - device is gone */
164 libusb10_cancel_all_transfer(dev);
166 /* remove USB device from polling loop */
167 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
170 libusb_unref_device(dev);
177 if (read(fds[i].fd, &dummy, 1) != 1)
187 /* Do all done callbacks */
189 while ((sxfer = TAILQ_FIRST(&ctx->tr_done))) {
192 TAILQ_REMOVE(&ctx->tr_done, sxfer, entry);
193 sxfer->entry.tqe_prev = NULL;
199 uxfer = (struct libusb_transfer *)(
200 ((uint8_t *)sxfer) + sizeof(*sxfer));
202 /* Allow the callback to free the transfer itself. */
203 flags = uxfer->flags;
205 if (uxfer->callback != NULL)
206 (uxfer->callback) (uxfer);
208 /* Check if the USB transfer should be automatically freed. */
209 if (flags & LIBUSB_TRANSFER_FREE_TRANSFER)
210 libusb_free_transfer(uxfer);
218 /* Wakeup other waiters */
219 pthread_cond_broadcast(&ctx->ctx_cond);
224 /* Polling and timing */
227 libusb_try_lock_events(libusb_context *ctx)
231 ctx = GET_CONTEXT(ctx);
235 err = CTX_TRYLOCK(ctx);
239 err = (ctx->ctx_handler != NO_THREAD);
243 ctx->ctx_handler = pthread_self();
249 libusb_lock_events(libusb_context *ctx)
251 ctx = GET_CONTEXT(ctx);
253 if (ctx->ctx_handler == NO_THREAD)
254 ctx->ctx_handler = pthread_self();
258 libusb_unlock_events(libusb_context *ctx)
260 ctx = GET_CONTEXT(ctx);
261 if (ctx->ctx_handler == pthread_self()) {
262 ctx->ctx_handler = NO_THREAD;
263 pthread_cond_broadcast(&ctx->ctx_cond);
269 libusb_event_handling_ok(libusb_context *ctx)
271 ctx = GET_CONTEXT(ctx);
272 return (ctx->ctx_handler == pthread_self());
276 libusb_event_handler_active(libusb_context *ctx)
278 ctx = GET_CONTEXT(ctx);
279 return (ctx->ctx_handler != NO_THREAD);
283 libusb_lock_event_waiters(libusb_context *ctx)
285 ctx = GET_CONTEXT(ctx);
290 libusb_unlock_event_waiters(libusb_context *ctx)
292 ctx = GET_CONTEXT(ctx);
297 libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
302 ctx = GET_CONTEXT(ctx);
303 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_wait_for_event enter");
306 pthread_cond_wait(&ctx->ctx_cond,
310 err = clock_gettime(CLOCK_MONOTONIC, &ts);
312 return (LIBUSB_ERROR_OTHER);
315 * The "tv" arguments points to a relative time structure and
316 * not an absolute time structure.
318 ts.tv_sec += tv->tv_sec;
319 ts.tv_nsec += tv->tv_usec * 1000;
320 if (ts.tv_nsec >= 1000000000) {
321 ts.tv_nsec -= 1000000000;
324 err = pthread_cond_timedwait(&ctx->ctx_cond,
325 &ctx->ctx_lock, &ts);
327 if (err == ETIMEDOUT)
334 libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
338 ctx = GET_CONTEXT(ctx);
340 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout enter");
342 libusb_lock_events(ctx);
344 err = libusb_handle_events_locked(ctx, tv);
346 libusb_unlock_events(ctx);
348 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout leave");
354 libusb_handle_events(libusb_context *ctx)
356 return (libusb_handle_events_timeout(ctx, NULL));
360 libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
364 ctx = GET_CONTEXT(ctx);
366 if (libusb_event_handling_ok(ctx)) {
367 err = libusb10_handle_events_sub(ctx, tv);
369 libusb_wait_for_event(ctx, tv);
376 libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
378 /* all timeouts are currently being done by the kernel */
384 libusb_set_pollfd_notifiers(libusb_context *ctx,
385 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
388 ctx = GET_CONTEXT(ctx);
390 ctx->fd_added_cb = added_cb;
391 ctx->fd_removed_cb = removed_cb;
392 ctx->fd_cb_user_data = user_data;
395 struct libusb_pollfd **
396 libusb_get_pollfds(libusb_context *ctx)
398 struct libusb_super_pollfd *pollfd;
402 ctx = GET_CONTEXT(ctx);
407 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
410 ret = calloc(i + 1, sizeof(struct libusb_pollfd *));
415 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
416 ret[i++] = &pollfd->pollfd;
425 /* Synchronous device I/O */
428 libusb_control_transfer(libusb_device_handle *devh,
429 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
430 uint8_t *data, uint16_t wLength, unsigned int timeout)
432 struct LIBUSB20_CONTROL_SETUP_DECODED req;
437 return (LIBUSB_ERROR_INVALID_PARAM);
439 if ((wLength != 0) && (data == NULL))
440 return (LIBUSB_ERROR_INVALID_PARAM);
442 LIBUSB20_INIT(LIBUSB20_CONTROL_SETUP, &req);
444 req.bmRequestType = bmRequestType;
445 req.bRequest = bRequest;
448 req.wLength = wLength;
450 err = libusb20_dev_request_sync(devh, &req, data,
451 &actlen, timeout, 0);
453 if (err == LIBUSB20_ERROR_PIPE)
454 return (LIBUSB_ERROR_PIPE);
455 else if (err == LIBUSB20_ERROR_TIMEOUT)
456 return (LIBUSB_ERROR_TIMEOUT);
458 return (LIBUSB_ERROR_NO_DEVICE);
464 libusb10_do_transfer_cb(struct libusb_transfer *transfer)
469 ctx = GET_CONTEXT(NULL);
471 DPRINTF(ctx, LIBUSB_DEBUG_TRANSFER, "sync I/O done");
473 pdone = transfer->user_data;
478 * TODO: Replace the following function. Allocating and freeing on a
479 * per-transfer basis is slow. --HPS
482 libusb10_do_transfer(libusb_device_handle *devh,
483 uint8_t endpoint, uint8_t *data, int length,
484 int *transferred, unsigned int timeout, int type)
487 struct libusb_transfer *xfer;
492 return (LIBUSB_ERROR_INVALID_PARAM);
494 if ((length != 0) && (data == NULL))
495 return (LIBUSB_ERROR_INVALID_PARAM);
497 xfer = libusb_alloc_transfer(0);
499 return (LIBUSB_ERROR_NO_MEM);
501 ctx = libusb_get_device(devh)->ctx;
503 xfer->dev_handle = devh;
504 xfer->endpoint = endpoint;
506 xfer->timeout = timeout;
508 xfer->length = length;
509 xfer->user_data = (void *)&done;
510 xfer->callback = libusb10_do_transfer_cb;
513 if ((ret = libusb_submit_transfer(xfer)) < 0) {
514 libusb_free_transfer(xfer);
518 if ((ret = libusb_handle_events(ctx)) < 0) {
519 libusb_cancel_transfer(xfer);
520 usleep(1000); /* nice it */
524 *transferred = xfer->actual_length;
526 switch (xfer->status) {
527 case LIBUSB_TRANSFER_COMPLETED:
530 case LIBUSB_TRANSFER_TIMED_OUT:
531 ret = LIBUSB_ERROR_TIMEOUT;
533 case LIBUSB_TRANSFER_OVERFLOW:
534 ret = LIBUSB_ERROR_OVERFLOW;
536 case LIBUSB_TRANSFER_STALL:
537 ret = LIBUSB_ERROR_PIPE;
539 case LIBUSB_TRANSFER_NO_DEVICE:
540 ret = LIBUSB_ERROR_NO_DEVICE;
543 ret = LIBUSB_ERROR_OTHER;
547 libusb_free_transfer(xfer);
552 libusb_bulk_transfer(libusb_device_handle *devh,
553 uint8_t endpoint, uint8_t *data, int length,
554 int *transferred, unsigned int timeout)
559 ctx = GET_CONTEXT(NULL);
560 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer enter");
562 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
563 timeout, LIBUSB_TRANSFER_TYPE_BULK);
565 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer leave");
570 libusb_interrupt_transfer(libusb_device_handle *devh,
571 uint8_t endpoint, uint8_t *data, int length,
572 int *transferred, unsigned int timeout)
577 ctx = GET_CONTEXT(NULL);
578 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer enter");
580 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
581 timeout, LIBUSB_TRANSFER_TYPE_INTERRUPT);
583 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer leave");
588 libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t off)
593 if (transfer->num_iso_packets < 0)
596 if (off >= (uint32_t)transfer->num_iso_packets)
599 ptr = transfer->buffer;
603 for (n = 0; n != off; n++) {
604 ptr += transfer->iso_packet_desc[n].length;
610 libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t off)
614 if (transfer->num_iso_packets < 0)
617 if (off >= (uint32_t)transfer->num_iso_packets)
620 ptr = transfer->buffer;
624 ptr += transfer->iso_packet_desc[0].length * off;
630 libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length)
634 if (transfer->num_iso_packets < 0)
637 for (n = 0; n != transfer->num_iso_packets; n++)
638 transfer->iso_packet_desc[n].length = length;
642 libusb_control_transfer_get_data(struct libusb_transfer *transfer)
644 if (transfer->buffer == NULL)
647 return (transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE);
650 struct libusb_control_setup *
651 libusb_control_transfer_get_setup(struct libusb_transfer *transfer)
653 return ((struct libusb_control_setup *)transfer->buffer);
657 libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType,
658 uint8_t bRequest, uint16_t wValue,
659 uint16_t wIndex, uint16_t wLength)
661 struct libusb_control_setup *req = (struct libusb_control_setup *)buf;
663 /* The alignment is OK for all fields below. */
664 req->bmRequestType = bmRequestType;
665 req->bRequest = bRequest;
666 req->wValue = htole16(wValue);
667 req->wIndex = htole16(wIndex);
668 req->wLength = htole16(wLength);
672 libusb_fill_control_transfer(struct libusb_transfer *transfer,
673 libusb_device_handle *devh, uint8_t *buf,
674 libusb_transfer_cb_fn callback, void *user_data,
677 struct libusb_control_setup *setup = (struct libusb_control_setup *)buf;
679 transfer->dev_handle = devh;
680 transfer->endpoint = 0;
681 transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
682 transfer->timeout = timeout;
683 transfer->buffer = buf;
685 transfer->length = LIBUSB_CONTROL_SETUP_SIZE
686 + le16toh(setup->wLength);
688 transfer->length = 0;
689 transfer->user_data = user_data;
690 transfer->callback = callback;
695 libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
696 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
697 int length, libusb_transfer_cb_fn callback, void *user_data,
700 transfer->dev_handle = devh;
701 transfer->endpoint = endpoint;
702 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
703 transfer->timeout = timeout;
704 transfer->buffer = buf;
705 transfer->length = length;
706 transfer->user_data = user_data;
707 transfer->callback = callback;
711 libusb_fill_interrupt_transfer(struct libusb_transfer *transfer,
712 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
713 int length, libusb_transfer_cb_fn callback, void *user_data,
716 transfer->dev_handle = devh;
717 transfer->endpoint = endpoint;
718 transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
719 transfer->timeout = timeout;
720 transfer->buffer = buf;
721 transfer->length = length;
722 transfer->user_data = user_data;
723 transfer->callback = callback;
727 libusb_fill_iso_transfer(struct libusb_transfer *transfer,
728 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
729 int length, int npacket, libusb_transfer_cb_fn callback,
730 void *user_data, uint32_t timeout)
732 transfer->dev_handle = devh;
733 transfer->endpoint = endpoint;
734 transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
735 transfer->timeout = timeout;
736 transfer->buffer = buf;
737 transfer->length = length;
738 transfer->num_iso_packets = npacket;
739 transfer->user_data = user_data;
740 transfer->callback = callback;