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