1 /* SPDX-License-Identifier: GPL-2.0-or-later * <<
2 /* 1 /*
3 * Copyright (c) 1999 Andreas Gal 2 * Copyright (c) 1999 Andreas Gal
4 * Copyright (c) 2000-2001 Vojtech Pavlik 3 * Copyright (c) 2000-2001 Vojtech Pavlik
5 * Copyright (c) 2006-2007 Jiri Kosina 4 * Copyright (c) 2006-2007 Jiri Kosina
6 */ 5 */
7 /* 6 /*
>> 7 * This program is free software; you can redistribute it and/or modify
>> 8 * it under the terms of the GNU General Public License as published by
>> 9 * the Free Software Foundation; either version 2 of the License, or
>> 10 * (at your option) any later version.
>> 11 *
>> 12 * This program is distributed in the hope that it will be useful,
>> 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
>> 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> 15 * GNU General Public License for more details.
>> 16 *
>> 17 * You should have received a copy of the GNU General Public License
>> 18 * along with this program; if not, write to the Free Software
>> 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
8 * 20 *
9 * Should you need to contact me, the author, 21 * Should you need to contact me, the author, you can do so either by
10 * e-mail - mail your message to <vojtech@ucw. 22 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
11 * Vojtech Pavlik, Simunkova 1594, Prague 8, 1 23 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
12 */ 24 */
13 #ifndef __HID_H 25 #ifndef __HID_H
14 #define __HID_H 26 #define __HID_H
15 27
16 28
17 #include <linux/bitops.h> 29 #include <linux/bitops.h>
18 #include <linux/types.h> 30 #include <linux/types.h>
19 #include <linux/slab.h> 31 #include <linux/slab.h>
20 #include <linux/list.h> 32 #include <linux/list.h>
21 #include <linux/mod_devicetable.h> /* hid_devi 33 #include <linux/mod_devicetable.h> /* hid_device_id */
22 #include <linux/timer.h> 34 #include <linux/timer.h>
23 #include <linux/workqueue.h> 35 #include <linux/workqueue.h>
24 #include <linux/input.h> 36 #include <linux/input.h>
25 #include <linux/semaphore.h> 37 #include <linux/semaphore.h>
26 #include <linux/mutex.h> 38 #include <linux/mutex.h>
27 #include <linux/power_supply.h> 39 #include <linux/power_supply.h>
28 #include <uapi/linux/hid.h> 40 #include <uapi/linux/hid.h>
29 #include <linux/hid_bpf.h> <<
30 41
31 /* 42 /*
32 * We parse each description item into this st 43 * We parse each description item into this structure. Short items data
33 * values are expanded to 32-bit signed int, l 44 * values are expanded to 32-bit signed int, long items contain a pointer
34 * into the data area. 45 * into the data area.
35 */ 46 */
36 47
37 struct hid_item { 48 struct hid_item {
38 unsigned format; 49 unsigned format;
39 __u8 size; 50 __u8 size;
40 __u8 type; 51 __u8 type;
41 __u8 tag; 52 __u8 tag;
42 union { 53 union {
43 __u8 u8; 54 __u8 u8;
44 __s8 s8; 55 __s8 s8;
45 __u16 u16; 56 __u16 u16;
46 __s16 s16; 57 __s16 s16;
47 __u32 u32; 58 __u32 u32;
48 __s32 s32; 59 __s32 s32;
49 const __u8 *longdata; !! 60 __u8 *longdata;
50 } data; 61 } data;
51 }; 62 };
52 63
53 /* 64 /*
54 * HID report item format 65 * HID report item format
55 */ 66 */
56 67
57 #define HID_ITEM_FORMAT_SHORT 0 68 #define HID_ITEM_FORMAT_SHORT 0
58 #define HID_ITEM_FORMAT_LONG 1 69 #define HID_ITEM_FORMAT_LONG 1
59 70
60 /* 71 /*
61 * Special tag indicating long items 72 * Special tag indicating long items
62 */ 73 */
63 74
64 #define HID_ITEM_TAG_LONG 15 75 #define HID_ITEM_TAG_LONG 15
65 76
66 /* 77 /*
67 * HID report descriptor item type (prefix bit 78 * HID report descriptor item type (prefix bit 2,3)
68 */ 79 */
69 80
70 #define HID_ITEM_TYPE_MAIN 0 81 #define HID_ITEM_TYPE_MAIN 0
71 #define HID_ITEM_TYPE_GLOBAL 1 82 #define HID_ITEM_TYPE_GLOBAL 1
72 #define HID_ITEM_TYPE_LOCAL 2 83 #define HID_ITEM_TYPE_LOCAL 2
73 #define HID_ITEM_TYPE_RESERVED 3 84 #define HID_ITEM_TYPE_RESERVED 3
74 85
75 /* 86 /*
76 * HID report descriptor main item tags 87 * HID report descriptor main item tags
77 */ 88 */
78 89
79 #define HID_MAIN_ITEM_TAG_INPUT 90 #define HID_MAIN_ITEM_TAG_INPUT 8
80 #define HID_MAIN_ITEM_TAG_OUTPUT 91 #define HID_MAIN_ITEM_TAG_OUTPUT 9
81 #define HID_MAIN_ITEM_TAG_FEATURE 92 #define HID_MAIN_ITEM_TAG_FEATURE 11
82 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 93 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
83 #define HID_MAIN_ITEM_TAG_END_COLLECTION 94 #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
84 95
85 /* 96 /*
86 * HID report descriptor main item contents 97 * HID report descriptor main item contents
87 */ 98 */
88 99
89 #define HID_MAIN_ITEM_CONSTANT 0x001 100 #define HID_MAIN_ITEM_CONSTANT 0x001
90 #define HID_MAIN_ITEM_VARIABLE 0x002 101 #define HID_MAIN_ITEM_VARIABLE 0x002
91 #define HID_MAIN_ITEM_RELATIVE 0x004 102 #define HID_MAIN_ITEM_RELATIVE 0x004
92 #define HID_MAIN_ITEM_WRAP 0x008 103 #define HID_MAIN_ITEM_WRAP 0x008
93 #define HID_MAIN_ITEM_NONLINEAR 0x010 104 #define HID_MAIN_ITEM_NONLINEAR 0x010
94 #define HID_MAIN_ITEM_NO_PREFERRED 0x020 105 #define HID_MAIN_ITEM_NO_PREFERRED 0x020
95 #define HID_MAIN_ITEM_NULL_STATE 0x040 106 #define HID_MAIN_ITEM_NULL_STATE 0x040
96 #define HID_MAIN_ITEM_VOLATILE 0x080 107 #define HID_MAIN_ITEM_VOLATILE 0x080
97 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 108 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
98 109
99 /* 110 /*
100 * HID report descriptor collection item types 111 * HID report descriptor collection item types
101 */ 112 */
102 113
103 #define HID_COLLECTION_PHYSICAL 0 114 #define HID_COLLECTION_PHYSICAL 0
104 #define HID_COLLECTION_APPLICATION 1 115 #define HID_COLLECTION_APPLICATION 1
105 #define HID_COLLECTION_LOGICAL 2 116 #define HID_COLLECTION_LOGICAL 2
106 #define HID_COLLECTION_NAMED_ARRAY 4 <<
107 117
108 /* 118 /*
109 * HID report descriptor global item tags 119 * HID report descriptor global item tags
110 */ 120 */
111 121
112 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 122 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
113 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 123 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
114 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 124 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
115 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 125 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
116 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 126 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
117 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 127 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
118 #define HID_GLOBAL_ITEM_TAG_UNIT 128 #define HID_GLOBAL_ITEM_TAG_UNIT 6
119 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 129 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
120 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 130 #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
121 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 131 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
122 #define HID_GLOBAL_ITEM_TAG_PUSH 132 #define HID_GLOBAL_ITEM_TAG_PUSH 10
123 #define HID_GLOBAL_ITEM_TAG_POP 133 #define HID_GLOBAL_ITEM_TAG_POP 11
124 134
125 /* 135 /*
126 * HID report descriptor local item tags 136 * HID report descriptor local item tags
127 */ 137 */
128 138
129 #define HID_LOCAL_ITEM_TAG_USAGE 139 #define HID_LOCAL_ITEM_TAG_USAGE 0
130 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 140 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
131 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 141 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
132 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 142 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
133 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 143 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
134 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 144 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
135 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 145 #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
136 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 146 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
137 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 147 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
138 #define HID_LOCAL_ITEM_TAG_DELIMITER 148 #define HID_LOCAL_ITEM_TAG_DELIMITER 10
139 149
140 /* 150 /*
141 * HID usage tables 151 * HID usage tables
142 */ 152 */
143 153
144 #define HID_USAGE_PAGE 0xffff0000 154 #define HID_USAGE_PAGE 0xffff0000
145 155
146 #define HID_UP_UNDEFINED 0x00000000 156 #define HID_UP_UNDEFINED 0x00000000
147 #define HID_UP_GENDESK 0x00010000 157 #define HID_UP_GENDESK 0x00010000
148 #define HID_UP_SIMULATION 0x00020000 158 #define HID_UP_SIMULATION 0x00020000
149 #define HID_UP_GENDEVCTRLS 0x00060000 159 #define HID_UP_GENDEVCTRLS 0x00060000
150 #define HID_UP_KEYBOARD 0x00070000 160 #define HID_UP_KEYBOARD 0x00070000
151 #define HID_UP_LED 0x00080000 161 #define HID_UP_LED 0x00080000
152 #define HID_UP_BUTTON 0x00090000 162 #define HID_UP_BUTTON 0x00090000
153 #define HID_UP_ORDINAL 0x000a0000 163 #define HID_UP_ORDINAL 0x000a0000
154 #define HID_UP_TELEPHONY 0x000b0000 164 #define HID_UP_TELEPHONY 0x000b0000
155 #define HID_UP_CONSUMER 0x000c0000 165 #define HID_UP_CONSUMER 0x000c0000
156 #define HID_UP_DIGITIZER 0x000d0000 166 #define HID_UP_DIGITIZER 0x000d0000
157 #define HID_UP_PID 0x000f0000 167 #define HID_UP_PID 0x000f0000
158 #define HID_UP_BATTERY 0x00850000 <<
159 #define HID_UP_CAMERA 0x00900000 <<
160 #define HID_UP_HPVENDOR 0xff7f0000 168 #define HID_UP_HPVENDOR 0xff7f0000
161 #define HID_UP_HPVENDOR2 0xff010000 169 #define HID_UP_HPVENDOR2 0xff010000
162 #define HID_UP_MSVENDOR 0xff000000 170 #define HID_UP_MSVENDOR 0xff000000
163 #define HID_UP_CUSTOM 0x00ff0000 171 #define HID_UP_CUSTOM 0x00ff0000
164 #define HID_UP_LOGIVENDOR 0xffbc0000 172 #define HID_UP_LOGIVENDOR 0xffbc0000
165 #define HID_UP_LOGIVENDOR2 0xff090000 173 #define HID_UP_LOGIVENDOR2 0xff090000
166 #define HID_UP_LOGIVENDOR3 0xff430000 174 #define HID_UP_LOGIVENDOR3 0xff430000
167 #define HID_UP_LNVENDOR 0xffa00000 175 #define HID_UP_LNVENDOR 0xffa00000
168 #define HID_UP_SENSOR 0x00200000 176 #define HID_UP_SENSOR 0x00200000
169 #define HID_UP_ASUSVENDOR 0xff310000 177 #define HID_UP_ASUSVENDOR 0xff310000
170 #define HID_UP_GOOGLEVENDOR 0xffd10000 <<
171 178
172 #define HID_USAGE 0x0000ffff 179 #define HID_USAGE 0x0000ffff
173 180
174 #define HID_GD_POINTER 0x00010001 181 #define HID_GD_POINTER 0x00010001
175 #define HID_GD_MOUSE 0x00010002 182 #define HID_GD_MOUSE 0x00010002
176 #define HID_GD_JOYSTICK 0x00010004 183 #define HID_GD_JOYSTICK 0x00010004
177 #define HID_GD_GAMEPAD 0x00010005 184 #define HID_GD_GAMEPAD 0x00010005
178 #define HID_GD_KEYBOARD 0x00010006 185 #define HID_GD_KEYBOARD 0x00010006
179 #define HID_GD_KEYPAD 0x00010007 186 #define HID_GD_KEYPAD 0x00010007
180 #define HID_GD_MULTIAXIS 0x00010008 187 #define HID_GD_MULTIAXIS 0x00010008
181 /* 188 /*
182 * Microsoft Win8 Wireless Radio Controls exte 189 * Microsoft Win8 Wireless Radio Controls extensions CA, see:
183 * http://www.usb.org/developers/hidpage/HUTRR 190 * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
184 */ 191 */
185 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001 192 #define HID_GD_WIRELESS_RADIO_CTLS 0x0001000c
186 /* 193 /*
187 * System Multi-Axis, see: 194 * System Multi-Axis, see:
188 * http://www.usb.org/developers/hidpage/HUTRR 195 * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
189 */ 196 */
190 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e 197 #define HID_GD_SYSTEM_MULTIAXIS 0x0001000e
191 198
192 #define HID_GD_X 0x00010030 199 #define HID_GD_X 0x00010030
193 #define HID_GD_Y 0x00010031 200 #define HID_GD_Y 0x00010031
194 #define HID_GD_Z 0x00010032 201 #define HID_GD_Z 0x00010032
195 #define HID_GD_RX 0x00010033 202 #define HID_GD_RX 0x00010033
196 #define HID_GD_RY 0x00010034 203 #define HID_GD_RY 0x00010034
197 #define HID_GD_RZ 0x00010035 204 #define HID_GD_RZ 0x00010035
198 #define HID_GD_SLIDER 0x00010036 205 #define HID_GD_SLIDER 0x00010036
199 #define HID_GD_DIAL 0x00010037 206 #define HID_GD_DIAL 0x00010037
200 #define HID_GD_WHEEL 0x00010038 207 #define HID_GD_WHEEL 0x00010038
201 #define HID_GD_HATSWITCH 0x00010039 208 #define HID_GD_HATSWITCH 0x00010039
202 #define HID_GD_BUFFER 0x0001003a 209 #define HID_GD_BUFFER 0x0001003a
203 #define HID_GD_BYTECOUNT 0x0001003b 210 #define HID_GD_BYTECOUNT 0x0001003b
204 #define HID_GD_MOTION 0x0001003c 211 #define HID_GD_MOTION 0x0001003c
205 #define HID_GD_START 0x0001003d 212 #define HID_GD_START 0x0001003d
206 #define HID_GD_SELECT 0x0001003e 213 #define HID_GD_SELECT 0x0001003e
207 #define HID_GD_VX 0x00010040 214 #define HID_GD_VX 0x00010040
208 #define HID_GD_VY 0x00010041 215 #define HID_GD_VY 0x00010041
209 #define HID_GD_VZ 0x00010042 216 #define HID_GD_VZ 0x00010042
210 #define HID_GD_VBRX 0x00010043 217 #define HID_GD_VBRX 0x00010043
211 #define HID_GD_VBRY 0x00010044 218 #define HID_GD_VBRY 0x00010044
212 #define HID_GD_VBRZ 0x00010045 219 #define HID_GD_VBRZ 0x00010045
213 #define HID_GD_VNO 0x00010046 220 #define HID_GD_VNO 0x00010046
214 #define HID_GD_FEATURE 0x00010047 221 #define HID_GD_FEATURE 0x00010047
215 #define HID_GD_RESOLUTION_MULTIPLIER 0x0001 222 #define HID_GD_RESOLUTION_MULTIPLIER 0x00010048
216 #define HID_GD_SYSTEM_CONTROL 0x00010080 223 #define HID_GD_SYSTEM_CONTROL 0x00010080
217 #define HID_GD_UP 0x00010090 224 #define HID_GD_UP 0x00010090
218 #define HID_GD_DOWN 0x00010091 225 #define HID_GD_DOWN 0x00010091
219 #define HID_GD_RIGHT 0x00010092 226 #define HID_GD_RIGHT 0x00010092
220 #define HID_GD_LEFT 0x00010093 227 #define HID_GD_LEFT 0x00010093
221 /* Microsoft Win8 Wireless Radio Controls CA u 228 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
222 #define HID_GD_RFKILL_BTN 0x000100c6 229 #define HID_GD_RFKILL_BTN 0x000100c6
223 #define HID_GD_RFKILL_LED 0x000100c7 230 #define HID_GD_RFKILL_LED 0x000100c7
224 #define HID_GD_RFKILL_SWITCH 0x000100c8 231 #define HID_GD_RFKILL_SWITCH 0x000100c8
225 232
226 #define HID_DC_BATTERYSTRENGTH 0x00060020 233 #define HID_DC_BATTERYSTRENGTH 0x00060020
227 234
228 #define HID_CP_CONSUMER_CONTROL 0x000c0001 235 #define HID_CP_CONSUMER_CONTROL 0x000c0001
229 #define HID_CP_AC_PAN 0x000c0238 236 #define HID_CP_AC_PAN 0x000c0238
230 237
231 #define HID_DG_DIGITIZER 0x000d0001 238 #define HID_DG_DIGITIZER 0x000d0001
232 #define HID_DG_PEN 0x000d0002 239 #define HID_DG_PEN 0x000d0002
233 #define HID_DG_LIGHTPEN 0x000d0003 240 #define HID_DG_LIGHTPEN 0x000d0003
234 #define HID_DG_TOUCHSCREEN 0x000d0004 241 #define HID_DG_TOUCHSCREEN 0x000d0004
235 #define HID_DG_TOUCHPAD 0x000d0005 242 #define HID_DG_TOUCHPAD 0x000d0005
236 #define HID_DG_WHITEBOARD 0x000d0006 243 #define HID_DG_WHITEBOARD 0x000d0006
237 #define HID_DG_STYLUS 0x000d0020 244 #define HID_DG_STYLUS 0x000d0020
238 #define HID_DG_PUCK 0x000d0021 245 #define HID_DG_PUCK 0x000d0021
239 #define HID_DG_FINGER 0x000d0022 246 #define HID_DG_FINGER 0x000d0022
240 #define HID_DG_TIPPRESSURE 0x000d0030 247 #define HID_DG_TIPPRESSURE 0x000d0030
241 #define HID_DG_BARRELPRESSURE 0x000d0031 248 #define HID_DG_BARRELPRESSURE 0x000d0031
242 #define HID_DG_INRANGE 0x000d0032 249 #define HID_DG_INRANGE 0x000d0032
243 #define HID_DG_TOUCH 0x000d0033 250 #define HID_DG_TOUCH 0x000d0033
244 #define HID_DG_UNTOUCH 0x000d0034 251 #define HID_DG_UNTOUCH 0x000d0034
245 #define HID_DG_TAP 0x000d0035 252 #define HID_DG_TAP 0x000d0035
246 #define HID_DG_TRANSDUCER_INDEX 0x000d0038 <<
247 #define HID_DG_TABLETFUNCTIONKEY 0x000d 253 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
248 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a 254 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
249 #define HID_DG_BATTERYSTRENGTH 0x000d003b 255 #define HID_DG_BATTERYSTRENGTH 0x000d003b
250 #define HID_DG_INVERT 0x000d003c 256 #define HID_DG_INVERT 0x000d003c
251 #define HID_DG_TILT_X 0x000d003d 257 #define HID_DG_TILT_X 0x000d003d
252 #define HID_DG_TILT_Y 0x000d003e 258 #define HID_DG_TILT_Y 0x000d003e
253 #define HID_DG_TWIST 0x000d0041 259 #define HID_DG_TWIST 0x000d0041
254 #define HID_DG_TIPSWITCH 0x000d0042 260 #define HID_DG_TIPSWITCH 0x000d0042
255 #define HID_DG_TIPSWITCH2 0x000d0043 261 #define HID_DG_TIPSWITCH2 0x000d0043
256 #define HID_DG_BARRELSWITCH 0x000d0044 262 #define HID_DG_BARRELSWITCH 0x000d0044
257 #define HID_DG_ERASER 0x000d0045 263 #define HID_DG_ERASER 0x000d0045
258 #define HID_DG_TABLETPICK 0x000d0046 264 #define HID_DG_TABLETPICK 0x000d0046
259 #define HID_DG_PEN_COLOR <<
260 #define HID_DG_PEN_LINE_WIDTH <<
261 #define HID_DG_PEN_LINE_STYLE <<
262 #define HID_DG_PEN_LINE_STYLE_INK <<
263 #define HID_DG_PEN_LINE_STYLE_PENCIL <<
264 #define HID_DG_PEN_LINE_STYLE_HIGHLIGHTER <<
265 #define HID_DG_PEN_LINE_STYLE_CHISEL_MARKER <<
266 #define HID_DG_PEN_LINE_STYLE_BRUSH <<
267 #define HID_DG_PEN_LINE_STYLE_NO_PREFERENCE <<
268 265
269 #define HID_CP_CONSUMERCONTROL 0x000c0001 266 #define HID_CP_CONSUMERCONTROL 0x000c0001
270 #define HID_CP_NUMERICKEYPAD 0x000c0002 267 #define HID_CP_NUMERICKEYPAD 0x000c0002
271 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c 268 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
272 #define HID_CP_MICROPHONE 0x000c0004 269 #define HID_CP_MICROPHONE 0x000c0004
273 #define HID_CP_HEADPHONE 0x000c0005 270 #define HID_CP_HEADPHONE 0x000c0005
274 #define HID_CP_GRAPHICEQUALIZER 0x000c0006 271 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
275 #define HID_CP_FUNCTIONBUTTONS 0x000c0036 272 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
276 #define HID_CP_SELECTION 0x000c0080 273 #define HID_CP_SELECTION 0x000c0080
277 #define HID_CP_MEDIASELECTION 0x000c0087 274 #define HID_CP_MEDIASELECTION 0x000c0087
278 #define HID_CP_SELECTDISC 0x000c00ba 275 #define HID_CP_SELECTDISC 0x000c00ba
279 #define HID_CP_VOLUMEUP 0x000c00e9 <<
280 #define HID_CP_VOLUMEDOWN 0x000c00ea <<
281 #define HID_CP_PLAYBACKSPEED 0x000c00f1 276 #define HID_CP_PLAYBACKSPEED 0x000c00f1
282 #define HID_CP_PROXIMITY 0x000c0109 277 #define HID_CP_PROXIMITY 0x000c0109
283 #define HID_CP_SPEAKERSYSTEM 0x000c0160 278 #define HID_CP_SPEAKERSYSTEM 0x000c0160
284 #define HID_CP_CHANNELLEFT 0x000c0161 279 #define HID_CP_CHANNELLEFT 0x000c0161
285 #define HID_CP_CHANNELRIGHT 0x000c0162 280 #define HID_CP_CHANNELRIGHT 0x000c0162
286 #define HID_CP_CHANNELCENTER 0x000c0163 281 #define HID_CP_CHANNELCENTER 0x000c0163
287 #define HID_CP_CHANNELFRONT 0x000c0164 282 #define HID_CP_CHANNELFRONT 0x000c0164
288 #define HID_CP_CHANNELCENTERFRONT 0x000c 283 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
289 #define HID_CP_CHANNELSIDE 0x000c0166 284 #define HID_CP_CHANNELSIDE 0x000c0166
290 #define HID_CP_CHANNELSURROUND 0x000c0167 285 #define HID_CP_CHANNELSURROUND 0x000c0167
291 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 286 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
292 #define HID_CP_CHANNELTOP 0x000c0169 287 #define HID_CP_CHANNELTOP 0x000c0169
293 #define HID_CP_CHANNELUNKNOWN 0x000c016a 288 #define HID_CP_CHANNELUNKNOWN 0x000c016a
294 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c 289 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
295 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 290 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
296 291
297 #define HID_DG_DEVICECONFIG 0x000d000e 292 #define HID_DG_DEVICECONFIG 0x000d000e
298 #define HID_DG_DEVICESETTINGS 0x000d0023 293 #define HID_DG_DEVICESETTINGS 0x000d0023
299 #define HID_DG_AZIMUTH 0x000d003f 294 #define HID_DG_AZIMUTH 0x000d003f
300 #define HID_DG_CONFIDENCE 0x000d0047 295 #define HID_DG_CONFIDENCE 0x000d0047
301 #define HID_DG_WIDTH 0x000d0048 296 #define HID_DG_WIDTH 0x000d0048
302 #define HID_DG_HEIGHT 0x000d0049 297 #define HID_DG_HEIGHT 0x000d0049
303 #define HID_DG_CONTACTID 0x000d0051 298 #define HID_DG_CONTACTID 0x000d0051
304 #define HID_DG_INPUTMODE 0x000d0052 299 #define HID_DG_INPUTMODE 0x000d0052
305 #define HID_DG_DEVICEINDEX 0x000d0053 300 #define HID_DG_DEVICEINDEX 0x000d0053
306 #define HID_DG_CONTACTCOUNT 0x000d0054 301 #define HID_DG_CONTACTCOUNT 0x000d0054
307 #define HID_DG_CONTACTMAX 0x000d0055 302 #define HID_DG_CONTACTMAX 0x000d0055
308 #define HID_DG_SCANTIME 0x000d0056 303 #define HID_DG_SCANTIME 0x000d0056
309 #define HID_DG_SURFACESWITCH 0x000d0057 304 #define HID_DG_SURFACESWITCH 0x000d0057
310 #define HID_DG_BUTTONSWITCH 0x000d0058 305 #define HID_DG_BUTTONSWITCH 0x000d0058
311 #define HID_DG_BUTTONTYPE 0x000d0059 306 #define HID_DG_BUTTONTYPE 0x000d0059
312 #define HID_DG_BARRELSWITCH2 0x000d005a 307 #define HID_DG_BARRELSWITCH2 0x000d005a
313 #define HID_DG_TOOLSERIALNUMBER 0x000d005b 308 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
314 #define HID_DG_LATENCYMODE 0x000d0060 309 #define HID_DG_LATENCYMODE 0x000d0060
315 310
316 #define HID_BAT_ABSOLUTESTATEOFCHARGE 0x0085 <<
317 #define HID_BAT_CHARGING 0x0085 <<
318 <<
319 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff31 311 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS 0xff310076
>> 312 /*
>> 313 * HID report types --- Ouch! HID spec says 1 2 3!
>> 314 */
>> 315
>> 316 #define HID_INPUT_REPORT 0
>> 317 #define HID_OUTPUT_REPORT 1
>> 318 #define HID_FEATURE_REPORT 2
>> 319
>> 320 #define HID_REPORT_TYPES 3
320 321
321 /* 322 /*
322 * HID connect requests 323 * HID connect requests
323 */ 324 */
324 325
325 #define HID_CONNECT_HIDINPUT BIT(0) 326 #define HID_CONNECT_HIDINPUT BIT(0)
326 #define HID_CONNECT_HIDINPUT_FORCE BIT(1) 327 #define HID_CONNECT_HIDINPUT_FORCE BIT(1)
327 #define HID_CONNECT_HIDRAW BIT(2) 328 #define HID_CONNECT_HIDRAW BIT(2)
328 #define HID_CONNECT_HIDDEV BIT(3) 329 #define HID_CONNECT_HIDDEV BIT(3)
329 #define HID_CONNECT_HIDDEV_FORCE BIT(4) 330 #define HID_CONNECT_HIDDEV_FORCE BIT(4)
330 #define HID_CONNECT_FF BIT(5) 331 #define HID_CONNECT_FF BIT(5)
331 #define HID_CONNECT_DRIVER BIT(6) 332 #define HID_CONNECT_DRIVER BIT(6)
332 #define HID_CONNECT_DEFAULT (HID_CONNECT_H 333 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
333 HID_CONNECT_HIDDEV|HID_CONNECT 334 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
334 335
335 /* 336 /*
336 * HID device quirks. 337 * HID device quirks.
337 */ 338 */
338 339
339 /* !! 340 /*
340 * Increase this if you need to configure more 341 * Increase this if you need to configure more HID quirks at module load time
341 */ 342 */
342 #define MAX_USBHID_BOOT_QUIRKS 4 343 #define MAX_USBHID_BOOT_QUIRKS 4
343 344
344 /** !! 345 #define HID_QUIRK_INVERT BIT(0)
345 * DOC: HID quirks <<
346 * | @HID_QUIRK_NOTOUCH: <<
347 * | @HID_QUIRK_IGNORE: ignore this device <<
348 * | @HID_QUIRK_NOGET: <<
349 * | @HID_QUIRK_HIDDEV_FORCE: <<
350 * | @HID_QUIRK_BADPAD: <<
351 * | @HID_QUIRK_MULTI_INPUT: <<
352 * | @HID_QUIRK_HIDINPUT_FORCE: <<
353 * | @HID_QUIRK_ALWAYS_POLL: <<
354 * | @HID_QUIRK_INPUT_PER_APP: <<
355 * | @HID_QUIRK_X_INVERT: <<
356 * | @HID_QUIRK_Y_INVERT: <<
357 * | @HID_QUIRK_SKIP_OUTPUT_REPORTS: <<
358 * | @HID_QUIRK_SKIP_OUTPUT_REPORT_ID: <<
359 * | @HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP: <<
360 * | @HID_QUIRK_HAVE_SPECIAL_DRIVER: <<
361 * | @HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE: <<
362 * | @HID_QUIRK_FULLSPEED_INTERVAL: <<
363 * | @HID_QUIRK_NO_INIT_REPORTS: <<
364 * | @HID_QUIRK_NO_IGNORE: <<
365 * | @HID_QUIRK_NO_INPUT_SYNC: <<
366 */ <<
367 /* BIT(0) reserved for backward compatibility, <<
368 #define HID_QUIRK_NOTOUCH 346 #define HID_QUIRK_NOTOUCH BIT(1)
369 #define HID_QUIRK_IGNORE 347 #define HID_QUIRK_IGNORE BIT(2)
370 #define HID_QUIRK_NOGET 348 #define HID_QUIRK_NOGET BIT(3)
371 #define HID_QUIRK_HIDDEV_FORCE 349 #define HID_QUIRK_HIDDEV_FORCE BIT(4)
372 #define HID_QUIRK_BADPAD 350 #define HID_QUIRK_BADPAD BIT(5)
373 #define HID_QUIRK_MULTI_INPUT 351 #define HID_QUIRK_MULTI_INPUT BIT(6)
374 #define HID_QUIRK_HIDINPUT_FORCE 352 #define HID_QUIRK_HIDINPUT_FORCE BIT(7)
375 /* BIT(8) reserved for backward compatibility, 353 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
376 /* BIT(9) reserved for backward compatibility, 354 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
377 #define HID_QUIRK_ALWAYS_POLL 355 #define HID_QUIRK_ALWAYS_POLL BIT(10)
378 #define HID_QUIRK_INPUT_PER_APP 356 #define HID_QUIRK_INPUT_PER_APP BIT(11)
379 #define HID_QUIRK_X_INVERT <<
380 #define HID_QUIRK_Y_INVERT <<
381 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 357 #define HID_QUIRK_SKIP_OUTPUT_REPORTS BIT(16)
382 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID 358 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID BIT(17)
383 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP 359 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP BIT(18)
384 #define HID_QUIRK_HAVE_SPECIAL_DRIVER 360 #define HID_QUIRK_HAVE_SPECIAL_DRIVER BIT(19)
385 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE 361 #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE BIT(20)
386 #define HID_QUIRK_NOINVERT <<
387 #define HID_QUIRK_FULLSPEED_INTERVAL 362 #define HID_QUIRK_FULLSPEED_INTERVAL BIT(28)
388 #define HID_QUIRK_NO_INIT_REPORTS 363 #define HID_QUIRK_NO_INIT_REPORTS BIT(29)
389 #define HID_QUIRK_NO_IGNORE 364 #define HID_QUIRK_NO_IGNORE BIT(30)
390 #define HID_QUIRK_NO_INPUT_SYNC 365 #define HID_QUIRK_NO_INPUT_SYNC BIT(31)
391 366
392 /* 367 /*
393 * HID device groups 368 * HID device groups
394 * 369 *
395 * Note: HID_GROUP_ANY is declared in linux/mo 370 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
396 * and has a value of 0x0000 371 * and has a value of 0x0000
397 */ 372 */
398 #define HID_GROUP_GENERIC 373 #define HID_GROUP_GENERIC 0x0001
399 #define HID_GROUP_MULTITOUCH 374 #define HID_GROUP_MULTITOUCH 0x0002
400 #define HID_GROUP_SENSOR_HUB 375 #define HID_GROUP_SENSOR_HUB 0x0003
401 #define HID_GROUP_MULTITOUCH_WIN_8 376 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
402 377
403 /* 378 /*
404 * Vendor specific HID device groups 379 * Vendor specific HID device groups
405 */ 380 */
406 #define HID_GROUP_RMI 381 #define HID_GROUP_RMI 0x0100
407 #define HID_GROUP_WACOM 382 #define HID_GROUP_WACOM 0x0101
408 #define HID_GROUP_LOGITECH_DJ_DEVICE 383 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
409 #define HID_GROUP_STEAM 384 #define HID_GROUP_STEAM 0x0103
410 #define HID_GROUP_LOGITECH_27MHZ_DEVICE <<
411 #define HID_GROUP_VIVALDI <<
412 385
413 /* 386 /*
414 * HID protocol status 387 * HID protocol status
415 */ 388 */
416 #define HID_REPORT_PROTOCOL 1 389 #define HID_REPORT_PROTOCOL 1
417 #define HID_BOOT_PROTOCOL 0 390 #define HID_BOOT_PROTOCOL 0
418 391
419 /* 392 /*
420 * This is the global environment of the parse 393 * This is the global environment of the parser. This information is
421 * persistent for main-items. The global envir 394 * persistent for main-items. The global environment can be saved and
422 * restored with PUSH/POP statements. 395 * restored with PUSH/POP statements.
423 */ 396 */
424 397
425 struct hid_global { 398 struct hid_global {
426 unsigned usage_page; 399 unsigned usage_page;
427 __s32 logical_minimum; 400 __s32 logical_minimum;
428 __s32 logical_maximum; 401 __s32 logical_maximum;
429 __s32 physical_minimum; 402 __s32 physical_minimum;
430 __s32 physical_maximum; 403 __s32 physical_maximum;
431 __s32 unit_exponent; 404 __s32 unit_exponent;
432 unsigned unit; 405 unsigned unit;
433 unsigned report_id; 406 unsigned report_id;
434 unsigned report_size; 407 unsigned report_size;
435 unsigned report_count; 408 unsigned report_count;
436 }; 409 };
437 410
438 /* 411 /*
439 * This is the local environment. It is persis 412 * This is the local environment. It is persistent up the next main-item.
440 */ 413 */
441 414
442 #define HID_MAX_USAGES 12288 415 #define HID_MAX_USAGES 12288
443 #define HID_DEFAULT_NUM_COLLECTIONS 16 416 #define HID_DEFAULT_NUM_COLLECTIONS 16
444 417
445 struct hid_local { 418 struct hid_local {
446 unsigned usage[HID_MAX_USAGES]; /* usa 419 unsigned usage[HID_MAX_USAGES]; /* usage array */
447 u8 usage_size[HID_MAX_USAGES]; /* usag 420 u8 usage_size[HID_MAX_USAGES]; /* usage size array */
448 unsigned collection_index[HID_MAX_USAG 421 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
449 unsigned usage_index; 422 unsigned usage_index;
450 unsigned usage_minimum; 423 unsigned usage_minimum;
451 unsigned delimiter_depth; 424 unsigned delimiter_depth;
452 unsigned delimiter_branch; 425 unsigned delimiter_branch;
453 }; 426 };
454 427
455 /* 428 /*
456 * This is the collection stack. We climb up t 429 * This is the collection stack. We climb up the stack to determine
457 * application and function of each field. 430 * application and function of each field.
458 */ 431 */
459 432
460 struct hid_collection { 433 struct hid_collection {
461 int parent_idx; /* device->collection 434 int parent_idx; /* device->collection */
462 unsigned type; 435 unsigned type;
463 unsigned usage; 436 unsigned usage;
464 unsigned level; 437 unsigned level;
465 }; 438 };
466 439
467 struct hid_usage { 440 struct hid_usage {
468 unsigned hid; /* hid 441 unsigned hid; /* hid usage code */
469 unsigned collection_index; /* ind 442 unsigned collection_index; /* index into collection array */
470 unsigned usage_index; /* ind 443 unsigned usage_index; /* index into usage array */
471 __s8 resolution_multiplier;/* Eff 444 __s8 resolution_multiplier;/* Effective Resolution Multiplier
472 (HU 445 (HUT v1.12, 4.3.1), default: 1 */
473 /* hidinput data */ 446 /* hidinput data */
474 __s8 wheel_factor; /* 120 447 __s8 wheel_factor; /* 120/resolution_multiplier */
475 __u16 code; /* inp 448 __u16 code; /* input driver code */
476 __u8 type; /* inp 449 __u8 type; /* input driver type */
477 __s16 hat_min; /* hat !! 450 __s8 hat_min; /* hat switch fun */
478 __s16 hat_max; /* dit !! 451 __s8 hat_max; /* ditto */
479 __s16 hat_dir; /* dit !! 452 __s8 hat_dir; /* ditto */
480 __s16 wheel_accumulated; /* hi- 453 __s16 wheel_accumulated; /* hi-res wheel */
481 }; 454 };
482 455
483 struct hid_input; 456 struct hid_input;
484 457
485 struct hid_field { 458 struct hid_field {
486 unsigned physical; /* phy 459 unsigned physical; /* physical usage for this field */
487 unsigned logical; /* log 460 unsigned logical; /* logical usage for this field */
488 unsigned application; /* app 461 unsigned application; /* application usage for this field */
489 struct hid_usage *usage; /* usa 462 struct hid_usage *usage; /* usage table for this function */
490 unsigned maxusage; /* max 463 unsigned maxusage; /* maximum usage index */
491 unsigned flags; /* mai 464 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
492 unsigned report_offset; /* bit 465 unsigned report_offset; /* bit offset in the report */
493 unsigned report_size; /* siz 466 unsigned report_size; /* size of this field in the report */
494 unsigned report_count; /* num 467 unsigned report_count; /* number of this field in the report */
495 unsigned report_type; /* (in 468 unsigned report_type; /* (input,output,feature) */
496 __s32 *value; /* las 469 __s32 *value; /* last known value(s) */
497 __s32 *new_value; /* new <<
498 __s32 *usages_priorities; /* pri <<
499 * bit <<
500 */ <<
501 __s32 logical_minimum; 470 __s32 logical_minimum;
502 __s32 logical_maximum; 471 __s32 logical_maximum;
503 __s32 physical_minimum; 472 __s32 physical_minimum;
504 __s32 physical_maximum; 473 __s32 physical_maximum;
505 __s32 unit_exponent; 474 __s32 unit_exponent;
506 unsigned unit; 475 unsigned unit;
507 bool ignored; /* thi <<
508 struct hid_report *report; /* ass 476 struct hid_report *report; /* associated report */
509 unsigned index; /* ind 477 unsigned index; /* index into report->field[] */
510 /* hidinput data */ 478 /* hidinput data */
511 struct hid_input *hidinput; /* ass 479 struct hid_input *hidinput; /* associated input structure */
512 __u16 dpad; /* dpa 480 __u16 dpad; /* dpad input code */
513 unsigned int slot_idx; /* slo <<
514 }; 481 };
515 482
516 #define HID_MAX_FIELDS 256 483 #define HID_MAX_FIELDS 256
517 484
518 struct hid_field_entry { <<
519 struct list_head list; <<
520 struct hid_field *field; <<
521 unsigned int index; <<
522 __s32 priority; <<
523 }; <<
524 <<
525 struct hid_report { 485 struct hid_report {
526 struct list_head list; 486 struct list_head list;
527 struct list_head hidinput_list; 487 struct list_head hidinput_list;
528 struct list_head field_entry_list; <<
529 unsigned int id; 488 unsigned int id; /* id of this report */
530 enum hid_report_type type; !! 489 unsigned int type; /* report type */
531 unsigned int application; 490 unsigned int application; /* application usage for this report */
532 struct hid_field *field[HID_MAX_FIELDS 491 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
533 struct hid_field_entry *field_entries; <<
534 unsigned maxfield; 492 unsigned maxfield; /* maximum valid field index */
535 unsigned size; 493 unsigned size; /* size of the report (bits) */
536 struct hid_device *device; 494 struct hid_device *device; /* associated device */
537 <<
538 /* tool related state */ <<
539 bool tool_active; <<
540 unsigned int tool; <<
541 }; 495 };
542 496
543 #define HID_MAX_IDS 256 497 #define HID_MAX_IDS 256
544 498
545 struct hid_report_enum { 499 struct hid_report_enum {
546 unsigned numbered; 500 unsigned numbered;
547 struct list_head report_list; 501 struct list_head report_list;
548 struct hid_report *report_id_hash[HID_ 502 struct hid_report *report_id_hash[HID_MAX_IDS];
549 }; 503 };
550 504
551 #define HID_MIN_BUFFER_SIZE 64 505 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
552 #define HID_MAX_BUFFER_SIZE 16384 !! 506 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
553 #define HID_CONTROL_FIFO_SIZE 256 507 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
554 #define HID_OUTPUT_FIFO_SIZE 64 508 #define HID_OUTPUT_FIFO_SIZE 64
555 509
556 struct hid_control_fifo { 510 struct hid_control_fifo {
557 unsigned char dir; 511 unsigned char dir;
558 struct hid_report *report; 512 struct hid_report *report;
559 char *raw_report; 513 char *raw_report;
560 }; 514 };
561 515
562 struct hid_output_fifo { 516 struct hid_output_fifo {
563 struct hid_report *report; 517 struct hid_report *report;
564 char *raw_report; 518 char *raw_report;
565 }; 519 };
566 520
567 #define HID_CLAIMED_INPUT BIT(0) 521 #define HID_CLAIMED_INPUT BIT(0)
568 #define HID_CLAIMED_HIDDEV BIT(1) 522 #define HID_CLAIMED_HIDDEV BIT(1)
569 #define HID_CLAIMED_HIDRAW BIT(2) 523 #define HID_CLAIMED_HIDRAW BIT(2)
570 #define HID_CLAIMED_DRIVER BIT(3) 524 #define HID_CLAIMED_DRIVER BIT(3)
571 525
572 #define HID_STAT_ADDED BIT(0) 526 #define HID_STAT_ADDED BIT(0)
573 #define HID_STAT_PARSED BIT(1) 527 #define HID_STAT_PARSED BIT(1)
574 #define HID_STAT_DUP_DETECTED BIT(2) 528 #define HID_STAT_DUP_DETECTED BIT(2)
575 #define HID_STAT_REPROBED BIT(3) 529 #define HID_STAT_REPROBED BIT(3)
576 530
577 struct hid_input { 531 struct hid_input {
578 struct list_head list; 532 struct list_head list;
579 struct hid_report *report; 533 struct hid_report *report;
580 struct input_dev *input; 534 struct input_dev *input;
581 const char *name; 535 const char *name;
>> 536 bool registered;
582 struct list_head reports; /* the 537 struct list_head reports; /* the list of reports */
583 unsigned int application; /* app 538 unsigned int application; /* application usage for this input */
584 bool registered; <<
585 }; 539 };
586 540
587 enum hid_type { 541 enum hid_type {
588 HID_TYPE_OTHER = 0, 542 HID_TYPE_OTHER = 0,
589 HID_TYPE_USBMOUSE, 543 HID_TYPE_USBMOUSE,
590 HID_TYPE_USBNONE 544 HID_TYPE_USBNONE
591 }; 545 };
592 546
593 enum hid_battery_status { 547 enum hid_battery_status {
594 HID_BATTERY_UNKNOWN = 0, 548 HID_BATTERY_UNKNOWN = 0,
595 HID_BATTERY_QUERIED, /* Ker 549 HID_BATTERY_QUERIED, /* Kernel explicitly queried battery strength */
596 HID_BATTERY_REPORTED, /* Dev 550 HID_BATTERY_REPORTED, /* Device sent unsolicited battery strength report */
597 }; 551 };
598 552
599 struct hid_driver; 553 struct hid_driver;
600 struct hid_ll_driver; 554 struct hid_ll_driver;
601 555
602 struct hid_device { 556 struct hid_device { /* device report descriptor */
603 const __u8 *dev_rdesc; !! 557 __u8 *dev_rdesc;
604 unsigned dev_rsize; 558 unsigned dev_rsize;
605 const __u8 *rdesc; !! 559 __u8 *rdesc;
606 unsigned rsize; 560 unsigned rsize;
607 struct hid_collection *collection; 561 struct hid_collection *collection; /* List of HID collections */
608 unsigned collection_size; 562 unsigned collection_size; /* Number of allocated hid_collections */
609 unsigned maxcollection; 563 unsigned maxcollection; /* Number of parsed collections */
610 unsigned maxapplication; 564 unsigned maxapplication; /* Number of applications */
611 __u16 bus; 565 __u16 bus; /* BUS ID */
612 __u16 group; 566 __u16 group; /* Report group */
613 __u32 vendor; 567 __u32 vendor; /* Vendor ID */
614 __u32 product; 568 __u32 product; /* Product ID */
615 __u32 version; 569 __u32 version; /* HID version */
616 enum hid_type type; 570 enum hid_type type; /* device type (mouse, kbd, ...) */
617 unsigned country; 571 unsigned country; /* HID country */
618 struct hid_report_enum report_enum[HID 572 struct hid_report_enum report_enum[HID_REPORT_TYPES];
619 struct work_struct led_work; 573 struct work_struct led_work; /* delayed LED worker */
620 574
621 struct semaphore driver_input_lock; 575 struct semaphore driver_input_lock; /* protects the current driver */
622 struct device dev; 576 struct device dev; /* device */
623 struct hid_driver *driver; 577 struct hid_driver *driver;
624 void *devres_group_id; <<
625 578
626 const struct hid_ll_driver *ll_driver; !! 579 struct hid_ll_driver *ll_driver;
627 struct mutex ll_open_lock; 580 struct mutex ll_open_lock;
628 unsigned int ll_open_count; 581 unsigned int ll_open_count;
629 582
630 #ifdef CONFIG_HID_BATTERY_STRENGTH 583 #ifdef CONFIG_HID_BATTERY_STRENGTH
631 /* 584 /*
632 * Power supply information for HID de 585 * Power supply information for HID devices which report
633 * battery strength. power_supply was 586 * battery strength. power_supply was successfully registered if
634 * battery is non-NULL. 587 * battery is non-NULL.
635 */ 588 */
636 struct power_supply *battery; 589 struct power_supply *battery;
637 __s32 battery_capacity; 590 __s32 battery_capacity;
638 __s32 battery_min; 591 __s32 battery_min;
639 __s32 battery_max; 592 __s32 battery_max;
640 __s32 battery_report_type; 593 __s32 battery_report_type;
641 __s32 battery_report_id; 594 __s32 battery_report_id;
642 __s32 battery_charge_status; <<
643 enum hid_battery_status battery_status 595 enum hid_battery_status battery_status;
644 bool battery_avoid_query; 596 bool battery_avoid_query;
645 ktime_t battery_ratelimit_time; <<
646 #endif 597 #endif
647 598
648 unsigned long status; 599 unsigned long status; /* see STAT flags above */
649 unsigned claimed; 600 unsigned claimed; /* Claimed by hidinput, hiddev? */
650 unsigned quirks; 601 unsigned quirks; /* Various quirks the device can pull on us */
651 unsigned initial_quirks; <<
652 bool io_started; 602 bool io_started; /* If IO has started */
653 603
654 struct list_head inputs; 604 struct list_head inputs; /* The list of inputs */
655 void *hiddev; 605 void *hiddev; /* The hiddev structure */
656 void *hidraw; 606 void *hidraw;
657 607
658 char name[128]; 608 char name[128]; /* Device name */
659 char phys[64]; 609 char phys[64]; /* Device physical location */
660 char uniq[64]; 610 char uniq[64]; /* Device unique identifier (serial #) */
661 611
662 void *driver_data; 612 void *driver_data;
663 613
664 /* temporary hid_ff handling (until mo 614 /* temporary hid_ff handling (until moved to the drivers) */
665 int (*ff_init)(struct hid_device *); 615 int (*ff_init)(struct hid_device *);
666 616
667 /* hiddev event handler */ 617 /* hiddev event handler */
668 int (*hiddev_connect)(struct hid_devic 618 int (*hiddev_connect)(struct hid_device *, unsigned int);
669 void (*hiddev_disconnect)(struct hid_d 619 void (*hiddev_disconnect)(struct hid_device *);
670 void (*hiddev_hid_event) (struct hid_d 620 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
671 struct hid_u 621 struct hid_usage *, __s32);
672 void (*hiddev_report_event) (struct hi 622 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
673 623
674 /* debugging support via debugfs */ 624 /* debugging support via debugfs */
675 unsigned short debug; 625 unsigned short debug;
676 struct dentry *debug_dir; 626 struct dentry *debug_dir;
677 struct dentry *debug_rdesc; 627 struct dentry *debug_rdesc;
678 struct dentry *debug_events; 628 struct dentry *debug_events;
679 struct list_head debug_list; 629 struct list_head debug_list;
680 spinlock_t debug_list_lock; 630 spinlock_t debug_list_lock;
681 wait_queue_head_t debug_wait; 631 wait_queue_head_t debug_wait;
682 struct kref ref; <<
683 <<
684 unsigned int id; <<
685 <<
686 #ifdef CONFIG_HID_BPF <<
687 struct hid_bpf bpf; <<
688 #endif /* CONFIG_HID_BPF */ <<
689 }; 632 };
690 633
691 void hiddev_free(struct kref *ref); <<
692 <<
693 #define to_hid_device(pdev) \ 634 #define to_hid_device(pdev) \
694 container_of(pdev, struct hid_device, 635 container_of(pdev, struct hid_device, dev)
695 636
696 static inline void *hid_get_drvdata(struct hid 637 static inline void *hid_get_drvdata(struct hid_device *hdev)
697 { 638 {
698 return dev_get_drvdata(&hdev->dev); 639 return dev_get_drvdata(&hdev->dev);
699 } 640 }
700 641
701 static inline void hid_set_drvdata(struct hid_ 642 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
702 { 643 {
703 dev_set_drvdata(&hdev->dev, data); 644 dev_set_drvdata(&hdev->dev, data);
704 } 645 }
705 646
706 #define HID_GLOBAL_STACK_SIZE 4 647 #define HID_GLOBAL_STACK_SIZE 4
707 #define HID_COLLECTION_STACK_SIZE 4 648 #define HID_COLLECTION_STACK_SIZE 4
708 649
709 #define HID_SCAN_FLAG_MT_WIN_8 650 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
710 #define HID_SCAN_FLAG_VENDOR_SPECIFIC 651 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
711 #define HID_SCAN_FLAG_GD_POINTER 652 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
712 653
713 struct hid_parser { 654 struct hid_parser {
714 struct hid_global global; 655 struct hid_global global;
715 struct hid_global global_stack[HID 656 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
716 unsigned int global_stack_ptr 657 unsigned int global_stack_ptr;
717 struct hid_local local; 658 struct hid_local local;
718 unsigned int *collection_stack 659 unsigned int *collection_stack;
719 unsigned int collection_stack 660 unsigned int collection_stack_ptr;
720 unsigned int collection_stack 661 unsigned int collection_stack_size;
721 struct hid_device *device; 662 struct hid_device *device;
722 unsigned int scan_flags; 663 unsigned int scan_flags;
723 }; 664 };
724 665
725 struct hid_class_descriptor { 666 struct hid_class_descriptor {
726 __u8 bDescriptorType; 667 __u8 bDescriptorType;
727 __le16 wDescriptorLength; 668 __le16 wDescriptorLength;
728 } __attribute__ ((packed)); 669 } __attribute__ ((packed));
729 670
730 struct hid_descriptor { 671 struct hid_descriptor {
731 __u8 bLength; 672 __u8 bLength;
732 __u8 bDescriptorType; 673 __u8 bDescriptorType;
733 __le16 bcdHID; 674 __le16 bcdHID;
734 __u8 bCountryCode; 675 __u8 bCountryCode;
735 __u8 bNumDescriptors; 676 __u8 bNumDescriptors;
736 677
737 struct hid_class_descriptor desc[1]; 678 struct hid_class_descriptor desc[1];
738 } __attribute__ ((packed)); 679 } __attribute__ ((packed));
739 680
740 #define HID_DEVICE(b, g, ven, prod) 681 #define HID_DEVICE(b, g, ven, prod) \
741 .bus = (b), .group = (g), .vendor = (v 682 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
742 #define HID_USB_DEVICE(ven, prod) 683 #define HID_USB_DEVICE(ven, prod) \
743 .bus = BUS_USB, .vendor = (ven), .prod 684 .bus = BUS_USB, .vendor = (ven), .product = (prod)
744 #define HID_BLUETOOTH_DEVICE(ven, prod) 685 #define HID_BLUETOOTH_DEVICE(ven, prod) \
745 .bus = BUS_BLUETOOTH, .vendor = (ven), 686 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
746 #define HID_I2C_DEVICE(ven, prod) 687 #define HID_I2C_DEVICE(ven, prod) \
747 .bus = BUS_I2C, .vendor = (ven), .prod 688 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
748 689
749 #define HID_REPORT_ID(rep) \ 690 #define HID_REPORT_ID(rep) \
750 .report_type = (rep) 691 .report_type = (rep)
751 #define HID_USAGE_ID(uhid, utype, ucode) \ 692 #define HID_USAGE_ID(uhid, utype, ucode) \
752 .usage_hid = (uhid), .usage_type = (ut 693 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
753 /* we don't want to catch types and codes equa 694 /* we don't want to catch types and codes equal to 0 */
754 #define HID_TERMINATOR (HID_ANY_ID - 695 #define HID_TERMINATOR (HID_ANY_ID - 1)
755 696
756 struct hid_report_id { 697 struct hid_report_id {
757 __u32 report_type; 698 __u32 report_type;
758 }; 699 };
759 struct hid_usage_id { 700 struct hid_usage_id {
760 __u32 usage_hid; 701 __u32 usage_hid;
761 __u32 usage_type; 702 __u32 usage_type;
762 __u32 usage_code; 703 __u32 usage_code;
763 }; 704 };
764 705
765 /** 706 /**
766 * struct hid_driver 707 * struct hid_driver
767 * @name: driver name (e.g. "Footech_bar-wheel 708 * @name: driver name (e.g. "Footech_bar-wheel")
768 * @id_table: which devices is this driver for 709 * @id_table: which devices is this driver for (must be non-NULL for probe
769 * to be called) 710 * to be called)
770 * @dyn_list: list of dynamically added device 711 * @dyn_list: list of dynamically added device ids
771 * @dyn_lock: lock protecting @dyn_list 712 * @dyn_lock: lock protecting @dyn_list
772 * @match: check if the given device is handle 713 * @match: check if the given device is handled by this driver
773 * @probe: new device inserted 714 * @probe: new device inserted
774 * @remove: device removed (NULL if not a hot- 715 * @remove: device removed (NULL if not a hot-plug capable driver)
775 * @report_table: on which reports to call raw 716 * @report_table: on which reports to call raw_event (NULL means all)
776 * @raw_event: if report in report_table, this 717 * @raw_event: if report in report_table, this hook is called (NULL means nop)
777 * @usage_table: on which events to call event 718 * @usage_table: on which events to call event (NULL means all)
778 * @event: if usage in usage_table, this hook 719 * @event: if usage in usage_table, this hook is called (NULL means nop)
779 * @report: this hook is called after parsing 720 * @report: this hook is called after parsing a report (NULL means nop)
780 * @report_fixup: called before report descrip 721 * @report_fixup: called before report descriptor parsing (NULL means nop)
781 * @input_mapping: invoked on input registerin 722 * @input_mapping: invoked on input registering before mapping an usage
782 * @input_mapped: invoked on input registering 723 * @input_mapped: invoked on input registering after mapping an usage
783 * @input_configured: invoked just before the 724 * @input_configured: invoked just before the device is registered
784 * @feature_mapping: invoked on feature regist 725 * @feature_mapping: invoked on feature registering
785 * @suspend: invoked on suspend (NULL means no 726 * @suspend: invoked on suspend (NULL means nop)
786 * @resume: invoked on resume if device was no 727 * @resume: invoked on resume if device was not reset (NULL means nop)
787 * @reset_resume: invoked on resume if device 728 * @reset_resume: invoked on resume if device was reset (NULL means nop)
788 * 729 *
789 * probe should return -errno on error, or 0 o 730 * probe should return -errno on error, or 0 on success. During probe,
790 * input will not be passed to raw_event unles 731 * input will not be passed to raw_event unless hid_device_io_start is
791 * called. 732 * called.
792 * 733 *
793 * raw_event and event should return negative 734 * raw_event and event should return negative on error, any other value will
794 * pass the event on to .event() typically ret 735 * pass the event on to .event() typically return 0 for success.
795 * 736 *
796 * input_mapping shall return a negative value 737 * input_mapping shall return a negative value to completely ignore this usage
797 * (e.g. doubled or invalid usage), zero to co 738 * (e.g. doubled or invalid usage), zero to continue with parsing of this
798 * usage by generic code (no special handling 739 * usage by generic code (no special handling needed) or positive to skip
799 * generic parsing (needed special handling wh 740 * generic parsing (needed special handling which was done in the hook already)
800 * input_mapped shall return negative to infor 741 * input_mapped shall return negative to inform the layer that this usage
801 * should not be considered for further proces 742 * should not be considered for further processing or zero to notify that
802 * no processing was performed and should be d 743 * no processing was performed and should be done in a generic manner
803 * Both these functions may be NULL which mean 744 * Both these functions may be NULL which means the same behavior as returning
804 * zero from them. 745 * zero from them.
805 */ 746 */
806 struct hid_driver { 747 struct hid_driver {
807 char *name; 748 char *name;
808 const struct hid_device_id *id_table; 749 const struct hid_device_id *id_table;
809 750
810 struct list_head dyn_list; 751 struct list_head dyn_list;
811 spinlock_t dyn_lock; 752 spinlock_t dyn_lock;
812 753
813 bool (*match)(struct hid_device *dev, 754 bool (*match)(struct hid_device *dev, bool ignore_special_driver);
814 int (*probe)(struct hid_device *dev, c 755 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
815 void (*remove)(struct hid_device *dev) 756 void (*remove)(struct hid_device *dev);
816 757
817 const struct hid_report_id *report_tab 758 const struct hid_report_id *report_table;
818 int (*raw_event)(struct hid_device *hd 759 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
819 u8 *data, int size); 760 u8 *data, int size);
820 const struct hid_usage_id *usage_table 761 const struct hid_usage_id *usage_table;
821 int (*event)(struct hid_device *hdev, 762 int (*event)(struct hid_device *hdev, struct hid_field *field,
822 struct hid_usage *usag 763 struct hid_usage *usage, __s32 value);
823 void (*report)(struct hid_device *hdev 764 void (*report)(struct hid_device *hdev, struct hid_report *report);
824 765
825 const __u8 *(*report_fixup)(struct hid !! 766 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
826 unsigned int *size); 767 unsigned int *size);
827 768
828 int (*input_mapping)(struct hid_device 769 int (*input_mapping)(struct hid_device *hdev,
829 struct hid_input *hidi 770 struct hid_input *hidinput, struct hid_field *field,
830 struct hid_usage *usag 771 struct hid_usage *usage, unsigned long **bit, int *max);
831 int (*input_mapped)(struct hid_device 772 int (*input_mapped)(struct hid_device *hdev,
832 struct hid_input *hidi 773 struct hid_input *hidinput, struct hid_field *field,
833 struct hid_usage *usag 774 struct hid_usage *usage, unsigned long **bit, int *max);
834 int (*input_configured)(struct hid_dev 775 int (*input_configured)(struct hid_device *hdev,
835 struct hid_inp 776 struct hid_input *hidinput);
836 void (*feature_mapping)(struct hid_dev 777 void (*feature_mapping)(struct hid_device *hdev,
837 struct hid_field *fiel 778 struct hid_field *field,
838 struct hid_usage *usag 779 struct hid_usage *usage);
839 !! 780 #ifdef CONFIG_PM
840 int (*suspend)(struct hid_device *hdev 781 int (*suspend)(struct hid_device *hdev, pm_message_t message);
841 int (*resume)(struct hid_device *hdev) 782 int (*resume)(struct hid_device *hdev);
842 int (*reset_resume)(struct hid_device 783 int (*reset_resume)(struct hid_device *hdev);
843 !! 784 #endif
844 /* private: */ 785 /* private: */
845 struct device_driver driver; 786 struct device_driver driver;
846 }; 787 };
847 788
848 #define to_hid_driver(pdrv) \ 789 #define to_hid_driver(pdrv) \
849 container_of(pdrv, struct hid_driver, 790 container_of(pdrv, struct hid_driver, driver)
850 791
851 /** 792 /**
852 * struct hid_ll_driver - low level driver cal !! 793 * hid_ll_driver - low level driver callbacks
853 * @start: called on probe to start the device 794 * @start: called on probe to start the device
854 * @stop: called on remove 795 * @stop: called on remove
855 * @open: called by input layer on open 796 * @open: called by input layer on open
856 * @close: called by input layer on close 797 * @close: called by input layer on close
857 * @power: request underlying hardware to ente 798 * @power: request underlying hardware to enter requested power mode
858 * @parse: this method is called only once to 799 * @parse: this method is called only once to parse the device data,
859 * shouldn't allocate anything to not 800 * shouldn't allocate anything to not leak memory
860 * @request: send report request to device (e. 801 * @request: send report request to device (e.g. feature report)
861 * @wait: wait for buffered io to complete (se 802 * @wait: wait for buffered io to complete (send/recv reports)
862 * @raw_request: send raw report request to de 803 * @raw_request: send raw report request to device (e.g. feature report)
863 * @output_report: send output report to devic 804 * @output_report: send output report to device
864 * @idle: send idle request to device 805 * @idle: send idle request to device
865 * @may_wakeup: return if device may act as a <<
866 * @max_buffer_size: over-ride maximum data bu <<
867 */ 806 */
868 struct hid_ll_driver { 807 struct hid_ll_driver {
869 int (*start)(struct hid_device *hdev); 808 int (*start)(struct hid_device *hdev);
870 void (*stop)(struct hid_device *hdev); 809 void (*stop)(struct hid_device *hdev);
871 810
872 int (*open)(struct hid_device *hdev); 811 int (*open)(struct hid_device *hdev);
873 void (*close)(struct hid_device *hdev) 812 void (*close)(struct hid_device *hdev);
874 813
875 int (*power)(struct hid_device *hdev, 814 int (*power)(struct hid_device *hdev, int level);
876 815
877 int (*parse)(struct hid_device *hdev); 816 int (*parse)(struct hid_device *hdev);
878 817
879 void (*request)(struct hid_device *hde 818 void (*request)(struct hid_device *hdev,
880 struct hid_report *rep 819 struct hid_report *report, int reqtype);
881 820
882 int (*wait)(struct hid_device *hdev); 821 int (*wait)(struct hid_device *hdev);
883 822
884 int (*raw_request) (struct hid_device 823 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
885 __u8 *buf, size_t 824 __u8 *buf, size_t len, unsigned char rtype,
886 int reqtype); 825 int reqtype);
887 826
888 int (*output_report) (struct hid_devic 827 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
889 828
890 int (*idle)(struct hid_device *hdev, i 829 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
891 bool (*may_wakeup)(struct hid_device * <<
892 <<
893 unsigned int max_buffer_size; <<
894 }; 830 };
895 831
896 extern bool hid_is_usb(const struct hid_device !! 832 extern struct hid_ll_driver i2c_hid_ll_driver;
>> 833 extern struct hid_ll_driver hidp_hid_driver;
>> 834 extern struct hid_ll_driver uhid_hid_driver;
>> 835 extern struct hid_ll_driver usb_hid_driver;
>> 836
>> 837 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
>> 838 struct hid_ll_driver *driver)
>> 839 {
>> 840 return hdev->ll_driver == driver;
>> 841 }
897 842
898 #define PM_HINT_FULLON 1<<5 843 #define PM_HINT_FULLON 1<<5
899 #define PM_HINT_NORMAL 1<<1 844 #define PM_HINT_NORMAL 1<<1
900 845
901 /* Applications from HID Usage Tables 4/8/99 V 846 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
902 /* We ignore a few input applications that are 847 /* We ignore a few input applications that are not widely used */
903 #define IS_INPUT_APPLICATION(a) \ 848 #define IS_INPUT_APPLICATION(a) \
904 (((a >= HID_UP_GENDESK) && (a 849 (((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
905 || ((a >= HID_DG_DIGITIZER) && !! 850 || ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
906 || (a == HID_GD_SYSTEM_CONTROL 851 || (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
907 || (a == HID_GD_WIRELESS_RADIO 852 || (a == HID_GD_WIRELESS_RADIO_CTLS))
908 853
909 /* HID core API */ 854 /* HID core API */
910 855
>> 856 extern int hid_debug;
>> 857
911 extern bool hid_ignore(struct hid_device *); 858 extern bool hid_ignore(struct hid_device *);
912 extern int hid_add_device(struct hid_device *) 859 extern int hid_add_device(struct hid_device *);
913 extern void hid_destroy_device(struct hid_devi 860 extern void hid_destroy_device(struct hid_device *);
914 861
915 extern const struct bus_type hid_bus_type; !! 862 extern struct bus_type hid_bus_type;
916 863
917 extern int __must_check __hid_register_driver( 864 extern int __must_check __hid_register_driver(struct hid_driver *,
918 struct module *, const char *m 865 struct module *, const char *mod_name);
919 866
920 /* use a define to avoid include chaining to g 867 /* use a define to avoid include chaining to get THIS_MODULE & friends */
921 #define hid_register_driver(driver) \ 868 #define hid_register_driver(driver) \
922 __hid_register_driver(driver, THIS_MOD 869 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
923 870
924 extern void hid_unregister_driver(struct hid_d 871 extern void hid_unregister_driver(struct hid_driver *);
925 872
926 /** 873 /**
927 * module_hid_driver() - Helper macro for regi 874 * module_hid_driver() - Helper macro for registering a HID driver
928 * @__hid_driver: hid_driver struct 875 * @__hid_driver: hid_driver struct
929 * 876 *
930 * Helper macro for HID drivers which do not d 877 * Helper macro for HID drivers which do not do anything special in module
931 * init/exit. This eliminates a lot of boilerp 878 * init/exit. This eliminates a lot of boilerplate. Each module may only
932 * use this macro once, and calling it replace 879 * use this macro once, and calling it replaces module_init() and module_exit()
933 */ 880 */
934 #define module_hid_driver(__hid_driver) \ 881 #define module_hid_driver(__hid_driver) \
935 module_driver(__hid_driver, hid_regist 882 module_driver(__hid_driver, hid_register_driver, \
936 hid_unregister_driver) 883 hid_unregister_driver)
937 884
938 extern void hidinput_hid_event(struct hid_devi 885 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
939 extern void hidinput_report_event(struct hid_d 886 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
940 extern int hidinput_connect(struct hid_device 887 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
941 extern void hidinput_disconnect(struct hid_dev 888 extern void hidinput_disconnect(struct hid_device *);
942 889
943 struct hid_field *hid_find_field(struct hid_de <<
944 unsigned int <<
945 int hid_set_field(struct hid_field *, unsigned 890 int hid_set_field(struct hid_field *, unsigned, __s32);
946 int hid_input_report(struct hid_device *hid, e !! 891 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
947 int interrupt); !! 892 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
948 struct hid_field *hidinput_get_led_field(struc 893 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
949 unsigned int hidinput_count_leds(struct hid_de 894 unsigned int hidinput_count_leds(struct hid_device *hid);
950 __s32 hidinput_calc_abs_res(const struct hid_f 895 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
951 void hid_output_report(struct hid_report *repo 896 void hid_output_report(struct hid_report *report, __u8 *data);
952 int __hid_request(struct hid_device *hid, stru !! 897 int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
953 u8 *hid_alloc_report_buf(struct hid_report *re 898 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
954 struct hid_device *hid_allocate_device(void); 899 struct hid_device *hid_allocate_device(void);
955 struct hid_report *hid_register_report(struct 900 struct hid_report *hid_register_report(struct hid_device *device,
956 enum hi !! 901 unsigned int type, unsigned int id,
957 unsigne 902 unsigned int application);
958 int hid_parse_report(struct hid_device *hid, c !! 903 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
959 struct hid_report *hid_validate_values(struct 904 struct hid_report *hid_validate_values(struct hid_device *hid,
960 enum hi !! 905 unsigned int type, unsigned int id,
961 unsigne 906 unsigned int field_index,
962 unsigne 907 unsigned int report_counts);
963 908
964 void hid_setup_resolution_multiplier(struct hi 909 void hid_setup_resolution_multiplier(struct hid_device *hid);
965 int hid_open_report(struct hid_device *device) 910 int hid_open_report(struct hid_device *device);
966 int hid_check_keys_pressed(struct hid_device * 911 int hid_check_keys_pressed(struct hid_device *hid);
967 int hid_connect(struct hid_device *hid, unsign 912 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
968 void hid_disconnect(struct hid_device *hid); 913 void hid_disconnect(struct hid_device *hid);
969 bool hid_match_one_id(const struct hid_device 914 bool hid_match_one_id(const struct hid_device *hdev,
970 const struct hid_device_ 915 const struct hid_device_id *id);
971 const struct hid_device_id *hid_match_id(const 916 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
972 const 917 const struct hid_device_id *id);
973 const struct hid_device_id *hid_match_device(s 918 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
974 s 919 struct hid_driver *hdrv);
975 bool hid_compare_device_paths(struct hid_devic 920 bool hid_compare_device_paths(struct hid_device *hdev_a,
976 struct hid_devic 921 struct hid_device *hdev_b, char separator);
977 s32 hid_snto32(__u32 value, unsigned n); 922 s32 hid_snto32(__u32 value, unsigned n);
978 __u32 hid_field_extract(const struct hid_devic 923 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
979 unsigned offset, unsigned 924 unsigned offset, unsigned n);
980 925
981 #ifdef CONFIG_PM <<
982 int hid_driver_suspend(struct hid_device *hdev <<
983 int hid_driver_reset_resume(struct hid_device <<
984 int hid_driver_resume(struct hid_device *hdev) <<
985 #else <<
986 static inline int hid_driver_suspend(struct hi <<
987 static inline int hid_driver_reset_resume(stru <<
988 static inline int hid_driver_resume(struct hid <<
989 #endif <<
990 <<
991 /** 926 /**
992 * hid_device_io_start - enable HID input duri 927 * hid_device_io_start - enable HID input during probe, remove
993 * 928 *
994 * @hid: the device !! 929 * @hid - the device
995 * 930 *
996 * This should only be called during probe or 931 * This should only be called during probe or remove and only be
997 * called by the thread calling probe or remov 932 * called by the thread calling probe or remove. It will allow
998 * incoming packets to be delivered to the dri 933 * incoming packets to be delivered to the driver.
999 */ 934 */
1000 static inline void hid_device_io_start(struct 935 static inline void hid_device_io_start(struct hid_device *hid) {
1001 if (hid->io_started) { 936 if (hid->io_started) {
1002 dev_warn(&hid->dev, "io alrea 937 dev_warn(&hid->dev, "io already started\n");
1003 return; 938 return;
1004 } 939 }
1005 hid->io_started = true; 940 hid->io_started = true;
1006 up(&hid->driver_input_lock); 941 up(&hid->driver_input_lock);
1007 } 942 }
1008 943
1009 /** 944 /**
1010 * hid_device_io_stop - disable HID input dur 945 * hid_device_io_stop - disable HID input during probe, remove
1011 * 946 *
1012 * @hid: the device !! 947 * @hid - the device
1013 * 948 *
1014 * Should only be called after hid_device_io_ 949 * Should only be called after hid_device_io_start. It will prevent
1015 * incoming packets from going to the driver 950 * incoming packets from going to the driver for the duration of
1016 * probe, remove. If called during probe, pac 951 * probe, remove. If called during probe, packets will still go to the
1017 * driver after probe is complete. This funct 952 * driver after probe is complete. This function should only be called
1018 * by the thread calling probe or remove. 953 * by the thread calling probe or remove.
1019 */ 954 */
1020 static inline void hid_device_io_stop(struct 955 static inline void hid_device_io_stop(struct hid_device *hid) {
1021 if (!hid->io_started) { 956 if (!hid->io_started) {
1022 dev_warn(&hid->dev, "io alrea 957 dev_warn(&hid->dev, "io already stopped\n");
1023 return; 958 return;
1024 } 959 }
1025 hid->io_started = false; 960 hid->io_started = false;
1026 down(&hid->driver_input_lock); 961 down(&hid->driver_input_lock);
1027 } 962 }
1028 963
1029 /** 964 /**
1030 * hid_map_usage - map usage input bits 965 * hid_map_usage - map usage input bits
1031 * 966 *
1032 * @hidinput: hidinput which we are intereste 967 * @hidinput: hidinput which we are interested in
1033 * @usage: usage to fill in 968 * @usage: usage to fill in
1034 * @bit: pointer to input->{}bit (out paramet 969 * @bit: pointer to input->{}bit (out parameter)
1035 * @max: maximal valid usage->code to conside 970 * @max: maximal valid usage->code to consider later (out parameter)
1036 * @type: input event type (EV_KEY, EV_REL, . 971 * @type: input event type (EV_KEY, EV_REL, ...)
1037 * @c: code which corresponds to this usage a 972 * @c: code which corresponds to this usage and type
1038 * <<
1039 * The value pointed to by @bit will be set t <<
1040 * an unhandled event type, or if @c is out o <<
1041 * can be used as an error condition. <<
1042 */ 973 */
1043 static inline void hid_map_usage(struct hid_i 974 static inline void hid_map_usage(struct hid_input *hidinput,
1044 struct hid_usage *usage, unsi 975 struct hid_usage *usage, unsigned long **bit, int *max,
1045 __u8 type, unsigned int c) !! 976 __u8 type, __u16 c)
1046 { 977 {
1047 struct input_dev *input = hidinput->i 978 struct input_dev *input = hidinput->input;
1048 unsigned long *bmap = NULL; !! 979
1049 unsigned int limit = 0; !! 980 usage->type = type;
>> 981 usage->code = c;
1050 982
1051 switch (type) { 983 switch (type) {
1052 case EV_ABS: 984 case EV_ABS:
1053 bmap = input->absbit; !! 985 *bit = input->absbit;
1054 limit = ABS_MAX; !! 986 *max = ABS_MAX;
1055 break; 987 break;
1056 case EV_REL: 988 case EV_REL:
1057 bmap = input->relbit; !! 989 *bit = input->relbit;
1058 limit = REL_MAX; !! 990 *max = REL_MAX;
1059 break; 991 break;
1060 case EV_KEY: 992 case EV_KEY:
1061 bmap = input->keybit; !! 993 *bit = input->keybit;
1062 limit = KEY_MAX; !! 994 *max = KEY_MAX;
1063 break; 995 break;
1064 case EV_LED: 996 case EV_LED:
1065 bmap = input->ledbit; !! 997 *bit = input->ledbit;
1066 limit = LED_MAX; !! 998 *max = LED_MAX;
1067 break; <<
1068 case EV_MSC: <<
1069 bmap = input->mscbit; <<
1070 limit = MSC_MAX; <<
1071 break; 999 break;
1072 } 1000 }
1073 <<
1074 if (unlikely(c > limit || !bmap)) { <<
1075 pr_warn_ratelimited("%s: Inva <<
1076 input->na <<
1077 *bit = NULL; <<
1078 return; <<
1079 } <<
1080 <<
1081 usage->type = type; <<
1082 usage->code = c; <<
1083 *max = limit; <<
1084 *bit = bmap; <<
1085 } 1001 }
1086 1002
1087 /** 1003 /**
1088 * hid_map_usage_clear - map usage input bits 1004 * hid_map_usage_clear - map usage input bits and clear the input bit
1089 * 1005 *
1090 * @hidinput: hidinput which we are intereste <<
1091 * @usage: usage to fill in <<
1092 * @bit: pointer to input->{}bit (out paramet <<
1093 * @max: maximal valid usage->code to conside <<
1094 * @type: input event type (EV_KEY, EV_REL, . <<
1095 * @c: code which corresponds to this usage a <<
1096 * <<
1097 * The same as hid_map_usage, except the @c b 1006 * The same as hid_map_usage, except the @c bit is also cleared in supported
1098 * bits (@bit). 1007 * bits (@bit).
1099 */ 1008 */
1100 static inline void hid_map_usage_clear(struct 1009 static inline void hid_map_usage_clear(struct hid_input *hidinput,
1101 struct hid_usage *usage, unsi 1010 struct hid_usage *usage, unsigned long **bit, int *max,
1102 __u8 type, __u16 c) 1011 __u8 type, __u16 c)
1103 { 1012 {
1104 hid_map_usage(hidinput, usage, bit, m 1013 hid_map_usage(hidinput, usage, bit, max, type, c);
1105 if (*bit) !! 1014 clear_bit(c, *bit);
1106 clear_bit(usage->code, *bit); <<
1107 } 1015 }
1108 1016
1109 /** 1017 /**
1110 * hid_parse - parse HW reports 1018 * hid_parse - parse HW reports
1111 * 1019 *
1112 * @hdev: hid device 1020 * @hdev: hid device
1113 * 1021 *
1114 * Call this from probe after you set up the 1022 * Call this from probe after you set up the device (if needed). Your
1115 * report_fixup will be called (if non-NULL) 1023 * report_fixup will be called (if non-NULL) after reading raw report from
1116 * device before passing it to hid layer for 1024 * device before passing it to hid layer for real parsing.
1117 */ 1025 */
1118 static inline int __must_check hid_parse(stru 1026 static inline int __must_check hid_parse(struct hid_device *hdev)
1119 { 1027 {
1120 return hid_open_report(hdev); 1028 return hid_open_report(hdev);
1121 } 1029 }
1122 1030
1123 int __must_check hid_hw_start(struct hid_devi 1031 int __must_check hid_hw_start(struct hid_device *hdev,
1124 unsigned int co 1032 unsigned int connect_mask);
1125 void hid_hw_stop(struct hid_device *hdev); 1033 void hid_hw_stop(struct hid_device *hdev);
1126 int __must_check hid_hw_open(struct hid_devic 1034 int __must_check hid_hw_open(struct hid_device *hdev);
1127 void hid_hw_close(struct hid_device *hdev); 1035 void hid_hw_close(struct hid_device *hdev);
1128 void hid_hw_request(struct hid_device *hdev, <<
1129 struct hid_report *report <<
1130 int __hid_hw_raw_request(struct hid_device *h <<
1131 unsigned char report <<
1132 size_t len, enum hid <<
1133 enum hid_class_reque <<
1134 __u64 source, bool f <<
1135 int __hid_hw_output_report(struct hid_device <<
1136 bool from_bpf); <<
1137 int hid_hw_raw_request(struct hid_device *hde <<
1138 unsigned char reportnu <<
1139 size_t len, enum hid_r <<
1140 enum hid_class_request <<
1141 int hid_hw_output_report(struct hid_device *h <<
1142 1036
1143 /** 1037 /**
1144 * hid_hw_power - requests underlying HW to g 1038 * hid_hw_power - requests underlying HW to go into given power mode
1145 * 1039 *
1146 * @hdev: hid device 1040 * @hdev: hid device
1147 * @level: requested power level (one of %PM_ 1041 * @level: requested power level (one of %PM_HINT_* defines)
1148 * 1042 *
1149 * This function requests underlying hardware 1043 * This function requests underlying hardware to enter requested power
1150 * mode. 1044 * mode.
1151 */ 1045 */
1152 1046
1153 static inline int hid_hw_power(struct hid_dev 1047 static inline int hid_hw_power(struct hid_device *hdev, int level)
1154 { 1048 {
1155 return hdev->ll_driver->power ? hdev- 1049 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1156 } 1050 }
1157 1051
1158 1052
1159 /** 1053 /**
1160 * hid_hw_idle - send idle request to device !! 1054 * hid_hw_request - send report request to device
1161 * 1055 *
1162 * @hdev: hid device 1056 * @hdev: hid device
1163 * @report: report to control !! 1057 * @report: report to send
1164 * @idle: idle state <<
1165 * @reqtype: hid request type 1058 * @reqtype: hid request type
1166 */ 1059 */
1167 static inline int hid_hw_idle(struct hid_devi !! 1060 static inline void hid_hw_request(struct hid_device *hdev,
1168 enum hid_class_request reqtyp !! 1061 struct hid_report *report, int reqtype)
1169 { 1062 {
1170 if (hdev->ll_driver->idle) !! 1063 if (hdev->ll_driver->request)
1171 return hdev->ll_driver->idle( !! 1064 return hdev->ll_driver->request(hdev, report, reqtype);
1172 1065
1173 return 0; !! 1066 __hid_request(hdev, report, reqtype);
>> 1067 }
>> 1068
>> 1069 /**
>> 1070 * hid_hw_raw_request - send report request to device
>> 1071 *
>> 1072 * @hdev: hid device
>> 1073 * @reportnum: report ID
>> 1074 * @buf: in/out data to transfer
>> 1075 * @len: length of buf
>> 1076 * @rtype: HID report type
>> 1077 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
>> 1078 *
>> 1079 * @return: count of data transfered, negative if error
>> 1080 *
>> 1081 * Same behavior as hid_hw_request, but with raw buffers instead.
>> 1082 */
>> 1083 static inline int hid_hw_raw_request(struct hid_device *hdev,
>> 1084 unsigned char reportnum, __u8 *buf,
>> 1085 size_t len, unsigned char rtype, int reqtype)
>> 1086 {
>> 1087 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
>> 1088 return -EINVAL;
>> 1089
>> 1090 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
>> 1091 rtype, reqtype);
1174 } 1092 }
1175 1093
1176 /** 1094 /**
1177 * hid_hw_may_wakeup - return if the hid devi !! 1095 * hid_hw_output_report - send output report to device
1178 * 1096 *
1179 * @hdev: hid device 1097 * @hdev: hid device
>> 1098 * @buf: raw data to transfer
>> 1099 * @len: length of buf
>> 1100 *
>> 1101 * @return: count of data transfered, negative if error
1180 */ 1102 */
1181 static inline bool hid_hw_may_wakeup(struct h !! 1103 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
>> 1104 size_t len)
1182 { 1105 {
1183 if (hdev->ll_driver->may_wakeup) !! 1106 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1184 return hdev->ll_driver->may_w !! 1107 return -EINVAL;
>> 1108
>> 1109 if (hdev->ll_driver->output_report)
>> 1110 return hdev->ll_driver->output_report(hdev, buf, len);
>> 1111
>> 1112 return -ENOSYS;
>> 1113 }
1185 1114
1186 if (hdev->dev.parent) !! 1115 /**
1187 return device_may_wakeup(hdev !! 1116 * hid_hw_idle - send idle request to device
>> 1117 *
>> 1118 * @hdev: hid device
>> 1119 * @report: report to control
>> 1120 * @idle: idle state
>> 1121 * @reqtype: hid request type
>> 1122 */
>> 1123 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
>> 1124 int reqtype)
>> 1125 {
>> 1126 if (hdev->ll_driver->idle)
>> 1127 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1188 1128
1189 return false; !! 1129 return 0;
1190 } 1130 }
1191 1131
1192 /** 1132 /**
1193 * hid_hw_wait - wait for buffered io to comp 1133 * hid_hw_wait - wait for buffered io to complete
1194 * 1134 *
1195 * @hdev: hid device 1135 * @hdev: hid device
1196 */ 1136 */
1197 static inline void hid_hw_wait(struct hid_dev 1137 static inline void hid_hw_wait(struct hid_device *hdev)
1198 { 1138 {
1199 if (hdev->ll_driver->wait) 1139 if (hdev->ll_driver->wait)
1200 hdev->ll_driver->wait(hdev); 1140 hdev->ll_driver->wait(hdev);
1201 } 1141 }
1202 1142
1203 /** 1143 /**
1204 * hid_report_len - calculate the report leng 1144 * hid_report_len - calculate the report length
1205 * 1145 *
1206 * @report: the report we want to know the le 1146 * @report: the report we want to know the length
1207 */ 1147 */
1208 static inline u32 hid_report_len(struct hid_r 1148 static inline u32 hid_report_len(struct hid_report *report)
1209 { 1149 {
1210 return DIV_ROUND_UP(report->size, 8) !! 1150 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
>> 1151 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1211 } 1152 }
1212 1153
1213 int hid_report_raw_event(struct hid_device *h !! 1154 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1214 int interrupt); !! 1155 int interrupt);
1215 1156
1216 /* HID quirks API */ 1157 /* HID quirks API */
1217 unsigned long hid_lookup_quirk(const struct h 1158 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1218 int hid_quirks_init(char **quirks_param, __u1 1159 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1219 void hid_quirks_exit(__u16 bus); 1160 void hid_quirks_exit(__u16 bus);
1220 1161
1221 #ifdef CONFIG_HID_PID 1162 #ifdef CONFIG_HID_PID
1222 int hid_pidff_init(struct hid_device *hid); 1163 int hid_pidff_init(struct hid_device *hid);
1223 #else 1164 #else
1224 #define hid_pidff_init NULL 1165 #define hid_pidff_init NULL
1225 #endif 1166 #endif
1226 1167
1227 #define dbg_hid(fmt, ...) pr_debug("%s: " fmt !! 1168 #define dbg_hid(format, arg...) \
1228 !! 1169 do { \
1229 #define hid_err(hid, fmt, ...) !! 1170 if (hid_debug) \
1230 dev_err(&(hid)->dev, fmt, ##__VA_ARGS !! 1171 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \
1231 #define hid_notice(hid, fmt, ...) !! 1172 } while (0)
1232 dev_notice(&(hid)->dev, fmt, ##__VA_A !! 1173
1233 #define hid_warn(hid, fmt, ...) !! 1174 #define hid_printk(level, hid, fmt, arg...) \
1234 dev_warn(&(hid)->dev, fmt, ##__VA_ARG !! 1175 dev_printk(level, &(hid)->dev, fmt, ##arg)
1235 #define hid_info(hid, fmt, ...) !! 1176 #define hid_emerg(hid, fmt, arg...) \
1236 dev_info(&(hid)->dev, fmt, ##__VA_ARG !! 1177 dev_emerg(&(hid)->dev, fmt, ##arg)
1237 #define hid_dbg(hid, fmt, ...) !! 1178 #define hid_crit(hid, fmt, arg...) \
1238 dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS !! 1179 dev_crit(&(hid)->dev, fmt, ##arg)
1239 !! 1180 #define hid_alert(hid, fmt, arg...) \
1240 #define hid_err_once(hid, fmt, ...) !! 1181 dev_alert(&(hid)->dev, fmt, ##arg)
1241 dev_err_once(&(hid)->dev, fmt, ##__VA !! 1182 #define hid_err(hid, fmt, arg...) \
1242 #define hid_notice_once(hid, fmt, ...) !! 1183 dev_err(&(hid)->dev, fmt, ##arg)
1243 dev_notice_once(&(hid)->dev, fmt, ##_ !! 1184 #define hid_notice(hid, fmt, arg...) \
1244 #define hid_warn_once(hid, fmt, ...) !! 1185 dev_notice(&(hid)->dev, fmt, ##arg)
1245 dev_warn_once(&(hid)->dev, fmt, ##__V !! 1186 #define hid_warn(hid, fmt, arg...) \
1246 #define hid_info_once(hid, fmt, ...) !! 1187 dev_warn(&(hid)->dev, fmt, ##arg)
1247 dev_info_once(&(hid)->dev, fmt, ##__V !! 1188 #define hid_info(hid, fmt, arg...) \
1248 #define hid_dbg_once(hid, fmt, ...) !! 1189 dev_info(&(hid)->dev, fmt, ##arg)
1249 dev_dbg_once(&(hid)->dev, fmt, ##__VA !! 1190 #define hid_dbg(hid, fmt, arg...) \
>> 1191 dev_dbg(&(hid)->dev, fmt, ##arg)
1250 1192
1251 #endif 1193 #endif
1252 1194
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.