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