2 * Copyright (c) 1999 Andreas Gal
3 * Copyright (c) 2000-2001 Vojtech Pavlik
4 * Copyright (c) 2006-2007 Jiri Kosina
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.
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.
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
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
29 #include <linux/types.h>
30 #include <linux/slab.h>
31 #include <linux/list.h>
32 #include <linux/mod_devicetable.h> /* hid_device_id */
33 #include <linux/timer.h>
34 #include <linux/workqueue.h>
35 #include <linux/input.h>
36 #include <linux/semaphore.h>
37 #include <linux/power_supply.h>
38 #include <uapi/linux/hid.h>
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
63 * HID report item format
66 #define HID_ITEM_FORMAT_SHORT 0
67 #define HID_ITEM_FORMAT_LONG 1
70 * Special tag indicating long items
73 #define HID_ITEM_TAG_LONG 15
76 * HID report descriptor item type (prefix bit 2,3)
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
85 * HID report descriptor main item tags
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
95 * HID report descriptor main item contents
98 #define HID_MAIN_ITEM_CONSTANT 0x001
99 #define HID_MAIN_ITEM_VARIABLE 0x002
100 #define HID_MAIN_ITEM_RELATIVE 0x004
101 #define HID_MAIN_ITEM_WRAP 0x008
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
109 * HID report descriptor collection item types
112 #define HID_COLLECTION_PHYSICAL 0
113 #define HID_COLLECTION_APPLICATION 1
114 #define HID_COLLECTION_LOGICAL 2
117 * HID report descriptor global item tags
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
134 * HID report descriptor local item tags
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
152 #define HID_USAGE_PAGE 0xffff0000
154 #define HID_UP_UNDEFINED 0x00000000
155 #define HID_UP_GENDESK 0x00010000
156 #define HID_UP_SIMULATION 0x00020000
157 #define HID_UP_GENDEVCTRLS 0x00060000
158 #define HID_UP_KEYBOARD 0x00070000
159 #define HID_UP_LED 0x00080000
160 #define HID_UP_BUTTON 0x00090000
161 #define HID_UP_ORDINAL 0x000a0000
162 #define HID_UP_CONSUMER 0x000c0000
163 #define HID_UP_DIGITIZER 0x000d0000
164 #define HID_UP_PID 0x000f0000
165 #define HID_UP_HPVENDOR 0xff7f0000
166 #define HID_UP_HPVENDOR2 0xff010000
167 #define HID_UP_MSVENDOR 0xff000000
168 #define HID_UP_CUSTOM 0x00ff0000
169 #define HID_UP_LOGIVENDOR 0xffbc0000
170 #define HID_UP_LNVENDOR 0xffa00000
171 #define HID_UP_SENSOR 0x00200000
173 #define HID_USAGE 0x0000ffff
175 #define HID_GD_POINTER 0x00010001
176 #define HID_GD_MOUSE 0x00010002
177 #define HID_GD_JOYSTICK 0x00010004
178 #define HID_GD_GAMEPAD 0x00010005
179 #define HID_GD_KEYBOARD 0x00010006
180 #define HID_GD_KEYPAD 0x00010007
181 #define HID_GD_MULTIAXIS 0x00010008
182 #define HID_GD_X 0x00010030
183 #define HID_GD_Y 0x00010031
184 #define HID_GD_Z 0x00010032
185 #define HID_GD_RX 0x00010033
186 #define HID_GD_RY 0x00010034
187 #define HID_GD_RZ 0x00010035
188 #define HID_GD_SLIDER 0x00010036
189 #define HID_GD_DIAL 0x00010037
190 #define HID_GD_WHEEL 0x00010038
191 #define HID_GD_HATSWITCH 0x00010039
192 #define HID_GD_BUFFER 0x0001003a
193 #define HID_GD_BYTECOUNT 0x0001003b
194 #define HID_GD_MOTION 0x0001003c
195 #define HID_GD_START 0x0001003d
196 #define HID_GD_SELECT 0x0001003e
197 #define HID_GD_VX 0x00010040
198 #define HID_GD_VY 0x00010041
199 #define HID_GD_VZ 0x00010042
200 #define HID_GD_VBRX 0x00010043
201 #define HID_GD_VBRY 0x00010044
202 #define HID_GD_VBRZ 0x00010045
203 #define HID_GD_VNO 0x00010046
204 #define HID_GD_FEATURE 0x00010047
205 #define HID_GD_SYSTEM_CONTROL 0x00010080
206 #define HID_GD_UP 0x00010090
207 #define HID_GD_DOWN 0x00010091
208 #define HID_GD_RIGHT 0x00010092
209 #define HID_GD_LEFT 0x00010093
211 #define HID_DC_BATTERYSTRENGTH 0x00060020
213 #define HID_CP_CONSUMER_CONTROL 0x000c0001
215 #define HID_DG_DIGITIZER 0x000d0001
216 #define HID_DG_PEN 0x000d0002
217 #define HID_DG_LIGHTPEN 0x000d0003
218 #define HID_DG_TOUCHSCREEN 0x000d0004
219 #define HID_DG_TOUCHPAD 0x000d0005
220 #define HID_DG_STYLUS 0x000d0020
221 #define HID_DG_PUCK 0x000d0021
222 #define HID_DG_FINGER 0x000d0022
223 #define HID_DG_TIPPRESSURE 0x000d0030
224 #define HID_DG_BARRELPRESSURE 0x000d0031
225 #define HID_DG_INRANGE 0x000d0032
226 #define HID_DG_TOUCH 0x000d0033
227 #define HID_DG_UNTOUCH 0x000d0034
228 #define HID_DG_TAP 0x000d0035
229 #define HID_DG_TABLETFUNCTIONKEY 0x000d0039
230 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
231 #define HID_DG_INVERT 0x000d003c
232 #define HID_DG_TIPSWITCH 0x000d0042
233 #define HID_DG_TIPSWITCH2 0x000d0043
234 #define HID_DG_BARRELSWITCH 0x000d0044
235 #define HID_DG_ERASER 0x000d0045
236 #define HID_DG_TABLETPICK 0x000d0046
238 #define HID_CP_CONSUMERCONTROL 0x000c0001
239 #define HID_CP_NUMERICKEYPAD 0x000c0002
240 #define HID_CP_PROGRAMMABLEBUTTONS 0x000c0003
241 #define HID_CP_MICROPHONE 0x000c0004
242 #define HID_CP_HEADPHONE 0x000c0005
243 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
244 #define HID_CP_FUNCTIONBUTTONS 0x000c0036
245 #define HID_CP_SELECTION 0x000c0080
246 #define HID_CP_MEDIASELECTION 0x000c0087
247 #define HID_CP_SELECTDISC 0x000c00ba
248 #define HID_CP_PLAYBACKSPEED 0x000c00f1
249 #define HID_CP_PROXIMITY 0x000c0109
250 #define HID_CP_SPEAKERSYSTEM 0x000c0160
251 #define HID_CP_CHANNELLEFT 0x000c0161
252 #define HID_CP_CHANNELRIGHT 0x000c0162
253 #define HID_CP_CHANNELCENTER 0x000c0163
254 #define HID_CP_CHANNELFRONT 0x000c0164
255 #define HID_CP_CHANNELCENTERFRONT 0x000c0165
256 #define HID_CP_CHANNELSIDE 0x000c0166
257 #define HID_CP_CHANNELSURROUND 0x000c0167
258 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT 0x000c0168
259 #define HID_CP_CHANNELTOP 0x000c0169
260 #define HID_CP_CHANNELUNKNOWN 0x000c016a
261 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
262 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS 0x000c0200
264 #define HID_DG_CONFIDENCE 0x000d0047
265 #define HID_DG_WIDTH 0x000d0048
266 #define HID_DG_HEIGHT 0x000d0049
267 #define HID_DG_CONTACTID 0x000d0051
268 #define HID_DG_INPUTMODE 0x000d0052
269 #define HID_DG_DEVICEINDEX 0x000d0053
270 #define HID_DG_CONTACTCOUNT 0x000d0054
271 #define HID_DG_CONTACTMAX 0x000d0055
272 #define HID_DG_BARRELSWITCH2 0x000d005a
273 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
276 * HID report types --- Ouch! HID spec says 1 2 3!
279 #define HID_INPUT_REPORT 0
280 #define HID_OUTPUT_REPORT 1
281 #define HID_FEATURE_REPORT 2
283 #define HID_REPORT_TYPES 3
286 * HID connect requests
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_DRIVER 0x40
296 #define HID_CONNECT_DEFAULT (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
297 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
304 * Increase this if you need to configure more HID quirks at module load time
306 #define MAX_USBHID_BOOT_QUIRKS 4
308 #define HID_QUIRK_INVERT 0x00000001
309 #define HID_QUIRK_NOTOUCH 0x00000002
310 #define HID_QUIRK_IGNORE 0x00000004
311 #define HID_QUIRK_NOGET 0x00000008
312 #define HID_QUIRK_HIDDEV_FORCE 0x00000010
313 #define HID_QUIRK_BADPAD 0x00000020
314 #define HID_QUIRK_MULTI_INPUT 0x00000040
315 #define HID_QUIRK_HIDINPUT_FORCE 0x00000080
316 #define HID_QUIRK_NO_EMPTY_INPUT 0x00000100
317 #define HID_QUIRK_NO_INIT_INPUT_REPORTS 0x00000200
318 #define HID_QUIRK_ALWAYS_POLL 0x00000400
319 #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
320 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID 0x00020000
321 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP 0x00040000
322 #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
323 #define HID_QUIRK_NO_INIT_REPORTS 0x20000000
324 #define HID_QUIRK_NO_IGNORE 0x40000000
325 #define HID_QUIRK_NO_INPUT_SYNC 0x80000000
330 * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
331 * and has a value of 0x0000
333 #define HID_GROUP_GENERIC 0x0001
334 #define HID_GROUP_MULTITOUCH 0x0002
335 #define HID_GROUP_SENSOR_HUB 0x0003
336 #define HID_GROUP_MULTITOUCH_WIN_8 0x0004
339 * Vendor specific HID device groups
341 #define HID_GROUP_RMI 0x0100
342 #define HID_GROUP_WACOM 0x0101
343 #define HID_GROUP_LOGITECH_DJ_DEVICE 0x0102
346 * This is the global environment of the parser. This information is
347 * persistent for main-items. The global environment can be saved and
348 * restored with PUSH/POP statements.
353 __s32 logical_minimum;
354 __s32 logical_maximum;
355 __s32 physical_minimum;
356 __s32 physical_maximum;
360 unsigned report_size;
361 unsigned report_count;
365 * This is the local environment. It is persistent up the next main-item.
368 #define HID_MAX_USAGES 12288
369 #define HID_DEFAULT_NUM_COLLECTIONS 16
372 unsigned usage[HID_MAX_USAGES]; /* usage array */
373 unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
374 unsigned usage_index;
375 unsigned usage_minimum;
376 unsigned delimiter_depth;
377 unsigned delimiter_branch;
381 * This is the collection stack. We climb up the stack to determine
382 * application and function of each field.
385 struct hid_collection {
392 unsigned hid; /* hid usage code */
393 unsigned collection_index; /* index into collection array */
394 unsigned usage_index; /* index into usage array */
396 __u16 code; /* input driver code */
397 __u8 type; /* input driver type */
398 __s8 hat_min; /* hat switch fun */
399 __s8 hat_max; /* ditto */
400 __s8 hat_dir; /* ditto */
406 unsigned physical; /* physical usage for this field */
407 unsigned logical; /* logical usage for this field */
408 unsigned application; /* application usage for this field */
409 struct hid_usage *usage; /* usage table for this function */
410 unsigned maxusage; /* maximum usage index */
411 unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
412 unsigned report_offset; /* bit offset in the report */
413 unsigned report_size; /* size of this field in the report */
414 unsigned report_count; /* number of this field in the report */
415 unsigned report_type; /* (input,output,feature) */
416 __s32 *value; /* last known value(s) */
417 __s32 logical_minimum;
418 __s32 logical_maximum;
419 __s32 physical_minimum;
420 __s32 physical_maximum;
423 struct hid_report *report; /* associated report */
424 unsigned index; /* index into report->field[] */
426 struct hid_input *hidinput; /* associated input structure */
427 __u16 dpad; /* dpad input code */
430 #define HID_MAX_FIELDS 256
433 struct list_head list;
434 unsigned id; /* id of this report */
435 unsigned type; /* report type */
436 struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
437 unsigned maxfield; /* maximum valid field index */
438 unsigned size; /* size of the report (bits) */
439 struct hid_device *device; /* associated device */
442 #define HID_MAX_IDS 256
444 struct hid_report_enum {
446 struct list_head report_list;
447 struct hid_report *report_id_hash[HID_MAX_IDS];
450 #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
451 #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
452 #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
453 #define HID_OUTPUT_FIFO_SIZE 64
455 struct hid_control_fifo {
457 struct hid_report *report;
461 struct hid_output_fifo {
462 struct hid_report *report;
466 #define HID_CLAIMED_INPUT 1
467 #define HID_CLAIMED_HIDDEV 2
468 #define HID_CLAIMED_HIDRAW 4
469 #define HID_CLAIMED_DRIVER 8
471 #define HID_STAT_ADDED 1
472 #define HID_STAT_PARSED 2
475 struct list_head list;
476 struct hid_report *report;
477 struct input_dev *input;
487 struct hid_ll_driver;
489 struct hid_device { /* device report descriptor */
494 struct hid_collection *collection; /* List of HID collections */
495 unsigned collection_size; /* Number of allocated hid_collections */
496 unsigned maxcollection; /* Number of parsed collections */
497 unsigned maxapplication; /* Number of applications */
498 __u16 bus; /* BUS ID */
499 __u16 group; /* Report group */
500 __u32 vendor; /* Vendor ID */
501 __u32 product; /* Product ID */
502 __u32 version; /* HID version */
503 enum hid_type type; /* device type (mouse, kbd, ...) */
504 unsigned country; /* HID country */
505 struct hid_report_enum report_enum[HID_REPORT_TYPES];
506 struct work_struct led_work; /* delayed LED worker */
508 struct semaphore driver_lock; /* protects the current driver, except during input */
509 struct semaphore driver_input_lock; /* protects the current driver */
510 struct device dev; /* device */
511 struct hid_driver *driver;
512 struct hid_ll_driver *ll_driver;
514 #ifdef CONFIG_HID_BATTERY_STRENGTH
516 * Power supply information for HID devices which report
517 * battery strength. power_supply was successfully registered if
518 * battery is non-NULL.
520 struct power_supply *battery;
523 __s32 battery_report_type;
524 __s32 battery_report_id;
527 unsigned int status; /* see STAT flags above */
528 unsigned claimed; /* Claimed by hidinput, hiddev? */
529 unsigned quirks; /* Various quirks the device can pull on us */
530 bool io_started; /* Protected by driver_lock. If IO has started */
532 struct list_head inputs; /* The list of inputs */
533 void *hiddev; /* The hiddev structure */
535 int minor; /* Hiddev minor number */
537 int open; /* is the device open by anyone? */
538 char name[128]; /* Device name */
539 char phys[64]; /* Device physical location */
540 char uniq[64]; /* Device unique identifier (serial #) */
544 /* temporary hid_ff handling (until moved to the drivers) */
545 int (*ff_init)(struct hid_device *);
547 /* hiddev event handler */
548 int (*hiddev_connect)(struct hid_device *, unsigned int);
549 void (*hiddev_disconnect)(struct hid_device *);
550 void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
551 struct hid_usage *, __s32);
552 void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
554 /* debugging support via debugfs */
555 unsigned short debug;
556 struct dentry *debug_dir;
557 struct dentry *debug_rdesc;
558 struct dentry *debug_events;
559 struct list_head debug_list;
560 spinlock_t debug_list_lock;
561 wait_queue_head_t debug_wait;
564 static inline void *hid_get_drvdata(struct hid_device *hdev)
566 return dev_get_drvdata(&hdev->dev);
569 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
571 dev_set_drvdata(&hdev->dev, data);
574 #define HID_GLOBAL_STACK_SIZE 4
575 #define HID_COLLECTION_STACK_SIZE 4
577 #define HID_SCAN_FLAG_MT_WIN_8 BIT(0)
578 #define HID_SCAN_FLAG_VENDOR_SPECIFIC BIT(1)
579 #define HID_SCAN_FLAG_GD_POINTER BIT(2)
582 struct hid_global global;
583 struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
584 unsigned global_stack_ptr;
585 struct hid_local local;
586 unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
587 unsigned collection_stack_ptr;
588 struct hid_device *device;
592 struct hid_class_descriptor {
593 __u8 bDescriptorType;
594 __le16 wDescriptorLength;
595 } __attribute__ ((packed));
597 struct hid_descriptor {
599 __u8 bDescriptorType;
602 __u8 bNumDescriptors;
604 struct hid_class_descriptor desc[1];
605 } __attribute__ ((packed));
607 #define HID_DEVICE(b, g, ven, prod) \
608 .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
609 #define HID_USB_DEVICE(ven, prod) \
610 .bus = BUS_USB, .vendor = (ven), .product = (prod)
611 #define HID_BLUETOOTH_DEVICE(ven, prod) \
612 .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
613 #define HID_I2C_DEVICE(ven, prod) \
614 .bus = BUS_I2C, .vendor = (ven), .product = (prod)
616 #define HID_REPORT_ID(rep) \
618 #define HID_USAGE_ID(uhid, utype, ucode) \
619 .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
620 /* we don't want to catch types and codes equal to 0 */
621 #define HID_TERMINATOR (HID_ANY_ID - 1)
623 struct hid_report_id {
626 struct hid_usage_id {
634 * @name: driver name (e.g. "Footech_bar-wheel")
635 * @id_table: which devices is this driver for (must be non-NULL for probe
637 * @dyn_list: list of dynamically added device ids
638 * @dyn_lock: lock protecting @dyn_list
639 * @probe: new device inserted
640 * @remove: device removed (NULL if not a hot-plug capable driver)
641 * @report_table: on which reports to call raw_event (NULL means all)
642 * @raw_event: if report in report_table, this hook is called (NULL means nop)
643 * @usage_table: on which events to call event (NULL means all)
644 * @event: if usage in usage_table, this hook is called (NULL means nop)
645 * @report: this hook is called after parsing a report (NULL means nop)
646 * @report_fixup: called before report descriptor parsing (NULL means nop)
647 * @input_mapping: invoked on input registering before mapping an usage
648 * @input_mapped: invoked on input registering after mapping an usage
649 * @input_configured: invoked just before the device is registered
650 * @feature_mapping: invoked on feature registering
651 * @suspend: invoked on suspend (NULL means nop)
652 * @resume: invoked on resume if device was not reset (NULL means nop)
653 * @reset_resume: invoked on resume if device was reset (NULL means nop)
655 * probe should return -errno on error, or 0 on success. During probe,
656 * input will not be passed to raw_event unless hid_device_io_start is
659 * raw_event and event should return 0 on no action performed, 1 when no
660 * further processing should be done and negative on error
662 * input_mapping shall return a negative value to completely ignore this usage
663 * (e.g. doubled or invalid usage), zero to continue with parsing of this
664 * usage by generic code (no special handling needed) or positive to skip
665 * generic parsing (needed special handling which was done in the hook already)
666 * input_mapped shall return negative to inform the layer that this usage
667 * should not be considered for further processing or zero to notify that
668 * no processing was performed and should be done in a generic manner
669 * Both these functions may be NULL which means the same behavior as returning
674 const struct hid_device_id *id_table;
676 struct list_head dyn_list;
679 int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
680 void (*remove)(struct hid_device *dev);
682 const struct hid_report_id *report_table;
683 int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
685 const struct hid_usage_id *usage_table;
686 int (*event)(struct hid_device *hdev, struct hid_field *field,
687 struct hid_usage *usage, __s32 value);
688 void (*report)(struct hid_device *hdev, struct hid_report *report);
690 __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
693 int (*input_mapping)(struct hid_device *hdev,
694 struct hid_input *hidinput, struct hid_field *field,
695 struct hid_usage *usage, unsigned long **bit, int *max);
696 int (*input_mapped)(struct hid_device *hdev,
697 struct hid_input *hidinput, struct hid_field *field,
698 struct hid_usage *usage, unsigned long **bit, int *max);
699 void (*input_configured)(struct hid_device *hdev,
700 struct hid_input *hidinput);
701 void (*feature_mapping)(struct hid_device *hdev,
702 struct hid_field *field,
703 struct hid_usage *usage);
705 int (*suspend)(struct hid_device *hdev, pm_message_t message);
706 int (*resume)(struct hid_device *hdev);
707 int (*reset_resume)(struct hid_device *hdev);
710 struct device_driver driver;
714 * hid_ll_driver - low level driver callbacks
715 * @start: called on probe to start the device
716 * @stop: called on remove
717 * @open: called by input layer on open
718 * @close: called by input layer on close
719 * @parse: this method is called only once to parse the device data,
720 * shouldn't allocate anything to not leak memory
721 * @request: send report request to device (e.g. feature report)
722 * @wait: wait for buffered io to complete (send/recv reports)
723 * @raw_request: send raw report request to device (e.g. feature report)
724 * @output_report: send output report to device
725 * @idle: send idle request to device
727 struct hid_ll_driver {
728 int (*start)(struct hid_device *hdev);
729 void (*stop)(struct hid_device *hdev);
731 int (*open)(struct hid_device *hdev);
732 void (*close)(struct hid_device *hdev);
734 int (*power)(struct hid_device *hdev, int level);
736 int (*parse)(struct hid_device *hdev);
738 void (*request)(struct hid_device *hdev,
739 struct hid_report *report, int reqtype);
741 int (*wait)(struct hid_device *hdev);
743 int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
744 __u8 *buf, size_t len, unsigned char rtype,
747 int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
749 int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
752 #define PM_HINT_FULLON 1<<5
753 #define PM_HINT_NORMAL 1<<1
755 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
756 /* We ignore a few input applications that are not widely used */
757 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
761 extern int hid_debug;
763 extern bool hid_ignore(struct hid_device *);
764 extern int hid_add_device(struct hid_device *);
765 extern void hid_destroy_device(struct hid_device *);
767 extern int __must_check __hid_register_driver(struct hid_driver *,
768 struct module *, const char *mod_name);
770 /* use a define to avoid include chaining to get THIS_MODULE & friends */
771 #define hid_register_driver(driver) \
772 __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
774 extern void hid_unregister_driver(struct hid_driver *);
777 * module_hid_driver() - Helper macro for registering a HID driver
778 * @__hid_driver: hid_driver struct
780 * Helper macro for HID drivers which do not do anything special in module
781 * init/exit. This eliminates a lot of boilerplate. Each module may only
782 * use this macro once, and calling it replaces module_init() and module_exit()
784 #define module_hid_driver(__hid_driver) \
785 module_driver(__hid_driver, hid_register_driver, \
786 hid_unregister_driver)
788 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
789 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
790 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
791 extern void hidinput_disconnect(struct hid_device *);
793 int hid_set_field(struct hid_field *, unsigned, __s32);
794 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
795 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
796 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
797 unsigned int hidinput_count_leds(struct hid_device *hid);
798 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
799 void hid_output_report(struct hid_report *report, __u8 *data);
800 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
801 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
802 struct hid_device *hid_allocate_device(void);
803 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
804 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
805 struct hid_report *hid_validate_values(struct hid_device *hid,
806 unsigned int type, unsigned int id,
807 unsigned int field_index,
808 unsigned int report_counts);
809 int hid_open_report(struct hid_device *device);
810 int hid_check_keys_pressed(struct hid_device *hid);
811 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
812 void hid_disconnect(struct hid_device *hid);
813 const struct hid_device_id *hid_match_id(struct hid_device *hdev,
814 const struct hid_device_id *id);
815 s32 hid_snto32(__u32 value, unsigned n);
818 * hid_device_io_start - enable HID input during probe, remove
822 * This should only be called during probe or remove and only be
823 * called by the thread calling probe or remove. It will allow
824 * incoming packets to be delivered to the driver.
826 static inline void hid_device_io_start(struct hid_device *hid) {
827 if (hid->io_started) {
828 dev_warn(&hid->dev, "io already started");
831 hid->io_started = true;
832 up(&hid->driver_input_lock);
836 * hid_device_io_stop - disable HID input during probe, remove
840 * Should only be called after hid_device_io_start. It will prevent
841 * incoming packets from going to the driver for the duration of
842 * probe, remove. If called during probe, packets will still go to the
843 * driver after probe is complete. This function should only be called
844 * by the thread calling probe or remove.
846 static inline void hid_device_io_stop(struct hid_device *hid) {
847 if (!hid->io_started) {
848 dev_warn(&hid->dev, "io already stopped");
851 hid->io_started = false;
852 down(&hid->driver_input_lock);
856 * hid_map_usage - map usage input bits
858 * @hidinput: hidinput which we are interested in
859 * @usage: usage to fill in
860 * @bit: pointer to input->{}bit (out parameter)
861 * @max: maximal valid usage->code to consider later (out parameter)
862 * @type: input event type (EV_KEY, EV_REL, ...)
863 * @c: code which corresponds to this usage and type
865 static inline void hid_map_usage(struct hid_input *hidinput,
866 struct hid_usage *usage, unsigned long **bit, int *max,
869 struct input_dev *input = hidinput->input;
876 *bit = input->absbit;
880 *bit = input->relbit;
884 *bit = input->keybit;
888 *bit = input->ledbit;
895 * hid_map_usage_clear - map usage input bits and clear the input bit
897 * The same as hid_map_usage, except the @c bit is also cleared in supported
900 static inline void hid_map_usage_clear(struct hid_input *hidinput,
901 struct hid_usage *usage, unsigned long **bit, int *max,
904 hid_map_usage(hidinput, usage, bit, max, type, c);
909 * hid_parse - parse HW reports
913 * Call this from probe after you set up the device (if needed). Your
914 * report_fixup will be called (if non-NULL) after reading raw report from
915 * device before passing it to hid layer for real parsing.
917 static inline int __must_check hid_parse(struct hid_device *hdev)
919 return hid_open_report(hdev);
923 * hid_hw_start - start underlaying HW
926 * @connect_mask: which outputs to connect, see HID_CONNECT_*
928 * Call this in probe function *after* hid_parse. This will setup HW buffers
929 * and start the device (if not deffered to device open). hid_hw_stop must be
930 * called if this was successful.
932 static inline int __must_check hid_hw_start(struct hid_device *hdev,
933 unsigned int connect_mask)
935 int ret = hdev->ll_driver->start(hdev);
936 if (ret || !connect_mask)
938 ret = hid_connect(hdev, connect_mask);
940 hdev->ll_driver->stop(hdev);
945 * hid_hw_stop - stop underlaying HW
949 * This is usually called from remove function or from probe when something
950 * failed and hid_hw_start was called already.
952 static inline void hid_hw_stop(struct hid_device *hdev)
954 hid_disconnect(hdev);
955 hdev->ll_driver->stop(hdev);
959 * hid_hw_open - signal underlaying HW to start delivering events
963 * Tell underlying HW to start delivering events from the device.
964 * This function should be called sometime after successful call
965 * to hid_hiw_start().
967 static inline int __must_check hid_hw_open(struct hid_device *hdev)
969 return hdev->ll_driver->open(hdev);
973 * hid_hw_close - signal underlaying HW to stop delivering events
977 * This function indicates that we are not interested in the events
978 * from this device anymore. Delivery of events may or may not stop,
979 * depending on the number of users still outstanding.
981 static inline void hid_hw_close(struct hid_device *hdev)
983 hdev->ll_driver->close(hdev);
987 * hid_hw_power - requests underlying HW to go into given power mode
990 * @level: requested power level (one of %PM_HINT_* defines)
992 * This function requests underlying hardware to enter requested power
996 static inline int hid_hw_power(struct hid_device *hdev, int level)
998 return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1003 * hid_hw_request - send report request to device
1006 * @report: report to send
1007 * @reqtype: hid request type
1009 static inline void hid_hw_request(struct hid_device *hdev,
1010 struct hid_report *report, int reqtype)
1012 if (hdev->ll_driver->request)
1013 return hdev->ll_driver->request(hdev, report, reqtype);
1015 __hid_request(hdev, report, reqtype);
1019 * hid_hw_raw_request - send report request to device
1022 * @reportnum: report ID
1023 * @buf: in/out data to transfer
1024 * @len: length of buf
1025 * @rtype: HID report type
1026 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1028 * @return: count of data transfered, negative if error
1030 * Same behavior as hid_hw_request, but with raw buffers instead.
1032 static inline int hid_hw_raw_request(struct hid_device *hdev,
1033 unsigned char reportnum, __u8 *buf,
1034 size_t len, unsigned char rtype, int reqtype)
1036 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1039 return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1044 * hid_hw_output_report - send output report to device
1047 * @buf: raw data to transfer
1048 * @len: length of buf
1050 * @return: count of data transfered, negative if error
1052 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1055 if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1058 if (hdev->ll_driver->output_report)
1059 return hdev->ll_driver->output_report(hdev, buf, len);
1065 * hid_hw_idle - send idle request to device
1068 * @report: report to control
1070 * @reqtype: hid request type
1072 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1075 if (hdev->ll_driver->idle)
1076 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1082 * hid_hw_wait - wait for buffered io to complete
1086 static inline void hid_hw_wait(struct hid_device *hdev)
1088 if (hdev->ll_driver->wait)
1089 hdev->ll_driver->wait(hdev);
1093 * hid_report_len - calculate the report length
1095 * @report: the report we want to know the length
1097 static inline int hid_report_len(struct hid_report *report)
1099 /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1100 return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1103 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1106 /* HID quirks API */
1107 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
1108 int usbhid_quirks_init(char **quirks_param);
1109 void usbhid_quirks_exit(void);
1111 #ifdef CONFIG_HID_PID
1112 int hid_pidff_init(struct hid_device *hid);
1114 #define hid_pidff_init NULL
1117 #define dbg_hid(format, arg...) \
1120 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg); \
1123 #define hid_printk(level, hid, fmt, arg...) \
1124 dev_printk(level, &(hid)->dev, fmt, ##arg)
1125 #define hid_emerg(hid, fmt, arg...) \
1126 dev_emerg(&(hid)->dev, fmt, ##arg)
1127 #define hid_crit(hid, fmt, arg...) \
1128 dev_crit(&(hid)->dev, fmt, ##arg)
1129 #define hid_alert(hid, fmt, arg...) \
1130 dev_alert(&(hid)->dev, fmt, ##arg)
1131 #define hid_err(hid, fmt, arg...) \
1132 dev_err(&(hid)->dev, fmt, ##arg)
1133 #define hid_notice(hid, fmt, arg...) \
1134 dev_notice(&(hid)->dev, fmt, ##arg)
1135 #define hid_warn(hid, fmt, arg...) \
1136 dev_warn(&(hid)->dev, fmt, ##arg)
1137 #define hid_info(hid, fmt, arg...) \
1138 dev_info(&(hid)->dev, fmt, ##arg)
1139 #define hid_dbg(hid, fmt, arg...) \
1140 dev_dbg(&(hid)->dev, fmt, ##arg)