29 #if !defined(__cplusplus)
30 #define inline __inline
33 #ifndef _SSIZE_T_DEFINED
34 #define _SSIZE_T_DEFINED
37 typedef __int64 ssize_t;
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__)
69 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
71 #if defined(interface)
74 #if !defined(__CYGWIN__)
79 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
80 #define LIBUSB_DEPRECATED_FOR(f) \
81 __attribute__((deprecated("Use " #f " instead")))
83 #define LIBUSB_DEPRECATED_FOR(f)
118 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
119 #define LIBUSB_CALL WINAPI
147 #define LIBUSBX_API_VERSION 0x01000102
161 static inline uint16_t libusb_cpu_to_le16(
const uint16_t x)
167 _tmp.b8[1] = (uint8_t) (x >> 8);
168 _tmp.b8[0] = (uint8_t) (x & 0xff);
180 #define libusb_le16_to_cpu libusb_cpu_to_le16
210 LIBUSB_CLASS_IMAGE = 6,
290 #define LIBUSB_DT_DEVICE_SIZE 18
291 #define LIBUSB_DT_CONFIG_SIZE 9
292 #define LIBUSB_DT_INTERFACE_SIZE 9
293 #define LIBUSB_DT_ENDPOINT_SIZE 7
294 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
295 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
296 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
297 #define LIBUSB_DT_BOS_SIZE 5
298 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
301 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
302 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
303 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
306 #define LIBUSB_DT_BOS_MAX_SIZE ((LIBUSB_DT_BOS_SIZE) +\
307 (LIBUSB_BT_USB_2_0_EXTENSION_SIZE) +\
308 (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\
309 (LIBUSB_BT_CONTAINER_ID_SIZE))
311 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
312 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
326 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
430 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
451 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
729 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
760 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
890 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
897 struct libusb_hotplug_callback;
1099 #define LIBUSB_ERROR_COUNT 14
1254 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
1293 LIBUSB_LOG_LEVEL_NONE = 0,
1294 LIBUSB_LOG_LEVEL_ERROR,
1295 LIBUSB_LOG_LEVEL_WARNING,
1296 LIBUSB_LOG_LEVEL_INFO,
1297 LIBUSB_LOG_LEVEL_DEBUG,
1363 unsigned char endpoint);
1365 unsigned char endpoint);
1374 int interface_number);
1376 int interface_number);
1382 int interface_number,
int alternate_setting);
1384 unsigned char endpoint);
1388 int interface_number);
1390 int interface_number);
1392 int interface_number);
1413 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1464 setup->
wValue = libusb_cpu_to_le16(wValue);
1465 setup->
wIndex = libusb_cpu_to_le16(wIndex);
1466 setup->
wLength = libusb_cpu_to_le16(wLength);
1512 transfer->
buffer = buffer;
1514 transfer->
length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1536 void *user_data,
unsigned int timeout)
1542 transfer->
buffer = buffer;
1543 transfer->
length = length;
1563 unsigned char endpoint,
unsigned char *buffer,
int length,
1570 transfer->
buffer = buffer;
1571 transfer->
length = length;
1592 unsigned char *buffer,
int length,
int num_iso_packets,
1599 transfer->
buffer = buffer;
1600 transfer->
length = length;
1648 if (packet > INT_MAX)
1650 _packet = (int) packet;
1655 for (i = 0; i < _packet; i++)
1658 return transfer->
buffer + offset;
1688 if (packet > INT_MAX)
1690 _packet = (int) packet;
1702 unsigned char *data, uint16_t
wLength,
unsigned int timeout);
1705 unsigned char endpoint,
unsigned char *data,
int length,
1706 int *actual_length,
unsigned int timeout);
1709 unsigned char endpoint,
unsigned char *data,
int length,
1710 int *actual_length,
unsigned int timeout);
1725 uint8_t desc_type, uint8_t desc_index,
unsigned char *data,
int length)
1729 0, data, (uint16_t) length, 1000);
1747 uint8_t desc_index, uint16_t langid,
unsigned char *data,
int length)
1751 langid, data, (uint16_t) length, 1000);
1755 uint8_t desc_index,
unsigned char *data,
int length);
1769 struct timeval *tv);
1771 struct timeval *tv,
int *completed);
1775 struct timeval *tv);
1778 struct timeval *tv);
1865 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1931 int vendor_id,
int product_id,
1935 libusb_hotplug_callback_handle *handle);
1949 libusb_hotplug_callback_handle handle);
uint8_t dev_capability_data[0]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:734
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:623
const char * describe
For ABI compatibility only.
Definition: libusb.h:919
The device is operating at full speed (12MBit/s).
Definition: libusb.h:980
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:1073
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:1967
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:833
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user...
Definition: libusb.h:827
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1339
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:588
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:563
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:398
Return the selected alternate setting for the specified interface.
Definition: libusb.h:378
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:1889
Smart Card.
Definition: libusb.h:222
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:738
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:2239
int libusb_open(libusb_device *dev, libusb_device_handle **handle)
Open a device and obtain a device handle.
Definition: core.c:1078
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:550
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:437
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:626
int libusb_set_interface_alt_setting(libusb_device_handle *dev, int interface_number, int alternate_setting)
Activate an alternate setting for an interface.
Definition: core.c:1540
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1352
struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:671
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1144
uint8_t bReserved
Reserved field.
Definition: libusb.h:856
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1182
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:520
Data endpoint.
Definition: libusb.h:460
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:1701
uint8_t bRequest
Request.
Definition: libusb.h:877
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:936
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:1502
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1808
void libusb_hotplug_deregister_callback(struct libusb_context *ctx, libusb_hotplug_callback_handle handle)
Deregisters a hotplug callback.
Definition: hotplug.c:279
void libusb_exit(struct libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:1907
Endpoint.
Definition: libusb.h:424
const uint16_t nano
Library nano version.
Definition: libusb.h:913
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:853
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:416
Data class.
Definition: libusb.h:219
SuperSpeed USB device capability.
Definition: libusb.h:1038
struct libusb_context libusb_context
Structure representing a libusbx session.
Definition: libusb.h:939
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:720
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:492
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:724
struct libusb_bos_dev_capability_descriptor * dev_capability[0]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:759
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:640
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:718
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:556
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1845
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:476
#define LIBUSB_CALL
libusbx's Windows calling convention.
Definition: libusb.h:121
Device Capability descriptor.
Definition: libusb.h:268
Set device configuration.
Definition: libusb.h:375
String descriptor.
Definition: libusb.h:256
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1228
Endpoint descriptor.
Definition: libusb.h:262
const char * libusb_strerror(enum libusb_error errcode)
Returns a constant string with a short description of the given error code, this description is inten...
Definition: strerror.c:174
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:488
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1791
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:574
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:570
libusb_speed
Speed codes.
Definition: libusb.h:972
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:799
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1209
int libusb_hotplug_register_callback(libusb_context *ctx, libusb_hotplug_event events, libusb_hotplug_flag flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *handle)
Register a hotplug callback function.
Definition: hotplug.c:201
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1089
High speed operation supported (480MBit/s).
Definition: libusb.h:1001
Success (no error)
Definition: libusb.h:1053
int libusb_init(libusb_context **context)
Initialize libusb.
Definition: core.c:1795
Class is vendor-specific.
Definition: libusb.h:243
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:706
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:806
void libusb_set_debug(libusb_context *ctx, int level)
Set log message verbosity.
Definition: core.c:1775
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:535
libusb_hotplug_event
Since version 1.0.16, LIBUSBX_API_VERSION >= 0x01000102.
Definition: libusb.h:1853
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:830
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:517
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2219
static int libusb_get_string_descriptor(libusb_device_handle *dev, uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
Retrieve a descriptor from a device.
Definition: libusb.h:1746
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:718
Interrupt endpoint.
Definition: libusb.h:343
Insufficient memory.
Definition: libusb.h:1086
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:986
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:580
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:967
Vendor.
Definition: libusb.h:406
File descriptor for polling.
Definition: libusb.h:1783
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:180
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:653
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:995
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1766
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:817
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:1004
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:301
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:508
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:248
unsigned char * buffer
Data buffer.
Definition: libusb.h:1246
int libusb_get_ss_endpoint_companion_descriptor(struct 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:761
Hub descriptor.
Definition: libusb.h:280
No such device (it may have been disconnected)
Definition: libusb.h:1065
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:496
Entity not found.
Definition: libusb.h:1068
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1410
int libusb_setlocale(const char *locale)
Set the language, and only the language, not the encoding! used for translatable libusb messages...
Definition: strerror.c:140
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:553
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:811
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:567
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusbx needs to handle.
Definition: io.c:2328
Transfer was cancelled.
Definition: libusb.h:1115
Report short frames as errors.
Definition: libusb.h:1135
int fd
Numeric file descriptor.
Definition: libusb.h:1785
A structure representing the Container ID descriptor.
Definition: libusb.h:841
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:511
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:609
Set or enable a specific feature.
Definition: libusb.h:358
The generic USB transfer structure.
Definition: libusb.h:1204
Class.
Definition: libusb.h:403
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:1680
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1729
Control endpoint.
Definition: libusb.h:334
Human Interface Device class.
Definition: libusb.h:200
int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:1670
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:286
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2197
BOS descriptor.
Definition: libusb.h:265
Input/output error.
Definition: libusb.h:1056
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:651
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2177
unsigned int timeout
Timeout for this transfer in millseconds.
Definition: libusb.h:1219
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1434
Bulk endpoint.
Definition: libusb.h:340
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:1015
Implicit feedback Data endpoint.
Definition: libusb.h:466
Configuration descriptor.
Definition: libusb.h:253
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *port_numbers, uint8_t port_numbers_len)
Deprecated please use libusb_get_port_numbers instead.
Definition: core.c:800
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:726
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1267
Synchronous.
Definition: libusb.h:448
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1240
Device.
Definition: libusb.h:418
int libusb_attach_kernel_driver(libusb_device_handle *dev, int interface_number)
Re-attach an interface's kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:1704
A structure representing the standard USB interface descriptor.
Definition: libusb.h:578
const uint16_t minor
Library minor version.
Definition: libusb.h:907
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:675
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:90
A structure representing the standard USB device descriptor.
Definition: libusb.h:474
static int libusb_get_descriptor(libusb_device_handle *dev, uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
Retrieve a descriptor from the default control pipe.
Definition: libusb.h:1724
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:191
uint8_t bmRequestType
Request type.
Definition: libusb.h:870
Audio class.
Definition: libusb.h:194
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:530
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:541
Standard.
Definition: libusb.h:400
Resource busy.
Definition: libusb.h:1071
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:318
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:690
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:859
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:387
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:585
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:687
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:951
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:620
struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:613
struct libusb_pollfd ** libusb_get_pollfds(libusb_context *ctx)
Retrieve a list of file descriptors that should be polled by your main loop as libusbx event sources...
Definition: io.c:2483
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:986
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable)
Enable/disable libusbx's automatic kernel driver detachment.
Definition: core.c:1740
Personal Healthcare.
Definition: libusb.h:231
HID report descriptor.
Definition: libusb.h:274
int libusb_get_usb_2_0_extension_descriptor(struct 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:976
const uint16_t major
Library major version.
Definition: libusb.h:904
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:830
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:758
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:742
Application class.
Definition: libusb.h:240
int libusb_set_configuration(libusb_device_handle *dev, int configuration)
Set the active configuration for a device.
Definition: core.c:1416
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:1561
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:1024
Interface.
Definition: libusb.h:421
Transfer timed out.
Definition: libusb.h:1112
Video.
Definition: libusb.h:228
A device has been plugged in and is ready to use.
Definition: libusb.h:1855
Printer class.
Definition: libusb.h:206
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor. ...
Definition: libusb.h:1012
const uint16_t micro
Library micro version.
Definition: libusb.h:910
const char * libusb_error_name(int error_code)
Returns a constant NULL-terminated string with the ASCII name of a libusbx error or transfer status c...
Definition: core.c:2184
Wireless class.
Definition: libusb.h:237
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1179
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:1022
Request status of the specific recipient.
Definition: libusb.h:350
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:632
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:775
libusb_hotplug_flag
Since version 1.0.16, LIBUSBX_API_VERSION >= 0x01000102.
Definition: libusb.h:1843
Get the current device configuration value.
Definition: libusb.h:372
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:598
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1252
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:1590
libusb_transfer_type
Endpoint transfer type.
Definition: libusb.h:332
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:2409
Container ID type.
Definition: libusb.h:1041
int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1580
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:1428
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1666
uint16_t wValue
Value.
Definition: libusb.h:880
Asynchronous.
Definition: libusb.h:442
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1196
SuperSpeed Hub descriptor.
Definition: libusb.h:283
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1276
Overflow.
Definition: libusb.h:1077
Clear or disable a specific feature.
Definition: libusb.h:353
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:662
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:647
int length
Length of the data buffer.
Definition: libusb.h:1231
USB 2.0 extensions.
Definition: libusb.h:1035
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:707
void * user_data
User context data to pass to the callback function.
Definition: libusb.h:1243
Other.
Definition: libusb.h:427
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:595
Out: host-to-device.
Definition: libusb.h:323
uint16_t wIndex
Index.
Definition: libusb.h:884
Set then report an endpoint's synchronization frame.
Definition: libusb.h:384
Set device address for all future accesses.
Definition: libusb.h:363
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9...
Definition: libusb.h:773
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:1457
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:785
Physical descriptor.
Definition: libusb.h:277
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1777
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:806
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:744
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:252
Access denied (insufficient permissions)
Definition: libusb.h:1062
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1103
Setup packet for control transfers.
Definition: libusb.h:864
Get the specified descriptor.
Definition: libusb.h:366
int libusb_claim_interface(libusb_device_handle *dev, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1451
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:848
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1206
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:780
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:756
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1133
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:650
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:505
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:752
Device descriptor.
Definition: libusb.h:250
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:1638
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1836
Device sent more data than requested.
Definition: libusb.h:1125
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1609
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1651
Communications class.
Definition: libusb.h:197
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:887
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:551
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:2245
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:502
int libusb_kernel_driver_active(libusb_device_handle *dev, int interface_number)
Determine if a kernel driver is active on an interface.
Definition: core.c:1635
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:602
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:528
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:801
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:656
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:993
libusb_bos_type
USB capability types.
Definition: libusb.h:1030
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1250
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2108
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:1148
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1236
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:481
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:774
Hotplug support is available on this platform.
Definition: libusb.h:1271
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:977
int libusb_reset_device(libusb_device_handle *dev)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1609
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:642
Transfer completed without error.
Definition: libusb.h:1106
int libusb_get_ss_usb_device_capability_descriptor(struct 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:1034
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:499
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:1804
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:1816
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:514
Isochronous endpoint.
Definition: libusb.h:337
struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:629
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1486
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:1130
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:973
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:843
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:749
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a handle.
Definition: core.c:1314
Device was disconnected.
Definition: libusb.h:1122
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:678
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:791
Transfer failed.
Definition: libusb.h:1109
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:710
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:841
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:659
int libusb_get_string_descriptor_ascii(libusb_device_handle *dev, uint8_t desc_index, unsigned char *data, int length)
Retrieve a string descriptor in C style ASCII.
Definition: descriptor.c:1148
Invalid parameter.
Definition: libusb.h:1059
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1176
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:956
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:617
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:591
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:739
Image class.
Definition: libusb.h:209
The libusb_has_capability() API is available.
Definition: libusb.h:1269
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:1279
int libusb_get_container_id_descriptor(struct 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:1092
Physical.
Definition: libusb.h:203
In: device-to-host.
Definition: libusb.h:320
Reserved.
Definition: libusb.h:409
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:391
Other error.
Definition: libusb.h:1095
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1212
Diagnostic Device.
Definition: libusb.h:234
Mass storage class.
Definition: libusb.h:213
HID descriptor.
Definition: libusb.h:271
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:458
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:606
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:1169
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:485
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:1533
Content Security.
Definition: libusb.h:225
The OS doesn't report or know the device speed.
Definition: libusb.h:974
The device is operating at high speed (480MBit/s).
Definition: libusb.h:983
Operation timed out.
Definition: libusb.h:1074
Feedback endpoint.
Definition: libusb.h:463
int libusb_release_interface(libusb_device_handle *dev, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1495
Structure providing the version of the libusbx runtime.
Definition: libusb.h:902
Wireless USB device capability.
Definition: libusb.h:1032
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or recieve as part of a burst.
Definition: libusb.h:700
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode...
Definition: libusb.h:821
Pipe error.
Definition: libusb.h:1080
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusbx'...
Definition: io.c:2289
Full speed operation supported (12MBit/s).
Definition: libusb.h:998
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:348
Adaptive.
Definition: libusb.h:445
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:186
A device has left and is no longer available.
Definition: libusb.h:1860
No synchronization.
Definition: libusb.h:439
Isochronous packet descriptor.
Definition: libusb.h:1174
Automatically free() transfer buffer during libusb_free_transfer()
Definition: libusb.h:1138
Interface descriptor.
Definition: libusb.h:259
System call interrupted (perhaps due to signal)
Definition: libusb.h:1083
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:820
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:695
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:916
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1119
Supports Link Power Management (LPM)
Definition: libusb.h:1014
int libusb_get_bos_descriptor(libusb_device_handle *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:902
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:369
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:667
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:887
unsigned char type
Type of the endpoint from libusb_transfer_type.
Definition: libusb.h:1215
libusb_error
Error codes.
Definition: libusb.h:1051
libusb_log_level
Log message levels.
Definition: libusb.h:1292
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusbx transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1317
Select an alternate interface for the specified interface.
Definition: libusb.h:381
struct libusb_iso_packet_descriptor iso_packet_desc[0]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1253
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:560
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:1614
Hub class.
Definition: libusb.h:216