projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
HID: hid-steelseries fix led class build issue
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / hid.h
CommitLineData
1da177e4 1/*
1da177e4
LT		 2 * Copyright (c) 1999 Andreas Gal
3 * Copyright (c) 2000-2001 Vojtech Pavlik
b55fd23c 4 * Copyright (c) 2006-2007 Jiri Kosina
1da177e4 5 */
1da177e4
LT		 6/*
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 * Should you need to contact me, the author, you can do so either by
22 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
23 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
24 */
607ca46e
DH		 25#ifndef __HID_H
26#define __HID_H
1da177e4 27
57d292bd
JK		 28
29#include <linux/types.h>
30#include <linux/slab.h>
31#include <linux/list.h>
e8c84f9a 32#include <linux/mod_devicetable.h> /* hid_device_id */
57d292bd
JK		 33#include <linux/timer.h>
34#include <linux/workqueue.h>
35#include <linux/input.h>
4ea54542 36#include <linux/semaphore.h>
4f5ca836 37#include <linux/power_supply.h>
607ca46e 38#include <uapi/linux/hid.h>
57d292bd 39
1da177e4
LT		 40/*
41 * We parse each description item into this structure. Short items data
42 * values are expanded to 32-bit signed int, long items contain a pointer
43 * into the data area.
44 */
45
46struct hid_item {
47 unsigned format;
48 __u8 size;
49 __u8 type;
50 __u8 tag;
51 union {
52 __u8 u8;
53 __s8 s8;
54 __u16 u16;
55 __s16 s16;
56 __u32 u32;
57 __s32 s32;
58 __u8 *longdata;
59 } data;
60};
61
62/*
63 * HID report item format
64 */
65
66#define HID_ITEM_FORMAT_SHORT 0
67#define HID_ITEM_FORMAT_LONG 1
68
69/*
70 * Special tag indicating long items
71 */
72
73#define HID_ITEM_TAG_LONG 15
74
75/*
76 * HID report descriptor item type (prefix bit 2,3)
77 */
78
79#define HID_ITEM_TYPE_MAIN 0
80#define HID_ITEM_TYPE_GLOBAL 1
81#define HID_ITEM_TYPE_LOCAL 2
82#define HID_ITEM_TYPE_RESERVED 3
83
84/*
85 * HID report descriptor main item tags
86 */
87
88#define HID_MAIN_ITEM_TAG_INPUT 8
89#define HID_MAIN_ITEM_TAG_OUTPUT 9
90#define HID_MAIN_ITEM_TAG_FEATURE 11
91#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
92#define HID_MAIN_ITEM_TAG_END_COLLECTION 12
93
94/*
95 * HID report descriptor main item contents
96 */
97
98#define HID_MAIN_ITEM_CONSTANT 0x001
99#define HID_MAIN_ITEM_VARIABLE 0x002
100#define HID_MAIN_ITEM_RELATIVE 0x004
05f091ab 101#define HID_MAIN_ITEM_WRAP 0x008
1da177e4
LT		 102#define HID_MAIN_ITEM_NONLINEAR 0x010
103#define HID_MAIN_ITEM_NO_PREFERRED 0x020
104#define HID_MAIN_ITEM_NULL_STATE 0x040
105#define HID_MAIN_ITEM_VOLATILE 0x080
106#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
107
108/*
109 * HID report descriptor collection item types
110 */
111
112#define HID_COLLECTION_PHYSICAL 0
113#define HID_COLLECTION_APPLICATION 1
114#define HID_COLLECTION_LOGICAL 2
115
116/*
117 * HID report descriptor global item tags
118 */
119
120#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
121#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
122#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
123#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
124#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
125#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
126#define HID_GLOBAL_ITEM_TAG_UNIT 6
127#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
128#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
129#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
130#define HID_GLOBAL_ITEM_TAG_PUSH 10
131#define HID_GLOBAL_ITEM_TAG_POP 11
132
133/*
134 * HID report descriptor local item tags
135 */
136
137#define HID_LOCAL_ITEM_TAG_USAGE 0
138#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
139#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
140#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
141#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
142#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
143#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
144#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
145#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
146#define HID_LOCAL_ITEM_TAG_DELIMITER 10
147
148/*
149 * HID usage tables
150 */
151
152#define HID_USAGE_PAGE 0xffff0000
153
154#define HID_UP_UNDEFINED 0x00000000
05f091ab 155#define HID_UP_GENDESK 0x00010000
0aebfdac 156#define HID_UP_SIMULATION 0x00020000
4f5ca836 157#define HID_UP_GENDEVCTRLS 0x00060000
05f091ab
DT		 158#define HID_UP_KEYBOARD 0x00070000
159#define HID_UP_LED 0x00080000
160#define HID_UP_BUTTON 0x00090000
161#define HID_UP_ORDINAL 0x000a0000
1da177e4 162#define HID_UP_CONSUMER 0x000c0000
05f091ab
DT		 163#define HID_UP_DIGITIZER 0x000d0000
164#define HID_UP_PID 0x000f0000
1da177e4 165#define HID_UP_HPVENDOR 0xff7f0000
929578ab 166#define HID_UP_HPVENDOR2 0xff010000
1da177e4 167#define HID_UP_MSVENDOR 0xff000000
e875ce37
SP		 168#define HID_UP_CUSTOM 0x00ff0000
169#define HID_UP_LOGIVENDOR 0xffbc0000
83499b52 170#define HID_UP_SENSOR 0x00200000
1da177e4
LT		 171
172#define HID_USAGE 0x0000ffff
173
174#define HID_GD_POINTER 0x00010001
175#define HID_GD_MOUSE 0x00010002
176#define HID_GD_JOYSTICK 0x00010004
177#define HID_GD_GAMEPAD 0x00010005
178#define HID_GD_KEYBOARD 0x00010006
179#define HID_GD_KEYPAD 0x00010007
180#define HID_GD_MULTIAXIS 0x00010008
181#define HID_GD_X 0x00010030
182#define HID_GD_Y 0x00010031
183#define HID_GD_Z 0x00010032
184#define HID_GD_RX 0x00010033
185#define HID_GD_RY 0x00010034
186#define HID_GD_RZ 0x00010035
187#define HID_GD_SLIDER 0x00010036
188#define HID_GD_DIAL 0x00010037
189#define HID_GD_WHEEL 0x00010038
190#define HID_GD_HATSWITCH 0x00010039
191#define HID_GD_BUFFER 0x0001003a
192#define HID_GD_BYTECOUNT 0x0001003b
193#define HID_GD_MOTION 0x0001003c
194#define HID_GD_START 0x0001003d
195#define HID_GD_SELECT 0x0001003e
196#define HID_GD_VX 0x00010040
197#define HID_GD_VY 0x00010041
198#define HID_GD_VZ 0x00010042
199#define HID_GD_VBRX 0x00010043
200#define HID_GD_VBRY 0x00010044
201#define HID_GD_VBRZ 0x00010045
202#define HID_GD_VNO 0x00010046
203#define HID_GD_FEATURE 0x00010047
204#define HID_GD_UP 0x00010090
205#define HID_GD_DOWN 0x00010091
206#define HID_GD_RIGHT 0x00010092
207#define HID_GD_LEFT 0x00010093
208
4f5ca836
JF		 209#define HID_DC_BATTERYSTRENGTH 0x00060020
210
89f536cc
SC		 211#define HID_DG_DIGITIZER 0x000d0001
212#define HID_DG_PEN 0x000d0002
213#define HID_DG_LIGHTPEN 0x000d0003
214#define HID_DG_TOUCHSCREEN 0x000d0004
215#define HID_DG_TOUCHPAD 0x000d0005
216#define HID_DG_STYLUS 0x000d0020
217#define HID_DG_PUCK 0x000d0021
218#define HID_DG_FINGER 0x000d0022
219#define HID_DG_TIPPRESSURE 0x000d0030
220#define HID_DG_BARRELPRESSURE 0x000d0031
221#define HID_DG_INRANGE 0x000d0032
222#define HID_DG_TOUCH 0x000d0033
223#define HID_DG_UNTOUCH 0x000d0034
224#define HID_DG_TAP 0x000d0035
225#define HID_DG_TABLETFUNCTIONKEY 0x000d0039
226#define HID_DG_PROGRAMCHANGEKEY 0x000d003a
227#define HID_DG_INVERT 0x000d003c
228#define HID_DG_TIPSWITCH 0x000d0042
229#define HID_DG_TIPSWITCH2 0x000d0043
230#define HID_DG_BARRELSWITCH 0x000d0044
231#define HID_DG_ERASER 0x000d0045
232#define HID_DG_TABLETPICK 0x000d0046
233/*
234 * as of May 20, 2009 the usages below are not yet in the official USB spec
235 * but are being pushed by Microsft as described in their paper "Digitizer
236 * Drivers for Windows Touch and Pen-Based Computers"
237 */
238#define HID_DG_CONFIDENCE 0x000d0047
239#define HID_DG_WIDTH 0x000d0048
240#define HID_DG_HEIGHT 0x000d0049
241#define HID_DG_CONTACTID 0x000d0051
242#define HID_DG_INPUTMODE 0x000d0052
243#define HID_DG_DEVICEINDEX 0x000d0053
244#define HID_DG_CONTACTCOUNT 0x000d0054
245#define HID_DG_CONTACTMAX 0x000d0055
246
1da177e4
LT		 247/*
248 * HID report types --- Ouch! HID spec says 1 2 3!
249 */
250
251#define HID_INPUT_REPORT 0
252#define HID_OUTPUT_REPORT 1
253#define HID_FEATURE_REPORT 2
254
93c10132
JS		 255/*
256 * HID connect requests
257 */
258
259#define HID_CONNECT_HIDINPUT 0x01
260#define HID_CONNECT_HIDINPUT_FORCE 0x02
261#define HID_CONNECT_HIDRAW 0x04
262#define HID_CONNECT_HIDDEV 0x08
263#define HID_CONNECT_HIDDEV_FORCE 0x10
264#define HID_CONNECT_FF 0x20
265#define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
266 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
267
1da177e4
LT		 268/*
269 * HID device quirks.
270 */
271
876b9276
PW		 272/*
273 * Increase this if you need to configure more HID quirks at module load time
274 */
275#define MAX_USBHID_BOOT_QUIRKS 4
276
eab9edd2
MH		 277#define HID_QUIRK_INVERT 0x00000001
278#define HID_QUIRK_NOTOUCH 0x00000002
6f4303fb 279#define HID_QUIRK_IGNORE 0x00000004
eab9edd2 280#define HID_QUIRK_NOGET 0x00000008
b5e5a37e 281#define HID_QUIRK_HIDDEV_FORCE 0x00000010
eab9edd2
MH		 282#define HID_QUIRK_BADPAD 0x00000020
283#define HID_QUIRK_MULTI_INPUT 0x00000040
3a343ee4 284#define HID_QUIRK_HIDINPUT_FORCE 0x00000080
4f22decf 285#define HID_QUIRK_NO_EMPTY_INPUT 0x00000100
ea9a4a8b 286#define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
f345c37c 287#define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
5b915d9e 288#define HID_QUIRK_NO_INIT_REPORTS 0x20000000
b5e5a37e 289#define HID_QUIRK_NO_IGNORE 0x40000000
24750f3e 290#define HID_QUIRK_NO_INPUT_SYNC 0x80000000
ea9a4a8b 291
734c6609
HR		 292/*
293 * HID device groups
294 */
295#define HID_GROUP_GENERIC 0x0001
4fa3a583 296#define HID_GROUP_MULTITOUCH 0x0002
83499b52 297#define HID_GROUP_SENSOR_HUB 0x0003
734c6609 298
1da177e4
LT		 299/*
300 * This is the global environment of the parser. This information is
301 * persistent for main-items. The global environment can be saved and
302 * restored with PUSH/POP statements.
303 */
304
305struct hid_global {
306 unsigned usage_page;
307 __s32 logical_minimum;
308 __s32 logical_maximum;
309 __s32 physical_minimum;
310 __s32 physical_maximum;
311 __s32 unit_exponent;
312 unsigned unit;
313 unsigned report_id;
314 unsigned report_size;
315 unsigned report_count;
316};
317
318/*
319 * This is the local environment. It is persistent up the next main-item.
320 */
321
5f1ab74f 322#define HID_MAX_USAGES 12288
1da177e4
LT		 323#define HID_DEFAULT_NUM_COLLECTIONS 16
324
325struct hid_local {
326 unsigned usage[HID_MAX_USAGES]; /* usage array */
327 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
328 unsigned usage_index;
329 unsigned usage_minimum;
330 unsigned delimiter_depth;
331 unsigned delimiter_branch;
332};
333
334/*
335 * This is the collection stack. We climb up the stack to determine
336 * application and function of each field.
337 */
338
339struct hid_collection {
340 unsigned type;
341 unsigned usage;
342 unsigned level;
343};
344
345struct hid_usage {
346 unsigned hid; /* hid usage code */
347 unsigned collection_index; /* index into collection array */
f262d1fa 348 unsigned usage_index; /* index into usage array */
1da177e4
LT		 349 /* hidinput data */
350 __u16 code; /* input driver code */
351 __u8 type; /* input driver type */
352 __s8 hat_min; /* hat switch fun */
353 __s8 hat_max; /* ditto */
354 __s8 hat_dir; /* ditto */
355};
356
357struct hid_input;
358
359struct hid_field {
360 unsigned physical; /* physical usage for this field */
361 unsigned logical; /* logical usage for this field */
362 unsigned application; /* application usage for this field */
363 struct hid_usage *usage; /* usage table for this function */
364 unsigned maxusage; /* maximum usage index */
365 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
366 unsigned report_offset; /* bit offset in the report */
367 unsigned report_size; /* size of this field in the report */
368 unsigned report_count; /* number of this field in the report */
369 unsigned report_type; /* (input,output,feature) */
370 __s32 *value; /* last known value(s) */
371 __s32 logical_minimum;
372 __s32 logical_maximum;
373 __s32 physical_minimum;
374 __s32 physical_maximum;
375 __s32 unit_exponent;
376 unsigned unit;
377 struct hid_report *report; /* associated report */
378 unsigned index; /* index into report->field[] */
379 /* hidinput data */
380 struct hid_input *hidinput; /* associated input structure */
381 __u16 dpad; /* dpad input code */
382};
383
7e55bded 384#define HID_MAX_FIELDS 256
1da177e4
LT		 385
386struct hid_report {
387 struct list_head list;
388 unsigned id; /* id of this report */
389 unsigned type; /* report type */
390 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
391 unsigned maxfield; /* maximum valid field index */
392 unsigned size; /* size of the report (bits) */
393 struct hid_device *device; /* associated device */
394};
395
396struct hid_report_enum {
397 unsigned numbered;
398 struct list_head report_list;
399 struct hid_report *report_id_hash[256];
400};
401
402#define HID_REPORT_TYPES 3
403
bf0964dc
MH		 404#define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
405#define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
1da177e4
LT		 406#define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
407#define HID_OUTPUT_FIFO_SIZE 64
408
409struct hid_control_fifo {
410 unsigned char dir;
411 struct hid_report *report;
f129ea6d
AH		 412 char *raw_report;
413};
414
415struct hid_output_fifo {
416 struct hid_report *report;
417 char *raw_report;
1da177e4
LT		 418};
419
420#define HID_CLAIMED_INPUT 1
421#define HID_CLAIMED_HIDDEV 2
86166b7b 422#define HID_CLAIMED_HIDRAW 4
1da177e4 423
85cdaf52 424#define HID_STAT_ADDED 1
c500c971 425#define HID_STAT_PARSED 2
85cdaf52 426
1da177e4
LT		 427struct hid_input {
428 struct list_head list;
429 struct hid_report *report;
c5b7c7c3 430 struct input_dev *input;
1da177e4
LT		 431};
432
a73a6370
JS		 433enum hid_type {
434 HID_TYPE_OTHER = 0,
6dc1418e
TS		 435 HID_TYPE_USBMOUSE,
436 HID_TYPE_USBNONE
a73a6370
JS		 437};
438
85cdaf52 439struct hid_driver;
c500c971 440struct hid_ll_driver;
85cdaf52 441
1da177e4 442struct hid_device { /* device report descriptor */
a7197c2e
HR		 443 __u8 *dev_rdesc;
444 unsigned dev_rsize;
85cdaf52 445 __u8 *rdesc;
1da177e4
LT		 446 unsigned rsize;
447 struct hid_collection *collection; /* List of HID collections */
448 unsigned collection_size; /* Number of allocated hid_collections */
449 unsigned maxcollection; /* Number of parsed collections */
450 unsigned maxapplication; /* Number of applications */
85cdaf52 451 __u16 bus; /* BUS ID */
4d53b801 452 __u16 group; /* Report group */
85cdaf52
JS		 453 __u32 vendor; /* Vendor ID */
454 __u32 product; /* Product ID */
455 __u32 version; /* HID version */
a73a6370 456 enum hid_type type; /* device type (mouse, kbd, ...) */
1da177e4
LT		 457 unsigned country; /* HID country */
458 struct hid_report_enum report_enum[HID_REPORT_TYPES];
459
c849a614
AR		 460 struct semaphore driver_lock; /* protects the current driver, except during input */
461 struct semaphore driver_input_lock; /* protects the current driver */
85cdaf52
JS		 462 struct device dev; /* device */
463 struct hid_driver *driver;
c500c971 464 struct hid_ll_driver *ll_driver;
1da177e4 465
4f5ca836
JF		 466#ifdef CONFIG_HID_BATTERY_STRENGTH
467 /*
468 * Power supply information for HID devices which report
469 * battery strength. power_supply is registered iff
470 * battery.name is non-NULL.
471 */
472 struct power_supply battery;
473 __s32 battery_min;
474 __s32 battery_max;
fb8ac91b 475 __s32 battery_report_type;
c5a92aa3 476 __s32 battery_report_id;
4f5ca836
JF		 477#endif
478
85cdaf52 479 unsigned int status; /* see STAT flags above */
05f091ab 480 unsigned claimed; /* Claimed by hidinput, hiddev? */
1da177e4 481 unsigned quirks; /* Various quirks the device can pull on us */
c849a614 482 bool io_started; /* Protected by driver_lock. If IO has started */
1da177e4
LT		 483
484 struct list_head inputs; /* The list of inputs */
485 void *hiddev; /* The hiddev structure */
86166b7b 486 void *hidraw;
1da177e4
LT		 487 int minor; /* Hiddev minor number */
488
1da177e4
LT		 489 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
229695e5
JK		 494 void *driver_data;
495
93c10132
JS		 496 /* temporary hid_ff handling (until moved to the drivers) */
497 int (*ff_init)(struct hid_device *);
498
aa938f79 499 /* hiddev event handler */
93c10132 500 int (*hiddev_connect)(struct hid_device *, unsigned int);
c4c259bc 501 void (*hiddev_disconnect)(struct hid_device *);
aa938f79
JK		 502 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
503 struct hid_usage *, __s32);
aa8de2f0 504 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
86166b7b 505
b4dbde9d
AO		 506 /* handler for raw input (Get_Report) data, used by hidraw */
507 int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char);
508
86166b7b 509 /* handler for raw output data, used by hidraw */
d4bfa033 510 int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char);
cd667ce2
JK		 511
512 /* debugging support via debugfs */
513 unsigned short debug;
514 struct dentry *debug_dir;
515 struct dentry *debug_rdesc;
516 struct dentry *debug_events;
517 struct list_head debug_list;
2353f2be 518 struct mutex debug_list_lock;
cd667ce2 519 wait_queue_head_t debug_wait;
1da177e4
LT		 520};
521
85cdaf52
JS		 522static inline void *hid_get_drvdata(struct hid_device *hdev)
523{
524 return dev_get_drvdata(&hdev->dev);
525}
526
527static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
528{
529 dev_set_drvdata(&hdev->dev, data);
530}
531
1da177e4
LT		 532#define HID_GLOBAL_STACK_SIZE 4
533#define HID_COLLECTION_STACK_SIZE 4
534
535struct hid_parser {
536 struct hid_global global;
537 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
538 unsigned global_stack_ptr;
539 struct hid_local local;
540 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
541 unsigned collection_stack_ptr;
542 struct hid_device *device;
543};
544
545struct hid_class_descriptor {
546 __u8 bDescriptorType;
01d7b369 547 __le16 wDescriptorLength;
1da177e4
LT		 548} __attribute__ ((packed));
549
550struct hid_descriptor {
551 __u8 bLength;
552 __u8 bDescriptorType;
01d7b369 553 __le16 bcdHID;
1da177e4
LT		 554 __u8 bCountryCode;
555 __u8 bNumDescriptors;
556
557 struct hid_class_descriptor desc[1];
558} __attribute__ ((packed));
559
070748ed
HR		 560#define HID_DEVICE(b, g, ven, prod) \
561 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
562#define HID_USB_DEVICE(ven, prod) \
563 .bus = BUS_USB, .vendor = (ven), .product = (prod)
564#define HID_BLUETOOTH_DEVICE(ven, prod) \
565 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
85cdaf52
JS		 566
567#define HID_REPORT_ID(rep) \
568 .report_type = (rep)
569#define HID_USAGE_ID(uhid, utype, ucode) \
570 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
571/* we don't want to catch types and codes equal to 0 */
572#define HID_TERMINATOR (HID_ANY_ID - 1)
573
574struct hid_report_id {
575 __u32 report_type;
576};
577struct hid_usage_id {
578 __u32 usage_hid;
579 __u32 usage_type;
580 __u32 usage_code;
581};
582
583/**
584 * struct hid_driver
585 * @name: driver name (e.g. "Footech_bar-wheel")
586 * @id_table: which devices is this driver for (must be non-NULL for probe
587 * to be called)
3a6f82f7
JS		 588 * @dyn_list: list of dynamically added device ids
589 * @dyn_lock: lock protecting @dyn_list
85cdaf52
JS		 590 * @probe: new device inserted
591 * @remove: device removed (NULL if not a hot-plug capable driver)
592 * @report_table: on which reports to call raw_event (NULL means all)
593 * @raw_event: if report in report_table, this hook is called (NULL means nop)
594 * @usage_table: on which events to call event (NULL means all)
595 * @event: if usage in usage_table, this hook is called (NULL means nop)
6d85d037 596 * @report: this hook is called after parsing a report (NULL means nop)
c500c971
JS		 597 * @report_fixup: called before report descriptor parsing (NULL means nop)
598 * @input_mapping: invoked on input registering before mapping an usage
599 * @input_mapped: invoked on input registering after mapping an usage
9ebf3d76 600 * @input_configured: invoked just before the device is registered
0d2689c0 601 * @feature_mapping: invoked on feature registering
6a740aa4
BP		 602 * @suspend: invoked on suspend (NULL means nop)
603 * @resume: invoked on resume if device was not reset (NULL means nop)
604 * @reset_resume: invoked on resume if device was reset (NULL means nop)
85cdaf52 605 *
c849a614
AR		 606 * probe should return -errno on error, or 0 on success. During probe,
607 * input will not be passed to raw_event unless hid_device_io_start is
608 * called.
609 *
85cdaf52
JS		 610 * raw_event and event should return 0 on no action performed, 1 when no
611 * further processing should be done and negative on error
c500c971
JS		 612 *
613 * input_mapping shall return a negative value to completely ignore this usage
614 * (e.g. doubled or invalid usage), zero to continue with parsing of this
615 * usage by generic code (no special handling needed) or positive to skip
616 * generic parsing (needed special handling which was done in the hook already)
617 * input_mapped shall return negative to inform the layer that this usage
618 * should not be considered for further processing or zero to notify that
619 * no processing was performed and should be done in a generic manner
620 * Both these functions may be NULL which means the same behavior as returning
621 * zero from them.
85cdaf52
JS		 622 */
623struct hid_driver {
624 char *name;
625 const struct hid_device_id *id_table;
626
3a6f82f7
JS		 627 struct list_head dyn_list;
628 spinlock_t dyn_lock;
629
85cdaf52
JS		 630 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
631 void (*remove)(struct hid_device *dev);
632
633 const struct hid_report_id *report_table;
634 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
635 u8 *data, int size);
636 const struct hid_usage_id *usage_table;
637 int (*event)(struct hid_device *hdev, struct hid_field *field,
638 struct hid_usage *usage, __s32 value);
6d85d037 639 void (*report)(struct hid_device *hdev, struct hid_report *report);
c500c971 640
73e4008d
NK		 641 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
642 unsigned int *size);
c500c971
JS		 643
644 int (*input_mapping)(struct hid_device *hdev,
645 struct hid_input *hidinput, struct hid_field *field,
646 struct hid_usage *usage, unsigned long **bit, int *max);
647 int (*input_mapped)(struct hid_device *hdev,
648 struct hid_input *hidinput, struct hid_field *field,
649 struct hid_usage *usage, unsigned long **bit, int *max);
9ebf3d76
HR		 650 void (*input_configured)(struct hid_device *hdev,
651 struct hid_input *hidinput);
0d2689c0 652 void (*feature_mapping)(struct hid_device *hdev,
f635bd11 653 struct hid_field *field,
0d2689c0 654 struct hid_usage *usage);
6a740aa4
BP		 655#ifdef CONFIG_PM
656 int (*suspend)(struct hid_device *hdev, pm_message_t message);
657 int (*resume)(struct hid_device *hdev);
658 int (*reset_resume)(struct hid_device *hdev);
659#endif
85cdaf52
JS		 660/* private: */
661 struct device_driver driver;
662};
663
c500c971
JS		 664/**
665 * hid_ll_driver - low level driver callbacks
666 * @start: called on probe to start the device
667 * @stop: called on remove
668 * @open: called by input layer on open
669 * @close: called by input layer on close
670 * @hidinput_input_event: event input event (e.g. ff or leds)
671 * @parse: this method is called only once to parse the device data,
672 * shouldn't allocate anything to not leak memory
e90a6df8 673 * @request: send report request to device (e.g. feature report)
3373443b 674 * @wait: wait for buffered io to complete (send/recv reports)
9684819b 675 * @idle: send idle request to device
c500c971
JS		 676 */
677struct hid_ll_driver {
678 int (*start)(struct hid_device *hdev);
679 void (*stop)(struct hid_device *hdev);
680
681 int (*open)(struct hid_device *hdev);
682 void (*close)(struct hid_device *hdev);
683
0361a28d
ON		 684 int (*power)(struct hid_device *hdev, int level);
685
c500c971
JS		 686 int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
687 unsigned int code, int value);
688
689 int (*parse)(struct hid_device *hdev);
e90a6df8
HR		 690
691 void (*request)(struct hid_device *hdev,
692 struct hid_report *report, int reqtype);
693
3373443b 694 int (*wait)(struct hid_device *hdev);
9684819b 695 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
3373443b 696
c500c971
JS		 697};
698
0361a28d
ON		 699#define PM_HINT_FULLON 1<<5
700#define PM_HINT_NORMAL 1<<1
701
1da177e4
LT		 702/* Applications from HID Usage Tables 4/8/99 Version 1.1 */
703/* We ignore a few input applications that are not widely used */
8b0e58a7 704#define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
229695e5
JK		 705
706/* HID core API */
58037eb9 707
58037eb9 708extern int hid_debug;
58037eb9 709
4529eefa 710extern bool hid_ignore(struct hid_device *);
85cdaf52
JS		 711extern int hid_add_device(struct hid_device *);
712extern void hid_destroy_device(struct hid_device *);
713
714extern int __must_check __hid_register_driver(struct hid_driver *,
715 struct module *, const char *mod_name);
eb5589a8
PG		 716
717/* use a define to avoid include chaining to get THIS_MODULE & friends */
718#define hid_register_driver(driver) \
719 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
720
85cdaf52
JS		 721extern void hid_unregister_driver(struct hid_driver *);
722
4d02c58e
HS		 723/**
724 * module_hid_driver() - Helper macro for registering a HID driver
725 * @__hid_driver: hid_driver struct
726 *
727 * Helper macro for HID drivers which do not do anything special in module
728 * init/exit. This eliminates a lot of boilerplate. Each module may only
729 * use this macro once, and calling it replaces module_init() and module_exit()
730 */
731#define module_hid_driver(__hid_driver) \
732 module_driver(__hid_driver, hid_register_driver, \
733 hid_unregister_driver)
734
7d12e780 735extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
1da177e4 736extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
93c10132 737extern int hidinput_connect(struct hid_device *hid, unsigned int force);
1da177e4 738extern void hidinput_disconnect(struct hid_device *);
1da177e4 739
1da177e4 740int hid_set_field(struct hid_field *, unsigned, __s32);
aa8de2f0 741int hid_input_report(struct hid_device *, int type, u8 *, int, int);
dde5845a 742int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
4371ea82
DK		 743struct hid_field *hidinput_get_led_field(struct hid_device *hid);
744unsigned int hidinput_count_leds(struct hid_device *hid);
37cf6e6f 745__s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
dde5845a 746void hid_output_report(struct hid_report *report, __u8 *data);
85cdaf52 747struct hid_device *hid_allocate_device(void);
90a006ab 748struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
85cdaf52 749int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
a7197c2e 750int hid_open_report(struct hid_device *device);
0361a28d 751int hid_check_keys_pressed(struct hid_device *hid);
93c10132 752int hid_connect(struct hid_device *hid, unsigned int connect_mask);
c4c259bc 753void hid_disconnect(struct hid_device *hid);
bbc21cfd
JF		 754const struct hid_device_id *hid_match_id(struct hid_device *hdev,
755 const struct hid_device_id *id);
77463838 756s32 hid_snto32(__u32 value, unsigned n);
85cdaf52 757
c849a614
AR		 758/**
759 * hid_device_io_start - enable HID input during probe, remove
760 *
761 * @hid - the device
762 *
763 * This should only be called during probe or remove and only be
764 * called by the thread calling probe or remove. It will allow
765 * incoming packets to be delivered to the driver.
766 */
767static inline void hid_device_io_start(struct hid_device *hid) {
768 if (hid->io_started) {
769 dev_warn(&hid->dev, "io already started");
770 return;
771 }
772 hid->io_started = true;
773 up(&hid->driver_input_lock);
774}
775
776/**
777 * hid_device_io_stop - disable HID input during probe, remove
778 *
779 * @hid - the device
780 *
781 * Should only be called after hid_device_io_start. It will prevent
782 * incoming packets from going to the driver for the duration of
783 * probe, remove. If called during probe, packets will still go to the
784 * driver after probe is complete. This function should only be called
785 * by the thread calling probe or remove.
786 */
787static inline void hid_device_io_stop(struct hid_device *hid) {
788 if (!hid->io_started) {
789 dev_warn(&hid->dev, "io already stopped");
790 return;
791 }
792 hid->io_started = false;
793 down(&hid->driver_input_lock);
794}
795
022e8c4d
JS		 796/**
797 * hid_map_usage - map usage input bits
798 *
799 * @hidinput: hidinput which we are interested in
800 * @usage: usage to fill in
801 * @bit: pointer to input->{}bit (out parameter)
802 * @max: maximal valid usage->code to consider later (out parameter)
803 * @type: input event type (EV_KEY, EV_REL, ...)
804 * @c: code which corresponds to this usage and type
805 */
806static inline void hid_map_usage(struct hid_input *hidinput,
807 struct hid_usage *usage, unsigned long **bit, int *max,
808 __u8 type, __u16 c)
809{
810 struct input_dev *input = hidinput->input;
811
812 usage->type = type;
813 usage->code = c;
814
815 switch (type) {
816 case EV_ABS:
817 *bit = input->absbit;
818 *max = ABS_MAX;
819 break;
820 case EV_REL:
821 *bit = input->relbit;
822 *max = REL_MAX;
823 break;
824 case EV_KEY:
825 *bit = input->keybit;
826 *max = KEY_MAX;
827 break;
828 case EV_LED:
829 *bit = input->ledbit;
830 *max = LED_MAX;
831 break;
832 }
833}
834
835/**
836 * hid_map_usage_clear - map usage input bits and clear the input bit
837 *
838 * The same as hid_map_usage, except the @c bit is also cleared in supported
839 * bits (@bit).
840 */
841static inline void hid_map_usage_clear(struct hid_input *hidinput,
842 struct hid_usage *usage, unsigned long **bit, int *max,
843 __u8 type, __u16 c)
844{
845 hid_map_usage(hidinput, usage, bit, max, type, c);
846 clear_bit(c, *bit);
847}
848
c500c971
JS		 849/**
850 * hid_parse - parse HW reports
851 *
852 * @hdev: hid device
853 *
854 * Call this from probe after you set up the device (if needed). Your
855 * report_fixup will be called (if non-NULL) after reading raw report from
856 * device before passing it to hid layer for real parsing.
857 */
858static inline int __must_check hid_parse(struct hid_device *hdev)
859{
a7197c2e 860 return hid_open_report(hdev);
c500c971
JS		 861}
862
863/**
864 * hid_hw_start - start underlaying HW
865 *
866 * @hdev: hid device
93c10132 867 * @connect_mask: which outputs to connect, see HID_CONNECT_*
c500c971
JS		 868 *
869 * Call this in probe function *after* hid_parse. This will setup HW buffers
870 * and start the device (if not deffered to device open). hid_hw_stop must be
25985edc 871 * called if this was successful.
c500c971 872 */
93c10132
JS		 873static inline int __must_check hid_hw_start(struct hid_device *hdev,
874 unsigned int connect_mask)
c500c971 875{
93c10132
JS		 876 int ret = hdev->ll_driver->start(hdev);
877 if (ret || !connect_mask)
878 return ret;
879 ret = hid_connect(hdev, connect_mask);
880 if (ret)
881 hdev->ll_driver->stop(hdev);
882 return ret;
c500c971
JS		 883}
884
885/**
886 * hid_hw_stop - stop underlaying HW
887 *
888 * @hdev: hid device
889 *
890 * This is usually called from remove function or from probe when something
891 * failed and hid_hw_start was called already.
892 */
893static inline void hid_hw_stop(struct hid_device *hdev)
894{
c4c259bc 895 hid_disconnect(hdev);
c500c971
JS		 896 hdev->ll_driver->stop(hdev);
897}
898
5bea7660
DT		 899/**
900 * hid_hw_open - signal underlaying HW to start delivering events
901 *
902 * @hdev: hid device
903 *
904 * Tell underlying HW to start delivering events from the device.
905 * This function should be called sometime after successful call
906 * to hid_hiw_start().
907 */
908static inline int __must_check hid_hw_open(struct hid_device *hdev)
909{
910 return hdev->ll_driver->open(hdev);
911}
912
913/**
914 * hid_hw_close - signal underlaying HW to stop delivering events
915 *
916 * @hdev: hid device
917 *
918 * This function indicates that we are not interested in the events
919 * from this device anymore. Delivery of events may or may not stop,
920 * depending on the number of users still outstanding.
921 */
922static inline void hid_hw_close(struct hid_device *hdev)
923{
924 hdev->ll_driver->close(hdev);
925}
926
927/**
928 * hid_hw_power - requests underlying HW to go into given power mode
929 *
930 * @hdev: hid device
931 * @level: requested power level (one of %PM_HINT_* defines)
932 *
933 * This function requests underlying hardware to enter requested power
934 * mode.
935 */
936
937static inline int hid_hw_power(struct hid_device *hdev, int level)
938{
939 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
940}
941
e90a6df8
HR		 942
943/**
944 * hid_hw_request - send report request to device
945 *
946 * @hdev: hid device
947 * @report: report to send
948 * @reqtype: hid request type
949 */
950static inline void hid_hw_request(struct hid_device *hdev,
951 struct hid_report *report, int reqtype)
952{
953 if (hdev->ll_driver->request)
954 hdev->ll_driver->request(hdev, report, reqtype);
955}
956
9684819b
BT		 957/**
958 * hid_hw_idle - send idle request to device
959 *
960 * @hdev: hid device
961 * @report: report to control
962 * @idle: idle state
963 * @reqtype: hid request type
964 */
965static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
966 int reqtype)
967{
968 if (hdev->ll_driver->idle)
969 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
970
971 return 0;
972}
973
3373443b
HR		 974/**
975 * hid_hw_wait - wait for buffered io to complete
976 *
977 * @hdev: hid device
978 */
979static inline void hid_hw_wait(struct hid_device *hdev)
980{
981 if (hdev->ll_driver->wait)
982 hdev->ll_driver->wait(hdev);
983}
984
b6787242 985int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
85cdaf52
JS		 986 int interrupt);
987
876b9276 988/* HID quirks API */
2eb5dc30 989u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
876b9276
PW		 990int usbhid_quirks_init(char **quirks_param);
991void usbhid_quirks_exit(void);
6edfa8dc 992void usbhid_set_leds(struct hid_device *hid);
2eb5dc30 993
224ee88f
AH		 994#ifdef CONFIG_HID_PID
995int hid_pidff_init(struct hid_device *hid);
996#else
76483cf4 997#define hid_pidff_init NULL
1da177e4 998#endif
58037eb9 999
4291ee30
JP		 1000#define dbg_hid(format, arg...) \
1001do { \
1002 if (hid_debug) \
1003 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \
1004} while (0)
1005
1006#define hid_printk(level, hid, fmt, arg...) \
1007 dev_printk(level, &(hid)->dev, fmt, ##arg)
1008#define hid_emerg(hid, fmt, arg...) \
1009 dev_emerg(&(hid)->dev, fmt, ##arg)
1010#define hid_crit(hid, fmt, arg...) \
1011 dev_crit(&(hid)->dev, fmt, ##arg)
1012#define hid_alert(hid, fmt, arg...) \
1013 dev_alert(&(hid)->dev, fmt, ##arg)
1014#define hid_err(hid, fmt, arg...) \
1015 dev_err(&(hid)->dev, fmt, ##arg)
1016#define hid_notice(hid, fmt, arg...) \
1017 dev_notice(&(hid)->dev, fmt, ##arg)
1018#define hid_warn(hid, fmt, arg...) \
1019 dev_warn(&(hid)->dev, fmt, ##arg)
1020#define hid_info(hid, fmt, arg...) \
1021 dev_info(&(hid)->dev, fmt, ##arg)
1022#define hid_dbg(hid, fmt, arg...) \
1023 dev_dbg(&(hid)->dev, fmt, ##arg)
1024
57d292bd 1025#endif
kernel source for telekom puls (alcatel/mediatek)