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