input.h 33 KB

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