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