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