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