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