xref: /netbsd-src/sys/dev/usb/uhidev.h (revision 627f7eb200a4419d89b531d55fccd2ee3ffdcde0)
1 /*	$NetBSD: uhidev.h,v 1.21 2020/11/29 22:54:51 riastradh Exp $	*/
2 
3 /*
4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net) at
9  * Carlstedt Research & Technology.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef	_DEV_USB_UHIDEV_H_
34 #define	_DEV_USB_UHIDEV_H_
35 
36 #include <sys/rndsource.h>
37 
38 struct uhidev_softc {
39 	device_t sc_dev;		/* base device */
40 	struct usbd_device *sc_udev;
41 	struct usbd_interface *sc_iface;	/* interface */
42 	int sc_iep_addr;
43 	int sc_oep_addr;
44 	u_int sc_isize;
45 
46 	int sc_repdesc_size;
47 	void *sc_repdesc;
48 
49 	u_int sc_nrepid;
50 	device_t *sc_subdevs;
51 
52 	kmutex_t sc_lock;
53 	kcondvar_t sc_cv;
54 
55 	/* Read/written under sc_lock.  */
56 	struct lwp *sc_writelock;
57 	struct lwp *sc_configlock;
58 	int sc_refcnt;
59 	int sc_writereportid;
60 	u_char sc_dying;
61 
62 	/*
63 	 * - Read under sc_lock, provided sc_refcnt > 0.
64 	 * - Written under sc_configlock only when transitioning to and
65 	 *   from sc_refcnt = 0.
66 	 */
67 	u_char *sc_ibuf;
68 	struct usbd_pipe *sc_ipipe;	/* input interrupt pipe */
69 	struct usbd_pipe *sc_opipe;	/* output interrupt pipe */
70 	struct usbd_xfer *sc_oxfer;	/* write request */
71 
72 	u_int sc_flags;
73 #define UHIDEV_F_XB1	0x0001	/* Xbox 1 controller */
74 };
75 
76 struct uhidev {
77 	device_t sc_dev;		/* base device */
78 	struct uhidev_softc *sc_parent;
79 	uByte sc_report_id;
80 	uint8_t sc_state;	/* read/written under sc_parent->sc_lock */
81 #define	UHIDEV_OPEN	0x01	/* device is open */
82 	int sc_in_rep_size;
83 	void (*sc_intr)(struct uhidev *, void *, u_int);
84 	krndsource_t     rnd_source;
85 };
86 
87 struct uhidev_attach_arg {
88 	struct usbif_attach_arg *uiaa;
89 	struct uhidev_softc *parent;
90 	int reportid;
91 	int reportsize;
92 };
93 
94 void uhidev_get_report_desc(struct uhidev_softc *, void **, int *);
95 int uhidev_open(struct uhidev *);
96 void uhidev_stop(struct uhidev *);
97 void uhidev_close(struct uhidev *);
98 usbd_status uhidev_set_report(struct uhidev *, int, void *, int);
99 usbd_status uhidev_get_report(struct uhidev *, int, void *, int);
100 usbd_status uhidev_write(struct uhidev_softc *, void *, int);
101 
102 #define	UHIDEV_OSIZE	64
103 
104 #endif	/* _DEV_USB_UHIDEV_H_ */
105