Merge branch 'linus' into x86/signal

[linux-2.6] / include / linux / input.h

#ifndef _INPUT_H
#define _INPUT_H

/*
 * Copyright (c) 1999-2002 Vojtech Pavlik
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#ifdef __KERNEL__
#include <linux/time.h>
#include <linux/list.h>
#else
#include <sys/time.h>
#include <sys/ioctl.h>
#include <sys/types.h>
#include <asm/types.h>
#endif

/*
 * The event structure itself
 */

struct input_event {
        struct timeval time;
        __u16 type;
        __u16 code;
        __s32 value;
};

/*
 * Protocol version.
 */

#define EV_VERSION              0x010000

/*
 * IOCTLs (0x00 - 0x7f)
 */

struct input_id {
        __u16 bustype;
        __u16 vendor;
        __u16 product;
        __u16 version;
};

struct input_absinfo {
        __s32 value;
        __s32 minimum;
        __s32 maximum;
        __s32 fuzz;
        __s32 flat;
};

#define EVIOCGVERSION           _IOR('E', 0x01, int)                    /* get driver version */
#define EVIOCGID                _IOR('E', 0x02, struct input_id)        /* get device ID */
#define EVIOCGREP               _IOR('E', 0x03, int[2])                 /* get repeat settings */
#define EVIOCSREP               _IOW('E', 0x03, int[2])                 /* set repeat settings */
#define EVIOCGKEYCODE           _IOR('E', 0x04, int[2])                 /* get keycode */
#define EVIOCSKEYCODE           _IOW('E', 0x04, int[2])                 /* set keycode */

#define EVIOCGNAME(len)         _IOC(_IOC_READ, 'E', 0x06, len)         /* get device name */
#define EVIOCGPHYS(len)         _IOC(_IOC_READ, 'E', 0x07, len)         /* get physical location */
#define EVIOCGUNIQ(len)         _IOC(_IOC_READ, 'E', 0x08, len)         /* get unique identifier */

#define EVIOCGKEY(len)          _IOC(_IOC_READ, 'E', 0x18, len)         /* get global keystate */
#define EVIOCGLED(len)          _IOC(_IOC_READ, 'E', 0x19, len)         /* get all LEDs */
#define EVIOCGSND(len)          _IOC(_IOC_READ, 'E', 0x1a, len)         /* get all sounds status */
#define EVIOCGSW(len)           _IOC(_IOC_READ, 'E', 0x1b, len)         /* get all switch states */

#define EVIOCGBIT(ev,len)       _IOC(_IOC_READ, 'E', 0x20 + ev, len)    /* get event bits */
#define EVIOCGABS(abs)          _IOR('E', 0x40 + abs, struct input_absinfo)             /* get abs value/limits */
#define EVIOCSABS(abs)          _IOW('E', 0xc0 + abs, struct input_absinfo)             /* set abs value/limits */

#define EVIOCSFF                _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))   /* send a force effect to a force feedback device */
#define EVIOCRMFF               _IOW('E', 0x81, int)                    /* Erase a force effect */
#define EVIOCGEFFECTS           _IOR('E', 0x84, int)                    /* Report number of effects playable at the same time */

#define EVIOCGRAB               _IOW('E', 0x90, int)                    /* Grab/Release device */

/*
 * Event types
 */

#define EV_SYN                  0x00
#define EV_KEY                  0x01
#define EV_REL                  0x02
#define EV_ABS                  0x03
#define EV_MSC                  0x04
#define EV_SW                   0x05
#define EV_LED                  0x11
#define EV_SND                  0x12
#define EV_REP                  0x14
#define EV_FF                   0x15
#define EV_PWR                  0x16
#define EV_FF_STATUS            0x17
#define EV_MAX                  0x1f
#define EV_CNT                  (EV_MAX+1)

/*
 * Synchronization events.
 */

#define SYN_REPORT              0
#define SYN_CONFIG              1

/*
 * Keys and buttons
 *
 * Most of the keys/buttons are modeled after USB HUT 1.12
 * (see http://www.usb.org/developers/hidpage).
 * Abbreviations in the comments:
 * AC - Application Control
 * AL - Application Launch Button
 * SC - System Control
 */

#define KEY_RESERVED            0
#define KEY_ESC                 1
#define KEY_1                   2
#define KEY_2                   3
#define KEY_3                   4
#define KEY_4                   5
#define KEY_5                   6
#define KEY_6                   7
#define KEY_7                   8
#define KEY_8                   9
#define KEY_9                   10
#define KEY_0                   11
#define KEY_MINUS               12
#define KEY_EQUAL               13
#define KEY_BACKSPACE           14
#define KEY_TAB                 15
#define KEY_Q                   16
#define KEY_W                   17
#define KEY_E                   18
#define KEY_R                   19
#define KEY_T                   20
#define KEY_Y                   21
#define KEY_U                   22
#define KEY_I                   23
#define KEY_O                   24
#define KEY_P                   25
#define KEY_LEFTBRACE           26
#define KEY_RIGHTBRACE          27
#define KEY_ENTER               28
#define KEY_LEFTCTRL            29
#define KEY_A                   30
#define KEY_S                   31
#define KEY_D                   32
#define KEY_F                   33
#define KEY_G                   34
#define KEY_H                   35
#define KEY_J                   36
#define KEY_K                   37
#define KEY_L                   38
#define KEY_SEMICOLON           39
#define KEY_APOSTROPHE          40
#define KEY_GRAVE               41
#define KEY_LEFTSHIFT           42
#define KEY_BACKSLASH           43
#define KEY_Z                   44
#define KEY_X                   45
#define KEY_C                   46
#define KEY_V                   47
#define KEY_B                   48
#define KEY_N                   49
#define KEY_M                   50
#define KEY_COMMA               51
#define KEY_DOT                 52
#define KEY_SLASH               53
#define KEY_RIGHTSHIFT          54
#define KEY_KPASTERISK          55
#define KEY_LEFTALT             56
#define KEY_SPACE               57
#define KEY_CAPSLOCK            58
#define KEY_F1                  59
#define KEY_F2                  60
#define KEY_F3                  61
#define KEY_F4                  62
#define KEY_F5                  63
#define KEY_F6                  64
#define KEY_F7                  65
#define KEY_F8                  66
#define KEY_F9                  67
#define KEY_F10                 68
#define KEY_NUMLOCK             69
#define KEY_SCROLLLOCK          70
#define KEY_KP7                 71
#define KEY_KP8                 72
#define KEY_KP9                 73
#define KEY_KPMINUS             74
#define KEY_KP4                 75
#define KEY_KP5                 76
#define KEY_KP6                 77
#define KEY_KPPLUS              78
#define KEY_KP1                 79
#define KEY_KP2                 80
#define KEY_KP3                 81
#define KEY_KP0                 82
#define KEY_KPDOT               83

#define KEY_ZENKAKUHANKAKU      85
#define KEY_102ND               86
#define KEY_F11                 87
#define KEY_F12                 88
#define KEY_RO                  89
#define KEY_KATAKANA            90
#define KEY_HIRAGANA            91
#define KEY_HENKAN              92
#define KEY_KATAKANAHIRAGANA    93
#define KEY_MUHENKAN            94
#define KEY_KPJPCOMMA           95
#define KEY_KPENTER             96
#define KEY_RIGHTCTRL           97
#define KEY_KPSLASH             98
#define KEY_SYSRQ               99
#define KEY_RIGHTALT            100
#define KEY_LINEFEED            101
#define KEY_HOME                102
#define KEY_UP                  103
#define KEY_PAGEUP              104
#define KEY_LEFT                105
#define KEY_RIGHT               106
#define KEY_END                 107
#define KEY_DOWN                108
#define KEY_PAGEDOWN            109
#define KEY_INSERT              110
#define KEY_DELETE              111
#define KEY_MACRO               112
#define KEY_MUTE                113
#define KEY_VOLUMEDOWN          114
#define KEY_VOLUMEUP            115
#define KEY_POWER               116     /* SC System Power Down */
#define KEY_KPEQUAL             117
#define KEY_KPPLUSMINUS         118
#define KEY_PAUSE               119

#define KEY_KPCOMMA             121
#define KEY_HANGEUL             122
#define KEY_HANGUEL             KEY_HANGEUL
#define KEY_HANJA               123
#define KEY_YEN                 124
#define KEY_LEFTMETA            125
#define KEY_RIGHTMETA           126
#define KEY_COMPOSE             127

#define KEY_STOP                128     /* AC Stop */
#define KEY_AGAIN               129
#define KEY_PROPS               130     /* AC Properties */
#define KEY_UNDO                131     /* AC Undo */
#define KEY_FRONT               132
#define KEY_COPY                133     /* AC Copy */
#define KEY_OPEN                134     /* AC Open */
#define KEY_PASTE               135     /* AC Paste */
#define KEY_FIND                136     /* AC Search */
#define KEY_CUT                 137     /* AC Cut */
#define KEY_HELP                138     /* AL Integrated Help Center */
#define KEY_MENU                139     /* Menu (show menu) */
#define KEY_CALC                140     /* AL Calculator */
#define KEY_SETUP               141
#define KEY_SLEEP               142     /* SC System Sleep */
#define KEY_WAKEUP              143     /* System Wake Up */
#define KEY_FILE                144     /* AL Local Machine Browser */
#define KEY_SENDFILE            145
#define KEY_DELETEFILE          146
#define KEY_XFER                147
#define KEY_PROG1               148
#define KEY_PROG2               149
#define KEY_WWW                 150     /* AL Internet Browser */
#define KEY_MSDOS               151
#define KEY_COFFEE              152     /* AL Terminal Lock/Screensaver */
#define KEY_SCREENLOCK          KEY_COFFEE
#define KEY_DIRECTION           153
#define KEY_CYCLEWINDOWS        154
#define KEY_MAIL                155
#define KEY_BOOKMARKS           156     /* AC Bookmarks */
#define KEY_COMPUTER            157
#define KEY_BACK                158     /* AC Back */
#define KEY_FORWARD             159     /* AC Forward */
#define KEY_CLOSECD             160
#define KEY_EJECTCD             161
#define KEY_EJECTCLOSECD        162
#define KEY_NEXTSONG            163
#define KEY_PLAYPAUSE           164
#define KEY_PREVIOUSSONG        165
#define KEY_STOPCD              166
#define KEY_RECORD              167
#define KEY_REWIND              168
#define KEY_PHONE               169     /* Media Select Telephone */
#define KEY_ISO                 170
#define KEY_CONFIG              171     /* AL Consumer Control Configuration */
#define KEY_HOMEPAGE            172     /* AC Home */
#define KEY_REFRESH             173     /* AC Refresh */
#define KEY_EXIT                174     /* AC Exit */
#define KEY_MOVE                175
#define KEY_EDIT                176
#define KEY_SCROLLUP            177
#define KEY_SCROLLDOWN          178
#define KEY_KPLEFTPAREN         179
#define KEY_KPRIGHTPAREN        180
#define KEY_NEW                 181     /* AC New */
#define KEY_REDO                182     /* AC Redo/Repeat */

#define KEY_F13                 183
#define KEY_F14                 184
#define KEY_F15                 185
#define KEY_F16                 186
#define KEY_F17                 187
#define KEY_F18                 188
#define KEY_F19                 189
#define KEY_F20                 190
#define KEY_F21                 191
#define KEY_F22                 192
#define KEY_F23                 193
#define KEY_F24                 194

#define KEY_PLAYCD              200
#define KEY_PAUSECD             201
#define KEY_PROG3               202
#define KEY_PROG4               203
#define KEY_SUSPEND             205
#define KEY_CLOSE               206     /* AC Close */
#define KEY_PLAY                207
#define KEY_FASTFORWARD         208
#define KEY_BASSBOOST           209
#define KEY_PRINT               210     /* AC Print */
#define KEY_HP                  211
#define KEY_CAMERA              212
#define KEY_SOUND               213
#define KEY_QUESTION            214
#define KEY_EMAIL               215
#define KEY_CHAT                216
#define KEY_SEARCH              217
#define KEY_CONNECT             218
#define KEY_FINANCE             219     /* AL Checkbook/Finance */
#define KEY_SPORT               220
#define KEY_SHOP                221
#define KEY_ALTERASE            222
#define KEY_CANCEL              223     /* AC Cancel */
#define KEY_BRIGHTNESSDOWN      224
#define KEY_BRIGHTNESSUP        225
#define KEY_MEDIA               226

#define KEY_SWITCHVIDEOMODE     227     /* Cycle between available video
                                           outputs (Monitor/LCD/TV-out/etc) */
#define KEY_KBDILLUMTOGGLE      228
#define KEY_KBDILLUMDOWN        229
#define KEY_KBDILLUMUP          230

#define KEY_SEND                231     /* AC Send */
#define KEY_REPLY               232     /* AC Reply */
#define KEY_FORWARDMAIL         233     /* AC Forward Msg */
#define KEY_SAVE                234     /* AC Save */
#define KEY_DOCUMENTS           235

#define KEY_BATTERY             236

#define KEY_BLUETOOTH           237
#define KEY_WLAN                238
#define KEY_UWB                 239

#define KEY_UNKNOWN             240

#define KEY_VIDEO_NEXT          241     /* drive next video source */
#define KEY_VIDEO_PREV          242     /* drive previous video source */
#define KEY_BRIGHTNESS_CYCLE    243     /* brightness up, after max is min */
#define KEY_BRIGHTNESS_ZERO     244     /* brightness off, use ambient */
#define KEY_DISPLAY_OFF         245     /* display device to off state */

#define KEY_WIMAX               246

/* Range 248 - 255 is reserved for special needs of AT keyboard driver */

#define BTN_MISC                0x100
#define BTN_0                   0x100
#define BTN_1                   0x101
#define BTN_2                   0x102
#define BTN_3                   0x103
#define BTN_4                   0x104
#define BTN_5                   0x105
#define BTN_6                   0x106
#define BTN_7                   0x107
#define BTN_8                   0x108
#define BTN_9                   0x109

#define BTN_MOUSE               0x110
#define BTN_LEFT                0x110
#define BTN_RIGHT               0x111
#define BTN_MIDDLE              0x112
#define BTN_SIDE                0x113
#define BTN_EXTRA               0x114
#define BTN_FORWARD             0x115
#define BTN_BACK                0x116
#define BTN_TASK                0x117

#define BTN_JOYSTICK            0x120
#define BTN_TRIGGER             0x120
#define BTN_THUMB               0x121
#define BTN_THUMB2              0x122
#define BTN_TOP                 0x123
#define BTN_TOP2                0x124
#define BTN_PINKIE              0x125
#define BTN_BASE                0x126
#define BTN_BASE2               0x127
#define BTN_BASE3               0x128
#define BTN_BASE4               0x129
#define BTN_BASE5               0x12a
#define BTN_BASE6               0x12b
#define BTN_DEAD                0x12f

#define BTN_GAMEPAD             0x130
#define BTN_A                   0x130
#define BTN_B                   0x131
#define BTN_C                   0x132
#define BTN_X                   0x133
#define BTN_Y                   0x134
#define BTN_Z                   0x135
#define BTN_TL                  0x136
#define BTN_TR                  0x137
#define BTN_TL2                 0x138
#define BTN_TR2                 0x139
#define BTN_SELECT              0x13a
#define BTN_START               0x13b
#define BTN_MODE                0x13c
#define BTN_THUMBL              0x13d
#define BTN_THUMBR              0x13e

#define BTN_DIGI                0x140
#define BTN_TOOL_PEN            0x140
#define BTN_TOOL_RUBBER         0x141
#define BTN_TOOL_BRUSH          0x142
#define BTN_TOOL_PENCIL         0x143
#define BTN_TOOL_AIRBRUSH       0x144
#define BTN_TOOL_FINGER         0x145
#define BTN_TOOL_MOUSE          0x146
#define BTN_TOOL_LENS           0x147
#define BTN_TOUCH               0x14a
#define BTN_STYLUS              0x14b
#define BTN_STYLUS2             0x14c
#define BTN_TOOL_DOUBLETAP      0x14d
#define BTN_TOOL_TRIPLETAP      0x14e

#define BTN_WHEEL               0x150
#define BTN_GEAR_DOWN           0x150
#define BTN_GEAR_UP             0x151

#define KEY_OK                  0x160
#define KEY_SELECT              0x161
#define KEY_GOTO                0x162
#define KEY_CLEAR               0x163
#define KEY_POWER2              0x164
#define KEY_OPTION              0x165
#define KEY_INFO                0x166   /* AL OEM Features/Tips/Tutorial */
#define KEY_TIME                0x167
#define KEY_VENDOR              0x168
#define KEY_ARCHIVE             0x169
#define KEY_PROGRAM             0x16a   /* Media Select Program Guide */
#define KEY_CHANNEL             0x16b
#define KEY_FAVORITES           0x16c
#define KEY_EPG                 0x16d
#define KEY_PVR                 0x16e   /* Media Select Home */
#define KEY_MHP                 0x16f
#define KEY_LANGUAGE            0x170
#define KEY_TITLE               0x171
#define KEY_SUBTITLE            0x172
#define KEY_ANGLE               0x173
#define KEY_ZOOM                0x174
#define KEY_MODE                0x175
#define KEY_KEYBOARD            0x176
#define KEY_SCREEN              0x177
#define KEY_PC                  0x178   /* Media Select Computer */
#define KEY_TV                  0x179   /* Media Select TV */
#define KEY_TV2                 0x17a   /* Media Select Cable */
#define KEY_VCR                 0x17b   /* Media Select VCR */
#define KEY_VCR2                0x17c   /* VCR Plus */
#define KEY_SAT                 0x17d   /* Media Select Satellite */
#define KEY_SAT2                0x17e
#define KEY_CD                  0x17f   /* Media Select CD */
#define KEY_TAPE                0x180   /* Media Select Tape */
#define KEY_RADIO               0x181
#define KEY_TUNER               0x182   /* Media Select Tuner */
#define KEY_PLAYER              0x183
#define KEY_TEXT                0x184
#define KEY_DVD                 0x185   /* Media Select DVD */
#define KEY_AUX                 0x186
#define KEY_MP3                 0x187
#define KEY_AUDIO               0x188
#define KEY_VIDEO               0x189
#define KEY_DIRECTORY           0x18a
#define KEY_LIST                0x18b
#define KEY_MEMO                0x18c   /* Media Select Messages */
#define KEY_CALENDAR            0x18d
#define KEY_RED                 0x18e
#define KEY_GREEN               0x18f
#define KEY_YELLOW              0x190
#define KEY_BLUE                0x191
#define KEY_CHANNELUP           0x192   /* Channel Increment */
#define KEY_CHANNELDOWN         0x193   /* Channel Decrement */
#define KEY_FIRST               0x194
#define KEY_LAST                0x195   /* Recall Last */
#define KEY_AB                  0x196
#define KEY_NEXT                0x197
#define KEY_RESTART             0x198
#define KEY_SLOW                0x199
#define KEY_SHUFFLE             0x19a
#define KEY_BREAK               0x19b
#define KEY_PREVIOUS            0x19c
#define KEY_DIGITS              0x19d
#define KEY_TEEN                0x19e
#define KEY_TWEN                0x19f
#define KEY_VIDEOPHONE          0x1a0   /* Media Select Video Phone */
#define KEY_GAMES               0x1a1   /* Media Select Games */
#define KEY_ZOOMIN              0x1a2   /* AC Zoom In */
#define KEY_ZOOMOUT             0x1a3   /* AC Zoom Out */
#define KEY_ZOOMRESET           0x1a4   /* AC Zoom */
#define KEY_WORDPROCESSOR       0x1a5   /* AL Word Processor */
#define KEY_EDITOR              0x1a6   /* AL Text Editor */
#define KEY_SPREADSHEET         0x1a7   /* AL Spreadsheet */
#define KEY_GRAPHICSEDITOR      0x1a8   /* AL Graphics Editor */
#define KEY_PRESENTATION        0x1a9   /* AL Presentation App */
#define KEY_DATABASE            0x1aa   /* AL Database App */
#define KEY_NEWS                0x1ab   /* AL Newsreader */
#define KEY_VOICEMAIL           0x1ac   /* AL Voicemail */
#define KEY_ADDRESSBOOK         0x1ad   /* AL Contacts/Address Book */
#define KEY_MESSENGER           0x1ae   /* AL Instant Messaging */
#define KEY_DISPLAYTOGGLE       0x1af   /* Turn display (LCD) on and off */
#define KEY_SPELLCHECK          0x1b0   /* AL Spell Check */
#define KEY_LOGOFF              0x1b1   /* AL Logoff */

#define KEY_DOLLAR              0x1b2
#define KEY_EURO                0x1b3

#define KEY_FRAMEBACK           0x1b4   /* Consumer - transport controls */
#define KEY_FRAMEFORWARD        0x1b5
#define KEY_CONTEXT_MENU        0x1b6   /* GenDesc - system context menu */
#define KEY_MEDIA_REPEAT        0x1b7   /* Consumer - transport control */

#define KEY_DEL_EOL             0x1c0
#define KEY_DEL_EOS             0x1c1
#define KEY_INS_LINE            0x1c2
#define KEY_DEL_LINE            0x1c3

#define KEY_FN                  0x1d0
#define KEY_FN_ESC              0x1d1
#define KEY_FN_F1               0x1d2
#define KEY_FN_F2               0x1d3
#define KEY_FN_F3               0x1d4
#define KEY_FN_F4               0x1d5
#define KEY_FN_F5               0x1d6
#define KEY_FN_F6               0x1d7
#define KEY_FN_F7               0x1d8
#define KEY_FN_F8               0x1d9
#define KEY_FN_F9               0x1da
#define KEY_FN_F10              0x1db
#define KEY_FN_F11              0x1dc
#define KEY_FN_F12              0x1dd
#define KEY_FN_1                0x1de
#define KEY_FN_2                0x1df
#define KEY_FN_D                0x1e0
#define KEY_FN_E                0x1e1
#define KEY_FN_F                0x1e2
#define KEY_FN_S                0x1e3
#define KEY_FN_B                0x1e4

#define KEY_BRL_DOT1            0x1f1
#define KEY_BRL_DOT2            0x1f2
#define KEY_BRL_DOT3            0x1f3
#define KEY_BRL_DOT4            0x1f4
#define KEY_BRL_DOT5            0x1f5
#define KEY_BRL_DOT6            0x1f6
#define KEY_BRL_DOT7            0x1f7
#define KEY_BRL_DOT8            0x1f8
#define KEY_BRL_DOT9            0x1f9
#define KEY_BRL_DOT10           0x1fa

/* We avoid low common keys in module aliases so they don't get huge. */
#define KEY_MIN_INTERESTING     KEY_MUTE
#define KEY_MAX                 0x1ff
#define KEY_CNT                 (KEY_MAX+1)

/*
 * Relative axes
 */

#define REL_X                   0x00
#define REL_Y                   0x01
#define REL_Z                   0x02
#define REL_RX                  0x03
#define REL_RY                  0x04
#define REL_RZ                  0x05
#define REL_HWHEEL              0x06
#define REL_DIAL                0x07
#define REL_WHEEL               0x08
#define REL_MISC                0x09
#define REL_MAX                 0x0f
#define REL_CNT                 (REL_MAX+1)

/*
 * Absolute axes
 */

#define ABS_X                   0x00
#define ABS_Y                   0x01
#define ABS_Z                   0x02
#define ABS_RX                  0x03
#define ABS_RY                  0x04
#define ABS_RZ                  0x05
#define ABS_THROTTLE            0x06
#define ABS_RUDDER              0x07
#define ABS_WHEEL               0x08
#define ABS_GAS                 0x09
#define ABS_BRAKE               0x0a
#define ABS_HAT0X               0x10
#define ABS_HAT0Y               0x11
#define ABS_HAT1X               0x12
#define ABS_HAT1Y               0x13
#define ABS_HAT2X               0x14
#define ABS_HAT2Y               0x15
#define ABS_HAT3X               0x16
#define ABS_HAT3Y               0x17
#define ABS_PRESSURE            0x18
#define ABS_DISTANCE            0x19
#define ABS_TILT_X              0x1a
#define ABS_TILT_Y              0x1b
#define ABS_TOOL_WIDTH          0x1c
#define ABS_VOLUME              0x20
#define ABS_MISC                0x28
#define ABS_MAX                 0x3f
#define ABS_CNT                 (ABS_MAX+1)

/*
 * Switch events
 */

#define SW_LID                  0x00  /* set = lid shut */
#define SW_TABLET_MODE          0x01  /* set = tablet mode */
#define SW_HEADPHONE_INSERT     0x02  /* set = inserted */
#define SW_RFKILL_ALL           0x03  /* rfkill master switch, type "any"
                                         set = radio enabled */
#define SW_RADIO                SW_RFKILL_ALL   /* deprecated */
#define SW_MICROPHONE_INSERT    0x04  /* set = inserted */
#define SW_DOCK                 0x05  /* set = plugged into dock */
#define SW_MAX                  0x0f
#define SW_CNT                  (SW_MAX+1)

/*
 * Misc events
 */

#define MSC_SERIAL              0x00
#define MSC_PULSELED            0x01
#define MSC_GESTURE             0x02
#define MSC_RAW                 0x03
#define MSC_SCAN                0x04
#define MSC_MAX                 0x07
#define MSC_CNT                 (MSC_MAX+1)

/*
 * LEDs
 */

#define LED_NUML                0x00
#define LED_CAPSL               0x01
#define LED_SCROLLL             0x02
#define LED_COMPOSE             0x03
#define LED_KANA                0x04
#define LED_SLEEP               0x05
#define LED_SUSPEND             0x06
#define LED_MUTE                0x07
#define LED_MISC                0x08
#define LED_MAIL                0x09
#define LED_CHARGING            0x0a
#define LED_MAX                 0x0f
#define LED_CNT                 (LED_MAX+1)

/*
 * Autorepeat values
 */

#define REP_DELAY               0x00
#define REP_PERIOD              0x01
#define REP_MAX                 0x01

/*
 * Sounds
 */

#define SND_CLICK               0x00
#define SND_BELL                0x01
#define SND_TONE                0x02
#define SND_MAX                 0x07
#define SND_CNT                 (SND_MAX+1)

/*
 * IDs.
 */

#define ID_BUS                  0
#define ID_VENDOR               1
#define ID_PRODUCT              2
#define ID_VERSION              3

#define BUS_PCI                 0x01
#define BUS_ISAPNP              0x02
#define BUS_USB                 0x03
#define BUS_HIL                 0x04
#define BUS_BLUETOOTH           0x05
#define BUS_VIRTUAL             0x06

#define BUS_ISA                 0x10
#define BUS_I8042               0x11
#define BUS_XTKBD               0x12
#define BUS_RS232               0x13
#define BUS_GAMEPORT            0x14
#define BUS_PARPORT             0x15
#define BUS_AMIGA               0x16
#define BUS_ADB                 0x17
#define BUS_I2C                 0x18
#define BUS_HOST                0x19
#define BUS_GSC                 0x1A
#define BUS_ATARI               0x1B

/*
 * Values describing the status of a force-feedback effect
 */
#define FF_STATUS_STOPPED       0x00
#define FF_STATUS_PLAYING       0x01
#define FF_STATUS_MAX           0x01

/*
 * Structures used in ioctls to upload effects to a device
 * They are pieces of a bigger structure (called ff_effect)
 */

/*
 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
 * should not be used and have unspecified results.
 */

/**
 * struct ff_replay - defines scheduling of the force-feedback effect
 * @length: duration of the effect
 * @delay: delay before effect should start playing
 */
struct ff_replay {
        __u16 length;
        __u16 delay;
};

/**
 * struct ff_trigger - defines what triggers the force-feedback effect
 * @button: number of the button triggering the effect
 * @interval: controls how soon the effect can be re-triggered
 */
struct ff_trigger {
        __u16 button;
        __u16 interval;
};

/**
 * struct ff_envelope - generic force-feedback effect envelope
 * @attack_length: duration of the attack (ms)
 * @attack_level: level at the beginning of the attack
 * @fade_length: duration of fade (ms)
 * @fade_level: level at the end of fade
 *
 * The @attack_level and @fade_level are absolute values; when applying
 * envelope force-feedback core will convert to positive/negative
 * value based on polarity of the default level of the effect.
 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
 */
struct ff_envelope {
        __u16 attack_length;
        __u16 attack_level;
        __u16 fade_length;
        __u16 fade_level;
};

/**
 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
 * @level: strength of the effect; may be negative
 * @envelope: envelope data
 */
struct ff_constant_effect {
        __s16 level;
        struct ff_envelope envelope;
};

/**
 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
 * @start_level: beginning strength of the effect; may be negative
 * @end_level: final strength of the effect; may be negative
 * @envelope: envelope data
 */
struct ff_ramp_effect {
        __s16 start_level;
        __s16 end_level;
        struct ff_envelope envelope;
};

/**
 * struct ff_condition_effect - defines a spring or friction force-feedback effect
 * @right_saturation: maximum level when joystick moved all way to the right
 * @left_saturation: same for the left side
 * @right_coeff: controls how fast the force grows when the joystick moves
 *      to the right
 * @left_coeff: same for the left side
 * @deadband: size of the dead zone, where no force is produced
 * @center: position of the dead zone
 */
struct ff_condition_effect {
        __u16 right_saturation;
        __u16 left_saturation;

        __s16 right_coeff;
        __s16 left_coeff;

        __u16 deadband;
        __s16 center;
};

/**
 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
 * @waveform: kind of the effect (wave)
 * @period: period of the wave (ms)
 * @magnitude: peak value
 * @offset: mean value of the wave (roughly)
 * @phase: 'horizontal' shift
 * @envelope: envelope data
 * @custom_len: number of samples (FF_CUSTOM only)
 * @custom_data: buffer of samples (FF_CUSTOM only)
 *
 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
 * for the time being as no driver supports it yet.
 *
 * Note: the data pointed by custom_data is copied by the driver.
 * You can therefore dispose of the memory after the upload/update.
 */
struct ff_periodic_effect {
        __u16 waveform;
        __u16 period;
        __s16 magnitude;
        __s16 offset;
        __u16 phase;

        struct ff_envelope envelope;

        __u32 custom_len;
        __s16 *custom_data;
};

/**
 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
 * @strong_magnitude: magnitude of the heavy motor
 * @weak_magnitude: magnitude of the light one
 *
 * Some rumble pads have two motors of different weight. Strong_magnitude
 * represents the magnitude of the vibration generated by the heavy one.
 */
struct ff_rumble_effect {
        __u16 strong_magnitude;
        __u16 weak_magnitude;
};

/**
 * struct ff_effect - defines force feedback effect
 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
 *      FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
 * @id: an unique id assigned to an effect
 * @direction: direction of the effect
 * @trigger: trigger conditions (struct ff_trigger)
 * @replay: scheduling of the effect (struct ff_replay)
 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
 *      ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
 *      defining effect parameters
 *
 * This structure is sent through ioctl from the application to the driver.
 * To create a new effect application should set its @id to -1; the kernel
 * will return assigned @id which can later be used to update or delete
 * this effect.
 *
 * Direction of the effect is encoded as follows:
 *      0 deg -> 0x0000 (down)
 *      90 deg -> 0x4000 (left)
 *      180 deg -> 0x8000 (up)
 *      270 deg -> 0xC000 (right)
 */
struct ff_effect {
        __u16 type;
        __s16 id;
        __u16 direction;
        struct ff_trigger trigger;
        struct ff_replay replay;

        union {
                struct ff_constant_effect constant;
                struct ff_ramp_effect ramp;
                struct ff_periodic_effect periodic;
                struct ff_condition_effect condition[2]; /* One for each axis */
                struct ff_rumble_effect rumble;
        } u;
};

/*
 * Force feedback effect types
 */

#define FF_RUMBLE       0x50
#define FF_PERIODIC     0x51
#define FF_CONSTANT     0x52
#define FF_SPRING       0x53
#define FF_FRICTION     0x54
#define FF_DAMPER       0x55
#define FF_INERTIA      0x56
#define FF_RAMP         0x57

#define FF_EFFECT_MIN   FF_RUMBLE
#define FF_EFFECT_MAX   FF_RAMP

/*
 * Force feedback periodic effect types
 */

#define FF_SQUARE       0x58
#define FF_TRIANGLE     0x59
#define FF_SINE         0x5a
#define FF_SAW_UP       0x5b
#define FF_SAW_DOWN     0x5c
#define FF_CUSTOM       0x5d

#define FF_WAVEFORM_MIN FF_SQUARE
#define FF_WAVEFORM_MAX FF_CUSTOM

/*
 * Set ff device properties
 */

#define FF_GAIN         0x60
#define FF_AUTOCENTER   0x61

#define FF_MAX          0x7f
#define FF_CNT          (FF_MAX+1)

#ifdef __KERNEL__

/*
 * In-kernel definitions.
 */

#include <linux/device.h>
#include <linux/fs.h>
#include <linux/timer.h>
#include <linux/mod_devicetable.h>

/**
 * struct input_dev - represents an input device
 * @name: name of the device
 * @phys: physical path to the device in the system hierarchy
 * @uniq: unique identification code for the device (if device has it)
 * @id: id of the device (struct input_id)
 * @evbit: bitmap of types of events supported by the device (EV_KEY,
 *      EV_REL, etc.)
 * @keybit: bitmap of keys/buttons this device has
 * @relbit: bitmap of relative axes for the device
 * @absbit: bitmap of absolute axes for the device
 * @mscbit: bitmap of miscellaneous events supported by the device
 * @ledbit: bitmap of leds present on the device
 * @sndbit: bitmap of sound effects supported by the device
 * @ffbit: bitmap of force feedback effects supported by the device
 * @swbit: bitmap of switches present on the device
 * @keycodemax: size of keycode table
 * @keycodesize: size of elements in keycode table
 * @keycode: map of scancodes to keycodes for this device
 * @setkeycode: optional method to alter current keymap, used to implement
 *      sparse keymaps. If not supplied default mechanism will be used
 * @getkeycode: optional method to retrieve current keymap. If not supplied
 *      default mechanism will be used
 * @ff: force feedback structure associated with the device if device
 *      supports force feedback effects
 * @repeat_key: stores key code of the last key pressed; used to implement
 *      software autorepeat
 * @timer: timer for software autorepeat
 * @sync: set to 1 when there were no new events since last EV_SYNC
 * @abs: current values for reports from absolute axes
 * @rep: current values for autorepeat parameters (delay, rate)
 * @key: reflects current state of device's keys/buttons
 * @led: reflects current state of device's LEDs
 * @snd: reflects current state of sound effects
 * @sw: reflects current state of device's switches
 * @absmax: maximum values for events coming from absolute axes
 * @absmin: minimum values for events coming from absolute axes
 * @absfuzz: describes noisiness for axes
 * @absflat: size of the center flat position (used by joydev)
 * @open: this method is called when the very first user calls
 *      input_open_device(). The driver must prepare the device
 *      to start generating events (start polling thread,
 *      request an IRQ, submit URB, etc.)
 * @close: this method is called when the very last user calls
 *      input_close_device().
 * @flush: purges the device. Most commonly used to get rid of force
 *      feedback effects loaded into the device when disconnecting
 *      from it
 * @event: event handler for events sent _to_ the device, like EV_LED
 *      or EV_SND. The device is expected to carry out the requested
 *      action (turn on a LED, play sound, etc.) The call is protected
 *      by @event_lock and must not sleep
 * @grab: input handle that currently has the device grabbed (via
 *      EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
 *      recipient for all input events coming from the device
 * @event_lock: this spinlock is is taken when input core receives
 *      and processes a new event for the device (in input_event()).
 *      Code that accesses and/or modifies parameters of a device
 *      (such as keymap or absmin, absmax, absfuzz, etc.) after device
 *      has been registered with input core must take this lock.
 * @mutex: serializes calls to open(), close() and flush() methods
 * @users: stores number of users (input handlers) that opened this
 *      device. It is used by input_open_device() and input_close_device()
 *      to make sure that dev->open() is only called when the first
 *      user opens device and dev->close() is called when the very
 *      last user closes the device
 * @going_away: marks devices that are in a middle of unregistering and
 *      causes input_open_device*() fail with -ENODEV.
 * @dev: driver model's view of this device
 * @h_list: list of input handles associated with the device. When
 *      accessing the list dev->mutex must be held
 * @node: used to place the device onto input_dev_list
 */
struct input_dev {
        const char *name;
        const char *phys;
        const char *uniq;
        struct input_id id;

        unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
        unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
        unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
        unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
        unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
        unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
        unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
        unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
        unsigned long swbit[BITS_TO_LONGS(SW_CNT)];

        unsigned int keycodemax;
        unsigned int keycodesize;
        void *keycode;
        int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
        int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);

        struct ff_device *ff;

        unsigned int repeat_key;
        struct timer_list timer;

        int sync;

        int abs[ABS_MAX + 1];
        int rep[REP_MAX + 1];

        unsigned long key[BITS_TO_LONGS(KEY_CNT)];
        unsigned long led[BITS_TO_LONGS(LED_CNT)];
        unsigned long snd[BITS_TO_LONGS(SND_CNT)];
        unsigned long sw[BITS_TO_LONGS(SW_CNT)];

        int absmax[ABS_MAX + 1];
        int absmin[ABS_MAX + 1];
        int absfuzz[ABS_MAX + 1];
        int absflat[ABS_MAX + 1];

        int (*open)(struct input_dev *dev);
        void (*close)(struct input_dev *dev);
        int (*flush)(struct input_dev *dev, struct file *file);
        int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);

        struct input_handle *grab;

        spinlock_t event_lock;
        struct mutex mutex;

        unsigned int users;
        int going_away;

        struct device dev;

        struct list_head        h_list;
        struct list_head        node;
};
#define to_input_dev(d) container_of(d, struct input_dev, dev)

/*
 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
 */

#if EV_MAX != INPUT_DEVICE_ID_EV_MAX
#error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
#endif

#if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
#error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
#endif

#if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
#error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
#endif

#if REL_MAX != INPUT_DEVICE_ID_REL_MAX
#error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
#endif

#if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
#error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
#endif

#if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
#error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
#endif

#if LED_MAX != INPUT_DEVICE_ID_LED_MAX
#error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
#endif

#if SND_MAX != INPUT_DEVICE_ID_SND_MAX
#error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
#endif

#if FF_MAX != INPUT_DEVICE_ID_FF_MAX
#error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
#endif

#if SW_MAX != INPUT_DEVICE_ID_SW_MAX
#error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
#endif

#define INPUT_DEVICE_ID_MATCH_DEVICE \
        (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
#define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
        (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)

struct input_handle;

/**
 * struct input_handler - implements one of interfaces for input devices
 * @private: driver-specific data
 * @event: event handler. This method is being called by input core with
 *      interrupts disabled and dev->event_lock spinlock held and so
 *      it may not sleep
 * @connect: called when attaching a handler to an input device
 * @disconnect: disconnects a handler from input device
 * @start: starts handler for given handle. This function is called by
 *      input core right after connect() method and also when a process
 *      that "grabbed" a device releases it
 * @fops: file operations this driver implements
 * @minor: beginning of range of 32 minors for devices this driver
 *      can provide
 * @name: name of the handler, to be shown in /proc/bus/input/handlers
 * @id_table: pointer to a table of input_device_ids this driver can
 *      handle
 * @blacklist: pointer to a table of input_device_ids this driver should
 *      ignore even if they match @id_table
 * @h_list: list of input handles associated with the handler
 * @node: for placing the driver onto input_handler_list
 *
 * Input handlers attach to input devices and create input handles. There
 * are likely several handlers attached to any given input device at the
 * same time. All of them will get their copy of input event generated by
 * the device.
 *
 * Note that input core serializes calls to connect() and disconnect()
 * methods.
 */
struct input_handler {

        void *private;

        void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
        int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
        void (*disconnect)(struct input_handle *handle);
        void (*start)(struct input_handle *handle);

        const struct file_operations *fops;
        int minor;
        const char *name;

        const struct input_device_id *id_table;
        const struct input_device_id *blacklist;

        struct list_head        h_list;
        struct list_head        node;
};

/**
 * struct input_handle - links input device with an input handler
 * @private: handler-specific data
 * @open: counter showing whether the handle is 'open', i.e. should deliver
 *      events from its device
 * @name: name given to the handle by handler that created it
 * @dev: input device the handle is attached to
 * @handler: handler that works with the device through this handle
 * @d_node: used to put the handle on device's list of attached handles
 * @h_node: used to put the handle on handler's list of handles from which
 *      it gets events
 */
struct input_handle {

        void *private;

        int open;
        const char *name;

        struct input_dev *dev;
        struct input_handler *handler;

        struct list_head        d_node;
        struct list_head        h_node;
};

struct input_dev *input_allocate_device(void);
void input_free_device(struct input_dev *dev);

static inline struct input_dev *input_get_device(struct input_dev *dev)
{
        return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
}

static inline void input_put_device(struct input_dev *dev)
{
        if (dev)
                put_device(&dev->dev);
}

static inline void *input_get_drvdata(struct input_dev *dev)
{
        return dev_get_drvdata(&dev->dev);
}

static inline void input_set_drvdata(struct input_dev *dev, void *data)
{
        dev_set_drvdata(&dev->dev, data);
}

int __must_check input_register_device(struct input_dev *);
void input_unregister_device(struct input_dev *);

int __must_check input_register_handler(struct input_handler *);
void input_unregister_handler(struct input_handler *);

int input_register_handle(struct input_handle *);
void input_unregister_handle(struct input_handle *);

int input_grab_device(struct input_handle *);
void input_release_device(struct input_handle *);

int input_open_device(struct input_handle *);
void input_close_device(struct input_handle *);

int input_flush_device(struct input_handle* handle, struct file* file);

void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);

static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
{
        input_event(dev, EV_KEY, code, !!value);
}

static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
{
        input_event(dev, EV_REL, code, value);
}

static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
{
        input_event(dev, EV_ABS, code, value);
}

static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
{
        input_event(dev, EV_FF_STATUS, code, value);
}

static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
{
        input_event(dev, EV_SW, code, !!value);
}

static inline void input_sync(struct input_dev *dev)
{
        input_event(dev, EV_SYN, SYN_REPORT, 0);
}

void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);

static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
{
        dev->absmin[axis] = min;
        dev->absmax[axis] = max;
        dev->absfuzz[axis] = fuzz;
        dev->absflat[axis] = flat;

        dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
}

int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
int input_set_keycode(struct input_dev *dev, int scancode, int keycode);

extern struct class input_class;

/**
 * struct ff_device - force-feedback part of an input device
 * @upload: Called to upload an new effect into device
 * @erase: Called to erase an effect from device
 * @playback: Called to request device to start playing specified effect
 * @set_gain: Called to set specified gain
 * @set_autocenter: Called to auto-center device
 * @destroy: called by input core when parent input device is being
 *      destroyed
 * @private: driver-specific data, will be freed automatically
 * @ffbit: bitmap of force feedback capabilities truly supported by
 *      device (not emulated like ones in input_dev->ffbit)
 * @mutex: mutex for serializing access to the device
 * @max_effects: maximum number of effects supported by device
 * @effects: pointer to an array of effects currently loaded into device
 * @effect_owners: array of effect owners; when file handle owning
 *      an effect gets closed the effect is automatically erased
 *
 * Every force-feedback device must implement upload() and playback()
 * methods; erase() is optional. set_gain() and set_autocenter() need
 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
 * bits.
 */
struct ff_device {
        int (*upload)(struct input_dev *dev, struct ff_effect *effect,
                      struct ff_effect *old);
        int (*erase)(struct input_dev *dev, int effect_id);

        int (*playback)(struct input_dev *dev, int effect_id, int value);
        void (*set_gain)(struct input_dev *dev, u16 gain);
        void (*set_autocenter)(struct input_dev *dev, u16 magnitude);

        void (*destroy)(struct ff_device *);

        void *private;

        unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];

        struct mutex mutex;

        int max_effects;
        struct ff_effect *effects;
        struct file *effect_owners[];
};

int input_ff_create(struct input_dev *dev, int max_effects);
void input_ff_destroy(struct input_dev *dev);

int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);

int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);

int input_ff_create_memless(struct input_dev *dev, void *data,
                int (*play_effect)(struct input_dev *, void *, struct ff_effect *));

#endif
#endif