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>
43 enum libusb_class_code {
44 LIBUSB_CLASS_PER_INTERFACE = 0,
45 LIBUSB_CLASS_AUDIO = 1,
46 LIBUSB_CLASS_COMM = 2,
49 LIBUSB_CLASS_PRINTER = 7,
50 LIBUSB_CLASS_MASS_STORAGE = 8,
52 LIBUSB_CLASS_DATA = 10,
53 LIBUSB_CLASS_VENDOR_SPEC = 0xff,
56 enum libusb_descriptor_type {
57 LIBUSB_DT_DEVICE = 0x01,
58 LIBUSB_DT_CONFIG = 0x02,
59 LIBUSB_DT_STRING = 0x03,
60 LIBUSB_DT_INTERFACE = 0x04,
61 LIBUSB_DT_ENDPOINT = 0x05,
63 LIBUSB_DT_REPORT = 0x22,
64 LIBUSB_DT_PHYSICAL = 0x23,
68 #define LIBUSB_DT_DEVICE_SIZE 18
69 #define LIBUSB_DT_CONFIG_SIZE 9
70 #define LIBUSB_DT_INTERFACE_SIZE 9
71 #define LIBUSB_DT_ENDPOINT_SIZE 7
72 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
73 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
75 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
76 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
78 enum libusb_endpoint_direction {
79 LIBUSB_ENDPOINT_IN = 0x80,
80 LIBUSB_ENDPOINT_OUT = 0x00,
83 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
85 enum libusb_transfer_type {
86 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
87 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
88 LIBUSB_TRANSFER_TYPE_BULK = 2,
89 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
92 enum libusb_standard_request {
93 LIBUSB_REQUEST_GET_STATUS = 0x00,
94 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
95 LIBUSB_REQUEST_SET_FEATURE = 0x03,
96 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
97 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
98 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
99 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
100 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
101 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
102 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
103 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
106 enum libusb_request_type {
107 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
108 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
109 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
110 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
113 enum libusb_request_recipient {
114 LIBUSB_RECIPIENT_DEVICE = 0x00,
115 LIBUSB_RECIPIENT_INTERFACE = 0x01,
116 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
117 LIBUSB_RECIPIENT_OTHER = 0x03,
120 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
122 enum libusb_iso_sync_type {
123 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
124 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
125 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
126 LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
129 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
131 enum libusb_iso_usage_type {
132 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
133 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
134 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
139 LIBUSB_ERROR_IO = -1,
140 LIBUSB_ERROR_INVALID_PARAM = -2,
141 LIBUSB_ERROR_ACCESS = -3,
142 LIBUSB_ERROR_NO_DEVICE = -4,
143 LIBUSB_ERROR_NOT_FOUND = -5,
144 LIBUSB_ERROR_BUSY = -6,
145 LIBUSB_ERROR_TIMEOUT = -7,
146 LIBUSB_ERROR_OVERFLOW = -8,
147 LIBUSB_ERROR_PIPE = -9,
148 LIBUSB_ERROR_INTERRUPTED = -10,
149 LIBUSB_ERROR_NO_MEM = -11,
150 LIBUSB_ERROR_NOT_SUPPORTED = -12,
151 LIBUSB_ERROR_OTHER = -99,
155 LIBUSB_SPEED_UNKNOWN = 0,
156 LIBUSB_SPEED_LOW = 1,
157 LIBUSB_SPEED_FULL = 2,
158 LIBUSB_SPEED_HIGH = 3,
159 LIBUSB_SPEED_SUPER = 4,
162 enum libusb_transfer_status {
163 LIBUSB_TRANSFER_COMPLETED,
164 LIBUSB_TRANSFER_ERROR,
165 LIBUSB_TRANSFER_TIMED_OUT,
166 LIBUSB_TRANSFER_CANCELLED,
167 LIBUSB_TRANSFER_STALL,
168 LIBUSB_TRANSFER_NO_DEVICE,
169 LIBUSB_TRANSFER_OVERFLOW,
172 enum libusb_transfer_flags {
173 LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
174 LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
175 LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
178 enum libusb_debug_level {
180 LIBUSB_DEBUG_FUNCTION=1,
181 LIBUSB_DEBUG_TRANSFER=2,
184 /* libusb structures */
186 struct libusb_context;
187 struct libusb_device;
188 struct libusb_transfer;
189 struct libusb_device_handle;
191 struct libusb_pollfd {
196 typedef struct libusb_context libusb_context;
197 typedef struct libusb_device libusb_device;
198 typedef struct libusb_device_handle libusb_device_handle;
199 typedef struct libusb_pollfd libusb_pollfd;
200 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
201 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
203 typedef struct libusb_device_descriptor {
205 uint8_t bDescriptorType;
207 uint8_t bDeviceClass;
208 uint8_t bDeviceSubClass;
209 uint8_t bDeviceProtocol;
210 uint8_t bMaxPacketSize0;
214 uint8_t iManufacturer;
216 uint8_t iSerialNumber;
217 uint8_t bNumConfigurations;
218 } libusb_device_descriptor;
220 typedef struct libusb_endpoint_descriptor {
222 uint8_t bDescriptorType;
223 uint8_t bEndpointAddress;
224 uint8_t bmAttributes;
225 uint16_t wMaxPacketSize;
228 uint8_t bSynchAddress;
231 } libusb_endpoint_descriptor __aligned(sizeof(void *));
233 typedef struct libusb_interface_descriptor {
235 uint8_t bDescriptorType;
236 uint8_t bInterfaceNumber;
237 uint8_t bAlternateSetting;
238 uint8_t bNumEndpoints;
239 uint8_t bInterfaceClass;
240 uint8_t bInterfaceSubClass;
241 uint8_t bInterfaceProtocol;
243 struct libusb_endpoint_descriptor *endpoint;
246 } libusb_interface_descriptor __aligned(sizeof(void *));
248 typedef struct libusb_interface {
249 struct libusb_interface_descriptor *altsetting;
251 } libusb_interface __aligned(sizeof(void *));
253 typedef struct libusb_config_descriptor {
255 uint8_t bDescriptorType;
256 uint16_t wTotalLength;
257 uint8_t bNumInterfaces;
258 uint8_t bConfigurationValue;
259 uint8_t iConfiguration;
260 uint8_t bmAttributes;
262 struct libusb_interface *interface;
265 } libusb_config_descriptor __aligned(sizeof(void *));
267 typedef struct libusb_control_setup {
268 uint8_t bmRequestType;
273 } libusb_control_setup;
275 #define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */
277 typedef struct libusb_iso_packet_descriptor {
279 uint32_t actual_length;
280 enum libusb_transfer_status status;
281 } libusb_iso_packet_descriptor __aligned(sizeof(void *));
283 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
285 typedef struct libusb_transfer {
286 libusb_device_handle *dev_handle;
291 enum libusb_transfer_status status;
294 libusb_transfer_cb_fn callback;
299 struct libusb_iso_packet_descriptor iso_packet_desc[0];
300 } libusb_transfer __aligned(sizeof(void *));
302 /* Library initialisation */
304 void libusb_set_debug(libusb_context * ctx, int level);
305 const char *libusb_strerror(int code);
306 const char *libusb_error_name(int code);
307 int libusb_init(libusb_context ** context);
308 void libusb_exit(struct libusb_context *ctx);
310 /* Device handling and enumeration */
312 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
313 void libusb_free_device_list(libusb_device ** list, int unref_devices);
314 uint8_t libusb_get_bus_number(libusb_device * dev);
315 uint8_t libusb_get_device_address(libusb_device * dev);
316 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
317 int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
318 int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
319 libusb_device *libusb_ref_device(libusb_device * dev);
320 void libusb_unref_device(libusb_device * dev);
321 int libusb_open(libusb_device * dev, libusb_device_handle ** devh);
322 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
323 void libusb_close(libusb_device_handle * devh);
324 libusb_device *libusb_get_device(libusb_device_handle * devh);
325 int libusb_get_configuration(libusb_device_handle * devh, int *config);
326 int libusb_set_configuration(libusb_device_handle * devh, int configuration);
327 int libusb_claim_interface(libusb_device_handle * devh, int interface_number);
328 int libusb_release_interface(libusb_device_handle * devh, int interface_number);
329 int libusb_reset_device(libusb_device_handle * devh);
330 int libusb_check_connected(libusb_device_handle * devh);
331 int libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
332 int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
333 int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
334 int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
335 int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
336 int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
337 int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
339 /* USB Descriptors */
341 int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
342 int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
343 int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
344 int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
345 void libusb_free_config_descriptor(struct libusb_config_descriptor *config);
346 int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
347 int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
349 /* Asynchronous device I/O */
351 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
352 void libusb_free_transfer(struct libusb_transfer *transfer);
353 int libusb_submit_transfer(struct libusb_transfer *transfer);
354 int libusb_cancel_transfer(struct libusb_transfer *transfer);
355 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
356 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
357 void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
358 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
359 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
360 void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
361 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);
362 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);
363 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);
364 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);
366 /* Polling and timing */
368 int libusb_try_lock_events(libusb_context * ctx);
369 void libusb_lock_events(libusb_context * ctx);
370 void libusb_unlock_events(libusb_context * ctx);
371 int libusb_event_handling_ok(libusb_context * ctx);
372 int libusb_event_handler_active(libusb_context * ctx);
373 void libusb_lock_event_waiters(libusb_context * ctx);
374 void libusb_unlock_event_waiters(libusb_context * ctx);
375 int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
376 int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
377 int libusb_handle_events(libusb_context * ctx);
378 int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
379 int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
380 void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
381 struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);
383 /* Synchronous device I/O */
385 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);
386 int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
387 int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
391 uint16_t libusb_cpu_to_le16(uint16_t x);
392 uint16_t libusb_le16_to_cpu(uint16_t x);
402 #endif /* __LIBUSB_H__ */