Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
1da177e4 LT |
2 | * Copyright (c) 1999 Andreas Gal |
3 | * Copyright (c) 2000-2001 Vojtech Pavlik | |
b55fd23c | 4 | * Copyright (c) 2006-2007 Jiri Kosina |
1da177e4 | 5 | */ |
1da177e4 LT |
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 | |
20 | * | |
21 | * Should you need to contact me, the author, you can do so either by | |
22 | * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: | |
23 | * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic | |
24 | */ | |
607ca46e DH |
25 | #ifndef __HID_H |
26 | #define __HID_H | |
1da177e4 | 27 | |
57d292bd JK |
28 | |
29 | #include <linux/types.h> | |
30 | #include <linux/slab.h> | |
31 | #include <linux/list.h> | |
e8c84f9a | 32 | #include <linux/mod_devicetable.h> /* hid_device_id */ |
57d292bd JK |
33 | #include <linux/timer.h> |
34 | #include <linux/workqueue.h> | |
35 | #include <linux/input.h> | |
4ea54542 | 36 | #include <linux/semaphore.h> |
4f5ca836 | 37 | #include <linux/power_supply.h> |
607ca46e | 38 | #include <uapi/linux/hid.h> |
57d292bd | 39 | |
1da177e4 LT |
40 | /* |
41 | * We parse each description item into this structure. Short items data | |
42 | * values are expanded to 32-bit signed int, long items contain a pointer | |
43 | * into the data area. | |
44 | */ | |
45 | ||
46 | struct hid_item { | |
47 | unsigned format; | |
48 | __u8 size; | |
49 | __u8 type; | |
50 | __u8 tag; | |
51 | union { | |
52 | __u8 u8; | |
53 | __s8 s8; | |
54 | __u16 u16; | |
55 | __s16 s16; | |
56 | __u32 u32; | |
57 | __s32 s32; | |
58 | __u8 *longdata; | |
59 | } data; | |
60 | }; | |
61 | ||
62 | /* | |
63 | * HID report item format | |
64 | */ | |
65 | ||
66 | #define HID_ITEM_FORMAT_SHORT 0 | |
67 | #define HID_ITEM_FORMAT_LONG 1 | |
68 | ||
69 | /* | |
70 | * Special tag indicating long items | |
71 | */ | |
72 | ||
73 | #define HID_ITEM_TAG_LONG 15 | |
74 | ||
75 | /* | |
76 | * HID report descriptor item type (prefix bit 2,3) | |
77 | */ | |
78 | ||
79 | #define HID_ITEM_TYPE_MAIN 0 | |
80 | #define HID_ITEM_TYPE_GLOBAL 1 | |
81 | #define HID_ITEM_TYPE_LOCAL 2 | |
82 | #define HID_ITEM_TYPE_RESERVED 3 | |
83 | ||
84 | /* | |
85 | * HID report descriptor main item tags | |
86 | */ | |
87 | ||
88 | #define HID_MAIN_ITEM_TAG_INPUT 8 | |
89 | #define HID_MAIN_ITEM_TAG_OUTPUT 9 | |
90 | #define HID_MAIN_ITEM_TAG_FEATURE 11 | |
91 | #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10 | |
92 | #define HID_MAIN_ITEM_TAG_END_COLLECTION 12 | |
93 | ||
94 | /* | |
95 | * HID report descriptor main item contents | |
96 | */ | |
97 | ||
98 | #define HID_MAIN_ITEM_CONSTANT 0x001 | |
99 | #define HID_MAIN_ITEM_VARIABLE 0x002 | |
100 | #define HID_MAIN_ITEM_RELATIVE 0x004 | |
05f091ab | 101 | #define HID_MAIN_ITEM_WRAP 0x008 |
1da177e4 LT |
102 | #define HID_MAIN_ITEM_NONLINEAR 0x010 |
103 | #define HID_MAIN_ITEM_NO_PREFERRED 0x020 | |
104 | #define HID_MAIN_ITEM_NULL_STATE 0x040 | |
105 | #define HID_MAIN_ITEM_VOLATILE 0x080 | |
106 | #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 | |
107 | ||
108 | /* | |
109 | * HID report descriptor collection item types | |
110 | */ | |
111 | ||
112 | #define HID_COLLECTION_PHYSICAL 0 | |
113 | #define HID_COLLECTION_APPLICATION 1 | |
114 | #define HID_COLLECTION_LOGICAL 2 | |
115 | ||
116 | /* | |
117 | * HID report descriptor global item tags | |
118 | */ | |
119 | ||
120 | #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0 | |
121 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1 | |
122 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2 | |
123 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3 | |
124 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4 | |
125 | #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5 | |
126 | #define HID_GLOBAL_ITEM_TAG_UNIT 6 | |
127 | #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7 | |
128 | #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8 | |
129 | #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9 | |
130 | #define HID_GLOBAL_ITEM_TAG_PUSH 10 | |
131 | #define HID_GLOBAL_ITEM_TAG_POP 11 | |
132 | ||
133 | /* | |
134 | * HID report descriptor local item tags | |
135 | */ | |
136 | ||
137 | #define HID_LOCAL_ITEM_TAG_USAGE 0 | |
138 | #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1 | |
139 | #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2 | |
140 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3 | |
141 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4 | |
142 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5 | |
143 | #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7 | |
144 | #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8 | |
145 | #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9 | |
146 | #define HID_LOCAL_ITEM_TAG_DELIMITER 10 | |
147 | ||
148 | /* | |
149 | * HID usage tables | |
150 | */ | |
151 | ||
152 | #define HID_USAGE_PAGE 0xffff0000 | |
153 | ||
154 | #define HID_UP_UNDEFINED 0x00000000 | |
05f091ab | 155 | #define HID_UP_GENDESK 0x00010000 |
0aebfdac | 156 | #define HID_UP_SIMULATION 0x00020000 |
4f5ca836 | 157 | #define HID_UP_GENDEVCTRLS 0x00060000 |
05f091ab DT |
158 | #define HID_UP_KEYBOARD 0x00070000 |
159 | #define HID_UP_LED 0x00080000 | |
160 | #define HID_UP_BUTTON 0x00090000 | |
161 | #define HID_UP_ORDINAL 0x000a0000 | |
1da177e4 | 162 | #define HID_UP_CONSUMER 0x000c0000 |
05f091ab DT |
163 | #define HID_UP_DIGITIZER 0x000d0000 |
164 | #define HID_UP_PID 0x000f0000 | |
1da177e4 | 165 | #define HID_UP_HPVENDOR 0xff7f0000 |
929578ab | 166 | #define HID_UP_HPVENDOR2 0xff010000 |
1da177e4 | 167 | #define HID_UP_MSVENDOR 0xff000000 |
e875ce37 SP |
168 | #define HID_UP_CUSTOM 0x00ff0000 |
169 | #define HID_UP_LOGIVENDOR 0xffbc0000 | |
f3d4ff0e | 170 | #define HID_UP_LNVENDOR 0xffa00000 |
83499b52 | 171 | #define HID_UP_SENSOR 0x00200000 |
1da177e4 LT |
172 | |
173 | #define HID_USAGE 0x0000ffff | |
174 | ||
175 | #define HID_GD_POINTER 0x00010001 | |
176 | #define HID_GD_MOUSE 0x00010002 | |
177 | #define HID_GD_JOYSTICK 0x00010004 | |
178 | #define HID_GD_GAMEPAD 0x00010005 | |
179 | #define HID_GD_KEYBOARD 0x00010006 | |
180 | #define HID_GD_KEYPAD 0x00010007 | |
181 | #define HID_GD_MULTIAXIS 0x00010008 | |
182 | #define HID_GD_X 0x00010030 | |
183 | #define HID_GD_Y 0x00010031 | |
184 | #define HID_GD_Z 0x00010032 | |
185 | #define HID_GD_RX 0x00010033 | |
186 | #define HID_GD_RY 0x00010034 | |
187 | #define HID_GD_RZ 0x00010035 | |
188 | #define HID_GD_SLIDER 0x00010036 | |
189 | #define HID_GD_DIAL 0x00010037 | |
190 | #define HID_GD_WHEEL 0x00010038 | |
191 | #define HID_GD_HATSWITCH 0x00010039 | |
192 | #define HID_GD_BUFFER 0x0001003a | |
193 | #define HID_GD_BYTECOUNT 0x0001003b | |
194 | #define HID_GD_MOTION 0x0001003c | |
195 | #define HID_GD_START 0x0001003d | |
196 | #define HID_GD_SELECT 0x0001003e | |
197 | #define HID_GD_VX 0x00010040 | |
198 | #define HID_GD_VY 0x00010041 | |
199 | #define HID_GD_VZ 0x00010042 | |
200 | #define HID_GD_VBRX 0x00010043 | |
201 | #define HID_GD_VBRY 0x00010044 | |
202 | #define HID_GD_VBRZ 0x00010045 | |
203 | #define HID_GD_VNO 0x00010046 | |
204 | #define HID_GD_FEATURE 0x00010047 | |
6aef704e | 205 | #define HID_GD_SYSTEM_CONTROL 0x00010080 |
1da177e4 LT |
206 | #define HID_GD_UP 0x00010090 |
207 | #define HID_GD_DOWN 0x00010091 | |
208 | #define HID_GD_RIGHT 0x00010092 | |
209 | #define HID_GD_LEFT 0x00010093 | |
210 | ||
4f5ca836 JF |
211 | #define HID_DC_BATTERYSTRENGTH 0x00060020 |
212 | ||
6aef704e BT |
213 | #define HID_CP_CONSUMER_CONTROL 0x000c0001 |
214 | ||
89f536cc SC |
215 | #define HID_DG_DIGITIZER 0x000d0001 |
216 | #define HID_DG_PEN 0x000d0002 | |
217 | #define HID_DG_LIGHTPEN 0x000d0003 | |
218 | #define HID_DG_TOUCHSCREEN 0x000d0004 | |
219 | #define HID_DG_TOUCHPAD 0x000d0005 | |
220 | #define HID_DG_STYLUS 0x000d0020 | |
221 | #define HID_DG_PUCK 0x000d0021 | |
222 | #define HID_DG_FINGER 0x000d0022 | |
223 | #define HID_DG_TIPPRESSURE 0x000d0030 | |
224 | #define HID_DG_BARRELPRESSURE 0x000d0031 | |
225 | #define HID_DG_INRANGE 0x000d0032 | |
226 | #define HID_DG_TOUCH 0x000d0033 | |
227 | #define HID_DG_UNTOUCH 0x000d0034 | |
228 | #define HID_DG_TAP 0x000d0035 | |
229 | #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 | |
230 | #define HID_DG_PROGRAMCHANGEKEY 0x000d003a | |
231 | #define HID_DG_INVERT 0x000d003c | |
232 | #define HID_DG_TIPSWITCH 0x000d0042 | |
233 | #define HID_DG_TIPSWITCH2 0x000d0043 | |
234 | #define HID_DG_BARRELSWITCH 0x000d0044 | |
235 | #define HID_DG_ERASER 0x000d0045 | |
236 | #define HID_DG_TABLETPICK 0x000d0046 | |
1a3f83f6 JC |
237 | |
238 | #define HID_CP_CONSUMERCONTROL 0x000c0001 | |
a45c30ec JC |
239 | #define HID_CP_NUMERICKEYPAD 0x000c0002 |
240 | #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003 | |
241 | #define HID_CP_MICROPHONE 0x000c0004 | |
242 | #define HID_CP_HEADPHONE 0x000c0005 | |
243 | #define HID_CP_GRAPHICEQUALIZER 0x000c0006 | |
244 | #define HID_CP_FUNCTIONBUTTONS 0x000c0036 | |
245 | #define HID_CP_SELECTION 0x000c0080 | |
246 | #define HID_CP_MEDIASELECTION 0x000c0087 | |
247 | #define HID_CP_SELECTDISC 0x000c00ba | |
248 | #define HID_CP_PLAYBACKSPEED 0x000c00f1 | |
249 | #define HID_CP_PROXIMITY 0x000c0109 | |
250 | #define HID_CP_SPEAKERSYSTEM 0x000c0160 | |
251 | #define HID_CP_CHANNELLEFT 0x000c0161 | |
252 | #define HID_CP_CHANNELRIGHT 0x000c0162 | |
253 | #define HID_CP_CHANNELCENTER 0x000c0163 | |
254 | #define HID_CP_CHANNELFRONT 0x000c0164 | |
255 | #define HID_CP_CHANNELCENTERFRONT 0x000c0165 | |
256 | #define HID_CP_CHANNELSIDE 0x000c0166 | |
257 | #define HID_CP_CHANNELSURROUND 0x000c0167 | |
258 | #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168 | |
259 | #define HID_CP_CHANNELTOP 0x000c0169 | |
260 | #define HID_CP_CHANNELUNKNOWN 0x000c016a | |
261 | #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180 | |
262 | #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200 | |
1a3f83f6 | 263 | |
89f536cc SC |
264 | #define HID_DG_CONFIDENCE 0x000d0047 |
265 | #define HID_DG_WIDTH 0x000d0048 | |
266 | #define HID_DG_HEIGHT 0x000d0049 | |
267 | #define HID_DG_CONTACTID 0x000d0051 | |
268 | #define HID_DG_INPUTMODE 0x000d0052 | |
269 | #define HID_DG_DEVICEINDEX 0x000d0053 | |
270 | #define HID_DG_CONTACTCOUNT 0x000d0054 | |
271 | #define HID_DG_CONTACTMAX 0x000d0055 | |
368c9664 PC |
272 | #define HID_DG_BARRELSWITCH2 0x000d005a |
273 | #define HID_DG_TOOLSERIALNUMBER 0x000d005b | |
89f536cc | 274 | |
1da177e4 LT |
275 | /* |
276 | * HID report types --- Ouch! HID spec says 1 2 3! | |
277 | */ | |
278 | ||
279 | #define HID_INPUT_REPORT 0 | |
280 | #define HID_OUTPUT_REPORT 1 | |
281 | #define HID_FEATURE_REPORT 2 | |
282 | ||
39054a5a DH |
283 | #define HID_REPORT_TYPES 3 |
284 | ||
93c10132 JS |
285 | /* |
286 | * HID connect requests | |
287 | */ | |
288 | ||
289 | #define HID_CONNECT_HIDINPUT 0x01 | |
290 | #define HID_CONNECT_HIDINPUT_FORCE 0x02 | |
291 | #define HID_CONNECT_HIDRAW 0x04 | |
292 | #define HID_CONNECT_HIDDEV 0x08 | |
293 | #define HID_CONNECT_HIDDEV_FORCE 0x10 | |
294 | #define HID_CONNECT_FF 0x20 | |
7704ac93 | 295 | #define HID_CONNECT_DRIVER 0x40 |
93c10132 JS |
296 | #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ |
297 | HID_CONNECT_HIDDEV|HID_CONNECT_FF) | |
298 | ||
1da177e4 LT |
299 | /* |
300 | * HID device quirks. | |
301 | */ | |
302 | ||
876b9276 PW |
303 | /* |
304 | * Increase this if you need to configure more HID quirks at module load time | |
305 | */ | |
306 | #define MAX_USBHID_BOOT_QUIRKS 4 | |
307 | ||
eab9edd2 MH |
308 | #define HID_QUIRK_INVERT 0x00000001 |
309 | #define HID_QUIRK_NOTOUCH 0x00000002 | |
6f4303fb | 310 | #define HID_QUIRK_IGNORE 0x00000004 |
eab9edd2 | 311 | #define HID_QUIRK_NOGET 0x00000008 |
b5e5a37e | 312 | #define HID_QUIRK_HIDDEV_FORCE 0x00000010 |
eab9edd2 MH |
313 | #define HID_QUIRK_BADPAD 0x00000020 |
314 | #define HID_QUIRK_MULTI_INPUT 0x00000040 | |
3a343ee4 | 315 | #define HID_QUIRK_HIDINPUT_FORCE 0x00000080 |
4f22decf | 316 | #define HID_QUIRK_NO_EMPTY_INPUT 0x00000100 |
595e9276 | 317 | #define HID_QUIRK_NO_INIT_INPUT_REPORTS 0x00000200 |
0b750b3b | 318 | #define HID_QUIRK_ALWAYS_POLL 0x00000400 |
ea9a4a8b | 319 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 |
e534a935 BT |
320 | #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID 0x00020000 |
321 | #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP 0x00040000 | |
f345c37c | 322 | #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000 |
5b915d9e | 323 | #define HID_QUIRK_NO_INIT_REPORTS 0x20000000 |
b5e5a37e | 324 | #define HID_QUIRK_NO_IGNORE 0x40000000 |
24750f3e | 325 | #define HID_QUIRK_NO_INPUT_SYNC 0x80000000 |
ea9a4a8b | 326 | |
734c6609 HR |
327 | /* |
328 | * HID device groups | |
ba391e5a BT |
329 | * |
330 | * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h | |
331 | * and has a value of 0x0000 | |
734c6609 HR |
332 | */ |
333 | #define HID_GROUP_GENERIC 0x0001 | |
4fa3a583 | 334 | #define HID_GROUP_MULTITOUCH 0x0002 |
83499b52 | 335 | #define HID_GROUP_SENSOR_HUB 0x0003 |
f961bd35 | 336 | #define HID_GROUP_MULTITOUCH_WIN_8 0x0004 |
734c6609 | 337 | |
ba391e5a BT |
338 | /* |
339 | * Vendor specific HID device groups | |
340 | */ | |
341 | #define HID_GROUP_RMI 0x0100 | |
29b47391 | 342 | #define HID_GROUP_WACOM 0x0101 |
d610274b | 343 | #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102 |
29b47391 | 344 | |
1da177e4 LT |
345 | /* |
346 | * This is the global environment of the parser. This information is | |
347 | * persistent for main-items. The global environment can be saved and | |
348 | * restored with PUSH/POP statements. | |
349 | */ | |
350 | ||
351 | struct hid_global { | |
352 | unsigned usage_page; | |
353 | __s32 logical_minimum; | |
354 | __s32 logical_maximum; | |
355 | __s32 physical_minimum; | |
356 | __s32 physical_maximum; | |
357 | __s32 unit_exponent; | |
358 | unsigned unit; | |
359 | unsigned report_id; | |
360 | unsigned report_size; | |
361 | unsigned report_count; | |
362 | }; | |
363 | ||
364 | /* | |
365 | * This is the local environment. It is persistent up the next main-item. | |
366 | */ | |
367 | ||
5f1ab74f | 368 | #define HID_MAX_USAGES 12288 |
1da177e4 LT |
369 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
370 | ||
371 | struct hid_local { | |
372 | unsigned usage[HID_MAX_USAGES]; /* usage array */ | |
373 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ | |
374 | unsigned usage_index; | |
375 | unsigned usage_minimum; | |
376 | unsigned delimiter_depth; | |
377 | unsigned delimiter_branch; | |
378 | }; | |
379 | ||
380 | /* | |
381 | * This is the collection stack. We climb up the stack to determine | |
382 | * application and function of each field. | |
383 | */ | |
384 | ||
385 | struct hid_collection { | |
386 | unsigned type; | |
387 | unsigned usage; | |
388 | unsigned level; | |
389 | }; | |
390 | ||
391 | struct hid_usage { | |
392 | unsigned hid; /* hid usage code */ | |
393 | unsigned collection_index; /* index into collection array */ | |
f262d1fa | 394 | unsigned usage_index; /* index into usage array */ |
1da177e4 LT |
395 | /* hidinput data */ |
396 | __u16 code; /* input driver code */ | |
397 | __u8 type; /* input driver type */ | |
398 | __s8 hat_min; /* hat switch fun */ | |
399 | __s8 hat_max; /* ditto */ | |
400 | __s8 hat_dir; /* ditto */ | |
401 | }; | |
402 | ||
403 | struct hid_input; | |
404 | ||
405 | struct hid_field { | |
406 | unsigned physical; /* physical usage for this field */ | |
407 | unsigned logical; /* logical usage for this field */ | |
408 | unsigned application; /* application usage for this field */ | |
409 | struct hid_usage *usage; /* usage table for this function */ | |
410 | unsigned maxusage; /* maximum usage index */ | |
411 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ | |
412 | unsigned report_offset; /* bit offset in the report */ | |
413 | unsigned report_size; /* size of this field in the report */ | |
414 | unsigned report_count; /* number of this field in the report */ | |
415 | unsigned report_type; /* (input,output,feature) */ | |
416 | __s32 *value; /* last known value(s) */ | |
417 | __s32 logical_minimum; | |
418 | __s32 logical_maximum; | |
419 | __s32 physical_minimum; | |
420 | __s32 physical_maximum; | |
421 | __s32 unit_exponent; | |
422 | unsigned unit; | |
423 | struct hid_report *report; /* associated report */ | |
424 | unsigned index; /* index into report->field[] */ | |
425 | /* hidinput data */ | |
426 | struct hid_input *hidinput; /* associated input structure */ | |
427 | __u16 dpad; /* dpad input code */ | |
428 | }; | |
429 | ||
7e55bded | 430 | #define HID_MAX_FIELDS 256 |
1da177e4 LT |
431 | |
432 | struct hid_report { | |
433 | struct list_head list; | |
434 | unsigned id; /* id of this report */ | |
435 | unsigned type; /* report type */ | |
436 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ | |
437 | unsigned maxfield; /* maximum valid field index */ | |
438 | unsigned size; /* size of the report (bits) */ | |
439 | struct hid_device *device; /* associated device */ | |
440 | }; | |
441 | ||
43622021 KC |
442 | #define HID_MAX_IDS 256 |
443 | ||
1da177e4 LT |
444 | struct hid_report_enum { |
445 | unsigned numbered; | |
446 | struct list_head report_list; | |
43622021 | 447 | struct hid_report *report_id_hash[HID_MAX_IDS]; |
1da177e4 LT |
448 | }; |
449 | ||
bf0964dc MH |
450 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
451 | #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ | |
1da177e4 LT |
452 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
453 | #define HID_OUTPUT_FIFO_SIZE 64 | |
454 | ||
455 | struct hid_control_fifo { | |
456 | unsigned char dir; | |
457 | struct hid_report *report; | |
f129ea6d AH |
458 | char *raw_report; |
459 | }; | |
460 | ||
461 | struct hid_output_fifo { | |
462 | struct hid_report *report; | |
463 | char *raw_report; | |
1da177e4 LT |
464 | }; |
465 | ||
466 | #define HID_CLAIMED_INPUT 1 | |
467 | #define HID_CLAIMED_HIDDEV 2 | |
86166b7b | 468 | #define HID_CLAIMED_HIDRAW 4 |
7704ac93 | 469 | #define HID_CLAIMED_DRIVER 8 |
1da177e4 | 470 | |
85cdaf52 | 471 | #define HID_STAT_ADDED 1 |
c500c971 | 472 | #define HID_STAT_PARSED 2 |
85cdaf52 | 473 | |
1da177e4 LT |
474 | struct hid_input { |
475 | struct list_head list; | |
476 | struct hid_report *report; | |
c5b7c7c3 | 477 | struct input_dev *input; |
1da177e4 LT |
478 | }; |
479 | ||
a73a6370 JS |
480 | enum hid_type { |
481 | HID_TYPE_OTHER = 0, | |
6dc1418e TS |
482 | HID_TYPE_USBMOUSE, |
483 | HID_TYPE_USBNONE | |
a73a6370 JS |
484 | }; |
485 | ||
85cdaf52 | 486 | struct hid_driver; |
c500c971 | 487 | struct hid_ll_driver; |
85cdaf52 | 488 | |
1da177e4 | 489 | struct hid_device { /* device report descriptor */ |
a7197c2e HR |
490 | __u8 *dev_rdesc; |
491 | unsigned dev_rsize; | |
85cdaf52 | 492 | __u8 *rdesc; |
1da177e4 LT |
493 | unsigned rsize; |
494 | struct hid_collection *collection; /* List of HID collections */ | |
495 | unsigned collection_size; /* Number of allocated hid_collections */ | |
496 | unsigned maxcollection; /* Number of parsed collections */ | |
497 | unsigned maxapplication; /* Number of applications */ | |
85cdaf52 | 498 | __u16 bus; /* BUS ID */ |
4d53b801 | 499 | __u16 group; /* Report group */ |
85cdaf52 JS |
500 | __u32 vendor; /* Vendor ID */ |
501 | __u32 product; /* Product ID */ | |
502 | __u32 version; /* HID version */ | |
a73a6370 | 503 | enum hid_type type; /* device type (mouse, kbd, ...) */ |
1da177e4 LT |
504 | unsigned country; /* HID country */ |
505 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; | |
50c9d75b | 506 | struct work_struct led_work; /* delayed LED worker */ |
1da177e4 | 507 | |
c849a614 AR |
508 | struct semaphore driver_lock; /* protects the current driver, except during input */ |
509 | struct semaphore driver_input_lock; /* protects the current driver */ | |
85cdaf52 JS |
510 | struct device dev; /* device */ |
511 | struct hid_driver *driver; | |
c500c971 | 512 | struct hid_ll_driver *ll_driver; |
1da177e4 | 513 | |
4f5ca836 JF |
514 | #ifdef CONFIG_HID_BATTERY_STRENGTH |
515 | /* | |
516 | * Power supply information for HID devices which report | |
517 | * battery strength. power_supply is registered iff | |
518 | * battery.name is non-NULL. | |
519 | */ | |
520 | struct power_supply battery; | |
521 | __s32 battery_min; | |
522 | __s32 battery_max; | |
fb8ac91b | 523 | __s32 battery_report_type; |
c5a92aa3 | 524 | __s32 battery_report_id; |
4f5ca836 JF |
525 | #endif |
526 | ||
85cdaf52 | 527 | unsigned int status; /* see STAT flags above */ |
05f091ab | 528 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
1da177e4 | 529 | unsigned quirks; /* Various quirks the device can pull on us */ |
c849a614 | 530 | bool io_started; /* Protected by driver_lock. If IO has started */ |
1da177e4 LT |
531 | |
532 | struct list_head inputs; /* The list of inputs */ | |
533 | void *hiddev; /* The hiddev structure */ | |
86166b7b | 534 | void *hidraw; |
1da177e4 LT |
535 | int minor; /* Hiddev minor number */ |
536 | ||
1da177e4 LT |
537 | int open; /* is the device open by anyone? */ |
538 | char name[128]; /* Device name */ | |
539 | char phys[64]; /* Device physical location */ | |
540 | char uniq[64]; /* Device unique identifier (serial #) */ | |
541 | ||
229695e5 JK |
542 | void *driver_data; |
543 | ||
93c10132 JS |
544 | /* temporary hid_ff handling (until moved to the drivers) */ |
545 | int (*ff_init)(struct hid_device *); | |
546 | ||
aa938f79 | 547 | /* hiddev event handler */ |
93c10132 | 548 | int (*hiddev_connect)(struct hid_device *, unsigned int); |
c4c259bc | 549 | void (*hiddev_disconnect)(struct hid_device *); |
aa938f79 JK |
550 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
551 | struct hid_usage *, __s32); | |
aa8de2f0 | 552 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
86166b7b | 553 | |
cd667ce2 JK |
554 | /* debugging support via debugfs */ |
555 | unsigned short debug; | |
556 | struct dentry *debug_dir; | |
557 | struct dentry *debug_rdesc; | |
558 | struct dentry *debug_events; | |
559 | struct list_head debug_list; | |
1deb9d34 | 560 | spinlock_t debug_list_lock; |
cd667ce2 | 561 | wait_queue_head_t debug_wait; |
1da177e4 LT |
562 | }; |
563 | ||
85cdaf52 JS |
564 | static inline void *hid_get_drvdata(struct hid_device *hdev) |
565 | { | |
566 | return dev_get_drvdata(&hdev->dev); | |
567 | } | |
568 | ||
569 | static inline void hid_set_drvdata(struct hid_device *hdev, void *data) | |
570 | { | |
571 | dev_set_drvdata(&hdev->dev, data); | |
572 | } | |
573 | ||
1da177e4 LT |
574 | #define HID_GLOBAL_STACK_SIZE 4 |
575 | #define HID_COLLECTION_STACK_SIZE 4 | |
576 | ||
e39f2d59 AD |
577 | #define HID_SCAN_FLAG_MT_WIN_8 BIT(0) |
578 | #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1) | |
579 | #define HID_SCAN_FLAG_GD_POINTER BIT(2) | |
f961bd35 | 580 | |
1da177e4 LT |
581 | struct hid_parser { |
582 | struct hid_global global; | |
583 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; | |
584 | unsigned global_stack_ptr; | |
585 | struct hid_local local; | |
586 | unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; | |
587 | unsigned collection_stack_ptr; | |
588 | struct hid_device *device; | |
f961bd35 | 589 | unsigned scan_flags; |
1da177e4 LT |
590 | }; |
591 | ||
592 | struct hid_class_descriptor { | |
593 | __u8 bDescriptorType; | |
01d7b369 | 594 | __le16 wDescriptorLength; |
1da177e4 LT |
595 | } __attribute__ ((packed)); |
596 | ||
597 | struct hid_descriptor { | |
598 | __u8 bLength; | |
599 | __u8 bDescriptorType; | |
01d7b369 | 600 | __le16 bcdHID; |
1da177e4 LT |
601 | __u8 bCountryCode; |
602 | __u8 bNumDescriptors; | |
603 | ||
604 | struct hid_class_descriptor desc[1]; | |
605 | } __attribute__ ((packed)); | |
606 | ||
070748ed HR |
607 | #define HID_DEVICE(b, g, ven, prod) \ |
608 | .bus = (b), .group = (g), .vendor = (ven), .product = (prod) | |
609 | #define HID_USB_DEVICE(ven, prod) \ | |
610 | .bus = BUS_USB, .vendor = (ven), .product = (prod) | |
611 | #define HID_BLUETOOTH_DEVICE(ven, prod) \ | |
612 | .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) | |
9fb6bf02 BT |
613 | #define HID_I2C_DEVICE(ven, prod) \ |
614 | .bus = BUS_I2C, .vendor = (ven), .product = (prod) | |
85cdaf52 JS |
615 | |
616 | #define HID_REPORT_ID(rep) \ | |
617 | .report_type = (rep) | |
618 | #define HID_USAGE_ID(uhid, utype, ucode) \ | |
619 | .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) | |
620 | /* we don't want to catch types and codes equal to 0 */ | |
621 | #define HID_TERMINATOR (HID_ANY_ID - 1) | |
622 | ||
623 | struct hid_report_id { | |
624 | __u32 report_type; | |
625 | }; | |
626 | struct hid_usage_id { | |
627 | __u32 usage_hid; | |
628 | __u32 usage_type; | |
629 | __u32 usage_code; | |
630 | }; | |
631 | ||
632 | /** | |
633 | * struct hid_driver | |
634 | * @name: driver name (e.g. "Footech_bar-wheel") | |
635 | * @id_table: which devices is this driver for (must be non-NULL for probe | |
636 | * to be called) | |
3a6f82f7 JS |
637 | * @dyn_list: list of dynamically added device ids |
638 | * @dyn_lock: lock protecting @dyn_list | |
85cdaf52 JS |
639 | * @probe: new device inserted |
640 | * @remove: device removed (NULL if not a hot-plug capable driver) | |
641 | * @report_table: on which reports to call raw_event (NULL means all) | |
642 | * @raw_event: if report in report_table, this hook is called (NULL means nop) | |
643 | * @usage_table: on which events to call event (NULL means all) | |
644 | * @event: if usage in usage_table, this hook is called (NULL means nop) | |
6d85d037 | 645 | * @report: this hook is called after parsing a report (NULL means nop) |
c500c971 JS |
646 | * @report_fixup: called before report descriptor parsing (NULL means nop) |
647 | * @input_mapping: invoked on input registering before mapping an usage | |
648 | * @input_mapped: invoked on input registering after mapping an usage | |
9ebf3d76 | 649 | * @input_configured: invoked just before the device is registered |
0d2689c0 | 650 | * @feature_mapping: invoked on feature registering |
6a740aa4 BP |
651 | * @suspend: invoked on suspend (NULL means nop) |
652 | * @resume: invoked on resume if device was not reset (NULL means nop) | |
653 | * @reset_resume: invoked on resume if device was reset (NULL means nop) | |
85cdaf52 | 654 | * |
c849a614 AR |
655 | * probe should return -errno on error, or 0 on success. During probe, |
656 | * input will not be passed to raw_event unless hid_device_io_start is | |
657 | * called. | |
658 | * | |
85cdaf52 JS |
659 | * raw_event and event should return 0 on no action performed, 1 when no |
660 | * further processing should be done and negative on error | |
c500c971 JS |
661 | * |
662 | * input_mapping shall return a negative value to completely ignore this usage | |
663 | * (e.g. doubled or invalid usage), zero to continue with parsing of this | |
664 | * usage by generic code (no special handling needed) or positive to skip | |
665 | * generic parsing (needed special handling which was done in the hook already) | |
666 | * input_mapped shall return negative to inform the layer that this usage | |
667 | * should not be considered for further processing or zero to notify that | |
668 | * no processing was performed and should be done in a generic manner | |
669 | * Both these functions may be NULL which means the same behavior as returning | |
670 | * zero from them. | |
85cdaf52 JS |
671 | */ |
672 | struct hid_driver { | |
673 | char *name; | |
674 | const struct hid_device_id *id_table; | |
675 | ||
3a6f82f7 JS |
676 | struct list_head dyn_list; |
677 | spinlock_t dyn_lock; | |
678 | ||
85cdaf52 JS |
679 | int (*probe)(struct hid_device *dev, const struct hid_device_id *id); |
680 | void (*remove)(struct hid_device *dev); | |
681 | ||
682 | const struct hid_report_id *report_table; | |
683 | int (*raw_event)(struct hid_device *hdev, struct hid_report *report, | |
684 | u8 *data, int size); | |
685 | const struct hid_usage_id *usage_table; | |
686 | int (*event)(struct hid_device *hdev, struct hid_field *field, | |
687 | struct hid_usage *usage, __s32 value); | |
6d85d037 | 688 | void (*report)(struct hid_device *hdev, struct hid_report *report); |
c500c971 | 689 | |
73e4008d NK |
690 | __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, |
691 | unsigned int *size); | |
c500c971 JS |
692 | |
693 | int (*input_mapping)(struct hid_device *hdev, | |
694 | struct hid_input *hidinput, struct hid_field *field, | |
695 | struct hid_usage *usage, unsigned long **bit, int *max); | |
696 | int (*input_mapped)(struct hid_device *hdev, | |
697 | struct hid_input *hidinput, struct hid_field *field, | |
698 | struct hid_usage *usage, unsigned long **bit, int *max); | |
9ebf3d76 HR |
699 | void (*input_configured)(struct hid_device *hdev, |
700 | struct hid_input *hidinput); | |
0d2689c0 | 701 | void (*feature_mapping)(struct hid_device *hdev, |
f635bd11 | 702 | struct hid_field *field, |
0d2689c0 | 703 | struct hid_usage *usage); |
6a740aa4 BP |
704 | #ifdef CONFIG_PM |
705 | int (*suspend)(struct hid_device *hdev, pm_message_t message); | |
706 | int (*resume)(struct hid_device *hdev); | |
707 | int (*reset_resume)(struct hid_device *hdev); | |
708 | #endif | |
85cdaf52 JS |
709 | /* private: */ |
710 | struct device_driver driver; | |
711 | }; | |
712 | ||
c500c971 JS |
713 | /** |
714 | * hid_ll_driver - low level driver callbacks | |
715 | * @start: called on probe to start the device | |
716 | * @stop: called on remove | |
717 | * @open: called by input layer on open | |
718 | * @close: called by input layer on close | |
c500c971 JS |
719 | * @parse: this method is called only once to parse the device data, |
720 | * shouldn't allocate anything to not leak memory | |
e90a6df8 | 721 | * @request: send report request to device (e.g. feature report) |
3373443b | 722 | * @wait: wait for buffered io to complete (send/recv reports) |
b69d6536 BT |
723 | * @raw_request: send raw report request to device (e.g. feature report) |
724 | * @output_report: send output report to device | |
9684819b | 725 | * @idle: send idle request to device |
c500c971 JS |
726 | */ |
727 | struct hid_ll_driver { | |
728 | int (*start)(struct hid_device *hdev); | |
729 | void (*stop)(struct hid_device *hdev); | |
730 | ||
731 | int (*open)(struct hid_device *hdev); | |
732 | void (*close)(struct hid_device *hdev); | |
733 | ||
0361a28d ON |
734 | int (*power)(struct hid_device *hdev, int level); |
735 | ||
c500c971 | 736 | int (*parse)(struct hid_device *hdev); |
e90a6df8 HR |
737 | |
738 | void (*request)(struct hid_device *hdev, | |
739 | struct hid_report *report, int reqtype); | |
740 | ||
3373443b HR |
741 | int (*wait)(struct hid_device *hdev); |
742 | ||
cd4dc082 FP |
743 | int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, |
744 | __u8 *buf, size_t len, unsigned char rtype, | |
745 | int reqtype); | |
746 | ||
747 | int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len); | |
748 | ||
749 | int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); | |
c500c971 JS |
750 | }; |
751 | ||
0361a28d ON |
752 | #define PM_HINT_FULLON 1<<5 |
753 | #define PM_HINT_NORMAL 1<<1 | |
754 | ||
1da177e4 LT |
755 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
756 | /* We ignore a few input applications that are not widely used */ | |
8b0e58a7 | 757 | #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) |
229695e5 JK |
758 | |
759 | /* HID core API */ | |
58037eb9 | 760 | |
58037eb9 | 761 | extern int hid_debug; |
58037eb9 | 762 | |
4529eefa | 763 | extern bool hid_ignore(struct hid_device *); |
85cdaf52 JS |
764 | extern int hid_add_device(struct hid_device *); |
765 | extern void hid_destroy_device(struct hid_device *); | |
766 | ||
767 | extern int __must_check __hid_register_driver(struct hid_driver *, | |
768 | struct module *, const char *mod_name); | |
eb5589a8 PG |
769 | |
770 | /* use a define to avoid include chaining to get THIS_MODULE & friends */ | |
771 | #define hid_register_driver(driver) \ | |
772 | __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) | |
773 | ||
85cdaf52 JS |
774 | extern void hid_unregister_driver(struct hid_driver *); |
775 | ||
4d02c58e HS |
776 | /** |
777 | * module_hid_driver() - Helper macro for registering a HID driver | |
778 | * @__hid_driver: hid_driver struct | |
779 | * | |
780 | * Helper macro for HID drivers which do not do anything special in module | |
781 | * init/exit. This eliminates a lot of boilerplate. Each module may only | |
782 | * use this macro once, and calling it replaces module_init() and module_exit() | |
783 | */ | |
784 | #define module_hid_driver(__hid_driver) \ | |
785 | module_driver(__hid_driver, hid_register_driver, \ | |
786 | hid_unregister_driver) | |
787 | ||
7d12e780 | 788 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
1da177e4 | 789 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
93c10132 | 790 | extern int hidinput_connect(struct hid_device *hid, unsigned int force); |
1da177e4 | 791 | extern void hidinput_disconnect(struct hid_device *); |
1da177e4 | 792 | |
1da177e4 | 793 | int hid_set_field(struct hid_field *, unsigned, __s32); |
aa8de2f0 | 794 | int hid_input_report(struct hid_device *, int type, u8 *, int, int); |
dde5845a | 795 | int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); |
4371ea82 DK |
796 | struct hid_field *hidinput_get_led_field(struct hid_device *hid); |
797 | unsigned int hidinput_count_leds(struct hid_device *hid); | |
37cf6e6f | 798 | __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code); |
dde5845a | 799 | void hid_output_report(struct hid_report *report, __u8 *data); |
4fa5a7f7 | 800 | void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype); |
27ce4050 | 801 | u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags); |
85cdaf52 | 802 | struct hid_device *hid_allocate_device(void); |
90a006ab | 803 | struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); |
85cdaf52 | 804 | int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); |
331415ff KC |
805 | struct hid_report *hid_validate_values(struct hid_device *hid, |
806 | unsigned int type, unsigned int id, | |
807 | unsigned int field_index, | |
808 | unsigned int report_counts); | |
a7197c2e | 809 | int hid_open_report(struct hid_device *device); |
0361a28d | 810 | int hid_check_keys_pressed(struct hid_device *hid); |
93c10132 | 811 | int hid_connect(struct hid_device *hid, unsigned int connect_mask); |
c4c259bc | 812 | void hid_disconnect(struct hid_device *hid); |
bbc21cfd JF |
813 | const struct hid_device_id *hid_match_id(struct hid_device *hdev, |
814 | const struct hid_device_id *id); | |
77463838 | 815 | s32 hid_snto32(__u32 value, unsigned n); |
85cdaf52 | 816 | |
c849a614 AR |
817 | /** |
818 | * hid_device_io_start - enable HID input during probe, remove | |
819 | * | |
820 | * @hid - the device | |
821 | * | |
822 | * This should only be called during probe or remove and only be | |
823 | * called by the thread calling probe or remove. It will allow | |
824 | * incoming packets to be delivered to the driver. | |
825 | */ | |
826 | static inline void hid_device_io_start(struct hid_device *hid) { | |
827 | if (hid->io_started) { | |
828 | dev_warn(&hid->dev, "io already started"); | |
829 | return; | |
830 | } | |
831 | hid->io_started = true; | |
832 | up(&hid->driver_input_lock); | |
833 | } | |
834 | ||
835 | /** | |
836 | * hid_device_io_stop - disable HID input during probe, remove | |
837 | * | |
838 | * @hid - the device | |
839 | * | |
840 | * Should only be called after hid_device_io_start. It will prevent | |
841 | * incoming packets from going to the driver for the duration of | |
842 | * probe, remove. If called during probe, packets will still go to the | |
843 | * driver after probe is complete. This function should only be called | |
844 | * by the thread calling probe or remove. | |
845 | */ | |
846 | static inline void hid_device_io_stop(struct hid_device *hid) { | |
847 | if (!hid->io_started) { | |
848 | dev_warn(&hid->dev, "io already stopped"); | |
849 | return; | |
850 | } | |
851 | hid->io_started = false; | |
852 | down(&hid->driver_input_lock); | |
853 | } | |
854 | ||
022e8c4d JS |
855 | /** |
856 | * hid_map_usage - map usage input bits | |
857 | * | |
858 | * @hidinput: hidinput which we are interested in | |
859 | * @usage: usage to fill in | |
860 | * @bit: pointer to input->{}bit (out parameter) | |
861 | * @max: maximal valid usage->code to consider later (out parameter) | |
862 | * @type: input event type (EV_KEY, EV_REL, ...) | |
863 | * @c: code which corresponds to this usage and type | |
864 | */ | |
865 | static inline void hid_map_usage(struct hid_input *hidinput, | |
866 | struct hid_usage *usage, unsigned long **bit, int *max, | |
867 | __u8 type, __u16 c) | |
868 | { | |
869 | struct input_dev *input = hidinput->input; | |
870 | ||
871 | usage->type = type; | |
872 | usage->code = c; | |
873 | ||
874 | switch (type) { | |
875 | case EV_ABS: | |
876 | *bit = input->absbit; | |
877 | *max = ABS_MAX; | |
878 | break; | |
879 | case EV_REL: | |
880 | *bit = input->relbit; | |
881 | *max = REL_MAX; | |
882 | break; | |
883 | case EV_KEY: | |
884 | *bit = input->keybit; | |
885 | *max = KEY_MAX; | |
886 | break; | |
887 | case EV_LED: | |
888 | *bit = input->ledbit; | |
889 | *max = LED_MAX; | |
890 | break; | |
891 | } | |
892 | } | |
893 | ||
894 | /** | |
895 | * hid_map_usage_clear - map usage input bits and clear the input bit | |
896 | * | |
897 | * The same as hid_map_usage, except the @c bit is also cleared in supported | |
898 | * bits (@bit). | |
899 | */ | |
900 | static inline void hid_map_usage_clear(struct hid_input *hidinput, | |
901 | struct hid_usage *usage, unsigned long **bit, int *max, | |
902 | __u8 type, __u16 c) | |
903 | { | |
904 | hid_map_usage(hidinput, usage, bit, max, type, c); | |
905 | clear_bit(c, *bit); | |
906 | } | |
907 | ||
c500c971 JS |
908 | /** |
909 | * hid_parse - parse HW reports | |
910 | * | |
911 | * @hdev: hid device | |
912 | * | |
913 | * Call this from probe after you set up the device (if needed). Your | |
914 | * report_fixup will be called (if non-NULL) after reading raw report from | |
915 | * device before passing it to hid layer for real parsing. | |
916 | */ | |
917 | static inline int __must_check hid_parse(struct hid_device *hdev) | |
918 | { | |
a7197c2e | 919 | return hid_open_report(hdev); |
c500c971 JS |
920 | } |
921 | ||
922 | /** | |
923 | * hid_hw_start - start underlaying HW | |
924 | * | |
925 | * @hdev: hid device | |
93c10132 | 926 | * @connect_mask: which outputs to connect, see HID_CONNECT_* |
c500c971 JS |
927 | * |
928 | * Call this in probe function *after* hid_parse. This will setup HW buffers | |
929 | * and start the device (if not deffered to device open). hid_hw_stop must be | |
25985edc | 930 | * called if this was successful. |
c500c971 | 931 | */ |
93c10132 JS |
932 | static inline int __must_check hid_hw_start(struct hid_device *hdev, |
933 | unsigned int connect_mask) | |
c500c971 | 934 | { |
93c10132 JS |
935 | int ret = hdev->ll_driver->start(hdev); |
936 | if (ret || !connect_mask) | |
937 | return ret; | |
938 | ret = hid_connect(hdev, connect_mask); | |
939 | if (ret) | |
940 | hdev->ll_driver->stop(hdev); | |
941 | return ret; | |
c500c971 JS |
942 | } |
943 | ||
944 | /** | |
945 | * hid_hw_stop - stop underlaying HW | |
946 | * | |
947 | * @hdev: hid device | |
948 | * | |
949 | * This is usually called from remove function or from probe when something | |
950 | * failed and hid_hw_start was called already. | |
951 | */ | |
952 | static inline void hid_hw_stop(struct hid_device *hdev) | |
953 | { | |
c4c259bc | 954 | hid_disconnect(hdev); |
c500c971 JS |
955 | hdev->ll_driver->stop(hdev); |
956 | } | |
957 | ||
5bea7660 DT |
958 | /** |
959 | * hid_hw_open - signal underlaying HW to start delivering events | |
960 | * | |
961 | * @hdev: hid device | |
962 | * | |
963 | * Tell underlying HW to start delivering events from the device. | |
964 | * This function should be called sometime after successful call | |
965 | * to hid_hiw_start(). | |
966 | */ | |
967 | static inline int __must_check hid_hw_open(struct hid_device *hdev) | |
968 | { | |
969 | return hdev->ll_driver->open(hdev); | |
970 | } | |
971 | ||
972 | /** | |
973 | * hid_hw_close - signal underlaying HW to stop delivering events | |
974 | * | |
975 | * @hdev: hid device | |
976 | * | |
977 | * This function indicates that we are not interested in the events | |
978 | * from this device anymore. Delivery of events may or may not stop, | |
979 | * depending on the number of users still outstanding. | |
980 | */ | |
981 | static inline void hid_hw_close(struct hid_device *hdev) | |
982 | { | |
983 | hdev->ll_driver->close(hdev); | |
984 | } | |
985 | ||
986 | /** | |
987 | * hid_hw_power - requests underlying HW to go into given power mode | |
988 | * | |
989 | * @hdev: hid device | |
990 | * @level: requested power level (one of %PM_HINT_* defines) | |
991 | * | |
992 | * This function requests underlying hardware to enter requested power | |
993 | * mode. | |
994 | */ | |
995 | ||
996 | static inline int hid_hw_power(struct hid_device *hdev, int level) | |
997 | { | |
998 | return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; | |
999 | } | |
1000 | ||
e90a6df8 HR |
1001 | |
1002 | /** | |
1003 | * hid_hw_request - send report request to device | |
1004 | * | |
1005 | * @hdev: hid device | |
1006 | * @report: report to send | |
1007 | * @reqtype: hid request type | |
1008 | */ | |
1009 | static inline void hid_hw_request(struct hid_device *hdev, | |
1010 | struct hid_report *report, int reqtype) | |
1011 | { | |
1012 | if (hdev->ll_driver->request) | |
4fa5a7f7 BT |
1013 | return hdev->ll_driver->request(hdev, report, reqtype); |
1014 | ||
1015 | __hid_request(hdev, report, reqtype); | |
e90a6df8 HR |
1016 | } |
1017 | ||
b69d6536 BT |
1018 | /** |
1019 | * hid_hw_raw_request - send report request to device | |
1020 | * | |
1021 | * @hdev: hid device | |
1022 | * @reportnum: report ID | |
1023 | * @buf: in/out data to transfer | |
1024 | * @len: length of buf | |
1025 | * @rtype: HID report type | |
1026 | * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT | |
1027 | * | |
1028 | * @return: count of data transfered, negative if error | |
1029 | * | |
1030 | * Same behavior as hid_hw_request, but with raw buffers instead. | |
1031 | */ | |
1032 | static inline int hid_hw_raw_request(struct hid_device *hdev, | |
1033 | unsigned char reportnum, __u8 *buf, | |
1034 | size_t len, unsigned char rtype, int reqtype) | |
1035 | { | |
53182517 BT |
1036 | if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) |
1037 | return -EINVAL; | |
1038 | ||
3c86726c | 1039 | return hdev->ll_driver->raw_request(hdev, reportnum, buf, len, |
b69d6536 | 1040 | rtype, reqtype); |
b69d6536 BT |
1041 | } |
1042 | ||
1043 | /** | |
1044 | * hid_hw_output_report - send output report to device | |
1045 | * | |
1046 | * @hdev: hid device | |
1047 | * @buf: raw data to transfer | |
1048 | * @len: length of buf | |
1049 | * | |
1050 | * @return: count of data transfered, negative if error | |
1051 | */ | |
1052 | static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf, | |
1053 | size_t len) | |
1054 | { | |
53182517 BT |
1055 | if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf) |
1056 | return -EINVAL; | |
1057 | ||
b69d6536 BT |
1058 | if (hdev->ll_driver->output_report) |
1059 | return hdev->ll_driver->output_report(hdev, buf, len); | |
1060 | ||
1061 | return -ENOSYS; | |
1062 | } | |
1063 | ||
9684819b BT |
1064 | /** |
1065 | * hid_hw_idle - send idle request to device | |
1066 | * | |
1067 | * @hdev: hid device | |
1068 | * @report: report to control | |
1069 | * @idle: idle state | |
1070 | * @reqtype: hid request type | |
1071 | */ | |
1072 | static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle, | |
1073 | int reqtype) | |
1074 | { | |
1075 | if (hdev->ll_driver->idle) | |
1076 | return hdev->ll_driver->idle(hdev, report, idle, reqtype); | |
1077 | ||
1078 | return 0; | |
1079 | } | |
1080 | ||
3373443b HR |
1081 | /** |
1082 | * hid_hw_wait - wait for buffered io to complete | |
1083 | * | |
1084 | * @hdev: hid device | |
1085 | */ | |
1086 | static inline void hid_hw_wait(struct hid_device *hdev) | |
1087 | { | |
1088 | if (hdev->ll_driver->wait) | |
1089 | hdev->ll_driver->wait(hdev); | |
1090 | } | |
1091 | ||
dabb05c6 MM |
1092 | /** |
1093 | * hid_report_len - calculate the report length | |
1094 | * | |
1095 | * @report: the report we want to know the length | |
1096 | */ | |
1097 | static inline int hid_report_len(struct hid_report *report) | |
1098 | { | |
1099 | /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */ | |
1100 | return ((report->size - 1) >> 3) + 1 + (report->id > 0); | |
1101 | } | |
1102 | ||
b6787242 | 1103 | int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, |
85cdaf52 JS |
1104 | int interrupt); |
1105 | ||
876b9276 | 1106 | /* HID quirks API */ |
2eb5dc30 | 1107 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); |
876b9276 PW |
1108 | int usbhid_quirks_init(char **quirks_param); |
1109 | void usbhid_quirks_exit(void); | |
2eb5dc30 | 1110 | |
224ee88f AH |
1111 | #ifdef CONFIG_HID_PID |
1112 | int hid_pidff_init(struct hid_device *hid); | |
1113 | #else | |
76483cf4 | 1114 | #define hid_pidff_init NULL |
1da177e4 | 1115 | #endif |
58037eb9 | 1116 | |
4291ee30 JP |
1117 | #define dbg_hid(format, arg...) \ |
1118 | do { \ | |
1119 | if (hid_debug) \ | |
1120 | printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ | |
1121 | } while (0) | |
1122 | ||
1123 | #define hid_printk(level, hid, fmt, arg...) \ | |
1124 | dev_printk(level, &(hid)->dev, fmt, ##arg) | |
1125 | #define hid_emerg(hid, fmt, arg...) \ | |
1126 | dev_emerg(&(hid)->dev, fmt, ##arg) | |
1127 | #define hid_crit(hid, fmt, arg...) \ | |
1128 | dev_crit(&(hid)->dev, fmt, ##arg) | |
1129 | #define hid_alert(hid, fmt, arg...) \ | |
1130 | dev_alert(&(hid)->dev, fmt, ##arg) | |
1131 | #define hid_err(hid, fmt, arg...) \ | |
1132 | dev_err(&(hid)->dev, fmt, ##arg) | |
1133 | #define hid_notice(hid, fmt, arg...) \ | |
1134 | dev_notice(&(hid)->dev, fmt, ##arg) | |
1135 | #define hid_warn(hid, fmt, arg...) \ | |
1136 | dev_warn(&(hid)->dev, fmt, ##arg) | |
1137 | #define hid_info(hid, fmt, arg...) \ | |
1138 | dev_info(&(hid)->dev, fmt, ##arg) | |
1139 | #define hid_dbg(hid, fmt, arg...) \ | |
1140 | dev_dbg(&(hid)->dev, fmt, ##arg) | |
1141 | ||
57d292bd | 1142 | #endif |