LCOV - code coverage report
Current view: top level - include/linux - input.h (source / functions) Hit Total Coverage
Test: coverage.info Lines: 18 21 85.7 %
Date: 2017-01-25 Functions: 1 2 50.0 %

          Line data    Source code
       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           1 : 
      33             : /*
      34             :  * Protocol version.
      35             :  */
      36             : 
      37             : #define EV_VERSION              0x010000
      38             : 
      39             : /*
      40             :  * IOCTLs (0x00 - 0x7f)
      41             :  */
      42             : 
      43             : struct input_id {
      44             :         __u16 bustype;
      45             :         __u16 vendor;
      46             :         __u16 product;
      47             :         __u16 version;
      48             : };
      49             : 
      50             : struct input_absinfo {
      51             :         __s32 value;
      52             :         __s32 minimum;
      53             :         __s32 maximum;
      54             :         __s32 fuzz;
      55             :         __s32 flat;
      56             :         __s32 resolution;
      57             : };
      58           1 : 
      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             : #define KEY_RFKILL              247     /* Key that controls all radios */
     380             : 
     381             : /* Range 248 - 255 is reserved for special needs of AT keyboard driver */
     382             : 
     383             : #define BTN_MISC                0x100
     384             : #define BTN_0                   0x100
     385             : #define BTN_1                   0x101
     386             : #define BTN_2                   0x102
     387             : #define BTN_3                   0x103
     388             : #define BTN_4                   0x104
     389             : #define BTN_5                   0x105
     390             : #define BTN_6                   0x106
     391             : #define BTN_7                   0x107
     392             : #define BTN_8                   0x108
     393             : #define BTN_9                   0x109
     394             : 
     395             : #define BTN_MOUSE               0x110
     396             : #define BTN_LEFT                0x110
     397             : #define BTN_RIGHT               0x111
     398             : #define BTN_MIDDLE              0x112
     399             : #define BTN_SIDE                0x113
     400             : #define BTN_EXTRA               0x114
     401             : #define BTN_FORWARD             0x115
     402             : #define BTN_BACK                0x116
     403             : #define BTN_TASK                0x117
     404             : 
     405             : #define BTN_JOYSTICK            0x120
     406             : #define BTN_TRIGGER             0x120
     407             : #define BTN_THUMB               0x121
     408             : #define BTN_THUMB2              0x122
     409             : #define BTN_TOP                 0x123
     410             : #define BTN_TOP2                0x124
     411             : #define BTN_PINKIE              0x125
     412             : #define BTN_BASE                0x126
     413             : #define BTN_BASE2               0x127
     414             : #define BTN_BASE3               0x128
     415             : #define BTN_BASE4               0x129
     416             : #define BTN_BASE5               0x12a
     417             : #define BTN_BASE6               0x12b
     418             : #define BTN_DEAD                0x12f
     419             : 
     420             : #define BTN_GAMEPAD             0x130
     421             : #define BTN_A                   0x130
     422             : #define BTN_B                   0x131
     423             : #define BTN_C                   0x132
     424             : #define BTN_X                   0x133
     425             : #define BTN_Y                   0x134
     426             : #define BTN_Z                   0x135
     427             : #define BTN_TL                  0x136
     428             : #define BTN_TR                  0x137
     429             : #define BTN_TL2                 0x138
     430             : #define BTN_TR2                 0x139
     431             : #define BTN_SELECT              0x13a
     432             : #define BTN_START               0x13b
     433             : #define BTN_MODE                0x13c
     434             : #define BTN_THUMBL              0x13d
     435             : #define BTN_THUMBR              0x13e
     436             : 
     437             : #define BTN_DIGI                0x140
     438             : #define BTN_TOOL_PEN            0x140
     439             : #define BTN_TOOL_RUBBER         0x141
     440             : #define BTN_TOOL_BRUSH          0x142
     441             : #define BTN_TOOL_PENCIL         0x143
     442             : #define BTN_TOOL_AIRBRUSH       0x144
     443             : #define BTN_TOOL_FINGER         0x145
     444             : #define BTN_TOOL_MOUSE          0x146
     445             : #define BTN_TOOL_LENS           0x147
     446             : #define BTN_TOUCH               0x14a
     447             : #define BTN_STYLUS              0x14b
     448             : #define BTN_STYLUS2             0x14c
     449             : #define BTN_TOOL_DOUBLETAP      0x14d
     450             : #define BTN_TOOL_TRIPLETAP      0x14e
     451             : #define BTN_TOOL_QUADTAP        0x14f   /* Four fingers on trackpad */
     452             : 
     453             : #define BTN_WHEEL               0x150
     454             : #define BTN_GEAR_DOWN           0x150
     455             : #define BTN_GEAR_UP             0x151
     456             : 
     457             : #define KEY_OK                  0x160
     458             : #define KEY_SELECT              0x161
     459             : #define KEY_GOTO                0x162
     460             : #define KEY_CLEAR               0x163
     461             : #define KEY_POWER2              0x164
     462             : #define KEY_OPTION              0x165
     463             : #define KEY_INFO                0x166   /* AL OEM Features/Tips/Tutorial */
     464             : #define KEY_TIME                0x167
     465             : #define KEY_VENDOR              0x168
     466             : #define KEY_ARCHIVE             0x169
     467             : #define KEY_PROGRAM             0x16a   /* Media Select Program Guide */
     468             : #define KEY_CHANNEL             0x16b
     469             : #define KEY_FAVORITES           0x16c
     470             : #define KEY_EPG                 0x16d
     471             : #define KEY_PVR                 0x16e   /* Media Select Home */
     472             : #define KEY_MHP                 0x16f
     473             : #define KEY_LANGUAGE            0x170
     474             : #define KEY_TITLE               0x171
     475             : #define KEY_SUBTITLE            0x172
     476             : #define KEY_ANGLE               0x173
     477             : #define KEY_ZOOM                0x174
     478             : #define KEY_MODE                0x175
     479             : #define KEY_KEYBOARD            0x176
     480             : #define KEY_SCREEN              0x177
     481             : #define KEY_PC                  0x178   /* Media Select Computer */
     482             : #define KEY_TV                  0x179   /* Media Select TV */
     483             : #define KEY_TV2                 0x17a   /* Media Select Cable */
     484             : #define KEY_VCR                 0x17b   /* Media Select VCR */
     485             : #define KEY_VCR2                0x17c   /* VCR Plus */
     486             : #define KEY_SAT                 0x17d   /* Media Select Satellite */
     487             : #define KEY_SAT2                0x17e
     488             : #define KEY_CD                  0x17f   /* Media Select CD */
     489             : #define KEY_TAPE                0x180   /* Media Select Tape */
     490             : #define KEY_RADIO               0x181
     491             : #define KEY_TUNER               0x182   /* Media Select Tuner */
     492             : #define KEY_PLAYER              0x183
     493             : #define KEY_TEXT                0x184
     494             : #define KEY_DVD                 0x185   /* Media Select DVD */
     495             : #define KEY_AUX                 0x186
     496             : #define KEY_MP3                 0x187
     497             : #define KEY_AUDIO               0x188
     498             : #define KEY_VIDEO               0x189
     499             : #define KEY_DIRECTORY           0x18a
     500             : #define KEY_LIST                0x18b
     501             : #define KEY_MEMO                0x18c   /* Media Select Messages */
     502             : #define KEY_CALENDAR            0x18d
     503             : #define KEY_RED                 0x18e
     504             : #define KEY_GREEN               0x18f
     505             : #define KEY_YELLOW              0x190
     506             : #define KEY_BLUE                0x191
     507             : #define KEY_CHANNELUP           0x192   /* Channel Increment */
     508             : #define KEY_CHANNELDOWN         0x193   /* Channel Decrement */
     509             : #define KEY_FIRST               0x194
     510             : #define KEY_LAST                0x195   /* Recall Last */
     511             : #define KEY_AB                  0x196
     512             : #define KEY_NEXT                0x197
     513             : #define KEY_RESTART             0x198
     514             : #define KEY_SLOW                0x199
     515             : #define KEY_SHUFFLE             0x19a
     516             : #define KEY_BREAK               0x19b
     517             : #define KEY_PREVIOUS            0x19c
     518             : #define KEY_DIGITS              0x19d
     519             : #define KEY_TEEN                0x19e
     520             : #define KEY_TWEN                0x19f
     521             : #define KEY_VIDEOPHONE          0x1a0   /* Media Select Video Phone */
     522             : #define KEY_GAMES               0x1a1   /* Media Select Games */
     523             : #define KEY_ZOOMIN              0x1a2   /* AC Zoom In */
     524             : #define KEY_ZOOMOUT             0x1a3   /* AC Zoom Out */
     525             : #define KEY_ZOOMRESET           0x1a4   /* AC Zoom */
     526             : #define KEY_WORDPROCESSOR       0x1a5   /* AL Word Processor */
     527             : #define KEY_EDITOR              0x1a6   /* AL Text Editor */
     528             : #define KEY_SPREADSHEET         0x1a7   /* AL Spreadsheet */
     529             : #define KEY_GRAPHICSEDITOR      0x1a8   /* AL Graphics Editor */
     530             : #define KEY_PRESENTATION        0x1a9   /* AL Presentation App */
     531             : #define KEY_DATABASE            0x1aa   /* AL Database App */
     532             : #define KEY_NEWS                0x1ab   /* AL Newsreader */
     533             : #define KEY_VOICEMAIL           0x1ac   /* AL Voicemail */
     534             : #define KEY_ADDRESSBOOK         0x1ad   /* AL Contacts/Address Book */
     535             : #define KEY_MESSENGER           0x1ae   /* AL Instant Messaging */
     536             : #define KEY_DISPLAYTOGGLE       0x1af   /* Turn display (LCD) on and off */
     537             : #define KEY_SPELLCHECK          0x1b0   /* AL Spell Check */
     538             : #define KEY_LOGOFF              0x1b1   /* AL Logoff */
     539             : 
     540             : #define KEY_DOLLAR              0x1b2
     541             : #define KEY_EURO                0x1b3
     542             : 
     543             : #define KEY_FRAMEBACK           0x1b4   /* Consumer - transport controls */
     544             : #define KEY_FRAMEFORWARD        0x1b5
     545             : #define KEY_CONTEXT_MENU        0x1b6   /* GenDesc - system context menu */
     546             : #define KEY_MEDIA_REPEAT        0x1b7   /* Consumer - transport control */
     547             : 
     548             : #define KEY_DEL_EOL             0x1c0
     549             : #define KEY_DEL_EOS             0x1c1
     550             : #define KEY_INS_LINE            0x1c2
     551             : #define KEY_DEL_LINE            0x1c3
     552             : 
     553             : #define KEY_FN                  0x1d0
     554             : #define KEY_FN_ESC              0x1d1
     555             : #define KEY_FN_F1               0x1d2
     556             : #define KEY_FN_F2               0x1d3
     557             : #define KEY_FN_F3               0x1d4
     558             : #define KEY_FN_F4               0x1d5
     559             : #define KEY_FN_F5               0x1d6
     560             : #define KEY_FN_F6               0x1d7
     561             : #define KEY_FN_F7               0x1d8
     562             : #define KEY_FN_F8               0x1d9
     563             : #define KEY_FN_F9               0x1da
     564             : #define KEY_FN_F10              0x1db
     565             : #define KEY_FN_F11              0x1dc
     566             : #define KEY_FN_F12              0x1dd
     567             : #define KEY_FN_1                0x1de
     568             : #define KEY_FN_2                0x1df
     569             : #define KEY_FN_D                0x1e0
     570             : #define KEY_FN_E                0x1e1
     571             : #define KEY_FN_F                0x1e2
     572             : #define KEY_FN_S                0x1e3
     573             : #define KEY_FN_B                0x1e4
     574             : 
     575             : #define KEY_BRL_DOT1            0x1f1
     576             : #define KEY_BRL_DOT2            0x1f2
     577             : #define KEY_BRL_DOT3            0x1f3
     578             : #define KEY_BRL_DOT4            0x1f4
     579             : #define KEY_BRL_DOT5            0x1f5
     580             : #define KEY_BRL_DOT6            0x1f6
     581             : #define KEY_BRL_DOT7            0x1f7
     582             : #define KEY_BRL_DOT8            0x1f8
     583             : #define KEY_BRL_DOT9            0x1f9
     584             : #define KEY_BRL_DOT10           0x1fa
     585             : 
     586             : #define KEY_NUMERIC_0           0x200   /* used by phones, remote controls, */
     587             : #define KEY_NUMERIC_1           0x201   /* and other keypads */
     588             : #define KEY_NUMERIC_2           0x202
     589             : #define KEY_NUMERIC_3           0x203
     590             : #define KEY_NUMERIC_4           0x204
     591             : #define KEY_NUMERIC_5           0x205
     592             : #define KEY_NUMERIC_6           0x206
     593             : #define KEY_NUMERIC_7           0x207
     594             : #define KEY_NUMERIC_8           0x208
     595             : #define KEY_NUMERIC_9           0x209
     596             : #define KEY_NUMERIC_STAR        0x20a
     597             : #define KEY_NUMERIC_POUND       0x20b
     598             : 
     599             : #define KEY_CAMERA_FOCUS        0x210
     600             : 
     601             : /* We avoid low common keys in module aliases so they don't get huge. */
     602             : #define KEY_MIN_INTERESTING     KEY_MUTE
     603             : #define KEY_MAX                 0x2ff
     604             : #define KEY_CNT                 (KEY_MAX+1)
     605             : 
     606             : /*
     607             :  * Relative axes
     608             :  */
     609             : 
     610             : #define REL_X                   0x00
     611             : #define REL_Y                   0x01
     612             : #define REL_Z                   0x02
     613             : #define REL_RX                  0x03
     614             : #define REL_RY                  0x04
     615             : #define REL_RZ                  0x05
     616             : #define REL_HWHEEL              0x06
     617             : #define REL_DIAL                0x07
     618             : #define REL_WHEEL               0x08
     619             : #define REL_MISC                0x09
     620             : #define REL_MAX                 0x0f
     621             : #define REL_CNT                 (REL_MAX+1)
     622             : 
     623             : /*
     624             :  * Absolute axes
     625             :  */
     626             : 
     627             : #define ABS_X                   0x00
     628             : #define ABS_Y                   0x01
     629             : #define ABS_Z                   0x02
     630             : #define ABS_RX                  0x03
     631             : #define ABS_RY                  0x04
     632             : #define ABS_RZ                  0x05
     633             : #define ABS_THROTTLE            0x06
     634             : #define ABS_RUDDER              0x07
     635             : #define ABS_WHEEL               0x08
     636             : #define ABS_GAS                 0x09
     637             : #define ABS_BRAKE               0x0a
     638             : #define ABS_HAT0X               0x10
     639             : #define ABS_HAT0Y               0x11
     640             : #define ABS_HAT1X               0x12
     641             : #define ABS_HAT1Y               0x13
     642             : #define ABS_HAT2X               0x14
     643             : #define ABS_HAT2Y               0x15
     644             : #define ABS_HAT3X               0x16
     645             : #define ABS_HAT3Y               0x17
     646             : #define ABS_PRESSURE            0x18
     647             : #define ABS_DISTANCE            0x19
     648             : #define ABS_TILT_X              0x1a
     649             : #define ABS_TILT_Y              0x1b
     650             : #define ABS_TOOL_WIDTH          0x1c
     651             : #define ABS_VOLUME              0x20
     652             : #define ABS_MISC                0x28
     653             : 
     654             : #define ABS_MT_TOUCH_MAJOR      0x30    /* Major axis of touching ellipse */
     655             : #define ABS_MT_TOUCH_MINOR      0x31    /* Minor axis (omit if circular) */
     656             : #define ABS_MT_WIDTH_MAJOR      0x32    /* Major axis of approaching ellipse */
     657             : #define ABS_MT_WIDTH_MINOR      0x33    /* Minor axis (omit if circular) */
     658             : #define ABS_MT_ORIENTATION      0x34    /* Ellipse orientation */
     659             : #define ABS_MT_POSITION_X       0x35    /* Center X ellipse position */
     660             : #define ABS_MT_POSITION_Y       0x36    /* Center Y ellipse position */
     661             : #define ABS_MT_TOOL_TYPE        0x37    /* Type of touching device */
     662             : #define ABS_MT_BLOB_ID          0x38    /* Group a set of packets as a blob */
     663             : #define ABS_MT_TRACKING_ID      0x39    /* Unique ID of initiated contact */
     664             : #define ABS_MT_PRESSURE         0x3a    /* Pressure on contact area */
     665             : 
     666             : #define ABS_MAX                 0x3f
     667             : #define ABS_CNT                 (ABS_MAX+1)
     668             : 
     669             : /*
     670             :  * Switch events
     671             :  */
     672             : 
     673             : #define SW_LID                  0x00  /* set = lid shut */
     674             : #define SW_TABLET_MODE          0x01  /* set = tablet mode */
     675             : #define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
     676             : #define SW_RFKILL_ALL           0x03  /* rfkill master switch, type "any"
     677             :                                          set = radio enabled */
     678             : #define SW_RADIO                SW_RFKILL_ALL   /* deprecated */
     679             : #define SW_MICROPHONE_INSERT    0x04  /* set = inserted */
     680             : #define SW_DOCK                 0x05  /* set = plugged into dock */
     681             : #define SW_LINEOUT_INSERT       0x06  /* set = inserted */
     682             : #define SW_JACK_PHYSICAL_INSERT 0x07  /* set = mechanical switch set */
     683             : #define SW_VIDEOOUT_INSERT      0x08  /* set = inserted */
     684             : #define SW_CAMERA_LENS_COVER    0x09  /* set = lens covered */
     685             : #define SW_KEYPAD_SLIDE         0x0a  /* set = keypad slide out */
     686             : #define SW_FRONT_PROXIMITY      0x0b  /* set = front proximity sensor active */
     687             : #define SW_MAX                  0x0f
     688             : #define SW_CNT                  (SW_MAX+1)
     689             : 
     690             : /*
     691             :  * Misc events
     692             :  */
     693             : 
     694             : #define MSC_SERIAL              0x00
     695             : #define MSC_PULSELED            0x01
     696             : #define MSC_GESTURE             0x02
     697             : #define MSC_RAW                 0x03
     698             : #define MSC_SCAN                0x04
     699             : #define MSC_MAX                 0x07
     700             : #define MSC_CNT                 (MSC_MAX+1)
     701             : 
     702             : /*
     703             :  * LEDs
     704             :  */
     705             : 
     706             : #define LED_NUML                0x00
     707             : #define LED_CAPSL               0x01
     708             : #define LED_SCROLLL             0x02
     709             : #define LED_COMPOSE             0x03
     710             : #define LED_KANA                0x04
     711             : #define LED_SLEEP               0x05
     712             : #define LED_SUSPEND             0x06
     713             : #define LED_MUTE                0x07
     714             : #define LED_MISC                0x08
     715             : #define LED_MAIL                0x09
     716             : #define LED_CHARGING            0x0a
     717             : #define LED_MAX                 0x0f
     718             : #define LED_CNT                 (LED_MAX+1)
     719             : 
     720             : /*
     721             :  * Autorepeat values
     722             :  */
     723             : 
     724             : #define REP_DELAY               0x00
     725             : #define REP_PERIOD              0x01
     726             : #define REP_MAX                 0x01
     727             : 
     728             : /*
     729             :  * Sounds
     730             :  */
     731             : 
     732             : #define SND_CLICK               0x00
     733             : #define SND_BELL                0x01
     734             : #define SND_TONE                0x02
     735             : #define SND_MAX                 0x07
     736             : #define SND_CNT                 (SND_MAX+1)
     737             : 
     738             : /*
     739             :  * IDs.
     740             :  */
     741             : 
     742             : #define ID_BUS                  0
     743             : #define ID_VENDOR               1
     744             : #define ID_PRODUCT              2
     745             : #define ID_VERSION              3
     746             : 
     747             : #define BUS_PCI                 0x01
     748             : #define BUS_ISAPNP              0x02
     749             : #define BUS_USB                 0x03
     750             : #define BUS_HIL                 0x04
     751             : #define BUS_BLUETOOTH           0x05
     752             : #define BUS_VIRTUAL             0x06
     753             : 
     754             : #define BUS_ISA                 0x10
     755             : #define BUS_I8042               0x11
     756             : #define BUS_XTKBD               0x12
     757             : #define BUS_RS232               0x13
     758             : #define BUS_GAMEPORT            0x14
     759             : #define BUS_PARPORT             0x15
     760             : #define BUS_AMIGA               0x16
     761             : #define BUS_ADB                 0x17
     762             : #define BUS_I2C                 0x18
     763             : #define BUS_HOST                0x19
     764             : #define BUS_GSC                 0x1A
     765             : #define BUS_ATARI               0x1B
     766             : 
     767             : /*
     768             :  * MT_TOOL types
     769             :  */
     770             : #define MT_TOOL_FINGER          0
     771             : #define MT_TOOL_PEN             1
     772             : 
     773             : /*
     774             :  * Values describing the status of a force-feedback effect
     775             :  */
     776             : #define FF_STATUS_STOPPED       0x00
     777             : #define FF_STATUS_PLAYING       0x01
     778             : #define FF_STATUS_MAX           0x01
     779             : 
     780             : /*
     781             :  * Structures used in ioctls to upload effects to a device
     782             :  * They are pieces of a bigger structure (called ff_effect)
     783             :  */
     784             : 
     785             : /*
     786             :  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
     787             :  * should not be used and have unspecified results.
     788             :  */
     789             : 
     790             : /**
     791             :  * struct ff_replay - defines scheduling of the force-feedback effect
     792             :  * @length: duration of the effect
     793             :  * @delay: delay before effect should start playing
     794             :  */
     795             : struct ff_replay {
     796             :         __u16 length;
     797             :         __u16 delay;
     798             : };
     799           1 : 
     800             : /**
     801             :  * struct ff_trigger - defines what triggers the force-feedback effect
     802             :  * @button: number of the button triggering the effect
     803             :  * @interval: controls how soon the effect can be re-triggered
     804             :  */
     805             : struct ff_trigger {
     806             :         __u16 button;
     807             :         __u16 interval;
     808             : };
     809           1 : 
     810             : /**
     811             :  * struct ff_envelope - generic force-feedback effect envelope
     812             :  * @attack_length: duration of the attack (ms)
     813             :  * @attack_level: level at the beginning of the attack
     814             :  * @fade_length: duration of fade (ms)
     815             :  * @fade_level: level at the end of fade
     816             :  *
     817             :  * The @attack_level and @fade_level are absolute values; when applying
     818             :  * envelope force-feedback core will convert to positive/negative
     819             :  * value based on polarity of the default level of the effect.
     820             :  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
     821             :  */
     822             : struct ff_envelope {
     823             :         __u16 attack_length;
     824             :         __u16 attack_level;
     825             :         __u16 fade_length;
     826             :         __u16 fade_level;
     827             : };
     828           1 : 
     829             : /**
     830             :  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
     831             :  * @level: strength of the effect; may be negative
     832             :  * @envelope: envelope data
     833             :  */
     834             : struct ff_constant_effect {
     835             :         __s16 level;
     836             :         struct ff_envelope envelope;
     837             : };
     838           1 : 
     839             : /**
     840             :  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
     841             :  * @start_level: beginning strength of the effect; may be negative
     842             :  * @end_level: final strength of the effect; may be negative
     843             :  * @envelope: envelope data
     844             :  */
     845             : struct ff_ramp_effect {
     846             :         __s16 start_level;
     847             :         __s16 end_level;
     848             :         struct ff_envelope envelope;
     849             : };
     850           1 : 
     851             : /**
     852             :  * struct ff_condition_effect - defines a spring or friction force-feedback effect
     853             :  * @right_saturation: maximum level when joystick moved all way to the right
     854             :  * @left_saturation: same for the left side
     855             :  * @right_coeff: controls how fast the force grows when the joystick moves
     856             :  *      to the right
     857             :  * @left_coeff: same for the left side
     858             :  * @deadband: size of the dead zone, where no force is produced
     859             :  * @center: position of the dead zone
     860             :  */
     861             : struct ff_condition_effect {
     862             :         __u16 right_saturation;
     863             :         __u16 left_saturation;
     864             : 
     865             :         __s16 right_coeff;
     866             :         __s16 left_coeff;
     867             : 
     868             :         __u16 deadband;
     869             :         __s16 center;
     870             : };
     871           1 : 
     872             : /**
     873             :  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
     874             :  * @waveform: kind of the effect (wave)
     875             :  * @period: period of the wave (ms)
     876             :  * @magnitude: peak value
     877             :  * @offset: mean value of the wave (roughly)
     878             :  * @phase: 'horizontal' shift
     879             :  * @envelope: envelope data
     880             :  * @custom_len: number of samples (FF_CUSTOM only)
     881             :  * @custom_data: buffer of samples (FF_CUSTOM only)
     882             :  *
     883             :  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
     884             :  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
     885             :  * for the time being as no driver supports it yet.
     886             :  *
     887             :  * Note: the data pointed by custom_data is copied by the driver.
     888             :  * You can therefore dispose of the memory after the upload/update.
     889             :  */
     890             : struct ff_periodic_effect {
     891             :         __u16 waveform;
     892             :         __u16 period;
     893             :         __s16 magnitude;
     894             :         __s16 offset;
     895             :         __u16 phase;
     896             : 
     897             :         struct ff_envelope envelope;
     898             : 
     899             :         __u32 custom_len;
     900             :         __s16 __user *custom_data;
     901             : };
     902           1 : 
     903             : /**
     904             :  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
     905             :  * @strong_magnitude: magnitude of the heavy motor
     906             :  * @weak_magnitude: magnitude of the light one
     907             :  *
     908             :  * Some rumble pads have two motors of different weight. Strong_magnitude
     909             :  * represents the magnitude of the vibration generated by the heavy one.
     910             :  */
     911             : struct ff_rumble_effect {
     912             :         __u16 strong_magnitude;
     913             :         __u16 weak_magnitude;
     914             : };
     915           2 : 
     916             : /**
     917             :  * struct ff_effect - defines force feedback effect
     918             :  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
     919             :  *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
     920             :  * @id: an unique id assigned to an effect
     921             :  * @direction: direction of the effect
     922             :  * @trigger: trigger conditions (struct ff_trigger)
     923             :  * @replay: scheduling of the effect (struct ff_replay)
     924             :  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
     925             :  *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
     926             :  *      defining effect parameters
     927             :  *
     928             :  * This structure is sent through ioctl from the application to the driver.
     929             :  * To create a new effect application should set its @id to -1; the kernel
     930             :  * will return assigned @id which can later be used to update or delete
     931             :  * this effect.
     932             :  *
     933             :  * Direction of the effect is encoded as follows:
     934             :  *      0 deg -> 0x0000 (down)
     935             :  *      90 deg -> 0x4000 (left)
     936             :  *      180 deg -> 0x8000 (up)
     937             :  *      270 deg -> 0xC000 (right)
     938             :  */
     939             : struct ff_effect {
     940             :         __u16 type;
     941             :         __s16 id;
     942             :         __u16 direction;
     943             :         struct ff_trigger trigger;
     944             :         struct ff_replay replay;
     945             : 
     946             :         union {
     947             :                 struct ff_constant_effect constant;
     948             :                 struct ff_ramp_effect ramp;
     949             :                 struct ff_periodic_effect periodic;
     950             :                 struct ff_condition_effect condition[2]; /* One for each axis */
     951             :                 struct ff_rumble_effect rumble;
     952             :         } u;
     953             : };
     954           1 : 
     955             : /*
     956             :  * Force feedback effect types
     957             :  */
     958             : 
     959             : #define FF_RUMBLE       0x50
     960             : #define FF_PERIODIC     0x51
     961             : #define FF_CONSTANT     0x52
     962             : #define FF_SPRING       0x53
     963             : #define FF_FRICTION     0x54
     964             : #define FF_DAMPER       0x55
     965             : #define FF_INERTIA      0x56
     966             : #define FF_RAMP         0x57
     967             : 
     968             : #define FF_EFFECT_MIN   FF_RUMBLE
     969             : #define FF_EFFECT_MAX   FF_RAMP
     970             : 
     971             : /*
     972             :  * Force feedback periodic effect types
     973             :  */
     974             : 
     975             : #define FF_SQUARE       0x58
     976             : #define FF_TRIANGLE     0x59
     977             : #define FF_SINE         0x5a
     978             : #define FF_SAW_UP       0x5b
     979             : #define FF_SAW_DOWN     0x5c
     980             : #define FF_CUSTOM       0x5d
     981             : 
     982             : #define FF_WAVEFORM_MIN FF_SQUARE
     983             : #define FF_WAVEFORM_MAX FF_CUSTOM
     984             : 
     985             : /*
     986             :  * Set ff device properties
     987             :  */
     988             : 
     989             : #define FF_GAIN         0x60
     990             : #define FF_AUTOCENTER   0x61
     991             : 
     992             : #define FF_MAX          0x7f
     993             : #define FF_CNT          (FF_MAX+1)
     994             : 
     995             : #ifdef __KERNEL__
     996             : 
     997             : /*
     998             :  * In-kernel definitions.
     999             :  */
    1000             : 
    1001             : #include <linux/device.h>
    1002             : #include <linux/fs.h>
    1003             : #include <linux/timer.h>
    1004             : #include <linux/mod_devicetable.h>
    1005             : 
    1006             : /**
    1007             :  * struct input_dev - represents an input device
    1008             :  * @name: name of the device
    1009             :  * @phys: physical path to the device in the system hierarchy
    1010             :  * @uniq: unique identification code for the device (if device has it)
    1011             :  * @id: id of the device (struct input_id)
    1012             :  * @evbit: bitmap of types of events supported by the device (EV_KEY,
    1013             :  *      EV_REL, etc.)
    1014             :  * @keybit: bitmap of keys/buttons this device has
    1015             :  * @relbit: bitmap of relative axes for the device
    1016             :  * @absbit: bitmap of absolute axes for the device
    1017             :  * @mscbit: bitmap of miscellaneous events supported by the device
    1018             :  * @ledbit: bitmap of leds present on the device
    1019             :  * @sndbit: bitmap of sound effects supported by the device
    1020             :  * @ffbit: bitmap of force feedback effects supported by the device
    1021             :  * @swbit: bitmap of switches present on the device
    1022             :  * @keycodemax: size of keycode table
    1023             :  * @keycodesize: size of elements in keycode table
    1024             :  * @keycode: map of scancodes to keycodes for this device
    1025             :  * @setkeycode: optional method to alter current keymap, used to implement
    1026             :  *      sparse keymaps. If not supplied default mechanism will be used.
    1027             :  *      The method is being called while holding event_lock and thus must
    1028             :  *      not sleep
    1029             :  * @getkeycode: optional method to retrieve current keymap. If not supplied
    1030             :  *      default mechanism will be used. The method is being called while
    1031             :  *      holding event_lock and thus must not sleep
    1032             :  * @ff: force feedback structure associated with the device if device
    1033             :  *      supports force feedback effects
    1034             :  * @repeat_key: stores key code of the last key pressed; used to implement
    1035             :  *      software autorepeat
    1036             :  * @timer: timer for software autorepeat
    1037             :  * @sync: set to 1 when there were no new events since last EV_SYNC
    1038             :  * @abs: current values for reports from absolute axes
    1039             :  * @rep: current values for autorepeat parameters (delay, rate)
    1040             :  * @key: reflects current state of device's keys/buttons
    1041             :  * @led: reflects current state of device's LEDs
    1042             :  * @snd: reflects current state of sound effects
    1043             :  * @sw: reflects current state of device's switches
    1044             :  * @absmax: maximum values for events coming from absolute axes
    1045             :  * @absmin: minimum values for events coming from absolute axes
    1046             :  * @absfuzz: describes noisiness for axes
    1047             :  * @absflat: size of the center flat position (used by joydev)
    1048             :  * @absres: resolution used for events coming form absolute axes
    1049             :  * @open: this method is called when the very first user calls
    1050             :  *      input_open_device(). The driver must prepare the device
    1051             :  *      to start generating events (start polling thread,
    1052             :  *      request an IRQ, submit URB, etc.)
    1053             :  * @close: this method is called when the very last user calls
    1054             :  *      input_close_device().
    1055             :  * @flush: purges the device. Most commonly used to get rid of force
    1056             :  *      feedback effects loaded into the device when disconnecting
    1057             :  *      from it
    1058             :  * @event: event handler for events sent _to_ the device, like EV_LED
    1059             :  *      or EV_SND. The device is expected to carry out the requested
    1060             :  *      action (turn on a LED, play sound, etc.) The call is protected
    1061             :  *      by @event_lock and must not sleep
    1062             :  * @grab: input handle that currently has the device grabbed (via
    1063             :  *      EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
    1064             :  *      recipient for all input events coming from the device
    1065             :  * @event_lock: this spinlock is is taken when input core receives
    1066             :  *      and processes a new event for the device (in input_event()).
    1067             :  *      Code that accesses and/or modifies parameters of a device
    1068             :  *      (such as keymap or absmin, absmax, absfuzz, etc.) after device
    1069             :  *      has been registered with input core must take this lock.
    1070             :  * @mutex: serializes calls to open(), close() and flush() methods
    1071             :  * @users: stores number of users (input handlers) that opened this
    1072             :  *      device. It is used by input_open_device() and input_close_device()
    1073             :  *      to make sure that dev->open() is only called when the first
    1074             :  *      user opens device and dev->close() is called when the very
    1075             :  *      last user closes the device
    1076             :  * @going_away: marks devices that are in a middle of unregistering and
    1077             :  *      causes input_open_device*() fail with -ENODEV.
    1078             :  * @dev: driver model's view of this device
    1079             :  * @h_list: list of input handles associated with the device. When
    1080             :  *      accessing the list dev->mutex must be held
    1081             :  * @node: used to place the device onto input_dev_list
    1082             :  */
    1083             : struct input_dev {
    1084             :         const char *name;
    1085             :         const char *phys;
    1086             :         const char *uniq;
    1087             :         struct input_id id;
    1088             : 
    1089             :         unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
    1090             :         unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
    1091             :         unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
    1092             :         unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
    1093             :         unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
    1094             :         unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
    1095             :         unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
    1096             :         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
    1097             :         unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
    1098             : 
    1099             :         unsigned int keycodemax;
    1100             :         unsigned int keycodesize;
    1101             :         void *keycode;
    1102             :         int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
    1103             :         int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
    1104             : 
    1105             :         struct ff_device *ff;
    1106             : 
    1107             :         unsigned int repeat_key;
    1108             :         struct timer_list timer;
    1109             : 
    1110             :         int sync;
    1111             : 
    1112             :         int abs[ABS_MAX + 1];
    1113             :         int rep[REP_MAX + 1];
    1114             : 
    1115             :         unsigned long key[BITS_TO_LONGS(KEY_CNT)];
    1116             :         unsigned long led[BITS_TO_LONGS(LED_CNT)];
    1117             :         unsigned long snd[BITS_TO_LONGS(SND_CNT)];
    1118             :         unsigned long sw[BITS_TO_LONGS(SW_CNT)];
    1119             : 
    1120             :         int absmax[ABS_MAX + 1];
    1121             :         int absmin[ABS_MAX + 1];
    1122             :         int absfuzz[ABS_MAX + 1];
    1123             :         int absflat[ABS_MAX + 1];
    1124             :         int absres[ABS_MAX + 1];
    1125             : 
    1126             :         int (*open)(struct input_dev *dev);
    1127             :         void (*close)(struct input_dev *dev);
    1128             :         int (*flush)(struct input_dev *dev, struct file *file);
    1129             :         int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
    1130             : 
    1131             :         struct input_handle *grab;
    1132             : 
    1133             :         spinlock_t event_lock;
    1134             :         struct mutex mutex;
    1135             : 
    1136             :         unsigned int users;
    1137             :         bool going_away;
    1138             : 
    1139             :         struct device dev;
    1140             : 
    1141             :         struct list_head        h_list;
    1142             :         struct list_head        node;
    1143             : };
    1144           1 : #define to_input_dev(d) container_of(d, struct input_dev, dev)
    1145             : 
    1146             : /*
    1147             :  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
    1148             :  */
    1149             : 
    1150             : #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
    1151             : #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
    1152             : #endif
    1153             : 
    1154             : #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
    1155             : #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
    1156             : #endif
    1157             : 
    1158             : #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
    1159             : #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
    1160             : #endif
    1161             : 
    1162             : #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
    1163             : #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
    1164             : #endif
    1165             : 
    1166             : #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
    1167             : #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
    1168             : #endif
    1169             : 
    1170             : #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
    1171             : #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
    1172             : #endif
    1173             : 
    1174             : #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
    1175             : #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
    1176             : #endif
    1177             : 
    1178             : #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
    1179             : #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
    1180             : #endif
    1181             : 
    1182             : #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
    1183             : #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
    1184             : #endif
    1185             : 
    1186             : #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
    1187             : #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
    1188             : #endif
    1189             : 
    1190             : #define INPUT_DEVICE_ID_MATCH_DEVICE \
    1191             :         (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
    1192             : #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
    1193             :         (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
    1194             : 
    1195             : struct input_handle;
    1196             : 
    1197             : /**
    1198             :  * struct input_handler - implements one of interfaces for input devices
    1199             :  * @private: driver-specific data
    1200             :  * @event: event handler. This method is being called by input core with
    1201             :  *      interrupts disabled and dev->event_lock spinlock held and so
    1202             :  *      it may not sleep
    1203             :  * @connect: called when attaching a handler to an input device
    1204             :  * @disconnect: disconnects a handler from input device
    1205             :  * @start: starts handler for given handle. This function is called by
    1206             :  *      input core right after connect() method and also when a process
    1207             :  *      that "grabbed" a device releases it
    1208             :  * @fops: file operations this driver implements
    1209             :  * @minor: beginning of range of 32 minors for devices this driver
    1210             :  *      can provide
    1211             :  * @name: name of the handler, to be shown in /proc/bus/input/handlers
    1212             :  * @id_table: pointer to a table of input_device_ids this driver can
    1213             :  *      handle
    1214             :  * @blacklist: pointer to a table of input_device_ids this driver should
    1215             :  *      ignore even if they match @id_table
    1216             :  * @h_list: list of input handles associated with the handler
    1217             :  * @node: for placing the driver onto input_handler_list
    1218             :  *
    1219             :  * Input handlers attach to input devices and create input handles. There
    1220             :  * are likely several handlers attached to any given input device at the
    1221             :  * same time. All of them will get their copy of input event generated by
    1222             :  * the device.
    1223             :  *
    1224             :  * Note that input core serializes calls to connect() and disconnect()
    1225             :  * methods.
    1226             :  */
    1227             : struct input_handler {
    1228             : 
    1229             :         void *private;
    1230             : 
    1231             :         void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
    1232             :         int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
    1233             :         void (*disconnect)(struct input_handle *handle);
    1234             :         void (*start)(struct input_handle *handle);
    1235             : 
    1236             :         const struct file_operations *fops;
    1237             :         int minor;
    1238             :         const char *name;
    1239             : 
    1240             :         const struct input_device_id *id_table;
    1241             :         const struct input_device_id *blacklist;
    1242             : 
    1243             :         struct list_head        h_list;
    1244             :         struct list_head        node;
    1245             : };
    1246           1 : 
    1247             : /**
    1248             :  * struct input_handle - links input device with an input handler
    1249             :  * @private: handler-specific data
    1250             :  * @open: counter showing whether the handle is 'open', i.e. should deliver
    1251             :  *      events from its device
    1252             :  * @name: name given to the handle by handler that created it
    1253             :  * @dev: input device the handle is attached to
    1254             :  * @handler: handler that works with the device through this handle
    1255             :  * @d_node: used to put the handle on device's list of attached handles
    1256             :  * @h_node: used to put the handle on handler's list of handles from which
    1257             :  *      it gets events
    1258             :  */
    1259             : struct input_handle {
    1260             : 
    1261             :         void *private;
    1262             : 
    1263             :         int open;
    1264             :         const char *name;
    1265             : 
    1266             :         struct input_dev *dev;
    1267             :         struct input_handler *handler;
    1268             : 
    1269             :         struct list_head        d_node;
    1270             :         struct list_head        h_node;
    1271             : };
    1272             : 
    1273             : struct input_dev *input_allocate_device(void);
    1274             : void input_free_device(struct input_dev *dev);
    1275             : 
    1276             : static inline struct input_dev *input_get_device(struct input_dev *dev)
    1277             : {
    1278          16 :         return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
    1279           2 : }
    1280           2 : 
    1281             : static inline void input_put_device(struct input_dev *dev)
    1282             : {
    1283           0 :         if (dev)
    1284           0 :                 put_device(&dev->dev);
    1285           0 : }
    1286             : 
    1287             : static inline void *input_get_drvdata(struct input_dev *dev)
    1288             : {
    1289             :         return dev_get_drvdata(&dev->dev);
    1290             : }
    1291             : 
    1292             : static inline void input_set_drvdata(struct input_dev *dev, void *data)
    1293             : {
    1294             :         dev_set_drvdata(&dev->dev, data);
    1295             : }
    1296             : 
    1297             : int __must_check input_register_device(struct input_dev *);
    1298             : void input_unregister_device(struct input_dev *);
    1299             : 
    1300             : int __must_check input_register_handler(struct input_handler *);
    1301             : void input_unregister_handler(struct input_handler *);
    1302             : 
    1303             : int input_handler_for_each_handle(struct input_handler *, void *data,
    1304             :                                   int (*fn)(struct input_handle *, void *));
    1305             : 
    1306             : int input_register_handle(struct input_handle *);
    1307             : void input_unregister_handle(struct input_handle *);
    1308             : 
    1309             : int input_grab_device(struct input_handle *);
    1310             : void input_release_device(struct input_handle *);
    1311             : 
    1312             : int input_open_device(struct input_handle *);
    1313             : void input_close_device(struct input_handle *);
    1314             : 
    1315             : int input_flush_device(struct input_handle* handle, struct file* file);
    1316             : 
    1317             : void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
    1318             : void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
    1319             : 
    1320             : static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
    1321             : {
    1322             :         input_event(dev, EV_KEY, code, !!value);
    1323             : }
    1324             : 
    1325             : static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
    1326             : {
    1327             :         input_event(dev, EV_REL, code, value);
    1328             : }
    1329             : 
    1330             : static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
    1331             : {
    1332             :         input_event(dev, EV_ABS, code, value);
    1333             : }
    1334             : 
    1335             : static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
    1336             : {
    1337             :         input_event(dev, EV_FF_STATUS, code, value);
    1338             : }
    1339             : 
    1340             : static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
    1341             : {
    1342             :         input_event(dev, EV_SW, code, !!value);
    1343             : }
    1344             : 
    1345             : static inline void input_sync(struct input_dev *dev)
    1346             : {
    1347             :         input_event(dev, EV_SYN, SYN_REPORT, 0);
    1348             : }
    1349             : 
    1350             : static inline void input_mt_sync(struct input_dev *dev)
    1351             : {
    1352             :         input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
    1353             : }
    1354             : 
    1355             : void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
    1356             : 
    1357             : static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
    1358             : {
    1359             :         dev->absmin[axis] = min;
    1360             :         dev->absmax[axis] = max;
    1361             :         dev->absfuzz[axis] = fuzz;
    1362             :         dev->absflat[axis] = flat;
    1363             : 
    1364             :         dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
    1365             : }
    1366             : 
    1367             : int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
    1368             : int input_set_keycode(struct input_dev *dev, int scancode, int keycode);
    1369             : 
    1370           1 : extern struct class input_class;
    1371           1 : 
    1372             : /**
    1373             :  * struct ff_device - force-feedback part of an input device
    1374             :  * @upload: Called to upload an new effect into device
    1375             :  * @erase: Called to erase an effect from device
    1376             :  * @playback: Called to request device to start playing specified effect
    1377             :  * @set_gain: Called to set specified gain
    1378             :  * @set_autocenter: Called to auto-center device
    1379             :  * @destroy: called by input core when parent input device is being
    1380             :  *      destroyed
    1381             :  * @private: driver-specific data, will be freed automatically
    1382             :  * @ffbit: bitmap of force feedback capabilities truly supported by
    1383             :  *      device (not emulated like ones in input_dev->ffbit)
    1384             :  * @mutex: mutex for serializing access to the device
    1385             :  * @max_effects: maximum number of effects supported by device
    1386             :  * @effects: pointer to an array of effects currently loaded into device
    1387             :  * @effect_owners: array of effect owners; when file handle owning
    1388             :  *      an effect gets closed the effect is automatically erased
    1389             :  *
    1390             :  * Every force-feedback device must implement upload() and playback()
    1391             :  * methods; erase() is optional. set_gain() and set_autocenter() need
    1392             :  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
    1393             :  * bits.
    1394             :  *
    1395             :  * Note that playback(), set_gain() and set_autocenter() are called with
    1396             :  * dev->event_lock spinlock held and interrupts off and thus may not
    1397             :  * sleep.
    1398             :  */
    1399             : struct ff_device {
    1400             :         int (*upload)(struct input_dev *dev, struct ff_effect *effect,
    1401             :                       struct ff_effect *old);
    1402             :         int (*erase)(struct input_dev *dev, int effect_id);
    1403             : 
    1404             :         int (*playback)(struct input_dev *dev, int effect_id, int value);
    1405             :         void (*set_gain)(struct input_dev *dev, u16 gain);
    1406             :         void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
    1407             : 
    1408             :         void (*destroy)(struct ff_device *);
    1409             : 
    1410             :         void *private;
    1411             : 
    1412             :         unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
    1413             : 
    1414             :         struct mutex mutex;
    1415             : 
    1416             :         int max_effects;
    1417             :         struct ff_effect *effects;
    1418             :         struct file *effect_owners[];
    1419             : };
    1420             : 
    1421             : int input_ff_create(struct input_dev *dev, int max_effects);
    1422             : void input_ff_destroy(struct input_dev *dev);
    1423             : 
    1424             : int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
    1425             : 
    1426             : int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
    1427             : int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
    1428             : 
    1429             : int input_ff_create_memless(struct input_dev *dev, void *data,
    1430             :                 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
    1431             : 
    1432             : #endif
    1433             : #endif

Generated by: LCOV version 1.10