xref: /freebsd/lib/libusb/libusb.h (revision 61e2ffd8168cc0f558ba7effe445573ffe2ad8c3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef __LIBUSB_H__
29 #define	__LIBUSB_H__
30 
31 #ifndef LIBUSB_GLOBAL_INCLUDE_FILE
32 #include <stdint.h>
33 #include <sys/time.h>
34 #include <sys/types.h>
35 #endif
36 
37 #define	LIBUSB_API_VERSION 0x01000102
38 
39 #define	LIBUSB_CALL
40 
41 #ifdef __cplusplus
42 extern	"C" {
43 #endif
44 #if 0
45 }					/* indent fix */
46 
47 #endif
48 
49 /* libusb enums */
50 
51 enum libusb_class_code {
52 	LIBUSB_CLASS_PER_INTERFACE = 0,
53 	LIBUSB_CLASS_AUDIO = 1,
54 	LIBUSB_CLASS_COMM = 2,
55 	LIBUSB_CLASS_HID = 3,
56 	LIBUSB_CLASS_PHYSICAL = 5,
57 	LIBUSB_CLASS_PTP = 6,
58 	LIBUSB_CLASS_IMAGE = 6,
59 	LIBUSB_CLASS_PRINTER = 7,
60 	LIBUSB_CLASS_MASS_STORAGE = 8,
61 	LIBUSB_CLASS_HUB = 9,
62 	LIBUSB_CLASS_DATA = 10,
63 	LIBUSB_CLASS_SMART_CARD = 11,
64 	LIBUSB_CLASS_CONTENT_SECURITY = 13,
65 	LIBUSB_CLASS_VIDEO = 14,
66 	LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15,
67 	LIBUSB_CLASS_AUDIO_VIDEO = 16,
68 	LIBUSB_CLASS_BILLBOARD = 17,
69 	LIBUSB_CLASS_TYPE_C_BRIDGE = 18,
70 	LIBUSB_CLASS_BULK_DISPLAY_PROTOCOL = 19,
71 	LIBUSB_CLASS_MCTP = 20,
72 	LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
73 	LIBUSB_CLASS_WIRELESS = 0xe0,
74 	LIBUSB_CLASS_MISCELLANEOUS = 0xef,
75 	LIBUSB_CLASS_APPLICATION = 0xfe,
76 	LIBUSB_CLASS_VENDOR_SPEC = 0xff,
77 };
78 
79 enum libusb_descriptor_type {
80 	LIBUSB_DT_DEVICE = 0x01,
81 	LIBUSB_DT_CONFIG = 0x02,
82 	LIBUSB_DT_STRING = 0x03,
83 	LIBUSB_DT_INTERFACE = 0x04,
84 	LIBUSB_DT_ENDPOINT = 0x05,
85 	LIBUSB_DT_HID = 0x21,
86 	LIBUSB_DT_REPORT = 0x22,
87 	LIBUSB_DT_PHYSICAL = 0x23,
88 	LIBUSB_DT_HUB = 0x29,
89 	LIBUSB_DT_BOS = 0x0f,
90 	LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
91 	LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
92 };
93 
94 enum libusb_device_capability_type {
95 	LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
96 	LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
97 	LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
98 	LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
99 };
100 
101 #define	LIBUSB_DT_DEVICE_SIZE		18
102 #define	LIBUSB_DT_CONFIG_SIZE		9
103 #define	LIBUSB_DT_INTERFACE_SIZE	9
104 #define	LIBUSB_DT_ENDPOINT_SIZE		7
105 #define	LIBUSB_DT_ENDPOINT_AUDIO_SIZE	9
106 #define	LIBUSB_DT_HUB_NONVAR_SIZE	7
107 #define	LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE	6
108 #define	LIBUSB_DT_BOS_SIZE		5
109 #define	LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE	7
110 #define	LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE	10
111 
112 #define	LIBUSB_BT_USB_2_0_EXTENSION_SIZE	7
113 #define	LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE	10
114 #define	LIBUSB_BT_CONTAINER_ID_SIZE		20
115 #define	LIBUSB_BT_PLATFORM_DESCRIPTOR_MIN_SIZE	20
116 
117 #define	LIBUSB_ENDPOINT_ADDRESS_MASK	0x0f
118 #define	LIBUSB_ENDPOINT_DIR_MASK	0x80
119 
120 enum libusb_endpoint_direction {
121 	LIBUSB_ENDPOINT_IN = 0x80,
122 	LIBUSB_ENDPOINT_OUT = 0x00,
123 };
124 
125 #define	LIBUSB_TRANSFER_TYPE_MASK	0x03
126 
127 enum libusb_endpoint_transfer_type {
128 	LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL = 0,
129 	LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS = 1,
130 	LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK = 2,
131 	LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT = 3,
132 };
133 
134 enum libusb_transfer_type {
135 	LIBUSB_TRANSFER_TYPE_CONTROL = 0,
136 	LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
137 	LIBUSB_TRANSFER_TYPE_BULK = 2,
138 	LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
139 	LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,
140 };
141 
142 enum libusb_standard_request {
143 	LIBUSB_REQUEST_GET_STATUS = 0x00,
144 	LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
145 	LIBUSB_REQUEST_SET_FEATURE = 0x03,
146 	LIBUSB_REQUEST_SET_ADDRESS = 0x05,
147 	LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
148 	LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
149 	LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
150 	LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
151 	LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
152 	LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
153 	LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
154 	LIBUSB_REQUEST_SET_SEL = 0x30,
155 	LIBUSB_REQUEST_SET_ISOCH_DELAY = 0x31,
156 };
157 
158 enum libusb_request_type {
159 	LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
160 	LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
161 	LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
162 	LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
163 };
164 
165 enum libusb_request_recipient {
166 	LIBUSB_RECIPIENT_DEVICE = 0x00,
167 	LIBUSB_RECIPIENT_INTERFACE = 0x01,
168 	LIBUSB_RECIPIENT_ENDPOINT = 0x02,
169 	LIBUSB_RECIPIENT_OTHER = 0x03,
170 };
171 
172 #define	LIBUSB_ISO_SYNC_TYPE_MASK	0x0C
173 
174 enum libusb_iso_sync_type {
175 	LIBUSB_ISO_SYNC_TYPE_NONE = 0,
176 	LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
177 	LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
178 	LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
179 };
180 
181 #define	LIBUSB_ISO_USAGE_TYPE_MASK 0x30
182 
183 enum libusb_iso_usage_type {
184 	LIBUSB_ISO_USAGE_TYPE_DATA = 0,
185 	LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
186 	LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
187 };
188 
189 enum libusb_usb_2_0_extension_attributes {
190 	LIBUSB_BM_LPM_SUPPORT = 0x2,
191 };
192 
193 enum libusb_supported_speed {
194 	LIBUSB_LOW_SPEED_OPERATION = (1 << 0),
195 	LIBUSB_FULL_SPEED_OPERATION = (1 << 1),
196 	LIBUSB_HIGH_SPEED_OPERATION = (1 << 2),
197 	LIBUSB_SUPER_SPEED_OPERATION = (1 << 3),
198 };
199 
200 enum libusb_bos_type {
201 	LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1,
202 	LIBUSB_BT_USB_2_0_EXTENSION = 2,
203 	LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3,
204 	LIBUSB_BT_CONTAINER_ID = 4,
205 	LIBUSB_BT_PLATFORM_DESCRIPTOR = 5,
206 };
207 
208 enum libusb_capability {
209 	/* libusb supports libusb_has_capability(). */
210 	LIBUSB_CAP_HAS_CAPABILITY = 0,
211 	/* Hotplug support is available. */
212 	LIBUSB_CAP_HAS_HOTPLUG,
213 	/* Can access HID devices without requiring user intervention. */
214 	LIBUSB_CAP_HAS_HID_ACCESS,
215 
216 	/*
217 	 * Supports detaching and attaching of the default USB driver with
218 	 * libusb_detach_kernel_driver() and libusb_attach_kernel_driver().
219 	 */
220 	LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER,
221 };
222 
223 enum libusb_error {
224 	LIBUSB_SUCCESS = 0,
225 	LIBUSB_ERROR_IO = -1,
226 	LIBUSB_ERROR_INVALID_PARAM = -2,
227 	LIBUSB_ERROR_ACCESS = -3,
228 	LIBUSB_ERROR_NO_DEVICE = -4,
229 	LIBUSB_ERROR_NOT_FOUND = -5,
230 	LIBUSB_ERROR_BUSY = -6,
231 	LIBUSB_ERROR_TIMEOUT = -7,
232 	LIBUSB_ERROR_OVERFLOW = -8,
233 	LIBUSB_ERROR_PIPE = -9,
234 	LIBUSB_ERROR_INTERRUPTED = -10,
235 	LIBUSB_ERROR_NO_MEM = -11,
236 	LIBUSB_ERROR_NOT_SUPPORTED = -12,
237 	LIBUSB_ERROR_OTHER = -99,
238 };
239 
240 #define	LIBUSB_ERROR_COUNT 14
241 
242 enum libusb_speed {
243 	LIBUSB_SPEED_UNKNOWN = 0,
244 	LIBUSB_SPEED_LOW = 1,
245 	LIBUSB_SPEED_FULL = 2,
246 	LIBUSB_SPEED_HIGH = 3,
247 	LIBUSB_SPEED_SUPER = 4,
248 	LIBUSB_SPEED_SUPER_PLUS = 5,
249 };
250 
251 enum libusb_transfer_status {
252 	LIBUSB_TRANSFER_COMPLETED,
253 	LIBUSB_TRANSFER_ERROR,
254 	LIBUSB_TRANSFER_TIMED_OUT,
255 	LIBUSB_TRANSFER_CANCELLED,
256 	LIBUSB_TRANSFER_STALL,
257 	LIBUSB_TRANSFER_NO_DEVICE,
258 	LIBUSB_TRANSFER_OVERFLOW,
259 };
260 
261 enum libusb_transfer_flags {
262 	LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
263 	LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
264 	LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
265 };
266 
267 enum libusb_log_level {
268        LIBUSB_LOG_LEVEL_NONE = 0,
269        LIBUSB_LOG_LEVEL_ERROR,
270        LIBUSB_LOG_LEVEL_WARNING,
271        LIBUSB_LOG_LEVEL_INFO,
272        LIBUSB_LOG_LEVEL_DEBUG
273 };
274 
275 #define	LIBUSB_HOTPLUG_MATCH_ANY -1
276 
277 typedef enum {
278 	LIBUSB_HOTPLUG_NO_FLAGS = 0,
279 	LIBUSB_HOTPLUG_ENUMERATE = 1 << 0,
280 } libusb_hotplug_flag;
281 
282 typedef enum {
283 	LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 1,
284 	LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 2,
285 } libusb_hotplug_event;
286 
287 enum libusb_option {
288 	LIBUSB_OPTION_LOG_LEVEL = 0,
289 	LIBUSB_OPTION_USE_USBDK = 1,
290 	LIBUSB_OPTION_NO_DEVICE_DISCOVERY = 2,
291 	LIBUSB_OPTION_WEAK_AUTHORITY = 2,
292 	LIBUSB_OPTION_MAX = 3,
293 };
294 
295 /* libusb structures */
296 
297 struct libusb_context;
298 struct libusb_device;
299 struct libusb_transfer;
300 struct libusb_device_handle;
301 struct libusb_hotplug_callback_handle_struct;
302 
303 struct libusb_pollfd {
304 	int	fd;
305 	short	events;
306 };
307 
308 struct libusb_version {
309 	const uint16_t major;
310 	const uint16_t minor;
311 	const uint16_t micro;
312 	const uint16_t nano;
313 	const char *rc;
314 	const char *describe;
315 };
316 
317 struct libusb_init_option {
318 	enum libusb_option option;
319 	union {
320 		int64_t ival;
321 	} value;
322 };
323 
324 typedef struct libusb_context libusb_context;
325 typedef struct libusb_device libusb_device;
326 typedef struct libusb_device_handle libusb_device_handle;
327 typedef struct libusb_pollfd libusb_pollfd;
328 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
329 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
330 typedef struct libusb_hotplug_callback_handle_struct *libusb_hotplug_callback_handle;
331 
332 typedef struct libusb_device_descriptor {
333 	uint8_t	bLength;
334 	uint8_t	bDescriptorType;
335 	uint16_t bcdUSB;
336 	uint8_t	bDeviceClass;
337 	uint8_t	bDeviceSubClass;
338 	uint8_t	bDeviceProtocol;
339 	uint8_t	bMaxPacketSize0;
340 	uint16_t idVendor;
341 	uint16_t idProduct;
342 	uint16_t bcdDevice;
343 	uint8_t	iManufacturer;
344 	uint8_t	iProduct;
345 	uint8_t	iSerialNumber;
346 	uint8_t	bNumConfigurations;
347 }	libusb_device_descriptor;
348 
349 typedef struct libusb_endpoint_descriptor {
350 	uint8_t	bLength;
351 	uint8_t	bDescriptorType;
352 	uint8_t	bEndpointAddress;
353 	uint8_t	bmAttributes;
354 	uint16_t wMaxPacketSize;
355 	uint8_t	bInterval;
356 	uint8_t	bRefresh;
357 	uint8_t	bSynchAddress;
358 	uint8_t *extra;
359 	int	extra_length;
360 }	libusb_endpoint_descriptor __aligned(sizeof(void *));
361 
362 typedef struct libusb_ss_endpoint_companion_descriptor {
363 	uint8_t bLength;
364 	uint8_t bDescriptorType;
365 	uint8_t bMaxBurst;
366 	uint8_t bmAttributes;
367 	uint16_t wBytesPerInterval;
368 }	libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
369 
370 typedef struct libusb_interface_descriptor {
371 	uint8_t	bLength;
372 	uint8_t	bDescriptorType;
373 	uint8_t	bInterfaceNumber;
374 	uint8_t	bAlternateSetting;
375 	uint8_t	bNumEndpoints;
376 	uint8_t	bInterfaceClass;
377 	uint8_t	bInterfaceSubClass;
378 	uint8_t	bInterfaceProtocol;
379 	uint8_t	iInterface;
380 	struct libusb_endpoint_descriptor *endpoint;
381 	uint8_t *extra;
382 	int	extra_length;
383 }	libusb_interface_descriptor __aligned(sizeof(void *));
384 
385 typedef struct libusb_interface {
386 	struct libusb_interface_descriptor *altsetting;
387 	int	num_altsetting;
388 }	libusb_interface __aligned(sizeof(void *));
389 
390 typedef struct libusb_config_descriptor {
391 	uint8_t	bLength;
392 	uint8_t	bDescriptorType;
393 	uint16_t wTotalLength;
394 	uint8_t	bNumInterfaces;
395 	uint8_t	bConfigurationValue;
396 	uint8_t	iConfiguration;
397 	uint8_t	bmAttributes;
398 	uint8_t	MaxPower;
399 	struct libusb_interface *interface;
400 	uint8_t *extra;
401 	int	extra_length;
402 }	libusb_config_descriptor __aligned(sizeof(void *));
403 
404 typedef struct libusb_usb_2_0_device_capability_descriptor {
405 	uint8_t bLength;
406 	uint8_t bDescriptorType;
407 	uint8_t bDevCapabilityType;
408 	uint32_t bmAttributes;
409 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT  (1 << 1)
410 }	libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
411 
412 typedef struct libusb_ss_usb_device_capability_descriptor {
413 	uint8_t bLength;
414 	uint8_t bDescriptorType;
415 	uint8_t bDevCapabilityType;
416 	uint8_t bmAttributes;
417 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT   (1 << 1)
418 	uint16_t wSpeedSupported;
419 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION  (1)
420 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
421 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
422 #define LIBUSB_CAPABILITY_5GBPS_OPERATION      (1 << 3)
423 	uint8_t bFunctionalitySupport;
424 	uint8_t bU1DevExitLat;
425 	uint16_t wU2DevExitLat;
426 }	libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
427 
428 typedef struct libusb_bos_dev_capability_descriptor {
429 	uint8_t bLength;
430 	uint8_t bDescriptorType;
431 	uint8_t bDevCapabilityType;
432 	uint8_t dev_capability_data[0];
433 }	libusb_bos_dev_capability_descriptor __aligned(sizeof(void *));
434 
435 typedef struct libusb_bos_descriptor {
436 	uint8_t bLength;
437 	uint8_t bDescriptorType;
438 	uint16_t wTotalLength;
439 #ifndef bNumDeviceCapabilities
440 #define bNumDeviceCapabilities bNumDeviceCaps
441 #endif
442 	uint8_t bNumDeviceCaps;
443 	struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
444 	struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
445 	struct libusb_bos_dev_capability_descriptor **dev_capability;
446 }	libusb_bos_descriptor __aligned(sizeof(void *));
447 
448 typedef struct libusb_usb_2_0_extension_descriptor {
449 	uint8_t bLength;
450 	uint8_t bDescriptorType;
451 	uint8_t bDevCapabilityType;
452 	uint32_t bmAttributes;
453 }	libusb_usb_2_0_extension_descriptor __aligned(sizeof(void *));
454 
455 typedef struct libusb_container_id_descriptor {
456 	uint8_t bLength;
457 	uint8_t bDescriptorType;
458 	uint8_t bDevCapabilityType;
459 	uint8_t	bReserved;
460 	uint8_t ContainerID[16];
461 }	libusb_container_id_descriptor __aligned(sizeof(void *));
462 
463 typedef struct libusb_platform_descriptor {
464 	uint8_t bLength;
465 	uint8_t bDescriptorType;
466 	uint8_t bDevCapabilityType;
467 	uint8_t bReserved;
468 	uint8_t PlatformCapabilityUUID[16];
469 	uint8_t CapabilityData[];
470 }	libusb_platform_descriptor __aligned(sizeof(void *));
471 
472 typedef struct libusb_control_setup {
473 	uint8_t	bmRequestType;
474 	uint8_t	bRequest;
475 	uint16_t wValue;
476 	uint16_t wIndex;
477 	uint16_t wLength;
478 }	libusb_control_setup;
479 
480 #define	LIBUSB_CONTROL_SETUP_SIZE	8	/* bytes */
481 
482 typedef struct libusb_iso_packet_descriptor {
483 	uint32_t length;
484 	uint32_t actual_length;
485 	enum libusb_transfer_status status;
486 }	libusb_iso_packet_descriptor __aligned(sizeof(void *));
487 
488 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
489 
490 typedef struct libusb_transfer {
491 	libusb_device_handle *dev_handle;
492 	uint8_t	flags;
493 	uint8_t endpoint;
494 	uint8_t type;
495 	uint32_t timeout;
496 	enum libusb_transfer_status status;
497 	int	length;
498 	int	actual_length;
499 	libusb_transfer_cb_fn callback;
500 	void   *user_data;
501 	uint8_t *buffer;
502 	int	num_iso_packets;
503 	struct libusb_iso_packet_descriptor iso_packet_desc[0];
504 }	libusb_transfer __aligned(sizeof(void *));
505 
506 /* Library initialisation */
507 
508 void	libusb_set_debug(libusb_context * ctx, int level);
509 const struct libusb_version *libusb_get_version(void);
510 const char *libusb_strerror(int code);
511 const char *libusb_error_name(int code);
512 int	libusb_init(libusb_context ** context);
513 int	libusb_init_context(libusb_context **, const struct libusb_init_option [], int num_options);
514 void	libusb_exit(struct libusb_context *ctx);
515 int	libusb_has_capability(uint32_t capability);
516 int	libusb_setlocale(const char *locale);
517 
518 /* Device handling and enumeration */
519 
520 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
521 void	libusb_free_device_list(libusb_device ** list, int unref_devices);
522 uint8_t	libusb_get_bus_number(libusb_device * dev);
523 uint8_t	libusb_get_port_number(libusb_device * dev);
524 int	libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
525 int	libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
526 uint8_t	libusb_get_device_address(libusb_device * dev);
527 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
528 int	libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
529 int	libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
530 int	libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint);
531 libusb_device *libusb_ref_device(libusb_device * dev);
532 void	libusb_unref_device(libusb_device * dev);
533 int	libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
534 int	libusb_open(libusb_device * dev, libusb_device_handle ** devh);
535 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
536 void	libusb_close(libusb_device_handle * devh);
537 libusb_device *libusb_get_device(libusb_device_handle * devh);
538 libusb_device *libusb_get_parent(libusb_device * dev);
539 int	libusb_get_configuration(libusb_device_handle * devh, int *config);
540 int	libusb_set_configuration(libusb_device_handle * devh, int configuration);
541 int	libusb_claim_interface(libusb_device_handle * devh, int interface_number);
542 int	libusb_release_interface(libusb_device_handle * devh, int interface_number);
543 int	libusb_reset_device(libusb_device_handle * devh);
544 int	libusb_check_connected(libusb_device_handle * devh);
545 int 	libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
546 int	libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
547 int	libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
548 int 	libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
549 int 	libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
550 int 	libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
551 int	libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable);
552 int	libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
553 unsigned char *libusb_dev_mem_alloc(libusb_device_handle *devh);
554 int	libusb_dev_mem_free(libusb_device_handle *devh, unsigned char *buffer,
555     size_t size);
556 
557 /* USB Descriptors */
558 
559 int	libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
560 int	libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
561 int	libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
562 int	libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
563 void	libusb_free_config_descriptor(struct libusb_config_descriptor *config);
564 int	libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
565 void	libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
566 int	libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
567 int	libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
568 int	libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
569 int	libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
570 void	libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
571 int	libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
572 void	libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
573 int	libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos);
574 int	libusb_get_usb_2_0_extension_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
575 void	libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
576 int	libusb_get_ss_usb_device_capability_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_capability);
577 void	libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability);
578 int	libusb_get_container_id_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id);
579 void	libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id);
580 int	libusb_get_platform_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_platform_descriptor **platform_descriptor);
581 void	libusb_free_platform_descriptor(struct libusb_platform_descriptor *platform_descriptor);
582 
583 /* Asynchronous device I/O */
584 
585 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
586 void	libusb_free_transfer(struct libusb_transfer *transfer);
587 int	libusb_submit_transfer(struct libusb_transfer *transfer);
588 int	libusb_cancel_transfer(struct libusb_transfer *transfer);
589 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
590 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
591 void	libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
592 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
593 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
594 void	libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
595 void	libusb_fill_control_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t *buf, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout);
596 void	libusb_fill_bulk_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout);
597 void	libusb_fill_bulk_stream_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, uint32_t stream_id, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout);
598 void	libusb_fill_interrupt_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout);
599 void	libusb_fill_iso_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, int npacket, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout);
600 
601 /* Polling and timing */
602 
603 int	libusb_try_lock_events(libusb_context * ctx);
604 void	libusb_lock_events(libusb_context * ctx);
605 void	libusb_unlock_events(libusb_context * ctx);
606 int	libusb_event_handling_ok(libusb_context * ctx);
607 int	libusb_event_handler_active(libusb_context * ctx);
608 void	libusb_interrupt_event_handler(libusb_context *ctx);
609 void	libusb_lock_event_waiters(libusb_context * ctx);
610 void	libusb_unlock_event_waiters(libusb_context * ctx);
611 int	libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
612 int	libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
613 int	libusb_handle_events_completed(libusb_context * ctx, int *completed);
614 int	libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
615 int	libusb_handle_events(libusb_context * ctx);
616 int	libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
617 int	libusb_pollfds_handle_timeouts(libusb_context *ctx);
618 int	libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
619 void	libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
620 const struct libusb_pollfd **libusb_get_pollfds(libusb_context *ctx);
621 void    libusb_free_pollfds(const struct libusb_pollfd **pollfds);
622 
623 /* Synchronous device I/O */
624 
625 int	libusb_control_transfer(libusb_device_handle * devh, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint8_t *data, uint16_t wLength, uint32_t timeout);
626 int	libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
627 int	libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
628 
629 /* Byte-order */
630 
631 uint16_t libusb_cpu_to_le16(uint16_t x);
632 uint16_t libusb_le16_to_cpu(uint16_t x);
633 
634 /* Hotplug support */
635 
636 typedef int (*libusb_hotplug_callback_fn)(libusb_context *ctx,
637     libusb_device *device, libusb_hotplug_event event, void *user_data);
638 
639 int	libusb_hotplug_register_callback(libusb_context *ctx, libusb_hotplug_event events, libusb_hotplug_flag flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *handle);
640 void	libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle);
641 void   *libusb_hotplug_get_user_data(struct libusb_context *ctx,
642     libusb_hotplug_callback_handle callback_handle);
643 
644 /* Streams support */
645 
646 int	libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
647 int	libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints);
648 void	libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id);
649 uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer);
650 
651 #if 0
652 {					/* indent fix */
653 #endif
654 #ifdef __cplusplus
655 }
656 
657 #endif
658 
659 #endif					/* __LIBUSB_H__ */
660