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