eXpand your USB potential
libusb.h
1 /*
2  * Public libusbx header file
3  * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4  * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5  * Copyright © 2012 Pete Batard <pete@akeo.ie>
6  * For more information, please visit: http://libusbx.org
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #ifndef LIBUSB_H
24 #define LIBUSB_H
25 
26 #ifdef _MSC_VER
27 /* on MS environments, the inline keyword is available in C++ only */
28 #if !defined(__cplusplus)
29 #define inline __inline
30 #endif
31 /* ssize_t is also not available (copy/paste from MinGW) */
32 #ifndef _SSIZE_T_DEFINED
33 #define _SSIZE_T_DEFINED
34 #undef ssize_t
35 #ifdef _WIN64
36  typedef __int64 ssize_t;
37 #else
38  typedef int ssize_t;
39 #endif /* _WIN64 */
40 #endif /* _SSIZE_T_DEFINED */
41 #endif /* _MSC_VER */
42 
43 /* stdint.h is not available on older MSVC */
44 #if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
45 typedef unsigned __int8 uint8_t;
46 typedef unsigned __int16 uint16_t;
47 typedef unsigned __int32 uint32_t;
48 #else
49 #include <stdint.h>
50 #endif
51 
52 #if !defined(_WIN32_WCE)
53 #include <sys/types.h>
54 #endif
55 
56 #if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__)
57 #include <sys/time.h>
58 #endif
59 
60 #include <time.h>
61 #include <limits.h>
62 
63 /* 'interface' might be defined as a macro on Windows, so we need to
64  * undefine it so as not to break the current libusbx API, because
65  * libusb_config_descriptor has an 'interface' member
66  * As this can be problematic if you include windows.h after libusb.h
67  * in your sources, we force windows.h to be included first. */
68 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
69 #include <windows.h>
70 #if defined(interface)
71 #undef interface
72 #endif
73 #if !defined(__CYGWIN__)
74 #include <winsock.h>
75 #endif
76 #endif
77 
103 /* LIBUSB_CALL must be defined on both definition and declaration of libusbx
104  * functions. You'd think that declaration would be enough, but cygwin will
105  * complain about conflicting types unless both are marked this way.
106  * The placement of this macro is important too; it must appear after the
107  * return type, before the function name. See internal documentation for
108  * API_EXPORTED.
109  */
110 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
111 #define LIBUSB_CALL WINAPI
112 #else
113 #define LIBUSB_CALL
114 #endif
115 
139 #define LIBUSBX_API_VERSION 0x01000101
140 
141 #ifdef __cplusplus
142 extern "C" {
143 #endif
144 
153 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
154 {
155  union {
156  uint8_t b8[2];
157  uint16_t b16;
158  } _tmp;
159  _tmp.b8[1] = x >> 8;
160  _tmp.b8[0] = x & 0xff;
161  return _tmp.b16;
162 }
163 
172 #define libusb_le16_to_cpu libusb_cpu_to_le16
173 
174 /* standard USB stuff */
175 
184 
187 
190 
193 
196 
199 
201  LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
202  LIBUSB_CLASS_IMAGE = 6,
203 
206 
209 
212 
215 
218 
221 
224 
227 
230 
233 
236 };
237 
243 
246 
249 
252 
255 
258 
261 
264 
267 
270 };
271 
272 /* Descriptor sizes per descriptor type */
273 #define LIBUSB_DT_DEVICE_SIZE 18
274 #define LIBUSB_DT_CONFIG_SIZE 9
275 #define LIBUSB_DT_INTERFACE_SIZE 9
276 #define LIBUSB_DT_ENDPOINT_SIZE 7
277 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
278 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
279 
280 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
281 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
282 
290 
293 };
294 
295 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
296 
304 
307 
310 
313 };
314 
320 
323 
324  /* 0x02 is reserved */
325 
328 
329  /* 0x04 is reserved */
330 
333 
336 
339 
342 
345 
348 
351 
354 
357 
361 };
362 
370 
373 
376 
379 };
380 
388 
391 
394 
397 };
398 
399 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
400 
409 
412 
415 
418 };
419 
420 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
421 
430 
433 
436 };
437 
445  uint8_t bLength;
446 
451 
454  uint16_t bcdUSB;
455 
457  uint8_t bDeviceClass;
458 
462 
466 
469 
471  uint16_t idVendor;
472 
474  uint16_t idProduct;
475 
477  uint16_t bcdDevice;
478 
480  uint8_t iManufacturer;
481 
483  uint8_t iProduct;
484 
486  uint8_t iSerialNumber;
487 
490 };
491 
499  uint8_t bLength;
500 
505 
511 
519  uint8_t bmAttributes;
520 
522  uint16_t wMaxPacketSize;
523 
525  uint8_t bInterval;
526 
529  uint8_t bRefresh;
530 
532  uint8_t bSynchAddress;
533 
536  const unsigned char *extra;
537 
540 };
541 
549  uint8_t bLength;
550 
555 
558 
561 
564  uint8_t bNumEndpoints;
565 
568 
572 
576 
578  uint8_t iInterface;
579 
583 
586  const unsigned char *extra;
587 
590 };
591 
599 
602 };
603 
611  uint8_t bLength;
612 
617 
619  uint16_t wTotalLength;
620 
622  uint8_t bNumInterfaces;
623 
626 
628  uint8_t iConfiguration;
629 
631  uint8_t bmAttributes;
632 
636  uint8_t MaxPower;
637 
641 
644  const unsigned char *extra;
645 
648 };
649 
658  uint8_t bmRequestType;
659 
665  uint8_t bRequest;
666 
668  uint16_t wValue;
669 
672  uint16_t wIndex;
673 
675  uint16_t wLength;
676 };
677 
678 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
679 
680 /* libusbx */
681 
682 struct libusb_context;
683 struct libusb_device;
684 struct libusb_device_handle;
685 
691  const uint16_t major;
692 
694  const uint16_t minor;
695 
697  const uint16_t micro;
698 
700  const uint16_t nano;
701 
703  const char *rc;
704 
706  const char* describe;
707 };
708 
727 
744 
745 
755 
762 
765 
768 
771 
774 };
775 
785 
788 
791 
794 
797 
800 
803 
806 
809 
812 
815 
818 
821 
822  /* NB! Remember to update libusb_error_name()
823  when adding new error codes here. */
824 
827 };
828 
835 
838 
841 
844 
848 
851 
854 
855  /* NB! Remember to update libusb_error_name()
856  when adding new status codes here. */
857 };
858 
864 
867 
873 
898 };
899 
904  unsigned int length;
905 
907  unsigned int actual_length;
908 
911 };
912 
913 struct libusb_transfer;
914 
924 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
925 
935 
937  uint8_t flags;
938 
940  unsigned char endpoint;
941 
943  unsigned char type;
944 
947  unsigned int timeout;
948 
957 
959  int length;
960 
965 
969 
971  void *user_data;
972 
974  unsigned char *buffer;
975 
979 
982 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
983  [] /* valid C99 code */
984 #else
985  [0] /* non-standard, but usually working code */
986 #endif
987  ;
988 };
989 
1008 };
1009 
1021  LIBUSB_LOG_LEVEL_NONE = 0,
1022  LIBUSB_LOG_LEVEL_ERROR,
1023  LIBUSB_LOG_LEVEL_WARNING,
1024  LIBUSB_LOG_LEVEL_INFO,
1025  LIBUSB_LOG_LEVEL_DEBUG,
1026 };
1027 
1030 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1031 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1032 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1033 const char * LIBUSB_CALL libusb_error_name(int errcode);
1034 
1036  libusb_device ***list);
1038  int unref_devices);
1041 
1043  int *config);
1045  struct libusb_device_descriptor *desc);
1047  struct libusb_config_descriptor **config);
1049  uint8_t config_index, struct libusb_config_descriptor **config);
1051  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1053  struct libusb_config_descriptor *config);
1057 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length);
1061  unsigned char endpoint);
1063  unsigned char endpoint);
1064 
1068 
1070  int configuration);
1072  int interface_number);
1074  int interface_number);
1075 
1077  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1078 
1080  int interface_number, int alternate_setting);
1082  unsigned char endpoint);
1084 
1086  int interface_number);
1088  int interface_number);
1090  int interface_number);
1091 
1092 /* async I/O */
1093 
1106 static inline unsigned char *libusb_control_transfer_get_data(
1107  struct libusb_transfer *transfer)
1108 {
1109  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1110 }
1111 
1125  struct libusb_transfer *transfer)
1126 {
1127  return (struct libusb_control_setup *) transfer->buffer;
1128 }
1129 
1152 static inline void libusb_fill_control_setup(unsigned char *buffer,
1153  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1154  uint16_t wLength)
1155 {
1156  struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
1157  setup->bmRequestType = bmRequestType;
1158  setup->bRequest = bRequest;
1159  setup->wValue = libusb_cpu_to_le16(wValue);
1160  setup->wIndex = libusb_cpu_to_le16(wIndex);
1161  setup->wLength = libusb_cpu_to_le16(wLength);
1162 }
1163 
1164 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1165 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1166 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1167 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1168 
1196 static inline void libusb_fill_control_transfer(
1197  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1198  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1199  unsigned int timeout)
1200 {
1201  struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
1202  transfer->dev_handle = dev_handle;
1203  transfer->endpoint = 0;
1204  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1205  transfer->timeout = timeout;
1206  transfer->buffer = buffer;
1207  if (setup)
1208  transfer->length = LIBUSB_CONTROL_SETUP_SIZE
1209  + libusb_le16_to_cpu(setup->wLength);
1210  transfer->user_data = user_data;
1211  transfer->callback = callback;
1212 }
1213 
1227 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1228  libusb_device_handle *dev_handle, unsigned char endpoint,
1229  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1230  void *user_data, unsigned int timeout)
1231 {
1232  transfer->dev_handle = dev_handle;
1233  transfer->endpoint = endpoint;
1234  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1235  transfer->timeout = timeout;
1236  transfer->buffer = buffer;
1237  transfer->length = length;
1238  transfer->user_data = user_data;
1239  transfer->callback = callback;
1240 }
1241 
1256  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1257  unsigned char endpoint, unsigned char *buffer, int length,
1258  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1259 {
1260  transfer->dev_handle = dev_handle;
1261  transfer->endpoint = endpoint;
1263  transfer->timeout = timeout;
1264  transfer->buffer = buffer;
1265  transfer->length = length;
1266  transfer->user_data = user_data;
1267  transfer->callback = callback;
1268 }
1269 
1284 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1285  libusb_device_handle *dev_handle, unsigned char endpoint,
1286  unsigned char *buffer, int length, int num_iso_packets,
1287  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1288 {
1289  transfer->dev_handle = dev_handle;
1290  transfer->endpoint = endpoint;
1292  transfer->timeout = timeout;
1293  transfer->buffer = buffer;
1294  transfer->length = length;
1295  transfer->num_iso_packets = num_iso_packets;
1296  transfer->user_data = user_data;
1297  transfer->callback = callback;
1298 }
1299 
1309  struct libusb_transfer *transfer, unsigned int length)
1310 {
1311  int i;
1312  for (i = 0; i < transfer->num_iso_packets; i++)
1313  transfer->iso_packet_desc[i].length = length;
1314 }
1315 
1332 static inline unsigned char *libusb_get_iso_packet_buffer(
1333  struct libusb_transfer *transfer, unsigned int packet)
1334 {
1335  int i;
1336  size_t offset = 0;
1337  int _packet;
1338 
1339  /* oops..slight bug in the API. packet is an unsigned int, but we use
1340  * signed integers almost everywhere else. range-check and convert to
1341  * signed to avoid compiler warnings. FIXME for libusb-2. */
1342  if (packet > INT_MAX)
1343  return NULL;
1344  _packet = packet;
1345 
1346  if (_packet >= transfer->num_iso_packets)
1347  return NULL;
1348 
1349  for (i = 0; i < _packet; i++)
1350  offset += transfer->iso_packet_desc[i].length;
1351 
1352  return transfer->buffer + offset;
1353 }
1354 
1374 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1375  struct libusb_transfer *transfer, unsigned int packet)
1376 {
1377  int _packet;
1378 
1379  /* oops..slight bug in the API. packet is an unsigned int, but we use
1380  * signed integers almost everywhere else. range-check and convert to
1381  * signed to avoid compiler warnings. FIXME for libusb-2. */
1382  if (packet > INT_MAX)
1383  return NULL;
1384  _packet = packet;
1385 
1386  if (_packet >= transfer->num_iso_packets)
1387  return NULL;
1388 
1389  return transfer->buffer + (transfer->iso_packet_desc[0].length * _packet);
1390 }
1391 
1392 /* sync I/O */
1393 
1395  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1396  unsigned char *data, uint16_t wLength, unsigned int timeout);
1397 
1399  unsigned char endpoint, unsigned char *data, int length,
1400  int *actual_length, unsigned int timeout);
1401 
1403  unsigned char endpoint, unsigned char *data, int length,
1404  int *actual_length, unsigned int timeout);
1405 
1419  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1420 {
1422  LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data,
1423  (uint16_t) length, 1000);
1424 }
1425 
1441  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1442 {
1444  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1445  langid, data, (uint16_t) length, 1000);
1446 }
1447 
1449  uint8_t desc_index, unsigned char *data, int length);
1450 
1451 /* polling and timeouts */
1452 
1460 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1461 
1463  struct timeval *tv);
1465  struct timeval *tv, int *completed);
1469  struct timeval *tv);
1472  struct timeval *tv);
1473 
1479  int fd;
1480 
1485  short events;
1486 };
1487 
1498 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1499  void *user_data);
1500 
1510 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1511 
1513  libusb_context *ctx);
1515  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1516  void *user_data);
1517 
1518 #ifdef __cplusplus
1519 }
1520 #endif
1521 
1522 #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:552
const char * describe
For ABI compatibility only.
Definition: libusb.h:706
The device is operating at full speed (12MBit/s).
Definition: libusb.h:767
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:1749
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1240
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:557
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:532
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:367
Return the selected alternate setting for the specified interface.
Definition: libusb.h:347
Smart Card.
Definition: libusb.h:214
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:672
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:1960
int libusb_open(libusb_device *dev, libusb_device_handle **handle)
Open a device and obtain a device handle.
Definition: core.c:984
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:519
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:406
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:595
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:1422
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1278
struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:640
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:872
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:910
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:489
Data endpoint.
Definition: libusb.h:429
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:1623
uint8_t bRequest
Request.
Definition: libusb.h:665
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:845
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:1196
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1730
void libusb_exit(struct libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:1708
Endpoint.
Definition: libusb.h:393
const uint16_t nano
Library nano version.
Definition: libusb.h:700
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:385
Data class.
Definition: libusb.h:211
struct libusb_context libusb_context
Structure representing a libusbx session.
Definition: libusb.h:726
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:461
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:609
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:525
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:445
#define LIBUSB_CALL
libusbx&#39;s Windows calling convention.
Definition: libusb.h:113
Set device configuration.
Definition: libusb.h:344
String descriptor.
Definition: libusb.h:248
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:956
Endpoint descriptor.
Definition: libusb.h:254
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:457
short events
Event flags to poll for from &lt;poll.h&gt;.
Definition: libusb.h:1485
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:485
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:539
libusb_speed
Speed codes.
Definition: libusb.h:759
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:937
Operation not supported or unimplemented on this platform.
Definition: libusb.h:820
Success (no error)
Definition: libusb.h:784
int libusb_init(libusb_context **context)
Initialize libusb.
Definition: core.c:1622
Class is vendor-specific.
Definition: libusb.h:235
void libusb_set_debug(libusb_context *ctx, int level)
Set log message verbosity.
Definition: core.c:1602
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:504
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:739
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:486
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2114
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:1440
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:642
Interrupt endpoint.
Definition: libusb.h:312
Insufficient memory.
Definition: libusb.h:817
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:895
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:549
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:754
Vendor.
Definition: libusb.h:375
File descriptor for polling.
Definition: libusb.h:1477
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:172
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:622
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1688
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:317
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:477
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:240
unsigned char * buffer
Data buffer.
Definition: libusb.h:974
Hub descriptor.
Definition: libusb.h:266
No such device (it may have been disconnected)
Definition: libusb.h:796
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:465
Entity not found.
Definition: libusb.h:799
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1106
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:522
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:536
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusbx needs to handle.
Definition: io.c:2223
Transfer was cancelled.
Definition: libusb.h:843
Report short frames as errors.
Definition: libusb.h:863
int fd
Numeric file descriptor.
Definition: libusb.h:1479
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:480
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:578
Set or enable a specific feature.
Definition: libusb.h:327
The generic USB transfer structure.
Definition: libusb.h:932
Class.
Definition: libusb.h:372
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:1374
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1651
Control endpoint.
Definition: libusb.h:303
Human Interface Device class.
Definition: libusb.h:192
int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:1537
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2092
Input/output error.
Definition: libusb.h:787
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:596
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2072
unsigned int timeout
Timeout for this transfer in millseconds.
Definition: libusb.h:947
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1360
Bulk endpoint.
Definition: libusb.h:309
Implicit feedback Data endpoint.
Definition: libusb.h:435
Configuration descriptor.
Definition: libusb.h:245
libusb_capability
Capabilities supported by this instance of libusb.
Definition: libusb.h:995
Synchronous.
Definition: libusb.h:417
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:968
Device.
Definition: libusb.h:387
int libusb_attach_kernel_driver(libusb_device_handle *dev, int interface_number)
Re-attach an interface&#39;s kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:1567
A structure representing the standard USB interface descriptor.
Definition: libusb.h:547
const uint16_t minor
Library minor version.
Definition: libusb.h:694
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:644
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:443
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:1418
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:183
uint8_t bmRequestType
Request type.
Definition: libusb.h:658
Audio class.
Definition: libusb.h:186
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:499
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:510
Standard.
Definition: libusb.h:369
Resource busy.
Definition: libusb.h:802
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:287
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:356
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:554
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:589
struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:582
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:2378
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:773
Personal Healthcare.
Definition: libusb.h:223
HID report descriptor.
Definition: libusb.h:260
const uint16_t major
Library major version.
Definition: libusb.h:691
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:673
Application class.
Definition: libusb.h:232
int libusb_set_configuration(libusb_device_handle *dev, int configuration)
Set the active configuration for a device.
Definition: core.c:1309
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:1255
Interface.
Definition: libusb.h:390
Transfer timed out.
Definition: libusb.h:840
Video.
Definition: libusb.h:220
Printer class.
Definition: libusb.h:198
const uint16_t micro
Library micro version.
Definition: libusb.h:697
const char * libusb_error_name(int error_code)
Returns a constant NULL-terminated string with the ASCII name of a libusb error or transfer status co...
Definition: core.c:1905
Wireless class.
Definition: libusb.h:229
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:907
Request status of the specific recipient.
Definition: libusb.h:319
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:601
Get the current device configuration value.
Definition: libusb.h:341
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:567
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1153
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:1284
libusb_transfer_type
Endpoint transfer type.
Definition: libusb.h:301
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:2304
int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1457
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:1124
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1588
uint16_t wValue
Value.
Definition: libusb.h:668
Asynchronous.
Definition: libusb.h:411
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:924
SuperSpeed Hub descriptor.
Definition: libusb.h:269
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1004
Overflow.
Definition: libusb.h:808
Clear or disable a specific feature.
Definition: libusb.h:322
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:631
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:616
int length
Length of the data buffer.
Definition: libusb.h:959
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:651
void * user_data
User context data to pass to the callback function.
Definition: libusb.h:971
Other.
Definition: libusb.h:396
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:564
Out: host-to-device.
Definition: libusb.h:292
uint16_t wIndex
Index.
Definition: libusb.h:672
Set then report an endpoint&#39;s synchronization frame.
Definition: libusb.h:353
Set device address for all future accesses.
Definition: libusb.h:332
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:1152
Physical descriptor.
Definition: libusb.h:263
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1699
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:268
Access denied (insufficient permissions)
Definition: libusb.h:793
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:831
Setup packet for control transfers.
Definition: libusb.h:652
Get the specified descriptor.
Definition: libusb.h:335
int libusb_claim_interface(libusb_device_handle *dev, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1340
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:934
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:861
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:619
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:474
Device descriptor.
Definition: libusb.h:242
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:1332
Device sent more data than requested.
Definition: libusb.h:853
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1531
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1573
Communications class.
Definition: libusb.h:189
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:675
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:449
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:2140
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:471
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:1506
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:571
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:497
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:625
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:978
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2003
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:1049
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:964
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:450
Hotplug support is available.
Definition: libusb.h:999
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:764
int libusb_reset_device(libusb_device_handle *dev)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1483
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:611
Transfer completed without error.
Definition: libusb.h:834
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:468
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:1498
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:1510
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:483
Isochronous endpoint.
Definition: libusb.h:306
struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:598
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1410
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:882
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a handle.
Definition: core.c:1215
Device was disconnected.
Definition: libusb.h:850
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:647
Transfer failed.
Definition: libusb.h:837
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:750
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:628
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:694
Invalid parameter.
Definition: libusb.h:790
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:904
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:743
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:586
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:560
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:663
Image class.
Definition: libusb.h:201
The libusb_has_capability() API is available.
Definition: libusb.h:997
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:1007
Physical.
Definition: libusb.h:195
In: device-to-host.
Definition: libusb.h:289
Reserved.
Definition: libusb.h:378
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:360
Other error.
Definition: libusb.h:826
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:940
Diagnostic Device.
Definition: libusb.h:226
Mass storage class.
Definition: libusb.h:205
HID descriptor.
Definition: libusb.h:257
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:427
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:575
Terminate transfers that are a multiple of the endpoint&#39;s wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:897
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:454
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:1227
Content Security.
Definition: libusb.h:217
The OS doesn&#39;t report or know the device speed.
Definition: libusb.h:761
The device is operating at high speed (480MBit/s).
Definition: libusb.h:770
Operation timed out.
Definition: libusb.h:805
Feedback endpoint.
Definition: libusb.h:432
int libusb_release_interface(libusb_device_handle *dev, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1377
Structure providing the version of the libusbx runtime.
Definition: libusb.h:689
Pipe error.
Definition: libusb.h:811
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusbx&#39;...
Definition: io.c:2184
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:317
Adaptive.
Definition: libusb.h:414
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:178
No synchronization.
Definition: libusb.h:408
Isochronous packet descriptor.
Definition: libusb.h:902
Automatically free() transfer buffer during libusb_free_transfer()
Definition: libusb.h:866
Interface descriptor.
Definition: libusb.h:251
System call interrupted (perhaps due to signal)
Definition: libusb.h:814
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device [EXPERIMENTAL].
Definition: core.c:729
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_len)
Get the list of all port numbers from root for the specified device.
Definition: core.c:688
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:703
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:847
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:338
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:636
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:796
unsigned char type
Type of the endpoint from libusb_transfer_type.
Definition: libusb.h:943
libusb_error
Error codes.
Definition: libusb.h:782
libusb_log_level
Log message levels.
Definition: libusb.h:1020
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusbx transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1243
Select an alternate interface for the specified interface.
Definition: libusb.h:350
struct libusb_iso_packet_descriptor iso_packet_desc[0]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:981
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:529
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:1308
Hub class.
Definition: libusb.h:208