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