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