xref: /linux-6.15/include/linux/input.h (revision c75b81bf)
1 #ifndef _INPUT_H
2 #define _INPUT_H
3 
4 /*
5  * Copyright (c) 1999-2002 Vojtech Pavlik
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  */
11 
12 #ifdef __KERNEL__
13 #include <linux/time.h>
14 #include <linux/list.h>
15 #else
16 #include <sys/time.h>
17 #include <sys/ioctl.h>
18 #include <sys/types.h>
19 #include <linux/types.h>
20 #endif
21 
22 /*
23  * The event structure itself
24  */
25 
26 struct input_event {
27 	struct timeval time;
28 	__u16 type;
29 	__u16 code;
30 	__s32 value;
31 };
32 
33 /*
34  * Protocol version.
35  */
36 
37 #define EV_VERSION		0x010000
38 
39 /*
40  * IOCTLs (0x00 - 0x7f)
41  */
42 
43 struct input_id {
44 	__u16 bustype;
45 	__u16 vendor;
46 	__u16 product;
47 	__u16 version;
48 };
49 
50 struct input_absinfo {
51 	__s32 value;
52 	__s32 minimum;
53 	__s32 maximum;
54 	__s32 fuzz;
55 	__s32 flat;
56 	__s32 resolution;
57 };
58 
59 #define EVIOCGVERSION		_IOR('E', 0x01, int)			/* get driver version */
60 #define EVIOCGID		_IOR('E', 0x02, struct input_id)	/* get device ID */
61 #define EVIOCGREP		_IOR('E', 0x03, int[2])			/* get repeat settings */
62 #define EVIOCSREP		_IOW('E', 0x03, int[2])			/* set repeat settings */
63 #define EVIOCGKEYCODE		_IOR('E', 0x04, int[2])			/* get keycode */
64 #define EVIOCSKEYCODE		_IOW('E', 0x04, int[2])			/* set keycode */
65 
66 #define EVIOCGNAME(len)		_IOC(_IOC_READ, 'E', 0x06, len)		/* get device name */
67 #define EVIOCGPHYS(len)		_IOC(_IOC_READ, 'E', 0x07, len)		/* get physical location */
68 #define EVIOCGUNIQ(len)		_IOC(_IOC_READ, 'E', 0x08, len)		/* get unique identifier */
69 
70 #define EVIOCGKEY(len)		_IOC(_IOC_READ, 'E', 0x18, len)		/* get global keystate */
71 #define EVIOCGLED(len)		_IOC(_IOC_READ, 'E', 0x19, len)		/* get all LEDs */
72 #define EVIOCGSND(len)		_IOC(_IOC_READ, 'E', 0x1a, len)		/* get all sounds status */
73 #define EVIOCGSW(len)		_IOC(_IOC_READ, 'E', 0x1b, len)		/* get all switch states */
74 
75 #define EVIOCGBIT(ev,len)	_IOC(_IOC_READ, 'E', 0x20 + ev, len)	/* get event bits */
76 #define EVIOCGABS(abs)		_IOR('E', 0x40 + abs, struct input_absinfo)		/* get abs value/limits */
77 #define EVIOCSABS(abs)		_IOW('E', 0xc0 + abs, struct input_absinfo)		/* set abs value/limits */
78 
79 #define EVIOCSFF		_IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))	/* send a force effect to a force feedback device */
80 #define EVIOCRMFF		_IOW('E', 0x81, int)			/* Erase a force effect */
81 #define EVIOCGEFFECTS		_IOR('E', 0x84, int)			/* Report number of effects playable at the same time */
82 
83 #define EVIOCGRAB		_IOW('E', 0x90, int)			/* Grab/Release device */
84 
85 /*
86  * Event types
87  */
88 
89 #define EV_SYN			0x00
90 #define EV_KEY			0x01
91 #define EV_REL			0x02
92 #define EV_ABS			0x03
93 #define EV_MSC			0x04
94 #define EV_SW			0x05
95 #define EV_LED			0x11
96 #define EV_SND			0x12
97 #define EV_REP			0x14
98 #define EV_FF			0x15
99 #define EV_PWR			0x16
100 #define EV_FF_STATUS		0x17
101 #define EV_MAX			0x1f
102 #define EV_CNT			(EV_MAX+1)
103 
104 /*
105  * Synchronization events.
106  */
107 
108 #define SYN_REPORT		0
109 #define SYN_CONFIG		1
110 #define SYN_MT_REPORT		2
111 
112 /*
113  * Keys and buttons
114  *
115  * Most of the keys/buttons are modeled after USB HUT 1.12
116  * (see http://www.usb.org/developers/hidpage).
117  * Abbreviations in the comments:
118  * AC - Application Control
119  * AL - Application Launch Button
120  * SC - System Control
121  */
122 
123 #define KEY_RESERVED		0
124 #define KEY_ESC			1
125 #define KEY_1			2
126 #define KEY_2			3
127 #define KEY_3			4
128 #define KEY_4			5
129 #define KEY_5			6
130 #define KEY_6			7
131 #define KEY_7			8
132 #define KEY_8			9
133 #define KEY_9			10
134 #define KEY_0			11
135 #define KEY_MINUS		12
136 #define KEY_EQUAL		13
137 #define KEY_BACKSPACE		14
138 #define KEY_TAB			15
139 #define KEY_Q			16
140 #define KEY_W			17
141 #define KEY_E			18
142 #define KEY_R			19
143 #define KEY_T			20
144 #define KEY_Y			21
145 #define KEY_U			22
146 #define KEY_I			23
147 #define KEY_O			24
148 #define KEY_P			25
149 #define KEY_LEFTBRACE		26
150 #define KEY_RIGHTBRACE		27
151 #define KEY_ENTER		28
152 #define KEY_LEFTCTRL		29
153 #define KEY_A			30
154 #define KEY_S			31
155 #define KEY_D			32
156 #define KEY_F			33
157 #define KEY_G			34
158 #define KEY_H			35
159 #define KEY_J			36
160 #define KEY_K			37
161 #define KEY_L			38
162 #define KEY_SEMICOLON		39
163 #define KEY_APOSTROPHE		40
164 #define KEY_GRAVE		41
165 #define KEY_LEFTSHIFT		42
166 #define KEY_BACKSLASH		43
167 #define KEY_Z			44
168 #define KEY_X			45
169 #define KEY_C			46
170 #define KEY_V			47
171 #define KEY_B			48
172 #define KEY_N			49
173 #define KEY_M			50
174 #define KEY_COMMA		51
175 #define KEY_DOT			52
176 #define KEY_SLASH		53
177 #define KEY_RIGHTSHIFT		54
178 #define KEY_KPASTERISK		55
179 #define KEY_LEFTALT		56
180 #define KEY_SPACE		57
181 #define KEY_CAPSLOCK		58
182 #define KEY_F1			59
183 #define KEY_F2			60
184 #define KEY_F3			61
185 #define KEY_F4			62
186 #define KEY_F5			63
187 #define KEY_F6			64
188 #define KEY_F7			65
189 #define KEY_F8			66
190 #define KEY_F9			67
191 #define KEY_F10			68
192 #define KEY_NUMLOCK		69
193 #define KEY_SCROLLLOCK		70
194 #define KEY_KP7			71
195 #define KEY_KP8			72
196 #define KEY_KP9			73
197 #define KEY_KPMINUS		74
198 #define KEY_KP4			75
199 #define KEY_KP5			76
200 #define KEY_KP6			77
201 #define KEY_KPPLUS		78
202 #define KEY_KP1			79
203 #define KEY_KP2			80
204 #define KEY_KP3			81
205 #define KEY_KP0			82
206 #define KEY_KPDOT		83
207 
208 #define KEY_ZENKAKUHANKAKU	85
209 #define KEY_102ND		86
210 #define KEY_F11			87
211 #define KEY_F12			88
212 #define KEY_RO			89
213 #define KEY_KATAKANA		90
214 #define KEY_HIRAGANA		91
215 #define KEY_HENKAN		92
216 #define KEY_KATAKANAHIRAGANA	93
217 #define KEY_MUHENKAN		94
218 #define KEY_KPJPCOMMA		95
219 #define KEY_KPENTER		96
220 #define KEY_RIGHTCTRL		97
221 #define KEY_KPSLASH		98
222 #define KEY_SYSRQ		99
223 #define KEY_RIGHTALT		100
224 #define KEY_LINEFEED		101
225 #define KEY_HOME		102
226 #define KEY_UP			103
227 #define KEY_PAGEUP		104
228 #define KEY_LEFT		105
229 #define KEY_RIGHT		106
230 #define KEY_END			107
231 #define KEY_DOWN		108
232 #define KEY_PAGEDOWN		109
233 #define KEY_INSERT		110
234 #define KEY_DELETE		111
235 #define KEY_MACRO		112
236 #define KEY_MUTE		113
237 #define KEY_VOLUMEDOWN		114
238 #define KEY_VOLUMEUP		115
239 #define KEY_POWER		116	/* SC System Power Down */
240 #define KEY_KPEQUAL		117
241 #define KEY_KPPLUSMINUS		118
242 #define KEY_PAUSE		119
243 #define KEY_SCALE		120	/* AL Compiz Scale (Expose) */
244 
245 #define KEY_KPCOMMA		121
246 #define KEY_HANGEUL		122
247 #define KEY_HANGUEL		KEY_HANGEUL
248 #define KEY_HANJA		123
249 #define KEY_YEN			124
250 #define KEY_LEFTMETA		125
251 #define KEY_RIGHTMETA		126
252 #define KEY_COMPOSE		127
253 
254 #define KEY_STOP		128	/* AC Stop */
255 #define KEY_AGAIN		129
256 #define KEY_PROPS		130	/* AC Properties */
257 #define KEY_UNDO		131	/* AC Undo */
258 #define KEY_FRONT		132
259 #define KEY_COPY		133	/* AC Copy */
260 #define KEY_OPEN		134	/* AC Open */
261 #define KEY_PASTE		135	/* AC Paste */
262 #define KEY_FIND		136	/* AC Search */
263 #define KEY_CUT			137	/* AC Cut */
264 #define KEY_HELP		138	/* AL Integrated Help Center */
265 #define KEY_MENU		139	/* Menu (show menu) */
266 #define KEY_CALC		140	/* AL Calculator */
267 #define KEY_SETUP		141
268 #define KEY_SLEEP		142	/* SC System Sleep */
269 #define KEY_WAKEUP		143	/* System Wake Up */
270 #define KEY_FILE		144	/* AL Local Machine Browser */
271 #define KEY_SENDFILE		145
272 #define KEY_DELETEFILE		146
273 #define KEY_XFER		147
274 #define KEY_PROG1		148
275 #define KEY_PROG2		149
276 #define KEY_WWW			150	/* AL Internet Browser */
277 #define KEY_MSDOS		151
278 #define KEY_COFFEE		152	/* AL Terminal Lock/Screensaver */
279 #define KEY_SCREENLOCK		KEY_COFFEE
280 #define KEY_DIRECTION		153
281 #define KEY_CYCLEWINDOWS	154
282 #define KEY_MAIL		155
283 #define KEY_BOOKMARKS		156	/* AC Bookmarks */
284 #define KEY_COMPUTER		157
285 #define KEY_BACK		158	/* AC Back */
286 #define KEY_FORWARD		159	/* AC Forward */
287 #define KEY_CLOSECD		160
288 #define KEY_EJECTCD		161
289 #define KEY_EJECTCLOSECD	162
290 #define KEY_NEXTSONG		163
291 #define KEY_PLAYPAUSE		164
292 #define KEY_PREVIOUSSONG	165
293 #define KEY_STOPCD		166
294 #define KEY_RECORD		167
295 #define KEY_REWIND		168
296 #define KEY_PHONE		169	/* Media Select Telephone */
297 #define KEY_ISO			170
298 #define KEY_CONFIG		171	/* AL Consumer Control Configuration */
299 #define KEY_HOMEPAGE		172	/* AC Home */
300 #define KEY_REFRESH		173	/* AC Refresh */
301 #define KEY_EXIT		174	/* AC Exit */
302 #define KEY_MOVE		175
303 #define KEY_EDIT		176
304 #define KEY_SCROLLUP		177
305 #define KEY_SCROLLDOWN		178
306 #define KEY_KPLEFTPAREN		179
307 #define KEY_KPRIGHTPAREN	180
308 #define KEY_NEW			181	/* AC New */
309 #define KEY_REDO		182	/* AC Redo/Repeat */
310 
311 #define KEY_F13			183
312 #define KEY_F14			184
313 #define KEY_F15			185
314 #define KEY_F16			186
315 #define KEY_F17			187
316 #define KEY_F18			188
317 #define KEY_F19			189
318 #define KEY_F20			190
319 #define KEY_F21			191
320 #define KEY_F22			192
321 #define KEY_F23			193
322 #define KEY_F24			194
323 
324 #define KEY_PLAYCD		200
325 #define KEY_PAUSECD		201
326 #define KEY_PROG3		202
327 #define KEY_PROG4		203
328 #define KEY_DASHBOARD		204	/* AL Dashboard */
329 #define KEY_SUSPEND		205
330 #define KEY_CLOSE		206	/* AC Close */
331 #define KEY_PLAY		207
332 #define KEY_FASTFORWARD		208
333 #define KEY_BASSBOOST		209
334 #define KEY_PRINT		210	/* AC Print */
335 #define KEY_HP			211
336 #define KEY_CAMERA		212
337 #define KEY_SOUND		213
338 #define KEY_QUESTION		214
339 #define KEY_EMAIL		215
340 #define KEY_CHAT		216
341 #define KEY_SEARCH		217
342 #define KEY_CONNECT		218
343 #define KEY_FINANCE		219	/* AL Checkbook/Finance */
344 #define KEY_SPORT		220
345 #define KEY_SHOP		221
346 #define KEY_ALTERASE		222
347 #define KEY_CANCEL		223	/* AC Cancel */
348 #define KEY_BRIGHTNESSDOWN	224
349 #define KEY_BRIGHTNESSUP	225
350 #define KEY_MEDIA		226
351 
352 #define KEY_SWITCHVIDEOMODE	227	/* Cycle between available video
353 					   outputs (Monitor/LCD/TV-out/etc) */
354 #define KEY_KBDILLUMTOGGLE	228
355 #define KEY_KBDILLUMDOWN	229
356 #define KEY_KBDILLUMUP		230
357 
358 #define KEY_SEND		231	/* AC Send */
359 #define KEY_REPLY		232	/* AC Reply */
360 #define KEY_FORWARDMAIL		233	/* AC Forward Msg */
361 #define KEY_SAVE		234	/* AC Save */
362 #define KEY_DOCUMENTS		235
363 
364 #define KEY_BATTERY		236
365 
366 #define KEY_BLUETOOTH		237
367 #define KEY_WLAN		238
368 #define KEY_UWB			239
369 
370 #define KEY_UNKNOWN		240
371 
372 #define KEY_VIDEO_NEXT		241	/* drive next video source */
373 #define KEY_VIDEO_PREV		242	/* drive previous video source */
374 #define KEY_BRIGHTNESS_CYCLE	243	/* brightness up, after max is min */
375 #define KEY_BRIGHTNESS_ZERO	244	/* brightness off, use ambient */
376 #define KEY_DISPLAY_OFF		245	/* display device to off state */
377 
378 #define KEY_WIMAX		246
379 
380 /* Range 248 - 255 is reserved for special needs of AT keyboard driver */
381 
382 #define BTN_MISC		0x100
383 #define BTN_0			0x100
384 #define BTN_1			0x101
385 #define BTN_2			0x102
386 #define BTN_3			0x103
387 #define BTN_4			0x104
388 #define BTN_5			0x105
389 #define BTN_6			0x106
390 #define BTN_7			0x107
391 #define BTN_8			0x108
392 #define BTN_9			0x109
393 
394 #define BTN_MOUSE		0x110
395 #define BTN_LEFT		0x110
396 #define BTN_RIGHT		0x111
397 #define BTN_MIDDLE		0x112
398 #define BTN_SIDE		0x113
399 #define BTN_EXTRA		0x114
400 #define BTN_FORWARD		0x115
401 #define BTN_BACK		0x116
402 #define BTN_TASK		0x117
403 
404 #define BTN_JOYSTICK		0x120
405 #define BTN_TRIGGER		0x120
406 #define BTN_THUMB		0x121
407 #define BTN_THUMB2		0x122
408 #define BTN_TOP			0x123
409 #define BTN_TOP2		0x124
410 #define BTN_PINKIE		0x125
411 #define BTN_BASE		0x126
412 #define BTN_BASE2		0x127
413 #define BTN_BASE3		0x128
414 #define BTN_BASE4		0x129
415 #define BTN_BASE5		0x12a
416 #define BTN_BASE6		0x12b
417 #define BTN_DEAD		0x12f
418 
419 #define BTN_GAMEPAD		0x130
420 #define BTN_A			0x130
421 #define BTN_B			0x131
422 #define BTN_C			0x132
423 #define BTN_X			0x133
424 #define BTN_Y			0x134
425 #define BTN_Z			0x135
426 #define BTN_TL			0x136
427 #define BTN_TR			0x137
428 #define BTN_TL2			0x138
429 #define BTN_TR2			0x139
430 #define BTN_SELECT		0x13a
431 #define BTN_START		0x13b
432 #define BTN_MODE		0x13c
433 #define BTN_THUMBL		0x13d
434 #define BTN_THUMBR		0x13e
435 
436 #define BTN_DIGI		0x140
437 #define BTN_TOOL_PEN		0x140
438 #define BTN_TOOL_RUBBER		0x141
439 #define BTN_TOOL_BRUSH		0x142
440 #define BTN_TOOL_PENCIL		0x143
441 #define BTN_TOOL_AIRBRUSH	0x144
442 #define BTN_TOOL_FINGER		0x145
443 #define BTN_TOOL_MOUSE		0x146
444 #define BTN_TOOL_LENS		0x147
445 #define BTN_TOUCH		0x14a
446 #define BTN_STYLUS		0x14b
447 #define BTN_STYLUS2		0x14c
448 #define BTN_TOOL_DOUBLETAP	0x14d
449 #define BTN_TOOL_TRIPLETAP	0x14e
450 #define BTN_TOOL_QUADTAP	0x14f	/* Four fingers on trackpad */
451 
452 #define BTN_WHEEL		0x150
453 #define BTN_GEAR_DOWN		0x150
454 #define BTN_GEAR_UP		0x151
455 
456 #define KEY_OK			0x160
457 #define KEY_SELECT		0x161
458 #define KEY_GOTO		0x162
459 #define KEY_CLEAR		0x163
460 #define KEY_POWER2		0x164
461 #define KEY_OPTION		0x165
462 #define KEY_INFO		0x166	/* AL OEM Features/Tips/Tutorial */
463 #define KEY_TIME		0x167
464 #define KEY_VENDOR		0x168
465 #define KEY_ARCHIVE		0x169
466 #define KEY_PROGRAM		0x16a	/* Media Select Program Guide */
467 #define KEY_CHANNEL		0x16b
468 #define KEY_FAVORITES		0x16c
469 #define KEY_EPG			0x16d
470 #define KEY_PVR			0x16e	/* Media Select Home */
471 #define KEY_MHP			0x16f
472 #define KEY_LANGUAGE		0x170
473 #define KEY_TITLE		0x171
474 #define KEY_SUBTITLE		0x172
475 #define KEY_ANGLE		0x173
476 #define KEY_ZOOM		0x174
477 #define KEY_MODE		0x175
478 #define KEY_KEYBOARD		0x176
479 #define KEY_SCREEN		0x177
480 #define KEY_PC			0x178	/* Media Select Computer */
481 #define KEY_TV			0x179	/* Media Select TV */
482 #define KEY_TV2			0x17a	/* Media Select Cable */
483 #define KEY_VCR			0x17b	/* Media Select VCR */
484 #define KEY_VCR2		0x17c	/* VCR Plus */
485 #define KEY_SAT			0x17d	/* Media Select Satellite */
486 #define KEY_SAT2		0x17e
487 #define KEY_CD			0x17f	/* Media Select CD */
488 #define KEY_TAPE		0x180	/* Media Select Tape */
489 #define KEY_RADIO		0x181
490 #define KEY_TUNER		0x182	/* Media Select Tuner */
491 #define KEY_PLAYER		0x183
492 #define KEY_TEXT		0x184
493 #define KEY_DVD			0x185	/* Media Select DVD */
494 #define KEY_AUX			0x186
495 #define KEY_MP3			0x187
496 #define KEY_AUDIO		0x188
497 #define KEY_VIDEO		0x189
498 #define KEY_DIRECTORY		0x18a
499 #define KEY_LIST		0x18b
500 #define KEY_MEMO		0x18c	/* Media Select Messages */
501 #define KEY_CALENDAR		0x18d
502 #define KEY_RED			0x18e
503 #define KEY_GREEN		0x18f
504 #define KEY_YELLOW		0x190
505 #define KEY_BLUE		0x191
506 #define KEY_CHANNELUP		0x192	/* Channel Increment */
507 #define KEY_CHANNELDOWN		0x193	/* Channel Decrement */
508 #define KEY_FIRST		0x194
509 #define KEY_LAST		0x195	/* Recall Last */
510 #define KEY_AB			0x196
511 #define KEY_NEXT		0x197
512 #define KEY_RESTART		0x198
513 #define KEY_SLOW		0x199
514 #define KEY_SHUFFLE		0x19a
515 #define KEY_BREAK		0x19b
516 #define KEY_PREVIOUS		0x19c
517 #define KEY_DIGITS		0x19d
518 #define KEY_TEEN		0x19e
519 #define KEY_TWEN		0x19f
520 #define KEY_VIDEOPHONE		0x1a0	/* Media Select Video Phone */
521 #define KEY_GAMES		0x1a1	/* Media Select Games */
522 #define KEY_ZOOMIN		0x1a2	/* AC Zoom In */
523 #define KEY_ZOOMOUT		0x1a3	/* AC Zoom Out */
524 #define KEY_ZOOMRESET		0x1a4	/* AC Zoom */
525 #define KEY_WORDPROCESSOR	0x1a5	/* AL Word Processor */
526 #define KEY_EDITOR		0x1a6	/* AL Text Editor */
527 #define KEY_SPREADSHEET		0x1a7	/* AL Spreadsheet */
528 #define KEY_GRAPHICSEDITOR	0x1a8	/* AL Graphics Editor */
529 #define KEY_PRESENTATION	0x1a9	/* AL Presentation App */
530 #define KEY_DATABASE		0x1aa	/* AL Database App */
531 #define KEY_NEWS		0x1ab	/* AL Newsreader */
532 #define KEY_VOICEMAIL		0x1ac	/* AL Voicemail */
533 #define KEY_ADDRESSBOOK		0x1ad	/* AL Contacts/Address Book */
534 #define KEY_MESSENGER		0x1ae	/* AL Instant Messaging */
535 #define KEY_DISPLAYTOGGLE	0x1af	/* Turn display (LCD) on and off */
536 #define KEY_SPELLCHECK		0x1b0   /* AL Spell Check */
537 #define KEY_LOGOFF		0x1b1   /* AL Logoff */
538 
539 #define KEY_DOLLAR		0x1b2
540 #define KEY_EURO		0x1b3
541 
542 #define KEY_FRAMEBACK		0x1b4	/* Consumer - transport controls */
543 #define KEY_FRAMEFORWARD	0x1b5
544 #define KEY_CONTEXT_MENU	0x1b6	/* GenDesc - system context menu */
545 #define KEY_MEDIA_REPEAT	0x1b7	/* Consumer - transport control */
546 
547 #define KEY_DEL_EOL		0x1c0
548 #define KEY_DEL_EOS		0x1c1
549 #define KEY_INS_LINE		0x1c2
550 #define KEY_DEL_LINE		0x1c3
551 
552 #define KEY_FN			0x1d0
553 #define KEY_FN_ESC		0x1d1
554 #define KEY_FN_F1		0x1d2
555 #define KEY_FN_F2		0x1d3
556 #define KEY_FN_F3		0x1d4
557 #define KEY_FN_F4		0x1d5
558 #define KEY_FN_F5		0x1d6
559 #define KEY_FN_F6		0x1d7
560 #define KEY_FN_F7		0x1d8
561 #define KEY_FN_F8		0x1d9
562 #define KEY_FN_F9		0x1da
563 #define KEY_FN_F10		0x1db
564 #define KEY_FN_F11		0x1dc
565 #define KEY_FN_F12		0x1dd
566 #define KEY_FN_1		0x1de
567 #define KEY_FN_2		0x1df
568 #define KEY_FN_D		0x1e0
569 #define KEY_FN_E		0x1e1
570 #define KEY_FN_F		0x1e2
571 #define KEY_FN_S		0x1e3
572 #define KEY_FN_B		0x1e4
573 
574 #define KEY_BRL_DOT1		0x1f1
575 #define KEY_BRL_DOT2		0x1f2
576 #define KEY_BRL_DOT3		0x1f3
577 #define KEY_BRL_DOT4		0x1f4
578 #define KEY_BRL_DOT5		0x1f5
579 #define KEY_BRL_DOT6		0x1f6
580 #define KEY_BRL_DOT7		0x1f7
581 #define KEY_BRL_DOT8		0x1f8
582 #define KEY_BRL_DOT9		0x1f9
583 #define KEY_BRL_DOT10		0x1fa
584 
585 #define KEY_NUMERIC_0		0x200	/* used by phones, remote controls, */
586 #define KEY_NUMERIC_1		0x201	/* and other keypads */
587 #define KEY_NUMERIC_2		0x202
588 #define KEY_NUMERIC_3		0x203
589 #define KEY_NUMERIC_4		0x204
590 #define KEY_NUMERIC_5		0x205
591 #define KEY_NUMERIC_6		0x206
592 #define KEY_NUMERIC_7		0x207
593 #define KEY_NUMERIC_8		0x208
594 #define KEY_NUMERIC_9		0x209
595 #define KEY_NUMERIC_STAR	0x20a
596 #define KEY_NUMERIC_POUND	0x20b
597 
598 #define KEY_CAMERA_FOCUS	0x210
599 
600 /* We avoid low common keys in module aliases so they don't get huge. */
601 #define KEY_MIN_INTERESTING	KEY_MUTE
602 #define KEY_MAX			0x2ff
603 #define KEY_CNT			(KEY_MAX+1)
604 
605 /*
606  * Relative axes
607  */
608 
609 #define REL_X			0x00
610 #define REL_Y			0x01
611 #define REL_Z			0x02
612 #define REL_RX			0x03
613 #define REL_RY			0x04
614 #define REL_RZ			0x05
615 #define REL_HWHEEL		0x06
616 #define REL_DIAL		0x07
617 #define REL_WHEEL		0x08
618 #define REL_MISC		0x09
619 #define REL_MAX			0x0f
620 #define REL_CNT			(REL_MAX+1)
621 
622 /*
623  * Absolute axes
624  */
625 
626 #define ABS_X			0x00
627 #define ABS_Y			0x01
628 #define ABS_Z			0x02
629 #define ABS_RX			0x03
630 #define ABS_RY			0x04
631 #define ABS_RZ			0x05
632 #define ABS_THROTTLE		0x06
633 #define ABS_RUDDER		0x07
634 #define ABS_WHEEL		0x08
635 #define ABS_GAS			0x09
636 #define ABS_BRAKE		0x0a
637 #define ABS_HAT0X		0x10
638 #define ABS_HAT0Y		0x11
639 #define ABS_HAT1X		0x12
640 #define ABS_HAT1Y		0x13
641 #define ABS_HAT2X		0x14
642 #define ABS_HAT2Y		0x15
643 #define ABS_HAT3X		0x16
644 #define ABS_HAT3Y		0x17
645 #define ABS_PRESSURE		0x18
646 #define ABS_DISTANCE		0x19
647 #define ABS_TILT_X		0x1a
648 #define ABS_TILT_Y		0x1b
649 #define ABS_TOOL_WIDTH		0x1c
650 #define ABS_VOLUME		0x20
651 #define ABS_MISC		0x28
652 
653 #define ABS_MT_TOUCH_MAJOR	0x30	/* Major axis of touching ellipse */
654 #define ABS_MT_TOUCH_MINOR	0x31	/* Minor axis (omit if circular) */
655 #define ABS_MT_WIDTH_MAJOR	0x32	/* Major axis of approaching ellipse */
656 #define ABS_MT_WIDTH_MINOR	0x33	/* Minor axis (omit if circular) */
657 #define ABS_MT_ORIENTATION	0x34	/* Ellipse orientation */
658 #define ABS_MT_POSITION_X	0x35	/* Center X ellipse position */
659 #define ABS_MT_POSITION_Y	0x36	/* Center Y ellipse position */
660 #define ABS_MT_TOOL_TYPE	0x37	/* Type of touching device */
661 #define ABS_MT_BLOB_ID		0x38	/* Group a set of packets as a blob */
662 #define ABS_MT_TRACKING_ID	0x39	/* Unique ID of initiated contact */
663 #define ABS_MT_PRESSURE		0x3a	/* Pressure on contact area */
664 
665 #define ABS_MAX			0x3f
666 #define ABS_CNT			(ABS_MAX+1)
667 
668 /*
669  * Switch events
670  */
671 
672 #define SW_LID			0x00  /* set = lid shut */
673 #define SW_TABLET_MODE		0x01  /* set = tablet mode */
674 #define SW_HEADPHONE_INSERT	0x02  /* set = inserted */
675 #define SW_RFKILL_ALL		0x03  /* rfkill master switch, type "any"
676 					 set = radio enabled */
677 #define SW_RADIO		SW_RFKILL_ALL	/* deprecated */
678 #define SW_MICROPHONE_INSERT	0x04  /* set = inserted */
679 #define SW_DOCK			0x05  /* set = plugged into dock */
680 #define SW_LINEOUT_INSERT	0x06  /* set = inserted */
681 #define SW_JACK_PHYSICAL_INSERT 0x07  /* set = mechanical switch set */
682 #define SW_VIDEOOUT_INSERT	0x08  /* set = inserted */
683 #define SW_CAMERA_LENS_COVER	0x09  /* set = lens covered */
684 #define SW_KEYPAD_SLIDE		0x0a  /* set = keypad slide out */
685 #define SW_FRONT_PROXIMITY	0x0b  /* set = front proximity sensor active */
686 #define SW_MAX			0x0f
687 #define SW_CNT			(SW_MAX+1)
688 
689 /*
690  * Misc events
691  */
692 
693 #define MSC_SERIAL		0x00
694 #define MSC_PULSELED		0x01
695 #define MSC_GESTURE		0x02
696 #define MSC_RAW			0x03
697 #define MSC_SCAN		0x04
698 #define MSC_MAX			0x07
699 #define MSC_CNT			(MSC_MAX+1)
700 
701 /*
702  * LEDs
703  */
704 
705 #define LED_NUML		0x00
706 #define LED_CAPSL		0x01
707 #define LED_SCROLLL		0x02
708 #define LED_COMPOSE		0x03
709 #define LED_KANA		0x04
710 #define LED_SLEEP		0x05
711 #define LED_SUSPEND		0x06
712 #define LED_MUTE		0x07
713 #define LED_MISC		0x08
714 #define LED_MAIL		0x09
715 #define LED_CHARGING		0x0a
716 #define LED_MAX			0x0f
717 #define LED_CNT			(LED_MAX+1)
718 
719 /*
720  * Autorepeat values
721  */
722 
723 #define REP_DELAY		0x00
724 #define REP_PERIOD		0x01
725 #define REP_MAX			0x01
726 
727 /*
728  * Sounds
729  */
730 
731 #define SND_CLICK		0x00
732 #define SND_BELL		0x01
733 #define SND_TONE		0x02
734 #define SND_MAX			0x07
735 #define SND_CNT			(SND_MAX+1)
736 
737 /*
738  * IDs.
739  */
740 
741 #define ID_BUS			0
742 #define ID_VENDOR		1
743 #define ID_PRODUCT		2
744 #define ID_VERSION		3
745 
746 #define BUS_PCI			0x01
747 #define BUS_ISAPNP		0x02
748 #define BUS_USB			0x03
749 #define BUS_HIL			0x04
750 #define BUS_BLUETOOTH		0x05
751 #define BUS_VIRTUAL		0x06
752 
753 #define BUS_ISA			0x10
754 #define BUS_I8042		0x11
755 #define BUS_XTKBD		0x12
756 #define BUS_RS232		0x13
757 #define BUS_GAMEPORT		0x14
758 #define BUS_PARPORT		0x15
759 #define BUS_AMIGA		0x16
760 #define BUS_ADB			0x17
761 #define BUS_I2C			0x18
762 #define BUS_HOST		0x19
763 #define BUS_GSC			0x1A
764 #define BUS_ATARI		0x1B
765 
766 /*
767  * MT_TOOL types
768  */
769 #define MT_TOOL_FINGER		0
770 #define MT_TOOL_PEN		1
771 
772 /*
773  * Values describing the status of a force-feedback effect
774  */
775 #define FF_STATUS_STOPPED	0x00
776 #define FF_STATUS_PLAYING	0x01
777 #define FF_STATUS_MAX		0x01
778 
779 /*
780  * Structures used in ioctls to upload effects to a device
781  * They are pieces of a bigger structure (called ff_effect)
782  */
783 
784 /*
785  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
786  * should not be used and have unspecified results.
787  */
788 
789 /**
790  * struct ff_replay - defines scheduling of the force-feedback effect
791  * @length: duration of the effect
792  * @delay: delay before effect should start playing
793  */
794 struct ff_replay {
795 	__u16 length;
796 	__u16 delay;
797 };
798 
799 /**
800  * struct ff_trigger - defines what triggers the force-feedback effect
801  * @button: number of the button triggering the effect
802  * @interval: controls how soon the effect can be re-triggered
803  */
804 struct ff_trigger {
805 	__u16 button;
806 	__u16 interval;
807 };
808 
809 /**
810  * struct ff_envelope - generic force-feedback effect envelope
811  * @attack_length: duration of the attack (ms)
812  * @attack_level: level at the beginning of the attack
813  * @fade_length: duration of fade (ms)
814  * @fade_level: level at the end of fade
815  *
816  * The @attack_level and @fade_level are absolute values; when applying
817  * envelope force-feedback core will convert to positive/negative
818  * value based on polarity of the default level of the effect.
819  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
820  */
821 struct ff_envelope {
822 	__u16 attack_length;
823 	__u16 attack_level;
824 	__u16 fade_length;
825 	__u16 fade_level;
826 };
827 
828 /**
829  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
830  * @level: strength of the effect; may be negative
831  * @envelope: envelope data
832  */
833 struct ff_constant_effect {
834 	__s16 level;
835 	struct ff_envelope envelope;
836 };
837 
838 /**
839  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
840  * @start_level: beginning strength of the effect; may be negative
841  * @end_level: final strength of the effect; may be negative
842  * @envelope: envelope data
843  */
844 struct ff_ramp_effect {
845 	__s16 start_level;
846 	__s16 end_level;
847 	struct ff_envelope envelope;
848 };
849 
850 /**
851  * struct ff_condition_effect - defines a spring or friction force-feedback effect
852  * @right_saturation: maximum level when joystick moved all way to the right
853  * @left_saturation: same for the left side
854  * @right_coeff: controls how fast the force grows when the joystick moves
855  *	to the right
856  * @left_coeff: same for the left side
857  * @deadband: size of the dead zone, where no force is produced
858  * @center: position of the dead zone
859  */
860 struct ff_condition_effect {
861 	__u16 right_saturation;
862 	__u16 left_saturation;
863 
864 	__s16 right_coeff;
865 	__s16 left_coeff;
866 
867 	__u16 deadband;
868 	__s16 center;
869 };
870 
871 /**
872  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
873  * @waveform: kind of the effect (wave)
874  * @period: period of the wave (ms)
875  * @magnitude: peak value
876  * @offset: mean value of the wave (roughly)
877  * @phase: 'horizontal' shift
878  * @envelope: envelope data
879  * @custom_len: number of samples (FF_CUSTOM only)
880  * @custom_data: buffer of samples (FF_CUSTOM only)
881  *
882  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
883  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
884  * for the time being as no driver supports it yet.
885  *
886  * Note: the data pointed by custom_data is copied by the driver.
887  * You can therefore dispose of the memory after the upload/update.
888  */
889 struct ff_periodic_effect {
890 	__u16 waveform;
891 	__u16 period;
892 	__s16 magnitude;
893 	__s16 offset;
894 	__u16 phase;
895 
896 	struct ff_envelope envelope;
897 
898 	__u32 custom_len;
899 	__s16 __user *custom_data;
900 };
901 
902 /**
903  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
904  * @strong_magnitude: magnitude of the heavy motor
905  * @weak_magnitude: magnitude of the light one
906  *
907  * Some rumble pads have two motors of different weight. Strong_magnitude
908  * represents the magnitude of the vibration generated by the heavy one.
909  */
910 struct ff_rumble_effect {
911 	__u16 strong_magnitude;
912 	__u16 weak_magnitude;
913 };
914 
915 /**
916  * struct ff_effect - defines force feedback effect
917  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
918  *	FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
919  * @id: an unique id assigned to an effect
920  * @direction: direction of the effect
921  * @trigger: trigger conditions (struct ff_trigger)
922  * @replay: scheduling of the effect (struct ff_replay)
923  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
924  *	ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
925  *	defining effect parameters
926  *
927  * This structure is sent through ioctl from the application to the driver.
928  * To create a new effect application should set its @id to -1; the kernel
929  * will return assigned @id which can later be used to update or delete
930  * this effect.
931  *
932  * Direction of the effect is encoded as follows:
933  *	0 deg -> 0x0000 (down)
934  *	90 deg -> 0x4000 (left)
935  *	180 deg -> 0x8000 (up)
936  *	270 deg -> 0xC000 (right)
937  */
938 struct ff_effect {
939 	__u16 type;
940 	__s16 id;
941 	__u16 direction;
942 	struct ff_trigger trigger;
943 	struct ff_replay replay;
944 
945 	union {
946 		struct ff_constant_effect constant;
947 		struct ff_ramp_effect ramp;
948 		struct ff_periodic_effect periodic;
949 		struct ff_condition_effect condition[2]; /* One for each axis */
950 		struct ff_rumble_effect rumble;
951 	} u;
952 };
953 
954 /*
955  * Force feedback effect types
956  */
957 
958 #define FF_RUMBLE	0x50
959 #define FF_PERIODIC	0x51
960 #define FF_CONSTANT	0x52
961 #define FF_SPRING	0x53
962 #define FF_FRICTION	0x54
963 #define FF_DAMPER	0x55
964 #define FF_INERTIA	0x56
965 #define FF_RAMP		0x57
966 
967 #define FF_EFFECT_MIN	FF_RUMBLE
968 #define FF_EFFECT_MAX	FF_RAMP
969 
970 /*
971  * Force feedback periodic effect types
972  */
973 
974 #define FF_SQUARE	0x58
975 #define FF_TRIANGLE	0x59
976 #define FF_SINE		0x5a
977 #define FF_SAW_UP	0x5b
978 #define FF_SAW_DOWN	0x5c
979 #define FF_CUSTOM	0x5d
980 
981 #define FF_WAVEFORM_MIN	FF_SQUARE
982 #define FF_WAVEFORM_MAX	FF_CUSTOM
983 
984 /*
985  * Set ff device properties
986  */
987 
988 #define FF_GAIN		0x60
989 #define FF_AUTOCENTER	0x61
990 
991 #define FF_MAX		0x7f
992 #define FF_CNT		(FF_MAX+1)
993 
994 #ifdef __KERNEL__
995 
996 /*
997  * In-kernel definitions.
998  */
999 
1000 #include <linux/device.h>
1001 #include <linux/fs.h>
1002 #include <linux/timer.h>
1003 #include <linux/mod_devicetable.h>
1004 
1005 /**
1006  * struct input_dev - represents an input device
1007  * @name: name of the device
1008  * @phys: physical path to the device in the system hierarchy
1009  * @uniq: unique identification code for the device (if device has it)
1010  * @id: id of the device (struct input_id)
1011  * @evbit: bitmap of types of events supported by the device (EV_KEY,
1012  *	EV_REL, etc.)
1013  * @keybit: bitmap of keys/buttons this device has
1014  * @relbit: bitmap of relative axes for the device
1015  * @absbit: bitmap of absolute axes for the device
1016  * @mscbit: bitmap of miscellaneous events supported by the device
1017  * @ledbit: bitmap of leds present on the device
1018  * @sndbit: bitmap of sound effects supported by the device
1019  * @ffbit: bitmap of force feedback effects supported by the device
1020  * @swbit: bitmap of switches present on the device
1021  * @keycodemax: size of keycode table
1022  * @keycodesize: size of elements in keycode table
1023  * @keycode: map of scancodes to keycodes for this device
1024  * @setkeycode: optional method to alter current keymap, used to implement
1025  *	sparse keymaps. If not supplied default mechanism will be used.
1026  *	The method is being called while holding event_lock and thus must
1027  *	not sleep
1028  * @getkeycode: optional method to retrieve current keymap. If not supplied
1029  *	default mechanism will be used. The method is being called while
1030  *	holding event_lock and thus must not sleep
1031  * @ff: force feedback structure associated with the device if device
1032  *	supports force feedback effects
1033  * @repeat_key: stores key code of the last key pressed; used to implement
1034  *	software autorepeat
1035  * @timer: timer for software autorepeat
1036  * @sync: set to 1 when there were no new events since last EV_SYNC
1037  * @abs: current values for reports from absolute axes
1038  * @rep: current values for autorepeat parameters (delay, rate)
1039  * @key: reflects current state of device's keys/buttons
1040  * @led: reflects current state of device's LEDs
1041  * @snd: reflects current state of sound effects
1042  * @sw: reflects current state of device's switches
1043  * @absmax: maximum values for events coming from absolute axes
1044  * @absmin: minimum values for events coming from absolute axes
1045  * @absfuzz: describes noisiness for axes
1046  * @absflat: size of the center flat position (used by joydev)
1047  * @absres: resolution used for events coming form absolute axes
1048  * @open: this method is called when the very first user calls
1049  *	input_open_device(). The driver must prepare the device
1050  *	to start generating events (start polling thread,
1051  *	request an IRQ, submit URB, etc.)
1052  * @close: this method is called when the very last user calls
1053  *	input_close_device().
1054  * @flush: purges the device. Most commonly used to get rid of force
1055  *	feedback effects loaded into the device when disconnecting
1056  *	from it
1057  * @event: event handler for events sent _to_ the device, like EV_LED
1058  *	or EV_SND. The device is expected to carry out the requested
1059  *	action (turn on a LED, play sound, etc.) The call is protected
1060  *	by @event_lock and must not sleep
1061  * @grab: input handle that currently has the device grabbed (via
1062  *	EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1063  *	recipient for all input events coming from the device
1064  * @event_lock: this spinlock is is taken when input core receives
1065  *	and processes a new event for the device (in input_event()).
1066  *	Code that accesses and/or modifies parameters of a device
1067  *	(such as keymap or absmin, absmax, absfuzz, etc.) after device
1068  *	has been registered with input core must take this lock.
1069  * @mutex: serializes calls to open(), close() and flush() methods
1070  * @users: stores number of users (input handlers) that opened this
1071  *	device. It is used by input_open_device() and input_close_device()
1072  *	to make sure that dev->open() is only called when the first
1073  *	user opens device and dev->close() is called when the very
1074  *	last user closes the device
1075  * @going_away: marks devices that are in a middle of unregistering and
1076  *	causes input_open_device*() fail with -ENODEV.
1077  * @dev: driver model's view of this device
1078  * @h_list: list of input handles associated with the device. When
1079  *	accessing the list dev->mutex must be held
1080  * @node: used to place the device onto input_dev_list
1081  */
1082 struct input_dev {
1083 	const char *name;
1084 	const char *phys;
1085 	const char *uniq;
1086 	struct input_id id;
1087 
1088 	unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1089 	unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1090 	unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1091 	unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1092 	unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1093 	unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1094 	unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1095 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1096 	unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
1097 
1098 	unsigned int keycodemax;
1099 	unsigned int keycodesize;
1100 	void *keycode;
1101 	int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
1102 	int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
1103 
1104 	struct ff_device *ff;
1105 
1106 	unsigned int repeat_key;
1107 	struct timer_list timer;
1108 
1109 	int sync;
1110 
1111 	int abs[ABS_MAX + 1];
1112 	int rep[REP_MAX + 1];
1113 
1114 	unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1115 	unsigned long led[BITS_TO_LONGS(LED_CNT)];
1116 	unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1117 	unsigned long sw[BITS_TO_LONGS(SW_CNT)];
1118 
1119 	int absmax[ABS_MAX + 1];
1120 	int absmin[ABS_MAX + 1];
1121 	int absfuzz[ABS_MAX + 1];
1122 	int absflat[ABS_MAX + 1];
1123 	int absres[ABS_MAX + 1];
1124 
1125 	int (*open)(struct input_dev *dev);
1126 	void (*close)(struct input_dev *dev);
1127 	int (*flush)(struct input_dev *dev, struct file *file);
1128 	int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1129 
1130 	struct input_handle *grab;
1131 
1132 	spinlock_t event_lock;
1133 	struct mutex mutex;
1134 
1135 	unsigned int users;
1136 	bool going_away;
1137 
1138 	struct device dev;
1139 
1140 	struct list_head	h_list;
1141 	struct list_head	node;
1142 };
1143 #define to_input_dev(d) container_of(d, struct input_dev, dev)
1144 
1145 /*
1146  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1147  */
1148 
1149 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1150 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1151 #endif
1152 
1153 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1154 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1155 #endif
1156 
1157 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1158 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1159 #endif
1160 
1161 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1162 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1163 #endif
1164 
1165 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1166 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1167 #endif
1168 
1169 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1170 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1171 #endif
1172 
1173 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1174 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1175 #endif
1176 
1177 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1178 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1179 #endif
1180 
1181 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1182 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1183 #endif
1184 
1185 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1186 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1187 #endif
1188 
1189 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1190 	(INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1191 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1192 	(INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1193 
1194 struct input_handle;
1195 
1196 /**
1197  * struct input_handler - implements one of interfaces for input devices
1198  * @private: driver-specific data
1199  * @event: event handler. This method is being called by input core with
1200  *	interrupts disabled and dev->event_lock spinlock held and so
1201  *	it may not sleep
1202  * @connect: called when attaching a handler to an input device
1203  * @disconnect: disconnects a handler from input device
1204  * @start: starts handler for given handle. This function is called by
1205  *	input core right after connect() method and also when a process
1206  *	that "grabbed" a device releases it
1207  * @fops: file operations this driver implements
1208  * @minor: beginning of range of 32 minors for devices this driver
1209  *	can provide
1210  * @name: name of the handler, to be shown in /proc/bus/input/handlers
1211  * @id_table: pointer to a table of input_device_ids this driver can
1212  *	handle
1213  * @blacklist: pointer to a table of input_device_ids this driver should
1214  *	ignore even if they match @id_table
1215  * @h_list: list of input handles associated with the handler
1216  * @node: for placing the driver onto input_handler_list
1217  *
1218  * Input handlers attach to input devices and create input handles. There
1219  * are likely several handlers attached to any given input device at the
1220  * same time. All of them will get their copy of input event generated by
1221  * the device.
1222  *
1223  * Note that input core serializes calls to connect() and disconnect()
1224  * methods.
1225  */
1226 struct input_handler {
1227 
1228 	void *private;
1229 
1230 	void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1231 	int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1232 	void (*disconnect)(struct input_handle *handle);
1233 	void (*start)(struct input_handle *handle);
1234 
1235 	const struct file_operations *fops;
1236 	int minor;
1237 	const char *name;
1238 
1239 	const struct input_device_id *id_table;
1240 	const struct input_device_id *blacklist;
1241 
1242 	struct list_head	h_list;
1243 	struct list_head	node;
1244 };
1245 
1246 /**
1247  * struct input_handle - links input device with an input handler
1248  * @private: handler-specific data
1249  * @open: counter showing whether the handle is 'open', i.e. should deliver
1250  *	events from its device
1251  * @name: name given to the handle by handler that created it
1252  * @dev: input device the handle is attached to
1253  * @handler: handler that works with the device through this handle
1254  * @d_node: used to put the handle on device's list of attached handles
1255  * @h_node: used to put the handle on handler's list of handles from which
1256  *	it gets events
1257  */
1258 struct input_handle {
1259 
1260 	void *private;
1261 
1262 	int open;
1263 	const char *name;
1264 
1265 	struct input_dev *dev;
1266 	struct input_handler *handler;
1267 
1268 	struct list_head	d_node;
1269 	struct list_head	h_node;
1270 };
1271 
1272 struct input_dev *input_allocate_device(void);
1273 void input_free_device(struct input_dev *dev);
1274 
1275 static inline struct input_dev *input_get_device(struct input_dev *dev)
1276 {
1277 	return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1278 }
1279 
1280 static inline void input_put_device(struct input_dev *dev)
1281 {
1282 	if (dev)
1283 		put_device(&dev->dev);
1284 }
1285 
1286 static inline void *input_get_drvdata(struct input_dev *dev)
1287 {
1288 	return dev_get_drvdata(&dev->dev);
1289 }
1290 
1291 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1292 {
1293 	dev_set_drvdata(&dev->dev, data);
1294 }
1295 
1296 int __must_check input_register_device(struct input_dev *);
1297 void input_unregister_device(struct input_dev *);
1298 
1299 int __must_check input_register_handler(struct input_handler *);
1300 void input_unregister_handler(struct input_handler *);
1301 
1302 int input_handler_for_each_handle(struct input_handler *, void *data,
1303 				  int (*fn)(struct input_handle *, void *));
1304 
1305 int input_register_handle(struct input_handle *);
1306 void input_unregister_handle(struct input_handle *);
1307 
1308 int input_grab_device(struct input_handle *);
1309 void input_release_device(struct input_handle *);
1310 
1311 int input_open_device(struct input_handle *);
1312 void input_close_device(struct input_handle *);
1313 
1314 int input_flush_device(struct input_handle* handle, struct file* file);
1315 
1316 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1317 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1318 
1319 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1320 {
1321 	input_event(dev, EV_KEY, code, !!value);
1322 }
1323 
1324 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1325 {
1326 	input_event(dev, EV_REL, code, value);
1327 }
1328 
1329 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1330 {
1331 	input_event(dev, EV_ABS, code, value);
1332 }
1333 
1334 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1335 {
1336 	input_event(dev, EV_FF_STATUS, code, value);
1337 }
1338 
1339 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1340 {
1341 	input_event(dev, EV_SW, code, !!value);
1342 }
1343 
1344 static inline void input_sync(struct input_dev *dev)
1345 {
1346 	input_event(dev, EV_SYN, SYN_REPORT, 0);
1347 }
1348 
1349 static inline void input_mt_sync(struct input_dev *dev)
1350 {
1351 	input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
1352 }
1353 
1354 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1355 
1356 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1357 {
1358 	dev->absmin[axis] = min;
1359 	dev->absmax[axis] = max;
1360 	dev->absfuzz[axis] = fuzz;
1361 	dev->absflat[axis] = flat;
1362 
1363 	dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
1364 }
1365 
1366 int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
1367 int input_set_keycode(struct input_dev *dev, int scancode, int keycode);
1368 
1369 extern struct class input_class;
1370 
1371 /**
1372  * struct ff_device - force-feedback part of an input device
1373  * @upload: Called to upload an new effect into device
1374  * @erase: Called to erase an effect from device
1375  * @playback: Called to request device to start playing specified effect
1376  * @set_gain: Called to set specified gain
1377  * @set_autocenter: Called to auto-center device
1378  * @destroy: called by input core when parent input device is being
1379  *	destroyed
1380  * @private: driver-specific data, will be freed automatically
1381  * @ffbit: bitmap of force feedback capabilities truly supported by
1382  *	device (not emulated like ones in input_dev->ffbit)
1383  * @mutex: mutex for serializing access to the device
1384  * @max_effects: maximum number of effects supported by device
1385  * @effects: pointer to an array of effects currently loaded into device
1386  * @effect_owners: array of effect owners; when file handle owning
1387  *	an effect gets closed the effect is automatically erased
1388  *
1389  * Every force-feedback device must implement upload() and playback()
1390  * methods; erase() is optional. set_gain() and set_autocenter() need
1391  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1392  * bits.
1393  *
1394  * Note that playback(), set_gain() and set_autocenter() are called with
1395  * dev->event_lock spinlock held and interrupts off and thus may not
1396  * sleep.
1397  */
1398 struct ff_device {
1399 	int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1400 		      struct ff_effect *old);
1401 	int (*erase)(struct input_dev *dev, int effect_id);
1402 
1403 	int (*playback)(struct input_dev *dev, int effect_id, int value);
1404 	void (*set_gain)(struct input_dev *dev, u16 gain);
1405 	void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1406 
1407 	void (*destroy)(struct ff_device *);
1408 
1409 	void *private;
1410 
1411 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1412 
1413 	struct mutex mutex;
1414 
1415 	int max_effects;
1416 	struct ff_effect *effects;
1417 	struct file *effect_owners[];
1418 };
1419 
1420 int input_ff_create(struct input_dev *dev, int max_effects);
1421 void input_ff_destroy(struct input_dev *dev);
1422 
1423 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1424 
1425 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1426 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1427 
1428 int input_ff_create_memless(struct input_dev *dev, void *data,
1429 		int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1430 
1431 #endif
1432 #endif
1433