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