FreeBSD/Linux Kernel Cross Reference
sys/dev/usb/usbhid.h
1 /* $NetBSD: usbhid.h,v 1.11 2001/12/28 00:20:24 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/usbhid.h,v 1.7 1999/11/17 22:33:51 n_hibma Exp $ */
3
4 /*
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 */
40
41
42 #ifndef _USBHID_H_
43 #define _USBHID_H_
44
45 #define UR_GET_HID_DESCRIPTOR 0x06
46 #define UDESC_HID 0x21
47 #define UDESC_REPORT 0x22
48 #define UDESC_PHYSICAL 0x23
49 #define UR_SET_HID_DESCRIPTOR 0x07
50 #define UR_GET_REPORT 0x01
51 #define UR_SET_REPORT 0x09
52 #define UR_GET_IDLE 0x02
53 #define UR_SET_IDLE 0x0a
54 #define UR_GET_PROTOCOL 0x03
55 #define UR_SET_PROTOCOL 0x0b
56
57 typedef struct usb_hid_descriptor {
58 uByte bLength;
59 uByte bDescriptorType;
60 uWord bcdHID;
61 uByte bCountryCode;
62 uByte bNumDescriptors;
63 struct {
64 uByte bDescriptorType;
65 uWord wDescriptorLength;
66 } descrs[1];
67 } UPACKED usb_hid_descriptor_t;
68 #define USB_HID_DESCRIPTOR_SIZE(n) (9+(n)*3)
69
70 /* Usage pages */
71 #define HUP_UNDEFINED 0x0000
72 #define HUP_GENERIC_DESKTOP 0x0001
73 #define HUP_SIMULATION 0x0002
74 #define HUP_VR_CONTROLS 0x0003
75 #define HUP_SPORTS_CONTROLS 0x0004
76 #define HUP_GAMING_CONTROLS 0x0005
77 #define HUP_KEYBOARD 0x0007
78 #define HUP_LEDS 0x0008
79 #define HUP_BUTTON 0x0009
80 #define HUP_ORDINALS 0x000a
81 #define HUP_TELEPHONY 0x000b
82 #define HUP_CONSUMER 0x000c
83 #define HUP_DIGITIZERS 0x000d
84 #define HUP_PHYSICAL_IFACE 0x000e
85 #define HUP_UNICODE 0x0010
86 #define HUP_ALPHANUM_DISPLAY 0x0014
87 #define HUP_MONITOR 0x0080
88 #define HUP_MONITOR_ENUM_VAL 0x0081
89 #define HUP_VESA_VC 0x0082
90 #define HUP_VESA_CMD 0x0083
91 #define HUP_POWER 0x0084
92 #define HUP_BATTERY_SYSTEM 0x0085
93 #define HUP_BARCODE_SCANNER 0x008b
94 #define HUP_SCALE 0x008c
95 #define HUP_CAMERA_CONTROL 0x0090
96 #define HUP_ARCADE 0x0091
97 #define HUP_MICROSOFT 0xff00
98
99 /* Usages, generic desktop */
100 #define HUG_POINTER 0x0001
101 #define HUG_MOUSE 0x0002
102 #define HUG_JOYSTICK 0x0004
103 #define HUG_GAME_PAD 0x0005
104 #define HUG_KEYBOARD 0x0006
105 #define HUG_KEYPAD 0x0007
106 #define HUG_X 0x0030
107 #define HUG_Y 0x0031
108 #define HUG_Z 0x0032
109 #define HUG_RX 0x0033
110 #define HUG_RY 0x0034
111 #define HUG_RZ 0x0035
112 #define HUG_SLIDER 0x0036
113 #define HUG_DIAL 0x0037
114 #define HUG_WHEEL 0x0038
115 #define HUG_HAT_SWITCH 0x0039
116 #define HUG_COUNTED_BUFFER 0x003a
117 #define HUG_BYTE_COUNT 0x003b
118 #define HUG_MOTION_WAKEUP 0x003c
119 #define HUG_VX 0x0040
120 #define HUG_VY 0x0041
121 #define HUG_VZ 0x0042
122 #define HUG_VBRX 0x0043
123 #define HUG_VBRY 0x0044
124 #define HUG_VBRZ 0x0045
125 #define HUG_VNO 0x0046
126 #define HUG_SYSTEM_CONTROL 0x0080
127 #define HUG_SYSTEM_POWER_DOWN 0x0081
128 #define HUG_SYSTEM_SLEEP 0x0082
129 #define HUG_SYSTEM_WAKEUP 0x0083
130 #define HUG_SYSTEM_CONTEXT_MENU 0x0084
131 #define HUG_SYSTEM_MAIN_MENU 0x0085
132 #define HUG_SYSTEM_APP_MENU 0x0086
133 #define HUG_SYSTEM_MENU_HELP 0x0087
134 #define HUG_SYSTEM_MENU_EXIT 0x0088
135 #define HUG_SYSTEM_MENU_SELECT 0x0089
136 #define HUG_SYSTEM_MENU_RIGHT 0x008a
137 #define HUG_SYSTEM_MENU_LEFT 0x008b
138 #define HUG_SYSTEM_MENU_UP 0x008c
139 #define HUG_SYSTEM_MENU_DOWN 0x008d
140
141 /* Usages Digitizers */
142 #define HUD_UNDEFINED 0x0000
143 #define HUD_TIP_PRESSURE 0x0030
144 #define HUD_BARREL_PRESSURE 0x0031
145 #define HUD_IN_RANGE 0x0032
146 #define HUD_TOUCH 0x0033
147 #define HUD_UNTOUCH 0x0034
148 #define HUD_TAP 0x0035
149 #define HUD_QUALITY 0x0036
150 #define HUD_DATA_VALID 0x0037
151 #define HUD_TRANSDUCER_INDEX 0x0038
152 #define HUD_TABLET_FKEYS 0x0039
153 #define HUD_PROGRAM_CHANGE_KEYS 0x003a
154 #define HUD_BATTERY_STRENGTH 0x003b
155 #define HUD_INVERT 0x003c
156 #define HUD_X_TILT 0x003d
157 #define HUD_Y_TILT 0x003e
158 #define HUD_AZIMUTH 0x003f
159 #define HUD_ALTITUDE 0x0040
160 #define HUD_TWIST 0x0041
161 #define HUD_TIP_SWITCH 0x0042
162 #define HUD_SEC_TIP_SWITCH 0x0043
163 #define HUD_BARREL_SWITCH 0x0044
164 #define HUD_ERASER 0x0045
165 #define HUD_TABLET_PICK 0x0046
166
167 /* Usages LEDs */
168 #define HUD_LED_NUM_LOCK 0x0001
169 #define HUD_LED_CAPS_LOCK 0x0002
170 #define HUD_LED_SCROLL_LOCK 0x0003
171 #define HUD_LED_COMPOSE 0x0004
172 #define HUD_LED_KANA 0x0005
173
174 #define HID_USAGE2(p, u) (((p) << 16) | u)
175 #define HID_GET_USAGE(u) ((u) & 0xffff)
176 #define HID_GET_USAGE_PAGE(u) (((u) >> 16) & 0xffff)
177
178 #define UHID_INPUT_REPORT 0x01
179 #define UHID_OUTPUT_REPORT 0x02
180 #define UHID_FEATURE_REPORT 0x03
181
182 #define HCOLL_PHYSICAL 0
183 #define HCOLL_APPLICATION 1
184 #define HCOLL_LOGICAL 2
185
186 /* Bits in the input/output/feature items */
187 #define HIO_CONST 0x001
188 #define HIO_VARIABLE 0x002
189 #define HIO_RELATIVE 0x004
190 #define HIO_WRAP 0x008
191 #define HIO_NONLINEAR 0x010
192 #define HIO_NOPREF 0x020
193 #define HIO_NULLSTATE 0x040
194 #define HIO_VOLATILE 0x080
195 #define HIO_BUFBYTES 0x100
196
197 #endif /* _USBHID_H_ */
Cache object: 3e2791b8330351ee0587e8994963d8a8
|