2 * Internal header for libusb
3 * Copyright (C) 2007 Daniel Drake <dsd@gentoo.org>
4 * Copyright (c) 2001 Johannes Erdfelt <johannes@erdfelt.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <sys/select.h>
33 #define DEVICE_DESC_LENGTH 18
35 #define USB_MAXENDPOINTS 32
36 #define USB_MAXINTERFACES 32
37 #define USB_MAXCONFIG 8
40 struct list_head *prev, *next;
43 /* Get an entry from the list
44 * ptr - the address of this list_head element in "type"
45 * type - the data type that contains "member"
46 * member - the list_head element in "type"
48 #define list_entry(ptr, type, member) \
49 ((type *)((char *)(ptr) - (unsigned long)(&((type *)0L)->member)))
51 /* Get each entry from a list
52 * pos - A structure pointer has a "member" element
54 * member - the list_head element in "pos"
56 #define list_for_each_entry(pos, head, member) \
57 for (pos = list_entry((head)->next, typeof(*pos), member); \
58 &pos->member != (head); \
59 pos = list_entry(pos->member.next, typeof(*pos), member))
61 #define list_for_each_entry_safe(pos, n, head, member) \
62 for (pos = list_entry((head)->next, typeof(*pos), member), \
63 n = list_entry(pos->member.next, typeof(*pos), member); \
64 &pos->member != (head); \
65 pos = n, n = list_entry(n->member.next, typeof(*n), member))
67 #define list_empty(entry) ((entry)->next == (entry))
69 static inline void list_init(struct list_head *entry)
71 entry->prev = entry->next = entry;
74 static inline void list_add(struct list_head *entry, struct list_head *head)
76 entry->next = head->next;
79 head->next->prev = entry;
83 static inline void list_add_tail(struct list_head *entry,
84 struct list_head *head)
87 entry->prev = head->prev;
89 head->prev->next = entry;
93 static inline void list_del(struct list_head *entry)
95 entry->next->prev = entry->prev;
96 entry->prev->next = entry->next;
99 #define container_of(ptr, type, member) ({ \
100 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
101 (type *)( (char *)__mptr - offsetof(type,member) );})
103 #define MIN(a, b) ((a) < (b) ? (a) : (b))
104 #define MAX(a, b) ((a) > (b) ? (a) : (b))
106 #define TIMESPEC_IS_SET(ts) ((ts)->tv_sec != 0 || (ts)->tv_nsec != 0)
108 enum usbi_log_level {
115 void usbi_log(enum usbi_log_level, const char *function, const char *format, ...);
117 #ifdef ENABLE_LOGGING
118 #define _usbi_log(level, fmt...) usbi_log(level, __FUNCTION__, fmt)
120 #define _usbi_log(level, fmt...)
123 #ifdef ENABLE_DEBUG_LOGGING
124 #define usbi_dbg(fmt...) _usbi_log(LOG_LEVEL_DEBUG, fmt)
126 #define usbi_dbg(fmt...)
129 #define usbi_info(fmt...) _usbi_log(LOG_LEVEL_INFO, fmt)
130 #define usbi_warn(fmt...) _usbi_log(LOG_LEVEL_WARNING, fmt)
131 #define usbi_err(fmt...) _usbi_log(LOG_LEVEL_ERROR, fmt)
133 struct libusb_device {
134 /* lock protects refcnt, everything else is finalized at initialization
136 pthread_mutex_t lock;
140 uint8_t device_address;
141 uint8_t num_configurations;
143 struct list_head list;
144 unsigned long session_data;
145 unsigned char os_priv[0];
148 struct libusb_device_handle {
149 /* lock protects claimed_interfaces */
150 pthread_mutex_t lock;
151 unsigned long claimed_interfaces;
153 struct list_head list;
154 struct libusb_device *dev;
155 unsigned char os_priv[0];
158 #define USBI_TRANSFER_TIMED_OUT (1<<0)
160 /* in-memory transfer layout:
162 * 1. struct usbi_transfer
163 * 2. struct libusb_transfer (which includes iso packets) [variable size]
164 * 3. os private data [variable size]
166 * from a libusb_transfer, you can get the usbi_transfer by rewinding the
167 * appropriate number of bytes.
168 * the usbi_transfer includes the number of allocated packets, so you can
169 * determine the size of the transfer and hence the start and length of the
173 struct usbi_transfer {
175 struct list_head list;
176 struct timeval timeout;
181 #define __USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer) \
182 ((struct libusb_transfer *)(((void *)(transfer)) \
183 + sizeof(struct usbi_transfer)))
184 #define __LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer) \
185 ((struct usbi_transfer *)(((void *)(transfer)) \
186 - sizeof(struct usbi_transfer)))
188 static inline void *usbi_transfer_get_os_priv(struct usbi_transfer *transfer)
190 return ((void *)transfer) + sizeof(struct usbi_transfer)
191 + sizeof(struct libusb_transfer)
192 + (transfer->num_iso_packets
193 * sizeof(struct libusb_iso_packet_descriptor));
198 /* All standard descriptors have these 2 fields in common */
199 struct usb_descriptor_header {
201 uint8_t bDescriptorType;
204 /* shared data and functions */
206 extern struct list_head usbi_open_devs;
207 extern pthread_mutex_t usbi_open_devs_lock;
209 void usbi_io_init(void);
211 struct libusb_device *usbi_alloc_device(unsigned long session_id);
212 struct libusb_device *usbi_get_device_by_session_id(unsigned long session_id);
213 int usbi_sanitize_device(struct libusb_device *dev);
215 void usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
216 enum libusb_transfer_status status);
217 void usbi_handle_transfer_cancellation(struct usbi_transfer *transfer);
219 int usbi_parse_descriptor(unsigned char *source, char *descriptor, void *dest);
220 int usbi_get_config_index_by_value(struct libusb_device *dev,
221 uint8_t bConfigurationValue, int *idx);
226 /* must come first */
227 struct libusb_pollfd pollfd;
229 struct list_head list;
232 int usbi_add_pollfd(int fd, short events);
233 void usbi_remove_pollfd(int fd);
235 /* device discovery */
237 /* we traverse usbfs without knowing how many devices we are going to find.
238 * so we create this discovered_devs model which is similar to a linked-list
239 * which grows when required. it can be freed once discovery has completed,
240 * eliminating the need for a list node in the libusb_device structure
242 struct discovered_devs {
245 struct libusb_device *devices[0];
248 struct discovered_devs *discovered_devs_append(
249 struct discovered_devs *discdevs, struct libusb_device *dev);
253 struct usbi_os_backend {
258 int (*get_device_list)(struct discovered_devs **discdevs);
260 int (*open)(struct libusb_device_handle *handle);
261 void (*close)(struct libusb_device_handle *handle);
263 int (*get_device_descriptor)(struct libusb_device *device,
264 unsigned char *buffer);
265 int (*get_active_config_descriptor)(struct libusb_device *device,
266 unsigned char *buffer, size_t len);
267 int (*get_config_descriptor)(struct libusb_device *device,
268 uint8_t config_index, unsigned char *buffer, size_t len);
270 int (*set_configuration)(struct libusb_device_handle *handle, int config);
272 int (*claim_interface)(struct libusb_device_handle *handle, int iface);
273 int (*release_interface)(struct libusb_device_handle *handle, int iface);
275 int (*set_interface_altsetting)(struct libusb_device_handle *handle,
276 int iface, int altsetting);
277 int (*clear_halt)(struct libusb_device_handle *handle,
278 unsigned char endpoint);
279 int (*reset_device)(struct libusb_device_handle *handle);
282 int (*kernel_driver_active)(struct libusb_device_handle *handle,
284 int (*detach_kernel_driver)(struct libusb_device_handle *handle,
287 void (*destroy_device)(struct libusb_device *dev);
289 int (*submit_transfer)(struct usbi_transfer *itransfer);
290 int (*cancel_transfer)(struct usbi_transfer *itransfer);
292 int (*handle_events)(fd_set *readfds, fd_set *writefds);
294 /* number of bytes to reserve for libusb_device.os_priv */
295 size_t device_priv_size;
297 /* number of bytes to reserve for libusb_device_handle.os_priv */
298 size_t device_handle_priv_size;
300 /* number of bytes to reserve for usbi_transfer.os_priv */
301 size_t transfer_priv_size;
303 /* number of additional bytes for os_priv for each iso packet */
304 /* FIXME: linux can't use this any more. if other OS's cannot either,
305 * then remove this */
306 size_t add_iso_packet_size;
309 extern const struct usbi_os_backend * const usbi_backend;
311 extern const struct usbi_os_backend linux_usbfs_backend;