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