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