2 * Public libusb header file
3 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4 * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5 * Copyright © 2012 Pete Batard <pete@akeo.ie>
6 * Copyright © 2012 Nathan Hjelm <hjelmn@cs.unm.edu>
7 * For more information, please visit: http://libusb.info
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 /* on MS environments, the inline keyword is available in C++ only */
29 #if !defined(__cplusplus)
30 #define inline __inline
32 /* ssize_t is also not available (copy/paste from MinGW) */
33 #ifndef _SSIZE_T_DEFINED
34 #define _SSIZE_T_DEFINED
37 typedef __int64 ssize_t;
41 #endif /* _SSIZE_T_DEFINED */
44 /* stdint.h is not available on older MSVC */
45 #if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
46 typedef unsigned __int8 uint8_t;
47 typedef unsigned __int16 uint16_t;
48 typedef unsigned __int32 uint32_t;
53 #if !defined(_WIN32_WCE)
54 #include <sys/types.h>
57 #if defined(__linux__) || defined(__APPLE__) || defined(__CYGWIN__) || defined(__HAIKU__)
64 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
65 #define ZERO_SIZED_ARRAY /* [] - valid C99 code */
67 #define ZERO_SIZED_ARRAY 0 /* [0] - non-standard, but usually working code */
70 /* 'interface' might be defined as a macro on Windows, so we need to
71 * undefine it so as not to break the current libusb API, because
72 * libusb_config_descriptor has an 'interface' member
73 * As this can be problematic if you include windows.h after libusb.h
74 * in your sources, we force windows.h to be included first. */
75 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
77 #if defined(interface)
80 #if !defined(__CYGWIN__)
85 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
86 #define LIBUSB_DEPRECATED_FOR(f) \
87 __attribute__((deprecated("Use " #f " instead")))
89 #define LIBUSB_DEPRECATED_FOR(f) __attribute__((deprecated))
91 #define LIBUSB_DEPRECATED_FOR(f)
95 * \ingroup libusb_misc
96 * libusb's Windows calling convention.
98 * Under Windows, the selection of available compilers and configurations
99 * means that, unlike other platforms, there is not <em>one true calling
100 * convention</em> (calling convention: the manner in which parameters are
101 * passed to functions in the generated assembly code).
103 * Matching the Windows API itself, libusb uses the WINAPI convention (which
104 * translates to the <tt>stdcall</tt> convention) and guarantees that the
105 * library is compiled in this way. The public header file also includes
106 * appropriate annotations so that your own software will use the right
107 * convention, even if another convention is being used by default within
110 * The one consideration that you must apply in your software is to mark
111 * all functions which you use as libusb callbacks with this LIBUSB_CALL
112 * annotation, so that they too get compiled for the correct calling
115 * On non-Windows operating systems, this macro is defined as nothing. This
116 * means that you can apply it to your code without worrying about
117 * cross-platform compatibility.
119 /* LIBUSB_CALL must be defined on both definition and declaration of libusb
120 * functions. You'd think that declaration would be enough, but cygwin will
121 * complain about conflicting types unless both are marked this way.
122 * The placement of this macro is important too; it must appear after the
123 * return type, before the function name. See internal documentation for
126 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
127 #define LIBUSB_CALL WINAPI
132 /** \def LIBUSB_API_VERSION
133 * \ingroup libusb_misc
134 * libusb's API version.
136 * Since version 1.0.13, to help with feature detection, libusb defines
137 * a LIBUSB_API_VERSION macro that gets increased every time there is a
138 * significant change to the API, such as the introduction of a new call,
139 * the definition of a new macro/enum member, or any other element that
140 * libusb applications may want to detect at compilation time.
142 * The macro is typically used in an application as follows:
144 * #if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01001234)
145 * // Use one of the newer features from the libusb API
149 * Internally, LIBUSB_API_VERSION is defined as follows:
150 * (libusb major << 24) | (libusb minor << 16) | (16 bit incremental)
152 #define LIBUSB_API_VERSION 0x01000106
154 /* The following is kept for compatibility, but will be deprecated in the future */
155 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
162 * \ingroup libusb_misc
163 * Convert a 16-bit value from host-endian to little-endian format. On
164 * little endian systems, this function does nothing. On big endian systems,
165 * the bytes are swapped.
166 * \param x the host-endian value to convert
167 * \returns the value in little-endian byte order
169 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
175 _tmp.b8[1] = (uint8_t) (x >> 8);
176 _tmp.b8[0] = (uint8_t) (x & 0xff);
180 /** \def libusb_le16_to_cpu
181 * \ingroup libusb_misc
182 * Convert a 16-bit value from little-endian to host-endian format. On
183 * little endian systems, this function does nothing. On big endian systems,
184 * the bytes are swapped.
185 * \param x the little-endian value to convert
186 * \returns the value in host-endian byte order
188 #define libusb_le16_to_cpu libusb_cpu_to_le16
190 /* standard USB stuff */
192 /** \ingroup libusb_desc
193 * Device and/or Interface Class codes */
194 enum libusb_class_code {
195 /** In the context of a \ref libusb_device_descriptor "device descriptor",
196 * this bDeviceClass value indicates that each interface specifies its
197 * own class information and all interfaces operate independently.
199 LIBUSB_CLASS_PER_INTERFACE = 0,
202 LIBUSB_CLASS_AUDIO = 1,
204 /** Communications class */
205 LIBUSB_CLASS_COMM = 2,
207 /** Human Interface Device class */
208 LIBUSB_CLASS_HID = 3,
211 LIBUSB_CLASS_PHYSICAL = 5,
214 LIBUSB_CLASS_PRINTER = 7,
217 LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
218 LIBUSB_CLASS_IMAGE = 6,
220 /** Mass storage class */
221 LIBUSB_CLASS_MASS_STORAGE = 8,
224 LIBUSB_CLASS_HUB = 9,
227 LIBUSB_CLASS_DATA = 10,
230 LIBUSB_CLASS_SMART_CARD = 0x0b,
232 /** Content Security */
233 LIBUSB_CLASS_CONTENT_SECURITY = 0x0d,
236 LIBUSB_CLASS_VIDEO = 0x0e,
238 /** Personal Healthcare */
239 LIBUSB_CLASS_PERSONAL_HEALTHCARE = 0x0f,
241 /** Diagnostic Device */
242 LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
244 /** Wireless class */
245 LIBUSB_CLASS_WIRELESS = 0xe0,
247 /** Application class */
248 LIBUSB_CLASS_APPLICATION = 0xfe,
250 /** Class is vendor-specific */
251 LIBUSB_CLASS_VENDOR_SPEC = 0xff
254 /** \ingroup libusb_desc
255 * Descriptor types as defined by the USB specification. */
256 enum libusb_descriptor_type {
257 /** Device descriptor. See libusb_device_descriptor. */
258 LIBUSB_DT_DEVICE = 0x01,
260 /** Configuration descriptor. See libusb_config_descriptor. */
261 LIBUSB_DT_CONFIG = 0x02,
263 /** String descriptor */
264 LIBUSB_DT_STRING = 0x03,
266 /** Interface descriptor. See libusb_interface_descriptor. */
267 LIBUSB_DT_INTERFACE = 0x04,
269 /** Endpoint descriptor. See libusb_endpoint_descriptor. */
270 LIBUSB_DT_ENDPOINT = 0x05,
272 /** BOS descriptor */
273 LIBUSB_DT_BOS = 0x0f,
275 /** Device Capability descriptor */
276 LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
278 /** HID descriptor */
279 LIBUSB_DT_HID = 0x21,
281 /** HID report descriptor */
282 LIBUSB_DT_REPORT = 0x22,
284 /** Physical descriptor */
285 LIBUSB_DT_PHYSICAL = 0x23,
287 /** Hub descriptor */
288 LIBUSB_DT_HUB = 0x29,
290 /** SuperSpeed Hub descriptor */
291 LIBUSB_DT_SUPERSPEED_HUB = 0x2a,
293 /** SuperSpeed Endpoint Companion descriptor */
294 LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30
297 /* Descriptor sizes per descriptor type */
298 #define LIBUSB_DT_DEVICE_SIZE 18
299 #define LIBUSB_DT_CONFIG_SIZE 9
300 #define LIBUSB_DT_INTERFACE_SIZE 9
301 #define LIBUSB_DT_ENDPOINT_SIZE 7
302 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
303 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
304 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
305 #define LIBUSB_DT_BOS_SIZE 5
306 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
308 /* BOS descriptor sizes */
309 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
310 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
311 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
313 /* We unwrap the BOS => define its max size */
314 #define LIBUSB_DT_BOS_MAX_SIZE ((LIBUSB_DT_BOS_SIZE) +\
315 (LIBUSB_BT_USB_2_0_EXTENSION_SIZE) +\
316 (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\
317 (LIBUSB_BT_CONTAINER_ID_SIZE))
319 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
320 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
322 /** \ingroup libusb_desc
323 * Endpoint direction. Values for bit 7 of the
324 * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme.
326 enum libusb_endpoint_direction {
327 /** In: device-to-host */
328 LIBUSB_ENDPOINT_IN = 0x80,
330 /** Out: host-to-device */
331 LIBUSB_ENDPOINT_OUT = 0x00
334 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
336 /** \ingroup libusb_desc
337 * Endpoint transfer type. Values for bits 0:1 of the
338 * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field.
340 enum libusb_transfer_type {
341 /** Control endpoint */
342 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
344 /** Isochronous endpoint */
345 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
348 LIBUSB_TRANSFER_TYPE_BULK = 2,
350 /** Interrupt endpoint */
351 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
353 /** Stream endpoint */
354 LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,
357 /** \ingroup libusb_misc
358 * Standard requests, as defined in table 9-5 of the USB 3.0 specifications */
359 enum libusb_standard_request {
360 /** Request status of the specific recipient */
361 LIBUSB_REQUEST_GET_STATUS = 0x00,
363 /** Clear or disable a specific feature */
364 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
366 /* 0x02 is reserved */
368 /** Set or enable a specific feature */
369 LIBUSB_REQUEST_SET_FEATURE = 0x03,
371 /* 0x04 is reserved */
373 /** Set device address for all future accesses */
374 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
376 /** Get the specified descriptor */
377 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
379 /** Used to update existing descriptors or add new descriptors */
380 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
382 /** Get the current device configuration value */
383 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
385 /** Set device configuration */
386 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
388 /** Return the selected alternate setting for the specified interface */
389 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
391 /** Select an alternate interface for the specified interface */
392 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
394 /** Set then report an endpoint's synchronization frame */
395 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
397 /** Sets both the U1 and U2 Exit Latency */
398 LIBUSB_REQUEST_SET_SEL = 0x30,
400 /** Delay from the time a host transmits a packet to the time it is
401 * received by the device. */
402 LIBUSB_SET_ISOCH_DELAY = 0x31,
405 /** \ingroup libusb_misc
406 * Request type bits of the
407 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
409 enum libusb_request_type {
411 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
414 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
417 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
420 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
423 /** \ingroup libusb_misc
424 * Recipient bits of the
425 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
426 * transfers. Values 4 through 31 are reserved. */
427 enum libusb_request_recipient {
429 LIBUSB_RECIPIENT_DEVICE = 0x00,
432 LIBUSB_RECIPIENT_INTERFACE = 0x01,
435 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
438 LIBUSB_RECIPIENT_OTHER = 0x03,
441 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
443 /** \ingroup libusb_desc
444 * Synchronization type for isochronous endpoints. Values for bits 2:3 of the
445 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
446 * libusb_endpoint_descriptor.
448 enum libusb_iso_sync_type {
449 /** No synchronization */
450 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
453 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
456 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
459 LIBUSB_ISO_SYNC_TYPE_SYNC = 3
462 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
464 /** \ingroup libusb_desc
465 * Usage type for isochronous endpoints. Values for bits 4:5 of the
466 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
467 * libusb_endpoint_descriptor.
469 enum libusb_iso_usage_type {
471 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
473 /** Feedback endpoint */
474 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
476 /** Implicit feedback Data endpoint */
477 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
480 /** \ingroup libusb_desc
481 * A structure representing the standard USB device descriptor. This
482 * descriptor is documented in section 9.6.1 of the USB 3.0 specification.
483 * All multiple-byte fields are represented in host-endian format.
485 struct libusb_device_descriptor {
486 /** Size of this descriptor (in bytes) */
489 /** Descriptor type. Will have value
490 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this
492 uint8_t bDescriptorType;
494 /** USB specification release number in binary-coded decimal. A value of
495 * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */
498 /** USB-IF class code for the device. See \ref libusb_class_code. */
499 uint8_t bDeviceClass;
501 /** USB-IF subclass code for the device, qualified by the bDeviceClass
503 uint8_t bDeviceSubClass;
505 /** USB-IF protocol code for the device, qualified by the bDeviceClass and
506 * bDeviceSubClass values */
507 uint8_t bDeviceProtocol;
509 /** Maximum packet size for endpoint 0 */
510 uint8_t bMaxPacketSize0;
512 /** USB-IF vendor ID */
515 /** USB-IF product ID */
518 /** Device release number in binary-coded decimal */
521 /** Index of string descriptor describing manufacturer */
522 uint8_t iManufacturer;
524 /** Index of string descriptor describing product */
527 /** Index of string descriptor containing device serial number */
528 uint8_t iSerialNumber;
530 /** Number of possible configurations */
531 uint8_t bNumConfigurations;
534 /** \ingroup libusb_desc
535 * A structure representing the standard USB endpoint descriptor. This
536 * descriptor is documented in section 9.6.6 of the USB 3.0 specification.
537 * All multiple-byte fields are represented in host-endian format.
539 struct libusb_endpoint_descriptor {
540 /** Size of this descriptor (in bytes) */
543 /** Descriptor type. Will have value
544 * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in
546 uint8_t bDescriptorType;
548 /** The address of the endpoint described by this descriptor. Bits 0:3 are
549 * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction,
550 * see \ref libusb_endpoint_direction.
552 uint8_t bEndpointAddress;
554 /** Attributes which apply to the endpoint when it is configured using
555 * the bConfigurationValue. Bits 0:1 determine the transfer type and
556 * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for
557 * isochronous endpoints and correspond to \ref libusb_iso_sync_type.
558 * Bits 4:5 are also only used for isochronous endpoints and correspond to
559 * \ref libusb_iso_usage_type. Bits 6:7 are reserved.
561 uint8_t bmAttributes;
563 /** Maximum packet size this endpoint is capable of sending/receiving. */
564 uint16_t wMaxPacketSize;
566 /** Interval for polling endpoint for data transfers. */
569 /** For audio devices only: the rate at which synchronization feedback
573 /** For audio devices only: the address if the synch endpoint */
574 uint8_t bSynchAddress;
576 /** Extra descriptors. If libusb encounters unknown endpoint descriptors,
577 * it will store them here, should you wish to parse them. */
578 const unsigned char *extra;
580 /** Length of the extra descriptors, in bytes. */
584 /** \ingroup libusb_desc
585 * A structure representing the standard USB interface descriptor. This
586 * descriptor is documented in section 9.6.5 of the USB 3.0 specification.
587 * All multiple-byte fields are represented in host-endian format.
589 struct libusb_interface_descriptor {
590 /** Size of this descriptor (in bytes) */
593 /** Descriptor type. Will have value
594 * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE
595 * in this context. */
596 uint8_t bDescriptorType;
598 /** Number of this interface */
599 uint8_t bInterfaceNumber;
601 /** Value used to select this alternate setting for this interface */
602 uint8_t bAlternateSetting;
604 /** Number of endpoints used by this interface (excluding the control
606 uint8_t bNumEndpoints;
608 /** USB-IF class code for this interface. See \ref libusb_class_code. */
609 uint8_t bInterfaceClass;
611 /** USB-IF subclass code for this interface, qualified by the
612 * bInterfaceClass value */
613 uint8_t bInterfaceSubClass;
615 /** USB-IF protocol code for this interface, qualified by the
616 * bInterfaceClass and bInterfaceSubClass values */
617 uint8_t bInterfaceProtocol;
619 /** Index of string descriptor describing this interface */
622 /** Array of endpoint descriptors. This length of this array is determined
623 * by the bNumEndpoints field. */
624 const struct libusb_endpoint_descriptor *endpoint;
626 /** Extra descriptors. If libusb encounters unknown interface descriptors,
627 * it will store them here, should you wish to parse them. */
628 const unsigned char *extra;
630 /** Length of the extra descriptors, in bytes. */
634 /** \ingroup libusb_desc
635 * A collection of alternate settings for a particular USB interface.
637 struct libusb_interface {
638 /** Array of interface descriptors. The length of this array is determined
639 * by the num_altsetting field. */
640 const struct libusb_interface_descriptor *altsetting;
642 /** The number of alternate settings that belong to this interface */
646 /** \ingroup libusb_desc
647 * A structure representing the standard USB configuration descriptor. This
648 * descriptor is documented in section 9.6.3 of the USB 3.0 specification.
649 * All multiple-byte fields are represented in host-endian format.
651 struct libusb_config_descriptor {
652 /** Size of this descriptor (in bytes) */
655 /** Descriptor type. Will have value
656 * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG
657 * in this context. */
658 uint8_t bDescriptorType;
660 /** Total length of data returned for this configuration */
661 uint16_t wTotalLength;
663 /** Number of interfaces supported by this configuration */
664 uint8_t bNumInterfaces;
666 /** Identifier value for this configuration */
667 uint8_t bConfigurationValue;
669 /** Index of string descriptor describing this configuration */
670 uint8_t iConfiguration;
672 /** Configuration characteristics */
673 uint8_t bmAttributes;
675 /** Maximum power consumption of the USB device from this bus in this
676 * configuration when the device is fully operation. Expressed in units
677 * of 2 mA when the device is operating in high-speed mode and in units
678 * of 8 mA when the device is operating in super-speed mode. */
681 /** Array of interfaces supported by this configuration. The length of
682 * this array is determined by the bNumInterfaces field. */
683 const struct libusb_interface *interface;
685 /** Extra descriptors. If libusb encounters unknown configuration
686 * descriptors, it will store them here, should you wish to parse them. */
687 const unsigned char *extra;
689 /** Length of the extra descriptors, in bytes. */
693 /** \ingroup libusb_desc
694 * A structure representing the superspeed endpoint companion
695 * descriptor. This descriptor is documented in section 9.6.7 of
696 * the USB 3.0 specification. All multiple-byte fields are represented in
697 * host-endian format.
699 struct libusb_ss_endpoint_companion_descriptor {
701 /** Size of this descriptor (in bytes) */
704 /** Descriptor type. Will have value
705 * \ref libusb_descriptor_type::LIBUSB_DT_SS_ENDPOINT_COMPANION in
707 uint8_t bDescriptorType;
710 /** The maximum number of packets the endpoint can send or
711 * receive as part of a burst. */
714 /** In bulk EP: bits 4:0 represents the maximum number of
715 * streams the EP supports. In isochronous EP: bits 1:0
716 * represents the Mult - a zero based value that determines
717 * the maximum number of packets within a service interval */
718 uint8_t bmAttributes;
720 /** The total number of bytes this EP will transfer every
721 * service interval. valid only for periodic EPs. */
722 uint16_t wBytesPerInterval;
725 /** \ingroup libusb_desc
726 * A generic representation of a BOS Device Capability descriptor. It is
727 * advised to check bDevCapabilityType and call the matching
728 * libusb_get_*_descriptor function to get a structure fully matching the type.
730 struct libusb_bos_dev_capability_descriptor {
731 /** Size of this descriptor (in bytes) */
733 /** Descriptor type. Will have value
734 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
735 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
736 uint8_t bDescriptorType;
737 /** Device Capability type */
738 uint8_t bDevCapabilityType;
739 /** Device Capability data (bLength - 3 bytes) */
740 uint8_t dev_capability_data[ZERO_SIZED_ARRAY];
743 /** \ingroup libusb_desc
744 * A structure representing the Binary Device Object Store (BOS) descriptor.
745 * This descriptor is documented in section 9.6.2 of the USB 3.0 specification.
746 * All multiple-byte fields are represented in host-endian format.
748 struct libusb_bos_descriptor {
749 /** Size of this descriptor (in bytes) */
752 /** Descriptor type. Will have value
753 * \ref libusb_descriptor_type::LIBUSB_DT_BOS LIBUSB_DT_BOS
754 * in this context. */
755 uint8_t bDescriptorType;
757 /** Length of this descriptor and all of its sub descriptors */
758 uint16_t wTotalLength;
760 /** The number of separate device capability descriptors in
762 uint8_t bNumDeviceCaps;
764 /** bNumDeviceCap Device Capability Descriptors */
765 struct libusb_bos_dev_capability_descriptor *dev_capability[ZERO_SIZED_ARRAY];
768 /** \ingroup libusb_desc
769 * A structure representing the USB 2.0 Extension descriptor
770 * This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification.
771 * All multiple-byte fields are represented in host-endian format.
773 struct libusb_usb_2_0_extension_descriptor {
774 /** Size of this descriptor (in bytes) */
777 /** Descriptor type. Will have value
778 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
779 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
780 uint8_t bDescriptorType;
782 /** Capability type. Will have value
783 * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION
784 * LIBUSB_BT_USB_2_0_EXTENSION in this context. */
785 uint8_t bDevCapabilityType;
787 /** Bitmap encoding of supported device level features.
788 * A value of one in a bit location indicates a feature is
789 * supported; a value of zero indicates it is not supported.
790 * See \ref libusb_usb_2_0_extension_attributes. */
791 uint32_t bmAttributes;
794 /** \ingroup libusb_desc
795 * A structure representing the SuperSpeed USB Device Capability descriptor
796 * This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification.
797 * All multiple-byte fields are represented in host-endian format.
799 struct libusb_ss_usb_device_capability_descriptor {
800 /** Size of this descriptor (in bytes) */
803 /** Descriptor type. Will have value
804 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
805 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
806 uint8_t bDescriptorType;
808 /** Capability type. Will have value
809 * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
810 * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY in this context. */
811 uint8_t bDevCapabilityType;
813 /** Bitmap encoding of supported device level features.
814 * A value of one in a bit location indicates a feature is
815 * supported; a value of zero indicates it is not supported.
816 * See \ref libusb_ss_usb_device_capability_attributes. */
817 uint8_t bmAttributes;
819 /** Bitmap encoding of the speed supported by this device when
820 * operating in SuperSpeed mode. See \ref libusb_supported_speed. */
821 uint16_t wSpeedSupported;
823 /** The lowest speed at which all the functionality supported
824 * by the device is available to the user. For example if the
825 * device supports all its functionality when connected at
826 * full speed and above then it sets this value to 1. */
827 uint8_t bFunctionalitySupport;
829 /** U1 Device Exit Latency. */
830 uint8_t bU1DevExitLat;
832 /** U2 Device Exit Latency. */
833 uint16_t bU2DevExitLat;
836 /** \ingroup libusb_desc
837 * A structure representing the Container ID descriptor.
838 * This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification.
839 * All multiple-byte fields, except UUIDs, are represented in host-endian format.
841 struct libusb_container_id_descriptor {
842 /** Size of this descriptor (in bytes) */
845 /** Descriptor type. Will have value
846 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
847 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
848 uint8_t bDescriptorType;
850 /** Capability type. Will have value
851 * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID
852 * LIBUSB_BT_CONTAINER_ID in this context. */
853 uint8_t bDevCapabilityType;
855 /** Reserved field */
859 uint8_t ContainerID[16];
862 /** \ingroup libusb_asyncio
863 * Setup packet for control transfers. */
864 struct libusb_control_setup {
865 /** Request type. Bits 0:4 determine recipient, see
866 * \ref libusb_request_recipient. Bits 5:6 determine type, see
867 * \ref libusb_request_type. Bit 7 determines data transfer direction, see
868 * \ref libusb_endpoint_direction.
870 uint8_t bmRequestType;
872 /** Request. If the type bits of bmRequestType are equal to
873 * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD
874 * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to
875 * \ref libusb_standard_request. For other cases, use of this field is
876 * application-specific. */
879 /** Value. Varies according to request */
882 /** Index. Varies according to request, typically used to pass an index
886 /** Number of bytes to transfer */
890 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
894 struct libusb_context;
895 struct libusb_device;
896 struct libusb_device_handle;
898 /** \ingroup libusb_lib
899 * Structure providing the version of the libusb runtime
901 struct libusb_version {
902 /** Library major version. */
903 const uint16_t major;
905 /** Library minor version. */
906 const uint16_t minor;
908 /** Library micro version. */
909 const uint16_t micro;
911 /** Library nano version. */
914 /** Library release candidate suffix string, e.g. "-rc4". */
917 /** For ABI compatibility only. */
918 const char* describe;
921 /** \ingroup libusb_lib
922 * Structure representing a libusb session. The concept of individual libusb
923 * sessions allows for your program to use two libraries (or dynamically
924 * load two modules) which both independently use libusb. This will prevent
925 * interference between the individual libusb users - for example
926 * libusb_set_option() will not affect the other user of the library, and
927 * libusb_exit() will not destroy resources that the other user is still
930 * Sessions are created by libusb_init() and destroyed through libusb_exit().
931 * If your application is guaranteed to only ever include a single libusb
932 * user (i.e. you), you do not have to worry about contexts: pass NULL in
933 * every function call where a context is required. The default context
936 * For more information, see \ref libusb_contexts.
938 typedef struct libusb_context libusb_context;
940 /** \ingroup libusb_dev
941 * Structure representing a USB device detected on the system. This is an
942 * opaque type for which you are only ever provided with a pointer, usually
943 * originating from libusb_get_device_list().
945 * Certain operations can be performed on a device, but in order to do any
946 * I/O you will have to first obtain a device handle using libusb_open().
948 * Devices are reference counted with libusb_ref_device() and
949 * libusb_unref_device(), and are freed when the reference count reaches 0.
950 * New devices presented by libusb_get_device_list() have a reference count of
951 * 1, and libusb_free_device_list() can optionally decrease the reference count
952 * on all devices in the list. libusb_open() adds another reference which is
953 * later destroyed by libusb_close().
955 typedef struct libusb_device libusb_device;
958 /** \ingroup libusb_dev
959 * Structure representing a handle on a USB device. This is an opaque type for
960 * which you are only ever provided with a pointer, usually originating from
963 * A device handle is used to perform I/O and other operations. When finished
964 * with a device handle, you should call libusb_close().
966 typedef struct libusb_device_handle libusb_device_handle;
968 /** \ingroup libusb_dev
969 * Speed codes. Indicates the speed at which the device is operating.
972 /** The OS doesn't report or know the device speed. */
973 LIBUSB_SPEED_UNKNOWN = 0,
975 /** The device is operating at low speed (1.5MBit/s). */
976 LIBUSB_SPEED_LOW = 1,
978 /** The device is operating at full speed (12MBit/s). */
979 LIBUSB_SPEED_FULL = 2,
981 /** The device is operating at high speed (480MBit/s). */
982 LIBUSB_SPEED_HIGH = 3,
984 /** The device is operating at super speed (5000MBit/s). */
985 LIBUSB_SPEED_SUPER = 4,
987 /** The device is operating at super speed plus (10000MBit/s). */
988 LIBUSB_SPEED_SUPER_PLUS = 5,
991 /** \ingroup libusb_dev
992 * Supported speeds (wSpeedSupported) bitfield. Indicates what
993 * speeds the device supports.
995 enum libusb_supported_speed {
996 /** Low speed operation supported (1.5MBit/s). */
997 LIBUSB_LOW_SPEED_OPERATION = 1,
999 /** Full speed operation supported (12MBit/s). */
1000 LIBUSB_FULL_SPEED_OPERATION = 2,
1002 /** High speed operation supported (480MBit/s). */
1003 LIBUSB_HIGH_SPEED_OPERATION = 4,
1005 /** Superspeed operation supported (5000MBit/s). */
1006 LIBUSB_SUPER_SPEED_OPERATION = 8,
1009 /** \ingroup libusb_dev
1010 * Masks for the bits of the
1011 * \ref libusb_usb_2_0_extension_descriptor::bmAttributes "bmAttributes" field
1012 * of the USB 2.0 Extension descriptor.
1014 enum libusb_usb_2_0_extension_attributes {
1015 /** Supports Link Power Management (LPM) */
1016 LIBUSB_BM_LPM_SUPPORT = 2,
1019 /** \ingroup libusb_dev
1020 * Masks for the bits of the
1021 * \ref libusb_ss_usb_device_capability_descriptor::bmAttributes "bmAttributes" field
1022 * field of the SuperSpeed USB Device Capability descriptor.
1024 enum libusb_ss_usb_device_capability_attributes {
1025 /** Supports Latency Tolerance Messages (LTM) */
1026 LIBUSB_BM_LTM_SUPPORT = 2,
1029 /** \ingroup libusb_dev
1030 * USB capability types
1032 enum libusb_bos_type {
1033 /** Wireless USB device capability */
1034 LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1,
1036 /** USB 2.0 extensions */
1037 LIBUSB_BT_USB_2_0_EXTENSION = 2,
1039 /** SuperSpeed USB device capability */
1040 LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3,
1042 /** Container ID type */
1043 LIBUSB_BT_CONTAINER_ID = 4,
1046 /** \ingroup libusb_misc
1047 * Error codes. Most libusb functions return 0 on success or one of these
1049 * You can call libusb_error_name() to retrieve a string representation of an
1050 * error code or libusb_strerror() to get an end-user suitable description of
1054 /** Success (no error) */
1057 /** Input/output error */
1058 LIBUSB_ERROR_IO = -1,
1060 /** Invalid parameter */
1061 LIBUSB_ERROR_INVALID_PARAM = -2,
1063 /** Access denied (insufficient permissions) */
1064 LIBUSB_ERROR_ACCESS = -3,
1066 /** No such device (it may have been disconnected) */
1067 LIBUSB_ERROR_NO_DEVICE = -4,
1069 /** Entity not found */
1070 LIBUSB_ERROR_NOT_FOUND = -5,
1072 /** Resource busy */
1073 LIBUSB_ERROR_BUSY = -6,
1075 /** Operation timed out */
1076 LIBUSB_ERROR_TIMEOUT = -7,
1079 LIBUSB_ERROR_OVERFLOW = -8,
1082 LIBUSB_ERROR_PIPE = -9,
1084 /** System call interrupted (perhaps due to signal) */
1085 LIBUSB_ERROR_INTERRUPTED = -10,
1087 /** Insufficient memory */
1088 LIBUSB_ERROR_NO_MEM = -11,
1090 /** Operation not supported or unimplemented on this platform */
1091 LIBUSB_ERROR_NOT_SUPPORTED = -12,
1093 /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1094 message strings in strerror.c when adding new error codes here. */
1097 LIBUSB_ERROR_OTHER = -99,
1100 /* Total number of error codes in enum libusb_error */
1101 #define LIBUSB_ERROR_COUNT 14
1103 /** \ingroup libusb_asyncio
1104 * Transfer status codes */
1105 enum libusb_transfer_status {
1106 /** Transfer completed without error. Note that this does not indicate
1107 * that the entire amount of requested data was transferred. */
1108 LIBUSB_TRANSFER_COMPLETED,
1110 /** Transfer failed */
1111 LIBUSB_TRANSFER_ERROR,
1113 /** Transfer timed out */
1114 LIBUSB_TRANSFER_TIMED_OUT,
1116 /** Transfer was cancelled */
1117 LIBUSB_TRANSFER_CANCELLED,
1119 /** For bulk/interrupt endpoints: halt condition detected (endpoint
1120 * stalled). For control endpoints: control request not supported. */
1121 LIBUSB_TRANSFER_STALL,
1123 /** Device was disconnected */
1124 LIBUSB_TRANSFER_NO_DEVICE,
1126 /** Device sent more data than requested */
1127 LIBUSB_TRANSFER_OVERFLOW,
1129 /* NB! Remember to update libusb_error_name()
1130 when adding new status codes here. */
1133 /** \ingroup libusb_asyncio
1134 * libusb_transfer.flags values */
1135 enum libusb_transfer_flags {
1136 /** Report short frames as errors */
1137 LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0,
1139 /** Automatically free() transfer buffer during libusb_free_transfer().
1140 * Note that buffers allocated with libusb_dev_mem_alloc() should not
1141 * be attempted freed in this way, since free() is not an appropriate
1142 * way to release such memory. */
1143 LIBUSB_TRANSFER_FREE_BUFFER = 1<<1,
1145 /** Automatically call libusb_free_transfer() after callback returns.
1146 * If this flag is set, it is illegal to call libusb_free_transfer()
1147 * from your transfer callback, as this will result in a double-free
1148 * when this flag is acted upon. */
1149 LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2,
1151 /** Terminate transfers that are a multiple of the endpoint's
1152 * wMaxPacketSize with an extra zero length packet. This is useful
1153 * when a device protocol mandates that each logical request is
1154 * terminated by an incomplete packet (i.e. the logical requests are
1155 * not separated by other means).
1157 * This flag only affects host-to-device transfers to bulk and interrupt
1158 * endpoints. In other situations, it is ignored.
1160 * This flag only affects transfers with a length that is a multiple of
1161 * the endpoint's wMaxPacketSize. On transfers of other lengths, this
1162 * flag has no effect. Therefore, if you are working with a device that
1163 * needs a ZLP whenever the end of the logical request falls on a packet
1164 * boundary, then it is sensible to set this flag on <em>every</em>
1165 * transfer (you do not have to worry about only setting it on transfers
1166 * that end on the boundary).
1168 * This flag is currently only supported on Linux.
1169 * On other systems, libusb_submit_transfer() will return
1170 * LIBUSB_ERROR_NOT_SUPPORTED for every transfer where this flag is set.
1172 * Available since libusb-1.0.9.
1174 LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3,
1177 /** \ingroup libusb_asyncio
1178 * Isochronous packet descriptor. */
1179 struct libusb_iso_packet_descriptor {
1180 /** Length of data to request in this packet */
1181 unsigned int length;
1183 /** Amount of data that was actually transferred */
1184 unsigned int actual_length;
1186 /** Status code for this packet */
1187 enum libusb_transfer_status status;
1190 struct libusb_transfer;
1192 /** \ingroup libusb_asyncio
1193 * Asynchronous transfer callback function type. When submitting asynchronous
1194 * transfers, you pass a pointer to a callback function of this type via the
1195 * \ref libusb_transfer::callback "callback" member of the libusb_transfer
1196 * structure. libusb will call this function later, when the transfer has
1197 * completed or failed. See \ref libusb_asyncio for more information.
1198 * \param transfer The libusb_transfer struct the callback function is being
1201 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1203 /** \ingroup libusb_asyncio
1204 * The generic USB transfer structure. The user populates this structure and
1205 * then submits it in order to request a transfer. After the transfer has
1206 * completed, the library populates the transfer with the results and passes
1207 * it back to the user.
1209 struct libusb_transfer {
1210 /** Handle of the device that this transfer will be submitted to */
1211 libusb_device_handle *dev_handle;
1213 /** A bitwise OR combination of \ref libusb_transfer_flags. */
1216 /** Address of the endpoint where this transfer will be sent. */
1217 unsigned char endpoint;
1219 /** Type of the endpoint from \ref libusb_transfer_type */
1222 /** Timeout for this transfer in milliseconds. A value of 0 indicates no
1224 unsigned int timeout;
1226 /** The status of the transfer. Read-only, and only for use within
1227 * transfer callback function.
1229 * If this is an isochronous transfer, this field may read COMPLETED even
1230 * if there were errors in the frames. Use the
1231 * \ref libusb_iso_packet_descriptor::status "status" field in each packet
1232 * to determine if errors occurred. */
1233 enum libusb_transfer_status status;
1235 /** Length of the data buffer */
1238 /** Actual length of data that was transferred. Read-only, and only for
1239 * use within transfer callback function. Not valid for isochronous
1240 * endpoint transfers. */
1243 /** Callback function. This will be invoked when the transfer completes,
1244 * fails, or is cancelled. */
1245 libusb_transfer_cb_fn callback;
1247 /** User context data to pass to the callback function. */
1251 unsigned char *buffer;
1253 /** Number of isochronous packets. Only used for I/O with isochronous
1255 int num_iso_packets;
1257 /** Isochronous packet descriptors, for isochronous transfers only. */
1258 struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY];
1261 /** \ingroup libusb_misc
1262 * Capabilities supported by an instance of libusb on the current running
1263 * platform. Test if the loaded library supports a given capability by calling
1264 * \ref libusb_has_capability().
1266 enum libusb_capability {
1267 /** The libusb_has_capability() API is available. */
1268 LIBUSB_CAP_HAS_CAPABILITY = 0x0000,
1269 /** Hotplug support is available on this platform. */
1270 LIBUSB_CAP_HAS_HOTPLUG = 0x0001,
1271 /** The library can access HID devices without requiring user intervention.
1272 * Note that before being able to actually access an HID device, you may
1273 * still have to call additional libusb functions such as
1274 * \ref libusb_detach_kernel_driver(). */
1275 LIBUSB_CAP_HAS_HID_ACCESS = 0x0100,
1276 /** The library supports detaching of the default USB driver, using
1277 * \ref libusb_detach_kernel_driver(), if one is set by the OS kernel */
1278 LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER = 0x0101
1281 /** \ingroup libusb_lib
1282 * Log message levels.
1283 * - LIBUSB_LOG_LEVEL_NONE (0) : no messages ever printed by the library (default)
1284 * - LIBUSB_LOG_LEVEL_ERROR (1) : error messages are printed to stderr
1285 * - LIBUSB_LOG_LEVEL_WARNING (2) : warning and error messages are printed to stderr
1286 * - LIBUSB_LOG_LEVEL_INFO (3) : informational messages are printed to stderr
1287 * - LIBUSB_LOG_LEVEL_DEBUG (4) : debug and informational messages are printed to stderr
1289 enum libusb_log_level {
1290 LIBUSB_LOG_LEVEL_NONE = 0,
1291 LIBUSB_LOG_LEVEL_ERROR = 1,
1292 LIBUSB_LOG_LEVEL_WARNING = 2,
1293 LIBUSB_LOG_LEVEL_INFO = 3,
1294 LIBUSB_LOG_LEVEL_DEBUG = 4,
1297 int LIBUSB_CALL libusb_init(libusb_context **ctx);
1298 void LIBUSB_CALL libusb_exit(libusb_context *ctx);
1299 LIBUSB_DEPRECATED_FOR(libusb_set_option)
1300 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1301 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1302 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1303 const char * LIBUSB_CALL libusb_error_name(int errcode);
1304 int LIBUSB_CALL libusb_setlocale(const char *locale);
1305 const char * LIBUSB_CALL libusb_strerror(enum libusb_error errcode);
1307 ssize_t LIBUSB_CALL libusb_get_device_list(libusb_context *ctx,
1308 libusb_device ***list);
1309 void LIBUSB_CALL libusb_free_device_list(libusb_device **list,
1311 libusb_device * LIBUSB_CALL libusb_ref_device(libusb_device *dev);
1312 void LIBUSB_CALL libusb_unref_device(libusb_device *dev);
1314 int LIBUSB_CALL libusb_get_configuration(libusb_device_handle *dev,
1316 int LIBUSB_CALL libusb_get_device_descriptor(libusb_device *dev,
1317 struct libusb_device_descriptor *desc);
1318 int LIBUSB_CALL libusb_get_active_config_descriptor(libusb_device *dev,
1319 struct libusb_config_descriptor **config);
1320 int LIBUSB_CALL libusb_get_config_descriptor(libusb_device *dev,
1321 uint8_t config_index, struct libusb_config_descriptor **config);
1322 int LIBUSB_CALL libusb_get_config_descriptor_by_value(libusb_device *dev,
1323 uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1324 void LIBUSB_CALL libusb_free_config_descriptor(
1325 struct libusb_config_descriptor *config);
1326 int LIBUSB_CALL libusb_get_ss_endpoint_companion_descriptor(
1327 struct libusb_context *ctx,
1328 const struct libusb_endpoint_descriptor *endpoint,
1329 struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1330 void LIBUSB_CALL libusb_free_ss_endpoint_companion_descriptor(
1331 struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1332 int LIBUSB_CALL libusb_get_bos_descriptor(libusb_device_handle *dev_handle,
1333 struct libusb_bos_descriptor **bos);
1334 void LIBUSB_CALL libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
1335 int LIBUSB_CALL libusb_get_usb_2_0_extension_descriptor(
1336 struct libusb_context *ctx,
1337 struct libusb_bos_dev_capability_descriptor *dev_cap,
1338 struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1339 void LIBUSB_CALL libusb_free_usb_2_0_extension_descriptor(
1340 struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1341 int LIBUSB_CALL libusb_get_ss_usb_device_capability_descriptor(
1342 struct libusb_context *ctx,
1343 struct libusb_bos_dev_capability_descriptor *dev_cap,
1344 struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1345 void LIBUSB_CALL libusb_free_ss_usb_device_capability_descriptor(
1346 struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1347 int LIBUSB_CALL libusb_get_container_id_descriptor(struct libusb_context *ctx,
1348 struct libusb_bos_dev_capability_descriptor *dev_cap,
1349 struct libusb_container_id_descriptor **container_id);
1350 void LIBUSB_CALL libusb_free_container_id_descriptor(
1351 struct libusb_container_id_descriptor *container_id);
1352 uint8_t LIBUSB_CALL libusb_get_bus_number(libusb_device *dev);
1353 uint8_t LIBUSB_CALL libusb_get_port_number(libusb_device *dev);
1354 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t* port_numbers, int port_numbers_len);
1355 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1356 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length);
1357 libusb_device * LIBUSB_CALL libusb_get_parent(libusb_device *dev);
1358 uint8_t LIBUSB_CALL libusb_get_device_address(libusb_device *dev);
1359 int LIBUSB_CALL libusb_get_device_speed(libusb_device *dev);
1360 int LIBUSB_CALL libusb_get_max_packet_size(libusb_device *dev,
1361 unsigned char endpoint);
1362 int LIBUSB_CALL libusb_get_max_iso_packet_size(libusb_device *dev,
1363 unsigned char endpoint);
1365 libusb_device * LIBUSB_CALL libusb_get_device_with_fd(libusb_context *ctx,
1366 int vid, int pid, const char *serial, int fd, int busnum, int devaddr);
1367 int LIBUSB_CALL libusb_open(libusb_device *dev, libusb_device_handle **dev_handle);
1368 void LIBUSB_CALL libusb_close(libusb_device_handle *dev_handle);
1369 libusb_device * LIBUSB_CALL libusb_get_device(libusb_device_handle *dev_handle);
1371 int LIBUSB_CALL libusb_set_configuration(libusb_device_handle *dev_handle,
1373 int LIBUSB_CALL libusb_claim_interface(libusb_device_handle *dev_handle,
1374 int interface_number);
1375 int LIBUSB_CALL libusb_release_interface(libusb_device_handle *dev_handle,
1376 int interface_number);
1378 libusb_device_handle * LIBUSB_CALL libusb_open_device_with_vid_pid(
1379 libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1381 int LIBUSB_CALL libusb_set_interface_alt_setting(libusb_device_handle *dev_handle,
1382 int interface_number, int alternate_setting);
1383 int LIBUSB_CALL libusb_clear_halt(libusb_device_handle *dev_handle,
1384 unsigned char endpoint);
1385 int LIBUSB_CALL libusb_reset_device(libusb_device_handle *dev_handle);
1387 int LIBUSB_CALL libusb_alloc_streams(libusb_device_handle *dev_handle,
1388 uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1389 int LIBUSB_CALL libusb_free_streams(libusb_device_handle *dev_handle,
1390 unsigned char *endpoints, int num_endpoints);
1392 unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1394 int LIBUSB_CALL libusb_dev_mem_free(libusb_device_handle *dev_handle,
1395 unsigned char *buffer, size_t length);
1397 int LIBUSB_CALL libusb_kernel_driver_active(libusb_device_handle *dev_handle,
1398 int interface_number);
1399 int LIBUSB_CALL libusb_detach_kernel_driver(libusb_device_handle *dev_handle,
1400 int interface_number);
1401 int LIBUSB_CALL libusb_attach_kernel_driver(libusb_device_handle *dev_handle,
1402 int interface_number);
1403 int LIBUSB_CALL libusb_set_auto_detach_kernel_driver(
1404 libusb_device_handle *dev_handle, int enable);
1408 /** \ingroup libusb_asyncio
1409 * Get the data section of a control transfer. This convenience function is here
1410 * to remind you that the data does not start until 8 bytes into the actual
1411 * buffer, as the setup packet comes first.
1413 * Calling this function only makes sense from a transfer callback function,
1414 * or situations where you have already allocated a suitably sized buffer at
1417 * \param transfer a transfer
1418 * \returns pointer to the first byte of the data section
1420 static inline unsigned char *libusb_control_transfer_get_data(
1421 struct libusb_transfer *transfer)
1423 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1426 /** \ingroup libusb_asyncio
1427 * Get the control setup packet of a control transfer. This convenience
1428 * function is here to remind you that the control setup occupies the first
1429 * 8 bytes of the transfer data buffer.
1431 * Calling this function only makes sense from a transfer callback function,
1432 * or situations where you have already allocated a suitably sized buffer at
1435 * \param transfer a transfer
1436 * \returns a casted pointer to the start of the transfer data buffer
1438 static inline struct libusb_control_setup *libusb_control_transfer_get_setup(
1439 struct libusb_transfer *transfer)
1441 return (struct libusb_control_setup *)(void *) transfer->buffer;
1444 /** \ingroup libusb_asyncio
1445 * Helper function to populate the setup packet (first 8 bytes of the data
1446 * buffer) for a control transfer. The wIndex, wValue and wLength values should
1447 * be given in host-endian byte order.
1449 * \param buffer buffer to output the setup packet into
1450 * This pointer must be aligned to at least 2 bytes boundary.
1451 * \param bmRequestType see the
1452 * \ref libusb_control_setup::bmRequestType "bmRequestType" field of
1453 * \ref libusb_control_setup
1454 * \param bRequest see the
1455 * \ref libusb_control_setup::bRequest "bRequest" field of
1456 * \ref libusb_control_setup
1457 * \param wValue see the
1458 * \ref libusb_control_setup::wValue "wValue" field of
1459 * \ref libusb_control_setup
1460 * \param wIndex see the
1461 * \ref libusb_control_setup::wIndex "wIndex" field of
1462 * \ref libusb_control_setup
1463 * \param wLength see the
1464 * \ref libusb_control_setup::wLength "wLength" field of
1465 * \ref libusb_control_setup
1467 static inline void libusb_fill_control_setup(unsigned char *buffer,
1468 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1471 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1472 setup->bmRequestType = bmRequestType;
1473 setup->bRequest = bRequest;
1474 setup->wValue = libusb_cpu_to_le16(wValue);
1475 setup->wIndex = libusb_cpu_to_le16(wIndex);
1476 setup->wLength = libusb_cpu_to_le16(wLength);
1479 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1480 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1481 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1482 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1483 void LIBUSB_CALL libusb_transfer_set_stream_id(
1484 struct libusb_transfer *transfer, uint32_t stream_id);
1485 uint32_t LIBUSB_CALL libusb_transfer_get_stream_id(
1486 struct libusb_transfer *transfer);
1488 /** \ingroup libusb_asyncio
1489 * Helper function to populate the required \ref libusb_transfer fields
1490 * for a control transfer.
1492 * If you pass a transfer buffer to this function, the first 8 bytes will
1493 * be interpreted as a control setup packet, and the wLength field will be
1494 * used to automatically populate the \ref libusb_transfer::length "length"
1495 * field of the transfer. Therefore the recommended approach is:
1496 * -# Allocate a suitably sized data buffer (including space for control setup)
1497 * -# Call libusb_fill_control_setup()
1498 * -# If this is a host-to-device transfer with a data stage, put the data
1499 * in place after the setup packet
1500 * -# Call this function
1501 * -# Call libusb_submit_transfer()
1503 * It is also legal to pass a NULL buffer to this function, in which case this
1504 * function will not attempt to populate the length field. Remember that you
1505 * must then populate the buffer and length fields later.
1507 * \param transfer the transfer to populate
1508 * \param dev_handle handle of the device that will handle the transfer
1509 * \param buffer data buffer. If provided, this function will interpret the
1510 * first 8 bytes as a setup packet and infer the transfer length from that.
1511 * This pointer must be aligned to at least 2 bytes boundary.
1512 * \param callback callback function to be invoked on transfer completion
1513 * \param user_data user data to pass to callback function
1514 * \param timeout timeout for the transfer in milliseconds
1516 static inline void libusb_fill_control_transfer(
1517 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1518 unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1519 unsigned int timeout)
1521 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1522 transfer->dev_handle = dev_handle;
1523 transfer->endpoint = 0;
1524 transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1525 transfer->timeout = timeout;
1526 transfer->buffer = buffer;
1528 transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1529 + libusb_le16_to_cpu(setup->wLength));
1530 transfer->user_data = user_data;
1531 transfer->callback = callback;
1534 /** \ingroup libusb_asyncio
1535 * Helper function to populate the required \ref libusb_transfer fields
1536 * for a bulk transfer.
1538 * \param transfer the transfer to populate
1539 * \param dev_handle handle of the device that will handle the transfer
1540 * \param endpoint address of the endpoint where this transfer will be sent
1541 * \param buffer data buffer
1542 * \param length length of data buffer
1543 * \param callback callback function to be invoked on transfer completion
1544 * \param user_data user data to pass to callback function
1545 * \param timeout timeout for the transfer in milliseconds
1547 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1548 libusb_device_handle *dev_handle, unsigned char endpoint,
1549 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1550 void *user_data, unsigned int timeout)
1552 transfer->dev_handle = dev_handle;
1553 transfer->endpoint = endpoint;
1554 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1555 transfer->timeout = timeout;
1556 transfer->buffer = buffer;
1557 transfer->length = length;
1558 transfer->user_data = user_data;
1559 transfer->callback = callback;
1562 /** \ingroup libusb_asyncio
1563 * Helper function to populate the required \ref libusb_transfer fields
1564 * for a bulk transfer using bulk streams.
1566 * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1568 * \param transfer the transfer to populate
1569 * \param dev_handle handle of the device that will handle the transfer
1570 * \param endpoint address of the endpoint where this transfer will be sent
1571 * \param stream_id bulk stream id for this transfer
1572 * \param buffer data buffer
1573 * \param length length of data buffer
1574 * \param callback callback function to be invoked on transfer completion
1575 * \param user_data user data to pass to callback function
1576 * \param timeout timeout for the transfer in milliseconds
1578 static inline void libusb_fill_bulk_stream_transfer(
1579 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1580 unsigned char endpoint, uint32_t stream_id,
1581 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1582 void *user_data, unsigned int timeout)
1584 libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1585 length, callback, user_data, timeout);
1586 transfer->type = LIBUSB_TRANSFER_TYPE_BULK_STREAM;
1587 libusb_transfer_set_stream_id(transfer, stream_id);
1590 /** \ingroup libusb_asyncio
1591 * Helper function to populate the required \ref libusb_transfer fields
1592 * for an interrupt transfer.
1594 * \param transfer the transfer to populate
1595 * \param dev_handle handle of the device that will handle the transfer
1596 * \param endpoint address of the endpoint where this transfer will be sent
1597 * \param buffer data buffer
1598 * \param length length of data buffer
1599 * \param callback callback function to be invoked on transfer completion
1600 * \param user_data user data to pass to callback function
1601 * \param timeout timeout for the transfer in milliseconds
1603 static inline void libusb_fill_interrupt_transfer(
1604 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1605 unsigned char endpoint, unsigned char *buffer, int length,
1606 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1608 transfer->dev_handle = dev_handle;
1609 transfer->endpoint = endpoint;
1610 transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
1611 transfer->timeout = timeout;
1612 transfer->buffer = buffer;
1613 transfer->length = length;
1614 transfer->user_data = user_data;
1615 transfer->callback = callback;
1618 /** \ingroup libusb_asyncio
1619 * Helper function to populate the required \ref libusb_transfer fields
1620 * for an isochronous transfer.
1622 * \param transfer the transfer to populate
1623 * \param dev_handle handle of the device that will handle the transfer
1624 * \param endpoint address of the endpoint where this transfer will be sent
1625 * \param buffer data buffer
1626 * \param length length of data buffer
1627 * \param num_iso_packets the number of isochronous packets
1628 * \param callback callback function to be invoked on transfer completion
1629 * \param user_data user data to pass to callback function
1630 * \param timeout timeout for the transfer in milliseconds
1632 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1633 libusb_device_handle *dev_handle, unsigned char endpoint,
1634 unsigned char *buffer, int length, int num_iso_packets,
1635 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1637 transfer->dev_handle = dev_handle;
1638 transfer->endpoint = endpoint;
1639 transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
1640 transfer->timeout = timeout;
1641 transfer->buffer = buffer;
1642 transfer->length = length;
1643 transfer->num_iso_packets = num_iso_packets;
1644 transfer->user_data = user_data;
1645 transfer->callback = callback;
1648 /** \ingroup libusb_asyncio
1649 * Convenience function to set the length of all packets in an isochronous
1650 * transfer, based on the num_iso_packets field in the transfer structure.
1652 * \param transfer a transfer
1653 * \param length the length to set in each isochronous packet descriptor
1654 * \see libusb_get_max_packet_size()
1656 static inline void libusb_set_iso_packet_lengths(
1657 struct libusb_transfer *transfer, unsigned int length)
1660 for (i = 0; i < transfer->num_iso_packets; i++)
1661 transfer->iso_packet_desc[i].length = length;
1664 /** \ingroup libusb_asyncio
1665 * Convenience function to locate the position of an isochronous packet
1666 * within the buffer of an isochronous transfer.
1668 * This is a thorough function which loops through all preceding packets,
1669 * accumulating their lengths to find the position of the specified packet.
1670 * Typically you will assign equal lengths to each packet in the transfer,
1671 * and hence the above method is sub-optimal. You may wish to use
1672 * libusb_get_iso_packet_buffer_simple() instead.
1674 * \param transfer a transfer
1675 * \param packet the packet to return the address of
1676 * \returns the base address of the packet buffer inside the transfer buffer,
1677 * or NULL if the packet does not exist.
1678 * \see libusb_get_iso_packet_buffer_simple()
1680 static inline unsigned char *libusb_get_iso_packet_buffer(
1681 struct libusb_transfer *transfer, unsigned int packet)
1687 /* oops..slight bug in the API. packet is an unsigned int, but we use
1688 * signed integers almost everywhere else. range-check and convert to
1689 * signed to avoid compiler warnings. FIXME for libusb-2. */
1690 if (packet > INT_MAX)
1692 _packet = (int) packet;
1694 if (_packet >= transfer->num_iso_packets)
1697 for (i = 0; i < _packet; i++)
1698 offset += transfer->iso_packet_desc[i].length;
1700 return transfer->buffer + offset;
1703 /** \ingroup libusb_asyncio
1704 * Convenience function to locate the position of an isochronous packet
1705 * within the buffer of an isochronous transfer, for transfers where each
1706 * packet is of identical size.
1708 * This function relies on the assumption that every packet within the transfer
1709 * is of identical size to the first packet. Calculating the location of
1710 * the packet buffer is then just a simple calculation:
1711 * <tt>buffer + (packet_size * packet)</tt>
1713 * Do not use this function on transfers other than those that have identical
1714 * packet lengths for each packet.
1716 * \param transfer a transfer
1717 * \param packet the packet to return the address of
1718 * \returns the base address of the packet buffer inside the transfer buffer,
1719 * or NULL if the packet does not exist.
1720 * \see libusb_get_iso_packet_buffer()
1722 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1723 struct libusb_transfer *transfer, unsigned int packet)
1727 /* oops..slight bug in the API. packet is an unsigned int, but we use
1728 * signed integers almost everywhere else. range-check and convert to
1729 * signed to avoid compiler warnings. FIXME for libusb-2. */
1730 if (packet > INT_MAX)
1732 _packet = (int) packet;
1734 if (_packet >= transfer->num_iso_packets)
1737 return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1742 int LIBUSB_CALL libusb_control_transfer(libusb_device_handle *dev_handle,
1743 uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1744 unsigned char *data, uint16_t wLength, unsigned int timeout);
1746 int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle,
1747 unsigned char endpoint, unsigned char *data, int length,
1748 int *actual_length, unsigned int timeout);
1750 int LIBUSB_CALL libusb_interrupt_transfer(libusb_device_handle *dev_handle,
1751 unsigned char endpoint, unsigned char *data, int length,
1752 int *actual_length, unsigned int timeout);
1754 /** \ingroup libusb_desc
1755 * Retrieve a descriptor from the default control pipe.
1756 * This is a convenience function which formulates the appropriate control
1757 * message to retrieve the descriptor.
1759 * \param dev_handle a device handle
1760 * \param desc_type the descriptor type, see \ref libusb_descriptor_type
1761 * \param desc_index the index of the descriptor to retrieve
1762 * \param data output buffer for descriptor
1763 * \param length size of data buffer
1764 * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1766 static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
1767 uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1769 return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1770 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1771 0, data, (uint16_t) length, 1000);
1774 /** \ingroup libusb_desc
1775 * Retrieve a descriptor from a device.
1776 * This is a convenience function which formulates the appropriate control
1777 * message to retrieve the descriptor. The string returned is Unicode, as
1778 * detailed in the USB specifications.
1780 * \param dev_handle a device handle
1781 * \param desc_index the index of the descriptor to retrieve
1782 * \param langid the language ID for the string descriptor
1783 * \param data output buffer for descriptor
1784 * \param length size of data buffer
1785 * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1786 * \see libusb_get_string_descriptor_ascii()
1788 static inline int libusb_get_string_descriptor(libusb_device_handle *dev_handle,
1789 uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1791 return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1792 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1793 langid, data, (uint16_t) length, 1000);
1796 int LIBUSB_CALL libusb_get_string_descriptor_ascii(libusb_device_handle *dev_handle,
1797 uint8_t desc_index, unsigned char *data, int length);
1799 /* polling and timeouts */
1801 int LIBUSB_CALL libusb_try_lock_events(libusb_context *ctx);
1802 void LIBUSB_CALL libusb_lock_events(libusb_context *ctx);
1803 void LIBUSB_CALL libusb_unlock_events(libusb_context *ctx);
1804 int LIBUSB_CALL libusb_event_handling_ok(libusb_context *ctx);
1805 int LIBUSB_CALL libusb_event_handler_active(libusb_context *ctx);
1806 void LIBUSB_CALL libusb_interrupt_event_handler(libusb_context *ctx);
1807 void LIBUSB_CALL libusb_lock_event_waiters(libusb_context *ctx);
1808 void LIBUSB_CALL libusb_unlock_event_waiters(libusb_context *ctx);
1809 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1811 int LIBUSB_CALL libusb_handle_events_timeout(libusb_context *ctx,
1812 struct timeval *tv);
1813 int LIBUSB_CALL libusb_handle_events_timeout_completed(libusb_context *ctx,
1814 struct timeval *tv, int *completed);
1815 int LIBUSB_CALL libusb_handle_events(libusb_context *ctx);
1816 int LIBUSB_CALL libusb_handle_events_completed(libusb_context *ctx, int *completed);
1817 int LIBUSB_CALL libusb_handle_events_locked(libusb_context *ctx,
1818 struct timeval *tv);
1819 int LIBUSB_CALL libusb_pollfds_handle_timeouts(libusb_context *ctx);
1820 int LIBUSB_CALL libusb_get_next_timeout(libusb_context *ctx,
1821 struct timeval *tv);
1823 /** \ingroup libusb_poll
1824 * File descriptor for polling
1826 struct libusb_pollfd {
1827 /** Numeric file descriptor */
1830 /** Event flags to poll for from <poll.h>. POLLIN indicates that you
1831 * should monitor this file descriptor for becoming ready to read from,
1832 * and POLLOUT indicates that you should monitor this file descriptor for
1833 * nonblocking write readiness. */
1837 /** \ingroup libusb_poll
1838 * Callback function, invoked when a new file descriptor should be added
1839 * to the set of file descriptors monitored for events.
1840 * \param fd the new file descriptor
1841 * \param events events to monitor for, see \ref libusb_pollfd for a
1843 * \param user_data User data pointer specified in
1844 * libusb_set_pollfd_notifiers() call
1845 * \see libusb_set_pollfd_notifiers()
1847 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1850 /** \ingroup libusb_poll
1851 * Callback function, invoked when a file descriptor should be removed from
1852 * the set of file descriptors being monitored for events. After returning
1853 * from this callback, do not use that file descriptor again.
1854 * \param fd the file descriptor to stop monitoring
1855 * \param user_data User data pointer specified in
1856 * libusb_set_pollfd_notifiers() call
1857 * \see libusb_set_pollfd_notifiers()
1859 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1861 const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
1862 libusb_context *ctx);
1863 void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
1864 void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx,
1865 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1868 /** \ingroup libusb_hotplug
1871 * Callbacks handles are generated by libusb_hotplug_register_callback()
1872 * and can be used to deregister callbacks. Callback handles are unique
1873 * per libusb_context and it is safe to call libusb_hotplug_deregister_callback()
1874 * on an already deregisted callback.
1876 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1878 * For more information, see \ref libusb_hotplug.
1880 typedef int libusb_hotplug_callback_handle;
1882 /** \ingroup libusb_hotplug
1884 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1886 * Flags for hotplug events */
1888 /** Default value when not using any flags. */
1889 LIBUSB_HOTPLUG_NO_FLAGS = 0,
1891 /** Arm the callback and fire it for all matching currently attached devices. */
1892 LIBUSB_HOTPLUG_ENUMERATE = 1<<0,
1893 } libusb_hotplug_flag;
1895 /** \ingroup libusb_hotplug
1897 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1901 /** A device has been plugged in and is ready to use */
1902 LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 0x01,
1904 /** A device has left and is no longer available.
1905 * It is the user's responsibility to call libusb_close on any handle associated with a disconnected device.
1906 * It is safe to call libusb_get_device_descriptor on a device that has left */
1907 LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 0x02,
1908 } libusb_hotplug_event;
1910 /** \ingroup libusb_hotplug
1911 * Wildcard matching for hotplug events */
1912 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1914 /** \ingroup libusb_hotplug
1915 * Hotplug callback function type. When requesting hotplug event notifications,
1916 * you pass a pointer to a callback function of this type.
1918 * This callback may be called by an internal event thread and as such it is
1919 * recommended the callback do minimal processing before returning.
1921 * libusb will call this function later, when a matching event had happened on
1922 * a matching device. See \ref libusb_hotplug for more information.
1924 * It is safe to call either libusb_hotplug_register_callback() or
1925 * libusb_hotplug_deregister_callback() from within a callback function.
1927 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1929 * \param ctx context of this notification
1930 * \param device libusb_device this event occurred on
1931 * \param event event that occurred
1932 * \param user_data user data provided when this callback was registered
1933 * \returns bool whether this callback is finished processing events.
1934 * returning 1 will cause this callback to be deregistered
1936 typedef int (LIBUSB_CALL *libusb_hotplug_callback_fn)(libusb_context *ctx,
1937 libusb_device *device,
1938 libusb_hotplug_event event,
1941 /** \ingroup libusb_hotplug
1942 * Register a hotplug callback function
1944 * Register a callback with the libusb_context. The callback will fire
1945 * when a matching event occurs on a matching device. The callback is
1946 * armed until either it is deregistered with libusb_hotplug_deregister_callback()
1947 * or the supplied callback returns 1 to indicate it is finished processing events.
1949 * If the \ref LIBUSB_HOTPLUG_ENUMERATE is passed the callback will be
1950 * called with a \ref LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED for all devices
1951 * already plugged into the machine. Note that libusb modifies its internal
1952 * device list from a separate thread, while calling hotplug callbacks from
1953 * libusb_handle_events(), so it is possible for a device to already be present
1954 * on, or removed from, its internal device list, while the hotplug callbacks
1955 * still need to be dispatched. This means that when using \ref
1956 * LIBUSB_HOTPLUG_ENUMERATE, your callback may be called twice for the arrival
1957 * of the same device, once from libusb_hotplug_register_callback() and once
1958 * from libusb_handle_events(); and/or your callback may be called for the
1959 * removal of a device for which an arrived call was never made.
1961 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1963 * \param[in] ctx context to register this callback with
1964 * \param[in] events bitwise or of events that will trigger this callback. See \ref
1965 * libusb_hotplug_event
1966 * \param[in] flags hotplug callback flags. See \ref libusb_hotplug_flag
1967 * \param[in] vendor_id the vendor id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1968 * \param[in] product_id the product id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1969 * \param[in] dev_class the device class to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1970 * \param[in] cb_fn the function to be invoked on a matching event/device
1971 * \param[in] user_data user data to pass to the callback function
1972 * \param[out] callback_handle pointer to store the handle of the allocated callback (can be NULL)
1973 * \returns LIBUSB_SUCCESS on success LIBUSB_ERROR code on failure
1975 int LIBUSB_CALL libusb_hotplug_register_callback(libusb_context *ctx,
1976 libusb_hotplug_event events,
1977 libusb_hotplug_flag flags,
1978 int vendor_id, int product_id,
1980 libusb_hotplug_callback_fn cb_fn,
1982 libusb_hotplug_callback_handle *callback_handle);
1984 /** \ingroup libusb_hotplug
1985 * Deregisters a hotplug callback.
1987 * Deregister a callback from a libusb_context. This function is safe to call from within
1988 * a hotplug callback.
1990 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1992 * \param[in] ctx context this callback is registered with
1993 * \param[in] callback_handle the handle of the callback to deregister
1995 void LIBUSB_CALL libusb_hotplug_deregister_callback(libusb_context *ctx,
1996 libusb_hotplug_callback_handle callback_handle);
1998 /** \ingroup libusb_lib
1999 * Available option values for libusb_set_option().
2001 enum libusb_option {
2002 /** Set the log message verbosity.
2004 * The default level is LIBUSB_LOG_LEVEL_NONE, which means no messages are ever
2005 * printed. If you choose to increase the message verbosity level, ensure
2006 * that your application does not close the stderr file descriptor.
2008 * You are advised to use level LIBUSB_LOG_LEVEL_WARNING. libusb is conservative
2009 * with its message logging and most of the time, will only log messages that
2010 * explain error conditions and other oddities. This will help you debug
2013 * If the LIBUSB_DEBUG environment variable was set when libusb was
2014 * initialized, this function does nothing: the message verbosity is fixed
2015 * to the value in the environment variable.
2017 * If libusb was compiled without any message logging, this function does
2018 * nothing: you'll never get any messages.
2020 * If libusb was compiled with verbose debug message logging, this function
2021 * does nothing: you'll always get messages from all levels.
2023 LIBUSB_OPTION_LOG_LEVEL,
2025 /** Use the UsbDk backend for a specific context, if available.
2027 * This option should be set immediately after calling libusb_init(), otherwise
2028 * unspecified behavior may occur.
2030 * Only valid on Windows.
2032 LIBUSB_OPTION_USE_USBDK,
2035 int LIBUSB_CALL libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);