xref: /third_party/FreeBSD/sys/dev/usb/usbhid.h (revision f9f848fa) 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
6 * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#ifndef _USB_HID_H_
31#define	_USB_HID_H_
32
33#define	UR_GET_HID_DESCRIPTOR	0x06
34#define	UDESC_HID		0x21
35#define	UDESC_REPORT		0x22
36#define	UDESC_PHYSICAL		0x23
37#define	UR_SET_HID_DESCRIPTOR	0x07
38#define	UR_GET_REPORT		0x01
39#define	UR_SET_REPORT		0x09
40#define	UR_GET_IDLE		0x02
41#define	UR_SET_IDLE		0x0a
42#define	UR_GET_PROTOCOL		0x03
43#define	UR_SET_PROTOCOL		0x0b
44
45struct usb_hid_descriptor {
46	uByte	bLength;
47	uByte	bDescriptorType;
48	uWord	bcdHID;
49	uByte	bCountryCode;
50	uByte	bNumDescriptors;
51	struct {
52		uByte	bDescriptorType;
53		uWord	wDescriptorLength;
54	}	descrs[1];
55} __packed;
56
57#define	USB_HID_DESCRIPTOR_SIZE(n) (9+((n)*3))
58
59/* Usage pages */
60#define	HUP_UNDEFINED		0x0000
61#define	HUP_GENERIC_DESKTOP	0x0001
62#define	HUP_SIMULATION		0x0002
63#define	HUP_VR_CONTROLS		0x0003
64#define	HUP_SPORTS_CONTROLS	0x0004
65#define	HUP_GAMING_CONTROLS	0x0005
66#define	HUP_KEYBOARD		0x0007
67#define	HUP_LEDS		0x0008
68#define	HUP_BUTTON		0x0009
69#define	HUP_ORDINALS		0x000a
70#define	HUP_TELEPHONY		0x000b
71#define	HUP_CONSUMER		0x000c
72#define	HUP_DIGITIZERS		0x000d
73#define	HUP_PHYSICAL_IFACE	0x000e
74#define	HUP_UNICODE		0x0010
75#define	HUP_ALPHANUM_DISPLAY	0x0014
76#define	HUP_MONITOR		0x0080
77#define	HUP_MONITOR_ENUM_VAL	0x0081
78#define	HUP_VESA_VC		0x0082
79#define	HUP_VESA_CMD		0x0083
80#define	HUP_POWER		0x0084
81#define	HUP_BATTERY_SYSTEM	0x0085
82#define	HUP_BARCODE_SCANNER	0x008b
83#define	HUP_SCALE		0x008c
84#define	HUP_CAMERA_CONTROL	0x0090
85#define	HUP_ARCADE		0x0091
86#define	HUP_MICROSOFT		0xff00
87
88/* Usages, generic desktop */
89#define	HUG_POINTER		0x0001
90#define	HUG_MOUSE		0x0002
91#define	HUG_JOYSTICK		0x0004
92#define	HUG_GAME_PAD		0x0005
93#define	HUG_KEYBOARD		0x0006
94#define	HUG_KEYPAD		0x0007
95#define	HUG_X			0x0030
96#define	HUG_Y			0x0031
97#define	HUG_Z			0x0032
98#define	HUG_RX			0x0033
99#define	HUG_RY			0x0034
100#define	HUG_RZ			0x0035
101#define	HUG_SLIDER		0x0036
102#define	HUG_DIAL		0x0037
103#define	HUG_WHEEL		0x0038
104#define	HUG_HAT_SWITCH		0x0039
105#define	HUG_COUNTED_BUFFER	0x003a
106#define	HUG_BYTE_COUNT		0x003b
107#define	HUG_MOTION_WAKEUP	0x003c
108#define	HUG_VX			0x0040
109#define	HUG_VY			0x0041
110#define	HUG_VZ			0x0042
111#define	HUG_VBRX		0x0043
112#define	HUG_VBRY		0x0044
113#define	HUG_VBRZ		0x0045
114#define	HUG_VNO			0x0046
115#define	HUG_TWHEEL		0x0048	/* M$ Wireless Intellimouse Wheel */
116#define	HUG_SYSTEM_CONTROL	0x0080
117#define	HUG_SYSTEM_POWER_DOWN	0x0081
118#define	HUG_SYSTEM_SLEEP	0x0082
119#define	HUG_SYSTEM_WAKEUP	0x0083
120#define	HUG_SYSTEM_CONTEXT_MENU	0x0084
121#define	HUG_SYSTEM_MAIN_MENU	0x0085
122#define	HUG_SYSTEM_APP_MENU	0x0086
123#define	HUG_SYSTEM_MENU_HELP	0x0087
124#define	HUG_SYSTEM_MENU_EXIT	0x0088
125#define	HUG_SYSTEM_MENU_SELECT	0x0089
126#define	HUG_SYSTEM_MENU_RIGHT	0x008a
127#define	HUG_SYSTEM_MENU_LEFT	0x008b
128#define	HUG_SYSTEM_MENU_UP	0x008c
129#define	HUG_SYSTEM_MENU_DOWN	0x008d
130#define	HUG_APPLE_EJECT		0x00b8
131
132/* Usages Digitizers */
133#define	HUD_UNDEFINED		0x0000
134#define	HUD_DIGITIZER		0x0001
135#define	HUD_PEN			0x0002
136#define	HUD_TOUCHSCREEN		0x0004
137#define	HUD_TOUCHPAD		0x0005
138#define	HUD_CONFIG		0x000e
139#define	HUD_FINGER		0x0022
140#define	HUD_TIP_PRESSURE	0x0030
141#define	HUD_BARREL_PRESSURE	0x0031
142#define	HUD_IN_RANGE		0x0032
143#define	HUD_TOUCH		0x0033
144#define	HUD_UNTOUCH		0x0034
145#define	HUD_TAP			0x0035
146#define	HUD_QUALITY		0x0036
147#define	HUD_DATA_VALID		0x0037
148#define	HUD_TRANSDUCER_INDEX	0x0038
149#define	HUD_TABLET_FKEYS	0x0039
150#define	HUD_PROGRAM_CHANGE_KEYS	0x003a
151#define	HUD_BATTERY_STRENGTH	0x003b
152#define	HUD_INVERT		0x003c
153#define	HUD_X_TILT		0x003d
154#define	HUD_Y_TILT		0x003e
155#define	HUD_AZIMUTH		0x003f
156#define	HUD_ALTITUDE		0x0040
157#define	HUD_TWIST		0x0041
158#define	HUD_TIP_SWITCH		0x0042
159#define	HUD_SEC_TIP_SWITCH	0x0043
160#define	HUD_BARREL_SWITCH	0x0044
161#define	HUD_ERASER		0x0045
162#define	HUD_TABLET_PICK		0x0046
163#define	HUD_CONFIDENCE		0x0047
164#define	HUD_WIDTH		0x0048
165#define	HUD_HEIGHT		0x0049
166#define	HUD_CONTACTID		0x0051
167#define	HUD_INPUT_MODE		0x0052
168#define	HUD_DEVICE_INDEX	0x0053
169#define	HUD_CONTACTCOUNT	0x0054
170#define	HUD_CONTACT_MAX		0x0055
171#define	HUD_SCAN_TIME		0x0056
172#define	HUD_BUTTON_TYPE		0x0059
173
174/* Usages, Consumer */
175#define	HUC_AC_PAN		0x0238
176
177#define	HID_USAGE2(p,u) (((p) << 16) | (u))
178
179#define	UHID_INPUT_REPORT 0x01
180#define	UHID_OUTPUT_REPORT 0x02
181#define	UHID_FEATURE_REPORT 0x03
182
183/* Bits in the input/output/feature items */
184#define	HIO_CONST	0x001
185#define	HIO_VARIABLE	0x002
186#define	HIO_RELATIVE	0x004
187#define	HIO_WRAP	0x008
188#define	HIO_NONLINEAR	0x010
189#define	HIO_NOPREF	0x020
190#define	HIO_NULLSTATE	0x040
191#define	HIO_VOLATILE	0x080
192#define	HIO_BUFBYTES	0x100
193
194/* Units of Measure */
195#define	HUM_CENTIMETER	0x11
196#define	HUM_RADIAN	0x12
197#define	HUM_INCH	0x13
198#define	HUM_DEGREE	0x14
199
200#ifdef _KERNEL
201struct usb_config_descriptor;
202
203enum hid_kind {
204	hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
205};
206
207struct hid_location {
208	uint32_t size;
209	uint32_t count;
210	uint32_t pos;
211};
212
213struct hid_item {
214	/* Global */
215	int32_t	_usage_page;
216	int32_t	logical_minimum;
217	int32_t	logical_maximum;
218	int32_t	physical_minimum;
219	int32_t	physical_maximum;
220	int32_t	unit_exponent;
221	int32_t	unit;
222	int32_t	report_ID;
223	/* Local */
224	int32_t	usage;
225	int32_t	usage_minimum;
226	int32_t	usage_maximum;
227	int32_t	designator_index;
228	int32_t	designator_minimum;
229	int32_t	designator_maximum;
230	int32_t	string_index;
231	int32_t	string_minimum;
232	int32_t	string_maximum;
233	int32_t	set_delimiter;
234	/* Misc */
235	int32_t	collection;
236	int	collevel;
237	enum hid_kind kind;
238	uint32_t flags;
239	/* Location */
240	struct hid_location loc;
241};
242
243/* prototypes from "usb_hid.c" */
244
245struct hid_data *hid_start_parse(const void *d, usb_size_t len, int kindset);
246void	hid_end_parse(struct hid_data *s);
247int	hid_get_item(struct hid_data *s, struct hid_item *h);
248int	hid_report_size(const void *buf, usb_size_t len, enum hid_kind k,
249	    uint8_t *id);
250int	hid_locate(const void *desc, usb_size_t size, int32_t usage,
251	    enum hid_kind kind, uint8_t index, struct hid_location *loc,
252	    uint32_t *flags, uint8_t *id);
253int32_t hid_get_data(const uint8_t *buf, usb_size_t len,
254	    struct hid_location *loc);
255uint32_t hid_get_data_unsigned(const uint8_t *buf, usb_size_t len,
256	    struct hid_location *loc);
257void hid_put_data_unsigned(uint8_t *buf, usb_size_t len,
258	    struct hid_location *loc, unsigned int value);
259int	hid_is_collection(const void *desc, usb_size_t size, int32_t usage);
260struct usb_hid_descriptor *hid_get_descriptor_from_usb(
261	    struct usb_config_descriptor *cd,
262	    struct usb_interface_descriptor *id);
263usb_error_t usbd_req_get_hid_desc(struct usb_device *udev, struct mtx *mtx,
264	    void **descp, uint16_t *sizep, struct malloc_type *mem,
265	    uint8_t iface_index);
266int	hid_is_mouse(const void *d_ptr, uint16_t d_len);
267int	hid_is_keyboard(const void *d_ptr, uint16_t d_len);
268#endif					/* _KERNEL */
269#endif					/* _USB_HID_H_ */
270