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