00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021 #ifndef __LIBUSB_H__
00022 #define __LIBUSB_H__
00023
00024 #include <endian.h>
00025 #include <stdint.h>
00026 #include <sys/time.h>
00027 #include <sys/types.h>
00028 #include <time.h>
00029
00030 #define bswap16(x) (((x & 0xff) << 8) | (x >> 8))
00031 #if __BYTE_ORDER == __LITTLE_ENDIAN
00032 #define libusb_cpu_to_le16(x) (x)
00033 #define libusb_le16_to_cpu(x) (x)
00034 #elif __BYTE_ORDER == __BIG_ENDIAN
00035 #define libusb_le16_to_cpu(x) bswap16(x)
00036 #define libusb_cpu_to_le16(x) bswap16(x)
00037 #else
00038 #error "Unrecognized endianness"
00039 #endif
00040
00059 #ifdef __cplusplus
00060 extern "C" {
00061 #endif
00062
00063
00064
00067 enum libusb_class_code {
00072 LIBUSB_CLASS_PER_INTERFACE = 0,
00073
00075 LIBUSB_CLASS_AUDIO = 1,
00076
00078 LIBUSB_CLASS_COMM = 2,
00079
00081 LIBUSB_CLASS_HID = 3,
00082
00084 LIBUSB_CLASS_PRINTER = 7,
00085
00087 LIBUSB_CLASS_PTP = 6,
00088
00090 LIBUSB_CLASS_MASS_STORAGE = 8,
00091
00093 LIBUSB_CLASS_HUB = 9,
00094
00096 LIBUSB_CLASS_DATA = 10,
00097
00099 LIBUSB_CLASS_VENDOR_SPEC = 0xff,
00100 };
00101
00104 enum libusb_descriptor_type {
00106 LIBUSB_DT_DEVICE = 0x01,
00107
00109 LIBUSB_DT_CONFIG = 0x02,
00110
00112 LIBUSB_DT_STRING = 0x03,
00113
00115 LIBUSB_DT_INTERFACE = 0x04,
00116
00118 LIBUSB_DT_ENDPOINT = 0x05,
00119
00121 LIBUSB_DT_HID = 0x21,
00122
00124 LIBUSB_DT_REPORT = 0x22,
00125
00127 LIBUSB_DT_PHYSICAL = 0x23,
00128
00130 LIBUSB_DT_HUB = 0x29,
00131 };
00132
00133
00134 #define LIBUSB_DT_DEVICE_SIZE 18
00135 #define LIBUSB_DT_CONFIG_SIZE 9
00136 #define LIBUSB_DT_INTERFACE_SIZE 9
00137 #define LIBUSB_DT_ENDPOINT_SIZE 7
00138 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9
00139 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
00140
00141 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f
00142 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
00143
00148 enum libusb_endpoint_direction {
00150 LIBUSB_ENDPOINT_IN = 0x80,
00151
00153 LIBUSB_ENDPOINT_OUT = 0x00,
00154 };
00155
00156 #define LIBUSB_TRANSFER_TYPE_MASK 0x03
00157
00162 enum libusb_transfer_type {
00164 LIBUSB_TRANSFER_TYPE_CONTROL = 0,
00165
00167 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
00168
00170 LIBUSB_TRANSFER_TYPE_BULK = 2,
00171
00173 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
00174 };
00175
00178 enum libusb_standard_request {
00180 LIBUSB_REQUEST_GET_STATUS = 0x00,
00181
00183 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
00184
00185
00186
00188 LIBUSB_REQUEST_SET_FEATURE = 0x03,
00189
00190
00191
00193 LIBUSB_REQUEST_SET_ADDRESS = 0x05,
00194
00196 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
00197
00199 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
00200
00202 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
00203
00205 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
00206
00208 LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
00209
00211 LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
00212
00214 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
00215 };
00216
00221 enum libusb_request_type {
00223 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
00224
00226 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
00227
00229 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
00230
00232 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
00233 };
00234
00239 enum libusb_request_recipient {
00241 LIBUSB_RECIPIENT_DEVICE = 0x00,
00242
00244 LIBUSB_RECIPIENT_INTERFACE = 0x01,
00245
00247 LIBUSB_RECIPIENT_ENDPOINT = 0x02,
00248
00250 LIBUSB_RECIPIENT_OTHER = 0x03,
00251 };
00252
00253 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
00254
00260 enum libusb_iso_sync_type {
00262 LIBUSB_ISO_SYNC_TYPE_NONE = 0,
00263
00265 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
00266
00268 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
00269
00271 LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
00272 };
00273
00274 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
00275
00281 enum libusb_iso_usage_type {
00283 LIBUSB_ISO_USAGE_TYPE_DATA = 0,
00284
00286 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
00287
00289 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
00290 };
00291
00297 struct libusb_device_descriptor {
00299 uint8_t bLength;
00300
00304 uint8_t bDescriptorType;
00305
00308 uint16_t bcdUSB;
00309
00311 uint8_t bDeviceClass;
00312
00315 uint8_t bDeviceSubClass;
00316
00319 uint8_t bDeviceProtocol;
00320
00322 uint8_t bMaxPacketSize0;
00323
00325 uint16_t idVendor;
00326
00328 uint16_t idProduct;
00329
00331 uint16_t bcdDevice;
00332
00334 uint8_t iManufacturer;
00335
00337 uint8_t iProduct;
00338
00340 uint8_t iSerialNumber;
00341
00343 uint8_t bNumConfigurations;
00344 };
00345
00351 struct libusb_endpoint_descriptor {
00353 uint8_t bLength;
00354
00358 uint8_t bDescriptorType;
00359
00364 uint8_t bEndpointAddress;
00365
00373 uint8_t bmAttributes;
00374
00376 uint16_t wMaxPacketSize;
00377
00379 uint8_t bInterval;
00380
00383 uint8_t bRefresh;
00384
00386 uint8_t bSynchAddress;
00387
00390 const unsigned char *extra;
00391
00393 int extra_length;
00394 };
00395
00401 struct libusb_interface_descriptor {
00403 uint8_t bLength;
00404
00408 uint8_t bDescriptorType;
00409
00411 uint8_t bInterfaceNumber;
00412
00414 uint8_t bAlternateSetting;
00415
00418 uint8_t bNumEndpoints;
00419
00421 uint8_t bInterfaceClass;
00422
00425 uint8_t bInterfaceSubClass;
00426
00429 uint8_t bInterfaceProtocol;
00430
00432 uint8_t iInterface;
00433
00436 const struct libusb_endpoint_descriptor *endpoint;
00437
00440 const unsigned char *extra;
00441
00443 int extra_length;
00444 };
00445
00449 struct libusb_interface {
00452 const struct libusb_interface_descriptor *altsetting;
00453
00455 int num_altsetting;
00456 };
00457
00463 struct libusb_config_descriptor {
00465 uint8_t bLength;
00466
00470 uint8_t bDescriptorType;
00471
00473 uint16_t wTotalLength;
00474
00476 uint8_t bNumInterfaces;
00477
00479 uint8_t bConfigurationValue;
00480
00482 uint8_t iConfiguration;
00483
00485 uint8_t bmAttributes;
00486
00490 uint8_t MaxPower;
00491
00494 const struct libusb_interface *interface;
00495
00498 const unsigned char *extra;
00499
00501 int extra_length;
00502 };
00503
00506 struct libusb_control_setup {
00512 uint8_t bmRequestType;
00513
00519 uint8_t bRequest;
00520
00522 uint16_t wValue;
00523
00526 uint16_t wIndex;
00527
00529 uint16_t wLength;
00530 };
00531
00532 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
00533
00534
00535
00536 struct libusb_context;
00537 struct libusb_device;
00538 struct libusb_device_handle;
00539
00557 typedef struct libusb_context libusb_context;
00558
00574 typedef struct libusb_device libusb_device;
00575
00576
00585 typedef struct libusb_device_handle libusb_device_handle;
00586
00591 enum libusb_error {
00593 LIBUSB_SUCCESS = 0,
00594
00596 LIBUSB_ERROR_IO = -1,
00597
00599 LIBUSB_ERROR_INVALID_PARAM = -2,
00600
00602 LIBUSB_ERROR_ACCESS = -3,
00603
00605 LIBUSB_ERROR_NO_DEVICE = -4,
00606
00608 LIBUSB_ERROR_NOT_FOUND = -5,
00609
00611 LIBUSB_ERROR_BUSY = -6,
00612
00614 LIBUSB_ERROR_TIMEOUT = -7,
00615
00617 LIBUSB_ERROR_OVERFLOW = -8,
00618
00620 LIBUSB_ERROR_PIPE = -9,
00621
00623 LIBUSB_ERROR_INTERRUPTED = -10,
00624
00626 LIBUSB_ERROR_NO_MEM = -11,
00627
00629 LIBUSB_ERROR_NOT_SUPPORTED = -12,
00630
00632 LIBUSB_ERROR_OTHER = -99,
00633 };
00634
00637 enum libusb_transfer_status {
00640 LIBUSB_TRANSFER_COMPLETED,
00641
00643 LIBUSB_TRANSFER_ERROR,
00644
00646 LIBUSB_TRANSFER_TIMED_OUT,
00647
00649 LIBUSB_TRANSFER_CANCELLED,
00650
00653 LIBUSB_TRANSFER_STALL,
00654
00656 LIBUSB_TRANSFER_NO_DEVICE,
00657
00659 LIBUSB_TRANSFER_OVERFLOW,
00660 };
00661
00664 enum libusb_transfer_flags {
00666 LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0,
00667
00669 LIBUSB_TRANSFER_FREE_BUFFER = 1<<1,
00670
00675 LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2,
00676 };
00677
00680 struct libusb_iso_packet_descriptor {
00682 unsigned int length;
00683
00685 unsigned int actual_length;
00686
00688 enum libusb_transfer_status status;
00689 };
00690
00691 struct libusb_transfer;
00692
00693 typedef void (*libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
00694
00698 struct libusb_transfer {
00700 libusb_device_handle *dev_handle;
00701
00703 uint8_t flags;
00704
00706 unsigned char endpoint;
00707
00709 unsigned char type;
00710
00713 unsigned int timeout;
00714
00722 enum libusb_transfer_status status;
00723
00725 int length;
00726
00730 int actual_length;
00731
00734 libusb_transfer_cb_fn callback;
00735
00737 void *user_data;
00738
00740 unsigned char *buffer;
00741
00744 int num_iso_packets;
00745
00747 struct libusb_iso_packet_descriptor iso_packet_desc[0];
00748 };
00749
00750 int libusb_init(libusb_context **ctx);
00751 void libusb_exit(libusb_context *ctx);
00752 void libusb_set_debug(libusb_context *ctx, int level);
00753
00754 ssize_t libusb_get_device_list(libusb_context *ctx,
00755 libusb_device ***list);
00756 void libusb_free_device_list(libusb_device **list, int unref_devices);
00757 libusb_device *libusb_ref_device(libusb_device *dev);
00758 void libusb_unref_device(libusb_device *dev);
00759
00760 int libusb_get_configuration(libusb_device_handle *dev, int *config);
00761 int libusb_get_device_descriptor(libusb_device *dev,
00762 struct libusb_device_descriptor *desc);
00763 int libusb_get_active_config_descriptor(libusb_device *dev,
00764 struct libusb_config_descriptor **config);
00765 int libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index,
00766 struct libusb_config_descriptor **config);
00767 int libusb_get_config_descriptor_by_value(libusb_device *dev,
00768 uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
00769 void libusb_free_config_descriptor(struct libusb_config_descriptor *config);
00770 uint8_t libusb_get_bus_number(libusb_device *dev);
00771 uint8_t libusb_get_device_address(libusb_device *dev);
00772 int libusb_get_max_packet_size(libusb_device *dev, unsigned char endpoint);
00773
00774 int libusb_open(libusb_device *dev, libusb_device_handle **handle);
00775 void libusb_close(libusb_device_handle *dev_handle);
00776 libusb_device *libusb_get_device(libusb_device_handle *dev_handle);
00777
00778 int libusb_set_configuration(libusb_device_handle *dev, int configuration);
00779 int libusb_claim_interface(libusb_device_handle *dev, int iface);
00780 int libusb_release_interface(libusb_device_handle *dev, int iface);
00781
00782 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context *ctx,
00783 uint16_t vendor_id, uint16_t product_id);
00784
00785 int libusb_set_interface_alt_setting(libusb_device_handle *dev,
00786 int interface_number, int alternate_setting);
00787 int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint);
00788 int libusb_reset_device(libusb_device_handle *dev);
00789
00790 int libusb_kernel_driver_active(libusb_device_handle *dev, int interface);
00791 int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface);
00792
00793
00794
00807 static inline unsigned char *libusb_control_transfer_get_data(
00808 struct libusb_transfer *transfer)
00809 {
00810 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
00811 }
00812
00825 static inline struct libusb_control_setup *libusb_control_transfer_get_setup(
00826 struct libusb_transfer *transfer)
00827 {
00828 return (struct libusb_control_setup *) transfer->buffer;
00829 }
00830
00853 static inline void libusb_fill_control_setup(unsigned char *buffer,
00854 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
00855 uint16_t wLength)
00856 {
00857 struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
00858 setup->bmRequestType = bmRequestType;
00859 setup->bRequest = bRequest;
00860 setup->wValue = libusb_cpu_to_le16(wValue);
00861 setup->wIndex = libusb_cpu_to_le16(wIndex);
00862 setup->wLength = libusb_cpu_to_le16(wLength);
00863 }
00864
00865 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
00866 int libusb_submit_transfer(struct libusb_transfer *transfer);
00867 int libusb_cancel_transfer(struct libusb_transfer *transfer);
00868 void libusb_free_transfer(struct libusb_transfer *transfer);
00869
00897 static inline void libusb_fill_control_transfer(
00898 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
00899 unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
00900 unsigned int timeout)
00901 {
00902 struct libusb_control_setup *setup = (struct libusb_control_setup *) buffer;
00903 transfer->dev_handle = dev_handle;
00904 transfer->endpoint = 0;
00905 transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
00906 transfer->timeout = timeout;
00907 transfer->buffer = buffer;
00908 if (setup)
00909 transfer->length = LIBUSB_CONTROL_SETUP_SIZE
00910 + libusb_le16_to_cpu(setup->wLength);
00911 transfer->user_data = user_data;
00912 transfer->callback = callback;
00913 }
00914
00928 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
00929 libusb_device_handle *dev_handle, unsigned char endpoint,
00930 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
00931 void *user_data, unsigned int timeout)
00932 {
00933 transfer->dev_handle = dev_handle;
00934 transfer->endpoint = endpoint;
00935 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
00936 transfer->timeout = timeout;
00937 transfer->buffer = buffer;
00938 transfer->length = length;
00939 transfer->user_data = user_data;
00940 transfer->callback = callback;
00941 }
00942
00956 static inline void libusb_fill_interrupt_transfer(
00957 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
00958 unsigned char endpoint, unsigned char *buffer, int length,
00959 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
00960 {
00961 transfer->dev_handle = dev_handle;
00962 transfer->endpoint = endpoint;
00963 transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
00964 transfer->timeout = timeout;
00965 transfer->buffer = buffer;
00966 transfer->length = length;
00967 transfer->user_data = user_data;
00968 transfer->callback = callback;
00969 }
00970
00985 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
00986 libusb_device_handle *dev_handle, unsigned char endpoint,
00987 unsigned char *buffer, int length, int num_iso_packets,
00988 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
00989 {
00990 transfer->dev_handle = dev_handle;
00991 transfer->endpoint = endpoint;
00992 transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
00993 transfer->timeout = timeout;
00994 transfer->buffer = buffer;
00995 transfer->length = length;
00996 transfer->num_iso_packets = num_iso_packets;
00997 transfer->user_data = user_data;
00998 transfer->callback = callback;
00999 }
01000
01009 static inline void libusb_set_iso_packet_lengths(
01010 struct libusb_transfer *transfer, unsigned int length)
01011 {
01012 int i;
01013 for (i = 0; i < transfer->num_iso_packets; i++)
01014 transfer->iso_packet_desc[i].length = length;
01015 }
01016
01033 static inline unsigned char *libusb_get_iso_packet_buffer(
01034 struct libusb_transfer *transfer, unsigned int packet)
01035 {
01036 int i;
01037 size_t offset = 0;
01038
01039 if (packet >= transfer->num_iso_packets)
01040 return NULL;
01041
01042 for (i = 0; i < packet; i++)
01043 offset += transfer->iso_packet_desc[i].length;
01044
01045 return transfer->buffer + offset;
01046 }
01047
01067 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
01068 struct libusb_transfer *transfer, unsigned int packet)
01069 {
01070 if (packet >= transfer->num_iso_packets)
01071 return NULL;
01072
01073 return transfer->buffer + (transfer->iso_packet_desc[0].length * packet);
01074 }
01075
01076
01077
01078 int libusb_control_transfer(libusb_device_handle *dev_handle,
01079 uint8_t request_type, uint8_t request, uint16_t value, uint16_t index,
01080 unsigned char *data, uint16_t length, unsigned int timeout);
01081
01082 int libusb_bulk_transfer(libusb_device_handle *dev_handle,
01083 unsigned char endpoint, unsigned char *data, int length,
01084 int *actual_length, unsigned int timeout);
01085
01086 int libusb_interrupt_transfer(libusb_device_handle *dev_handle,
01087 unsigned char endpoint, unsigned char *data, int length,
01088 int *actual_length, unsigned int timeout);
01089
01102 static inline int libusb_get_descriptor(libusb_device_handle *dev,
01103 uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
01104 {
01105 return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
01106 LIBUSB_REQUEST_GET_DESCRIPTOR, (desc_type << 8) | desc_index, 0, data,
01107 length, 1000);
01108 }
01109
01124 static inline int libusb_get_string_descriptor(libusb_device_handle *dev,
01125 uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
01126 {
01127 return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
01128 LIBUSB_REQUEST_GET_DESCRIPTOR, (LIBUSB_DT_STRING << 8) | desc_index,
01129 langid, data, length, 1000);
01130 }
01131
01132 int libusb_get_string_descriptor_ascii(libusb_device_handle *dev,
01133 uint8_t index, unsigned char *data, int length);
01134
01135
01136
01137 int libusb_try_lock_events(libusb_context *ctx);
01138 void libusb_lock_events(libusb_context *ctx);
01139 void libusb_unlock_events(libusb_context *ctx);
01140 int libusb_event_handler_active(libusb_context *ctx);
01141 void libusb_lock_event_waiters(libusb_context *ctx);
01142 void libusb_unlock_event_waiters(libusb_context *ctx);
01143 int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
01144
01145 int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv);
01146 int libusb_handle_events(libusb_context *ctx);
01147 int libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv);
01148 int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv);
01149
01153 struct libusb_pollfd {
01155 int fd;
01156
01161 short events;
01162 };
01163
01174 typedef void (*libusb_pollfd_added_cb)(int fd, short events, void *user_data);
01175
01185 typedef void (*libusb_pollfd_removed_cb)(int fd, void *user_data);
01186
01187 const struct libusb_pollfd **libusb_get_pollfds(libusb_context *ctx);
01188 void libusb_set_pollfd_notifiers(libusb_context *ctx,
01189 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
01190 void *user_data);
01191
01192 #ifdef __cplusplus
01193 }
01194 #endif
01195
01196 #endif