blob: 42a0f1d1136540b5aada9f816a2289f687d01c57 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __HID_H
2#define __HID_H
3
4/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Copyright (c) 1999 Andreas Gal
6 * Copyright (c) 2000-2001 Vojtech Pavlik
Jiri Kosinab55fd232007-02-21 19:27:49 +01007 * Copyright (c) 2006-2007 Jiri Kosina
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
9
10/*
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *
25 * Should you need to contact me, the author, you can do so either by
26 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
27 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
28 */
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030/*
31 * USB HID (Human Interface Device) interface class code
32 */
33
34#define USB_INTERFACE_CLASS_HID 3
35
36/*
Alan Stern0f28b552006-05-15 14:49:04 -040037 * USB HID interface subclass and protocol codes
38 */
39
40#define USB_INTERFACE_SUBCLASS_BOOT 1
41#define USB_INTERFACE_PROTOCOL_KEYBOARD 1
42#define USB_INTERFACE_PROTOCOL_MOUSE 2
43
44/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * HID class requests
46 */
47
48#define HID_REQ_GET_REPORT 0x01
49#define HID_REQ_GET_IDLE 0x02
50#define HID_REQ_GET_PROTOCOL 0x03
51#define HID_REQ_SET_REPORT 0x09
52#define HID_REQ_SET_IDLE 0x0A
53#define HID_REQ_SET_PROTOCOL 0x0B
54
55/*
56 * HID class descriptor types
57 */
58
59#define HID_DT_HID (USB_TYPE_CLASS | 0x01)
60#define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
61#define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
62
Jiri Kosina57d292b2007-10-15 15:17:41 +020063#define HID_MAX_DESCRIPTOR_SIZE 4096
64
65#ifdef __KERNEL__
66
67#include <linux/types.h>
68#include <linux/slab.h>
69#include <linux/list.h>
Jiri Slabye8c84f92008-05-19 15:50:01 +020070#include <linux/mod_devicetable.h> /* hid_device_id */
Jiri Kosina57d292b2007-10-15 15:17:41 +020071#include <linux/timer.h>
72#include <linux/workqueue.h>
73#include <linux/input.h>
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075/*
76 * We parse each description item into this structure. Short items data
77 * values are expanded to 32-bit signed int, long items contain a pointer
78 * into the data area.
79 */
80
81struct hid_item {
82 unsigned format;
83 __u8 size;
84 __u8 type;
85 __u8 tag;
86 union {
87 __u8 u8;
88 __s8 s8;
89 __u16 u16;
90 __s16 s16;
91 __u32 u32;
92 __s32 s32;
93 __u8 *longdata;
94 } data;
95};
96
97/*
98 * HID report item format
99 */
100
101#define HID_ITEM_FORMAT_SHORT 0
102#define HID_ITEM_FORMAT_LONG 1
103
104/*
105 * Special tag indicating long items
106 */
107
108#define HID_ITEM_TAG_LONG 15
109
110/*
111 * HID report descriptor item type (prefix bit 2,3)
112 */
113
114#define HID_ITEM_TYPE_MAIN 0
115#define HID_ITEM_TYPE_GLOBAL 1
116#define HID_ITEM_TYPE_LOCAL 2
117#define HID_ITEM_TYPE_RESERVED 3
118
119/*
120 * HID report descriptor main item tags
121 */
122
123#define HID_MAIN_ITEM_TAG_INPUT 8
124#define HID_MAIN_ITEM_TAG_OUTPUT 9
125#define HID_MAIN_ITEM_TAG_FEATURE 11
126#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
127#define HID_MAIN_ITEM_TAG_END_COLLECTION 12
128
129/*
130 * HID report descriptor main item contents
131 */
132
133#define HID_MAIN_ITEM_CONSTANT 0x001
134#define HID_MAIN_ITEM_VARIABLE 0x002
135#define HID_MAIN_ITEM_RELATIVE 0x004
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500136#define HID_MAIN_ITEM_WRAP 0x008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137#define HID_MAIN_ITEM_NONLINEAR 0x010
138#define HID_MAIN_ITEM_NO_PREFERRED 0x020
139#define HID_MAIN_ITEM_NULL_STATE 0x040
140#define HID_MAIN_ITEM_VOLATILE 0x080
141#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
142
143/*
144 * HID report descriptor collection item types
145 */
146
147#define HID_COLLECTION_PHYSICAL 0
148#define HID_COLLECTION_APPLICATION 1
149#define HID_COLLECTION_LOGICAL 2
150
151/*
152 * HID report descriptor global item tags
153 */
154
155#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
156#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
157#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
158#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
159#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
160#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
161#define HID_GLOBAL_ITEM_TAG_UNIT 6
162#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
163#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
164#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
165#define HID_GLOBAL_ITEM_TAG_PUSH 10
166#define HID_GLOBAL_ITEM_TAG_POP 11
167
168/*
169 * HID report descriptor local item tags
170 */
171
172#define HID_LOCAL_ITEM_TAG_USAGE 0
173#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
174#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
175#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
176#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
177#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
178#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
179#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
180#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
181#define HID_LOCAL_ITEM_TAG_DELIMITER 10
182
183/*
184 * HID usage tables
185 */
186
187#define HID_USAGE_PAGE 0xffff0000
188
189#define HID_UP_UNDEFINED 0x00000000
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500190#define HID_UP_GENDESK 0x00010000
Vojtech Pavlik0aebfda2005-09-05 00:07:59 -0500191#define HID_UP_SIMULATION 0x00020000
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500192#define HID_UP_KEYBOARD 0x00070000
193#define HID_UP_LED 0x00080000
194#define HID_UP_BUTTON 0x00090000
195#define HID_UP_ORDINAL 0x000a0000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196#define HID_UP_CONSUMER 0x000c0000
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500197#define HID_UP_DIGITIZER 0x000d0000
198#define HID_UP_PID 0x000f0000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199#define HID_UP_HPVENDOR 0xff7f0000
200#define HID_UP_MSVENDOR 0xff000000
Stelian Pope875ce32005-09-05 01:57:33 -0500201#define HID_UP_CUSTOM 0x00ff0000
202#define HID_UP_LOGIVENDOR 0xffbc0000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204#define HID_USAGE 0x0000ffff
205
206#define HID_GD_POINTER 0x00010001
207#define HID_GD_MOUSE 0x00010002
208#define HID_GD_JOYSTICK 0x00010004
209#define HID_GD_GAMEPAD 0x00010005
210#define HID_GD_KEYBOARD 0x00010006
211#define HID_GD_KEYPAD 0x00010007
212#define HID_GD_MULTIAXIS 0x00010008
213#define HID_GD_X 0x00010030
214#define HID_GD_Y 0x00010031
215#define HID_GD_Z 0x00010032
216#define HID_GD_RX 0x00010033
217#define HID_GD_RY 0x00010034
218#define HID_GD_RZ 0x00010035
219#define HID_GD_SLIDER 0x00010036
220#define HID_GD_DIAL 0x00010037
221#define HID_GD_WHEEL 0x00010038
222#define HID_GD_HATSWITCH 0x00010039
223#define HID_GD_BUFFER 0x0001003a
224#define HID_GD_BYTECOUNT 0x0001003b
225#define HID_GD_MOTION 0x0001003c
226#define HID_GD_START 0x0001003d
227#define HID_GD_SELECT 0x0001003e
228#define HID_GD_VX 0x00010040
229#define HID_GD_VY 0x00010041
230#define HID_GD_VZ 0x00010042
231#define HID_GD_VBRX 0x00010043
232#define HID_GD_VBRY 0x00010044
233#define HID_GD_VBRZ 0x00010045
234#define HID_GD_VNO 0x00010046
235#define HID_GD_FEATURE 0x00010047
236#define HID_GD_UP 0x00010090
237#define HID_GD_DOWN 0x00010091
238#define HID_GD_RIGHT 0x00010092
239#define HID_GD_LEFT 0x00010093
240
Stephane Chatty89f536c2009-05-20 15:41:24 +0200241#define HID_DG_DIGITIZER 0x000d0001
242#define HID_DG_PEN 0x000d0002
243#define HID_DG_LIGHTPEN 0x000d0003
244#define HID_DG_TOUCHSCREEN 0x000d0004
245#define HID_DG_TOUCHPAD 0x000d0005
246#define HID_DG_STYLUS 0x000d0020
247#define HID_DG_PUCK 0x000d0021
248#define HID_DG_FINGER 0x000d0022
249#define HID_DG_TIPPRESSURE 0x000d0030
250#define HID_DG_BARRELPRESSURE 0x000d0031
251#define HID_DG_INRANGE 0x000d0032
252#define HID_DG_TOUCH 0x000d0033
253#define HID_DG_UNTOUCH 0x000d0034
254#define HID_DG_TAP 0x000d0035
255#define HID_DG_TABLETFUNCTIONKEY 0x000d0039
256#define HID_DG_PROGRAMCHANGEKEY 0x000d003a
257#define HID_DG_INVERT 0x000d003c
258#define HID_DG_TIPSWITCH 0x000d0042
259#define HID_DG_TIPSWITCH2 0x000d0043
260#define HID_DG_BARRELSWITCH 0x000d0044
261#define HID_DG_ERASER 0x000d0045
262#define HID_DG_TABLETPICK 0x000d0046
263/*
264 * as of May 20, 2009 the usages below are not yet in the official USB spec
265 * but are being pushed by Microsft as described in their paper "Digitizer
266 * Drivers for Windows Touch and Pen-Based Computers"
267 */
268#define HID_DG_CONFIDENCE 0x000d0047
269#define HID_DG_WIDTH 0x000d0048
270#define HID_DG_HEIGHT 0x000d0049
271#define HID_DG_CONTACTID 0x000d0051
272#define HID_DG_INPUTMODE 0x000d0052
273#define HID_DG_DEVICEINDEX 0x000d0053
274#define HID_DG_CONTACTCOUNT 0x000d0054
275#define HID_DG_CONTACTMAX 0x000d0055
276
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
285/*
Jiri Slaby93c10132008-06-27 00:04:24 +0200286 * HID connect requests
287 */
288
289#define HID_CONNECT_HIDINPUT 0x01
290#define HID_CONNECT_HIDINPUT_FORCE 0x02
291#define HID_CONNECT_HIDRAW 0x04
292#define HID_CONNECT_HIDDEV 0x08
293#define HID_CONNECT_HIDDEV_FORCE 0x10
294#define HID_CONNECT_FF 0x20
295#define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
296 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
297
298/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 * HID device quirks.
300 */
301
Paul Walmsley876b9272007-04-19 14:56:12 +0200302/*
303 * Increase this if you need to configure more HID quirks at module load time
304 */
305#define MAX_USBHID_BOOT_QUIRKS 4
306
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500307#define HID_QUIRK_INVERT 0x00000001
308#define HID_QUIRK_NOTOUCH 0x00000002
Jiri Kosina6f4303f2009-01-29 00:15:51 +0100309#define HID_QUIRK_IGNORE 0x00000004
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500310#define HID_QUIRK_NOGET 0x00000008
Bastien Nocerab5e5a372010-04-16 17:19:50 +0100311#define HID_QUIRK_HIDDEV_FORCE 0x00000010
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500312#define HID_QUIRK_BADPAD 0x00000020
313#define HID_QUIRK_MULTI_INPUT 0x00000040
Daniel Mack3a343ee2010-07-12 19:28:27 +0200314#define HID_QUIRK_HIDINPUT_FORCE 0x00000080
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200315#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100316#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
Jiri Kosina5b915d92009-11-05 14:08:03 +0100317#define HID_QUIRK_NO_INIT_REPORTS 0x20000000
Bastien Nocerab5e5a372010-04-16 17:19:50 +0100318#define HID_QUIRK_NO_IGNORE 0x40000000
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200319
320/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 * This is the global environment of the parser. This information is
322 * persistent for main-items. The global environment can be saved and
323 * restored with PUSH/POP statements.
324 */
325
326struct hid_global {
327 unsigned usage_page;
328 __s32 logical_minimum;
329 __s32 logical_maximum;
330 __s32 physical_minimum;
331 __s32 physical_maximum;
332 __s32 unit_exponent;
333 unsigned unit;
334 unsigned report_id;
335 unsigned report_size;
336 unsigned report_count;
337};
338
339/*
340 * This is the local environment. It is persistent up the next main-item.
341 */
342
Jiri Kosina5f1ab742008-03-14 16:53:07 +0100343#define HID_MAX_USAGES 12288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344#define HID_DEFAULT_NUM_COLLECTIONS 16
345
346struct hid_local {
347 unsigned usage[HID_MAX_USAGES]; /* usage array */
348 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
349 unsigned usage_index;
350 unsigned usage_minimum;
351 unsigned delimiter_depth;
352 unsigned delimiter_branch;
353};
354
355/*
356 * This is the collection stack. We climb up the stack to determine
357 * application and function of each field.
358 */
359
360struct hid_collection {
361 unsigned type;
362 unsigned usage;
363 unsigned level;
364};
365
366struct hid_usage {
367 unsigned hid; /* hid usage code */
368 unsigned collection_index; /* index into collection array */
369 /* hidinput data */
370 __u16 code; /* input driver code */
371 __u8 type; /* input driver type */
372 __s8 hat_min; /* hat switch fun */
373 __s8 hat_max; /* ditto */
374 __s8 hat_dir; /* ditto */
375};
376
377struct hid_input;
378
379struct hid_field {
380 unsigned physical; /* physical usage for this field */
381 unsigned logical; /* logical usage for this field */
382 unsigned application; /* application usage for this field */
383 struct hid_usage *usage; /* usage table for this function */
384 unsigned maxusage; /* maximum usage index */
385 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
386 unsigned report_offset; /* bit offset in the report */
387 unsigned report_size; /* size of this field in the report */
388 unsigned report_count; /* number of this field in the report */
389 unsigned report_type; /* (input,output,feature) */
390 __s32 *value; /* last known value(s) */
391 __s32 logical_minimum;
392 __s32 logical_maximum;
393 __s32 physical_minimum;
394 __s32 physical_maximum;
395 __s32 unit_exponent;
396 unsigned unit;
397 struct hid_report *report; /* associated report */
398 unsigned index; /* index into report->field[] */
399 /* hidinput data */
400 struct hid_input *hidinput; /* associated input structure */
401 __u16 dpad; /* dpad input code */
402};
403
404#define HID_MAX_FIELDS 64
405
406struct hid_report {
407 struct list_head list;
408 unsigned id; /* id of this report */
409 unsigned type; /* report type */
410 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
411 unsigned maxfield; /* maximum valid field index */
412 unsigned size; /* size of the report (bits) */
413 struct hid_device *device; /* associated device */
414};
415
416struct hid_report_enum {
417 unsigned numbered;
418 struct list_head report_list;
419 struct hid_report *report_id_hash[256];
420};
421
422#define HID_REPORT_TYPES 3
423
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500424#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
425#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
427#define HID_OUTPUT_FIFO_SIZE 64
428
429struct hid_control_fifo {
430 unsigned char dir;
431 struct hid_report *report;
Anssi Hannulaf129ea62008-10-04 14:44:06 +0200432 char *raw_report;
433};
434
435struct hid_output_fifo {
436 struct hid_report *report;
437 char *raw_report;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438};
439
440#define HID_CLAIMED_INPUT 1
441#define HID_CLAIMED_HIDDEV 2
Jiri Kosina86166b72007-05-14 09:57:40 +0200442#define HID_CLAIMED_HIDRAW 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200444#define HID_STAT_ADDED 1
Jiri Slabyc500c972008-05-16 11:49:16 +0200445#define HID_STAT_PARSED 2
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447struct hid_input {
448 struct list_head list;
449 struct hid_report *report;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500450 struct input_dev *input;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451};
452
Jiri Slabya73a6372008-10-22 14:45:11 +0200453enum hid_type {
454 HID_TYPE_OTHER = 0,
455 HID_TYPE_USBMOUSE
456};
457
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200458struct hid_driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200459struct hid_ll_driver;
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461struct hid_device { /* device report descriptor */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200462 __u8 *rdesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 unsigned rsize;
464 struct hid_collection *collection; /* List of HID collections */
465 unsigned collection_size; /* Number of allocated hid_collections */
466 unsigned maxcollection; /* Number of parsed collections */
467 unsigned maxapplication; /* Number of applications */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200468 __u16 bus; /* BUS ID */
469 __u32 vendor; /* Vendor ID */
470 __u32 product; /* Product ID */
471 __u32 version; /* HID version */
Jiri Slabya73a6372008-10-22 14:45:11 +0200472 enum hid_type type; /* device type (mouse, kbd, ...) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 unsigned country; /* HID country */
474 struct hid_report_enum report_enum[HID_REPORT_TYPES];
475
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200476 struct device dev; /* device */
477 struct hid_driver *driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200478 struct hid_ll_driver *ll_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200480 unsigned int status; /* see STAT flags above */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500481 unsigned claimed; /* Claimed by hidinput, hiddev? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 unsigned quirks; /* Various quirks the device can pull on us */
483
484 struct list_head inputs; /* The list of inputs */
485 void *hiddev; /* The hiddev structure */
Jiri Kosina86166b72007-05-14 09:57:40 +0200486 void *hidraw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 int minor; /* Hiddev minor number */
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 int open; /* is the device open by anyone? */
490 char name[128]; /* Device name */
491 char phys[64]; /* Device physical location */
492 char uniq[64]; /* Device unique identifier (serial #) */
493
Jiri Kosina229695e2006-12-08 18:40:53 +0100494 void *driver_data;
495
Jiri Slaby93c10132008-06-27 00:04:24 +0200496 /* temporary hid_ff handling (until moved to the drivers) */
497 int (*ff_init)(struct hid_device *);
498
Jiri Kosinaaa938f72006-12-08 18:41:10 +0100499 /* hiddev event handler */
Jiri Slaby93c10132008-06-27 00:04:24 +0200500 int (*hiddev_connect)(struct hid_device *, unsigned int);
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200501 void (*hiddev_disconnect)(struct hid_device *);
Jiri Kosinaaa938f72006-12-08 18:41:10 +0100502 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
503 struct hid_usage *, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100504 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
Jiri Kosina86166b72007-05-14 09:57:40 +0200505
506 /* handler for raw output data, used by hidraw */
Jiri Kosinad4bfa032010-01-29 15:03:36 +0100507 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char);
Jiri Kosinacd667ce2009-06-12 15:20:57 +0200508
509 /* debugging support via debugfs */
510 unsigned short debug;
511 struct dentry *debug_dir;
512 struct dentry *debug_rdesc;
513 struct dentry *debug_events;
514 struct list_head debug_list;
515 wait_queue_head_t debug_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516};
517
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200518static inline void *hid_get_drvdata(struct hid_device *hdev)
519{
520 return dev_get_drvdata(&hdev->dev);
521}
522
523static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
524{
525 dev_set_drvdata(&hdev->dev, data);
526}
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528#define HID_GLOBAL_STACK_SIZE 4
529#define HID_COLLECTION_STACK_SIZE 4
530
531struct hid_parser {
532 struct hid_global global;
533 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
534 unsigned global_stack_ptr;
535 struct hid_local local;
536 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
537 unsigned collection_stack_ptr;
538 struct hid_device *device;
539};
540
541struct hid_class_descriptor {
542 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100543 __le16 wDescriptorLength;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544} __attribute__ ((packed));
545
546struct hid_descriptor {
547 __u8 bLength;
548 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100549 __le16 bcdHID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 __u8 bCountryCode;
551 __u8 bNumDescriptors;
552
553 struct hid_class_descriptor desc[1];
554} __attribute__ ((packed));
555
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200556#define HID_DEVICE(b, ven, prod) \
557 .bus = (b), \
558 .vendor = (ven), .product = (prod)
559
560#define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
561#define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
562
563#define HID_REPORT_ID(rep) \
564 .report_type = (rep)
565#define HID_USAGE_ID(uhid, utype, ucode) \
566 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
567/* we don't want to catch types and codes equal to 0 */
568#define HID_TERMINATOR (HID_ANY_ID - 1)
569
570struct hid_report_id {
571 __u32 report_type;
572};
573struct hid_usage_id {
574 __u32 usage_hid;
575 __u32 usage_type;
576 __u32 usage_code;
577};
578
579/**
580 * struct hid_driver
581 * @name: driver name (e.g. "Footech_bar-wheel")
582 * @id_table: which devices is this driver for (must be non-NULL for probe
583 * to be called)
Jiri Slaby3a6f82f2008-11-24 16:20:09 +0100584 * @dyn_list: list of dynamically added device ids
585 * @dyn_lock: lock protecting @dyn_list
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200586 * @probe: new device inserted
587 * @remove: device removed (NULL if not a hot-plug capable driver)
588 * @report_table: on which reports to call raw_event (NULL means all)
589 * @raw_event: if report in report_table, this hook is called (NULL means nop)
590 * @usage_table: on which events to call event (NULL means all)
591 * @event: if usage in usage_table, this hook is called (NULL means nop)
Jiri Slabyc500c972008-05-16 11:49:16 +0200592 * @report_fixup: called before report descriptor parsing (NULL means nop)
593 * @input_mapping: invoked on input registering before mapping an usage
594 * @input_mapped: invoked on input registering after mapping an usage
Bruno Prémont6a740aa2010-04-25 21:40:03 +0200595 * @suspend: invoked on suspend (NULL means nop)
596 * @resume: invoked on resume if device was not reset (NULL means nop)
597 * @reset_resume: invoked on resume if device was reset (NULL means nop)
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200598 *
599 * raw_event and event should return 0 on no action performed, 1 when no
600 * further processing should be done and negative on error
Jiri Slabyc500c972008-05-16 11:49:16 +0200601 *
602 * input_mapping shall return a negative value to completely ignore this usage
603 * (e.g. doubled or invalid usage), zero to continue with parsing of this
604 * usage by generic code (no special handling needed) or positive to skip
605 * generic parsing (needed special handling which was done in the hook already)
606 * input_mapped shall return negative to inform the layer that this usage
607 * should not be considered for further processing or zero to notify that
608 * no processing was performed and should be done in a generic manner
609 * Both these functions may be NULL which means the same behavior as returning
610 * zero from them.
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200611 */
612struct hid_driver {
613 char *name;
614 const struct hid_device_id *id_table;
615
Jiri Slaby3a6f82f2008-11-24 16:20:09 +0100616 struct list_head dyn_list;
617 spinlock_t dyn_lock;
618
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200619 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
620 void (*remove)(struct hid_device *dev);
621
622 const struct hid_report_id *report_table;
623 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
624 u8 *data, int size);
625 const struct hid_usage_id *usage_table;
626 int (*event)(struct hid_device *hdev, struct hid_field *field,
627 struct hid_usage *usage, __s32 value);
Jiri Slabyc500c972008-05-16 11:49:16 +0200628
629 void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
630 unsigned int size);
631
632 int (*input_mapping)(struct hid_device *hdev,
633 struct hid_input *hidinput, struct hid_field *field,
634 struct hid_usage *usage, unsigned long **bit, int *max);
635 int (*input_mapped)(struct hid_device *hdev,
636 struct hid_input *hidinput, struct hid_field *field,
637 struct hid_usage *usage, unsigned long **bit, int *max);
Bruno Prémont6a740aa2010-04-25 21:40:03 +0200638#ifdef CONFIG_PM
639 int (*suspend)(struct hid_device *hdev, pm_message_t message);
640 int (*resume)(struct hid_device *hdev);
641 int (*reset_resume)(struct hid_device *hdev);
642#endif
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200643/* private: */
644 struct device_driver driver;
645};
646
Jiri Slabyc500c972008-05-16 11:49:16 +0200647/**
648 * hid_ll_driver - low level driver callbacks
649 * @start: called on probe to start the device
650 * @stop: called on remove
651 * @open: called by input layer on open
652 * @close: called by input layer on close
653 * @hidinput_input_event: event input event (e.g. ff or leds)
654 * @parse: this method is called only once to parse the device data,
655 * shouldn't allocate anything to not leak memory
656 */
657struct hid_ll_driver {
658 int (*start)(struct hid_device *hdev);
659 void (*stop)(struct hid_device *hdev);
660
661 int (*open)(struct hid_device *hdev);
662 void (*close)(struct hid_device *hdev);
663
Oliver Neukum0361a282008-12-17 15:38:03 +0100664 int (*power)(struct hid_device *hdev, int level);
665
Jiri Slabyc500c972008-05-16 11:49:16 +0200666 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
667 unsigned int code, int value);
668
669 int (*parse)(struct hid_device *hdev);
670};
671
Oliver Neukum0361a282008-12-17 15:38:03 +0100672#define PM_HINT_FULLON 1<<5
673#define PM_HINT_NORMAL 1<<1
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
676/* We ignore a few input applications that are not widely used */
Stephane Chatty8b0e58a2010-01-13 21:52:34 +0100677#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
Jiri Kosina229695e2006-12-08 18:40:53 +0100678
679/* HID core API */
Jiri Kosina58037eb2007-05-30 15:07:13 +0200680
Jiri Kosina58037eb2007-05-30 15:07:13 +0200681extern int hid_debug;
Jiri Kosina58037eb2007-05-30 15:07:13 +0200682
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200683extern int hid_add_device(struct hid_device *);
684extern void hid_destroy_device(struct hid_device *);
685
686extern int __must_check __hid_register_driver(struct hid_driver *,
687 struct module *, const char *mod_name);
688static inline int __must_check hid_register_driver(struct hid_driver *driver)
689{
690 return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
691}
692extern void hid_unregister_driver(struct hid_driver *);
693
David Howells7d12e782006-10-05 14:55:46 +0100694extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
Jiri Slaby93c10132008-06-27 00:04:24 +0200696extern int hidinput_connect(struct hid_device *hid, unsigned int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697extern void hidinput_disconnect(struct hid_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699int hid_set_field(struct hid_field *, unsigned, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100700int hid_input_report(struct hid_device *, int type, u8 *, int, int);
Jiri Kosinadde58452006-12-08 18:40:44 +0100701int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
Jiri Kosinadde58452006-12-08 18:40:44 +0100702void hid_output_report(struct hid_report *report, __u8 *data);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200703struct hid_device *hid_allocate_device(void);
Michael Poole90a006a2010-01-24 22:32:29 -0500704struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200705int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
Oliver Neukum0361a282008-12-17 15:38:03 +0100706int hid_check_keys_pressed(struct hid_device *hid);
Jiri Slaby93c10132008-06-27 00:04:24 +0200707int hid_connect(struct hid_device *hid, unsigned int connect_mask);
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200708void hid_disconnect(struct hid_device *hid);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200709
Jiri Slabyc500c972008-05-16 11:49:16 +0200710/**
Jiri Slaby022e8c42008-05-16 11:49:18 +0200711 * hid_map_usage - map usage input bits
712 *
713 * @hidinput: hidinput which we are interested in
714 * @usage: usage to fill in
715 * @bit: pointer to input->{}bit (out parameter)
716 * @max: maximal valid usage->code to consider later (out parameter)
717 * @type: input event type (EV_KEY, EV_REL, ...)
718 * @c: code which corresponds to this usage and type
719 */
720static inline void hid_map_usage(struct hid_input *hidinput,
721 struct hid_usage *usage, unsigned long **bit, int *max,
722 __u8 type, __u16 c)
723{
724 struct input_dev *input = hidinput->input;
725
726 usage->type = type;
727 usage->code = c;
728
729 switch (type) {
730 case EV_ABS:
731 *bit = input->absbit;
732 *max = ABS_MAX;
733 break;
734 case EV_REL:
735 *bit = input->relbit;
736 *max = REL_MAX;
737 break;
738 case EV_KEY:
739 *bit = input->keybit;
740 *max = KEY_MAX;
741 break;
742 case EV_LED:
743 *bit = input->ledbit;
744 *max = LED_MAX;
745 break;
746 }
747}
748
749/**
750 * hid_map_usage_clear - map usage input bits and clear the input bit
751 *
752 * The same as hid_map_usage, except the @c bit is also cleared in supported
753 * bits (@bit).
754 */
755static inline void hid_map_usage_clear(struct hid_input *hidinput,
756 struct hid_usage *usage, unsigned long **bit, int *max,
757 __u8 type, __u16 c)
758{
759 hid_map_usage(hidinput, usage, bit, max, type, c);
760 clear_bit(c, *bit);
761}
762
763/**
Jiri Slabyc500c972008-05-16 11:49:16 +0200764 * hid_parse - parse HW reports
765 *
766 * @hdev: hid device
767 *
768 * Call this from probe after you set up the device (if needed). Your
769 * report_fixup will be called (if non-NULL) after reading raw report from
770 * device before passing it to hid layer for real parsing.
771 */
772static inline int __must_check hid_parse(struct hid_device *hdev)
773{
774 int ret;
775
776 if (hdev->status & HID_STAT_PARSED)
777 return 0;
778
779 ret = hdev->ll_driver->parse(hdev);
780 if (!ret)
781 hdev->status |= HID_STAT_PARSED;
782
783 return ret;
784}
785
786/**
787 * hid_hw_start - start underlaying HW
788 *
789 * @hdev: hid device
Jiri Slaby93c10132008-06-27 00:04:24 +0200790 * @connect_mask: which outputs to connect, see HID_CONNECT_*
Jiri Slabyc500c972008-05-16 11:49:16 +0200791 *
792 * Call this in probe function *after* hid_parse. This will setup HW buffers
793 * and start the device (if not deffered to device open). hid_hw_stop must be
794 * called if this was successfull.
795 */
Jiri Slaby93c10132008-06-27 00:04:24 +0200796static inline int __must_check hid_hw_start(struct hid_device *hdev,
797 unsigned int connect_mask)
Jiri Slabyc500c972008-05-16 11:49:16 +0200798{
Jiri Slaby93c10132008-06-27 00:04:24 +0200799 int ret = hdev->ll_driver->start(hdev);
800 if (ret || !connect_mask)
801 return ret;
802 ret = hid_connect(hdev, connect_mask);
803 if (ret)
804 hdev->ll_driver->stop(hdev);
805 return ret;
Jiri Slabyc500c972008-05-16 11:49:16 +0200806}
807
808/**
809 * hid_hw_stop - stop underlaying HW
810 *
811 * @hdev: hid device
812 *
813 * This is usually called from remove function or from probe when something
814 * failed and hid_hw_start was called already.
815 */
816static inline void hid_hw_stop(struct hid_device *hdev)
817{
Jiri Kosinac4c259b2009-09-15 16:27:45 +0200818 hid_disconnect(hdev);
Jiri Slabyc500c972008-05-16 11:49:16 +0200819 hdev->ll_driver->stop(hdev);
820}
821
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200822void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
823 int interrupt);
824
825extern int hid_generic_init(void);
826extern void hid_generic_exit(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Paul Walmsley876b9272007-04-19 14:56:12 +0200828/* HID quirks API */
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200829u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
Paul Walmsley876b9272007-04-19 14:56:12 +0200830int usbhid_quirks_init(char **quirks_param);
831void usbhid_quirks_exit(void);
Jiri Slaby6edfa8d2008-06-27 20:41:02 +0200832void usbhid_set_leds(struct hid_device *hid);
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200833
Anssi Hannula224ee882006-07-19 01:40:47 -0400834#ifdef CONFIG_HID_PID
835int hid_pidff_init(struct hid_device *hid);
836#else
Jiri Slaby76483cf2008-09-18 12:23:33 +0200837#define hid_pidff_init NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838#endif
Jiri Kosina58037eb2007-05-30 15:07:13 +0200839
Jiri Kosina58037eb2007-05-30 15:07:13 +0200840#define dbg_hid(format, arg...) if (hid_debug) \
841 printk(KERN_DEBUG "%s: " format ,\
842 __FILE__ , ## arg)
Jiri Kosina58037eb2007-05-30 15:07:13 +0200843#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
Jiri Kosina229695e2006-12-08 18:40:53 +0100844 __FILE__ , ## arg)
Jiri Slaby02ae9a12008-05-16 11:49:22 +0200845#endif /* HID_FF */
846
Jiri Kosina57d292b2007-10-15 15:17:41 +0200847#endif
Anssi Hannula224ee882006-07-19 01:40:47 -0400848