xref: /freebsd-src/lib/libusb/libusb10.h (revision 9dc96d8bc3f282fefb186670edbf07c7cc32f9c5)
18c8fff31SAndrew Thompson /*-
24d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
35e53a4f9SPedro F. Giffuni  *
48c8fff31SAndrew Thompson  * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
58c8fff31SAndrew Thompson  *
68c8fff31SAndrew Thompson  * Redistribution and use in source and binary forms, with or without
78c8fff31SAndrew Thompson  * modification, are permitted provided that the following conditions
88c8fff31SAndrew Thompson  * are met:
98c8fff31SAndrew Thompson  * 1. Redistributions of source code must retain the above copyright
108c8fff31SAndrew Thompson  *    notice, this list of conditions and the following disclaimer.
118c8fff31SAndrew Thompson  * 2. Redistributions in binary form must reproduce the above copyright
128c8fff31SAndrew Thompson  *    notice, this list of conditions and the following disclaimer in the
138c8fff31SAndrew Thompson  *    documentation and/or other materials provided with the distribution.
148c8fff31SAndrew Thompson  *
158c8fff31SAndrew Thompson  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
168c8fff31SAndrew Thompson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
178c8fff31SAndrew Thompson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
188c8fff31SAndrew Thompson  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
198c8fff31SAndrew Thompson  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
208c8fff31SAndrew Thompson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
218c8fff31SAndrew Thompson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
228c8fff31SAndrew Thompson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
238c8fff31SAndrew Thompson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
248c8fff31SAndrew Thompson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
258c8fff31SAndrew Thompson  * SUCH DAMAGE.
268c8fff31SAndrew Thompson  */
278c8fff31SAndrew Thompson 
288c8fff31SAndrew Thompson #ifndef __LIBUSB10_H__
298c8fff31SAndrew Thompson #define	__LIBUSB10_H__
308c8fff31SAndrew Thompson 
3166194130SHans Petter Selasky #ifndef LIBUSB_GLOBAL_INCLUDE_FILE
32390065b1SAlfred Perlstein #include <sys/queue.h>
33*9dc96d8bSBaptiste Daroussin #include <netlink/netlink.h>
34*9dc96d8bSBaptiste Daroussin #include <netlink/netlink_generic.h>
35*9dc96d8bSBaptiste Daroussin #include <netlink/netlink_snl.h>
36*9dc96d8bSBaptiste Daroussin #include <netlink/netlink_snl_generic.h>
37*9dc96d8bSBaptiste Daroussin #include <netlink/netlink_sysevent.h>
38*9dc96d8bSBaptiste Daroussin 
3966194130SHans Petter Selasky #endif
408c8fff31SAndrew Thompson 
41390065b1SAlfred Perlstein #define	GET_CONTEXT(ctx) (((ctx) == NULL) ? usbi_default_context : (ctx))
42c500e4ddSAndrew Thompson #define	UNEXPORTED __attribute__((__visibility__("hidden")))
43390065b1SAlfred Perlstein #define	CTX_LOCK(ctx) pthread_mutex_lock(&(ctx)->ctx_lock)
44390065b1SAlfred Perlstein #define	CTX_TRYLOCK(ctx) pthread_mutex_trylock(&(ctx)->ctx_lock)
45390065b1SAlfred Perlstein #define	CTX_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->ctx_lock)
467bdc064bSHans Petter Selasky #define	HOTPLUG_LOCK(ctx) pthread_mutex_lock(&(ctx)->hotplug_lock)
477bdc064bSHans Petter Selasky #define	HOTPLUG_UNLOCK(ctx) pthread_mutex_unlock(&(ctx)->hotplug_lock)
488c8fff31SAndrew Thompson 
495b21ba5cSHans Petter Selasky #define	DPRINTF(ctx, dbg, format, ...) do {			\
50390065b1SAlfred Perlstein 	switch (dbg) {						\
51c500e4ddSAndrew Thompson 	case LIBUSB_DEBUG_FUNCTION:				\
525b21ba5cSHans Petter Selasky 		if ((ctx)->debug & LIBUSB_DEBUG_FUNCTION) {	\
53390065b1SAlfred Perlstein 			printf("LIBUSB_FUNCTION: "		\
545b21ba5cSHans Petter Selasky 			       format "\n", ## __VA_ARGS__);	\
555b21ba5cSHans Petter Selasky 		}						\
56c500e4ddSAndrew Thompson 		break;						\
57c500e4ddSAndrew Thompson 	case LIBUSB_DEBUG_TRANSFER:				\
585b21ba5cSHans Petter Selasky 		if ((ctx)->debug & LIBUSB_DEBUG_TRANSFER) { 	\
59390065b1SAlfred Perlstein 			printf("LIBUSB_TRANSFER: "		\
605b21ba5cSHans Petter Selasky 			       format "\n", ## __VA_ARGS__);	\
615b21ba5cSHans Petter Selasky 		}						\
62390065b1SAlfred Perlstein 		break;						\
63390065b1SAlfred Perlstein 	default:						\
64c500e4ddSAndrew Thompson 		break;						\
65c500e4ddSAndrew Thompson 	}							\
66390065b1SAlfred Perlstein } while (0)
678c8fff31SAndrew Thompson 
68390065b1SAlfred Perlstein /* internal structures */
69390065b1SAlfred Perlstein 
70390065b1SAlfred Perlstein struct libusb_super_pollfd {
71390065b1SAlfred Perlstein 	TAILQ_ENTRY(libusb_super_pollfd) entry;
72390065b1SAlfred Perlstein 	struct libusb20_device *pdev;
73390065b1SAlfred Perlstein 	struct libusb_pollfd pollfd;
74390065b1SAlfred Perlstein };
75390065b1SAlfred Perlstein 
76390065b1SAlfred Perlstein struct libusb_super_transfer {
77390065b1SAlfred Perlstein 	TAILQ_ENTRY(libusb_super_transfer) entry;
78390065b1SAlfred Perlstein 	uint8_t *curr_data;
79390065b1SAlfred Perlstein 	uint32_t rem_len;
80390065b1SAlfred Perlstein 	uint32_t last_len;
81a0c93fa3SHans Petter Selasky 	uint32_t stream_id;
824594d907SAndrew Thompson 	uint8_t	state;
834594d907SAndrew Thompson #define	LIBUSB_SUPER_XFER_ST_NONE 0
844594d907SAndrew Thompson #define	LIBUSB_SUPER_XFER_ST_PEND 1
85390065b1SAlfred Perlstein };
86390065b1SAlfred Perlstein 
8756c926d0SHans Petter Selasky struct libusb_hotplug_callback_handle_struct {
8856c926d0SHans Petter Selasky 	TAILQ_ENTRY(libusb_hotplug_callback_handle_struct) entry;
897bdc064bSHans Petter Selasky 	int events;
907bdc064bSHans Petter Selasky 	int vendor;
917bdc064bSHans Petter Selasky 	int product;
927bdc064bSHans Petter Selasky 	int devclass;
937bdc064bSHans Petter Selasky 	libusb_hotplug_callback_fn fn;
947bdc064bSHans Petter Selasky 	void *user_data;
957bdc064bSHans Petter Selasky };
967bdc064bSHans Petter Selasky 
97a41b0ec1SHans Petter Selasky TAILQ_HEAD(libusb_device_head, libusb_device);
98a41b0ec1SHans Petter Selasky 
99*9dc96d8bSBaptiste Daroussin typedef enum {
100*9dc96d8bSBaptiste Daroussin 	usb_event_none,
101*9dc96d8bSBaptiste Daroussin 	usb_event_scan,
102*9dc96d8bSBaptiste Daroussin 	usb_event_devd,
103*9dc96d8bSBaptiste Daroussin 	usb_event_netlink
104*9dc96d8bSBaptiste Daroussin } usb_event_mode_t;
105*9dc96d8bSBaptiste Daroussin 
106390065b1SAlfred Perlstein struct libusb_context {
107390065b1SAlfred Perlstein 	int	debug;
108390065b1SAlfred Perlstein 	int	debug_fixed;
109390065b1SAlfred Perlstein 	int	ctrl_pipe[2];
110390065b1SAlfred Perlstein 	int	tr_done_ref;
111390065b1SAlfred Perlstein 	int	tr_done_gen;
112*9dc96d8bSBaptiste Daroussin 	usb_event_mode_t usb_event_mode;
113*9dc96d8bSBaptiste Daroussin 	int	devd_pipe;
114*9dc96d8bSBaptiste Daroussin 	struct	snl_state ss;
115390065b1SAlfred Perlstein 
116390065b1SAlfred Perlstein 	pthread_mutex_t ctx_lock;
1177bdc064bSHans Petter Selasky   	pthread_mutex_t hotplug_lock;
118390065b1SAlfred Perlstein 	pthread_cond_t ctx_cond;
1197bdc064bSHans Petter Selasky 	pthread_t hotplug_handler;
120390065b1SAlfred Perlstein 	pthread_t ctx_handler;
121390065b1SAlfred Perlstein #define	NO_THREAD ((pthread_t)-1)
122390065b1SAlfred Perlstein 
123390065b1SAlfred Perlstein 	TAILQ_HEAD(, libusb_super_pollfd) pollfds;
124390065b1SAlfred Perlstein 	TAILQ_HEAD(, libusb_super_transfer) tr_done;
12556c926d0SHans Petter Selasky 	TAILQ_HEAD(, libusb_hotplug_callback_handle_struct) hotplug_cbh;
126a41b0ec1SHans Petter Selasky 	struct libusb_device_head hotplug_devs;
127390065b1SAlfred Perlstein 
128390065b1SAlfred Perlstein 	struct libusb_super_pollfd ctx_poll;
129390065b1SAlfred Perlstein 
130390065b1SAlfred Perlstein 	libusb_pollfd_added_cb fd_added_cb;
131390065b1SAlfred Perlstein 	libusb_pollfd_removed_cb fd_removed_cb;
132390065b1SAlfred Perlstein 	void   *fd_cb_user_data;
133390065b1SAlfred Perlstein };
134390065b1SAlfred Perlstein 
135390065b1SAlfred Perlstein struct libusb_device {
136390065b1SAlfred Perlstein 	int	refcnt;
137390065b1SAlfred Perlstein 
138540c7229SHans Petter Selasky 	int	device_is_gone;
139540c7229SHans Petter Selasky 
140390065b1SAlfred Perlstein 	uint32_t claimed_interfaces;
141390065b1SAlfred Perlstein 
142390065b1SAlfred Perlstein 	struct libusb_super_pollfd dev_poll;
143390065b1SAlfred Perlstein 
144390065b1SAlfred Perlstein 	struct libusb_context *ctx;
145390065b1SAlfred Perlstein 
1467bdc064bSHans Petter Selasky 	TAILQ_ENTRY(libusb_device) hotplug_entry;
1477bdc064bSHans Petter Selasky 
148390065b1SAlfred Perlstein 	TAILQ_HEAD(, libusb_super_transfer) tr_head;
149390065b1SAlfred Perlstein 
150390065b1SAlfred Perlstein 	struct libusb20_device *os_priv;
151390065b1SAlfred Perlstein };
152390065b1SAlfred Perlstein 
153390065b1SAlfred Perlstein extern struct libusb_context *usbi_default_context;
154390065b1SAlfred Perlstein 
155390065b1SAlfred Perlstein void	libusb10_add_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd, struct libusb20_device *pdev, int fd, short events);
156390065b1SAlfred Perlstein void	libusb10_remove_pollfd(libusb_context *ctx, struct libusb_super_pollfd *pollfd);
157390065b1SAlfred Perlstein void	libusb10_cancel_all_transfer(libusb_device *dev);
158540c7229SHans Petter Selasky void	libusb10_cancel_all_transfer_locked(struct libusb20_device *pdev, struct libusb_device *dev);
1598c8fff31SAndrew Thompson 
1608c8fff31SAndrew Thompson #endif					/* __LIBUSB10_H__ */
161