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