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