projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
HID: move connect quirks
[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
93c10132
JS		 249/*
250 * HID connect requests
251 */
252
253#define HID_CONNECT_HIDINPUT 0x01
254#define HID_CONNECT_HIDINPUT_FORCE 0x02
255#define HID_CONNECT_HIDRAW 0x04
256#define HID_CONNECT_HIDDEV 0x08
257#define HID_CONNECT_HIDDEV_FORCE 0x10
258#define HID_CONNECT_FF 0x20
259#define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
260 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
261
1da177e4
LT		 262/*
263 * HID device quirks.
264 */
265
876b9276
PW		 266/*
267 * Increase this if you need to configure more HID quirks at module load time
268 */
269#define MAX_USBHID_BOOT_QUIRKS 4
270
eab9edd2
MH		 271#define HID_QUIRK_INVERT 0x00000001
272#define HID_QUIRK_NOTOUCH 0x00000002
eab9edd2 273#define HID_QUIRK_NOGET 0x00000008
eab9edd2
MH		 274#define HID_QUIRK_BADPAD 0x00000020
275#define HID_QUIRK_MULTI_INPUT 0x00000040
ea9a4a8b 276#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
ea9a4a8b 277#define HID_QUIRK_RESET_LEDS 0x00100000
f345c37c 278#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
ea9a4a8b 279
1da177e4
LT		 280/*
281 * This is the global environment of the parser. This information is
282 * persistent for main-items. The global environment can be saved and
283 * restored with PUSH/POP statements.
284 */
285
286struct hid_global {
287 unsigned usage_page;
288 __s32 logical_minimum;
289 __s32 logical_maximum;
290 __s32 physical_minimum;
291 __s32 physical_maximum;
292 __s32 unit_exponent;
293 unsigned unit;
294 unsigned report_id;
295 unsigned report_size;
296 unsigned report_count;
297};
298
299/*
300 * This is the local environment. It is persistent up the next main-item.
301 */
302
5f1ab74f 303#define HID_MAX_USAGES 12288
1da177e4
LT		 304#define HID_DEFAULT_NUM_COLLECTIONS 16
305
306struct hid_local {
307 unsigned usage[HID_MAX_USAGES]; /* usage array */
308 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
309 unsigned usage_index;
310 unsigned usage_minimum;
311 unsigned delimiter_depth;
312 unsigned delimiter_branch;
313};
314
315/*
316 * This is the collection stack. We climb up the stack to determine
317 * application and function of each field.
318 */
319
320struct hid_collection {
321 unsigned type;
322 unsigned usage;
323 unsigned level;
324};
325
326struct hid_usage {
327 unsigned hid; /* hid usage code */
328 unsigned collection_index; /* index into collection array */
329 /* hidinput data */
330 __u16 code; /* input driver code */
331 __u8 type; /* input driver type */
332 __s8 hat_min; /* hat switch fun */
333 __s8 hat_max; /* ditto */
334 __s8 hat_dir; /* ditto */
335};
336
337struct hid_input;
338
339struct hid_field {
340 unsigned physical; /* physical usage for this field */
341 unsigned logical; /* logical usage for this field */
342 unsigned application; /* application usage for this field */
343 struct hid_usage *usage; /* usage table for this function */
344 unsigned maxusage; /* maximum usage index */
345 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
346 unsigned report_offset; /* bit offset in the report */
347 unsigned report_size; /* size of this field in the report */
348 unsigned report_count; /* number of this field in the report */
349 unsigned report_type; /* (input,output,feature) */
350 __s32 *value; /* last known value(s) */
351 __s32 logical_minimum;
352 __s32 logical_maximum;
353 __s32 physical_minimum;
354 __s32 physical_maximum;
355 __s32 unit_exponent;
356 unsigned unit;
357 struct hid_report *report; /* associated report */
358 unsigned index; /* index into report->field[] */
359 /* hidinput data */
360 struct hid_input *hidinput; /* associated input structure */
361 __u16 dpad; /* dpad input code */
362};
363
364#define HID_MAX_FIELDS 64
365
366struct hid_report {
367 struct list_head list;
368 unsigned id; /* id of this report */
369 unsigned type; /* report type */
370 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
371 unsigned maxfield; /* maximum valid field index */
372 unsigned size; /* size of the report (bits) */
373 struct hid_device *device; /* associated device */
374};
375
376struct hid_report_enum {
377 unsigned numbered;
378 struct list_head report_list;
379 struct hid_report *report_id_hash[256];
380};
381
382#define HID_REPORT_TYPES 3
383
bf0964dc
MH		 384#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
385#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
1da177e4
LT		 386#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
387#define HID_OUTPUT_FIFO_SIZE 64
388
389struct hid_control_fifo {
390 unsigned char dir;
391 struct hid_report *report;
392};
393
394#define HID_CLAIMED_INPUT 1
395#define HID_CLAIMED_HIDDEV 2
86166b7b 396#define HID_CLAIMED_HIDRAW 4
1da177e4 397
85cdaf52 398#define HID_STAT_ADDED 1
c500c971 399#define HID_STAT_PARSED 2
85cdaf52 400
1da177e4
LT		 401#define HID_CTRL_RUNNING 1
402#define HID_OUT_RUNNING 2
aef4e266
AS		 403#define HID_IN_RUNNING 3
404#define HID_RESET_PENDING 4
405#define HID_SUSPENDED 5
6d8fc4d2 406#define HID_CLEAR_HALT 6
69626f23 407#define HID_DISCONNECTED 7
1da177e4
LT		 408
409struct hid_input {
410 struct list_head list;
411 struct hid_report *report;
c5b7c7c3 412 struct input_dev *input;
1da177e4
LT		 413};
414
85cdaf52 415struct hid_driver;
c500c971 416struct hid_ll_driver;
85cdaf52 417
1da177e4 418struct hid_device { /* device report descriptor */
85cdaf52 419 __u8 *rdesc;
1da177e4
LT		 420 unsigned rsize;
421 struct hid_collection *collection; /* List of HID collections */
422 unsigned collection_size; /* Number of allocated hid_collections */
423 unsigned maxcollection; /* Number of parsed collections */
424 unsigned maxapplication; /* Number of applications */
85cdaf52
JS		 425 __u16 bus; /* BUS ID */
426 __u32 vendor; /* Vendor ID */
427 __u32 product; /* Product ID */
428 __u32 version; /* HID version */
1da177e4
LT		 429 unsigned country; /* HID country */
430 struct hid_report_enum report_enum[HID_REPORT_TYPES];
431
85cdaf52
JS		 432 struct device dev; /* device */
433 struct hid_driver *driver;
c500c971 434 struct hid_ll_driver *ll_driver;
1da177e4 435
85cdaf52 436 unsigned int status; /* see STAT flags above */
05f091ab 437 unsigned claimed; /* Claimed by hidinput, hiddev? */
1da177e4
LT		 438 unsigned quirks; /* Various quirks the device can pull on us */
439
440 struct list_head inputs; /* The list of inputs */
441 void *hiddev; /* The hiddev structure */
86166b7b 442 void *hidraw;
1da177e4
LT		 443 int minor; /* Hiddev minor number */
444
1da177e4
LT		 445 int open; /* is the device open by anyone? */
446 char name[128]; /* Device name */
447 char phys[64]; /* Device physical location */
448 char uniq[64]; /* Device unique identifier (serial #) */
449
229695e5
JK		 450 void *driver_data;
451
93c10132
JS		 452 /* temporary hid_ff handling (until moved to the drivers) */
453 int (*ff_init)(struct hid_device *);
454
aa938f79 455 /* hiddev event handler */
93c10132 456 int (*hiddev_connect)(struct hid_device *, unsigned int);
aa938f79
JK		 457 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
458 struct hid_usage *, __s32);
aa8de2f0 459 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
86166b7b
JK		 460
461 /* handler for raw output data, used by hidraw */
462 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
1da177e4
LT		 463};
464
85cdaf52
JS		 465static inline void *hid_get_drvdata(struct hid_device *hdev)
466{
467 return dev_get_drvdata(&hdev->dev);
468}
469
470static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
471{
472 dev_set_drvdata(&hdev->dev, data);
473}
474
1da177e4
LT		 475#define HID_GLOBAL_STACK_SIZE 4
476#define HID_COLLECTION_STACK_SIZE 4
477
478struct hid_parser {
479 struct hid_global global;
480 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
481 unsigned global_stack_ptr;
482 struct hid_local local;
483 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
484 unsigned collection_stack_ptr;
485 struct hid_device *device;
486};
487
488struct hid_class_descriptor {
489 __u8 bDescriptorType;
01d7b369 490 __le16 wDescriptorLength;
1da177e4
LT		 491} __attribute__ ((packed));
492
493struct hid_descriptor {
494 __u8 bLength;
495 __u8 bDescriptorType;
01d7b369 496 __le16 bcdHID;
1da177e4
LT		 497 __u8 bCountryCode;
498 __u8 bNumDescriptors;
499
500 struct hid_class_descriptor desc[1];
501} __attribute__ ((packed));
502
85cdaf52
JS		 503#define HID_DEVICE(b, ven, prod) \
504 .bus = (b), \
505 .vendor = (ven), .product = (prod)
506
507#define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
508#define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
509
510#define HID_REPORT_ID(rep) \
511 .report_type = (rep)
512#define HID_USAGE_ID(uhid, utype, ucode) \
513 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
514/* we don't want to catch types and codes equal to 0 */
515#define HID_TERMINATOR (HID_ANY_ID - 1)
516
517struct hid_report_id {
518 __u32 report_type;
519};
520struct hid_usage_id {
521 __u32 usage_hid;
522 __u32 usage_type;
523 __u32 usage_code;
524};
525
526/**
527 * struct hid_driver
528 * @name: driver name (e.g. "Footech_bar-wheel")
529 * @id_table: which devices is this driver for (must be non-NULL for probe
530 * to be called)
531 * @probe: new device inserted
532 * @remove: device removed (NULL if not a hot-plug capable driver)
533 * @report_table: on which reports to call raw_event (NULL means all)
534 * @raw_event: if report in report_table, this hook is called (NULL means nop)
535 * @usage_table: on which events to call event (NULL means all)
536 * @event: if usage in usage_table, this hook is called (NULL means nop)
c500c971
JS		 537 * @report_fixup: called before report descriptor parsing (NULL means nop)
538 * @input_mapping: invoked on input registering before mapping an usage
539 * @input_mapped: invoked on input registering after mapping an usage
85cdaf52
JS		 540 *
541 * raw_event and event should return 0 on no action performed, 1 when no
542 * further processing should be done and negative on error
c500c971
JS		 543 *
544 * input_mapping shall return a negative value to completely ignore this usage
545 * (e.g. doubled or invalid usage), zero to continue with parsing of this
546 * usage by generic code (no special handling needed) or positive to skip
547 * generic parsing (needed special handling which was done in the hook already)
548 * input_mapped shall return negative to inform the layer that this usage
549 * should not be considered for further processing or zero to notify that
550 * no processing was performed and should be done in a generic manner
551 * Both these functions may be NULL which means the same behavior as returning
552 * zero from them.
85cdaf52
JS		 553 */
554struct hid_driver {
555 char *name;
556 const struct hid_device_id *id_table;
557
558 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
559 void (*remove)(struct hid_device *dev);
560
561 const struct hid_report_id *report_table;
562 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
563 u8 *data, int size);
564 const struct hid_usage_id *usage_table;
565 int (*event)(struct hid_device *hdev, struct hid_field *field,
566 struct hid_usage *usage, __s32 value);
c500c971
JS		 567
568 void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
569 unsigned int size);
570
571 int (*input_mapping)(struct hid_device *hdev,
572 struct hid_input *hidinput, struct hid_field *field,
573 struct hid_usage *usage, unsigned long **bit, int *max);
574 int (*input_mapped)(struct hid_device *hdev,
575 struct hid_input *hidinput, struct hid_field *field,
576 struct hid_usage *usage, unsigned long **bit, int *max);
85cdaf52
JS		 577/* private: */
578 struct device_driver driver;
579};
580
c500c971
JS		 581/**
582 * hid_ll_driver - low level driver callbacks
583 * @start: called on probe to start the device
584 * @stop: called on remove
585 * @open: called by input layer on open
586 * @close: called by input layer on close
587 * @hidinput_input_event: event input event (e.g. ff or leds)
588 * @parse: this method is called only once to parse the device data,
589 * shouldn't allocate anything to not leak memory
590 */
591struct hid_ll_driver {
592 int (*start)(struct hid_device *hdev);
593 void (*stop)(struct hid_device *hdev);
594
595 int (*open)(struct hid_device *hdev);
596 void (*close)(struct hid_device *hdev);
597
598 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
599 unsigned int code, int value);
600
601 int (*parse)(struct hid_device *hdev);
602};
603
1da177e4
LT		 604/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
605/* We ignore a few input applications that are not widely used */
f472f800 606#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
229695e5
JK		 607
608/* HID core API */
58037eb9
JK		 609
610#ifdef CONFIG_HID_DEBUG
611extern int hid_debug;
612#endif
613
85cdaf52
JS		 614extern int hid_add_device(struct hid_device *);
615extern void hid_destroy_device(struct hid_device *);
616
617extern int __must_check __hid_register_driver(struct hid_driver *,
618 struct module *, const char *mod_name);
619static inline int __must_check hid_register_driver(struct hid_driver *driver)
620{
621 return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
622}
623extern void hid_unregister_driver(struct hid_driver *);
624
7d12e780 625extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
1da177e4 626extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
93c10132 627extern int hidinput_connect(struct hid_device *hid, unsigned int force);
1da177e4 628extern void hidinput_disconnect(struct hid_device *);
1da177e4 629
1da177e4 630int hid_set_field(struct hid_field *, unsigned, __s32);
aa8de2f0 631int hid_input_report(struct hid_device *, int type, u8 *, int, int);
dde5845a 632int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
dde5845a 633void hid_output_report(struct hid_report *report, __u8 *data);
85cdaf52
JS		 634struct hid_device *hid_allocate_device(void);
635int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
93c10132 636int hid_connect(struct hid_device *hid, unsigned int connect_mask);
85cdaf52 637
022e8c4d
JS		 638/**
639 * hid_map_usage - map usage input bits
640 *
641 * @hidinput: hidinput which we are interested in
642 * @usage: usage to fill in
643 * @bit: pointer to input->{}bit (out parameter)
644 * @max: maximal valid usage->code to consider later (out parameter)
645 * @type: input event type (EV_KEY, EV_REL, ...)
646 * @c: code which corresponds to this usage and type
647 */
648static inline void hid_map_usage(struct hid_input *hidinput,
649 struct hid_usage *usage, unsigned long **bit, int *max,
650 __u8 type, __u16 c)
651{
652 struct input_dev *input = hidinput->input;
653
654 usage->type = type;
655 usage->code = c;
656
657 switch (type) {
658 case EV_ABS:
659 *bit = input->absbit;
660 *max = ABS_MAX;
661 break;
662 case EV_REL:
663 *bit = input->relbit;
664 *max = REL_MAX;
665 break;
666 case EV_KEY:
667 *bit = input->keybit;
668 *max = KEY_MAX;
669 break;
670 case EV_LED:
671 *bit = input->ledbit;
672 *max = LED_MAX;
673 break;
674 }
675}
676
677/**
678 * hid_map_usage_clear - map usage input bits and clear the input bit
679 *
680 * The same as hid_map_usage, except the @c bit is also cleared in supported
681 * bits (@bit).
682 */
683static inline void hid_map_usage_clear(struct hid_input *hidinput,
684 struct hid_usage *usage, unsigned long **bit, int *max,
685 __u8 type, __u16 c)
686{
687 hid_map_usage(hidinput, usage, bit, max, type, c);
688 clear_bit(c, *bit);
689}
690
c500c971
JS		 691/**
692 * hid_parse - parse HW reports
693 *
694 * @hdev: hid device
695 *
696 * Call this from probe after you set up the device (if needed). Your
697 * report_fixup will be called (if non-NULL) after reading raw report from
698 * device before passing it to hid layer for real parsing.
699 */
700static inline int __must_check hid_parse(struct hid_device *hdev)
701{
702 int ret;
703
704 if (hdev->status & HID_STAT_PARSED)
705 return 0;
706
707 ret = hdev->ll_driver->parse(hdev);
708 if (!ret)
709 hdev->status |= HID_STAT_PARSED;
710
711 return ret;
712}
713
714/**
715 * hid_hw_start - start underlaying HW
716 *
717 * @hdev: hid device
93c10132 718 * @connect_mask: which outputs to connect, see HID_CONNECT_*
c500c971
JS		 719 *
720 * Call this in probe function *after* hid_parse. This will setup HW buffers
721 * and start the device (if not deffered to device open). hid_hw_stop must be
722 * called if this was successfull.
723 */
93c10132
JS		 724static inline int __must_check hid_hw_start(struct hid_device *hdev,
725 unsigned int connect_mask)
c500c971 726{
93c10132
JS		 727 int ret = hdev->ll_driver->start(hdev);
728 if (ret || !connect_mask)
729 return ret;
730 ret = hid_connect(hdev, connect_mask);
731 if (ret)
732 hdev->ll_driver->stop(hdev);
733 return ret;
c500c971
JS		 734}
735
736/**
737 * hid_hw_stop - stop underlaying HW
738 *
739 * @hdev: hid device
740 *
741 * This is usually called from remove function or from probe when something
742 * failed and hid_hw_start was called already.
743 */
744static inline void hid_hw_stop(struct hid_device *hdev)
745{
746 hdev->ll_driver->stop(hdev);
747}
748
85cdaf52
JS		 749void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
750 int interrupt);
751
752extern int hid_generic_init(void);
753extern void hid_generic_exit(void);
1da177e4 754
876b9276 755/* HID quirks API */
2eb5dc30 756u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
876b9276
PW		 757int usbhid_quirks_init(char **quirks_param);
758void usbhid_quirks_exit(void);
2eb5dc30 759
1da177e4
LT		 760#ifdef CONFIG_HID_FF
761int hid_ff_init(struct hid_device *hid);
224ee88f
AH		 762
763int hid_lgff_init(struct hid_device *hid);
c17f9c90 764int hid_lg2ff_init(struct hid_device *hid);
20eb1279 765int hid_plff_init(struct hid_device *hid);
224ee88f 766int hid_tmff_init(struct hid_device *hid);
bb3caf7f 767int hid_zpff_init(struct hid_device *hid);
224ee88f
AH		 768#ifdef CONFIG_HID_PID
769int hid_pidff_init(struct hid_device *hid);
770#else
771static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
772#endif
773
1da177e4 774#else
93c10132 775#define hid_ff_init NULL
1da177e4 776#endif
58037eb9
JK		 777
778#ifdef CONFIG_HID_DEBUG
779#define dbg_hid(format, arg...) if (hid_debug) \
780 printk(KERN_DEBUG "%s: " format ,\
781 __FILE__ , ## arg)
782#define dbg_hid_line(format, arg...) if (hid_debug) \
783 printk(format, ## arg)
229695e5 784#else
1b184cf3
JS		 785static inline int __attribute__((format(printf, 1, 2)))
786dbg_hid(const char *fmt, ...)
787{
788 return 0;
789}
58037eb9 790#define dbg_hid_line dbg_hid
02ae9a1a 791#endif /* HID_DEBUG */
229695e5 792
58037eb9 793#define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
229695e5 794 __FILE__ , ## arg)
02ae9a1a
JS		 795#endif /* HID_FF */
796
797#ifdef CONFIG_HID_COMPAT
798#define HID_COMPAT_LOAD_DRIVER(name) \
799void hid_compat_##name(void) { } \
800EXPORT_SYMBOL(hid_compat_##name)
801#else
802#define HID_COMPAT_LOAD_DRIVER(name)
803#endif /* HID_COMPAT */
804#define HID_COMPAT_CALL_DRIVER(name) do { \
805 extern void hid_compat_##name(void); \
806 hid_compat_##name(); \
807} while (0)
808
57d292bd 809#endif
224ee88f 810
kernel source for telekom puls (alcatel/mediatek)