]>
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> | |
74 | ||
1da177e4 LT |
75 | /* |
76 | * We parse each description item into this structure. Short items data | |
77 | * values are expanded to 32-bit signed int, long items contain a pointer | |
78 | * into the data area. | |
79 | */ | |
80 | ||
81 | struct hid_item { | |
82 | unsigned format; | |
83 | __u8 size; | |
84 | __u8 type; | |
85 | __u8 tag; | |
86 | union { | |
87 | __u8 u8; | |
88 | __s8 s8; | |
89 | __u16 u16; | |
90 | __s16 s16; | |
91 | __u32 u32; | |
92 | __s32 s32; | |
93 | __u8 *longdata; | |
94 | } data; | |
95 | }; | |
96 | ||
97 | /* | |
98 | * HID report item format | |
99 | */ | |
100 | ||
101 | #define HID_ITEM_FORMAT_SHORT 0 | |
102 | #define HID_ITEM_FORMAT_LONG 1 | |
103 | ||
104 | /* | |
105 | * Special tag indicating long items | |
106 | */ | |
107 | ||
108 | #define HID_ITEM_TAG_LONG 15 | |
109 | ||
110 | /* | |
111 | * HID report descriptor item type (prefix bit 2,3) | |
112 | */ | |
113 | ||
114 | #define HID_ITEM_TYPE_MAIN 0 | |
115 | #define HID_ITEM_TYPE_GLOBAL 1 | |
116 | #define HID_ITEM_TYPE_LOCAL 2 | |
117 | #define HID_ITEM_TYPE_RESERVED 3 | |
118 | ||
119 | /* | |
120 | * HID report descriptor main item tags | |
121 | */ | |
122 | ||
123 | #define HID_MAIN_ITEM_TAG_INPUT 8 | |
124 | #define HID_MAIN_ITEM_TAG_OUTPUT 9 | |
125 | #define HID_MAIN_ITEM_TAG_FEATURE 11 | |
126 | #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10 | |
127 | #define HID_MAIN_ITEM_TAG_END_COLLECTION 12 | |
128 | ||
129 | /* | |
130 | * HID report descriptor main item contents | |
131 | */ | |
132 | ||
133 | #define HID_MAIN_ITEM_CONSTANT 0x001 | |
134 | #define HID_MAIN_ITEM_VARIABLE 0x002 | |
135 | #define HID_MAIN_ITEM_RELATIVE 0x004 | |
05f091ab | 136 | #define HID_MAIN_ITEM_WRAP 0x008 |
1da177e4 LT |
137 | #define HID_MAIN_ITEM_NONLINEAR 0x010 |
138 | #define HID_MAIN_ITEM_NO_PREFERRED 0x020 | |
139 | #define HID_MAIN_ITEM_NULL_STATE 0x040 | |
140 | #define HID_MAIN_ITEM_VOLATILE 0x080 | |
141 | #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100 | |
142 | ||
143 | /* | |
144 | * HID report descriptor collection item types | |
145 | */ | |
146 | ||
147 | #define HID_COLLECTION_PHYSICAL 0 | |
148 | #define HID_COLLECTION_APPLICATION 1 | |
149 | #define HID_COLLECTION_LOGICAL 2 | |
150 | ||
151 | /* | |
152 | * HID report descriptor global item tags | |
153 | */ | |
154 | ||
155 | #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0 | |
156 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1 | |
157 | #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2 | |
158 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3 | |
159 | #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4 | |
160 | #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5 | |
161 | #define HID_GLOBAL_ITEM_TAG_UNIT 6 | |
162 | #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7 | |
163 | #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8 | |
164 | #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9 | |
165 | #define HID_GLOBAL_ITEM_TAG_PUSH 10 | |
166 | #define HID_GLOBAL_ITEM_TAG_POP 11 | |
167 | ||
168 | /* | |
169 | * HID report descriptor local item tags | |
170 | */ | |
171 | ||
172 | #define HID_LOCAL_ITEM_TAG_USAGE 0 | |
173 | #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1 | |
174 | #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2 | |
175 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3 | |
176 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4 | |
177 | #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5 | |
178 | #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7 | |
179 | #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8 | |
180 | #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9 | |
181 | #define HID_LOCAL_ITEM_TAG_DELIMITER 10 | |
182 | ||
183 | /* | |
184 | * HID usage tables | |
185 | */ | |
186 | ||
187 | #define HID_USAGE_PAGE 0xffff0000 | |
188 | ||
189 | #define HID_UP_UNDEFINED 0x00000000 | |
05f091ab | 190 | #define HID_UP_GENDESK 0x00010000 |
0aebfdac | 191 | #define HID_UP_SIMULATION 0x00020000 |
05f091ab DT |
192 | #define HID_UP_KEYBOARD 0x00070000 |
193 | #define HID_UP_LED 0x00080000 | |
194 | #define HID_UP_BUTTON 0x00090000 | |
195 | #define HID_UP_ORDINAL 0x000a0000 | |
1da177e4 | 196 | #define HID_UP_CONSUMER 0x000c0000 |
05f091ab DT |
197 | #define HID_UP_DIGITIZER 0x000d0000 |
198 | #define HID_UP_PID 0x000f0000 | |
1da177e4 LT |
199 | #define HID_UP_HPVENDOR 0xff7f0000 |
200 | #define HID_UP_MSVENDOR 0xff000000 | |
e875ce37 SP |
201 | #define HID_UP_CUSTOM 0x00ff0000 |
202 | #define HID_UP_LOGIVENDOR 0xffbc0000 | |
1da177e4 LT |
203 | |
204 | #define HID_USAGE 0x0000ffff | |
205 | ||
206 | #define HID_GD_POINTER 0x00010001 | |
207 | #define HID_GD_MOUSE 0x00010002 | |
208 | #define HID_GD_JOYSTICK 0x00010004 | |
209 | #define HID_GD_GAMEPAD 0x00010005 | |
210 | #define HID_GD_KEYBOARD 0x00010006 | |
211 | #define HID_GD_KEYPAD 0x00010007 | |
212 | #define HID_GD_MULTIAXIS 0x00010008 | |
213 | #define HID_GD_X 0x00010030 | |
214 | #define HID_GD_Y 0x00010031 | |
215 | #define HID_GD_Z 0x00010032 | |
216 | #define HID_GD_RX 0x00010033 | |
217 | #define HID_GD_RY 0x00010034 | |
218 | #define HID_GD_RZ 0x00010035 | |
219 | #define HID_GD_SLIDER 0x00010036 | |
220 | #define HID_GD_DIAL 0x00010037 | |
221 | #define HID_GD_WHEEL 0x00010038 | |
222 | #define HID_GD_HATSWITCH 0x00010039 | |
223 | #define HID_GD_BUFFER 0x0001003a | |
224 | #define HID_GD_BYTECOUNT 0x0001003b | |
225 | #define HID_GD_MOTION 0x0001003c | |
226 | #define HID_GD_START 0x0001003d | |
227 | #define HID_GD_SELECT 0x0001003e | |
228 | #define HID_GD_VX 0x00010040 | |
229 | #define HID_GD_VY 0x00010041 | |
230 | #define HID_GD_VZ 0x00010042 | |
231 | #define HID_GD_VBRX 0x00010043 | |
232 | #define HID_GD_VBRY 0x00010044 | |
233 | #define HID_GD_VBRZ 0x00010045 | |
234 | #define HID_GD_VNO 0x00010046 | |
235 | #define HID_GD_FEATURE 0x00010047 | |
236 | #define HID_GD_UP 0x00010090 | |
237 | #define HID_GD_DOWN 0x00010091 | |
238 | #define HID_GD_RIGHT 0x00010092 | |
239 | #define HID_GD_LEFT 0x00010093 | |
240 | ||
241 | /* | |
242 | * HID report types --- Ouch! HID spec says 1 2 3! | |
243 | */ | |
244 | ||
245 | #define HID_INPUT_REPORT 0 | |
246 | #define HID_OUTPUT_REPORT 1 | |
247 | #define HID_FEATURE_REPORT 2 | |
248 | ||
93c10132 JS |
249 | /* |
250 | * HID connect requests | |
251 | */ | |
252 | ||
253 | #define HID_CONNECT_HIDINPUT 0x01 | |
254 | #define HID_CONNECT_HIDINPUT_FORCE 0x02 | |
255 | #define HID_CONNECT_HIDRAW 0x04 | |
256 | #define HID_CONNECT_HIDDEV 0x08 | |
257 | #define HID_CONNECT_HIDDEV_FORCE 0x10 | |
258 | #define HID_CONNECT_FF 0x20 | |
259 | #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ | |
260 | HID_CONNECT_HIDDEV|HID_CONNECT_FF) | |
261 | ||
1da177e4 LT |
262 | /* |
263 | * HID device quirks. | |
264 | */ | |
265 | ||
876b9276 PW |
266 | /* |
267 | * Increase this if you need to configure more HID quirks at module load time | |
268 | */ | |
269 | #define MAX_USBHID_BOOT_QUIRKS 4 | |
270 | ||
eab9edd2 MH |
271 | #define HID_QUIRK_INVERT 0x00000001 |
272 | #define HID_QUIRK_NOTOUCH 0x00000002 | |
eab9edd2 | 273 | #define HID_QUIRK_NOGET 0x00000008 |
eab9edd2 MH |
274 | #define HID_QUIRK_BADPAD 0x00000020 |
275 | #define HID_QUIRK_MULTI_INPUT 0x00000040 | |
ea9a4a8b | 276 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 |
f345c37c | 277 | #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000 |
ea9a4a8b | 278 | |
1da177e4 LT |
279 | /* |
280 | * This is the global environment of the parser. This information is | |
281 | * persistent for main-items. The global environment can be saved and | |
282 | * restored with PUSH/POP statements. | |
283 | */ | |
284 | ||
285 | struct hid_global { | |
286 | unsigned usage_page; | |
287 | __s32 logical_minimum; | |
288 | __s32 logical_maximum; | |
289 | __s32 physical_minimum; | |
290 | __s32 physical_maximum; | |
291 | __s32 unit_exponent; | |
292 | unsigned unit; | |
293 | unsigned report_id; | |
294 | unsigned report_size; | |
295 | unsigned report_count; | |
296 | }; | |
297 | ||
298 | /* | |
299 | * This is the local environment. It is persistent up the next main-item. | |
300 | */ | |
301 | ||
5f1ab74f | 302 | #define HID_MAX_USAGES 12288 |
1da177e4 LT |
303 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
304 | ||
305 | struct hid_local { | |
306 | unsigned usage[HID_MAX_USAGES]; /* usage array */ | |
307 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ | |
308 | unsigned usage_index; | |
309 | unsigned usage_minimum; | |
310 | unsigned delimiter_depth; | |
311 | unsigned delimiter_branch; | |
312 | }; | |
313 | ||
314 | /* | |
315 | * This is the collection stack. We climb up the stack to determine | |
316 | * application and function of each field. | |
317 | */ | |
318 | ||
319 | struct hid_collection { | |
320 | unsigned type; | |
321 | unsigned usage; | |
322 | unsigned level; | |
323 | }; | |
324 | ||
325 | struct hid_usage { | |
326 | unsigned hid; /* hid usage code */ | |
327 | unsigned collection_index; /* index into collection array */ | |
328 | /* hidinput data */ | |
329 | __u16 code; /* input driver code */ | |
330 | __u8 type; /* input driver type */ | |
331 | __s8 hat_min; /* hat switch fun */ | |
332 | __s8 hat_max; /* ditto */ | |
333 | __s8 hat_dir; /* ditto */ | |
334 | }; | |
335 | ||
336 | struct hid_input; | |
337 | ||
338 | struct hid_field { | |
339 | unsigned physical; /* physical usage for this field */ | |
340 | unsigned logical; /* logical usage for this field */ | |
341 | unsigned application; /* application usage for this field */ | |
342 | struct hid_usage *usage; /* usage table for this function */ | |
343 | unsigned maxusage; /* maximum usage index */ | |
344 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ | |
345 | unsigned report_offset; /* bit offset in the report */ | |
346 | unsigned report_size; /* size of this field in the report */ | |
347 | unsigned report_count; /* number of this field in the report */ | |
348 | unsigned report_type; /* (input,output,feature) */ | |
349 | __s32 *value; /* last known value(s) */ | |
350 | __s32 logical_minimum; | |
351 | __s32 logical_maximum; | |
352 | __s32 physical_minimum; | |
353 | __s32 physical_maximum; | |
354 | __s32 unit_exponent; | |
355 | unsigned unit; | |
356 | struct hid_report *report; /* associated report */ | |
357 | unsigned index; /* index into report->field[] */ | |
358 | /* hidinput data */ | |
359 | struct hid_input *hidinput; /* associated input structure */ | |
360 | __u16 dpad; /* dpad input code */ | |
361 | }; | |
362 | ||
363 | #define HID_MAX_FIELDS 64 | |
364 | ||
365 | struct hid_report { | |
366 | struct list_head list; | |
367 | unsigned id; /* id of this report */ | |
368 | unsigned type; /* report type */ | |
369 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ | |
370 | unsigned maxfield; /* maximum valid field index */ | |
371 | unsigned size; /* size of the report (bits) */ | |
372 | struct hid_device *device; /* associated device */ | |
373 | }; | |
374 | ||
375 | struct hid_report_enum { | |
376 | unsigned numbered; | |
377 | struct list_head report_list; | |
378 | struct hid_report *report_id_hash[256]; | |
379 | }; | |
380 | ||
381 | #define HID_REPORT_TYPES 3 | |
382 | ||
bf0964dc MH |
383 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
384 | #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ | |
1da177e4 LT |
385 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
386 | #define HID_OUTPUT_FIFO_SIZE 64 | |
387 | ||
388 | struct hid_control_fifo { | |
389 | unsigned char dir; | |
390 | struct hid_report *report; | |
f129ea6d AH |
391 | char *raw_report; |
392 | }; | |
393 | ||
394 | struct hid_output_fifo { | |
395 | struct hid_report *report; | |
396 | char *raw_report; | |
1da177e4 LT |
397 | }; |
398 | ||
399 | #define HID_CLAIMED_INPUT 1 | |
400 | #define HID_CLAIMED_HIDDEV 2 | |
86166b7b | 401 | #define HID_CLAIMED_HIDRAW 4 |
1da177e4 | 402 | |
85cdaf52 | 403 | #define HID_STAT_ADDED 1 |
c500c971 | 404 | #define HID_STAT_PARSED 2 |
85cdaf52 | 405 | |
1da177e4 LT |
406 | struct hid_input { |
407 | struct list_head list; | |
408 | struct hid_report *report; | |
c5b7c7c3 | 409 | struct input_dev *input; |
1da177e4 LT |
410 | }; |
411 | ||
a73a6370 JS |
412 | enum hid_type { |
413 | HID_TYPE_OTHER = 0, | |
414 | HID_TYPE_USBMOUSE | |
415 | }; | |
416 | ||
85cdaf52 | 417 | struct hid_driver; |
c500c971 | 418 | struct hid_ll_driver; |
85cdaf52 | 419 | |
1da177e4 | 420 | struct hid_device { /* device report descriptor */ |
85cdaf52 | 421 | __u8 *rdesc; |
1da177e4 LT |
422 | unsigned rsize; |
423 | struct hid_collection *collection; /* List of HID collections */ | |
424 | unsigned collection_size; /* Number of allocated hid_collections */ | |
425 | unsigned maxcollection; /* Number of parsed collections */ | |
426 | unsigned maxapplication; /* Number of applications */ | |
85cdaf52 JS |
427 | __u16 bus; /* BUS ID */ |
428 | __u32 vendor; /* Vendor ID */ | |
429 | __u32 product; /* Product ID */ | |
430 | __u32 version; /* HID version */ | |
a73a6370 | 431 | enum hid_type type; /* device type (mouse, kbd, ...) */ |
1da177e4 LT |
432 | unsigned country; /* HID country */ |
433 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; | |
434 | ||
85cdaf52 JS |
435 | struct device dev; /* device */ |
436 | struct hid_driver *driver; | |
c500c971 | 437 | struct hid_ll_driver *ll_driver; |
1da177e4 | 438 | |
85cdaf52 | 439 | unsigned int status; /* see STAT flags above */ |
05f091ab | 440 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
1da177e4 LT |
441 | unsigned quirks; /* Various quirks the device can pull on us */ |
442 | ||
443 | struct list_head inputs; /* The list of inputs */ | |
444 | void *hiddev; /* The hiddev structure */ | |
86166b7b | 445 | void *hidraw; |
1da177e4 LT |
446 | int minor; /* Hiddev minor number */ |
447 | ||
1da177e4 LT |
448 | int open; /* is the device open by anyone? */ |
449 | char name[128]; /* Device name */ | |
450 | char phys[64]; /* Device physical location */ | |
451 | char uniq[64]; /* Device unique identifier (serial #) */ | |
452 | ||
229695e5 JK |
453 | void *driver_data; |
454 | ||
93c10132 JS |
455 | /* temporary hid_ff handling (until moved to the drivers) */ |
456 | int (*ff_init)(struct hid_device *); | |
457 | ||
aa938f79 | 458 | /* hiddev event handler */ |
93c10132 | 459 | int (*hiddev_connect)(struct hid_device *, unsigned int); |
aa938f79 JK |
460 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
461 | struct hid_usage *, __s32); | |
aa8de2f0 | 462 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
86166b7b JK |
463 | |
464 | /* handler for raw output data, used by hidraw */ | |
465 | int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t); | |
1da177e4 LT |
466 | }; |
467 | ||
85cdaf52 JS |
468 | static inline void *hid_get_drvdata(struct hid_device *hdev) |
469 | { | |
470 | return dev_get_drvdata(&hdev->dev); | |
471 | } | |
472 | ||
473 | static inline void hid_set_drvdata(struct hid_device *hdev, void *data) | |
474 | { | |
475 | dev_set_drvdata(&hdev->dev, data); | |
476 | } | |
477 | ||
1da177e4 LT |
478 | #define HID_GLOBAL_STACK_SIZE 4 |
479 | #define HID_COLLECTION_STACK_SIZE 4 | |
480 | ||
481 | struct hid_parser { | |
482 | struct hid_global global; | |
483 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; | |
484 | unsigned global_stack_ptr; | |
485 | struct hid_local local; | |
486 | unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; | |
487 | unsigned collection_stack_ptr; | |
488 | struct hid_device *device; | |
489 | }; | |
490 | ||
491 | struct hid_class_descriptor { | |
492 | __u8 bDescriptorType; | |
01d7b369 | 493 | __le16 wDescriptorLength; |
1da177e4 LT |
494 | } __attribute__ ((packed)); |
495 | ||
496 | struct hid_descriptor { | |
497 | __u8 bLength; | |
498 | __u8 bDescriptorType; | |
01d7b369 | 499 | __le16 bcdHID; |
1da177e4 LT |
500 | __u8 bCountryCode; |
501 | __u8 bNumDescriptors; | |
502 | ||
503 | struct hid_class_descriptor desc[1]; | |
504 | } __attribute__ ((packed)); | |
505 | ||
85cdaf52 JS |
506 | #define HID_DEVICE(b, ven, prod) \ |
507 | .bus = (b), \ | |
508 | .vendor = (ven), .product = (prod) | |
509 | ||
510 | #define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod) | |
511 | #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod) | |
512 | ||
513 | #define HID_REPORT_ID(rep) \ | |
514 | .report_type = (rep) | |
515 | #define HID_USAGE_ID(uhid, utype, ucode) \ | |
516 | .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) | |
517 | /* we don't want to catch types and codes equal to 0 */ | |
518 | #define HID_TERMINATOR (HID_ANY_ID - 1) | |
519 | ||
520 | struct hid_report_id { | |
521 | __u32 report_type; | |
522 | }; | |
523 | struct hid_usage_id { | |
524 | __u32 usage_hid; | |
525 | __u32 usage_type; | |
526 | __u32 usage_code; | |
527 | }; | |
528 | ||
529 | /** | |
530 | * struct hid_driver | |
531 | * @name: driver name (e.g. "Footech_bar-wheel") | |
532 | * @id_table: which devices is this driver for (must be non-NULL for probe | |
533 | * to be called) | |
3a6f82f7 JS |
534 | * @dyn_list: list of dynamically added device ids |
535 | * @dyn_lock: lock protecting @dyn_list | |
85cdaf52 JS |
536 | * @probe: new device inserted |
537 | * @remove: device removed (NULL if not a hot-plug capable driver) | |
538 | * @report_table: on which reports to call raw_event (NULL means all) | |
539 | * @raw_event: if report in report_table, this hook is called (NULL means nop) | |
540 | * @usage_table: on which events to call event (NULL means all) | |
541 | * @event: if usage in usage_table, this hook is called (NULL means nop) | |
c500c971 JS |
542 | * @report_fixup: called before report descriptor parsing (NULL means nop) |
543 | * @input_mapping: invoked on input registering before mapping an usage | |
544 | * @input_mapped: invoked on input registering after mapping an usage | |
85cdaf52 JS |
545 | * |
546 | * raw_event and event should return 0 on no action performed, 1 when no | |
547 | * further processing should be done and negative on error | |
c500c971 JS |
548 | * |
549 | * input_mapping shall return a negative value to completely ignore this usage | |
550 | * (e.g. doubled or invalid usage), zero to continue with parsing of this | |
551 | * usage by generic code (no special handling needed) or positive to skip | |
552 | * generic parsing (needed special handling which was done in the hook already) | |
553 | * input_mapped shall return negative to inform the layer that this usage | |
554 | * should not be considered for further processing or zero to notify that | |
555 | * no processing was performed and should be done in a generic manner | |
556 | * Both these functions may be NULL which means the same behavior as returning | |
557 | * zero from them. | |
85cdaf52 JS |
558 | */ |
559 | struct hid_driver { | |
560 | char *name; | |
561 | const struct hid_device_id *id_table; | |
562 | ||
3a6f82f7 JS |
563 | struct list_head dyn_list; |
564 | spinlock_t dyn_lock; | |
565 | ||
85cdaf52 JS |
566 | int (*probe)(struct hid_device *dev, const struct hid_device_id *id); |
567 | void (*remove)(struct hid_device *dev); | |
568 | ||
569 | const struct hid_report_id *report_table; | |
570 | int (*raw_event)(struct hid_device *hdev, struct hid_report *report, | |
571 | u8 *data, int size); | |
572 | const struct hid_usage_id *usage_table; | |
573 | int (*event)(struct hid_device *hdev, struct hid_field *field, | |
574 | struct hid_usage *usage, __s32 value); | |
c500c971 JS |
575 | |
576 | void (*report_fixup)(struct hid_device *hdev, __u8 *buf, | |
577 | unsigned int size); | |
578 | ||
579 | int (*input_mapping)(struct hid_device *hdev, | |
580 | struct hid_input *hidinput, struct hid_field *field, | |
581 | struct hid_usage *usage, unsigned long **bit, int *max); | |
582 | int (*input_mapped)(struct hid_device *hdev, | |
583 | struct hid_input *hidinput, struct hid_field *field, | |
584 | struct hid_usage *usage, unsigned long **bit, int *max); | |
85cdaf52 JS |
585 | /* private: */ |
586 | struct device_driver driver; | |
587 | }; | |
588 | ||
c500c971 JS |
589 | /** |
590 | * hid_ll_driver - low level driver callbacks | |
591 | * @start: called on probe to start the device | |
592 | * @stop: called on remove | |
593 | * @open: called by input layer on open | |
594 | * @close: called by input layer on close | |
595 | * @hidinput_input_event: event input event (e.g. ff or leds) | |
596 | * @parse: this method is called only once to parse the device data, | |
597 | * shouldn't allocate anything to not leak memory | |
598 | */ | |
599 | struct hid_ll_driver { | |
600 | int (*start)(struct hid_device *hdev); | |
601 | void (*stop)(struct hid_device *hdev); | |
602 | ||
603 | int (*open)(struct hid_device *hdev); | |
604 | void (*close)(struct hid_device *hdev); | |
605 | ||
606 | int (*hidinput_input_event) (struct input_dev *idev, unsigned int type, | |
607 | unsigned int code, int value); | |
608 | ||
609 | int (*parse)(struct hid_device *hdev); | |
610 | }; | |
611 | ||
1da177e4 LT |
612 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
613 | /* We ignore a few input applications that are not widely used */ | |
f472f800 | 614 | #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002)) |
229695e5 JK |
615 | |
616 | /* HID core API */ | |
58037eb9 JK |
617 | |
618 | #ifdef CONFIG_HID_DEBUG | |
619 | extern int hid_debug; | |
620 | #endif | |
621 | ||
85cdaf52 JS |
622 | extern int hid_add_device(struct hid_device *); |
623 | extern void hid_destroy_device(struct hid_device *); | |
624 | ||
625 | extern int __must_check __hid_register_driver(struct hid_driver *, | |
626 | struct module *, const char *mod_name); | |
627 | static inline int __must_check hid_register_driver(struct hid_driver *driver) | |
628 | { | |
629 | return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME); | |
630 | } | |
631 | extern void hid_unregister_driver(struct hid_driver *); | |
632 | ||
7d12e780 | 633 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
1da177e4 | 634 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
93c10132 | 635 | extern int hidinput_connect(struct hid_device *hid, unsigned int force); |
1da177e4 | 636 | extern void hidinput_disconnect(struct hid_device *); |
1da177e4 | 637 | |
1da177e4 | 638 | int hid_set_field(struct hid_field *, unsigned, __s32); |
aa8de2f0 | 639 | int hid_input_report(struct hid_device *, int type, u8 *, int, int); |
dde5845a | 640 | int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); |
dde5845a | 641 | void hid_output_report(struct hid_report *report, __u8 *data); |
85cdaf52 JS |
642 | struct hid_device *hid_allocate_device(void); |
643 | int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); | |
93c10132 | 644 | int hid_connect(struct hid_device *hid, unsigned int connect_mask); |
85cdaf52 | 645 | |
022e8c4d JS |
646 | /** |
647 | * hid_map_usage - map usage input bits | |
648 | * | |
649 | * @hidinput: hidinput which we are interested in | |
650 | * @usage: usage to fill in | |
651 | * @bit: pointer to input->{}bit (out parameter) | |
652 | * @max: maximal valid usage->code to consider later (out parameter) | |
653 | * @type: input event type (EV_KEY, EV_REL, ...) | |
654 | * @c: code which corresponds to this usage and type | |
655 | */ | |
656 | static inline void hid_map_usage(struct hid_input *hidinput, | |
657 | struct hid_usage *usage, unsigned long **bit, int *max, | |
658 | __u8 type, __u16 c) | |
659 | { | |
660 | struct input_dev *input = hidinput->input; | |
661 | ||
662 | usage->type = type; | |
663 | usage->code = c; | |
664 | ||
665 | switch (type) { | |
666 | case EV_ABS: | |
667 | *bit = input->absbit; | |
668 | *max = ABS_MAX; | |
669 | break; | |
670 | case EV_REL: | |
671 | *bit = input->relbit; | |
672 | *max = REL_MAX; | |
673 | break; | |
674 | case EV_KEY: | |
675 | *bit = input->keybit; | |
676 | *max = KEY_MAX; | |
677 | break; | |
678 | case EV_LED: | |
679 | *bit = input->ledbit; | |
680 | *max = LED_MAX; | |
681 | break; | |
682 | } | |
683 | } | |
684 | ||
685 | /** | |
686 | * hid_map_usage_clear - map usage input bits and clear the input bit | |
687 | * | |
688 | * The same as hid_map_usage, except the @c bit is also cleared in supported | |
689 | * bits (@bit). | |
690 | */ | |
691 | static inline void hid_map_usage_clear(struct hid_input *hidinput, | |
692 | struct hid_usage *usage, unsigned long **bit, int *max, | |
693 | __u8 type, __u16 c) | |
694 | { | |
695 | hid_map_usage(hidinput, usage, bit, max, type, c); | |
696 | clear_bit(c, *bit); | |
697 | } | |
698 | ||
c500c971 JS |
699 | /** |
700 | * hid_parse - parse HW reports | |
701 | * | |
702 | * @hdev: hid device | |
703 | * | |
704 | * Call this from probe after you set up the device (if needed). Your | |
705 | * report_fixup will be called (if non-NULL) after reading raw report from | |
706 | * device before passing it to hid layer for real parsing. | |
707 | */ | |
708 | static inline int __must_check hid_parse(struct hid_device *hdev) | |
709 | { | |
710 | int ret; | |
711 | ||
712 | if (hdev->status & HID_STAT_PARSED) | |
713 | return 0; | |
714 | ||
715 | ret = hdev->ll_driver->parse(hdev); | |
716 | if (!ret) | |
717 | hdev->status |= HID_STAT_PARSED; | |
718 | ||
719 | return ret; | |
720 | } | |
721 | ||
722 | /** | |
723 | * hid_hw_start - start underlaying HW | |
724 | * | |
725 | * @hdev: hid device | |
93c10132 | 726 | * @connect_mask: which outputs to connect, see HID_CONNECT_* |
c500c971 JS |
727 | * |
728 | * Call this in probe function *after* hid_parse. This will setup HW buffers | |
729 | * and start the device (if not deffered to device open). hid_hw_stop must be | |
730 | * called if this was successfull. | |
731 | */ | |
93c10132 JS |
732 | static inline int __must_check hid_hw_start(struct hid_device *hdev, |
733 | unsigned int connect_mask) | |
c500c971 | 734 | { |
93c10132 JS |
735 | int ret = hdev->ll_driver->start(hdev); |
736 | if (ret || !connect_mask) | |
737 | return ret; | |
738 | ret = hid_connect(hdev, connect_mask); | |
739 | if (ret) | |
740 | hdev->ll_driver->stop(hdev); | |
741 | return ret; | |
c500c971 JS |
742 | } |
743 | ||
744 | /** | |
745 | * hid_hw_stop - stop underlaying HW | |
746 | * | |
747 | * @hdev: hid device | |
748 | * | |
749 | * This is usually called from remove function or from probe when something | |
750 | * failed and hid_hw_start was called already. | |
751 | */ | |
752 | static inline void hid_hw_stop(struct hid_device *hdev) | |
753 | { | |
754 | hdev->ll_driver->stop(hdev); | |
755 | } | |
756 | ||
85cdaf52 JS |
757 | void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, |
758 | int interrupt); | |
759 | ||
760 | extern int hid_generic_init(void); | |
761 | extern void hid_generic_exit(void); | |
1da177e4 | 762 | |
876b9276 | 763 | /* HID quirks API */ |
2eb5dc30 | 764 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); |
876b9276 PW |
765 | int usbhid_quirks_init(char **quirks_param); |
766 | void usbhid_quirks_exit(void); | |
6edfa8dc | 767 | void usbhid_set_leds(struct hid_device *hid); |
2eb5dc30 | 768 | |
224ee88f AH |
769 | #ifdef CONFIG_HID_PID |
770 | int hid_pidff_init(struct hid_device *hid); | |
771 | #else | |
76483cf4 | 772 | #define hid_pidff_init NULL |
1da177e4 | 773 | #endif |
58037eb9 JK |
774 | |
775 | #ifdef CONFIG_HID_DEBUG | |
776 | #define dbg_hid(format, arg...) if (hid_debug) \ | |
777 | printk(KERN_DEBUG "%s: " format ,\ | |
778 | __FILE__ , ## arg) | |
779 | #define dbg_hid_line(format, arg...) if (hid_debug) \ | |
780 | printk(format, ## arg) | |
229695e5 | 781 | #else |
1b184cf3 JS |
782 | static inline int __attribute__((format(printf, 1, 2))) |
783 | dbg_hid(const char *fmt, ...) | |
784 | { | |
785 | return 0; | |
786 | } | |
58037eb9 | 787 | #define dbg_hid_line dbg_hid |
02ae9a1a | 788 | #endif /* HID_DEBUG */ |
229695e5 | 789 | |
58037eb9 | 790 | #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \ |
229695e5 | 791 | __FILE__ , ## arg) |
02ae9a1a JS |
792 | #endif /* HID_FF */ |
793 | ||
794 | #ifdef CONFIG_HID_COMPAT | |
795 | #define HID_COMPAT_LOAD_DRIVER(name) \ | |
725cf0f4 HE |
796 | /* prototype to avoid sparse warning */ \ |
797 | extern void hid_compat_##name(void); \ | |
02ae9a1a JS |
798 | void hid_compat_##name(void) { } \ |
799 | EXPORT_SYMBOL(hid_compat_##name) | |
800 | #else | |
801 | #define HID_COMPAT_LOAD_DRIVER(name) | |
802 | #endif /* HID_COMPAT */ | |
803 | #define HID_COMPAT_CALL_DRIVER(name) do { \ | |
804 | extern void hid_compat_##name(void); \ | |
805 | hid_compat_##name(); \ | |
806 | } while (0) | |
807 | ||
57d292bd | 808 | #endif |
224ee88f | 809 |