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