Root/
1 | #ifndef __HID_H |
2 | #define __HID_H |
3 | |
4 | /* |
5 | * Copyright (c) 1999 Andreas Gal |
6 | * Copyright (c) 2000-2001 Vojtech Pavlik |
7 | * Copyright (c) 2006-2007 Jiri Kosina |
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 | |
30 | /* |
31 | * USB HID (Human Interface Device) interface class code |
32 | */ |
33 | |
34 | #define USB_INTERFACE_CLASS_HID 3 |
35 | |
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 | |
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 | |
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> |
70 | #include <linux/mod_devicetable.h> /* hid_device_id */ |
71 | #include <linux/timer.h> |
72 | #include <linux/workqueue.h> |
73 | #include <linux/input.h> |
74 | |
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 |
136 | #define HID_MAIN_ITEM_WRAP 0x008 |
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 |
190 | #define HID_UP_GENDESK 0x00010000 |
191 | #define HID_UP_SIMULATION 0x00020000 |
192 | #define HID_UP_KEYBOARD 0x00070000 |
193 | #define HID_UP_LED 0x00080000 |
194 | #define HID_UP_BUTTON 0x00090000 |
195 | #define HID_UP_ORDINAL 0x000a0000 |
196 | #define HID_UP_CONSUMER 0x000c0000 |
197 | #define HID_UP_DIGITIZER 0x000d0000 |
198 | #define HID_UP_PID 0x000f0000 |
199 | #define HID_UP_HPVENDOR 0xff7f0000 |
200 | #define HID_UP_MSVENDOR 0xff000000 |
201 | #define HID_UP_CUSTOM 0x00ff0000 |
202 | #define HID_UP_LOGIVENDOR 0xffbc0000 |
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 | #define HID_DG_DIGITIZER 0x000d0001 |
242 | #define HID_DG_PEN 0x000d0002 |
243 | #define HID_DG_LIGHTPEN 0x000d0003 |
244 | #define HID_DG_TOUCHSCREEN 0x000d0004 |
245 | #define HID_DG_TOUCHPAD 0x000d0005 |
246 | #define HID_DG_STYLUS 0x000d0020 |
247 | #define HID_DG_PUCK 0x000d0021 |
248 | #define HID_DG_FINGER 0x000d0022 |
249 | #define HID_DG_TIPPRESSURE 0x000d0030 |
250 | #define HID_DG_BARRELPRESSURE 0x000d0031 |
251 | #define HID_DG_INRANGE 0x000d0032 |
252 | #define HID_DG_TOUCH 0x000d0033 |
253 | #define HID_DG_UNTOUCH 0x000d0034 |
254 | #define HID_DG_TAP 0x000d0035 |
255 | #define HID_DG_TABLETFUNCTIONKEY 0x000d0039 |
256 | #define HID_DG_PROGRAMCHANGEKEY 0x000d003a |
257 | #define HID_DG_INVERT 0x000d003c |
258 | #define HID_DG_TIPSWITCH 0x000d0042 |
259 | #define HID_DG_TIPSWITCH2 0x000d0043 |
260 | #define HID_DG_BARRELSWITCH 0x000d0044 |
261 | #define HID_DG_ERASER 0x000d0045 |
262 | #define HID_DG_TABLETPICK 0x000d0046 |
263 | /* |
264 | * as of May 20, 2009 the usages below are not yet in the official USB spec |
265 | * but are being pushed by Microsft as described in their paper "Digitizer |
266 | * Drivers for Windows Touch and Pen-Based Computers" |
267 | */ |
268 | #define HID_DG_CONFIDENCE 0x000d0047 |
269 | #define HID_DG_WIDTH 0x000d0048 |
270 | #define HID_DG_HEIGHT 0x000d0049 |
271 | #define HID_DG_CONTACTID 0x000d0051 |
272 | #define HID_DG_INPUTMODE 0x000d0052 |
273 | #define HID_DG_DEVICEINDEX 0x000d0053 |
274 | #define HID_DG_CONTACTCOUNT 0x000d0054 |
275 | #define HID_DG_CONTACTMAX 0x000d0055 |
276 | |
277 | /* |
278 | * HID report types --- Ouch! HID spec says 1 2 3! |
279 | */ |
280 | |
281 | #define HID_INPUT_REPORT 0 |
282 | #define HID_OUTPUT_REPORT 1 |
283 | #define HID_FEATURE_REPORT 2 |
284 | |
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 |
295 | #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \ |
296 | HID_CONNECT_HIDDEV|HID_CONNECT_FF) |
297 | |
298 | /* |
299 | * HID device quirks. |
300 | */ |
301 | |
302 | /* |
303 | * Increase this if you need to configure more HID quirks at module load time |
304 | */ |
305 | #define MAX_USBHID_BOOT_QUIRKS 4 |
306 | |
307 | #define HID_QUIRK_INVERT 0x00000001 |
308 | #define HID_QUIRK_NOTOUCH 0x00000002 |
309 | #define HID_QUIRK_IGNORE 0x00000004 |
310 | #define HID_QUIRK_NOGET 0x00000008 |
311 | #define HID_QUIRK_HIDDEV_FORCE 0x00000010 |
312 | #define HID_QUIRK_BADPAD 0x00000020 |
313 | #define HID_QUIRK_MULTI_INPUT 0x00000040 |
314 | #define HID_QUIRK_HIDINPUT_FORCE 0x00000080 |
315 | #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000 |
316 | #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000 |
317 | #define HID_QUIRK_NO_INIT_REPORTS 0x20000000 |
318 | #define HID_QUIRK_NO_IGNORE 0x40000000 |
319 | #define HID_QUIRK_NO_INPUT_SYNC 0x80000000 |
320 | |
321 | /* |
322 | * This is the global environment of the parser. This information is |
323 | * persistent for main-items. The global environment can be saved and |
324 | * restored with PUSH/POP statements. |
325 | */ |
326 | |
327 | struct hid_global { |
328 | unsigned usage_page; |
329 | __s32 logical_minimum; |
330 | __s32 logical_maximum; |
331 | __s32 physical_minimum; |
332 | __s32 physical_maximum; |
333 | __s32 unit_exponent; |
334 | unsigned unit; |
335 | unsigned report_id; |
336 | unsigned report_size; |
337 | unsigned report_count; |
338 | }; |
339 | |
340 | /* |
341 | * This is the local environment. It is persistent up the next main-item. |
342 | */ |
343 | |
344 | #define HID_MAX_USAGES 12288 |
345 | #define HID_DEFAULT_NUM_COLLECTIONS 16 |
346 | |
347 | struct hid_local { |
348 | unsigned usage[HID_MAX_USAGES]; /* usage array */ |
349 | unsigned collection_index[HID_MAX_USAGES]; /* collection index array */ |
350 | unsigned usage_index; |
351 | unsigned usage_minimum; |
352 | unsigned delimiter_depth; |
353 | unsigned delimiter_branch; |
354 | }; |
355 | |
356 | /* |
357 | * This is the collection stack. We climb up the stack to determine |
358 | * application and function of each field. |
359 | */ |
360 | |
361 | struct hid_collection { |
362 | unsigned type; |
363 | unsigned usage; |
364 | unsigned level; |
365 | }; |
366 | |
367 | struct hid_usage { |
368 | unsigned hid; /* hid usage code */ |
369 | unsigned collection_index; /* index into collection array */ |
370 | /* hidinput data */ |
371 | __u16 code; /* input driver code */ |
372 | __u8 type; /* input driver type */ |
373 | __s8 hat_min; /* hat switch fun */ |
374 | __s8 hat_max; /* ditto */ |
375 | __s8 hat_dir; /* ditto */ |
376 | }; |
377 | |
378 | struct hid_input; |
379 | |
380 | struct hid_field { |
381 | unsigned physical; /* physical usage for this field */ |
382 | unsigned logical; /* logical usage for this field */ |
383 | unsigned application; /* application usage for this field */ |
384 | struct hid_usage *usage; /* usage table for this function */ |
385 | unsigned maxusage; /* maximum usage index */ |
386 | unsigned flags; /* main-item flags (i.e. volatile,array,constant) */ |
387 | unsigned report_offset; /* bit offset in the report */ |
388 | unsigned report_size; /* size of this field in the report */ |
389 | unsigned report_count; /* number of this field in the report */ |
390 | unsigned report_type; /* (input,output,feature) */ |
391 | __s32 *value; /* last known value(s) */ |
392 | __s32 logical_minimum; |
393 | __s32 logical_maximum; |
394 | __s32 physical_minimum; |
395 | __s32 physical_maximum; |
396 | __s32 unit_exponent; |
397 | unsigned unit; |
398 | struct hid_report *report; /* associated report */ |
399 | unsigned index; /* index into report->field[] */ |
400 | /* hidinput data */ |
401 | struct hid_input *hidinput; /* associated input structure */ |
402 | __u16 dpad; /* dpad input code */ |
403 | }; |
404 | |
405 | #define HID_MAX_FIELDS 64 |
406 | |
407 | struct hid_report { |
408 | struct list_head list; |
409 | unsigned id; /* id of this report */ |
410 | unsigned type; /* report type */ |
411 | struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */ |
412 | unsigned maxfield; /* maximum valid field index */ |
413 | unsigned size; /* size of the report (bits) */ |
414 | struct hid_device *device; /* associated device */ |
415 | }; |
416 | |
417 | struct hid_report_enum { |
418 | unsigned numbered; |
419 | struct list_head report_list; |
420 | struct hid_report *report_id_hash[256]; |
421 | }; |
422 | |
423 | #define HID_REPORT_TYPES 3 |
424 | |
425 | #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */ |
426 | #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */ |
427 | #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */ |
428 | #define HID_OUTPUT_FIFO_SIZE 64 |
429 | |
430 | struct hid_control_fifo { |
431 | unsigned char dir; |
432 | struct hid_report *report; |
433 | char *raw_report; |
434 | }; |
435 | |
436 | struct hid_output_fifo { |
437 | struct hid_report *report; |
438 | char *raw_report; |
439 | }; |
440 | |
441 | #define HID_CLAIMED_INPUT 1 |
442 | #define HID_CLAIMED_HIDDEV 2 |
443 | #define HID_CLAIMED_HIDRAW 4 |
444 | |
445 | #define HID_STAT_ADDED 1 |
446 | #define HID_STAT_PARSED 2 |
447 | |
448 | struct hid_input { |
449 | struct list_head list; |
450 | struct hid_report *report; |
451 | struct input_dev *input; |
452 | }; |
453 | |
454 | enum hid_type { |
455 | HID_TYPE_OTHER = 0, |
456 | HID_TYPE_USBMOUSE |
457 | }; |
458 | |
459 | struct hid_driver; |
460 | struct hid_ll_driver; |
461 | |
462 | struct hid_device { /* device report descriptor */ |
463 | __u8 *rdesc; |
464 | unsigned rsize; |
465 | struct hid_collection *collection; /* List of HID collections */ |
466 | unsigned collection_size; /* Number of allocated hid_collections */ |
467 | unsigned maxcollection; /* Number of parsed collections */ |
468 | unsigned maxapplication; /* Number of applications */ |
469 | __u16 bus; /* BUS ID */ |
470 | __u32 vendor; /* Vendor ID */ |
471 | __u32 product; /* Product ID */ |
472 | __u32 version; /* HID version */ |
473 | enum hid_type type; /* device type (mouse, kbd, ...) */ |
474 | unsigned country; /* HID country */ |
475 | struct hid_report_enum report_enum[HID_REPORT_TYPES]; |
476 | |
477 | struct device dev; /* device */ |
478 | struct hid_driver *driver; |
479 | struct hid_ll_driver *ll_driver; |
480 | |
481 | unsigned int status; /* see STAT flags above */ |
482 | unsigned claimed; /* Claimed by hidinput, hiddev? */ |
483 | unsigned quirks; /* Various quirks the device can pull on us */ |
484 | |
485 | struct list_head inputs; /* The list of inputs */ |
486 | void *hiddev; /* The hiddev structure */ |
487 | void *hidraw; |
488 | int minor; /* Hiddev minor number */ |
489 | |
490 | int open; /* is the device open by anyone? */ |
491 | char name[128]; /* Device name */ |
492 | char phys[64]; /* Device physical location */ |
493 | char uniq[64]; /* Device unique identifier (serial #) */ |
494 | |
495 | void *driver_data; |
496 | |
497 | /* temporary hid_ff handling (until moved to the drivers) */ |
498 | int (*ff_init)(struct hid_device *); |
499 | |
500 | /* hiddev event handler */ |
501 | int (*hiddev_connect)(struct hid_device *, unsigned int); |
502 | void (*hiddev_disconnect)(struct hid_device *); |
503 | void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field, |
504 | struct hid_usage *, __s32); |
505 | void (*hiddev_report_event) (struct hid_device *, struct hid_report *); |
506 | |
507 | /* handler for raw output data, used by hidraw */ |
508 | int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char); |
509 | |
510 | /* debugging support via debugfs */ |
511 | unsigned short debug; |
512 | struct dentry *debug_dir; |
513 | struct dentry *debug_rdesc; |
514 | struct dentry *debug_events; |
515 | struct list_head debug_list; |
516 | wait_queue_head_t debug_wait; |
517 | }; |
518 | |
519 | static inline void *hid_get_drvdata(struct hid_device *hdev) |
520 | { |
521 | return dev_get_drvdata(&hdev->dev); |
522 | } |
523 | |
524 | static inline void hid_set_drvdata(struct hid_device *hdev, void *data) |
525 | { |
526 | dev_set_drvdata(&hdev->dev, data); |
527 | } |
528 | |
529 | #define HID_GLOBAL_STACK_SIZE 4 |
530 | #define HID_COLLECTION_STACK_SIZE 4 |
531 | |
532 | struct hid_parser { |
533 | struct hid_global global; |
534 | struct hid_global global_stack[HID_GLOBAL_STACK_SIZE]; |
535 | unsigned global_stack_ptr; |
536 | struct hid_local local; |
537 | unsigned collection_stack[HID_COLLECTION_STACK_SIZE]; |
538 | unsigned collection_stack_ptr; |
539 | struct hid_device *device; |
540 | }; |
541 | |
542 | struct hid_class_descriptor { |
543 | __u8 bDescriptorType; |
544 | __le16 wDescriptorLength; |
545 | } __attribute__ ((packed)); |
546 | |
547 | struct hid_descriptor { |
548 | __u8 bLength; |
549 | __u8 bDescriptorType; |
550 | __le16 bcdHID; |
551 | __u8 bCountryCode; |
552 | __u8 bNumDescriptors; |
553 | |
554 | struct hid_class_descriptor desc[1]; |
555 | } __attribute__ ((packed)); |
556 | |
557 | #define HID_DEVICE(b, ven, prod) \ |
558 | .bus = (b), \ |
559 | .vendor = (ven), .product = (prod) |
560 | |
561 | #define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod) |
562 | #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod) |
563 | |
564 | #define HID_REPORT_ID(rep) \ |
565 | .report_type = (rep) |
566 | #define HID_USAGE_ID(uhid, utype, ucode) \ |
567 | .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode) |
568 | /* we don't want to catch types and codes equal to 0 */ |
569 | #define HID_TERMINATOR (HID_ANY_ID - 1) |
570 | |
571 | struct hid_report_id { |
572 | __u32 report_type; |
573 | }; |
574 | struct hid_usage_id { |
575 | __u32 usage_hid; |
576 | __u32 usage_type; |
577 | __u32 usage_code; |
578 | }; |
579 | |
580 | /** |
581 | * struct hid_driver |
582 | * @name: driver name (e.g. "Footech_bar-wheel") |
583 | * @id_table: which devices is this driver for (must be non-NULL for probe |
584 | * to be called) |
585 | * @dyn_list: list of dynamically added device ids |
586 | * @dyn_lock: lock protecting @dyn_list |
587 | * @probe: new device inserted |
588 | * @remove: device removed (NULL if not a hot-plug capable driver) |
589 | * @report_table: on which reports to call raw_event (NULL means all) |
590 | * @raw_event: if report in report_table, this hook is called (NULL means nop) |
591 | * @usage_table: on which events to call event (NULL means all) |
592 | * @event: if usage in usage_table, this hook is called (NULL means nop) |
593 | * @report_fixup: called before report descriptor parsing (NULL means nop) |
594 | * @input_mapping: invoked on input registering before mapping an usage |
595 | * @input_mapped: invoked on input registering after mapping an usage |
596 | * @suspend: invoked on suspend (NULL means nop) |
597 | * @resume: invoked on resume if device was not reset (NULL means nop) |
598 | * @reset_resume: invoked on resume if device was reset (NULL means nop) |
599 | * |
600 | * raw_event and event should return 0 on no action performed, 1 when no |
601 | * further processing should be done and negative on error |
602 | * |
603 | * input_mapping shall return a negative value to completely ignore this usage |
604 | * (e.g. doubled or invalid usage), zero to continue with parsing of this |
605 | * usage by generic code (no special handling needed) or positive to skip |
606 | * generic parsing (needed special handling which was done in the hook already) |
607 | * input_mapped shall return negative to inform the layer that this usage |
608 | * should not be considered for further processing or zero to notify that |
609 | * no processing was performed and should be done in a generic manner |
610 | * Both these functions may be NULL which means the same behavior as returning |
611 | * zero from them. |
612 | */ |
613 | struct hid_driver { |
614 | char *name; |
615 | const struct hid_device_id *id_table; |
616 | |
617 | struct list_head dyn_list; |
618 | spinlock_t dyn_lock; |
619 | |
620 | int (*probe)(struct hid_device *dev, const struct hid_device_id *id); |
621 | void (*remove)(struct hid_device *dev); |
622 | |
623 | const struct hid_report_id *report_table; |
624 | int (*raw_event)(struct hid_device *hdev, struct hid_report *report, |
625 | u8 *data, int size); |
626 | const struct hid_usage_id *usage_table; |
627 | int (*event)(struct hid_device *hdev, struct hid_field *field, |
628 | struct hid_usage *usage, __s32 value); |
629 | |
630 | __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf, |
631 | unsigned int *size); |
632 | |
633 | int (*input_mapping)(struct hid_device *hdev, |
634 | struct hid_input *hidinput, struct hid_field *field, |
635 | struct hid_usage *usage, unsigned long **bit, int *max); |
636 | int (*input_mapped)(struct hid_device *hdev, |
637 | struct hid_input *hidinput, struct hid_field *field, |
638 | struct hid_usage *usage, unsigned long **bit, int *max); |
639 | #ifdef CONFIG_PM |
640 | int (*suspend)(struct hid_device *hdev, pm_message_t message); |
641 | int (*resume)(struct hid_device *hdev); |
642 | int (*reset_resume)(struct hid_device *hdev); |
643 | #endif |
644 | /* private: */ |
645 | struct device_driver driver; |
646 | }; |
647 | |
648 | /** |
649 | * hid_ll_driver - low level driver callbacks |
650 | * @start: called on probe to start the device |
651 | * @stop: called on remove |
652 | * @open: called by input layer on open |
653 | * @close: called by input layer on close |
654 | * @hidinput_input_event: event input event (e.g. ff or leds) |
655 | * @parse: this method is called only once to parse the device data, |
656 | * shouldn't allocate anything to not leak memory |
657 | */ |
658 | struct hid_ll_driver { |
659 | int (*start)(struct hid_device *hdev); |
660 | void (*stop)(struct hid_device *hdev); |
661 | |
662 | int (*open)(struct hid_device *hdev); |
663 | void (*close)(struct hid_device *hdev); |
664 | |
665 | int (*power)(struct hid_device *hdev, int level); |
666 | |
667 | int (*hidinput_input_event) (struct input_dev *idev, unsigned int type, |
668 | unsigned int code, int value); |
669 | |
670 | int (*parse)(struct hid_device *hdev); |
671 | }; |
672 | |
673 | #define PM_HINT_FULLON 1<<5 |
674 | #define PM_HINT_NORMAL 1<<1 |
675 | |
676 | /* Applications from HID Usage Tables 4/8/99 Version 1.1 */ |
677 | /* We ignore a few input applications that are not widely used */ |
678 | #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006))) |
679 | |
680 | /* HID core API */ |
681 | |
682 | extern int hid_debug; |
683 | |
684 | extern int hid_add_device(struct hid_device *); |
685 | extern void hid_destroy_device(struct hid_device *); |
686 | |
687 | extern int __must_check __hid_register_driver(struct hid_driver *, |
688 | struct module *, const char *mod_name); |
689 | static inline int __must_check hid_register_driver(struct hid_driver *driver) |
690 | { |
691 | return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME); |
692 | } |
693 | extern void hid_unregister_driver(struct hid_driver *); |
694 | |
695 | extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32); |
696 | extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report); |
697 | extern int hidinput_connect(struct hid_device *hid, unsigned int force); |
698 | extern void hidinput_disconnect(struct hid_device *); |
699 | |
700 | int hid_set_field(struct hid_field *, unsigned, __s32); |
701 | int hid_input_report(struct hid_device *, int type, u8 *, int, int); |
702 | int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field); |
703 | void hid_output_report(struct hid_report *report, __u8 *data); |
704 | struct hid_device *hid_allocate_device(void); |
705 | struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id); |
706 | int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size); |
707 | int hid_check_keys_pressed(struct hid_device *hid); |
708 | int hid_connect(struct hid_device *hid, unsigned int connect_mask); |
709 | void hid_disconnect(struct hid_device *hid); |
710 | |
711 | /** |
712 | * hid_map_usage - map usage input bits |
713 | * |
714 | * @hidinput: hidinput which we are interested in |
715 | * @usage: usage to fill in |
716 | * @bit: pointer to input->{}bit (out parameter) |
717 | * @max: maximal valid usage->code to consider later (out parameter) |
718 | * @type: input event type (EV_KEY, EV_REL, ...) |
719 | * @c: code which corresponds to this usage and type |
720 | */ |
721 | static inline void hid_map_usage(struct hid_input *hidinput, |
722 | struct hid_usage *usage, unsigned long **bit, int *max, |
723 | __u8 type, __u16 c) |
724 | { |
725 | struct input_dev *input = hidinput->input; |
726 | |
727 | usage->type = type; |
728 | usage->code = c; |
729 | |
730 | switch (type) { |
731 | case EV_ABS: |
732 | *bit = input->absbit; |
733 | *max = ABS_MAX; |
734 | break; |
735 | case EV_REL: |
736 | *bit = input->relbit; |
737 | *max = REL_MAX; |
738 | break; |
739 | case EV_KEY: |
740 | *bit = input->keybit; |
741 | *max = KEY_MAX; |
742 | break; |
743 | case EV_LED: |
744 | *bit = input->ledbit; |
745 | *max = LED_MAX; |
746 | break; |
747 | } |
748 | } |
749 | |
750 | /** |
751 | * hid_map_usage_clear - map usage input bits and clear the input bit |
752 | * |
753 | * The same as hid_map_usage, except the @c bit is also cleared in supported |
754 | * bits (@bit). |
755 | */ |
756 | static inline void hid_map_usage_clear(struct hid_input *hidinput, |
757 | struct hid_usage *usage, unsigned long **bit, int *max, |
758 | __u8 type, __u16 c) |
759 | { |
760 | hid_map_usage(hidinput, usage, bit, max, type, c); |
761 | clear_bit(c, *bit); |
762 | } |
763 | |
764 | /** |
765 | * hid_parse - parse HW reports |
766 | * |
767 | * @hdev: hid device |
768 | * |
769 | * Call this from probe after you set up the device (if needed). Your |
770 | * report_fixup will be called (if non-NULL) after reading raw report from |
771 | * device before passing it to hid layer for real parsing. |
772 | */ |
773 | static inline int __must_check hid_parse(struct hid_device *hdev) |
774 | { |
775 | int ret; |
776 | |
777 | if (hdev->status & HID_STAT_PARSED) |
778 | return 0; |
779 | |
780 | ret = hdev->ll_driver->parse(hdev); |
781 | if (!ret) |
782 | hdev->status |= HID_STAT_PARSED; |
783 | |
784 | return ret; |
785 | } |
786 | |
787 | /** |
788 | * hid_hw_start - start underlaying HW |
789 | * |
790 | * @hdev: hid device |
791 | * @connect_mask: which outputs to connect, see HID_CONNECT_* |
792 | * |
793 | * Call this in probe function *after* hid_parse. This will setup HW buffers |
794 | * and start the device (if not deffered to device open). hid_hw_stop must be |
795 | * called if this was successfull. |
796 | */ |
797 | static inline int __must_check hid_hw_start(struct hid_device *hdev, |
798 | unsigned int connect_mask) |
799 | { |
800 | int ret = hdev->ll_driver->start(hdev); |
801 | if (ret || !connect_mask) |
802 | return ret; |
803 | ret = hid_connect(hdev, connect_mask); |
804 | if (ret) |
805 | hdev->ll_driver->stop(hdev); |
806 | return ret; |
807 | } |
808 | |
809 | /** |
810 | * hid_hw_stop - stop underlaying HW |
811 | * |
812 | * @hdev: hid device |
813 | * |
814 | * This is usually called from remove function or from probe when something |
815 | * failed and hid_hw_start was called already. |
816 | */ |
817 | static inline void hid_hw_stop(struct hid_device *hdev) |
818 | { |
819 | hid_disconnect(hdev); |
820 | hdev->ll_driver->stop(hdev); |
821 | } |
822 | |
823 | void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size, |
824 | int interrupt); |
825 | |
826 | extern int hid_generic_init(void); |
827 | extern void hid_generic_exit(void); |
828 | |
829 | /* HID quirks API */ |
830 | u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct); |
831 | int usbhid_quirks_init(char **quirks_param); |
832 | void usbhid_quirks_exit(void); |
833 | void usbhid_set_leds(struct hid_device *hid); |
834 | |
835 | #ifdef CONFIG_HID_PID |
836 | int hid_pidff_init(struct hid_device *hid); |
837 | #else |
838 | #define hid_pidff_init NULL |
839 | #endif |
840 | |
841 | #define dbg_hid(format, arg...) if (hid_debug) \ |
842 | printk(KERN_DEBUG "%s: " format ,\ |
843 | __FILE__ , ## arg) |
844 | #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \ |
845 | __FILE__ , ## arg) |
846 | #endif /* HID_FF */ |
847 | |
848 | #endif |
849 | |
850 |
Branches:
ben-wpan
ben-wpan-stefan
javiroman/ks7010
jz-2.6.34
jz-2.6.34-rc5
jz-2.6.34-rc6
jz-2.6.34-rc7
jz-2.6.35
jz-2.6.36
jz-2.6.37
jz-2.6.38
jz-2.6.39
jz-3.0
jz-3.1
jz-3.11
jz-3.12
jz-3.13
jz-3.15
jz-3.16
jz-3.18-dt
jz-3.2
jz-3.3
jz-3.4
jz-3.5
jz-3.6
jz-3.6-rc2-pwm
jz-3.9
jz-3.9-clk
jz-3.9-rc8
jz47xx
jz47xx-2.6.38
master
Tags:
od-2011-09-04
od-2011-09-18
v2.6.34-rc5
v2.6.34-rc6
v2.6.34-rc7
v3.9