projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
HID: move ids into separate file
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / hid.h
CommitLineData
1da177e4
LT		 1#ifndef __HID_H
2#define __HID_H
3
4/*
1da177e4
LT		 5 * Copyright (c) 1999 Andreas Gal
6 * Copyright (c) 2000-2001 Vojtech Pavlik
b55fd23c 7 * Copyright (c) 2006-2007 Jiri Kosina
1da177e4
LT		 8 */
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
1da177e4
LT		 30/*
31 * USB HID (Human Interface Device) interface class code
32 */
33
34#define USB_INTERFACE_CLASS_HID 3
35
0f28b55d
AS		 36/*
37 * 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
1da177e4
LT		 44/*
45 * 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
57d292bd
JK		 63#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>
e8c84f9a 70#include <linux/mod_devicetable.h> /* hid_device_id */
57d292bd
JK		 71#include <linux/timer.h>
72#include <linux/workqueue.h>
73#include <linux/input.h>
74
1da177e4
LT		 75/*
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
05f091ab 136#define HID_MAIN_ITEM_WRAP 0x008
1da177e4
LT		 137#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
05f091ab 190#define HID_UP_GENDESK 0x00010000
0aebfdac 191#define HID_UP_SIMULATION 0x00020000
05f091ab
DT		 192#define HID_UP_KEYBOARD 0x00070000
193#define HID_UP_LED 0x00080000
194#define HID_UP_BUTTON 0x00090000
195#define HID_UP_ORDINAL 0x000a0000
1da177e4 196#define HID_UP_CONSUMER 0x000c0000
05f091ab
DT		 197#define HID_UP_DIGITIZER 0x000d0000
198#define HID_UP_PID 0x000f0000
1da177e4
LT		 199#define HID_UP_HPVENDOR 0xff7f0000
200#define HID_UP_MSVENDOR 0xff000000
e875ce37
SP		 201#define HID_UP_CUSTOM 0x00ff0000
202#define HID_UP_LOGIVENDOR 0xffbc0000
1da177e4
LT		 203
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
876b9276
PW		 253/*
254 * Increase this if you need to configure more HID quirks at module load time
255 */
256#define MAX_USBHID_BOOT_QUIRKS 4
257
eab9edd2
MH		 258#define HID_QUIRK_INVERT 0x00000001
259#define HID_QUIRK_NOTOUCH 0x00000002
260#define HID_QUIRK_IGNORE 0x00000004
261#define HID_QUIRK_NOGET 0x00000008
262#define HID_QUIRK_HIDDEV 0x00000010
263#define HID_QUIRK_BADPAD 0x00000020
264#define HID_QUIRK_MULTI_INPUT 0x00000040
265#define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
266#define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
267#define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
a82e49b8 268#define HID_QUIRK_MIGHTYMOUSE 0x00000400
81e1a875
MD		 269#define HID_QUIRK_APPLE_HAS_FN 0x00000800
270#define HID_QUIRK_APPLE_FN_ON 0x00001000
ea9a4a8b 271#define HID_QUIRK_INVERT_HWHEEL 0x00002000
81e1a875 272#define HID_QUIRK_APPLE_ISO_KEYBOARD 0x00004000
ea9a4a8b
JK		 273#define HID_QUIRK_BAD_RELATIVE_KEYS 0x00008000
274#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
275#define HID_QUIRK_IGNORE_MOUSE 0x00020000
276#define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000
277#define HID_QUIRK_DUPLICATE_USAGES 0x00080000
278#define HID_QUIRK_RESET_LEDS 0x00100000
279#define HID_QUIRK_HIDINPUT 0x00200000
5f9c464a
RD		 280#define HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL 0x00400000
281#define HID_QUIRK_LOGITECH_EXPANDED_KEYMAP 0x00800000
0ce91cf9 282#define HID_QUIRK_IGNORE_HIDINPUT 0x01000000
c80e5ffa 283#define HID_QUIRK_2WHEEL_MOUSE_HACK_B8 0x02000000
36ccaad6 284#define HID_QUIRK_HWHEEL_WHEEL_INVERT 0x04000000
628edcde 285#define HID_QUIRK_MICROSOFT_KEYS 0x08000000
f345c37c 286#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
6e704599 287#define HID_QUIRK_APPLE_NUMLOCK_EMULATION 0x20000000
ea9a4a8b
JK		 288
289/*
290 * Separate quirks for runtime report descriptor fixup
291 */
292
293#define HID_QUIRK_RDESC_CYMOTION 0x00000001
294#define HID_QUIRK_RDESC_LOGITECH 0x00000002
295#define HID_QUIRK_RDESC_SWAPPED_MIN_MAX 0x00000004
296#define HID_QUIRK_RDESC_PETALYNX 0x00000008
08f06177 297#define HID_QUIRK_RDESC_MACBOOK_JIS 0x00000010
af9e0eac 298#define HID_QUIRK_RDESC_BUTTON_CONSUMER 0x00000020
fe56caa9 299#define HID_QUIRK_RDESC_SAMSUNG_REMOTE 0x00000040
974faac4 300#define HID_QUIRK_RDESC_MICROSOFT_RECV_1028 0x00000080
5f1ab74f 301#define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP 0x00000100
1da177e4
LT		 302
303/*
304 * This is the global environment of the parser. This information is
305 * persistent for main-items. The global environment can be saved and
306 * restored with PUSH/POP statements.
307 */
308
309struct hid_global {
310 unsigned usage_page;
311 __s32 logical_minimum;
312 __s32 logical_maximum;
313 __s32 physical_minimum;
314 __s32 physical_maximum;
315 __s32 unit_exponent;
316 unsigned unit;
317 unsigned report_id;
318 unsigned report_size;
319 unsigned report_count;
320};
321
322/*
323 * This is the local environment. It is persistent up the next main-item.
324 */
325
5f1ab74f 326#define HID_MAX_USAGES 12288
1da177e4
LT		 327#define HID_DEFAULT_NUM_COLLECTIONS 16
328
329struct hid_local {
330 unsigned usage[HID_MAX_USAGES]; /* usage array */
331 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
332 unsigned usage_index;
333 unsigned usage_minimum;
334 unsigned delimiter_depth;
335 unsigned delimiter_branch;
336};
337
338/*
339 * This is the collection stack. We climb up the stack to determine
340 * application and function of each field.
341 */
342
343struct hid_collection {
344 unsigned type;
345 unsigned usage;
346 unsigned level;
347};
348
349struct hid_usage {
350 unsigned hid; /* hid usage code */
351 unsigned collection_index; /* index into collection array */
352 /* hidinput data */
353 __u16 code; /* input driver code */
354 __u8 type; /* input driver type */
355 __s8 hat_min; /* hat switch fun */
356 __s8 hat_max; /* ditto */
357 __s8 hat_dir; /* ditto */
358};
359
360struct hid_input;
361
362struct hid_field {
363 unsigned physical; /* physical usage for this field */
364 unsigned logical; /* logical usage for this field */
365 unsigned application; /* application usage for this field */
366 struct hid_usage *usage; /* usage table for this function */
367 unsigned maxusage; /* maximum usage index */
368 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
369 unsigned report_offset; /* bit offset in the report */
370 unsigned report_size; /* size of this field in the report */
371 unsigned report_count; /* number of this field in the report */
372 unsigned report_type; /* (input,output,feature) */
373 __s32 *value; /* last known value(s) */
374 __s32 logical_minimum;
375 __s32 logical_maximum;
376 __s32 physical_minimum;
377 __s32 physical_maximum;
378 __s32 unit_exponent;
379 unsigned unit;
380 struct hid_report *report; /* associated report */
381 unsigned index; /* index into report->field[] */
382 /* hidinput data */
383 struct hid_input *hidinput; /* associated input structure */
384 __u16 dpad; /* dpad input code */
385};
386
387#define HID_MAX_FIELDS 64
388
389struct hid_report {
390 struct list_head list;
391 unsigned id; /* id of this report */
392 unsigned type; /* report type */
393 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
394 unsigned maxfield; /* maximum valid field index */
395 unsigned size; /* size of the report (bits) */
396 struct hid_device *device; /* associated device */
397};
398
399struct hid_report_enum {
400 unsigned numbered;
401 struct list_head report_list;
402 struct hid_report *report_id_hash[256];
403};
404
405#define HID_REPORT_TYPES 3
406
bf0964dc
MH		 407#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
408#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
1da177e4
LT		 409#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
410#define HID_OUTPUT_FIFO_SIZE 64
411
412struct hid_control_fifo {
413 unsigned char dir;
414 struct hid_report *report;
415};
416
417#define HID_CLAIMED_INPUT 1
418#define HID_CLAIMED_HIDDEV 2
86166b7b 419#define HID_CLAIMED_HIDRAW 4
1da177e4 420
85cdaf52 421#define HID_STAT_ADDED 1
c500c971 422#define HID_STAT_PARSED 2
85cdaf52 423
1da177e4
LT		 424#define HID_CTRL_RUNNING 1
425#define HID_OUT_RUNNING 2
aef4e266
AS		 426#define HID_IN_RUNNING 3
427#define HID_RESET_PENDING 4
428#define HID_SUSPENDED 5
6d8fc4d2 429#define HID_CLEAR_HALT 6
69626f23 430#define HID_DISCONNECTED 7
1da177e4
LT		 431
432struct hid_input {
433 struct list_head list;
434 struct hid_report *report;
c5b7c7c3 435 struct input_dev *input;
1da177e4
LT		 436};
437
85cdaf52 438struct hid_driver;
c500c971 439struct hid_ll_driver;
85cdaf52 440
1da177e4 441struct hid_device { /* device report descriptor */
85cdaf52 442 __u8 *rdesc;
1da177e4
LT		 443 unsigned rsize;
444 struct hid_collection *collection; /* List of HID collections */
445 unsigned collection_size; /* Number of allocated hid_collections */
446 unsigned maxcollection; /* Number of parsed collections */
447 unsigned maxapplication; /* Number of applications */
85cdaf52
JS		 448 __u16 bus; /* BUS ID */
449 __u32 vendor; /* Vendor ID */
450 __u32 product; /* Product ID */
451 __u32 version; /* HID version */
1da177e4
LT		 452 unsigned country; /* HID country */
453 struct hid_report_enum report_enum[HID_REPORT_TYPES];
454
85cdaf52
JS		 455 struct device dev; /* device */
456 struct hid_driver *driver;
c500c971 457 struct hid_ll_driver *ll_driver;
1da177e4 458
85cdaf52 459 unsigned int status; /* see STAT flags above */
05f091ab 460 unsigned claimed; /* Claimed by hidinput, hiddev? */
1da177e4
LT		 461 unsigned quirks; /* Various quirks the device can pull on us */
462
463 struct list_head inputs; /* The list of inputs */
464 void *hiddev; /* The hiddev structure */
86166b7b 465 void *hidraw;
1da177e4
LT		 466 int minor; /* Hiddev minor number */
467
1da177e4
LT		 468 int open; /* is the device open by anyone? */
469 char name[128]; /* Device name */
470 char phys[64]; /* Device physical location */
471 char uniq[64]; /* Device unique identifier (serial #) */
472
229695e5
JK		 473 void *driver_data;
474
c80e5ffa
PT		 475 __s32 delayed_value; /* For A4 Tech mice hwheel quirk */
476
aa938f79
JK		 477 /* hiddev event handler */
478 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
479 struct hid_usage *, __s32);
aa8de2f0 480 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
86166b7b
JK		 481
482 /* handler for raw output data, used by hidraw */
483 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
eab9edd2 484#ifdef CONFIG_USB_HIDINPUT_POWERBOOK
81e1a875 485 unsigned long apple_pressed_fn[BITS_TO_LONGS(KEY_CNT)];
7b19ada2 486 unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)];
eab9edd2 487#endif
1da177e4
LT		 488};
489
85cdaf52
JS		 490static inline void *hid_get_drvdata(struct hid_device *hdev)
491{
492 return dev_get_drvdata(&hdev->dev);
493}
494
495static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
496{
497 dev_set_drvdata(&hdev->dev, data);
498}
499
1da177e4
LT		 500#define HID_GLOBAL_STACK_SIZE 4
501#define HID_COLLECTION_STACK_SIZE 4
502
503struct hid_parser {
504 struct hid_global global;
505 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
506 unsigned global_stack_ptr;
507 struct hid_local local;
508 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
509 unsigned collection_stack_ptr;
510 struct hid_device *device;
511};
512
513struct hid_class_descriptor {
514 __u8 bDescriptorType;
01d7b369 515 __le16 wDescriptorLength;
1da177e4
LT		 516} __attribute__ ((packed));
517
518struct hid_descriptor {
519 __u8 bLength;
520 __u8 bDescriptorType;
01d7b369 521 __le16 bcdHID;
1da177e4
LT		 522 __u8 bCountryCode;
523 __u8 bNumDescriptors;
524
525 struct hid_class_descriptor desc[1];
526} __attribute__ ((packed));
527
85cdaf52
JS		 528#define HID_DEVICE(b, ven, prod) \
529 .bus = (b), \
530 .vendor = (ven), .product = (prod)
531
532#define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
533#define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
534
535#define HID_REPORT_ID(rep) \
536 .report_type = (rep)
537#define HID_USAGE_ID(uhid, utype, ucode) \
538 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
539/* we don't want to catch types and codes equal to 0 */
540#define HID_TERMINATOR (HID_ANY_ID - 1)
541
542struct hid_report_id {
543 __u32 report_type;
544};
545struct hid_usage_id {
546 __u32 usage_hid;
547 __u32 usage_type;
548 __u32 usage_code;
549};
550
551/**
552 * struct hid_driver
553 * @name: driver name (e.g. "Footech_bar-wheel")
554 * @id_table: which devices is this driver for (must be non-NULL for probe
555 * to be called)
556 * @probe: new device inserted
557 * @remove: device removed (NULL if not a hot-plug capable driver)
558 * @report_table: on which reports to call raw_event (NULL means all)
559 * @raw_event: if report in report_table, this hook is called (NULL means nop)
560 * @usage_table: on which events to call event (NULL means all)
561 * @event: if usage in usage_table, this hook is called (NULL means nop)
c500c971
JS		 562 * @report_fixup: called before report descriptor parsing (NULL means nop)
563 * @input_mapping: invoked on input registering before mapping an usage
564 * @input_mapped: invoked on input registering after mapping an usage
85cdaf52
JS		 565 *
566 * raw_event and event should return 0 on no action performed, 1 when no
567 * further processing should be done and negative on error
c500c971
JS		 568 *
569 * input_mapping shall return a negative value to completely ignore this usage
570 * (e.g. doubled or invalid usage), zero to continue with parsing of this
571 * usage by generic code (no special handling needed) or positive to skip
572 * generic parsing (needed special handling which was done in the hook already)
573 * input_mapped shall return negative to inform the layer that this usage
574 * should not be considered for further processing or zero to notify that
575 * no processing was performed and should be done in a generic manner
576 * Both these functions may be NULL which means the same behavior as returning
577 * zero from them.
85cdaf52
JS		 578 */
579struct hid_driver {
580 char *name;
581 const struct hid_device_id *id_table;
582
583 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
584 void (*remove)(struct hid_device *dev);
585
586 const struct hid_report_id *report_table;
587 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
588 u8 *data, int size);
589 const struct hid_usage_id *usage_table;
590 int (*event)(struct hid_device *hdev, struct hid_field *field,
591 struct hid_usage *usage, __s32 value);
c500c971
JS		 592
593 void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
594 unsigned int size);
595
596 int (*input_mapping)(struct hid_device *hdev,
597 struct hid_input *hidinput, struct hid_field *field,
598 struct hid_usage *usage, unsigned long **bit, int *max);
599 int (*input_mapped)(struct hid_device *hdev,
600 struct hid_input *hidinput, struct hid_field *field,
601 struct hid_usage *usage, unsigned long **bit, int *max);
85cdaf52
JS		 602/* private: */
603 struct device_driver driver;
604};
605
c500c971
JS		 606/**
607 * hid_ll_driver - low level driver callbacks
608 * @start: called on probe to start the device
609 * @stop: called on remove
610 * @open: called by input layer on open
611 * @close: called by input layer on close
612 * @hidinput_input_event: event input event (e.g. ff or leds)
613 * @parse: this method is called only once to parse the device data,
614 * shouldn't allocate anything to not leak memory
615 */
616struct hid_ll_driver {
617 int (*start)(struct hid_device *hdev);
618 void (*stop)(struct hid_device *hdev);
619
620 int (*open)(struct hid_device *hdev);
621 void (*close)(struct hid_device *hdev);
622
623 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
624 unsigned int code, int value);
625
626 int (*parse)(struct hid_device *hdev);
627};
628
1da177e4
LT		 629/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
630/* We ignore a few input applications that are not widely used */
f472f800 631#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
229695e5
JK		 632
633/* HID core API */
58037eb9
JK		 634
635#ifdef CONFIG_HID_DEBUG
636extern int hid_debug;
637#endif
638
85cdaf52
JS		 639extern int hid_add_device(struct hid_device *);
640extern void hid_destroy_device(struct hid_device *);
641
642extern int __must_check __hid_register_driver(struct hid_driver *,
643 struct module *, const char *mod_name);
644static inline int __must_check hid_register_driver(struct hid_driver *driver)
645{
646 return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
647}
648extern void hid_unregister_driver(struct hid_driver *);
649
7d12e780 650extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
1da177e4
LT		 651extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
652extern int hidinput_connect(struct hid_device *);
653extern void hidinput_disconnect(struct hid_device *);
1da177e4 654
1da177e4 655int hid_set_field(struct hid_field *, unsigned, __s32);
aa8de2f0 656int hid_input_report(struct hid_device *, int type, u8 *, int, int);
dde5845a 657int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
70d215c4 658int hidinput_mapping_quirks(struct hid_usage *, struct input_dev *, unsigned long **, int *);
68a1f2cc 659int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
87bc2aa9 660int hidinput_apple_event(struct hid_device *, struct input_dev *, struct hid_usage *, __s32);
dde5845a 661void hid_output_report(struct hid_report *report, __u8 *data);
85cdaf52
JS		 662struct hid_device *hid_allocate_device(void);
663int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
664
c500c971
JS		 665/**
666 * hid_parse - parse HW reports
667 *
668 * @hdev: hid device
669 *
670 * Call this from probe after you set up the device (if needed). Your
671 * report_fixup will be called (if non-NULL) after reading raw report from
672 * device before passing it to hid layer for real parsing.
673 */
674static inline int __must_check hid_parse(struct hid_device *hdev)
675{
676 int ret;
677
678 if (hdev->status & HID_STAT_PARSED)
679 return 0;
680
681 ret = hdev->ll_driver->parse(hdev);
682 if (!ret)
683 hdev->status |= HID_STAT_PARSED;
684
685 return ret;
686}
687
688/**
689 * hid_hw_start - start underlaying HW
690 *
691 * @hdev: hid device
692 *
693 * Call this in probe function *after* hid_parse. This will setup HW buffers
694 * and start the device (if not deffered to device open). hid_hw_stop must be
695 * called if this was successfull.
696 */
697static inline int __must_check hid_hw_start(struct hid_device *hdev)
698{
699 return hdev->ll_driver->start(hdev);
700}
701
702/**
703 * hid_hw_stop - stop underlaying HW
704 *
705 * @hdev: hid device
706 *
707 * This is usually called from remove function or from probe when something
708 * failed and hid_hw_start was called already.
709 */
710static inline void hid_hw_stop(struct hid_device *hdev)
711{
712 hdev->ll_driver->stop(hdev);
713}
714
85cdaf52
JS		 715void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
716 int interrupt);
717
718extern int hid_generic_init(void);
719extern void hid_generic_exit(void);
1da177e4 720
876b9276 721/* HID quirks API */
2eb5dc30 722u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
876b9276
PW		 723int usbhid_quirks_init(char **quirks_param);
724void usbhid_quirks_exit(void);
ea9a4a8b 725void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
2eb5dc30 726
1da177e4
LT		 727#ifdef CONFIG_HID_FF
728int hid_ff_init(struct hid_device *hid);
224ee88f
AH		 729
730int hid_lgff_init(struct hid_device *hid);
c17f9c90 731int hid_lg2ff_init(struct hid_device *hid);
20eb1279 732int hid_plff_init(struct hid_device *hid);
224ee88f 733int hid_tmff_init(struct hid_device *hid);
bb3caf7f 734int hid_zpff_init(struct hid_device *hid);
224ee88f
AH		 735#ifdef CONFIG_HID_PID
736int hid_pidff_init(struct hid_device *hid);
737#else
738static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
739#endif
740
1da177e4
LT		 741#else
742static inline int hid_ff_init(struct hid_device *hid) { return -1; }
743#endif
58037eb9
JK		 744
745#ifdef CONFIG_HID_DEBUG
746#define dbg_hid(format, arg...) if (hid_debug) \
747 printk(KERN_DEBUG "%s: " format ,\
748 __FILE__ , ## arg)
749#define dbg_hid_line(format, arg...) if (hid_debug) \
750 printk(format, ## arg)
229695e5 751#else
1b184cf3
JS		 752static inline int __attribute__((format(printf, 1, 2)))
753dbg_hid(const char *fmt, ...)
754{
755 return 0;
756}
58037eb9 757#define dbg_hid_line dbg_hid
229695e5
JK		 758#endif
759
58037eb9 760#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
229695e5 761 __FILE__ , ## arg)
dde5845a 762#endif
57d292bd 763#endif
224ee88f 764
kernel source for telekom puls (alcatel/mediatek)