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