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