Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[muen/linux.git] / include / linux / hid.h
1 /*
2  *  Copyright (c) 1999 Andreas Gal
3  *  Copyright (c) 2000-2001 Vojtech Pavlik
4  *  Copyright (c) 2006-2007 Jiri Kosina
5  */
6 /*
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  *
21  * Should you need to contact me, the author, you can do so either by
22  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
23  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
24  */
25 #ifndef __HID_H
26 #define __HID_H
27
28
29 #include <linux/bitops.h>
30 #include <linux/types.h>
31 #include <linux/slab.h>
32 #include <linux/list.h>
33 #include <linux/mod_devicetable.h> /* hid_device_id */
34 #include <linux/timer.h>
35 #include <linux/workqueue.h>
36 #include <linux/input.h>
37 #include <linux/semaphore.h>
38 #include <linux/mutex.h>
39 #include <linux/power_supply.h>
40 #include <uapi/linux/hid.h>
41
42 /*
43  * We parse each description item into this structure. Short items data
44  * values are expanded to 32-bit signed int, long items contain a pointer
45  * into the data area.
46  */
47
48 struct hid_item {
49         unsigned  format;
50         __u8      size;
51         __u8      type;
52         __u8      tag;
53         union {
54             __u8   u8;
55             __s8   s8;
56             __u16  u16;
57             __s16  s16;
58             __u32  u32;
59             __s32  s32;
60             __u8  *longdata;
61         } data;
62 };
63
64 /*
65  * HID report item format
66  */
67
68 #define HID_ITEM_FORMAT_SHORT   0
69 #define HID_ITEM_FORMAT_LONG    1
70
71 /*
72  * Special tag indicating long items
73  */
74
75 #define HID_ITEM_TAG_LONG       15
76
77 /*
78  * HID report descriptor item type (prefix bit 2,3)
79  */
80
81 #define HID_ITEM_TYPE_MAIN              0
82 #define HID_ITEM_TYPE_GLOBAL            1
83 #define HID_ITEM_TYPE_LOCAL             2
84 #define HID_ITEM_TYPE_RESERVED          3
85
86 /*
87  * HID report descriptor main item tags
88  */
89
90 #define HID_MAIN_ITEM_TAG_INPUT                 8
91 #define HID_MAIN_ITEM_TAG_OUTPUT                9
92 #define HID_MAIN_ITEM_TAG_FEATURE               11
93 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION      10
94 #define HID_MAIN_ITEM_TAG_END_COLLECTION        12
95
96 /*
97  * HID report descriptor main item contents
98  */
99
100 #define HID_MAIN_ITEM_CONSTANT          0x001
101 #define HID_MAIN_ITEM_VARIABLE          0x002
102 #define HID_MAIN_ITEM_RELATIVE          0x004
103 #define HID_MAIN_ITEM_WRAP              0x008
104 #define HID_MAIN_ITEM_NONLINEAR         0x010
105 #define HID_MAIN_ITEM_NO_PREFERRED      0x020
106 #define HID_MAIN_ITEM_NULL_STATE        0x040
107 #define HID_MAIN_ITEM_VOLATILE          0x080
108 #define HID_MAIN_ITEM_BUFFERED_BYTE     0x100
109
110 /*
111  * HID report descriptor collection item types
112  */
113
114 #define HID_COLLECTION_PHYSICAL         0
115 #define HID_COLLECTION_APPLICATION      1
116 #define HID_COLLECTION_LOGICAL          2
117
118 /*
119  * HID report descriptor global item tags
120  */
121
122 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE          0
123 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM     1
124 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM     2
125 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM    3
126 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM    4
127 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT       5
128 #define HID_GLOBAL_ITEM_TAG_UNIT                6
129 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE         7
130 #define HID_GLOBAL_ITEM_TAG_REPORT_ID           8
131 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT        9
132 #define HID_GLOBAL_ITEM_TAG_PUSH                10
133 #define HID_GLOBAL_ITEM_TAG_POP                 11
134
135 /*
136  * HID report descriptor local item tags
137  */
138
139 #define HID_LOCAL_ITEM_TAG_USAGE                0
140 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM        1
141 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM        2
142 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX     3
143 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM   4
144 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM   5
145 #define HID_LOCAL_ITEM_TAG_STRING_INDEX         7
146 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM       8
147 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM       9
148 #define HID_LOCAL_ITEM_TAG_DELIMITER            10
149
150 /*
151  * HID usage tables
152  */
153
154 #define HID_USAGE_PAGE          0xffff0000
155
156 #define HID_UP_UNDEFINED        0x00000000
157 #define HID_UP_GENDESK          0x00010000
158 #define HID_UP_SIMULATION       0x00020000
159 #define HID_UP_GENDEVCTRLS      0x00060000
160 #define HID_UP_KEYBOARD         0x00070000
161 #define HID_UP_LED              0x00080000
162 #define HID_UP_BUTTON           0x00090000
163 #define HID_UP_ORDINAL          0x000a0000
164 #define HID_UP_TELEPHONY        0x000b0000
165 #define HID_UP_CONSUMER         0x000c0000
166 #define HID_UP_DIGITIZER        0x000d0000
167 #define HID_UP_PID              0x000f0000
168 #define HID_UP_HPVENDOR         0xff7f0000
169 #define HID_UP_HPVENDOR2        0xff010000
170 #define HID_UP_MSVENDOR         0xff000000
171 #define HID_UP_CUSTOM           0x00ff0000
172 #define HID_UP_LOGIVENDOR       0xffbc0000
173 #define HID_UP_LOGIVENDOR2   0xff090000
174 #define HID_UP_LOGIVENDOR3   0xff430000
175 #define HID_UP_LNVENDOR         0xffa00000
176 #define HID_UP_SENSOR           0x00200000
177 #define HID_UP_ASUSVENDOR       0xff310000
178
179 #define HID_USAGE               0x0000ffff
180
181 #define HID_GD_POINTER          0x00010001
182 #define HID_GD_MOUSE            0x00010002
183 #define HID_GD_JOYSTICK         0x00010004
184 #define HID_GD_GAMEPAD          0x00010005
185 #define HID_GD_KEYBOARD         0x00010006
186 #define HID_GD_KEYPAD           0x00010007
187 #define HID_GD_MULTIAXIS        0x00010008
188 /*
189  * Microsoft Win8 Wireless Radio Controls extensions CA, see:
190  * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
191  */
192 #define HID_GD_WIRELESS_RADIO_CTLS      0x0001000c
193 #define HID_GD_X                0x00010030
194 #define HID_GD_Y                0x00010031
195 #define HID_GD_Z                0x00010032
196 #define HID_GD_RX               0x00010033
197 #define HID_GD_RY               0x00010034
198 #define HID_GD_RZ               0x00010035
199 #define HID_GD_SLIDER           0x00010036
200 #define HID_GD_DIAL             0x00010037
201 #define HID_GD_WHEEL            0x00010038
202 #define HID_GD_HATSWITCH        0x00010039
203 #define HID_GD_BUFFER           0x0001003a
204 #define HID_GD_BYTECOUNT        0x0001003b
205 #define HID_GD_MOTION           0x0001003c
206 #define HID_GD_START            0x0001003d
207 #define HID_GD_SELECT           0x0001003e
208 #define HID_GD_VX               0x00010040
209 #define HID_GD_VY               0x00010041
210 #define HID_GD_VZ               0x00010042
211 #define HID_GD_VBRX             0x00010043
212 #define HID_GD_VBRY             0x00010044
213 #define HID_GD_VBRZ             0x00010045
214 #define HID_GD_VNO              0x00010046
215 #define HID_GD_FEATURE          0x00010047
216 #define HID_GD_SYSTEM_CONTROL   0x00010080
217 #define HID_GD_UP               0x00010090
218 #define HID_GD_DOWN             0x00010091
219 #define HID_GD_RIGHT            0x00010092
220 #define HID_GD_LEFT             0x00010093
221 /* Microsoft Win8 Wireless Radio Controls CA usage codes */
222 #define HID_GD_RFKILL_BTN       0x000100c6
223 #define HID_GD_RFKILL_LED       0x000100c7
224 #define HID_GD_RFKILL_SWITCH    0x000100c8
225
226 #define HID_DC_BATTERYSTRENGTH  0x00060020
227
228 #define HID_CP_CONSUMER_CONTROL 0x000c0001
229
230 #define HID_DG_DIGITIZER        0x000d0001
231 #define HID_DG_PEN              0x000d0002
232 #define HID_DG_LIGHTPEN         0x000d0003
233 #define HID_DG_TOUCHSCREEN      0x000d0004
234 #define HID_DG_TOUCHPAD         0x000d0005
235 #define HID_DG_STYLUS           0x000d0020
236 #define HID_DG_PUCK             0x000d0021
237 #define HID_DG_FINGER           0x000d0022
238 #define HID_DG_TIPPRESSURE      0x000d0030
239 #define HID_DG_BARRELPRESSURE   0x000d0031
240 #define HID_DG_INRANGE          0x000d0032
241 #define HID_DG_TOUCH            0x000d0033
242 #define HID_DG_UNTOUCH          0x000d0034
243 #define HID_DG_TAP              0x000d0035
244 #define HID_DG_TABLETFUNCTIONKEY        0x000d0039
245 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
246 #define HID_DG_BATTERYSTRENGTH  0x000d003b
247 #define HID_DG_INVERT           0x000d003c
248 #define HID_DG_TILT_X           0x000d003d
249 #define HID_DG_TILT_Y           0x000d003e
250 #define HID_DG_TWIST            0x000d0041
251 #define HID_DG_TIPSWITCH        0x000d0042
252 #define HID_DG_TIPSWITCH2       0x000d0043
253 #define HID_DG_BARRELSWITCH     0x000d0044
254 #define HID_DG_ERASER           0x000d0045
255 #define HID_DG_TABLETPICK       0x000d0046
256
257 #define HID_CP_CONSUMERCONTROL  0x000c0001
258 #define HID_CP_NUMERICKEYPAD    0x000c0002
259 #define HID_CP_PROGRAMMABLEBUTTONS      0x000c0003
260 #define HID_CP_MICROPHONE       0x000c0004
261 #define HID_CP_HEADPHONE        0x000c0005
262 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
263 #define HID_CP_FUNCTIONBUTTONS  0x000c0036
264 #define HID_CP_SELECTION        0x000c0080
265 #define HID_CP_MEDIASELECTION   0x000c0087
266 #define HID_CP_SELECTDISC       0x000c00ba
267 #define HID_CP_PLAYBACKSPEED    0x000c00f1
268 #define HID_CP_PROXIMITY        0x000c0109
269 #define HID_CP_SPEAKERSYSTEM    0x000c0160
270 #define HID_CP_CHANNELLEFT      0x000c0161
271 #define HID_CP_CHANNELRIGHT     0x000c0162
272 #define HID_CP_CHANNELCENTER    0x000c0163
273 #define HID_CP_CHANNELFRONT     0x000c0164
274 #define HID_CP_CHANNELCENTERFRONT       0x000c0165
275 #define HID_CP_CHANNELSIDE      0x000c0166
276 #define HID_CP_CHANNELSURROUND  0x000c0167
277 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT   0x000c0168
278 #define HID_CP_CHANNELTOP       0x000c0169
279 #define HID_CP_CHANNELUNKNOWN   0x000c016a
280 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
281 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS    0x000c0200
282
283 #define HID_DG_DEVICECONFIG     0x000d000e
284 #define HID_DG_DEVICESETTINGS   0x000d0023
285 #define HID_DG_AZIMUTH          0x000d003f
286 #define HID_DG_CONFIDENCE       0x000d0047
287 #define HID_DG_WIDTH            0x000d0048
288 #define HID_DG_HEIGHT           0x000d0049
289 #define HID_DG_CONTACTID        0x000d0051
290 #define HID_DG_INPUTMODE        0x000d0052
291 #define HID_DG_DEVICEINDEX      0x000d0053
292 #define HID_DG_CONTACTCOUNT     0x000d0054
293 #define HID_DG_CONTACTMAX       0x000d0055
294 #define HID_DG_SCANTIME         0x000d0056
295 #define HID_DG_BUTTONTYPE       0x000d0059
296 #define HID_DG_BARRELSWITCH2    0x000d005a
297 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
298
299 #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS   0xff310076
300 /*
301  * HID report types --- Ouch! HID spec says 1 2 3!
302  */
303
304 #define HID_INPUT_REPORT        0
305 #define HID_OUTPUT_REPORT       1
306 #define HID_FEATURE_REPORT      2
307
308 #define HID_REPORT_TYPES        3
309
310 /*
311  * HID connect requests
312  */
313
314 #define HID_CONNECT_HIDINPUT            BIT(0)
315 #define HID_CONNECT_HIDINPUT_FORCE      BIT(1)
316 #define HID_CONNECT_HIDRAW              BIT(2)
317 #define HID_CONNECT_HIDDEV              BIT(3)
318 #define HID_CONNECT_HIDDEV_FORCE        BIT(4)
319 #define HID_CONNECT_FF                  BIT(5)
320 #define HID_CONNECT_DRIVER              BIT(6)
321 #define HID_CONNECT_DEFAULT     (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
322                 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
323
324 /*
325  * HID device quirks.
326  */
327
328 /* 
329  * Increase this if you need to configure more HID quirks at module load time
330  */
331 #define MAX_USBHID_BOOT_QUIRKS 4
332
333 #define HID_QUIRK_INVERT                        BIT(0)
334 #define HID_QUIRK_NOTOUCH                       BIT(1)
335 #define HID_QUIRK_IGNORE                        BIT(2)
336 #define HID_QUIRK_NOGET                         BIT(3)
337 #define HID_QUIRK_HIDDEV_FORCE                  BIT(4)
338 #define HID_QUIRK_BADPAD                        BIT(5)
339 #define HID_QUIRK_MULTI_INPUT                   BIT(6)
340 #define HID_QUIRK_HIDINPUT_FORCE                BIT(7)
341 /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
342 /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
343 #define HID_QUIRK_ALWAYS_POLL                   BIT(10)
344 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           BIT(16)
345 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID         BIT(17)
346 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP  BIT(18)
347 #define HID_QUIRK_HAVE_SPECIAL_DRIVER           BIT(19)
348 #define HID_QUIRK_FULLSPEED_INTERVAL            BIT(28)
349 #define HID_QUIRK_NO_INIT_REPORTS               BIT(29)
350 #define HID_QUIRK_NO_IGNORE                     BIT(30)
351 #define HID_QUIRK_NO_INPUT_SYNC                 BIT(31)
352
353 /*
354  * HID device groups
355  *
356  * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
357  * and has a value of 0x0000
358  */
359 #define HID_GROUP_GENERIC                       0x0001
360 #define HID_GROUP_MULTITOUCH                    0x0002
361 #define HID_GROUP_SENSOR_HUB                    0x0003
362 #define HID_GROUP_MULTITOUCH_WIN_8              0x0004
363
364 /*
365  * Vendor specific HID device groups
366  */
367 #define HID_GROUP_RMI                           0x0100
368 #define HID_GROUP_WACOM                         0x0101
369 #define HID_GROUP_LOGITECH_DJ_DEVICE            0x0102
370
371 /*
372  * HID protocol status
373  */
374 #define HID_REPORT_PROTOCOL     1
375 #define HID_BOOT_PROTOCOL       0
376
377 /*
378  * This is the global environment of the parser. This information is
379  * persistent for main-items. The global environment can be saved and
380  * restored with PUSH/POP statements.
381  */
382
383 struct hid_global {
384         unsigned usage_page;
385         __s32    logical_minimum;
386         __s32    logical_maximum;
387         __s32    physical_minimum;
388         __s32    physical_maximum;
389         __s32    unit_exponent;
390         unsigned unit;
391         unsigned report_id;
392         unsigned report_size;
393         unsigned report_count;
394 };
395
396 /*
397  * This is the local environment. It is persistent up the next main-item.
398  */
399
400 #define HID_MAX_USAGES                  12288
401 #define HID_DEFAULT_NUM_COLLECTIONS     16
402
403 struct hid_local {
404         unsigned usage[HID_MAX_USAGES]; /* usage array */
405         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
406         unsigned usage_index;
407         unsigned usage_minimum;
408         unsigned delimiter_depth;
409         unsigned delimiter_branch;
410 };
411
412 /*
413  * This is the collection stack. We climb up the stack to determine
414  * application and function of each field.
415  */
416
417 struct hid_collection {
418         unsigned type;
419         unsigned usage;
420         unsigned level;
421 };
422
423 struct hid_usage {
424         unsigned  hid;                  /* hid usage code */
425         unsigned  collection_index;     /* index into collection array */
426         unsigned  usage_index;          /* index into usage array */
427         /* hidinput data */
428         __u16     code;                 /* input driver code */
429         __u8      type;                 /* input driver type */
430         __s8      hat_min;              /* hat switch fun */
431         __s8      hat_max;              /* ditto */
432         __s8      hat_dir;              /* ditto */
433 };
434
435 struct hid_input;
436
437 struct hid_field {
438         unsigned  physical;             /* physical usage for this field */
439         unsigned  logical;              /* logical usage for this field */
440         unsigned  application;          /* application usage for this field */
441         struct hid_usage *usage;        /* usage table for this function */
442         unsigned  maxusage;             /* maximum usage index */
443         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
444         unsigned  report_offset;        /* bit offset in the report */
445         unsigned  report_size;          /* size of this field in the report */
446         unsigned  report_count;         /* number of this field in the report */
447         unsigned  report_type;          /* (input,output,feature) */
448         __s32    *value;                /* last known value(s) */
449         __s32     logical_minimum;
450         __s32     logical_maximum;
451         __s32     physical_minimum;
452         __s32     physical_maximum;
453         __s32     unit_exponent;
454         unsigned  unit;
455         struct hid_report *report;      /* associated report */
456         unsigned index;                 /* index into report->field[] */
457         /* hidinput data */
458         struct hid_input *hidinput;     /* associated input structure */
459         __u16 dpad;                     /* dpad input code */
460 };
461
462 #define HID_MAX_FIELDS 256
463
464 struct hid_report {
465         struct list_head list;
466         unsigned id;                                    /* id of this report */
467         unsigned type;                                  /* report type */
468         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
469         unsigned maxfield;                              /* maximum valid field index */
470         unsigned size;                                  /* size of the report (bits) */
471         struct hid_device *device;                      /* associated device */
472 };
473
474 #define HID_MAX_IDS 256
475
476 struct hid_report_enum {
477         unsigned numbered;
478         struct list_head report_list;
479         struct hid_report *report_id_hash[HID_MAX_IDS];
480 };
481
482 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
483 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
484 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
485 #define HID_OUTPUT_FIFO_SIZE    64
486
487 struct hid_control_fifo {
488         unsigned char dir;
489         struct hid_report *report;
490         char *raw_report;
491 };
492
493 struct hid_output_fifo {
494         struct hid_report *report;
495         char *raw_report;
496 };
497
498 #define HID_CLAIMED_INPUT       BIT(0)
499 #define HID_CLAIMED_HIDDEV      BIT(1)
500 #define HID_CLAIMED_HIDRAW      BIT(2)
501 #define HID_CLAIMED_DRIVER      BIT(3)
502
503 #define HID_STAT_ADDED          BIT(0)
504 #define HID_STAT_PARSED         BIT(1)
505
506 struct hid_input {
507         struct list_head list;
508         struct hid_report *report;
509         struct input_dev *input;
510         bool registered;
511 };
512
513 enum hid_type {
514         HID_TYPE_OTHER = 0,
515         HID_TYPE_USBMOUSE,
516         HID_TYPE_USBNONE
517 };
518
519 enum hid_battery_status {
520         HID_BATTERY_UNKNOWN = 0,
521         HID_BATTERY_QUERIED,            /* Kernel explicitly queried battery strength */
522         HID_BATTERY_REPORTED,           /* Device sent unsolicited battery strength report */
523 };
524
525 struct hid_driver;
526 struct hid_ll_driver;
527
528 struct hid_device {                                                     /* device report descriptor */
529         __u8 *dev_rdesc;
530         unsigned dev_rsize;
531         __u8 *rdesc;
532         unsigned rsize;
533         struct hid_collection *collection;                              /* List of HID collections */
534         unsigned collection_size;                                       /* Number of allocated hid_collections */
535         unsigned maxcollection;                                         /* Number of parsed collections */
536         unsigned maxapplication;                                        /* Number of applications */
537         __u16 bus;                                                      /* BUS ID */
538         __u16 group;                                                    /* Report group */
539         __u32 vendor;                                                   /* Vendor ID */
540         __u32 product;                                                  /* Product ID */
541         __u32 version;                                                  /* HID version */
542         enum hid_type type;                                             /* device type (mouse, kbd, ...) */
543         unsigned country;                                               /* HID country */
544         struct hid_report_enum report_enum[HID_REPORT_TYPES];
545         struct work_struct led_work;                                    /* delayed LED worker */
546
547         struct semaphore driver_input_lock;                             /* protects the current driver */
548         struct device dev;                                              /* device */
549         struct hid_driver *driver;
550
551         struct hid_ll_driver *ll_driver;
552         struct mutex ll_open_lock;
553         unsigned int ll_open_count;
554
555 #ifdef CONFIG_HID_BATTERY_STRENGTH
556         /*
557          * Power supply information for HID devices which report
558          * battery strength. power_supply was successfully registered if
559          * battery is non-NULL.
560          */
561         struct power_supply *battery;
562         __s32 battery_capacity;
563         __s32 battery_min;
564         __s32 battery_max;
565         __s32 battery_report_type;
566         __s32 battery_report_id;
567         enum hid_battery_status battery_status;
568         bool battery_avoid_query;
569 #endif
570
571         unsigned int status;                                            /* see STAT flags above */
572         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
573         unsigned quirks;                                                /* Various quirks the device can pull on us */
574         bool io_started;                                                /* If IO has started */
575
576         struct list_head inputs;                                        /* The list of inputs */
577         void *hiddev;                                                   /* The hiddev structure */
578         void *hidraw;
579
580         char name[128];                                                 /* Device name */
581         char phys[64];                                                  /* Device physical location */
582         char uniq[64];                                                  /* Device unique identifier (serial #) */
583
584         void *driver_data;
585
586         /* temporary hid_ff handling (until moved to the drivers) */
587         int (*ff_init)(struct hid_device *);
588
589         /* hiddev event handler */
590         int (*hiddev_connect)(struct hid_device *, unsigned int);
591         void (*hiddev_disconnect)(struct hid_device *);
592         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
593                                   struct hid_usage *, __s32);
594         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
595
596         /* debugging support via debugfs */
597         unsigned short debug;
598         struct dentry *debug_dir;
599         struct dentry *debug_rdesc;
600         struct dentry *debug_events;
601         struct list_head debug_list;
602         spinlock_t  debug_list_lock;
603         wait_queue_head_t debug_wait;
604 };
605
606 #define to_hid_device(pdev) \
607         container_of(pdev, struct hid_device, dev)
608
609 static inline void *hid_get_drvdata(struct hid_device *hdev)
610 {
611         return dev_get_drvdata(&hdev->dev);
612 }
613
614 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
615 {
616         dev_set_drvdata(&hdev->dev, data);
617 }
618
619 #define HID_GLOBAL_STACK_SIZE 4
620 #define HID_COLLECTION_STACK_SIZE 4
621
622 #define HID_SCAN_FLAG_MT_WIN_8                  BIT(0)
623 #define HID_SCAN_FLAG_VENDOR_SPECIFIC           BIT(1)
624 #define HID_SCAN_FLAG_GD_POINTER                BIT(2)
625
626 struct hid_parser {
627         struct hid_global     global;
628         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
629         unsigned              global_stack_ptr;
630         struct hid_local      local;
631         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
632         unsigned              collection_stack_ptr;
633         struct hid_device    *device;
634         unsigned              scan_flags;
635 };
636
637 struct hid_class_descriptor {
638         __u8  bDescriptorType;
639         __le16 wDescriptorLength;
640 } __attribute__ ((packed));
641
642 struct hid_descriptor {
643         __u8  bLength;
644         __u8  bDescriptorType;
645         __le16 bcdHID;
646         __u8  bCountryCode;
647         __u8  bNumDescriptors;
648
649         struct hid_class_descriptor desc[1];
650 } __attribute__ ((packed));
651
652 #define HID_DEVICE(b, g, ven, prod)                                     \
653         .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
654 #define HID_USB_DEVICE(ven, prod)                               \
655         .bus = BUS_USB, .vendor = (ven), .product = (prod)
656 #define HID_BLUETOOTH_DEVICE(ven, prod)                                 \
657         .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
658 #define HID_I2C_DEVICE(ven, prod)                               \
659         .bus = BUS_I2C, .vendor = (ven), .product = (prod)
660
661 #define HID_REPORT_ID(rep) \
662         .report_type = (rep)
663 #define HID_USAGE_ID(uhid, utype, ucode) \
664         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
665 /* we don't want to catch types and codes equal to 0 */
666 #define HID_TERMINATOR          (HID_ANY_ID - 1)
667
668 struct hid_report_id {
669         __u32 report_type;
670 };
671 struct hid_usage_id {
672         __u32 usage_hid;
673         __u32 usage_type;
674         __u32 usage_code;
675 };
676
677 /**
678  * struct hid_driver
679  * @name: driver name (e.g. "Footech_bar-wheel")
680  * @id_table: which devices is this driver for (must be non-NULL for probe
681  *            to be called)
682  * @dyn_list: list of dynamically added device ids
683  * @dyn_lock: lock protecting @dyn_list
684  * @match: check if the given device is handled by this driver
685  * @probe: new device inserted
686  * @remove: device removed (NULL if not a hot-plug capable driver)
687  * @report_table: on which reports to call raw_event (NULL means all)
688  * @raw_event: if report in report_table, this hook is called (NULL means nop)
689  * @usage_table: on which events to call event (NULL means all)
690  * @event: if usage in usage_table, this hook is called (NULL means nop)
691  * @report: this hook is called after parsing a report (NULL means nop)
692  * @report_fixup: called before report descriptor parsing (NULL means nop)
693  * @input_mapping: invoked on input registering before mapping an usage
694  * @input_mapped: invoked on input registering after mapping an usage
695  * @input_configured: invoked just before the device is registered
696  * @feature_mapping: invoked on feature registering
697  * @suspend: invoked on suspend (NULL means nop)
698  * @resume: invoked on resume if device was not reset (NULL means nop)
699  * @reset_resume: invoked on resume if device was reset (NULL means nop)
700  *
701  * probe should return -errno on error, or 0 on success. During probe,
702  * input will not be passed to raw_event unless hid_device_io_start is
703  * called.
704  *
705  * raw_event and event should return 0 on no action performed, 1 when no
706  * further processing should be done and negative on error
707  *
708  * input_mapping shall return a negative value to completely ignore this usage
709  * (e.g. doubled or invalid usage), zero to continue with parsing of this
710  * usage by generic code (no special handling needed) or positive to skip
711  * generic parsing (needed special handling which was done in the hook already)
712  * input_mapped shall return negative to inform the layer that this usage
713  * should not be considered for further processing or zero to notify that
714  * no processing was performed and should be done in a generic manner
715  * Both these functions may be NULL which means the same behavior as returning
716  * zero from them.
717  */
718 struct hid_driver {
719         char *name;
720         const struct hid_device_id *id_table;
721
722         struct list_head dyn_list;
723         spinlock_t dyn_lock;
724
725         bool (*match)(struct hid_device *dev, bool ignore_special_driver);
726         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
727         void (*remove)(struct hid_device *dev);
728
729         const struct hid_report_id *report_table;
730         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
731                         u8 *data, int size);
732         const struct hid_usage_id *usage_table;
733         int (*event)(struct hid_device *hdev, struct hid_field *field,
734                         struct hid_usage *usage, __s32 value);
735         void (*report)(struct hid_device *hdev, struct hid_report *report);
736
737         __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
738                         unsigned int *size);
739
740         int (*input_mapping)(struct hid_device *hdev,
741                         struct hid_input *hidinput, struct hid_field *field,
742                         struct hid_usage *usage, unsigned long **bit, int *max);
743         int (*input_mapped)(struct hid_device *hdev,
744                         struct hid_input *hidinput, struct hid_field *field,
745                         struct hid_usage *usage, unsigned long **bit, int *max);
746         int (*input_configured)(struct hid_device *hdev,
747                                 struct hid_input *hidinput);
748         void (*feature_mapping)(struct hid_device *hdev,
749                         struct hid_field *field,
750                         struct hid_usage *usage);
751 #ifdef CONFIG_PM
752         int (*suspend)(struct hid_device *hdev, pm_message_t message);
753         int (*resume)(struct hid_device *hdev);
754         int (*reset_resume)(struct hid_device *hdev);
755 #endif
756 /* private: */
757         struct device_driver driver;
758 };
759
760 #define to_hid_driver(pdrv) \
761         container_of(pdrv, struct hid_driver, driver)
762
763 /**
764  * hid_ll_driver - low level driver callbacks
765  * @start: called on probe to start the device
766  * @stop: called on remove
767  * @open: called by input layer on open
768  * @close: called by input layer on close
769  * @power: request underlying hardware to enter requested power mode
770  * @parse: this method is called only once to parse the device data,
771  *         shouldn't allocate anything to not leak memory
772  * @request: send report request to device (e.g. feature report)
773  * @wait: wait for buffered io to complete (send/recv reports)
774  * @raw_request: send raw report request to device (e.g. feature report)
775  * @output_report: send output report to device
776  * @idle: send idle request to device
777  */
778 struct hid_ll_driver {
779         int (*start)(struct hid_device *hdev);
780         void (*stop)(struct hid_device *hdev);
781
782         int (*open)(struct hid_device *hdev);
783         void (*close)(struct hid_device *hdev);
784
785         int (*power)(struct hid_device *hdev, int level);
786
787         int (*parse)(struct hid_device *hdev);
788
789         void (*request)(struct hid_device *hdev,
790                         struct hid_report *report, int reqtype);
791
792         int (*wait)(struct hid_device *hdev);
793
794         int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
795                             __u8 *buf, size_t len, unsigned char rtype,
796                             int reqtype);
797
798         int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
799
800         int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
801 };
802
803 extern struct hid_ll_driver i2c_hid_ll_driver;
804 extern struct hid_ll_driver hidp_hid_driver;
805 extern struct hid_ll_driver uhid_hid_driver;
806 extern struct hid_ll_driver usb_hid_driver;
807
808 static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
809                 struct hid_ll_driver *driver)
810 {
811         return hdev->ll_driver == driver;
812 }
813
814 #define PM_HINT_FULLON  1<<5
815 #define PM_HINT_NORMAL  1<<1
816
817 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
818 /* We ignore a few input applications that are not widely used */
819 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
820
821 /* HID core API */
822
823 extern int hid_debug;
824
825 extern bool hid_ignore(struct hid_device *);
826 extern int hid_add_device(struct hid_device *);
827 extern void hid_destroy_device(struct hid_device *);
828
829 extern struct bus_type hid_bus_type;
830
831 extern int __must_check __hid_register_driver(struct hid_driver *,
832                 struct module *, const char *mod_name);
833
834 /* use a define to avoid include chaining to get THIS_MODULE & friends */
835 #define hid_register_driver(driver) \
836         __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
837
838 extern void hid_unregister_driver(struct hid_driver *);
839
840 /**
841  * module_hid_driver() - Helper macro for registering a HID driver
842  * @__hid_driver: hid_driver struct
843  *
844  * Helper macro for HID drivers which do not do anything special in module
845  * init/exit. This eliminates a lot of boilerplate. Each module may only
846  * use this macro once, and calling it replaces module_init() and module_exit()
847  */
848 #define module_hid_driver(__hid_driver) \
849         module_driver(__hid_driver, hid_register_driver, \
850                       hid_unregister_driver)
851
852 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
853 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
854 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
855 extern void hidinput_disconnect(struct hid_device *);
856
857 int hid_set_field(struct hid_field *, unsigned, __s32);
858 int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
859 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
860 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
861 unsigned int hidinput_count_leds(struct hid_device *hid);
862 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
863 void hid_output_report(struct hid_report *report, __u8 *data);
864 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
865 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
866 struct hid_device *hid_allocate_device(void);
867 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
868 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
869 struct hid_report *hid_validate_values(struct hid_device *hid,
870                                        unsigned int type, unsigned int id,
871                                        unsigned int field_index,
872                                        unsigned int report_counts);
873 int hid_open_report(struct hid_device *device);
874 int hid_check_keys_pressed(struct hid_device *hid);
875 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
876 void hid_disconnect(struct hid_device *hid);
877 bool hid_match_one_id(const struct hid_device *hdev,
878                       const struct hid_device_id *id);
879 const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
880                                          const struct hid_device_id *id);
881 const struct hid_device_id *hid_match_device(struct hid_device *hdev,
882                                              struct hid_driver *hdrv);
883 s32 hid_snto32(__u32 value, unsigned n);
884 __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
885                      unsigned offset, unsigned n);
886
887 /**
888  * hid_device_io_start - enable HID input during probe, remove
889  *
890  * @hid - the device
891  *
892  * This should only be called during probe or remove and only be
893  * called by the thread calling probe or remove. It will allow
894  * incoming packets to be delivered to the driver.
895  */
896 static inline void hid_device_io_start(struct hid_device *hid) {
897         if (hid->io_started) {
898                 dev_warn(&hid->dev, "io already started\n");
899                 return;
900         }
901         hid->io_started = true;
902         up(&hid->driver_input_lock);
903 }
904
905 /**
906  * hid_device_io_stop - disable HID input during probe, remove
907  *
908  * @hid - the device
909  *
910  * Should only be called after hid_device_io_start. It will prevent
911  * incoming packets from going to the driver for the duration of
912  * probe, remove. If called during probe, packets will still go to the
913  * driver after probe is complete. This function should only be called
914  * by the thread calling probe or remove.
915  */
916 static inline void hid_device_io_stop(struct hid_device *hid) {
917         if (!hid->io_started) {
918                 dev_warn(&hid->dev, "io already stopped\n");
919                 return;
920         }
921         hid->io_started = false;
922         down(&hid->driver_input_lock);
923 }
924
925 /**
926  * hid_map_usage - map usage input bits
927  *
928  * @hidinput: hidinput which we are interested in
929  * @usage: usage to fill in
930  * @bit: pointer to input->{}bit (out parameter)
931  * @max: maximal valid usage->code to consider later (out parameter)
932  * @type: input event type (EV_KEY, EV_REL, ...)
933  * @c: code which corresponds to this usage and type
934  */
935 static inline void hid_map_usage(struct hid_input *hidinput,
936                 struct hid_usage *usage, unsigned long **bit, int *max,
937                 __u8 type, __u16 c)
938 {
939         struct input_dev *input = hidinput->input;
940
941         usage->type = type;
942         usage->code = c;
943
944         switch (type) {
945         case EV_ABS:
946                 *bit = input->absbit;
947                 *max = ABS_MAX;
948                 break;
949         case EV_REL:
950                 *bit = input->relbit;
951                 *max = REL_MAX;
952                 break;
953         case EV_KEY:
954                 *bit = input->keybit;
955                 *max = KEY_MAX;
956                 break;
957         case EV_LED:
958                 *bit = input->ledbit;
959                 *max = LED_MAX;
960                 break;
961         }
962 }
963
964 /**
965  * hid_map_usage_clear - map usage input bits and clear the input bit
966  *
967  * The same as hid_map_usage, except the @c bit is also cleared in supported
968  * bits (@bit).
969  */
970 static inline void hid_map_usage_clear(struct hid_input *hidinput,
971                 struct hid_usage *usage, unsigned long **bit, int *max,
972                 __u8 type, __u16 c)
973 {
974         hid_map_usage(hidinput, usage, bit, max, type, c);
975         clear_bit(c, *bit);
976 }
977
978 /**
979  * hid_parse - parse HW reports
980  *
981  * @hdev: hid device
982  *
983  * Call this from probe after you set up the device (if needed). Your
984  * report_fixup will be called (if non-NULL) after reading raw report from
985  * device before passing it to hid layer for real parsing.
986  */
987 static inline int __must_check hid_parse(struct hid_device *hdev)
988 {
989         return hid_open_report(hdev);
990 }
991
992 int __must_check hid_hw_start(struct hid_device *hdev,
993                               unsigned int connect_mask);
994 void hid_hw_stop(struct hid_device *hdev);
995 int __must_check hid_hw_open(struct hid_device *hdev);
996 void hid_hw_close(struct hid_device *hdev);
997
998 /**
999  * hid_hw_power - requests underlying HW to go into given power mode
1000  *
1001  * @hdev: hid device
1002  * @level: requested power level (one of %PM_HINT_* defines)
1003  *
1004  * This function requests underlying hardware to enter requested power
1005  * mode.
1006  */
1007
1008 static inline int hid_hw_power(struct hid_device *hdev, int level)
1009 {
1010         return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1011 }
1012
1013
1014 /**
1015  * hid_hw_request - send report request to device
1016  *
1017  * @hdev: hid device
1018  * @report: report to send
1019  * @reqtype: hid request type
1020  */
1021 static inline void hid_hw_request(struct hid_device *hdev,
1022                                   struct hid_report *report, int reqtype)
1023 {
1024         if (hdev->ll_driver->request)
1025                 return hdev->ll_driver->request(hdev, report, reqtype);
1026
1027         __hid_request(hdev, report, reqtype);
1028 }
1029
1030 /**
1031  * hid_hw_raw_request - send report request to device
1032  *
1033  * @hdev: hid device
1034  * @reportnum: report ID
1035  * @buf: in/out data to transfer
1036  * @len: length of buf
1037  * @rtype: HID report type
1038  * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1039  *
1040  * @return: count of data transfered, negative if error
1041  *
1042  * Same behavior as hid_hw_request, but with raw buffers instead.
1043  */
1044 static inline int hid_hw_raw_request(struct hid_device *hdev,
1045                                   unsigned char reportnum, __u8 *buf,
1046                                   size_t len, unsigned char rtype, int reqtype)
1047 {
1048         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1049                 return -EINVAL;
1050
1051         return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1052                                                     rtype, reqtype);
1053 }
1054
1055 /**
1056  * hid_hw_output_report - send output report to device
1057  *
1058  * @hdev: hid device
1059  * @buf: raw data to transfer
1060  * @len: length of buf
1061  *
1062  * @return: count of data transfered, negative if error
1063  */
1064 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1065                                         size_t len)
1066 {
1067         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1068                 return -EINVAL;
1069
1070         if (hdev->ll_driver->output_report)
1071                 return hdev->ll_driver->output_report(hdev, buf, len);
1072
1073         return -ENOSYS;
1074 }
1075
1076 /**
1077  * hid_hw_idle - send idle request to device
1078  *
1079  * @hdev: hid device
1080  * @report: report to control
1081  * @idle: idle state
1082  * @reqtype: hid request type
1083  */
1084 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1085                 int reqtype)
1086 {
1087         if (hdev->ll_driver->idle)
1088                 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1089
1090         return 0;
1091 }
1092
1093 /**
1094  * hid_hw_wait - wait for buffered io to complete
1095  *
1096  * @hdev: hid device
1097  */
1098 static inline void hid_hw_wait(struct hid_device *hdev)
1099 {
1100         if (hdev->ll_driver->wait)
1101                 hdev->ll_driver->wait(hdev);
1102 }
1103
1104 /**
1105  * hid_report_len - calculate the report length
1106  *
1107  * @report: the report we want to know the length
1108  */
1109 static inline u32 hid_report_len(struct hid_report *report)
1110 {
1111         /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1112         return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1113 }
1114
1115 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1116                 int interrupt);
1117
1118 /* HID quirks API */
1119 unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1120 int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1121 void hid_quirks_exit(__u16 bus);
1122
1123 #ifdef CONFIG_HID_PID
1124 int hid_pidff_init(struct hid_device *hid);
1125 #else
1126 #define hid_pidff_init NULL
1127 #endif
1128
1129 #define dbg_hid(format, arg...)                                         \
1130 do {                                                                    \
1131         if (hid_debug)                                                  \
1132                 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);      \
1133 } while (0)
1134
1135 #define hid_printk(level, hid, fmt, arg...)             \
1136         dev_printk(level, &(hid)->dev, fmt, ##arg)
1137 #define hid_emerg(hid, fmt, arg...)                     \
1138         dev_emerg(&(hid)->dev, fmt, ##arg)
1139 #define hid_crit(hid, fmt, arg...)                      \
1140         dev_crit(&(hid)->dev, fmt, ##arg)
1141 #define hid_alert(hid, fmt, arg...)                     \
1142         dev_alert(&(hid)->dev, fmt, ##arg)
1143 #define hid_err(hid, fmt, arg...)                       \
1144         dev_err(&(hid)->dev, fmt, ##arg)
1145 #define hid_notice(hid, fmt, arg...)                    \
1146         dev_notice(&(hid)->dev, fmt, ##arg)
1147 #define hid_warn(hid, fmt, arg...)                      \
1148         dev_warn(&(hid)->dev, fmt, ##arg)
1149 #define hid_info(hid, fmt, arg...)                      \
1150         dev_info(&(hid)->dev, fmt, ##arg)
1151 #define hid_dbg(hid, fmt, arg...)                       \
1152         dev_dbg(&(hid)->dev, fmt, ##arg)
1153
1154 #endif