input.h 49 KB

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