daf0177b28e15bef20ae1e780fad1694cc283868
[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 <linux/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              0x010001
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 /**
51  * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
52  * @value: latest reported value for the axis.
53  * @minimum: specifies minimum value for the axis.
54  * @maximum: specifies maximum value for the axis.
55  * @fuzz: specifies fuzz value that is used to filter noise from
56  *      the event stream.
57  * @flat: values that are within this value will be discarded by
58  *      joydev interface and reported as 0 instead.
59  * @resolution: specifies resolution for the values reported for
60  *      the axis.
61  *
62  * Note that input core does not clamp reported values to the
63  * [minimum, maximum] limits, such task is left to userspace.
64  *
65  * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
66  * units per millimeter (units/mm), resolution for rotational axes
67  * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
68  */
69 struct input_absinfo {
70         __s32 value;
71         __s32 minimum;
72         __s32 maximum;
73         __s32 fuzz;
74         __s32 flat;
75         __s32 resolution;
76 };
77
78 /**
79  * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
80  * @scancode: scancode represented in machine-endian form.
81  * @len: length of the scancode that resides in @scancode buffer.
82  * @index: index in the keymap, may be used instead of scancode
83  * @flags: allows to specify how kernel should handle the request. For
84  *      example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
85  *      should perform lookup in keymap by @index instead of @scancode
86  * @keycode: key code assigned to this scancode
87  *
88  * The structure is used to retrieve and modify keymap data. Users have
89  * option of performing lookup either by @scancode itself or by @index
90  * in keymap entry. EVIOCGKEYCODE will also return scancode or index
91  * (depending on which element was used to perform lookup).
92  */
93 struct input_keymap_entry {
94 #define INPUT_KEYMAP_BY_INDEX   (1 << 0)
95         __u8  flags;
96         __u8  len;
97         __u16 index;
98         __u32 keycode;
99         __u8  scancode[32];
100 };
101
102 #define EVIOCGVERSION           _IOR('E', 0x01, int)                    /* get driver version */
103 #define EVIOCGID                _IOR('E', 0x02, struct input_id)        /* get device ID */
104 #define EVIOCGREP               _IOR('E', 0x03, unsigned int[2])        /* get repeat settings */
105 #define EVIOCSREP               _IOW('E', 0x03, unsigned int[2])        /* set repeat settings */
106
107 #define EVIOCGKEYCODE           _IOR('E', 0x04, unsigned int[2])        /* get keycode */
108 #define EVIOCGKEYCODE_V2        _IOR('E', 0x04, struct input_keymap_entry)
109 #define EVIOCSKEYCODE           _IOW('E', 0x04, unsigned int[2])        /* set keycode */
110 #define EVIOCSKEYCODE_V2        _IOW('E', 0x04, struct input_keymap_entry)
111
112 #define EVIOCGNAME(len)         _IOC(_IOC_READ, 'E', 0x06, len)         /* get device name */
113 #define EVIOCGPHYS(len)         _IOC(_IOC_READ, 'E', 0x07, len)         /* get physical location */
114 #define EVIOCGUNIQ(len)         _IOC(_IOC_READ, 'E', 0x08, len)         /* get unique identifier */
115 #define EVIOCGPROP(len)         _IOC(_IOC_READ, 'E', 0x09, len)         /* get device properties */
116
117 #define EVIOCGKEY(len)          _IOC(_IOC_READ, 'E', 0x18, len)         /* get global key state */
118 #define EVIOCGLED(len)          _IOC(_IOC_READ, 'E', 0x19, len)         /* get all LEDs */
119 #define EVIOCGSND(len)          _IOC(_IOC_READ, 'E', 0x1a, len)         /* get all sounds status */
120 #define EVIOCGSW(len)           _IOC(_IOC_READ, 'E', 0x1b, len)         /* get all switch states */
121
122 #define EVIOCGBIT(ev,len)       _IOC(_IOC_READ, 'E', 0x20 + (ev), len)  /* get event bits */
123 #define EVIOCGABS(abs)          _IOR('E', 0x40 + (abs), struct input_absinfo)   /* get abs value/limits */
124 #define EVIOCSABS(abs)          _IOW('E', 0xc0 + (abs), struct input_absinfo)   /* set abs value/limits */
125
126 #define EVIOCSFF                _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))   /* send a force effect to a force feedback device */
127 #define EVIOCRMFF               _IOW('E', 0x81, int)                    /* Erase a force effect */
128 #define EVIOCGEFFECTS           _IOR('E', 0x84, int)                    /* Report number of effects playable at the same time */
129
130 #define EVIOCGRAB               _IOW('E', 0x90, int)                    /* Grab/Release device */
131
132 #define EVIOCGSUSPENDBLOCK      _IOR('E', 0x91, int)                    /* get suspend block enable */
133 #define EVIOCSSUSPENDBLOCK      _IOW('E', 0x91, int)                    /* set suspend block enable */
134
135 /*
136  * Device properties and quirks
137  */
138
139 #define INPUT_PROP_POINTER              0x00    /* needs a pointer */
140 #define INPUT_PROP_DIRECT               0x01    /* direct input devices */
141 #define INPUT_PROP_BUTTONPAD            0x02    /* has button(s) under pad */
142 #define INPUT_PROP_SEMI_MT              0x03    /* touch rectangle only */
143
144 #define INPUT_PROP_MAX                  0x1f
145 #define INPUT_PROP_CNT                  (INPUT_PROP_MAX + 1)
146
147 /*
148  * Event types
149  */
150
151 #define EV_SYN                  0x00
152 #define EV_KEY                  0x01
153 #define EV_REL                  0x02
154 #define EV_ABS                  0x03
155 #define EV_MSC                  0x04
156 #define EV_SW                   0x05
157 #define EV_LED                  0x11
158 #define EV_SND                  0x12
159 #define EV_REP                  0x14
160 #define EV_FF                   0x15
161 #define EV_PWR                  0x16
162 #define EV_FF_STATUS            0x17
163 #define EV_MAX                  0x1f
164 #define EV_CNT                  (EV_MAX+1)
165
166 /*
167  * Synchronization events.
168  */
169
170 #define SYN_REPORT              0
171 #define SYN_CONFIG              1
172 #define SYN_MT_REPORT           2
173 #define SYN_DROPPED             3
174
175 /*
176  * Keys and buttons
177  *
178  * Most of the keys/buttons are modeled after USB HUT 1.12
179  * (see http://www.usb.org/developers/hidpage).
180  * Abbreviations in the comments:
181  * AC - Application Control
182  * AL - Application Launch Button
183  * SC - System Control
184  */
185
186 #define KEY_RESERVED            0
187 #define KEY_ESC                 1
188 #define KEY_1                   2
189 #define KEY_2                   3
190 #define KEY_3                   4
191 #define KEY_4                   5
192 #define KEY_5                   6
193 #define KEY_6                   7
194 #define KEY_7                   8
195 #define KEY_8                   9
196 #define KEY_9                   10
197 #define KEY_0                   11
198 #define KEY_MINUS               12
199 #define KEY_EQUAL               13
200 #define KEY_BACKSPACE           14
201 #define KEY_TAB                 15
202 #define KEY_Q                   16
203 #define KEY_W                   17
204 #define KEY_E                   18
205 #define KEY_R                   19
206 #define KEY_T                   20
207 #define KEY_Y                   21
208 #define KEY_U                   22
209 #define KEY_I                   23
210 #define KEY_O                   24
211 #define KEY_P                   25
212 #define KEY_LEFTBRACE           26
213 #define KEY_RIGHTBRACE          27
214 #define KEY_ENTER               28
215 #define KEY_LEFTCTRL            29
216 #define KEY_A                   30
217 #define KEY_S                   31
218 #define KEY_D                   32
219 #define KEY_F                   33
220 #define KEY_G                   34
221 #define KEY_H                   35
222 #define KEY_J                   36
223 #define KEY_K                   37
224 #define KEY_L                   38
225 #define KEY_SEMICOLON           39
226 #define KEY_APOSTROPHE          40
227 #define KEY_GRAVE               41
228 #define KEY_LEFTSHIFT           42
229 #define KEY_BACKSLASH           43
230 #define KEY_Z                   44
231 #define KEY_X                   45
232 #define KEY_C                   46
233 #define KEY_V                   47
234 #define KEY_B                   48
235 #define KEY_N                   49
236 #define KEY_M                   50
237 #define KEY_COMMA               51
238 #define KEY_DOT                 52
239 #define KEY_SLASH               53
240 #define KEY_RIGHTSHIFT          54
241 #define KEY_KPASTERISK          55
242 #define KEY_LEFTALT             56
243 #define KEY_SPACE               57
244 #define KEY_CAPSLOCK            58
245 #define KEY_F1                  59
246 #define KEY_F2                  60
247 #define KEY_F3                  61
248 #define KEY_F4                  62
249 #define KEY_F5                  63
250 #define KEY_F6                  64
251 #define KEY_F7                  65
252 #define KEY_F8                  66
253 #define KEY_F9                  67
254 #define KEY_F10                 68
255 #define KEY_NUMLOCK             69
256 #define KEY_SCROLLLOCK          70
257 #define KEY_KP7                 71
258 #define KEY_KP8                 72
259 #define KEY_KP9                 73
260 #define KEY_KPMINUS             74
261 #define KEY_KP4                 75
262 #define KEY_KP5                 76
263 #define KEY_KP6                 77
264 #define KEY_KPPLUS              78
265 #define KEY_KP1                 79
266 #define KEY_KP2                 80
267 #define KEY_KP3                 81
268 #define KEY_KP0                 82
269 #define KEY_KPDOT               83
270
271 #define KEY_ZENKAKUHANKAKU      85
272 #define KEY_102ND               86
273 #define KEY_F11                 87
274 #define KEY_F12                 88
275 #define KEY_RO                  89
276 #define KEY_KATAKANA            90
277 #define KEY_HIRAGANA            91
278 #define KEY_HENKAN              92
279 #define KEY_KATAKANAHIRAGANA    93
280 #define KEY_MUHENKAN            94
281 #define KEY_KPJPCOMMA           95
282 #define KEY_KPENTER             96
283 #define KEY_RIGHTCTRL           97
284 #define KEY_KPSLASH             98
285 #define KEY_SYSRQ               99
286 #define KEY_RIGHTALT            100
287 #define KEY_LINEFEED            101
288 #define KEY_HOME                102
289 #define KEY_UP                  103
290 #define KEY_PAGEUP              104
291 #define KEY_LEFT                105
292 #define KEY_RIGHT               106
293 #define KEY_END                 107
294 #define KEY_DOWN                108
295 #define KEY_PAGEDOWN            109
296 #define KEY_INSERT              110
297 #define KEY_DELETE              111
298 #define KEY_MACRO               112
299 #define KEY_MUTE                113
300 #define KEY_VOLUMEDOWN          114
301 #define KEY_VOLUMEUP            115
302 #define KEY_POWER               116     /* SC System Power Down */
303 #define KEY_KPEQUAL             117
304 #define KEY_KPPLUSMINUS         118
305 #define KEY_PAUSE               119
306 #define KEY_SCALE               120     /* AL Compiz Scale (Expose) */
307
308 #define KEY_KPCOMMA             121
309 #define KEY_HANGEUL             122
310 #define KEY_HANGUEL             KEY_HANGEUL
311 #define KEY_HANJA               123
312 #define KEY_YEN                 124
313 #define KEY_LEFTMETA            125
314 #define KEY_RIGHTMETA           126
315 #define KEY_COMPOSE             127
316
317 #define KEY_STOP                128     /* AC Stop */
318 #define KEY_AGAIN               129
319 #define KEY_PROPS               130     /* AC Properties */
320 #define KEY_UNDO                131     /* AC Undo */
321 #define KEY_FRONT               132
322 #define KEY_COPY                133     /* AC Copy */
323 #define KEY_OPEN                134     /* AC Open */
324 #define KEY_PASTE               135     /* AC Paste */
325 #define KEY_FIND                136     /* AC Search */
326 #define KEY_CUT                 137     /* AC Cut */
327 #define KEY_HELP                138     /* AL Integrated Help Center */
328 #define KEY_MENU                139     /* Menu (show menu) */
329 #define KEY_CALC                140     /* AL Calculator */
330 #define KEY_SETUP               141
331 #define KEY_SLEEP               142     /* SC System Sleep */
332 #define KEY_WAKEUP              143     /* System Wake Up */
333 #define KEY_FILE                144     /* AL Local Machine Browser */
334 #define KEY_SENDFILE            145
335 #define KEY_DELETEFILE          146
336 #define KEY_XFER                147
337 #define KEY_PROG1               148
338 #define KEY_PROG2               149
339 #define KEY_WWW                 150     /* AL Internet Browser */
340 #define KEY_MSDOS               151
341 #define KEY_COFFEE              152     /* AL Terminal Lock/Screensaver */
342 #define KEY_SCREENLOCK          KEY_COFFEE
343 #define KEY_DIRECTION           153
344 #define KEY_CYCLEWINDOWS        154
345 #define KEY_MAIL                155
346 #define KEY_BOOKMARKS           156     /* AC Bookmarks */
347 #define KEY_COMPUTER            157
348 #define KEY_BACK                158     /* AC Back */
349 #define KEY_FORWARD             159     /* AC Forward */
350 #define KEY_CLOSECD             160
351 #define KEY_EJECTCD             161
352 #define KEY_EJECTCLOSECD        162
353 #define KEY_NEXTSONG            163
354 #define KEY_PLAYPAUSE           164
355 #define KEY_PREVIOUSSONG        165
356 #define KEY_STOPCD              166
357 #define KEY_RECORD              167
358 #define KEY_REWIND              168
359 #define KEY_PHONE               169     /* Media Select Telephone */
360 #define KEY_ISO                 170
361 #define KEY_CONFIG              171     /* AL Consumer Control Configuration */
362 #define KEY_HOMEPAGE            172     /* AC Home */
363 #define KEY_REFRESH             173     /* AC Refresh */
364 #define KEY_EXIT                174     /* AC Exit */
365 #define KEY_MOVE                175
366 #define KEY_EDIT                176
367 #define KEY_SCROLLUP            177
368 #define KEY_SCROLLDOWN          178
369 #define KEY_KPLEFTPAREN         179
370 #define KEY_KPRIGHTPAREN        180
371 #define KEY_NEW                 181     /* AC New */
372 #define KEY_REDO                182     /* AC Redo/Repeat */
373
374 #define KEY_F13                 183
375 #define KEY_F14                 184
376 #define KEY_F15                 185
377 #define KEY_F16                 186
378 #define KEY_F17                 187
379 #define KEY_F18                 188
380 #define KEY_F19                 189
381 #define KEY_F20                 190
382 #define KEY_F21                 191
383 #define KEY_F22                 192
384 #define KEY_F23                 193
385 #define KEY_F24                 194
386
387 #define KEY_PLAYCD              200
388 #define KEY_PAUSECD             201
389 #define KEY_PROG3               202
390 #define KEY_PROG4               203
391 #define KEY_DASHBOARD           204     /* AL Dashboard */
392 #define KEY_SUSPEND             205
393 #define KEY_CLOSE               206     /* AC Close */
394 #define KEY_PLAY                207
395 #define KEY_FASTFORWARD         208
396 #define KEY_BASSBOOST           209
397 #define KEY_PRINT               210     /* AC Print */
398 #define KEY_HP                  211
399 #define KEY_CAMERA              212
400 #define KEY_SOUND               213
401 #define KEY_QUESTION            214
402 #define KEY_EMAIL               215
403 #define KEY_CHAT                216
404 #define KEY_SEARCH              217
405 #define KEY_CONNECT             218
406 #define KEY_FINANCE             219     /* AL Checkbook/Finance */
407 #define KEY_SPORT               220
408 #define KEY_SHOP                221
409 #define KEY_ALTERASE            222
410 #define KEY_CANCEL              223     /* AC Cancel */
411 #define KEY_BRIGHTNESSDOWN      224
412 #define KEY_BRIGHTNESSUP        225
413 #define KEY_MEDIA               226
414
415 #define KEY_SWITCHVIDEOMODE     227     /* Cycle between available video
416                                            outputs (Monitor/LCD/TV-out/etc) */
417 #define KEY_KBDILLUMTOGGLE      228
418 #define KEY_KBDILLUMDOWN        229
419 #define KEY_KBDILLUMUP          230
420
421 #define KEY_SEND                231     /* AC Send */
422 #define KEY_REPLY               232     /* AC Reply */
423 #define KEY_FORWARDMAIL         233     /* AC Forward Msg */
424 #define KEY_SAVE                234     /* AC Save */
425 #define KEY_DOCUMENTS           235
426
427 #define KEY_BATTERY             236
428
429 #define KEY_BLUETOOTH           237
430 #define KEY_WLAN                238
431 #define KEY_UWB                 239
432
433 #define KEY_UNKNOWN             240
434
435 #define KEY_VIDEO_NEXT          241     /* drive next video source */
436 #define KEY_VIDEO_PREV          242     /* drive previous video source */
437 #define KEY_BRIGHTNESS_CYCLE    243     /* brightness up, after max is min */
438 #define KEY_BRIGHTNESS_ZERO     244     /* brightness off, use ambient */
439 #define KEY_DISPLAY_OFF         245     /* display device to off state */
440
441 #define KEY_WIMAX               246
442 #define KEY_RFKILL              247     /* Key that controls all radios */
443
444 #define KEY_MICMUTE             248     /* Mute / unmute the microphone */
445
446 /* Code 255 is reserved for special needs of AT keyboard driver */
447
448 #define BTN_MISC                0x100
449 #define BTN_0                   0x100
450 #define BTN_1                   0x101
451 #define BTN_2                   0x102
452 #define BTN_3                   0x103
453 #define BTN_4                   0x104
454 #define BTN_5                   0x105
455 #define BTN_6                   0x106
456 #define BTN_7                   0x107
457 #define BTN_8                   0x108
458 #define BTN_9                   0x109
459
460 #define BTN_MOUSE               0x110
461 #define BTN_LEFT                0x110
462 #define BTN_RIGHT               0x111
463 #define BTN_MIDDLE              0x112
464 #define BTN_SIDE                0x113
465 #define BTN_EXTRA               0x114
466 #define BTN_FORWARD             0x115
467 #define BTN_BACK                0x116
468 #define BTN_TASK                0x117
469
470 #define BTN_JOYSTICK            0x120
471 #define BTN_TRIGGER             0x120
472 #define BTN_THUMB               0x121
473 #define BTN_THUMB2              0x122
474 #define BTN_TOP                 0x123
475 #define BTN_TOP2                0x124
476 #define BTN_PINKIE              0x125
477 #define BTN_BASE                0x126
478 #define BTN_BASE2               0x127
479 #define BTN_BASE3               0x128
480 #define BTN_BASE4               0x129
481 #define BTN_BASE5               0x12a
482 #define BTN_BASE6               0x12b
483 #define BTN_DEAD                0x12f
484
485 #define BTN_GAMEPAD             0x130
486 #define BTN_A                   0x130
487 #define BTN_B                   0x131
488 #define BTN_C                   0x132
489 #define BTN_X                   0x133
490 #define BTN_Y                   0x134
491 #define BTN_Z                   0x135
492 #define BTN_TL                  0x136
493 #define BTN_TR                  0x137
494 #define BTN_TL2                 0x138
495 #define BTN_TR2                 0x139
496 #define BTN_SELECT              0x13a
497 #define BTN_START               0x13b
498 #define BTN_MODE                0x13c
499 #define BTN_THUMBL              0x13d
500 #define BTN_THUMBR              0x13e
501
502 #define BTN_DIGI                0x140
503 #define BTN_TOOL_PEN            0x140
504 #define BTN_TOOL_RUBBER         0x141
505 #define BTN_TOOL_BRUSH          0x142
506 #define BTN_TOOL_PENCIL         0x143
507 #define BTN_TOOL_AIRBRUSH       0x144
508 #define BTN_TOOL_FINGER         0x145
509 #define BTN_TOOL_MOUSE          0x146
510 #define BTN_TOOL_LENS           0x147
511 #define BTN_TOOL_QUINTTAP       0x148   /* Five fingers on trackpad */
512 #define BTN_TOUCH               0x14a
513 #define BTN_STYLUS              0x14b
514 #define BTN_STYLUS2             0x14c
515 #define BTN_TOOL_DOUBLETAP      0x14d
516 #define BTN_TOOL_TRIPLETAP      0x14e
517 #define BTN_TOOL_QUADTAP        0x14f   /* Four fingers on trackpad */
518
519 #define BTN_WHEEL               0x150
520 #define BTN_GEAR_DOWN           0x150
521 #define BTN_GEAR_UP             0x151
522
523 #define KEY_OK                  0x160
524 #define KEY_SELECT              0x161
525 #define KEY_GOTO                0x162
526 #define KEY_CLEAR               0x163
527 #define KEY_POWER2              0x164
528 #define KEY_OPTION              0x165
529 #define KEY_INFO                0x166   /* AL OEM Features/Tips/Tutorial */
530 #define KEY_TIME                0x167
531 #define KEY_VENDOR              0x168
532 #define KEY_ARCHIVE             0x169
533 #define KEY_PROGRAM             0x16a   /* Media Select Program Guide */
534 #define KEY_CHANNEL             0x16b
535 #define KEY_FAVORITES           0x16c
536 #define KEY_EPG                 0x16d
537 #define KEY_PVR                 0x16e   /* Media Select Home */
538 #define KEY_MHP                 0x16f
539 #define KEY_LANGUAGE            0x170
540 #define KEY_TITLE               0x171
541 #define KEY_SUBTITLE            0x172
542 #define KEY_ANGLE               0x173
543 #define KEY_ZOOM                0x174
544 #define KEY_MODE                0x175
545 #define KEY_KEYBOARD            0x176
546 #define KEY_SCREEN              0x177
547 #define KEY_PC                  0x178   /* Media Select Computer */
548 #define KEY_TV                  0x179   /* Media Select TV */
549 #define KEY_TV2                 0x17a   /* Media Select Cable */
550 #define KEY_VCR                 0x17b   /* Media Select VCR */
551 #define KEY_VCR2                0x17c   /* VCR Plus */
552 #define KEY_SAT                 0x17d   /* Media Select Satellite */
553 #define KEY_SAT2                0x17e
554 #define KEY_CD                  0x17f   /* Media Select CD */
555 #define KEY_TAPE                0x180   /* Media Select Tape */
556 #define KEY_RADIO               0x181
557 #define KEY_TUNER               0x182   /* Media Select Tuner */
558 #define KEY_PLAYER              0x183
559 #define KEY_TEXT                0x184
560 #define KEY_DVD                 0x185   /* Media Select DVD */
561 #define KEY_AUX                 0x186
562 #define KEY_MP3                 0x187
563 #define KEY_AUDIO               0x188   /* AL Audio Browser */
564 #define KEY_VIDEO               0x189   /* AL Movie Browser */
565 #define KEY_DIRECTORY           0x18a
566 #define KEY_LIST                0x18b
567 #define KEY_MEMO                0x18c   /* Media Select Messages */
568 #define KEY_CALENDAR            0x18d
569 #define KEY_RED                 0x18e
570 #define KEY_GREEN               0x18f
571 #define KEY_YELLOW              0x190
572 #define KEY_BLUE                0x191
573 #define KEY_CHANNELUP           0x192   /* Channel Increment */
574 #define KEY_CHANNELDOWN         0x193   /* Channel Decrement */
575 #define KEY_FIRST               0x194
576 #define KEY_LAST                0x195   /* Recall Last */
577 #define KEY_AB                  0x196
578 #define KEY_NEXT                0x197
579 #define KEY_RESTART             0x198
580 #define KEY_SLOW                0x199
581 #define KEY_SHUFFLE             0x19a
582 #define KEY_BREAK               0x19b
583 #define KEY_PREVIOUS            0x19c
584 #define KEY_DIGITS              0x19d
585 #define KEY_TEEN                0x19e
586 #define KEY_TWEN                0x19f
587 #define KEY_VIDEOPHONE          0x1a0   /* Media Select Video Phone */
588 #define KEY_GAMES               0x1a1   /* Media Select Games */
589 #define KEY_ZOOMIN              0x1a2   /* AC Zoom In */
590 #define KEY_ZOOMOUT             0x1a3   /* AC Zoom Out */
591 #define KEY_ZOOMRESET           0x1a4   /* AC Zoom */
592 #define KEY_WORDPROCESSOR       0x1a5   /* AL Word Processor */
593 #define KEY_EDITOR              0x1a6   /* AL Text Editor */
594 #define KEY_SPREADSHEET         0x1a7   /* AL Spreadsheet */
595 #define KEY_GRAPHICSEDITOR      0x1a8   /* AL Graphics Editor */
596 #define KEY_PRESENTATION        0x1a9   /* AL Presentation App */
597 #define KEY_DATABASE            0x1aa   /* AL Database App */
598 #define KEY_NEWS                0x1ab   /* AL Newsreader */
599 #define KEY_VOICEMAIL           0x1ac   /* AL Voicemail */
600 #define KEY_ADDRESSBOOK         0x1ad   /* AL Contacts/Address Book */
601 #define KEY_MESSENGER           0x1ae   /* AL Instant Messaging */
602 #define KEY_DISPLAYTOGGLE       0x1af   /* Turn display (LCD) on and off */
603 #define KEY_SPELLCHECK          0x1b0   /* AL Spell Check */
604 #define KEY_LOGOFF              0x1b1   /* AL Logoff */
605
606 #define KEY_DOLLAR              0x1b2
607 #define KEY_EURO                0x1b3
608
609 #define KEY_FRAMEBACK           0x1b4   /* Consumer - transport controls */
610 #define KEY_FRAMEFORWARD        0x1b5
611 #define KEY_CONTEXT_MENU        0x1b6   /* GenDesc - system context menu */
612 #define KEY_MEDIA_REPEAT        0x1b7   /* Consumer - transport control */
613 #define KEY_10CHANNELSUP        0x1b8   /* 10 channels up (10+) */
614 #define KEY_10CHANNELSDOWN      0x1b9   /* 10 channels down (10-) */
615 #define KEY_IMAGES              0x1ba   /* AL Image Browser */
616
617 #define KEY_DEL_EOL             0x1c0
618 #define KEY_DEL_EOS             0x1c1
619 #define KEY_INS_LINE            0x1c2
620 #define KEY_DEL_LINE            0x1c3
621
622 #define KEY_FN                  0x1d0
623 #define KEY_FN_ESC              0x1d1
624 #define KEY_FN_F1               0x1d2
625 #define KEY_FN_F2               0x1d3
626 #define KEY_FN_F3               0x1d4
627 #define KEY_FN_F4               0x1d5
628 #define KEY_FN_F5               0x1d6
629 #define KEY_FN_F6               0x1d7
630 #define KEY_FN_F7               0x1d8
631 #define KEY_FN_F8               0x1d9
632 #define KEY_FN_F9               0x1da
633 #define KEY_FN_F10              0x1db
634 #define KEY_FN_F11              0x1dc
635 #define KEY_FN_F12              0x1dd
636 #define KEY_FN_1                0x1de
637 #define KEY_FN_2                0x1df
638 #define KEY_FN_D                0x1e0
639 #define KEY_FN_E                0x1e1
640 #define KEY_FN_F                0x1e2
641 #define KEY_FN_S                0x1e3
642 #define KEY_FN_B                0x1e4
643
644 #define KEY_BRL_DOT1            0x1f1
645 #define KEY_BRL_DOT2            0x1f2
646 #define KEY_BRL_DOT3            0x1f3
647 #define KEY_BRL_DOT4            0x1f4
648 #define KEY_BRL_DOT5            0x1f5
649 #define KEY_BRL_DOT6            0x1f6
650 #define KEY_BRL_DOT7            0x1f7
651 #define KEY_BRL_DOT8            0x1f8
652 #define KEY_BRL_DOT9            0x1f9
653 #define KEY_BRL_DOT10           0x1fa
654
655 #define KEY_NUMERIC_0           0x200   /* used by phones, remote controls, */
656 #define KEY_NUMERIC_1           0x201   /* and other keypads */
657 #define KEY_NUMERIC_2           0x202
658 #define KEY_NUMERIC_3           0x203
659 #define KEY_NUMERIC_4           0x204
660 #define KEY_NUMERIC_5           0x205
661 #define KEY_NUMERIC_6           0x206
662 #define KEY_NUMERIC_7           0x207
663 #define KEY_NUMERIC_8           0x208
664 #define KEY_NUMERIC_9           0x209
665 #define KEY_NUMERIC_STAR        0x20a
666 #define KEY_NUMERIC_POUND       0x20b
667
668 #define KEY_CAMERA_FOCUS        0x210
669 #define KEY_WPS_BUTTON          0x211   /* WiFi Protected Setup key */
670
671 #define KEY_TOUCHPAD_TOGGLE     0x212   /* Request switch touchpad on or off */
672 #define KEY_TOUCHPAD_ON         0x213
673 #define KEY_TOUCHPAD_OFF        0x214
674
675 #define KEY_CAMERA_ZOOMIN       0x215
676 #define KEY_CAMERA_ZOOMOUT      0x216
677 #define KEY_CAMERA_UP           0x217
678 #define KEY_CAMERA_DOWN         0x218
679 #define KEY_CAMERA_LEFT         0x219
680 #define KEY_CAMERA_RIGHT        0x21a
681
682 #define BTN_TRIGGER_HAPPY               0x2c0
683 #define BTN_TRIGGER_HAPPY1              0x2c0
684 #define BTN_TRIGGER_HAPPY2              0x2c1
685 #define BTN_TRIGGER_HAPPY3              0x2c2
686 #define BTN_TRIGGER_HAPPY4              0x2c3
687 #define BTN_TRIGGER_HAPPY5              0x2c4
688 #define BTN_TRIGGER_HAPPY6              0x2c5
689 #define BTN_TRIGGER_HAPPY7              0x2c6
690 #define BTN_TRIGGER_HAPPY8              0x2c7
691 #define BTN_TRIGGER_HAPPY9              0x2c8
692 #define BTN_TRIGGER_HAPPY10             0x2c9
693 #define BTN_TRIGGER_HAPPY11             0x2ca
694 #define BTN_TRIGGER_HAPPY12             0x2cb
695 #define BTN_TRIGGER_HAPPY13             0x2cc
696 #define BTN_TRIGGER_HAPPY14             0x2cd
697 #define BTN_TRIGGER_HAPPY15             0x2ce
698 #define BTN_TRIGGER_HAPPY16             0x2cf
699 #define BTN_TRIGGER_HAPPY17             0x2d0
700 #define BTN_TRIGGER_HAPPY18             0x2d1
701 #define BTN_TRIGGER_HAPPY19             0x2d2
702 #define BTN_TRIGGER_HAPPY20             0x2d3
703 #define BTN_TRIGGER_HAPPY21             0x2d4
704 #define BTN_TRIGGER_HAPPY22             0x2d5
705 #define BTN_TRIGGER_HAPPY23             0x2d6
706 #define BTN_TRIGGER_HAPPY24             0x2d7
707 #define BTN_TRIGGER_HAPPY25             0x2d8
708 #define BTN_TRIGGER_HAPPY26             0x2d9
709 #define BTN_TRIGGER_HAPPY27             0x2da
710 #define BTN_TRIGGER_HAPPY28             0x2db
711 #define BTN_TRIGGER_HAPPY29             0x2dc
712 #define BTN_TRIGGER_HAPPY30             0x2dd
713 #define BTN_TRIGGER_HAPPY31             0x2de
714 #define BTN_TRIGGER_HAPPY32             0x2df
715 #define BTN_TRIGGER_HAPPY33             0x2e0
716 #define BTN_TRIGGER_HAPPY34             0x2e1
717 #define BTN_TRIGGER_HAPPY35             0x2e2
718 #define BTN_TRIGGER_HAPPY36             0x2e3
719 #define BTN_TRIGGER_HAPPY37             0x2e4
720 #define BTN_TRIGGER_HAPPY38             0x2e5
721 #define BTN_TRIGGER_HAPPY39             0x2e6
722 #define BTN_TRIGGER_HAPPY40             0x2e7
723
724 /* We avoid low common keys in module aliases so they don't get huge. */
725 #define KEY_MIN_INTERESTING     KEY_MUTE
726 #define KEY_MAX                 0x2ff
727 #define KEY_CNT                 (KEY_MAX+1)
728
729 /*
730  * Relative axes
731  */
732
733 #define REL_X                   0x00
734 #define REL_Y                   0x01
735 #define REL_Z                   0x02
736 #define REL_RX                  0x03
737 #define REL_RY                  0x04
738 #define REL_RZ                  0x05
739 #define REL_HWHEEL              0x06
740 #define REL_DIAL                0x07
741 #define REL_WHEEL               0x08
742 #define REL_MISC                0x09
743 #define REL_MAX                 0x0f
744 #define REL_CNT                 (REL_MAX+1)
745
746 /*
747  * Absolute axes
748  */
749
750 #define ABS_X                   0x00
751 #define ABS_Y                   0x01
752 #define ABS_Z                   0x02
753 #define ABS_RX                  0x03
754 #define ABS_RY                  0x04
755 #define ABS_RZ                  0x05
756 #define ABS_THROTTLE            0x06
757 #define ABS_RUDDER              0x07
758 #define ABS_WHEEL               0x08
759 #define ABS_GAS                 0x09
760 #define ABS_BRAKE               0x0a
761 #define ABS_HAT0X               0x10
762 #define ABS_HAT0Y               0x11
763 #define ABS_HAT1X               0x12
764 #define ABS_HAT1Y               0x13
765 #define ABS_HAT2X               0x14
766 #define ABS_HAT2Y               0x15
767 #define ABS_HAT3X               0x16
768 #define ABS_HAT3Y               0x17
769 #define ABS_PRESSURE            0x18
770 #define ABS_DISTANCE            0x19
771 #define ABS_TILT_X              0x1a
772 #define ABS_TILT_Y              0x1b
773 #define ABS_TOOL_WIDTH          0x1c
774
775 #define ABS_VOLUME              0x20
776
777 #define ABS_MISC                0x28
778
779 #define ABS_MT_SLOT             0x2f    /* MT slot being modified */
780 #define ABS_MT_TOUCH_MAJOR      0x30    /* Major axis of touching ellipse */
781 #define ABS_MT_TOUCH_MINOR      0x31    /* Minor axis (omit if circular) */
782 #define ABS_MT_WIDTH_MAJOR      0x32    /* Major axis of approaching ellipse */
783 #define ABS_MT_WIDTH_MINOR      0x33    /* Minor axis (omit if circular) */
784 #define ABS_MT_ORIENTATION      0x34    /* Ellipse orientation */
785 #define ABS_MT_POSITION_X       0x35    /* Center X ellipse position */
786 #define ABS_MT_POSITION_Y       0x36    /* Center Y ellipse position */
787 #define ABS_MT_TOOL_TYPE        0x37    /* Type of touching device */
788 #define ABS_MT_BLOB_ID          0x38    /* Group a set of packets as a blob */
789 #define ABS_MT_TRACKING_ID      0x39    /* Unique ID of initiated contact */
790 #define ABS_MT_PRESSURE         0x3a    /* Pressure on contact area */
791 #define ABS_MT_DISTANCE         0x3b    /* Contact hover distance */
792
793 #ifdef __KERNEL__
794 /* Implementation details, userspace should not care about these */
795 #define ABS_MT_FIRST            ABS_MT_TOUCH_MAJOR
796 #define ABS_MT_LAST             ABS_MT_DISTANCE
797 #endif
798
799 #define ABS_MAX                 0x3f
800 #define ABS_CNT                 (ABS_MAX+1)
801
802 /*
803  * Switch events
804  */
805
806 #define SW_LID                  0x00  /* set = lid shut */
807 #define SW_TABLET_MODE          0x01  /* set = tablet mode */
808 #define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
809 #define SW_RFKILL_ALL           0x03  /* rfkill master switch, type "any"
810                                          set = radio enabled */
811 #define SW_RADIO                SW_RFKILL_ALL   /* deprecated */
812 #define SW_MICROPHONE_INSERT    0x04  /* set = inserted */
813 #define SW_DOCK                 0x05  /* set = plugged into dock */
814 #define SW_LINEOUT_INSERT       0x06  /* set = inserted */
815 #define SW_JACK_PHYSICAL_INSERT 0x07  /* set = mechanical switch set */
816 #define SW_VIDEOOUT_INSERT      0x08  /* set = inserted */
817 #define SW_CAMERA_LENS_COVER    0x09  /* set = lens covered */
818 #define SW_KEYPAD_SLIDE         0x0a  /* set = keypad slide out */
819 #define SW_FRONT_PROXIMITY      0x0b  /* set = front proximity sensor active */
820 #define SW_ROTATE_LOCK          0x0c  /* set = rotate locked/disabled */
821 #define SW_LINEIN_INSERT        0x0d  /* set = inserted */
822 #define SW_MAX                  0x0f
823 #define SW_CNT                  (SW_MAX+1)
824
825 /*
826  * Misc events
827  */
828
829 #define MSC_SERIAL              0x00
830 #define MSC_PULSELED            0x01
831 #define MSC_GESTURE             0x02
832 #define MSC_RAW                 0x03
833 #define MSC_SCAN                0x04
834 #define MSC_MAX                 0x07
835 #define MSC_CNT                 (MSC_MAX+1)
836
837 /*
838  * LEDs
839  */
840
841 #define LED_NUML                0x00
842 #define LED_CAPSL               0x01
843 #define LED_SCROLLL             0x02
844 #define LED_COMPOSE             0x03
845 #define LED_KANA                0x04
846 #define LED_SLEEP               0x05
847 #define LED_SUSPEND             0x06
848 #define LED_MUTE                0x07
849 #define LED_MISC                0x08
850 #define LED_MAIL                0x09
851 #define LED_CHARGING            0x0a
852 #define LED_MAX                 0x0f
853 #define LED_CNT                 (LED_MAX+1)
854
855 /*
856  * Autorepeat values
857  */
858
859 #define REP_DELAY               0x00
860 #define REP_PERIOD              0x01
861 #define REP_MAX                 0x01
862 #define REP_CNT                 (REP_MAX+1)
863
864 /*
865  * Sounds
866  */
867
868 #define SND_CLICK               0x00
869 #define SND_BELL                0x01
870 #define SND_TONE                0x02
871 #define SND_MAX                 0x07
872 #define SND_CNT                 (SND_MAX+1)
873
874 /*
875  * IDs.
876  */
877
878 #define ID_BUS                  0
879 #define ID_VENDOR               1
880 #define ID_PRODUCT              2
881 #define ID_VERSION              3
882
883 #define BUS_PCI                 0x01
884 #define BUS_ISAPNP              0x02
885 #define BUS_USB                 0x03
886 #define BUS_HIL                 0x04
887 #define BUS_BLUETOOTH           0x05
888 #define BUS_VIRTUAL             0x06
889
890 #define BUS_ISA                 0x10
891 #define BUS_I8042               0x11
892 #define BUS_XTKBD               0x12
893 #define BUS_RS232               0x13
894 #define BUS_GAMEPORT            0x14
895 #define BUS_PARPORT             0x15
896 #define BUS_AMIGA               0x16
897 #define BUS_ADB                 0x17
898 #define BUS_I2C                 0x18
899 #define BUS_HOST                0x19
900 #define BUS_GSC                 0x1A
901 #define BUS_ATARI               0x1B
902 #define BUS_SPI                 0x1C
903
904 /*
905  * MT_TOOL types
906  */
907 #define MT_TOOL_FINGER          0
908 #define MT_TOOL_PEN             1
909 #define MT_TOOL_MAX             1
910
911 /*
912  * Values describing the status of a force-feedback effect
913  */
914 #define FF_STATUS_STOPPED       0x00
915 #define FF_STATUS_PLAYING       0x01
916 #define FF_STATUS_MAX           0x01
917
918 /*
919  * Structures used in ioctls to upload effects to a device
920  * They are pieces of a bigger structure (called ff_effect)
921  */
922
923 /*
924  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
925  * should not be used and have unspecified results.
926  */
927
928 /**
929  * struct ff_replay - defines scheduling of the force-feedback effect
930  * @length: duration of the effect
931  * @delay: delay before effect should start playing
932  */
933 struct ff_replay {
934         __u16 length;
935         __u16 delay;
936 };
937
938 /**
939  * struct ff_trigger - defines what triggers the force-feedback effect
940  * @button: number of the button triggering the effect
941  * @interval: controls how soon the effect can be re-triggered
942  */
943 struct ff_trigger {
944         __u16 button;
945         __u16 interval;
946 };
947
948 /**
949  * struct ff_envelope - generic force-feedback effect envelope
950  * @attack_length: duration of the attack (ms)
951  * @attack_level: level at the beginning of the attack
952  * @fade_length: duration of fade (ms)
953  * @fade_level: level at the end of fade
954  *
955  * The @attack_level and @fade_level are absolute values; when applying
956  * envelope force-feedback core will convert to positive/negative
957  * value based on polarity of the default level of the effect.
958  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
959  */
960 struct ff_envelope {
961         __u16 attack_length;
962         __u16 attack_level;
963         __u16 fade_length;
964         __u16 fade_level;
965 };
966
967 /**
968  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
969  * @level: strength of the effect; may be negative
970  * @envelope: envelope data
971  */
972 struct ff_constant_effect {
973         __s16 level;
974         struct ff_envelope envelope;
975 };
976
977 /**
978  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
979  * @start_level: beginning strength of the effect; may be negative
980  * @end_level: final strength of the effect; may be negative
981  * @envelope: envelope data
982  */
983 struct ff_ramp_effect {
984         __s16 start_level;
985         __s16 end_level;
986         struct ff_envelope envelope;
987 };
988
989 /**
990  * struct ff_condition_effect - defines a spring or friction force-feedback effect
991  * @right_saturation: maximum level when joystick moved all way to the right
992  * @left_saturation: same for the left side
993  * @right_coeff: controls how fast the force grows when the joystick moves
994  *      to the right
995  * @left_coeff: same for the left side
996  * @deadband: size of the dead zone, where no force is produced
997  * @center: position of the dead zone
998  */
999 struct ff_condition_effect {
1000         __u16 right_saturation;
1001         __u16 left_saturation;
1002
1003         __s16 right_coeff;
1004         __s16 left_coeff;
1005
1006         __u16 deadband;
1007         __s16 center;
1008 };
1009
1010 /**
1011  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
1012  * @waveform: kind of the effect (wave)
1013  * @period: period of the wave (ms)
1014  * @magnitude: peak value
1015  * @offset: mean value of the wave (roughly)
1016  * @phase: 'horizontal' shift
1017  * @envelope: envelope data
1018  * @custom_len: number of samples (FF_CUSTOM only)
1019  * @custom_data: buffer of samples (FF_CUSTOM only)
1020  *
1021  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
1022  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
1023  * for the time being as no driver supports it yet.
1024  *
1025  * Note: the data pointed by custom_data is copied by the driver.
1026  * You can therefore dispose of the memory after the upload/update.
1027  */
1028 struct ff_periodic_effect {
1029         __u16 waveform;
1030         __u16 period;
1031         __s16 magnitude;
1032         __s16 offset;
1033         __u16 phase;
1034
1035         struct ff_envelope envelope;
1036
1037         __u32 custom_len;
1038         __s16 __user *custom_data;
1039 };
1040
1041 /**
1042  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
1043  * @strong_magnitude: magnitude of the heavy motor
1044  * @weak_magnitude: magnitude of the light one
1045  *
1046  * Some rumble pads have two motors of different weight. Strong_magnitude
1047  * represents the magnitude of the vibration generated by the heavy one.
1048  */
1049 struct ff_rumble_effect {
1050         __u16 strong_magnitude;
1051         __u16 weak_magnitude;
1052 };
1053
1054 /**
1055  * struct ff_effect - defines force feedback effect
1056  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
1057  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
1058  * @id: an unique id assigned to an effect
1059  * @direction: direction of the effect
1060  * @trigger: trigger conditions (struct ff_trigger)
1061  * @replay: scheduling of the effect (struct ff_replay)
1062  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
1063  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
1064  *      defining effect parameters
1065  *
1066  * This structure is sent through ioctl from the application to the driver.
1067  * To create a new effect application should set its @id to -1; the kernel
1068  * will return assigned @id which can later be used to update or delete
1069  * this effect.
1070  *
1071  * Direction of the effect is encoded as follows:
1072  *      0 deg -> 0x0000 (down)
1073  *      90 deg -> 0x4000 (left)
1074  *      180 deg -> 0x8000 (up)
1075  *      270 deg -> 0xC000 (right)
1076  */
1077 struct ff_effect {
1078         __u16 type;
1079         __s16 id;
1080         __u16 direction;
1081         struct ff_trigger trigger;
1082         struct ff_replay replay;
1083
1084         union {
1085                 struct ff_constant_effect constant;
1086                 struct ff_ramp_effect ramp;
1087                 struct ff_periodic_effect periodic;
1088                 struct ff_condition_effect condition[2]; /* One for each axis */
1089                 struct ff_rumble_effect rumble;
1090         } u;
1091 };
1092
1093 /*
1094  * Force feedback effect types
1095  */
1096
1097 #define FF_RUMBLE       0x50
1098 #define FF_PERIODIC     0x51
1099 #define FF_CONSTANT     0x52
1100 #define FF_SPRING       0x53
1101 #define FF_FRICTION     0x54
1102 #define FF_DAMPER       0x55
1103 #define FF_INERTIA      0x56
1104 #define FF_RAMP         0x57
1105
1106 #define FF_EFFECT_MIN   FF_RUMBLE
1107 #define FF_EFFECT_MAX   FF_RAMP
1108
1109 /*
1110  * Force feedback periodic effect types
1111  */
1112
1113 #define FF_SQUARE       0x58
1114 #define FF_TRIANGLE     0x59
1115 #define FF_SINE         0x5a
1116 #define FF_SAW_UP       0x5b
1117 #define FF_SAW_DOWN     0x5c
1118 #define FF_CUSTOM       0x5d
1119
1120 #define FF_WAVEFORM_MIN FF_SQUARE
1121 #define FF_WAVEFORM_MAX FF_CUSTOM
1122
1123 /*
1124  * Set ff device properties
1125  */
1126
1127 #define FF_GAIN         0x60
1128 #define FF_AUTOCENTER   0x61
1129
1130 #define FF_MAX          0x7f
1131 #define FF_CNT          (FF_MAX+1)
1132
1133 #ifdef __KERNEL__
1134
1135 /*
1136  * In-kernel definitions.
1137  */
1138
1139 #include <linux/device.h>
1140 #include <linux/fs.h>
1141 #include <linux/timer.h>
1142 #include <linux/mod_devicetable.h>
1143
1144 /**
1145  * struct input_dev - represents an input device
1146  * @name: name of the device
1147  * @phys: physical path to the device in the system hierarchy
1148  * @uniq: unique identification code for the device (if device has it)
1149  * @id: id of the device (struct input_id)
1150  * @propbit: bitmap of device properties and quirks
1151  * @evbit: bitmap of types of events supported by the device (EV_KEY,
1152  *      EV_REL, etc.)
1153  * @keybit: bitmap of keys/buttons this device has
1154  * @relbit: bitmap of relative axes for the device
1155  * @absbit: bitmap of absolute axes for the device
1156  * @mscbit: bitmap of miscellaneous events supported by the device
1157  * @ledbit: bitmap of leds present on the device
1158  * @sndbit: bitmap of sound effects supported by the device
1159  * @ffbit: bitmap of force feedback effects supported by the device
1160  * @swbit: bitmap of switches present on the device
1161  * @hint_events_per_packet: average number of events generated by the
1162  *      device in a packet (between EV_SYN/SYN_REPORT events). Used by
1163  *      event handlers to estimate size of the buffer needed to hold
1164  *      events.
1165  * @keycodemax: size of keycode table
1166  * @keycodesize: size of elements in keycode table
1167  * @keycode: map of scancodes to keycodes for this device
1168  * @getkeycode: optional legacy method to retrieve current keymap.
1169  * @setkeycode: optional method to alter current keymap, used to implement
1170  *      sparse keymaps. If not supplied default mechanism will be used.
1171  *      The method is being called while holding event_lock and thus must
1172  *      not sleep
1173  * @ff: force feedback structure associated with the device if device
1174  *      supports force feedback effects
1175  * @repeat_key: stores key code of the last key pressed; used to implement
1176  *      software autorepeat
1177  * @timer: timer for software autorepeat
1178  * @rep: current values for autorepeat parameters (delay, rate)
1179  * @mt: pointer to array of struct input_mt_slot holding current values
1180  *      of tracked contacts
1181  * @mtsize: number of MT slots the device uses
1182  * @slot: MT slot currently being transmitted
1183  * @trkid: stores MT tracking ID for the current contact
1184  * @absinfo: array of &struct input_absinfo elements holding information
1185  *      about absolute axes (current value, min, max, flat, fuzz,
1186  *      resolution)
1187  * @key: reflects current state of device's keys/buttons
1188  * @led: reflects current state of device's LEDs
1189  * @snd: reflects current state of sound effects
1190  * @sw: reflects current state of device's switches
1191  * @open: this method is called when the very first user calls
1192  *      input_open_device(). The driver must prepare the device
1193  *      to start generating events (start polling thread,
1194  *      request an IRQ, submit URB, etc.)
1195  * @close: this method is called when the very last user calls
1196  *      input_close_device().
1197  * @flush: purges the device. Most commonly used to get rid of force
1198  *      feedback effects loaded into the device when disconnecting
1199  *      from it
1200  * @event: event handler for events sent _to_ the device, like EV_LED
1201  *      or EV_SND. The device is expected to carry out the requested
1202  *      action (turn on a LED, play sound, etc.) The call is protected
1203  *      by @event_lock and must not sleep
1204  * @grab: input handle that currently has the device grabbed (via
1205  *      EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1206  *      recipient for all input events coming from the device
1207  * @event_lock: this spinlock is is taken when input core receives
1208  *      and processes a new event for the device (in input_event()).
1209  *      Code that accesses and/or modifies parameters of a device
1210  *      (such as keymap or absmin, absmax, absfuzz, etc.) after device
1211  *      has been registered with input core must take this lock.
1212  * @mutex: serializes calls to open(), close() and flush() methods
1213  * @users: stores number of users (input handlers) that opened this
1214  *      device. It is used by input_open_device() and input_close_device()
1215  *      to make sure that dev->open() is only called when the first
1216  *      user opens device and dev->close() is called when the very
1217  *      last user closes the device
1218  * @going_away: marks devices that are in a middle of unregistering and
1219  *      causes input_open_device*() fail with -ENODEV.
1220  * @sync: set to %true when there were no new events since last EV_SYN
1221  * @dev: driver model's view of this device
1222  * @h_list: list of input handles associated with the device. When
1223  *      accessing the list dev->mutex must be held
1224  * @node: used to place the device onto input_dev_list
1225  */
1226 struct input_dev {
1227         const char *name;
1228         const char *phys;
1229         const char *uniq;
1230         struct input_id id;
1231
1232         unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
1233
1234         unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1235         unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1236         unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1237         unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1238         unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1239         unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1240         unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1241         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1242         unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
1243
1244         unsigned int hint_events_per_packet;
1245
1246         unsigned int keycodemax;
1247         unsigned int keycodesize;
1248         void *keycode;
1249
1250         int (*setkeycode)(struct input_dev *dev,
1251                           const struct input_keymap_entry *ke,
1252                           unsigned int *old_keycode);
1253         int (*getkeycode)(struct input_dev *dev,
1254                           struct input_keymap_entry *ke);
1255
1256         struct ff_device *ff;
1257
1258         unsigned int repeat_key;
1259         struct timer_list timer;
1260
1261         int rep[REP_CNT];
1262
1263         struct input_mt_slot *mt;
1264         int mtsize;
1265         int slot;
1266         int trkid;
1267
1268         struct input_absinfo *absinfo;
1269
1270         unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1271         unsigned long led[BITS_TO_LONGS(LED_CNT)];
1272         unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1273         unsigned long sw[BITS_TO_LONGS(SW_CNT)];
1274
1275         int (*open)(struct input_dev *dev);
1276         void (*close)(struct input_dev *dev);
1277         int (*flush)(struct input_dev *dev, struct file *file);
1278         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1279
1280         struct input_handle __rcu *grab;
1281
1282         spinlock_t event_lock;
1283         struct mutex mutex;
1284
1285         unsigned int users;
1286         bool going_away;
1287
1288         bool sync;
1289
1290         struct device dev;
1291
1292         struct list_head        h_list;
1293         struct list_head        node;
1294 };
1295 #define to_input_dev(d) container_of(d, struct input_dev, dev)
1296
1297 /*
1298  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1299  */
1300
1301 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1302 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1303 #endif
1304
1305 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1306 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1307 #endif
1308
1309 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1310 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1311 #endif
1312
1313 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1314 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1315 #endif
1316
1317 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1318 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1319 #endif
1320
1321 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1322 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1323 #endif
1324
1325 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1326 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1327 #endif
1328
1329 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1330 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1331 #endif
1332
1333 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1334 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1335 #endif
1336
1337 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1338 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1339 #endif
1340
1341 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1342         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1343 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1344         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1345
1346 struct input_handle;
1347
1348 /**
1349  * struct input_handler - implements one of interfaces for input devices
1350  * @private: driver-specific data
1351  * @event: event handler. This method is being called by input core with
1352  *      interrupts disabled and dev->event_lock spinlock held and so
1353  *      it may not sleep
1354  * @filter: similar to @event; separates normal event handlers from
1355  *      "filters".
1356  * @match: called after comparing device's id with handler's id_table
1357  *      to perform fine-grained matching between device and handler
1358  * @connect: called when attaching a handler to an input device
1359  * @disconnect: disconnects a handler from input device
1360  * @start: starts handler for given handle. This function is called by
1361  *      input core right after connect() method and also when a process
1362  *      that "grabbed" a device releases it
1363  * @fops: file operations this driver implements
1364  * @minor: beginning of range of 32 minors for devices this driver
1365  *      can provide
1366  * @name: name of the handler, to be shown in /proc/bus/input/handlers
1367  * @id_table: pointer to a table of input_device_ids this driver can
1368  *      handle
1369  * @h_list: list of input handles associated with the handler
1370  * @node: for placing the driver onto input_handler_list
1371  *
1372  * Input handlers attach to input devices and create input handles. There
1373  * are likely several handlers attached to any given input device at the
1374  * same time. All of them will get their copy of input event generated by
1375  * the device.
1376  *
1377  * The very same structure is used to implement input filters. Input core
1378  * allows filters to run first and will not pass event to regular handlers
1379  * if any of the filters indicate that the event should be filtered (by
1380  * returning %true from their filter() method).
1381  *
1382  * Note that input core serializes calls to connect() and disconnect()
1383  * methods.
1384  */
1385 struct input_handler {
1386
1387         void *private;
1388
1389         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1390         bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1391         bool (*match)(struct input_handler *handler, struct input_dev *dev);
1392         int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1393         void (*disconnect)(struct input_handle *handle);
1394         void (*start)(struct input_handle *handle);
1395
1396         const struct file_operations *fops;
1397         int minor;
1398         const char *name;
1399
1400         const struct input_device_id *id_table;
1401
1402         struct list_head        h_list;
1403         struct list_head        node;
1404 };
1405
1406 /**
1407  * struct input_handle - links input device with an input handler
1408  * @private: handler-specific data
1409  * @open: counter showing whether the handle is 'open', i.e. should deliver
1410  *      events from its device
1411  * @name: name given to the handle by handler that created it
1412  * @dev: input device the handle is attached to
1413  * @handler: handler that works with the device through this handle
1414  * @d_node: used to put the handle on device's list of attached handles
1415  * @h_node: used to put the handle on handler's list of handles from which
1416  *      it gets events
1417  */
1418 struct input_handle {
1419
1420         void *private;
1421
1422         int open;
1423         const char *name;
1424
1425         struct input_dev *dev;
1426         struct input_handler *handler;
1427
1428         struct list_head        d_node;
1429         struct list_head        h_node;
1430 };
1431
1432 struct input_dev *input_allocate_device(void);
1433 void input_free_device(struct input_dev *dev);
1434
1435 static inline struct input_dev *input_get_device(struct input_dev *dev)
1436 {
1437         return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1438 }
1439
1440 static inline void input_put_device(struct input_dev *dev)
1441 {
1442         if (dev)
1443                 put_device(&dev->dev);
1444 }
1445
1446 static inline void *input_get_drvdata(struct input_dev *dev)
1447 {
1448         return dev_get_drvdata(&dev->dev);
1449 }
1450
1451 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1452 {
1453         dev_set_drvdata(&dev->dev, data);
1454 }
1455
1456 int __must_check input_register_device(struct input_dev *);
1457 void input_unregister_device(struct input_dev *);
1458
1459 void input_reset_device(struct input_dev *);
1460
1461 int __must_check input_register_handler(struct input_handler *);
1462 void input_unregister_handler(struct input_handler *);
1463
1464 int input_handler_for_each_handle(struct input_handler *, void *data,
1465                                   int (*fn)(struct input_handle *, void *));
1466
1467 int input_register_handle(struct input_handle *);
1468 void input_unregister_handle(struct input_handle *);
1469
1470 int input_grab_device(struct input_handle *);
1471 void input_release_device(struct input_handle *);
1472
1473 int input_open_device(struct input_handle *);
1474 void input_close_device(struct input_handle *);
1475
1476 int input_flush_device(struct input_handle *handle, struct file *file);
1477
1478 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1479 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1480
1481 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1482 {
1483         input_event(dev, EV_KEY, code, !!value);
1484 }
1485
1486 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1487 {
1488         input_event(dev, EV_REL, code, value);
1489 }
1490
1491 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1492 {
1493         input_event(dev, EV_ABS, code, value);
1494 }
1495
1496 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1497 {
1498         input_event(dev, EV_FF_STATUS, code, value);
1499 }
1500
1501 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1502 {
1503         input_event(dev, EV_SW, code, !!value);
1504 }
1505
1506 static inline void input_sync(struct input_dev *dev)
1507 {
1508         input_event(dev, EV_SYN, SYN_REPORT, 0);
1509 }
1510
1511 static inline void input_mt_sync(struct input_dev *dev)
1512 {
1513         input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
1514 }
1515
1516 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1517
1518 /**
1519  * input_set_events_per_packet - tell handlers about the driver event rate
1520  * @dev: the input device used by the driver
1521  * @n_events: the average number of events between calls to input_sync()
1522  *
1523  * If the event rate sent from a device is unusually large, use this
1524  * function to set the expected event rate. This will allow handlers
1525  * to set up an appropriate buffer size for the event stream, in order
1526  * to minimize information loss.
1527  */
1528 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
1529 {
1530         dev->hint_events_per_packet = n_events;
1531 }
1532
1533 void input_alloc_absinfo(struct input_dev *dev);
1534 void input_set_abs_params(struct input_dev *dev, unsigned int axis,
1535                           int min, int max, int fuzz, int flat);
1536
1537 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item)                    \
1538 static inline int input_abs_get_##_suffix(struct input_dev *dev,        \
1539                                           unsigned int axis)            \
1540 {                                                                       \
1541         return dev->absinfo ? dev->absinfo[axis]._item : 0;             \
1542 }                                                                       \
1543                                                                         \
1544 static inline void input_abs_set_##_suffix(struct input_dev *dev,       \
1545                                            unsigned int axis, int val)  \
1546 {                                                                       \
1547         input_alloc_absinfo(dev);                                       \
1548         if (dev->absinfo)                                               \
1549                 dev->absinfo[axis]._item = val;                         \
1550 }
1551
1552 INPUT_GENERATE_ABS_ACCESSORS(val, value)
1553 INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
1554 INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
1555 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
1556 INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
1557 INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
1558
1559 int input_scancode_to_scalar(const struct input_keymap_entry *ke,
1560                              unsigned int *scancode);
1561
1562 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
1563 int input_set_keycode(struct input_dev *dev,
1564                       const struct input_keymap_entry *ke);
1565
1566 extern struct class input_class;
1567
1568 /**
1569  * struct ff_device - force-feedback part of an input device
1570  * @upload: Called to upload an new effect into device
1571  * @erase: Called to erase an effect from device
1572  * @playback: Called to request device to start playing specified effect
1573  * @set_gain: Called to set specified gain
1574  * @set_autocenter: Called to auto-center device
1575  * @destroy: called by input core when parent input device is being
1576  *      destroyed
1577  * @private: driver-specific data, will be freed automatically
1578  * @ffbit: bitmap of force feedback capabilities truly supported by
1579  *      device (not emulated like ones in input_dev->ffbit)
1580  * @mutex: mutex for serializing access to the device
1581  * @max_effects: maximum number of effects supported by device
1582  * @effects: pointer to an array of effects currently loaded into device
1583  * @effect_owners: array of effect owners; when file handle owning
1584  *      an effect gets closed the effect is automatically erased
1585  *
1586  * Every force-feedback device must implement upload() and playback()
1587  * methods; erase() is optional. set_gain() and set_autocenter() need
1588  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1589  * bits.
1590  *
1591  * Note that playback(), set_gain() and set_autocenter() are called with
1592  * dev->event_lock spinlock held and interrupts off and thus may not
1593  * sleep.
1594  */
1595 struct ff_device {
1596         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1597                       struct ff_effect *old);
1598         int (*erase)(struct input_dev *dev, int effect_id);
1599
1600         int (*playback)(struct input_dev *dev, int effect_id, int value);
1601         void (*set_gain)(struct input_dev *dev, u16 gain);
1602         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1603
1604         void (*destroy)(struct ff_device *);
1605
1606         void *private;
1607
1608         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1609
1610         struct mutex mutex;
1611
1612         int max_effects;
1613         struct ff_effect *effects;
1614         struct file *effect_owners[];
1615 };
1616
1617 int input_ff_create(struct input_dev *dev, unsigned int max_effects);
1618 void input_ff_destroy(struct input_dev *dev);
1619
1620 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1621
1622 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1623 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1624
1625 int input_ff_create_memless(struct input_dev *dev, void *data,
1626                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1627
1628 #endif
1629 #endif