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