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
31 #include <sys/types.h>
45 enum libusb_class_code {
46 LIBUSB_CLASS_PER_INTERFACE = 0,
47 LIBUSB_CLASS_AUDIO = 1,
48 LIBUSB_CLASS_COMM = 2,
51 LIBUSB_CLASS_IMAGE = 6,
52 LIBUSB_CLASS_PRINTER = 7,
53 LIBUSB_CLASS_MASS_STORAGE = 8,
55 LIBUSB_CLASS_DATA = 10,
56 LIBUSB_CLASS_SMART_CARD = 11,
57 LIBUSB_CLASS_CONTENT_SECURITY = 13,
58 LIBUSB_CLASS_VIDEO = 14,
59 LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15,
60 LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
61 LIBUSB_CLASS_WIRELESS = 0xe0,
62 LIBUSB_CLASS_APPLICATION = 0xfe,
63 LIBUSB_CLASS_VENDOR_SPEC = 0xff,
66 enum libusb_descriptor_type {
67 LIBUSB_DT_DEVICE = 0x01,
68 LIBUSB_DT_CONFIG = 0x02,
69 LIBUSB_DT_STRING = 0x03,
70 LIBUSB_DT_INTERFACE = 0x04,
71 LIBUSB_DT_ENDPOINT = 0x05,
73 LIBUSB_DT_REPORT = 0x22,
74 LIBUSB_DT_PHYSICAL = 0x23,
77 LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
78 LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
81 enum libusb_device_capability_type {
82 LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
83 LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
84 LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
85 LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
88 #define LIBUSB_DT_DEVICE_SIZE 18
89 #define LIBUSB_DT_CONFIG_SIZE 9
90 #define LIBUSB_DT_INTERFACE_SIZE 9
91 #define LIBUSB_DT_ENDPOINT_SIZE 7
92 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
93 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
94 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
95 #define LIBUSB_DT_BOS_SIZE 5
96 #define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7
97 #define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE 10
99 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
100 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
102 enum libusb_endpoint_direction {
103 LIBUSB_ENDPOINT_IN = 0x80,
104 LIBUSB_ENDPOINT_OUT = 0x00,
107 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
109 enum libusb_transfer_type {
110 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
111 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
112 LIBUSB_TRANSFER_TYPE_BULK = 2,
113 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
116 enum libusb_standard_request {
117 LIBUSB_REQUEST_GET_STATUS = 0x00,
118 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
119 LIBUSB_REQUEST_SET_FEATURE = 0x03,
120 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
121 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
122 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
123 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
124 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
125 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
126 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
127 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
130 enum libusb_request_type {
131 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
132 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
133 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
134 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
137 enum libusb_request_recipient {
138 LIBUSB_RECIPIENT_DEVICE = 0x00,
139 LIBUSB_RECIPIENT_INTERFACE = 0x01,
140 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
141 LIBUSB_RECIPIENT_OTHER = 0x03,
144 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
146 enum libusb_iso_sync_type {
147 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
148 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
149 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
150 LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
153 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
155 enum libusb_iso_usage_type {
156 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
157 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
158 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
163 LIBUSB_ERROR_IO = -1,
164 LIBUSB_ERROR_INVALID_PARAM = -2,
165 LIBUSB_ERROR_ACCESS = -3,
166 LIBUSB_ERROR_NO_DEVICE = -4,
167 LIBUSB_ERROR_NOT_FOUND = -5,
168 LIBUSB_ERROR_BUSY = -6,
169 LIBUSB_ERROR_TIMEOUT = -7,
170 LIBUSB_ERROR_OVERFLOW = -8,
171 LIBUSB_ERROR_PIPE = -9,
172 LIBUSB_ERROR_INTERRUPTED = -10,
173 LIBUSB_ERROR_NO_MEM = -11,
174 LIBUSB_ERROR_NOT_SUPPORTED = -12,
175 LIBUSB_ERROR_OTHER = -99,
179 LIBUSB_SPEED_UNKNOWN = 0,
180 LIBUSB_SPEED_LOW = 1,
181 LIBUSB_SPEED_FULL = 2,
182 LIBUSB_SPEED_HIGH = 3,
183 LIBUSB_SPEED_SUPER = 4,
186 enum libusb_transfer_status {
187 LIBUSB_TRANSFER_COMPLETED,
188 LIBUSB_TRANSFER_ERROR,
189 LIBUSB_TRANSFER_TIMED_OUT,
190 LIBUSB_TRANSFER_CANCELLED,
191 LIBUSB_TRANSFER_STALL,
192 LIBUSB_TRANSFER_NO_DEVICE,
193 LIBUSB_TRANSFER_OVERFLOW,
196 enum libusb_transfer_flags {
197 LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
198 LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
199 LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
202 enum libusb_debug_level {
204 LIBUSB_DEBUG_FUNCTION=1,
205 LIBUSB_DEBUG_TRANSFER=2,
208 /* libusb structures */
210 struct libusb_context;
211 struct libusb_device;
212 struct libusb_transfer;
213 struct libusb_device_handle;
215 struct libusb_pollfd {
220 typedef struct libusb_context libusb_context;
221 typedef struct libusb_device libusb_device;
222 typedef struct libusb_device_handle libusb_device_handle;
223 typedef struct libusb_pollfd libusb_pollfd;
224 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
225 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
227 typedef struct libusb_device_descriptor {
229 uint8_t bDescriptorType;
231 uint8_t bDeviceClass;
232 uint8_t bDeviceSubClass;
233 uint8_t bDeviceProtocol;
234 uint8_t bMaxPacketSize0;
238 uint8_t iManufacturer;
240 uint8_t iSerialNumber;
241 uint8_t bNumConfigurations;
242 } libusb_device_descriptor;
244 typedef struct libusb_endpoint_descriptor {
246 uint8_t bDescriptorType;
247 uint8_t bEndpointAddress;
248 uint8_t bmAttributes;
249 uint16_t wMaxPacketSize;
252 uint8_t bSynchAddress;
255 } libusb_endpoint_descriptor __aligned(sizeof(void *));
257 typedef struct libusb_ss_endpoint_companion_descriptor {
259 uint8_t bDescriptorType;
261 uint8_t bmAttributes;
262 uint16_t wBytesPerInterval;
263 } libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
265 typedef struct libusb_interface_descriptor {
267 uint8_t bDescriptorType;
268 uint8_t bInterfaceNumber;
269 uint8_t bAlternateSetting;
270 uint8_t bNumEndpoints;
271 uint8_t bInterfaceClass;
272 uint8_t bInterfaceSubClass;
273 uint8_t bInterfaceProtocol;
275 struct libusb_endpoint_descriptor *endpoint;
278 } libusb_interface_descriptor __aligned(sizeof(void *));
280 typedef struct libusb_interface {
281 struct libusb_interface_descriptor *altsetting;
283 } libusb_interface __aligned(sizeof(void *));
285 typedef struct libusb_config_descriptor {
287 uint8_t bDescriptorType;
288 uint16_t wTotalLength;
289 uint8_t bNumInterfaces;
290 uint8_t bConfigurationValue;
291 uint8_t iConfiguration;
292 uint8_t bmAttributes;
294 struct libusb_interface *interface;
297 } libusb_config_descriptor __aligned(sizeof(void *));
299 typedef struct libusb_usb_2_0_device_capability_descriptor {
301 uint8_t bDescriptorType;
302 uint8_t bDevCapabilityType;
303 uint32_t bmAttributes;
304 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT (1 << 1)
305 } libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
307 typedef struct libusb_ss_usb_device_capability_descriptor {
309 uint8_t bDescriptorType;
310 uint8_t bDevCapabilityType;
311 uint8_t bmAttributes;
312 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT (1 << 1)
313 uint16_t wSpeedSupported;
314 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION (1)
315 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
316 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
317 #define LIBUSB_CAPABILITY_5GBPS_OPERATION (1 << 3)
318 uint8_t bFunctionalitySupport;
319 uint8_t bU1DevExitLat;
320 uint16_t wU2DevExitLat;
321 } libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
323 typedef struct libusb_bos_descriptor {
325 uint8_t bDescriptorType;
326 uint16_t wTotalLength;
327 uint8_t bNumDeviceCapabilities;
328 struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
329 struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
330 } libusb_bos_descriptor __aligned(sizeof(void *));
332 typedef struct libusb_control_setup {
333 uint8_t bmRequestType;
338 } libusb_control_setup;
340 #define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */
342 typedef struct libusb_iso_packet_descriptor {
344 uint32_t actual_length;
345 enum libusb_transfer_status status;
346 } libusb_iso_packet_descriptor __aligned(sizeof(void *));
348 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
350 typedef struct libusb_transfer {
351 libusb_device_handle *dev_handle;
356 enum libusb_transfer_status status;
359 libusb_transfer_cb_fn callback;
364 struct libusb_iso_packet_descriptor iso_packet_desc[0];
365 } libusb_transfer __aligned(sizeof(void *));
367 /* Library initialisation */
369 void libusb_set_debug(libusb_context * ctx, int level);
370 const char *libusb_strerror(int code);
371 const char *libusb_error_name(int code);
372 int libusb_init(libusb_context ** context);
373 void libusb_exit(struct libusb_context *ctx);
375 /* Device handling and enumeration */
377 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
378 void libusb_free_device_list(libusb_device ** list, int unref_devices);
379 uint8_t libusb_get_bus_number(libusb_device * dev);
380 int libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
381 int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
382 uint8_t libusb_get_device_address(libusb_device * dev);
383 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
384 int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
385 int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
386 int libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint);
387 libusb_device *libusb_ref_device(libusb_device * dev);
388 void libusb_unref_device(libusb_device * dev);
389 int libusb_open(libusb_device * dev, libusb_device_handle ** devh);
390 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
391 void libusb_close(libusb_device_handle * devh);
392 libusb_device *libusb_get_device(libusb_device_handle * devh);
393 int libusb_get_configuration(libusb_device_handle * devh, int *config);
394 int libusb_set_configuration(libusb_device_handle * devh, int configuration);
395 int libusb_claim_interface(libusb_device_handle * devh, int interface_number);
396 int libusb_release_interface(libusb_device_handle * devh, int interface_number);
397 int libusb_reset_device(libusb_device_handle * devh);
398 int libusb_check_connected(libusb_device_handle * devh);
399 int libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
400 int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
401 int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
402 int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
403 int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
404 int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
405 int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
407 /* USB Descriptors */
409 int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
410 int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
411 int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
412 int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
413 void libusb_free_config_descriptor(struct libusb_config_descriptor *config);
414 int libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
415 int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
416 int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
417 int libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
418 void libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
419 int libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
420 void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
422 /* Asynchronous device I/O */
424 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
425 void libusb_free_transfer(struct libusb_transfer *transfer);
426 int libusb_submit_transfer(struct libusb_transfer *transfer);
427 int libusb_cancel_transfer(struct libusb_transfer *transfer);
428 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
429 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
430 void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
431 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
432 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
433 void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
434 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);
435 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);
436 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);
437 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);
439 /* Polling and timing */
441 int libusb_try_lock_events(libusb_context * ctx);
442 void libusb_lock_events(libusb_context * ctx);
443 void libusb_unlock_events(libusb_context * ctx);
444 int libusb_event_handling_ok(libusb_context * ctx);
445 int libusb_event_handler_active(libusb_context * ctx);
446 void libusb_lock_event_waiters(libusb_context * ctx);
447 void libusb_unlock_event_waiters(libusb_context * ctx);
448 int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
449 int libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
450 int libusb_handle_events_completed(libusb_context * ctx, int *completed);
451 int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
452 int libusb_handle_events(libusb_context * ctx);
453 int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
454 int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
455 void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
456 const struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);
458 /* Synchronous device I/O */
460 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);
461 int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
462 int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
466 uint16_t libusb_cpu_to_le16(uint16_t x);
467 uint16_t libusb_le16_to_cpu(uint16_t x);
477 #endif /* __LIBUSB_H__ */