summaryrefslogtreecommitdiffstats
path: root/lib/libusb/libusb.h
blob: 58a8918098f877f388c11b02e569d3bc34fdd769 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/* $FreeBSD$ */
/*-
 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef __LIBUSB_H__
#define	__LIBUSB_H__

#include <sys/time.h>
#include <sys/types.h>
#include <sys/endian.h>
#include <sys/queue.h>

#include <stdint.h>
#include <time.h>
#include <string.h>
#include <pthread.h>


#ifdef __cplusplus
extern	"C" {
#endif
#if 0
}					/* indent fix */

#endif

/* libusb enums */

enum libusb_class_code {
	LIBUSB_CLASS_PER_INTERFACE = 0,
	LIBUSB_CLASS_AUDIO = 1,
	LIBUSB_CLASS_COMM = 2,
	LIBUSB_CLASS_HID = 3,
	LIBUSB_CLASS_PTP = 6,
	LIBUSB_CLASS_PRINTER = 7,
	LIBUSB_CLASS_MASS_STORAGE = 8,
	LIBUSB_CLASS_HUB = 9,
	LIBUSB_CLASS_DATA = 10,
	LIBUSB_CLASS_VENDOR_SPEC = 0xff,
};

enum libusb_descriptor_type {
	LIBUSB_DT_DEVICE = 0x01,
	LIBUSB_DT_CONFIG = 0x02,
	LIBUSB_DT_STRING = 0x03,
	LIBUSB_DT_INTERFACE = 0x04,
	LIBUSB_DT_ENDPOINT = 0x05,
	LIBUSB_DT_HID = 0x21,
	LIBUSB_DT_REPORT = 0x22,
	LIBUSB_DT_PHYSICAL = 0x23,
	LIBUSB_DT_HUB = 0x29,
};

#define	LIBUSB_DT_DEVICE_SIZE		18
#define	LIBUSB_DT_CONFIG_SIZE		9
#define	LIBUSB_DT_INTERFACE_SIZE	9
#define	LIBUSB_DT_ENDPOINT_SIZE		7
#define	LIBUSB_DT_ENDPOINT_AUDIO_SIZE	9
#define	LIBUSB_DT_HUB_NONVAR_SIZE	7

#define	LIBUSB_ENDPOINT_ADDRESS_MASK	0x0f
#define	LIBUSB_ENDPOINT_DIR_MASK	0x80

enum libusb_endpoint_direction {
	LIBUSB_ENDPOINT_IN = 0x80,
	LIBUSB_ENDPOINT_OUT = 0x00,
};

#define	LIBUSB_TRANSFER_TYPE_MASK	0x03

enum libusb_transfer_type {
	LIBUSB_TRANSFER_TYPE_CONTROL = 0,
	LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
	LIBUSB_TRANSFER_TYPE_BULK = 2,
	LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
};

enum libusb_standard_request {
	LIBUSB_REQUEST_GET_STATUS = 0x00,
	LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
	LIBUSB_REQUEST_SET_FEATURE = 0x03,
	LIBUSB_REQUEST_SET_ADDRESS = 0x05,
	LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
	LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
	LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
	LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
	LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
	LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
	LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
};

enum libusb_request_type {
	LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
	LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
	LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
	LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
};

enum libusb_request_recipient {
	LIBUSB_RECIPIENT_DEVICE = 0x00,
	LIBUSB_RECIPIENT_INTERFACE = 0x01,
	LIBUSB_RECIPIENT_ENDPOINT = 0x02,
	LIBUSB_RECIPIENT_OTHER = 0x03,
};

#define	LIBUSB_ISO_SYNC_TYPE_MASK	0x0C

enum libusb_iso_sync_type {
	LIBUSB_ISO_SYNC_TYPE_NONE = 0,
	LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
	LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
	LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
};

#define	LIBUSB_ISO_USAGE_TYPE_MASK 0x30

enum libusb_iso_usage_type {
	LIBUSB_ISO_USAGE_TYPE_DATA = 0,
	LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
	LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
};

enum libusb_error {
	LIBUSB_SUCCESS = 0,
	LIBUSB_ERROR_IO = -1,
	LIBUSB_ERROR_INVALID_PARAM = -2,
	LIBUSB_ERROR_ACCESS = -3,
	LIBUSB_ERROR_NO_DEVICE = -4,
	LIBUSB_ERROR_NOT_FOUND = -5,
	LIBUSB_ERROR_BUSY = -6,
	LIBUSB_ERROR_TIMEOUT = -7,
	LIBUSB_ERROR_OVERFLOW = -8,
	LIBUSB_ERROR_PIPE = -9,
	LIBUSB_ERROR_INTERRUPTED = -10,
	LIBUSB_ERROR_NO_MEM = -11,
	LIBUSB_ERROR_NOT_SUPPORTED = -12,
	LIBUSB_ERROR_OTHER = -99,
};

enum libusb_transfer_status {
	LIBUSB_TRANSFER_COMPLETED,
	LIBUSB_TRANSFER_ERROR,
	LIBUSB_TRANSFER_TIMED_OUT,
	LIBUSB_TRANSFER_CANCELLED,
	LIBUSB_TRANSFER_STALL,
	LIBUSB_TRANSFER_NO_DEVICE,
	LIBUSB_TRANSFER_OVERFLOW,
};

enum libusb_transfer_flags {
	LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
	LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
	LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
};

enum libusb_debug_level {
	LIBUSB_DEBUG_NO=0,
	LIBUSB_DEBUG_FUNCTION=1,
	LIBUSB_DEBUG_TRANSFER=2,
};

/* internal structures */

typedef struct libusb_pollfd {
	int	fd;
	short	events;
}	libusb_pollfd;

struct usb_pollfd {
	TAILQ_ENTRY(usb_pollfd) list;
	struct libusb_pollfd pollfd;
};

struct usb_transfer {
	TAILQ_ENTRY(usb_transfer) list;
	int num_iso_packets;
	struct timeval timeout;
	int transferred;
	uint8_t flags;
};

struct usb_ep_tr {
	TAILQ_ENTRY(usb_ep_tr) list;
	uint8_t addr;
	uint8_t idx;
	uint8_t flags;
	void *os_priv;
};
/* libusb structures */

typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);

typedef struct libusb_context {
	int	debug;
	int	debug_fixed;

	int	ctrl_pipe[2];

	TAILQ_HEAD(usb_devs_list, libusb_device) usb_devs;
	pthread_mutex_t usb_devs_lock;

	TAILQ_HEAD(open_devs_list, libusb_device_handle) open_devs;
	pthread_mutex_t open_devs_lock;

	TAILQ_HEAD(flying_transfers_list, usb_transfer) flying_transfers;
	pthread_mutex_t flying_transfers_lock;

	TAILQ_HEAD(pollfds_list, usb_pollfd) pollfds;
	pthread_mutex_t pollfds_lock;

	unsigned int pollfd_modify;
	pthread_mutex_t pollfd_modify_lock;

	libusb_pollfd_added_cb fd_added_cb;
	libusb_pollfd_removed_cb fd_removed_cb;
	void   *fd_cb_user_data;

	pthread_mutex_t events_lock;
	int	event_handler_active;

	pthread_mutex_t event_waiters_lock;
	pthread_cond_t event_waiters_cond;
}	libusb_context;

typedef struct libusb_device {
	pthread_mutex_t lock;
	int	refcnt;

	struct libusb_context *ctx;

	uint8_t	bus_number;
	uint8_t	device_address;
	uint8_t	num_configurations;

	TAILQ_ENTRY(libusb_device) list;
	unsigned long session_data;
	void   *os_priv;
}	libusb_device;

typedef struct libusb_device_handle {
	pthread_mutex_t lock;
	unsigned long claimed_interfaces;

	TAILQ_ENTRY(libusb_device_handle) list;
	struct libusb_device *dev;
	void   *os_priv;
	TAILQ_HEAD(ep_list, usb_ep_tr) ep_list; 
}	libusb_device_handle;

typedef struct libusb_device_descriptor {
	uint8_t	bLength;
	uint8_t	bDescriptorType;
	uint16_t bcdUSB;
	uint8_t	bDeviceClass;
	uint8_t	bDeviceSubClass;
	uint8_t	bDeviceProtocol;
	uint8_t	bMaxPacketSize0;
	uint16_t idVendor;
	uint16_t idProduct;
	uint16_t bcdDevice;
	uint8_t	iManufacturer;
	uint8_t	iProduct;
	uint8_t	iSerialNumber;
	uint8_t	bNumConfigurations;
}	libusb_device_descriptor;

typedef struct libusb_endpoint_descriptor {
	uint8_t	bLength;
	uint8_t	bDescriptorType;
	uint8_t	bEndpointAddress;
	uint8_t	bmAttributes;
	uint16_t wMaxPacketSize;
	uint8_t	bInterval;
	uint8_t	bRefresh;
	uint8_t	bSynchAddress;
	unsigned char *extra;
	int	extra_length;
}	libusb_endpoint_descriptor __aligned(sizeof(void *));

typedef struct libusb_interface_descriptor {
	uint8_t	bLength;
	uint8_t	bDescriptorType;
	uint8_t	bInterfaceNumber;
	uint8_t	bAlternateSetting;
	uint8_t	bNumEndpoints;
	uint8_t	bInterfaceClass;
	uint8_t	bInterfaceSubClass;
	uint8_t	bInterfaceProtocol;
	uint8_t	iInterface;
	struct libusb_endpoint_descriptor *endpoint;
	unsigned char *extra;
	int	extra_length;
}	libusb_interface_descriptor __aligned(sizeof(void *));

typedef struct libusb_interface {
	struct libusb_interface_descriptor *altsetting;
	int	num_altsetting;
}	libusb_interface __aligned(sizeof(void *));

typedef struct libusb_config_descriptor {
	uint8_t	bLength;
	uint8_t	bDescriptorType;
	uint16_t wTotalLength;
	uint8_t	bNumInterfaces;
	uint8_t	bConfigurationValue;
	uint8_t	iConfiguration;
	uint8_t	bmAttributes;
	uint8_t	MaxPower;
	struct libusb_interface *interface;
	unsigned char *extra;
	int	extra_length;
}	libusb_config_descriptor __aligned(sizeof(void *));

typedef struct libusb_control_setup {
	uint8_t	bmRequestType;
	uint8_t	bRequest;
	uint16_t wValue;
	uint16_t wIndex;
	uint16_t wLength;
}	libusb_control_setup;

typedef struct libusb_iso_packet_descriptor {
	unsigned int length;
	unsigned int actual_length;
	enum libusb_transfer_status status;
}	libusb_iso_packet_descriptor __aligned(sizeof(void *));

struct libusb_transfer;

typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);

typedef struct libusb_transfer {
	libusb_device_handle *dev_handle;
	uint8_t	flags;
	unsigned int endpoint;
	unsigned char type;
	unsigned int timeout;
	enum libusb_transfer_status status;
	int	length;
	int	actual_length;
	libusb_transfer_cb_fn callback;
	void   *user_data;
	unsigned char *buffer;
	void *os_priv;
	int	num_iso_packets;
	struct libusb_iso_packet_descriptor iso_packet_desc[0];
}	libusb_transfer __aligned(sizeof(void *));

/* Library initialisation */

void	libusb_set_debug(libusb_context * ctx, int level);
int	libusb_init(libusb_context ** context);
void	libusb_exit(struct libusb_context *ctx);

/* Device handling and enumeration */

ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
void	libusb_free_device_list(libusb_device ** list, int unref_devices);
uint8_t	libusb_get_bus_number(libusb_device * dev);
uint8_t	libusb_get_device_address(libusb_device * dev);
int	libusb_clear_halt(libusb_device_handle *devh, unsigned char endpoint);
int	libusb_get_max_packet_size(libusb_device * dev, unsigned char endpoint);
libusb_device *libusb_ref_device(libusb_device * dev);
void	libusb_unref_device(libusb_device * dev);
int	libusb_open(libusb_device * dev, libusb_device_handle ** devh);
libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
void	libusb_close(libusb_device_handle * devh);
libusb_device *libusb_get_device(libusb_device_handle * devh);
int	libusb_get_configuration(libusb_device_handle * devh, int *config);
int	libusb_set_configuration(libusb_device_handle * devh, int configuration);
int	libusb_claim_interface(libusb_device_handle * devh, int interface_number);
int	libusb_release_interface(libusb_device_handle * devh, int interface_number);
int 	libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
int 	libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
int 	libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
int	libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);

/* USB Descriptors */

int	libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
int	libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
int	libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
int	libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
void	libusb_free_config_descriptor(struct libusb_config_descriptor *config);
int	libusb_get_string_descriptor_ascii(libusb_device_handle * dev, uint8_t desc_index, unsigned char *data, int length);

/* Asynchronous device I/O*/

struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
void	libusb_free_transfer(struct libusb_transfer *transfer);
int	libusb_submit_transfer(struct libusb_transfer *transfer);
int	libusb_cancel_transfer(struct libusb_transfer *transfer);
unsigned char *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, unsigned int packet);

/* Polling and timing */

int	libusb_try_lock_events(libusb_context * ctx);
void	libusb_lock_events(libusb_context * ctx);
void	libusb_unlock_events(libusb_context * ctx);
int	libusb_event_handling_ok(libusb_context * ctx);
int	libusb_event_handler_active(libusb_context * ctx);
void	libusb_lock_event_waiters(libusb_context * ctx);
void	libusb_unlock_event_waiters(libusb_context * ctx);
int	libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
int	libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
int	libusb_handle_events(libusb_context * ctx);
int	libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
int	libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
void	libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);

/* Synchronous device I/O */

int	libusb_control_transfer(libusb_device_handle * devh, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, unsigned char *data, uint16_t wLength, unsigned int timeout);
int	libusb_bulk_transfer(struct libusb_device_handle *devh, unsigned char endpoint, unsigned char *data, int length, int *transferred, unsigned int timeout);
int	libusb_interrupt_transfer(struct libusb_device_handle *devh, unsigned char endpoint, unsigned char *data, int length, int *transferred, unsigned int timeout);

#if 0
{					/* indent fix */
#endif
#ifdef __cplusplus
}

#endif

#endif					/* __LIBUSB_H__ */
OpenPOWER on IntegriCloud