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 _HID_HID_H_
31#define _HID_HID_H_
32
33/* Usage pages */
34#define HUP_UNDEFINED 0x0000
35#define HUP_GENERIC_DESKTOP 0x0001
36#define HUP_SIMULATION 0x0002
37#define HUP_VR_CONTROLS 0x0003
38#define HUP_SPORTS_CONTROLS 0x0004
39#define HUP_GAMING_CONTROLS 0x0005
40#define HUP_KEYBOARD 0x0007
41#define HUP_LEDS 0x0008
42#define HUP_BUTTON 0x0009
43#define HUP_ORDINALS 0x000a
44#define HUP_TELEPHONY 0x000b
45#define HUP_CONSUMER 0x000c
46#define HUP_DIGITIZERS 0x000d
47#define HUP_PHYSICAL_IFACE 0x000e
48#define HUP_UNICODE 0x0010
49#define HUP_ALPHANUM_DISPLAY 0x0014
50#define HUP_MONITOR 0x0080
51#define HUP_MONITOR_ENUM_VAL 0x0081
52#define HUP_VESA_VC 0x0082
53#define HUP_VESA_CMD 0x0083
54#define HUP_POWER 0x0084
55#define HUP_BATTERY_SYSTEM 0x0085
56#define HUP_BARCODE_SCANNER 0x008b
57#define HUP_SCALE 0x008c
58#define HUP_CAMERA_CONTROL 0x0090
59#define HUP_ARCADE 0x0091
60#define HUP_FIDO 0xf1d0
61#define HUP_MICROSOFT 0xff00
62
63/* Usages, generic desktop */
64#define HUG_POINTER 0x0001
65#define HUG_MOUSE 0x0002
66#define HUG_JOYSTICK 0x0004
67#define HUG_GAME_PAD 0x0005
68#define HUG_KEYBOARD 0x0006
69#define HUG_KEYPAD 0x0007
70#define HUG_MULTIAXIS_CNTROLLER 0x0008
71#define HUG_X 0x0030
72#define HUG_Y 0x0031
73#define HUG_Z 0x0032
74#define HUG_RX 0x0033
75#define HUG_RY 0x0034
76#define HUG_RZ 0x0035
77#define HUG_SLIDER 0x0036
78#define HUG_DIAL 0x0037
79#define HUG_WHEEL 0x0038
80#define HUG_HAT_SWITCH 0x0039
81#define HUG_COUNTED_BUFFER 0x003a
82#define HUG_BYTE_COUNT 0x003b
83#define HUG_MOTION_WAKEUP 0x003c
84#define HUG_VX 0x0040
85#define HUG_VY 0x0041
86#define HUG_VZ 0x0042
87#define HUG_VBRX 0x0043
88#define HUG_VBRY 0x0044
89#define HUG_VBRZ 0x0045
90#define HUG_VNO 0x0046
91#define HUG_TWHEEL 0x0048 /* M$ Wireless Intellimouse Wheel */
92#define HUG_SYSTEM_CONTROL 0x0080
93#define HUG_SYSTEM_POWER_DOWN 0x0081
94#define HUG_SYSTEM_SLEEP 0x0082
95#define HUG_SYSTEM_WAKEUP 0x0083
96#define HUG_SYSTEM_CONTEXT_MENU 0x0084
97#define HUG_SYSTEM_MAIN_MENU 0x0085
98#define HUG_SYSTEM_APP_MENU 0x0086
99#define HUG_SYSTEM_MENU_HELP 0x0087
100#define HUG_SYSTEM_MENU_EXIT 0x0088
101#define HUG_SYSTEM_MENU_SELECT 0x0089
102#define HUG_SYSTEM_MENU_RIGHT 0x008a
103#define HUG_SYSTEM_MENU_LEFT 0x008b
104#define HUG_SYSTEM_MENU_UP 0x008c
105#define HUG_SYSTEM_MENU_DOWN 0x008d
106#define HUG_SYSTEM_POWER_UP 0x008e
107#define HUG_SYSTEM_RESTART 0x008f
108#define HUG_D_PAD_UP 0x0090
109#define HUG_D_PAD_DOWN 0x0091
110#define HUG_D_PAD_RIGHT 0x0092
111#define HUG_D_PAD_LEFT 0x0093
112#define HUG_APPLE_EJECT 0x00b8
113
114/* Usages Digitizers */
115#define HUD_UNDEFINED 0x0000
116#define HUD_DIGITIZER 0x0001
117#define HUD_PEN 0x0002
118#define HUD_TOUCHSCREEN 0x0004
119#define HUD_TOUCHPAD 0x0005
120#define HUD_CONFIG 0x000e
121#define HUD_FINGER 0x0022
122#define HUD_TIP_PRESSURE 0x0030
123#define HUD_BARREL_PRESSURE 0x0031
124#define HUD_IN_RANGE 0x0032
125#define HUD_TOUCH 0x0033
126#define HUD_UNTOUCH 0x0034
127#define HUD_TAP 0x0035
128#define HUD_QUALITY 0x0036
129#define HUD_DATA_VALID 0x0037
130#define HUD_TRANSDUCER_INDEX 0x0038
131#define HUD_TABLET_FKEYS 0x0039
132#define HUD_PROGRAM_CHANGE_KEYS 0x003a
133#define HUD_BATTERY_STRENGTH 0x003b
134#define HUD_INVERT 0x003c
135#define HUD_X_TILT 0x003d
136#define HUD_Y_TILT 0x003e
137#define HUD_AZIMUTH 0x003f
138#define HUD_ALTITUDE 0x0040
139#define HUD_TWIST 0x0041
140#define HUD_TIP_SWITCH 0x0042
141#define HUD_SEC_TIP_SWITCH 0x0043
142#define HUD_BARREL_SWITCH 0x0044
143#define HUD_ERASER 0x0045
144#define HUD_TABLET_PICK 0x0046
145#define HUD_CONFIDENCE 0x0047
146#define HUD_WIDTH 0x0048
147#define HUD_HEIGHT 0x0049
148#define HUD_CONTACTID 0x0051
149#define HUD_INPUT_MODE 0x0052
150#define HUD_DEVICE_INDEX 0x0053
151#define HUD_CONTACTCOUNT 0x0054
152#define HUD_CONTACT_MAX 0x0055
153#define HUD_SCAN_TIME 0x0056
154#define HUD_SURFACE_SWITCH 0x0057
155#define HUD_BUTTONS_SWITCH 0x0058
156#define HUD_BUTTON_TYPE 0x0059
157#define HUD_SEC_BARREL_SWITCH 0x005a
158#define HUD_LATENCY_MODE 0x0060
159
160/* Usages, Consumer */
161#define HUC_CONTROL 0x0001
162#define HUC_HEADPHONE 0x0005
163#define HUC_AC_PAN 0x0238
164
165/* Usages, FIDO */
166#define HUF_U2FHID 0x0001
167
168#define HID_USAGE2(p,u) (((p) << 16) | (u))
169#define HID_GET_USAGE(u) ((u) & 0xffff)
170#define HID_GET_USAGE_PAGE(u) (((u) >> 16) & 0xffff)
171
172#define HID_INPUT_REPORT 0x01
173#define HID_OUTPUT_REPORT 0x02
174#define HID_FEATURE_REPORT 0x03
175
176/* Bits in the input/output/feature items */
177#define HIO_CONST 0x001
178#define HIO_VARIABLE 0x002
179#define HIO_RELATIVE 0x004
180#define HIO_WRAP 0x008
181#define HIO_NONLINEAR 0x010
182#define HIO_NOPREF 0x020
183#define HIO_NULLSTATE 0x040
184#define HIO_VOLATILE 0x080
185#define HIO_BUFBYTES 0x100
186
187/* Units of Measure */
188#define HUM_CENTIMETER 0x11
189#define HUM_RADIAN 0x12
190#define HUM_INCH 0x13
191#define HUM_INCH_EGALAX 0x33
192#define HUM_DEGREE 0x14
193
194#if defined(_KERNEL) || defined(_STANDALONE)
195
196#define HID_ITEM_MAXUSAGE 8
197#define HID_MAX_AUTO_QUIRK 8 /* maximum number of dynamic quirks */
198#define HID_PNP_ID_SIZE 20 /* includes null terminator */
199
200/* Declare global HID debug variable. */
201extern int hid_debug;
202
203/* Check if HID debugging is enabled. */
204#ifdef HID_DEBUG_VAR
205#ifdef HID_DEBUG
206#define DPRINTFN(n,fmt,...) do { \
207 if ((HID_DEBUG_VAR) >= (n)) { \
208 printf("%s: " fmt, \
209 __FUNCTION__ ,##__VA_ARGS__); \
210 } \
211} while (0)
212#define DPRINTF(...) DPRINTFN(1, __VA_ARGS__)
213#else
214#define DPRINTF(...) do { } while (0)
215#define DPRINTFN(...) do { } while (0)
216#endif
217#endif
218
219/* Declare parent SYSCTL HID node. */
220#ifdef SYSCTL_DECL
221SYSCTL_DECL(_hw_hid);
222#endif
223
224typedef uint32_t hid_size_t;
225
226#define HID_IN_POLLING_MODE() (SCHEDULER_STOPPED() || kdb_active)
227
228enum hid_kind {
229 hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
230};
231
232struct hid_location {
233 uint32_t size;
234 uint32_t count;
235 uint32_t pos;
236};
237
238struct hid_item {
239 /* Global */
240 uint32_t _usage_page;
241 int32_t logical_minimum;
242 int32_t logical_maximum;
243 int32_t physical_minimum;
244 int32_t physical_maximum;
245 uint32_t unit_exponent;
246 uint32_t unit;
247 uint32_t report_ID;
248 /* Local */
249 int nusages;
250 union {
251 uint32_t usage;
252 uint32_t usages[HID_ITEM_MAXUSAGE];
253 };
254 uint32_t usage_minimum;
255 uint32_t usage_maximum;
256 uint32_t designator_index;
257 uint32_t designator_minimum;
258 uint32_t designator_maximum;
259 uint32_t string_index;
260 uint32_t string_minimum;
261 uint32_t string_maximum;
262 uint32_t set_delimiter;
263 /* Misc */
264 uint32_t collection;
265 int collevel;
266 enum hid_kind kind;
267 uint32_t flags;
268 /* Location */
269 struct hid_location loc;
270};
271
272struct hid_absinfo {
273 int32_t min;
274 int32_t max;
275 int32_t res;
276};
277
278struct hid_device_info {
279 char name[80];
280 char serial[80];
281 char idPnP[HID_PNP_ID_SIZE];
282 uint16_t idBus;
283 uint16_t idVendor;
284 uint16_t idProduct;
285 uint16_t idVersion;
286 hid_size_t rdescsize; /* Report descriptor size */
287 uint8_t autoQuirk[HID_MAX_AUTO_QUIRK];
288};
289
290struct hid_rdesc_info {
291 void *data;
292 hid_size_t len;
293 hid_size_t isize;
294 hid_size_t osize;
295 hid_size_t fsize;
296 uint8_t iid;
297 uint8_t oid;
298 uint8_t fid;
299 /* Max sizes for HID requests supported by transport backend */
300 hid_size_t rdsize;
301 hid_size_t wrsize;
302 hid_size_t grsize;
303 hid_size_t srsize;
304};
305
306typedef void hid_intr_t(void *context, void *data, hid_size_t len);
307typedef bool hid_test_quirk_t(const struct hid_device_info *dev_info,
308 uint16_t quirk);
309
310extern hid_test_quirk_t *hid_test_quirk_p;
311
312/* prototypes from "usb_hid.c" */
313
314struct hid_data *hid_start_parse(const void *d, hid_size_t len, int kindset);
315void hid_end_parse(struct hid_data *s);
316int hid_get_item(struct hid_data *s, struct hid_item *h);
317int hid_report_size(const void *buf, hid_size_t len, enum hid_kind k,
318 uint8_t id);
319int hid_report_size_max(const void *buf, hid_size_t len, enum hid_kind k,
320 uint8_t *id);
321int hid_locate(const void *desc, hid_size_t size, int32_t usage,
322 enum hid_kind kind, uint8_t index, struct hid_location *loc,
323 uint32_t *flags, uint8_t *id);
324int32_t hid_get_data(const uint8_t *buf, hid_size_t len,
325 struct hid_location *loc);
326uint32_t hid_get_udata(const uint8_t *buf, hid_size_t len,
327 struct hid_location *loc);
328void hid_put_udata(uint8_t *buf, hid_size_t len,
329 struct hid_location *loc, unsigned int value);
330int hid_is_collection(const void *desc, hid_size_t size, int32_t usage);
331int32_t hid_item_resolution(struct hid_item *hi);
332int hid_is_mouse(const void *d_ptr, uint16_t d_len);
333int hid_is_keyboard(const void *d_ptr, uint16_t d_len);
334bool hid_test_quirk(const struct hid_device_info *dev_info, uint16_t quirk);
335int hid_add_dynamic_quirk(struct hid_device_info *dev_info,
336 uint16_t quirk);
337void hid_quirk_unload(void *arg);
338
339int hid_intr_start(device_t);
340int hid_intr_stop(device_t);
341void hid_intr_poll(device_t);
342int hid_get_rdesc(device_t, void *, hid_size_t);
343int hid_read(device_t, void *, hid_size_t, hid_size_t *);
344int hid_write(device_t, const void *, hid_size_t);
345int hid_get_report(device_t, void *, hid_size_t, hid_size_t *, uint8_t,
346 uint8_t);
347int hid_set_report(device_t, const void *, hid_size_t, uint8_t, uint8_t);
348int hid_set_idle(device_t, uint16_t, uint8_t);
349int hid_set_protocol(device_t, uint16_t);
350int hid_ioctl(device_t, unsigned long, uintptr_t);
351#endif /* _KERNEL || _STANDALONE */
352#endif /* _HID_HID_H_ */