30 #if !defined(__cplusplus)
31 #define inline __inline
35 typedef SSIZE_T ssize_t;
40 #include <sys/types.h>
41 #if !defined(_MSC_VER)
46 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
47 #define ZERO_SIZED_ARRAY
49 #define ZERO_SIZED_ARRAY 0
57 #if defined(_WIN32) || defined(__CYGWIN__)
59 #if defined(interface)
62 #if !defined(__CYGWIN__)
67 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
68 #define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated ("Use " #f " instead")))
69 #elif defined(__GNUC__) && (__GNUC__ >= 3)
70 #define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated))
72 #define LIBUSB_DEPRECATED_FOR(f)
76 #define LIBUSB_PACKED __attribute__ ((packed))
113 #if defined(_WIN32) || defined(__CYGWIN__)
114 #define LIBUSB_CALL WINAPI
139 #define LIBUSB_API_VERSION 0x01000108
142 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
144 #if defined(__cplusplus)
162 _tmp.b8[1] = (uint8_t) (x >> 8);
163 _tmp.b8[0] = (uint8_t) (x & 0xff);
175 #define libusb_le16_to_cpu libusb_cpu_to_le16
202 LIBUSB_CLASS_PTP = 0x06,
288 #define LIBUSB_DT_DEVICE_SIZE 18
289 #define LIBUSB_DT_CONFIG_SIZE 9
290 #define LIBUSB_DT_INTERFACE_SIZE 9
291 #define LIBUSB_DT_ENDPOINT_SIZE 7
292 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
293 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
294 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
295 #define LIBUSB_DT_BOS_SIZE 5
296 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
299 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
300 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
301 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
304 #define LIBUSB_DT_BOS_MAX_SIZE \
305 (LIBUSB_DT_BOS_SIZE + \
306 LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
307 LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
308 LIBUSB_BT_CONTAINER_ID_SIZE)
310 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
311 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
325 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
429 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
450 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
907 #if defined(_MSC_VER)
908 #pragma pack(push, 1)
935 #if defined(_MSC_VER)
939 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
1095 #define LIBUSB_ERROR_COUNT 14
1414 unsigned char endpoint);
1416 unsigned char endpoint);
1426 int interface_number);
1428 int interface_number);
1434 int interface_number,
int alternate_setting);
1436 unsigned char endpoint);
1440 uint32_t num_streams,
unsigned char *endpoints,
int num_endpoints);
1442 unsigned char *endpoints,
int num_endpoints);
1447 unsigned char *buffer,
size_t length);
1450 int interface_number);
1452 int interface_number);
1454 int interface_number);
1475 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1578 transfer->
buffer = buffer;
1580 transfer->
length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1602 void *user_data,
unsigned int timeout)
1608 transfer->
buffer = buffer;
1609 transfer->
length = length;
1632 unsigned char endpoint, uint32_t stream_id,
1634 void *user_data,
unsigned int timeout)
1637 length, callback, user_data, timeout);
1657 unsigned char endpoint,
unsigned char *buffer,
int length,
1664 transfer->
buffer = buffer;
1665 transfer->
length = length;
1686 unsigned char *buffer,
int length,
int num_iso_packets,
1693 transfer->
buffer = buffer;
1694 transfer->
length = length;
1743 if (packet > INT_MAX)
1745 _packet = (int) packet;
1750 for (i = 0; i < _packet; i++)
1753 return transfer->
buffer + offset;
1783 if (packet > INT_MAX)
1785 _packet = (int) packet;
1797 unsigned char *data, uint16_t
wLength,
unsigned int timeout);
1800 unsigned char endpoint,
unsigned char *data,
int length,
1801 int *actual_length,
unsigned int timeout);
1804 unsigned char endpoint,
unsigned char *data,
int length,
1805 int *actual_length,
unsigned int timeout);
1820 uint8_t desc_type, uint8_t desc_index,
unsigned char *data,
int length)
1824 0, data, (uint16_t) length, 1000);
1842 uint8_t desc_index, uint16_t langid,
unsigned char *data,
int length)
1846 langid, data, (uint16_t) length, 1000);
1850 uint8_t desc_index,
unsigned char *data,
int length);
1865 struct timeval *tv);
1867 struct timeval *tv,
int *completed);
1871 struct timeval *tv);
1874 struct timeval *tv);
1962 #define LIBUSB_HOTPLUG_NO_FLAGS 0
1966 #define LIBUSB_HOTPLUG_MATCH_ANY -1
2029 int events,
int flags,
2030 int vendor_id,
int product_id,
int dev_class,
2032 libusb_hotplug_callback_handle *callback_handle);
2046 libusb_hotplug_callback_handle callback_handle);
2057 libusb_hotplug_callback_handle callback_handle);
2109 #if defined(__cplusplus)
void libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension)
Free a USB 2.0 Extension descriptor obtained from libusb_get_usb_2_0_extension_descriptor().
Definition: descriptor.c:957
const char * describe
For ABI compatibility only.
Definition: libusb.h:967
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:876
ssize_t libusb_get_device_list(libusb_context *ctx, libusb_device ***list)
Returns a list of USB devices currently attached to the system.
Definition: core.c:825
Device.
Definition: libusb.h:417
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user...
Definition: libusb.h:870
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:284
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:640
Asynchronous.
Definition: libusb.h:441
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:615
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1311
int libusb_bulk_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *actual_length, unsigned int timeout)
Perform a USB bulk transfer.
Definition: sync.c:274
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1025
Isochronous endpoint.
Definition: libusb.h:336
Success (no error)
Definition: libusb.h:1049
void libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
Free a superspeed endpoint companion descriptor obtained from libusb_get_ss_endpoint_companion_descri...
Definition: descriptor.c:754
static unsigned char * libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, unsigned int packet)
Convenience function to locate the position of an isochronous packet within the buffer of an isochron...
Definition: libusb.h:1733
Device was disconnected.
Definition: libusb.h:1137
Device Capability descriptor.
Definition: libusb.h:266
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:602
The OS doesn't report or know the device speed.
Definition: libusb.h:1022
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1334
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:678
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1472
static uint16_t libusb_cpu_to_le16(const uint16_t x)
Convert a 16-bit value from host-endian to little-endian format.
Definition: libusb.h:156
int libusb_free_streams(libusb_device_handle *dev_handle, unsigned char *endpoints, int num_endpoints)
Free usb bulk streams allocated with libusb_alloc_streams().
Definition: core.c:1890
HID descriptor.
Definition: libusb.h:269
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1346
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2771
uint8_t bReserved
Reserved field.
Definition: libusb.h:899
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1200
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev_handle, int enable)
Enable/disable libusb's automatic kernel driver detachment.
Definition: core.c:2093
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:574
Audio class.
Definition: libusb.h:189
uint8_t bRequest
Request.
Definition: libusb.h:923
int libusb_get_config_descriptor_by_value(libusb_device *dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config)
Get a USB configuration descriptor with a specific bConfigurationValue.
Definition: descriptor.c:642
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1085
Physical.
Definition: libusb.h:198
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1917
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1581
Other.
Definition: libusb.h:426
int libusb_event_handling_ok(libusb_context *ctx)
Determine if it is still OK for this thread to be doing event handling.
Definition: io.c:1859
static void libusb_fill_bulk_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a bulk transfer.
Definition: libusb.h:1599
const uint16_t nano
Library nano version.
Definition: libusb.h:961
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:896
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2367
Bulk transfer.
Definition: libusb.h:1107
Supports Link Power Management (LPM)
Definition: libusb.h:493
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:772
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:546
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:181
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:175
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:777
Hub class.
Definition: libusb.h:211
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:2017
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1766
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:693
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:770
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1996
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:608
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:530
int libusb_get_ss_endpoint_companion_descriptor(libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp)
Get an endpoints superspeed endpoint companion descriptor (if any)
Definition: descriptor.c:705
void(* libusb_pollfd_added_cb)(int fd, short events, void *user_data)
Callback function, invoked when a new file descriptor should be added to the set of file descriptors ...
Definition: libusb.h:1900
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1246
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:317
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:542
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1667
Interface descriptor.
Definition: libusb.h:257
Overflow.
Definition: libusb.h:1073
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition: core.c:1302
libusb_ss_usb_device_capability_attributes
Masks for the bits of the bmAttributes field field of the SuperSpeed USB Device Capability descriptor...
Definition: libusb.h:501
short events
Event flags to poll for from
. Definition: libusb.h:1887
Container ID type.
Definition: libusb.h:520
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:622
void(* libusb_pollfd_removed_cb)(int fd, void *user_data)
Callback function, invoked when a file descriptor should be removed from the set of file descriptors ...
Definition: libusb.h:1912
int libusb_attach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Re-attach an interface's kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:2054
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:842
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1227
int libusb_setlocale(const char *locale)
Set the language, and only the language, not the encoding! used for translatable libusb messages...
Definition: strerror.c:178
int libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, struct libusb_config_descriptor **config)
Get a USB configuration descriptor based on its index.
Definition: descriptor.c:596
Feedback endpoint.
Definition: libusb.h:462
Data endpoint.
Definition: libusb.h:459
Reserved.
Definition: libusb.h:408
Callback function handling context related log messages.
Definition: libusb.h:1335
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1957
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:758
static unsigned char * libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, unsigned int packet)
Convenience function to locate the position of an isochronous packet within the buffer of an isochron...
Definition: libusb.h:1775
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1457
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:916
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1299
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:589
int libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle)
Wrap a platform-specific system device handle and obtain a libusb device handle for the underlying de...
Definition: core.c:1247
Class is vendor-specific.
Definition: libusb.h:241
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:987
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:1187
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:571
libusb_option
Available option values for libusb_set_option().
Definition: libusb.h:2062
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:386
Isochronous transfer.
Definition: libusb.h:1104
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:632
Invalid parameter.
Definition: libusb.h:1055
File descriptor for polling.
Definition: libusb.h:1879
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:503
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:706
libusb_speed
Speed codes.
Definition: libusb.h:1020
void libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap)
Free a SuperSpeed USB Device Capability descriptor obtained from libusb_get_ss_usb_device_capability_...
Definition: descriptor.c:1013
A device has left and is no longer available.
Definition: libusb.h:1947
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1888
System call interrupted (perhaps due to signal)
Definition: libusb.h:1079
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:436
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:860
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1544
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:896
(1) : Error messages are emitted
Definition: libusb.h:1314
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:562
unsigned char * buffer
Data buffer.
Definition: libusb.h:1273
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:935
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:474
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:550
A device has been plugged in and is ready to use.
Definition: libusb.h:1942
static void libusb_fill_interrupt_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for an interrupt transfer.
Definition: libusb.h:1655
(4) : All messages are emitted
Definition: libusb.h:1323
Access denied (insufficient permissions)
Definition: libusb.h:1058
Entity not found.
Definition: libusb.h:1064
Input/output error.
Definition: libusb.h:1052
The libusb_has_capability() API is available.
Definition: libusb.h:1290
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:605
Diagnostic Device.
Definition: libusb.h:229
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:854
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:619
int libusb_get_active_config_descriptor(libusb_device *dev, struct libusb_config_descriptor **config)
Get the USB configuration descriptor for the currently active configuration.
Definition: descriptor.c:555
static int libusb_get_descriptor(libusb_device_handle *dev_handle, uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
Retrieve a descriptor from the default control pipe.
Definition: libusb.h:1819
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:347
void libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id)
Free a Container ID descriptor obtained from libusb_get_container_id_descriptor().
Definition: descriptor.c:1067
int libusb_get_max_iso_packet_size(libusb_device *dev, unsigned char endpoint)
Calculate the maximum packet size which a specific endpoint is capable is sending or receiving in the...
Definition: core.c:1119
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1028
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:1018
Set device address for all future accesses.
Definition: libusb.h:362
int fd
Numeric file descriptor.
Definition: libusb.h:1881
A structure representing the Container ID descriptor.
Definition: libusb.h:884
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:565
USB 2.0 extensions.
Definition: libusb.h:514
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1037
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:661
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2411
The generic USB transfer structure.
Definition: libusb.h:1222
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusb transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1286
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1162
int libusb_get_container_id_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id)
Get a Container ID descriptor.
Definition: descriptor.c:1032
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:246
Endpoint.
Definition: libusb.h:423
uint8_t libusb_get_device_address(libusb_device *dev)
Get the address of the device on the bus it is connected to.
Definition: core.c:1007
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1031
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1237
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1953
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:368
Wireless USB device capability.
Definition: libusb.h:511
struct libusb_bos_dev_capability_descriptor * dev_capability[ZERO_SIZED_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:808
Smart Card.
Definition: libusb.h:217
Control endpoint.
Definition: libusb.h:333
libusb_bos_type
USB capability types.
Definition: libusb.h:509
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:1187
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:780
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition: io.c:2509
int libusb_get_string_descriptor_ascii(libusb_device_handle *dev_handle, uint8_t desc_index, unsigned char *data, int length)
Retrieve a string descriptor in C style ASCII.
Definition: descriptor.c:1085
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1258
A structure representing the standard USB interface descriptor.
Definition: libusb.h:630
const uint16_t minor
Library minor version.
Definition: libusb.h:955
void libusb_set_pollfd_notifiers(libusb_context *ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data)
Register notification functions for file descriptor additions/removals.
Definition: io.c:2615
int libusb_interrupt_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *actual_length, unsigned int timeout)
Perform a USB interrupt transfer.
Definition: sync.c:328
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:729
Out: host-to-device.
Definition: libusb.h:319
static void libusb_fill_bulk_stream_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, uint32_t stream_id, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a bulk transfer using bulk stream...
Definition: libusb.h:1630
A structure representing the standard USB device descriptor.
Definition: libusb.h:528
int libusb_get_ss_usb_device_capability_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap)
Get a SuperSpeed USB Device Capability descriptor.
Definition: descriptor.c:976
Insufficient memory.
Definition: libusb.h:1082
uint8_t bmRequestType
Request type.
Definition: libusb.h:916
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1630
libusb_transfer_type
Transfer type.
Definition: libusb.h:1099
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:584
Human Interface Device class.
Definition: libusb.h:195
Mass storage class.
Definition: libusb.h:208
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1004
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:594
Get the current device configuration value.
Definition: libusb.h:371
Printer class.
Definition: libusb.h:205
Resource busy.
Definition: libusb.h:1067
unsigned char * libusb_dev_mem_alloc(libusb_device_handle *dev_handle, size_t length)
Attempts to allocate a block of persistent DMA memory suitable for transfers against the given device...
Definition: core.c:1933
Get the specified descriptor.
Definition: libusb.h:365
Content Security.
Definition: libusb.h:220
int libusb_kernel_driver_active(libusb_device_handle *dev_handle, int interface_number)
Determine if a kernel driver is active on an interface.
Definition: core.c:1979
static void libusb_fill_control_setup(unsigned char *buffer, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength)
Helper function to populate the setup packet (first 8 bytes of the data buffer) for a control transfe...
Definition: libusb.h:1519
Other error.
Definition: libusb.h:1091
const char * libusb_strerror(int errcode)
Returns a constant string with a short description of the given error code, this description is inten...
Definition: strerror.c:213
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:725
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:415
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1827
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:743
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:902
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:637
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:741
libusb_error
Error codes.
Definition: libusb.h:1047
SuperSpeed Hub descriptor.
Definition: libusb.h:281
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:672
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:681
struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1280
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1940
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1809
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:2093
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:472
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1955
const uint16_t major
Library major version.
Definition: libusb.h:952
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:873
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:791
Data class.
Definition: libusb.h:214
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1118
Interface.
Definition: libusb.h:420
libusb_device_handle * libusb_open_device_with_vid_pid(libusb_context *ctx, uint16_t vendor_id, uint16_t product_id)
Convenience function for finding a device with a particular idVendor/idProduct combination.
Definition: core.c:1357
Miscellaneous class.
Definition: libusb.h:235
Control transfer.
Definition: libusb.h:1101
const uint16_t micro
Library micro version.
Definition: libusb.h:958
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1197
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:685
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1320
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:397
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1933
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1964
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:818
static void libusb_fill_iso_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, int num_iso_packets, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for an isochronous transfer...
Definition: libusb.h:1684
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:650
(2) : Warning and error messages are emitted
Definition: libusb.h:1317
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2463
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1330
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2543
int libusb_get_device_descriptor(libusb_device *dev, struct libusb_device_descriptor *desc)
Get the USB device descriptor for a given device.
Definition: descriptor.c:531
Transfer timed out.
Definition: libusb.h:1127
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2433
Operation timed out.
Definition: libusb.h:1070
int libusb_hotplug_register_callback(libusb_context *ctx, int events, int flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *callback_handle)
Register a hotplug callback function.
Definition: hotplug.c:231
Adaptive.
Definition: libusb.h:444
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:457
uint16_t wValue
Value.
Definition: libusb.h:926
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1625
Standard.
Definition: libusb.h:399
Physical descriptor.
Definition: libusb.h:275
High speed operation supported (480MBit/s).
Definition: libusb.h:480
Full speed operation supported (12MBit/s).
Definition: libusb.h:477
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1824
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:715
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:700
int length
Length of the data buffer.
Definition: libusb.h:1249
Report short frames as errors.
Definition: libusb.h:1150
void * user_data
User context data.
Definition: libusb.h:1270
No synchronization.
Definition: libusb.h:438
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:647
uint16_t wIndex
Index.
Definition: libusb.h:930
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2391
BOS descriptor.
Definition: libusb.h:263
Transfer completed without error.
Definition: libusb.h:1121
Hub descriptor.
Definition: libusb.h:278
Wireless class.
Definition: libusb.h:232
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9...
Definition: libusb.h:816
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:828
static void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, unsigned int length)
Convenience function to set the length of all packets in an isochronous transfer, based on the num_is...
Definition: libusb.h:1708
const char * libusb_error_name(int errcode)
Returns a constant NULL-terminated string with the ASCII name of a libusb error or transfer status co...
Definition: core.c:2679
String descriptor.
Definition: libusb.h:254
Synchronous.
Definition: libusb.h:447
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:849
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:793
Image class.
Definition: libusb.h:201
int libusb_dev_mem_free(libusb_device_handle *dev_handle, unsigned char *buffer, size_t length)
Free device memory allocated with libusb_dev_mem_alloc().
Definition: core.c:1953
Setup packet for control transfers.
Definition: libusb.h:910
const struct libusb_version * libusb_get_version(void)
Returns a pointer to const struct libusb_version with the version (major, minor, micro, nano and rc) of the running library.
Definition: core.c:2734
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1034
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2142
int libusb_get_usb_2_0_extension_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension)
Get an USB 2.0 Extension descriptor.
Definition: descriptor.c:921
Transfer failed.
Definition: libusb.h:1124
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:997
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:891
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1224
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:823
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:805
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:703
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:559
int libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
Handle any pending events by polling file descriptors, without checking if any other threads are alre...
Definition: io.c:2461
Configuration descriptor.
Definition: libusb.h:251
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:801
static void libusb_fill_control_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a control transfer.
Definition: libusb.h:1568
Return the selected alternate setting for the specified interface.
Definition: libusb.h:377
Endpoint descriptor.
Definition: libusb.h:260
Set libusb has weak authority.
Definition: libusb.h:2104
Class.
Definition: libusb.h:402
Clear or disable a specific feature.
Definition: libusb.h:352
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:933
Bulk endpoint.
Definition: libusb.h:339
Video.
Definition: libusb.h:223
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:556
int libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2185
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:654
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:582
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(), if one is set by the OS kernel.
Definition: libusb.h:1303
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1214
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:844
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:709
No such device (it may have been disconnected)
Definition: libusb.h:1061
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1277
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1148
Interrupt transfer.
Definition: libusb.h:1110
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1174
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1254
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:535
In: device-to-host.
Definition: libusb.h:322
Application class.
Definition: libusb.h:238
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:483
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:695
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1015
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2319
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:331
int libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len)
Get the list of all port numbers from root for the specified device.
Definition: core.c:951
Transfer was cancelled.
Definition: libusb.h:1130
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1134
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:553
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1642
void * libusb_hotplug_get_user_data(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Gets the user_data associated with a hotplug callback.
Definition: hotplug.c:357
Personal Healthcare.
Definition: libusb.h:226
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:568
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:390
static int libusb_get_string_descriptor(libusb_device_handle *dev_handle, uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
Retrieve a descriptor from a device.
Definition: libusb.h:1841
Set the log message verbosity.
Definition: libusb.h:2084
uint8_t dev_capability_data[ZERO_SIZED_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:783
int(* libusb_hotplug_callback_fn)(libusb_context *ctx, libusb_device *device, libusb_hotplug_event event, void *user_data)
Hotplug callback function type.
Definition: libusb.h:1990
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:886
void libusb_free_device_list(libusb_device **list, int unref_devices)
Frees a list of devices previously discovered using libusb_get_device_list().
Definition: core.c:895
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:798
const struct libusb_pollfd ** libusb_get_pollfds(libusb_context *ctx)
Retrieve a list of file descriptors that should be polled by your main loop as libusb event sources...
Definition: io.c:2723
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1288
Bulk stream transfer.
Definition: libusb.h:1113
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1490
Select an alternate interface for the specified interface.
Definition: libusb.h:380
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:732
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1798
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:834
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:762
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:712
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1194
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:669
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:643
Implicit feedback Data endpoint.
Definition: libusb.h:465
libusb_log_level
Log message levels.
Definition: libusb.h:1309
Device sent more data than requested.
Definition: libusb.h:1140
Pipe error.
Definition: libusb.h:1076
Request status of the specific recipient.
Definition: libusb.h:349
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1519
int libusb_alloc_streams(libusb_device_handle *dev_handle, uint32_t num_streams, unsigned char *endpoints, int num_endpoints)
Allocate up to num_streams usb bulk streams on the specified endpoints.
Definition: core.c:1860
Vendor.
Definition: libusb.h:405
Communications class.
Definition: libusb.h:192
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1230
int libusb_get_bos_descriptor(libusb_device_handle *dev_handle, struct libusb_bos_descriptor **bos)
Get a Binary Object Store (BOS) descriptor This is a BLOCKING function, which will send requests to t...
Definition: descriptor.c:846
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:658
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1156
void libusb_free_config_descriptor(struct libusb_config_descriptor *config)
Free a configuration descriptor obtained from libusb_get_active_config_descriptor() or libusb_get_con...
Definition: descriptor.c:682
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:539
int libusb_set_interface_alt_setting(libusb_device_handle *dev_handle, int interface_number, int alternate_setting)
Activate an alternate setting for an interface.
Definition: core.c:1756
Interrupt endpoint.
Definition: libusb.h:342
Structure providing the version of the libusb runtime.
Definition: libusb.h:950
Device descriptor.
Definition: libusb.h:248
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:752
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode...
Definition: libusb.h:864
Set or enable a specific feature.
Definition: libusb.h:357
Set device configuration.
Definition: libusb.h:374
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:665
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition: core.c:977
int libusb_control_transfer(libusb_device_handle *dev_handle, uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, unsigned char *data, uint16_t wLength, unsigned int timeout)
Perform a USB control transfer.
Definition: sync.c:97
int libusb_release_interface(libusb_device_handle *dev_handle, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1711
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:116
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:2257
Isochronous packet descriptor.
Definition: libusb.h:1192
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:748
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:964
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:319
Set then report an endpoint's synchronization frame.
Definition: libusb.h:383
Hotplug support is available on this platform.
Definition: libusb.h:1293
SuperSpeed USB device capability.
Definition: libusb.h:517
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:721
void libusb_set_debug(libusb_context *ctx, int level)
Definition: core.c:2107
HID report descriptor.
Definition: libusb.h:272
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1233
Callback function handling all log messages.
Definition: libusb.h:1332
static struct libusb_control_setup * libusb_control_transfer_get_setup(struct libusb_transfer *transfer)
Get the control setup packet of a control transfer.
Definition: libusb.h:1490
int libusb_get_max_packet_size(libusb_device *dev, unsigned char endpoint)
Convenience function to retrieve the wMaxPacketSize value for a particular endpoint in the active dev...
Definition: core.c:1064
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:612
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor. ...
Definition: libusb.h:491
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:186