blob: f17980de26629fbf65365047a0cfe8ce6034b53e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (c) 1999 Andreas Gal
3 * Copyright (c) 2000-2001 Vojtech Pavlik
Jiri Kosinab55fd232007-02-21 19:27:49 +01004 * Copyright (c) 2006-2007 Jiri Kosina
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07006/*
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 */
David Howells607ca462012-10-13 10:46:48 +010025#ifndef __HID_H
26#define __HID_H
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Jiri Kosina57d292b2007-10-15 15:17:41 +020028
29#include <linux/types.h>
30#include <linux/slab.h>
31#include <linux/list.h>
Jiri Slabye8c84f92008-05-19 15:50:01 +020032#include <linux/mod_devicetable.h> /* hid_device_id */
Jiri Kosina57d292b2007-10-15 15:17:41 +020033#include <linux/timer.h>
34#include <linux/workqueue.h>
35#include <linux/input.h>
David Herrmann4ea54542011-08-10 14:02:07 +020036#include <linux/semaphore.h>
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -080037#include <linux/power_supply.h>
David Howells607ca462012-10-13 10:46:48 +010038#include <uapi/linux/hid.h>
Jiri Kosina57d292b2007-10-15 15:17:41 +020039
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/*
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
46struct 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
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500101#define HID_MAIN_ITEM_WRAP 0x008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#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
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500155#define HID_UP_GENDESK 0x00010000
Vojtech Pavlik0aebfda2005-09-05 00:07:59 -0500156#define HID_UP_SIMULATION 0x00020000
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800157#define HID_UP_GENDEVCTRLS 0x00060000
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500158#define HID_UP_KEYBOARD 0x00070000
159#define HID_UP_LED 0x00080000
160#define HID_UP_BUTTON 0x00090000
161#define HID_UP_ORDINAL 0x000a0000
Dmitry Torokhovf3dddf22015-03-04 14:10:26 -0800162#define HID_UP_TELEPHONY 0x000b0000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163#define HID_UP_CONSUMER 0x000c0000
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500164#define HID_UP_DIGITIZER 0x000d0000
165#define HID_UP_PID 0x000f0000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166#define HID_UP_HPVENDOR 0xff7f0000
Keng-Yu Lin929578a2012-07-06 18:06:11 +0800167#define HID_UP_HPVENDOR2 0xff010000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168#define HID_UP_MSVENDOR 0xff000000
Stelian Pope875ce32005-09-05 01:57:33 -0500169#define HID_UP_CUSTOM 0x00ff0000
170#define HID_UP_LOGIVENDOR 0xffbc0000
Jamie Lentinf3d4ff02014-07-23 23:30:48 +0100171#define HID_UP_LNVENDOR 0xffa00000
Alexander Holler83499b52012-12-09 12:44:30 +0100172#define HID_UP_SENSOR 0x00200000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174#define HID_USAGE 0x0000ffff
175
176#define HID_GD_POINTER 0x00010001
177#define HID_GD_MOUSE 0x00010002
178#define HID_GD_JOYSTICK 0x00010004
179#define HID_GD_GAMEPAD 0x00010005
180#define HID_GD_KEYBOARD 0x00010006
181#define HID_GD_KEYPAD 0x00010007
182#define HID_GD_MULTIAXIS 0x00010008
183#define HID_GD_X 0x00010030
184#define HID_GD_Y 0x00010031
185#define HID_GD_Z 0x00010032
186#define HID_GD_RX 0x00010033
187#define HID_GD_RY 0x00010034
188#define HID_GD_RZ 0x00010035
189#define HID_GD_SLIDER 0x00010036
190#define HID_GD_DIAL 0x00010037
191#define HID_GD_WHEEL 0x00010038
192#define HID_GD_HATSWITCH 0x00010039
193#define HID_GD_BUFFER 0x0001003a
194#define HID_GD_BYTECOUNT 0x0001003b
195#define HID_GD_MOTION 0x0001003c
196#define HID_GD_START 0x0001003d
197#define HID_GD_SELECT 0x0001003e
198#define HID_GD_VX 0x00010040
199#define HID_GD_VY 0x00010041
200#define HID_GD_VZ 0x00010042
201#define HID_GD_VBRX 0x00010043
202#define HID_GD_VBRY 0x00010044
203#define HID_GD_VBRZ 0x00010045
204#define HID_GD_VNO 0x00010046
205#define HID_GD_FEATURE 0x00010047
Benjamin Tissoires6aef7042014-02-28 11:41:25 -0500206#define HID_GD_SYSTEM_CONTROL 0x00010080
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207#define HID_GD_UP 0x00010090
208#define HID_GD_DOWN 0x00010091
209#define HID_GD_RIGHT 0x00010092
210#define HID_GD_LEFT 0x00010093
211
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800212#define HID_DC_BATTERYSTRENGTH 0x00060020
213
Benjamin Tissoires6aef7042014-02-28 11:41:25 -0500214#define HID_CP_CONSUMER_CONTROL 0x000c0001
215
Stephane Chatty89f536c2009-05-20 15:41:24 +0200216#define HID_DG_DIGITIZER 0x000d0001
217#define HID_DG_PEN 0x000d0002
218#define HID_DG_LIGHTPEN 0x000d0003
219#define HID_DG_TOUCHSCREEN 0x000d0004
220#define HID_DG_TOUCHPAD 0x000d0005
221#define HID_DG_STYLUS 0x000d0020
222#define HID_DG_PUCK 0x000d0021
223#define HID_DG_FINGER 0x000d0022
224#define HID_DG_TIPPRESSURE 0x000d0030
225#define HID_DG_BARRELPRESSURE 0x000d0031
226#define HID_DG_INRANGE 0x000d0032
227#define HID_DG_TOUCH 0x000d0033
228#define HID_DG_UNTOUCH 0x000d0034
229#define HID_DG_TAP 0x000d0035
230#define HID_DG_TABLETFUNCTIONKEY 0x000d0039
231#define HID_DG_PROGRAMCHANGEKEY 0x000d003a
232#define HID_DG_INVERT 0x000d003c
233#define HID_DG_TIPSWITCH 0x000d0042
234#define HID_DG_TIPSWITCH2 0x000d0043
235#define HID_DG_BARRELSWITCH 0x000d0044
236#define HID_DG_ERASER 0x000d0045
237#define HID_DG_TABLETPICK 0x000d0046
JD Cole1a3f83f2014-10-31 17:34:42 -0700238
239#define HID_CP_CONSUMERCONTROL 0x000c0001
JD Colea45c30e2014-10-31 17:44:42 -0700240#define HID_CP_NUMERICKEYPAD 0x000c0002
241#define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
242#define HID_CP_MICROPHONE 0x000c0004
243#define HID_CP_HEADPHONE 0x000c0005
244#define HID_CP_GRAPHICEQUALIZER 0x000c0006
245#define HID_CP_FUNCTIONBUTTONS 0x000c0036
246#define HID_CP_SELECTION 0x000c0080
247#define HID_CP_MEDIASELECTION 0x000c0087
248#define HID_CP_SELECTDISC 0x000c00ba
249#define HID_CP_PLAYBACKSPEED 0x000c00f1
250#define HID_CP_PROXIMITY 0x000c0109
251#define HID_CP_SPEAKERSYSTEM 0x000c0160
252#define HID_CP_CHANNELLEFT 0x000c0161
253#define HID_CP_CHANNELRIGHT 0x000c0162
254#define HID_CP_CHANNELCENTER 0x000c0163
255#define HID_CP_CHANNELFRONT 0x000c0164
256#define HID_CP_CHANNELCENTERFRONT 0x000c0165
257#define HID_CP_CHANNELSIDE 0x000c0166
258#define HID_CP_CHANNELSURROUND 0x000c0167
259#define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
260#define HID_CP_CHANNELTOP 0x000c0169
261#define HID_CP_CHANNELUNKNOWN 0x000c016a
262#define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
263#define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
JD Cole1a3f83f2014-10-31 17:34:42 -0700264
Stephane Chatty89f536c2009-05-20 15:41:24 +0200265#define HID_DG_CONFIDENCE 0x000d0047
266#define HID_DG_WIDTH 0x000d0048
267#define HID_DG_HEIGHT 0x000d0049
268#define HID_DG_CONTACTID 0x000d0051
269#define HID_DG_INPUTMODE 0x000d0052
270#define HID_DG_DEVICEINDEX 0x000d0053
271#define HID_DG_CONTACTCOUNT 0x000d0054
272#define HID_DG_CONTACTMAX 0x000d0055
Seth Forshee2c6e0272015-03-11 17:26:41 -0500273#define HID_DG_BUTTONTYPE 0x000d0059
Ping Cheng368c9662014-06-02 17:19:52 -0700274#define HID_DG_BARRELSWITCH2 0x000d005a
275#define HID_DG_TOOLSERIALNUMBER 0x000d005b
Stephane Chatty89f536c2009-05-20 15:41:24 +0200276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277/*
278 * HID report types --- Ouch! HID spec says 1 2 3!
279 */
280
281#define HID_INPUT_REPORT 0
282#define HID_OUTPUT_REPORT 1
283#define HID_FEATURE_REPORT 2
284
David Herrmann39054a52013-09-02 14:00:05 +0200285#define HID_REPORT_TYPES 3
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287/*
Jiri Slaby93c10132008-06-27 00:04:24 +0200288 * HID connect requests
289 */
290
291#define HID_CONNECT_HIDINPUT 0x01
292#define HID_CONNECT_HIDINPUT_FORCE 0x02
293#define HID_CONNECT_HIDRAW 0x04
294#define HID_CONNECT_HIDDEV 0x08
295#define HID_CONNECT_HIDDEV_FORCE 0x10
296#define HID_CONNECT_FF 0x20
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400297#define HID_CONNECT_DRIVER 0x40
Jiri Slaby93c10132008-06-27 00:04:24 +0200298#define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
299 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
300
301/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 * HID device quirks.
303 */
304
Paul Walmsley876b9272007-04-19 14:56:12 +0200305/*
306 * Increase this if you need to configure more HID quirks at module load time
307 */
308#define MAX_USBHID_BOOT_QUIRKS 4
309
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500310#define HID_QUIRK_INVERT 0x00000001
311#define HID_QUIRK_NOTOUCH 0x00000002
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100312#define HID_QUIRK_IGNORE 0x00000004
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500313#define HID_QUIRK_NOGET 0x00000008
Bastien Nocerab5e5a372010-04-16 17:19:50 +0100314#define HID_QUIRK_HIDDEV_FORCE 0x00000010
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500315#define HID_QUIRK_BADPAD 0x00000020
316#define HID_QUIRK_MULTI_INPUT 0x00000040
Daniel Mack3a343ee2010-07-12 19:28:27 +0200317#define HID_QUIRK_HIDINPUT_FORCE 0x00000080
Benjamin Tissoires4f22dec2013-03-22 18:38:28 +0100318#define HID_QUIRK_NO_EMPTY_INPUT 0x00000100
Benjamin Tissoires595e9272013-08-22 14:51:09 +0200319#define HID_QUIRK_NO_INIT_INPUT_REPORTS 0x00000200
Johan Hovold0b750b32014-09-05 18:08:47 +0200320#define HID_QUIRK_ALWAYS_POLL 0x00000400
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200321#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
Benjamin Tissoirese534a932014-03-08 22:52:42 -0500322#define HID_QUIRK_SKIP_OUTPUT_REPORT_ID 0x00020000
323#define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP 0x00040000
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100324#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
Jiri Kosina5b915d92009-11-05 14:08:03 +0100325#define HID_QUIRK_NO_INIT_REPORTS 0x20000000
Bastien Nocerab5e5a372010-04-16 17:19:50 +0100326#define HID_QUIRK_NO_IGNORE 0x40000000
Henrik Rydberg24750f32010-08-24 10:54:44 +0200327#define HID_QUIRK_NO_INPUT_SYNC 0x80000000
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200328
329/*
Henrik Rydberg734c6602012-04-23 12:07:03 +0200330 * HID device groups
Benjamin Tissoiresba391e52014-05-21 11:15:56 -0400331 *
332 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
333 * and has a value of 0x0000
Henrik Rydberg734c6602012-04-23 12:07:03 +0200334 */
335#define HID_GROUP_GENERIC 0x0001
Henrik Rydberg4fa3a582012-05-01 08:40:01 +0200336#define HID_GROUP_MULTITOUCH 0x0002
Alexander Holler83499b52012-12-09 12:44:30 +0100337#define HID_GROUP_SENSOR_HUB 0x0003
Benjamin Tissoiresf961bd32013-08-22 14:51:08 +0200338#define HID_GROUP_MULTITOUCH_WIN_8 0x0004
Henrik Rydberg734c6602012-04-23 12:07:03 +0200339
340/*
Benjamin Tissoiresba391e52014-05-21 11:15:56 -0400341 * Vendor specific HID device groups
342 */
343#define HID_GROUP_RMI 0x0100
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700344#define HID_GROUP_WACOM 0x0101
Benjamin Tissoiresd6102742014-09-30 13:18:25 -0400345#define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
Benjamin Tissoires29b47392014-07-24 12:52:23 -0700346
347/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * This is the global environment of the parser. This information is
349 * persistent for main-items. The global environment can be saved and
350 * restored with PUSH/POP statements.
351 */
352
353struct hid_global {
354 unsigned usage_page;
355 __s32 logical_minimum;
356 __s32 logical_maximum;
357 __s32 physical_minimum;
358 __s32 physical_maximum;
359 __s32 unit_exponent;
360 unsigned unit;
361 unsigned report_id;
362 unsigned report_size;
363 unsigned report_count;
364};
365
366/*
367 * This is the local environment. It is persistent up the next main-item.
368 */
369
Jiri Kosina5f1ab742008-03-14 16:53:07 +0100370#define HID_MAX_USAGES 12288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#define HID_DEFAULT_NUM_COLLECTIONS 16
372
373struct hid_local {
374 unsigned usage[HID_MAX_USAGES]; /* usage array */
375 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
376 unsigned usage_index;
377 unsigned usage_minimum;
378 unsigned delimiter_depth;
379 unsigned delimiter_branch;
380};
381
382/*
383 * This is the collection stack. We climb up the stack to determine
384 * application and function of each field.
385 */
386
387struct hid_collection {
388 unsigned type;
389 unsigned usage;
390 unsigned level;
391};
392
393struct hid_usage {
394 unsigned hid; /* hid usage code */
395 unsigned collection_index; /* index into collection array */
Benjamin Tissoiresf262d1f2012-11-14 16:59:16 +0100396 unsigned usage_index; /* index into usage array */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 /* hidinput data */
398 __u16 code; /* input driver code */
399 __u8 type; /* input driver type */
400 __s8 hat_min; /* hat switch fun */
401 __s8 hat_max; /* ditto */
402 __s8 hat_dir; /* ditto */
403};
404
405struct hid_input;
406
407struct hid_field {
408 unsigned physical; /* physical usage for this field */
409 unsigned logical; /* logical usage for this field */
410 unsigned application; /* application usage for this field */
411 struct hid_usage *usage; /* usage table for this function */
412 unsigned maxusage; /* maximum usage index */
413 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
414 unsigned report_offset; /* bit offset in the report */
415 unsigned report_size; /* size of this field in the report */
416 unsigned report_count; /* number of this field in the report */
417 unsigned report_type; /* (input,output,feature) */
418 __s32 *value; /* last known value(s) */
419 __s32 logical_minimum;
420 __s32 logical_maximum;
421 __s32 physical_minimum;
422 __s32 physical_maximum;
423 __s32 unit_exponent;
424 unsigned unit;
425 struct hid_report *report; /* associated report */
426 unsigned index; /* index into report->field[] */
427 /* hidinput data */
428 struct hid_input *hidinput; /* associated input structure */
429 __u16 dpad; /* dpad input code */
430};
431
Henrik Rydberg7e55bde2012-09-03 12:28:59 +0200432#define HID_MAX_FIELDS 256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434struct hid_report {
435 struct list_head list;
436 unsigned id; /* id of this report */
437 unsigned type; /* report type */
438 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
439 unsigned maxfield; /* maximum valid field index */
440 unsigned size; /* size of the report (bits) */
441 struct hid_device *device; /* associated device */
442};
443
Kees Cook43622022013-08-28 22:29:55 +0200444#define HID_MAX_IDS 256
445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446struct hid_report_enum {
447 unsigned numbered;
448 struct list_head report_list;
Kees Cook43622022013-08-28 22:29:55 +0200449 struct hid_report *report_id_hash[HID_MAX_IDS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450};
451
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500452#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
453#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
455#define HID_OUTPUT_FIFO_SIZE 64
456
457struct hid_control_fifo {
458 unsigned char dir;
459 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200460 char *raw_report;
461};
462
463struct hid_output_fifo {
464 struct hid_report *report;
465 char *raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466};
467
468#define HID_CLAIMED_INPUT 1
469#define HID_CLAIMED_HIDDEV 2
Jiri Kosina86166b72007-05-14 09:57:40 +0200470#define HID_CLAIMED_HIDRAW 4
Benjamin Tissoires7704ac92014-09-23 12:08:08 -0400471#define HID_CLAIMED_DRIVER 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200473#define HID_STAT_ADDED 1
Jiri Slabyc500c972008-05-16 11:49:16 +0200474#define HID_STAT_PARSED 2
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476struct hid_input {
477 struct list_head list;
478 struct hid_report *report;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500479 struct input_dev *input;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480};
481
Jiri Slabya73a6372008-10-22 14:45:11 +0200482enum hid_type {
483 HID_TYPE_OTHER = 0,
Tomoki Sekiyama6dc14182011-05-23 15:45:44 -0700484 HID_TYPE_USBMOUSE,
485 HID_TYPE_USBNONE
Jiri Slabya73a6372008-10-22 14:45:11 +0200486};
487
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200488struct hid_driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200489struct hid_ll_driver;
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491struct hid_device { /* device report descriptor */
Henrik Rydberga7197c2e2012-04-22 14:21:40 +0200492 __u8 *dev_rdesc;
493 unsigned dev_rsize;
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200494 __u8 *rdesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 unsigned rsize;
496 struct hid_collection *collection; /* List of HID collections */
497 unsigned collection_size; /* Number of allocated hid_collections */
498 unsigned maxcollection; /* Number of parsed collections */
499 unsigned maxapplication; /* Number of applications */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200500 __u16 bus; /* BUS ID */
Henrik Rydberg4d53b802012-04-23 12:07:02 +0200501 __u16 group; /* Report group */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200502 __u32 vendor; /* Vendor ID */
503 __u32 product; /* Product ID */
504 __u32 version; /* HID version */
Jiri Slabya73a6372008-10-22 14:45:11 +0200505 enum hid_type type; /* device type (mouse, kbd, ...) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 unsigned country; /* HID country */
507 struct hid_report_enum report_enum[HID_REPORT_TYPES];
David Herrmann50c9d752013-07-15 19:10:12 +0200508 struct work_struct led_work; /* delayed LED worker */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Andrew de los Reyesc849a612013-02-18 09:20:21 -0800510 struct semaphore driver_lock; /* protects the current driver, except during input */
511 struct semaphore driver_input_lock; /* protects the current driver */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200512 struct device dev; /* device */
513 struct hid_driver *driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200514 struct hid_ll_driver *ll_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800516#ifdef CONFIG_HID_BATTERY_STRENGTH
517 /*
518 * Power supply information for HID devices which report
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100519 * battery strength. power_supply was successfully registered if
520 * battery is non-NULL.
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800521 */
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100522 struct power_supply *battery;
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800523 __s32 battery_min;
524 __s32 battery_max;
Jeremy Fitzhardingefb8ac91b2011-12-02 11:18:45 -0800525 __s32 battery_report_type;
Daniel Nicolettic5a92aa2011-12-02 03:52:22 -0200526 __s32 battery_report_id;
Jeremy Fitzhardinge4f5ca832011-11-23 00:49:14 -0800527#endif
528
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200529 unsigned int status; /* see STAT flags above */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500530 unsigned claimed; /* Claimed by hidinput, hiddev? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 unsigned quirks; /* Various quirks the device can pull on us */
Andrew de los Reyesc849a612013-02-18 09:20:21 -0800532 bool io_started; /* Protected by driver_lock. If IO has started */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534 struct list_head inputs; /* The list of inputs */
535 void *hiddev; /* The hiddev structure */
Jiri Kosina86166b72007-05-14 09:57:40 +0200536 void *hidraw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 int minor; /* Hiddev minor number */
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 int open; /* is the device open by anyone? */
540 char name[128]; /* Device name */
541 char phys[64]; /* Device physical location */
542 char uniq[64]; /* Device unique identifier (serial #) */
543
Jiri Kosina229695e2006-12-08 18:40:53 +0100544 void *driver_data;
545
Jiri Slaby93c10132008-06-27 00:04:24 +0200546 /* temporary hid_ff handling (until moved to the drivers) */
547 int (*ff_init)(struct hid_device *);
548
Jiri Kosinaaa938f72006-12-08 18:41:10 +0100549 /* hiddev event handler */
Jiri Slaby93c10132008-06-27 00:04:24 +0200550 int (*hiddev_connect)(struct hid_device *, unsigned int);
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200551 void (*hiddev_disconnect)(struct hid_device *);
Jiri Kosinaaa938f72006-12-08 18:41:10 +0100552 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
553 struct hid_usage *, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100554 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
Jiri Kosina86166b72007-05-14 09:57:40 +0200555
Jiri Kosinacd667ce2009-06-12 15:20:57 +0200556 /* debugging support via debugfs */
557 unsigned short debug;
558 struct dentry *debug_dir;
559 struct dentry *debug_rdesc;
560 struct dentry *debug_events;
561 struct list_head debug_list;
Jiri Kosina1deb9d32013-05-06 13:05:50 +0200562 spinlock_t debug_list_lock;
Jiri Kosinacd667ce2009-06-12 15:20:57 +0200563 wait_queue_head_t debug_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564};
565
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200566static inline void *hid_get_drvdata(struct hid_device *hdev)
567{
568 return dev_get_drvdata(&hdev->dev);
569}
570
571static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
572{
573 dev_set_drvdata(&hdev->dev, data);
574}
575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576#define HID_GLOBAL_STACK_SIZE 4
577#define HID_COLLECTION_STACK_SIZE 4
578
Andrew Duggane39f2d52014-12-12 10:17:26 -0800579#define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
580#define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
581#define HID_SCAN_FLAG_GD_POINTER BIT(2)
Benjamin Tissoiresf961bd32013-08-22 14:51:08 +0200582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583struct hid_parser {
584 struct hid_global global;
585 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
586 unsigned global_stack_ptr;
587 struct hid_local local;
588 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
589 unsigned collection_stack_ptr;
590 struct hid_device *device;
Benjamin Tissoiresf961bd32013-08-22 14:51:08 +0200591 unsigned scan_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592};
593
594struct hid_class_descriptor {
595 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100596 __le16 wDescriptorLength;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597} __attribute__ ((packed));
598
599struct hid_descriptor {
600 __u8 bLength;
601 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100602 __le16 bcdHID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 __u8 bCountryCode;
604 __u8 bNumDescriptors;
605
606 struct hid_class_descriptor desc[1];
607} __attribute__ ((packed));
608
Henrik Rydberg070748e2012-04-23 12:07:05 +0200609#define HID_DEVICE(b, g, ven, prod) \
610 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
611#define HID_USB_DEVICE(ven, prod) \
612 .bus = BUS_USB, .vendor = (ven), .product = (prod)
613#define HID_BLUETOOTH_DEVICE(ven, prod) \
614 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
Benjamin Tissoires9fb6bf02014-04-07 13:39:33 -0400615#define HID_I2C_DEVICE(ven, prod) \
616 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200617
618#define HID_REPORT_ID(rep) \
619 .report_type = (rep)
620#define HID_USAGE_ID(uhid, utype, ucode) \
621 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
622/* we don't want to catch types and codes equal to 0 */
623#define HID_TERMINATOR (HID_ANY_ID - 1)
624
625struct hid_report_id {
626 __u32 report_type;
627};
628struct hid_usage_id {
629 __u32 usage_hid;
630 __u32 usage_type;
631 __u32 usage_code;
632};
633
634/**
635 * struct hid_driver
636 * @name: driver name (e.g. "Footech_bar-wheel")
637 * @id_table: which devices is this driver for (must be non-NULL for probe
638 * to be called)
Jiri Slaby3a6f82f2008-11-24 16:20:09 +0100639 * @dyn_list: list of dynamically added device ids
640 * @dyn_lock: lock protecting @dyn_list
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200641 * @probe: new device inserted
642 * @remove: device removed (NULL if not a hot-plug capable driver)
643 * @report_table: on which reports to call raw_event (NULL means all)
644 * @raw_event: if report in report_table, this hook is called (NULL means nop)
645 * @usage_table: on which events to call event (NULL means all)
646 * @event: if usage in usage_table, this hook is called (NULL means nop)
Benjamin Tissoires6d85d032013-01-31 17:22:23 +0100647 * @report: this hook is called after parsing a report (NULL means nop)
Jiri Slabyc500c972008-05-16 11:49:16 +0200648 * @report_fixup: called before report descriptor parsing (NULL means nop)
649 * @input_mapping: invoked on input registering before mapping an usage
650 * @input_mapped: invoked on input registering after mapping an usage
Henrik Rydberg9ebf3d72012-07-30 13:28:18 +0200651 * @input_configured: invoked just before the device is registered
Benjamin Tissoires0d2689c2011-01-07 23:44:32 +0100652 * @feature_mapping: invoked on feature registering
Bruno Prémont6a740aa2010-04-25 21:40:03 +0200653 * @suspend: invoked on suspend (NULL means nop)
654 * @resume: invoked on resume if device was not reset (NULL means nop)
655 * @reset_resume: invoked on resume if device was reset (NULL means nop)
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200656 *
Andrew de los Reyesc849a612013-02-18 09:20:21 -0800657 * probe should return -errno on error, or 0 on success. During probe,
658 * input will not be passed to raw_event unless hid_device_io_start is
659 * called.
660 *
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200661 * raw_event and event should return 0 on no action performed, 1 when no
662 * further processing should be done and negative on error
Jiri Slabyc500c972008-05-16 11:49:16 +0200663 *
664 * input_mapping shall return a negative value to completely ignore this usage
665 * (e.g. doubled or invalid usage), zero to continue with parsing of this
666 * usage by generic code (no special handling needed) or positive to skip
667 * generic parsing (needed special handling which was done in the hook already)
668 * input_mapped shall return negative to inform the layer that this usage
669 * should not be considered for further processing or zero to notify that
670 * no processing was performed and should be done in a generic manner
671 * Both these functions may be NULL which means the same behavior as returning
672 * zero from them.
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200673 */
674struct hid_driver {
675 char *name;
676 const struct hid_device_id *id_table;
677
Jiri Slaby3a6f82f2008-11-24 16:20:09 +0100678 struct list_head dyn_list;
679 spinlock_t dyn_lock;
680
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200681 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
682 void (*remove)(struct hid_device *dev);
683
684 const struct hid_report_id *report_table;
685 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
686 u8 *data, int size);
687 const struct hid_usage_id *usage_table;
688 int (*event)(struct hid_device *hdev, struct hid_field *field,
689 struct hid_usage *usage, __s32 value);
Benjamin Tissoires6d85d032013-01-31 17:22:23 +0100690 void (*report)(struct hid_device *hdev, struct hid_report *report);
Jiri Slabyc500c972008-05-16 11:49:16 +0200691
Nikolai Kondrashov73e40082010-08-06 23:03:06 +0400692 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
693 unsigned int *size);
Jiri Slabyc500c972008-05-16 11:49:16 +0200694
695 int (*input_mapping)(struct hid_device *hdev,
696 struct hid_input *hidinput, struct hid_field *field,
697 struct hid_usage *usage, unsigned long **bit, int *max);
698 int (*input_mapped)(struct hid_device *hdev,
699 struct hid_input *hidinput, struct hid_field *field,
700 struct hid_usage *usage, unsigned long **bit, int *max);
Henrik Rydberg9ebf3d72012-07-30 13:28:18 +0200701 void (*input_configured)(struct hid_device *hdev,
702 struct hid_input *hidinput);
Benjamin Tissoires0d2689c2011-01-07 23:44:32 +0100703 void (*feature_mapping)(struct hid_device *hdev,
Henrik Rydbergf635bd12011-02-24 19:30:59 +0100704 struct hid_field *field,
Benjamin Tissoires0d2689c2011-01-07 23:44:32 +0100705 struct hid_usage *usage);
Bruno Prémont6a740aa2010-04-25 21:40:03 +0200706#ifdef CONFIG_PM
707 int (*suspend)(struct hid_device *hdev, pm_message_t message);
708 int (*resume)(struct hid_device *hdev);
709 int (*reset_resume)(struct hid_device *hdev);
710#endif
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200711/* private: */
712 struct device_driver driver;
713};
714
Jiri Slabyc500c972008-05-16 11:49:16 +0200715/**
716 * hid_ll_driver - low level driver callbacks
717 * @start: called on probe to start the device
718 * @stop: called on remove
719 * @open: called by input layer on open
720 * @close: called by input layer on close
Jiri Slabyc500c972008-05-16 11:49:16 +0200721 * @parse: this method is called only once to parse the device data,
722 * shouldn't allocate anything to not leak memory
Henrik Rydberge90a6df2013-02-25 11:31:43 +0100723 * @request: send report request to device (e.g. feature report)
Henrik Rydberg33734432013-02-25 11:31:44 +0100724 * @wait: wait for buffered io to complete (send/recv reports)
Benjamin Tissoiresb69d6532014-02-05 16:33:16 -0500725 * @raw_request: send raw report request to device (e.g. feature report)
726 * @output_report: send output report to device
Benjamin Tissoires96848192013-02-27 16:38:17 +0100727 * @idle: send idle request to device
Jiri Slabyc500c972008-05-16 11:49:16 +0200728 */
729struct hid_ll_driver {
730 int (*start)(struct hid_device *hdev);
731 void (*stop)(struct hid_device *hdev);
732
733 int (*open)(struct hid_device *hdev);
734 void (*close)(struct hid_device *hdev);
735
Oliver Neukum0361a282008-12-17 15:38:03 +0100736 int (*power)(struct hid_device *hdev, int level);
737
Jiri Slabyc500c972008-05-16 11:49:16 +0200738 int (*parse)(struct hid_device *hdev);
Henrik Rydberge90a6df2013-02-25 11:31:43 +0100739
740 void (*request)(struct hid_device *hdev,
741 struct hid_report *report, int reqtype);
742
Henrik Rydberg33734432013-02-25 11:31:44 +0100743 int (*wait)(struct hid_device *hdev);
744
Frank Praznikcd4dc082014-01-22 13:49:41 -0500745 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
746 __u8 *buf, size_t len, unsigned char rtype,
747 int reqtype);
748
749 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
750
751 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
Jiri Slabyc500c972008-05-16 11:49:16 +0200752};
753
Oliver Neukum0361a282008-12-17 15:38:03 +0100754#define PM_HINT_FULLON 1<<5
755#define PM_HINT_NORMAL 1<<1
756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
758/* We ignore a few input applications that are not widely used */
Stephane Chatty8b0e58a2010-01-13 21:52:34 +0100759#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
Jiri Kosina229695e2006-12-08 18:40:53 +0100760
761/* HID core API */
Jiri Kosina58037eb2007-05-30 15:07:13 +0200762
Jiri Kosina58037eb2007-05-30 15:07:13 +0200763extern int hid_debug;
Jiri Kosina58037eb2007-05-30 15:07:13 +0200764
Lamarque V. Souza4529eef2012-12-06 12:39:55 -0200765extern bool hid_ignore(struct hid_device *);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200766extern int hid_add_device(struct hid_device *);
767extern void hid_destroy_device(struct hid_device *);
768
769extern int __must_check __hid_register_driver(struct hid_driver *,
770 struct module *, const char *mod_name);
Paul Gortmakereb5589a2011-05-27 09:02:11 -0400771
772/* use a define to avoid include chaining to get THIS_MODULE & friends */
773#define hid_register_driver(driver) \
774 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
775
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200776extern void hid_unregister_driver(struct hid_driver *);
777
H Hartley Sweeten4d02c582012-12-17 15:26:55 -0700778/**
779 * module_hid_driver() - Helper macro for registering a HID driver
780 * @__hid_driver: hid_driver struct
781 *
782 * Helper macro for HID drivers which do not do anything special in module
783 * init/exit. This eliminates a lot of boilerplate. Each module may only
784 * use this macro once, and calling it replaces module_init() and module_exit()
785 */
786#define module_hid_driver(__hid_driver) \
787 module_driver(__hid_driver, hid_register_driver, \
788 hid_unregister_driver)
789
David Howells7d12e782006-10-05 14:55:46 +0100790extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
Jiri Slaby93c10132008-06-27 00:04:24 +0200792extern int hidinput_connect(struct hid_device *hid, unsigned int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793extern void hidinput_disconnect(struct hid_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795int hid_set_field(struct hid_field *, unsigned, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100796int hid_input_report(struct hid_device *, int type, u8 *, int, int);
Jiri Kosinadde58452006-12-08 18:40:44 +0100797int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
Daniel Kurtz4371ea82011-11-17 19:23:50 +0800798struct hid_field *hidinput_get_led_field(struct hid_device *hid);
799unsigned int hidinput_count_leds(struct hid_device *hid);
Benjamin Tissoires37cf6e62012-11-14 16:59:13 +0100800__s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
Jiri Kosinadde58452006-12-08 18:40:44 +0100801void hid_output_report(struct hid_report *report, __u8 *data);
Benjamin Tissoires4fa5a7f2014-02-10 12:58:48 -0500802void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
Jiri Kosina27ce4052013-07-10 19:56:27 +0200803u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200804struct hid_device *hid_allocate_device(void);
Michael Poole90a006a2010-01-24 22:32:29 -0500805struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200806int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
Kees Cook331415f2013-09-11 21:56:50 +0200807struct hid_report *hid_validate_values(struct hid_device *hid,
808 unsigned int type, unsigned int id,
809 unsigned int field_index,
810 unsigned int report_counts);
Henrik Rydberga7197c2e2012-04-22 14:21:40 +0200811int hid_open_report(struct hid_device *device);
Oliver Neukum0361a282008-12-17 15:38:03 +0100812int hid_check_keys_pressed(struct hid_device *hid);
Jiri Slaby93c10132008-06-27 00:04:24 +0200813int hid_connect(struct hid_device *hid, unsigned int connect_mask);
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200814void hid_disconnect(struct hid_device *hid);
Jeremy Fitzhardingebbc21cf2011-12-02 11:12:36 -0800815const struct hid_device_id *hid_match_id(struct hid_device *hdev,
816 const struct hid_device_id *id);
Benjamin Tissoires77463832012-11-14 16:59:15 +0100817s32 hid_snto32(__u32 value, unsigned n);
Goffredo Baroncelli04fba782015-05-30 11:00:26 +0200818__u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
819 unsigned offset, unsigned n);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200820
Jiri Slabyc500c972008-05-16 11:49:16 +0200821/**
Andrew de los Reyesc849a612013-02-18 09:20:21 -0800822 * hid_device_io_start - enable HID input during probe, remove
823 *
824 * @hid - the device
825 *
826 * This should only be called during probe or remove and only be
827 * called by the thread calling probe or remove. It will allow
828 * incoming packets to be delivered to the driver.
829 */
830static inline void hid_device_io_start(struct hid_device *hid) {
831 if (hid->io_started) {
832 dev_warn(&hid->dev, "io already started");
833 return;
834 }
835 hid->io_started = true;
836 up(&hid->driver_input_lock);
837}
838
839/**
840 * hid_device_io_stop - disable HID input during probe, remove
841 *
842 * @hid - the device
843 *
844 * Should only be called after hid_device_io_start. It will prevent
845 * incoming packets from going to the driver for the duration of
846 * probe, remove. If called during probe, packets will still go to the
847 * driver after probe is complete. This function should only be called
848 * by the thread calling probe or remove.
849 */
850static inline void hid_device_io_stop(struct hid_device *hid) {
851 if (!hid->io_started) {
852 dev_warn(&hid->dev, "io already stopped");
853 return;
854 }
855 hid->io_started = false;
856 down(&hid->driver_input_lock);
857}
858
859/**
Jiri Slaby022e8c42008-05-16 11:49:18 +0200860 * hid_map_usage - map usage input bits
861 *
862 * @hidinput: hidinput which we are interested in
863 * @usage: usage to fill in
864 * @bit: pointer to input->{}bit (out parameter)
865 * @max: maximal valid usage->code to consider later (out parameter)
866 * @type: input event type (EV_KEY, EV_REL, ...)
867 * @c: code which corresponds to this usage and type
868 */
869static inline void hid_map_usage(struct hid_input *hidinput,
870 struct hid_usage *usage, unsigned long **bit, int *max,
871 __u8 type, __u16 c)
872{
873 struct input_dev *input = hidinput->input;
874
875 usage->type = type;
876 usage->code = c;
877
878 switch (type) {
879 case EV_ABS:
880 *bit = input->absbit;
881 *max = ABS_MAX;
882 break;
883 case EV_REL:
884 *bit = input->relbit;
885 *max = REL_MAX;
886 break;
887 case EV_KEY:
888 *bit = input->keybit;
889 *max = KEY_MAX;
890 break;
891 case EV_LED:
892 *bit = input->ledbit;
893 *max = LED_MAX;
894 break;
895 }
896}
897
898/**
899 * hid_map_usage_clear - map usage input bits and clear the input bit
900 *
901 * The same as hid_map_usage, except the @c bit is also cleared in supported
902 * bits (@bit).
903 */
904static inline void hid_map_usage_clear(struct hid_input *hidinput,
905 struct hid_usage *usage, unsigned long **bit, int *max,
906 __u8 type, __u16 c)
907{
908 hid_map_usage(hidinput, usage, bit, max, type, c);
909 clear_bit(c, *bit);
910}
911
912/**
Jiri Slabyc500c972008-05-16 11:49:16 +0200913 * hid_parse - parse HW reports
914 *
915 * @hdev: hid device
916 *
917 * Call this from probe after you set up the device (if needed). Your
918 * report_fixup will be called (if non-NULL) after reading raw report from
919 * device before passing it to hid layer for real parsing.
920 */
921static inline int __must_check hid_parse(struct hid_device *hdev)
922{
Henrik Rydberga7197c2e2012-04-22 14:21:40 +0200923 return hid_open_report(hdev);
Jiri Slabyc500c972008-05-16 11:49:16 +0200924}
925
926/**
927 * hid_hw_start - start underlaying HW
928 *
929 * @hdev: hid device
Jiri Slaby93c10132008-06-27 00:04:24 +0200930 * @connect_mask: which outputs to connect, see HID_CONNECT_*
Jiri Slabyc500c972008-05-16 11:49:16 +0200931 *
932 * Call this in probe function *after* hid_parse. This will setup HW buffers
933 * and start the device (if not deffered to device open). hid_hw_stop must be
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300934 * called if this was successful.
Jiri Slabyc500c972008-05-16 11:49:16 +0200935 */
Jiri Slaby93c10132008-06-27 00:04:24 +0200936static inline int __must_check hid_hw_start(struct hid_device *hdev,
937 unsigned int connect_mask)
Jiri Slabyc500c972008-05-16 11:49:16 +0200938{
Jiri Slaby93c10132008-06-27 00:04:24 +0200939 int ret = hdev->ll_driver->start(hdev);
940 if (ret || !connect_mask)
941 return ret;
942 ret = hid_connect(hdev, connect_mask);
943 if (ret)
944 hdev->ll_driver->stop(hdev);
945 return ret;
Jiri Slabyc500c972008-05-16 11:49:16 +0200946}
947
948/**
949 * hid_hw_stop - stop underlaying HW
950 *
951 * @hdev: hid device
952 *
953 * This is usually called from remove function or from probe when something
954 * failed and hid_hw_start was called already.
955 */
956static inline void hid_hw_stop(struct hid_device *hdev)
957{
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200958 hid_disconnect(hdev);
Jiri Slabyc500c972008-05-16 11:49:16 +0200959 hdev->ll_driver->stop(hdev);
960}
961
Dmitry Torokhov5bea7662010-12-07 23:02:48 -0800962/**
963 * hid_hw_open - signal underlaying HW to start delivering events
964 *
965 * @hdev: hid device
966 *
967 * Tell underlying HW to start delivering events from the device.
968 * This function should be called sometime after successful call
969 * to hid_hiw_start().
970 */
971static inline int __must_check hid_hw_open(struct hid_device *hdev)
972{
973 return hdev->ll_driver->open(hdev);
974}
975
976/**
977 * hid_hw_close - signal underlaying HW to stop delivering events
978 *
979 * @hdev: hid device
980 *
981 * This function indicates that we are not interested in the events
982 * from this device anymore. Delivery of events may or may not stop,
983 * depending on the number of users still outstanding.
984 */
985static inline void hid_hw_close(struct hid_device *hdev)
986{
987 hdev->ll_driver->close(hdev);
988}
989
990/**
991 * hid_hw_power - requests underlying HW to go into given power mode
992 *
993 * @hdev: hid device
994 * @level: requested power level (one of %PM_HINT_* defines)
995 *
996 * This function requests underlying hardware to enter requested power
997 * mode.
998 */
999
1000static inline int hid_hw_power(struct hid_device *hdev, int level)
1001{
1002 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1003}
1004
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001005
1006/**
1007 * hid_hw_request - send report request to device
1008 *
1009 * @hdev: hid device
1010 * @report: report to send
1011 * @reqtype: hid request type
1012 */
1013static inline void hid_hw_request(struct hid_device *hdev,
1014 struct hid_report *report, int reqtype)
1015{
1016 if (hdev->ll_driver->request)
Benjamin Tissoires4fa5a7f2014-02-10 12:58:48 -05001017 return hdev->ll_driver->request(hdev, report, reqtype);
1018
1019 __hid_request(hdev, report, reqtype);
Henrik Rydberge90a6df2013-02-25 11:31:43 +01001020}
1021
Henrik Rydberg33734432013-02-25 11:31:44 +01001022/**
Benjamin Tissoiresb69d6532014-02-05 16:33:16 -05001023 * hid_hw_raw_request - send report request to device
1024 *
1025 * @hdev: hid device
1026 * @reportnum: report ID
1027 * @buf: in/out data to transfer
1028 * @len: length of buf
1029 * @rtype: HID report type
1030 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1031 *
1032 * @return: count of data transfered, negative if error
1033 *
1034 * Same behavior as hid_hw_request, but with raw buffers instead.
1035 */
1036static inline int hid_hw_raw_request(struct hid_device *hdev,
1037 unsigned char reportnum, __u8 *buf,
1038 size_t len, unsigned char rtype, int reqtype)
1039{
Benjamin Tissoires53182512014-02-10 12:58:59 -05001040 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1041 return -EINVAL;
1042
Benjamin Tissoires3c867262014-02-20 15:24:49 -05001043 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
Benjamin Tissoiresb69d6532014-02-05 16:33:16 -05001044 rtype, reqtype);
Benjamin Tissoiresb69d6532014-02-05 16:33:16 -05001045}
1046
1047/**
1048 * hid_hw_output_report - send output report to device
1049 *
1050 * @hdev: hid device
1051 * @buf: raw data to transfer
1052 * @len: length of buf
1053 *
1054 * @return: count of data transfered, negative if error
1055 */
1056static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1057 size_t len)
1058{
Benjamin Tissoires53182512014-02-10 12:58:59 -05001059 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1060 return -EINVAL;
1061
Benjamin Tissoiresb69d6532014-02-05 16:33:16 -05001062 if (hdev->ll_driver->output_report)
1063 return hdev->ll_driver->output_report(hdev, buf, len);
1064
1065 return -ENOSYS;
1066}
1067
1068/**
Benjamin Tissoires96848192013-02-27 16:38:17 +01001069 * hid_hw_idle - send idle request to device
1070 *
1071 * @hdev: hid device
1072 * @report: report to control
1073 * @idle: idle state
1074 * @reqtype: hid request type
1075 */
1076static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1077 int reqtype)
1078{
1079 if (hdev->ll_driver->idle)
1080 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1081
1082 return 0;
1083}
1084
1085/**
Henrik Rydberg33734432013-02-25 11:31:44 +01001086 * hid_hw_wait - wait for buffered io to complete
1087 *
1088 * @hdev: hid device
1089 */
1090static inline void hid_hw_wait(struct hid_device *hdev)
1091{
1092 if (hdev->ll_driver->wait)
1093 hdev->ll_driver->wait(hdev);
1094}
1095
Mathieu Magnaudetdabb05c62014-11-27 16:02:36 +01001096/**
1097 * hid_report_len - calculate the report length
1098 *
1099 * @report: the report we want to know the length
1100 */
1101static inline int hid_report_len(struct hid_report *report)
1102{
1103 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1104 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1105}
1106
Jiri Kosinab6787242012-04-27 00:56:08 +02001107int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
Jiri Slaby85cdaf52008-05-16 11:49:15 +02001108 int interrupt);
1109
Paul Walmsley876b9272007-04-19 14:56:12 +02001110/* HID quirks API */
Paul Walmsley2eb5dc32007-04-19 13:27:04 +02001111u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
Paul Walmsley876b9272007-04-19 14:56:12 +02001112int usbhid_quirks_init(char **quirks_param);
1113void usbhid_quirks_exit(void);
Paul Walmsley2eb5dc32007-04-19 13:27:04 +02001114
Anssi Hannula224ee882006-07-19 01:40:47 -04001115#ifdef CONFIG_HID_PID
1116int hid_pidff_init(struct hid_device *hid);
1117#else
Jiri Slaby76483cf2008-09-18 12:23:33 +02001118#define hid_pidff_init NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119#endif
Jiri Kosina58037eb2007-05-30 15:07:13 +02001120
Joe Perches4291ee32010-12-09 19:29:03 -08001121#define dbg_hid(format, arg...) \
1122do { \
1123 if (hid_debug) \
1124 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \
1125} while (0)
1126
1127#define hid_printk(level, hid, fmt, arg...) \
1128 dev_printk(level, &(hid)->dev, fmt, ##arg)
1129#define hid_emerg(hid, fmt, arg...) \
1130 dev_emerg(&(hid)->dev, fmt, ##arg)
1131#define hid_crit(hid, fmt, arg...) \
1132 dev_crit(&(hid)->dev, fmt, ##arg)
1133#define hid_alert(hid, fmt, arg...) \
1134 dev_alert(&(hid)->dev, fmt, ##arg)
1135#define hid_err(hid, fmt, arg...) \
1136 dev_err(&(hid)->dev, fmt, ##arg)
1137#define hid_notice(hid, fmt, arg...) \
1138 dev_notice(&(hid)->dev, fmt, ##arg)
1139#define hid_warn(hid, fmt, arg...) \
1140 dev_warn(&(hid)->dev, fmt, ##arg)
1141#define hid_info(hid, fmt, arg...) \
1142 dev_info(&(hid)->dev, fmt, ##arg)
1143#define hid_dbg(hid, fmt, arg...) \
1144 dev_dbg(&(hid)->dev, fmt, ##arg)
1145
Jiri Kosina57d292b2007-10-15 15:17:41 +02001146#endif