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