• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1  /* SPDX-License-Identifier: GPL-2.0-or-later */
2  /*
3   *  Copyright (c) 1999 Andreas Gal
4   *  Copyright (c) 2000-2001 Vojtech Pavlik
5   *  Copyright (c) 2006-2007 Jiri Kosina
6   */
7  /*
8   *
9   * Should you need to contact me, the author, you can do so either by
10   * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
11   * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
12   */
13  #ifndef __HID_H
14  #define __HID_H
15  
16  
17  #include <linux/bitops.h>
18  #include <linux/types.h>
19  #include <linux/slab.h>
20  #include <linux/list.h>
21  #include <linux/mod_devicetable.h> /* hid_device_id */
22  #include <linux/timer.h>
23  #include <linux/workqueue.h>
24  #include <linux/input.h>
25  #include <linux/semaphore.h>
26  #include <linux/mutex.h>
27  #include <linux/power_supply.h>
28  #include <uapi/linux/hid.h>
29  
30  /*
31   * We parse each description item into this structure. Short items data
32   * values are expanded to 32-bit signed int, long items contain a pointer
33   * into the data area.
34   */
35  
36  struct hid_item {
37  	unsigned  format;
38  	__u8      size;
39  	__u8      type;
40  	__u8      tag;
41  	union {
42  	    __u8   u8;
43  	    __s8   s8;
44  	    __u16  u16;
45  	    __s16  s16;
46  	    __u32  u32;
47  	    __s32  s32;
48  	    __u8  *longdata;
49  	} data;
50  };
51  
52  /*
53   * HID report item format
54   */
55  
56  #define HID_ITEM_FORMAT_SHORT	0
57  #define HID_ITEM_FORMAT_LONG	1
58  
59  /*
60   * Special tag indicating long items
61   */
62  
63  #define HID_ITEM_TAG_LONG	15
64  
65  /*
66   * HID report descriptor item type (prefix bit 2,3)
67   */
68  
69  #define HID_ITEM_TYPE_MAIN		0
70  #define HID_ITEM_TYPE_GLOBAL		1
71  #define HID_ITEM_TYPE_LOCAL		2
72  #define HID_ITEM_TYPE_RESERVED		3
73  
74  /*
75   * HID report descriptor main item tags
76   */
77  
78  #define HID_MAIN_ITEM_TAG_INPUT			8
79  #define HID_MAIN_ITEM_TAG_OUTPUT		9
80  #define HID_MAIN_ITEM_TAG_FEATURE		11
81  #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION	10
82  #define HID_MAIN_ITEM_TAG_END_COLLECTION	12
83  
84  /*
85   * HID report descriptor main item contents
86   */
87  
88  #define HID_MAIN_ITEM_CONSTANT		0x001
89  #define HID_MAIN_ITEM_VARIABLE		0x002
90  #define HID_MAIN_ITEM_RELATIVE		0x004
91  #define HID_MAIN_ITEM_WRAP		0x008
92  #define HID_MAIN_ITEM_NONLINEAR		0x010
93  #define HID_MAIN_ITEM_NO_PREFERRED	0x020
94  #define HID_MAIN_ITEM_NULL_STATE	0x040
95  #define HID_MAIN_ITEM_VOLATILE		0x080
96  #define HID_MAIN_ITEM_BUFFERED_BYTE	0x100
97  
98  /*
99   * HID report descriptor collection item types
100   */
101  
102  #define HID_COLLECTION_PHYSICAL		0
103  #define HID_COLLECTION_APPLICATION	1
104  #define HID_COLLECTION_LOGICAL		2
105  
106  /*
107   * HID report descriptor global item tags
108   */
109  
110  #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE		0
111  #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM	1
112  #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM	2
113  #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM	3
114  #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM	4
115  #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT	5
116  #define HID_GLOBAL_ITEM_TAG_UNIT		6
117  #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE		7
118  #define HID_GLOBAL_ITEM_TAG_REPORT_ID		8
119  #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT	9
120  #define HID_GLOBAL_ITEM_TAG_PUSH		10
121  #define HID_GLOBAL_ITEM_TAG_POP			11
122  
123  /*
124   * HID report descriptor local item tags
125   */
126  
127  #define HID_LOCAL_ITEM_TAG_USAGE		0
128  #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM	1
129  #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM	2
130  #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX	3
131  #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM	4
132  #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM	5
133  #define HID_LOCAL_ITEM_TAG_STRING_INDEX		7
134  #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM	8
135  #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM	9
136  #define HID_LOCAL_ITEM_TAG_DELIMITER		10
137  
138  /*
139   * HID usage tables
140   */
141  
142  #define HID_USAGE_PAGE		0xffff0000
143  
144  #define HID_UP_UNDEFINED	0x00000000
145  #define HID_UP_GENDESK		0x00010000
146  #define HID_UP_SIMULATION	0x00020000
147  #define HID_UP_GENDEVCTRLS	0x00060000
148  #define HID_UP_KEYBOARD		0x00070000
149  #define HID_UP_LED		0x00080000
150  #define HID_UP_BUTTON		0x00090000
151  #define HID_UP_ORDINAL		0x000a0000
152  #define HID_UP_TELEPHONY	0x000b0000
153  #define HID_UP_CONSUMER		0x000c0000
154  #define HID_UP_DIGITIZER	0x000d0000
155  #define HID_UP_PID		0x000f0000
156  #define HID_UP_HPVENDOR         0xff7f0000
157  #define HID_UP_HPVENDOR2        0xff010000
158  #define HID_UP_MSVENDOR		0xff000000
159  #define HID_UP_CUSTOM		0x00ff0000
160  #define HID_UP_LOGIVENDOR	0xffbc0000
161  #define HID_UP_LOGIVENDOR2   0xff090000
162  #define HID_UP_LOGIVENDOR3   0xff430000
163  #define HID_UP_LNVENDOR		0xffa00000
164  #define HID_UP_SENSOR		0x00200000
165  #define HID_UP_ASUSVENDOR	0xff310000
166  #define HID_UP_GOOGLEVENDOR	0xffd10000
167  
168  #define HID_USAGE		0x0000ffff
169  
170  #define HID_GD_POINTER		0x00010001
171  #define HID_GD_MOUSE		0x00010002
172  #define HID_GD_JOYSTICK		0x00010004
173  #define HID_GD_GAMEPAD		0x00010005
174  #define HID_GD_KEYBOARD		0x00010006
175  #define HID_GD_KEYPAD		0x00010007
176  #define HID_GD_MULTIAXIS	0x00010008
177  /*
178   * Microsoft Win8 Wireless Radio Controls extensions CA, see:
179   * http://www.usb.org/developers/hidpage/HUTRR40RadioHIDUsagesFinal.pdf
180   */
181  #define HID_GD_WIRELESS_RADIO_CTLS	0x0001000c
182  /*
183   * System Multi-Axis, see:
184   * http://www.usb.org/developers/hidpage/HUTRR62_-_Generic_Desktop_CA_for_System_Multi-Axis_Controllers.txt
185   */
186  #define HID_GD_SYSTEM_MULTIAXIS	0x0001000e
187  
188  #define HID_GD_X		0x00010030
189  #define HID_GD_Y		0x00010031
190  #define HID_GD_Z		0x00010032
191  #define HID_GD_RX		0x00010033
192  #define HID_GD_RY		0x00010034
193  #define HID_GD_RZ		0x00010035
194  #define HID_GD_SLIDER		0x00010036
195  #define HID_GD_DIAL		0x00010037
196  #define HID_GD_WHEEL		0x00010038
197  #define HID_GD_HATSWITCH	0x00010039
198  #define HID_GD_BUFFER		0x0001003a
199  #define HID_GD_BYTECOUNT	0x0001003b
200  #define HID_GD_MOTION		0x0001003c
201  #define HID_GD_START		0x0001003d
202  #define HID_GD_SELECT		0x0001003e
203  #define HID_GD_VX		0x00010040
204  #define HID_GD_VY		0x00010041
205  #define HID_GD_VZ		0x00010042
206  #define HID_GD_VBRX		0x00010043
207  #define HID_GD_VBRY		0x00010044
208  #define HID_GD_VBRZ		0x00010045
209  #define HID_GD_VNO		0x00010046
210  #define HID_GD_FEATURE		0x00010047
211  #define HID_GD_RESOLUTION_MULTIPLIER	0x00010048
212  #define HID_GD_SYSTEM_CONTROL	0x00010080
213  #define HID_GD_UP		0x00010090
214  #define HID_GD_DOWN		0x00010091
215  #define HID_GD_RIGHT		0x00010092
216  #define HID_GD_LEFT		0x00010093
217  /* Microsoft Win8 Wireless Radio Controls CA usage codes */
218  #define HID_GD_RFKILL_BTN	0x000100c6
219  #define HID_GD_RFKILL_LED	0x000100c7
220  #define HID_GD_RFKILL_SWITCH	0x000100c8
221  
222  #define HID_DC_BATTERYSTRENGTH	0x00060020
223  
224  #define HID_CP_CONSUMER_CONTROL	0x000c0001
225  #define HID_CP_AC_PAN		0x000c0238
226  
227  #define HID_DG_DIGITIZER	0x000d0001
228  #define HID_DG_PEN		0x000d0002
229  #define HID_DG_LIGHTPEN		0x000d0003
230  #define HID_DG_TOUCHSCREEN	0x000d0004
231  #define HID_DG_TOUCHPAD		0x000d0005
232  #define HID_DG_WHITEBOARD	0x000d0006
233  #define HID_DG_STYLUS		0x000d0020
234  #define HID_DG_PUCK		0x000d0021
235  #define HID_DG_FINGER		0x000d0022
236  #define HID_DG_TIPPRESSURE	0x000d0030
237  #define HID_DG_BARRELPRESSURE	0x000d0031
238  #define HID_DG_INRANGE		0x000d0032
239  #define HID_DG_TOUCH		0x000d0033
240  #define HID_DG_UNTOUCH		0x000d0034
241  #define HID_DG_TAP		0x000d0035
242  #define HID_DG_TABLETFUNCTIONKEY	0x000d0039
243  #define HID_DG_PROGRAMCHANGEKEY	0x000d003a
244  #define HID_DG_BATTERYSTRENGTH	0x000d003b
245  #define HID_DG_INVERT		0x000d003c
246  #define HID_DG_TILT_X		0x000d003d
247  #define HID_DG_TILT_Y		0x000d003e
248  #define HID_DG_TWIST		0x000d0041
249  #define HID_DG_TIPSWITCH	0x000d0042
250  #define HID_DG_TIPSWITCH2	0x000d0043
251  #define HID_DG_BARRELSWITCH	0x000d0044
252  #define HID_DG_ERASER		0x000d0045
253  #define HID_DG_TABLETPICK	0x000d0046
254  
255  #define HID_CP_CONSUMERCONTROL	0x000c0001
256  #define HID_CP_NUMERICKEYPAD	0x000c0002
257  #define HID_CP_PROGRAMMABLEBUTTONS	0x000c0003
258  #define HID_CP_MICROPHONE	0x000c0004
259  #define HID_CP_HEADPHONE	0x000c0005
260  #define HID_CP_GRAPHICEQUALIZER	0x000c0006
261  #define HID_CP_FUNCTIONBUTTONS	0x000c0036
262  #define HID_CP_SELECTION	0x000c0080
263  #define HID_CP_MEDIASELECTION	0x000c0087
264  #define HID_CP_SELECTDISC	0x000c00ba
265  #define HID_CP_VOLUMEUP		0x000c00e9
266  #define HID_CP_VOLUMEDOWN	0x000c00ea
267  #define HID_CP_PLAYBACKSPEED	0x000c00f1
268  #define HID_CP_PROXIMITY	0x000c0109
269  #define HID_CP_SPEAKERSYSTEM	0x000c0160
270  #define HID_CP_CHANNELLEFT	0x000c0161
271  #define HID_CP_CHANNELRIGHT	0x000c0162
272  #define HID_CP_CHANNELCENTER	0x000c0163
273  #define HID_CP_CHANNELFRONT	0x000c0164
274  #define HID_CP_CHANNELCENTERFRONT	0x000c0165
275  #define HID_CP_CHANNELSIDE	0x000c0166
276  #define HID_CP_CHANNELSURROUND	0x000c0167
277  #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT	0x000c0168
278  #define HID_CP_CHANNELTOP	0x000c0169
279  #define HID_CP_CHANNELUNKNOWN	0x000c016a
280  #define HID_CP_APPLICATIONLAUNCHBUTTONS	0x000c0180
281  #define HID_CP_GENERICGUIAPPLICATIONCONTROLS	0x000c0200
282  
283  #define HID_DG_DEVICECONFIG	0x000d000e
284  #define HID_DG_DEVICESETTINGS	0x000d0023
285  #define HID_DG_AZIMUTH		0x000d003f
286  #define HID_DG_CONFIDENCE	0x000d0047
287  #define HID_DG_WIDTH		0x000d0048
288  #define HID_DG_HEIGHT		0x000d0049
289  #define HID_DG_CONTACTID	0x000d0051
290  #define HID_DG_INPUTMODE	0x000d0052
291  #define HID_DG_DEVICEINDEX	0x000d0053
292  #define HID_DG_CONTACTCOUNT	0x000d0054
293  #define HID_DG_CONTACTMAX	0x000d0055
294  #define HID_DG_SCANTIME		0x000d0056
295  #define HID_DG_SURFACESWITCH	0x000d0057
296  #define HID_DG_BUTTONSWITCH	0x000d0058
297  #define HID_DG_BUTTONTYPE	0x000d0059
298  #define HID_DG_BARRELSWITCH2	0x000d005a
299  #define HID_DG_TOOLSERIALNUMBER	0x000d005b
300  #define HID_DG_LATENCYMODE	0x000d0060
301  
302  #define HID_VD_ASUS_CUSTOM_MEDIA_KEYS	0xff310076
303  /*
304   * HID report types --- Ouch! HID spec says 1 2 3!
305   */
306  
307  #define HID_INPUT_REPORT	0
308  #define HID_OUTPUT_REPORT	1
309  #define HID_FEATURE_REPORT	2
310  
311  #define HID_REPORT_TYPES	3
312  
313  /*
314   * HID connect requests
315   */
316  
317  #define HID_CONNECT_HIDINPUT		BIT(0)
318  #define HID_CONNECT_HIDINPUT_FORCE	BIT(1)
319  #define HID_CONNECT_HIDRAW		BIT(2)
320  #define HID_CONNECT_HIDDEV		BIT(3)
321  #define HID_CONNECT_HIDDEV_FORCE	BIT(4)
322  #define HID_CONNECT_FF			BIT(5)
323  #define HID_CONNECT_DRIVER		BIT(6)
324  #define HID_CONNECT_DEFAULT	(HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
325  		HID_CONNECT_HIDDEV|HID_CONNECT_FF)
326  
327  /*
328   * HID device quirks.
329   */
330  
331  /*
332   * Increase this if you need to configure more HID quirks at module load time
333   */
334  #define MAX_USBHID_BOOT_QUIRKS 4
335  
336  #define HID_QUIRK_INVERT			BIT(0)
337  #define HID_QUIRK_NOTOUCH			BIT(1)
338  #define HID_QUIRK_IGNORE			BIT(2)
339  #define HID_QUIRK_NOGET				BIT(3)
340  #define HID_QUIRK_HIDDEV_FORCE			BIT(4)
341  #define HID_QUIRK_BADPAD			BIT(5)
342  #define HID_QUIRK_MULTI_INPUT			BIT(6)
343  #define HID_QUIRK_HIDINPUT_FORCE		BIT(7)
344  /* BIT(8) reserved for backward compatibility, was HID_QUIRK_NO_EMPTY_INPUT */
345  /* BIT(9) reserved for backward compatibility, was NO_INIT_INPUT_REPORTS */
346  #define HID_QUIRK_ALWAYS_POLL			BIT(10)
347  #define HID_QUIRK_INPUT_PER_APP			BIT(11)
348  #define HID_QUIRK_X_INVERT			BIT(12)
349  #define HID_QUIRK_Y_INVERT			BIT(13)
350  #define HID_QUIRK_SKIP_OUTPUT_REPORTS		BIT(16)
351  #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID		BIT(17)
352  #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP	BIT(18)
353  #define HID_QUIRK_HAVE_SPECIAL_DRIVER		BIT(19)
354  #define HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE	BIT(20)
355  #define HID_QUIRK_FULLSPEED_INTERVAL		BIT(28)
356  #define HID_QUIRK_NO_INIT_REPORTS		BIT(29)
357  #define HID_QUIRK_NO_IGNORE			BIT(30)
358  #define HID_QUIRK_NO_INPUT_SYNC			BIT(31)
359  
360  /*
361   * HID device groups
362   *
363   * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
364   * and has a value of 0x0000
365   */
366  #define HID_GROUP_GENERIC			0x0001
367  #define HID_GROUP_MULTITOUCH			0x0002
368  #define HID_GROUP_SENSOR_HUB			0x0003
369  #define HID_GROUP_MULTITOUCH_WIN_8		0x0004
370  
371  /*
372   * Vendor specific HID device groups
373   */
374  #define HID_GROUP_RMI				0x0100
375  #define HID_GROUP_WACOM				0x0101
376  #define HID_GROUP_LOGITECH_DJ_DEVICE		0x0102
377  #define HID_GROUP_STEAM				0x0103
378  #define HID_GROUP_LOGITECH_27MHZ_DEVICE		0x0104
379  #define HID_GROUP_VIVALDI			0x0105
380  
381  /*
382   * HID protocol status
383   */
384  #define HID_REPORT_PROTOCOL	1
385  #define HID_BOOT_PROTOCOL	0
386  
387  /*
388   * This is the global environment of the parser. This information is
389   * persistent for main-items. The global environment can be saved and
390   * restored with PUSH/POP statements.
391   */
392  
393  struct hid_global {
394  	unsigned usage_page;
395  	__s32    logical_minimum;
396  	__s32    logical_maximum;
397  	__s32    physical_minimum;
398  	__s32    physical_maximum;
399  	__s32    unit_exponent;
400  	unsigned unit;
401  	unsigned report_id;
402  	unsigned report_size;
403  	unsigned report_count;
404  };
405  
406  /*
407   * This is the local environment. It is persistent up the next main-item.
408   */
409  
410  #define HID_MAX_USAGES			12288
411  #define HID_DEFAULT_NUM_COLLECTIONS	16
412  
413  struct hid_local {
414  	unsigned usage[HID_MAX_USAGES]; /* usage array */
415  	u8 usage_size[HID_MAX_USAGES]; /* usage size array */
416  	unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
417  	unsigned usage_index;
418  	unsigned usage_minimum;
419  	unsigned delimiter_depth;
420  	unsigned delimiter_branch;
421  };
422  
423  /*
424   * This is the collection stack. We climb up the stack to determine
425   * application and function of each field.
426   */
427  
428  struct hid_collection {
429  	int parent_idx; /* device->collection */
430  	unsigned type;
431  	unsigned usage;
432  	unsigned level;
433  };
434  
435  struct hid_usage {
436  	unsigned  hid;			/* hid usage code */
437  	unsigned  collection_index;	/* index into collection array */
438  	unsigned  usage_index;		/* index into usage array */
439  	__s8	  resolution_multiplier;/* Effective Resolution Multiplier
440  					   (HUT v1.12, 4.3.1), default: 1 */
441  	/* hidinput data */
442  	__s8	  wheel_factor;		/* 120/resolution_multiplier */
443  	__u16     code;			/* input driver code */
444  	__u8      type;			/* input driver type */
445  	__s8	  hat_min;		/* hat switch fun */
446  	__s8	  hat_max;		/* ditto */
447  	__s8	  hat_dir;		/* ditto */
448  	__s16	  wheel_accumulated;	/* hi-res wheel */
449  };
450  
451  struct hid_input;
452  
453  struct hid_field {
454  	unsigned  physical;		/* physical usage for this field */
455  	unsigned  logical;		/* logical usage for this field */
456  	unsigned  application;		/* application usage for this field */
457  	struct hid_usage *usage;	/* usage table for this function */
458  	unsigned  maxusage;		/* maximum usage index */
459  	unsigned  flags;		/* main-item flags (i.e. volatile,array,constant) */
460  	unsigned  report_offset;	/* bit offset in the report */
461  	unsigned  report_size;		/* size of this field in the report */
462  	unsigned  report_count;		/* number of this field in the report */
463  	unsigned  report_type;		/* (input,output,feature) */
464  	__s32    *value;		/* last known value(s) */
465  	__s32     logical_minimum;
466  	__s32     logical_maximum;
467  	__s32     physical_minimum;
468  	__s32     physical_maximum;
469  	__s32     unit_exponent;
470  	unsigned  unit;
471  	struct hid_report *report;	/* associated report */
472  	unsigned index;			/* index into report->field[] */
473  	/* hidinput data */
474  	struct hid_input *hidinput;	/* associated input structure */
475  	__u16 dpad;			/* dpad input code */
476  };
477  
478  #define HID_MAX_FIELDS 256
479  
480  struct hid_report {
481  	struct list_head list;
482  	struct list_head hidinput_list;
483  	unsigned int id;				/* id of this report */
484  	unsigned int type;				/* report type */
485  	unsigned int application;			/* application usage for this report */
486  	struct hid_field *field[HID_MAX_FIELDS];	/* fields of the report */
487  	unsigned maxfield;				/* maximum valid field index */
488  	unsigned size;					/* size of the report (bits) */
489  	struct hid_device *device;			/* associated device */
490  };
491  
492  #define HID_MAX_IDS 256
493  
494  struct hid_report_enum {
495  	unsigned numbered;
496  	struct list_head report_list;
497  	struct hid_report *report_id_hash[HID_MAX_IDS];
498  };
499  
500  #define HID_MIN_BUFFER_SIZE	64		/* make sure there is at least a packet size of space */
501  #define HID_MAX_BUFFER_SIZE	8192		/* 8kb */
502  #define HID_CONTROL_FIFO_SIZE	256		/* to init devices with >100 reports */
503  #define HID_OUTPUT_FIFO_SIZE	64
504  
505  struct hid_control_fifo {
506  	unsigned char dir;
507  	struct hid_report *report;
508  	char *raw_report;
509  };
510  
511  struct hid_output_fifo {
512  	struct hid_report *report;
513  	char *raw_report;
514  };
515  
516  #define HID_CLAIMED_INPUT	BIT(0)
517  #define HID_CLAIMED_HIDDEV	BIT(1)
518  #define HID_CLAIMED_HIDRAW	BIT(2)
519  #define HID_CLAIMED_DRIVER	BIT(3)
520  
521  #define HID_STAT_ADDED		BIT(0)
522  #define HID_STAT_PARSED		BIT(1)
523  #define HID_STAT_DUP_DETECTED	BIT(2)
524  #define HID_STAT_REPROBED	BIT(3)
525  
526  struct hid_input {
527  	struct list_head list;
528  	struct hid_report *report;
529  	struct input_dev *input;
530  	const char *name;
531  	bool registered;
532  	struct list_head reports;	/* the list of reports */
533  	unsigned int application;	/* application usage for this input */
534  };
535  
536  enum hid_type {
537  	HID_TYPE_OTHER = 0,
538  	HID_TYPE_USBMOUSE,
539  	HID_TYPE_USBNONE
540  };
541  
542  enum hid_battery_status {
543  	HID_BATTERY_UNKNOWN = 0,
544  	HID_BATTERY_QUERIED,		/* Kernel explicitly queried battery strength */
545  	HID_BATTERY_REPORTED,		/* Device sent unsolicited battery strength report */
546  };
547  
548  struct hid_driver;
549  struct hid_ll_driver;
550  
551  struct hid_device {							/* device report descriptor */
552  	__u8 *dev_rdesc;
553  	unsigned dev_rsize;
554  	__u8 *rdesc;
555  	unsigned rsize;
556  	struct hid_collection *collection;				/* List of HID collections */
557  	unsigned collection_size;					/* Number of allocated hid_collections */
558  	unsigned maxcollection;						/* Number of parsed collections */
559  	unsigned maxapplication;					/* Number of applications */
560  	__u16 bus;							/* BUS ID */
561  	__u16 group;							/* Report group */
562  	__u32 vendor;							/* Vendor ID */
563  	__u32 product;							/* Product ID */
564  	__u32 version;							/* HID version */
565  	enum hid_type type;						/* device type (mouse, kbd, ...) */
566  	unsigned country;						/* HID country */
567  	struct hid_report_enum report_enum[HID_REPORT_TYPES];
568  	struct work_struct led_work;					/* delayed LED worker */
569  
570  	struct semaphore driver_input_lock;				/* protects the current driver */
571  	struct device dev;						/* device */
572  	struct hid_driver *driver;
573  
574  	struct hid_ll_driver *ll_driver;
575  	struct mutex ll_open_lock;
576  	unsigned int ll_open_count;
577  
578  #ifdef CONFIG_HID_BATTERY_STRENGTH
579  	/*
580  	 * Power supply information for HID devices which report
581  	 * battery strength. power_supply was successfully registered if
582  	 * battery is non-NULL.
583  	 */
584  	struct power_supply *battery;
585  	__s32 battery_capacity;
586  	__s32 battery_min;
587  	__s32 battery_max;
588  	__s32 battery_report_type;
589  	__s32 battery_report_id;
590  	enum hid_battery_status battery_status;
591  	bool battery_avoid_query;
592  #endif
593  
594  	unsigned long status;						/* see STAT flags above */
595  	unsigned claimed;						/* Claimed by hidinput, hiddev? */
596  	unsigned quirks;						/* Various quirks the device can pull on us */
597  	bool io_started;						/* If IO has started */
598  
599  	struct list_head inputs;					/* The list of inputs */
600  	void *hiddev;							/* The hiddev structure */
601  	void *hidraw;
602  
603  	char name[128];							/* Device name */
604  	char phys[64];							/* Device physical location */
605  	char uniq[64];							/* Device unique identifier (serial #) */
606  
607  	void *driver_data;
608  
609  	/* temporary hid_ff handling (until moved to the drivers) */
610  	int (*ff_init)(struct hid_device *);
611  
612  	/* hiddev event handler */
613  	int (*hiddev_connect)(struct hid_device *, unsigned int);
614  	void (*hiddev_disconnect)(struct hid_device *);
615  	void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
616  				  struct hid_usage *, __s32);
617  	void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
618  
619  	/* debugging support via debugfs */
620  	unsigned short debug;
621  	struct dentry *debug_dir;
622  	struct dentry *debug_rdesc;
623  	struct dentry *debug_events;
624  	struct list_head debug_list;
625  	spinlock_t  debug_list_lock;
626  	wait_queue_head_t debug_wait;
627  };
628  
629  #define to_hid_device(pdev) \
630  	container_of(pdev, struct hid_device, dev)
631  
hid_get_drvdata(struct hid_device * hdev)632  static inline void *hid_get_drvdata(struct hid_device *hdev)
633  {
634  	return dev_get_drvdata(&hdev->dev);
635  }
636  
hid_set_drvdata(struct hid_device * hdev,void * data)637  static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
638  {
639  	dev_set_drvdata(&hdev->dev, data);
640  }
641  
642  #define HID_GLOBAL_STACK_SIZE 4
643  #define HID_COLLECTION_STACK_SIZE 4
644  
645  #define HID_SCAN_FLAG_MT_WIN_8			BIT(0)
646  #define HID_SCAN_FLAG_VENDOR_SPECIFIC		BIT(1)
647  #define HID_SCAN_FLAG_GD_POINTER		BIT(2)
648  
649  struct hid_parser {
650  	struct hid_global     global;
651  	struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
652  	unsigned int          global_stack_ptr;
653  	struct hid_local      local;
654  	unsigned int         *collection_stack;
655  	unsigned int          collection_stack_ptr;
656  	unsigned int          collection_stack_size;
657  	struct hid_device    *device;
658  	unsigned int          scan_flags;
659  };
660  
661  struct hid_class_descriptor {
662  	__u8  bDescriptorType;
663  	__le16 wDescriptorLength;
664  } __attribute__ ((packed));
665  
666  struct hid_descriptor {
667  	__u8  bLength;
668  	__u8  bDescriptorType;
669  	__le16 bcdHID;
670  	__u8  bCountryCode;
671  	__u8  bNumDescriptors;
672  
673  	struct hid_class_descriptor desc[1];
674  } __attribute__ ((packed));
675  
676  #define HID_DEVICE(b, g, ven, prod)					\
677  	.bus = (b), .group = (g), .vendor = (ven), .product = (prod)
678  #define HID_USB_DEVICE(ven, prod)				\
679  	.bus = BUS_USB, .vendor = (ven), .product = (prod)
680  #define HID_BLUETOOTH_DEVICE(ven, prod)					\
681  	.bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
682  #define HID_I2C_DEVICE(ven, prod)				\
683  	.bus = BUS_I2C, .vendor = (ven), .product = (prod)
684  
685  #define HID_REPORT_ID(rep) \
686  	.report_type = (rep)
687  #define HID_USAGE_ID(uhid, utype, ucode) \
688  	.usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
689  /* we don't want to catch types and codes equal to 0 */
690  #define HID_TERMINATOR		(HID_ANY_ID - 1)
691  
692  struct hid_report_id {
693  	__u32 report_type;
694  };
695  struct hid_usage_id {
696  	__u32 usage_hid;
697  	__u32 usage_type;
698  	__u32 usage_code;
699  };
700  
701  /**
702   * struct hid_driver
703   * @name: driver name (e.g. "Footech_bar-wheel")
704   * @id_table: which devices is this driver for (must be non-NULL for probe
705   * 	      to be called)
706   * @dyn_list: list of dynamically added device ids
707   * @dyn_lock: lock protecting @dyn_list
708   * @match: check if the given device is handled by this driver
709   * @probe: new device inserted
710   * @remove: device removed (NULL if not a hot-plug capable driver)
711   * @report_table: on which reports to call raw_event (NULL means all)
712   * @raw_event: if report in report_table, this hook is called (NULL means nop)
713   * @usage_table: on which events to call event (NULL means all)
714   * @event: if usage in usage_table, this hook is called (NULL means nop)
715   * @report: this hook is called after parsing a report (NULL means nop)
716   * @report_fixup: called before report descriptor parsing (NULL means nop)
717   * @input_mapping: invoked on input registering before mapping an usage
718   * @input_mapped: invoked on input registering after mapping an usage
719   * @input_configured: invoked just before the device is registered
720   * @feature_mapping: invoked on feature registering
721   * @suspend: invoked on suspend (NULL means nop)
722   * @resume: invoked on resume if device was not reset (NULL means nop)
723   * @reset_resume: invoked on resume if device was reset (NULL means nop)
724   *
725   * probe should return -errno on error, or 0 on success. During probe,
726   * input will not be passed to raw_event unless hid_device_io_start is
727   * called.
728   *
729   * raw_event and event should return negative on error, any other value will
730   * pass the event on to .event() typically return 0 for success.
731   *
732   * input_mapping shall return a negative value to completely ignore this usage
733   * (e.g. doubled or invalid usage), zero to continue with parsing of this
734   * usage by generic code (no special handling needed) or positive to skip
735   * generic parsing (needed special handling which was done in the hook already)
736   * input_mapped shall return negative to inform the layer that this usage
737   * should not be considered for further processing or zero to notify that
738   * no processing was performed and should be done in a generic manner
739   * Both these functions may be NULL which means the same behavior as returning
740   * zero from them.
741   */
742  struct hid_driver {
743  	char *name;
744  	const struct hid_device_id *id_table;
745  
746  	struct list_head dyn_list;
747  	spinlock_t dyn_lock;
748  
749  	bool (*match)(struct hid_device *dev, bool ignore_special_driver);
750  	int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
751  	void (*remove)(struct hid_device *dev);
752  
753  	const struct hid_report_id *report_table;
754  	int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
755  			u8 *data, int size);
756  	const struct hid_usage_id *usage_table;
757  	int (*event)(struct hid_device *hdev, struct hid_field *field,
758  			struct hid_usage *usage, __s32 value);
759  	void (*report)(struct hid_device *hdev, struct hid_report *report);
760  
761  	__u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
762  			unsigned int *size);
763  
764  	int (*input_mapping)(struct hid_device *hdev,
765  			struct hid_input *hidinput, struct hid_field *field,
766  			struct hid_usage *usage, unsigned long **bit, int *max);
767  	int (*input_mapped)(struct hid_device *hdev,
768  			struct hid_input *hidinput, struct hid_field *field,
769  			struct hid_usage *usage, unsigned long **bit, int *max);
770  	int (*input_configured)(struct hid_device *hdev,
771  				struct hid_input *hidinput);
772  	void (*feature_mapping)(struct hid_device *hdev,
773  			struct hid_field *field,
774  			struct hid_usage *usage);
775  #ifdef CONFIG_PM
776  	int (*suspend)(struct hid_device *hdev, pm_message_t message);
777  	int (*resume)(struct hid_device *hdev);
778  	int (*reset_resume)(struct hid_device *hdev);
779  #endif
780  /* private: */
781  	struct device_driver driver;
782  };
783  
784  #define to_hid_driver(pdrv) \
785  	container_of(pdrv, struct hid_driver, driver)
786  
787  /**
788   * hid_ll_driver - low level driver callbacks
789   * @start: called on probe to start the device
790   * @stop: called on remove
791   * @open: called by input layer on open
792   * @close: called by input layer on close
793   * @power: request underlying hardware to enter requested power mode
794   * @parse: this method is called only once to parse the device data,
795   *	   shouldn't allocate anything to not leak memory
796   * @request: send report request to device (e.g. feature report)
797   * @wait: wait for buffered io to complete (send/recv reports)
798   * @raw_request: send raw report request to device (e.g. feature report)
799   * @output_report: send output report to device
800   * @idle: send idle request to device
801   */
802  struct hid_ll_driver {
803  	int (*start)(struct hid_device *hdev);
804  	void (*stop)(struct hid_device *hdev);
805  
806  	int (*open)(struct hid_device *hdev);
807  	void (*close)(struct hid_device *hdev);
808  
809  	int (*power)(struct hid_device *hdev, int level);
810  
811  	int (*parse)(struct hid_device *hdev);
812  
813  	void (*request)(struct hid_device *hdev,
814  			struct hid_report *report, int reqtype);
815  
816  	int (*wait)(struct hid_device *hdev);
817  
818  	int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
819  			    __u8 *buf, size_t len, unsigned char rtype,
820  			    int reqtype);
821  
822  	int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
823  
824  	int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
825  };
826  
827  extern struct hid_ll_driver i2c_hid_ll_driver;
828  extern struct hid_ll_driver hidp_hid_driver;
829  extern struct hid_ll_driver uhid_hid_driver;
830  extern struct hid_ll_driver usb_hid_driver;
831  
hid_is_using_ll_driver(struct hid_device * hdev,struct hid_ll_driver * driver)832  static inline bool hid_is_using_ll_driver(struct hid_device *hdev,
833  		struct hid_ll_driver *driver)
834  {
835  	return hdev->ll_driver == driver;
836  }
837  
hid_is_usb(struct hid_device * hdev)838  static inline bool hid_is_usb(struct hid_device *hdev)
839  {
840  	return hid_is_using_ll_driver(hdev, &usb_hid_driver);
841  }
842  
843  #define	PM_HINT_FULLON	1<<5
844  #define PM_HINT_NORMAL	1<<1
845  
846  /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
847  /* We ignore a few input applications that are not widely used */
848  #define IS_INPUT_APPLICATION(a) \
849  		(((a >= HID_UP_GENDESK) && (a <= HID_GD_MULTIAXIS)) \
850  		|| ((a >= HID_DG_PEN) && (a <= HID_DG_WHITEBOARD)) \
851  		|| (a == HID_GD_SYSTEM_CONTROL) || (a == HID_CP_CONSUMER_CONTROL) \
852  		|| (a == HID_GD_WIRELESS_RADIO_CTLS))
853  
854  /* HID core API */
855  
856  extern int hid_debug;
857  
858  extern bool hid_ignore(struct hid_device *);
859  extern int hid_add_device(struct hid_device *);
860  extern void hid_destroy_device(struct hid_device *);
861  
862  extern struct bus_type hid_bus_type;
863  
864  extern int __must_check __hid_register_driver(struct hid_driver *,
865  		struct module *, const char *mod_name);
866  
867  /* use a define to avoid include chaining to get THIS_MODULE & friends */
868  #define hid_register_driver(driver) \
869  	__hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
870  
871  extern void hid_unregister_driver(struct hid_driver *);
872  
873  /**
874   * module_hid_driver() - Helper macro for registering a HID driver
875   * @__hid_driver: hid_driver struct
876   *
877   * Helper macro for HID drivers which do not do anything special in module
878   * init/exit. This eliminates a lot of boilerplate. Each module may only
879   * use this macro once, and calling it replaces module_init() and module_exit()
880   */
881  #define module_hid_driver(__hid_driver) \
882  	module_driver(__hid_driver, hid_register_driver, \
883  		      hid_unregister_driver)
884  
885  extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
886  extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
887  extern int hidinput_connect(struct hid_device *hid, unsigned int force);
888  extern void hidinput_disconnect(struct hid_device *);
889  
890  int hid_set_field(struct hid_field *, unsigned, __s32);
891  int hid_input_report(struct hid_device *, int type, u8 *, u32, int);
892  int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
893  struct hid_field *hidinput_get_led_field(struct hid_device *hid);
894  unsigned int hidinput_count_leds(struct hid_device *hid);
895  __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
896  void hid_output_report(struct hid_report *report, __u8 *data);
897  int __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
898  u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
899  struct hid_device *hid_allocate_device(void);
900  struct hid_report *hid_register_report(struct hid_device *device,
901  				       unsigned int type, unsigned int id,
902  				       unsigned int application);
903  int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
904  struct hid_report *hid_validate_values(struct hid_device *hid,
905  				       unsigned int type, unsigned int id,
906  				       unsigned int field_index,
907  				       unsigned int report_counts);
908  
909  void hid_setup_resolution_multiplier(struct hid_device *hid);
910  int hid_open_report(struct hid_device *device);
911  int hid_check_keys_pressed(struct hid_device *hid);
912  int hid_connect(struct hid_device *hid, unsigned int connect_mask);
913  void hid_disconnect(struct hid_device *hid);
914  bool hid_match_one_id(const struct hid_device *hdev,
915  		      const struct hid_device_id *id);
916  const struct hid_device_id *hid_match_id(const struct hid_device *hdev,
917  					 const struct hid_device_id *id);
918  const struct hid_device_id *hid_match_device(struct hid_device *hdev,
919  					     struct hid_driver *hdrv);
920  bool hid_compare_device_paths(struct hid_device *hdev_a,
921  			      struct hid_device *hdev_b, char separator);
922  s32 hid_snto32(__u32 value, unsigned n);
923  __u32 hid_field_extract(const struct hid_device *hid, __u8 *report,
924  		     unsigned offset, unsigned n);
925  
926  /**
927   * hid_device_io_start - enable HID input during probe, remove
928   *
929   * @hid - the device
930   *
931   * This should only be called during probe or remove and only be
932   * called by the thread calling probe or remove. It will allow
933   * incoming packets to be delivered to the driver.
934   */
hid_device_io_start(struct hid_device * hid)935  static inline void hid_device_io_start(struct hid_device *hid) {
936  	if (hid->io_started) {
937  		dev_warn(&hid->dev, "io already started\n");
938  		return;
939  	}
940  	hid->io_started = true;
941  	up(&hid->driver_input_lock);
942  }
943  
944  /**
945   * hid_device_io_stop - disable HID input during probe, remove
946   *
947   * @hid - the device
948   *
949   * Should only be called after hid_device_io_start. It will prevent
950   * incoming packets from going to the driver for the duration of
951   * probe, remove. If called during probe, packets will still go to the
952   * driver after probe is complete. This function should only be called
953   * by the thread calling probe or remove.
954   */
hid_device_io_stop(struct hid_device * hid)955  static inline void hid_device_io_stop(struct hid_device *hid) {
956  	if (!hid->io_started) {
957  		dev_warn(&hid->dev, "io already stopped\n");
958  		return;
959  	}
960  	hid->io_started = false;
961  	down(&hid->driver_input_lock);
962  }
963  
964  /**
965   * hid_map_usage - map usage input bits
966   *
967   * @hidinput: hidinput which we are interested in
968   * @usage: usage to fill in
969   * @bit: pointer to input->{}bit (out parameter)
970   * @max: maximal valid usage->code to consider later (out parameter)
971   * @type: input event type (EV_KEY, EV_REL, ...)
972   * @c: code which corresponds to this usage and type
973   *
974   * The value pointed to by @bit will be set to NULL if either @type is
975   * an unhandled event type, or if @c is out of range for @type. This
976   * can be used as an error condition.
977   */
hid_map_usage(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,unsigned int c)978  static inline void hid_map_usage(struct hid_input *hidinput,
979  		struct hid_usage *usage, unsigned long **bit, int *max,
980  		__u8 type, unsigned int c)
981  {
982  	struct input_dev *input = hidinput->input;
983  	unsigned long *bmap = NULL;
984  	unsigned int limit = 0;
985  
986  	switch (type) {
987  	case EV_ABS:
988  		bmap = input->absbit;
989  		limit = ABS_MAX;
990  		break;
991  	case EV_REL:
992  		bmap = input->relbit;
993  		limit = REL_MAX;
994  		break;
995  	case EV_KEY:
996  		bmap = input->keybit;
997  		limit = KEY_MAX;
998  		break;
999  	case EV_LED:
1000  		bmap = input->ledbit;
1001  		limit = LED_MAX;
1002  		break;
1003  	}
1004  
1005  	if (unlikely(c > limit || !bmap)) {
1006  		pr_warn_ratelimited("%s: Invalid code %d type %d\n",
1007  				    input->name, c, type);
1008  		*bit = NULL;
1009  		return;
1010  	}
1011  
1012  	usage->type = type;
1013  	usage->code = c;
1014  	*max = limit;
1015  	*bit = bmap;
1016  }
1017  
1018  /**
1019   * hid_map_usage_clear - map usage input bits and clear the input bit
1020   *
1021   * The same as hid_map_usage, except the @c bit is also cleared in supported
1022   * bits (@bit).
1023   */
hid_map_usage_clear(struct hid_input * hidinput,struct hid_usage * usage,unsigned long ** bit,int * max,__u8 type,__u16 c)1024  static inline void hid_map_usage_clear(struct hid_input *hidinput,
1025  		struct hid_usage *usage, unsigned long **bit, int *max,
1026  		__u8 type, __u16 c)
1027  {
1028  	hid_map_usage(hidinput, usage, bit, max, type, c);
1029  	if (*bit)
1030  		clear_bit(usage->code, *bit);
1031  }
1032  
1033  /**
1034   * hid_parse - parse HW reports
1035   *
1036   * @hdev: hid device
1037   *
1038   * Call this from probe after you set up the device (if needed). Your
1039   * report_fixup will be called (if non-NULL) after reading raw report from
1040   * device before passing it to hid layer for real parsing.
1041   */
hid_parse(struct hid_device * hdev)1042  static inline int __must_check hid_parse(struct hid_device *hdev)
1043  {
1044  	return hid_open_report(hdev);
1045  }
1046  
1047  int __must_check hid_hw_start(struct hid_device *hdev,
1048  			      unsigned int connect_mask);
1049  void hid_hw_stop(struct hid_device *hdev);
1050  int __must_check hid_hw_open(struct hid_device *hdev);
1051  void hid_hw_close(struct hid_device *hdev);
1052  
1053  /**
1054   * hid_hw_power - requests underlying HW to go into given power mode
1055   *
1056   * @hdev: hid device
1057   * @level: requested power level (one of %PM_HINT_* defines)
1058   *
1059   * This function requests underlying hardware to enter requested power
1060   * mode.
1061   */
1062  
hid_hw_power(struct hid_device * hdev,int level)1063  static inline int hid_hw_power(struct hid_device *hdev, int level)
1064  {
1065  	return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1066  }
1067  
1068  
1069  /**
1070   * hid_hw_request - send report request to device
1071   *
1072   * @hdev: hid device
1073   * @report: report to send
1074   * @reqtype: hid request type
1075   */
hid_hw_request(struct hid_device * hdev,struct hid_report * report,int reqtype)1076  static inline void hid_hw_request(struct hid_device *hdev,
1077  				  struct hid_report *report, int reqtype)
1078  {
1079  	if (hdev->ll_driver->request)
1080  		return hdev->ll_driver->request(hdev, report, reqtype);
1081  
1082  	__hid_request(hdev, report, reqtype);
1083  }
1084  
1085  /**
1086   * hid_hw_raw_request - send report request to device
1087   *
1088   * @hdev: hid device
1089   * @reportnum: report ID
1090   * @buf: in/out data to transfer
1091   * @len: length of buf
1092   * @rtype: HID report type
1093   * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1094   *
1095   * @return: count of data transfered, negative if error
1096   *
1097   * Same behavior as hid_hw_request, but with raw buffers instead.
1098   */
hid_hw_raw_request(struct hid_device * hdev,unsigned char reportnum,__u8 * buf,size_t len,unsigned char rtype,int reqtype)1099  static inline int hid_hw_raw_request(struct hid_device *hdev,
1100  				  unsigned char reportnum, __u8 *buf,
1101  				  size_t len, unsigned char rtype, int reqtype)
1102  {
1103  	if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1104  		return -EINVAL;
1105  
1106  	return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1107  						    rtype, reqtype);
1108  }
1109  
1110  /**
1111   * hid_hw_output_report - send output report to device
1112   *
1113   * @hdev: hid device
1114   * @buf: raw data to transfer
1115   * @len: length of buf
1116   *
1117   * @return: count of data transfered, negative if error
1118   */
hid_hw_output_report(struct hid_device * hdev,__u8 * buf,size_t len)1119  static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1120  					size_t len)
1121  {
1122  	if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1123  		return -EINVAL;
1124  
1125  	if (hdev->ll_driver->output_report)
1126  		return hdev->ll_driver->output_report(hdev, buf, len);
1127  
1128  	return -ENOSYS;
1129  }
1130  
1131  /**
1132   * hid_hw_idle - send idle request to device
1133   *
1134   * @hdev: hid device
1135   * @report: report to control
1136   * @idle: idle state
1137   * @reqtype: hid request type
1138   */
hid_hw_idle(struct hid_device * hdev,int report,int idle,int reqtype)1139  static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1140  		int reqtype)
1141  {
1142  	if (hdev->ll_driver->idle)
1143  		return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1144  
1145  	return 0;
1146  }
1147  
1148  /**
1149   * hid_hw_wait - wait for buffered io to complete
1150   *
1151   * @hdev: hid device
1152   */
hid_hw_wait(struct hid_device * hdev)1153  static inline void hid_hw_wait(struct hid_device *hdev)
1154  {
1155  	if (hdev->ll_driver->wait)
1156  		hdev->ll_driver->wait(hdev);
1157  }
1158  
1159  /**
1160   * hid_report_len - calculate the report length
1161   *
1162   * @report: the report we want to know the length
1163   */
hid_report_len(struct hid_report * report)1164  static inline u32 hid_report_len(struct hid_report *report)
1165  {
1166  	return DIV_ROUND_UP(report->size, 8) + (report->id > 0);
1167  }
1168  
1169  int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, u32 size,
1170  		int interrupt);
1171  
1172  /* HID quirks API */
1173  unsigned long hid_lookup_quirk(const struct hid_device *hdev);
1174  int hid_quirks_init(char **quirks_param, __u16 bus, int count);
1175  void hid_quirks_exit(__u16 bus);
1176  
1177  #ifdef CONFIG_HID_PID
1178  int hid_pidff_init(struct hid_device *hid);
1179  #else
1180  #define hid_pidff_init NULL
1181  #endif
1182  
1183  #define dbg_hid(fmt, ...)						\
1184  do {									\
1185  	if (hid_debug)							\
1186  		printk(KERN_DEBUG "%s: " fmt, __FILE__, ##__VA_ARGS__);	\
1187  } while (0)
1188  
1189  #define hid_err(hid, fmt, ...)				\
1190  	dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
1191  #define hid_notice(hid, fmt, ...)			\
1192  	dev_notice(&(hid)->dev, fmt, ##__VA_ARGS__)
1193  #define hid_warn(hid, fmt, ...)				\
1194  	dev_warn(&(hid)->dev, fmt, ##__VA_ARGS__)
1195  #define hid_info(hid, fmt, ...)				\
1196  	dev_info(&(hid)->dev, fmt, ##__VA_ARGS__)
1197  #define hid_dbg(hid, fmt, ...)				\
1198  	dev_dbg(&(hid)->dev, fmt, ##__VA_ARGS__)
1199  
1200  #define hid_err_once(hid, fmt, ...)			\
1201  	dev_err_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1202  #define hid_notice_once(hid, fmt, ...)			\
1203  	dev_notice_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1204  #define hid_warn_once(hid, fmt, ...)			\
1205  	dev_warn_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1206  #define hid_info_once(hid, fmt, ...)			\
1207  	dev_info_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1208  #define hid_dbg_once(hid, fmt, ...)			\
1209  	dev_dbg_once(&(hid)->dev, fmt, ##__VA_ARGS__)
1210  
1211  #endif
1212