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