1/*
2 * Copyright (c) 1999-2002 Vojtech Pavlik
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
7 */
8#ifndef _INPUT_H
9#define _INPUT_H
10
11
12#include <sys/time.h>
13#include <sys/ioctl.h>
14#include <sys/types.h>
15#include <linux/types.h>
16
17
18/*
19 * The event structure itself
20 */
21
22struct input_event {
23 struct timeval time;
24 __u16 type;
25 __u16 code;
26 __s32 value;
27};
28
29/*
30 * Protocol version.
31 */
32
33#define EV_VERSION 0x010001
34
35/*
36 * IOCTLs (0x00 - 0x7f)
37 */
38
39struct input_id {
40 __u16 bustype;
41 __u16 vendor;
42 __u16 product;
43 __u16 version;
44};
45
46/**
47 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
48 * @value: latest reported value for the axis.
49 * @minimum: specifies minimum value for the axis.
50 * @maximum: specifies maximum value for the axis.
51 * @fuzz: specifies fuzz value that is used to filter noise from
52 * the event stream.
53 * @flat: values that are within this value will be discarded by
54 * joydev interface and reported as 0 instead.
55 * @resolution: specifies resolution for the values reported for
56 * the axis.
57 *
58 * Note that input core does not clamp reported values to the
59 * [minimum, maximum] limits, such task is left to userspace.
60 *
61 * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
62 * units per millimeter (units/mm), resolution for rotational axes
63 * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
64 */
65struct input_absinfo {
66 __s32 value;
67 __s32 minimum;
68 __s32 maximum;
69 __s32 fuzz;
70 __s32 flat;
71 __s32 resolution;
72};
73
74/**
75 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
76 * @scancode: scancode represented in machine-endian form.
77 * @len: length of the scancode that resides in @scancode buffer.
78 * @index: index in the keymap, may be used instead of scancode
79 * @flags: allows to specify how kernel should handle the request. For
80 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
81 * should perform lookup in keymap by @index instead of @scancode
82 * @keycode: key code assigned to this scancode
83 *
84 * The structure is used to retrieve and modify keymap data. Users have
85 * option of performing lookup either by @scancode itself or by @index
86 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
87 * (depending on which element was used to perform lookup).
88 */
89struct input_keymap_entry {
90#define INPUT_KEYMAP_BY_INDEX (1 << 0)
91 __u8 flags;
92 __u8 len;
93 __u16 index;
94 __u32 keycode;
95 __u8 scancode[32];
96};
97
98#define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
99#define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
100#define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
101#define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
102
103#define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
104#define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
105#define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
106#define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
107
108#define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
109#define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
110#define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
111#define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
112
113/**
114 * EVIOCGMTSLOTS(len) - get MT slot values
115 * @len: size of the data buffer in bytes
116 *
117 * The ioctl buffer argument should be binary equivalent to
118 *
119 * struct input_mt_request_layout {
120 * __u32 code;
121 * __s32 values[num_slots];
122 * };
123 *
124 * where num_slots is the (arbitrary) number of MT slots to extract.
125 *
126 * The ioctl size argument (len) is the size of the buffer, which
127 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is
128 * too small to fit all available slots, the first num_slots are
129 * returned.
130 *
131 * Before the call, code is set to the wanted ABS_MT event type. On
132 * return, values[] is filled with the slot values for the specified
133 * ABS_MT code.
134 *
135 * If the request code is not an ABS_MT value, -EINVAL is returned.
136 */
137#define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
138
139#define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
140#define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
141#define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
142#define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
143
144#define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
145#define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
146#define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
147
148#define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */
149#define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
150#define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
151
152#define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
153#define EVIOCREVOKE _IOW('E', 0x91, int) /* Revoke device access */
154
155#define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
156
157/*
158 * Device properties and quirks
159 */
160
161#define INPUT_PROP_POINTER 0x00 /* needs a pointer */
162#define INPUT_PROP_DIRECT 0x01 /* direct input devices */
163#define INPUT_PROP_BUTTONPAD 0x02 /* has button(s) under pad */
164#define INPUT_PROP_SEMI_MT 0x03 /* touch rectangle only */
165#define INPUT_PROP_TOPBUTTONPAD 0x04 /* softbuttons at top of pad */
166
167#define INPUT_PROP_MAX 0x1f
168#define INPUT_PROP_CNT (INPUT_PROP_MAX + 1)
169
170/*
171 * Event types
172 */
173
174#define EV_SYN 0x00
175#define EV_KEY 0x01
176#define EV_REL 0x02
177#define EV_ABS 0x03
178#define EV_MSC 0x04
179#define EV_SW 0x05
180#define EV_LED 0x11
181#define EV_SND 0x12
182#define EV_REP 0x14
183#define EV_FF 0x15
184#define EV_PWR 0x16
185#define EV_FF_STATUS 0x17
186#define EV_MAX 0x1f
187#define EV_CNT (EV_MAX+1)
188
189/*
190 * Synchronization events.
191 */
192
193#define SYN_REPORT 0
194#define SYN_CONFIG 1
195#define SYN_MT_REPORT 2
196#define SYN_DROPPED 3
197#define SYN_MAX 0xf
198#define SYN_CNT (SYN_MAX+1)
199
200/*
201 * Keys and buttons
202 *
203 * Most of the keys/buttons are modeled after USB HUT 1.12
204 * (see http://www.usb.org/developers/hidpage).
205 * Abbreviations in the comments:
206 * AC - Application Control
207 * AL - Application Launch Button
208 * SC - System Control
209 */
210
211#define KEY_RESERVED 0
212#define KEY_ESC 1
213#define KEY_1 2
214#define KEY_2 3
215#define KEY_3 4
216#define KEY_4 5
217#define KEY_5 6
218#define KEY_6 7
219#define KEY_7 8
220#define KEY_8 9
221#define KEY_9 10
222#define KEY_0 11
223#define KEY_MINUS 12
224#define KEY_EQUAL 13
225#define KEY_BACKSPACE 14
226#define KEY_TAB 15
227#define KEY_Q 16
228#define KEY_W 17
229#define KEY_E 18
230#define KEY_R 19
231#define KEY_T 20
232#define KEY_Y 21
233#define KEY_U 22
234#define KEY_I 23
235#define KEY_O 24
236#define KEY_P 25
237#define KEY_LEFTBRACE 26
238#define KEY_RIGHTBRACE 27
239#define KEY_ENTER 28
240#define KEY_LEFTCTRL 29
241#define KEY_A 30
242#define KEY_S 31
243#define KEY_D 32
244#define KEY_F 33
245#define KEY_G 34
246#define KEY_H 35
247#define KEY_J 36
248#define KEY_K 37
249#define KEY_L 38
250#define KEY_SEMICOLON 39
251#define KEY_APOSTROPHE 40
252#define KEY_GRAVE 41
253#define KEY_LEFTSHIFT 42
254#define KEY_BACKSLASH 43
255#define KEY_Z 44
256#define KEY_X 45
257#define KEY_C 46
258#define KEY_V 47
259#define KEY_B 48
260#define KEY_N 49
261#define KEY_M 50
262#define KEY_COMMA 51
263#define KEY_DOT 52
264#define KEY_SLASH 53
265#define KEY_RIGHTSHIFT 54
266#define KEY_KPASTERISK 55
267#define KEY_LEFTALT 56
268#define KEY_SPACE 57
269#define KEY_CAPSLOCK 58
270#define KEY_F1 59
271#define KEY_F2 60
272#define KEY_F3 61
273#define KEY_F4 62
274#define KEY_F5 63
275#define KEY_F6 64
276#define KEY_F7 65
277#define KEY_F8 66
278#define KEY_F9 67
279#define KEY_F10 68
280#define KEY_NUMLOCK 69
281#define KEY_SCROLLLOCK 70
282#define KEY_KP7 71
283#define KEY_KP8 72
284#define KEY_KP9 73
285#define KEY_KPMINUS 74
286#define KEY_KP4 75
287#define KEY_KP5 76
288#define KEY_KP6 77
289#define KEY_KPPLUS 78
290#define KEY_KP1 79
291#define KEY_KP2 80
292#define KEY_KP3 81
293#define KEY_KP0 82
294#define KEY_KPDOT 83
295
296#define KEY_ZENKAKUHANKAKU 85
297#define KEY_102ND 86
298#define KEY_F11 87
299#define KEY_F12 88
300#define KEY_RO 89
301#define KEY_KATAKANA 90
302#define KEY_HIRAGANA 91
303#define KEY_HENKAN 92
304#define KEY_KATAKANAHIRAGANA 93
305#define KEY_MUHENKAN 94
306#define KEY_KPJPCOMMA 95
307#define KEY_KPENTER 96
308#define KEY_RIGHTCTRL 97
309#define KEY_KPSLASH 98
310#define KEY_SYSRQ 99
311#define KEY_RIGHTALT 100
312#define KEY_LINEFEED 101
313#define KEY_HOME 102
314#define KEY_UP 103
315#define KEY_PAGEUP 104
316#define KEY_LEFT 105
317#define KEY_RIGHT 106
318#define KEY_END 107
319#define KEY_DOWN 108
320#define KEY_PAGEDOWN 109
321#define KEY_INSERT 110
322#define KEY_DELETE 111
323#define KEY_MACRO 112
324#define KEY_MUTE 113
325#define KEY_VOLUMEDOWN 114
326#define KEY_VOLUMEUP 115
327#define KEY_POWER 116 /* SC System Power Down */
328#define KEY_KPEQUAL 117
329#define KEY_KPPLUSMINUS 118
330#define KEY_PAUSE 119
331#define KEY_SCALE 120 /* AL Compiz Scale (Expose) */
332
333#define KEY_KPCOMMA 121
334#define KEY_HANGEUL 122
335#define KEY_HANGUEL KEY_HANGEUL
336#define KEY_HANJA 123
337#define KEY_YEN 124
338#define KEY_LEFTMETA 125
339#define KEY_RIGHTMETA 126
340#define KEY_COMPOSE 127
341
342#define KEY_STOP 128 /* AC Stop */
343#define KEY_AGAIN 129
344#define KEY_PROPS 130 /* AC Properties */
345#define KEY_UNDO 131 /* AC Undo */
346#define KEY_FRONT 132
347#define KEY_COPY 133 /* AC Copy */
348#define KEY_OPEN 134 /* AC Open */
349#define KEY_PASTE 135 /* AC Paste */
350#define KEY_FIND 136 /* AC Search */
351#define KEY_CUT 137 /* AC Cut */
352#define KEY_HELP 138 /* AL Integrated Help Center */
353#define KEY_MENU 139 /* Menu (show menu) */
354#define KEY_CALC 140 /* AL Calculator */
355#define KEY_SETUP 141
356#define KEY_SLEEP 142 /* SC System Sleep */
357#define KEY_WAKEUP 143 /* System Wake Up */
358#define KEY_FILE 144 /* AL Local Machine Browser */
359#define KEY_SENDFILE 145
360#define KEY_DELETEFILE 146
361#define KEY_XFER 147
362#define KEY_PROG1 148
363#define KEY_PROG2 149
364#define KEY_WWW 150 /* AL Internet Browser */
365#define KEY_MSDOS 151
366#define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */
367#define KEY_SCREENLOCK KEY_COFFEE
368#define KEY_DIRECTION 153
369#define KEY_CYCLEWINDOWS 154
370#define KEY_MAIL 155
371#define KEY_BOOKMARKS 156 /* AC Bookmarks */
372#define KEY_COMPUTER 157
373#define KEY_BACK 158 /* AC Back */
374#define KEY_FORWARD 159 /* AC Forward */
375#define KEY_CLOSECD 160
376#define KEY_EJECTCD 161
377#define KEY_EJECTCLOSECD 162
378#define KEY_NEXTSONG 163
379#define KEY_PLAYPAUSE 164
380#define KEY_PREVIOUSSONG 165
381#define KEY_STOPCD 166
382#define KEY_RECORD 167
383#define KEY_REWIND 168
384#define KEY_PHONE 169 /* Media Select Telephone */
385#define KEY_ISO 170
386#define KEY_CONFIG 171 /* AL Consumer Control Configuration */
387#define KEY_HOMEPAGE 172 /* AC Home */
388#define KEY_REFRESH 173 /* AC Refresh */
389#define KEY_EXIT 174 /* AC Exit */
390#define KEY_MOVE 175
391#define KEY_EDIT 176
392#define KEY_SCROLLUP 177
393#define KEY_SCROLLDOWN 178
394#define KEY_KPLEFTPAREN 179
395#define KEY_KPRIGHTPAREN 180
396#define KEY_NEW 181 /* AC New */
397#define KEY_REDO 182 /* AC Redo/Repeat */
398
399#define KEY_F13 183
400#define KEY_F14 184
401#define KEY_F15 185
402#define KEY_F16 186
403#define KEY_F17 187
404#define KEY_F18 188
405#define KEY_F19 189
406#define KEY_F20 190
407#define KEY_F21 191
408#define KEY_F22 192
409#define KEY_F23 193
410#define KEY_F24 194
411
412#define KEY_PLAYCD 200
413#define KEY_PAUSECD 201
414#define KEY_PROG3 202
415#define KEY_PROG4 203
416#define KEY_DASHBOARD 204 /* AL Dashboard */
417#define KEY_SUSPEND 205
418#define KEY_CLOSE 206 /* AC Close */
419#define KEY_PLAY 207
420#define KEY_FASTFORWARD 208
421#define KEY_BASSBOOST 209
422#define KEY_PRINT 210 /* AC Print */
423#define KEY_HP 211
424#define KEY_CAMERA 212
425#define KEY_SOUND 213
426#define KEY_QUESTION 214
427#define KEY_EMAIL 215
428#define KEY_CHAT 216
429#define KEY_SEARCH 217
430#define KEY_CONNECT 218
431#define KEY_FINANCE 219 /* AL Checkbook/Finance */
432#define KEY_SPORT 220
433#define KEY_SHOP 221
434#define KEY_ALTERASE 222
435#define KEY_CANCEL 223 /* AC Cancel */
436#define KEY_BRIGHTNESSDOWN 224
437#define KEY_BRIGHTNESSUP 225
438#define KEY_MEDIA 226
439
440#define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video
441 outputs (Monitor/LCD/TV-out/etc) */
442#define KEY_KBDILLUMTOGGLE 228
443#define KEY_KBDILLUMDOWN 229
444#define KEY_KBDILLUMUP 230
445
446#define KEY_SEND 231 /* AC Send */
447#define KEY_REPLY 232 /* AC Reply */
448#define KEY_FORWARDMAIL 233 /* AC Forward Msg */
449#define KEY_SAVE 234 /* AC Save */
450#define KEY_DOCUMENTS 235
451
452#define KEY_BATTERY 236
453
454#define KEY_BLUETOOTH 237
455#define KEY_WLAN 238
456#define KEY_UWB 239
457
458#define KEY_UNKNOWN 240
459
460#define KEY_VIDEO_NEXT 241 /* drive next video source */
461#define KEY_VIDEO_PREV 242 /* drive previous video source */
462#define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */
463#define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */
464#define KEY_DISPLAY_OFF 245 /* display device to off state */
465
466#define KEY_WWAN 246 /* Wireless WAN (LTE, UMTS, GSM, etc.) */
467#define KEY_WIMAX KEY_WWAN
468#define KEY_RFKILL 247 /* Key that controls all radios */
469
470#define KEY_MICMUTE 248 /* Mute / unmute the microphone */
471
472/* Code 255 is reserved for special needs of AT keyboard driver */
473
474#define BTN_MISC 0x100
475#define BTN_0 0x100
476#define BTN_1 0x101
477#define BTN_2 0x102
478#define BTN_3 0x103
479#define BTN_4 0x104
480#define BTN_5 0x105
481#define BTN_6 0x106
482#define BTN_7 0x107
483#define BTN_8 0x108
484#define BTN_9 0x109
485
486#define BTN_MOUSE 0x110
487#define BTN_LEFT 0x110
488#define BTN_RIGHT 0x111
489#define BTN_MIDDLE 0x112
490#define BTN_SIDE 0x113
491#define BTN_EXTRA 0x114
492#define BTN_FORWARD 0x115
493#define BTN_BACK 0x116
494#define BTN_TASK 0x117
495
496#define BTN_JOYSTICK 0x120
497#define BTN_TRIGGER 0x120
498#define BTN_THUMB 0x121
499#define BTN_THUMB2 0x122
500#define BTN_TOP 0x123
501#define BTN_TOP2 0x124
502#define BTN_PINKIE 0x125
503#define BTN_BASE 0x126
504#define BTN_BASE2 0x127
505#define BTN_BASE3 0x128
506#define BTN_BASE4 0x129
507#define BTN_BASE5 0x12a
508#define BTN_BASE6 0x12b
509#define BTN_DEAD 0x12f
510
511#define BTN_GAMEPAD 0x130
512#define BTN_SOUTH 0x130
513#define BTN_A BTN_SOUTH
514#define BTN_EAST 0x131
515#define BTN_B BTN_EAST
516#define BTN_C 0x132
517#define BTN_NORTH 0x133
518#define BTN_X BTN_NORTH
519#define BTN_WEST 0x134
520#define BTN_Y BTN_WEST
521#define BTN_Z 0x135
522#define BTN_TL 0x136
523#define BTN_TR 0x137
524#define BTN_TL2 0x138
525#define BTN_TR2 0x139
526#define BTN_SELECT 0x13a
527#define BTN_START 0x13b
528#define BTN_MODE 0x13c
529#define BTN_THUMBL 0x13d
530#define BTN_THUMBR 0x13e
531
532#define BTN_DIGI 0x140
533#define BTN_TOOL_PEN 0x140
534#define BTN_TOOL_RUBBER 0x141
535#define BTN_TOOL_BRUSH 0x142
536#define BTN_TOOL_PENCIL 0x143
537#define BTN_TOOL_AIRBRUSH 0x144
538#define BTN_TOOL_FINGER 0x145
539#define BTN_TOOL_MOUSE 0x146
540#define BTN_TOOL_LENS 0x147
541#define BTN_TOOL_QUINTTAP 0x148 /* Five fingers on trackpad */
542#define BTN_TOUCH 0x14a
543#define BTN_STYLUS 0x14b
544#define BTN_STYLUS2 0x14c
545#define BTN_TOOL_DOUBLETAP 0x14d
546#define BTN_TOOL_TRIPLETAP 0x14e
547#define BTN_TOOL_QUADTAP 0x14f /* Four fingers on trackpad */
548
549#define BTN_WHEEL 0x150
550#define BTN_GEAR_DOWN 0x150
551#define BTN_GEAR_UP 0x151
552
553#define KEY_OK 0x160
554#define KEY_SELECT 0x161
555#define KEY_GOTO 0x162
556#define KEY_CLEAR 0x163
557#define KEY_POWER2 0x164
558#define KEY_OPTION 0x165
559#define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
560#define KEY_TIME 0x167
561#define KEY_VENDOR 0x168
562#define KEY_ARCHIVE 0x169
563#define KEY_PROGRAM 0x16a /* Media Select Program Guide */
564#define KEY_CHANNEL 0x16b
565#define KEY_FAVORITES 0x16c
566#define KEY_EPG 0x16d
567#define KEY_PVR 0x16e /* Media Select Home */
568#define KEY_MHP 0x16f
569#define KEY_LANGUAGE 0x170
570#define KEY_TITLE 0x171
571#define KEY_SUBTITLE 0x172
572#define KEY_ANGLE 0x173
573#define KEY_ZOOM 0x174
574#define KEY_MODE 0x175
575#define KEY_KEYBOARD 0x176
576#define KEY_SCREEN 0x177
577#define KEY_PC 0x178 /* Media Select Computer */
578#define KEY_TV 0x179 /* Media Select TV */
579#define KEY_TV2 0x17a /* Media Select Cable */
580#define KEY_VCR 0x17b /* Media Select VCR */
581#define KEY_VCR2 0x17c /* VCR Plus */
582#define KEY_SAT 0x17d /* Media Select Satellite */
583#define KEY_SAT2 0x17e
584#define KEY_CD 0x17f /* Media Select CD */
585#define KEY_TAPE 0x180 /* Media Select Tape */
586#define KEY_RADIO 0x181
587#define KEY_TUNER 0x182 /* Media Select Tuner */
588#define KEY_PLAYER 0x183
589#define KEY_TEXT 0x184
590#define KEY_DVD 0x185 /* Media Select DVD */
591#define KEY_AUX 0x186
592#define KEY_MP3 0x187
593#define KEY_AUDIO 0x188 /* AL Audio Browser */
594#define KEY_VIDEO 0x189 /* AL Movie Browser */
595#define KEY_DIRECTORY 0x18a
596#define KEY_LIST 0x18b
597#define KEY_MEMO 0x18c /* Media Select Messages */
598#define KEY_CALENDAR 0x18d
599#define KEY_RED 0x18e
600#define KEY_GREEN 0x18f
601#define KEY_YELLOW 0x190
602#define KEY_BLUE 0x191
603#define KEY_CHANNELUP 0x192 /* Channel Increment */
604#define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
605#define KEY_FIRST 0x194
606#define KEY_LAST 0x195 /* Recall Last */
607#define KEY_AB 0x196
608#define KEY_NEXT 0x197
609#define KEY_RESTART 0x198
610#define KEY_SLOW 0x199
611#define KEY_SHUFFLE 0x19a
612#define KEY_BREAK 0x19b
613#define KEY_PREVIOUS 0x19c
614#define KEY_DIGITS 0x19d
615#define KEY_TEEN 0x19e
616#define KEY_TWEN 0x19f
617#define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
618#define KEY_GAMES 0x1a1 /* Media Select Games */
619#define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
620#define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
621#define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
622#define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
623#define KEY_EDITOR 0x1a6 /* AL Text Editor */
624#define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
625#define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
626#define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
627#define KEY_DATABASE 0x1aa /* AL Database App */
628#define KEY_NEWS 0x1ab /* AL Newsreader */
629#define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
630#define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
631#define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
632#define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
633#define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */
634#define KEY_LOGOFF 0x1b1 /* AL Logoff */
635
636#define KEY_DOLLAR 0x1b2
637#define KEY_EURO 0x1b3
638
639#define KEY_FRAMEBACK 0x1b4 /* Consumer - transport controls */
640#define KEY_FRAMEFORWARD 0x1b5
641#define KEY_CONTEXT_MENU 0x1b6 /* GenDesc - system context menu */
642#define KEY_MEDIA_REPEAT 0x1b7 /* Consumer - transport control */
643#define KEY_10CHANNELSUP 0x1b8 /* 10 channels up (10+) */
644#define KEY_10CHANNELSDOWN 0x1b9 /* 10 channels down (10-) */
645#define KEY_IMAGES 0x1ba /* AL Image Browser */
646
647#define KEY_DEL_EOL 0x1c0
648#define KEY_DEL_EOS 0x1c1
649#define KEY_INS_LINE 0x1c2
650#define KEY_DEL_LINE 0x1c3
651
652#define KEY_FN 0x1d0
653#define KEY_FN_ESC 0x1d1
654#define KEY_FN_F1 0x1d2
655#define KEY_FN_F2 0x1d3
656#define KEY_FN_F3 0x1d4
657#define KEY_FN_F4 0x1d5
658#define KEY_FN_F5 0x1d6
659#define KEY_FN_F6 0x1d7
660#define KEY_FN_F7 0x1d8
661#define KEY_FN_F8 0x1d9
662#define KEY_FN_F9 0x1da
663#define KEY_FN_F10 0x1db
664#define KEY_FN_F11 0x1dc
665#define KEY_FN_F12 0x1dd
666#define KEY_FN_1 0x1de
667#define KEY_FN_2 0x1df
668#define KEY_FN_D 0x1e0
669#define KEY_FN_E 0x1e1
670#define KEY_FN_F 0x1e2
671#define KEY_FN_S 0x1e3
672#define KEY_FN_B 0x1e4
673
674#define KEY_BRL_DOT1 0x1f1
675#define KEY_BRL_DOT2 0x1f2
676#define KEY_BRL_DOT3 0x1f3
677#define KEY_BRL_DOT4 0x1f4
678#define KEY_BRL_DOT5 0x1f5
679#define KEY_BRL_DOT6 0x1f6
680#define KEY_BRL_DOT7 0x1f7
681#define KEY_BRL_DOT8 0x1f8
682#define KEY_BRL_DOT9 0x1f9
683#define KEY_BRL_DOT10 0x1fa
684
685#define KEY_NUMERIC_0 0x200 /* used by phones, remote controls, */
686#define KEY_NUMERIC_1 0x201 /* and other keypads */
687#define KEY_NUMERIC_2 0x202
688#define KEY_NUMERIC_3 0x203
689#define KEY_NUMERIC_4 0x204
690#define KEY_NUMERIC_5 0x205
691#define KEY_NUMERIC_6 0x206
692#define KEY_NUMERIC_7 0x207
693#define KEY_NUMERIC_8 0x208
694#define KEY_NUMERIC_9 0x209
695#define KEY_NUMERIC_STAR 0x20a
696#define KEY_NUMERIC_POUND 0x20b
697
698#define KEY_CAMERA_FOCUS 0x210
699#define KEY_WPS_BUTTON 0x211 /* WiFi Protected Setup key */
700
701#define KEY_TOUCHPAD_TOGGLE 0x212 /* Request switch touchpad on or off */
702#define KEY_TOUCHPAD_ON 0x213
703#define KEY_TOUCHPAD_OFF 0x214
704
705#define KEY_CAMERA_ZOOMIN 0x215
706#define KEY_CAMERA_ZOOMOUT 0x216
707#define KEY_CAMERA_UP 0x217
708#define KEY_CAMERA_DOWN 0x218
709#define KEY_CAMERA_LEFT 0x219
710#define KEY_CAMERA_RIGHT 0x21a
711
712#define KEY_ATTENDANT_ON 0x21b
713#define KEY_ATTENDANT_OFF 0x21c
714#define KEY_ATTENDANT_TOGGLE 0x21d /* Attendant call on or off */
715#define KEY_LIGHTS_TOGGLE 0x21e /* Reading light on or off */
716
717#define BTN_DPAD_UP 0x220
718#define BTN_DPAD_DOWN 0x221
719#define BTN_DPAD_LEFT 0x222
720#define BTN_DPAD_RIGHT 0x223
721
722#define KEY_ALS_TOGGLE 0x230 /* Ambient light sensor */
723
724#define BTN_TRIGGER_HAPPY 0x2c0
725#define BTN_TRIGGER_HAPPY1 0x2c0
726#define BTN_TRIGGER_HAPPY2 0x2c1
727#define BTN_TRIGGER_HAPPY3 0x2c2
728#define BTN_TRIGGER_HAPPY4 0x2c3
729#define BTN_TRIGGER_HAPPY5 0x2c4
730#define BTN_TRIGGER_HAPPY6 0x2c5
731#define BTN_TRIGGER_HAPPY7 0x2c6
732#define BTN_TRIGGER_HAPPY8 0x2c7
733#define BTN_TRIGGER_HAPPY9 0x2c8
734#define BTN_TRIGGER_HAPPY10 0x2c9
735#define BTN_TRIGGER_HAPPY11 0x2ca
736#define BTN_TRIGGER_HAPPY12 0x2cb
737#define BTN_TRIGGER_HAPPY13 0x2cc
738#define BTN_TRIGGER_HAPPY14 0x2cd
739#define BTN_TRIGGER_HAPPY15 0x2ce
740#define BTN_TRIGGER_HAPPY16 0x2cf
741#define BTN_TRIGGER_HAPPY17 0x2d0
742#define BTN_TRIGGER_HAPPY18 0x2d1
743#define BTN_TRIGGER_HAPPY19 0x2d2
744#define BTN_TRIGGER_HAPPY20 0x2d3
745#define BTN_TRIGGER_HAPPY21 0x2d4
746#define BTN_TRIGGER_HAPPY22 0x2d5
747#define BTN_TRIGGER_HAPPY23 0x2d6
748#define BTN_TRIGGER_HAPPY24 0x2d7
749#define BTN_TRIGGER_HAPPY25 0x2d8
750#define BTN_TRIGGER_HAPPY26 0x2d9
751#define BTN_TRIGGER_HAPPY27 0x2da
752#define BTN_TRIGGER_HAPPY28 0x2db
753#define BTN_TRIGGER_HAPPY29 0x2dc
754#define BTN_TRIGGER_HAPPY30 0x2dd
755#define BTN_TRIGGER_HAPPY31 0x2de
756#define BTN_TRIGGER_HAPPY32 0x2df
757#define BTN_TRIGGER_HAPPY33 0x2e0
758#define BTN_TRIGGER_HAPPY34 0x2e1
759#define BTN_TRIGGER_HAPPY35 0x2e2
760#define BTN_TRIGGER_HAPPY36 0x2e3
761#define BTN_TRIGGER_HAPPY37 0x2e4
762#define BTN_TRIGGER_HAPPY38 0x2e5
763#define BTN_TRIGGER_HAPPY39 0x2e6
764#define BTN_TRIGGER_HAPPY40 0x2e7
765
766/* We avoid low common keys in module aliases so they don't get huge. */
767#define KEY_MIN_INTERESTING KEY_MUTE
768#define KEY_MAX 0x2ff
769#define KEY_CNT (KEY_MAX+1)
770
771/*
772 * Relative axes
773 */
774
775#define REL_X 0x00
776#define REL_Y 0x01
777#define REL_Z 0x02
778#define REL_RX 0x03
779#define REL_RY 0x04
780#define REL_RZ 0x05
781#define REL_HWHEEL 0x06
782#define REL_DIAL 0x07
783#define REL_WHEEL 0x08
784#define REL_MISC 0x09
785#define REL_MAX 0x0f
786#define REL_CNT (REL_MAX+1)
787
788/*
789 * Absolute axes
790 */
791
792#define ABS_X 0x00
793#define ABS_Y 0x01
794#define ABS_Z 0x02
795#define ABS_RX 0x03
796#define ABS_RY 0x04
797#define ABS_RZ 0x05
798#define ABS_THROTTLE 0x06
799#define ABS_RUDDER 0x07
800#define ABS_WHEEL 0x08
801#define ABS_GAS 0x09
802#define ABS_BRAKE 0x0a
803#define ABS_HAT0X 0x10
804#define ABS_HAT0Y 0x11
805#define ABS_HAT1X 0x12
806#define ABS_HAT1Y 0x13
807#define ABS_HAT2X 0x14
808#define ABS_HAT2Y 0x15
809#define ABS_HAT3X 0x16
810#define ABS_HAT3Y 0x17
811#define ABS_PRESSURE 0x18
812#define ABS_DISTANCE 0x19
813#define ABS_TILT_X 0x1a
814#define ABS_TILT_Y 0x1b
815#define ABS_TOOL_WIDTH 0x1c
816
817#define ABS_VOLUME 0x20
818
819#define ABS_MISC 0x28
820
821#define ABS_MT_SLOT 0x2f /* MT slot being modified */
822#define ABS_MT_TOUCH_MAJOR 0x30 /* Major axis of touching ellipse */
823#define ABS_MT_TOUCH_MINOR 0x31 /* Minor axis (omit if circular) */
824#define ABS_MT_WIDTH_MAJOR 0x32 /* Major axis of approaching ellipse */
825#define ABS_MT_WIDTH_MINOR 0x33 /* Minor axis (omit if circular) */
826#define ABS_MT_ORIENTATION 0x34 /* Ellipse orientation */
827#define ABS_MT_POSITION_X 0x35 /* Center X touch position */
828#define ABS_MT_POSITION_Y 0x36 /* Center Y touch position */
829#define ABS_MT_TOOL_TYPE 0x37 /* Type of touching device */
830#define ABS_MT_BLOB_ID 0x38 /* Group a set of packets as a blob */
831#define ABS_MT_TRACKING_ID 0x39 /* Unique ID of initiated contact */
832#define ABS_MT_PRESSURE 0x3a /* Pressure on contact area */
833#define ABS_MT_DISTANCE 0x3b /* Contact hover distance */
834#define ABS_MT_TOOL_X 0x3c /* Center X tool position */
835#define ABS_MT_TOOL_Y 0x3d /* Center Y tool position */
836
837
838#define ABS_MAX 0x3f
839#define ABS_CNT (ABS_MAX+1)
840
841/*
842 * Switch events
843 */
844
845#define SW_LID 0x00 /* set = lid shut */
846#define SW_TABLET_MODE 0x01 /* set = tablet mode */
847#define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
848#define SW_RFKILL_ALL 0x03 /* rfkill master switch, type "any"
849 set = radio enabled */
850#define SW_RADIO SW_RFKILL_ALL /* deprecated */
851#define SW_MICROPHONE_INSERT 0x04 /* set = inserted */
852#define SW_DOCK 0x05 /* set = plugged into dock */
853#define SW_LINEOUT_INSERT 0x06 /* set = inserted */
854#define SW_JACK_PHYSICAL_INSERT 0x07 /* set = mechanical switch set */
855#define SW_VIDEOOUT_INSERT 0x08 /* set = inserted */
856#define SW_CAMERA_LENS_COVER 0x09 /* set = lens covered */
857#define SW_KEYPAD_SLIDE 0x0a /* set = keypad slide out */
858#define SW_FRONT_PROXIMITY 0x0b /* set = front proximity sensor active */
859#define SW_ROTATE_LOCK 0x0c /* set = rotate locked/disabled */
860#define SW_LINEIN_INSERT 0x0d /* set = inserted */
861#define SW_MUTE_DEVICE 0x0e /* set = device disabled */
862#define SW_MAX 0x0f
863#define SW_CNT (SW_MAX+1)
864
865/*
866 * Misc events
867 */
868
869#define MSC_SERIAL 0x00
870#define MSC_PULSELED 0x01
871#define MSC_GESTURE 0x02
872#define MSC_RAW 0x03
873#define MSC_SCAN 0x04
874#define MSC_TIMESTAMP 0x05
875#define MSC_MAX 0x07
876#define MSC_CNT (MSC_MAX+1)
877
878/*
879 * LEDs
880 */
881
882#define LED_NUML 0x00
883#define LED_CAPSL 0x01
884#define LED_SCROLLL 0x02
885#define LED_COMPOSE 0x03
886#define LED_KANA 0x04
887#define LED_SLEEP 0x05
888#define LED_SUSPEND 0x06
889#define LED_MUTE 0x07
890#define LED_MISC 0x08
891#define LED_MAIL 0x09
892#define LED_CHARGING 0x0a
893#define LED_MAX 0x0f
894#define LED_CNT (LED_MAX+1)
895
896/*
897 * Autorepeat values
898 */
899
900#define REP_DELAY 0x00
901#define REP_PERIOD 0x01
902#define REP_MAX 0x01
903#define REP_CNT (REP_MAX+1)
904
905/*
906 * Sounds
907 */
908
909#define SND_CLICK 0x00
910#define SND_BELL 0x01
911#define SND_TONE 0x02
912#define SND_MAX 0x07
913#define SND_CNT (SND_MAX+1)
914
915/*
916 * IDs.
917 */
918
919#define ID_BUS 0
920#define ID_VENDOR 1
921#define ID_PRODUCT 2
922#define ID_VERSION 3
923
924#define BUS_PCI 0x01
925#define BUS_ISAPNP 0x02
926#define BUS_USB 0x03
927#define BUS_HIL 0x04
928#define BUS_BLUETOOTH 0x05
929#define BUS_VIRTUAL 0x06
930
931#define BUS_ISA 0x10
932#define BUS_I8042 0x11
933#define BUS_XTKBD 0x12
934#define BUS_RS232 0x13
935#define BUS_GAMEPORT 0x14
936#define BUS_PARPORT 0x15
937#define BUS_AMIGA 0x16
938#define BUS_ADB 0x17
939#define BUS_I2C 0x18
940#define BUS_HOST 0x19
941#define BUS_GSC 0x1A
942#define BUS_ATARI 0x1B
943#define BUS_SPI 0x1C
944
945/*
946 * MT_TOOL types
947 */
948#define MT_TOOL_FINGER 0
949#define MT_TOOL_PEN 1
950#define MT_TOOL_MAX 1
951
952/*
953 * Values describing the status of a force-feedback effect
954 */
955#define FF_STATUS_STOPPED 0x00
956#define FF_STATUS_PLAYING 0x01
957#define FF_STATUS_MAX 0x01
958
959/*
960 * Structures used in ioctls to upload effects to a device
961 * They are pieces of a bigger structure (called ff_effect)
962 */
963
964/*
965 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
966 * should not be used and have unspecified results.
967 */
968
969/**
970 * struct ff_replay - defines scheduling of the force-feedback effect
971 * @length: duration of the effect
972 * @delay: delay before effect should start playing
973 */
974struct ff_replay {
975 __u16 length;
976 __u16 delay;
977};
978
979/**
980 * struct ff_trigger - defines what triggers the force-feedback effect
981 * @button: number of the button triggering the effect
982 * @interval: controls how soon the effect can be re-triggered
983 */
984struct ff_trigger {
985 __u16 button;
986 __u16 interval;
987};
988
989/**
990 * struct ff_envelope - generic force-feedback effect envelope
991 * @attack_length: duration of the attack (ms)
992 * @attack_level: level at the beginning of the attack
993 * @fade_length: duration of fade (ms)
994 * @fade_level: level at the end of fade
995 *
996 * The @attack_level and @fade_level are absolute values; when applying
997 * envelope force-feedback core will convert to positive/negative
998 * value based on polarity of the default level of the effect.
999 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
1000 */
1001struct ff_envelope {
1002 __u16 attack_length;
1003 __u16 attack_level;
1004 __u16 fade_length;
1005 __u16 fade_level;
1006};
1007
1008/**
1009 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
1010 * @level: strength of the effect; may be negative
1011 * @envelope: envelope data
1012 */
1013struct ff_constant_effect {
1014 __s16 level;
1015 struct ff_envelope envelope;
1016};
1017
1018/**
1019 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
1020 * @start_level: beginning strength of the effect; may be negative
1021 * @end_level: final strength of the effect; may be negative
1022 * @envelope: envelope data
1023 */
1024struct ff_ramp_effect {
1025 __s16 start_level;
1026 __s16 end_level;
1027 struct ff_envelope envelope;
1028};
1029
1030/**
1031 * struct ff_condition_effect - defines a spring or friction force-feedback effect
1032 * @right_saturation: maximum level when joystick moved all way to the right
1033 * @left_saturation: same for the left side
1034 * @right_coeff: controls how fast the force grows when the joystick moves
1035 * to the right
1036 * @left_coeff: same for the left side
1037 * @deadband: size of the dead zone, where no force is produced
1038 * @center: position of the dead zone
1039 */
1040struct ff_condition_effect {
1041 __u16 right_saturation;
1042 __u16 left_saturation;
1043
1044 __s16 right_coeff;
1045 __s16 left_coeff;
1046
1047 __u16 deadband;
1048 __s16 center;
1049};
1050
1051/**
1052 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
1053 * @waveform: kind of the effect (wave)
1054 * @period: period of the wave (ms)
1055 * @magnitude: peak value
1056 * @offset: mean value of the wave (roughly)
1057 * @phase: 'horizontal' shift
1058 * @envelope: envelope data
1059 * @custom_len: number of samples (FF_CUSTOM only)
1060 * @custom_data: buffer of samples (FF_CUSTOM only)
1061 *
1062 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
1063 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
1064 * for the time being as no driver supports it yet.
1065 *
1066 * Note: the data pointed by custom_data is copied by the driver.
1067 * You can therefore dispose of the memory after the upload/update.
1068 */
1069struct ff_periodic_effect {
1070 __u16 waveform;
1071 __u16 period;
1072 __s16 magnitude;
1073 __s16 offset;
1074 __u16 phase;
1075
1076 struct ff_envelope envelope;
1077
1078 __u32 custom_len;
1079 __s16 *custom_data;
1080};
1081
1082/**
1083 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
1084 * @strong_magnitude: magnitude of the heavy motor
1085 * @weak_magnitude: magnitude of the light one
1086 *
1087 * Some rumble pads have two motors of different weight. Strong_magnitude
1088 * represents the magnitude of the vibration generated by the heavy one.
1089 */
1090struct ff_rumble_effect {
1091 __u16 strong_magnitude;
1092 __u16 weak_magnitude;
1093};
1094
1095/**
1096 * struct ff_effect - defines force feedback effect
1097 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
1098 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
1099 * @id: an unique id assigned to an effect
1100 * @direction: direction of the effect
1101 * @trigger: trigger conditions (struct ff_trigger)
1102 * @replay: scheduling of the effect (struct ff_replay)
1103 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
1104 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
1105 * defining effect parameters
1106 *
1107 * This structure is sent through ioctl from the application to the driver.
1108 * To create a new effect application should set its @id to -1; the kernel
1109 * will return assigned @id which can later be used to update or delete
1110 * this effect.
1111 *
1112 * Direction of the effect is encoded as follows:
1113 * 0 deg -> 0x0000 (down)
1114 * 90 deg -> 0x4000 (left)
1115 * 180 deg -> 0x8000 (up)
1116 * 270 deg -> 0xC000 (right)
1117 */
1118struct ff_effect {
1119 __u16 type;
1120 __s16 id;
1121 __u16 direction;
1122 struct ff_trigger trigger;
1123 struct ff_replay replay;
1124
1125 union {
1126 struct ff_constant_effect constant;
1127 struct ff_ramp_effect ramp;
1128 struct ff_periodic_effect periodic;
1129 struct ff_condition_effect condition[2]; /* One for each axis */
1130 struct ff_rumble_effect rumble;
1131 } u;
1132};
1133
1134/*
1135 * Force feedback effect types
1136 */
1137
1138#define FF_RUMBLE 0x50
1139#define FF_PERIODIC 0x51
1140#define FF_CONSTANT 0x52
1141#define FF_SPRING 0x53
1142#define FF_FRICTION 0x54
1143#define FF_DAMPER 0x55
1144#define FF_INERTIA 0x56
1145#define FF_RAMP 0x57
1146
1147#define FF_EFFECT_MIN FF_RUMBLE
1148#define FF_EFFECT_MAX FF_RAMP
1149
1150/*
1151 * Force feedback periodic effect types
1152 */
1153
1154#define FF_SQUARE 0x58
1155#define FF_TRIANGLE 0x59
1156#define FF_SINE 0x5a
1157#define FF_SAW_UP 0x5b
1158#define FF_SAW_DOWN 0x5c
1159#define FF_CUSTOM 0x5d
1160
1161#define FF_WAVEFORM_MIN FF_SQUARE
1162#define FF_WAVEFORM_MAX FF_CUSTOM
1163
1164/*
1165 * Set ff device properties
1166 */
1167
1168#define FF_GAIN 0x60
1169#define FF_AUTOCENTER 0x61
1170
1171#define FF_MAX 0x7f
1172#define FF_CNT (FF_MAX+1)
1173
1174#endif /* _INPUT_H */
1175