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