Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef __HID_H |
2 | #define __HID_H | |
3 | ||
4 | /* | |
1da177e4 LT |
5 | * Copyright (c) 1999 Andreas Gal |
6 | * Copyright (c) 2000-2001 Vojtech Pavlik | |
b55fd23c | 7 | * Copyright (c) 2006-2007 Jiri Kosina |
1da177e4 LT |
8 | */ |
9 | ||
10 | /* | |
11 | * This program is free software; you can redistribute it and/or modify | |
12 | * it under the terms of the GNU General Public License as published by | |
13 | * the Free Software Foundation; either version 2 of the License, or | |
14 | * (at your option) any later version. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU General Public License | |
22 | * along with this program; if not, write to the Free Software | |
23 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 | * | |
25 | * Should you need to contact me, the author, you can do so either by | |
26 | * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: | |
27 | * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic | |
28 | */ | |
29 | ||
1da177e4 LT |
30 | /* |
31 | * USB HID (Human Interface Device) interface class code | |
32 | */ | |
33 | ||
34 | #define USB_INTERFACE_CLASS_HID 3 | |
35 | ||
0f28b55d AS |
36 | /* |
37 | * USB HID interface subclass and protocol codes | |
38 | */ | |
39 | ||
40 | #define USB_INTERFACE_SUBCLASS_BOOT 1 | |
41 | #define USB_INTERFACE_PROTOCOL_KEYBOARD 1 | |
42 | #define USB_INTERFACE_PROTOCOL_MOUSE 2 | |
43 | ||
1da177e4 LT |
44 | /* |
45 | * HID class requests | |
46 | */ | |
47 | ||
48 | #define HID_REQ_GET_REPORT 0x01 | |
49 | #define HID_REQ_GET_IDLE 0x02 | |
50 | #define HID_REQ_GET_PROTOCOL 0x03 | |
51 | #define HID_REQ_SET_REPORT 0x09 | |
52 | #define HID_REQ_SET_IDLE 0x0A | |
53 | #define HID_REQ_SET_PROTOCOL 0x0B | |
54 | ||
55 | /* | |
56 | * HID class descriptor types | |
57 | */ | |
58 | ||
59 | #define HID_DT_HID (USB_TYPE_CLASS | 0x01) | |
60 | #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02) | |
61 | #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03) | |
62 | ||
57d292bd JK |
63 | #define HID_MAX_DESCRIPTOR_SIZE 4096 |
64 | ||
65 | #ifdef __KERNEL__ | |
66 | ||
67 | #include <linux/types.h> | |
68 | #include <linux/slab.h> | |
69 | #include <linux/list.h> | |
e8c84f9a | 70 | #include <linux/mod_devicetable.h> /* hid_device_id */ |
57d292bd JK |
71 | #include <linux/timer.h> |
72 | #include <linux/workqueue.h> | |
73 | #include <linux/input.h> | |
4ea54542 | 74 | #include <linux/semaphore.h> |
4f5ca836 | 75 | #include <linux/power_supply.h> |
57d292bd | 76 | |
1da177e4 LT |
77 | /* |
78 | * We parse each description item into this structure. Short items data | |
79 | * values are expanded to 32-bit signed int, long items contain a pointer | |
80 | * into the data area. | |
81 | */ | |
82 | ||
83 | struct hid_item { | |
84 | unsigned format; | |
85 | __u8 size; | |
86 | __u8 type; | |
87 | __u8 tag; | |
88 | union { | |
89 | __u8 u8; | |
90 | __s8 s8; | |
91 | __u16 u16; | |
92 | __s16 s16; | |
93 | __u32 u32; | |
94 | __s32 s32; | |
95 | __u8 *longdata; | |
96 | } data; | |
97 | }; | |
98 | ||
99 | /* | |
100 | * HID report item format | |
101 | */ | |
102 | ||
103 | #define HID_ITEM_FORMAT_SHORT 0 | |
104 | #define HID_ITEM_FORMAT_LONG 1 | |
105 | ||
106 | /* | |
107 | * Special tag indicating long items | |
108 | */ | |
109 | ||
110 | #define HID_ITEM_TAG_LONG 15 | |
111 | ||
112 | /* | |
113 | * HID report descriptor item type (prefix bit 2,3) | |
114 | */ | |
115 | ||
116 | #define HID_ITEM_TYPE_MAIN 0 | |
117 | #define HID_ITEM_TYPE_GLOBAL 1 | |
118 | #define HID_ITEM_TYPE_LOCAL 2 | |
119 | #define HID_ITEM_TYPE_RESERVED 3 | |
120 | ||
121 | /* | |
122 | * HID report descriptor main item tags | |
123 | */ | |
124 | ||
125 | #define HID_MAIN_ITEM_TAG_INPUT 8 | |
126 | #define HID_MAIN_ITEM_TAG_OUTPUT 9 | |
127 | #define HID_MAIN_ITEM_TAG_FEATURE 11 | |
128 | #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10 | |
129 | #define HID_MAIN_ITEM_TAG_END_COLLECTION 12 | |
130 | ||
131 | /* | |
132 | * HID report descriptor main item contents | |
133 | */ | |
134 | ||
135 | #define HID_MAIN_ITEM_CONSTANT 0x001 | |
136 | #define HID_MAIN_ITEM_VARIABLE 0x002 | |
137 | #define HID_MAIN_ITEM_RELATIVE 0x004 | |
05f091ab | 138 | #define HID_MAIN_ITEM_WRAP 0x008 |
1da177e4 LT |
139 | #define HID_MAIN_ITEM_NONLINEAR 0x010 |
140 | #define HID_MAIN_ITEM_NO_PREFERRED 0x020 | |
141 | #define HID_MAIN_ITEM_NULL_STATE 0x040 | |
142 | #define HID_MAIN_ITEM_VOLATILE 0x080 | |
143 | #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 | |
144 | ||
145 | /* | |
146 | * HID report descriptor collection item types | |
147 | */ | |
148 | ||
149 | #define HID_COLLECTION_PHYSICAL 0 | |
150 | #define HID_COLLECTION_APPLICATION 1 | |
151 | #define HID_COLLECTION_LOGICAL 2 | |
152 | ||
153 | /* | |
154 | * HID report descriptor global item tags | |
155 | */ | |
156 | ||
157 | #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0 | |
158 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1 | |
159 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2 | |
160 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3 | |
161 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4 | |
162 | #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5 | |
163 | #define HID_GLOBAL_ITEM_TAG_UNIT 6 | |
164 | #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7 | |
165 | #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8 | |
166 | #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9 | |
167 | #define HID_GLOBAL_ITEM_TAG_PUSH 10 | |
168 | #define HID_GLOBAL_ITEM_TAG_POP 11 | |
169 | ||
170 | /* | |
171 | * HID report descriptor local item tags | |
172 | */ | |
173 | ||
174 | #define HID_LOCAL_ITEM_TAG_USAGE 0 | |
175 | #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1 | |
176 | #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2 | |
177 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3 | |
178 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4 | |
179 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5 | |
180 | #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7 | |
181 | #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8 | |
182 | #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9 | |
183 | #define HID_LOCAL_ITEM_TAG_DELIMITER 10 | |
184 | ||
185 | /* | |
186 | * HID usage tables | |
187 | */ | |
188 | ||
189 | #define HID_USAGE_PAGE 0xffff0000 | |
190 | ||
191 | #define HID_UP_UNDEFINED 0x00000000 | |
05f091ab | 192 | #define HID_UP_GENDESK 0x00010000 |
0aebfdac | 193 | #define HID_UP_SIMULATION 0x00020000 |
4f5ca836 | 194 | #define HID_UP_GENDEVCTRLS 0x00060000 |
05f091ab DT |
195 | #define HID_UP_KEYBOARD 0x00070000 |
196 | #define HID_UP_LED 0x00080000 | |
197 | #define HID_UP_BUTTON 0x00090000 | |
198 | #define HID_UP_ORDINAL 0x000a0000 | |
1da177e4 | 199 | #define HID_UP_CONSUMER 0x000c0000 |
05f091ab DT |
200 | #define HID_UP_DIGITIZER 0x000d0000 |
201 | #define HID_UP_PID 0x000f0000 | |
1da177e4 | 202 | #define HID_UP_HPVENDOR 0xff7f0000 |
929578ab | 203 | #define HID_UP_HPVENDOR2 0xff010000 |
1da177e4 | 204 | #define HID_UP_MSVENDOR 0xff000000 |
e875ce37 SP |
205 | #define HID_UP_CUSTOM 0x00ff0000 |
206 | #define HID_UP_LOGIVENDOR 0xffbc0000 | |
1da177e4 LT |
207 | |
208 | #define HID_USAGE 0x0000ffff | |
209 | ||
210 | #define HID_GD_POINTER 0x00010001 | |
211 | #define HID_GD_MOUSE 0x00010002 | |
212 | #define HID_GD_JOYSTICK 0x00010004 | |
213 | #define HID_GD_GAMEPAD 0x00010005 | |
214 | #define HID_GD_KEYBOARD 0x00010006 | |
215 | #define HID_GD_KEYPAD 0x00010007 | |
216 | #define HID_GD_MULTIAXIS 0x00010008 | |
217 | #define HID_GD_X 0x00010030 | |
218 | #define HID_GD_Y 0x00010031 | |
219 | #define HID_GD_Z 0x00010032 | |
220 | #define HID_GD_RX 0x00010033 | |
221 | #define HID_GD_RY 0x00010034 | |
222 | #define HID_GD_RZ 0x00010035 | |
223 | #define HID_GD_SLIDER 0x00010036 | |
224 | #define HID_GD_DIAL 0x00010037 | |
225 | #define HID_GD_WHEEL 0x00010038 | |
226 | #define HID_GD_HATSWITCH 0x00010039 | |
227 | #define HID_GD_BUFFER 0x0001003a | |
228 | #define HID_GD_BYTECOUNT 0x0001003b | |
229 | #define HID_GD_MOTION 0x0001003c | |
230 | #define HID_GD_START 0x0001003d | |
231 | #define HID_GD_SELECT 0x0001003e | |
232 | #define HID_GD_VX 0x00010040 | |
233 | #define HID_GD_VY 0x00010041 | |
234 | #define HID_GD_VZ 0x00010042 | |
235 | #define HID_GD_VBRX 0x00010043 | |
236 | #define HID_GD_VBRY 0x00010044 | |
237 | #define HID_GD_VBRZ 0x00010045 | |
238 | #define HID_GD_VNO 0x00010046 | |
239 | #define HID_GD_FEATURE 0x00010047 | |
240 | #define HID_GD_UP 0x00010090 | |
241 | #define HID_GD_DOWN 0x00010091 | |
242 | #define HID_GD_RIGHT 0x00010092 | |
243 | #define HID_GD_LEFT 0x00010093 | |
244 | ||
4f5ca836 JF |
245 | #define HID_DC_BATTERYSTRENGTH 0x00060020 |
246 | ||
89f536cc SC |
247 | #define HID_DG_DIGITIZER 0x000d0001 |
248 | #define HID_DG_PEN 0x000d0002 | |
249 | #define HID_DG_LIGHTPEN 0x000d0003 | |
250 | #define HID_DG_TOUCHSCREEN 0x000d0004 | |
251 | #define HID_DG_TOUCHPAD 0x000d0005 | |
252 | #define HID_DG_STYLUS 0x000d0020 | |
253 | #define HID_DG_PUCK 0x000d0021 | |
254 | #define HID_DG_FINGER 0x000d0022 | |
255 | #define HID_DG_TIPPRESSURE 0x000d0030 | |
256 | #define HID_DG_BARRELPRESSURE 0x000d0031 | |
257 | #define HID_DG_INRANGE 0x000d0032 | |
258 | #define HID_DG_TOUCH 0x000d0033 | |
259 | #define HID_DG_UNTOUCH 0x000d0034 | |
260 | #define HID_DG_TAP 0x000d0035 | |
261 | #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 | |
262 | #define HID_DG_PROGRAMCHANGEKEY 0x000d003a | |
263 | #define HID_DG_INVERT 0x000d003c | |
264 | #define HID_DG_TIPSWITCH 0x000d0042 | |
265 | #define HID_DG_TIPSWITCH2 0x000d0043 | |
266 | #define HID_DG_BARRELSWITCH 0x000d0044 | |
267 | #define HID_DG_ERASER 0x000d0045 | |
268 | #define HID_DG_TABLETPICK 0x000d0046 | |
269 | /* | |
270 | * as of May 20, 2009 the usages below are not yet in the official USB spec | |
271 | * but are being pushed by Microsft as described in their paper "Digitizer | |
272 | * Drivers for Windows Touch and Pen-Based Computers" | |
273 | */ | |
274 | #define HID_DG_CONFIDENCE 0x000d0047 | |
275 | #define HID_DG_WIDTH 0x000d0048 | |
276 | #define HID_DG_HEIGHT 0x000d0049 | |
277 | #define HID_DG_CONTACTID 0x000d0051 | |
278 | #define HID_DG_INPUTMODE 0x000d0052 | |
279 | #define HID_DG_DEVICEINDEX 0x000d0053 | |
280 | #define HID_DG_CONTACTCOUNT 0x000d0054 | |
281 | #define HID_DG_CONTACTMAX 0x000d0055 | |
282 | ||
1da177e4 LT |
283 | /* |
284 | * HID report types --- Ouch! HID spec says 1 2 3! | |
285 | */ | |
286 | ||
287 | #define HID_INPUT_REPORT 0 | |
288 | #define HID_OUTPUT_REPORT 1 | |
289 | #define HID_FEATURE_REPORT 2 | |
290 | ||
93c10132 JS |
291 | /* |
292 | * HID connect requests | |
293 | */ | |
294 | ||
295 | #define HID_CONNECT_HIDINPUT 0x01 | |
296 | #define HID_CONNECT_HIDINPUT_FORCE 0x02 | |
297 | #define HID_CONNECT_HIDRAW 0x04 | |
298 | #define HID_CONNECT_HIDDEV 0x08 | |
299 | #define HID_CONNECT_HIDDEV_FORCE 0x10 | |
300 | #define HID_CONNECT_FF 0x20 | |
301 | #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ | |
302 | HID_CONNECT_HIDDEV|HID_CONNECT_FF) | |
303 | ||
1da177e4 LT |
304 | /* |
305 | * HID device quirks. | |
306 | */ | |
307 | ||
876b9276 PW |
308 | /* |
309 | * Increase this if you need to configure more HID quirks at module load time | |
310 | */ | |
311 | #define MAX_USBHID_BOOT_QUIRKS 4 | |
312 | ||
eab9edd2 MH |
313 | #define HID_QUIRK_INVERT 0x00000001 |
314 | #define HID_QUIRK_NOTOUCH 0x00000002 | |
6f4303fb | 315 | #define HID_QUIRK_IGNORE 0x00000004 |
eab9edd2 | 316 | #define HID_QUIRK_NOGET 0x00000008 |
b5e5a37e | 317 | #define HID_QUIRK_HIDDEV_FORCE 0x00000010 |
eab9edd2 MH |
318 | #define HID_QUIRK_BADPAD 0x00000020 |
319 | #define HID_QUIRK_MULTI_INPUT 0x00000040 | |
3a343ee4 | 320 | #define HID_QUIRK_HIDINPUT_FORCE 0x00000080 |
ea9a4a8b | 321 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 |
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 | |
329 | */ | |
330 | #define HID_GROUP_GENERIC 0x0001 | |
4fa3a583 | 331 | #define HID_GROUP_MULTITOUCH 0x0002 |
734c6609 | 332 | |
1da177e4 LT |
333 | /* |
334 | * This is the global environment of the parser. This information is | |
335 | * persistent for main-items. The global environment can be saved and | |
336 | * restored with PUSH/POP statements. | |
337 | */ | |
338 | ||
339 | struct hid_global { | |
340 | unsigned usage_page; | |
341 | __s32 logical_minimum; | |
342 | __s32 logical_maximum; | |
343 | __s32 physical_minimum; | |
344 | __s32 physical_maximum; | |
345 | __s32 unit_exponent; | |
346 | unsigned unit; | |
347 | unsigned report_id; | |
348 | unsigned report_size; | |
349 | unsigned report_count; | |
350 | }; | |
351 | ||
352 | /* | |
353 | * This is the local environment. It is persistent up the next main-item. | |
354 | */ | |
355 | ||
5f1ab74f | 356 | #define HID_MAX_USAGES 12288 |
1da177e4 LT |
357 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
358 | ||
359 | struct hid_local { | |
360 | unsigned usage[HID_MAX_USAGES]; /* usage array */ | |
361 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ | |
362 | unsigned usage_index; | |
363 | unsigned usage_minimum; | |
364 | unsigned delimiter_depth; | |
365 | unsigned delimiter_branch; | |
366 | }; | |
367 | ||
368 | /* | |
369 | * This is the collection stack. We climb up the stack to determine | |
370 | * application and function of each field. | |
371 | */ | |
372 | ||
373 | struct hid_collection { | |
374 | unsigned type; | |
375 | unsigned usage; | |
376 | unsigned level; | |
377 | }; | |
378 | ||
379 | struct hid_usage { | |
380 | unsigned hid; /* hid usage code */ | |
381 | unsigned collection_index; /* index into collection array */ | |
382 | /* hidinput data */ | |
383 | __u16 code; /* input driver code */ | |
384 | __u8 type; /* input driver type */ | |
385 | __s8 hat_min; /* hat switch fun */ | |
386 | __s8 hat_max; /* ditto */ | |
387 | __s8 hat_dir; /* ditto */ | |
388 | }; | |
389 | ||
390 | struct hid_input; | |
391 | ||
392 | struct hid_field { | |
393 | unsigned physical; /* physical usage for this field */ | |
394 | unsigned logical; /* logical usage for this field */ | |
395 | unsigned application; /* application usage for this field */ | |
396 | struct hid_usage *usage; /* usage table for this function */ | |
397 | unsigned maxusage; /* maximum usage index */ | |
398 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ | |
399 | unsigned report_offset; /* bit offset in the report */ | |
400 | unsigned report_size; /* size of this field in the report */ | |
401 | unsigned report_count; /* number of this field in the report */ | |
402 | unsigned report_type; /* (input,output,feature) */ | |
403 | __s32 *value; /* last known value(s) */ | |
404 | __s32 logical_minimum; | |
405 | __s32 logical_maximum; | |
406 | __s32 physical_minimum; | |
407 | __s32 physical_maximum; | |
408 | __s32 unit_exponent; | |
409 | unsigned unit; | |
410 | struct hid_report *report; /* associated report */ | |
411 | unsigned index; /* index into report->field[] */ | |
412 | /* hidinput data */ | |
413 | struct hid_input *hidinput; /* associated input structure */ | |
414 | __u16 dpad; /* dpad input code */ | |
415 | }; | |
416 | ||
7e55bded | 417 | #define HID_MAX_FIELDS 256 |
1da177e4 LT |
418 | |
419 | struct hid_report { | |
420 | struct list_head list; | |
421 | unsigned id; /* id of this report */ | |
422 | unsigned type; /* report type */ | |
423 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ | |
424 | unsigned maxfield; /* maximum valid field index */ | |
425 | unsigned size; /* size of the report (bits) */ | |
426 | struct hid_device *device; /* associated device */ | |
427 | }; | |
428 | ||
429 | struct hid_report_enum { | |
430 | unsigned numbered; | |
431 | struct list_head report_list; | |
432 | struct hid_report *report_id_hash[256]; | |
433 | }; | |
434 | ||
435 | #define HID_REPORT_TYPES 3 | |
436 | ||
bf0964dc MH |
437 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
438 | #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ | |
1da177e4 LT |
439 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
440 | #define HID_OUTPUT_FIFO_SIZE 64 | |
441 | ||
442 | struct hid_control_fifo { | |
443 | unsigned char dir; | |
444 | struct hid_report *report; | |
f129ea6d AH |
445 | char *raw_report; |
446 | }; | |
447 | ||
448 | struct hid_output_fifo { | |
449 | struct hid_report *report; | |
450 | char *raw_report; | |
1da177e4 LT |
451 | }; |
452 | ||
453 | #define HID_CLAIMED_INPUT 1 | |
454 | #define HID_CLAIMED_HIDDEV 2 | |
86166b7b | 455 | #define HID_CLAIMED_HIDRAW 4 |
1da177e4 | 456 | |
85cdaf52 | 457 | #define HID_STAT_ADDED 1 |
c500c971 | 458 | #define HID_STAT_PARSED 2 |
85cdaf52 | 459 | |
1da177e4 LT |
460 | struct hid_input { |
461 | struct list_head list; | |
462 | struct hid_report *report; | |
c5b7c7c3 | 463 | struct input_dev *input; |
1da177e4 LT |
464 | }; |
465 | ||
a73a6370 JS |
466 | enum hid_type { |
467 | HID_TYPE_OTHER = 0, | |
6dc1418e TS |
468 | HID_TYPE_USBMOUSE, |
469 | HID_TYPE_USBNONE | |
a73a6370 JS |
470 | }; |
471 | ||
85cdaf52 | 472 | struct hid_driver; |
c500c971 | 473 | struct hid_ll_driver; |
85cdaf52 | 474 | |
1da177e4 | 475 | struct hid_device { /* device report descriptor */ |
a7197c2e HR |
476 | __u8 *dev_rdesc; |
477 | unsigned dev_rsize; | |
85cdaf52 | 478 | __u8 *rdesc; |
1da177e4 LT |
479 | unsigned rsize; |
480 | struct hid_collection *collection; /* List of HID collections */ | |
481 | unsigned collection_size; /* Number of allocated hid_collections */ | |
482 | unsigned maxcollection; /* Number of parsed collections */ | |
483 | unsigned maxapplication; /* Number of applications */ | |
85cdaf52 | 484 | __u16 bus; /* BUS ID */ |
4d53b801 | 485 | __u16 group; /* Report group */ |
85cdaf52 JS |
486 | __u32 vendor; /* Vendor ID */ |
487 | __u32 product; /* Product ID */ | |
488 | __u32 version; /* HID version */ | |
a73a6370 | 489 | enum hid_type type; /* device type (mouse, kbd, ...) */ |
1da177e4 LT |
490 | unsigned country; /* HID country */ |
491 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; | |
492 | ||
4ea54542 | 493 | struct semaphore driver_lock; /* protects the current driver */ |
85cdaf52 JS |
494 | struct device dev; /* device */ |
495 | struct hid_driver *driver; | |
c500c971 | 496 | struct hid_ll_driver *ll_driver; |
1da177e4 | 497 | |
4f5ca836 JF |
498 | #ifdef CONFIG_HID_BATTERY_STRENGTH |
499 | /* | |
500 | * Power supply information for HID devices which report | |
501 | * battery strength. power_supply is registered iff | |
502 | * battery.name is non-NULL. | |
503 | */ | |
504 | struct power_supply battery; | |
505 | __s32 battery_min; | |
506 | __s32 battery_max; | |
fb8ac91b | 507 | __s32 battery_report_type; |
c5a92aa3 | 508 | __s32 battery_report_id; |
4f5ca836 JF |
509 | #endif |
510 | ||
85cdaf52 | 511 | unsigned int status; /* see STAT flags above */ |
05f091ab | 512 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
1da177e4 LT |
513 | unsigned quirks; /* Various quirks the device can pull on us */ |
514 | ||
515 | struct list_head inputs; /* The list of inputs */ | |
516 | void *hiddev; /* The hiddev structure */ | |
86166b7b | 517 | void *hidraw; |
1da177e4 LT |
518 | int minor; /* Hiddev minor number */ |
519 | ||
1da177e4 LT |
520 | int open; /* is the device open by anyone? */ |
521 | char name[128]; /* Device name */ | |
522 | char phys[64]; /* Device physical location */ | |
523 | char uniq[64]; /* Device unique identifier (serial #) */ | |
524 | ||
229695e5 JK |
525 | void *driver_data; |
526 | ||
93c10132 JS |
527 | /* temporary hid_ff handling (until moved to the drivers) */ |
528 | int (*ff_init)(struct hid_device *); | |
529 | ||
aa938f79 | 530 | /* hiddev event handler */ |
93c10132 | 531 | int (*hiddev_connect)(struct hid_device *, unsigned int); |
c4c259bc | 532 | void (*hiddev_disconnect)(struct hid_device *); |
aa938f79 JK |
533 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
534 | struct hid_usage *, __s32); | |
aa8de2f0 | 535 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
86166b7b | 536 | |
b4dbde9d AO |
537 | /* handler for raw input (Get_Report) data, used by hidraw */ |
538 | int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char); | |
539 | ||
86166b7b | 540 | /* handler for raw output data, used by hidraw */ |
d4bfa033 | 541 | int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char); |
cd667ce2 JK |
542 | |
543 | /* debugging support via debugfs */ | |
544 | unsigned short debug; | |
545 | struct dentry *debug_dir; | |
546 | struct dentry *debug_rdesc; | |
547 | struct dentry *debug_events; | |
548 | struct list_head debug_list; | |
549 | wait_queue_head_t debug_wait; | |
1da177e4 LT |
550 | }; |
551 | ||
85cdaf52 JS |
552 | static inline void *hid_get_drvdata(struct hid_device *hdev) |
553 | { | |
554 | return dev_get_drvdata(&hdev->dev); | |
555 | } | |
556 | ||
557 | static inline void hid_set_drvdata(struct hid_device *hdev, void *data) | |
558 | { | |
559 | dev_set_drvdata(&hdev->dev, data); | |
560 | } | |
561 | ||
1da177e4 LT |
562 | #define HID_GLOBAL_STACK_SIZE 4 |
563 | #define HID_COLLECTION_STACK_SIZE 4 | |
564 | ||
565 | struct hid_parser { | |
566 | struct hid_global global; | |
567 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; | |
568 | unsigned global_stack_ptr; | |
569 | struct hid_local local; | |
570 | unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; | |
571 | unsigned collection_stack_ptr; | |
572 | struct hid_device *device; | |
573 | }; | |
574 | ||
575 | struct hid_class_descriptor { | |
576 | __u8 bDescriptorType; | |
01d7b369 | 577 | __le16 wDescriptorLength; |
1da177e4 LT |
578 | } __attribute__ ((packed)); |
579 | ||
580 | struct hid_descriptor { | |
581 | __u8 bLength; | |
582 | __u8 bDescriptorType; | |
01d7b369 | 583 | __le16 bcdHID; |
1da177e4 LT |
584 | __u8 bCountryCode; |
585 | __u8 bNumDescriptors; | |
586 | ||
587 | struct hid_class_descriptor desc[1]; | |
588 | } __attribute__ ((packed)); | |
589 | ||
070748ed HR |
590 | #define HID_DEVICE(b, g, ven, prod) \ |
591 | .bus = (b), .group = (g), .vendor = (ven), .product = (prod) | |
592 | #define HID_USB_DEVICE(ven, prod) \ | |
593 | .bus = BUS_USB, .vendor = (ven), .product = (prod) | |
594 | #define HID_BLUETOOTH_DEVICE(ven, prod) \ | |
595 | .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) | |
85cdaf52 JS |
596 | |
597 | #define HID_REPORT_ID(rep) \ | |
598 | .report_type = (rep) | |
599 | #define HID_USAGE_ID(uhid, utype, ucode) \ | |
600 | .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) | |
601 | /* we don't want to catch types and codes equal to 0 */ | |
602 | #define HID_TERMINATOR (HID_ANY_ID - 1) | |
603 | ||
604 | struct hid_report_id { | |
605 | __u32 report_type; | |
606 | }; | |
607 | struct hid_usage_id { | |
608 | __u32 usage_hid; | |
609 | __u32 usage_type; | |
610 | __u32 usage_code; | |
611 | }; | |
612 | ||
613 | /** | |
614 | * struct hid_driver | |
615 | * @name: driver name (e.g. "Footech_bar-wheel") | |
616 | * @id_table: which devices is this driver for (must be non-NULL for probe | |
617 | * to be called) | |
3a6f82f7 JS |
618 | * @dyn_list: list of dynamically added device ids |
619 | * @dyn_lock: lock protecting @dyn_list | |
85cdaf52 JS |
620 | * @probe: new device inserted |
621 | * @remove: device removed (NULL if not a hot-plug capable driver) | |
622 | * @report_table: on which reports to call raw_event (NULL means all) | |
623 | * @raw_event: if report in report_table, this hook is called (NULL means nop) | |
624 | * @usage_table: on which events to call event (NULL means all) | |
625 | * @event: if usage in usage_table, this hook is called (NULL means nop) | |
c500c971 JS |
626 | * @report_fixup: called before report descriptor parsing (NULL means nop) |
627 | * @input_mapping: invoked on input registering before mapping an usage | |
628 | * @input_mapped: invoked on input registering after mapping an usage | |
9ebf3d76 | 629 | * @input_configured: invoked just before the device is registered |
0d2689c0 | 630 | * @feature_mapping: invoked on feature registering |
6a740aa4 BP |
631 | * @suspend: invoked on suspend (NULL means nop) |
632 | * @resume: invoked on resume if device was not reset (NULL means nop) | |
633 | * @reset_resume: invoked on resume if device was reset (NULL means nop) | |
85cdaf52 JS |
634 | * |
635 | * raw_event and event should return 0 on no action performed, 1 when no | |
636 | * further processing should be done and negative on error | |
c500c971 JS |
637 | * |
638 | * input_mapping shall return a negative value to completely ignore this usage | |
639 | * (e.g. doubled or invalid usage), zero to continue with parsing of this | |
640 | * usage by generic code (no special handling needed) or positive to skip | |
641 | * generic parsing (needed special handling which was done in the hook already) | |
642 | * input_mapped shall return negative to inform the layer that this usage | |
643 | * should not be considered for further processing or zero to notify that | |
644 | * no processing was performed and should be done in a generic manner | |
645 | * Both these functions may be NULL which means the same behavior as returning | |
646 | * zero from them. | |
85cdaf52 JS |
647 | */ |
648 | struct hid_driver { | |
649 | char *name; | |
650 | const struct hid_device_id *id_table; | |
651 | ||
3a6f82f7 JS |
652 | struct list_head dyn_list; |
653 | spinlock_t dyn_lock; | |
654 | ||
85cdaf52 JS |
655 | int (*probe)(struct hid_device *dev, const struct hid_device_id *id); |
656 | void (*remove)(struct hid_device *dev); | |
657 | ||
658 | const struct hid_report_id *report_table; | |
659 | int (*raw_event)(struct hid_device *hdev, struct hid_report *report, | |
660 | u8 *data, int size); | |
661 | const struct hid_usage_id *usage_table; | |
662 | int (*event)(struct hid_device *hdev, struct hid_field *field, | |
663 | struct hid_usage *usage, __s32 value); | |
c500c971 | 664 | |
73e4008d NK |
665 | __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, |
666 | unsigned int *size); | |
c500c971 JS |
667 | |
668 | int (*input_mapping)(struct hid_device *hdev, | |
669 | struct hid_input *hidinput, struct hid_field *field, | |
670 | struct hid_usage *usage, unsigned long **bit, int *max); | |
671 | int (*input_mapped)(struct hid_device *hdev, | |
672 | struct hid_input *hidinput, struct hid_field *field, | |
673 | struct hid_usage *usage, unsigned long **bit, int *max); | |
9ebf3d76 HR |
674 | void (*input_configured)(struct hid_device *hdev, |
675 | struct hid_input *hidinput); | |
0d2689c0 | 676 | void (*feature_mapping)(struct hid_device *hdev, |
f635bd11 | 677 | struct hid_field *field, |
0d2689c0 | 678 | struct hid_usage *usage); |
6a740aa4 BP |
679 | #ifdef CONFIG_PM |
680 | int (*suspend)(struct hid_device *hdev, pm_message_t message); | |
681 | int (*resume)(struct hid_device *hdev); | |
682 | int (*reset_resume)(struct hid_device *hdev); | |
683 | #endif | |
85cdaf52 JS |
684 | /* private: */ |
685 | struct device_driver driver; | |
686 | }; | |
687 | ||
c500c971 JS |
688 | /** |
689 | * hid_ll_driver - low level driver callbacks | |
690 | * @start: called on probe to start the device | |
691 | * @stop: called on remove | |
692 | * @open: called by input layer on open | |
693 | * @close: called by input layer on close | |
694 | * @hidinput_input_event: event input event (e.g. ff or leds) | |
695 | * @parse: this method is called only once to parse the device data, | |
696 | * shouldn't allocate anything to not leak memory | |
697 | */ | |
698 | struct hid_ll_driver { | |
699 | int (*start)(struct hid_device *hdev); | |
700 | void (*stop)(struct hid_device *hdev); | |
701 | ||
702 | int (*open)(struct hid_device *hdev); | |
703 | void (*close)(struct hid_device *hdev); | |
704 | ||
0361a28d ON |
705 | int (*power)(struct hid_device *hdev, int level); |
706 | ||
c500c971 JS |
707 | int (*hidinput_input_event) (struct input_dev *idev, unsigned int type, |
708 | unsigned int code, int value); | |
709 | ||
710 | int (*parse)(struct hid_device *hdev); | |
711 | }; | |
712 | ||
0361a28d ON |
713 | #define PM_HINT_FULLON 1<<5 |
714 | #define PM_HINT_NORMAL 1<<1 | |
715 | ||
1da177e4 LT |
716 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
717 | /* We ignore a few input applications that are not widely used */ | |
8b0e58a7 | 718 | #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) |
229695e5 JK |
719 | |
720 | /* HID core API */ | |
58037eb9 | 721 | |
58037eb9 | 722 | extern int hid_debug; |
58037eb9 | 723 | |
85cdaf52 JS |
724 | extern int hid_add_device(struct hid_device *); |
725 | extern void hid_destroy_device(struct hid_device *); | |
726 | ||
727 | extern int __must_check __hid_register_driver(struct hid_driver *, | |
728 | struct module *, const char *mod_name); | |
eb5589a8 PG |
729 | |
730 | /* use a define to avoid include chaining to get THIS_MODULE & friends */ | |
731 | #define hid_register_driver(driver) \ | |
732 | __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) | |
733 | ||
85cdaf52 JS |
734 | extern void hid_unregister_driver(struct hid_driver *); |
735 | ||
7d12e780 | 736 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
1da177e4 | 737 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
93c10132 | 738 | extern int hidinput_connect(struct hid_device *hid, unsigned int force); |
1da177e4 | 739 | extern void hidinput_disconnect(struct hid_device *); |
1da177e4 | 740 | |
1da177e4 | 741 | int hid_set_field(struct hid_field *, unsigned, __s32); |
aa8de2f0 | 742 | int hid_input_report(struct hid_device *, int type, u8 *, int, int); |
dde5845a | 743 | int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); |
4371ea82 DK |
744 | struct hid_field *hidinput_get_led_field(struct hid_device *hid); |
745 | unsigned int hidinput_count_leds(struct hid_device *hid); | |
dde5845a | 746 | void hid_output_report(struct hid_report *report, __u8 *data); |
85cdaf52 | 747 | struct hid_device *hid_allocate_device(void); |
90a006ab | 748 | struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); |
85cdaf52 | 749 | int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); |
a7197c2e | 750 | int hid_open_report(struct hid_device *device); |
0361a28d | 751 | int hid_check_keys_pressed(struct hid_device *hid); |
93c10132 | 752 | int hid_connect(struct hid_device *hid, unsigned int connect_mask); |
c4c259bc | 753 | void hid_disconnect(struct hid_device *hid); |
bbc21cfd JF |
754 | const struct hid_device_id *hid_match_id(struct hid_device *hdev, |
755 | const struct hid_device_id *id); | |
85cdaf52 | 756 | |
022e8c4d JS |
757 | /** |
758 | * hid_map_usage - map usage input bits | |
759 | * | |
760 | * @hidinput: hidinput which we are interested in | |
761 | * @usage: usage to fill in | |
762 | * @bit: pointer to input->{}bit (out parameter) | |
763 | * @max: maximal valid usage->code to consider later (out parameter) | |
764 | * @type: input event type (EV_KEY, EV_REL, ...) | |
765 | * @c: code which corresponds to this usage and type | |
766 | */ | |
767 | static inline void hid_map_usage(struct hid_input *hidinput, | |
768 | struct hid_usage *usage, unsigned long **bit, int *max, | |
769 | __u8 type, __u16 c) | |
770 | { | |
771 | struct input_dev *input = hidinput->input; | |
772 | ||
773 | usage->type = type; | |
774 | usage->code = c; | |
775 | ||
776 | switch (type) { | |
777 | case EV_ABS: | |
778 | *bit = input->absbit; | |
779 | *max = ABS_MAX; | |
780 | break; | |
781 | case EV_REL: | |
782 | *bit = input->relbit; | |
783 | *max = REL_MAX; | |
784 | break; | |
785 | case EV_KEY: | |
786 | *bit = input->keybit; | |
787 | *max = KEY_MAX; | |
788 | break; | |
789 | case EV_LED: | |
790 | *bit = input->ledbit; | |
791 | *max = LED_MAX; | |
792 | break; | |
793 | } | |
794 | } | |
795 | ||
796 | /** | |
797 | * hid_map_usage_clear - map usage input bits and clear the input bit | |
798 | * | |
799 | * The same as hid_map_usage, except the @c bit is also cleared in supported | |
800 | * bits (@bit). | |
801 | */ | |
802 | static inline void hid_map_usage_clear(struct hid_input *hidinput, | |
803 | struct hid_usage *usage, unsigned long **bit, int *max, | |
804 | __u8 type, __u16 c) | |
805 | { | |
806 | hid_map_usage(hidinput, usage, bit, max, type, c); | |
807 | clear_bit(c, *bit); | |
808 | } | |
809 | ||
c500c971 JS |
810 | /** |
811 | * hid_parse - parse HW reports | |
812 | * | |
813 | * @hdev: hid device | |
814 | * | |
815 | * Call this from probe after you set up the device (if needed). Your | |
816 | * report_fixup will be called (if non-NULL) after reading raw report from | |
817 | * device before passing it to hid layer for real parsing. | |
818 | */ | |
819 | static inline int __must_check hid_parse(struct hid_device *hdev) | |
820 | { | |
a7197c2e | 821 | return hid_open_report(hdev); |
c500c971 JS |
822 | } |
823 | ||
824 | /** | |
825 | * hid_hw_start - start underlaying HW | |
826 | * | |
827 | * @hdev: hid device | |
93c10132 | 828 | * @connect_mask: which outputs to connect, see HID_CONNECT_* |
c500c971 JS |
829 | * |
830 | * Call this in probe function *after* hid_parse. This will setup HW buffers | |
831 | * and start the device (if not deffered to device open). hid_hw_stop must be | |
25985edc | 832 | * called if this was successful. |
c500c971 | 833 | */ |
93c10132 JS |
834 | static inline int __must_check hid_hw_start(struct hid_device *hdev, |
835 | unsigned int connect_mask) | |
c500c971 | 836 | { |
93c10132 JS |
837 | int ret = hdev->ll_driver->start(hdev); |
838 | if (ret || !connect_mask) | |
839 | return ret; | |
840 | ret = hid_connect(hdev, connect_mask); | |
841 | if (ret) | |
842 | hdev->ll_driver->stop(hdev); | |
843 | return ret; | |
c500c971 JS |
844 | } |
845 | ||
846 | /** | |
847 | * hid_hw_stop - stop underlaying HW | |
848 | * | |
849 | * @hdev: hid device | |
850 | * | |
851 | * This is usually called from remove function or from probe when something | |
852 | * failed and hid_hw_start was called already. | |
853 | */ | |
854 | static inline void hid_hw_stop(struct hid_device *hdev) | |
855 | { | |
c4c259bc | 856 | hid_disconnect(hdev); |
c500c971 JS |
857 | hdev->ll_driver->stop(hdev); |
858 | } | |
859 | ||
5bea7660 DT |
860 | /** |
861 | * hid_hw_open - signal underlaying HW to start delivering events | |
862 | * | |
863 | * @hdev: hid device | |
864 | * | |
865 | * Tell underlying HW to start delivering events from the device. | |
866 | * This function should be called sometime after successful call | |
867 | * to hid_hiw_start(). | |
868 | */ | |
869 | static inline int __must_check hid_hw_open(struct hid_device *hdev) | |
870 | { | |
871 | return hdev->ll_driver->open(hdev); | |
872 | } | |
873 | ||
874 | /** | |
875 | * hid_hw_close - signal underlaying HW to stop delivering events | |
876 | * | |
877 | * @hdev: hid device | |
878 | * | |
879 | * This function indicates that we are not interested in the events | |
880 | * from this device anymore. Delivery of events may or may not stop, | |
881 | * depending on the number of users still outstanding. | |
882 | */ | |
883 | static inline void hid_hw_close(struct hid_device *hdev) | |
884 | { | |
885 | hdev->ll_driver->close(hdev); | |
886 | } | |
887 | ||
888 | /** | |
889 | * hid_hw_power - requests underlying HW to go into given power mode | |
890 | * | |
891 | * @hdev: hid device | |
892 | * @level: requested power level (one of %PM_HINT_* defines) | |
893 | * | |
894 | * This function requests underlying hardware to enter requested power | |
895 | * mode. | |
896 | */ | |
897 | ||
898 | static inline int hid_hw_power(struct hid_device *hdev, int level) | |
899 | { | |
900 | return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0; | |
901 | } | |
902 | ||
b6787242 | 903 | int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, |
85cdaf52 JS |
904 | int interrupt); |
905 | ||
906 | extern int hid_generic_init(void); | |
907 | extern void hid_generic_exit(void); | |
1da177e4 | 908 | |
876b9276 | 909 | /* HID quirks API */ |
2eb5dc30 | 910 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); |
876b9276 PW |
911 | int usbhid_quirks_init(char **quirks_param); |
912 | void usbhid_quirks_exit(void); | |
6edfa8dc | 913 | void usbhid_set_leds(struct hid_device *hid); |
2eb5dc30 | 914 | |
224ee88f AH |
915 | #ifdef CONFIG_HID_PID |
916 | int hid_pidff_init(struct hid_device *hid); | |
917 | #else | |
76483cf4 | 918 | #define hid_pidff_init NULL |
1da177e4 | 919 | #endif |
58037eb9 | 920 | |
4291ee30 JP |
921 | #define dbg_hid(format, arg...) \ |
922 | do { \ | |
923 | if (hid_debug) \ | |
924 | printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \ | |
925 | } while (0) | |
926 | ||
927 | #define hid_printk(level, hid, fmt, arg...) \ | |
928 | dev_printk(level, &(hid)->dev, fmt, ##arg) | |
929 | #define hid_emerg(hid, fmt, arg...) \ | |
930 | dev_emerg(&(hid)->dev, fmt, ##arg) | |
931 | #define hid_crit(hid, fmt, arg...) \ | |
932 | dev_crit(&(hid)->dev, fmt, ##arg) | |
933 | #define hid_alert(hid, fmt, arg...) \ | |
934 | dev_alert(&(hid)->dev, fmt, ##arg) | |
935 | #define hid_err(hid, fmt, arg...) \ | |
936 | dev_err(&(hid)->dev, fmt, ##arg) | |
937 | #define hid_notice(hid, fmt, arg...) \ | |
938 | dev_notice(&(hid)->dev, fmt, ##arg) | |
939 | #define hid_warn(hid, fmt, arg...) \ | |
940 | dev_warn(&(hid)->dev, fmt, ##arg) | |
941 | #define hid_info(hid, fmt, arg...) \ | |
942 | dev_info(&(hid)->dev, fmt, ##arg) | |
943 | #define hid_dbg(hid, fmt, arg...) \ | |
944 | dev_dbg(&(hid)->dev, fmt, ##arg) | |
945 | ||
946 | #endif /* __KERNEL__ */ | |
02ae9a1a | 947 | |
57d292bd | 948 | #endif |
224ee88f | 949 |