usb 1.7.2-prebuild

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/.github/workflows/prebuild.yml +62 -0
  2. package/.gitmodules +3 -0
  3. package/LICENSE +7 -0
  4. package/Readme.md +339 -0
  5. package/binding.gyp +90 -0
  6. package/libusb/.gitattributes +11 -0
  7. package/libusb/.private/README.txt +5 -0
  8. package/libusb/.private/bd.cmd +89 -0
  9. package/libusb/.private/bm.sh +54 -0
  10. package/libusb/.private/bwince.cmd +57 -0
  11. package/libusb/.private/post-rewrite.sh +28 -0
  12. package/libusb/.private/pre-commit.sh +42 -0
  13. package/libusb/.private/wbs.txt +61 -0
  14. package/libusb/.private/wbs_wince.txt +42 -0
  15. package/libusb/AUTHORS +78 -0
  16. package/libusb/COPYING +504 -0
  17. package/libusb/ChangeLog +211 -0
  18. package/libusb/INSTALL +234 -0
  19. package/libusb/INSTALL_WIN.txt +73 -0
  20. package/libusb/Makefile.am +28 -0
  21. package/libusb/NEWS +2 -0
  22. package/libusb/PORTING +94 -0
  23. package/libusb/README +28 -0
  24. package/libusb/README.git +41 -0
  25. package/libusb/TODO +2 -0
  26. package/libusb/Xcode/common.xcconfig +49 -0
  27. package/libusb/Xcode/debug.xcconfig +29 -0
  28. package/libusb/Xcode/libusb.xcconfig +21 -0
  29. package/libusb/Xcode/libusb.xcodeproj/project.pbxproj +1 -0
  30. package/libusb/Xcode/libusb_debug.xcconfig +21 -0
  31. package/libusb/Xcode/libusb_release.xcconfig +21 -0
  32. package/libusb/Xcode/release.xcconfig +30 -0
  33. package/libusb/android/README +114 -0
  34. package/libusb/android/jni/Android.mk +23 -0
  35. package/libusb/android/jni/Application.mk +24 -0
  36. package/libusb/android/jni/examples.mk +134 -0
  37. package/libusb/android/jni/libusb.mk +54 -0
  38. package/libusb/android/jni/tests.mk +56 -0
  39. package/libusb/autogen.sh +8 -0
  40. package/libusb/bootstrap.sh +19 -0
  41. package/libusb/configure.ac +304 -0
  42. package/libusb/doc/Makefile.am +9 -0
  43. package/libusb/doc/doxygen.cfg.in +1288 -0
  44. package/libusb/doc/libusb.png +0 -0
  45. package/libusb/examples/Makefile.am +19 -0
  46. package/libusb/examples/dpfp.c +506 -0
  47. package/libusb/examples/dpfp_threaded.c +544 -0
  48. package/libusb/examples/ezusb.c +831 -0
  49. package/libusb/examples/ezusb.h +120 -0
  50. package/libusb/examples/fxload.c +287 -0
  51. package/libusb/examples/getopt/getopt.c +1060 -0
  52. package/libusb/examples/getopt/getopt.h +180 -0
  53. package/libusb/examples/getopt/getopt1.c +188 -0
  54. package/libusb/examples/hotplugtest.c +104 -0
  55. package/libusb/examples/listdevs.c +71 -0
  56. package/libusb/examples/sam3u_benchmark.c +193 -0
  57. package/libusb/examples/xusb.c +1129 -0
  58. package/libusb/libusb/Makefile.am +75 -0
  59. package/libusb/libusb/core.c +2342 -0
  60. package/libusb/libusb/descriptor.c +1199 -0
  61. package/libusb/libusb/hotplug.c +327 -0
  62. package/libusb/libusb/hotplug.h +82 -0
  63. package/libusb/libusb/io.c +2631 -0
  64. package/libusb/libusb/libusb-1.0.def +166 -0
  65. package/libusb/libusb/libusb-1.0.rc +61 -0
  66. package/libusb/libusb/libusb.h +1998 -0
  67. package/libusb/libusb/libusbi.h +1040 -0
  68. package/libusb/libusb/os/darwin_usb.c +2009 -0
  69. package/libusb/libusb/os/darwin_usb.h +162 -0
  70. package/libusb/libusb/os/linux_netlink.c +369 -0
  71. package/libusb/libusb/os/linux_udev.c +307 -0
  72. package/libusb/libusb/os/linux_usbfs.c +2695 -0
  73. package/libusb/libusb/os/linux_usbfs.h +192 -0
  74. package/libusb/libusb/os/netbsd_usb.c +738 -0
  75. package/libusb/libusb/os/openbsd_usb.c +832 -0
  76. package/libusb/libusb/os/poll_posix.c +51 -0
  77. package/libusb/libusb/os/poll_posix.h +11 -0
  78. package/libusb/libusb/os/poll_windows.c +796 -0
  79. package/libusb/libusb/os/poll_windows.h +131 -0
  80. package/libusb/libusb/os/threads_posix.c +82 -0
  81. package/libusb/libusb/os/threads_posix.h +50 -0
  82. package/libusb/libusb/os/threads_windows.c +212 -0
  83. package/libusb/libusb/os/threads_windows.h +87 -0
  84. package/libusb/libusb/os/wince_usb.c +1032 -0
  85. package/libusb/libusb/os/wince_usb.h +131 -0
  86. package/libusb/libusb/os/windows_common.h +108 -0
  87. package/libusb/libusb/os/windows_usb.c +5347 -0
  88. package/libusb/libusb/os/windows_usb.h +971 -0
  89. package/libusb/libusb/strerror.c +199 -0
  90. package/libusb/libusb/sync.c +307 -0
  91. package/libusb/libusb/version.h +18 -0
  92. package/libusb/libusb/version_nano.h +1 -0
  93. package/libusb/libusb-1.0.pc.in +11 -0
  94. package/libusb/msvc/config.h +50 -0
  95. package/libusb/msvc/ddk_build.cmd +175 -0
  96. package/libusb/msvc/errno.h +102 -0
  97. package/libusb/msvc/fxload_2010.vcxproj +170 -0
  98. package/libusb/msvc/fxload_2010.vcxproj.filters +25 -0
  99. package/libusb/msvc/fxload_2012.vcxproj +174 -0
  100. package/libusb/msvc/fxload_2012.vcxproj.filters +25 -0
  101. package/libusb/msvc/fxload_2013.vcxproj +174 -0
  102. package/libusb/msvc/fxload_sources +23 -0
  103. package/libusb/msvc/getopt_2005.vcproj +288 -0
  104. package/libusb/msvc/getopt_2010.vcxproj +131 -0
  105. package/libusb/msvc/getopt_2010.vcxproj.filters +26 -0
  106. package/libusb/msvc/getopt_2012.vcxproj +136 -0
  107. package/libusb/msvc/getopt_2012.vcxproj.filters +26 -0
  108. package/libusb/msvc/getopt_2013.vcxproj +136 -0
  109. package/libusb/msvc/getopt_sources +20 -0
  110. package/libusb/msvc/hotplugtest_2010.vcxproj +163 -0
  111. package/libusb/msvc/hotplugtest_2010.vcxproj.filters +14 -0
  112. package/libusb/msvc/hotplugtest_2012.vcxproj +167 -0
  113. package/libusb/msvc/hotplugtest_2012.vcxproj.filters +14 -0
  114. package/libusb/msvc/hotplugtest_2013.vcxproj +167 -0
  115. package/libusb/msvc/hotplugtest_sources +20 -0
  116. package/libusb/msvc/inttypes.h +295 -0
  117. package/libusb/msvc/libusb.dsw +71 -0
  118. package/libusb/msvc/libusb_2005.sln +95 -0
  119. package/libusb/msvc/libusb_2010.sln +94 -0
  120. package/libusb/msvc/libusb_2012.sln +94 -0
  121. package/libusb/msvc/libusb_2013.sln +100 -0
  122. package/libusb/msvc/libusb_2015.sln +100 -0
  123. package/libusb/msvc/libusb_dll.dsp +194 -0
  124. package/libusb/msvc/libusb_dll_2005.vcproj +436 -0
  125. package/libusb/msvc/libusb_dll_2010.vcxproj +170 -0
  126. package/libusb/msvc/libusb_dll_2010.vcxproj.filters +81 -0
  127. package/libusb/msvc/libusb_dll_2012.vcxproj +175 -0
  128. package/libusb/msvc/libusb_dll_2012.vcxproj.filters +84 -0
  129. package/libusb/msvc/libusb_dll_2013.vcxproj +175 -0
  130. package/libusb/msvc/libusb_dll_wince.vcproj +1243 -0
  131. package/libusb/msvc/libusb_sources +38 -0
  132. package/libusb/msvc/libusb_static.dsp +174 -0
  133. package/libusb/msvc/libusb_static_2005.vcproj +362 -0
  134. package/libusb/msvc/libusb_static_2010.vcxproj +156 -0
  135. package/libusb/msvc/libusb_static_2010.vcxproj.filters +74 -0
  136. package/libusb/msvc/libusb_static_2012.vcxproj +160 -0
  137. package/libusb/msvc/libusb_static_2012.vcxproj.filters +74 -0
  138. package/libusb/msvc/libusb_static_2013.vcxproj +160 -0
  139. package/libusb/msvc/libusb_static_wince.vcproj +1185 -0
  140. package/libusb/msvc/libusb_wince.sln +246 -0
  141. package/libusb/msvc/listdevs.dsp +103 -0
  142. package/libusb/msvc/listdevs_2005.vcproj +360 -0
  143. package/libusb/msvc/listdevs_2010.vcxproj +165 -0
  144. package/libusb/msvc/listdevs_2010.vcxproj.filters +14 -0
  145. package/libusb/msvc/listdevs_2012.vcxproj +169 -0
  146. package/libusb/msvc/listdevs_2012.vcxproj.filters +14 -0
  147. package/libusb/msvc/listdevs_2013.vcxproj +169 -0
  148. package/libusb/msvc/listdevs_sources +19 -0
  149. package/libusb/msvc/listdevs_wince.vcproj +1120 -0
  150. package/libusb/msvc/missing.c +80 -0
  151. package/libusb/msvc/missing.h +32 -0
  152. package/libusb/msvc/stdint.h +256 -0
  153. package/libusb/msvc/stress_2005.vcproj +390 -0
  154. package/libusb/msvc/stress_2010.vcxproj +167 -0
  155. package/libusb/msvc/stress_2010.vcxproj.filters +25 -0
  156. package/libusb/msvc/stress_2012.vcxproj +171 -0
  157. package/libusb/msvc/stress_2012.vcxproj.filters +25 -0
  158. package/libusb/msvc/stress_2013.vcxproj +171 -0
  159. package/libusb/msvc/stress_wince.vcproj +1128 -0
  160. package/libusb/msvc/xusb.dsp +102 -0
  161. package/libusb/msvc/xusb_2005.vcproj +344 -0
  162. package/libusb/msvc/xusb_2010.vcxproj +163 -0
  163. package/libusb/msvc/xusb_2010.vcxproj.filters +14 -0
  164. package/libusb/msvc/xusb_2012.vcxproj +167 -0
  165. package/libusb/msvc/xusb_2012.vcxproj.filters +14 -0
  166. package/libusb/msvc/xusb_2013.vcxproj +167 -0
  167. package/libusb/msvc/xusb_sources +20 -0
  168. package/libusb/msvc/xusb_wince.vcproj +1120 -0
  169. package/libusb/tests/Makefile.am +6 -0
  170. package/libusb/tests/libusb_testlib.h +107 -0
  171. package/libusb/tests/stress.c +160 -0
  172. package/libusb/tests/testlib.c +281 -0
  173. package/libusb.gypi +136 -0
  174. package/libusb_config/config.h +1 -0
  175. package/package.json +69 -0
  176. package/src/device.cc +412 -0
  177. package/src/helpers.h +64 -0
  178. package/src/node_usb.cc +319 -0
  179. package/src/node_usb.h +120 -0
  180. package/src/transfer.cc +148 -0
  181. package/src/uv_async_queue.h +33 -0
  182. package/test/usb.coffee +191 -0
  183. package/usb.js +524 -0
@@ -0,0 +1,1998 @@
1
+ /*
2
+ * Public libusb header file
3
+ * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4
+ * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5
+ * Copyright © 2012 Pete Batard <pete@akeo.ie>
6
+ * Copyright © 2012 Nathan Hjelm <hjelmn@cs.unm.edu>
7
+ * For more information, please visit: http://libusb.info
8
+ *
9
+ * This library is free software; you can redistribute it and/or
10
+ * modify it under the terms of the GNU Lesser General Public
11
+ * License as published by the Free Software Foundation; either
12
+ * version 2.1 of the License, or (at your option) any later version.
13
+ *
14
+ * This library is distributed in the hope that it will be useful,
15
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
+ * Lesser General Public License for more details.
18
+ *
19
+ * You should have received a copy of the GNU Lesser General Public
20
+ * License along with this library; if not, write to the Free Software
21
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22
+ */
23
+
24
+ #ifndef LIBUSB_H
25
+ #define LIBUSB_H
26
+
27
+ #ifdef _MSC_VER
28
+ /* on MS environments, the inline keyword is available in C++ only */
29
+ #if !defined(__cplusplus)
30
+ #define inline __inline
31
+ #endif
32
+ /* ssize_t is also not available (copy/paste from MinGW) */
33
+ #ifndef _SSIZE_T_DEFINED
34
+ #define _SSIZE_T_DEFINED
35
+ #undef ssize_t
36
+ #ifdef _WIN64
37
+ typedef __int64 ssize_t;
38
+ #else
39
+ typedef int ssize_t;
40
+ #endif /* _WIN64 */
41
+ #endif /* _SSIZE_T_DEFINED */
42
+ #endif /* _MSC_VER */
43
+
44
+ /* stdint.h is not available on older MSVC */
45
+ #if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
46
+ typedef unsigned __int8 uint8_t;
47
+ typedef unsigned __int16 uint16_t;
48
+ typedef unsigned __int32 uint32_t;
49
+ #else
50
+ #include <stdint.h>
51
+ #endif
52
+
53
+ #if !defined(_WIN32_WCE)
54
+ #include <sys/types.h>
55
+ #endif
56
+
57
+ #if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__)
58
+ #include <sys/time.h>
59
+ #endif
60
+
61
+ #include <time.h>
62
+ #include <limits.h>
63
+
64
+ /* 'interface' might be defined as a macro on Windows, so we need to
65
+ * undefine it so as not to break the current libusb API, because
66
+ * libusb_config_descriptor has an 'interface' member
67
+ * As this can be problematic if you include windows.h after libusb.h
68
+ * in your sources, we force windows.h to be included first. */
69
+ #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
70
+ #include <windows.h>
71
+ #if defined(interface)
72
+ #undef interface
73
+ #endif
74
+ #if !defined(__CYGWIN__)
75
+ #include <winsock.h>
76
+ #endif
77
+ #endif
78
+
79
+ #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
80
+ #define LIBUSB_DEPRECATED_FOR(f) \
81
+ __attribute__((deprecated("Use " #f " instead")))
82
+ #else
83
+ #define LIBUSB_DEPRECATED_FOR(f)
84
+ #endif /* __GNUC__ */
85
+
86
+ /** \def LIBUSB_CALL
87
+ * \ingroup misc
88
+ * libusb's Windows calling convention.
89
+ *
90
+ * Under Windows, the selection of available compilers and configurations
91
+ * means that, unlike other platforms, there is not <em>one true calling
92
+ * convention</em> (calling convention: the manner in which parameters are
93
+ * passed to funcions in the generated assembly code).
94
+ *
95
+ * Matching the Windows API itself, libusb uses the WINAPI convention (which
96
+ * translates to the <tt>stdcall</tt> convention) and guarantees that the
97
+ * library is compiled in this way. The public header file also includes
98
+ * appropriate annotations so that your own software will use the right
99
+ * convention, even if another convention is being used by default within
100
+ * your codebase.
101
+ *
102
+ * The one consideration that you must apply in your software is to mark
103
+ * all functions which you use as libusb callbacks with this LIBUSB_CALL
104
+ * annotation, so that they too get compiled for the correct calling
105
+ * convention.
106
+ *
107
+ * On non-Windows operating systems, this macro is defined as nothing. This
108
+ * means that you can apply it to your code without worrying about
109
+ * cross-platform compatibility.
110
+ */
111
+ /* LIBUSB_CALL must be defined on both definition and declaration of libusb
112
+ * functions. You'd think that declaration would be enough, but cygwin will
113
+ * complain about conflicting types unless both are marked this way.
114
+ * The placement of this macro is important too; it must appear after the
115
+ * return type, before the function name. See internal documentation for
116
+ * API_EXPORTED.
117
+ */
118
+ #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
119
+ #define LIBUSB_CALL WINAPI
120
+ #else
121
+ #define LIBUSB_CALL
122
+ #endif
123
+
124
+ /** \def LIBUSB_API_VERSION
125
+ * \ingroup misc
126
+ * libusb's API version.
127
+ *
128
+ * Since version 1.0.13, to help with feature detection, libusb defines
129
+ * a LIBUSB_API_VERSION macro that gets increased every time there is a
130
+ * significant change to the API, such as the introduction of a new call,
131
+ * the definition of a new macro/enum member, or any other element that
132
+ * libusb applications may want to detect at compilation time.
133
+ *
134
+ * The macro is typically used in an application as follows:
135
+ * \code
136
+ * #if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01001234)
137
+ * // Use one of the newer features from the libusb API
138
+ * #endif
139
+ * \endcode
140
+ *
141
+ * Another feature of LIBUSB_API_VERSION is that it can be used to detect
142
+ * whether you are compiling against the libusb or the libusb library.
143
+ *
144
+ * Internally, LIBUSB_API_VERSION is defined as follows:
145
+ * (libusb major << 24) | (libusb minor << 16) | (16 bit incremental)
146
+ */
147
+ #define LIBUSB_API_VERSION 0x01000103
148
+
149
+ /* The following is kept for compatibility, but will be deprecated in the future */
150
+ #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
151
+
152
+ #ifdef __cplusplus
153
+ extern "C" {
154
+ #endif
155
+
156
+ /**
157
+ * \ingroup misc
158
+ * Convert a 16-bit value from host-endian to little-endian format. On
159
+ * little endian systems, this function does nothing. On big endian systems,
160
+ * the bytes are swapped.
161
+ * \param x the host-endian value to convert
162
+ * \returns the value in little-endian byte order
163
+ */
164
+ static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
165
+ {
166
+ union {
167
+ uint8_t b8[2];
168
+ uint16_t b16;
169
+ } _tmp;
170
+ _tmp.b8[1] = (uint8_t) (x >> 8);
171
+ _tmp.b8[0] = (uint8_t) (x & 0xff);
172
+ return _tmp.b16;
173
+ }
174
+
175
+ /** \def libusb_le16_to_cpu
176
+ * \ingroup misc
177
+ * Convert a 16-bit value from little-endian to host-endian format. On
178
+ * little endian systems, this function does nothing. On big endian systems,
179
+ * the bytes are swapped.
180
+ * \param x the little-endian value to convert
181
+ * \returns the value in host-endian byte order
182
+ */
183
+ #define libusb_le16_to_cpu libusb_cpu_to_le16
184
+
185
+ /* standard USB stuff */
186
+
187
+ /** \ingroup desc
188
+ * Device and/or Interface Class codes */
189
+ enum libusb_class_code {
190
+ /** In the context of a \ref libusb_device_descriptor "device descriptor",
191
+ * this bDeviceClass value indicates that each interface specifies its
192
+ * own class information and all interfaces operate independently.
193
+ */
194
+ LIBUSB_CLASS_PER_INTERFACE = 0,
195
+
196
+ /** Audio class */
197
+ LIBUSB_CLASS_AUDIO = 1,
198
+
199
+ /** Communications class */
200
+ LIBUSB_CLASS_COMM = 2,
201
+
202
+ /** Human Interface Device class */
203
+ LIBUSB_CLASS_HID = 3,
204
+
205
+ /** Physical */
206
+ LIBUSB_CLASS_PHYSICAL = 5,
207
+
208
+ /** Printer class */
209
+ LIBUSB_CLASS_PRINTER = 7,
210
+
211
+ /** Image class */
212
+ LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
213
+ LIBUSB_CLASS_IMAGE = 6,
214
+
215
+ /** Mass storage class */
216
+ LIBUSB_CLASS_MASS_STORAGE = 8,
217
+
218
+ /** Hub class */
219
+ LIBUSB_CLASS_HUB = 9,
220
+
221
+ /** Data class */
222
+ LIBUSB_CLASS_DATA = 10,
223
+
224
+ /** Smart Card */
225
+ LIBUSB_CLASS_SMART_CARD = 0x0b,
226
+
227
+ /** Content Security */
228
+ LIBUSB_CLASS_CONTENT_SECURITY = 0x0d,
229
+
230
+ /** Video */
231
+ LIBUSB_CLASS_VIDEO = 0x0e,
232
+
233
+ /** Personal Healthcare */
234
+ LIBUSB_CLASS_PERSONAL_HEALTHCARE = 0x0f,
235
+
236
+ /** Diagnostic Device */
237
+ LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
238
+
239
+ /** Wireless class */
240
+ LIBUSB_CLASS_WIRELESS = 0xe0,
241
+
242
+ /** Application class */
243
+ LIBUSB_CLASS_APPLICATION = 0xfe,
244
+
245
+ /** Class is vendor-specific */
246
+ LIBUSB_CLASS_VENDOR_SPEC = 0xff
247
+ };
248
+
249
+ /** \ingroup desc
250
+ * Descriptor types as defined by the USB specification. */
251
+ enum libusb_descriptor_type {
252
+ /** Device descriptor. See libusb_device_descriptor. */
253
+ LIBUSB_DT_DEVICE = 0x01,
254
+
255
+ /** Configuration descriptor. See libusb_config_descriptor. */
256
+ LIBUSB_DT_CONFIG = 0x02,
257
+
258
+ /** String descriptor */
259
+ LIBUSB_DT_STRING = 0x03,
260
+
261
+ /** Interface descriptor. See libusb_interface_descriptor. */
262
+ LIBUSB_DT_INTERFACE = 0x04,
263
+
264
+ /** Endpoint descriptor. See libusb_endpoint_descriptor. */
265
+ LIBUSB_DT_ENDPOINT = 0x05,
266
+
267
+ /** BOS descriptor */
268
+ LIBUSB_DT_BOS = 0x0f,
269
+
270
+ /** Device Capability descriptor */
271
+ LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
272
+
273
+ /** HID descriptor */
274
+ LIBUSB_DT_HID = 0x21,
275
+
276
+ /** HID report descriptor */
277
+ LIBUSB_DT_REPORT = 0x22,
278
+
279
+ /** Physical descriptor */
280
+ LIBUSB_DT_PHYSICAL = 0x23,
281
+
282
+ /** Hub descriptor */
283
+ LIBUSB_DT_HUB = 0x29,
284
+
285
+ /** SuperSpeed Hub descriptor */
286
+ LIBUSB_DT_SUPERSPEED_HUB = 0x2a,
287
+
288
+ /** SuperSpeed Endpoint Companion descriptor */
289
+ LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30
290
+ };
291
+
292
+ /* Descriptor sizes per descriptor type */
293
+ #define LIBUSB_DT_DEVICE_SIZE 18
294
+ #define LIBUSB_DT_CONFIG_SIZE 9
295
+ #define LIBUSB_DT_INTERFACE_SIZE 9
296
+ #define LIBUSB_DT_ENDPOINT_SIZE 7
297
+ #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
298
+ #define LIBUSB_DT_HUB_NONVAR_SIZE 7
299
+ #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
300
+ #define LIBUSB_DT_BOS_SIZE 5
301
+ #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
302
+
303
+ /* BOS descriptor sizes */
304
+ #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
305
+ #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
306
+ #define LIBUSB_BT_CONTAINER_ID_SIZE 20
307
+
308
+ /* We unwrap the BOS => define its max size */
309
+ #define LIBUSB_DT_BOS_MAX_SIZE ((LIBUSB_DT_BOS_SIZE) +\
310
+ (LIBUSB_BT_USB_2_0_EXTENSION_SIZE) +\
311
+ (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\
312
+ (LIBUSB_BT_CONTAINER_ID_SIZE))
313
+
314
+ #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
315
+ #define LIBUSB_ENDPOINT_DIR_MASK 0x80
316
+
317
+ /** \ingroup desc
318
+ * Endpoint direction. Values for bit 7 of the
319
+ * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme.
320
+ */
321
+ enum libusb_endpoint_direction {
322
+ /** In: device-to-host */
323
+ LIBUSB_ENDPOINT_IN = 0x80,
324
+
325
+ /** Out: host-to-device */
326
+ LIBUSB_ENDPOINT_OUT = 0x00
327
+ };
328
+
329
+ #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
330
+
331
+ /** \ingroup desc
332
+ * Endpoint transfer type. Values for bits 0:1 of the
333
+ * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field.
334
+ */
335
+ enum libusb_transfer_type {
336
+ /** Control endpoint */
337
+ LIBUSB_TRANSFER_TYPE_CONTROL = 0,
338
+
339
+ /** Isochronous endpoint */
340
+ LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
341
+
342
+ /** Bulk endpoint */
343
+ LIBUSB_TRANSFER_TYPE_BULK = 2,
344
+
345
+ /** Interrupt endpoint */
346
+ LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
347
+
348
+ /** Stream endpoint */
349
+ LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,
350
+ };
351
+
352
+ /** \ingroup misc
353
+ * Standard requests, as defined in table 9-5 of the USB 3.0 specifications */
354
+ enum libusb_standard_request {
355
+ /** Request status of the specific recipient */
356
+ LIBUSB_REQUEST_GET_STATUS = 0x00,
357
+
358
+ /** Clear or disable a specific feature */
359
+ LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
360
+
361
+ /* 0x02 is reserved */
362
+
363
+ /** Set or enable a specific feature */
364
+ LIBUSB_REQUEST_SET_FEATURE = 0x03,
365
+
366
+ /* 0x04 is reserved */
367
+
368
+ /** Set device address for all future accesses */
369
+ LIBUSB_REQUEST_SET_ADDRESS = 0x05,
370
+
371
+ /** Get the specified descriptor */
372
+ LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
373
+
374
+ /** Used to update existing descriptors or add new descriptors */
375
+ LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
376
+
377
+ /** Get the current device configuration value */
378
+ LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
379
+
380
+ /** Set device configuration */
381
+ LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
382
+
383
+ /** Return the selected alternate setting for the specified interface */
384
+ LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
385
+
386
+ /** Select an alternate interface for the specified interface */
387
+ LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
388
+
389
+ /** Set then report an endpoint's synchronization frame */
390
+ LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
391
+
392
+ /** Sets both the U1 and U2 Exit Latency */
393
+ LIBUSB_REQUEST_SET_SEL = 0x30,
394
+
395
+ /** Delay from the time a host transmits a packet to the time it is
396
+ * received by the device. */
397
+ LIBUSB_SET_ISOCH_DELAY = 0x31,
398
+ };
399
+
400
+ /** \ingroup misc
401
+ * Request type bits of the
402
+ * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
403
+ * transfers. */
404
+ enum libusb_request_type {
405
+ /** Standard */
406
+ LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
407
+
408
+ /** Class */
409
+ LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
410
+
411
+ /** Vendor */
412
+ LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
413
+
414
+ /** Reserved */
415
+ LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
416
+ };
417
+
418
+ /** \ingroup misc
419
+ * Recipient bits of the
420
+ * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
421
+ * transfers. Values 4 through 31 are reserved. */
422
+ enum libusb_request_recipient {
423
+ /** Device */
424
+ LIBUSB_RECIPIENT_DEVICE = 0x00,
425
+
426
+ /** Interface */
427
+ LIBUSB_RECIPIENT_INTERFACE = 0x01,
428
+
429
+ /** Endpoint */
430
+ LIBUSB_RECIPIENT_ENDPOINT = 0x02,
431
+
432
+ /** Other */
433
+ LIBUSB_RECIPIENT_OTHER = 0x03,
434
+ };
435
+
436
+ #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
437
+
438
+ /** \ingroup desc
439
+ * Synchronization type for isochronous endpoints. Values for bits 2:3 of the
440
+ * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
441
+ * libusb_endpoint_descriptor.
442
+ */
443
+ enum libusb_iso_sync_type {
444
+ /** No synchronization */
445
+ LIBUSB_ISO_SYNC_TYPE_NONE = 0,
446
+
447
+ /** Asynchronous */
448
+ LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
449
+
450
+ /** Adaptive */
451
+ LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
452
+
453
+ /** Synchronous */
454
+ LIBUSB_ISO_SYNC_TYPE_SYNC = 3
455
+ };
456
+
457
+ #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
458
+
459
+ /** \ingroup desc
460
+ * Usage type for isochronous endpoints. Values for bits 4:5 of the
461
+ * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
462
+ * libusb_endpoint_descriptor.
463
+ */
464
+ enum libusb_iso_usage_type {
465
+ /** Data endpoint */
466
+ LIBUSB_ISO_USAGE_TYPE_DATA = 0,
467
+
468
+ /** Feedback endpoint */
469
+ LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
470
+
471
+ /** Implicit feedback Data endpoint */
472
+ LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
473
+ };
474
+
475
+ /** \ingroup desc
476
+ * A structure representing the standard USB device descriptor. This
477
+ * descriptor is documented in section 9.6.1 of the USB 3.0 specification.
478
+ * All multiple-byte fields are represented in host-endian format.
479
+ */
480
+ struct libusb_device_descriptor {
481
+ /** Size of this descriptor (in bytes) */
482
+ uint8_t bLength;
483
+
484
+ /** Descriptor type. Will have value
485
+ * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this
486
+ * context. */
487
+ uint8_t bDescriptorType;
488
+
489
+ /** USB specification release number in binary-coded decimal. A value of
490
+ * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */
491
+ uint16_t bcdUSB;
492
+
493
+ /** USB-IF class code for the device. See \ref libusb_class_code. */
494
+ uint8_t bDeviceClass;
495
+
496
+ /** USB-IF subclass code for the device, qualified by the bDeviceClass
497
+ * value */
498
+ uint8_t bDeviceSubClass;
499
+
500
+ /** USB-IF protocol code for the device, qualified by the bDeviceClass and
501
+ * bDeviceSubClass values */
502
+ uint8_t bDeviceProtocol;
503
+
504
+ /** Maximum packet size for endpoint 0 */
505
+ uint8_t bMaxPacketSize0;
506
+
507
+ /** USB-IF vendor ID */
508
+ uint16_t idVendor;
509
+
510
+ /** USB-IF product ID */
511
+ uint16_t idProduct;
512
+
513
+ /** Device release number in binary-coded decimal */
514
+ uint16_t bcdDevice;
515
+
516
+ /** Index of string descriptor describing manufacturer */
517
+ uint8_t iManufacturer;
518
+
519
+ /** Index of string descriptor describing product */
520
+ uint8_t iProduct;
521
+
522
+ /** Index of string descriptor containing device serial number */
523
+ uint8_t iSerialNumber;
524
+
525
+ /** Number of possible configurations */
526
+ uint8_t bNumConfigurations;
527
+ };
528
+
529
+ /** \ingroup desc
530
+ * A structure representing the standard USB endpoint descriptor. This
531
+ * descriptor is documented in section 9.6.6 of the USB 3.0 specification.
532
+ * All multiple-byte fields are represented in host-endian format.
533
+ */
534
+ struct libusb_endpoint_descriptor {
535
+ /** Size of this descriptor (in bytes) */
536
+ uint8_t bLength;
537
+
538
+ /** Descriptor type. Will have value
539
+ * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in
540
+ * this context. */
541
+ uint8_t bDescriptorType;
542
+
543
+ /** The address of the endpoint described by this descriptor. Bits 0:3 are
544
+ * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction,
545
+ * see \ref libusb_endpoint_direction.
546
+ */
547
+ uint8_t bEndpointAddress;
548
+
549
+ /** Attributes which apply to the endpoint when it is configured using
550
+ * the bConfigurationValue. Bits 0:1 determine the transfer type and
551
+ * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for
552
+ * isochronous endpoints and correspond to \ref libusb_iso_sync_type.
553
+ * Bits 4:5 are also only used for isochronous endpoints and correspond to
554
+ * \ref libusb_iso_usage_type. Bits 6:7 are reserved.
555
+ */
556
+ uint8_t bmAttributes;
557
+
558
+ /** Maximum packet size this endpoint is capable of sending/receiving. */
559
+ uint16_t wMaxPacketSize;
560
+
561
+ /** Interval for polling endpoint for data transfers. */
562
+ uint8_t bInterval;
563
+
564
+ /** For audio devices only: the rate at which synchronization feedback
565
+ * is provided. */
566
+ uint8_t bRefresh;
567
+
568
+ /** For audio devices only: the address if the synch endpoint */
569
+ uint8_t bSynchAddress;
570
+
571
+ /** Extra descriptors. If libusb encounters unknown endpoint descriptors,
572
+ * it will store them here, should you wish to parse them. */
573
+ const unsigned char *extra;
574
+
575
+ /** Length of the extra descriptors, in bytes. */
576
+ int extra_length;
577
+ };
578
+
579
+ /** \ingroup desc
580
+ * A structure representing the standard USB interface descriptor. This
581
+ * descriptor is documented in section 9.6.5 of the USB 3.0 specification.
582
+ * All multiple-byte fields are represented in host-endian format.
583
+ */
584
+ struct libusb_interface_descriptor {
585
+ /** Size of this descriptor (in bytes) */
586
+ uint8_t bLength;
587
+
588
+ /** Descriptor type. Will have value
589
+ * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE
590
+ * in this context. */
591
+ uint8_t bDescriptorType;
592
+
593
+ /** Number of this interface */
594
+ uint8_t bInterfaceNumber;
595
+
596
+ /** Value used to select this alternate setting for this interface */
597
+ uint8_t bAlternateSetting;
598
+
599
+ /** Number of endpoints used by this interface (excluding the control
600
+ * endpoint). */
601
+ uint8_t bNumEndpoints;
602
+
603
+ /** USB-IF class code for this interface. See \ref libusb_class_code. */
604
+ uint8_t bInterfaceClass;
605
+
606
+ /** USB-IF subclass code for this interface, qualified by the
607
+ * bInterfaceClass value */
608
+ uint8_t bInterfaceSubClass;
609
+
610
+ /** USB-IF protocol code for this interface, qualified by the
611
+ * bInterfaceClass and bInterfaceSubClass values */
612
+ uint8_t bInterfaceProtocol;
613
+
614
+ /** Index of string descriptor describing this interface */
615
+ uint8_t iInterface;
616
+
617
+ /** Array of endpoint descriptors. This length of this array is determined
618
+ * by the bNumEndpoints field. */
619
+ const struct libusb_endpoint_descriptor *endpoint;
620
+
621
+ /** Extra descriptors. If libusb encounters unknown interface descriptors,
622
+ * it will store them here, should you wish to parse them. */
623
+ const unsigned char *extra;
624
+
625
+ /** Length of the extra descriptors, in bytes. */
626
+ int extra_length;
627
+ };
628
+
629
+ /** \ingroup desc
630
+ * A collection of alternate settings for a particular USB interface.
631
+ */
632
+ struct libusb_interface {
633
+ /** Array of interface descriptors. The length of this array is determined
634
+ * by the num_altsetting field. */
635
+ const struct libusb_interface_descriptor *altsetting;
636
+
637
+ /** The number of alternate settings that belong to this interface */
638
+ int num_altsetting;
639
+ };
640
+
641
+ /** \ingroup desc
642
+ * A structure representing the standard USB configuration descriptor. This
643
+ * descriptor is documented in section 9.6.3 of the USB 3.0 specification.
644
+ * All multiple-byte fields are represented in host-endian format.
645
+ */
646
+ struct libusb_config_descriptor {
647
+ /** Size of this descriptor (in bytes) */
648
+ uint8_t bLength;
649
+
650
+ /** Descriptor type. Will have value
651
+ * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG
652
+ * in this context. */
653
+ uint8_t bDescriptorType;
654
+
655
+ /** Total length of data returned for this configuration */
656
+ uint16_t wTotalLength;
657
+
658
+ /** Number of interfaces supported by this configuration */
659
+ uint8_t bNumInterfaces;
660
+
661
+ /** Identifier value for this configuration */
662
+ uint8_t bConfigurationValue;
663
+
664
+ /** Index of string descriptor describing this configuration */
665
+ uint8_t iConfiguration;
666
+
667
+ /** Configuration characteristics */
668
+ uint8_t bmAttributes;
669
+
670
+ /** Maximum power consumption of the USB device from this bus in this
671
+ * configuration when the device is fully opreation. Expressed in units
672
+ * of 2 mA. */
673
+ uint8_t MaxPower;
674
+
675
+ /** Array of interfaces supported by this configuration. The length of
676
+ * this array is determined by the bNumInterfaces field. */
677
+ const struct libusb_interface *interface;
678
+
679
+ /** Extra descriptors. If libusb encounters unknown configuration
680
+ * descriptors, it will store them here, should you wish to parse them. */
681
+ const unsigned char *extra;
682
+
683
+ /** Length of the extra descriptors, in bytes. */
684
+ int extra_length;
685
+ };
686
+
687
+ /** \ingroup desc
688
+ * A structure representing the superspeed endpoint companion
689
+ * descriptor. This descriptor is documented in section 9.6.7 of
690
+ * the USB 3.0 specification. All multiple-byte fields are represented in
691
+ * host-endian format.
692
+ */
693
+ struct libusb_ss_endpoint_companion_descriptor {
694
+
695
+ /** Size of this descriptor (in bytes) */
696
+ uint8_t bLength;
697
+
698
+ /** Descriptor type. Will have value
699
+ * \ref libusb_descriptor_type::LIBUSB_DT_SS_ENDPOINT_COMPANION in
700
+ * this context. */
701
+ uint8_t bDescriptorType;
702
+
703
+
704
+ /** The maximum number of packets the endpoint can send or
705
+ * recieve as part of a burst. */
706
+ uint8_t bMaxBurst;
707
+
708
+ /** In bulk EP: bits 4:0 represents the maximum number of
709
+ * streams the EP supports. In isochronous EP: bits 1:0
710
+ * represents the Mult - a zero based value that determines
711
+ * the maximum number of packets within a service interval */
712
+ uint8_t bmAttributes;
713
+
714
+ /** The total number of bytes this EP will transfer every
715
+ * service interval. valid only for periodic EPs. */
716
+ uint16_t wBytesPerInterval;
717
+ };
718
+
719
+ /** \ingroup desc
720
+ * A generic representation of a BOS Device Capability descriptor. It is
721
+ * advised to check bDevCapabilityType and call the matching
722
+ * libusb_get_*_descriptor function to get a structure fully matching the type.
723
+ */
724
+ struct libusb_bos_dev_capability_descriptor {
725
+ /** Size of this descriptor (in bytes) */
726
+ uint8_t bLength;
727
+ /** Descriptor type. Will have value
728
+ * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
729
+ * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
730
+ uint8_t bDescriptorType;
731
+ /** Device Capability type */
732
+ uint8_t bDevCapabilityType;
733
+ /** Device Capability data (bLength - 3 bytes) */
734
+ uint8_t dev_capability_data
735
+ #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
736
+ [] /* valid C99 code */
737
+ #else
738
+ [0] /* non-standard, but usually working code */
739
+ #endif
740
+ ;
741
+ };
742
+
743
+ /** \ingroup desc
744
+ * A structure representing the Binary Device Object Store (BOS) descriptor.
745
+ * This descriptor is documented in section 9.6.2 of the USB 3.0 specification.
746
+ * All multiple-byte fields are represented in host-endian format.
747
+ */
748
+ struct libusb_bos_descriptor {
749
+ /** Size of this descriptor (in bytes) */
750
+ uint8_t bLength;
751
+
752
+ /** Descriptor type. Will have value
753
+ * \ref libusb_descriptor_type::LIBUSB_DT_BOS LIBUSB_DT_BOS
754
+ * in this context. */
755
+ uint8_t bDescriptorType;
756
+
757
+ /** Length of this descriptor and all of its sub descriptors */
758
+ uint16_t wTotalLength;
759
+
760
+ /** The number of separate device capability descriptors in
761
+ * the BOS */
762
+ uint8_t bNumDeviceCaps;
763
+
764
+ /** bNumDeviceCap Device Capability Descriptors */
765
+ struct libusb_bos_dev_capability_descriptor *dev_capability
766
+ #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
767
+ [] /* valid C99 code */
768
+ #else
769
+ [0] /* non-standard, but usually working code */
770
+ #endif
771
+ ;
772
+ };
773
+
774
+ /** \ingroup desc
775
+ * A structure representing the USB 2.0 Extension descriptor
776
+ * This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification.
777
+ * All multiple-byte fields are represented in host-endian format.
778
+ */
779
+ struct libusb_usb_2_0_extension_descriptor {
780
+ /** Size of this descriptor (in bytes) */
781
+ uint8_t bLength;
782
+
783
+ /** Descriptor type. Will have value
784
+ * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
785
+ * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
786
+ uint8_t bDescriptorType;
787
+
788
+ /** Capability type. Will have value
789
+ * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION
790
+ * LIBUSB_BT_USB_2_0_EXTENSION in this context. */
791
+ uint8_t bDevCapabilityType;
792
+
793
+ /** Bitmap encoding of supported device level features.
794
+ * A value of one in a bit location indicates a feature is
795
+ * supported; a value of zero indicates it is not supported.
796
+ * See \ref libusb_usb_2_0_extension_attributes. */
797
+ uint32_t bmAttributes;
798
+ };
799
+
800
+ /** \ingroup desc
801
+ * A structure representing the SuperSpeed USB Device Capability descriptor
802
+ * This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification.
803
+ * All multiple-byte fields are represented in host-endian format.
804
+ */
805
+ struct libusb_ss_usb_device_capability_descriptor {
806
+ /** Size of this descriptor (in bytes) */
807
+ uint8_t bLength;
808
+
809
+ /** Descriptor type. Will have value
810
+ * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
811
+ * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
812
+ uint8_t bDescriptorType;
813
+
814
+ /** Capability type. Will have value
815
+ * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
816
+ * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY in this context. */
817
+ uint8_t bDevCapabilityType;
818
+
819
+ /** Bitmap encoding of supported device level features.
820
+ * A value of one in a bit location indicates a feature is
821
+ * supported; a value of zero indicates it is not supported.
822
+ * See \ref libusb_ss_usb_device_capability_attributes. */
823
+ uint8_t bmAttributes;
824
+
825
+ /** Bitmap encoding of the speed supported by this device when
826
+ * operating in SuperSpeed mode. See \ref libusb_supported_speed. */
827
+ uint16_t wSpeedSupported;
828
+
829
+ /** The lowest speed at which all the functionality supported
830
+ * by the device is available to the user. For example if the
831
+ * device supports all its functionality when connected at
832
+ * full speed and above then it sets this value to 1. */
833
+ uint8_t bFunctionalitySupport;
834
+
835
+ /** U1 Device Exit Latency. */
836
+ uint8_t bU1DevExitLat;
837
+
838
+ /** U2 Device Exit Latency. */
839
+ uint16_t bU2DevExitLat;
840
+ };
841
+
842
+ /** \ingroup desc
843
+ * A structure representing the Container ID descriptor.
844
+ * This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification.
845
+ * All multiple-byte fields, except UUIDs, are represented in host-endian format.
846
+ */
847
+ struct libusb_container_id_descriptor {
848
+ /** Size of this descriptor (in bytes) */
849
+ uint8_t bLength;
850
+
851
+ /** Descriptor type. Will have value
852
+ * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
853
+ * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
854
+ uint8_t bDescriptorType;
855
+
856
+ /** Capability type. Will have value
857
+ * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID
858
+ * LIBUSB_BT_CONTAINER_ID in this context. */
859
+ uint8_t bDevCapabilityType;
860
+
861
+ /** Reserved field */
862
+ uint8_t bReserved;
863
+
864
+ /** 128 bit UUID */
865
+ uint8_t ContainerID[16];
866
+ };
867
+
868
+ /** \ingroup asyncio
869
+ * Setup packet for control transfers. */
870
+ struct libusb_control_setup {
871
+ /** Request type. Bits 0:4 determine recipient, see
872
+ * \ref libusb_request_recipient. Bits 5:6 determine type, see
873
+ * \ref libusb_request_type. Bit 7 determines data transfer direction, see
874
+ * \ref libusb_endpoint_direction.
875
+ */
876
+ uint8_t bmRequestType;
877
+
878
+ /** Request. If the type bits of bmRequestType are equal to
879
+ * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD
880
+ * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to
881
+ * \ref libusb_standard_request. For other cases, use of this field is
882
+ * application-specific. */
883
+ uint8_t bRequest;
884
+
885
+ /** Value. Varies according to request */
886
+ uint16_t wValue;
887
+
888
+ /** Index. Varies according to request, typically used to pass an index
889
+ * or offset */
890
+ uint16_t wIndex;
891
+
892
+ /** Number of bytes to transfer */
893
+ uint16_t wLength;
894
+ };
895
+
896
+ #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
897
+
898
+ /* libusb */
899
+
900
+ struct libusb_context;
901
+ struct libusb_device;
902
+ struct libusb_device_handle;
903
+ struct libusb_hotplug_callback;
904
+
905
+ /** \ingroup lib
906
+ * Structure providing the version of the libusb runtime
907
+ */
908
+ struct libusb_version {
909
+ /** Library major version. */
910
+ const uint16_t major;
911
+
912
+ /** Library minor version. */
913
+ const uint16_t minor;
914
+
915
+ /** Library micro version. */
916
+ const uint16_t micro;
917
+
918
+ /** Library nano version. */
919
+ const uint16_t nano;
920
+
921
+ /** Library release candidate suffix string, e.g. "-rc4". */
922
+ const char *rc;
923
+
924
+ /** For ABI compatibility only. */
925
+ const char* describe;
926
+ };
927
+
928
+ /** \ingroup lib
929
+ * Structure representing a libusb session. The concept of individual libusb
930
+ * sessions allows for your program to use two libraries (or dynamically
931
+ * load two modules) which both independently use libusb. This will prevent
932
+ * interference between the individual libusb users - for example
933
+ * libusb_set_debug() will not affect the other user of the library, and
934
+ * libusb_exit() will not destroy resources that the other user is still
935
+ * using.
936
+ *
937
+ * Sessions are created by libusb_init() and destroyed through libusb_exit().
938
+ * If your application is guaranteed to only ever include a single libusb
939
+ * user (i.e. you), you do not have to worry about contexts: pass NULL in
940
+ * every function call where a context is required. The default context
941
+ * will be used.
942
+ *
943
+ * For more information, see \ref contexts.
944
+ */
945
+ typedef struct libusb_context libusb_context;
946
+
947
+ /** \ingroup dev
948
+ * Structure representing a USB device detected on the system. This is an
949
+ * opaque type for which you are only ever provided with a pointer, usually
950
+ * originating from libusb_get_device_list().
951
+ *
952
+ * Certain operations can be performed on a device, but in order to do any
953
+ * I/O you will have to first obtain a device handle using libusb_open().
954
+ *
955
+ * Devices are reference counted with libusb_ref_device() and
956
+ * libusb_unref_device(), and are freed when the reference count reaches 0.
957
+ * New devices presented by libusb_get_device_list() have a reference count of
958
+ * 1, and libusb_free_device_list() can optionally decrease the reference count
959
+ * on all devices in the list. libusb_open() adds another reference which is
960
+ * later destroyed by libusb_close().
961
+ */
962
+ typedef struct libusb_device libusb_device;
963
+
964
+
965
+ /** \ingroup dev
966
+ * Structure representing a handle on a USB device. This is an opaque type for
967
+ * which you are only ever provided with a pointer, usually originating from
968
+ * libusb_open().
969
+ *
970
+ * A device handle is used to perform I/O and other operations. When finished
971
+ * with a device handle, you should call libusb_close().
972
+ */
973
+ typedef struct libusb_device_handle libusb_device_handle;
974
+
975
+ /** \ingroup dev
976
+ * Speed codes. Indicates the speed at which the device is operating.
977
+ */
978
+ enum libusb_speed {
979
+ /** The OS doesn't report or know the device speed. */
980
+ LIBUSB_SPEED_UNKNOWN = 0,
981
+
982
+ /** The device is operating at low speed (1.5MBit/s). */
983
+ LIBUSB_SPEED_LOW = 1,
984
+
985
+ /** The device is operating at full speed (12MBit/s). */
986
+ LIBUSB_SPEED_FULL = 2,
987
+
988
+ /** The device is operating at high speed (480MBit/s). */
989
+ LIBUSB_SPEED_HIGH = 3,
990
+
991
+ /** The device is operating at super speed (5000MBit/s). */
992
+ LIBUSB_SPEED_SUPER = 4,
993
+ };
994
+
995
+ /** \ingroup dev
996
+ * Supported speeds (wSpeedSupported) bitfield. Indicates what
997
+ * speeds the device supports.
998
+ */
999
+ enum libusb_supported_speed {
1000
+ /** Low speed operation supported (1.5MBit/s). */
1001
+ LIBUSB_LOW_SPEED_OPERATION = 1,
1002
+
1003
+ /** Full speed operation supported (12MBit/s). */
1004
+ LIBUSB_FULL_SPEED_OPERATION = 2,
1005
+
1006
+ /** High speed operation supported (480MBit/s). */
1007
+ LIBUSB_HIGH_SPEED_OPERATION = 4,
1008
+
1009
+ /** Superspeed operation supported (5000MBit/s). */
1010
+ LIBUSB_SUPER_SPEED_OPERATION = 8,
1011
+ };
1012
+
1013
+ /** \ingroup dev
1014
+ * Masks for the bits of the
1015
+ * \ref libusb_usb_2_0_extension_descriptor::bmAttributes "bmAttributes" field
1016
+ * of the USB 2.0 Extension descriptor.
1017
+ */
1018
+ enum libusb_usb_2_0_extension_attributes {
1019
+ /** Supports Link Power Management (LPM) */
1020
+ LIBUSB_BM_LPM_SUPPORT = 2,
1021
+ };
1022
+
1023
+ /** \ingroup dev
1024
+ * Masks for the bits of the
1025
+ * \ref libusb_ss_usb_device_capability_descriptor::bmAttributes "bmAttributes" field
1026
+ * field of the SuperSpeed USB Device Capability descriptor.
1027
+ */
1028
+ enum libusb_ss_usb_device_capability_attributes {
1029
+ /** Supports Latency Tolerance Messages (LTM) */
1030
+ LIBUSB_BM_LTM_SUPPORT = 2,
1031
+ };
1032
+
1033
+ /** \ingroup dev
1034
+ * USB capability types
1035
+ */
1036
+ enum libusb_bos_type {
1037
+ /** Wireless USB device capability */
1038
+ LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1,
1039
+
1040
+ /** USB 2.0 extensions */
1041
+ LIBUSB_BT_USB_2_0_EXTENSION = 2,
1042
+
1043
+ /** SuperSpeed USB device capability */
1044
+ LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3,
1045
+
1046
+ /** Container ID type */
1047
+ LIBUSB_BT_CONTAINER_ID = 4,
1048
+ };
1049
+
1050
+ /** \ingroup misc
1051
+ * Error codes. Most libusb functions return 0 on success or one of these
1052
+ * codes on failure.
1053
+ * You can call libusb_error_name() to retrieve a string representation of an
1054
+ * error code or libusb_strerror() to get an end-user suitable description of
1055
+ * an error code.
1056
+ */
1057
+ enum libusb_error {
1058
+ /** Success (no error) */
1059
+ LIBUSB_SUCCESS = 0,
1060
+
1061
+ /** Input/output error */
1062
+ LIBUSB_ERROR_IO = -1,
1063
+
1064
+ /** Invalid parameter */
1065
+ LIBUSB_ERROR_INVALID_PARAM = -2,
1066
+
1067
+ /** Access denied (insufficient permissions) */
1068
+ LIBUSB_ERROR_ACCESS = -3,
1069
+
1070
+ /** No such device (it may have been disconnected) */
1071
+ LIBUSB_ERROR_NO_DEVICE = -4,
1072
+
1073
+ /** Entity not found */
1074
+ LIBUSB_ERROR_NOT_FOUND = -5,
1075
+
1076
+ /** Resource busy */
1077
+ LIBUSB_ERROR_BUSY = -6,
1078
+
1079
+ /** Operation timed out */
1080
+ LIBUSB_ERROR_TIMEOUT = -7,
1081
+
1082
+ /** Overflow */
1083
+ LIBUSB_ERROR_OVERFLOW = -8,
1084
+
1085
+ /** Pipe error */
1086
+ LIBUSB_ERROR_PIPE = -9,
1087
+
1088
+ /** System call interrupted (perhaps due to signal) */
1089
+ LIBUSB_ERROR_INTERRUPTED = -10,
1090
+
1091
+ /** Insufficient memory */
1092
+ LIBUSB_ERROR_NO_MEM = -11,
1093
+
1094
+ /** Operation not supported or unimplemented on this platform */
1095
+ LIBUSB_ERROR_NOT_SUPPORTED = -12,
1096
+
1097
+ /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1098
+ message strings in strerror.c when adding new error codes here. */
1099
+
1100
+ /** Other error */
1101
+ LIBUSB_ERROR_OTHER = -99,
1102
+ };
1103
+
1104
+ /* Total number of error codes in enum libusb_error */
1105
+ #define LIBUSB_ERROR_COUNT 14
1106
+
1107
+ /** \ingroup asyncio
1108
+ * Transfer status codes */
1109
+ enum libusb_transfer_status {
1110
+ /** Transfer completed without error. Note that this does not indicate
1111
+ * that the entire amount of requested data was transferred. */
1112
+ LIBUSB_TRANSFER_COMPLETED,
1113
+
1114
+ /** Transfer failed */
1115
+ LIBUSB_TRANSFER_ERROR,
1116
+
1117
+ /** Transfer timed out */
1118
+ LIBUSB_TRANSFER_TIMED_OUT,
1119
+
1120
+ /** Transfer was cancelled */
1121
+ LIBUSB_TRANSFER_CANCELLED,
1122
+
1123
+ /** For bulk/interrupt endpoints: halt condition detected (endpoint
1124
+ * stalled). For control endpoints: control request not supported. */
1125
+ LIBUSB_TRANSFER_STALL,
1126
+
1127
+ /** Device was disconnected */
1128
+ LIBUSB_TRANSFER_NO_DEVICE,
1129
+
1130
+ /** Device sent more data than requested */
1131
+ LIBUSB_TRANSFER_OVERFLOW,
1132
+
1133
+ /* NB! Remember to update libusb_error_name()
1134
+ when adding new status codes here. */
1135
+ };
1136
+
1137
+ /** \ingroup asyncio
1138
+ * libusb_transfer.flags values */
1139
+ enum libusb_transfer_flags {
1140
+ /** Report short frames as errors */
1141
+ LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0,
1142
+
1143
+ /** Automatically free() transfer buffer during libusb_free_transfer() */
1144
+ LIBUSB_TRANSFER_FREE_BUFFER = 1<<1,
1145
+
1146
+ /** Automatically call libusb_free_transfer() after callback returns.
1147
+ * If this flag is set, it is illegal to call libusb_free_transfer()
1148
+ * from your transfer callback, as this will result in a double-free
1149
+ * when this flag is acted upon. */
1150
+ LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2,
1151
+
1152
+ /** Terminate transfers that are a multiple of the endpoint's
1153
+ * wMaxPacketSize with an extra zero length packet. This is useful
1154
+ * when a device protocol mandates that each logical request is
1155
+ * terminated by an incomplete packet (i.e. the logical requests are
1156
+ * not separated by other means).
1157
+ *
1158
+ * This flag only affects host-to-device transfers to bulk and interrupt
1159
+ * endpoints. In other situations, it is ignored.
1160
+ *
1161
+ * This flag only affects transfers with a length that is a multiple of
1162
+ * the endpoint's wMaxPacketSize. On transfers of other lengths, this
1163
+ * flag has no effect. Therefore, if you are working with a device that
1164
+ * needs a ZLP whenever the end of the logical request falls on a packet
1165
+ * boundary, then it is sensible to set this flag on <em>every</em>
1166
+ * transfer (you do not have to worry about only setting it on transfers
1167
+ * that end on the boundary).
1168
+ *
1169
+ * This flag is currently only supported on Linux.
1170
+ * On other systems, libusb_submit_transfer() will return
1171
+ * LIBUSB_ERROR_NOT_SUPPORTED for every transfer where this flag is set.
1172
+ *
1173
+ * Available since libusb-1.0.9.
1174
+ */
1175
+ LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3,
1176
+ };
1177
+
1178
+ /** \ingroup asyncio
1179
+ * Isochronous packet descriptor. */
1180
+ struct libusb_iso_packet_descriptor {
1181
+ /** Length of data to request in this packet */
1182
+ unsigned int length;
1183
+
1184
+ /** Amount of data that was actually transferred */
1185
+ unsigned int actual_length;
1186
+
1187
+ /** Status code for this packet */
1188
+ enum libusb_transfer_status status;
1189
+ };
1190
+
1191
+ struct libusb_transfer;
1192
+
1193
+ /** \ingroup asyncio
1194
+ * Asynchronous transfer callback function type. When submitting asynchronous
1195
+ * transfers, you pass a pointer to a callback function of this type via the
1196
+ * \ref libusb_transfer::callback "callback" member of the libusb_transfer
1197
+ * structure. libusb will call this function later, when the transfer has
1198
+ * completed or failed. See \ref asyncio for more information.
1199
+ * \param transfer The libusb_transfer struct the callback function is being
1200
+ * notified about.
1201
+ */
1202
+ typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1203
+
1204
+ /** \ingroup asyncio
1205
+ * The generic USB transfer structure. The user populates this structure and
1206
+ * then submits it in order to request a transfer. After the transfer has
1207
+ * completed, the library populates the transfer with the results and passes
1208
+ * it back to the user.
1209
+ */
1210
+ struct libusb_transfer {
1211
+ /** Handle of the device that this transfer will be submitted to */
1212
+ libusb_device_handle *dev_handle;
1213
+
1214
+ /** A bitwise OR combination of \ref libusb_transfer_flags. */
1215
+ uint8_t flags;
1216
+
1217
+ /** Address of the endpoint where this transfer will be sent. */
1218
+ unsigned char endpoint;
1219
+
1220
+ /** Type of the endpoint from \ref libusb_transfer_type */
1221
+ unsigned char type;
1222
+
1223
+ /** Timeout for this transfer in millseconds. A value of 0 indicates no
1224
+ * timeout. */
1225
+ unsigned int timeout;
1226
+
1227
+ /** The status of the transfer. Read-only, and only for use within
1228
+ * transfer callback function.
1229
+ *
1230
+ * If this is an isochronous transfer, this field may read COMPLETED even
1231
+ * if there were errors in the frames. Use the
1232
+ * \ref libusb_iso_packet_descriptor::status "status" field in each packet
1233
+ * to determine if errors occurred. */
1234
+ enum libusb_transfer_status status;
1235
+
1236
+ /** Length of the data buffer */
1237
+ int length;
1238
+
1239
+ /** Actual length of data that was transferred. Read-only, and only for
1240
+ * use within transfer callback function. Not valid for isochronous
1241
+ * endpoint transfers. */
1242
+ int actual_length;
1243
+
1244
+ /** Callback function. This will be invoked when the transfer completes,
1245
+ * fails, or is cancelled. */
1246
+ libusb_transfer_cb_fn callback;
1247
+
1248
+ /** User context data to pass to the callback function. */
1249
+ void *user_data;
1250
+
1251
+ /** Data buffer */
1252
+ unsigned char *buffer;
1253
+
1254
+ /** Number of isochronous packets. Only used for I/O with isochronous
1255
+ * endpoints. */
1256
+ int num_iso_packets;
1257
+
1258
+ /** Isochronous packet descriptors, for isochronous transfers only. */
1259
+ struct libusb_iso_packet_descriptor iso_packet_desc
1260
+ #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
1261
+ [] /* valid C99 code */
1262
+ #else
1263
+ [0] /* non-standard, but usually working code */
1264
+ #endif
1265
+ ;
1266
+ };
1267
+
1268
+ /** \ingroup misc
1269
+ * Capabilities supported by an instance of libusb on the current running
1270
+ * platform. Test if the loaded library supports a given capability by calling
1271
+ * \ref libusb_has_capability().
1272
+ */
1273
+ enum libusb_capability {
1274
+ /** The libusb_has_capability() API is available. */
1275
+ LIBUSB_CAP_HAS_CAPABILITY = 0x0000,
1276
+ /** Hotplug support is available on this platform. */
1277
+ LIBUSB_CAP_HAS_HOTPLUG = 0x0001,
1278
+ /** The library can access HID devices without requiring user intervention.
1279
+ * Note that before being able to actually access an HID device, you may
1280
+ * still have to call additional libusb functions such as
1281
+ * \ref libusb_detach_kernel_driver(). */
1282
+ LIBUSB_CAP_HAS_HID_ACCESS = 0x0100,
1283
+ /** The library supports detaching of the default USB driver, using
1284
+ * \ref libusb_detach_kernel_driver(), if one is set by the OS kernel */
1285
+ LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER = 0x0101
1286
+ };
1287
+
1288
+ /** \ingroup lib
1289
+ * Log message levels.
1290
+ * - LIBUSB_LOG_LEVEL_NONE (0) : no messages ever printed by the library (default)
1291
+ * - LIBUSB_LOG_LEVEL_ERROR (1) : error messages are printed to stderr
1292
+ * - LIBUSB_LOG_LEVEL_WARNING (2) : warning and error messages are printed to stderr
1293
+ * - LIBUSB_LOG_LEVEL_INFO (3) : informational messages are printed to stdout, warning
1294
+ * and error messages are printed to stderr
1295
+ * - LIBUSB_LOG_LEVEL_DEBUG (4) : debug and informational messages are printed to stdout,
1296
+ * warnings and errors to stderr
1297
+ */
1298
+ enum libusb_log_level {
1299
+ LIBUSB_LOG_LEVEL_NONE = 0,
1300
+ LIBUSB_LOG_LEVEL_ERROR,
1301
+ LIBUSB_LOG_LEVEL_WARNING,
1302
+ LIBUSB_LOG_LEVEL_INFO,
1303
+ LIBUSB_LOG_LEVEL_DEBUG,
1304
+ };
1305
+
1306
+ int LIBUSB_CALL libusb_init(libusb_context **ctx);
1307
+ void LIBUSB_CALL libusb_exit(libusb_context *ctx);
1308
+ void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1309
+ const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1310
+ int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1311
+ const char * LIBUSB_CALL libusb_error_name(int errcode);
1312
+ int LIBUSB_CALL libusb_setlocale(const char *locale);
1313
+ const char * LIBUSB_CALL libusb_strerror(enum libusb_error errcode);
1314
+
1315
+ ssize_t LIBUSB_CALL libusb_get_device_list(libusb_context *ctx,
1316
+ libusb_device ***list);
1317
+ void LIBUSB_CALL libusb_free_device_list(libusb_device **list,
1318
+ int unref_devices);
1319
+ libusb_device * LIBUSB_CALL libusb_ref_device(libusb_device *dev);
1320
+ void LIBUSB_CALL libusb_unref_device(libusb_device *dev);
1321
+
1322
+ int LIBUSB_CALL libusb_get_configuration(libusb_device_handle *dev,
1323
+ int *config);
1324
+ int LIBUSB_CALL libusb_get_device_descriptor(libusb_device *dev,
1325
+ struct libusb_device_descriptor *desc);
1326
+ int LIBUSB_CALL libusb_get_active_config_descriptor(libusb_device *dev,
1327
+ struct libusb_config_descriptor **config);
1328
+ int LIBUSB_CALL libusb_get_config_descriptor(libusb_device *dev,
1329
+ uint8_t config_index, struct libusb_config_descriptor **config);
1330
+ int LIBUSB_CALL libusb_get_config_descriptor_by_value(libusb_device *dev,
1331
+ uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1332
+ void LIBUSB_CALL libusb_free_config_descriptor(
1333
+ struct libusb_config_descriptor *config);
1334
+ int LIBUSB_CALL libusb_get_ss_endpoint_companion_descriptor(
1335
+ struct libusb_context *ctx,
1336
+ const struct libusb_endpoint_descriptor *endpoint,
1337
+ struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1338
+ void LIBUSB_CALL libusb_free_ss_endpoint_companion_descriptor(
1339
+ struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1340
+ int LIBUSB_CALL libusb_get_bos_descriptor(libusb_device_handle *handle,
1341
+ struct libusb_bos_descriptor **bos);
1342
+ void LIBUSB_CALL libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
1343
+ int LIBUSB_CALL libusb_get_usb_2_0_extension_descriptor(
1344
+ struct libusb_context *ctx,
1345
+ struct libusb_bos_dev_capability_descriptor *dev_cap,
1346
+ struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1347
+ void LIBUSB_CALL libusb_free_usb_2_0_extension_descriptor(
1348
+ struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1349
+ int LIBUSB_CALL libusb_get_ss_usb_device_capability_descriptor(
1350
+ struct libusb_context *ctx,
1351
+ struct libusb_bos_dev_capability_descriptor *dev_cap,
1352
+ struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1353
+ void LIBUSB_CALL libusb_free_ss_usb_device_capability_descriptor(
1354
+ struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1355
+ int LIBUSB_CALL libusb_get_container_id_descriptor(struct libusb_context *ctx,
1356
+ struct libusb_bos_dev_capability_descriptor *dev_cap,
1357
+ struct libusb_container_id_descriptor **container_id);
1358
+ void LIBUSB_CALL libusb_free_container_id_descriptor(
1359
+ struct libusb_container_id_descriptor *container_id);
1360
+ uint8_t LIBUSB_CALL libusb_get_bus_number(libusb_device *dev);
1361
+ uint8_t LIBUSB_CALL libusb_get_port_number(libusb_device *dev);
1362
+ int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t* port_numbers, int port_numbers_len);
1363
+ LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1364
+ int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length);
1365
+ libusb_device * LIBUSB_CALL libusb_get_parent(libusb_device *dev);
1366
+ uint8_t LIBUSB_CALL libusb_get_device_address(libusb_device *dev);
1367
+ int LIBUSB_CALL libusb_get_device_speed(libusb_device *dev);
1368
+ int LIBUSB_CALL libusb_get_max_packet_size(libusb_device *dev,
1369
+ unsigned char endpoint);
1370
+ int LIBUSB_CALL libusb_get_max_iso_packet_size(libusb_device *dev,
1371
+ unsigned char endpoint);
1372
+
1373
+ int LIBUSB_CALL libusb_open(libusb_device *dev, libusb_device_handle **handle);
1374
+ void LIBUSB_CALL libusb_close(libusb_device_handle *dev_handle);
1375
+ libusb_device * LIBUSB_CALL libusb_get_device(libusb_device_handle *dev_handle);
1376
+
1377
+ int LIBUSB_CALL libusb_set_configuration(libusb_device_handle *dev,
1378
+ int configuration);
1379
+ int LIBUSB_CALL libusb_claim_interface(libusb_device_handle *dev,
1380
+ int interface_number);
1381
+ int LIBUSB_CALL libusb_release_interface(libusb_device_handle *dev,
1382
+ int interface_number);
1383
+
1384
+ libusb_device_handle * LIBUSB_CALL libusb_open_device_with_vid_pid(
1385
+ libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1386
+
1387
+ int LIBUSB_CALL libusb_set_interface_alt_setting(libusb_device_handle *dev,
1388
+ int interface_number, int alternate_setting);
1389
+ int LIBUSB_CALL libusb_clear_halt(libusb_device_handle *dev,
1390
+ unsigned char endpoint);
1391
+ int LIBUSB_CALL libusb_reset_device(libusb_device_handle *dev);
1392
+
1393
+ int LIBUSB_CALL libusb_alloc_streams(libusb_device_handle *dev,
1394
+ uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1395
+ int LIBUSB_CALL libusb_free_streams(libusb_device_handle *dev,
1396
+ unsigned char *endpoints, int num_endpoints);
1397
+
1398
+ int LIBUSB_CALL libusb_kernel_driver_active(libusb_device_handle *dev,
1399
+ int interface_number);
1400
+ int LIBUSB_CALL libusb_detach_kernel_driver(libusb_device_handle *dev,
1401
+ int interface_number);
1402
+ int LIBUSB_CALL libusb_attach_kernel_driver(libusb_device_handle *dev,
1403
+ int interface_number);
1404
+ int LIBUSB_CALL libusb_set_auto_detach_kernel_driver(
1405
+ libusb_device_handle *dev, int enable);
1406
+
1407
+ /* async I/O */
1408
+
1409
+ /** \ingroup asyncio
1410
+ * Get the data section of a control transfer. This convenience function is here
1411
+ * to remind you that the data does not start until 8 bytes into the actual
1412
+ * buffer, as the setup packet comes first.
1413
+ *
1414
+ * Calling this function only makes sense from a transfer callback function,
1415
+ * or situations where you have already allocated a suitably sized buffer at
1416
+ * transfer->buffer.
1417
+ *
1418
+ * \param transfer a transfer
1419
+ * \returns pointer to the first byte of the data section
1420
+ */
1421
+ static inline unsigned char *libusb_control_transfer_get_data(
1422
+ struct libusb_transfer *transfer)
1423
+ {
1424
+ return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1425
+ }
1426
+
1427
+ /** \ingroup asyncio
1428
+ * Get the control setup packet of a control transfer. This convenience
1429
+ * function is here to remind you that the control setup occupies the first
1430
+ * 8 bytes of the transfer data buffer.
1431
+ *
1432
+ * Calling this function only makes sense from a transfer callback function,
1433
+ * or situations where you have already allocated a suitably sized buffer at
1434
+ * transfer->buffer.
1435
+ *
1436
+ * \param transfer a transfer
1437
+ * \returns a casted pointer to the start of the transfer data buffer
1438
+ */
1439
+ static inline struct libusb_control_setup *libusb_control_transfer_get_setup(
1440
+ struct libusb_transfer *transfer)
1441
+ {
1442
+ return (struct libusb_control_setup *)(void *) transfer->buffer;
1443
+ }
1444
+
1445
+ /** \ingroup asyncio
1446
+ * Helper function to populate the setup packet (first 8 bytes of the data
1447
+ * buffer) for a control transfer. The wIndex, wValue and wLength values should
1448
+ * be given in host-endian byte order.
1449
+ *
1450
+ * \param buffer buffer to output the setup packet into
1451
+ * This pointer must be aligned to at least 2 bytes boundary.
1452
+ * \param bmRequestType see the
1453
+ * \ref libusb_control_setup::bmRequestType "bmRequestType" field of
1454
+ * \ref libusb_control_setup
1455
+ * \param bRequest see the
1456
+ * \ref libusb_control_setup::bRequest "bRequest" field of
1457
+ * \ref libusb_control_setup
1458
+ * \param wValue see the
1459
+ * \ref libusb_control_setup::wValue "wValue" field of
1460
+ * \ref libusb_control_setup
1461
+ * \param wIndex see the
1462
+ * \ref libusb_control_setup::wIndex "wIndex" field of
1463
+ * \ref libusb_control_setup
1464
+ * \param wLength see the
1465
+ * \ref libusb_control_setup::wLength "wLength" field of
1466
+ * \ref libusb_control_setup
1467
+ */
1468
+ static inline void libusb_fill_control_setup(unsigned char *buffer,
1469
+ uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1470
+ uint16_t wLength)
1471
+ {
1472
+ struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1473
+ setup->bmRequestType = bmRequestType;
1474
+ setup->bRequest = bRequest;
1475
+ setup->wValue = libusb_cpu_to_le16(wValue);
1476
+ setup->wIndex = libusb_cpu_to_le16(wIndex);
1477
+ setup->wLength = libusb_cpu_to_le16(wLength);
1478
+ }
1479
+
1480
+ struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1481
+ int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1482
+ int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1483
+ void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1484
+ void LIBUSB_CALL libusb_transfer_set_stream_id(
1485
+ struct libusb_transfer *transfer, uint32_t stream_id);
1486
+ uint32_t LIBUSB_CALL libusb_transfer_get_stream_id(
1487
+ struct libusb_transfer *transfer);
1488
+
1489
+ /** \ingroup asyncio
1490
+ * Helper function to populate the required \ref libusb_transfer fields
1491
+ * for a control transfer.
1492
+ *
1493
+ * If you pass a transfer buffer to this function, the first 8 bytes will
1494
+ * be interpreted as a control setup packet, and the wLength field will be
1495
+ * used to automatically populate the \ref libusb_transfer::length "length"
1496
+ * field of the transfer. Therefore the recommended approach is:
1497
+ * -# Allocate a suitably sized data buffer (including space for control setup)
1498
+ * -# Call libusb_fill_control_setup()
1499
+ * -# If this is a host-to-device transfer with a data stage, put the data
1500
+ * in place after the setup packet
1501
+ * -# Call this function
1502
+ * -# Call libusb_submit_transfer()
1503
+ *
1504
+ * It is also legal to pass a NULL buffer to this function, in which case this
1505
+ * function will not attempt to populate the length field. Remember that you
1506
+ * must then populate the buffer and length fields later.
1507
+ *
1508
+ * \param transfer the transfer to populate
1509
+ * \param dev_handle handle of the device that will handle the transfer
1510
+ * \param buffer data buffer. If provided, this function will interpret the
1511
+ * first 8 bytes as a setup packet and infer the transfer length from that.
1512
+ * This pointer must be aligned to at least 2 bytes boundary.
1513
+ * \param callback callback function to be invoked on transfer completion
1514
+ * \param user_data user data to pass to callback function
1515
+ * \param timeout timeout for the transfer in milliseconds
1516
+ */
1517
+ static inline void libusb_fill_control_transfer(
1518
+ struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1519
+ unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1520
+ unsigned int timeout)
1521
+ {
1522
+ struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1523
+ transfer->dev_handle = dev_handle;
1524
+ transfer->endpoint = 0;
1525
+ transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1526
+ transfer->timeout = timeout;
1527
+ transfer->buffer = buffer;
1528
+ if (setup)
1529
+ transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1530
+ + libusb_le16_to_cpu(setup->wLength));
1531
+ transfer->user_data = user_data;
1532
+ transfer->callback = callback;
1533
+ }
1534
+
1535
+ /** \ingroup asyncio
1536
+ * Helper function to populate the required \ref libusb_transfer fields
1537
+ * for a bulk transfer.
1538
+ *
1539
+ * \param transfer the transfer to populate
1540
+ * \param dev_handle handle of the device that will handle the transfer
1541
+ * \param endpoint address of the endpoint where this transfer will be sent
1542
+ * \param buffer data buffer
1543
+ * \param length length of data buffer
1544
+ * \param callback callback function to be invoked on transfer completion
1545
+ * \param user_data user data to pass to callback function
1546
+ * \param timeout timeout for the transfer in milliseconds
1547
+ */
1548
+ static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1549
+ libusb_device_handle *dev_handle, unsigned char endpoint,
1550
+ unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1551
+ void *user_data, unsigned int timeout)
1552
+ {
1553
+ transfer->dev_handle = dev_handle;
1554
+ transfer->endpoint = endpoint;
1555
+ transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1556
+ transfer->timeout = timeout;
1557
+ transfer->buffer = buffer;
1558
+ transfer->length = length;
1559
+ transfer->user_data = user_data;
1560
+ transfer->callback = callback;
1561
+ }
1562
+
1563
+ /** \ingroup asyncio
1564
+ * Helper function to populate the required \ref libusb_transfer fields
1565
+ * for a bulk transfer using bulk streams.
1566
+ *
1567
+ * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1568
+ *
1569
+ * \param transfer the transfer to populate
1570
+ * \param dev_handle handle of the device that will handle the transfer
1571
+ * \param endpoint address of the endpoint where this transfer will be sent
1572
+ * \param stream_id bulk stream id for this transfer
1573
+ * \param buffer data buffer
1574
+ * \param length length of data buffer
1575
+ * \param callback callback function to be invoked on transfer completion
1576
+ * \param user_data user data to pass to callback function
1577
+ * \param timeout timeout for the transfer in milliseconds
1578
+ */
1579
+ static inline void libusb_fill_bulk_stream_transfer(
1580
+ struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1581
+ unsigned char endpoint, uint32_t stream_id,
1582
+ unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1583
+ void *user_data, unsigned int timeout)
1584
+ {
1585
+ libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1586
+ length, callback, user_data, timeout);
1587
+ transfer->type = LIBUSB_TRANSFER_TYPE_BULK_STREAM;
1588
+ libusb_transfer_set_stream_id(transfer, stream_id);
1589
+ }
1590
+
1591
+ /** \ingroup asyncio
1592
+ * Helper function to populate the required \ref libusb_transfer fields
1593
+ * for an interrupt transfer.
1594
+ *
1595
+ * \param transfer the transfer to populate
1596
+ * \param dev_handle handle of the device that will handle the transfer
1597
+ * \param endpoint address of the endpoint where this transfer will be sent
1598
+ * \param buffer data buffer
1599
+ * \param length length of data buffer
1600
+ * \param callback callback function to be invoked on transfer completion
1601
+ * \param user_data user data to pass to callback function
1602
+ * \param timeout timeout for the transfer in milliseconds
1603
+ */
1604
+ static inline void libusb_fill_interrupt_transfer(
1605
+ struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1606
+ unsigned char endpoint, unsigned char *buffer, int length,
1607
+ libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1608
+ {
1609
+ transfer->dev_handle = dev_handle;
1610
+ transfer->endpoint = endpoint;
1611
+ transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
1612
+ transfer->timeout = timeout;
1613
+ transfer->buffer = buffer;
1614
+ transfer->length = length;
1615
+ transfer->user_data = user_data;
1616
+ transfer->callback = callback;
1617
+ }
1618
+
1619
+ /** \ingroup asyncio
1620
+ * Helper function to populate the required \ref libusb_transfer fields
1621
+ * for an isochronous transfer.
1622
+ *
1623
+ * \param transfer the transfer to populate
1624
+ * \param dev_handle handle of the device that will handle the transfer
1625
+ * \param endpoint address of the endpoint where this transfer will be sent
1626
+ * \param buffer data buffer
1627
+ * \param length length of data buffer
1628
+ * \param num_iso_packets the number of isochronous packets
1629
+ * \param callback callback function to be invoked on transfer completion
1630
+ * \param user_data user data to pass to callback function
1631
+ * \param timeout timeout for the transfer in milliseconds
1632
+ */
1633
+ static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1634
+ libusb_device_handle *dev_handle, unsigned char endpoint,
1635
+ unsigned char *buffer, int length, int num_iso_packets,
1636
+ libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1637
+ {
1638
+ transfer->dev_handle = dev_handle;
1639
+ transfer->endpoint = endpoint;
1640
+ transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
1641
+ transfer->timeout = timeout;
1642
+ transfer->buffer = buffer;
1643
+ transfer->length = length;
1644
+ transfer->num_iso_packets = num_iso_packets;
1645
+ transfer->user_data = user_data;
1646
+ transfer->callback = callback;
1647
+ }
1648
+
1649
+ /** \ingroup asyncio
1650
+ * Convenience function to set the length of all packets in an isochronous
1651
+ * transfer, based on the num_iso_packets field in the transfer structure.
1652
+ *
1653
+ * \param transfer a transfer
1654
+ * \param length the length to set in each isochronous packet descriptor
1655
+ * \see libusb_get_max_packet_size()
1656
+ */
1657
+ static inline void libusb_set_iso_packet_lengths(
1658
+ struct libusb_transfer *transfer, unsigned int length)
1659
+ {
1660
+ int i;
1661
+ for (i = 0; i < transfer->num_iso_packets; i++)
1662
+ transfer->iso_packet_desc[i].length = length;
1663
+ }
1664
+
1665
+ /** \ingroup asyncio
1666
+ * Convenience function to locate the position of an isochronous packet
1667
+ * within the buffer of an isochronous transfer.
1668
+ *
1669
+ * This is a thorough function which loops through all preceding packets,
1670
+ * accumulating their lengths to find the position of the specified packet.
1671
+ * Typically you will assign equal lengths to each packet in the transfer,
1672
+ * and hence the above method is sub-optimal. You may wish to use
1673
+ * libusb_get_iso_packet_buffer_simple() instead.
1674
+ *
1675
+ * \param transfer a transfer
1676
+ * \param packet the packet to return the address of
1677
+ * \returns the base address of the packet buffer inside the transfer buffer,
1678
+ * or NULL if the packet does not exist.
1679
+ * \see libusb_get_iso_packet_buffer_simple()
1680
+ */
1681
+ static inline unsigned char *libusb_get_iso_packet_buffer(
1682
+ struct libusb_transfer *transfer, unsigned int packet)
1683
+ {
1684
+ int i;
1685
+ size_t offset = 0;
1686
+ int _packet;
1687
+
1688
+ /* oops..slight bug in the API. packet is an unsigned int, but we use
1689
+ * signed integers almost everywhere else. range-check and convert to
1690
+ * signed to avoid compiler warnings. FIXME for libusb-2. */
1691
+ if (packet > INT_MAX)
1692
+ return NULL;
1693
+ _packet = (int) packet;
1694
+
1695
+ if (_packet >= transfer->num_iso_packets)
1696
+ return NULL;
1697
+
1698
+ for (i = 0; i < _packet; i++)
1699
+ offset += transfer->iso_packet_desc[i].length;
1700
+
1701
+ return transfer->buffer + offset;
1702
+ }
1703
+
1704
+ /** \ingroup asyncio
1705
+ * Convenience function to locate the position of an isochronous packet
1706
+ * within the buffer of an isochronous transfer, for transfers where each
1707
+ * packet is of identical size.
1708
+ *
1709
+ * This function relies on the assumption that every packet within the transfer
1710
+ * is of identical size to the first packet. Calculating the location of
1711
+ * the packet buffer is then just a simple calculation:
1712
+ * <tt>buffer + (packet_size * packet)</tt>
1713
+ *
1714
+ * Do not use this function on transfers other than those that have identical
1715
+ * packet lengths for each packet.
1716
+ *
1717
+ * \param transfer a transfer
1718
+ * \param packet the packet to return the address of
1719
+ * \returns the base address of the packet buffer inside the transfer buffer,
1720
+ * or NULL if the packet does not exist.
1721
+ * \see libusb_get_iso_packet_buffer()
1722
+ */
1723
+ static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1724
+ struct libusb_transfer *transfer, unsigned int packet)
1725
+ {
1726
+ int _packet;
1727
+
1728
+ /* oops..slight bug in the API. packet is an unsigned int, but we use
1729
+ * signed integers almost everywhere else. range-check and convert to
1730
+ * signed to avoid compiler warnings. FIXME for libusb-2. */
1731
+ if (packet > INT_MAX)
1732
+ return NULL;
1733
+ _packet = (int) packet;
1734
+
1735
+ if (_packet >= transfer->num_iso_packets)
1736
+ return NULL;
1737
+
1738
+ return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1739
+ }
1740
+
1741
+ /* sync I/O */
1742
+
1743
+ int LIBUSB_CALL libusb_control_transfer(libusb_device_handle *dev_handle,
1744
+ uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1745
+ unsigned char *data, uint16_t wLength, unsigned int timeout);
1746
+
1747
+ int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle,
1748
+ unsigned char endpoint, unsigned char *data, int length,
1749
+ int *actual_length, unsigned int timeout);
1750
+
1751
+ int LIBUSB_CALL libusb_interrupt_transfer(libusb_device_handle *dev_handle,
1752
+ unsigned char endpoint, unsigned char *data, int length,
1753
+ int *actual_length, unsigned int timeout);
1754
+
1755
+ /** \ingroup desc
1756
+ * Retrieve a descriptor from the default control pipe.
1757
+ * This is a convenience function which formulates the appropriate control
1758
+ * message to retrieve the descriptor.
1759
+ *
1760
+ * \param dev a device handle
1761
+ * \param desc_type the descriptor type, see \ref libusb_descriptor_type
1762
+ * \param desc_index the index of the descriptor to retrieve
1763
+ * \param data output buffer for descriptor
1764
+ * \param length size of data buffer
1765
+ * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1766
+ */
1767
+ static inline int libusb_get_descriptor(libusb_device_handle *dev,
1768
+ uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1769
+ {
1770
+ return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
1771
+ LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1772
+ 0, data, (uint16_t) length, 1000);
1773
+ }
1774
+
1775
+ /** \ingroup desc
1776
+ * Retrieve a descriptor from a device.
1777
+ * This is a convenience function which formulates the appropriate control
1778
+ * message to retrieve the descriptor. The string returned is Unicode, as
1779
+ * detailed in the USB specifications.
1780
+ *
1781
+ * \param dev a device handle
1782
+ * \param desc_index the index of the descriptor to retrieve
1783
+ * \param langid the language ID for the string descriptor
1784
+ * \param data output buffer for descriptor
1785
+ * \param length size of data buffer
1786
+ * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1787
+ * \see libusb_get_string_descriptor_ascii()
1788
+ */
1789
+ static inline int libusb_get_string_descriptor(libusb_device_handle *dev,
1790
+ uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1791
+ {
1792
+ return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
1793
+ LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1794
+ langid, data, (uint16_t) length, 1000);
1795
+ }
1796
+
1797
+ int LIBUSB_CALL libusb_get_string_descriptor_ascii(libusb_device_handle *dev,
1798
+ uint8_t desc_index, unsigned char *data, int length);
1799
+
1800
+ /* polling and timeouts */
1801
+
1802
+ int LIBUSB_CALL libusb_try_lock_events(libusb_context *ctx);
1803
+ void LIBUSB_CALL libusb_lock_events(libusb_context *ctx);
1804
+ void LIBUSB_CALL libusb_unlock_events(libusb_context *ctx);
1805
+ int LIBUSB_CALL libusb_event_handling_ok(libusb_context *ctx);
1806
+ int LIBUSB_CALL libusb_event_handler_active(libusb_context *ctx);
1807
+ void LIBUSB_CALL libusb_lock_event_waiters(libusb_context *ctx);
1808
+ void LIBUSB_CALL libusb_unlock_event_waiters(libusb_context *ctx);
1809
+ int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1810
+
1811
+ int LIBUSB_CALL libusb_handle_events_timeout(libusb_context *ctx,
1812
+ struct timeval *tv);
1813
+ int LIBUSB_CALL libusb_handle_events_timeout_completed(libusb_context *ctx,
1814
+ struct timeval *tv, int *completed);
1815
+ int LIBUSB_CALL libusb_handle_events(libusb_context *ctx);
1816
+ int LIBUSB_CALL libusb_handle_events_completed(libusb_context *ctx, int *completed);
1817
+ int LIBUSB_CALL libusb_handle_events_locked(libusb_context *ctx,
1818
+ struct timeval *tv);
1819
+ int LIBUSB_CALL libusb_pollfds_handle_timeouts(libusb_context *ctx);
1820
+ int LIBUSB_CALL libusb_get_next_timeout(libusb_context *ctx,
1821
+ struct timeval *tv);
1822
+
1823
+ /** \ingroup poll
1824
+ * File descriptor for polling
1825
+ */
1826
+ struct libusb_pollfd {
1827
+ /** Numeric file descriptor */
1828
+ int fd;
1829
+
1830
+ /** Event flags to poll for from <poll.h>. POLLIN indicates that you
1831
+ * should monitor this file descriptor for becoming ready to read from,
1832
+ * and POLLOUT indicates that you should monitor this file descriptor for
1833
+ * nonblocking write readiness. */
1834
+ short events;
1835
+ };
1836
+
1837
+ /** \ingroup poll
1838
+ * Callback function, invoked when a new file descriptor should be added
1839
+ * to the set of file descriptors monitored for events.
1840
+ * \param fd the new file descriptor
1841
+ * \param events events to monitor for, see \ref libusb_pollfd for a
1842
+ * description
1843
+ * \param user_data User data pointer specified in
1844
+ * libusb_set_pollfd_notifiers() call
1845
+ * \see libusb_set_pollfd_notifiers()
1846
+ */
1847
+ typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1848
+ void *user_data);
1849
+
1850
+ /** \ingroup poll
1851
+ * Callback function, invoked when a file descriptor should be removed from
1852
+ * the set of file descriptors being monitored for events. After returning
1853
+ * from this callback, do not use that file descriptor again.
1854
+ * \param fd the file descriptor to stop monitoring
1855
+ * \param user_data User data pointer specified in
1856
+ * libusb_set_pollfd_notifiers() call
1857
+ * \see libusb_set_pollfd_notifiers()
1858
+ */
1859
+ typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1860
+
1861
+ const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
1862
+ libusb_context *ctx);
1863
+ void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx,
1864
+ libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1865
+ void *user_data);
1866
+
1867
+ /** \ingroup hotplug
1868
+ * Callback handle.
1869
+ *
1870
+ * Callbacks handles are generated by libusb_hotplug_register_callback()
1871
+ * and can be used to deregister callbacks. Callback handles are unique
1872
+ * per libusb_context and it is safe to call libusb_hotplug_deregister_callback()
1873
+ * on an already deregisted callback.
1874
+ *
1875
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1876
+ *
1877
+ * For more information, see \ref hotplug.
1878
+ */
1879
+ typedef int libusb_hotplug_callback_handle;
1880
+
1881
+ /** \ingroup hotplug
1882
+ *
1883
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1884
+ *
1885
+ * Flags for hotplug events */
1886
+ typedef enum {
1887
+ /** Arm the callback and fire it for all matching currently attached devices. */
1888
+ LIBUSB_HOTPLUG_ENUMERATE = 1,
1889
+ } libusb_hotplug_flag;
1890
+
1891
+ /** \ingroup hotplug
1892
+ *
1893
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1894
+ *
1895
+ * Hotplug events */
1896
+ typedef enum {
1897
+ /** A device has been plugged in and is ready to use */
1898
+ LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 0x01,
1899
+
1900
+ /** A device has left and is no longer available.
1901
+ * It is the user's responsibility to call libusb_close on any handle associated with a disconnected device.
1902
+ * It is safe to call libusb_get_device_descriptor on a device that has left */
1903
+ LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 0x02,
1904
+ } libusb_hotplug_event;
1905
+
1906
+ /** \ingroup hotplug
1907
+ * Wildcard matching for hotplug events */
1908
+ #define LIBUSB_HOTPLUG_MATCH_ANY -1
1909
+
1910
+ /** \ingroup hotplug
1911
+ * Hotplug callback function type. When requesting hotplug event notifications,
1912
+ * you pass a pointer to a callback function of this type.
1913
+ *
1914
+ * This callback may be called by an internal event thread and as such it is
1915
+ * recommended the callback do minimal processing before returning.
1916
+ *
1917
+ * libusb will call this function later, when a matching event had happened on
1918
+ * a matching device. See \ref hotplug for more information.
1919
+ *
1920
+ * It is safe to call either libusb_hotplug_register_callback() or
1921
+ * libusb_hotplug_deregister_callback() from within a callback function.
1922
+ *
1923
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1924
+ *
1925
+ * \param ctx context of this notification
1926
+ * \param device libusb_device this event occurred on
1927
+ * \param event event that occurred
1928
+ * \param user_data user data provided when this callback was registered
1929
+ * \returns bool whether this callback is finished processing events.
1930
+ * returning 1 will cause this callback to be deregistered
1931
+ */
1932
+ typedef int (LIBUSB_CALL *libusb_hotplug_callback_fn)(libusb_context *ctx,
1933
+ libusb_device *device,
1934
+ libusb_hotplug_event event,
1935
+ void *user_data);
1936
+
1937
+ /** \ingroup hotplug
1938
+ * Register a hotplug callback function
1939
+ *
1940
+ * Register a callback with the libusb_context. The callback will fire
1941
+ * when a matching event occurs on a matching device. The callback is
1942
+ * armed until either it is deregistered with libusb_hotplug_deregister_callback()
1943
+ * or the supplied callback returns 1 to indicate it is finished processing events.
1944
+ *
1945
+ * If the \ref LIBUSB_HOTPLUG_ENUMERATE is passed the callback will be
1946
+ * called with a \ref LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED for all devices
1947
+ * already plugged into the machine. Note that libusb modifies its internal
1948
+ * device list from a separate thread, while calling hotplug callbacks from
1949
+ * libusb_handle_events(), so it is possible for a device to already be present
1950
+ * on, or removed from, its internal device list, while the hotplug callbacks
1951
+ * still need to be dispatched. This means that when using \ref
1952
+ * LIBUSB_HOTPLUG_ENUMERATE, your callback may be called twice for the arrival
1953
+ * of the same device, once from libusb_hotplug_register_callback() and once
1954
+ * from libusb_handle_events(); and/or your callback may be called for the
1955
+ * removal of a device for which an arrived call was never made.
1956
+ *
1957
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1958
+ *
1959
+ * \param[in] ctx context to register this callback with
1960
+ * \param[in] events bitwise or of events that will trigger this callback. See \ref
1961
+ * libusb_hotplug_event
1962
+ * \param[in] flags hotplug callback flags. See \ref libusb_hotplug_flag
1963
+ * \param[in] vendor_id the vendor id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1964
+ * \param[in] product_id the product id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1965
+ * \param[in] dev_class the device class to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1966
+ * \param[in] cb_fn the function to be invoked on a matching event/device
1967
+ * \param[in] user_data user data to pass to the callback function
1968
+ * \param[out] handle pointer to store the handle of the allocated callback (can be NULL)
1969
+ * \returns LIBUSB_SUCCESS on success LIBUSB_ERROR code on failure
1970
+ */
1971
+ int LIBUSB_CALL libusb_hotplug_register_callback(libusb_context *ctx,
1972
+ libusb_hotplug_event events,
1973
+ libusb_hotplug_flag flags,
1974
+ int vendor_id, int product_id,
1975
+ int dev_class,
1976
+ libusb_hotplug_callback_fn cb_fn,
1977
+ void *user_data,
1978
+ libusb_hotplug_callback_handle *handle);
1979
+
1980
+ /** \ingroup hotplug
1981
+ * Deregisters a hotplug callback.
1982
+ *
1983
+ * Deregister a callback from a libusb_context. This function is safe to call from within
1984
+ * a hotplug callback.
1985
+ *
1986
+ * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1987
+ *
1988
+ * \param[in] ctx context this callback is registered with
1989
+ * \param[in] handle the handle of the callback to deregister
1990
+ */
1991
+ void LIBUSB_CALL libusb_hotplug_deregister_callback(libusb_context *ctx,
1992
+ libusb_hotplug_callback_handle handle);
1993
+
1994
+ #ifdef __cplusplus
1995
+ }
1996
+ #endif
1997
+
1998
+ #endif