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
34 #include <sys/queue.h>
35 #include <sys/endian.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 != nfds; i++) {
145 if (ppdev[i] != NULL) {
147 libusb_unref_device(libusb_get_device(ppdev[i]));
153 for (i = 0; i != 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))) {
190 TAILQ_REMOVE(&ctx->tr_done, sxfer, entry);
191 sxfer->entry.tqe_prev = NULL;
197 uxfer = (struct libusb_transfer *)(
198 ((uint8_t *)sxfer) + sizeof(*sxfer));
200 if (uxfer->callback != NULL)
201 (uxfer->callback) (uxfer);
203 if (uxfer->flags & LIBUSB_TRANSFER_FREE_BUFFER)
206 if (uxfer->flags & LIBUSB_TRANSFER_FREE_TRANSFER)
207 libusb_free_transfer(uxfer);
215 /* Wakeup other waiters */
216 pthread_cond_broadcast(&ctx->ctx_cond);
221 /* Polling and timing */
224 libusb_try_lock_events(libusb_context *ctx)
228 ctx = GET_CONTEXT(ctx);
232 err = CTX_TRYLOCK(ctx);
236 err = (ctx->ctx_handler != NO_THREAD);
240 ctx->ctx_handler = pthread_self();
246 libusb_lock_events(libusb_context *ctx)
248 ctx = GET_CONTEXT(ctx);
250 if (ctx->ctx_handler == NO_THREAD)
251 ctx->ctx_handler = pthread_self();
255 libusb_unlock_events(libusb_context *ctx)
257 ctx = GET_CONTEXT(ctx);
258 if (ctx->ctx_handler == pthread_self()) {
259 ctx->ctx_handler = NO_THREAD;
260 pthread_cond_broadcast(&ctx->ctx_cond);
266 libusb_event_handling_ok(libusb_context *ctx)
268 ctx = GET_CONTEXT(ctx);
269 return (ctx->ctx_handler == pthread_self());
273 libusb_event_handler_active(libusb_context *ctx)
275 ctx = GET_CONTEXT(ctx);
276 return (ctx->ctx_handler != NO_THREAD);
280 libusb_lock_event_waiters(libusb_context *ctx)
282 ctx = GET_CONTEXT(ctx);
287 libusb_unlock_event_waiters(libusb_context *ctx)
289 ctx = GET_CONTEXT(ctx);
294 libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
299 ctx = GET_CONTEXT(ctx);
300 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_wait_for_event enter");
303 pthread_cond_wait(&ctx->ctx_cond,
307 err = clock_gettime(CLOCK_REALTIME, &ts);
309 return (LIBUSB_ERROR_OTHER);
311 ts.tv_sec = tv->tv_sec;
312 ts.tv_nsec = tv->tv_usec * 1000;
313 if (ts.tv_nsec >= 1000000000) {
314 ts.tv_nsec -= 1000000000;
317 err = pthread_cond_timedwait(&ctx->ctx_cond,
318 &ctx->ctx_lock, &ts);
320 if (err == ETIMEDOUT)
327 libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
331 ctx = GET_CONTEXT(ctx);
333 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout enter");
335 libusb_lock_events(ctx);
337 err = libusb_handle_events_locked(ctx, tv);
339 libusb_unlock_events(ctx);
341 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout leave");
347 libusb_handle_events(libusb_context *ctx)
349 return (libusb_handle_events_timeout(ctx, NULL));
353 libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
357 ctx = GET_CONTEXT(ctx);
359 if (libusb_event_handling_ok(ctx)) {
360 err = libusb10_handle_events_sub(ctx, tv);
362 libusb_wait_for_event(ctx, tv);
369 libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
371 /* all timeouts are currently being done by the kernel */
377 libusb_set_pollfd_notifiers(libusb_context *ctx,
378 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
381 ctx = GET_CONTEXT(ctx);
383 ctx->fd_added_cb = added_cb;
384 ctx->fd_removed_cb = removed_cb;
385 ctx->fd_cb_user_data = user_data;
388 struct libusb_pollfd **
389 libusb_get_pollfds(libusb_context *ctx)
391 struct libusb_super_pollfd *pollfd;
395 ctx = GET_CONTEXT(ctx);
400 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
403 ret = calloc(i + 1, sizeof(struct libusb_pollfd *));
408 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
409 ret[i++] = &pollfd->pollfd;
418 /* Synchronous device I/O */
421 libusb_control_transfer(libusb_device_handle *devh,
422 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
423 uint8_t *data, uint16_t wLength, unsigned int timeout)
425 struct LIBUSB20_CONTROL_SETUP_DECODED req;
430 return (LIBUSB_ERROR_INVALID_PARAM);
432 if ((wLength != 0) && (data == NULL))
433 return (LIBUSB_ERROR_INVALID_PARAM);
435 LIBUSB20_INIT(LIBUSB20_CONTROL_SETUP, &req);
437 req.bmRequestType = bmRequestType;
438 req.bRequest = bRequest;
441 req.wLength = wLength;
443 err = libusb20_dev_request_sync(devh, &req, data,
444 &actlen, timeout, 0);
446 if (err == LIBUSB20_ERROR_PIPE)
447 return (LIBUSB_ERROR_PIPE);
448 else if (err == LIBUSB20_ERROR_TIMEOUT)
449 return (LIBUSB_ERROR_TIMEOUT);
451 return (LIBUSB_ERROR_NO_DEVICE);
457 libusb10_do_transfer_cb(struct libusb_transfer *transfer)
462 ctx = GET_CONTEXT(NULL);
464 DPRINTF(ctx, LIBUSB_DEBUG_TRANSFER, "sync I/O done");
466 pdone = transfer->user_data;
471 * TODO: Replace the following function. Allocating and freeing on a
472 * per-transfer basis is slow. --HPS
475 libusb10_do_transfer(libusb_device_handle *devh,
476 uint8_t endpoint, uint8_t *data, int length,
477 int *transferred, unsigned int timeout, int type)
480 struct libusb_transfer *xfer;
481 volatile int complet;
485 return (LIBUSB_ERROR_INVALID_PARAM);
487 if ((length != 0) && (data == NULL))
488 return (LIBUSB_ERROR_INVALID_PARAM);
490 xfer = libusb_alloc_transfer(0);
492 return (LIBUSB_ERROR_NO_MEM);
494 ctx = libusb_get_device(devh)->ctx;
496 xfer->dev_handle = devh;
497 xfer->endpoint = endpoint;
499 xfer->timeout = timeout;
501 xfer->length = length;
502 xfer->user_data = (void *)&complet;
503 xfer->callback = libusb10_do_transfer_cb;
506 if ((ret = libusb_submit_transfer(xfer)) < 0) {
507 libusb_free_transfer(xfer);
510 while (complet == 0) {
511 if ((ret = libusb_handle_events(ctx)) < 0) {
512 libusb_cancel_transfer(xfer);
513 usleep(1000); /* nice it */
517 *transferred = xfer->actual_length;
519 switch (xfer->status) {
520 case LIBUSB_TRANSFER_COMPLETED:
523 case LIBUSB_TRANSFER_TIMED_OUT:
524 ret = LIBUSB_ERROR_TIMEOUT;
526 case LIBUSB_TRANSFER_OVERFLOW:
527 ret = LIBUSB_ERROR_OVERFLOW;
529 case LIBUSB_TRANSFER_STALL:
530 ret = LIBUSB_ERROR_PIPE;
532 case LIBUSB_TRANSFER_NO_DEVICE:
533 ret = LIBUSB_ERROR_NO_DEVICE;
536 ret = LIBUSB_ERROR_OTHER;
540 libusb_free_transfer(xfer);
545 libusb_bulk_transfer(libusb_device_handle *devh,
546 uint8_t endpoint, uint8_t *data, int length,
547 int *transferred, unsigned int timeout)
552 ctx = GET_CONTEXT(NULL);
553 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer enter");
555 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
556 timeout, LIBUSB_TRANSFER_TYPE_BULK);
558 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer leave");
563 libusb_interrupt_transfer(libusb_device_handle *devh,
564 uint8_t endpoint, uint8_t *data, int length,
565 int *transferred, unsigned int timeout)
570 ctx = GET_CONTEXT(NULL);
571 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer enter");
573 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
574 timeout, LIBUSB_TRANSFER_TYPE_INTERRUPT);
576 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer leave");
581 libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index)
586 if (transfer->num_iso_packets < 0)
589 if (index >= (uint32_t)transfer->num_iso_packets)
592 ptr = transfer->buffer;
596 for (n = 0; n != index; n++) {
597 ptr += transfer->iso_packet_desc[n].length;
603 libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index)
607 if (transfer->num_iso_packets < 0)
610 if (index >= (uint32_t)transfer->num_iso_packets)
613 ptr = transfer->buffer;
617 ptr += transfer->iso_packet_desc[0].length * index;
623 libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length)
627 if (transfer->num_iso_packets < 0)
630 for (n = 0; n != transfer->num_iso_packets; n++)
631 transfer->iso_packet_desc[n].length = length;
635 libusb_control_transfer_get_data(struct libusb_transfer *transfer)
637 if (transfer->buffer == NULL)
640 return (transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE);
643 struct libusb_control_setup *
644 libusb_control_transfer_get_setup(struct libusb_transfer *transfer)
646 return ((struct libusb_control_setup *)transfer->buffer);
650 libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType,
651 uint8_t bRequest, uint16_t wValue,
652 uint16_t wIndex, uint16_t wLength)
654 struct libusb_control_setup *req = (struct libusb_control_setup *)buf;
656 /* The alignment is OK for all fields below. */
657 req->bmRequestType = bmRequestType;
658 req->bRequest = bRequest;
659 req->wValue = htole16(wValue);
660 req->wIndex = htole16(wIndex);
661 req->wLength = htole16(wLength);
665 libusb_fill_control_transfer(struct libusb_transfer *transfer,
666 libusb_device_handle *devh, uint8_t *buf,
667 libusb_transfer_cb_fn callback, void *user_data,
670 struct libusb_control_setup *setup = (struct libusb_control_setup *)buf;
672 transfer->dev_handle = devh;
673 transfer->endpoint = 0;
674 transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
675 transfer->timeout = timeout;
676 transfer->buffer = buf;
678 transfer->length = LIBUSB_CONTROL_SETUP_SIZE
679 + le16toh(setup->wLength);
681 transfer->length = 0;
682 transfer->user_data = user_data;
683 transfer->callback = callback;
688 libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
689 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
690 int length, libusb_transfer_cb_fn callback, void *user_data,
693 transfer->dev_handle = devh;
694 transfer->endpoint = endpoint;
695 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
696 transfer->timeout = timeout;
697 transfer->buffer = buf;
698 transfer->length = length;
699 transfer->user_data = user_data;
700 transfer->callback = callback;
704 libusb_fill_interrupt_transfer(struct libusb_transfer *transfer,
705 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
706 int length, libusb_transfer_cb_fn callback, void *user_data,
709 transfer->dev_handle = devh;
710 transfer->endpoint = endpoint;
711 transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
712 transfer->timeout = timeout;
713 transfer->buffer = buf;
714 transfer->length = length;
715 transfer->user_data = user_data;
716 transfer->callback = callback;
720 libusb_fill_iso_transfer(struct libusb_transfer *transfer,
721 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
722 int length, int npacket, libusb_transfer_cb_fn callback,
723 void *user_data, uint32_t timeout)
725 transfer->dev_handle = devh;
726 transfer->endpoint = endpoint;
727 transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
728 transfer->timeout = timeout;
729 transfer->buffer = buf;
730 transfer->length = length;
731 transfer->num_iso_packets = npacket;
732 transfer->user_data = user_data;
733 transfer->callback = callback;