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