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