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