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