blob: 77fc25365a35d0aa4df4511564978792d6480f2e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
David Woodhouse7b1c6ca2006-06-01 12:49:30 +010018#include <sys/types.h>
Jaswinder Singh Rajput00bfdda2009-01-15 13:51:26 -080019#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#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
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -070037#define EV_VERSION 0x010001
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39/*
40 * IOCTLs (0x00 - 0x7f)
41 */
42
43struct input_id {
44 __u16 bustype;
45 __u16 vendor;
46 __u16 product;
47 __u16 version;
48};
49
Dmitry Torokhov86b17f72010-11-29 23:33:04 -080050/**
51 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
52 * @value: latest reported value for the axis.
53 * @minimum: specifies minimum value for the axis.
54 * @maximum: specifies maximum value for the axis.
55 * @fuzz: specifies fuzz value that is used to filter noise from
56 * the event stream.
57 * @flat: values that are within this value will be discarded by
58 * joydev interface and reported as 0 instead.
59 * @resolution: specifies resolution for the values reported for
60 * the axis.
61 *
62 * Note that input core does not clamp reported values to the
63 * [minimum, maximum] limits, such task is left to userspace.
64 *
65 * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
66 * units per millimeter (units/mm), resolution for rotational axes
67 * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
68 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069struct input_absinfo {
70 __s32 value;
71 __s32 minimum;
72 __s32 maximum;
73 __s32 fuzz;
74 __s32 flat;
Tero Saarniec20a022009-06-10 23:27:24 -070075 __s32 resolution;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076};
77
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -070078/**
79 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
80 * @scancode: scancode represented in machine-endian form.
81 * @len: length of the scancode that resides in @scancode buffer.
82 * @index: index in the keymap, may be used instead of scancode
83 * @flags: allows to specify how kernel should handle the request. For
84 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
85 * should perform lookup in keymap by @index instead of @scancode
86 * @keycode: key code assigned to this scancode
87 *
88 * The structure is used to retrieve and modify keymap data. Users have
89 * option of performing lookup either by @scancode itself or by @index
90 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
91 * (depending on which element was used to perform lookup).
92 */
93struct input_keymap_entry {
94#define INPUT_KEYMAP_BY_INDEX (1 << 0)
95 __u8 flags;
96 __u8 len;
97 __u16 index;
98 __u32 keycode;
99 __u8 scancode[32];
100};
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
103#define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
Dmitry Torokhov58b93992010-03-08 22:37:10 -0800104#define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
105#define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -0700106
Dmitry Torokhovab4e0192010-12-14 23:53:21 -0800107#define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
108#define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
109#define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
110#define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112#define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
113#define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
114#define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
Henrik Rydberg85b77202010-12-18 20:51:13 +0100115#define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Henrik Rydberg1cf0c6e2012-02-06 08:49:25 +0100117/**
118 * EVIOCGMTSLOTS(len) - get MT slot values
119 *
120 * The ioctl buffer argument should be binary equivalent to
121 *
122 * struct input_mt_request_layout {
123 * __u32 code;
124 * __s32 values[num_slots];
125 * };
126 *
127 * where num_slots is the (arbitrary) number of MT slots to extract.
128 *
129 * The ioctl size argument (len) is the size of the buffer, which
130 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is
131 * too small to fit all available slots, the first num_slots are
132 * returned.
133 *
134 * Before the call, code is set to the wanted ABS_MT event type. On
135 * return, values[] is filled with the slot values for the specified
136 * ABS_MT code.
137 *
138 * If the request code is not an ABS_MT value, -EINVAL is returned.
139 */
140#define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
141
Dmitry Torokhov144c0f82010-09-03 10:31:05 -0700142#define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
144#define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
Richard Purdie31581062005-09-06 15:19:06 -0700145#define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Simon Budig7bed4b22011-07-04 19:56:01 -0700147#define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
148#define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
149#define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151#define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */
152#define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
153#define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
154
155#define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
156
Arve Hjønnevåg783820b2008-10-17 15:20:55 -0700157#define EVIOCGSUSPENDBLOCK _IOR('E', 0x91, int) /* get suspend block enable */
158#define EVIOCSSUSPENDBLOCK _IOW('E', 0x91, int) /* set suspend block enable */
159
John Stultza80b83b2012-02-03 00:19:07 -0800160#define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/*
Henrik Rydberg85b77202010-12-18 20:51:13 +0100163 * Device properties and quirks
164 */
165
166#define INPUT_PROP_POINTER 0x00 /* needs a pointer */
167#define INPUT_PROP_DIRECT 0x01 /* direct input devices */
168#define INPUT_PROP_BUTTONPAD 0x02 /* has button(s) under pad */
169#define INPUT_PROP_SEMI_MT 0x03 /* touch rectangle only */
Kun Liang017fcfa2013-12-11 11:03:44 +0800170#define INPUT_PROP_NO_DUMMY_RELEASE 0x04 /* no dummy event */
Henrik Rydberg85b77202010-12-18 20:51:13 +0100171
172#define INPUT_PROP_MAX 0x1f
173#define INPUT_PROP_CNT (INPUT_PROP_MAX + 1)
174
175/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 * Event types
177 */
178
179#define EV_SYN 0x00
180#define EV_KEY 0x01
181#define EV_REL 0x02
182#define EV_ABS 0x03
183#define EV_MSC 0x04
Richard Purdie31581062005-09-06 15:19:06 -0700184#define EV_SW 0x05
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185#define EV_LED 0x11
186#define EV_SND 0x12
187#define EV_REP 0x14
188#define EV_FF 0x15
189#define EV_PWR 0x16
190#define EV_FF_STATUS 0x17
191#define EV_MAX 0x1f
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700192#define EV_CNT (EV_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194/*
195 * Synchronization events.
196 */
197
198#define SYN_REPORT 0
199#define SYN_CONFIG 1
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700200#define SYN_MT_REPORT 2
Jeff Brown9fb0f142011-04-12 23:29:38 -0700201#define SYN_DROPPED 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203/*
204 * Keys and buttons
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400205 *
206 * Most of the keys/buttons are modeled after USB HUT 1.12
207 * (see http://www.usb.org/developers/hidpage).
208 * Abbreviations in the comments:
209 * AC - Application Control
210 * AL - Application Launch Button
211 * SC - System Control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 */
213
214#define KEY_RESERVED 0
215#define KEY_ESC 1
216#define KEY_1 2
217#define KEY_2 3
218#define KEY_3 4
219#define KEY_4 5
220#define KEY_5 6
221#define KEY_6 7
222#define KEY_7 8
223#define KEY_8 9
224#define KEY_9 10
225#define KEY_0 11
226#define KEY_MINUS 12
227#define KEY_EQUAL 13
228#define KEY_BACKSPACE 14
229#define KEY_TAB 15
230#define KEY_Q 16
231#define KEY_W 17
232#define KEY_E 18
233#define KEY_R 19
234#define KEY_T 20
235#define KEY_Y 21
236#define KEY_U 22
237#define KEY_I 23
238#define KEY_O 24
239#define KEY_P 25
240#define KEY_LEFTBRACE 26
241#define KEY_RIGHTBRACE 27
242#define KEY_ENTER 28
243#define KEY_LEFTCTRL 29
244#define KEY_A 30
245#define KEY_S 31
246#define KEY_D 32
247#define KEY_F 33
248#define KEY_G 34
249#define KEY_H 35
250#define KEY_J 36
251#define KEY_K 37
252#define KEY_L 38
253#define KEY_SEMICOLON 39
254#define KEY_APOSTROPHE 40
255#define KEY_GRAVE 41
256#define KEY_LEFTSHIFT 42
257#define KEY_BACKSLASH 43
258#define KEY_Z 44
259#define KEY_X 45
260#define KEY_C 46
261#define KEY_V 47
262#define KEY_B 48
263#define KEY_N 49
264#define KEY_M 50
265#define KEY_COMMA 51
266#define KEY_DOT 52
267#define KEY_SLASH 53
268#define KEY_RIGHTSHIFT 54
269#define KEY_KPASTERISK 55
270#define KEY_LEFTALT 56
271#define KEY_SPACE 57
272#define KEY_CAPSLOCK 58
273#define KEY_F1 59
274#define KEY_F2 60
275#define KEY_F3 61
276#define KEY_F4 62
277#define KEY_F5 63
278#define KEY_F6 64
279#define KEY_F7 65
280#define KEY_F8 66
281#define KEY_F9 67
282#define KEY_F10 68
283#define KEY_NUMLOCK 69
284#define KEY_SCROLLLOCK 70
285#define KEY_KP7 71
286#define KEY_KP8 72
287#define KEY_KP9 73
288#define KEY_KPMINUS 74
289#define KEY_KP4 75
290#define KEY_KP5 76
291#define KEY_KP6 77
292#define KEY_KPPLUS 78
293#define KEY_KP1 79
294#define KEY_KP2 80
295#define KEY_KP3 81
296#define KEY_KP0 82
297#define KEY_KPDOT 83
298
299#define KEY_ZENKAKUHANKAKU 85
300#define KEY_102ND 86
301#define KEY_F11 87
302#define KEY_F12 88
303#define KEY_RO 89
304#define KEY_KATAKANA 90
305#define KEY_HIRAGANA 91
306#define KEY_HENKAN 92
307#define KEY_KATAKANAHIRAGANA 93
308#define KEY_MUHENKAN 94
309#define KEY_KPJPCOMMA 95
310#define KEY_KPENTER 96
311#define KEY_RIGHTCTRL 97
312#define KEY_KPSLASH 98
313#define KEY_SYSRQ 99
314#define KEY_RIGHTALT 100
315#define KEY_LINEFEED 101
316#define KEY_HOME 102
317#define KEY_UP 103
318#define KEY_PAGEUP 104
319#define KEY_LEFT 105
320#define KEY_RIGHT 106
321#define KEY_END 107
322#define KEY_DOWN 108
323#define KEY_PAGEDOWN 109
324#define KEY_INSERT 110
325#define KEY_DELETE 111
326#define KEY_MACRO 112
327#define KEY_MUTE 113
328#define KEY_VOLUMEDOWN 114
329#define KEY_VOLUMEUP 115
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400330#define KEY_POWER 116 /* SC System Power Down */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#define KEY_KPEQUAL 117
332#define KEY_KPPLUSMINUS 118
333#define KEY_PAUSE 119
Henrik Rydberg437184a2008-11-04 13:31:38 +0100334#define KEY_SCALE 120 /* AL Compiz Scale (Expose) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336#define KEY_KPCOMMA 121
Jerome Pinotb9ab58d2006-06-26 01:51:23 -0400337#define KEY_HANGEUL 122
338#define KEY_HANGUEL KEY_HANGEUL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#define KEY_HANJA 123
340#define KEY_YEN 124
341#define KEY_LEFTMETA 125
342#define KEY_RIGHTMETA 126
343#define KEY_COMPOSE 127
344
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400345#define KEY_STOP 128 /* AC Stop */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346#define KEY_AGAIN 129
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400347#define KEY_PROPS 130 /* AC Properties */
348#define KEY_UNDO 131 /* AC Undo */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define KEY_FRONT 132
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400350#define KEY_COPY 133 /* AC Copy */
351#define KEY_OPEN 134 /* AC Open */
352#define KEY_PASTE 135 /* AC Paste */
353#define KEY_FIND 136 /* AC Search */
354#define KEY_CUT 137 /* AC Cut */
355#define KEY_HELP 138 /* AL Integrated Help Center */
356#define KEY_MENU 139 /* Menu (show menu) */
357#define KEY_CALC 140 /* AL Calculator */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358#define KEY_SETUP 141
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400359#define KEY_SLEEP 142 /* SC System Sleep */
360#define KEY_WAKEUP 143 /* System Wake Up */
361#define KEY_FILE 144 /* AL Local Machine Browser */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362#define KEY_SENDFILE 145
363#define KEY_DELETEFILE 146
364#define KEY_XFER 147
365#define KEY_PROG1 148
366#define KEY_PROG2 149
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400367#define KEY_WWW 150 /* AL Internet Browser */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368#define KEY_MSDOS 151
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400369#define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */
370#define KEY_SCREENLOCK KEY_COFFEE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#define KEY_DIRECTION 153
372#define KEY_CYCLEWINDOWS 154
373#define KEY_MAIL 155
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400374#define KEY_BOOKMARKS 156 /* AC Bookmarks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375#define KEY_COMPUTER 157
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400376#define KEY_BACK 158 /* AC Back */
377#define KEY_FORWARD 159 /* AC Forward */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378#define KEY_CLOSECD 160
379#define KEY_EJECTCD 161
380#define KEY_EJECTCLOSECD 162
381#define KEY_NEXTSONG 163
382#define KEY_PLAYPAUSE 164
383#define KEY_PREVIOUSSONG 165
384#define KEY_STOPCD 166
385#define KEY_RECORD 167
386#define KEY_REWIND 168
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400387#define KEY_PHONE 169 /* Media Select Telephone */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388#define KEY_ISO 170
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400389#define KEY_CONFIG 171 /* AL Consumer Control Configuration */
390#define KEY_HOMEPAGE 172 /* AC Home */
391#define KEY_REFRESH 173 /* AC Refresh */
392#define KEY_EXIT 174 /* AC Exit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393#define KEY_MOVE 175
394#define KEY_EDIT 176
395#define KEY_SCROLLUP 177
396#define KEY_SCROLLDOWN 178
397#define KEY_KPLEFTPAREN 179
398#define KEY_KPRIGHTPAREN 180
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400399#define KEY_NEW 181 /* AC New */
400#define KEY_REDO 182 /* AC Redo/Repeat */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402#define KEY_F13 183
403#define KEY_F14 184
404#define KEY_F15 185
405#define KEY_F16 186
406#define KEY_F17 187
407#define KEY_F18 188
408#define KEY_F19 189
409#define KEY_F20 190
410#define KEY_F21 191
411#define KEY_F22 192
412#define KEY_F23 193
413#define KEY_F24 194
414
415#define KEY_PLAYCD 200
416#define KEY_PAUSECD 201
417#define KEY_PROG3 202
418#define KEY_PROG4 203
Henrik Rydberg437184a2008-11-04 13:31:38 +0100419#define KEY_DASHBOARD 204 /* AL Dashboard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#define KEY_SUSPEND 205
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400421#define KEY_CLOSE 206 /* AC Close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422#define KEY_PLAY 207
423#define KEY_FASTFORWARD 208
424#define KEY_BASSBOOST 209
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400425#define KEY_PRINT 210 /* AC Print */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426#define KEY_HP 211
427#define KEY_CAMERA 212
428#define KEY_SOUND 213
429#define KEY_QUESTION 214
430#define KEY_EMAIL 215
431#define KEY_CHAT 216
432#define KEY_SEARCH 217
433#define KEY_CONNECT 218
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400434#define KEY_FINANCE 219 /* AL Checkbook/Finance */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435#define KEY_SPORT 220
436#define KEY_SHOP 221
437#define KEY_ALTERASE 222
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400438#define KEY_CANCEL 223 /* AC Cancel */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439#define KEY_BRIGHTNESSDOWN 224
440#define KEY_BRIGHTNESSUP 225
441#define KEY_MEDIA 226
442
Dmitry Torokhov55178532007-07-18 00:38:45 -0400443#define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video
444 outputs (Monitor/LCD/TV-out/etc) */
Andreas Jaggi146a4b32005-05-01 08:58:41 -0700445#define KEY_KBDILLUMTOGGLE 228
446#define KEY_KBDILLUMDOWN 229
447#define KEY_KBDILLUMUP 230
448
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400449#define KEY_SEND 231 /* AC Send */
450#define KEY_REPLY 232 /* AC Reply */
451#define KEY_FORWARDMAIL 233 /* AC Forward Msg */
452#define KEY_SAVE 234 /* AC Save */
Vojtech Pavlik8a409b02005-09-05 00:08:08 -0500453#define KEY_DOCUMENTS 235
454
Matthew Garrettf39b25b2006-05-29 23:27:39 -0400455#define KEY_BATTERY 236
456
Lennart Poettering90da1152006-09-19 01:59:55 -0400457#define KEY_BLUETOOTH 237
458#define KEY_WLAN 238
Ivo van Doorne0665482007-09-13 09:21:31 +0200459#define KEY_UWB 239
Lennart Poettering90da1152006-09-19 01:59:55 -0400460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461#define KEY_UNKNOWN 240
462
Yu Luminga7ecd1e2007-08-23 23:05:55 -0400463#define KEY_VIDEO_NEXT 241 /* drive next video source */
464#define KEY_VIDEO_PREV 242 /* drive previous video source */
465#define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */
466#define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */
467#define KEY_DISPLAY_OFF 245 /* display device to off state */
468
Iñaky Pérez-González303d9bf2008-01-23 13:40:27 -0800469#define KEY_WIMAX 246
Matthew Garrett3b77fd82010-02-17 12:21:45 -0800470#define KEY_RFKILL 247 /* Key that controls all radios */
Iñaky Pérez-González303d9bf2008-01-23 13:40:27 -0800471
Andy Lutomirski33009552011-05-24 15:16:43 -0400472#define KEY_MICMUTE 248 /* Mute / unmute the microphone */
473
Dmitry Torokhov4b708582010-02-26 00:22:04 -0800474/* Code 255 is reserved for special needs of AT keyboard driver */
Dmitry Torokhovf6d65612008-06-02 00:39:45 -0400475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#define BTN_MISC 0x100
477#define BTN_0 0x100
478#define BTN_1 0x101
479#define BTN_2 0x102
480#define BTN_3 0x103
481#define BTN_4 0x104
482#define BTN_5 0x105
483#define BTN_6 0x106
484#define BTN_7 0x107
485#define BTN_8 0x108
486#define BTN_9 0x109
487
488#define BTN_MOUSE 0x110
489#define BTN_LEFT 0x110
490#define BTN_RIGHT 0x111
491#define BTN_MIDDLE 0x112
492#define BTN_SIDE 0x113
493#define BTN_EXTRA 0x114
494#define BTN_FORWARD 0x115
495#define BTN_BACK 0x116
496#define BTN_TASK 0x117
497
498#define BTN_JOYSTICK 0x120
499#define BTN_TRIGGER 0x120
500#define BTN_THUMB 0x121
501#define BTN_THUMB2 0x122
502#define BTN_TOP 0x123
503#define BTN_TOP2 0x124
504#define BTN_PINKIE 0x125
505#define BTN_BASE 0x126
506#define BTN_BASE2 0x127
507#define BTN_BASE3 0x128
508#define BTN_BASE4 0x129
509#define BTN_BASE5 0x12a
510#define BTN_BASE6 0x12b
511#define BTN_DEAD 0x12f
512
513#define BTN_GAMEPAD 0x130
514#define BTN_A 0x130
515#define BTN_B 0x131
516#define BTN_C 0x132
517#define BTN_X 0x133
518#define BTN_Y 0x134
519#define BTN_Z 0x135
520#define BTN_TL 0x136
521#define BTN_TR 0x137
522#define BTN_TL2 0x138
523#define BTN_TR2 0x139
524#define BTN_SELECT 0x13a
525#define BTN_START 0x13b
526#define BTN_MODE 0x13c
527#define BTN_THUMBL 0x13d
528#define BTN_THUMBR 0x13e
529
530#define BTN_DIGI 0x140
531#define BTN_TOOL_PEN 0x140
532#define BTN_TOOL_RUBBER 0x141
533#define BTN_TOOL_BRUSH 0x142
534#define BTN_TOOL_PENCIL 0x143
535#define BTN_TOOL_AIRBRUSH 0x144
536#define BTN_TOOL_FINGER 0x145
537#define BTN_TOOL_MOUSE 0x146
538#define BTN_TOOL_LENS 0x147
Daniel Kurtzd5051272011-08-23 23:02:48 -0700539#define BTN_TOOL_QUINTTAP 0x148 /* Five fingers on trackpad */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540#define BTN_TOUCH 0x14a
541#define BTN_STYLUS 0x14b
542#define BTN_STYLUS2 0x14c
543#define BTN_TOOL_DOUBLETAP 0x14d
544#define BTN_TOOL_TRIPLETAP 0x14e
Henrik Rydberg6916d972009-04-27 11:52:43 -0700545#define BTN_TOOL_QUADTAP 0x14f /* Four fingers on trackpad */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547#define BTN_WHEEL 0x150
548#define BTN_GEAR_DOWN 0x150
549#define BTN_GEAR_UP 0x151
550
551#define KEY_OK 0x160
Dmitry Torokhov493a7e02006-03-14 00:09:05 -0500552#define KEY_SELECT 0x161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#define KEY_GOTO 0x162
554#define KEY_CLEAR 0x163
555#define KEY_POWER2 0x164
556#define KEY_OPTION 0x165
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400557#define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558#define KEY_TIME 0x167
559#define KEY_VENDOR 0x168
560#define KEY_ARCHIVE 0x169
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400561#define KEY_PROGRAM 0x16a /* Media Select Program Guide */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562#define KEY_CHANNEL 0x16b
563#define KEY_FAVORITES 0x16c
564#define KEY_EPG 0x16d
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400565#define KEY_PVR 0x16e /* Media Select Home */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566#define KEY_MHP 0x16f
567#define KEY_LANGUAGE 0x170
568#define KEY_TITLE 0x171
569#define KEY_SUBTITLE 0x172
570#define KEY_ANGLE 0x173
571#define KEY_ZOOM 0x174
572#define KEY_MODE 0x175
573#define KEY_KEYBOARD 0x176
574#define KEY_SCREEN 0x177
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400575#define KEY_PC 0x178 /* Media Select Computer */
576#define KEY_TV 0x179 /* Media Select TV */
577#define KEY_TV2 0x17a /* Media Select Cable */
578#define KEY_VCR 0x17b /* Media Select VCR */
579#define KEY_VCR2 0x17c /* VCR Plus */
580#define KEY_SAT 0x17d /* Media Select Satellite */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581#define KEY_SAT2 0x17e
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400582#define KEY_CD 0x17f /* Media Select CD */
583#define KEY_TAPE 0x180 /* Media Select Tape */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#define KEY_RADIO 0x181
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400585#define KEY_TUNER 0x182 /* Media Select Tuner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586#define KEY_PLAYER 0x183
587#define KEY_TEXT 0x184
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400588#define KEY_DVD 0x185 /* Media Select DVD */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589#define KEY_AUX 0x186
590#define KEY_MP3 0x187
Jarod Wilsonba6a0782011-04-12 23:13:08 -0700591#define KEY_AUDIO 0x188 /* AL Audio Browser */
592#define KEY_VIDEO 0x189 /* AL Movie Browser */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#define KEY_DIRECTORY 0x18a
594#define KEY_LIST 0x18b
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400595#define KEY_MEMO 0x18c /* Media Select Messages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596#define KEY_CALENDAR 0x18d
597#define KEY_RED 0x18e
598#define KEY_GREEN 0x18f
599#define KEY_YELLOW 0x190
600#define KEY_BLUE 0x191
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400601#define KEY_CHANNELUP 0x192 /* Channel Increment */
602#define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603#define KEY_FIRST 0x194
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400604#define KEY_LAST 0x195 /* Recall Last */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605#define KEY_AB 0x196
606#define KEY_NEXT 0x197
607#define KEY_RESTART 0x198
608#define KEY_SLOW 0x199
609#define KEY_SHUFFLE 0x19a
610#define KEY_BREAK 0x19b
611#define KEY_PREVIOUS 0x19c
612#define KEY_DIGITS 0x19d
613#define KEY_TEEN 0x19e
614#define KEY_TWEN 0x19f
Dmitry Torokhov4e4eda82007-06-29 01:10:54 -0400615#define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
616#define KEY_GAMES 0x1a1 /* Media Select Games */
617#define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
618#define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
619#define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
620#define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
621#define KEY_EDITOR 0x1a6 /* AL Text Editor */
622#define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
623#define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
624#define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
625#define KEY_DATABASE 0x1aa /* AL Database App */
626#define KEY_NEWS 0x1ab /* AL Newsreader */
627#define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
628#define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
629#define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
Eric Piel6480e2a2007-04-12 01:32:34 -0400630#define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
Jiri Kosina4dc21a82007-08-08 17:19:08 +0200631#define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */
Khelben Blackstaffe2bca072007-10-04 10:32:03 +0200632#define KEY_LOGOFF 0x1b1 /* AL Logoff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Carlos Corbachof7852be2007-10-27 23:42:32 -0400634#define KEY_DOLLAR 0x1b2
635#define KEY_EURO 0x1b3
636
Aristeu Rozanskic23f1f92007-11-27 00:46:57 -0500637#define KEY_FRAMEBACK 0x1b4 /* Consumer - transport controls */
638#define KEY_FRAMEFORWARD 0x1b5
Aristeu Rozanski35baef22007-11-27 00:47:04 -0500639#define KEY_CONTEXT_MENU 0x1b6 /* GenDesc - system context menu */
Bastien Nocera4bbff7e2008-06-26 09:13:48 -0400640#define KEY_MEDIA_REPEAT 0x1b7 /* Consumer - transport control */
Jarod Wilsonba6a0782011-04-12 23:13:08 -0700641#define KEY_10CHANNELSUP 0x1b8 /* 10 channels up (10+) */
642#define KEY_10CHANNELSDOWN 0x1b9 /* 10 channels down (10-) */
643#define KEY_IMAGES 0x1ba /* AL Image Browser */
Aristeu Rozanski35baef22007-11-27 00:47:04 -0500644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645#define KEY_DEL_EOL 0x1c0
646#define KEY_DEL_EOS 0x1c1
647#define KEY_INS_LINE 0x1c2
648#define KEY_DEL_LINE 0x1c3
649
650#define KEY_FN 0x1d0
651#define KEY_FN_ESC 0x1d1
652#define KEY_FN_F1 0x1d2
653#define KEY_FN_F2 0x1d3
654#define KEY_FN_F3 0x1d4
655#define KEY_FN_F4 0x1d5
656#define KEY_FN_F5 0x1d6
657#define KEY_FN_F6 0x1d7
658#define KEY_FN_F7 0x1d8
659#define KEY_FN_F8 0x1d9
660#define KEY_FN_F9 0x1da
661#define KEY_FN_F10 0x1db
662#define KEY_FN_F11 0x1dc
663#define KEY_FN_F12 0x1dd
664#define KEY_FN_1 0x1de
665#define KEY_FN_2 0x1df
666#define KEY_FN_D 0x1e0
667#define KEY_FN_E 0x1e1
668#define KEY_FN_F 0x1e2
669#define KEY_FN_S 0x1e3
670#define KEY_FN_B 0x1e4
671
Samuel Thibaultb9ec4e12006-04-02 00:10:28 -0500672#define KEY_BRL_DOT1 0x1f1
673#define KEY_BRL_DOT2 0x1f2
674#define KEY_BRL_DOT3 0x1f3
675#define KEY_BRL_DOT4 0x1f4
676#define KEY_BRL_DOT5 0x1f5
677#define KEY_BRL_DOT6 0x1f6
678#define KEY_BRL_DOT7 0x1f7
679#define KEY_BRL_DOT8 0x1f8
Samuel Thibault9e3d3d02007-09-04 23:16:04 -0400680#define KEY_BRL_DOT9 0x1f9
681#define KEY_BRL_DOT10 0x1fa
Samuel Thibaultb9ec4e12006-04-02 00:10:28 -0500682
Aristeu Rozanski5a599a12008-06-23 10:47:53 -0400683#define KEY_NUMERIC_0 0x200 /* used by phones, remote controls, */
684#define KEY_NUMERIC_1 0x201 /* and other keypads */
685#define KEY_NUMERIC_2 0x202
686#define KEY_NUMERIC_3 0x203
687#define KEY_NUMERIC_4 0x204
688#define KEY_NUMERIC_5 0x205
689#define KEY_NUMERIC_6 0x206
690#define KEY_NUMERIC_7 0x207
691#define KEY_NUMERIC_8 0x208
692#define KEY_NUMERIC_9 0x209
693#define KEY_NUMERIC_STAR 0x20a
694#define KEY_NUMERIC_POUND 0x20b
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -0700695#define KEY_CAMERA_SNAPSHOT 0x2fe
Jani Nikula765af102009-11-05 22:59:46 -0800696#define KEY_CAMERA_FOCUS 0x210
Dmitry Torokhov492d4f22010-02-26 00:16:05 -0800697#define KEY_WPS_BUTTON 0x211 /* WiFi Protected Setup key */
Jani Nikula765af102009-11-05 22:59:46 -0800698
Bastien Nocera04175962010-11-29 23:33:05 -0800699#define KEY_TOUCHPAD_TOGGLE 0x212 /* Request switch touchpad on or off */
700#define KEY_TOUCHPAD_ON 0x213
701#define KEY_TOUCHPAD_OFF 0x214
702
Corentin Charye2d3d442011-02-06 13:30:47 +0100703#define KEY_CAMERA_ZOOMIN 0x215
704#define KEY_CAMERA_ZOOMOUT 0x216
705#define KEY_CAMERA_UP 0x217
706#define KEY_CAMERA_DOWN 0x218
707#define KEY_CAMERA_LEFT 0x219
708#define KEY_CAMERA_RIGHT 0x21a
709
Jiri Kosinacf2f7652010-01-04 12:20:56 +0100710#define BTN_TRIGGER_HAPPY 0x2c0
711#define BTN_TRIGGER_HAPPY1 0x2c0
712#define BTN_TRIGGER_HAPPY2 0x2c1
713#define BTN_TRIGGER_HAPPY3 0x2c2
714#define BTN_TRIGGER_HAPPY4 0x2c3
715#define BTN_TRIGGER_HAPPY5 0x2c4
716#define BTN_TRIGGER_HAPPY6 0x2c5
717#define BTN_TRIGGER_HAPPY7 0x2c6
718#define BTN_TRIGGER_HAPPY8 0x2c7
719#define BTN_TRIGGER_HAPPY9 0x2c8
720#define BTN_TRIGGER_HAPPY10 0x2c9
721#define BTN_TRIGGER_HAPPY11 0x2ca
722#define BTN_TRIGGER_HAPPY12 0x2cb
723#define BTN_TRIGGER_HAPPY13 0x2cc
724#define BTN_TRIGGER_HAPPY14 0x2cd
725#define BTN_TRIGGER_HAPPY15 0x2ce
726#define BTN_TRIGGER_HAPPY16 0x2cf
727#define BTN_TRIGGER_HAPPY17 0x2d0
728#define BTN_TRIGGER_HAPPY18 0x2d1
729#define BTN_TRIGGER_HAPPY19 0x2d2
730#define BTN_TRIGGER_HAPPY20 0x2d3
731#define BTN_TRIGGER_HAPPY21 0x2d4
732#define BTN_TRIGGER_HAPPY22 0x2d5
733#define BTN_TRIGGER_HAPPY23 0x2d6
734#define BTN_TRIGGER_HAPPY24 0x2d7
735#define BTN_TRIGGER_HAPPY25 0x2d8
736#define BTN_TRIGGER_HAPPY26 0x2d9
737#define BTN_TRIGGER_HAPPY27 0x2da
738#define BTN_TRIGGER_HAPPY28 0x2db
739#define BTN_TRIGGER_HAPPY29 0x2dc
740#define BTN_TRIGGER_HAPPY30 0x2dd
741#define BTN_TRIGGER_HAPPY31 0x2de
742#define BTN_TRIGGER_HAPPY32 0x2df
743#define BTN_TRIGGER_HAPPY33 0x2e0
744#define BTN_TRIGGER_HAPPY34 0x2e1
745#define BTN_TRIGGER_HAPPY35 0x2e2
746#define BTN_TRIGGER_HAPPY36 0x2e3
747#define BTN_TRIGGER_HAPPY37 0x2e4
748#define BTN_TRIGGER_HAPPY38 0x2e5
749#define BTN_TRIGGER_HAPPY39 0x2e6
750#define BTN_TRIGGER_HAPPY40 0x2e7
751
Rusty Russell1d8f4302005-12-07 21:40:34 +0100752/* We avoid low common keys in module aliases so they don't get huge. */
753#define KEY_MIN_INTERESTING KEY_MUTE
Dmitry Torokhov03bac962008-06-23 10:47:34 -0400754#define KEY_MAX 0x2ff
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700755#define KEY_CNT (KEY_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
757/*
758 * Relative axes
759 */
760
761#define REL_X 0x00
762#define REL_Y 0x01
763#define REL_Z 0x02
764#define REL_RX 0x03
765#define REL_RY 0x04
766#define REL_RZ 0x05
767#define REL_HWHEEL 0x06
768#define REL_DIAL 0x07
769#define REL_WHEEL 0x08
770#define REL_MISC 0x09
771#define REL_MAX 0x0f
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700772#define REL_CNT (REL_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774/*
775 * Absolute axes
776 */
777
778#define ABS_X 0x00
779#define ABS_Y 0x01
780#define ABS_Z 0x02
781#define ABS_RX 0x03
782#define ABS_RY 0x04
783#define ABS_RZ 0x05
784#define ABS_THROTTLE 0x06
785#define ABS_RUDDER 0x07
786#define ABS_WHEEL 0x08
787#define ABS_GAS 0x09
788#define ABS_BRAKE 0x0a
789#define ABS_HAT0X 0x10
790#define ABS_HAT0Y 0x11
791#define ABS_HAT1X 0x12
792#define ABS_HAT1Y 0x13
793#define ABS_HAT2X 0x14
794#define ABS_HAT2Y 0x15
795#define ABS_HAT3X 0x16
796#define ABS_HAT3Y 0x17
797#define ABS_PRESSURE 0x18
798#define ABS_DISTANCE 0x19
799#define ABS_TILT_X 0x1a
800#define ABS_TILT_Y 0x1b
801#define ABS_TOOL_WIDTH 0x1c
Henrik Rydberg40d007e2010-07-15 23:10:10 -0700802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803#define ABS_VOLUME 0x20
Henrik Rydberg40d007e2010-07-15 23:10:10 -0700804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805#define ABS_MISC 0x28
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700806
Henrik Rydberg40d007e2010-07-15 23:10:10 -0700807#define ABS_MT_SLOT 0x2f /* MT slot being modified */
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700808#define ABS_MT_TOUCH_MAJOR 0x30 /* Major axis of touching ellipse */
809#define ABS_MT_TOUCH_MINOR 0x31 /* Minor axis (omit if circular) */
810#define ABS_MT_WIDTH_MAJOR 0x32 /* Major axis of approaching ellipse */
811#define ABS_MT_WIDTH_MINOR 0x33 /* Minor axis (omit if circular) */
812#define ABS_MT_ORIENTATION 0x34 /* Ellipse orientation */
813#define ABS_MT_POSITION_X 0x35 /* Center X ellipse position */
814#define ABS_MT_POSITION_Y 0x36 /* Center Y ellipse position */
815#define ABS_MT_TOOL_TYPE 0x37 /* Type of touching device */
816#define ABS_MT_BLOB_ID 0x38 /* Group a set of packets as a blob */
Henrik Rydbergdf391e02009-05-23 09:51:20 -0700817#define ABS_MT_TRACKING_ID 0x39 /* Unique ID of initiated contact */
Henrik Rydbergcb6ecf62010-01-28 22:28:27 -0800818#define ABS_MT_PRESSURE 0x3a /* Pressure on contact area */
Henrik Rydberge42a98b2010-12-06 10:05:43 +0100819#define ABS_MT_DISTANCE 0x3b /* Contact hover distance */
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700820
Henrik Rydberg40d007e2010-07-15 23:10:10 -0700821#ifdef __KERNEL__
822/* Implementation details, userspace should not care about these */
823#define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR
Henrik Rydberge42a98b2010-12-06 10:05:43 +0100824#define ABS_MT_LAST ABS_MT_DISTANCE
Henrik Rydberg40d007e2010-07-15 23:10:10 -0700825#endif
826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827#define ABS_MAX 0x3f
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700828#define ABS_CNT (ABS_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830/*
Richard Purdie31581062005-09-06 15:19:06 -0700831 * Switch events
832 */
833
Richard Purdieed8f9e22006-05-29 23:31:03 -0400834#define SW_LID 0x00 /* set = lid shut */
835#define SW_TABLET_MODE 0x01 /* set = tablet mode */
836#define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
Henrique de Moraes Holschuh5adad012008-05-30 10:40:46 -0400837#define SW_RFKILL_ALL 0x03 /* rfkill master switch, type "any"
838 set = radio enabled */
839#define SW_RADIO SW_RFKILL_ALL /* deprecated */
Mark Brown5ec461d2008-07-19 00:40:25 -0400840#define SW_MICROPHONE_INSERT 0x04 /* set = inserted */
Matthew Garrett92c49892008-07-19 00:43:54 -0400841#define SW_DOCK 0x05 /* set = plugged into dock */
Matthew Ranostaya53ccab2008-10-25 01:05:04 -0400842#define SW_LINEOUT_INSERT 0x06 /* set = inserted */
Mark Browncdc69362008-12-10 13:55:49 +0000843#define SW_JACK_PHYSICAL_INSERT 0x07 /* set = mechanical switch set */
Jani Nikulad506fc32009-01-07 11:54:25 +0200844#define SW_VIDEOOUT_INSERT 0x08 /* set = inserted */
Jani Nikula765af102009-11-05 22:59:46 -0800845#define SW_CAMERA_LENS_COVER 0x09 /* set = lens covered */
846#define SW_KEYPAD_SLIDE 0x0a /* set = keypad slide out */
847#define SW_FRONT_PROXIMITY 0x0b /* set = front proximity sensor active */
Jekyll Lai50a88cb2011-01-11 21:53:55 -0800848#define SW_ROTATE_LOCK 0x0c /* set = rotate locked/disabled */
David Henningsson7c2f8e42011-10-05 15:53:25 +0200849#define SW_LINEIN_INSERT 0x0d /* set = inserted */
Steve Mucklef132c6c2012-06-06 18:30:57 -0700850#define SW_HPHL_OVERCURRENT 0x0e /* set = over current on left hph */
851#define SW_HPHR_OVERCURRENT 0x0f /* set = over current on right hph */
852#define SW_UNSUPPORT_INSERT 0x10 /* set = unsupported device inserted */
Phani Kumar Uppalapati35360ca2014-01-02 21:11:45 -0800853#define SW_MICROPHONE2_INSERT 0x11 /* set = inserted */
Steve Mucklef132c6c2012-06-06 18:30:57 -0700854#define SW_MAX 0x20
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700855#define SW_CNT (SW_MAX+1)
Richard Purdie31581062005-09-06 15:19:06 -0700856
857/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 * Misc events
859 */
860
861#define MSC_SERIAL 0x00
862#define MSC_PULSELED 0x01
863#define MSC_GESTURE 0x02
864#define MSC_RAW 0x03
865#define MSC_SCAN 0x04
866#define MSC_MAX 0x07
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700867#define MSC_CNT (MSC_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
869/*
870 * LEDs
871 */
872
873#define LED_NUML 0x00
874#define LED_CAPSL 0x01
875#define LED_SCROLLL 0x02
876#define LED_COMPOSE 0x03
877#define LED_KANA 0x04
878#define LED_SLEEP 0x05
879#define LED_SUSPEND 0x06
880#define LED_MUTE 0x07
881#define LED_MISC 0x08
882#define LED_MAIL 0x09
883#define LED_CHARGING 0x0a
884#define LED_MAX 0x0f
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700885#define LED_CNT (LED_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887/*
888 * Autorepeat values
889 */
890
891#define REP_DELAY 0x00
892#define REP_PERIOD 0x01
893#define REP_MAX 0x01
Daniel Mackd31b2862010-08-02 20:18:21 -0700894#define REP_CNT (REP_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
896/*
897 * Sounds
898 */
899
900#define SND_CLICK 0x00
901#define SND_BELL 0x01
902#define SND_TONE 0x02
903#define SND_MAX 0x07
Jiri Slaby7b19ada2007-10-18 23:40:32 -0700904#define SND_CNT (SND_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
906/*
907 * IDs.
908 */
909
910#define ID_BUS 0
911#define ID_VENDOR 1
912#define ID_PRODUCT 2
913#define ID_VERSION 3
914
915#define BUS_PCI 0x01
916#define BUS_ISAPNP 0x02
917#define BUS_USB 0x03
918#define BUS_HIL 0x04
919#define BUS_BLUETOOTH 0x05
Michael Hanselmann9a87fdd2006-09-19 01:59:49 -0400920#define BUS_VIRTUAL 0x06
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
922#define BUS_ISA 0x10
923#define BUS_I8042 0x11
924#define BUS_XTKBD 0x12
925#define BUS_RS232 0x13
926#define BUS_GAMEPORT 0x14
927#define BUS_PARPORT 0x15
928#define BUS_AMIGA 0x16
929#define BUS_ADB 0x17
930#define BUS_I2C 0x18
931#define BUS_HOST 0x19
Matthew Wilcox6ab0f5c2005-10-21 22:58:51 -0400932#define BUS_GSC 0x1A
Michael Schmitzc04cb852007-05-01 22:32:38 +0200933#define BUS_ATARI 0x1B
Bryan Wu31a62962010-03-21 23:23:24 -0700934#define BUS_SPI 0x1C
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936/*
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700937 * MT_TOOL types
938 */
939#define MT_TOOL_FINGER 0
940#define MT_TOOL_PEN 1
Henrik Rydbergc5f4dec2010-12-15 13:50:34 +0100941#define MT_TOOL_MAX 1
Henrik Rydberg5e5ee682009-04-28 07:47:33 -0700942
943/*
Randy Dunlape4477d22006-11-24 00:43:09 -0500944 * Values describing the status of a force-feedback effect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 */
946#define FF_STATUS_STOPPED 0x00
947#define FF_STATUS_PLAYING 0x01
948#define FF_STATUS_MAX 0x01
949
950/*
951 * Structures used in ioctls to upload effects to a device
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400952 * They are pieces of a bigger structure (called ff_effect)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 */
954
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400955/*
956 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
957 * should not be used and have unspecified results.
958 */
959
960/**
Randy Dunlape4477d22006-11-24 00:43:09 -0500961 * struct ff_replay - defines scheduling of the force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400962 * @length: duration of the effect
963 * @delay: delay before effect should start playing
964 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965struct ff_replay {
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400966 __u16 length;
967 __u16 delay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968};
969
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400970/**
Randy Dunlape4477d22006-11-24 00:43:09 -0500971 * struct ff_trigger - defines what triggers the force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400972 * @button: number of the button triggering the effect
973 * @interval: controls how soon the effect can be re-triggered
974 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975struct ff_trigger {
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400976 __u16 button;
977 __u16 interval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978};
979
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400980/**
Randy Dunlape4477d22006-11-24 00:43:09 -0500981 * struct ff_envelope - generic force-feedback effect envelope
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400982 * @attack_length: duration of the attack (ms)
983 * @attack_level: level at the beginning of the attack
984 * @fade_length: duration of fade (ms)
985 * @fade_level: level at the end of fade
986 *
987 * The @attack_level and @fade_level are absolute values; when applying
988 * envelope force-feedback core will convert to positive/negative
989 * value based on polarity of the default level of the effect.
990 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
991 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992struct ff_envelope {
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400993 __u16 attack_length;
994 __u16 attack_level;
995 __u16 fade_length;
996 __u16 fade_level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997};
998
Anssi Hannula8b8277a2006-07-19 01:44:22 -0400999/**
Randy Dunlape4477d22006-11-24 00:43:09 -05001000 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001001 * @level: strength of the effect; may be negative
1002 * @envelope: envelope data
1003 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004struct ff_constant_effect {
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001005 __s16 level;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 struct ff_envelope envelope;
1007};
1008
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001009/**
Randy Dunlape4477d22006-11-24 00:43:09 -05001010 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001011 * @start_level: beginning strength of the effect; may be negative
1012 * @end_level: final strength of the effect; may be negative
1013 * @envelope: envelope data
1014 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015struct ff_ramp_effect {
1016 __s16 start_level;
1017 __s16 end_level;
1018 struct ff_envelope envelope;
1019};
1020
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001021/**
Randy Dunlape4477d22006-11-24 00:43:09 -05001022 * struct ff_condition_effect - defines a spring or friction force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001023 * @right_saturation: maximum level when joystick moved all way to the right
1024 * @left_saturation: same for the left side
1025 * @right_coeff: controls how fast the force grows when the joystick moves
1026 * to the right
1027 * @left_coeff: same for the left side
1028 * @deadband: size of the dead zone, where no force is produced
1029 * @center: position of the dead zone
1030 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031struct ff_condition_effect {
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001032 __u16 right_saturation;
1033 __u16 left_saturation;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001035 __s16 right_coeff;
1036 __s16 left_coeff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001038 __u16 deadband;
1039 __s16 center;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040};
1041
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001042/**
Randy Dunlape4477d22006-11-24 00:43:09 -05001043 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001044 * @waveform: kind of the effect (wave)
1045 * @period: period of the wave (ms)
1046 * @magnitude: peak value
1047 * @offset: mean value of the wave (roughly)
1048 * @phase: 'horizontal' shift
1049 * @envelope: envelope data
1050 * @custom_len: number of samples (FF_CUSTOM only)
1051 * @custom_data: buffer of samples (FF_CUSTOM only)
1052 *
1053 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
1054 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
1055 * for the time being as no driver supports it yet.
1056 *
1057 * Note: the data pointed by custom_data is copied by the driver.
1058 * You can therefore dispose of the memory after the upload/update.
1059 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060struct ff_periodic_effect {
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001061 __u16 waveform;
1062 __u16 period;
1063 __s16 magnitude;
1064 __s16 offset;
1065 __u16 phase;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
1067 struct ff_envelope envelope;
1068
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001069 __u32 custom_len;
Dmitry Torokhove74c2e82009-11-02 21:57:39 -08001070 __s16 __user *custom_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071};
1072
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001073/**
Randy Dunlape4477d22006-11-24 00:43:09 -05001074 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001075 * @strong_magnitude: magnitude of the heavy motor
1076 * @weak_magnitude: magnitude of the light one
1077 *
1078 * Some rumble pads have two motors of different weight. Strong_magnitude
1079 * represents the magnitude of the vibration generated by the heavy one.
1080 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081struct ff_rumble_effect {
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001082 __u16 strong_magnitude;
1083 __u16 weak_magnitude;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084};
1085
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001086/**
1087 * struct ff_effect - defines force feedback effect
1088 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
1089 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
1090 * @id: an unique id assigned to an effect
1091 * @direction: direction of the effect
1092 * @trigger: trigger conditions (struct ff_trigger)
1093 * @replay: scheduling of the effect (struct ff_replay)
1094 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
1095 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
1096 * defining effect parameters
1097 *
1098 * This structure is sent through ioctl from the application to the driver.
Dmitry Torokhov80064792007-08-30 00:22:11 -04001099 * To create a new effect application should set its @id to -1; the kernel
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001100 * will return assigned @id which can later be used to update or delete
1101 * this effect.
1102 *
1103 * Direction of the effect is encoded as follows:
1104 * 0 deg -> 0x0000 (down)
1105 * 90 deg -> 0x4000 (left)
1106 * 180 deg -> 0x8000 (up)
1107 * 270 deg -> 0xC000 (right)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 */
1109struct ff_effect {
1110 __u16 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 __s16 id;
Anssi Hannula8b8277a2006-07-19 01:44:22 -04001112 __u16 direction;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 struct ff_trigger trigger;
1114 struct ff_replay replay;
1115
1116 union {
1117 struct ff_constant_effect constant;
1118 struct ff_ramp_effect ramp;
1119 struct ff_periodic_effect periodic;
1120 struct ff_condition_effect condition[2]; /* One for each axis */
1121 struct ff_rumble_effect rumble;
1122 } u;
1123};
1124
1125/*
1126 * Force feedback effect types
1127 */
1128
1129#define FF_RUMBLE 0x50
1130#define FF_PERIODIC 0x51
1131#define FF_CONSTANT 0x52
1132#define FF_SPRING 0x53
1133#define FF_FRICTION 0x54
1134#define FF_DAMPER 0x55
1135#define FF_INERTIA 0x56
1136#define FF_RAMP 0x57
1137
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001138#define FF_EFFECT_MIN FF_RUMBLE
1139#define FF_EFFECT_MAX FF_RAMP
1140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141/*
1142 * Force feedback periodic effect types
1143 */
1144
1145#define FF_SQUARE 0x58
1146#define FF_TRIANGLE 0x59
1147#define FF_SINE 0x5a
1148#define FF_SAW_UP 0x5b
1149#define FF_SAW_DOWN 0x5c
1150#define FF_CUSTOM 0x5d
1151
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001152#define FF_WAVEFORM_MIN FF_SQUARE
1153#define FF_WAVEFORM_MAX FF_CUSTOM
1154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155/*
1156 * Set ff device properties
1157 */
1158
1159#define FF_GAIN 0x60
1160#define FF_AUTOCENTER 0x61
1161
1162#define FF_MAX 0x7f
Jiri Slaby7b19ada2007-10-18 23:40:32 -07001163#define FF_CNT (FF_MAX+1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
1165#ifdef __KERNEL__
1166
1167/*
1168 * In-kernel definitions.
1169 */
1170
Dmitry Torokhovddc5d342006-04-26 00:14:19 -04001171#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172#include <linux/fs.h>
1173#include <linux/timer.h>
Dmitry Torokhovddc5d342006-04-26 00:14:19 -04001174#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Dmitry Torokhov80064792007-08-30 00:22:11 -04001176/**
1177 * struct input_dev - represents an input device
1178 * @name: name of the device
1179 * @phys: physical path to the device in the system hierarchy
1180 * @uniq: unique identification code for the device (if device has it)
1181 * @id: id of the device (struct input_id)
Henrik Rydberg85b77202010-12-18 20:51:13 +01001182 * @propbit: bitmap of device properties and quirks
Dmitry Torokhov80064792007-08-30 00:22:11 -04001183 * @evbit: bitmap of types of events supported by the device (EV_KEY,
1184 * EV_REL, etc.)
1185 * @keybit: bitmap of keys/buttons this device has
1186 * @relbit: bitmap of relative axes for the device
1187 * @absbit: bitmap of absolute axes for the device
1188 * @mscbit: bitmap of miscellaneous events supported by the device
1189 * @ledbit: bitmap of leds present on the device
1190 * @sndbit: bitmap of sound effects supported by the device
1191 * @ffbit: bitmap of force feedback effects supported by the device
1192 * @swbit: bitmap of switches present on the device
Henrik Rydberg63a64042010-06-10 12:05:24 -07001193 * @hint_events_per_packet: average number of events generated by the
1194 * device in a packet (between EV_SYN/SYN_REPORT events). Used by
1195 * event handlers to estimate size of the buffer needed to hold
1196 * events.
Dmitry Torokhov80064792007-08-30 00:22:11 -04001197 * @keycodemax: size of keycode table
1198 * @keycodesize: size of elements in keycode table
1199 * @keycode: map of scancodes to keycodes for this device
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -07001200 * @getkeycode: optional legacy method to retrieve current keymap.
Dmitry Torokhov80064792007-08-30 00:22:11 -04001201 * @setkeycode: optional method to alter current keymap, used to implement
Dmitry Torokhov66d2a592009-12-01 21:54:35 -08001202 * sparse keymaps. If not supplied default mechanism will be used.
1203 * The method is being called while holding event_lock and thus must
1204 * not sleep
Dmitry Torokhov80064792007-08-30 00:22:11 -04001205 * @ff: force feedback structure associated with the device if device
1206 * supports force feedback effects
1207 * @repeat_key: stores key code of the last key pressed; used to implement
1208 * software autorepeat
1209 * @timer: timer for software autorepeat
Dmitry Torokhov80064792007-08-30 00:22:11 -04001210 * @rep: current values for autorepeat parameters (delay, rate)
Henrik Rydberg40d007e2010-07-15 23:10:10 -07001211 * @mt: pointer to array of struct input_mt_slot holding current values
1212 * of tracked contacts
1213 * @mtsize: number of MT slots the device uses
1214 * @slot: MT slot currently being transmitted
Henrik Rydbergc5f4dec2010-12-15 13:50:34 +01001215 * @trkid: stores MT tracking ID for the current contact
Dmitry Torokhov86b17f72010-11-29 23:33:04 -08001216 * @absinfo: array of &struct input_absinfo elements holding information
Daniel Mackd31b2862010-08-02 20:18:21 -07001217 * about absolute axes (current value, min, max, flat, fuzz,
1218 * resolution)
Dmitry Torokhov80064792007-08-30 00:22:11 -04001219 * @key: reflects current state of device's keys/buttons
1220 * @led: reflects current state of device's LEDs
1221 * @snd: reflects current state of sound effects
1222 * @sw: reflects current state of device's switches
Dmitry Torokhov80064792007-08-30 00:22:11 -04001223 * @open: this method is called when the very first user calls
1224 * input_open_device(). The driver must prepare the device
1225 * to start generating events (start polling thread,
1226 * request an IRQ, submit URB, etc.)
1227 * @close: this method is called when the very last user calls
1228 * input_close_device().
1229 * @flush: purges the device. Most commonly used to get rid of force
1230 * feedback effects loaded into the device when disconnecting
1231 * from it
1232 * @event: event handler for events sent _to_ the device, like EV_LED
1233 * or EV_SND. The device is expected to carry out the requested
1234 * action (turn on a LED, play sound, etc.) The call is protected
1235 * by @event_lock and must not sleep
1236 * @grab: input handle that currently has the device grabbed (via
1237 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1238 * recipient for all input events coming from the device
1239 * @event_lock: this spinlock is is taken when input core receives
1240 * and processes a new event for the device (in input_event()).
1241 * Code that accesses and/or modifies parameters of a device
1242 * (such as keymap or absmin, absmax, absfuzz, etc.) after device
1243 * has been registered with input core must take this lock.
1244 * @mutex: serializes calls to open(), close() and flush() methods
1245 * @users: stores number of users (input handlers) that opened this
1246 * device. It is used by input_open_device() and input_close_device()
1247 * to make sure that dev->open() is only called when the first
1248 * user opens device and dev->close() is called when the very
1249 * last user closes the device
1250 * @going_away: marks devices that are in a middle of unregistering and
1251 * causes input_open_device*() fail with -ENODEV.
Dmitry Torokhov20da92d2010-07-15 23:27:36 -07001252 * @sync: set to %true when there were no new events since last EV_SYN
Dmitry Torokhov80064792007-08-30 00:22:11 -04001253 * @dev: driver model's view of this device
1254 * @h_list: list of input handles associated with the device. When
1255 * accessing the list dev->mutex must be held
1256 * @node: used to place the device onto input_dev_list
1257 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258struct input_dev {
Dmitry Torokhov5b6271b2005-06-30 00:50:38 -05001259 const char *name;
1260 const char *phys;
1261 const char *uniq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 struct input_id id;
1263
Henrik Rydberg85b77202010-12-18 20:51:13 +01001264 unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
1265
Jiri Slaby7b19ada2007-10-18 23:40:32 -07001266 unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1267 unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1268 unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1269 unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1270 unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1271 unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1272 unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1273 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1274 unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Henrik Rydberg63a64042010-06-10 12:05:24 -07001276 unsigned int hint_events_per_packet;
1277
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 unsigned int keycodemax;
1279 unsigned int keycodesize;
1280 void *keycode;
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -07001281
Dmitry Torokhov58b93992010-03-08 22:37:10 -08001282 int (*setkeycode)(struct input_dev *dev,
Dmitry Torokhovaebd6362011-01-31 21:06:39 -08001283 const struct input_keymap_entry *ke,
1284 unsigned int *old_keycode);
Dmitry Torokhov58b93992010-03-08 22:37:10 -08001285 int (*getkeycode)(struct input_dev *dev,
Dmitry Torokhovaebd6362011-01-31 21:06:39 -08001286 struct input_keymap_entry *ke);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001288 struct ff_device *ff;
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 unsigned int repeat_key;
1291 struct timer_list timer;
1292
Daniel Mackd31b2862010-08-02 20:18:21 -07001293 int rep[REP_CNT];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
Henrik Rydberg40d007e2010-07-15 23:10:10 -07001295 struct input_mt_slot *mt;
1296 int mtsize;
1297 int slot;
Henrik Rydbergc5f4dec2010-12-15 13:50:34 +01001298 int trkid;
Henrik Rydberg40d007e2010-07-15 23:10:10 -07001299
Daniel Mackd31b2862010-08-02 20:18:21 -07001300 struct input_absinfo *absinfo;
1301
Jiri Slaby7b19ada2007-10-18 23:40:32 -07001302 unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1303 unsigned long led[BITS_TO_LONGS(LED_CNT)];
1304 unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1305 unsigned long sw[BITS_TO_LONGS(SW_CNT)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 int (*open)(struct input_dev *dev);
1308 void (*close)(struct input_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 int (*flush)(struct input_dev *dev, struct file *file);
1310 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Arnd Bergmann2be85272010-03-04 15:50:28 +01001312 struct input_handle __rcu *grab;
Dmitry Torokhov0fbf87c2005-05-29 02:29:25 -05001313
Dmitry Torokhov80064792007-08-30 00:22:11 -04001314 spinlock_t event_lock;
1315 struct mutex mutex;
1316
Dmitry Torokhov0fbf87c2005-05-29 02:29:25 -05001317 unsigned int users;
Dmitry Torokhovffd0db92009-09-16 01:06:43 -07001318 bool going_away;
Dmitry Torokhov0fbf87c2005-05-29 02:29:25 -05001319
Dmitry Torokhov20da92d2010-07-15 23:27:36 -07001320 bool sync;
1321
Dmitry Torokhov9657d752007-06-14 23:32:24 -04001322 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324 struct list_head h_list;
1325 struct list_head node;
1326};
Dmitry Torokhov9657d752007-06-14 23:32:24 -04001327#define to_input_dev(d) container_of(d, struct input_dev, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Dmitry Torokhovddc5d342006-04-26 00:14:19 -04001329/*
1330 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1331 */
1332
1333#if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1334#error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1335#endif
1336
Sam Ravnborgdc24f0e2007-03-09 19:59:06 +01001337#if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1338#error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1339#endif
1340
Dmitry Torokhovddc5d342006-04-26 00:14:19 -04001341#if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1342#error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1343#endif
1344
1345#if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1346#error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1347#endif
1348
1349#if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1350#error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1351#endif
1352
1353#if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1354#error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1355#endif
1356
1357#if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1358#error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1359#endif
1360
1361#if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1362#error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1363#endif
1364
1365#if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1366#error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1367#endif
1368
1369#if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1370#error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1371#endif
1372
1373#define INPUT_DEVICE_ID_MATCH_DEVICE \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
Dmitry Torokhovddc5d342006-04-26 00:14:19 -04001375#define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378struct input_handle;
1379
Dmitry Torokhovc7e8dc62006-07-06 00:21:03 -04001380/**
1381 * struct input_handler - implements one of interfaces for input devices
1382 * @private: driver-specific data
Dmitry Torokhov80064792007-08-30 00:22:11 -04001383 * @event: event handler. This method is being called by input core with
1384 * interrupts disabled and dev->event_lock spinlock held and so
1385 * it may not sleep
Dmitry Torokhovef7995f2010-01-29 23:59:12 -08001386 * @filter: similar to @event; separates normal event handlers from
1387 * "filters".
Dmitry Torokhov0b7024ac2010-02-02 21:08:26 -08001388 * @match: called after comparing device's id with handler's id_table
1389 * to perform fine-grained matching between device and handler
Dmitry Torokhovc7e8dc62006-07-06 00:21:03 -04001390 * @connect: called when attaching a handler to an input device
1391 * @disconnect: disconnects a handler from input device
1392 * @start: starts handler for given handle. This function is called by
1393 * input core right after connect() method and also when a process
1394 * that "grabbed" a device releases it
1395 * @fops: file operations this driver implements
1396 * @minor: beginning of range of 32 minors for devices this driver
1397 * can provide
1398 * @name: name of the handler, to be shown in /proc/bus/input/handlers
1399 * @id_table: pointer to a table of input_device_ids this driver can
1400 * handle
Dmitry Torokhovc7e8dc62006-07-06 00:21:03 -04001401 * @h_list: list of input handles associated with the handler
1402 * @node: for placing the driver onto input_handler_list
Dmitry Torokhov80064792007-08-30 00:22:11 -04001403 *
1404 * Input handlers attach to input devices and create input handles. There
1405 * are likely several handlers attached to any given input device at the
1406 * same time. All of them will get their copy of input event generated by
1407 * the device.
1408 *
Dmitry Torokhovef7995f2010-01-29 23:59:12 -08001409 * The very same structure is used to implement input filters. Input core
1410 * allows filters to run first and will not pass event to regular handlers
1411 * if any of the filters indicate that the event should be filtered (by
1412 * returning %true from their filter() method).
1413 *
Dmitry Torokhov80064792007-08-30 00:22:11 -04001414 * Note that input core serializes calls to connect() and disconnect()
1415 * methods.
Dmitry Torokhovc7e8dc62006-07-06 00:21:03 -04001416 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417struct input_handler {
1418
1419 void *private;
1420
1421 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
Dmitry Torokhovef7995f2010-01-29 23:59:12 -08001422 bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
Dmitry Torokhov0b7024ac2010-02-02 21:08:26 -08001423 bool (*match)(struct input_handler *handler, struct input_dev *dev);
Dmitry Torokhov5b2a0822007-04-12 01:29:46 -04001424 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 void (*disconnect)(struct input_handle *handle);
Dmitry Torokhovc7e8dc62006-07-06 00:21:03 -04001426 void (*start)(struct input_handle *handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Arjan van de Ven99ac48f2006-03-28 01:56:41 -08001428 const struct file_operations *fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 int minor;
Dmitry Torokhov66e66112006-09-14 01:31:59 -04001430 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Dmitry Torokhov66e66112006-09-14 01:31:59 -04001432 const struct input_device_id *id_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433
1434 struct list_head h_list;
1435 struct list_head node;
1436};
1437
Dmitry Torokhov80064792007-08-30 00:22:11 -04001438/**
1439 * struct input_handle - links input device with an input handler
1440 * @private: handler-specific data
1441 * @open: counter showing whether the handle is 'open', i.e. should deliver
1442 * events from its device
1443 * @name: name given to the handle by handler that created it
1444 * @dev: input device the handle is attached to
1445 * @handler: handler that works with the device through this handle
1446 * @d_node: used to put the handle on device's list of attached handles
1447 * @h_node: used to put the handle on handler's list of handles from which
1448 * it gets events
1449 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450struct input_handle {
1451
1452 void *private;
1453
1454 int open;
Dmitry Torokhov66e66112006-09-14 01:31:59 -04001455 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
1457 struct input_dev *dev;
1458 struct input_handler *handler;
1459
1460 struct list_head d_node;
1461 struct list_head h_node;
1462};
1463
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001464struct input_dev *input_allocate_device(void);
Dmitry Torokhovf60d2b12006-06-26 01:48:36 -04001465void input_free_device(struct input_dev *dev);
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001466
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001467static inline struct input_dev *input_get_device(struct input_dev *dev)
1468{
Dmitry Torokhova7097ff2008-04-01 00:22:53 -04001469 return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001470}
1471
1472static inline void input_put_device(struct input_dev *dev)
1473{
Dmitry Torokhova7097ff2008-04-01 00:22:53 -04001474 if (dev)
1475 put_device(&dev->dev);
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001476}
1477
Dmitry Torokhov3abccf32007-04-12 01:33:51 -04001478static inline void *input_get_drvdata(struct input_dev *dev)
1479{
Dmitry Torokhov3797fec2008-04-02 00:41:00 -04001480 return dev_get_drvdata(&dev->dev);
Dmitry Torokhov3abccf32007-04-12 01:33:51 -04001481}
1482
1483static inline void input_set_drvdata(struct input_dev *dev, void *data)
1484{
Dmitry Torokhov3797fec2008-04-02 00:41:00 -04001485 dev_set_drvdata(&dev->dev, data);
Dmitry Torokhov3abccf32007-04-12 01:33:51 -04001486}
1487
Dmitry Torokhov501cc542007-07-18 01:20:58 -04001488int __must_check input_register_device(struct input_dev *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489void input_unregister_device(struct input_dev *);
1490
Dmitry Torokhovb50b5212010-11-03 11:02:31 -07001491void input_reset_device(struct input_dev *);
1492
Dmitry Torokhov501cc542007-07-18 01:20:58 -04001493int __must_check input_register_handler(struct input_handler *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494void input_unregister_handler(struct input_handler *);
1495
Dmitry Torokhov66d2a592009-12-01 21:54:35 -08001496int input_handler_for_each_handle(struct input_handler *, void *data,
1497 int (*fn)(struct input_handle *, void *));
1498
Dmitry Torokhov5b2a0822007-04-12 01:29:46 -04001499int input_register_handle(struct input_handle *);
1500void input_unregister_handle(struct input_handle *);
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502int input_grab_device(struct input_handle *);
1503void input_release_device(struct input_handle *);
1504
1505int input_open_device(struct input_handle *);
1506void input_close_device(struct input_handle *);
1507
Dmitry Torokhovb50b5212010-11-03 11:02:31 -07001508int input_flush_device(struct input_handle *handle, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
1510void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
Dmitry Torokhov0e739d22006-07-06 00:22:43 -04001511void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
1513static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1514{
1515 input_event(dev, EV_KEY, code, !!value);
1516}
1517
1518static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1519{
1520 input_event(dev, EV_REL, code, value);
1521}
1522
1523static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1524{
1525 input_event(dev, EV_ABS, code, value);
1526}
1527
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1529{
1530 input_event(dev, EV_FF_STATUS, code, value);
1531}
1532
Richard Purdie31581062005-09-06 15:19:06 -07001533static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1534{
1535 input_event(dev, EV_SW, code, !!value);
1536}
1537
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538static inline void input_sync(struct input_dev *dev)
1539{
1540 input_event(dev, EV_SYN, SYN_REPORT, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541}
1542
Henrik Rydberg5e5ee682009-04-28 07:47:33 -07001543static inline void input_mt_sync(struct input_dev *dev)
1544{
1545 input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
1546}
1547
Dmitry Torokhov534565f2007-04-25 00:53:18 -04001548void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1549
Henrik Rydberg63a64042010-06-10 12:05:24 -07001550/**
1551 * input_set_events_per_packet - tell handlers about the driver event rate
1552 * @dev: the input device used by the driver
1553 * @n_events: the average number of events between calls to input_sync()
1554 *
1555 * If the event rate sent from a device is unusually large, use this
1556 * function to set the expected event rate. This will allow handlers
1557 * to set up an appropriate buffer size for the event stream, in order
1558 * to minimize information loss.
1559 */
1560static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
1561{
1562 dev->hint_events_per_packet = n_events;
1563}
1564
Daniel Mackd31b2862010-08-02 20:18:21 -07001565void input_alloc_absinfo(struct input_dev *dev);
1566void input_set_abs_params(struct input_dev *dev, unsigned int axis,
1567 int min, int max, int fuzz, int flat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
Daniel Mack7957e9c2010-08-02 19:33:51 -07001569#define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item) \
1570static inline int input_abs_get_##_suffix(struct input_dev *dev, \
1571 unsigned int axis) \
1572{ \
Daniel Mackd31b2862010-08-02 20:18:21 -07001573 return dev->absinfo ? dev->absinfo[axis]._item : 0; \
Daniel Mack7957e9c2010-08-02 19:33:51 -07001574} \
1575 \
1576static inline void input_abs_set_##_suffix(struct input_dev *dev, \
1577 unsigned int axis, int val) \
1578{ \
Daniel Mackd31b2862010-08-02 20:18:21 -07001579 input_alloc_absinfo(dev); \
1580 if (dev->absinfo) \
1581 dev->absinfo[axis]._item = val; \
Daniel Mack7957e9c2010-08-02 19:33:51 -07001582}
1583
Daniel Mackd31b2862010-08-02 20:18:21 -07001584INPUT_GENERATE_ABS_ACCESSORS(val, value)
1585INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
1586INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
Daniel Mack7957e9c2010-08-02 19:33:51 -07001587INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
1588INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
Daniel Mackd31b2862010-08-02 20:18:21 -07001589INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
Daniel Mack7957e9c2010-08-02 19:33:51 -07001590
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -07001591int input_scancode_to_scalar(const struct input_keymap_entry *ke,
1592 unsigned int *scancode);
1593
1594int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
Dmitry Torokhov58b93992010-03-08 22:37:10 -08001595int input_set_keycode(struct input_dev *dev,
Mauro Carvalho Chehab8613e4c2010-09-09 21:54:22 -07001596 const struct input_keymap_entry *ke);
Dmitry Torokhovf4f37c82007-11-04 00:41:12 -04001597
Greg Kroah-Hartmanea9f2402005-10-27 22:25:43 -07001598extern struct class input_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001600/**
1601 * struct ff_device - force-feedback part of an input device
1602 * @upload: Called to upload an new effect into device
1603 * @erase: Called to erase an effect from device
1604 * @playback: Called to request device to start playing specified effect
1605 * @set_gain: Called to set specified gain
1606 * @set_autocenter: Called to auto-center device
1607 * @destroy: called by input core when parent input device is being
1608 * destroyed
1609 * @private: driver-specific data, will be freed automatically
1610 * @ffbit: bitmap of force feedback capabilities truly supported by
1611 * device (not emulated like ones in input_dev->ffbit)
1612 * @mutex: mutex for serializing access to the device
1613 * @max_effects: maximum number of effects supported by device
1614 * @effects: pointer to an array of effects currently loaded into device
1615 * @effect_owners: array of effect owners; when file handle owning
Dmitry Torokhov80064792007-08-30 00:22:11 -04001616 * an effect gets closed the effect is automatically erased
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001617 *
1618 * Every force-feedback device must implement upload() and playback()
1619 * methods; erase() is optional. set_gain() and set_autocenter() need
1620 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1621 * bits.
Dmitry Torokhovbf3204c2009-11-06 21:39:07 -08001622 *
1623 * Note that playback(), set_gain() and set_autocenter() are called with
1624 * dev->event_lock spinlock held and interrupts off and thus may not
1625 * sleep.
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001626 */
1627struct ff_device {
1628 int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1629 struct ff_effect *old);
1630 int (*erase)(struct input_dev *dev, int effect_id);
1631
1632 int (*playback)(struct input_dev *dev, int effect_id, int value);
1633 void (*set_gain)(struct input_dev *dev, u16 gain);
1634 void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1635
1636 void (*destroy)(struct ff_device *);
1637
1638 void *private;
1639
Jiri Slaby7b19ada2007-10-18 23:40:32 -07001640 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001641
1642 struct mutex mutex;
1643
1644 int max_effects;
1645 struct ff_effect *effects;
1646 struct file *effect_owners[];
1647};
1648
Dan Carpenter05be8b82011-10-12 21:05:53 -07001649int input_ff_create(struct input_dev *dev, unsigned int max_effects);
Anssi Hannula509ca1a2006-07-19 01:40:22 -04001650void input_ff_destroy(struct input_dev *dev);
1651
1652int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1653
1654int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1655int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1656
Anssi Hannula7d928a22006-07-19 01:40:30 -04001657int input_ff_create_memless(struct input_dev *dev, void *data,
1658 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660#endif
1661#endif