Input: constify input core
[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_UNKNOWN             240
353
354 #define BTN_MISC                0x100
355 #define BTN_0                   0x100
356 #define BTN_1                   0x101
357 #define BTN_2                   0x102
358 #define BTN_3                   0x103
359 #define BTN_4                   0x104
360 #define BTN_5                   0x105
361 #define BTN_6                   0x106
362 #define BTN_7                   0x107
363 #define BTN_8                   0x108
364 #define BTN_9                   0x109
365
366 #define BTN_MOUSE               0x110
367 #define BTN_LEFT                0x110
368 #define BTN_RIGHT               0x111
369 #define BTN_MIDDLE              0x112
370 #define BTN_SIDE                0x113
371 #define BTN_EXTRA               0x114
372 #define BTN_FORWARD             0x115
373 #define BTN_BACK                0x116
374 #define BTN_TASK                0x117
375
376 #define BTN_JOYSTICK            0x120
377 #define BTN_TRIGGER             0x120
378 #define BTN_THUMB               0x121
379 #define BTN_THUMB2              0x122
380 #define BTN_TOP                 0x123
381 #define BTN_TOP2                0x124
382 #define BTN_PINKIE              0x125
383 #define BTN_BASE                0x126
384 #define BTN_BASE2               0x127
385 #define BTN_BASE3               0x128
386 #define BTN_BASE4               0x129
387 #define BTN_BASE5               0x12a
388 #define BTN_BASE6               0x12b
389 #define BTN_DEAD                0x12f
390
391 #define BTN_GAMEPAD             0x130
392 #define BTN_A                   0x130
393 #define BTN_B                   0x131
394 #define BTN_C                   0x132
395 #define BTN_X                   0x133
396 #define BTN_Y                   0x134
397 #define BTN_Z                   0x135
398 #define BTN_TL                  0x136
399 #define BTN_TR                  0x137
400 #define BTN_TL2                 0x138
401 #define BTN_TR2                 0x139
402 #define BTN_SELECT              0x13a
403 #define BTN_START               0x13b
404 #define BTN_MODE                0x13c
405 #define BTN_THUMBL              0x13d
406 #define BTN_THUMBR              0x13e
407
408 #define BTN_DIGI                0x140
409 #define BTN_TOOL_PEN            0x140
410 #define BTN_TOOL_RUBBER         0x141
411 #define BTN_TOOL_BRUSH          0x142
412 #define BTN_TOOL_PENCIL         0x143
413 #define BTN_TOOL_AIRBRUSH       0x144
414 #define BTN_TOOL_FINGER         0x145
415 #define BTN_TOOL_MOUSE          0x146
416 #define BTN_TOOL_LENS           0x147
417 #define BTN_TOUCH               0x14a
418 #define BTN_STYLUS              0x14b
419 #define BTN_STYLUS2             0x14c
420 #define BTN_TOOL_DOUBLETAP      0x14d
421 #define BTN_TOOL_TRIPLETAP      0x14e
422
423 #define BTN_WHEEL               0x150
424 #define BTN_GEAR_DOWN           0x150
425 #define BTN_GEAR_UP             0x151
426
427 #define KEY_OK                  0x160
428 #define KEY_SELECT              0x161
429 #define KEY_GOTO                0x162
430 #define KEY_CLEAR               0x163
431 #define KEY_POWER2              0x164
432 #define KEY_OPTION              0x165
433 #define KEY_INFO                0x166
434 #define KEY_TIME                0x167
435 #define KEY_VENDOR              0x168
436 #define KEY_ARCHIVE             0x169
437 #define KEY_PROGRAM             0x16a
438 #define KEY_CHANNEL             0x16b
439 #define KEY_FAVORITES           0x16c
440 #define KEY_EPG                 0x16d
441 #define KEY_PVR                 0x16e
442 #define KEY_MHP                 0x16f
443 #define KEY_LANGUAGE            0x170
444 #define KEY_TITLE               0x171
445 #define KEY_SUBTITLE            0x172
446 #define KEY_ANGLE               0x173
447 #define KEY_ZOOM                0x174
448 #define KEY_MODE                0x175
449 #define KEY_KEYBOARD            0x176
450 #define KEY_SCREEN              0x177
451 #define KEY_PC                  0x178
452 #define KEY_TV                  0x179
453 #define KEY_TV2                 0x17a
454 #define KEY_VCR                 0x17b
455 #define KEY_VCR2                0x17c
456 #define KEY_SAT                 0x17d
457 #define KEY_SAT2                0x17e
458 #define KEY_CD                  0x17f
459 #define KEY_TAPE                0x180
460 #define KEY_RADIO               0x181
461 #define KEY_TUNER               0x182
462 #define KEY_PLAYER              0x183
463 #define KEY_TEXT                0x184
464 #define KEY_DVD                 0x185
465 #define KEY_AUX                 0x186
466 #define KEY_MP3                 0x187
467 #define KEY_AUDIO               0x188
468 #define KEY_VIDEO               0x189
469 #define KEY_DIRECTORY           0x18a
470 #define KEY_LIST                0x18b
471 #define KEY_MEMO                0x18c
472 #define KEY_CALENDAR            0x18d
473 #define KEY_RED                 0x18e
474 #define KEY_GREEN               0x18f
475 #define KEY_YELLOW              0x190
476 #define KEY_BLUE                0x191
477 #define KEY_CHANNELUP           0x192
478 #define KEY_CHANNELDOWN         0x193
479 #define KEY_FIRST               0x194
480 #define KEY_LAST                0x195
481 #define KEY_AB                  0x196
482 #define KEY_NEXT                0x197
483 #define KEY_RESTART             0x198
484 #define KEY_SLOW                0x199
485 #define KEY_SHUFFLE             0x19a
486 #define KEY_BREAK               0x19b
487 #define KEY_PREVIOUS            0x19c
488 #define KEY_DIGITS              0x19d
489 #define KEY_TEEN                0x19e
490 #define KEY_TWEN                0x19f
491
492 #define KEY_DEL_EOL             0x1c0
493 #define KEY_DEL_EOS             0x1c1
494 #define KEY_INS_LINE            0x1c2
495 #define KEY_DEL_LINE            0x1c3
496
497 #define KEY_FN                  0x1d0
498 #define KEY_FN_ESC              0x1d1
499 #define KEY_FN_F1               0x1d2
500 #define KEY_FN_F2               0x1d3
501 #define KEY_FN_F3               0x1d4
502 #define KEY_FN_F4               0x1d5
503 #define KEY_FN_F5               0x1d6
504 #define KEY_FN_F6               0x1d7
505 #define KEY_FN_F7               0x1d8
506 #define KEY_FN_F8               0x1d9
507 #define KEY_FN_F9               0x1da
508 #define KEY_FN_F10              0x1db
509 #define KEY_FN_F11              0x1dc
510 #define KEY_FN_F12              0x1dd
511 #define KEY_FN_1                0x1de
512 #define KEY_FN_2                0x1df
513 #define KEY_FN_D                0x1e0
514 #define KEY_FN_E                0x1e1
515 #define KEY_FN_F                0x1e2
516 #define KEY_FN_S                0x1e3
517 #define KEY_FN_B                0x1e4
518
519 #define KEY_BRL_DOT1            0x1f1
520 #define KEY_BRL_DOT2            0x1f2
521 #define KEY_BRL_DOT3            0x1f3
522 #define KEY_BRL_DOT4            0x1f4
523 #define KEY_BRL_DOT5            0x1f5
524 #define KEY_BRL_DOT6            0x1f6
525 #define KEY_BRL_DOT7            0x1f7
526 #define KEY_BRL_DOT8            0x1f8
527
528 /* We avoid low common keys in module aliases so they don't get huge. */
529 #define KEY_MIN_INTERESTING     KEY_MUTE
530 #define KEY_MAX                 0x1ff
531
532 /*
533  * Relative axes
534  */
535
536 #define REL_X                   0x00
537 #define REL_Y                   0x01
538 #define REL_Z                   0x02
539 #define REL_RX                  0x03
540 #define REL_RY                  0x04
541 #define REL_RZ                  0x05
542 #define REL_HWHEEL              0x06
543 #define REL_DIAL                0x07
544 #define REL_WHEEL               0x08
545 #define REL_MISC                0x09
546 #define REL_MAX                 0x0f
547
548 /*
549  * Absolute axes
550  */
551
552 #define ABS_X                   0x00
553 #define ABS_Y                   0x01
554 #define ABS_Z                   0x02
555 #define ABS_RX                  0x03
556 #define ABS_RY                  0x04
557 #define ABS_RZ                  0x05
558 #define ABS_THROTTLE            0x06
559 #define ABS_RUDDER              0x07
560 #define ABS_WHEEL               0x08
561 #define ABS_GAS                 0x09
562 #define ABS_BRAKE               0x0a
563 #define ABS_HAT0X               0x10
564 #define ABS_HAT0Y               0x11
565 #define ABS_HAT1X               0x12
566 #define ABS_HAT1Y               0x13
567 #define ABS_HAT2X               0x14
568 #define ABS_HAT2Y               0x15
569 #define ABS_HAT3X               0x16
570 #define ABS_HAT3Y               0x17
571 #define ABS_PRESSURE            0x18
572 #define ABS_DISTANCE            0x19
573 #define ABS_TILT_X              0x1a
574 #define ABS_TILT_Y              0x1b
575 #define ABS_TOOL_WIDTH          0x1c
576 #define ABS_VOLUME              0x20
577 #define ABS_MISC                0x28
578 #define ABS_MAX                 0x3f
579
580 /*
581  * Switch events
582  */
583
584 #define SW_LID                  0x00  /* set = lid shut */
585 #define SW_TABLET_MODE          0x01  /* set = tablet mode */
586 #define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
587 #define SW_MAX                  0x0f
588
589 /*
590  * Misc events
591  */
592
593 #define MSC_SERIAL              0x00
594 #define MSC_PULSELED            0x01
595 #define MSC_GESTURE             0x02
596 #define MSC_RAW                 0x03
597 #define MSC_SCAN                0x04
598 #define MSC_MAX                 0x07
599
600 /*
601  * LEDs
602  */
603
604 #define LED_NUML                0x00
605 #define LED_CAPSL               0x01
606 #define LED_SCROLLL             0x02
607 #define LED_COMPOSE             0x03
608 #define LED_KANA                0x04
609 #define LED_SLEEP               0x05
610 #define LED_SUSPEND             0x06
611 #define LED_MUTE                0x07
612 #define LED_MISC                0x08
613 #define LED_MAIL                0x09
614 #define LED_CHARGING            0x0a
615 #define LED_MAX                 0x0f
616
617 /*
618  * Autorepeat values
619  */
620
621 #define REP_DELAY               0x00
622 #define REP_PERIOD              0x01
623 #define REP_MAX                 0x01
624
625 /*
626  * Sounds
627  */
628
629 #define SND_CLICK               0x00
630 #define SND_BELL                0x01
631 #define SND_TONE                0x02
632 #define SND_MAX                 0x07
633
634 /*
635  * IDs.
636  */
637
638 #define ID_BUS                  0
639 #define ID_VENDOR               1
640 #define ID_PRODUCT              2
641 #define ID_VERSION              3
642
643 #define BUS_PCI                 0x01
644 #define BUS_ISAPNP              0x02
645 #define BUS_USB                 0x03
646 #define BUS_HIL                 0x04
647 #define BUS_BLUETOOTH           0x05
648
649 #define BUS_ISA                 0x10
650 #define BUS_I8042               0x11
651 #define BUS_XTKBD               0x12
652 #define BUS_RS232               0x13
653 #define BUS_GAMEPORT            0x14
654 #define BUS_PARPORT             0x15
655 #define BUS_AMIGA               0x16
656 #define BUS_ADB                 0x17
657 #define BUS_I2C                 0x18
658 #define BUS_HOST                0x19
659 #define BUS_GSC                 0x1A
660
661 /*
662  * Values describing the status of an effect
663  */
664 #define FF_STATUS_STOPPED       0x00
665 #define FF_STATUS_PLAYING       0x01
666 #define FF_STATUS_MAX           0x01
667
668 /*
669  * Structures used in ioctls to upload effects to a device
670  * They are pieces of a bigger structure (called ff_effect)
671  */
672
673 /*
674  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
675  * should not be used and have unspecified results.
676  */
677
678 /**
679  * struct ff_replay - defines scheduling of the effect
680  * @length: duration of the effect
681  * @delay: delay before effect should start playing
682  */
683 struct ff_replay {
684         __u16 length;
685         __u16 delay;
686 };
687
688 /**
689  * struct ff_trigger - defines what triggers the effect
690  * @button: number of the button triggering the effect
691  * @interval: controls how soon the effect can be re-triggered
692  */
693 struct ff_trigger {
694         __u16 button;
695         __u16 interval;
696 };
697
698 /**
699  * struct ff_envelope - generic effect envelope
700  * @attack_length: duration of the attack (ms)
701  * @attack_level: level at the beginning of the attack
702  * @fade_length: duration of fade (ms)
703  * @fade_level: level at the end of fade
704  *
705  * The @attack_level and @fade_level are absolute values; when applying
706  * envelope force-feedback core will convert to positive/negative
707  * value based on polarity of the default level of the effect.
708  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
709  */
710 struct ff_envelope {
711         __u16 attack_length;
712         __u16 attack_level;
713         __u16 fade_length;
714         __u16 fade_level;
715 };
716
717 /**
718  * struct ff_constant_effect - defines parameters of a constant effect
719  * @level: strength of the effect; may be negative
720  * @envelope: envelope data
721  */
722 struct ff_constant_effect {
723         __s16 level;
724         struct ff_envelope envelope;
725 };
726
727 /**
728  * struct ff_ramp_effect - defines parameters of a ramp effect
729  * @start_level: beginning strength of the effect; may be negative
730  * @end_level: final strength of the effect; may be negative
731  * @envelope: envelope data
732  */
733 struct ff_ramp_effect {
734         __s16 start_level;
735         __s16 end_level;
736         struct ff_envelope envelope;
737 };
738
739 /**
740  * struct ff_condition_effect - defines a spring or friction effect
741  * @right_saturation: maximum level when joystick moved all way to the right
742  * @left_saturation: same for the left side
743  * @right_coeff: controls how fast the force grows when the joystick moves
744  *      to the right
745  * @left_coeff: same for the left side
746  * @deadband: size of the dead zone, where no force is produced
747  * @center: position of the dead zone
748  */
749 struct ff_condition_effect {
750         __u16 right_saturation;
751         __u16 left_saturation;
752
753         __s16 right_coeff;
754         __s16 left_coeff;
755
756         __u16 deadband;
757         __s16 center;
758 };
759
760 /**
761  * struct ff_periodic_effect - defines parameters of a periodic effect
762  * @waveform: kind of the effect (wave)
763  * @period: period of the wave (ms)
764  * @magnitude: peak value
765  * @offset: mean value of the wave (roughly)
766  * @phase: 'horizontal' shift
767  * @envelope: envelope data
768  * @custom_len: number of samples (FF_CUSTOM only)
769  * @custom_data: buffer of samples (FF_CUSTOM only)
770  *
771  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
772  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
773  * for the time being as no driver supports it yet.
774  *
775  * Note: the data pointed by custom_data is copied by the driver.
776  * You can therefore dispose of the memory after the upload/update.
777  */
778 struct ff_periodic_effect {
779         __u16 waveform;
780         __u16 period;
781         __s16 magnitude;
782         __s16 offset;
783         __u16 phase;
784
785         struct ff_envelope envelope;
786
787         __u32 custom_len;
788         __s16 *custom_data;
789 };
790
791 /**
792  * struct ff_rumble_effect - defines parameters of a periodic effect
793  * @strong_magnitude: magnitude of the heavy motor
794  * @weak_magnitude: magnitude of the light one
795  *
796  * Some rumble pads have two motors of different weight. Strong_magnitude
797  * represents the magnitude of the vibration generated by the heavy one.
798  */
799 struct ff_rumble_effect {
800         __u16 strong_magnitude;
801         __u16 weak_magnitude;
802 };
803
804 /**
805  * struct ff_effect - defines force feedback effect
806  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
807  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
808  * @id: an unique id assigned to an effect
809  * @direction: direction of the effect
810  * @trigger: trigger conditions (struct ff_trigger)
811  * @replay: scheduling of the effect (struct ff_replay)
812  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
813  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
814  *      defining effect parameters
815  *
816  * This structure is sent through ioctl from the application to the driver.
817  * To create a new effect aplication should set its @id to -1; the kernel
818  * will return assigned @id which can later be used to update or delete
819  * this effect.
820  *
821  * Direction of the effect is encoded as follows:
822  *      0 deg -> 0x0000 (down)
823  *      90 deg -> 0x4000 (left)
824  *      180 deg -> 0x8000 (up)
825  *      270 deg -> 0xC000 (right)
826  */
827 struct ff_effect {
828         __u16 type;
829         __s16 id;
830         __u16 direction;
831         struct ff_trigger trigger;
832         struct ff_replay replay;
833
834         union {
835                 struct ff_constant_effect constant;
836                 struct ff_ramp_effect ramp;
837                 struct ff_periodic_effect periodic;
838                 struct ff_condition_effect condition[2]; /* One for each axis */
839                 struct ff_rumble_effect rumble;
840         } u;
841 };
842
843 /*
844  * Force feedback effect types
845  */
846
847 #define FF_RUMBLE       0x50
848 #define FF_PERIODIC     0x51
849 #define FF_CONSTANT     0x52
850 #define FF_SPRING       0x53
851 #define FF_FRICTION     0x54
852 #define FF_DAMPER       0x55
853 #define FF_INERTIA      0x56
854 #define FF_RAMP         0x57
855
856 #define FF_EFFECT_MIN   FF_RUMBLE
857 #define FF_EFFECT_MAX   FF_RAMP
858
859 /*
860  * Force feedback periodic effect types
861  */
862
863 #define FF_SQUARE       0x58
864 #define FF_TRIANGLE     0x59
865 #define FF_SINE         0x5a
866 #define FF_SAW_UP       0x5b
867 #define FF_SAW_DOWN     0x5c
868 #define FF_CUSTOM       0x5d
869
870 #define FF_WAVEFORM_MIN FF_SQUARE
871 #define FF_WAVEFORM_MAX FF_CUSTOM
872
873 /*
874  * Set ff device properties
875  */
876
877 #define FF_GAIN         0x60
878 #define FF_AUTOCENTER   0x61
879
880 #define FF_MAX          0x7f
881
882 #ifdef __KERNEL__
883
884 /*
885  * In-kernel definitions.
886  */
887
888 #include <linux/device.h>
889 #include <linux/fs.h>
890 #include <linux/timer.h>
891 #include <linux/mod_devicetable.h>
892
893 #define NBITS(x) (((x)/BITS_PER_LONG)+1)
894 #define BIT(x)  (1UL<<((x)%BITS_PER_LONG))
895 #define LONG(x) ((x)/BITS_PER_LONG)
896
897 #define INPUT_KEYCODE(dev, scancode) ((dev->keycodesize == 1) ? ((u8*)dev->keycode)[scancode] : \
898         ((dev->keycodesize == 2) ? ((u16*)dev->keycode)[scancode] : (((u32*)dev->keycode)[scancode])))
899
900 #define SET_INPUT_KEYCODE(dev, scancode, val)                   \
901                 ({      unsigned __old;                         \
902                 switch (dev->keycodesize) {                     \
903                         case 1: {                               \
904                                 u8 *k = (u8 *)dev->keycode;     \
905                                 __old = k[scancode];            \
906                                 k[scancode] = val;              \
907                                 break;                          \
908                         }                                       \
909                         case 2: {                               \
910                                 u16 *k = (u16 *)dev->keycode;   \
911                                 __old = k[scancode];            \
912                                 k[scancode] = val;              \
913                                 break;                          \
914                         }                                       \
915                         default: {                              \
916                                 u32 *k = (u32 *)dev->keycode;   \
917                                 __old = k[scancode];            \
918                                 k[scancode] = val;              \
919                                 break;                          \
920                         }                                       \
921                 }                                               \
922                 __old; })
923
924 struct input_dev {
925
926         void *private;
927
928         const char *name;
929         const char *phys;
930         const char *uniq;
931         struct input_id id;
932
933         unsigned long evbit[NBITS(EV_MAX)];
934         unsigned long keybit[NBITS(KEY_MAX)];
935         unsigned long relbit[NBITS(REL_MAX)];
936         unsigned long absbit[NBITS(ABS_MAX)];
937         unsigned long mscbit[NBITS(MSC_MAX)];
938         unsigned long ledbit[NBITS(LED_MAX)];
939         unsigned long sndbit[NBITS(SND_MAX)];
940         unsigned long ffbit[NBITS(FF_MAX)];
941         unsigned long swbit[NBITS(SW_MAX)];
942
943         unsigned int keycodemax;
944         unsigned int keycodesize;
945         void *keycode;
946
947         struct ff_device *ff;
948
949         unsigned int repeat_key;
950         struct timer_list timer;
951
952         struct pt_regs *regs;
953         int state;
954
955         int sync;
956
957         int abs[ABS_MAX + 1];
958         int rep[REP_MAX + 1];
959
960         unsigned long key[NBITS(KEY_MAX)];
961         unsigned long led[NBITS(LED_MAX)];
962         unsigned long snd[NBITS(SND_MAX)];
963         unsigned long sw[NBITS(SW_MAX)];
964
965         int absmax[ABS_MAX + 1];
966         int absmin[ABS_MAX + 1];
967         int absfuzz[ABS_MAX + 1];
968         int absflat[ABS_MAX + 1];
969
970         int (*open)(struct input_dev *dev);
971         void (*close)(struct input_dev *dev);
972         int (*flush)(struct input_dev *dev, struct file *file);
973         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
974
975         struct input_handle *grab;
976
977         struct mutex mutex;     /* serializes open and close operations */
978         unsigned int users;
979
980         struct class_device cdev;
981         struct device *dev;     /* will be removed soon */
982
983         int dynalloc;   /* temporarily */
984
985         struct list_head        h_list;
986         struct list_head        node;
987 };
988 #define to_input_dev(d) container_of(d, struct input_dev, cdev)
989
990 /*
991  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
992  */
993
994 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
995 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
996 #endif
997
998 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
999 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1000 #endif
1001
1002 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1003 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1004 #endif
1005
1006 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1007 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1008 #endif
1009
1010 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1011 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1012 #endif
1013
1014 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1015 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1016 #endif
1017
1018 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1019 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1020 #endif
1021
1022 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1023 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1024 #endif
1025
1026 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1027 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1028 #endif
1029
1030 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1031         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1032 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1033         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1034
1035 struct input_handle;
1036
1037 /**
1038  * struct input_handler - implements one of interfaces for input devices
1039  * @private: driver-specific data
1040  * @event: event handler
1041  * @connect: called when attaching a handler to an input device
1042  * @disconnect: disconnects a handler from input device
1043  * @start: starts handler for given handle. This function is called by
1044  *      input core right after connect() method and also when a process
1045  *      that "grabbed" a device releases it
1046  * @fops: file operations this driver implements
1047  * @minor: beginning of range of 32 minors for devices this driver
1048  *      can provide
1049  * @name: name of the handler, to be shown in /proc/bus/input/handlers
1050  * @id_table: pointer to a table of input_device_ids this driver can
1051  *      handle
1052  * @blacklist: prointer to a table of input_device_ids this driver should
1053  *      ignore even if they match @id_table
1054  * @h_list: list of input handles associated with the handler
1055  * @node: for placing the driver onto input_handler_list
1056  */
1057 struct input_handler {
1058
1059         void *private;
1060
1061         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1062         struct input_handle* (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1063         void (*disconnect)(struct input_handle *handle);
1064         void (*start)(struct input_handle *handle);
1065
1066         const struct file_operations *fops;
1067         int minor;
1068         const char *name;
1069
1070         const struct input_device_id *id_table;
1071         const struct input_device_id *blacklist;
1072
1073         struct list_head        h_list;
1074         struct list_head        node;
1075 };
1076
1077 struct input_handle {
1078
1079         void *private;
1080
1081         int open;
1082         const char *name;
1083
1084         struct input_dev *dev;
1085         struct input_handler *handler;
1086
1087         struct list_head        d_node;
1088         struct list_head        h_node;
1089 };
1090
1091 #define to_dev(n) container_of(n,struct input_dev,node)
1092 #define to_handler(n) container_of(n,struct input_handler,node);
1093 #define to_handle(n) container_of(n,struct input_handle,d_node)
1094 #define to_handle_h(n) container_of(n,struct input_handle,h_node)
1095
1096 static inline void init_input_dev(struct input_dev *dev)
1097 {
1098         INIT_LIST_HEAD(&dev->h_list);
1099         INIT_LIST_HEAD(&dev->node);
1100 }
1101
1102 struct input_dev *input_allocate_device(void);
1103 void input_free_device(struct input_dev *dev);
1104
1105 static inline struct input_dev *input_get_device(struct input_dev *dev)
1106 {
1107         return to_input_dev(class_device_get(&dev->cdev));
1108 }
1109
1110 static inline void input_put_device(struct input_dev *dev)
1111 {
1112         class_device_put(&dev->cdev);
1113 }
1114
1115 int input_register_device(struct input_dev *);
1116 void input_unregister_device(struct input_dev *);
1117
1118 void input_register_handler(struct input_handler *);
1119 void input_unregister_handler(struct input_handler *);
1120
1121 int input_grab_device(struct input_handle *);
1122 void input_release_device(struct input_handle *);
1123
1124 int input_open_device(struct input_handle *);
1125 void input_close_device(struct input_handle *);
1126
1127 int input_flush_device(struct input_handle* handle, struct file* file);
1128
1129 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1130 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1131
1132 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1133 {
1134         input_event(dev, EV_KEY, code, !!value);
1135 }
1136
1137 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1138 {
1139         input_event(dev, EV_REL, code, value);
1140 }
1141
1142 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1143 {
1144         input_event(dev, EV_ABS, code, value);
1145 }
1146
1147 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1148 {
1149         input_event(dev, EV_FF_STATUS, code, value);
1150 }
1151
1152 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1153 {
1154         input_event(dev, EV_SW, code, !!value);
1155 }
1156
1157 static inline void input_regs(struct input_dev *dev, struct pt_regs *regs)
1158 {
1159         dev->regs = regs;
1160 }
1161
1162 static inline void input_sync(struct input_dev *dev)
1163 {
1164         input_event(dev, EV_SYN, SYN_REPORT, 0);
1165         dev->regs = NULL;
1166 }
1167
1168 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1169 {
1170         dev->absmin[axis] = min;
1171         dev->absmax[axis] = max;
1172         dev->absfuzz[axis] = fuzz;
1173         dev->absflat[axis] = flat;
1174
1175         dev->absbit[LONG(axis)] |= BIT(axis);
1176 }
1177
1178 extern struct class input_class;
1179
1180 /**
1181  * struct ff_device - force-feedback part of an input device
1182  * @upload: Called to upload an new effect into device
1183  * @erase: Called to erase an effect from device
1184  * @playback: Called to request device to start playing specified effect
1185  * @set_gain: Called to set specified gain
1186  * @set_autocenter: Called to auto-center device
1187  * @destroy: called by input core when parent input device is being
1188  *      destroyed
1189  * @private: driver-specific data, will be freed automatically
1190  * @ffbit: bitmap of force feedback capabilities truly supported by
1191  *      device (not emulated like ones in input_dev->ffbit)
1192  * @mutex: mutex for serializing access to the device
1193  * @max_effects: maximum number of effects supported by device
1194  * @effects: pointer to an array of effects currently loaded into device
1195  * @effect_owners: array of effect owners; when file handle owning
1196  *      an effect gets closed the effcet is automatically erased
1197  *
1198  * Every force-feedback device must implement upload() and playback()
1199  * methods; erase() is optional. set_gain() and set_autocenter() need
1200  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1201  * bits.
1202  */
1203 struct ff_device {
1204         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1205                       struct ff_effect *old);
1206         int (*erase)(struct input_dev *dev, int effect_id);
1207
1208         int (*playback)(struct input_dev *dev, int effect_id, int value);
1209         void (*set_gain)(struct input_dev *dev, u16 gain);
1210         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1211
1212         void (*destroy)(struct ff_device *);
1213
1214         void *private;
1215
1216         unsigned long ffbit[NBITS(FF_MAX)];
1217
1218         struct mutex mutex;
1219
1220         int max_effects;
1221         struct ff_effect *effects;
1222         struct file *effect_owners[];
1223 };
1224
1225 int input_ff_create(struct input_dev *dev, int max_effects);
1226 void input_ff_destroy(struct input_dev *dev);
1227
1228 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1229
1230 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1231 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1232
1233 int input_ff_create_memless(struct input_dev *dev, void *data,
1234                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1235
1236 #endif
1237 #endif