2 * Internal header for libusb
3 * Copyright © 2007-2009 Daniel Drake <dsd@gentoo.org>
4 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
42 /* Inside the libusb code, mark all public functions as follows:
43 * return_type API_EXPORTED function_name(params) { ... }
44 * But if the function returns a pointer, mark it as follows:
45 * DEFAULT_VISIBILITY return_type * LIBUSB_CALL function_name(params) { ... }
46 * In the libusb public header, mark all declarations as:
47 * return_type LIBUSB_CALL function_name(params);
49 #define API_EXPORTED LIBUSB_CALL DEFAULT_VISIBILITY
55 #define DEVICE_DESC_LENGTH 18
57 #define USB_MAXENDPOINTS 32
58 #define USB_MAXINTERFACES 32
59 #define USB_MAXCONFIG 8
61 /* Backend specific capabilities */
62 #define USBI_CAP_HAS_HID_ACCESS 0x00010000
63 #define USBI_CAP_SUPPORTS_DETACH_KERNEL_DRIVER 0x00020000
65 /* Maximum number of bytes in a log line */
66 #define USBI_MAX_LOG_LEN 1024
67 /* Terminator for log lines */
68 #define USBI_LOG_LINE_END "\n"
70 /* The following is used to silence warnings for unused variables */
71 #define UNUSED(var) do { (void)(var); } while(0)
73 #if !defined(ARRAYSIZE)
74 #define ARRAYSIZE(array) (sizeof(array) / sizeof(array[0]))
78 struct list_head *prev, *next;
81 /* Get an entry from the list
82 * ptr - the address of this list_head element in "type"
83 * type - the data type that contains "member"
84 * member - the list_head element in "type"
86 #define list_entry(ptr, type, member) \
87 ((type *)((uintptr_t)(ptr) - (uintptr_t)offsetof(type, member)))
89 #define list_first_entry(ptr, type, member) \
90 list_entry((ptr)->next, type, member)
92 /* Get each entry from a list
93 * pos - A structure pointer has a "member" element
95 * member - the list_head element in "pos"
96 * type - the type of the first parameter
98 #define list_for_each_entry(pos, head, member, type) \
99 for (pos = list_entry((head)->next, type, member); \
100 &pos->member != (head); \
101 pos = list_entry(pos->member.next, type, member))
103 #define list_for_each_entry_safe(pos, n, head, member, type) \
104 for (pos = list_entry((head)->next, type, member), \
105 n = list_entry(pos->member.next, type, member); \
106 &pos->member != (head); \
107 pos = n, n = list_entry(n->member.next, type, member))
109 #define list_empty(entry) ((entry)->next == (entry))
111 static inline void list_init(struct list_head *entry)
113 entry->prev = entry->next = entry;
116 static inline void list_add(struct list_head *entry, struct list_head *head)
118 entry->next = head->next;
121 head->next->prev = entry;
125 static inline void list_add_tail(struct list_head *entry,
126 struct list_head *head)
129 entry->prev = head->prev;
131 head->prev->next = entry;
135 static inline void list_del(struct list_head *entry)
137 entry->next->prev = entry->prev;
138 entry->prev->next = entry->next;
139 entry->next = entry->prev = NULL;
142 static inline void *usbi_reallocf(void *ptr, size_t size)
144 void *ret = realloc(ptr, size);
150 #define container_of(ptr, type, member) ({ \
151 const typeof( ((type *)0)->member ) *mptr = (ptr); \
152 (type *)( (char *)mptr - offsetof(type,member) );})
155 #define MIN(a, b) ((a) < (b) ? (a) : (b))
158 #define MAX(a, b) ((a) > (b) ? (a) : (b))
161 #define TIMESPEC_IS_SET(ts) ((ts)->tv_sec != 0 || (ts)->tv_nsec != 0)
163 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
164 #define TIMEVAL_TV_SEC_TYPE long
166 #define TIMEVAL_TV_SEC_TYPE time_t
169 /* Some platforms don't have this define */
170 #ifndef TIMESPEC_TO_TIMEVAL
171 #define TIMESPEC_TO_TIMEVAL(tv, ts) \
173 (tv)->tv_sec = (TIMEVAL_TV_SEC_TYPE) (ts)->tv_sec; \
174 (tv)->tv_usec = (ts)->tv_nsec / 1000; \
178 void usbi_log(struct libusb_context *ctx, enum libusb_log_level level,
179 const char *function, const char *format, ...);
181 void usbi_log_v(struct libusb_context *ctx, enum libusb_log_level level,
182 const char *function, const char *format, va_list args);
184 #if !defined(_MSC_VER) || _MSC_VER >= 1400
186 #ifdef ENABLE_LOGGING
187 #define _usbi_log(ctx, level, ...) usbi_log(ctx, level, __FUNCTION__, __VA_ARGS__)
188 #define usbi_dbg(...) _usbi_log(NULL, LIBUSB_LOG_LEVEL_DEBUG, __VA_ARGS__)
190 #define _usbi_log(ctx, level, ...) do { (void)(ctx); } while(0)
191 #define usbi_dbg(...) do {} while(0)
194 #define usbi_info(ctx, ...) _usbi_log(ctx, LIBUSB_LOG_LEVEL_INFO, __VA_ARGS__)
195 #define usbi_warn(ctx, ...) _usbi_log(ctx, LIBUSB_LOG_LEVEL_WARNING, __VA_ARGS__)
196 #define usbi_err(ctx, ...) _usbi_log(ctx, LIBUSB_LOG_LEVEL_ERROR, __VA_ARGS__)
198 #else /* !defined(_MSC_VER) || _MSC_VER >= 1400 */
200 #ifdef ENABLE_LOGGING
201 #define LOG_BODY(ctxt, level) \
204 va_start(args, format); \
205 usbi_log_v(ctxt, level, "", format, args); \
209 #define LOG_BODY(ctxt, level) \
215 static inline void usbi_info(struct libusb_context *ctx, const char *format, ...)
216 LOG_BODY(ctx, LIBUSB_LOG_LEVEL_INFO)
217 static inline void usbi_warn(struct libusb_context *ctx, const char *format, ...)
218 LOG_BODY(ctx, LIBUSB_LOG_LEVEL_WARNING)
219 static inline void usbi_err(struct libusb_context *ctx, const char *format, ...)
220 LOG_BODY(ctx, LIBUSB_LOG_LEVEL_ERROR)
222 static inline void usbi_dbg(const char *format, ...)
223 LOG_BODY(NULL, LIBUSB_LOG_LEVEL_DEBUG)
225 #endif /* !defined(_MSC_VER) || _MSC_VER >= 1400 */
227 #define USBI_GET_CONTEXT(ctx) \
230 (ctx) = usbi_default_context; \
233 #define DEVICE_CTX(dev) ((dev)->ctx)
234 #define HANDLE_CTX(handle) (DEVICE_CTX((handle)->dev))
235 #define TRANSFER_CTX(transfer) (HANDLE_CTX((transfer)->dev_handle))
236 #define ITRANSFER_CTX(transfer) \
237 (TRANSFER_CTX(USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)))
239 #define IS_EPIN(ep) (0 != ((ep) & LIBUSB_ENDPOINT_IN))
240 #define IS_EPOUT(ep) (!IS_EPIN(ep))
241 #define IS_XFERIN(xfer) (0 != ((xfer)->endpoint & LIBUSB_ENDPOINT_IN))
242 #define IS_XFEROUT(xfer) (!IS_XFERIN(xfer))
244 /* Internal abstraction for thread synchronization */
245 #if defined(THREADS_POSIX)
246 #include "os/threads_posix.h"
247 #elif defined(OS_WINDOWS) || defined(OS_WINCE)
248 #include "os/threads_windows.h"
251 extern struct libusb_context *usbi_default_context;
253 /* Forward declaration for use in context (fully defined inside poll abstraction) */
256 struct libusb_context {
260 /* internal event pipe, used for signalling occurrence of an internal event. */
263 struct list_head usb_devs;
264 usbi_mutex_t usb_devs_lock;
266 /* A list of open handles. Backends are free to traverse this if required.
268 struct list_head open_devs;
269 usbi_mutex_t open_devs_lock;
271 /* A list of registered hotplug callbacks */
272 struct list_head hotplug_cbs;
273 usbi_mutex_t hotplug_cbs_lock;
275 /* this is a list of in-flight transfer handles, sorted by timeout
276 * expiration. URBs to timeout the soonest are placed at the beginning of
277 * the list, URBs that will time out later are placed after, and urbs with
278 * infinite timeout are always placed at the very end. */
279 struct list_head flying_transfers;
280 usbi_mutex_t flying_transfers_lock;
282 /* user callbacks for pollfd changes */
283 libusb_pollfd_added_cb fd_added_cb;
284 libusb_pollfd_removed_cb fd_removed_cb;
285 void *fd_cb_user_data;
287 /* ensures that only one thread is handling events at any one time */
288 usbi_mutex_t events_lock;
290 /* used to see if there is an active thread doing event handling */
291 int event_handler_active;
293 /* A thread-local storage key to track which thread is performing event
295 usbi_tls_key_t event_handling_key;
297 /* used to wait for event completion in threads other than the one that is
299 usbi_mutex_t event_waiters_lock;
300 usbi_cond_t event_waiters_cond;
302 /* A lock to protect internal context event data. */
303 usbi_mutex_t event_data_lock;
305 /* A bitmask of flags that are set to indicate specific events that need to
306 * be handled. Protected by event_data_lock. */
307 unsigned int event_flags;
309 /* A counter that is set when we want to interrupt and prevent event handling,
310 * in order to safely close a device. Protected by event_data_lock. */
311 unsigned int device_close;
313 /* list and count of poll fds and an array of poll fd structures that is
314 * (re)allocated as necessary prior to polling. Protected by event_data_lock. */
315 struct list_head ipollfds;
316 struct pollfd *pollfds;
317 POLL_NFDS_TYPE pollfds_cnt;
319 /* A list of pending hotplug messages. Protected by event_data_lock. */
320 struct list_head hotplug_msgs;
322 /* A list of pending completed transfers. Protected by event_data_lock. */
323 struct list_head completed_transfers;
325 #ifdef USBI_TIMERFD_AVAILABLE
326 /* used for timeout handling, if supported by OS.
327 * this timerfd is maintained to trigger on the next pending timeout */
331 struct list_head list;
334 enum usbi_event_flags {
335 /* The list of pollfds has been modified */
336 USBI_EVENT_POLLFDS_MODIFIED = 1 << 0,
338 /* The user has interrupted the event handler */
339 USBI_EVENT_USER_INTERRUPT = 1 << 1,
342 /* Macros for managing event handling state */
343 #define usbi_handling_events(ctx) \
344 (usbi_tls_key_get((ctx)->event_handling_key) != NULL)
346 #define usbi_start_event_handling(ctx) \
347 usbi_tls_key_set((ctx)->event_handling_key, ctx)
349 #define usbi_end_event_handling(ctx) \
350 usbi_tls_key_set((ctx)->event_handling_key, NULL)
352 /* Update the following macro if new event sources are added */
353 #define usbi_pending_events(ctx) \
354 ((ctx)->event_flags || (ctx)->device_close \
355 || !list_empty(&(ctx)->hotplug_msgs) || !list_empty(&(ctx)->completed_transfers))
357 #ifdef USBI_TIMERFD_AVAILABLE
358 #define usbi_using_timerfd(ctx) ((ctx)->timerfd >= 0)
360 #define usbi_using_timerfd(ctx) (0)
363 struct libusb_device {
364 /* lock protects refcnt, everything else is finalized at initialization
369 struct libusb_context *ctx;
373 struct libusb_device* parent_dev;
374 uint8_t device_address;
375 uint8_t num_configurations;
376 enum libusb_speed speed;
378 struct list_head list;
379 unsigned long session_data;
381 struct libusb_device_descriptor device_descriptor;
384 unsigned char os_priv
385 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
386 [] /* valid C99 code */
388 [0] /* non-standard, but usually working code */
393 struct libusb_device_handle {
394 /* lock protects claimed_interfaces */
396 unsigned long claimed_interfaces;
398 struct list_head list;
399 struct libusb_device *dev;
400 int auto_detach_kernel_driver;
401 unsigned char os_priv
402 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
403 [] /* valid C99 code */
405 [0] /* non-standard, but usually working code */
411 USBI_CLOCK_MONOTONIC,
415 /* in-memory transfer layout:
417 * 1. struct usbi_transfer
418 * 2. struct libusb_transfer (which includes iso packets) [variable size]
419 * 3. os private data [variable size]
421 * from a libusb_transfer, you can get the usbi_transfer by rewinding the
422 * appropriate number of bytes.
423 * the usbi_transfer includes the number of allocated packets, so you can
424 * determine the size of the transfer and hence the start and length of the
428 struct usbi_transfer {
430 struct list_head list;
431 struct list_head completed_list;
432 struct timeval timeout;
437 /* this lock is held during libusb_submit_transfer() and
438 * libusb_cancel_transfer() (allowing the OS backend to prevent duplicate
439 * cancellation, submission-during-cancellation, etc). the OS backend
440 * should also take this lock in the handle_events path, to prevent the user
441 * cancelling the transfer from another thread while you are processing
442 * its completion (presumably there would be races within your OS backend
443 * if this were possible). */
446 /* this lock should be held whenever viewing or modifying flags
447 * relating to the transfer state */
448 usbi_mutex_t flags_lock;
451 enum usbi_transfer_flags {
452 /* The transfer has timed out */
453 USBI_TRANSFER_TIMED_OUT = 1 << 0,
455 /* Set by backend submit_transfer() if the OS handles timeout */
456 USBI_TRANSFER_OS_HANDLES_TIMEOUT = 1 << 1,
458 /* Cancellation was requested via libusb_cancel_transfer() */
459 USBI_TRANSFER_CANCELLING = 1 << 2,
461 /* Operation on the transfer failed because the device disappeared */
462 USBI_TRANSFER_DEVICE_DISAPPEARED = 1 << 3,
464 /* Transfer is currently being submitted */
465 USBI_TRANSFER_SUBMITTING = 1 << 4,
467 /* Transfer successfully submitted by backend */
468 USBI_TRANSFER_IN_FLIGHT = 1 << 5,
470 /* Completion handler has run */
471 USBI_TRANSFER_COMPLETED = 1 << 6,
473 /* The transfer timeout has been handled */
474 USBI_TRANSFER_TIMEOUT_HANDLED = 1 << 7,
477 #define USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer) \
478 ((struct libusb_transfer *)(((unsigned char *)(transfer)) \
479 + sizeof(struct usbi_transfer)))
480 #define LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer) \
481 ((struct usbi_transfer *)(((unsigned char *)(transfer)) \
482 - sizeof(struct usbi_transfer)))
484 static inline void *usbi_transfer_get_os_priv(struct usbi_transfer *transfer)
486 return ((unsigned char *)transfer) + sizeof(struct usbi_transfer)
487 + sizeof(struct libusb_transfer)
488 + (transfer->num_iso_packets
489 * sizeof(struct libusb_iso_packet_descriptor));
494 /* All standard descriptors have these 2 fields in common */
495 struct usb_descriptor_header {
497 uint8_t bDescriptorType;
500 /* shared data and functions */
502 int usbi_io_init(struct libusb_context *ctx);
503 void usbi_io_exit(struct libusb_context *ctx);
505 struct libusb_device *usbi_alloc_device(struct libusb_context *ctx,
506 unsigned long session_id);
507 struct libusb_device *usbi_get_device_by_session_id(struct libusb_context *ctx,
508 unsigned long session_id);
509 int usbi_sanitize_device(struct libusb_device *dev);
510 void usbi_handle_disconnect(struct libusb_device_handle *dev_handle);
512 int usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
513 enum libusb_transfer_status status);
514 int usbi_handle_transfer_cancellation(struct usbi_transfer *transfer);
515 void usbi_signal_transfer_completion(struct usbi_transfer *transfer);
517 int usbi_parse_descriptor(const unsigned char *source, const char *descriptor,
518 void *dest, int host_endian);
519 int usbi_device_cache_descriptor(libusb_device *dev);
520 int usbi_get_config_index_by_value(struct libusb_device *dev,
521 uint8_t bConfigurationValue, int *idx);
523 void usbi_connect_device (struct libusb_device *dev);
524 void usbi_disconnect_device (struct libusb_device *dev);
526 int usbi_signal_event(struct libusb_context *ctx);
527 int usbi_clear_event(struct libusb_context *ctx);
529 /* Internal abstraction for poll (needs struct usbi_transfer on Windows) */
530 #if defined(OS_LINUX) || defined(OS_DARWIN) || defined(OS_OPENBSD) || defined(OS_NETBSD) || defined(OS_HAIKU)
532 #include "os/poll_posix.h"
533 #elif defined(OS_WINDOWS) || defined(OS_WINCE)
534 #include "os/poll_windows.h"
537 #if (defined(OS_WINDOWS) || defined(OS_WINCE)) && !defined(__GNUC__)
538 #define snprintf _snprintf
539 #define vsnprintf _vsnprintf
540 int usbi_gettimeofday(struct timeval *tp, void *tzp);
541 #define LIBUSB_GETTIMEOFDAY_WIN32
542 #define HAVE_USBI_GETTIMEOFDAY
544 #ifdef HAVE_GETTIMEOFDAY
545 #define usbi_gettimeofday(tv, tz) gettimeofday((tv), (tz))
546 #define HAVE_USBI_GETTIMEOFDAY
551 /* must come first */
552 struct libusb_pollfd pollfd;
554 struct list_head list;
557 int usbi_add_pollfd(struct libusb_context *ctx, int fd, short events);
558 void usbi_remove_pollfd(struct libusb_context *ctx, int fd);
560 /* device discovery */
562 /* we traverse usbfs without knowing how many devices we are going to find.
563 * so we create this discovered_devs model which is similar to a linked-list
564 * which grows when required. it can be freed once discovery has completed,
565 * eliminating the need for a list node in the libusb_device structure
567 struct discovered_devs {
570 struct libusb_device *devices
571 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
572 [] /* valid C99 code */
574 [0] /* non-standard, but usually working code */
579 struct discovered_devs *discovered_devs_append(
580 struct discovered_devs *discdevs, struct libusb_device *dev);
584 /* This is the interface that OS backends need to implement.
585 * All fields are mandatory, except ones explicitly noted as optional. */
586 struct usbi_os_backend {
587 /* A human-readable name for your backend, e.g. "Linux usbfs" */
590 /* Binary mask for backend specific capabilities */
593 /* Perform initialization of your backend. You might use this function
594 * to determine specific capabilities of the system, allocate required
595 * data structures for later, etc.
597 * This function is called when a libusb user initializes the library
600 * Return 0 on success, or a LIBUSB_ERROR code on failure.
602 int (*init)(struct libusb_context *ctx);
604 /* Deinitialization. Optional. This function should destroy anything
605 * that was set up by init.
607 * This function is called when the user deinitializes the library.
611 /* Enumerate all the USB devices on the system, returning them in a list
612 * of discovered devices.
614 * Your implementation should enumerate all devices on the system,
615 * regardless of whether they have been seen before or not.
617 * When you have found a device, compute a session ID for it. The session
618 * ID should uniquely represent that particular device for that particular
619 * connection session since boot (i.e. if you disconnect and reconnect a
620 * device immediately after, it should be assigned a different session ID).
621 * If your OS cannot provide a unique session ID as described above,
622 * presenting a session ID of (bus_number << 8 | device_address) should
623 * be sufficient. Bus numbers and device addresses wrap and get reused,
624 * but that is an unlikely case.
626 * After computing a session ID for a device, call
627 * usbi_get_device_by_session_id(). This function checks if libusb already
628 * knows about the device, and if so, it provides you with a reference
629 * to a libusb_device structure for it.
631 * If usbi_get_device_by_session_id() returns NULL, it is time to allocate
632 * a new device structure for the device. Call usbi_alloc_device() to
633 * obtain a new libusb_device structure with reference count 1. Populate
634 * the bus_number and device_address attributes of the new device, and
635 * perform any other internal backend initialization you need to do. At
636 * this point, you should be ready to provide device descriptors and so
637 * on through the get_*_descriptor functions. Finally, call
638 * usbi_sanitize_device() to perform some final sanity checks on the
639 * device. Assuming all of the above succeeded, we can now continue.
640 * If any of the above failed, remember to unreference the device that
641 * was returned by usbi_alloc_device().
643 * At this stage we have a populated libusb_device structure (either one
644 * that was found earlier, or one that we have just allocated and
645 * populated). This can now be added to the discovered devices list
646 * using discovered_devs_append(). Note that discovered_devs_append()
647 * may reallocate the list, returning a new location for it, and also
648 * note that reallocation can fail. Your backend should handle these
649 * error conditions appropriately.
651 * This function should not generate any bus I/O and should not block.
652 * If I/O is required (e.g. reading the active configuration value), it is
653 * OK to ignore these suggestions :)
655 * This function is executed when the user wishes to retrieve a list
656 * of USB devices connected to the system.
658 * If the backend has hotplug support, this function is not used!
660 * Return 0 on success, or a LIBUSB_ERROR code on failure.
662 int (*get_device_list)(struct libusb_context *ctx,
663 struct discovered_devs **discdevs);
665 /* Apps which were written before hotplug support, may listen for
666 * hotplug events on their own and call libusb_get_device_list on
667 * device addition. In this case libusb_get_device_list will likely
668 * return a list without the new device in there, as the hotplug
669 * event thread will still be busy enumerating the device, which may
670 * take a while, or may not even have seen the event yet.
672 * To avoid this libusb_get_device_list will call this optional
673 * function for backends with hotplug support before copying
674 * ctx->usb_devs to the user. In this function the backend should
675 * ensure any pending hotplug events are fully processed before
678 * Optional, should be implemented by backends with hotplug support.
680 void (*hotplug_poll)(void);
682 /* Open a device for I/O and other USB operations. The device handle
683 * is preallocated for you, you can retrieve the device in question
684 * through handle->dev.
686 * Your backend should allocate any internal resources required for I/O
687 * and other operations so that those operations can happen (hopefully)
688 * without hiccup. This is also a good place to inform libusb that it
689 * should monitor certain file descriptors related to this device -
690 * see the usbi_add_pollfd() function.
692 * This function should not generate any bus I/O and should not block.
694 * This function is called when the user attempts to obtain a device
695 * handle for a device.
699 * - LIBUSB_ERROR_ACCESS if the user has insufficient permissions
700 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since
702 * - another LIBUSB_ERROR code on other failure
704 * Do not worry about freeing the handle on failed open, the upper layers
707 int (*open)(struct libusb_device_handle *dev_handle);
709 /* Close a device such that the handle cannot be used again. Your backend
710 * should destroy any resources that were allocated in the open path.
711 * This may also be a good place to call usbi_remove_pollfd() to inform
712 * libusb of any file descriptors associated with this device that should
713 * no longer be monitored.
715 * This function is called when the user closes a device handle.
717 void (*close)(struct libusb_device_handle *dev_handle);
719 /* Retrieve the device descriptor from a device.
721 * The descriptor should be retrieved from memory, NOT via bus I/O to the
722 * device. This means that you may have to cache it in a private structure
723 * during get_device_list enumeration. Alternatively, you may be able
724 * to retrieve it from a kernel interface (some Linux setups can do this)
725 * still without generating bus I/O.
727 * This function is expected to write DEVICE_DESC_LENGTH (18) bytes into
728 * buffer, which is guaranteed to be big enough.
730 * This function is called when sanity-checking a device before adding
731 * it to the list of discovered devices, and also when the user requests
732 * to read the device descriptor.
734 * This function is expected to return the descriptor in bus-endian format
735 * (LE). If it returns the multi-byte values in host-endian format,
736 * set the host_endian output parameter to "1".
738 * Return 0 on success or a LIBUSB_ERROR code on failure.
740 int (*get_device_descriptor)(struct libusb_device *device,
741 unsigned char *buffer, int *host_endian);
743 /* Get the ACTIVE configuration descriptor for a device.
745 * The descriptor should be retrieved from memory, NOT via bus I/O to the
746 * device. This means that you may have to cache it in a private structure
747 * during get_device_list enumeration. You may also have to keep track
748 * of which configuration is active when the user changes it.
750 * This function is expected to write len bytes of data into buffer, which
751 * is guaranteed to be big enough. If you can only do a partial write,
752 * return an error code.
754 * This function is expected to return the descriptor in bus-endian format
755 * (LE). If it returns the multi-byte values in host-endian format,
756 * set the host_endian output parameter to "1".
760 * - LIBUSB_ERROR_NOT_FOUND if the device is in unconfigured state
761 * - another LIBUSB_ERROR code on other failure
763 int (*get_active_config_descriptor)(struct libusb_device *device,
764 unsigned char *buffer, size_t len, int *host_endian);
766 /* Get a specific configuration descriptor for a device.
768 * The descriptor should be retrieved from memory, NOT via bus I/O to the
769 * device. This means that you may have to cache it in a private structure
770 * during get_device_list enumeration.
772 * The requested descriptor is expressed as a zero-based index (i.e. 0
773 * indicates that we are requesting the first descriptor). The index does
774 * not (necessarily) equal the bConfigurationValue of the configuration
777 * This function is expected to write len bytes of data into buffer, which
778 * is guaranteed to be big enough. If you can only do a partial write,
779 * return an error code.
781 * This function is expected to return the descriptor in bus-endian format
782 * (LE). If it returns the multi-byte values in host-endian format,
783 * set the host_endian output parameter to "1".
785 * Return the length read on success or a LIBUSB_ERROR code on failure.
787 int (*get_config_descriptor)(struct libusb_device *device,
788 uint8_t config_index, unsigned char *buffer, size_t len,
791 /* Like get_config_descriptor but then by bConfigurationValue instead
794 * Optional, if not present the core will call get_config_descriptor
795 * for all configs until it finds the desired bConfigurationValue.
797 * Returns a pointer to the raw-descriptor in *buffer, this memory
798 * is valid as long as device is valid.
800 * Returns the length of the returned raw-descriptor on success,
801 * or a LIBUSB_ERROR code on failure.
803 int (*get_config_descriptor_by_value)(struct libusb_device *device,
804 uint8_t bConfigurationValue, unsigned char **buffer,
807 /* Get the bConfigurationValue for the active configuration for a device.
808 * Optional. This should only be implemented if you can retrieve it from
809 * cache (don't generate I/O).
811 * If you cannot retrieve this from cache, either do not implement this
812 * function, or return LIBUSB_ERROR_NOT_SUPPORTED. This will cause
813 * libusb to retrieve the information through a standard control transfer.
815 * This function must be non-blocking.
818 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
820 * - LIBUSB_ERROR_NOT_SUPPORTED if the value cannot be retrieved without
822 * - another LIBUSB_ERROR code on other failure.
824 int (*get_configuration)(struct libusb_device_handle *dev_handle, int *config);
826 /* Set the active configuration for a device.
828 * A configuration value of -1 should put the device in unconfigured state.
830 * This function can block.
834 * - LIBUSB_ERROR_NOT_FOUND if the configuration does not exist
835 * - LIBUSB_ERROR_BUSY if interfaces are currently claimed (and hence
836 * configuration cannot be changed)
837 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
839 * - another LIBUSB_ERROR code on other failure.
841 int (*set_configuration)(struct libusb_device_handle *dev_handle, int config);
843 /* Claim an interface. When claimed, the application can then perform
844 * I/O to an interface's endpoints.
846 * This function should not generate any bus I/O and should not block.
847 * Interface claiming is a logical operation that simply ensures that
848 * no other drivers/applications are using the interface, and after
849 * claiming, no other drivers/applications can use the interface because
854 * - LIBUSB_ERROR_NOT_FOUND if the interface does not exist
855 * - LIBUSB_ERROR_BUSY if the interface is in use by another driver/app
856 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
858 * - another LIBUSB_ERROR code on other failure
860 int (*claim_interface)(struct libusb_device_handle *dev_handle, int interface_number);
862 /* Release a previously claimed interface.
864 * This function should also generate a SET_INTERFACE control request,
865 * resetting the alternate setting of that interface to 0. It's OK for
866 * this function to block as a result.
868 * You will only ever be asked to release an interface which was
869 * successfully claimed earlier.
873 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
875 * - another LIBUSB_ERROR code on other failure
877 int (*release_interface)(struct libusb_device_handle *dev_handle, int interface_number);
879 /* Set the alternate setting for an interface.
881 * You will only ever be asked to set the alternate setting for an
882 * interface which was successfully claimed earlier.
884 * It's OK for this function to block.
888 * - LIBUSB_ERROR_NOT_FOUND if the alternate setting does not exist
889 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
891 * - another LIBUSB_ERROR code on other failure
893 int (*set_interface_altsetting)(struct libusb_device_handle *dev_handle,
894 int interface_number, int altsetting);
896 /* Clear a halt/stall condition on an endpoint.
898 * It's OK for this function to block.
902 * - LIBUSB_ERROR_NOT_FOUND if the endpoint does not exist
903 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
905 * - another LIBUSB_ERROR code on other failure
907 int (*clear_halt)(struct libusb_device_handle *dev_handle,
908 unsigned char endpoint);
910 /* Perform a USB port reset to reinitialize a device.
912 * If possible, the device handle should still be usable after the reset
913 * completes, assuming that the device descriptors did not change during
914 * reset and all previous interface state can be restored.
916 * If something changes, or you cannot easily locate/verify the resetted
917 * device, return LIBUSB_ERROR_NOT_FOUND. This prompts the application
918 * to close the old handle and re-enumerate the device.
922 * - LIBUSB_ERROR_NOT_FOUND if re-enumeration is required, or if the device
923 * has been disconnected since it was opened
924 * - another LIBUSB_ERROR code on other failure
926 int (*reset_device)(struct libusb_device_handle *dev_handle);
928 /* Alloc num_streams usb3 bulk streams on the passed in endpoints */
929 int (*alloc_streams)(struct libusb_device_handle *dev_handle,
930 uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
932 /* Free usb3 bulk streams allocated with alloc_streams */
933 int (*free_streams)(struct libusb_device_handle *dev_handle,
934 unsigned char *endpoints, int num_endpoints);
936 /* Determine if a kernel driver is active on an interface. Optional.
938 * The presence of a kernel driver on an interface indicates that any
939 * calls to claim_interface would fail with the LIBUSB_ERROR_BUSY code.
942 * - 0 if no driver is active
943 * - 1 if a driver is active
944 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
946 * - another LIBUSB_ERROR code on other failure
948 int (*kernel_driver_active)(struct libusb_device_handle *dev_handle,
949 int interface_number);
951 /* Detach a kernel driver from an interface. Optional.
953 * After detaching a kernel driver, the interface should be available
958 * - LIBUSB_ERROR_NOT_FOUND if no kernel driver was active
959 * - LIBUSB_ERROR_INVALID_PARAM if the interface does not exist
960 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
962 * - another LIBUSB_ERROR code on other failure
964 int (*detach_kernel_driver)(struct libusb_device_handle *dev_handle,
965 int interface_number);
967 /* Attach a kernel driver to an interface. Optional.
969 * Reattach a kernel driver to the device.
973 * - LIBUSB_ERROR_NOT_FOUND if no kernel driver was active
974 * - LIBUSB_ERROR_INVALID_PARAM if the interface does not exist
975 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected since it
977 * - LIBUSB_ERROR_BUSY if a program or driver has claimed the interface,
978 * preventing reattachment
979 * - another LIBUSB_ERROR code on other failure
981 int (*attach_kernel_driver)(struct libusb_device_handle *dev_handle,
982 int interface_number);
984 /* Destroy a device. Optional.
986 * This function is called when the last reference to a device is
987 * destroyed. It should free any resources allocated in the get_device_list
990 void (*destroy_device)(struct libusb_device *dev);
992 /* Submit a transfer. Your implementation should take the transfer,
993 * morph it into whatever form your platform requires, and submit it
996 * This function must not block.
998 * This function gets called with the flying_transfers_lock locked!
1002 * - LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
1003 * - another LIBUSB_ERROR code on other failure
1005 int (*submit_transfer)(struct usbi_transfer *itransfer);
1007 /* Cancel a previously submitted transfer.
1009 * This function must not block. The transfer cancellation must complete
1010 * later, resulting in a call to usbi_handle_transfer_cancellation()
1011 * from the context of handle_events.
1013 int (*cancel_transfer)(struct usbi_transfer *itransfer);
1015 /* Clear a transfer as if it has completed or cancelled, but do not
1016 * report any completion/cancellation to the library. You should free
1017 * all private data from the transfer as if you were just about to report
1018 * completion or cancellation.
1020 * This function might seem a bit out of place. It is used when libusb
1021 * detects a disconnected device - it calls this function for all pending
1022 * transfers before reporting completion (with the disconnect code) to
1023 * the user. Maybe we can improve upon this internal interface in future.
1025 void (*clear_transfer_priv)(struct usbi_transfer *itransfer);
1027 /* Handle any pending events on file descriptors. Optional.
1029 * Provide this function when file descriptors directly indicate device
1030 * or transfer activity. If your backend does not have such file descriptors,
1031 * implement the handle_transfer_completion function below.
1033 * This involves monitoring any active transfers and processing their
1034 * completion or cancellation.
1036 * The function is passed an array of pollfd structures (size nfds)
1037 * as a result of the poll() system call. The num_ready parameter
1038 * indicates the number of file descriptors that have reported events
1039 * (i.e. the poll() return value). This should be enough information
1040 * for you to determine which actions need to be taken on the currently
1043 * For any cancelled transfers, call usbi_handle_transfer_cancellation().
1044 * For completed transfers, call usbi_handle_transfer_completion().
1045 * For control/bulk/interrupt transfers, populate the "transferred"
1046 * element of the appropriate usbi_transfer structure before calling the
1047 * above functions. For isochronous transfers, populate the status and
1048 * transferred fields of the iso packet descriptors of the transfer.
1050 * This function should also be able to detect disconnection of the
1051 * device, reporting that situation with usbi_handle_disconnect().
1053 * When processing an event related to a transfer, you probably want to
1054 * take usbi_transfer.lock to prevent races. See the documentation for
1055 * the usbi_transfer structure.
1057 * Return 0 on success, or a LIBUSB_ERROR code on failure.
1059 int (*handle_events)(struct libusb_context *ctx,
1060 struct pollfd *fds, POLL_NFDS_TYPE nfds, int num_ready);
1062 /* Handle transfer completion. Optional.
1064 * Provide this function when there are no file descriptors available
1065 * that directly indicate device or transfer activity. If your backend does
1066 * have such file descriptors, implement the handle_events function above.
1068 * Your backend must tell the library when a transfer has completed by
1069 * calling usbi_signal_transfer_completion(). You should store any private
1070 * information about the transfer and its completion status in the transfer's
1071 * private backend data.
1073 * During event handling, this function will be called on each transfer for
1074 * which usbi_signal_transfer_completion() was called.
1076 * For any cancelled transfers, call usbi_handle_transfer_cancellation().
1077 * For completed transfers, call usbi_handle_transfer_completion().
1078 * For control/bulk/interrupt transfers, populate the "transferred"
1079 * element of the appropriate usbi_transfer structure before calling the
1080 * above functions. For isochronous transfers, populate the status and
1081 * transferred fields of the iso packet descriptors of the transfer.
1083 * Return 0 on success, or a LIBUSB_ERROR code on failure.
1085 int (*handle_transfer_completion)(struct usbi_transfer *itransfer);
1087 /* Get time from specified clock. At least two clocks must be implemented
1088 by the backend: USBI_CLOCK_REALTIME, and USBI_CLOCK_MONOTONIC.
1090 Description of clocks:
1091 USBI_CLOCK_REALTIME : clock returns time since system epoch.
1092 USBI_CLOCK_MONOTONIC: clock returns time since unspecified start
1093 time (usually boot).
1095 int (*clock_gettime)(int clkid, struct timespec *tp);
1097 #ifdef USBI_TIMERFD_AVAILABLE
1098 /* clock ID of the clock that should be used for timerfd */
1099 clockid_t (*get_timerfd_clockid)(void);
1102 /* Number of bytes to reserve for per-device private backend data.
1103 * This private data area is accessible through the "os_priv" field of
1104 * struct libusb_device. */
1105 size_t device_priv_size;
1107 /* Number of bytes to reserve for per-handle private backend data.
1108 * This private data area is accessible through the "os_priv" field of
1109 * struct libusb_device. */
1110 size_t device_handle_priv_size;
1112 /* Number of bytes to reserve for per-transfer private backend data.
1113 * This private data area is accessible by calling
1114 * usbi_transfer_get_os_priv() on the appropriate usbi_transfer instance.
1116 size_t transfer_priv_size;
1119 extern const struct usbi_os_backend * const usbi_backend;
1121 extern const struct usbi_os_backend linux_usbfs_backend;
1122 extern const struct usbi_os_backend darwin_backend;
1123 extern const struct usbi_os_backend openbsd_backend;
1124 extern const struct usbi_os_backend netbsd_backend;
1125 extern const struct usbi_os_backend windows_backend;
1126 extern const struct usbi_os_backend usbdk_backend;
1127 extern const struct usbi_os_backend wince_backend;
1128 extern const struct usbi_os_backend haiku_usb_raw_backend;
1130 extern struct list_head active_contexts_list;
1131 extern usbi_mutex_static_t active_contexts_lock;