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