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