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
29 #include <sys/select.h>
34 #define DEVICE_DESC_LENGTH 18
36 #define USB_MAXENDPOINTS 32
37 #define USB_MAXINTERFACES 32
38 #define USB_MAXCONFIG 8
41 struct list_head *prev, *next;
44 /* Get an entry from the list
45 * ptr - the address of this list_head element in "type"
46 * type - the data type that contains "member"
47 * member - the list_head element in "type"
49 #define list_entry(ptr, type, member) \
50 ((type *)((char *)(ptr) - (unsigned long)(&((type *)0L)->member)))
52 /* Get each entry from a list
53 * pos - A structure pointer has a "member" element
55 * member - the list_head element in "pos"
57 #define list_for_each_entry(pos, head, member) \
58 for (pos = list_entry((head)->next, typeof(*pos), member); \
59 &pos->member != (head); \
60 pos = list_entry(pos->member.next, typeof(*pos), member))
62 #define list_for_each_entry_safe(pos, n, head, member) \
63 for (pos = list_entry((head)->next, typeof(*pos), member), \
64 n = list_entry(pos->member.next, typeof(*pos), member); \
65 &pos->member != (head); \
66 pos = n, n = list_entry(n->member.next, typeof(*n), member))
68 #define list_empty(entry) ((entry)->next == (entry))
70 static inline void list_init(struct list_head *entry)
72 entry->prev = entry->next = entry;
75 static inline void list_add(struct list_head *entry, struct list_head *head)
77 entry->next = head->next;
80 head->next->prev = entry;
84 static inline void list_add_tail(struct list_head *entry,
85 struct list_head *head)
88 entry->prev = head->prev;
90 head->prev->next = entry;
94 static inline void list_del(struct list_head *entry)
96 entry->next->prev = entry->prev;
97 entry->prev->next = entry->next;
100 #define container_of(ptr, type, member) ({ \
101 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
102 (type *)( (char *)__mptr - offsetof(type,member) );})
104 #define bswap16(x) (((x & 0xff) << 8) | (x >> 8))
105 #if __BYTE_ORDER == __LITTLE_ENDIAN
106 #define cpu_to_le16(x) (x)
107 #define le16_to_cpu(x) (x)
108 #elif __BYTE_ORDER == __BIG_ENDIAN
109 #define le16_to_cpu(x) bswap16(x)
110 #define cpu_to_le16(x) bswap16(x)
112 #error "Unrecognized endianness"
115 #define MIN(a, b) ((a) < (b) ? (a) : (b))
116 #define MAX(a, b) ((a) > (b) ? (a) : (b))
118 #define TIMESPEC_IS_SET(ts) ((ts)->tv_sec != 0 || (ts)->tv_nsec != 0)
120 enum usbi_log_level {
127 void usbi_log(enum usbi_log_level, const char *function, const char *format, ...);
129 #ifdef ENABLE_LOGGING
130 #define _usbi_log(level, fmt...) usbi_log(level, __FUNCTION__, fmt)
132 #define _usbi_log(level, fmt...)
135 #ifdef ENABLE_DEBUG_LOGGING
136 #define usbi_dbg(fmt...) _usbi_log(LOG_LEVEL_DEBUG, fmt)
138 #define usbi_dbg(fmt...)
141 #define usbi_info(fmt...) _usbi_log(LOG_LEVEL_INFO, fmt)
142 #define usbi_warn(fmt...) _usbi_log(LOG_LEVEL_WARNING, fmt)
143 #define usbi_err(fmt...) _usbi_log(LOG_LEVEL_ERROR, fmt)
145 struct libusb_device {
146 /* lock protects refcnt, everything else is finalized at initialization
148 pthread_mutex_t lock;
152 uint8_t device_address;
153 uint8_t num_configurations;
155 struct list_head list;
156 unsigned long session_data;
157 unsigned char os_priv[0];
160 struct libusb_device_handle {
161 /* lock protects claimed_interfaces */
162 pthread_mutex_t lock;
163 unsigned long claimed_interfaces;
165 struct list_head list;
166 struct libusb_device *dev;
167 unsigned char os_priv[0];
170 #define USBI_TRANSFER_TIMED_OUT (1<<0)
172 /* in-memory transfer layout:
174 * 1. struct usbi_transfer
175 * 2. struct libusb_transfer (which includes iso packets) [variable size]
176 * 3. os private data [variable size]
178 * from a libusb_transfer, you can get the usbi_transfer by rewinding the
179 * appropriate number of bytes.
180 * the usbi_transfer includes the number of allocated packets, so you can
181 * determine the size of the transfer and hence the start and length of the
185 struct usbi_transfer {
187 struct list_head list;
188 struct timeval timeout;
193 #define __USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer) \
194 ((struct libusb_transfer *)(((void *)(transfer)) \
195 + sizeof(struct usbi_transfer)))
196 #define __LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer) \
197 ((struct usbi_transfer *)(((void *)(transfer)) \
198 - sizeof(struct usbi_transfer)))
200 static inline void *usbi_transfer_get_os_priv(struct usbi_transfer *transfer)
202 return ((void *)transfer) + sizeof(struct usbi_transfer)
203 + sizeof(struct libusb_transfer)
204 + (transfer->num_iso_packets
205 * sizeof(struct libusb_iso_packet_descriptor));
210 /* All standard descriptors have these 2 fields in common */
211 struct usb_descriptor_header {
213 uint8_t bDescriptorType;
216 /* shared data and functions */
218 extern struct list_head usbi_open_devs;
219 extern pthread_mutex_t usbi_open_devs_lock;
221 void usbi_io_init(void);
223 struct libusb_device *usbi_alloc_device(unsigned long session_id);
224 struct libusb_device *usbi_get_device_by_session_id(unsigned long session_id);
225 int usbi_sanitize_device(struct libusb_device *dev);
227 void usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
228 enum libusb_transfer_status status);
229 void usbi_handle_transfer_cancellation(struct usbi_transfer *transfer);
231 int usbi_parse_descriptor(unsigned char *source, char *descriptor, void *dest);
232 int usbi_get_config_index_by_value(struct libusb_device *dev,
233 uint8_t bConfigurationValue, int *idx);
238 /* must come first */
239 struct libusb_pollfd pollfd;
241 struct list_head list;
244 int usbi_add_pollfd(int fd, short events);
245 void usbi_remove_pollfd(int fd);
247 /* device discovery */
249 /* we traverse usbfs without knowing how many devices we are going to find.
250 * so we create this discovered_devs model which is similar to a linked-list
251 * which grows when required. it can be freed once discovery has completed,
252 * eliminating the need for a list node in the libusb_device structure
254 struct discovered_devs {
257 struct libusb_device *devices[0];
260 struct discovered_devs *discovered_devs_append(
261 struct discovered_devs *discdevs, struct libusb_device *dev);
265 struct usbi_os_backend {
270 int (*get_device_list)(struct discovered_devs **discdevs);
272 int (*open)(struct libusb_device_handle *handle);
273 void (*close)(struct libusb_device_handle *handle);
275 int (*get_device_descriptor)(struct libusb_device *device,
276 unsigned char *buffer);
277 int (*get_active_config_descriptor)(struct libusb_device *device,
278 unsigned char *buffer, size_t len);
279 int (*get_config_descriptor)(struct libusb_device *device,
280 uint8_t config_index, unsigned char *buffer, size_t len);
282 int (*set_configuration)(struct libusb_device_handle *handle, int config);
284 int (*claim_interface)(struct libusb_device_handle *handle, int iface);
285 int (*release_interface)(struct libusb_device_handle *handle, int iface);
287 int (*set_interface_altsetting)(struct libusb_device_handle *handle,
288 int iface, int altsetting);
289 int (*clear_halt)(struct libusb_device_handle *handle,
290 unsigned char endpoint);
291 int (*reset_device)(struct libusb_device_handle *handle);
294 int (*kernel_driver_active)(struct libusb_device_handle *handle,
296 int (*detach_kernel_driver)(struct libusb_device_handle *handle,
299 void (*destroy_device)(struct libusb_device *dev);
301 int (*submit_transfer)(struct usbi_transfer *itransfer);
302 int (*cancel_transfer)(struct usbi_transfer *itransfer);
304 int (*handle_events)(fd_set *readfds, fd_set *writefds);
306 /* number of bytes to reserve for libusb_device.os_priv */
307 size_t device_priv_size;
309 /* number of bytes to reserve for libusb_device_handle.os_priv */
310 size_t device_handle_priv_size;
312 /* number of bytes to reserve for usbi_transfer.os_priv */
313 size_t transfer_priv_size;
315 /* number of additional bytes for os_priv for each iso packet */
316 /* FIXME: linux can't use this any more. if other OS's cannot either,
317 * then remove this */
318 size_t add_iso_packet_size;
321 extern const struct usbi_os_backend * const usbi_backend;
323 extern const struct usbi_os_backend linux_usbfs_backend;