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_PRINTER = 7,
55 LIBUSB_CLASS_MASS_STORAGE = 8,
57 LIBUSB_CLASS_DATA = 10,
58 LIBUSB_CLASS_VENDOR_SPEC = 0xff,
61 enum libusb_descriptor_type {
62 LIBUSB_DT_DEVICE = 0x01,
63 LIBUSB_DT_CONFIG = 0x02,
64 LIBUSB_DT_STRING = 0x03,
65 LIBUSB_DT_INTERFACE = 0x04,
66 LIBUSB_DT_ENDPOINT = 0x05,
68 LIBUSB_DT_REPORT = 0x22,
69 LIBUSB_DT_PHYSICAL = 0x23,
72 LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
73 LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
76 enum libusb_device_capability_type {
77 LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
78 LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
79 LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
80 LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
83 #define LIBUSB_DT_DEVICE_SIZE 18
84 #define LIBUSB_DT_CONFIG_SIZE 9
85 #define LIBUSB_DT_INTERFACE_SIZE 9
86 #define LIBUSB_DT_ENDPOINT_SIZE 7
87 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
88 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
89 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
90 #define LIBUSB_DT_BOS_SIZE 5
91 #define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7
92 #define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE 10
94 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
95 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
97 enum libusb_endpoint_direction {
98 LIBUSB_ENDPOINT_IN = 0x80,
99 LIBUSB_ENDPOINT_OUT = 0x00,
102 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
104 enum libusb_transfer_type {
105 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
106 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
107 LIBUSB_TRANSFER_TYPE_BULK = 2,
108 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
111 enum libusb_standard_request {
112 LIBUSB_REQUEST_GET_STATUS = 0x00,
113 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
114 LIBUSB_REQUEST_SET_FEATURE = 0x03,
115 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
116 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
117 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
118 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
119 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
120 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
121 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
122 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
125 enum libusb_request_type {
126 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
127 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
128 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
129 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
132 enum libusb_request_recipient {
133 LIBUSB_RECIPIENT_DEVICE = 0x00,
134 LIBUSB_RECIPIENT_INTERFACE = 0x01,
135 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
136 LIBUSB_RECIPIENT_OTHER = 0x03,
139 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
141 enum libusb_iso_sync_type {
142 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
143 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
144 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
145 LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
148 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
150 enum libusb_iso_usage_type {
151 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
152 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
153 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
158 LIBUSB_ERROR_IO = -1,
159 LIBUSB_ERROR_INVALID_PARAM = -2,
160 LIBUSB_ERROR_ACCESS = -3,
161 LIBUSB_ERROR_NO_DEVICE = -4,
162 LIBUSB_ERROR_NOT_FOUND = -5,
163 LIBUSB_ERROR_BUSY = -6,
164 LIBUSB_ERROR_TIMEOUT = -7,
165 LIBUSB_ERROR_OVERFLOW = -8,
166 LIBUSB_ERROR_PIPE = -9,
167 LIBUSB_ERROR_INTERRUPTED = -10,
168 LIBUSB_ERROR_NO_MEM = -11,
169 LIBUSB_ERROR_NOT_SUPPORTED = -12,
170 LIBUSB_ERROR_OTHER = -99,
174 LIBUSB_SPEED_UNKNOWN = 0,
175 LIBUSB_SPEED_LOW = 1,
176 LIBUSB_SPEED_FULL = 2,
177 LIBUSB_SPEED_HIGH = 3,
178 LIBUSB_SPEED_SUPER = 4,
181 enum libusb_transfer_status {
182 LIBUSB_TRANSFER_COMPLETED,
183 LIBUSB_TRANSFER_ERROR,
184 LIBUSB_TRANSFER_TIMED_OUT,
185 LIBUSB_TRANSFER_CANCELLED,
186 LIBUSB_TRANSFER_STALL,
187 LIBUSB_TRANSFER_NO_DEVICE,
188 LIBUSB_TRANSFER_OVERFLOW,
191 enum libusb_transfer_flags {
192 LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
193 LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
194 LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
197 enum libusb_debug_level {
199 LIBUSB_DEBUG_FUNCTION=1,
200 LIBUSB_DEBUG_TRANSFER=2,
203 /* libusb structures */
205 struct libusb_context;
206 struct libusb_device;
207 struct libusb_transfer;
208 struct libusb_device_handle;
210 struct libusb_pollfd {
215 typedef struct libusb_context libusb_context;
216 typedef struct libusb_device libusb_device;
217 typedef struct libusb_device_handle libusb_device_handle;
218 typedef struct libusb_pollfd libusb_pollfd;
219 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
220 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
222 typedef struct libusb_device_descriptor {
224 uint8_t bDescriptorType;
226 uint8_t bDeviceClass;
227 uint8_t bDeviceSubClass;
228 uint8_t bDeviceProtocol;
229 uint8_t bMaxPacketSize0;
233 uint8_t iManufacturer;
235 uint8_t iSerialNumber;
236 uint8_t bNumConfigurations;
237 } libusb_device_descriptor;
239 typedef struct libusb_endpoint_descriptor {
241 uint8_t bDescriptorType;
242 uint8_t bEndpointAddress;
243 uint8_t bmAttributes;
244 uint16_t wMaxPacketSize;
247 uint8_t bSynchAddress;
250 } libusb_endpoint_descriptor __aligned(sizeof(void *));
252 typedef struct libusb_ss_endpoint_companion_descriptor {
254 uint8_t bDescriptorType;
256 uint8_t bmAttributes;
257 uint16_t wBytesPerInterval;
258 } libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
260 typedef struct libusb_interface_descriptor {
262 uint8_t bDescriptorType;
263 uint8_t bInterfaceNumber;
264 uint8_t bAlternateSetting;
265 uint8_t bNumEndpoints;
266 uint8_t bInterfaceClass;
267 uint8_t bInterfaceSubClass;
268 uint8_t bInterfaceProtocol;
270 struct libusb_endpoint_descriptor *endpoint;
273 } libusb_interface_descriptor __aligned(sizeof(void *));
275 typedef struct libusb_interface {
276 struct libusb_interface_descriptor *altsetting;
278 } libusb_interface __aligned(sizeof(void *));
280 typedef struct libusb_config_descriptor {
282 uint8_t bDescriptorType;
283 uint16_t wTotalLength;
284 uint8_t bNumInterfaces;
285 uint8_t bConfigurationValue;
286 uint8_t iConfiguration;
287 uint8_t bmAttributes;
289 struct libusb_interface *interface;
292 } libusb_config_descriptor __aligned(sizeof(void *));
294 typedef struct libusb_usb_2_0_device_capability_descriptor {
296 uint8_t bDescriptorType;
297 uint8_t bDevCapabilityType;
298 uint32_t bmAttributes;
299 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT (1 << 1)
300 } libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
302 typedef struct libusb_ss_usb_device_capability_descriptor {
304 uint8_t bDescriptorType;
305 uint8_t bDevCapabilityType;
306 uint8_t bmAttributes;
307 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT (1 << 1)
308 uint16_t wSpeedSupported;
309 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION (1)
310 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
311 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
312 #define LIBUSB_CAPABILITY_5GBPS_OPERATION (1 << 3)
313 uint8_t bFunctionalitySupport;
314 uint8_t bU1DevExitLat;
315 uint16_t wU2DevExitLat;
316 } libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
318 typedef struct libusb_bos_descriptor {
320 uint8_t bDescriptorType;
321 uint16_t wTotalLength;
322 uint8_t bNumDeviceCapabilities;
323 struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
324 struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
325 } libusb_bos_descriptor __aligned(sizeof(void *));
327 typedef struct libusb_control_setup {
328 uint8_t bmRequestType;
333 } libusb_control_setup;
335 #define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */
337 typedef struct libusb_iso_packet_descriptor {
339 uint32_t actual_length;
340 enum libusb_transfer_status status;
341 } libusb_iso_packet_descriptor __aligned(sizeof(void *));
343 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
345 typedef struct libusb_transfer {
346 libusb_device_handle *dev_handle;
351 enum libusb_transfer_status status;
354 libusb_transfer_cb_fn callback;
358 struct libusb_iso_packet_descriptor iso_packet_desc[0];
359 } libusb_transfer __aligned(sizeof(void *));
361 /* Library initialisation */
363 void libusb_set_debug(libusb_context * ctx, int level);
364 const char *libusb_strerror(int code);
365 const char *libusb_error_name(int code);
366 int libusb_init(libusb_context ** context);
367 void libusb_exit(struct libusb_context *ctx);
369 /* Device handling and enumeration */
371 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
372 void libusb_free_device_list(libusb_device ** list, int unref_devices);
373 uint8_t libusb_get_bus_number(libusb_device * dev);
374 int libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
375 int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
376 uint8_t libusb_get_device_address(libusb_device * dev);
377 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
378 int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
379 int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
380 int libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint);
381 libusb_device *libusb_ref_device(libusb_device * dev);
382 void libusb_unref_device(libusb_device * dev);
383 int libusb_open(libusb_device * dev, libusb_device_handle ** devh);
384 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
385 void libusb_close(libusb_device_handle * devh);
386 libusb_device *libusb_get_device(libusb_device_handle * devh);
387 int libusb_get_configuration(libusb_device_handle * devh, int *config);
388 int libusb_set_configuration(libusb_device_handle * devh, int configuration);
389 int libusb_claim_interface(libusb_device_handle * devh, int interface_number);
390 int libusb_release_interface(libusb_device_handle * devh, int interface_number);
391 int libusb_reset_device(libusb_device_handle * devh);
392 int libusb_check_connected(libusb_device_handle * devh);
393 int libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
394 int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
395 int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
396 int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
397 int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
398 int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
399 int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
401 /* USB Descriptors */
403 int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
404 int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
405 int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
406 int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
407 void libusb_free_config_descriptor(struct libusb_config_descriptor *config);
408 int libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
409 int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
410 int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
411 int libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
412 void libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
413 int libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
414 void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
416 /* Asynchronous device I/O */
418 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
419 void libusb_free_transfer(struct libusb_transfer *transfer);
420 int libusb_submit_transfer(struct libusb_transfer *transfer);
421 int libusb_cancel_transfer(struct libusb_transfer *transfer);
422 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
423 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
424 void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
425 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
426 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
427 void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
428 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);
429 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);
430 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);
431 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);
433 /* Polling and timing */
435 int libusb_try_lock_events(libusb_context * ctx);
436 void libusb_lock_events(libusb_context * ctx);
437 void libusb_unlock_events(libusb_context * ctx);
438 int libusb_event_handling_ok(libusb_context * ctx);
439 int libusb_event_handler_active(libusb_context * ctx);
440 void libusb_lock_event_waiters(libusb_context * ctx);
441 void libusb_unlock_event_waiters(libusb_context * ctx);
442 int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
443 int libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
444 int libusb_handle_events_completed(libusb_context * ctx, int *completed);
445 int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
446 int libusb_handle_events(libusb_context * ctx);
447 int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
448 int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
449 void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
450 const struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);
452 /* Synchronous device I/O */
454 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);
455 int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
456 int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
460 uint16_t libusb_cpu_to_le16(uint16_t x);
461 uint16_t libusb_le16_to_cpu(uint16_t x);
471 #endif /* __LIBUSB_H__ */