a72876e435892cb3ce896e234e84084728434064
[linux-2.6.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 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
262 /*
263  * HID device quirks.
264  */
265
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
271 #define HID_QUIRK_INVERT                        0x00000001
272 #define HID_QUIRK_NOTOUCH                       0x00000002
273 #define HID_QUIRK_IGNORE                        0x00000004
274 #define HID_QUIRK_NOGET                         0x00000008
275 #define HID_QUIRK_BADPAD                        0x00000020
276 #define HID_QUIRK_MULTI_INPUT                   0x00000040
277 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
278 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
279
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
286 struct 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
303 #define HID_MAX_USAGES                  12288
304 #define HID_DEFAULT_NUM_COLLECTIONS     16
305
306 struct 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
320 struct hid_collection {
321         unsigned type;
322         unsigned usage;
323         unsigned level;
324 };
325
326 struct 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
337 struct hid_input;
338
339 struct 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
366 struct 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
376 struct 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
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 */
386 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
387 #define HID_OUTPUT_FIFO_SIZE    64
388
389 struct hid_control_fifo {
390         unsigned char dir;
391         struct hid_report *report;
392         char *raw_report;
393 };
394
395 struct hid_output_fifo {
396         struct hid_report *report;
397         char *raw_report;
398 };
399
400 #define HID_CLAIMED_INPUT       1
401 #define HID_CLAIMED_HIDDEV      2
402 #define HID_CLAIMED_HIDRAW      4
403
404 #define HID_STAT_ADDED          1
405 #define HID_STAT_PARSED         2
406
407 struct hid_input {
408         struct list_head list;
409         struct hid_report *report;
410         struct input_dev *input;
411 };
412
413 enum hid_type {
414         HID_TYPE_OTHER = 0,
415         HID_TYPE_USBMOUSE
416 };
417
418 struct hid_driver;
419 struct hid_ll_driver;
420
421 struct hid_device {                                                     /* device report descriptor */
422         __u8 *rdesc;
423         unsigned rsize;
424         struct hid_collection *collection;                              /* List of HID collections */
425         unsigned collection_size;                                       /* Number of allocated hid_collections */
426         unsigned maxcollection;                                         /* Number of parsed collections */
427         unsigned maxapplication;                                        /* Number of applications */
428         __u16 bus;                                                      /* BUS ID */
429         __u32 vendor;                                                   /* Vendor ID */
430         __u32 product;                                                  /* Product ID */
431         __u32 version;                                                  /* HID version */
432         enum hid_type type;                                             /* device type (mouse, kbd, ...) */
433         unsigned country;                                               /* HID country */
434         struct hid_report_enum report_enum[HID_REPORT_TYPES];
435
436         struct device dev;                                              /* device */
437         struct hid_driver *driver;
438         struct hid_ll_driver *ll_driver;
439
440         unsigned int status;                                            /* see STAT flags above */
441         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
442         unsigned quirks;                                                /* Various quirks the device can pull on us */
443
444         struct list_head inputs;                                        /* The list of inputs */
445         void *hiddev;                                                   /* The hiddev structure */
446         void *hidraw;
447         int minor;                                                      /* Hiddev minor number */
448
449         int open;                                                       /* is the device open by anyone? */
450         char name[128];                                                 /* Device name */
451         char phys[64];                                                  /* Device physical location */
452         char uniq[64];                                                  /* Device unique identifier (serial #) */
453
454         void *driver_data;
455
456         /* temporary hid_ff handling (until moved to the drivers) */
457         int (*ff_init)(struct hid_device *);
458
459         /* hiddev event handler */
460         int (*hiddev_connect)(struct hid_device *, unsigned int);
461         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
462                                   struct hid_usage *, __s32);
463         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
464
465         /* handler for raw output data, used by hidraw */
466         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
467 };
468
469 static inline void *hid_get_drvdata(struct hid_device *hdev)
470 {
471         return dev_get_drvdata(&hdev->dev);
472 }
473
474 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
475 {
476         dev_set_drvdata(&hdev->dev, data);
477 }
478
479 #define HID_GLOBAL_STACK_SIZE 4
480 #define HID_COLLECTION_STACK_SIZE 4
481
482 struct hid_parser {
483         struct hid_global     global;
484         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
485         unsigned              global_stack_ptr;
486         struct hid_local      local;
487         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
488         unsigned              collection_stack_ptr;
489         struct hid_device    *device;
490 };
491
492 struct hid_class_descriptor {
493         __u8  bDescriptorType;
494         __le16 wDescriptorLength;
495 } __attribute__ ((packed));
496
497 struct hid_descriptor {
498         __u8  bLength;
499         __u8  bDescriptorType;
500         __le16 bcdHID;
501         __u8  bCountryCode;
502         __u8  bNumDescriptors;
503
504         struct hid_class_descriptor desc[1];
505 } __attribute__ ((packed));
506
507 #define HID_DEVICE(b, ven, prod) \
508         .bus = (b), \
509         .vendor = (ven), .product = (prod)
510
511 #define HID_USB_DEVICE(ven, prod)       HID_DEVICE(BUS_USB, ven, prod)
512 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
513
514 #define HID_REPORT_ID(rep) \
515         .report_type = (rep)
516 #define HID_USAGE_ID(uhid, utype, ucode) \
517         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
518 /* we don't want to catch types and codes equal to 0 */
519 #define HID_TERMINATOR          (HID_ANY_ID - 1)
520
521 struct hid_report_id {
522         __u32 report_type;
523 };
524 struct hid_usage_id {
525         __u32 usage_hid;
526         __u32 usage_type;
527         __u32 usage_code;
528 };
529
530 /**
531  * struct hid_driver
532  * @name: driver name (e.g. "Footech_bar-wheel")
533  * @id_table: which devices is this driver for (must be non-NULL for probe
534  *            to be called)
535  * @dyn_list: list of dynamically added device ids
536  * @dyn_lock: lock protecting @dyn_list
537  * @probe: new device inserted
538  * @remove: device removed (NULL if not a hot-plug capable driver)
539  * @report_table: on which reports to call raw_event (NULL means all)
540  * @raw_event: if report in report_table, this hook is called (NULL means nop)
541  * @usage_table: on which events to call event (NULL means all)
542  * @event: if usage in usage_table, this hook is called (NULL means nop)
543  * @report_fixup: called before report descriptor parsing (NULL means nop)
544  * @input_mapping: invoked on input registering before mapping an usage
545  * @input_mapped: invoked on input registering after mapping an usage
546  *
547  * raw_event and event should return 0 on no action performed, 1 when no
548  * further processing should be done and negative on error
549  *
550  * input_mapping shall return a negative value to completely ignore this usage
551  * (e.g. doubled or invalid usage), zero to continue with parsing of this
552  * usage by generic code (no special handling needed) or positive to skip
553  * generic parsing (needed special handling which was done in the hook already)
554  * input_mapped shall return negative to inform the layer that this usage
555  * should not be considered for further processing or zero to notify that
556  * no processing was performed and should be done in a generic manner
557  * Both these functions may be NULL which means the same behavior as returning
558  * zero from them.
559  */
560 struct hid_driver {
561         char *name;
562         const struct hid_device_id *id_table;
563
564         struct list_head dyn_list;
565         spinlock_t dyn_lock;
566
567         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
568         void (*remove)(struct hid_device *dev);
569
570         const struct hid_report_id *report_table;
571         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
572                         u8 *data, int size);
573         const struct hid_usage_id *usage_table;
574         int (*event)(struct hid_device *hdev, struct hid_field *field,
575                         struct hid_usage *usage, __s32 value);
576
577         void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
578                         unsigned int size);
579
580         int (*input_mapping)(struct hid_device *hdev,
581                         struct hid_input *hidinput, struct hid_field *field,
582                         struct hid_usage *usage, unsigned long **bit, int *max);
583         int (*input_mapped)(struct hid_device *hdev,
584                         struct hid_input *hidinput, struct hid_field *field,
585                         struct hid_usage *usage, unsigned long **bit, int *max);
586 /* private: */
587         struct device_driver driver;
588 };
589
590 /**
591  * hid_ll_driver - low level driver callbacks
592  * @start: called on probe to start the device
593  * @stop: called on remove
594  * @open: called by input layer on open
595  * @close: called by input layer on close
596  * @hidinput_input_event: event input event (e.g. ff or leds)
597  * @parse: this method is called only once to parse the device data,
598  *         shouldn't allocate anything to not leak memory
599  */
600 struct hid_ll_driver {
601         int (*start)(struct hid_device *hdev);
602         void (*stop)(struct hid_device *hdev);
603
604         int (*open)(struct hid_device *hdev);
605         void (*close)(struct hid_device *hdev);
606
607         int (*power)(struct hid_device *hdev, int level);
608
609         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
610                         unsigned int code, int value);
611
612         int (*parse)(struct hid_device *hdev);
613 };
614
615 #define PM_HINT_FULLON  1<<5
616 #define PM_HINT_NORMAL  1<<1
617
618 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
619 /* We ignore a few input applications that are not widely used */
620 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
621
622 /* HID core API */
623
624 #ifdef CONFIG_HID_DEBUG
625 extern int hid_debug;
626 #endif
627
628 extern int hid_add_device(struct hid_device *);
629 extern void hid_destroy_device(struct hid_device *);
630
631 extern int __must_check __hid_register_driver(struct hid_driver *,
632                 struct module *, const char *mod_name);
633 static inline int __must_check hid_register_driver(struct hid_driver *driver)
634 {
635         return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
636 }
637 extern void hid_unregister_driver(struct hid_driver *);
638
639 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
640 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
641 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
642 extern void hidinput_disconnect(struct hid_device *);
643
644 int hid_set_field(struct hid_field *, unsigned, __s32);
645 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
646 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
647 void hid_output_report(struct hid_report *report, __u8 *data);
648 struct hid_device *hid_allocate_device(void);
649 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
650 int hid_check_keys_pressed(struct hid_device *hid);
651 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
652
653 /**
654  * hid_map_usage - map usage input bits
655  *
656  * @hidinput: hidinput which we are interested in
657  * @usage: usage to fill in
658  * @bit: pointer to input->{}bit (out parameter)
659  * @max: maximal valid usage->code to consider later (out parameter)
660  * @type: input event type (EV_KEY, EV_REL, ...)
661  * @c: code which corresponds to this usage and type
662  */
663 static inline void hid_map_usage(struct hid_input *hidinput,
664                 struct hid_usage *usage, unsigned long **bit, int *max,
665                 __u8 type, __u16 c)
666 {
667         struct input_dev *input = hidinput->input;
668
669         usage->type = type;
670         usage->code = c;
671
672         switch (type) {
673         case EV_ABS:
674                 *bit = input->absbit;
675                 *max = ABS_MAX;
676                 break;
677         case EV_REL:
678                 *bit = input->relbit;
679                 *max = REL_MAX;
680                 break;
681         case EV_KEY:
682                 *bit = input->keybit;
683                 *max = KEY_MAX;
684                 break;
685         case EV_LED:
686                 *bit = input->ledbit;
687                 *max = LED_MAX;
688                 break;
689         }
690 }
691
692 /**
693  * hid_map_usage_clear - map usage input bits and clear the input bit
694  *
695  * The same as hid_map_usage, except the @c bit is also cleared in supported
696  * bits (@bit).
697  */
698 static inline void hid_map_usage_clear(struct hid_input *hidinput,
699                 struct hid_usage *usage, unsigned long **bit, int *max,
700                 __u8 type, __u16 c)
701 {
702         hid_map_usage(hidinput, usage, bit, max, type, c);
703         clear_bit(c, *bit);
704 }
705
706 /**
707  * hid_parse - parse HW reports
708  *
709  * @hdev: hid device
710  *
711  * Call this from probe after you set up the device (if needed). Your
712  * report_fixup will be called (if non-NULL) after reading raw report from
713  * device before passing it to hid layer for real parsing.
714  */
715 static inline int __must_check hid_parse(struct hid_device *hdev)
716 {
717         int ret;
718
719         if (hdev->status & HID_STAT_PARSED)
720                 return 0;
721
722         ret = hdev->ll_driver->parse(hdev);
723         if (!ret)
724                 hdev->status |= HID_STAT_PARSED;
725
726         return ret;
727 }
728
729 /**
730  * hid_hw_start - start underlaying HW
731  *
732  * @hdev: hid device
733  * @connect_mask: which outputs to connect, see HID_CONNECT_*
734  *
735  * Call this in probe function *after* hid_parse. This will setup HW buffers
736  * and start the device (if not deffered to device open). hid_hw_stop must be
737  * called if this was successfull.
738  */
739 static inline int __must_check hid_hw_start(struct hid_device *hdev,
740                 unsigned int connect_mask)
741 {
742         int ret = hdev->ll_driver->start(hdev);
743         if (ret || !connect_mask)
744                 return ret;
745         ret = hid_connect(hdev, connect_mask);
746         if (ret)
747                 hdev->ll_driver->stop(hdev);
748         return ret;
749 }
750
751 /**
752  * hid_hw_stop - stop underlaying HW
753  *
754  * @hdev: hid device
755  *
756  * This is usually called from remove function or from probe when something
757  * failed and hid_hw_start was called already.
758  */
759 static inline void hid_hw_stop(struct hid_device *hdev)
760 {
761         hdev->ll_driver->stop(hdev);
762 }
763
764 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
765                 int interrupt);
766
767 extern int hid_generic_init(void);
768 extern void hid_generic_exit(void);
769
770 /* HID quirks API */
771 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
772 int usbhid_quirks_init(char **quirks_param);
773 void usbhid_quirks_exit(void);
774 void usbhid_set_leds(struct hid_device *hid);
775
776 #ifdef CONFIG_HID_PID
777 int hid_pidff_init(struct hid_device *hid);
778 #else
779 #define hid_pidff_init NULL
780 #endif
781
782 #ifdef CONFIG_HID_DEBUG
783 #define dbg_hid(format, arg...) if (hid_debug) \
784                                 printk(KERN_DEBUG "%s: " format ,\
785                                 __FILE__ , ## arg)
786 #define dbg_hid_line(format, arg...) if (hid_debug) \
787                                 printk(format, ## arg)
788 #else
789 static inline int __attribute__((format(printf, 1, 2)))
790 dbg_hid(const char *fmt, ...)
791 {
792         return 0;
793 }
794 #define dbg_hid_line dbg_hid
795 #endif /* HID_DEBUG */
796
797 #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
798                 __FILE__ , ## arg)
799 #endif /* HID_FF */
800
801 #endif
802