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