Merge branch 'release' of git://lm-sensors.org/kernel/mhoffman/hwmon-2.6
[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 #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 KEY_WIMAX               246
375
376 /* Range 248 - 255 is reserved for special needs of AT keyboard driver */
377
378 #define BTN_MISC                0x100
379 #define BTN_0                   0x100
380 #define BTN_1                   0x101
381 #define BTN_2                   0x102
382 #define BTN_3                   0x103
383 #define BTN_4                   0x104
384 #define BTN_5                   0x105
385 #define BTN_6                   0x106
386 #define BTN_7                   0x107
387 #define BTN_8                   0x108
388 #define BTN_9                   0x109
389
390 #define BTN_MOUSE               0x110
391 #define BTN_LEFT                0x110
392 #define BTN_RIGHT               0x111
393 #define BTN_MIDDLE              0x112
394 #define BTN_SIDE                0x113
395 #define BTN_EXTRA               0x114
396 #define BTN_FORWARD             0x115
397 #define BTN_BACK                0x116
398 #define BTN_TASK                0x117
399
400 #define BTN_JOYSTICK            0x120
401 #define BTN_TRIGGER             0x120
402 #define BTN_THUMB               0x121
403 #define BTN_THUMB2              0x122
404 #define BTN_TOP                 0x123
405 #define BTN_TOP2                0x124
406 #define BTN_PINKIE              0x125
407 #define BTN_BASE                0x126
408 #define BTN_BASE2               0x127
409 #define BTN_BASE3               0x128
410 #define BTN_BASE4               0x129
411 #define BTN_BASE5               0x12a
412 #define BTN_BASE6               0x12b
413 #define BTN_DEAD                0x12f
414
415 #define BTN_GAMEPAD             0x130
416 #define BTN_A                   0x130
417 #define BTN_B                   0x131
418 #define BTN_C                   0x132
419 #define BTN_X                   0x133
420 #define BTN_Y                   0x134
421 #define BTN_Z                   0x135
422 #define BTN_TL                  0x136
423 #define BTN_TR                  0x137
424 #define BTN_TL2                 0x138
425 #define BTN_TR2                 0x139
426 #define BTN_SELECT              0x13a
427 #define BTN_START               0x13b
428 #define BTN_MODE                0x13c
429 #define BTN_THUMBL              0x13d
430 #define BTN_THUMBR              0x13e
431
432 #define BTN_DIGI                0x140
433 #define BTN_TOOL_PEN            0x140
434 #define BTN_TOOL_RUBBER         0x141
435 #define BTN_TOOL_BRUSH          0x142
436 #define BTN_TOOL_PENCIL         0x143
437 #define BTN_TOOL_AIRBRUSH       0x144
438 #define BTN_TOOL_FINGER         0x145
439 #define BTN_TOOL_MOUSE          0x146
440 #define BTN_TOOL_LENS           0x147
441 #define BTN_TOUCH               0x14a
442 #define BTN_STYLUS              0x14b
443 #define BTN_STYLUS2             0x14c
444 #define BTN_TOOL_DOUBLETAP      0x14d
445 #define BTN_TOOL_TRIPLETAP      0x14e
446
447 #define BTN_WHEEL               0x150
448 #define BTN_GEAR_DOWN           0x150
449 #define BTN_GEAR_UP             0x151
450
451 #define KEY_OK                  0x160
452 #define KEY_SELECT              0x161
453 #define KEY_GOTO                0x162
454 #define KEY_CLEAR               0x163
455 #define KEY_POWER2              0x164
456 #define KEY_OPTION              0x165
457 #define KEY_INFO                0x166   /* AL OEM Features/Tips/Tutorial */
458 #define KEY_TIME                0x167
459 #define KEY_VENDOR              0x168
460 #define KEY_ARCHIVE             0x169
461 #define KEY_PROGRAM             0x16a   /* Media Select Program Guide */
462 #define KEY_CHANNEL             0x16b
463 #define KEY_FAVORITES           0x16c
464 #define KEY_EPG                 0x16d
465 #define KEY_PVR                 0x16e   /* Media Select Home */
466 #define KEY_MHP                 0x16f
467 #define KEY_LANGUAGE            0x170
468 #define KEY_TITLE               0x171
469 #define KEY_SUBTITLE            0x172
470 #define KEY_ANGLE               0x173
471 #define KEY_ZOOM                0x174
472 #define KEY_MODE                0x175
473 #define KEY_KEYBOARD            0x176
474 #define KEY_SCREEN              0x177
475 #define KEY_PC                  0x178   /* Media Select Computer */
476 #define KEY_TV                  0x179   /* Media Select TV */
477 #define KEY_TV2                 0x17a   /* Media Select Cable */
478 #define KEY_VCR                 0x17b   /* Media Select VCR */
479 #define KEY_VCR2                0x17c   /* VCR Plus */
480 #define KEY_SAT                 0x17d   /* Media Select Satellite */
481 #define KEY_SAT2                0x17e
482 #define KEY_CD                  0x17f   /* Media Select CD */
483 #define KEY_TAPE                0x180   /* Media Select Tape */
484 #define KEY_RADIO               0x181
485 #define KEY_TUNER               0x182   /* Media Select Tuner */
486 #define KEY_PLAYER              0x183
487 #define KEY_TEXT                0x184
488 #define KEY_DVD                 0x185   /* Media Select DVD */
489 #define KEY_AUX                 0x186
490 #define KEY_MP3                 0x187
491 #define KEY_AUDIO               0x188
492 #define KEY_VIDEO               0x189
493 #define KEY_DIRECTORY           0x18a
494 #define KEY_LIST                0x18b
495 #define KEY_MEMO                0x18c   /* Media Select Messages */
496 #define KEY_CALENDAR            0x18d
497 #define KEY_RED                 0x18e
498 #define KEY_GREEN               0x18f
499 #define KEY_YELLOW              0x190
500 #define KEY_BLUE                0x191
501 #define KEY_CHANNELUP           0x192   /* Channel Increment */
502 #define KEY_CHANNELDOWN         0x193   /* Channel Decrement */
503 #define KEY_FIRST               0x194
504 #define KEY_LAST                0x195   /* Recall Last */
505 #define KEY_AB                  0x196
506 #define KEY_NEXT                0x197
507 #define KEY_RESTART             0x198
508 #define KEY_SLOW                0x199
509 #define KEY_SHUFFLE             0x19a
510 #define KEY_BREAK               0x19b
511 #define KEY_PREVIOUS            0x19c
512 #define KEY_DIGITS              0x19d
513 #define KEY_TEEN                0x19e
514 #define KEY_TWEN                0x19f
515 #define KEY_VIDEOPHONE          0x1a0   /* Media Select Video Phone */
516 #define KEY_GAMES               0x1a1   /* Media Select Games */
517 #define KEY_ZOOMIN              0x1a2   /* AC Zoom In */
518 #define KEY_ZOOMOUT             0x1a3   /* AC Zoom Out */
519 #define KEY_ZOOMRESET           0x1a4   /* AC Zoom */
520 #define KEY_WORDPROCESSOR       0x1a5   /* AL Word Processor */
521 #define KEY_EDITOR              0x1a6   /* AL Text Editor */
522 #define KEY_SPREADSHEET         0x1a7   /* AL Spreadsheet */
523 #define KEY_GRAPHICSEDITOR      0x1a8   /* AL Graphics Editor */
524 #define KEY_PRESENTATION        0x1a9   /* AL Presentation App */
525 #define KEY_DATABASE            0x1aa   /* AL Database App */
526 #define KEY_NEWS                0x1ab   /* AL Newsreader */
527 #define KEY_VOICEMAIL           0x1ac   /* AL Voicemail */
528 #define KEY_ADDRESSBOOK         0x1ad   /* AL Contacts/Address Book */
529 #define KEY_MESSENGER           0x1ae   /* AL Instant Messaging */
530 #define KEY_DISPLAYTOGGLE       0x1af   /* Turn display (LCD) on and off */
531 #define KEY_SPELLCHECK          0x1b0   /* AL Spell Check */
532 #define KEY_LOGOFF              0x1b1   /* AL Logoff */
533
534 #define KEY_DOLLAR              0x1b2
535 #define KEY_EURO                0x1b3
536
537 #define KEY_FRAMEBACK           0x1b4   /* Consumer - transport controls */
538 #define KEY_FRAMEFORWARD        0x1b5
539 #define KEY_CONTEXT_MENU        0x1b6   /* GenDesc - system context menu */
540 #define KEY_MEDIA_REPEAT        0x1b7   /* Consumer - transport control */
541
542 #define KEY_DEL_EOL             0x1c0
543 #define KEY_DEL_EOS             0x1c1
544 #define KEY_INS_LINE            0x1c2
545 #define KEY_DEL_LINE            0x1c3
546
547 #define KEY_FN                  0x1d0
548 #define KEY_FN_ESC              0x1d1
549 #define KEY_FN_F1               0x1d2
550 #define KEY_FN_F2               0x1d3
551 #define KEY_FN_F3               0x1d4
552 #define KEY_FN_F4               0x1d5
553 #define KEY_FN_F5               0x1d6
554 #define KEY_FN_F6               0x1d7
555 #define KEY_FN_F7               0x1d8
556 #define KEY_FN_F8               0x1d9
557 #define KEY_FN_F9               0x1da
558 #define KEY_FN_F10              0x1db
559 #define KEY_FN_F11              0x1dc
560 #define KEY_FN_F12              0x1dd
561 #define KEY_FN_1                0x1de
562 #define KEY_FN_2                0x1df
563 #define KEY_FN_D                0x1e0
564 #define KEY_FN_E                0x1e1
565 #define KEY_FN_F                0x1e2
566 #define KEY_FN_S                0x1e3
567 #define KEY_FN_B                0x1e4
568
569 #define KEY_BRL_DOT1            0x1f1
570 #define KEY_BRL_DOT2            0x1f2
571 #define KEY_BRL_DOT3            0x1f3
572 #define KEY_BRL_DOT4            0x1f4
573 #define KEY_BRL_DOT5            0x1f5
574 #define KEY_BRL_DOT6            0x1f6
575 #define KEY_BRL_DOT7            0x1f7
576 #define KEY_BRL_DOT8            0x1f8
577 #define KEY_BRL_DOT9            0x1f9
578 #define KEY_BRL_DOT10           0x1fa
579
580 /* We avoid low common keys in module aliases so they don't get huge. */
581 #define KEY_MIN_INTERESTING     KEY_MUTE
582 #define KEY_MAX                 0x1ff
583 #define KEY_CNT                 (KEY_MAX+1)
584
585 /*
586  * Relative axes
587  */
588
589 #define REL_X                   0x00
590 #define REL_Y                   0x01
591 #define REL_Z                   0x02
592 #define REL_RX                  0x03
593 #define REL_RY                  0x04
594 #define REL_RZ                  0x05
595 #define REL_HWHEEL              0x06
596 #define REL_DIAL                0x07
597 #define REL_WHEEL               0x08
598 #define REL_MISC                0x09
599 #define REL_MAX                 0x0f
600 #define REL_CNT                 (REL_MAX+1)
601
602 /*
603  * Absolute axes
604  */
605
606 #define ABS_X                   0x00
607 #define ABS_Y                   0x01
608 #define ABS_Z                   0x02
609 #define ABS_RX                  0x03
610 #define ABS_RY                  0x04
611 #define ABS_RZ                  0x05
612 #define ABS_THROTTLE            0x06
613 #define ABS_RUDDER              0x07
614 #define ABS_WHEEL               0x08
615 #define ABS_GAS                 0x09
616 #define ABS_BRAKE               0x0a
617 #define ABS_HAT0X               0x10
618 #define ABS_HAT0Y               0x11
619 #define ABS_HAT1X               0x12
620 #define ABS_HAT1Y               0x13
621 #define ABS_HAT2X               0x14
622 #define ABS_HAT2Y               0x15
623 #define ABS_HAT3X               0x16
624 #define ABS_HAT3Y               0x17
625 #define ABS_PRESSURE            0x18
626 #define ABS_DISTANCE            0x19
627 #define ABS_TILT_X              0x1a
628 #define ABS_TILT_Y              0x1b
629 #define ABS_TOOL_WIDTH          0x1c
630 #define ABS_VOLUME              0x20
631 #define ABS_MISC                0x28
632 #define ABS_MAX                 0x3f
633 #define ABS_CNT                 (ABS_MAX+1)
634
635 /*
636  * Switch events
637  */
638
639 #define SW_LID                  0x00  /* set = lid shut */
640 #define SW_TABLET_MODE          0x01  /* set = tablet mode */
641 #define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
642 #define SW_RFKILL_ALL           0x03  /* rfkill master switch, type "any"
643                                          set = radio enabled */
644 #define SW_RADIO                SW_RFKILL_ALL   /* deprecated */
645 #define SW_MICROPHONE_INSERT    0x04  /* set = inserted */
646 #define SW_DOCK                 0x05  /* set = plugged into dock */
647 #define SW_MAX                  0x0f
648 #define SW_CNT                  (SW_MAX+1)
649
650 /*
651  * Misc events
652  */
653
654 #define MSC_SERIAL              0x00
655 #define MSC_PULSELED            0x01
656 #define MSC_GESTURE             0x02
657 #define MSC_RAW                 0x03
658 #define MSC_SCAN                0x04
659 #define MSC_MAX                 0x07
660 #define MSC_CNT                 (MSC_MAX+1)
661
662 /*
663  * LEDs
664  */
665
666 #define LED_NUML                0x00
667 #define LED_CAPSL               0x01
668 #define LED_SCROLLL             0x02
669 #define LED_COMPOSE             0x03
670 #define LED_KANA                0x04
671 #define LED_SLEEP               0x05
672 #define LED_SUSPEND             0x06
673 #define LED_MUTE                0x07
674 #define LED_MISC                0x08
675 #define LED_MAIL                0x09
676 #define LED_CHARGING            0x0a
677 #define LED_MAX                 0x0f
678 #define LED_CNT                 (LED_MAX+1)
679
680 /*
681  * Autorepeat values
682  */
683
684 #define REP_DELAY               0x00
685 #define REP_PERIOD              0x01
686 #define REP_MAX                 0x01
687
688 /*
689  * Sounds
690  */
691
692 #define SND_CLICK               0x00
693 #define SND_BELL                0x01
694 #define SND_TONE                0x02
695 #define SND_MAX                 0x07
696 #define SND_CNT                 (SND_MAX+1)
697
698 /*
699  * IDs.
700  */
701
702 #define ID_BUS                  0
703 #define ID_VENDOR               1
704 #define ID_PRODUCT              2
705 #define ID_VERSION              3
706
707 #define BUS_PCI                 0x01
708 #define BUS_ISAPNP              0x02
709 #define BUS_USB                 0x03
710 #define BUS_HIL                 0x04
711 #define BUS_BLUETOOTH           0x05
712 #define BUS_VIRTUAL             0x06
713
714 #define BUS_ISA                 0x10
715 #define BUS_I8042               0x11
716 #define BUS_XTKBD               0x12
717 #define BUS_RS232               0x13
718 #define BUS_GAMEPORT            0x14
719 #define BUS_PARPORT             0x15
720 #define BUS_AMIGA               0x16
721 #define BUS_ADB                 0x17
722 #define BUS_I2C                 0x18
723 #define BUS_HOST                0x19
724 #define BUS_GSC                 0x1A
725 #define BUS_ATARI               0x1B
726
727 /*
728  * Values describing the status of a force-feedback effect
729  */
730 #define FF_STATUS_STOPPED       0x00
731 #define FF_STATUS_PLAYING       0x01
732 #define FF_STATUS_MAX           0x01
733
734 /*
735  * Structures used in ioctls to upload effects to a device
736  * They are pieces of a bigger structure (called ff_effect)
737  */
738
739 /*
740  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
741  * should not be used and have unspecified results.
742  */
743
744 /**
745  * struct ff_replay - defines scheduling of the force-feedback effect
746  * @length: duration of the effect
747  * @delay: delay before effect should start playing
748  */
749 struct ff_replay {
750         __u16 length;
751         __u16 delay;
752 };
753
754 /**
755  * struct ff_trigger - defines what triggers the force-feedback effect
756  * @button: number of the button triggering the effect
757  * @interval: controls how soon the effect can be re-triggered
758  */
759 struct ff_trigger {
760         __u16 button;
761         __u16 interval;
762 };
763
764 /**
765  * struct ff_envelope - generic force-feedback effect envelope
766  * @attack_length: duration of the attack (ms)
767  * @attack_level: level at the beginning of the attack
768  * @fade_length: duration of fade (ms)
769  * @fade_level: level at the end of fade
770  *
771  * The @attack_level and @fade_level are absolute values; when applying
772  * envelope force-feedback core will convert to positive/negative
773  * value based on polarity of the default level of the effect.
774  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
775  */
776 struct ff_envelope {
777         __u16 attack_length;
778         __u16 attack_level;
779         __u16 fade_length;
780         __u16 fade_level;
781 };
782
783 /**
784  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
785  * @level: strength of the effect; may be negative
786  * @envelope: envelope data
787  */
788 struct ff_constant_effect {
789         __s16 level;
790         struct ff_envelope envelope;
791 };
792
793 /**
794  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
795  * @start_level: beginning strength of the effect; may be negative
796  * @end_level: final strength of the effect; may be negative
797  * @envelope: envelope data
798  */
799 struct ff_ramp_effect {
800         __s16 start_level;
801         __s16 end_level;
802         struct ff_envelope envelope;
803 };
804
805 /**
806  * struct ff_condition_effect - defines a spring or friction force-feedback effect
807  * @right_saturation: maximum level when joystick moved all way to the right
808  * @left_saturation: same for the left side
809  * @right_coeff: controls how fast the force grows when the joystick moves
810  *      to the right
811  * @left_coeff: same for the left side
812  * @deadband: size of the dead zone, where no force is produced
813  * @center: position of the dead zone
814  */
815 struct ff_condition_effect {
816         __u16 right_saturation;
817         __u16 left_saturation;
818
819         __s16 right_coeff;
820         __s16 left_coeff;
821
822         __u16 deadband;
823         __s16 center;
824 };
825
826 /**
827  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
828  * @waveform: kind of the effect (wave)
829  * @period: period of the wave (ms)
830  * @magnitude: peak value
831  * @offset: mean value of the wave (roughly)
832  * @phase: 'horizontal' shift
833  * @envelope: envelope data
834  * @custom_len: number of samples (FF_CUSTOM only)
835  * @custom_data: buffer of samples (FF_CUSTOM only)
836  *
837  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
838  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
839  * for the time being as no driver supports it yet.
840  *
841  * Note: the data pointed by custom_data is copied by the driver.
842  * You can therefore dispose of the memory after the upload/update.
843  */
844 struct ff_periodic_effect {
845         __u16 waveform;
846         __u16 period;
847         __s16 magnitude;
848         __s16 offset;
849         __u16 phase;
850
851         struct ff_envelope envelope;
852
853         __u32 custom_len;
854         __s16 *custom_data;
855 };
856
857 /**
858  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
859  * @strong_magnitude: magnitude of the heavy motor
860  * @weak_magnitude: magnitude of the light one
861  *
862  * Some rumble pads have two motors of different weight. Strong_magnitude
863  * represents the magnitude of the vibration generated by the heavy one.
864  */
865 struct ff_rumble_effect {
866         __u16 strong_magnitude;
867         __u16 weak_magnitude;
868 };
869
870 /**
871  * struct ff_effect - defines force feedback effect
872  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
873  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
874  * @id: an unique id assigned to an effect
875  * @direction: direction of the effect
876  * @trigger: trigger conditions (struct ff_trigger)
877  * @replay: scheduling of the effect (struct ff_replay)
878  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
879  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
880  *      defining effect parameters
881  *
882  * This structure is sent through ioctl from the application to the driver.
883  * To create a new effect application should set its @id to -1; the kernel
884  * will return assigned @id which can later be used to update or delete
885  * this effect.
886  *
887  * Direction of the effect is encoded as follows:
888  *      0 deg -> 0x0000 (down)
889  *      90 deg -> 0x4000 (left)
890  *      180 deg -> 0x8000 (up)
891  *      270 deg -> 0xC000 (right)
892  */
893 struct ff_effect {
894         __u16 type;
895         __s16 id;
896         __u16 direction;
897         struct ff_trigger trigger;
898         struct ff_replay replay;
899
900         union {
901                 struct ff_constant_effect constant;
902                 struct ff_ramp_effect ramp;
903                 struct ff_periodic_effect periodic;
904                 struct ff_condition_effect condition[2]; /* One for each axis */
905                 struct ff_rumble_effect rumble;
906         } u;
907 };
908
909 /*
910  * Force feedback effect types
911  */
912
913 #define FF_RUMBLE       0x50
914 #define FF_PERIODIC     0x51
915 #define FF_CONSTANT     0x52
916 #define FF_SPRING       0x53
917 #define FF_FRICTION     0x54
918 #define FF_DAMPER       0x55
919 #define FF_INERTIA      0x56
920 #define FF_RAMP         0x57
921
922 #define FF_EFFECT_MIN   FF_RUMBLE
923 #define FF_EFFECT_MAX   FF_RAMP
924
925 /*
926  * Force feedback periodic effect types
927  */
928
929 #define FF_SQUARE       0x58
930 #define FF_TRIANGLE     0x59
931 #define FF_SINE         0x5a
932 #define FF_SAW_UP       0x5b
933 #define FF_SAW_DOWN     0x5c
934 #define FF_CUSTOM       0x5d
935
936 #define FF_WAVEFORM_MIN FF_SQUARE
937 #define FF_WAVEFORM_MAX FF_CUSTOM
938
939 /*
940  * Set ff device properties
941  */
942
943 #define FF_GAIN         0x60
944 #define FF_AUTOCENTER   0x61
945
946 #define FF_MAX          0x7f
947 #define FF_CNT          (FF_MAX+1)
948
949 #ifdef __KERNEL__
950
951 /*
952  * In-kernel definitions.
953  */
954
955 #include <linux/device.h>
956 #include <linux/fs.h>
957 #include <linux/timer.h>
958 #include <linux/mod_devicetable.h>
959
960 /**
961  * struct input_dev - represents an input device
962  * @name: name of the device
963  * @phys: physical path to the device in the system hierarchy
964  * @uniq: unique identification code for the device (if device has it)
965  * @id: id of the device (struct input_id)
966  * @evbit: bitmap of types of events supported by the device (EV_KEY,
967  *      EV_REL, etc.)
968  * @keybit: bitmap of keys/buttons this device has
969  * @relbit: bitmap of relative axes for the device
970  * @absbit: bitmap of absolute axes for the device
971  * @mscbit: bitmap of miscellaneous events supported by the device
972  * @ledbit: bitmap of leds present on the device
973  * @sndbit: bitmap of sound effects supported by the device
974  * @ffbit: bitmap of force feedback effects supported by the device
975  * @swbit: bitmap of switches present on the device
976  * @keycodemax: size of keycode table
977  * @keycodesize: size of elements in keycode table
978  * @keycode: map of scancodes to keycodes for this device
979  * @setkeycode: optional method to alter current keymap, used to implement
980  *      sparse keymaps. If not supplied default mechanism will be used
981  * @getkeycode: optional method to retrieve current keymap. If not supplied
982  *      default mechanism will be used
983  * @ff: force feedback structure associated with the device if device
984  *      supports force feedback effects
985  * @repeat_key: stores key code of the last key pressed; used to implement
986  *      software autorepeat
987  * @timer: timer for software autorepeat
988  * @sync: set to 1 when there were no new events since last EV_SYNC
989  * @abs: current values for reports from absolute axes
990  * @rep: current values for autorepeat parameters (delay, rate)
991  * @key: reflects current state of device's keys/buttons
992  * @led: reflects current state of device's LEDs
993  * @snd: reflects current state of sound effects
994  * @sw: reflects current state of device's switches
995  * @absmax: maximum values for events coming from absolute axes
996  * @absmin: minimum values for events coming from absolute axes
997  * @absfuzz: describes noisiness for axes
998  * @absflat: size of the center flat position (used by joydev)
999  * @open: this method is called when the very first user calls
1000  *      input_open_device(). The driver must prepare the device
1001  *      to start generating events (start polling thread,
1002  *      request an IRQ, submit URB, etc.)
1003  * @close: this method is called when the very last user calls
1004  *      input_close_device().
1005  * @flush: purges the device. Most commonly used to get rid of force
1006  *      feedback effects loaded into the device when disconnecting
1007  *      from it
1008  * @event: event handler for events sent _to_ the device, like EV_LED
1009  *      or EV_SND. The device is expected to carry out the requested
1010  *      action (turn on a LED, play sound, etc.) The call is protected
1011  *      by @event_lock and must not sleep
1012  * @grab: input handle that currently has the device grabbed (via
1013  *      EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1014  *      recipient for all input events coming from the device
1015  * @event_lock: this spinlock is is taken when input core receives
1016  *      and processes a new event for the device (in input_event()).
1017  *      Code that accesses and/or modifies parameters of a device
1018  *      (such as keymap or absmin, absmax, absfuzz, etc.) after device
1019  *      has been registered with input core must take this lock.
1020  * @mutex: serializes calls to open(), close() and flush() methods
1021  * @users: stores number of users (input handlers) that opened this
1022  *      device. It is used by input_open_device() and input_close_device()
1023  *      to make sure that dev->open() is only called when the first
1024  *      user opens device and dev->close() is called when the very
1025  *      last user closes the device
1026  * @going_away: marks devices that are in a middle of unregistering and
1027  *      causes input_open_device*() fail with -ENODEV.
1028  * @dev: driver model's view of this device
1029  * @h_list: list of input handles associated with the device. When
1030  *      accessing the list dev->mutex must be held
1031  * @node: used to place the device onto input_dev_list
1032  */
1033 struct input_dev {
1034         const char *name;
1035         const char *phys;
1036         const char *uniq;
1037         struct input_id id;
1038
1039         unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1040         unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1041         unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1042         unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1043         unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1044         unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1045         unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1046         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1047         unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
1048
1049         unsigned int keycodemax;
1050         unsigned int keycodesize;
1051         void *keycode;
1052         int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
1053         int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
1054
1055         struct ff_device *ff;
1056
1057         unsigned int repeat_key;
1058         struct timer_list timer;
1059
1060         int sync;
1061
1062         int abs[ABS_MAX + 1];
1063         int rep[REP_MAX + 1];
1064
1065         unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1066         unsigned long led[BITS_TO_LONGS(LED_CNT)];
1067         unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1068         unsigned long sw[BITS_TO_LONGS(SW_CNT)];
1069
1070         int absmax[ABS_MAX + 1];
1071         int absmin[ABS_MAX + 1];
1072         int absfuzz[ABS_MAX + 1];
1073         int absflat[ABS_MAX + 1];
1074
1075         int (*open)(struct input_dev *dev);
1076         void (*close)(struct input_dev *dev);
1077         int (*flush)(struct input_dev *dev, struct file *file);
1078         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1079
1080         struct input_handle *grab;
1081
1082         spinlock_t event_lock;
1083         struct mutex mutex;
1084
1085         unsigned int users;
1086         int going_away;
1087
1088         struct device dev;
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 struct input_dev *input_allocate_device(void);
1223 void input_free_device(struct input_dev *dev);
1224
1225 static inline struct input_dev *input_get_device(struct input_dev *dev)
1226 {
1227         return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1228 }
1229
1230 static inline void input_put_device(struct input_dev *dev)
1231 {
1232         if (dev)
1233                 put_device(&dev->dev);
1234 }
1235
1236 static inline void *input_get_drvdata(struct input_dev *dev)
1237 {
1238         return dev_get_drvdata(&dev->dev);
1239 }
1240
1241 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1242 {
1243         dev_set_drvdata(&dev->dev, data);
1244 }
1245
1246 int __must_check input_register_device(struct input_dev *);
1247 void input_unregister_device(struct input_dev *);
1248
1249 int __must_check input_register_handler(struct input_handler *);
1250 void input_unregister_handler(struct input_handler *);
1251
1252 int input_register_handle(struct input_handle *);
1253 void input_unregister_handle(struct input_handle *);
1254
1255 int input_grab_device(struct input_handle *);
1256 void input_release_device(struct input_handle *);
1257
1258 int input_open_device(struct input_handle *);
1259 void input_close_device(struct input_handle *);
1260
1261 int input_flush_device(struct input_handle* handle, struct file* file);
1262
1263 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1264 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1265
1266 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1267 {
1268         input_event(dev, EV_KEY, code, !!value);
1269 }
1270
1271 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1272 {
1273         input_event(dev, EV_REL, code, value);
1274 }
1275
1276 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1277 {
1278         input_event(dev, EV_ABS, code, value);
1279 }
1280
1281 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1282 {
1283         input_event(dev, EV_FF_STATUS, code, value);
1284 }
1285
1286 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1287 {
1288         input_event(dev, EV_SW, code, !!value);
1289 }
1290
1291 static inline void input_sync(struct input_dev *dev)
1292 {
1293         input_event(dev, EV_SYN, SYN_REPORT, 0);
1294 }
1295
1296 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1297
1298 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1299 {
1300         dev->absmin[axis] = min;
1301         dev->absmax[axis] = max;
1302         dev->absfuzz[axis] = fuzz;
1303         dev->absflat[axis] = flat;
1304
1305         dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
1306 }
1307
1308 int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
1309 int input_set_keycode(struct input_dev *dev, int scancode, int keycode);
1310
1311 extern struct class input_class;
1312
1313 /**
1314  * struct ff_device - force-feedback part of an input device
1315  * @upload: Called to upload an new effect into device
1316  * @erase: Called to erase an effect from device
1317  * @playback: Called to request device to start playing specified effect
1318  * @set_gain: Called to set specified gain
1319  * @set_autocenter: Called to auto-center device
1320  * @destroy: called by input core when parent input device is being
1321  *      destroyed
1322  * @private: driver-specific data, will be freed automatically
1323  * @ffbit: bitmap of force feedback capabilities truly supported by
1324  *      device (not emulated like ones in input_dev->ffbit)
1325  * @mutex: mutex for serializing access to the device
1326  * @max_effects: maximum number of effects supported by device
1327  * @effects: pointer to an array of effects currently loaded into device
1328  * @effect_owners: array of effect owners; when file handle owning
1329  *      an effect gets closed the effect is automatically erased
1330  *
1331  * Every force-feedback device must implement upload() and playback()
1332  * methods; erase() is optional. set_gain() and set_autocenter() need
1333  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1334  * bits.
1335  */
1336 struct ff_device {
1337         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1338                       struct ff_effect *old);
1339         int (*erase)(struct input_dev *dev, int effect_id);
1340
1341         int (*playback)(struct input_dev *dev, int effect_id, int value);
1342         void (*set_gain)(struct input_dev *dev, u16 gain);
1343         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1344
1345         void (*destroy)(struct ff_device *);
1346
1347         void *private;
1348
1349         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1350
1351         struct mutex mutex;
1352
1353         int max_effects;
1354         struct ff_effect *effects;
1355         struct file *effect_owners[];
1356 };
1357
1358 int input_ff_create(struct input_dev *dev, int max_effects);
1359 void input_ff_destroy(struct input_dev *dev);
1360
1361 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1362
1363 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1364 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1365
1366 int input_ff_create_memless(struct input_dev *dev, void *data,
1367                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1368
1369 #endif
1370 #endif