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