xref: /linux-6.15/include/linux/input.h (revision 4e57b681)
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 #include <linux/device.h>
16 #else
17 #include <sys/time.h>
18 #include <sys/ioctl.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 EVIOCGKEYCODE		_IOR('E', 0x04, int[2])			/* get keycode */
61 #define EVIOCSKEYCODE		_IOW('E', 0x04, int[2])			/* set keycode */
62 
63 #define EVIOCGNAME(len)		_IOC(_IOC_READ, 'E', 0x06, len)		/* get device name */
64 #define EVIOCGPHYS(len)		_IOC(_IOC_READ, 'E', 0x07, len)		/* get physical location */
65 #define EVIOCGUNIQ(len)		_IOC(_IOC_READ, 'E', 0x08, len)		/* get unique identifier */
66 
67 #define EVIOCGKEY(len)		_IOC(_IOC_READ, 'E', 0x18, len)		/* get global keystate */
68 #define EVIOCGLED(len)		_IOC(_IOC_READ, 'E', 0x19, len)		/* get all LEDs */
69 #define EVIOCGSND(len)		_IOC(_IOC_READ, 'E', 0x1a, len)		/* get all sounds status */
70 #define EVIOCGSW(len)		_IOC(_IOC_READ, 'E', 0x1b, len)		/* get all switch states */
71 
72 #define EVIOCGBIT(ev,len)	_IOC(_IOC_READ, 'E', 0x20 + ev, len)	/* get event bits */
73 #define EVIOCGABS(abs)		_IOR('E', 0x40 + abs, struct input_absinfo)		/* get abs value/limits */
74 #define EVIOCSABS(abs)		_IOW('E', 0xc0 + abs, struct input_absinfo)		/* set abs value/limits */
75 
76 #define EVIOCSFF		_IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))	/* send a force effect to a force feedback device */
77 #define EVIOCRMFF		_IOW('E', 0x81, int)			/* Erase a force effect */
78 #define EVIOCGEFFECTS		_IOR('E', 0x84, int)			/* Report number of effects playable at the same time */
79 
80 #define EVIOCGRAB		_IOW('E', 0x90, int)			/* Grab/Release device */
81 
82 /*
83  * Event types
84  */
85 
86 #define EV_SYN			0x00
87 #define EV_KEY			0x01
88 #define EV_REL			0x02
89 #define EV_ABS			0x03
90 #define EV_MSC			0x04
91 #define EV_SW			0x05
92 #define EV_LED			0x11
93 #define EV_SND			0x12
94 #define EV_REP			0x14
95 #define EV_FF			0x15
96 #define EV_PWR			0x16
97 #define EV_FF_STATUS		0x17
98 #define EV_MAX			0x1f
99 
100 /*
101  * Synchronization events.
102  */
103 
104 #define SYN_REPORT		0
105 #define SYN_CONFIG		1
106 
107 /*
108  * Keys and buttons
109  */
110 
111 #define KEY_RESERVED		0
112 #define KEY_ESC			1
113 #define KEY_1			2
114 #define KEY_2			3
115 #define KEY_3			4
116 #define KEY_4			5
117 #define KEY_5			6
118 #define KEY_6			7
119 #define KEY_7			8
120 #define KEY_8			9
121 #define KEY_9			10
122 #define KEY_0			11
123 #define KEY_MINUS		12
124 #define KEY_EQUAL		13
125 #define KEY_BACKSPACE		14
126 #define KEY_TAB			15
127 #define KEY_Q			16
128 #define KEY_W			17
129 #define KEY_E			18
130 #define KEY_R			19
131 #define KEY_T			20
132 #define KEY_Y			21
133 #define KEY_U			22
134 #define KEY_I			23
135 #define KEY_O			24
136 #define KEY_P			25
137 #define KEY_LEFTBRACE		26
138 #define KEY_RIGHTBRACE		27
139 #define KEY_ENTER		28
140 #define KEY_LEFTCTRL		29
141 #define KEY_A			30
142 #define KEY_S			31
143 #define KEY_D			32
144 #define KEY_F			33
145 #define KEY_G			34
146 #define KEY_H			35
147 #define KEY_J			36
148 #define KEY_K			37
149 #define KEY_L			38
150 #define KEY_SEMICOLON		39
151 #define KEY_APOSTROPHE		40
152 #define KEY_GRAVE		41
153 #define KEY_LEFTSHIFT		42
154 #define KEY_BACKSLASH		43
155 #define KEY_Z			44
156 #define KEY_X			45
157 #define KEY_C			46
158 #define KEY_V			47
159 #define KEY_B			48
160 #define KEY_N			49
161 #define KEY_M			50
162 #define KEY_COMMA		51
163 #define KEY_DOT			52
164 #define KEY_SLASH		53
165 #define KEY_RIGHTSHIFT		54
166 #define KEY_KPASTERISK		55
167 #define KEY_LEFTALT		56
168 #define KEY_SPACE		57
169 #define KEY_CAPSLOCK		58
170 #define KEY_F1			59
171 #define KEY_F2			60
172 #define KEY_F3			61
173 #define KEY_F4			62
174 #define KEY_F5			63
175 #define KEY_F6			64
176 #define KEY_F7			65
177 #define KEY_F8			66
178 #define KEY_F9			67
179 #define KEY_F10			68
180 #define KEY_NUMLOCK		69
181 #define KEY_SCROLLLOCK		70
182 #define KEY_KP7			71
183 #define KEY_KP8			72
184 #define KEY_KP9			73
185 #define KEY_KPMINUS		74
186 #define KEY_KP4			75
187 #define KEY_KP5			76
188 #define KEY_KP6			77
189 #define KEY_KPPLUS		78
190 #define KEY_KP1			79
191 #define KEY_KP2			80
192 #define KEY_KP3			81
193 #define KEY_KP0			82
194 #define KEY_KPDOT		83
195 
196 #define KEY_ZENKAKUHANKAKU	85
197 #define KEY_102ND		86
198 #define KEY_F11			87
199 #define KEY_F12			88
200 #define KEY_RO			89
201 #define KEY_KATAKANA		90
202 #define KEY_HIRAGANA		91
203 #define KEY_HENKAN		92
204 #define KEY_KATAKANAHIRAGANA	93
205 #define KEY_MUHENKAN		94
206 #define KEY_KPJPCOMMA		95
207 #define KEY_KPENTER		96
208 #define KEY_RIGHTCTRL		97
209 #define KEY_KPSLASH		98
210 #define KEY_SYSRQ		99
211 #define KEY_RIGHTALT		100
212 #define KEY_LINEFEED		101
213 #define KEY_HOME		102
214 #define KEY_UP			103
215 #define KEY_PAGEUP		104
216 #define KEY_LEFT		105
217 #define KEY_RIGHT		106
218 #define KEY_END			107
219 #define KEY_DOWN		108
220 #define KEY_PAGEDOWN		109
221 #define KEY_INSERT		110
222 #define KEY_DELETE		111
223 #define KEY_MACRO		112
224 #define KEY_MUTE		113
225 #define KEY_VOLUMEDOWN		114
226 #define KEY_VOLUMEUP		115
227 #define KEY_POWER		116
228 #define KEY_KPEQUAL		117
229 #define KEY_KPPLUSMINUS		118
230 #define KEY_PAUSE		119
231 
232 #define KEY_KPCOMMA		121
233 #define KEY_HANGUEL		122
234 #define KEY_HANJA		123
235 #define KEY_YEN			124
236 #define KEY_LEFTMETA		125
237 #define KEY_RIGHTMETA		126
238 #define KEY_COMPOSE		127
239 
240 #define KEY_STOP		128
241 #define KEY_AGAIN		129
242 #define KEY_PROPS		130
243 #define KEY_UNDO		131
244 #define KEY_FRONT		132
245 #define KEY_COPY		133
246 #define KEY_OPEN		134
247 #define KEY_PASTE		135
248 #define KEY_FIND		136
249 #define KEY_CUT			137
250 #define KEY_HELP		138
251 #define KEY_MENU		139
252 #define KEY_CALC		140
253 #define KEY_SETUP		141
254 #define KEY_SLEEP		142
255 #define KEY_WAKEUP		143
256 #define KEY_FILE		144
257 #define KEY_SENDFILE		145
258 #define KEY_DELETEFILE		146
259 #define KEY_XFER		147
260 #define KEY_PROG1		148
261 #define KEY_PROG2		149
262 #define KEY_WWW			150
263 #define KEY_MSDOS		151
264 #define KEY_COFFEE		152
265 #define KEY_DIRECTION		153
266 #define KEY_CYCLEWINDOWS	154
267 #define KEY_MAIL		155
268 #define KEY_BOOKMARKS		156
269 #define KEY_COMPUTER		157
270 #define KEY_BACK		158
271 #define KEY_FORWARD		159
272 #define KEY_CLOSECD		160
273 #define KEY_EJECTCD		161
274 #define KEY_EJECTCLOSECD	162
275 #define KEY_NEXTSONG		163
276 #define KEY_PLAYPAUSE		164
277 #define KEY_PREVIOUSSONG	165
278 #define KEY_STOPCD		166
279 #define KEY_RECORD		167
280 #define KEY_REWIND		168
281 #define KEY_PHONE		169
282 #define KEY_ISO			170
283 #define KEY_CONFIG		171
284 #define KEY_HOMEPAGE		172
285 #define KEY_REFRESH		173
286 #define KEY_EXIT		174
287 #define KEY_MOVE		175
288 #define KEY_EDIT		176
289 #define KEY_SCROLLUP		177
290 #define KEY_SCROLLDOWN		178
291 #define KEY_KPLEFTPAREN		179
292 #define KEY_KPRIGHTPAREN	180
293 #define KEY_NEW			181
294 #define KEY_REDO		182
295 
296 #define KEY_F13			183
297 #define KEY_F14			184
298 #define KEY_F15			185
299 #define KEY_F16			186
300 #define KEY_F17			187
301 #define KEY_F18			188
302 #define KEY_F19			189
303 #define KEY_F20			190
304 #define KEY_F21			191
305 #define KEY_F22			192
306 #define KEY_F23			193
307 #define KEY_F24			194
308 
309 #define KEY_PLAYCD		200
310 #define KEY_PAUSECD		201
311 #define KEY_PROG3		202
312 #define KEY_PROG4		203
313 #define KEY_SUSPEND		205
314 #define KEY_CLOSE		206
315 #define KEY_PLAY		207
316 #define KEY_FASTFORWARD		208
317 #define KEY_BASSBOOST		209
318 #define KEY_PRINT		210
319 #define KEY_HP			211
320 #define KEY_CAMERA		212
321 #define KEY_SOUND		213
322 #define KEY_QUESTION		214
323 #define KEY_EMAIL		215
324 #define KEY_CHAT		216
325 #define KEY_SEARCH		217
326 #define KEY_CONNECT		218
327 #define KEY_FINANCE		219
328 #define KEY_SPORT		220
329 #define KEY_SHOP		221
330 #define KEY_ALTERASE		222
331 #define KEY_CANCEL		223
332 #define KEY_BRIGHTNESSDOWN	224
333 #define KEY_BRIGHTNESSUP	225
334 #define KEY_MEDIA		226
335 
336 #define KEY_SWITCHVIDEOMODE	227
337 #define KEY_KBDILLUMTOGGLE	228
338 #define KEY_KBDILLUMDOWN	229
339 #define KEY_KBDILLUMUP		230
340 
341 #define KEY_SEND		231
342 #define KEY_REPLY		232
343 #define KEY_FORWARDMAIL		233
344 #define KEY_SAVE		234
345 #define KEY_DOCUMENTS		235
346 
347 #define KEY_UNKNOWN		240
348 
349 #define BTN_MISC		0x100
350 #define BTN_0			0x100
351 #define BTN_1			0x101
352 #define BTN_2			0x102
353 #define BTN_3			0x103
354 #define BTN_4			0x104
355 #define BTN_5			0x105
356 #define BTN_6			0x106
357 #define BTN_7			0x107
358 #define BTN_8			0x108
359 #define BTN_9			0x109
360 
361 #define BTN_MOUSE		0x110
362 #define BTN_LEFT		0x110
363 #define BTN_RIGHT		0x111
364 #define BTN_MIDDLE		0x112
365 #define BTN_SIDE		0x113
366 #define BTN_EXTRA		0x114
367 #define BTN_FORWARD		0x115
368 #define BTN_BACK		0x116
369 #define BTN_TASK		0x117
370 
371 #define BTN_JOYSTICK		0x120
372 #define BTN_TRIGGER		0x120
373 #define BTN_THUMB		0x121
374 #define BTN_THUMB2		0x122
375 #define BTN_TOP			0x123
376 #define BTN_TOP2		0x124
377 #define BTN_PINKIE		0x125
378 #define BTN_BASE		0x126
379 #define BTN_BASE2		0x127
380 #define BTN_BASE3		0x128
381 #define BTN_BASE4		0x129
382 #define BTN_BASE5		0x12a
383 #define BTN_BASE6		0x12b
384 #define BTN_DEAD		0x12f
385 
386 #define BTN_GAMEPAD		0x130
387 #define BTN_A			0x130
388 #define BTN_B			0x131
389 #define BTN_C			0x132
390 #define BTN_X			0x133
391 #define BTN_Y			0x134
392 #define BTN_Z			0x135
393 #define BTN_TL			0x136
394 #define BTN_TR			0x137
395 #define BTN_TL2			0x138
396 #define BTN_TR2			0x139
397 #define BTN_SELECT		0x13a
398 #define BTN_START		0x13b
399 #define BTN_MODE		0x13c
400 #define BTN_THUMBL		0x13d
401 #define BTN_THUMBR		0x13e
402 
403 #define BTN_DIGI		0x140
404 #define BTN_TOOL_PEN		0x140
405 #define BTN_TOOL_RUBBER		0x141
406 #define BTN_TOOL_BRUSH		0x142
407 #define BTN_TOOL_PENCIL		0x143
408 #define BTN_TOOL_AIRBRUSH	0x144
409 #define BTN_TOOL_FINGER		0x145
410 #define BTN_TOOL_MOUSE		0x146
411 #define BTN_TOOL_LENS		0x147
412 #define BTN_TOUCH		0x14a
413 #define BTN_STYLUS		0x14b
414 #define BTN_STYLUS2		0x14c
415 #define BTN_TOOL_DOUBLETAP	0x14d
416 #define BTN_TOOL_TRIPLETAP	0x14e
417 
418 #define BTN_WHEEL		0x150
419 #define BTN_GEAR_DOWN		0x150
420 #define BTN_GEAR_UP		0x151
421 
422 #define KEY_OK			0x160
423 #define KEY_SELECT 		0x161
424 #define KEY_GOTO		0x162
425 #define KEY_CLEAR		0x163
426 #define KEY_POWER2		0x164
427 #define KEY_OPTION		0x165
428 #define KEY_INFO		0x166
429 #define KEY_TIME		0x167
430 #define KEY_VENDOR		0x168
431 #define KEY_ARCHIVE		0x169
432 #define KEY_PROGRAM		0x16a
433 #define KEY_CHANNEL		0x16b
434 #define KEY_FAVORITES		0x16c
435 #define KEY_EPG			0x16d
436 #define KEY_PVR			0x16e
437 #define KEY_MHP			0x16f
438 #define KEY_LANGUAGE		0x170
439 #define KEY_TITLE		0x171
440 #define KEY_SUBTITLE		0x172
441 #define KEY_ANGLE		0x173
442 #define KEY_ZOOM		0x174
443 #define KEY_MODE		0x175
444 #define KEY_KEYBOARD		0x176
445 #define KEY_SCREEN		0x177
446 #define KEY_PC			0x178
447 #define KEY_TV			0x179
448 #define KEY_TV2			0x17a
449 #define KEY_VCR			0x17b
450 #define KEY_VCR2		0x17c
451 #define KEY_SAT			0x17d
452 #define KEY_SAT2		0x17e
453 #define KEY_CD			0x17f
454 #define KEY_TAPE		0x180
455 #define KEY_RADIO		0x181
456 #define KEY_TUNER		0x182
457 #define KEY_PLAYER		0x183
458 #define KEY_TEXT		0x184
459 #define KEY_DVD			0x185
460 #define KEY_AUX			0x186
461 #define KEY_MP3			0x187
462 #define KEY_AUDIO		0x188
463 #define KEY_VIDEO		0x189
464 #define KEY_DIRECTORY		0x18a
465 #define KEY_LIST		0x18b
466 #define KEY_MEMO		0x18c
467 #define KEY_CALENDAR		0x18d
468 #define KEY_RED			0x18e
469 #define KEY_GREEN		0x18f
470 #define KEY_YELLOW		0x190
471 #define KEY_BLUE		0x191
472 #define KEY_CHANNELUP		0x192
473 #define KEY_CHANNELDOWN		0x193
474 #define KEY_FIRST		0x194
475 #define KEY_LAST		0x195
476 #define KEY_AB			0x196
477 #define KEY_NEXT		0x197
478 #define KEY_RESTART		0x198
479 #define KEY_SLOW		0x199
480 #define KEY_SHUFFLE		0x19a
481 #define KEY_BREAK		0x19b
482 #define KEY_PREVIOUS		0x19c
483 #define KEY_DIGITS		0x19d
484 #define KEY_TEEN		0x19e
485 #define KEY_TWEN		0x19f
486 
487 #define KEY_DEL_EOL		0x1c0
488 #define KEY_DEL_EOS		0x1c1
489 #define KEY_INS_LINE		0x1c2
490 #define KEY_DEL_LINE		0x1c3
491 
492 #define KEY_FN			0x1d0
493 #define KEY_FN_ESC		0x1d1
494 #define KEY_FN_F1		0x1d2
495 #define KEY_FN_F2		0x1d3
496 #define KEY_FN_F3		0x1d4
497 #define KEY_FN_F4		0x1d5
498 #define KEY_FN_F5		0x1d6
499 #define KEY_FN_F6		0x1d7
500 #define KEY_FN_F7		0x1d8
501 #define KEY_FN_F8		0x1d9
502 #define KEY_FN_F9		0x1da
503 #define KEY_FN_F10		0x1db
504 #define KEY_FN_F11		0x1dc
505 #define KEY_FN_F12		0x1dd
506 #define KEY_FN_1		0x1de
507 #define KEY_FN_2		0x1df
508 #define KEY_FN_D		0x1e0
509 #define KEY_FN_E		0x1e1
510 #define KEY_FN_F		0x1e2
511 #define KEY_FN_S		0x1e3
512 #define KEY_FN_B		0x1e4
513 
514 #define KEY_MAX			0x1ff
515 
516 /*
517  * Relative axes
518  */
519 
520 #define REL_X			0x00
521 #define REL_Y			0x01
522 #define REL_Z			0x02
523 #define REL_RX			0x03
524 #define REL_RY			0x04
525 #define REL_RZ			0x05
526 #define REL_HWHEEL		0x06
527 #define REL_DIAL		0x07
528 #define REL_WHEEL		0x08
529 #define REL_MISC		0x09
530 #define REL_MAX			0x0f
531 
532 /*
533  * Absolute axes
534  */
535 
536 #define ABS_X			0x00
537 #define ABS_Y			0x01
538 #define ABS_Z			0x02
539 #define ABS_RX			0x03
540 #define ABS_RY			0x04
541 #define ABS_RZ			0x05
542 #define ABS_THROTTLE		0x06
543 #define ABS_RUDDER		0x07
544 #define ABS_WHEEL		0x08
545 #define ABS_GAS			0x09
546 #define ABS_BRAKE		0x0a
547 #define ABS_HAT0X		0x10
548 #define ABS_HAT0Y		0x11
549 #define ABS_HAT1X		0x12
550 #define ABS_HAT1Y		0x13
551 #define ABS_HAT2X		0x14
552 #define ABS_HAT2Y		0x15
553 #define ABS_HAT3X		0x16
554 #define ABS_HAT3Y		0x17
555 #define ABS_PRESSURE		0x18
556 #define ABS_DISTANCE		0x19
557 #define ABS_TILT_X		0x1a
558 #define ABS_TILT_Y		0x1b
559 #define ABS_TOOL_WIDTH		0x1c
560 #define ABS_VOLUME		0x20
561 #define ABS_MISC		0x28
562 #define ABS_MAX			0x3f
563 
564 /*
565  * Switch events
566  */
567 
568 #define SW_0		0x00
569 #define SW_1		0x01
570 #define SW_2		0x02
571 #define SW_3		0x03
572 #define SW_4		0x04
573 #define SW_5		0x05
574 #define SW_6		0x06
575 #define SW_7		0x07
576 #define SW_MAX		0x0f
577 
578 /*
579  * Misc events
580  */
581 
582 #define MSC_SERIAL		0x00
583 #define MSC_PULSELED		0x01
584 #define MSC_GESTURE		0x02
585 #define MSC_RAW			0x03
586 #define MSC_SCAN		0x04
587 #define MSC_MAX			0x07
588 
589 /*
590  * LEDs
591  */
592 
593 #define LED_NUML		0x00
594 #define LED_CAPSL		0x01
595 #define LED_SCROLLL		0x02
596 #define LED_COMPOSE		0x03
597 #define LED_KANA		0x04
598 #define LED_SLEEP		0x05
599 #define LED_SUSPEND		0x06
600 #define LED_MUTE		0x07
601 #define LED_MISC		0x08
602 #define LED_MAIL		0x09
603 #define LED_CHARGING		0x0a
604 #define LED_MAX			0x0f
605 
606 /*
607  * Autorepeat values
608  */
609 
610 #define REP_DELAY		0x00
611 #define REP_PERIOD		0x01
612 #define REP_MAX			0x01
613 
614 /*
615  * Sounds
616  */
617 
618 #define SND_CLICK		0x00
619 #define SND_BELL		0x01
620 #define SND_TONE		0x02
621 #define SND_MAX			0x07
622 
623 /*
624  * IDs.
625  */
626 
627 #define ID_BUS			0
628 #define ID_VENDOR		1
629 #define ID_PRODUCT		2
630 #define ID_VERSION		3
631 
632 #define BUS_PCI			0x01
633 #define BUS_ISAPNP		0x02
634 #define BUS_USB			0x03
635 #define BUS_HIL			0x04
636 #define BUS_BLUETOOTH		0x05
637 
638 #define BUS_ISA			0x10
639 #define BUS_I8042		0x11
640 #define BUS_XTKBD		0x12
641 #define BUS_RS232		0x13
642 #define BUS_GAMEPORT		0x14
643 #define BUS_PARPORT		0x15
644 #define BUS_AMIGA		0x16
645 #define BUS_ADB			0x17
646 #define BUS_I2C			0x18
647 #define BUS_HOST		0x19
648 #define BUS_GSC			0x1A
649 
650 /*
651  * Values describing the status of an effect
652  */
653 #define FF_STATUS_STOPPED	0x00
654 #define FF_STATUS_PLAYING	0x01
655 #define FF_STATUS_MAX		0x01
656 
657 /*
658  * Structures used in ioctls to upload effects to a device
659  * The first structures are not passed directly by using ioctls.
660  * They are sub-structures of the actually sent structure (called ff_effect)
661  */
662 
663 struct ff_replay {
664 	__u16 length; /* Duration of an effect in ms. All other times are also expressed in ms */
665 	__u16 delay;  /* Time to wait before to start playing an effect */
666 };
667 
668 struct ff_trigger {
669 	__u16 button;   /* Number of button triggering an effect */
670 	__u16 interval; /* Time to wait before an effect can be re-triggered (ms) */
671 };
672 
673 struct ff_envelope {
674 	__u16 attack_length;	/* Duration of attack (ms) */
675 	__u16 attack_level;	/* Level at beginning of attack */
676 	__u16 fade_length;	/* Duration of fade (ms) */
677 	__u16 fade_level;	/* Level at end of fade */
678 };
679 
680 /* FF_CONSTANT */
681 struct ff_constant_effect {
682 	__s16 level;	    /* Strength of effect. Negative values are OK */
683 	struct ff_envelope envelope;
684 };
685 
686 /* FF_RAMP */
687 struct ff_ramp_effect {
688 	__s16 start_level;
689 	__s16 end_level;
690 	struct ff_envelope envelope;
691 };
692 
693 /* FF_SPRING of FF_FRICTION */
694 struct ff_condition_effect {
695 	__u16 right_saturation; /* Max level when joystick is on the right */
696 	__u16 left_saturation;  /* Max level when joystick in on the left */
697 
698 	__s16 right_coeff;	/* Indicates how fast the force grows when the
699 				   joystick moves to the right */
700 	__s16 left_coeff;	/* Same for left side */
701 
702 	__u16 deadband;	/* Size of area where no force is produced */
703 	__s16 center;	/* Position of dead zone */
704 
705 };
706 
707 /* FF_PERIODIC */
708 struct ff_periodic_effect {
709 	__u16 waveform;	/* Kind of wave (sine, square...) */
710 	__u16 period;	/* in ms */
711 	__s16 magnitude;	/* Peak value */
712 	__s16 offset;	/* Mean value of wave (roughly) */
713 	__u16 phase;		/* 'Horizontal' shift */
714 
715 	struct ff_envelope envelope;
716 
717 /* Only used if waveform == FF_CUSTOM */
718 	__u32 custom_len;	/* Number of samples */
719 	__s16 *custom_data;	/* Buffer of samples */
720 /* Note: the data pointed by custom_data is copied by the driver. You can
721  * therefore dispose of the memory after the upload/update */
722 };
723 
724 /* FF_RUMBLE */
725 /* Some rumble pads have two motors of different weight.
726    strong_magnitude represents the magnitude of the vibration generated
727    by the heavy motor.
728 */
729 struct ff_rumble_effect {
730 	__u16 strong_magnitude;  /* Magnitude of the heavy motor */
731 	__u16 weak_magnitude;    /* Magnitude of the light one */
732 };
733 
734 /*
735  * Structure sent through ioctl from the application to the driver
736  */
737 struct ff_effect {
738 	__u16 type;
739 /* Following field denotes the unique id assigned to an effect.
740  * If user sets if to -1, a new effect is created, and its id is returned in the same field
741  * Else, the user sets it to the effect id it wants to update.
742  */
743 	__s16 id;
744 
745 	__u16 direction;	/* Direction. 0 deg -> 0x0000 (down)
746 					     90 deg -> 0x4000 (left)
747 					    180 deg -> 0x8000 (up)
748 					    270 deg -> 0xC000 (right)
749 				*/
750 
751 	struct ff_trigger trigger;
752 	struct ff_replay replay;
753 
754 	union {
755 		struct ff_constant_effect constant;
756 		struct ff_ramp_effect ramp;
757 		struct ff_periodic_effect periodic;
758 		struct ff_condition_effect condition[2]; /* One for each axis */
759 		struct ff_rumble_effect rumble;
760 	} u;
761 };
762 
763 /*
764  * Force feedback effect types
765  */
766 
767 #define FF_RUMBLE	0x50
768 #define FF_PERIODIC	0x51
769 #define FF_CONSTANT	0x52
770 #define FF_SPRING	0x53
771 #define FF_FRICTION	0x54
772 #define FF_DAMPER	0x55
773 #define FF_INERTIA	0x56
774 #define FF_RAMP		0x57
775 
776 /*
777  * Force feedback periodic effect types
778  */
779 
780 #define FF_SQUARE	0x58
781 #define FF_TRIANGLE	0x59
782 #define FF_SINE		0x5a
783 #define FF_SAW_UP	0x5b
784 #define FF_SAW_DOWN	0x5c
785 #define FF_CUSTOM	0x5d
786 
787 /*
788  * Set ff device properties
789  */
790 
791 #define FF_GAIN		0x60
792 #define FF_AUTOCENTER	0x61
793 
794 #define FF_MAX		0x7f
795 
796 #ifdef __KERNEL__
797 
798 /*
799  * In-kernel definitions.
800  */
801 
802 #include <linux/fs.h>
803 #include <linux/timer.h>
804 
805 #define NBITS(x) (((x)/BITS_PER_LONG)+1)
806 #define BIT(x)	(1UL<<((x)%BITS_PER_LONG))
807 #define LONG(x) ((x)/BITS_PER_LONG)
808 
809 #define INPUT_KEYCODE(dev, scancode) ((dev->keycodesize == 1) ? ((u8*)dev->keycode)[scancode] : \
810 	((dev->keycodesize == 2) ? ((u16*)dev->keycode)[scancode] : (((u32*)dev->keycode)[scancode])))
811 
812 #define SET_INPUT_KEYCODE(dev, scancode, val)			\
813 		({	unsigned __old;				\
814 		switch (dev->keycodesize) {			\
815 			case 1: {				\
816 				u8 *k = (u8 *)dev->keycode;	\
817 				__old = k[scancode];		\
818 				k[scancode] = val;		\
819 				break;				\
820 			}					\
821 			case 2: {				\
822 				u16 *k = (u16 *)dev->keycode;	\
823 				__old = k[scancode];		\
824 				k[scancode] = val;		\
825 				break;				\
826 			}					\
827 			default: {				\
828 				u32 *k = (u32 *)dev->keycode;	\
829 				__old = k[scancode];		\
830 				k[scancode] = val;		\
831 				break;				\
832 			}					\
833 		}						\
834 		__old; })
835 
836 struct input_dev {
837 
838 	void *private;
839 
840 	const char *name;
841 	const char *phys;
842 	const char *uniq;
843 	struct input_id id;
844 
845 	unsigned long evbit[NBITS(EV_MAX)];
846 	unsigned long keybit[NBITS(KEY_MAX)];
847 	unsigned long relbit[NBITS(REL_MAX)];
848 	unsigned long absbit[NBITS(ABS_MAX)];
849 	unsigned long mscbit[NBITS(MSC_MAX)];
850 	unsigned long ledbit[NBITS(LED_MAX)];
851 	unsigned long sndbit[NBITS(SND_MAX)];
852 	unsigned long ffbit[NBITS(FF_MAX)];
853 	unsigned long swbit[NBITS(SW_MAX)];
854 	int ff_effects_max;
855 
856 	unsigned int keycodemax;
857 	unsigned int keycodesize;
858 	void *keycode;
859 
860 	unsigned int repeat_key;
861 	struct timer_list timer;
862 
863 	struct pt_regs *regs;
864 	int state;
865 
866 	int sync;
867 
868 	int abs[ABS_MAX + 1];
869 	int rep[REP_MAX + 1];
870 
871 	unsigned long key[NBITS(KEY_MAX)];
872 	unsigned long led[NBITS(LED_MAX)];
873 	unsigned long snd[NBITS(SND_MAX)];
874 	unsigned long sw[NBITS(SW_MAX)];
875 
876 	int absmax[ABS_MAX + 1];
877 	int absmin[ABS_MAX + 1];
878 	int absfuzz[ABS_MAX + 1];
879 	int absflat[ABS_MAX + 1];
880 
881 	int (*open)(struct input_dev *dev);
882 	void (*close)(struct input_dev *dev);
883 	int (*accept)(struct input_dev *dev, struct file *file);
884 	int (*flush)(struct input_dev *dev, struct file *file);
885 	int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
886 	int (*upload_effect)(struct input_dev *dev, struct ff_effect *effect);
887 	int (*erase_effect)(struct input_dev *dev, int effect_id);
888 
889 	struct input_handle *grab;
890 
891 	struct semaphore sem;	/* serializes open and close operations */
892 	unsigned int users;
893 
894 	struct class_device cdev;
895 	struct device *dev;	/* will be removed soon */
896 
897 	int dynalloc;	/* temporarily */
898 
899 	struct list_head	h_list;
900 	struct list_head	node;
901 };
902 #define to_input_dev(d) container_of(d, struct input_dev, cdev)
903 
904 /*
905  * Structure for hotplug & device<->driver matching.
906  */
907 
908 #define INPUT_DEVICE_ID_MATCH_BUS	1
909 #define INPUT_DEVICE_ID_MATCH_VENDOR	2
910 #define INPUT_DEVICE_ID_MATCH_PRODUCT	4
911 #define INPUT_DEVICE_ID_MATCH_VERSION	8
912 
913 #define INPUT_DEVICE_ID_MATCH_EVBIT	0x010
914 #define INPUT_DEVICE_ID_MATCH_KEYBIT	0x020
915 #define INPUT_DEVICE_ID_MATCH_RELBIT	0x040
916 #define INPUT_DEVICE_ID_MATCH_ABSBIT	0x080
917 #define INPUT_DEVICE_ID_MATCH_MSCIT	0x100
918 #define INPUT_DEVICE_ID_MATCH_LEDBIT	0x200
919 #define INPUT_DEVICE_ID_MATCH_SNDBIT	0x400
920 #define INPUT_DEVICE_ID_MATCH_FFBIT	0x800
921 #define INPUT_DEVICE_ID_MATCH_SWBIT	0x1000
922 
923 #define INPUT_DEVICE_ID_MATCH_DEVICE\
924 	(INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
925 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION\
926 	(INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
927 
928 struct input_device_id {
929 
930 	unsigned long flags;
931 
932 	struct input_id id;
933 
934 	unsigned long evbit[NBITS(EV_MAX)];
935 	unsigned long keybit[NBITS(KEY_MAX)];
936 	unsigned long relbit[NBITS(REL_MAX)];
937 	unsigned long absbit[NBITS(ABS_MAX)];
938 	unsigned long mscbit[NBITS(MSC_MAX)];
939 	unsigned long ledbit[NBITS(LED_MAX)];
940 	unsigned long sndbit[NBITS(SND_MAX)];
941 	unsigned long ffbit[NBITS(FF_MAX)];
942 	unsigned long swbit[NBITS(SW_MAX)];
943 
944 	unsigned long driver_info;
945 };
946 
947 struct input_handle;
948 
949 struct input_handler {
950 
951 	void *private;
952 
953 	void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
954 	struct input_handle* (*connect)(struct input_handler *handler, struct input_dev *dev, struct input_device_id *id);
955 	void (*disconnect)(struct input_handle *handle);
956 
957 	struct file_operations *fops;
958 	int minor;
959 	char *name;
960 
961 	struct input_device_id *id_table;
962 	struct input_device_id *blacklist;
963 
964 	struct list_head	h_list;
965 	struct list_head	node;
966 };
967 
968 struct input_handle {
969 
970 	void *private;
971 
972 	int open;
973 	char *name;
974 
975 	struct input_dev *dev;
976 	struct input_handler *handler;
977 
978 	struct list_head	d_node;
979 	struct list_head	h_node;
980 };
981 
982 #define to_dev(n) container_of(n,struct input_dev,node)
983 #define to_handler(n) container_of(n,struct input_handler,node);
984 #define to_handle(n) container_of(n,struct input_handle,d_node)
985 #define to_handle_h(n) container_of(n,struct input_handle,h_node)
986 
987 static inline void init_input_dev(struct input_dev *dev)
988 {
989 	INIT_LIST_HEAD(&dev->h_list);
990 	INIT_LIST_HEAD(&dev->node);
991 }
992 
993 struct input_dev *input_allocate_device(void);
994 
995 static inline void input_free_device(struct input_dev *dev)
996 {
997 	kfree(dev);
998 }
999 
1000 static inline struct input_dev *input_get_device(struct input_dev *dev)
1001 {
1002 	return to_input_dev(class_device_get(&dev->cdev));
1003 }
1004 
1005 static inline void input_put_device(struct input_dev *dev)
1006 {
1007 	class_device_put(&dev->cdev);
1008 }
1009 
1010 void input_register_device(struct input_dev *);
1011 void input_unregister_device(struct input_dev *);
1012 
1013 void input_register_handler(struct input_handler *);
1014 void input_unregister_handler(struct input_handler *);
1015 
1016 int input_grab_device(struct input_handle *);
1017 void input_release_device(struct input_handle *);
1018 
1019 int input_open_device(struct input_handle *);
1020 void input_close_device(struct input_handle *);
1021 
1022 int input_accept_process(struct input_handle *handle, struct file *file);
1023 int input_flush_device(struct input_handle* handle, struct file* file);
1024 
1025 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1026 
1027 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1028 {
1029 	input_event(dev, EV_KEY, code, !!value);
1030 }
1031 
1032 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1033 {
1034 	input_event(dev, EV_REL, code, value);
1035 }
1036 
1037 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1038 {
1039 	input_event(dev, EV_ABS, code, value);
1040 }
1041 
1042 static inline void input_report_ff(struct input_dev *dev, unsigned int code, int value)
1043 {
1044 	input_event(dev, EV_FF, code, value);
1045 }
1046 
1047 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1048 {
1049 	input_event(dev, EV_FF_STATUS, code, value);
1050 }
1051 
1052 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1053 {
1054 	input_event(dev, EV_SW, code, !!value);
1055 }
1056 
1057 static inline void input_regs(struct input_dev *dev, struct pt_regs *regs)
1058 {
1059 	dev->regs = regs;
1060 }
1061 
1062 static inline void input_sync(struct input_dev *dev)
1063 {
1064 	input_event(dev, EV_SYN, SYN_REPORT, 0);
1065 	dev->regs = NULL;
1066 }
1067 
1068 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1069 {
1070 	dev->absmin[axis] = min;
1071 	dev->absmax[axis] = max;
1072 	dev->absfuzz[axis] = fuzz;
1073 	dev->absflat[axis] = flat;
1074 
1075 	dev->absbit[LONG(axis)] |= BIT(axis);
1076 }
1077 
1078 extern struct class input_class;
1079 
1080 #endif
1081 #endif
1082