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