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 = libusb20_dev_process(ppdev[i]);
161 /* set device is gone */
162 dev->device_is_gone = 1;
164 /* remove USB device from polling loop */
165 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
167 /* cancel all pending transfers */
168 libusb10_cancel_all_transfer_locked(ppdev[i], dev);
172 libusb_unref_device(dev);
178 while (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,
308 /* try to grab polling of actual events, if any */
309 if (ctx->ctx_handler == NO_THREAD)
310 ctx->ctx_handler = pthread_self();
313 err = clock_gettime(CLOCK_MONOTONIC, &ts);
315 return (LIBUSB_ERROR_OTHER);
318 * The "tv" arguments points to a relative time structure and
319 * not an absolute time structure.
321 ts.tv_sec += tv->tv_sec;
322 ts.tv_nsec += tv->tv_usec * 1000;
323 if (ts.tv_nsec >= 1000000000) {
324 ts.tv_nsec -= 1000000000;
327 err = pthread_cond_timedwait(&ctx->ctx_cond,
328 &ctx->ctx_lock, &ts);
329 /* try to grab polling of actual events, if any */
330 if (ctx->ctx_handler == NO_THREAD)
331 ctx->ctx_handler = pthread_self();
333 if (err == ETIMEDOUT)
340 libusb_handle_events_timeout_completed(libusb_context *ctx,
341 struct timeval *tv, int *completed)
345 ctx = GET_CONTEXT(ctx);
347 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout_completed enter");
349 libusb_lock_events(ctx);
352 if (completed != NULL) {
353 if (*completed != 0 || err != 0)
356 err = libusb_handle_events_locked(ctx, tv);
357 if (completed == NULL)
361 libusb_unlock_events(ctx);
363 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_handle_events_timeout_completed exit");
369 libusb_handle_events_completed(libusb_context *ctx, int *completed)
371 return (libusb_handle_events_timeout_completed(ctx, NULL, completed));
375 libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
377 return (libusb_handle_events_timeout_completed(ctx, tv, NULL));
381 libusb_handle_events(libusb_context *ctx)
383 return (libusb_handle_events_timeout_completed(ctx, NULL, NULL));
387 libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
391 ctx = GET_CONTEXT(ctx);
393 if (libusb_event_handling_ok(ctx)) {
394 err = libusb10_handle_events_sub(ctx, tv);
396 err = libusb_wait_for_event(ctx, tv);
398 err = LIBUSB_ERROR_TIMEOUT;
404 libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
406 /* all timeouts are currently being done by the kernel */
412 libusb_set_pollfd_notifiers(libusb_context *ctx,
413 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
416 ctx = GET_CONTEXT(ctx);
418 ctx->fd_added_cb = added_cb;
419 ctx->fd_removed_cb = removed_cb;
420 ctx->fd_cb_user_data = user_data;
423 const struct libusb_pollfd **
424 libusb_get_pollfds(libusb_context *ctx)
426 struct libusb_super_pollfd *pollfd;
430 ctx = GET_CONTEXT(ctx);
435 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
438 ret = calloc(i + 1, sizeof(struct libusb_pollfd *));
443 TAILQ_FOREACH(pollfd, &ctx->pollfds, entry)
444 ret[i++] = &pollfd->pollfd;
449 return ((const struct libusb_pollfd **)ret);
453 /* Synchronous device I/O */
456 libusb_control_transfer(libusb_device_handle *devh,
457 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
458 uint8_t *data, uint16_t wLength, unsigned int timeout)
460 struct LIBUSB20_CONTROL_SETUP_DECODED req;
465 return (LIBUSB_ERROR_INVALID_PARAM);
467 if ((wLength != 0) && (data == NULL))
468 return (LIBUSB_ERROR_INVALID_PARAM);
470 LIBUSB20_INIT(LIBUSB20_CONTROL_SETUP, &req);
472 req.bmRequestType = bmRequestType;
473 req.bRequest = bRequest;
476 req.wLength = wLength;
478 err = libusb20_dev_request_sync(devh, &req, data,
479 &actlen, timeout, 0);
481 if (err == LIBUSB20_ERROR_PIPE)
482 return (LIBUSB_ERROR_PIPE);
483 else if (err == LIBUSB20_ERROR_TIMEOUT)
484 return (LIBUSB_ERROR_TIMEOUT);
486 return (LIBUSB_ERROR_NO_DEVICE);
491 static libusb_context *
492 libusb10_get_context_by_device_handle(libusb_device_handle *devh)
497 ctx = libusb_get_device(devh)->ctx;
501 return (GET_CONTEXT(ctx));
505 libusb10_do_transfer_cb(struct libusb_transfer *transfer)
510 ctx = libusb10_get_context_by_device_handle(transfer->dev_handle);
512 DPRINTF(ctx, LIBUSB_DEBUG_TRANSFER, "sync I/O done");
514 pdone = transfer->user_data;
519 * TODO: Replace the following function. Allocating and freeing on a
520 * per-transfer basis is slow. --HPS
523 libusb10_do_transfer(libusb_device_handle *devh,
524 uint8_t endpoint, uint8_t *data, int length,
525 int *transferred, unsigned int timeout, int type)
528 struct libusb_transfer *xfer;
533 return (LIBUSB_ERROR_INVALID_PARAM);
535 if ((length != 0) && (data == NULL))
536 return (LIBUSB_ERROR_INVALID_PARAM);
538 xfer = libusb_alloc_transfer(0);
540 return (LIBUSB_ERROR_NO_MEM);
542 ctx = libusb_get_device(devh)->ctx;
544 xfer->dev_handle = devh;
545 xfer->endpoint = endpoint;
547 xfer->timeout = timeout;
549 xfer->length = length;
550 xfer->user_data = (void *)&done;
551 xfer->callback = libusb10_do_transfer_cb;
554 if ((ret = libusb_submit_transfer(xfer)) < 0) {
555 libusb_free_transfer(xfer);
559 if ((ret = libusb_handle_events(ctx)) < 0) {
560 libusb_cancel_transfer(xfer);
561 usleep(1000); /* nice it */
565 *transferred = xfer->actual_length;
567 switch (xfer->status) {
568 case LIBUSB_TRANSFER_COMPLETED:
571 case LIBUSB_TRANSFER_TIMED_OUT:
572 ret = LIBUSB_ERROR_TIMEOUT;
574 case LIBUSB_TRANSFER_OVERFLOW:
575 ret = LIBUSB_ERROR_OVERFLOW;
577 case LIBUSB_TRANSFER_STALL:
578 ret = LIBUSB_ERROR_PIPE;
580 case LIBUSB_TRANSFER_NO_DEVICE:
581 ret = LIBUSB_ERROR_NO_DEVICE;
584 ret = LIBUSB_ERROR_OTHER;
588 libusb_free_transfer(xfer);
593 libusb_bulk_transfer(libusb_device_handle *devh,
594 uint8_t endpoint, uint8_t *data, int length,
595 int *transferred, unsigned int timeout)
600 ctx = libusb10_get_context_by_device_handle(devh);
602 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer enter");
604 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
605 timeout, LIBUSB_TRANSFER_TYPE_BULK);
607 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_bulk_transfer leave");
612 libusb_interrupt_transfer(libusb_device_handle *devh,
613 uint8_t endpoint, uint8_t *data, int length,
614 int *transferred, unsigned int timeout)
619 ctx = libusb10_get_context_by_device_handle(devh);
621 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer enter");
623 ret = libusb10_do_transfer(devh, endpoint, data, length, transferred,
624 timeout, LIBUSB_TRANSFER_TYPE_INTERRUPT);
626 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_interrupt_transfer leave");
631 libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t off)
636 if (transfer->num_iso_packets < 0)
639 if (off >= (uint32_t)transfer->num_iso_packets)
642 ptr = transfer->buffer;
646 for (n = 0; n != off; n++) {
647 ptr += transfer->iso_packet_desc[n].length;
653 libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t off)
657 if (transfer->num_iso_packets < 0)
660 if (off >= (uint32_t)transfer->num_iso_packets)
663 ptr = transfer->buffer;
667 ptr += transfer->iso_packet_desc[0].length * off;
673 libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length)
677 if (transfer->num_iso_packets < 0)
680 for (n = 0; n != transfer->num_iso_packets; n++)
681 transfer->iso_packet_desc[n].length = length;
685 libusb_control_transfer_get_data(struct libusb_transfer *transfer)
687 if (transfer->buffer == NULL)
690 return (transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE);
693 struct libusb_control_setup *
694 libusb_control_transfer_get_setup(struct libusb_transfer *transfer)
696 return ((struct libusb_control_setup *)transfer->buffer);
700 libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType,
701 uint8_t bRequest, uint16_t wValue,
702 uint16_t wIndex, uint16_t wLength)
704 struct libusb_control_setup *req = (struct libusb_control_setup *)buf;
706 /* The alignment is OK for all fields below. */
707 req->bmRequestType = bmRequestType;
708 req->bRequest = bRequest;
709 req->wValue = htole16(wValue);
710 req->wIndex = htole16(wIndex);
711 req->wLength = htole16(wLength);
715 libusb_fill_control_transfer(struct libusb_transfer *transfer,
716 libusb_device_handle *devh, uint8_t *buf,
717 libusb_transfer_cb_fn callback, void *user_data,
720 struct libusb_control_setup *setup = (struct libusb_control_setup *)buf;
722 transfer->dev_handle = devh;
723 transfer->endpoint = 0;
724 transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
725 transfer->timeout = timeout;
726 transfer->buffer = buf;
728 transfer->length = LIBUSB_CONTROL_SETUP_SIZE
729 + le16toh(setup->wLength);
731 transfer->length = 0;
732 transfer->user_data = user_data;
733 transfer->callback = callback;
738 libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
739 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
740 int length, libusb_transfer_cb_fn callback, void *user_data,
743 transfer->dev_handle = devh;
744 transfer->endpoint = endpoint;
745 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
746 transfer->timeout = timeout;
747 transfer->buffer = buf;
748 transfer->length = length;
749 transfer->user_data = user_data;
750 transfer->callback = callback;
754 libusb_fill_interrupt_transfer(struct libusb_transfer *transfer,
755 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
756 int length, libusb_transfer_cb_fn callback, void *user_data,
759 transfer->dev_handle = devh;
760 transfer->endpoint = endpoint;
761 transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
762 transfer->timeout = timeout;
763 transfer->buffer = buf;
764 transfer->length = length;
765 transfer->user_data = user_data;
766 transfer->callback = callback;
770 libusb_fill_iso_transfer(struct libusb_transfer *transfer,
771 libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf,
772 int length, int npacket, libusb_transfer_cb_fn callback,
773 void *user_data, uint32_t timeout)
775 transfer->dev_handle = devh;
776 transfer->endpoint = endpoint;
777 transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
778 transfer->timeout = timeout;
779 transfer->buffer = buf;
780 transfer->length = length;
781 transfer->num_iso_packets = npacket;
782 transfer->user_data = user_data;
783 transfer->callback = callback;
787 libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams,
788 unsigned char *endpoints, int num_endpoints)
791 return (LIBUSB_ERROR_NOT_SUPPORTED);
795 libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints)
802 libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
804 struct libusb_super_transfer *sxfer;
806 if (transfer == NULL)
809 sxfer = (struct libusb_super_transfer *)(
810 ((uint8_t *)transfer) - sizeof(*sxfer));
813 sxfer->stream_id = stream_id;
817 libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
819 struct libusb_super_transfer *sxfer;
821 if (transfer == NULL)
824 sxfer = (struct libusb_super_transfer *)(
825 ((uint8_t *)transfer) - sizeof(*sxfer));
828 return (sxfer->stream_id);