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