blob: 5b47feecc101b3b89bb604edd9d7294f754a619c [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
241/*
242 * HID report types --- Ouch! HID spec says 1 2 3!
243 */
244
245#define HID_INPUT_REPORT 0
246#define HID_OUTPUT_REPORT 1
247#define HID_FEATURE_REPORT 2
248
249/*
250 * HID device quirks.
251 */
252
Paul Walmsley876b9272007-04-19 14:56:12 +0200253/*
254 * Increase this if you need to configure more HID quirks at module load time
255 */
256#define MAX_USBHID_BOOT_QUIRKS 4
257
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500258#define HID_QUIRK_INVERT 0x00000001
259#define HID_QUIRK_NOTOUCH 0x00000002
Michael Hanselmanneab9edd2006-01-14 10:08:06 -0500260#define HID_QUIRK_NOGET 0x00000008
261#define HID_QUIRK_HIDDEV 0x00000010
262#define HID_QUIRK_BADPAD 0x00000020
263#define HID_QUIRK_MULTI_INPUT 0x00000040
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200264#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200265#define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200266#define HID_QUIRK_RESET_LEDS 0x00100000
267#define HID_QUIRK_HIDINPUT 0x00200000
Stelian Pop0ce91cf2007-09-11 23:34:55 +0200268#define HID_QUIRK_IGNORE_HIDINPUT 0x01000000
Pekka Sarnilaf345c372008-03-06 13:23:14 +0100269#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200270
271/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 * This is the global environment of the parser. This information is
273 * persistent for main-items. The global environment can be saved and
274 * restored with PUSH/POP statements.
275 */
276
277struct hid_global {
278 unsigned usage_page;
279 __s32 logical_minimum;
280 __s32 logical_maximum;
281 __s32 physical_minimum;
282 __s32 physical_maximum;
283 __s32 unit_exponent;
284 unsigned unit;
285 unsigned report_id;
286 unsigned report_size;
287 unsigned report_count;
288};
289
290/*
291 * This is the local environment. It is persistent up the next main-item.
292 */
293
Jiri Kosina5f1ab742008-03-14 16:53:07 +0100294#define HID_MAX_USAGES 12288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295#define HID_DEFAULT_NUM_COLLECTIONS 16
296
297struct hid_local {
298 unsigned usage[HID_MAX_USAGES]; /* usage array */
299 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
300 unsigned usage_index;
301 unsigned usage_minimum;
302 unsigned delimiter_depth;
303 unsigned delimiter_branch;
304};
305
306/*
307 * This is the collection stack. We climb up the stack to determine
308 * application and function of each field.
309 */
310
311struct hid_collection {
312 unsigned type;
313 unsigned usage;
314 unsigned level;
315};
316
317struct hid_usage {
318 unsigned hid; /* hid usage code */
319 unsigned collection_index; /* index into collection array */
320 /* hidinput data */
321 __u16 code; /* input driver code */
322 __u8 type; /* input driver type */
323 __s8 hat_min; /* hat switch fun */
324 __s8 hat_max; /* ditto */
325 __s8 hat_dir; /* ditto */
326};
327
328struct hid_input;
329
330struct hid_field {
331 unsigned physical; /* physical usage for this field */
332 unsigned logical; /* logical usage for this field */
333 unsigned application; /* application usage for this field */
334 struct hid_usage *usage; /* usage table for this function */
335 unsigned maxusage; /* maximum usage index */
336 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
337 unsigned report_offset; /* bit offset in the report */
338 unsigned report_size; /* size of this field in the report */
339 unsigned report_count; /* number of this field in the report */
340 unsigned report_type; /* (input,output,feature) */
341 __s32 *value; /* last known value(s) */
342 __s32 logical_minimum;
343 __s32 logical_maximum;
344 __s32 physical_minimum;
345 __s32 physical_maximum;
346 __s32 unit_exponent;
347 unsigned unit;
348 struct hid_report *report; /* associated report */
349 unsigned index; /* index into report->field[] */
350 /* hidinput data */
351 struct hid_input *hidinput; /* associated input structure */
352 __u16 dpad; /* dpad input code */
353};
354
355#define HID_MAX_FIELDS 64
356
357struct hid_report {
358 struct list_head list;
359 unsigned id; /* id of this report */
360 unsigned type; /* report type */
361 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
362 unsigned maxfield; /* maximum valid field index */
363 unsigned size; /* size of the report (bits) */
364 struct hid_device *device; /* associated device */
365};
366
367struct hid_report_enum {
368 unsigned numbered;
369 struct list_head report_list;
370 struct hid_report *report_id_hash[256];
371};
372
373#define HID_REPORT_TYPES 3
374
Michael Haboustakbf0964d2005-09-05 00:12:01 -0500375#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
376#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
378#define HID_OUTPUT_FIFO_SIZE 64
379
380struct hid_control_fifo {
381 unsigned char dir;
382 struct hid_report *report;
383};
384
385#define HID_CLAIMED_INPUT 1
386#define HID_CLAIMED_HIDDEV 2
Jiri Kosina86166b72007-05-14 09:57:40 +0200387#define HID_CLAIMED_HIDRAW 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200389#define HID_STAT_ADDED 1
Jiri Slabyc500c972008-05-16 11:49:16 +0200390#define HID_STAT_PARSED 2
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392#define HID_CTRL_RUNNING 1
393#define HID_OUT_RUNNING 2
Alan Sternaef4e262006-01-31 12:58:38 -0500394#define HID_IN_RUNNING 3
395#define HID_RESET_PENDING 4
396#define HID_SUSPENDED 5
Alan Stern6d8fc4d2006-10-18 12:35:24 -0400397#define HID_CLEAR_HALT 6
Oliver Neukum69626f22008-03-31 16:27:30 +0200398#define HID_DISCONNECTED 7
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400struct hid_input {
401 struct list_head list;
402 struct hid_report *report;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500403 struct input_dev *input;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404};
405
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200406struct hid_driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200407struct hid_ll_driver;
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409struct hid_device { /* device report descriptor */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200410 __u8 *rdesc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 unsigned rsize;
412 struct hid_collection *collection; /* List of HID collections */
413 unsigned collection_size; /* Number of allocated hid_collections */
414 unsigned maxcollection; /* Number of parsed collections */
415 unsigned maxapplication; /* Number of applications */
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200416 __u16 bus; /* BUS ID */
417 __u32 vendor; /* Vendor ID */
418 __u32 product; /* Product ID */
419 __u32 version; /* HID version */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 unsigned country; /* HID country */
421 struct hid_report_enum report_enum[HID_REPORT_TYPES];
422
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200423 struct device dev; /* device */
424 struct hid_driver *driver;
Jiri Slabyc500c972008-05-16 11:49:16 +0200425 struct hid_ll_driver *ll_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200427 unsigned int status; /* see STAT flags above */
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500428 unsigned claimed; /* Claimed by hidinput, hiddev? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 unsigned quirks; /* Various quirks the device can pull on us */
430
431 struct list_head inputs; /* The list of inputs */
432 void *hiddev; /* The hiddev structure */
Jiri Kosina86166b72007-05-14 09:57:40 +0200433 void *hidraw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 int minor; /* Hiddev minor number */
435
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 int open; /* is the device open by anyone? */
437 char name[128]; /* Device name */
438 char phys[64]; /* Device physical location */
439 char uniq[64]; /* Device unique identifier (serial #) */
440
Jiri Kosina229695e2006-12-08 18:40:53 +0100441 void *driver_data;
442
Jiri Kosinaaa938f72006-12-08 18:41:10 +0100443 /* hiddev event handler */
444 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
445 struct hid_usage *, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100446 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
Jiri Kosina86166b72007-05-14 09:57:40 +0200447
448 /* handler for raw output data, used by hidraw */
449 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450};
451
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200452static inline void *hid_get_drvdata(struct hid_device *hdev)
453{
454 return dev_get_drvdata(&hdev->dev);
455}
456
457static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
458{
459 dev_set_drvdata(&hdev->dev, data);
460}
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462#define HID_GLOBAL_STACK_SIZE 4
463#define HID_COLLECTION_STACK_SIZE 4
464
465struct hid_parser {
466 struct hid_global global;
467 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
468 unsigned global_stack_ptr;
469 struct hid_local local;
470 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
471 unsigned collection_stack_ptr;
472 struct hid_device *device;
473};
474
475struct hid_class_descriptor {
476 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100477 __le16 wDescriptorLength;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478} __attribute__ ((packed));
479
480struct hid_descriptor {
481 __u8 bLength;
482 __u8 bDescriptorType;
Al Viro01d7b362008-04-28 07:00:05 +0100483 __le16 bcdHID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 __u8 bCountryCode;
485 __u8 bNumDescriptors;
486
487 struct hid_class_descriptor desc[1];
488} __attribute__ ((packed));
489
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200490#define HID_DEVICE(b, ven, prod) \
491 .bus = (b), \
492 .vendor = (ven), .product = (prod)
493
494#define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
495#define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
496
497#define HID_REPORT_ID(rep) \
498 .report_type = (rep)
499#define HID_USAGE_ID(uhid, utype, ucode) \
500 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
501/* we don't want to catch types and codes equal to 0 */
502#define HID_TERMINATOR (HID_ANY_ID - 1)
503
504struct hid_report_id {
505 __u32 report_type;
506};
507struct hid_usage_id {
508 __u32 usage_hid;
509 __u32 usage_type;
510 __u32 usage_code;
511};
512
513/**
514 * struct hid_driver
515 * @name: driver name (e.g. "Footech_bar-wheel")
516 * @id_table: which devices is this driver for (must be non-NULL for probe
517 * to be called)
518 * @probe: new device inserted
519 * @remove: device removed (NULL if not a hot-plug capable driver)
520 * @report_table: on which reports to call raw_event (NULL means all)
521 * @raw_event: if report in report_table, this hook is called (NULL means nop)
522 * @usage_table: on which events to call event (NULL means all)
523 * @event: if usage in usage_table, this hook is called (NULL means nop)
Jiri Slabyc500c972008-05-16 11:49:16 +0200524 * @report_fixup: called before report descriptor parsing (NULL means nop)
525 * @input_mapping: invoked on input registering before mapping an usage
526 * @input_mapped: invoked on input registering after mapping an usage
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200527 *
528 * raw_event and event should return 0 on no action performed, 1 when no
529 * further processing should be done and negative on error
Jiri Slabyc500c972008-05-16 11:49:16 +0200530 *
531 * input_mapping shall return a negative value to completely ignore this usage
532 * (e.g. doubled or invalid usage), zero to continue with parsing of this
533 * usage by generic code (no special handling needed) or positive to skip
534 * generic parsing (needed special handling which was done in the hook already)
535 * input_mapped shall return negative to inform the layer that this usage
536 * should not be considered for further processing or zero to notify that
537 * no processing was performed and should be done in a generic manner
538 * Both these functions may be NULL which means the same behavior as returning
539 * zero from them.
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200540 */
541struct hid_driver {
542 char *name;
543 const struct hid_device_id *id_table;
544
545 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
546 void (*remove)(struct hid_device *dev);
547
548 const struct hid_report_id *report_table;
549 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
550 u8 *data, int size);
551 const struct hid_usage_id *usage_table;
552 int (*event)(struct hid_device *hdev, struct hid_field *field,
553 struct hid_usage *usage, __s32 value);
Jiri Slabyc500c972008-05-16 11:49:16 +0200554
555 void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
556 unsigned int size);
557
558 int (*input_mapping)(struct hid_device *hdev,
559 struct hid_input *hidinput, struct hid_field *field,
560 struct hid_usage *usage, unsigned long **bit, int *max);
561 int (*input_mapped)(struct hid_device *hdev,
562 struct hid_input *hidinput, struct hid_field *field,
563 struct hid_usage *usage, unsigned long **bit, int *max);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200564/* private: */
565 struct device_driver driver;
566};
567
Jiri Slabyc500c972008-05-16 11:49:16 +0200568/**
569 * hid_ll_driver - low level driver callbacks
570 * @start: called on probe to start the device
571 * @stop: called on remove
572 * @open: called by input layer on open
573 * @close: called by input layer on close
574 * @hidinput_input_event: event input event (e.g. ff or leds)
575 * @parse: this method is called only once to parse the device data,
576 * shouldn't allocate anything to not leak memory
577 */
578struct hid_ll_driver {
579 int (*start)(struct hid_device *hdev);
580 void (*stop)(struct hid_device *hdev);
581
582 int (*open)(struct hid_device *hdev);
583 void (*close)(struct hid_device *hdev);
584
585 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
586 unsigned int code, int value);
587
588 int (*parse)(struct hid_device *hdev);
589};
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
592/* We ignore a few input applications that are not widely used */
Rafi Rubinf472f802008-06-19 11:51:04 +0200593#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
Jiri Kosina229695e2006-12-08 18:40:53 +0100594
595/* HID core API */
Jiri Kosina58037eb2007-05-30 15:07:13 +0200596
597#ifdef CONFIG_HID_DEBUG
598extern int hid_debug;
599#endif
600
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200601extern int hid_add_device(struct hid_device *);
602extern void hid_destroy_device(struct hid_device *);
603
604extern int __must_check __hid_register_driver(struct hid_driver *,
605 struct module *, const char *mod_name);
606static inline int __must_check hid_register_driver(struct hid_driver *driver)
607{
608 return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
609}
610extern void hid_unregister_driver(struct hid_driver *);
611
David Howells7d12e782006-10-05 14:55:46 +0100612extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
614extern int hidinput_connect(struct hid_device *);
615extern void hidinput_disconnect(struct hid_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617int hid_set_field(struct hid_field *, unsigned, __s32);
Jiri Kosinaaa8de2f2006-12-08 18:41:17 +0100618int hid_input_report(struct hid_device *, int type, u8 *, int, int);
Jiri Kosinadde58452006-12-08 18:40:44 +0100619int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
Jiri Slaby022e8c42008-05-16 11:49:18 +0200620int hidinput_mapping_quirks(struct hid_usage *, struct hid_input *,
621 unsigned long **, int *);
Jiri Kosina68a1f2c2008-02-07 16:48:46 +0100622int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
Jiri Kosinadde58452006-12-08 18:40:44 +0100623void hid_output_report(struct hid_report *report, __u8 *data);
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200624struct hid_device *hid_allocate_device(void);
625int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
626
Jiri Slabyc500c972008-05-16 11:49:16 +0200627/**
Jiri Slaby022e8c42008-05-16 11:49:18 +0200628 * hid_map_usage - map usage input bits
629 *
630 * @hidinput: hidinput which we are interested in
631 * @usage: usage to fill in
632 * @bit: pointer to input->{}bit (out parameter)
633 * @max: maximal valid usage->code to consider later (out parameter)
634 * @type: input event type (EV_KEY, EV_REL, ...)
635 * @c: code which corresponds to this usage and type
636 */
637static inline void hid_map_usage(struct hid_input *hidinput,
638 struct hid_usage *usage, unsigned long **bit, int *max,
639 __u8 type, __u16 c)
640{
641 struct input_dev *input = hidinput->input;
642
643 usage->type = type;
644 usage->code = c;
645
646 switch (type) {
647 case EV_ABS:
648 *bit = input->absbit;
649 *max = ABS_MAX;
650 break;
651 case EV_REL:
652 *bit = input->relbit;
653 *max = REL_MAX;
654 break;
655 case EV_KEY:
656 *bit = input->keybit;
657 *max = KEY_MAX;
658 break;
659 case EV_LED:
660 *bit = input->ledbit;
661 *max = LED_MAX;
662 break;
663 }
664}
665
666/**
667 * hid_map_usage_clear - map usage input bits and clear the input bit
668 *
669 * The same as hid_map_usage, except the @c bit is also cleared in supported
670 * bits (@bit).
671 */
672static inline void hid_map_usage_clear(struct hid_input *hidinput,
673 struct hid_usage *usage, unsigned long **bit, int *max,
674 __u8 type, __u16 c)
675{
676 hid_map_usage(hidinput, usage, bit, max, type, c);
677 clear_bit(c, *bit);
678}
679
680/**
Jiri Slabyc500c972008-05-16 11:49:16 +0200681 * hid_parse - parse HW reports
682 *
683 * @hdev: hid device
684 *
685 * Call this from probe after you set up the device (if needed). Your
686 * report_fixup will be called (if non-NULL) after reading raw report from
687 * device before passing it to hid layer for real parsing.
688 */
689static inline int __must_check hid_parse(struct hid_device *hdev)
690{
691 int ret;
692
693 if (hdev->status & HID_STAT_PARSED)
694 return 0;
695
696 ret = hdev->ll_driver->parse(hdev);
697 if (!ret)
698 hdev->status |= HID_STAT_PARSED;
699
700 return ret;
701}
702
703/**
704 * hid_hw_start - start underlaying HW
705 *
706 * @hdev: hid device
707 *
708 * Call this in probe function *after* hid_parse. This will setup HW buffers
709 * and start the device (if not deffered to device open). hid_hw_stop must be
710 * called if this was successfull.
711 */
712static inline int __must_check hid_hw_start(struct hid_device *hdev)
713{
714 return hdev->ll_driver->start(hdev);
715}
716
717/**
718 * hid_hw_stop - stop underlaying HW
719 *
720 * @hdev: hid device
721 *
722 * This is usually called from remove function or from probe when something
723 * failed and hid_hw_start was called already.
724 */
725static inline void hid_hw_stop(struct hid_device *hdev)
726{
727 hdev->ll_driver->stop(hdev);
728}
729
Jiri Slaby85cdaf52008-05-16 11:49:15 +0200730void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
731 int interrupt);
732
733extern int hid_generic_init(void);
734extern void hid_generic_exit(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Paul Walmsley876b9272007-04-19 14:56:12 +0200736/* HID quirks API */
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200737u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
Paul Walmsley876b9272007-04-19 14:56:12 +0200738int usbhid_quirks_init(char **quirks_param);
739void usbhid_quirks_exit(void);
Jiri Kosinaea9a4a82007-06-19 14:09:14 +0200740void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
Paul Walmsley2eb5dc32007-04-19 13:27:04 +0200741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742#ifdef CONFIG_HID_FF
743int hid_ff_init(struct hid_device *hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400744
745int hid_lgff_init(struct hid_device *hid);
Anssi Hannulac17f9c92008-04-01 01:51:11 +0200746int hid_lg2ff_init(struct hid_device *hid);
Anssi Hannula20eb1272007-01-11 16:51:18 +0200747int hid_plff_init(struct hid_device *hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400748int hid_tmff_init(struct hid_device *hid);
Anssi Hannulabb3caf72006-07-19 01:44:17 -0400749int hid_zpff_init(struct hid_device *hid);
Anssi Hannula224ee882006-07-19 01:40:47 -0400750#ifdef CONFIG_HID_PID
751int hid_pidff_init(struct hid_device *hid);
752#else
753static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
754#endif
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756#else
757static inline int hid_ff_init(struct hid_device *hid) { return -1; }
758#endif
Jiri Kosina58037eb2007-05-30 15:07:13 +0200759
760#ifdef CONFIG_HID_DEBUG
761#define dbg_hid(format, arg...) if (hid_debug) \
762 printk(KERN_DEBUG "%s: " format ,\
763 __FILE__ , ## arg)
764#define dbg_hid_line(format, arg...) if (hid_debug) \
765 printk(format, ## arg)
Jiri Kosina229695e2006-12-08 18:40:53 +0100766#else
Jiri Slaby1b184cf2008-03-09 16:29:24 +0100767static inline int __attribute__((format(printf, 1, 2)))
768dbg_hid(const char *fmt, ...)
769{
770 return 0;
771}
Jiri Kosina58037eb2007-05-30 15:07:13 +0200772#define dbg_hid_line dbg_hid
Jiri Slaby02ae9a12008-05-16 11:49:22 +0200773#endif /* HID_DEBUG */
Jiri Kosina229695e2006-12-08 18:40:53 +0100774
Jiri Kosina58037eb2007-05-30 15:07:13 +0200775#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
Jiri Kosina229695e2006-12-08 18:40:53 +0100776 __FILE__ , ## arg)
Jiri Slaby02ae9a12008-05-16 11:49:22 +0200777#endif /* HID_FF */
778
779#ifdef CONFIG_HID_COMPAT
780#define HID_COMPAT_LOAD_DRIVER(name) \
781void hid_compat_##name(void) { } \
782EXPORT_SYMBOL(hid_compat_##name)
783#else
784#define HID_COMPAT_LOAD_DRIVER(name)
785#endif /* HID_COMPAT */
786#define HID_COMPAT_CALL_DRIVER(name) do { \
787 extern void hid_compat_##name(void); \
788 hid_compat_##name(); \
789} while (0)
790
Jiri Kosina57d292b2007-10-15 15:17:41 +0200791#endif
Anssi Hannula224ee882006-07-19 01:40:47 -0400792