eXpand your USB potential
libusb.h
1 /*
2  * Public libusbx header file
3  * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
4  * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #ifndef LIBUSB_H
22 #define LIBUSB_H
23 
24 #ifdef _MSC_VER
25 /* on MS environments, the inline keyword is available in C++ only */
26 #define inline __inline
27 /* ssize_t is also not available (copy/paste from MinGW) */
28 #ifndef _SSIZE_T_DEFINED
29 #define _SSIZE_T_DEFINED
30 #undef ssize_t
31 #ifdef _WIN64
32  typedef __int64 ssize_t;
33 #else
34  typedef int ssize_t;
35 #endif /* _WIN64 */
36 #endif /* _SSIZE_T_DEFINED */
37 #endif /* _MSC_VER */
38 
39 /* stdint.h is also not usually available on MS */
40 #if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
41 typedef unsigned __int8 uint8_t;
42 typedef unsigned __int16 uint16_t;
43 typedef unsigned __int32 uint32_t;
44 #else
45 #include <stdint.h>
46 #endif
47 
48 #include <sys/types.h>
49 #include <time.h>
50 #include <limits.h>
51 
52 #if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__)
53 #include <sys/time.h>
54 #endif
55 
56 /* 'interface' might be defined as a macro on Windows, so we need to
57  * undefine it so as not to break the current libusbx API, because
58  * libusb_config_descriptor has an 'interface' member
59  * As this can be problematic if you include windows.h after libusb.h
60  * in your sources, we force windows.h to be included first. */
61 #if defined(_WIN32) || defined(__CYGWIN__)
62 #include <windows.h>
63 #if defined(interface)
64 #undef interface
65 #endif
66 #endif
67 
93 /* LIBUSB_CALL must be defined on both definition and declaration of libusbx
94  * functions. You'd think that declaration would be enough, but cygwin will
95  * complain about conflicting types unless both are marked this way.
96  * The placement of this macro is important too; it must appear after the
97  * return type, before the function name. See internal documentation for
98  * API_EXPORTED.
99  */
100 #if defined(_WIN32) || defined(__CYGWIN__)
101 #define LIBUSB_CALL WINAPI
102 #else
103 #define LIBUSB_CALL
104 #endif
105 
106 #ifdef __cplusplus
107 extern "C" {
108 #endif
109 
118 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
119 {
120  union {
121  uint8_t b8[2];
122  uint16_t b16;
123  } _tmp;
124  _tmp.b8[1] = x >> 8;
125  _tmp.b8[0] = x & 0xff;
126  return _tmp.b16;
127 }
128 
137 #define libusb_le16_to_cpu libusb_cpu_to_le16
138 
139 /* standard USB stuff */
140 
149 
152 
155 
158 
161 
164 
166  LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
167  LIBUSB_CLASS_IMAGE = 6,
168 
171 
174 
177 
180 
183 
186 
189 
192 
195 
198 
201 };
202 
208 
211 
214 
217 
220 
223 
226 
229 
232 };
233 
234 /* Descriptor sizes per descriptor type */
235 #define LIBUSB_DT_DEVICE_SIZE 18
236 #define LIBUSB_DT_CONFIG_SIZE 9
237 #define LIBUSB_DT_INTERFACE_SIZE 9
238 #define LIBUSB_DT_ENDPOINT_SIZE 7
239 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
240 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
241 
242 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
243 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
244 
252 
255 };
256 
257 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
258 
266 
269 
272 
275 };
276 
282 
285 
286  /* 0x02 is reserved */
287 
290 
291  /* 0x04 is reserved */
292 
295 
298 
301 
304 
307 
310 
313 
316 };
317 
325 
328 
331 
334 };
335 
343 
346 
349 
352 };
353 
354 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
355 
364 
367 
370 
373 };
374 
375 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
376 
385 
388 
391 };
392 
400  uint8_t bLength;
401 
406 
409  uint16_t bcdUSB;
410 
412  uint8_t bDeviceClass;
413 
417 
421 
424 
426  uint16_t idVendor;
427 
429  uint16_t idProduct;
430 
432  uint16_t bcdDevice;
433 
435  uint8_t iManufacturer;
436 
438  uint8_t iProduct;
439 
441  uint8_t iSerialNumber;
442 
445 };
446 
454  uint8_t bLength;
455 
460 
466 
474  uint8_t bmAttributes;
475 
477  uint16_t wMaxPacketSize;
478 
480  uint8_t bInterval;
481 
484  uint8_t bRefresh;
485 
487  uint8_t bSynchAddress;
488 
491  const unsigned char *extra;
492 
495 };
496 
504  uint8_t bLength;
505 
510 
513 
516 
519  uint8_t bNumEndpoints;
520 
523 
527 
531 
533  uint8_t iInterface;
534 
538 
541  const unsigned char *extra;
542 
545 };
546 
554 
557 };
558 
566  uint8_t bLength;
567 
572 
574  uint16_t wTotalLength;
575 
577  uint8_t bNumInterfaces;
578 
581 
583  uint8_t iConfiguration;
584 
586  uint8_t bmAttributes;
587 
591  uint8_t MaxPower;
592 
596 
599  const unsigned char *extra;
600 
603 };
604 
613  uint8_t bmRequestType;
614 
620  uint8_t bRequest;
621 
623  uint16_t wValue;
624 
627  uint16_t wIndex;
628 
630  uint16_t wLength;
631 };
632 
633 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
634 
635 /* libusbx */
636 
637 struct libusb_context;
638 struct libusb_device;
639 struct libusb_device_handle;
640 
646  const uint16_t major;
647 
649  const uint16_t minor;
650 
652  const uint16_t micro;
653 
655  const uint16_t nano;
656 
658  const char *rc;
659 
661  const char* describe;
662 };
663 
682 
699 
700 
710 
717 
720 
723 
726 
729 };
730 
740 
743 
746 
749 
752 
755 
758 
761 
764 
767 
770 
773 
776 
777  /* NB! Remember to update libusb_error_name()
778  when adding new error codes here. */
779 
782 };
783 
790 
793 
796 
799 
803 
806 
809 };
810 
816 
819 
825 
850 };
851 
856  unsigned int length;
857 
859  unsigned int actual_length;
860 
863 };
864 
865 struct libusb_transfer;
866 
876 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
877 
887 
889  uint8_t flags;
890 
892  unsigned char endpoint;
893 
895  unsigned char type;
896 
899  unsigned int timeout;
900 
909 
911  int length;
912 
917 
921 
923  void *user_data;
924 
926  unsigned char *buffer;
927 
931 
934 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
935  [] /* valid C99 code */
936 #else
937  [0] /* non-standard, but usually working code */
938 #endif
939  ;
940 };
941 
950 };
951 
954 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
955 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
956 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
957 const char * LIBUSB_CALL libusb_error_name(int errcode);
958 
960  libusb_device ***list);
962  int unref_devices);
965 
967  int *config);
969  struct libusb_device_descriptor *desc);
971  struct libusb_config_descriptor **config);
973  uint8_t config_index, struct libusb_config_descriptor **config);
975  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
977  struct libusb_config_descriptor *config);
982  unsigned char endpoint);
984  unsigned char endpoint);
985 
989 
991  int configuration);
993  int interface_number);
995  int interface_number);
996 
998  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
999 
1001  int interface_number, int alternate_setting);
1003  unsigned char endpoint);
1005 
1007  int interface_number);
1009  int interface_number);
1011  int interface_number);
1012 
1013 /* async I/O */
1014 
1027 static inline unsigned char *libusb_control_transfer_get_data(
1028  struct libusb_transfer *transfer)
1029 {
1030  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1031 }
1032 
1046  struct libusb_transfer *transfer)
1047 {
1048  return (struct libusb_control_setup *) transfer->buffer;
1049 }
1050 
1073 static inline void libusb_fill_control_setup(unsigned char *buffer,
1074  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1075  uint16_t wLength)
1076 {
1077  struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
1078  setup->bmRequestType = bmRequestType;
1079  setup->bRequest = bRequest;
1080  setup->wValue = libusb_cpu_to_le16(wValue);
1081  setup->wIndex = libusb_cpu_to_le16(wIndex);
1082  setup->wLength = libusb_cpu_to_le16(wLength);
1083 }
1084 
1085 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1086 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1087 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1088 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1089 
1117 static inline void libusb_fill_control_transfer(
1118  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1119  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1120  unsigned int timeout)
1121 {
1122  struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
1123  transfer->dev_handle = dev_handle;
1124  transfer->endpoint = 0;
1125  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1126  transfer->timeout = timeout;
1127  transfer->buffer = buffer;
1128  if (setup)
1129  transfer->length = LIBUSB_CONTROL_SETUP_SIZE
1130  + libusb_le16_to_cpu(setup->wLength);
1131  transfer->user_data = user_data;
1132  transfer->callback = callback;
1133 }
1134 
1148 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1149  libusb_device_handle *dev_handle, unsigned char endpoint,
1150  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1151  void *user_data, unsigned int timeout)
1152 {
1153  transfer->dev_handle = dev_handle;
1154  transfer->endpoint = endpoint;
1155  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1156  transfer->timeout = timeout;
1157  transfer->buffer = buffer;
1158  transfer->length = length;
1159  transfer->user_data = user_data;
1160  transfer->callback = callback;
1161 }
1162 
1177  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1178  unsigned char endpoint, unsigned char *buffer, int length,
1179  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1180 {
1181  transfer->dev_handle = dev_handle;
1182  transfer->endpoint = endpoint;
1184  transfer->timeout = timeout;
1185  transfer->buffer = buffer;
1186  transfer->length = length;
1187  transfer->user_data = user_data;
1188  transfer->callback = callback;
1189 }
1190 
1205 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1206  libusb_device_handle *dev_handle, unsigned char endpoint,
1207  unsigned char *buffer, int length, int num_iso_packets,
1208  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1209 {
1210  transfer->dev_handle = dev_handle;
1211  transfer->endpoint = endpoint;
1213  transfer->timeout = timeout;
1214  transfer->buffer = buffer;
1215  transfer->length = length;
1216  transfer->num_iso_packets = num_iso_packets;
1217  transfer->user_data = user_data;
1218  transfer->callback = callback;
1219 }
1220 
1230  struct libusb_transfer *transfer, unsigned int length)
1231 {
1232  int i;
1233  for (i = 0; i < transfer->num_iso_packets; i++)
1234  transfer->iso_packet_desc[i].length = length;
1235 }
1236 
1253 static inline unsigned char *libusb_get_iso_packet_buffer(
1254  struct libusb_transfer *transfer, unsigned int packet)
1255 {
1256  int i;
1257  size_t offset = 0;
1258  int _packet;
1259 
1260  /* oops..slight bug in the API. packet is an unsigned int, but we use
1261  * signed integers almost everywhere else. range-check and convert to
1262  * signed to avoid compiler warnings. FIXME for libusb-2. */
1263  if (packet > INT_MAX)
1264  return NULL;
1265  _packet = packet;
1266 
1267  if (_packet >= transfer->num_iso_packets)
1268  return NULL;
1269 
1270  for (i = 0; i < _packet; i++)
1271  offset += transfer->iso_packet_desc[i].length;
1272 
1273  return transfer->buffer + offset;
1274 }
1275 
1295 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1296  struct libusb_transfer *transfer, unsigned int packet)
1297 {
1298  int _packet;
1299 
1300  /* oops..slight bug in the API. packet is an unsigned int, but we use
1301  * signed integers almost everywhere else. range-check and convert to
1302  * signed to avoid compiler warnings. FIXME for libusb-2. */
1303  if (packet > INT_MAX)
1304  return NULL;
1305  _packet = packet;
1306 
1307  if (_packet >= transfer->num_iso_packets)
1308  return NULL;
1309 
1310  return transfer->buffer + (transfer->iso_packet_desc[0].length * _packet);
1311 }
1312 
1313 /* sync I/O */
1314 
1316  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1317  unsigned char *data, uint16_t wLength, unsigned int timeout);
1318 
1320  unsigned char endpoint, unsigned char *data, int length,
1321  int *actual_length, unsigned int timeout);
1322 
1324  unsigned char endpoint, unsigned char *data, int length,
1325  int *actual_length, unsigned int timeout);
1326 
1340  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1341 {
1343  LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data,
1344  (uint16_t) length, 1000);
1345 }
1346 
1362  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1363 {
1365  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1366  langid, data, (uint16_t) length, 1000);
1367 }
1368 
1370  uint8_t desc_index, unsigned char *data, int length);
1371 
1372 /* polling and timeouts */
1373 
1381 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1382 
1384  struct timeval *tv);
1386  struct timeval *tv, int *completed);
1390  struct timeval *tv);
1393  struct timeval *tv);
1394 
1400  int fd;
1401 
1406  short events;
1407 };
1408 
1419 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1420  void *user_data);
1421 
1431 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1432 
1434  libusb_context *ctx);
1436  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1437  void *user_data);
1438 
1439 #ifdef __cplusplus
1440 }
1441 #endif
1442 
1443 #endif
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:536
const char * describe
For ABI compatibility only.
Definition: libusb.h:661
The device is operating at full speed (12MBit/s).
Definition: libusb.h:722
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:1662
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1168
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:512
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:487
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:322
Return the selected alternate setting for the specified interface.
Definition: libusb.h:309
Smart Card.
Definition: libusb.h:179
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:656
int libusb_open(libusb_device *dev, libusb_device_handle **handle)
Open a device and obtain a device handle.
Definition: core.c:912
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:474
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:361
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:550
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:1350
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1262
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:824
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:862
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:444
Data endpoint.
Definition: libusb.h:384
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:1627
uint8_t bRequest
Request.
Definition: libusb.h:620
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:773
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:1117
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1734
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:1623
Endpoint.
Definition: libusb.h:348
const uint16_t nano
Library nano version.
Definition: libusb.h:655
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:340
Data class.
Definition: libusb.h:176
struct libusb_context libusb_context
Structure representing a libusbx session.
Definition: libusb.h:681
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:416
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:564
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:480
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:400
#define LIBUSB_CALL
libusbx's Windows calling convention.
Definition: libusb.h:103
Set device configuration.
Definition: libusb.h:306
String descriptor.
Definition: libusb.h:213
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:908
Endpoint descriptor.
Definition: libusb.h:219
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:412
short events
Event flags to poll for from .
Definition: libusb.h:1406
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:471
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:494
libusb_speed
Speed codes.
Definition: libusb.h:714
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:889
Operation not supported or unimplemented on this platform.
Definition: libusb.h:775
Success (no error)
Definition: libusb.h:739
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:1550
Class is vendor-specific.
Definition: libusb.h:200
void libusb_set_debug(libusb_context *ctx, int level)
Set message verbosity.
Definition: core.c:1530
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:459
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:667
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:441
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2121
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:1361
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:636
Interrupt endpoint.
Definition: libusb.h:274
Insufficient memory.
Definition: libusb.h:772
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:823
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:1839
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:504
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:709
Vendor.
Definition: libusb.h:330
File descriptor for polling.
Definition: libusb.h:1398
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:137
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:577
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1692
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:315
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:432
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:205
unsigned char * buffer
Data buffer.
Definition: libusb.h:926
Hub descriptor.
Definition: libusb.h:231
No such device (it may have been disconnected)
Definition: libusb.h:751
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:420
Entity not found.
Definition: libusb.h:754
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1027
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:477
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:491
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusbx needs to handle.
Definition: io.c:2230
Transfer was cancelled.
Definition: libusb.h:798
Report short frames as errors.
Definition: libusb.h:815
int fd
Numeric file descriptor.
Definition: libusb.h:1400
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:435
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:533
Set or enable a specific feature.
Definition: libusb.h:289
The generic USB transfer structure.
Definition: libusb.h:884
Class.
Definition: libusb.h:327
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:1295
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1655
Control endpoint.
Definition: libusb.h:265
Human Interface Device class.
Definition: libusb.h:157
int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:1461
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2099
Input/output error.
Definition: libusb.h:742
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:590
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2079
unsigned int timeout
Timeout for this transfer in millseconds.
Definition: libusb.h:899
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1288
Bulk endpoint.
Definition: libusb.h:271
Implicit feedback Data endpoint.
Definition: libusb.h:390
Configuration descriptor.
Definition: libusb.h:210
libusb_capability
Capabilities supported by this instance of libusb.
Definition: libusb.h:947
Synchronous.
Definition: libusb.h:372
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:920
Device.
Definition: libusb.h:342
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:1491
A structure representing the standard USB interface descriptor.
Definition: libusb.h:502
const uint16_t minor
Library minor version.
Definition: libusb.h:649
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:599
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:72
A structure representing the standard USB device descriptor.
Definition: libusb.h:398
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:1339
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:148
uint8_t bmRequestType
Request type.
Definition: libusb.h:613
Audio class.
Definition: libusb.h:151
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:454
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:465
Standard.
Definition: libusb.h:324
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:595
Resource busy.
Definition: libusb.h:757
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:249
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:509
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:876
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:544
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:553
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:728
Personal Healthcare.
Definition: libusb.h:188
HID report descriptor.
Definition: libusb.h:225
const uint16_t major
Library major version.
Definition: libusb.h:646
Application class.
Definition: libusb.h:197
int libusb_set_configuration(libusb_device_handle *dev, int configuration)
Set the active configuration for a device.
Definition: core.c:1237
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:1176
Interface.
Definition: libusb.h:345
Transfer timed out.
Definition: libusb.h:795
Video.
Definition: libusb.h:185
Printer class.
Definition: libusb.h:163
const uint16_t micro
Library micro version.
Definition: libusb.h:652
const char * libusb_error_name(int errcode)
Returns a constant NULL-terminated string with the ASCII name of a libusb error code.
Definition: core.c:1798
Wireless class.
Definition: libusb.h:194
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:859
Request status of the specific recipient.
Definition: libusb.h:281
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:556
Get the current device configuration value.
Definition: libusb.h:303
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:522
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1081
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:1205
libusb_transfer_type
Endpoint transfer type.
Definition: libusb.h:263
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:2311
int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1385
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:1045
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1592
uint16_t wValue
Value.
Definition: libusb.h:623
Asynchronous.
Definition: libusb.h:366
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:1431
Overflow.
Definition: libusb.h:763
Clear or disable a specific feature.
Definition: libusb.h:284
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:586
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:571
int length
Length of the data buffer.
Definition: libusb.h:911
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:635
void * user_data
User context data to pass to the callback function.
Definition: libusb.h:923
Other.
Definition: libusb.h:351
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:519
Out: host-to-device.
Definition: libusb.h:254
uint16_t wIndex
Index.
Definition: libusb.h:627
Set then report an endpoint's synchronization frame.
Definition: libusb.h:315
Set device address for all future accesses.
Definition: libusb.h:294
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:1073
Physical descriptor.
Definition: libusb.h:228
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1703
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:266
Access denied (insufficient permissions)
Definition: libusb.h:748
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:786
Setup packet for control transfers.
Definition: libusb.h:607
Get the specified descriptor.
Definition: libusb.h:297
int libusb_claim_interface(libusb_device_handle *dev, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1268
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:886
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:813
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:574
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:429
Device descriptor.
Definition: libusb.h:207
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:1253
Device sent more data than requested.
Definition: libusb.h:808
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1536
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1577
Communications class.
Definition: libusb.h:154
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:630
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:435
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:2147
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:426
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:1434
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:526
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:452
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:580
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:930
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2010
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:977
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:916
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:405
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:719
int libusb_reset_device(libusb_device_handle *dev)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1411
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:566
Transfer completed without error.
Definition: libusb.h:789
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:423
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:438
Isochronous endpoint.
Definition: libusb.h:268
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1350
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:810
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a handle.
Definition: core.c:1143
Device was disconnected.
Definition: libusb.h:805
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:602
Transfer failed.
Definition: libusb.h:792
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:678
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:583
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:678
Invalid parameter.
Definition: libusb.h:745
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:856
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:698
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:541
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:515
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:657
Image class.
Definition: libusb.h:166
The libusb_has_capability() API is available.
Definition: libusb.h:949
Physical.
Definition: libusb.h:160
In: device-to-host.
Definition: libusb.h:251
Reserved.
Definition: libusb.h:333
Other error.
Definition: libusb.h:781
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:892
Diagnostic Device.
Definition: libusb.h:191
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 libusbx event sources...
Definition: io.c:2385
Mass storage class.
Definition: libusb.h:170
HID descriptor.
Definition: libusb.h:222
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:382
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:530
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:849
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:409
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:1148
Content Security.
Definition: libusb.h:182
The OS doesn't report or know the device speed.
Definition: libusb.h:716
The device is operating at high speed (480MBit/s).
Definition: libusb.h:725
Operation timed out.
Definition: libusb.h:760
Feedback endpoint.
Definition: libusb.h:387
int libusb_release_interface(libusb_device_handle *dev, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1305
Structure providing the version of the libusbx runtime.
Definition: libusb.h:644
Pipe error.
Definition: libusb.h:766
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusbx'...
Definition: io.c:2191
libusb_standard_request
Standard requests, as defined in table 9-3 of the USB2 specifications.
Definition: libusb.h:279
Adaptive.
Definition: libusb.h:369
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:537
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:143
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:1419
No synchronization.
Definition: libusb.h:363
Isochronous packet descriptor.
Definition: libusb.h:854
Automatically free() transfer buffer during libusb_free_transfer()
Definition: libusb.h:818
Interface descriptor.
Definition: libusb.h:216
System call interrupted (perhaps due to signal)
Definition: libusb.h:769
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:658
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:802
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:300
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:591
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:724
unsigned char type
Type of the endpoint from libusb_transfer_type.
Definition: libusb.h:895
libusb_error
Error codes.
Definition: libusb.h:737
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusbx transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1226
Select an alternate interface for the specified interface.
Definition: libusb.h:312
struct libusb_iso_packet_descriptor iso_packet_desc[0]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:933
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:484
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:1229
Hub class.
Definition: libusb.h:173