include/linux/input.h

   1 #ifndef _INPUT_H
   2 #define _INPUT_H
   3
   4 /*
   5  * Copyright (c) 1999-2002 Vojtech Pavlik
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License version 2 as published by
   9  * the Free Software Foundation.
  10  */
  11
  12 #ifdef __KERNEL__
  13 #include <linux/time.h>
  14 #include <linux/list.h>
  15 #else
  16 #include <sys/time.h>
  17 #include <sys/ioctl.h>
  18 #include <sys/types.h>
  19 #include <asm/types.h>
  20 #endif
  21
  22 /*
  23  * The event structure itself
  24  */
  25
  26 struct input_event {
  27         struct timeval time;
  28         __u16 type;
  29         __u16 code;
  30         __s32 value;
  31 };
  32
  33 /*
  34  * Protocol version.
  35  */
  36
  37 #define EV_VERSION              0x010000
  38
  39 /*
  40  * IOCTLs (0x00 - 0x7f)
  41  */
  42
  43 struct input_id {
  44         __u16 bustype;
  45         __u16 vendor;
  46         __u16 product;
  47         __u16 version;
  48 };
  49
  50 struct input_absinfo {
  51         __s32 value;
  52         __s32 minimum;
  53         __s32 maximum;
  54         __s32 fuzz;
  55         __s32 flat;
  56 };
  57
  58 #define EVIOCGVERSION           _IOR('E', 0x01, int)                    /* get driver version */
  59 #define EVIOCGID                _IOR('E', 0x02, struct input_id)        /* get device ID */
  60 #define EVIOCGREP               _IOR('E', 0x03, int[2])                 /* get repeat settings */
  61 #define EVIOCSREP               _IOW('E', 0x03, int[2])                 /* set repeat settings */
  62 #define EVIOCGKEYCODE           _IOR('E', 0x04, int[2])                 /* get keycode */
  63 #define EVIOCSKEYCODE           _IOW('E', 0x04, int[2])                 /* set keycode */
  64
  65 #define EVIOCGNAME(len)         _IOC(_IOC_READ, 'E', 0x06, len)         /* get device name */
  66 #define EVIOCGPHYS(len)         _IOC(_IOC_READ, 'E', 0x07, len)         /* get physical location */
  67 #define EVIOCGUNIQ(len)         _IOC(_IOC_READ, 'E', 0x08, len)         /* get unique identifier */
  68
  69 #define EVIOCGKEY(len)          _IOC(_IOC_READ, 'E', 0x18, len)         /* get global keystate */
  70 #define EVIOCGLED(len)          _IOC(_IOC_READ, 'E', 0x19, len)         /* get all LEDs */
  71 #define EVIOCGSND(len)          _IOC(_IOC_READ, 'E', 0x1a, len)         /* get all sounds status */
  72 #define EVIOCGSW(len)           _IOC(_IOC_READ, 'E', 0x1b, len)         /* get all switch states */
  73
  74 #define EVIOCGBIT(ev,len)       _IOC(_IOC_READ, 'E', 0x20 + ev, len)    /* get event bits */
  75 #define EVIOCGABS(abs)          _IOR('E', 0x40 + abs, struct input_absinfo)             /* get abs value/limits */
  76 #define EVIOCSABS(abs)          _IOW('E', 0xc0 + abs, struct input_absinfo)             /* set abs value/limits */
  77
  78 #define EVIOCSFF                _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))   /* send a force effect to a force feedback device */
  79 #define EVIOCRMFF               _IOW('E', 0x81, int)                    /* Erase a force effect */
  80 #define EVIOCGEFFECTS           _IOR('E', 0x84, int)                    /* Report number of effects playable at the same time */
  81
  82 #define EVIOCGRAB               _IOW('E', 0x90, int)                    /* Grab/Release device */
  83
  84 /*
  85  * Event types
  86  */
  87
  88 #define EV_SYN                  0x00
  89 #define EV_KEY                  0x01
  90 #define EV_REL                  0x02
  91 #define EV_ABS                  0x03
  92 #define EV_MSC                  0x04
  93 #define EV_SW                   0x05
  94 #define EV_LED                  0x11
  95 #define EV_SND                  0x12
  96 #define EV_REP                  0x14
  97 #define EV_FF                   0x15
  98 #define EV_PWR                  0x16
  99 #define EV_FF_STATUS            0x17
 100 #define EV_MAX                  0x1f
 101
 102 /*
 103  * Synchronization events.
 104  */
 105
 106 #define SYN_REPORT              0
 107 #define SYN_CONFIG              1
 108
 109 /*
 110  * Keys and buttons
 111  *
 112  * Most of the keys/buttons are modeled after USB HUT 1.12
 113  * (see http://www.usb.org/developers/hidpage).
 114  * Abbreviations in the comments:
 115  * AC - Application Control
 116  * AL - Application Launch Button
 117  * SC - System Control
 118  */
 119
 120 #define KEY_RESERVED            0
 121 #define KEY_ESC                 1
 122 #define KEY_1                   2
 123 #define KEY_2                   3
 124 #define KEY_3                   4
 125 #define KEY_4                   5
 126 #define KEY_5                   6
 127 #define KEY_6                   7
 128 #define KEY_7                   8
 129 #define KEY_8                   9
 130 #define KEY_9                   10
 131 #define KEY_0                   11
 132 #define KEY_MINUS               12
 133 #define KEY_EQUAL               13
 134 #define KEY_BACKSPACE           14
 135 #define KEY_TAB                 15
 136 #define KEY_Q                   16
 137 #define KEY_W                   17
 138 #define KEY_E                   18
 139 #define KEY_R                   19
 140 #define KEY_T                   20
 141 #define KEY_Y                   21
 142 #define KEY_U                   22
 143 #define KEY_I                   23
 144 #define KEY_O                   24
 145 #define KEY_P                   25
 146 #define KEY_LEFTBRACE           26
 147 #define KEY_RIGHTBRACE          27
 148 #define KEY_ENTER               28
 149 #define KEY_LEFTCTRL            29
 150 #define KEY_A                   30
 151 #define KEY_S                   31
 152 #define KEY_D                   32
 153 #define KEY_F                   33
 154 #define KEY_G                   34
 155 #define KEY_H                   35
 156 #define KEY_J                   36
 157 #define KEY_K                   37
 158 #define KEY_L                   38
 159 #define KEY_SEMICOLON           39
 160 #define KEY_APOSTROPHE          40
 161 #define KEY_GRAVE               41
 162 #define KEY_LEFTSHIFT           42
 163 #define KEY_BACKSLASH           43
 164 #define KEY_Z                   44
 165 #define KEY_X                   45
 166 #define KEY_C                   46
 167 #define KEY_V                   47
 168 #define KEY_B                   48
 169 #define KEY_N                   49
 170 #define KEY_M                   50
 171 #define KEY_COMMA               51
 172 #define KEY_DOT                 52
 173 #define KEY_SLASH               53
 174 #define KEY_RIGHTSHIFT          54
 175 #define KEY_KPASTERISK          55
 176 #define KEY_LEFTALT             56
 177 #define KEY_SPACE               57
 178 #define KEY_CAPSLOCK            58
 179 #define KEY_F1                  59
 180 #define KEY_F2                  60
 181 #define KEY_F3                  61
 182 #define KEY_F4                  62
 183 #define KEY_F5                  63
 184 #define KEY_F6                  64
 185 #define KEY_F7                  65
 186 #define KEY_F8                  66
 187 #define KEY_F9                  67
 188 #define KEY_F10                 68
 189 #define KEY_NUMLOCK             69
 190 #define KEY_SCROLLLOCK          70
 191 #define KEY_KP7                 71
 192 #define KEY_KP8                 72
 193 #define KEY_KP9                 73
 194 #define KEY_KPMINUS             74
 195 #define KEY_KP4                 75
 196 #define KEY_KP5                 76
 197 #define KEY_KP6                 77
 198 #define KEY_KPPLUS              78
 199 #define KEY_KP1                 79
 200 #define KEY_KP2                 80
 201 #define KEY_KP3                 81
 202 #define KEY_KP0                 82
 203 #define KEY_KPDOT               83
 204
 205 #define KEY_ZENKAKUHANKAKU      85
 206 #define KEY_102ND               86
 207 #define KEY_F11                 87
 208 #define KEY_F12                 88
 209 #define KEY_RO                  89
 210 #define KEY_KATAKANA            90
 211 #define KEY_HIRAGANA            91
 212 #define KEY_HENKAN              92
 213 #define KEY_KATAKANAHIRAGANA    93
 214 #define KEY_MUHENKAN            94
 215 #define KEY_KPJPCOMMA           95
 216 #define KEY_KPENTER             96
 217 #define KEY_RIGHTCTRL           97
 218 #define KEY_KPSLASH             98
 219 #define KEY_SYSRQ               99
 220 #define KEY_RIGHTALT            100
 221 #define KEY_LINEFEED            101
 222 #define KEY_HOME                102
 223 #define KEY_UP                  103
 224 #define KEY_PAGEUP              104
 225 #define KEY_LEFT                105
 226 #define KEY_RIGHT               106
 227 #define KEY_END                 107
 228 #define KEY_DOWN                108
 229 #define KEY_PAGEDOWN            109
 230 #define KEY_INSERT              110
 231 #define KEY_DELETE              111
 232 #define KEY_MACRO               112
 233 #define KEY_MUTE                113
 234 #define KEY_VOLUMEDOWN          114
 235 #define KEY_VOLUMEUP            115
 236 #define KEY_POWER               116     /* SC System Power Down */
 237 #define KEY_KPEQUAL             117
 238 #define KEY_KPPLUSMINUS         118
 239 #define KEY_PAUSE               119
 240
 241 #define KEY_KPCOMMA             121
 242 #define KEY_HANGEUL             122
 243 #define KEY_HANGUEL             KEY_HANGEUL
 244 #define KEY_HANJA               123
 245 #define KEY_YEN                 124
 246 #define KEY_LEFTMETA            125
 247 #define KEY_RIGHTMETA           126
 248 #define KEY_COMPOSE             127
 249
 250 #define KEY_STOP                128     /* AC Stop */
 251 #define KEY_AGAIN               129
 252 #define KEY_PROPS               130     /* AC Properties */
 253 #define KEY_UNDO                131     /* AC Undo */
 254 #define KEY_FRONT               132
 255 #define KEY_COPY                133     /* AC Copy */
 256 #define KEY_OPEN                134     /* AC Open */
 257 #define KEY_PASTE               135     /* AC Paste */
 258 #define KEY_FIND                136     /* AC Search */
 259 #define KEY_CUT                 137     /* AC Cut */
 260 #define KEY_HELP                138     /* AL Integrated Help Center */
 261 #define KEY_MENU                139     /* Menu (show menu) */
 262 #define KEY_CALC                140     /* AL Calculator */
 263 #define KEY_SETUP               141
 264 #define KEY_SLEEP               142     /* SC System Sleep */
 265 #define KEY_WAKEUP              143     /* System Wake Up */
 266 #define KEY_FILE                144     /* AL Local Machine Browser */
 267 #define KEY_SENDFILE            145
 268 #define KEY_DELETEFILE          146
 269 #define KEY_XFER                147
 270 #define KEY_PROG1               148
 271 #define KEY_PROG2               149
 272 #define KEY_WWW                 150     /* AL Internet Browser */
 273 #define KEY_MSDOS               151
 274 #define KEY_COFFEE              152     /* AL Terminal Lock/Screensaver */
 275 #define KEY_SCREENLOCK          KEY_COFFEE
 276 #define KEY_DIRECTION           153
 277 #define KEY_CYCLEWINDOWS        154
 278 #define KEY_MAIL                155
 279 #define KEY_BOOKMARKS           156     /* AC Bookmarks */
 280 #define KEY_COMPUTER            157
 281 #define KEY_BACK                158     /* AC Back */
 282 #define KEY_FORWARD             159     /* AC Forward */
 283 #define KEY_CLOSECD             160
 284 #define KEY_EJECTCD             161
 285 #define KEY_EJECTCLOSECD        162
 286 #define KEY_NEXTSONG            163
 287 #define KEY_PLAYPAUSE           164
 288 #define KEY_PREVIOUSSONG        165
 289 #define KEY_STOPCD              166
 290 #define KEY_RECORD              167
 291 #define KEY_REWIND              168
 292 #define KEY_PHONE               169     /* Media Select Telephone */
 293 #define KEY_ISO                 170
 294 #define KEY_CONFIG              171     /* AL Consumer Control Configuration */
 295 #define KEY_HOMEPAGE            172     /* AC Home */
 296 #define KEY_REFRESH             173     /* AC Refresh */
 297 #define KEY_EXIT                174     /* AC Exit */
 298 #define KEY_MOVE                175
 299 #define KEY_EDIT                176
 300 #define KEY_SCROLLUP            177
 301 #define KEY_SCROLLDOWN          178
 302 #define KEY_KPLEFTPAREN         179
 303 #define KEY_KPRIGHTPAREN        180
 304 #define KEY_NEW                 181     /* AC New */
 305 #define KEY_REDO                182     /* AC Redo/Repeat */
 306
 307 #define KEY_F13                 183
 308 #define KEY_F14                 184
 309 #define KEY_F15                 185
 310 #define KEY_F16                 186
 311 #define KEY_F17                 187
 312 #define KEY_F18                 188
 313 #define KEY_F19                 189
 314 #define KEY_F20                 190
 315 #define KEY_F21                 191
 316 #define KEY_F22                 192
 317 #define KEY_F23                 193
 318 #define KEY_F24                 194
 319
 320 #define KEY_PLAYCD              200
 321 #define KEY_PAUSECD             201
 322 #define KEY_PROG3               202
 323 #define KEY_PROG4               203
 324 #define KEY_SUSPEND             205
 325 #define KEY_CLOSE               206     /* AC Close */
 326 #define KEY_PLAY                207
 327 #define KEY_FASTFORWARD         208
 328 #define KEY_BASSBOOST           209
 329 #define KEY_PRINT               210     /* AC Print */
 330 #define KEY_HP                  211
 331 #define KEY_CAMERA              212
 332 #define KEY_SOUND               213
 333 #define KEY_QUESTION            214
 334 #define KEY_EMAIL               215
 335 #define KEY_CHAT                216
 336 #define KEY_SEARCH              217
 337 #define KEY_CONNECT             218
 338 #define KEY_FINANCE             219     /* AL Checkbook/Finance */
 339 #define KEY_SPORT               220
 340 #define KEY_SHOP                221
 341 #define KEY_ALTERASE            222
 342 #define KEY_CANCEL              223     /* AC Cancel */
 343 #define KEY_BRIGHTNESSDOWN      224
 344 #define KEY_BRIGHTNESSUP        225
 345 #define KEY_MEDIA               226
 346
 347 #define KEY_SWITCHVIDEOMODE     227
 348 #define KEY_KBDILLUMTOGGLE      228
 349 #define KEY_KBDILLUMDOWN        229
 350 #define KEY_KBDILLUMUP          230
 351
 352 #define KEY_SEND                231     /* AC Send */
 353 #define KEY_REPLY               232     /* AC Reply */
 354 #define KEY_FORWARDMAIL         233     /* AC Forward Msg */
 355 #define KEY_SAVE                234     /* AC Save */
 356 #define KEY_DOCUMENTS           235
 357
 358 #define KEY_BATTERY             236
 359
 360 #define KEY_BLUETOOTH           237
 361 #define KEY_WLAN                238
 362
 363 #define KEY_UNKNOWN             240
 364
 365 #define BTN_MISC                0x100
 366 #define BTN_0                   0x100
 367 #define BTN_1                   0x101
 368 #define BTN_2                   0x102
 369 #define BTN_3                   0x103
 370 #define BTN_4                   0x104
 371 #define BTN_5                   0x105
 372 #define BTN_6                   0x106
 373 #define BTN_7                   0x107
 374 #define BTN_8                   0x108
 375 #define BTN_9                   0x109
 376
 377 #define BTN_MOUSE               0x110
 378 #define BTN_LEFT                0x110
 379 #define BTN_RIGHT               0x111
 380 #define BTN_MIDDLE              0x112
 381 #define BTN_SIDE                0x113
 382 #define BTN_EXTRA               0x114
 383 #define BTN_FORWARD             0x115
 384 #define BTN_BACK                0x116
 385 #define BTN_TASK                0x117
 386
 387 #define BTN_JOYSTICK            0x120
 388 #define BTN_TRIGGER             0x120
 389 #define BTN_THUMB               0x121
 390 #define BTN_THUMB2              0x122
 391 #define BTN_TOP                 0x123
 392 #define BTN_TOP2                0x124
 393 #define BTN_PINKIE              0x125
 394 #define BTN_BASE                0x126
 395 #define BTN_BASE2               0x127
 396 #define BTN_BASE3               0x128
 397 #define BTN_BASE4               0x129
 398 #define BTN_BASE5               0x12a
 399 #define BTN_BASE6               0x12b
 400 #define BTN_DEAD                0x12f
 401
 402 #define BTN_GAMEPAD             0x130
 403 #define BTN_A                   0x130
 404 #define BTN_B                   0x131
 405 #define BTN_C                   0x132
 406 #define BTN_X                   0x133
 407 #define BTN_Y                   0x134
 408 #define BTN_Z                   0x135
 409 #define BTN_TL                  0x136
 410 #define BTN_TR                  0x137
 411 #define BTN_TL2                 0x138
 412 #define BTN_TR2                 0x139
 413 #define BTN_SELECT              0x13a
 414 #define BTN_START               0x13b
 415 #define BTN_MODE                0x13c
 416 #define BTN_THUMBL              0x13d
 417 #define BTN_THUMBR              0x13e
 418
 419 #define BTN_DIGI                0x140
 420 #define BTN_TOOL_PEN            0x140
 421 #define BTN_TOOL_RUBBER         0x141
 422 #define BTN_TOOL_BRUSH          0x142
 423 #define BTN_TOOL_PENCIL         0x143
 424 #define BTN_TOOL_AIRBRUSH       0x144
 425 #define BTN_TOOL_FINGER         0x145
 426 #define BTN_TOOL_MOUSE          0x146
 427 #define BTN_TOOL_LENS           0x147
 428 #define BTN_TOUCH               0x14a
 429 #define BTN_STYLUS              0x14b
 430 #define BTN_STYLUS2             0x14c
 431 #define BTN_TOOL_DOUBLETAP      0x14d
 432 #define BTN_TOOL_TRIPLETAP      0x14e
 433
 434 #define BTN_WHEEL               0x150
 435 #define BTN_GEAR_DOWN           0x150
 436 #define BTN_GEAR_UP             0x151
 437
 438 #define KEY_OK                  0x160
 439 #define KEY_SELECT              0x161
 440 #define KEY_GOTO                0x162
 441 #define KEY_CLEAR               0x163
 442 #define KEY_POWER2              0x164
 443 #define KEY_OPTION              0x165
 444 #define KEY_INFO                0x166   /* AL OEM Features/Tips/Tutorial */
 445 #define KEY_TIME                0x167
 446 #define KEY_VENDOR              0x168
 447 #define KEY_ARCHIVE             0x169
 448 #define KEY_PROGRAM             0x16a   /* Media Select Program Guide */
 449 #define KEY_CHANNEL             0x16b
 450 #define KEY_FAVORITES           0x16c
 451 #define KEY_EPG                 0x16d
 452 #define KEY_PVR                 0x16e   /* Media Select Home */
 453 #define KEY_MHP                 0x16f
 454 #define KEY_LANGUAGE            0x170
 455 #define KEY_TITLE               0x171
 456 #define KEY_SUBTITLE            0x172
 457 #define KEY_ANGLE               0x173
 458 #define KEY_ZOOM                0x174
 459 #define KEY_MODE                0x175
 460 #define KEY_KEYBOARD            0x176
 461 #define KEY_SCREEN              0x177
 462 #define KEY_PC                  0x178   /* Media Select Computer */
 463 #define KEY_TV                  0x179   /* Media Select TV */
 464 #define KEY_TV2                 0x17a   /* Media Select Cable */
 465 #define KEY_VCR                 0x17b   /* Media Select VCR */
 466 #define KEY_VCR2                0x17c   /* VCR Plus */
 467 #define KEY_SAT                 0x17d   /* Media Select Satellite */
 468 #define KEY_SAT2                0x17e
 469 #define KEY_CD                  0x17f   /* Media Select CD */
 470 #define KEY_TAPE                0x180   /* Media Select Tape */
 471 #define KEY_RADIO               0x181
 472 #define KEY_TUNER               0x182   /* Media Select Tuner */
 473 #define KEY_PLAYER              0x183
 474 #define KEY_TEXT                0x184
 475 #define KEY_DVD                 0x185   /* Media Select DVD */
 476 #define KEY_AUX                 0x186
 477 #define KEY_MP3                 0x187
 478 #define KEY_AUDIO               0x188
 479 #define KEY_VIDEO               0x189
 480 #define KEY_DIRECTORY           0x18a
 481 #define KEY_LIST                0x18b
 482 #define KEY_MEMO                0x18c   /* Media Select Messages */
 483 #define KEY_CALENDAR            0x18d
 484 #define KEY_RED                 0x18e
 485 #define KEY_GREEN               0x18f
 486 #define KEY_YELLOW              0x190
 487 #define KEY_BLUE                0x191
 488 #define KEY_CHANNELUP           0x192   /* Channel Increment */
 489 #define KEY_CHANNELDOWN         0x193   /* Channel Decrement */
 490 #define KEY_FIRST               0x194
 491 #define KEY_LAST                0x195   /* Recall Last */
 492 #define KEY_AB                  0x196
 493 #define KEY_NEXT                0x197
 494 #define KEY_RESTART             0x198
 495 #define KEY_SLOW                0x199
 496 #define KEY_SHUFFLE             0x19a
 497 #define KEY_BREAK               0x19b
 498 #define KEY_PREVIOUS            0x19c
 499 #define KEY_DIGITS              0x19d
 500 #define KEY_TEEN                0x19e
 501 #define KEY_TWEN                0x19f
 502 #define KEY_VIDEOPHONE          0x1a0   /* Media Select Video Phone */
 503 #define KEY_GAMES               0x1a1   /* Media Select Games */
 504 #define KEY_ZOOMIN              0x1a2   /* AC Zoom In */
 505 #define KEY_ZOOMOUT             0x1a3   /* AC Zoom Out */
 506 #define KEY_ZOOMRESET           0x1a4   /* AC Zoom */
 507 #define KEY_WORDPROCESSOR       0x1a5   /* AL Word Processor */
 508 #define KEY_EDITOR              0x1a6   /* AL Text Editor */
 509 #define KEY_SPREADSHEET         0x1a7   /* AL Spreadsheet */
 510 #define KEY_GRAPHICSEDITOR      0x1a8   /* AL Graphics Editor */
 511 #define KEY_PRESENTATION        0x1a9   /* AL Presentation App */
 512 #define KEY_DATABASE            0x1aa   /* AL Database App */
 513 #define KEY_NEWS                0x1ab   /* AL Newsreader */
 514 #define KEY_VOICEMAIL           0x1ac   /* AL Voicemail */
 515 #define KEY_ADDRESSBOOK         0x1ad   /* AL Contacts/Address Book */
 516 #define KEY_MESSENGER           0x1ae   /* AL Instant Messaging */
 517 #define KEY_DISPLAYTOGGLE       0x1af   /* Turn display (LCD) on and off */
 518
 519 #define KEY_DEL_EOL             0x1c0
 520 #define KEY_DEL_EOS             0x1c1
 521 #define KEY_INS_LINE            0x1c2
 522 #define KEY_DEL_LINE            0x1c3
 523
 524 #define KEY_FN                  0x1d0
 525 #define KEY_FN_ESC              0x1d1
 526 #define KEY_FN_F1               0x1d2
 527 #define KEY_FN_F2               0x1d3
 528 #define KEY_FN_F3               0x1d4
 529 #define KEY_FN_F4               0x1d5
 530 #define KEY_FN_F5               0x1d6
 531 #define KEY_FN_F6               0x1d7
 532 #define KEY_FN_F7               0x1d8
 533 #define KEY_FN_F8               0x1d9
 534 #define KEY_FN_F9               0x1da
 535 #define KEY_FN_F10              0x1db
 536 #define KEY_FN_F11              0x1dc
 537 #define KEY_FN_F12              0x1dd
 538 #define KEY_FN_1                0x1de
 539 #define KEY_FN_2                0x1df
 540 #define KEY_FN_D                0x1e0
 541 #define KEY_FN_E                0x1e1
 542 #define KEY_FN_F                0x1e2
 543 #define KEY_FN_S                0x1e3
 544 #define KEY_FN_B                0x1e4
 545
 546 #define KEY_BRL_DOT1            0x1f1
 547 #define KEY_BRL_DOT2            0x1f2
 548 #define KEY_BRL_DOT3            0x1f3
 549 #define KEY_BRL_DOT4            0x1f4
 550 #define KEY_BRL_DOT5            0x1f5
 551 #define KEY_BRL_DOT6            0x1f6
 552 #define KEY_BRL_DOT7            0x1f7
 553 #define KEY_BRL_DOT8            0x1f8
 554
 555 /* We avoid low common keys in module aliases so they don't get huge. */
 556 #define KEY_MIN_INTERESTING     KEY_MUTE
 557 #define KEY_MAX                 0x1ff
 558
 559 /*
 560  * Relative axes
 561  */
 562
 563 #define REL_X                   0x00
 564 #define REL_Y                   0x01
 565 #define REL_Z                   0x02
 566 #define REL_RX                  0x03
 567 #define REL_RY                  0x04
 568 #define REL_RZ                  0x05
 569 #define REL_HWHEEL              0x06
 570 #define REL_DIAL                0x07
 571 #define REL_WHEEL               0x08
 572 #define REL_MISC                0x09
 573 #define REL_MAX                 0x0f
 574
 575 /*
 576  * Absolute axes
 577  */
 578
 579 #define ABS_X                   0x00
 580 #define ABS_Y                   0x01
 581 #define ABS_Z                   0x02
 582 #define ABS_RX                  0x03
 583 #define ABS_RY                  0x04
 584 #define ABS_RZ                  0x05
 585 #define ABS_THROTTLE            0x06
 586 #define ABS_RUDDER              0x07
 587 #define ABS_WHEEL               0x08
 588 #define ABS_GAS                 0x09
 589 #define ABS_BRAKE               0x0a
 590 #define ABS_HAT0X               0x10
 591 #define ABS_HAT0Y               0x11
 592 #define ABS_HAT1X               0x12
 593 #define ABS_HAT1Y               0x13
 594 #define ABS_HAT2X               0x14
 595 #define ABS_HAT2Y               0x15
 596 #define ABS_HAT3X               0x16
 597 #define ABS_HAT3Y               0x17
 598 #define ABS_PRESSURE            0x18
 599 #define ABS_DISTANCE            0x19
 600 #define ABS_TILT_X              0x1a
 601 #define ABS_TILT_Y              0x1b
 602 #define ABS_TOOL_WIDTH          0x1c
 603 #define ABS_VOLUME              0x20
 604 #define ABS_MISC                0x28
 605 #define ABS_MAX                 0x3f
 606
 607 /*
 608  * Switch events
 609  */
 610
 611 #define SW_LID                  0x00  /* set = lid shut */
 612 #define SW_TABLET_MODE          0x01  /* set = tablet mode */
 613 #define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
 614 #define SW_RADIO                0x03  /* set = radio enabled */
 615 #define SW_MAX                  0x0f
 616
 617 /*
 618  * Misc events
 619  */
 620
 621 #define MSC_SERIAL              0x00
 622 #define MSC_PULSELED            0x01
 623 #define MSC_GESTURE             0x02
 624 #define MSC_RAW                 0x03
 625 #define MSC_SCAN                0x04
 626 #define MSC_MAX                 0x07
 627
 628 /*
 629  * LEDs
 630  */
 631
 632 #define LED_NUML                0x00
 633 #define LED_CAPSL               0x01
 634 #define LED_SCROLLL             0x02
 635 #define LED_COMPOSE             0x03
 636 #define LED_KANA                0x04
 637 #define LED_SLEEP               0x05
 638 #define LED_SUSPEND             0x06
 639 #define LED_MUTE                0x07
 640 #define LED_MISC                0x08
 641 #define LED_MAIL                0x09
 642 #define LED_CHARGING            0x0a
 643 #define LED_MAX                 0x0f
 644
 645 /*
 646  * Autorepeat values
 647  */
 648
 649 #define REP_DELAY               0x00
 650 #define REP_PERIOD              0x01
 651 #define REP_MAX                 0x01
 652
 653 /*
 654  * Sounds
 655  */
 656
 657 #define SND_CLICK               0x00
 658 #define SND_BELL                0x01
 659 #define SND_TONE                0x02
 660 #define SND_MAX                 0x07
 661
 662 /*
 663  * IDs.
 664  */
 665
 666 #define ID_BUS                  0
 667 #define ID_VENDOR               1
 668 #define ID_PRODUCT              2
 669 #define ID_VERSION              3
 670
 671 #define BUS_PCI                 0x01
 672 #define BUS_ISAPNP              0x02
 673 #define BUS_USB                 0x03
 674 #define BUS_HIL                 0x04
 675 #define BUS_BLUETOOTH           0x05
 676 #define BUS_VIRTUAL             0x06
 677
 678 #define BUS_ISA                 0x10
 679 #define BUS_I8042               0x11
 680 #define BUS_XTKBD               0x12
 681 #define BUS_RS232               0x13
 682 #define BUS_GAMEPORT            0x14
 683 #define BUS_PARPORT             0x15
 684 #define BUS_AMIGA               0x16
 685 #define BUS_ADB                 0x17
 686 #define BUS_I2C                 0x18
 687 #define BUS_HOST                0x19
 688 #define BUS_GSC                 0x1A
 689 #define BUS_ATARI               0x1B
 690
 691 /*
 692  * Values describing the status of a force-feedback effect
 693  */
 694 #define FF_STATUS_STOPPED       0x00
 695 #define FF_STATUS_PLAYING       0x01
 696 #define FF_STATUS_MAX           0x01
 697
 698 /*
 699  * Structures used in ioctls to upload effects to a device
 700  * They are pieces of a bigger structure (called ff_effect)
 701  */
 702
 703 /*
 704  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
 705  * should not be used and have unspecified results.
 706  */
 707
 708 /**
 709  * struct ff_replay - defines scheduling of the force-feedback effect
 710  * @length: duration of the effect
 711  * @delay: delay before effect should start playing
 712  */
 713 struct ff_replay {
 714         __u16 length;
 715         __u16 delay;
 716 };
 717
 718 /**
 719  * struct ff_trigger - defines what triggers the force-feedback effect
 720  * @button: number of the button triggering the effect
 721  * @interval: controls how soon the effect can be re-triggered
 722  */
 723 struct ff_trigger {
 724         __u16 button;
 725         __u16 interval;
 726 };
 727
 728 /**
 729  * struct ff_envelope - generic force-feedback effect envelope
 730  * @attack_length: duration of the attack (ms)
 731  * @attack_level: level at the beginning of the attack
 732  * @fade_length: duration of fade (ms)
 733  * @fade_level: level at the end of fade
 734  *
 735  * The @attack_level and @fade_level are absolute values; when applying
 736  * envelope force-feedback core will convert to positive/negative
 737  * value based on polarity of the default level of the effect.
 738  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
 739  */
 740 struct ff_envelope {
 741         __u16 attack_length;
 742         __u16 attack_level;
 743         __u16 fade_length;
 744         __u16 fade_level;
 745 };
 746
 747 /**
 748  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
 749  * @level: strength of the effect; may be negative
 750  * @envelope: envelope data
 751  */
 752 struct ff_constant_effect {
 753         __s16 level;
 754         struct ff_envelope envelope;
 755 };
 756
 757 /**
 758  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
 759  * @start_level: beginning strength of the effect; may be negative
 760  * @end_level: final strength of the effect; may be negative
 761  * @envelope: envelope data
 762  */
 763 struct ff_ramp_effect {
 764         __s16 start_level;
 765         __s16 end_level;
 766         struct ff_envelope envelope;
 767 };
 768
 769 /**
 770  * struct ff_condition_effect - defines a spring or friction force-feedback effect
 771  * @right_saturation: maximum level when joystick moved all way to the right
 772  * @left_saturation: same for the left side
 773  * @right_coeff: controls how fast the force grows when the joystick moves
 774  *      to the right
 775  * @left_coeff: same for the left side
 776  * @deadband: size of the dead zone, where no force is produced
 777  * @center: position of the dead zone
 778  */
 779 struct ff_condition_effect {
 780         __u16 right_saturation;
 781         __u16 left_saturation;
 782
 783         __s16 right_coeff;
 784         __s16 left_coeff;
 785
 786         __u16 deadband;
 787         __s16 center;
 788 };
 789
 790 /**
 791  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
 792  * @waveform: kind of the effect (wave)
 793  * @period: period of the wave (ms)
 794  * @magnitude: peak value
 795  * @offset: mean value of the wave (roughly)
 796  * @phase: 'horizontal' shift
 797  * @envelope: envelope data
 798  * @custom_len: number of samples (FF_CUSTOM only)
 799  * @custom_data: buffer of samples (FF_CUSTOM only)
 800  *
 801  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
 802  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
 803  * for the time being as no driver supports it yet.
 804  *
 805  * Note: the data pointed by custom_data is copied by the driver.
 806  * You can therefore dispose of the memory after the upload/update.
 807  */
 808 struct ff_periodic_effect {
 809         __u16 waveform;
 810         __u16 period;
 811         __s16 magnitude;
 812         __s16 offset;
 813         __u16 phase;
 814
 815         struct ff_envelope envelope;
 816
 817         __u32 custom_len;
 818         __s16 *custom_data;
 819 };
 820
 821 /**
 822  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
 823  * @strong_magnitude: magnitude of the heavy motor
 824  * @weak_magnitude: magnitude of the light one
 825  *
 826  * Some rumble pads have two motors of different weight. Strong_magnitude
 827  * represents the magnitude of the vibration generated by the heavy one.
 828  */
 829 struct ff_rumble_effect {
 830         __u16 strong_magnitude;
 831         __u16 weak_magnitude;
 832 };
 833
 834 /**
 835  * struct ff_effect - defines force feedback effect
 836  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
 837  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
 838  * @id: an unique id assigned to an effect
 839  * @direction: direction of the effect
 840  * @trigger: trigger conditions (struct ff_trigger)
 841  * @replay: scheduling of the effect (struct ff_replay)
 842  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
 843  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
 844  *      defining effect parameters
 845  *
 846  * This structure is sent through ioctl from the application to the driver.
 847  * To create a new effect aplication should set its @id to -1; the kernel
 848  * will return assigned @id which can later be used to update or delete
 849  * this effect.
 850  *
 851  * Direction of the effect is encoded as follows:
 852  *      0 deg -> 0x0000 (down)
 853  *      90 deg -> 0x4000 (left)
 854  *      180 deg -> 0x8000 (up)
 855  *      270 deg -> 0xC000 (right)
 856  */
 857 struct ff_effect {
 858         __u16 type;
 859         __s16 id;
 860         __u16 direction;
 861         struct ff_trigger trigger;
 862         struct ff_replay replay;
 863
 864         union {
 865                 struct ff_constant_effect constant;
 866                 struct ff_ramp_effect ramp;
 867                 struct ff_periodic_effect periodic;
 868                 struct ff_condition_effect condition[2]; /* One for each axis */
 869                 struct ff_rumble_effect rumble;
 870         } u;
 871 };
 872
 873 /*
 874  * Force feedback effect types
 875  */
 876
 877 #define FF_RUMBLE       0x50
 878 #define FF_PERIODIC     0x51
 879 #define FF_CONSTANT     0x52
 880 #define FF_SPRING       0x53
 881 #define FF_FRICTION     0x54
 882 #define FF_DAMPER       0x55
 883 #define FF_INERTIA      0x56
 884 #define FF_RAMP         0x57
 885
 886 #define FF_EFFECT_MIN   FF_RUMBLE
 887 #define FF_EFFECT_MAX   FF_RAMP
 888
 889 /*
 890  * Force feedback periodic effect types
 891  */
 892
 893 #define FF_SQUARE       0x58
 894 #define FF_TRIANGLE     0x59
 895 #define FF_SINE         0x5a
 896 #define FF_SAW_UP       0x5b
 897 #define FF_SAW_DOWN     0x5c
 898 #define FF_CUSTOM       0x5d
 899
 900 #define FF_WAVEFORM_MIN FF_SQUARE
 901 #define FF_WAVEFORM_MAX FF_CUSTOM
 902
 903 /*
 904  * Set ff device properties
 905  */
 906
 907 #define FF_GAIN         0x60
 908 #define FF_AUTOCENTER   0x61
 909
 910 #define FF_MAX          0x7f
 911
 912 #ifdef __KERNEL__
 913
 914 /*
 915  * In-kernel definitions.
 916  */
 917
 918 #include <linux/device.h>
 919 #include <linux/fs.h>
 920 #include <linux/timer.h>
 921 #include <linux/mod_devicetable.h>
 922
 923 #define NBITS(x) (((x)/BITS_PER_LONG)+1)
 924 #define BIT(x)  (1UL<<((x)%BITS_PER_LONG))
 925 #define LONG(x) ((x)/BITS_PER_LONG)
 926
 927 struct input_dev {
 928
 929         void *private;
 930
 931         const char *name;
 932         const char *phys;
 933         const char *uniq;
 934         struct input_id id;
 935
 936         unsigned long evbit[NBITS(EV_MAX)];
 937         unsigned long keybit[NBITS(KEY_MAX)];
 938         unsigned long relbit[NBITS(REL_MAX)];
 939         unsigned long absbit[NBITS(ABS_MAX)];
 940         unsigned long mscbit[NBITS(MSC_MAX)];
 941         unsigned long ledbit[NBITS(LED_MAX)];
 942         unsigned long sndbit[NBITS(SND_MAX)];
 943         unsigned long ffbit[NBITS(FF_MAX)];
 944         unsigned long swbit[NBITS(SW_MAX)];
 945
 946         unsigned int keycodemax;
 947         unsigned int keycodesize;
 948         void *keycode;
 949         int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
 950         int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
 951
 952         struct ff_device *ff;
 953
 954         unsigned int repeat_key;
 955         struct timer_list timer;
 956
 957         int state;
 958
 959         int sync;
 960
 961         int abs[ABS_MAX + 1];
 962         int rep[REP_MAX + 1];
 963
 964         unsigned long key[NBITS(KEY_MAX)];
 965         unsigned long led[NBITS(LED_MAX)];
 966         unsigned long snd[NBITS(SND_MAX)];
 967         unsigned long sw[NBITS(SW_MAX)];
 968
 969         int absmax[ABS_MAX + 1];
 970         int absmin[ABS_MAX + 1];
 971         int absfuzz[ABS_MAX + 1];
 972         int absflat[ABS_MAX + 1];
 973
 974         int (*open)(struct input_dev *dev);
 975         void (*close)(struct input_dev *dev);
 976         int (*flush)(struct input_dev *dev, struct file *file);
 977         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
 978
 979         struct input_handle *grab;
 980
 981         struct mutex mutex;     /* serializes open and close operations */
 982         unsigned int users;
 983
 984         struct device dev;
 985         union {                 /* temporarily so while we switching to struct device */
 986                 struct device *dev;
 987         } cdev;
 988
 989         struct list_head        h_list;
 990         struct list_head        node;
 991 };
 992 #define to_input_dev(d) container_of(d, struct input_dev, dev)
 993
 994 /*
 995  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
 996  */
 997
 998 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
 999 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1000 #endif
1001
1002 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1003 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1004 #endif
1005
1006 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1007 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1008 #endif
1009
1010 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1011 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1012 #endif
1013
1014 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1015 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1016 #endif
1017
1018 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1019 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1020 #endif
1021
1022 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1023 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1024 #endif
1025
1026 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1027 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1028 #endif
1029
1030 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1031 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1032 #endif
1033
1034 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1035 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1036 #endif
1037
1038 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1039         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1040 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1041         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1042
1043 struct input_handle;
1044
1045 /**
1046  * struct input_handler - implements one of interfaces for input devices
1047  * @private: driver-specific data
1048  * @event: event handler
1049  * @connect: called when attaching a handler to an input device
1050  * @disconnect: disconnects a handler from input device
1051  * @start: starts handler for given handle. This function is called by
1052  *      input core right after connect() method and also when a process
1053  *      that "grabbed" a device releases it
1054  * @fops: file operations this driver implements
1055  * @minor: beginning of range of 32 minors for devices this driver
1056  *      can provide
1057  * @name: name of the handler, to be shown in /proc/bus/input/handlers
1058  * @id_table: pointer to a table of input_device_ids this driver can
1059  *      handle
1060  * @blacklist: prointer to a table of input_device_ids this driver should
1061  *      ignore even if they match @id_table
1062  * @h_list: list of input handles associated with the handler
1063  * @node: for placing the driver onto input_handler_list
1064  */
1065 struct input_handler {
1066
1067         void *private;
1068
1069         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1070         int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1071         void (*disconnect)(struct input_handle *handle);
1072         void (*start)(struct input_handle *handle);
1073
1074         const struct file_operations *fops;
1075         int minor;
1076         const char *name;
1077
1078         const struct input_device_id *id_table;
1079         const struct input_device_id *blacklist;
1080
1081         struct list_head        h_list;
1082         struct list_head        node;
1083 };
1084
1085 struct input_handle {
1086
1087         void *private;
1088
1089         int open;
1090         const char *name;
1091
1092         struct input_dev *dev;
1093         struct input_handler *handler;
1094
1095         struct list_head        d_node;
1096         struct list_head        h_node;
1097 };
1098
1099 #define to_dev(n) container_of(n, struct input_dev, node)
1100 #define to_handler(n) container_of(n, struct input_handler, node)
1101 #define to_handle(n) container_of(n, struct input_handle, d_node)
1102 #define to_handle_h(n) container_of(n, struct input_handle, h_node)
1103
1104 struct input_dev *input_allocate_device(void);
1105 void input_free_device(struct input_dev *dev);
1106
1107 static inline struct input_dev *input_get_device(struct input_dev *dev)
1108 {
1109         return to_input_dev(get_device(&dev->dev));
1110 }
1111
1112 static inline void input_put_device(struct input_dev *dev)
1113 {
1114         put_device(&dev->dev);
1115 }
1116
1117 static inline void *input_get_drvdata(struct input_dev *dev)
1118 {
1119         return dev->private;
1120 }
1121
1122 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1123 {
1124         dev->private = data;
1125 }
1126
1127 int input_register_device(struct input_dev *);
1128 void input_unregister_device(struct input_dev *);
1129
1130 int input_register_handler(struct input_handler *);
1131 void input_unregister_handler(struct input_handler *);
1132
1133 int input_register_handle(struct input_handle *);
1134 void input_unregister_handle(struct input_handle *);
1135
1136 int input_grab_device(struct input_handle *);
1137 void input_release_device(struct input_handle *);
1138
1139 int input_open_device(struct input_handle *);
1140 void input_close_device(struct input_handle *);
1141
1142 int input_flush_device(struct input_handle* handle, struct file* file);
1143
1144 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1145 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1146
1147 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1148 {
1149         input_event(dev, EV_KEY, code, !!value);
1150 }
1151
1152 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1153 {
1154         input_event(dev, EV_REL, code, value);
1155 }
1156
1157 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1158 {
1159         input_event(dev, EV_ABS, code, value);
1160 }
1161
1162 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1163 {
1164         input_event(dev, EV_FF_STATUS, code, value);
1165 }
1166
1167 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1168 {
1169         input_event(dev, EV_SW, code, !!value);
1170 }
1171
1172 static inline void input_sync(struct input_dev *dev)
1173 {
1174         input_event(dev, EV_SYN, SYN_REPORT, 0);
1175 }
1176
1177 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1178
1179 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1180 {
1181         dev->absmin[axis] = min;
1182         dev->absmax[axis] = max;
1183         dev->absfuzz[axis] = fuzz;
1184         dev->absflat[axis] = flat;
1185
1186         dev->absbit[LONG(axis)] |= BIT(axis);
1187 }
1188
1189 extern struct class input_class;
1190
1191 /**
1192  * struct ff_device - force-feedback part of an input device
1193  * @upload: Called to upload an new effect into device
1194  * @erase: Called to erase an effect from device
1195  * @playback: Called to request device to start playing specified effect
1196  * @set_gain: Called to set specified gain
1197  * @set_autocenter: Called to auto-center device
1198  * @destroy: called by input core when parent input device is being
1199  *      destroyed
1200  * @private: driver-specific data, will be freed automatically
1201  * @ffbit: bitmap of force feedback capabilities truly supported by
1202  *      device (not emulated like ones in input_dev->ffbit)
1203  * @mutex: mutex for serializing access to the device
1204  * @max_effects: maximum number of effects supported by device
1205  * @effects: pointer to an array of effects currently loaded into device
1206  * @effect_owners: array of effect owners; when file handle owning
1207  *      an effect gets closed the effcet is automatically erased
1208  *
1209  * Every force-feedback device must implement upload() and playback()
1210  * methods; erase() is optional. set_gain() and set_autocenter() need
1211  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1212  * bits.
1213  */
1214 struct ff_device {
1215         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1216                       struct ff_effect *old);
1217         int (*erase)(struct input_dev *dev, int effect_id);
1218
1219         int (*playback)(struct input_dev *dev, int effect_id, int value);
1220         void (*set_gain)(struct input_dev *dev, u16 gain);
1221         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1222
1223         void (*destroy)(struct ff_device *);
1224
1225         void *private;
1226
1227         unsigned long ffbit[NBITS(FF_MAX)];
1228
1229         struct mutex mutex;
1230
1231         int max_effects;
1232         struct ff_effect *effects;
1233         struct file *effect_owners[];
1234 };
1235
1236 int input_ff_create(struct input_dev *dev, int max_effects);
1237 void input_ff_destroy(struct input_dev *dev);
1238
1239 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1240
1241 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1242 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1243
1244 int input_ff_create_memless(struct input_dev *dev, void *data,
1245                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1246
1247 #endif
1248 #endif