xref: /freebsd/lib/libusb/libusb.h (revision d15f2551b25f79ddcbe289faa95e655100b952da)
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_INTERFACE_ASSOCIATION = 0x0b,
86 	LIBUSB_DT_HID = 0x21,
87 	LIBUSB_DT_REPORT = 0x22,
88 	LIBUSB_DT_PHYSICAL = 0x23,
89 	LIBUSB_DT_HUB = 0x29,
90 	LIBUSB_DT_BOS = 0x0f,
91 	LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
92 	LIBUSB_DT_SUPERSPEED_HUB = 0x2a,
93 	LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
94 };
95 
96 enum libusb_device_capability_type {
97 	LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
98 	LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
99 	LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
100 	LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
101 };
102 
103 #define	LIBUSB_DT_DEVICE_SIZE		18
104 #define	LIBUSB_DT_CONFIG_SIZE		9
105 #define	LIBUSB_DT_INTERFACE_SIZE	9
106 #define	LIBUSB_DT_ENDPOINT_SIZE		7
107 #define	LIBUSB_DT_ENDPOINT_AUDIO_SIZE	9
108 #define	LIBUSB_DT_HUB_NONVAR_SIZE	7
109 #define	LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE	6
110 #define	LIBUSB_DT_BOS_SIZE		5
111 #define	LIBUSB_DT_INTERFACE_ASSOCIATION_SIZE		8
112 #define	LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE	7
113 #define	LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE	10
114 
115 #define	LIBUSB_BT_USB_2_0_EXTENSION_SIZE	7
116 #define	LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE	10
117 #define	LIBUSB_BT_CONTAINER_ID_SIZE		20
118 #define	LIBUSB_BT_PLATFORM_DESCRIPTOR_MIN_SIZE	20
119 
120 #define	LIBUSB_ENDPOINT_ADDRESS_MASK	0x0f
121 #define	LIBUSB_ENDPOINT_DIR_MASK	0x80
122 
123 enum libusb_endpoint_direction {
124 	LIBUSB_ENDPOINT_IN = 0x80,
125 	LIBUSB_ENDPOINT_OUT = 0x00,
126 };
127 
128 #define	LIBUSB_TRANSFER_TYPE_MASK	0x03
129 
130 enum libusb_endpoint_transfer_type {
131 	LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL = 0,
132 	LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS = 1,
133 	LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK = 2,
134 	LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT = 3,
135 };
136 
137 enum libusb_transfer_type {
138 	LIBUSB_TRANSFER_TYPE_CONTROL = 0,
139 	LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
140 	LIBUSB_TRANSFER_TYPE_BULK = 2,
141 	LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
142 	LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,
143 };
144 
145 enum libusb_standard_request {
146 	LIBUSB_REQUEST_GET_STATUS = 0x00,
147 	LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
148 	LIBUSB_REQUEST_SET_FEATURE = 0x03,
149 	LIBUSB_REQUEST_SET_ADDRESS = 0x05,
150 	LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
151 	LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
152 	LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
153 	LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
154 	LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
155 	LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
156 	LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
157 	LIBUSB_REQUEST_SET_SEL = 0x30,
158 	LIBUSB_REQUEST_SET_ISOCH_DELAY = 0x31,
159 };
160 
161 enum libusb_request_type {
162 	LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
163 	LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
164 	LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
165 	LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
166 };
167 
168 enum libusb_request_recipient {
169 	LIBUSB_RECIPIENT_DEVICE = 0x00,
170 	LIBUSB_RECIPIENT_INTERFACE = 0x01,
171 	LIBUSB_RECIPIENT_ENDPOINT = 0x02,
172 	LIBUSB_RECIPIENT_OTHER = 0x03,
173 };
174 
175 #define	LIBUSB_ISO_SYNC_TYPE_MASK	0x0C
176 
177 enum libusb_iso_sync_type {
178 	LIBUSB_ISO_SYNC_TYPE_NONE = 0,
179 	LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
180 	LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
181 	LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
182 };
183 
184 #define	LIBUSB_ISO_USAGE_TYPE_MASK 0x30
185 
186 enum libusb_iso_usage_type {
187 	LIBUSB_ISO_USAGE_TYPE_DATA = 0,
188 	LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
189 	LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
190 };
191 
192 enum libusb_usb_2_0_extension_attributes {
193 	LIBUSB_BM_LPM_SUPPORT = 0x2,
194 };
195 
196 enum libusb_supported_speed {
197 	LIBUSB_LOW_SPEED_OPERATION = (1 << 0),
198 	LIBUSB_FULL_SPEED_OPERATION = (1 << 1),
199 	LIBUSB_HIGH_SPEED_OPERATION = (1 << 2),
200 	LIBUSB_SUPER_SPEED_OPERATION = (1 << 3),
201 };
202 
203 enum libusb_bos_type {
204 	LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1,
205 	LIBUSB_BT_USB_2_0_EXTENSION = 2,
206 	LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3,
207 	LIBUSB_BT_CONTAINER_ID = 4,
208 	LIBUSB_BT_PLATFORM_DESCRIPTOR = 5,
209 };
210 
211 enum libusb_capability {
212 	/* libusb supports libusb_has_capability(). */
213 	LIBUSB_CAP_HAS_CAPABILITY = 0,
214 	/* Hotplug support is available. */
215 	LIBUSB_CAP_HAS_HOTPLUG,
216 	/* Can access HID devices without requiring user intervention. */
217 	LIBUSB_CAP_HAS_HID_ACCESS,
218 
219 	/*
220 	 * Supports detaching and attaching of the default USB driver with
221 	 * libusb_detach_kernel_driver() and libusb_attach_kernel_driver().
222 	 */
223 	LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER,
224 };
225 
226 enum libusb_error {
227 	LIBUSB_SUCCESS = 0,
228 	LIBUSB_ERROR_IO = -1,
229 	LIBUSB_ERROR_INVALID_PARAM = -2,
230 	LIBUSB_ERROR_ACCESS = -3,
231 	LIBUSB_ERROR_NO_DEVICE = -4,
232 	LIBUSB_ERROR_NOT_FOUND = -5,
233 	LIBUSB_ERROR_BUSY = -6,
234 	LIBUSB_ERROR_TIMEOUT = -7,
235 	LIBUSB_ERROR_OVERFLOW = -8,
236 	LIBUSB_ERROR_PIPE = -9,
237 	LIBUSB_ERROR_INTERRUPTED = -10,
238 	LIBUSB_ERROR_NO_MEM = -11,
239 	LIBUSB_ERROR_NOT_SUPPORTED = -12,
240 	LIBUSB_ERROR_OTHER = -99,
241 };
242 
243 #define	LIBUSB_ERROR_COUNT 14
244 
245 enum libusb_speed {
246 	LIBUSB_SPEED_UNKNOWN = 0,
247 	LIBUSB_SPEED_LOW = 1,
248 	LIBUSB_SPEED_FULL = 2,
249 	LIBUSB_SPEED_HIGH = 3,
250 	LIBUSB_SPEED_SUPER = 4,
251 	LIBUSB_SPEED_SUPER_PLUS = 5,
252 };
253 
254 enum libusb_transfer_status {
255 	LIBUSB_TRANSFER_COMPLETED,
256 	LIBUSB_TRANSFER_ERROR,
257 	LIBUSB_TRANSFER_TIMED_OUT,
258 	LIBUSB_TRANSFER_CANCELLED,
259 	LIBUSB_TRANSFER_STALL,
260 	LIBUSB_TRANSFER_NO_DEVICE,
261 	LIBUSB_TRANSFER_OVERFLOW,
262 };
263 
264 enum libusb_transfer_flags {
265 	LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
266 	LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
267 	LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
268 	LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3,
269 };
270 
271 enum libusb_log_level {
272        LIBUSB_LOG_LEVEL_NONE = 0,
273        LIBUSB_LOG_LEVEL_ERROR,
274        LIBUSB_LOG_LEVEL_WARNING,
275        LIBUSB_LOG_LEVEL_INFO,
276        LIBUSB_LOG_LEVEL_DEBUG
277 };
278 
279 #define	LIBUSB_HOTPLUG_MATCH_ANY -1
280 
281 typedef enum {
282 	LIBUSB_HOTPLUG_NO_FLAGS = 0,
283 	LIBUSB_HOTPLUG_ENUMERATE = 1 << 0,
284 } libusb_hotplug_flag;
285 
286 typedef enum {
287 	LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 1,
288 	LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 2,
289 } libusb_hotplug_event;
290 
291 enum libusb_option {
292 	LIBUSB_OPTION_LOG_LEVEL = 0,
293 	LIBUSB_OPTION_USE_USBDK = 1,
294 	LIBUSB_OPTION_NO_DEVICE_DISCOVERY = 2,
295 	LIBUSB_OPTION_WEAK_AUTHORITY = 2,
296 	LIBUSB_OPTION_LOG_CB = 3,
297 	LIBUSB_OPTION_MAX = 4,
298 };
299 
300 enum libusb_log_cb_mode {
301 	LIBUSB_LOG_CB_GLOBAL = (1 << 0),
302 	LIBUSB_LOG_CB_CONTEXT = (1 << 1),
303 };
304 
305 /* libusb structures */
306 
307 struct libusb_context;
308 struct libusb_device;
309 struct libusb_transfer;
310 struct libusb_device_handle;
311 struct libusb_hotplug_callback_handle_struct;
312 
313 struct libusb_pollfd {
314 	int	fd;
315 	short	events;
316 };
317 
318 struct libusb_version {
319 	const uint16_t major;
320 	const uint16_t minor;
321 	const uint16_t micro;
322 	const uint16_t nano;
323 	const char *rc;
324 	const char *describe;
325 };
326 
327 typedef struct libusb_context libusb_context;
328 typedef void (*libusb_log_cb)(libusb_context *ctx, enum libusb_log_level,
329     const char *str);
330 
331 struct libusb_init_option {
332 	enum libusb_option option;
333 	union {
334 		int64_t ival;
335 		libusb_log_cb log_cbval;
336 	} value;
337 };
338 
339 typedef struct libusb_device libusb_device;
340 typedef struct libusb_device_handle libusb_device_handle;
341 typedef struct libusb_pollfd libusb_pollfd;
342 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
343 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
344 typedef struct libusb_hotplug_callback_handle_struct *libusb_hotplug_callback_handle;
345 
346 typedef struct libusb_device_descriptor {
347 	uint8_t	bLength;
348 	uint8_t	bDescriptorType;
349 	uint16_t bcdUSB;
350 	uint8_t	bDeviceClass;
351 	uint8_t	bDeviceSubClass;
352 	uint8_t	bDeviceProtocol;
353 	uint8_t	bMaxPacketSize0;
354 	uint16_t idVendor;
355 	uint16_t idProduct;
356 	uint16_t bcdDevice;
357 	uint8_t	iManufacturer;
358 	uint8_t	iProduct;
359 	uint8_t	iSerialNumber;
360 	uint8_t	bNumConfigurations;
361 }	libusb_device_descriptor;
362 
363 typedef struct libusb_endpoint_descriptor {
364 	uint8_t	bLength;
365 	uint8_t	bDescriptorType;
366 	uint8_t	bEndpointAddress;
367 	uint8_t	bmAttributes;
368 	uint16_t wMaxPacketSize;
369 	uint8_t	bInterval;
370 	uint8_t	bRefresh;
371 	uint8_t	bSynchAddress;
372 	uint8_t *extra;
373 	int	extra_length;
374 }	libusb_endpoint_descriptor __aligned(sizeof(void *));
375 
376 typedef struct libusb_ss_endpoint_companion_descriptor {
377 	uint8_t bLength;
378 	uint8_t bDescriptorType;
379 	uint8_t bMaxBurst;
380 	uint8_t bmAttributes;
381 	uint16_t wBytesPerInterval;
382 }	libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
383 
384 typedef struct libusb_interface_association_descriptor {
385 	uint8_t bLength;
386 	uint8_t bDescriptorType;
387 	uint8_t bFirstInterface;
388 	uint8_t bInterfaceCount;
389 	uint8_t bFunctionClass;
390 	uint8_t bFunctionSubClass;
391 	uint8_t bFunctionProtocol;
392 	uint8_t iFunction;
393 } libusb_interface_association_descriptor __aligned(sizeof(void *));
394 
395 typedef struct libusb_interface_association_descriptor_array {
396 	const struct libusb_interface_association_descriptor *iad;
397 	int length;
398 } libusb_interface_association_descriptor_array;
399 
400 typedef struct libusb_interface_descriptor {
401 	uint8_t	bLength;
402 	uint8_t	bDescriptorType;
403 	uint8_t	bInterfaceNumber;
404 	uint8_t	bAlternateSetting;
405 	uint8_t	bNumEndpoints;
406 	uint8_t	bInterfaceClass;
407 	uint8_t	bInterfaceSubClass;
408 	uint8_t	bInterfaceProtocol;
409 	uint8_t	iInterface;
410 	struct libusb_endpoint_descriptor *endpoint;
411 	uint8_t *extra;
412 	int	extra_length;
413 }	libusb_interface_descriptor __aligned(sizeof(void *));
414 
415 typedef struct libusb_interface {
416 	struct libusb_interface_descriptor *altsetting;
417 	int	num_altsetting;
418 }	libusb_interface __aligned(sizeof(void *));
419 
420 typedef struct libusb_config_descriptor {
421 	uint8_t	bLength;
422 	uint8_t	bDescriptorType;
423 	uint16_t wTotalLength;
424 	uint8_t	bNumInterfaces;
425 	uint8_t	bConfigurationValue;
426 	uint8_t	iConfiguration;
427 	uint8_t	bmAttributes;
428 	uint8_t	MaxPower;
429 	struct libusb_interface *interface;
430 	uint8_t *extra;
431 	int	extra_length;
432 }	libusb_config_descriptor __aligned(sizeof(void *));
433 
434 typedef struct libusb_usb_2_0_device_capability_descriptor {
435 	uint8_t bLength;
436 	uint8_t bDescriptorType;
437 	uint8_t bDevCapabilityType;
438 	uint32_t bmAttributes;
439 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT  (1 << 1)
440 }	libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
441 
442 typedef struct libusb_ss_usb_device_capability_descriptor {
443 	uint8_t bLength;
444 	uint8_t bDescriptorType;
445 	uint8_t bDevCapabilityType;
446 	uint8_t bmAttributes;
447 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT   (1 << 1)
448 	uint16_t wSpeedSupported;
449 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION  (1)
450 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
451 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
452 #define LIBUSB_CAPABILITY_5GBPS_OPERATION      (1 << 3)
453 	uint8_t bFunctionalitySupport;
454 	uint8_t bU1DevExitLat;
455 	uint16_t wU2DevExitLat;
456 }	libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
457 
458 typedef struct libusb_bos_dev_capability_descriptor {
459 	uint8_t bLength;
460 	uint8_t bDescriptorType;
461 	uint8_t bDevCapabilityType;
462 	uint8_t dev_capability_data[0];
463 }	libusb_bos_dev_capability_descriptor __aligned(sizeof(void *));
464 
465 typedef struct libusb_bos_descriptor {
466 	uint8_t bLength;
467 	uint8_t bDescriptorType;
468 	uint16_t wTotalLength;
469 #ifndef bNumDeviceCapabilities
470 #define bNumDeviceCapabilities bNumDeviceCaps
471 #endif
472 	uint8_t bNumDeviceCaps;
473 	struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
474 	struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
475 	struct libusb_bos_dev_capability_descriptor **dev_capability;
476 }	libusb_bos_descriptor __aligned(sizeof(void *));
477 
478 typedef struct libusb_usb_2_0_extension_descriptor {
479 	uint8_t bLength;
480 	uint8_t bDescriptorType;
481 	uint8_t bDevCapabilityType;
482 	uint32_t bmAttributes;
483 }	libusb_usb_2_0_extension_descriptor __aligned(sizeof(void *));
484 
485 typedef struct libusb_container_id_descriptor {
486 	uint8_t bLength;
487 	uint8_t bDescriptorType;
488 	uint8_t bDevCapabilityType;
489 	uint8_t	bReserved;
490 	uint8_t ContainerID[16];
491 }	libusb_container_id_descriptor __aligned(sizeof(void *));
492 
493 typedef struct libusb_platform_descriptor {
494 	uint8_t bLength;
495 	uint8_t bDescriptorType;
496 	uint8_t bDevCapabilityType;
497 	uint8_t bReserved;
498 	uint8_t PlatformCapabilityUUID[16];
499 	uint8_t CapabilityData[];
500 }	libusb_platform_descriptor __aligned(sizeof(void *));
501 
502 typedef struct libusb_control_setup {
503 	uint8_t	bmRequestType;
504 	uint8_t	bRequest;
505 	uint16_t wValue;
506 	uint16_t wIndex;
507 	uint16_t wLength;
508 }	libusb_control_setup;
509 
510 #define	LIBUSB_CONTROL_SETUP_SIZE	8	/* bytes */
511 
512 typedef struct libusb_iso_packet_descriptor {
513 	uint32_t length;
514 	uint32_t actual_length;
515 	enum libusb_transfer_status status;
516 }	libusb_iso_packet_descriptor __aligned(sizeof(void *));
517 
518 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
519 
520 typedef struct libusb_transfer {
521 	libusb_device_handle *dev_handle;
522 	uint8_t	flags;
523 	uint8_t endpoint;
524 	uint8_t type;
525 	uint32_t timeout;
526 	enum libusb_transfer_status status;
527 	int	length;
528 	int	actual_length;
529 	libusb_transfer_cb_fn callback;
530 	void   *user_data;
531 	uint8_t *buffer;
532 	int	num_iso_packets;
533 	struct libusb_iso_packet_descriptor iso_packet_desc[0];
534 }	libusb_transfer __aligned(sizeof(void *));
535 
536 /* Library initialisation */
537 
538 void	libusb_set_debug(libusb_context * ctx, int level);
539 const struct libusb_version *libusb_get_version(void);
540 const char *libusb_strerror(int code);
541 const char *libusb_error_name(int code);
542 int	libusb_init(libusb_context ** context);
543 int	libusb_init_context(libusb_context **, const struct libusb_init_option [], int num_options);
544 void	libusb_exit(struct libusb_context *ctx);
545 int	libusb_has_capability(uint32_t capability);
546 int	libusb_setlocale(const char *locale);
547 
548 /* Device handling and enumeration */
549 
550 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
551 void	libusb_free_device_list(libusb_device ** list, int unref_devices);
552 uint8_t	libusb_get_bus_number(libusb_device * dev);
553 uint8_t	libusb_get_port_number(libusb_device * dev);
554 int	libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
555 int	libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
556 uint8_t	libusb_get_device_address(libusb_device * dev);
557 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
558 int	libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
559 int	libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
560 int	libusb_get_max_iso_packet_size(libusb_device *dev, uint8_t endpoint);
561 int	libusb_get_max_alt_packet_size(libusb_device *dev, int interface_number,
562     int alternate_setting, unsigned char endpoint);
563 libusb_device *libusb_ref_device(libusb_device * dev);
564 void	libusb_unref_device(libusb_device * dev);
565 int	libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
566 int	libusb_open(libusb_device * dev, libusb_device_handle ** devh);
567 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
568 void	libusb_close(libusb_device_handle * devh);
569 libusb_device *libusb_get_device(libusb_device_handle * devh);
570 libusb_device *libusb_get_parent(libusb_device * dev);
571 int	libusb_get_configuration(libusb_device_handle * devh, int *config);
572 int	libusb_set_configuration(libusb_device_handle * devh, int configuration);
573 int	libusb_claim_interface(libusb_device_handle * devh, int interface_number);
574 int	libusb_release_interface(libusb_device_handle * devh, int interface_number);
575 int	libusb_reset_device(libusb_device_handle * devh);
576 int	libusb_check_connected(libusb_device_handle * devh);
577 int 	libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
578 int	libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
579 int	libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
580 int 	libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
581 int 	libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
582 int 	libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
583 int	libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable);
584 int	libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
585 unsigned char *libusb_dev_mem_alloc(libusb_device_handle *devh);
586 int	libusb_dev_mem_free(libusb_device_handle *devh, unsigned char *buffer,
587     size_t size);
588 
589 /* USB Descriptors */
590 
591 int	libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
592 int	libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
593 int	libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
594 int	libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
595 void	libusb_free_config_descriptor(struct libusb_config_descriptor *config);
596 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);
597 void	libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
598 int	libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
599 int	libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
600 int	libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
601 int	libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
602 void	libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
603 int	libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
604 void	libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
605 int	libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos);
606 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);
607 void	libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
608 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);
609 void	libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability);
610 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);
611 void	libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id);
612 int	libusb_get_platform_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_platform_descriptor **platform_descriptor);
613 void	libusb_free_platform_descriptor(struct libusb_platform_descriptor *platform_descriptor);
614 int	libusb_get_interface_association_descriptors(libusb_device *dev, uint8_t config_index, struct libusb_interface_association_descriptor_array **iad_arr);
615 int	libusb_get_active_interface_association_descriptors(libusb_device *dev, struct libusb_interface_association_descriptor_array **iad_arr);
616 void	libusb_free_interface_association_descriptors(struct libusb_interface_association_descriptor_array *iad_arr);
617 
618 /* Asynchronous device I/O */
619 
620 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
621 void	libusb_free_transfer(struct libusb_transfer *transfer);
622 int	libusb_submit_transfer(struct libusb_transfer *transfer);
623 int	libusb_cancel_transfer(struct libusb_transfer *transfer);
624 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
625 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
626 void	libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
627 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
628 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
629 void	libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
630 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);
631 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);
632 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);
633 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);
634 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);
635 
636 /* Polling and timing */
637 
638 int	libusb_try_lock_events(libusb_context * ctx);
639 void	libusb_lock_events(libusb_context * ctx);
640 void	libusb_unlock_events(libusb_context * ctx);
641 int	libusb_event_handling_ok(libusb_context * ctx);
642 int	libusb_event_handler_active(libusb_context * ctx);
643 void	libusb_interrupt_event_handler(libusb_context *ctx);
644 void	libusb_lock_event_waiters(libusb_context * ctx);
645 void	libusb_unlock_event_waiters(libusb_context * ctx);
646 int	libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
647 int	libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
648 int	libusb_handle_events_completed(libusb_context * ctx, int *completed);
649 int	libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
650 int	libusb_handle_events(libusb_context * ctx);
651 int	libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
652 int	libusb_pollfds_handle_timeouts(libusb_context *ctx);
653 int	libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
654 void	libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
655 const struct libusb_pollfd **libusb_get_pollfds(libusb_context *ctx);
656 void    libusb_free_pollfds(const struct libusb_pollfd **pollfds);
657 
658 /* Synchronous device I/O */
659 
660 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);
661 int	libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
662 int	libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
663 
664 /* Byte-order */
665 
666 uint16_t libusb_cpu_to_le16(uint16_t x);
667 uint16_t libusb_le16_to_cpu(uint16_t x);
668 
669 /* Hotplug support */
670 
671 typedef int (*libusb_hotplug_callback_fn)(libusb_context *ctx,
672     libusb_device *device, libusb_hotplug_event event, void *user_data);
673 
674 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);
675 void	libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle);
676 void   *libusb_hotplug_get_user_data(struct libusb_context *ctx,
677     libusb_hotplug_callback_handle callback_handle);
678 
679 /* Streams support */
680 
681 int	libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
682 int	libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints);
683 void	libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id);
684 uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer);
685 int	libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
686 void	libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode);
687 
688 #if 0
689 {					/* indent fix */
690 #endif
691 #ifdef __cplusplus
692 }
693 
694 #endif
695 
696 #endif					/* __LIBUSB_H__ */
697