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