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