3 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
30 #ifndef LIBUSB_GLOBAL_INCLUDE_FILE
33 #include <sys/types.h>
48 enum libusb_class_code {
49 LIBUSB_CLASS_PER_INTERFACE = 0,
50 LIBUSB_CLASS_AUDIO = 1,
51 LIBUSB_CLASS_COMM = 2,
54 LIBUSB_CLASS_IMAGE = 6,
55 LIBUSB_CLASS_PRINTER = 7,
56 LIBUSB_CLASS_MASS_STORAGE = 8,
58 LIBUSB_CLASS_DATA = 10,
59 LIBUSB_CLASS_SMART_CARD = 11,
60 LIBUSB_CLASS_CONTENT_SECURITY = 13,
61 LIBUSB_CLASS_VIDEO = 14,
62 LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15,
63 LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
64 LIBUSB_CLASS_WIRELESS = 0xe0,
65 LIBUSB_CLASS_APPLICATION = 0xfe,
66 LIBUSB_CLASS_VENDOR_SPEC = 0xff,
69 enum libusb_descriptor_type {
70 LIBUSB_DT_DEVICE = 0x01,
71 LIBUSB_DT_CONFIG = 0x02,
72 LIBUSB_DT_STRING = 0x03,
73 LIBUSB_DT_INTERFACE = 0x04,
74 LIBUSB_DT_ENDPOINT = 0x05,
76 LIBUSB_DT_REPORT = 0x22,
77 LIBUSB_DT_PHYSICAL = 0x23,
80 LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
81 LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
84 enum libusb_device_capability_type {
85 LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
86 LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
87 LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
88 LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
91 #define LIBUSB_DT_DEVICE_SIZE 18
92 #define LIBUSB_DT_CONFIG_SIZE 9
93 #define LIBUSB_DT_INTERFACE_SIZE 9
94 #define LIBUSB_DT_ENDPOINT_SIZE 7
95 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
96 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
97 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
98 #define LIBUSB_DT_BOS_SIZE 5
99 #define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7
100 #define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE 10
102 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
103 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
105 enum libusb_endpoint_direction {
106 LIBUSB_ENDPOINT_IN = 0x80,
107 LIBUSB_ENDPOINT_OUT = 0x00,
110 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
112 enum libusb_transfer_type {
113 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
114 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
115 LIBUSB_TRANSFER_TYPE_BULK = 2,
116 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
119 enum libusb_standard_request {
120 LIBUSB_REQUEST_GET_STATUS = 0x00,
121 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
122 LIBUSB_REQUEST_SET_FEATURE = 0x03,
123 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
124 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
125 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
126 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
127 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
128 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
129 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
130 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
133 enum libusb_request_type {
134 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
135 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
136 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
137 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
140 enum libusb_request_recipient {
141 LIBUSB_RECIPIENT_DEVICE = 0x00,
142 LIBUSB_RECIPIENT_INTERFACE = 0x01,
143 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
144 LIBUSB_RECIPIENT_OTHER = 0x03,
147 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
149 enum libusb_iso_sync_type {
150 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
151 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
152 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
153 LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
156 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
158 enum libusb_iso_usage_type {
159 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
160 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
161 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
166 LIBUSB_ERROR_IO = -1,
167 LIBUSB_ERROR_INVALID_PARAM = -2,
168 LIBUSB_ERROR_ACCESS = -3,
169 LIBUSB_ERROR_NO_DEVICE = -4,
170 LIBUSB_ERROR_NOT_FOUND = -5,
171 LIBUSB_ERROR_BUSY = -6,
172 LIBUSB_ERROR_TIMEOUT = -7,
173 LIBUSB_ERROR_OVERFLOW = -8,
174 LIBUSB_ERROR_PIPE = -9,
175 LIBUSB_ERROR_INTERRUPTED = -10,
176 LIBUSB_ERROR_NO_MEM = -11,
177 LIBUSB_ERROR_NOT_SUPPORTED = -12,
178 LIBUSB_ERROR_OTHER = -99,
182 LIBUSB_SPEED_UNKNOWN = 0,
183 LIBUSB_SPEED_LOW = 1,
184 LIBUSB_SPEED_FULL = 2,
185 LIBUSB_SPEED_HIGH = 3,
186 LIBUSB_SPEED_SUPER = 4,
189 enum libusb_transfer_status {
190 LIBUSB_TRANSFER_COMPLETED,
191 LIBUSB_TRANSFER_ERROR,
192 LIBUSB_TRANSFER_TIMED_OUT,
193 LIBUSB_TRANSFER_CANCELLED,
194 LIBUSB_TRANSFER_STALL,
195 LIBUSB_TRANSFER_NO_DEVICE,
196 LIBUSB_TRANSFER_OVERFLOW,
199 enum libusb_transfer_flags {
200 LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
201 LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
202 LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
205 enum libusb_log_level {
206 LIBUSB_LOG_LEVEL_NONE = 0,
207 LIBUSB_LOG_LEVEL_ERROR,
208 LIBUSB_LOG_LEVEL_WARNING,
209 LIBUSB_LOG_LEVEL_INFO,
210 LIBUSB_LOG_LEVEL_DEBUG
214 /* libusb_set_debug should take parameters from libusb_log_level
216 * http://libusb.sourceforge.net/api-1.0/group__lib.html
218 enum libusb_debug_level {
220 LIBUSB_DEBUG_FUNCTION=1,
221 LIBUSB_DEBUG_TRANSFER=2,
224 /* libusb structures */
226 struct libusb_context;
227 struct libusb_device;
228 struct libusb_transfer;
229 struct libusb_device_handle;
231 struct libusb_pollfd {
236 typedef struct libusb_context libusb_context;
237 typedef struct libusb_device libusb_device;
238 typedef struct libusb_device_handle libusb_device_handle;
239 typedef struct libusb_pollfd libusb_pollfd;
240 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
241 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
243 typedef struct libusb_device_descriptor {
245 uint8_t bDescriptorType;
247 uint8_t bDeviceClass;
248 uint8_t bDeviceSubClass;
249 uint8_t bDeviceProtocol;
250 uint8_t bMaxPacketSize0;
254 uint8_t iManufacturer;
256 uint8_t iSerialNumber;
257 uint8_t bNumConfigurations;
258 } libusb_device_descriptor;
260 typedef struct libusb_endpoint_descriptor {
262 uint8_t bDescriptorType;
263 uint8_t bEndpointAddress;
264 uint8_t bmAttributes;
265 uint16_t wMaxPacketSize;
268 uint8_t bSynchAddress;
271 } libusb_endpoint_descriptor __aligned(sizeof(void *));
273 typedef struct libusb_ss_endpoint_companion_descriptor {
275 uint8_t bDescriptorType;
277 uint8_t bmAttributes;
278 uint16_t wBytesPerInterval;
279 } libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
281 typedef struct libusb_interface_descriptor {
283 uint8_t bDescriptorType;
284 uint8_t bInterfaceNumber;
285 uint8_t bAlternateSetting;
286 uint8_t bNumEndpoints;
287 uint8_t bInterfaceClass;
288 uint8_t bInterfaceSubClass;
289 uint8_t bInterfaceProtocol;
291 struct libusb_endpoint_descriptor *endpoint;
294 } libusb_interface_descriptor __aligned(sizeof(void *));
296 typedef struct libusb_interface {
297 struct libusb_interface_descriptor *altsetting;
299 } libusb_interface __aligned(sizeof(void *));
301 typedef struct libusb_config_descriptor {
303 uint8_t bDescriptorType;
304 uint16_t wTotalLength;
305 uint8_t bNumInterfaces;
306 uint8_t bConfigurationValue;
307 uint8_t iConfiguration;
308 uint8_t bmAttributes;
310 struct libusb_interface *interface;
313 } libusb_config_descriptor __aligned(sizeof(void *));
315 typedef struct libusb_usb_2_0_device_capability_descriptor {
317 uint8_t bDescriptorType;
318 uint8_t bDevCapabilityType;
319 uint32_t bmAttributes;
320 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT (1 << 1)
321 } libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
323 typedef struct libusb_ss_usb_device_capability_descriptor {
325 uint8_t bDescriptorType;
326 uint8_t bDevCapabilityType;
327 uint8_t bmAttributes;
328 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT (1 << 1)
329 uint16_t wSpeedSupported;
330 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION (1)
331 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
332 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
333 #define LIBUSB_CAPABILITY_5GBPS_OPERATION (1 << 3)
334 uint8_t bFunctionalitySupport;
335 uint8_t bU1DevExitLat;
336 uint16_t wU2DevExitLat;
337 } libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
339 typedef struct libusb_bos_descriptor {
341 uint8_t bDescriptorType;
342 uint16_t wTotalLength;
343 uint8_t bNumDeviceCapabilities;
344 struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
345 struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
346 } libusb_bos_descriptor __aligned(sizeof(void *));
348 typedef struct libusb_control_setup {
349 uint8_t bmRequestType;
354 } libusb_control_setup;
356 #define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */
358 typedef struct libusb_iso_packet_descriptor {
360 uint32_t actual_length;
361 enum libusb_transfer_status status;
362 } libusb_iso_packet_descriptor __aligned(sizeof(void *));
364 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
366 typedef struct libusb_transfer {
367 libusb_device_handle *dev_handle;
372 enum libusb_transfer_status status;
375 libusb_transfer_cb_fn callback;
379 struct libusb_iso_packet_descriptor iso_packet_desc[0];
380 } libusb_transfer __aligned(sizeof(void *));
382 /* Library initialisation */
384 void libusb_set_debug(libusb_context * ctx, int level);
385 const char *libusb_strerror(int code);
386 const char *libusb_error_name(int code);
387 int libusb_init(libusb_context ** context);
388 void libusb_exit(struct libusb_context *ctx);
390 /* Device handling and enumeration */
392 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
393 void libusb_free_device_list(libusb_device ** list, int unref_devices);
394 uint8_t libusb_get_bus_number(libusb_device * dev);
395 int libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
396 int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
397 uint8_t libusb_get_device_address(libusb_device * dev);
398 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
399 int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
400 int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
401 int libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint);
402 libusb_device *libusb_ref_device(libusb_device * dev);
403 void libusb_unref_device(libusb_device * dev);
404 int libusb_open(libusb_device * dev, libusb_device_handle ** devh);
405 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
406 void libusb_close(libusb_device_handle * devh);
407 libusb_device *libusb_get_device(libusb_device_handle * devh);
408 int libusb_get_configuration(libusb_device_handle * devh, int *config);
409 int libusb_set_configuration(libusb_device_handle * devh, int configuration);
410 int libusb_claim_interface(libusb_device_handle * devh, int interface_number);
411 int libusb_release_interface(libusb_device_handle * devh, int interface_number);
412 int libusb_reset_device(libusb_device_handle * devh);
413 int libusb_check_connected(libusb_device_handle * devh);
414 int libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
415 int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
416 int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
417 int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
418 int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
419 int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
420 int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
422 /* USB Descriptors */
424 int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
425 int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
426 int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
427 int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
428 void libusb_free_config_descriptor(struct libusb_config_descriptor *config);
429 int libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
430 int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
431 int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
432 int libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
433 void libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
434 int libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
435 void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
437 /* Asynchronous device I/O */
439 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
440 void libusb_free_transfer(struct libusb_transfer *transfer);
441 int libusb_submit_transfer(struct libusb_transfer *transfer);
442 int libusb_cancel_transfer(struct libusb_transfer *transfer);
443 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
444 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
445 void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
446 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
447 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
448 void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
449 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);
450 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);
451 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);
452 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);
454 /* Polling and timing */
456 int libusb_try_lock_events(libusb_context * ctx);
457 void libusb_lock_events(libusb_context * ctx);
458 void libusb_unlock_events(libusb_context * ctx);
459 int libusb_event_handling_ok(libusb_context * ctx);
460 int libusb_event_handler_active(libusb_context * ctx);
461 void libusb_lock_event_waiters(libusb_context * ctx);
462 void libusb_unlock_event_waiters(libusb_context * ctx);
463 int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
464 int libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
465 int libusb_handle_events_completed(libusb_context * ctx, int *completed);
466 int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
467 int libusb_handle_events(libusb_context * ctx);
468 int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
469 int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
470 void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
471 const struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);
473 /* Synchronous device I/O */
475 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);
476 int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
477 int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
481 uint16_t libusb_cpu_to_le16(uint16_t x);
482 uint16_t libusb_le16_to_cpu(uint16_t x);
492 #endif /* __LIBUSB_H__ */