xref: /freebsd/lib/libusb/libusb10.h (revision bca5df45652ae4edd14fa032be8f271e044d32b2)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef __LIBUSB10_H__
29 #define	__LIBUSB10_H__
30 
31 #ifndef LIBUSB_GLOBAL_INCLUDE_FILE
32 #include <sys/cdefs.h>
33 #include <sys/queue.h>
34 #include <netlink/netlink.h>
35 #include <netlink/netlink_generic.h>
36 #include <netlink/netlink_snl.h>
37 #include <netlink/netlink_snl_generic.h>
38 #include <netlink/netlink_sysevent.h>
39 
40 #endif
41 
42 #define	GET_CONTEXT(ctx) (((ctx) == NULL) ? usbi_default_context : (ctx))
43 #define	UNEXPORTED __attribute__((__visibility__("hidden")))
44 #define	CTX_LOCK(ctx) pthread_mutex_lock(&(ctx)->ctx_lock)
45 #define	CTX_TRYLOCK(ctx) pthread_mutex_trylock(&(ctx)->ctx_lock)
46 #define	CTX_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->ctx_lock)
47 #define	HOTPLUG_LOCK(ctx) pthread_mutex_lock(&(ctx)->hotplug_lock)
48 #define	HOTPLUG_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->hotplug_lock)
49 
50 void libusb_log_va_args(struct libusb_context *ctx, enum libusb_log_level level,
51     const char *fmt, ...) __printflike(3, 4);
52 
53 #define DPRINTF(ctx, dbg, format, ...) \
54 	libusb_log_va_args(ctx, dbg, format, ##__VA_ARGS__)
55 
56 /* internal structures */
57 
58 struct libusb_super_pollfd {
59 	TAILQ_ENTRY(libusb_super_pollfd) entry;
60 	struct libusb20_device *pdev;
61 	struct libusb_pollfd pollfd;
62 };
63 
64 struct libusb_super_transfer {
65 	TAILQ_ENTRY(libusb_super_transfer) entry;
66 	uint8_t *curr_data;
67 	uint32_t rem_len;
68 	uint32_t last_len;
69 	uint32_t stream_id;
70 	uint8_t	state;
71 #define	LIBUSB_SUPER_XFER_ST_NONE 0
72 #define	LIBUSB_SUPER_XFER_ST_PEND 1
73 };
74 
75 struct libusb_hotplug_callback_handle_struct {
76 	TAILQ_ENTRY(libusb_hotplug_callback_handle_struct) entry;
77 	int events;
78 	int vendor;
79 	int product;
80 	int devclass;
81 	libusb_hotplug_callback_fn fn;
82 	void *user_data;
83 };
84 
85 TAILQ_HEAD(libusb_device_head, libusb_device);
86 
87 typedef enum {
88 	usb_event_none,
89 	usb_event_scan,
90 	usb_event_devd,
91 	usb_event_netlink
92 } usb_event_mode_t;
93 
94 struct libusb_context {
95 	int	debug;
96 	int	debug_fixed;
97 	int	event;
98 	int	tr_done_ref;
99 	int	tr_done_gen;
100 	usb_event_mode_t usb_event_mode;
101 	int	devd_pipe;
102 	struct	snl_state ss;
103 
104 	pthread_mutex_t ctx_lock;
105   	pthread_mutex_t hotplug_lock;
106 	pthread_cond_t ctx_cond;
107 	pthread_t hotplug_handler;
108 	pthread_t ctx_handler;
109 #define	NO_THREAD ((pthread_t)-1)
110 
111 	TAILQ_HEAD(, libusb_super_pollfd) pollfds;
112 	TAILQ_HEAD(, libusb_super_transfer) tr_done;
113 	TAILQ_HEAD(, libusb_hotplug_callback_handle_struct) hotplug_cbh;
114 	struct libusb_device_head hotplug_devs;
115 
116 	struct libusb_super_pollfd ctx_poll;
117 
118 	libusb_pollfd_added_cb fd_added_cb;
119 	libusb_pollfd_removed_cb fd_removed_cb;
120 	void   *fd_cb_user_data;
121 };
122 
123 struct libusb_device {
124 	int	refcnt;
125 
126 	int	device_is_gone;
127 
128 	uint32_t claimed_interfaces;
129 
130 	struct libusb_super_pollfd dev_poll;
131 
132 	struct libusb_context *ctx;
133 	struct libusb_device *parent_dev;
134 
135 	TAILQ_ENTRY(libusb_device) hotplug_entry;
136 
137 	TAILQ_HEAD(, libusb_super_transfer) tr_head;
138 
139 	struct libusb20_device *os_priv;
140 };
141 
142 extern struct libusb_context *usbi_default_context;
143 
144 void	libusb10_add_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd, struct libusb20_device *pdev, int fd, short events);
145 void	libusb10_remove_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd);
146 void	libusb10_cancel_all_transfer(libusb_device *dev);
147 void	libusb10_cancel_all_transfer_locked(struct libusb20_device *pdev, struct libusb_device *dev);
148 
149 #endif					/* __LIBUSB10_H__ */
150