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