xref: /linux-6.15/include/linux/input.h (revision 6916d97f)
11da177e4SLinus Torvalds #ifndef _INPUT_H
21da177e4SLinus Torvalds #define _INPUT_H
31da177e4SLinus Torvalds 
41da177e4SLinus Torvalds /*
51da177e4SLinus Torvalds  * Copyright (c) 1999-2002 Vojtech Pavlik
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  * This program is free software; you can redistribute it and/or modify it
81da177e4SLinus Torvalds  * under the terms of the GNU General Public License version 2 as published by
91da177e4SLinus Torvalds  * the Free Software Foundation.
101da177e4SLinus Torvalds  */
111da177e4SLinus Torvalds 
121da177e4SLinus Torvalds #ifdef __KERNEL__
131da177e4SLinus Torvalds #include <linux/time.h>
141da177e4SLinus Torvalds #include <linux/list.h>
151da177e4SLinus Torvalds #else
161da177e4SLinus Torvalds #include <sys/time.h>
171da177e4SLinus Torvalds #include <sys/ioctl.h>
187b1c6ca7SDavid Woodhouse #include <sys/types.h>
1900bfddafSJaswinder Singh Rajput #include <linux/types.h>
201da177e4SLinus Torvalds #endif
211da177e4SLinus Torvalds 
221da177e4SLinus Torvalds /*
231da177e4SLinus Torvalds  * The event structure itself
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds 
261da177e4SLinus Torvalds struct input_event {
271da177e4SLinus Torvalds 	struct timeval time;
281da177e4SLinus Torvalds 	__u16 type;
291da177e4SLinus Torvalds 	__u16 code;
301da177e4SLinus Torvalds 	__s32 value;
311da177e4SLinus Torvalds };
321da177e4SLinus Torvalds 
331da177e4SLinus Torvalds /*
341da177e4SLinus Torvalds  * Protocol version.
351da177e4SLinus Torvalds  */
361da177e4SLinus Torvalds 
371da177e4SLinus Torvalds #define EV_VERSION		0x010000
381da177e4SLinus Torvalds 
391da177e4SLinus Torvalds /*
401da177e4SLinus Torvalds  * IOCTLs (0x00 - 0x7f)
411da177e4SLinus Torvalds  */
421da177e4SLinus Torvalds 
431da177e4SLinus Torvalds struct input_id {
441da177e4SLinus Torvalds 	__u16 bustype;
451da177e4SLinus Torvalds 	__u16 vendor;
461da177e4SLinus Torvalds 	__u16 product;
471da177e4SLinus Torvalds 	__u16 version;
481da177e4SLinus Torvalds };
491da177e4SLinus Torvalds 
501da177e4SLinus Torvalds struct input_absinfo {
511da177e4SLinus Torvalds 	__s32 value;
521da177e4SLinus Torvalds 	__s32 minimum;
531da177e4SLinus Torvalds 	__s32 maximum;
541da177e4SLinus Torvalds 	__s32 fuzz;
551da177e4SLinus Torvalds 	__s32 flat;
561da177e4SLinus Torvalds };
571da177e4SLinus Torvalds 
581da177e4SLinus Torvalds #define EVIOCGVERSION		_IOR('E', 0x01, int)			/* get driver version */
591da177e4SLinus Torvalds #define EVIOCGID		_IOR('E', 0x02, struct input_id)	/* get device ID */
6008791e5cSDmitry Torokhov #define EVIOCGREP		_IOR('E', 0x03, int[2])			/* get repeat settings */
6108791e5cSDmitry Torokhov #define EVIOCSREP		_IOW('E', 0x03, int[2])			/* set repeat settings */
621da177e4SLinus Torvalds #define EVIOCGKEYCODE		_IOR('E', 0x04, int[2])			/* get keycode */
631da177e4SLinus Torvalds #define EVIOCSKEYCODE		_IOW('E', 0x04, int[2])			/* set keycode */
641da177e4SLinus Torvalds 
651da177e4SLinus Torvalds #define EVIOCGNAME(len)		_IOC(_IOC_READ, 'E', 0x06, len)		/* get device name */
661da177e4SLinus Torvalds #define EVIOCGPHYS(len)		_IOC(_IOC_READ, 'E', 0x07, len)		/* get physical location */
671da177e4SLinus Torvalds #define EVIOCGUNIQ(len)		_IOC(_IOC_READ, 'E', 0x08, len)		/* get unique identifier */
681da177e4SLinus Torvalds 
691da177e4SLinus Torvalds #define EVIOCGKEY(len)		_IOC(_IOC_READ, 'E', 0x18, len)		/* get global keystate */
701da177e4SLinus Torvalds #define EVIOCGLED(len)		_IOC(_IOC_READ, 'E', 0x19, len)		/* get all LEDs */
711da177e4SLinus Torvalds #define EVIOCGSND(len)		_IOC(_IOC_READ, 'E', 0x1a, len)		/* get all sounds status */
7231581066SRichard Purdie #define EVIOCGSW(len)		_IOC(_IOC_READ, 'E', 0x1b, len)		/* get all switch states */
731da177e4SLinus Torvalds 
741da177e4SLinus Torvalds #define EVIOCGBIT(ev,len)	_IOC(_IOC_READ, 'E', 0x20 + ev, len)	/* get event bits */
751da177e4SLinus Torvalds #define EVIOCGABS(abs)		_IOR('E', 0x40 + abs, struct input_absinfo)		/* get abs value/limits */
761da177e4SLinus Torvalds #define EVIOCSABS(abs)		_IOW('E', 0xc0 + abs, struct input_absinfo)		/* set abs value/limits */
771da177e4SLinus Torvalds 
781da177e4SLinus Torvalds #define EVIOCSFF		_IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect))	/* send a force effect to a force feedback device */
791da177e4SLinus Torvalds #define EVIOCRMFF		_IOW('E', 0x81, int)			/* Erase a force effect */
801da177e4SLinus Torvalds #define EVIOCGEFFECTS		_IOR('E', 0x84, int)			/* Report number of effects playable at the same time */
811da177e4SLinus Torvalds 
821da177e4SLinus Torvalds #define EVIOCGRAB		_IOW('E', 0x90, int)			/* Grab/Release device */
831da177e4SLinus Torvalds 
841da177e4SLinus Torvalds /*
851da177e4SLinus Torvalds  * Event types
861da177e4SLinus Torvalds  */
871da177e4SLinus Torvalds 
881da177e4SLinus Torvalds #define EV_SYN			0x00
891da177e4SLinus Torvalds #define EV_KEY			0x01
901da177e4SLinus Torvalds #define EV_REL			0x02
911da177e4SLinus Torvalds #define EV_ABS			0x03
921da177e4SLinus Torvalds #define EV_MSC			0x04
9331581066SRichard Purdie #define EV_SW			0x05
941da177e4SLinus Torvalds #define EV_LED			0x11
951da177e4SLinus Torvalds #define EV_SND			0x12
961da177e4SLinus Torvalds #define EV_REP			0x14
971da177e4SLinus Torvalds #define EV_FF			0x15
981da177e4SLinus Torvalds #define EV_PWR			0x16
991da177e4SLinus Torvalds #define EV_FF_STATUS		0x17
1001da177e4SLinus Torvalds #define EV_MAX			0x1f
1017b19ada2SJiri Slaby #define EV_CNT			(EV_MAX+1)
1021da177e4SLinus Torvalds 
1031da177e4SLinus Torvalds /*
1041da177e4SLinus Torvalds  * Synchronization events.
1051da177e4SLinus Torvalds  */
1061da177e4SLinus Torvalds 
1071da177e4SLinus Torvalds #define SYN_REPORT		0
1081da177e4SLinus Torvalds #define SYN_CONFIG		1
1091da177e4SLinus Torvalds 
1101da177e4SLinus Torvalds /*
1111da177e4SLinus Torvalds  * Keys and buttons
1124e4eda86SDmitry Torokhov  *
1134e4eda86SDmitry Torokhov  * Most of the keys/buttons are modeled after USB HUT 1.12
1144e4eda86SDmitry Torokhov  * (see http://www.usb.org/developers/hidpage).
1154e4eda86SDmitry Torokhov  * Abbreviations in the comments:
1164e4eda86SDmitry Torokhov  * AC - Application Control
1174e4eda86SDmitry Torokhov  * AL - Application Launch Button
1184e4eda86SDmitry Torokhov  * SC - System Control
1191da177e4SLinus Torvalds  */
1201da177e4SLinus Torvalds 
1211da177e4SLinus Torvalds #define KEY_RESERVED		0
1221da177e4SLinus Torvalds #define KEY_ESC			1
1231da177e4SLinus Torvalds #define KEY_1			2
1241da177e4SLinus Torvalds #define KEY_2			3
1251da177e4SLinus Torvalds #define KEY_3			4
1261da177e4SLinus Torvalds #define KEY_4			5
1271da177e4SLinus Torvalds #define KEY_5			6
1281da177e4SLinus Torvalds #define KEY_6			7
1291da177e4SLinus Torvalds #define KEY_7			8
1301da177e4SLinus Torvalds #define KEY_8			9
1311da177e4SLinus Torvalds #define KEY_9			10
1321da177e4SLinus Torvalds #define KEY_0			11
1331da177e4SLinus Torvalds #define KEY_MINUS		12
1341da177e4SLinus Torvalds #define KEY_EQUAL		13
1351da177e4SLinus Torvalds #define KEY_BACKSPACE		14
1361da177e4SLinus Torvalds #define KEY_TAB			15
1371da177e4SLinus Torvalds #define KEY_Q			16
1381da177e4SLinus Torvalds #define KEY_W			17
1391da177e4SLinus Torvalds #define KEY_E			18
1401da177e4SLinus Torvalds #define KEY_R			19
1411da177e4SLinus Torvalds #define KEY_T			20
1421da177e4SLinus Torvalds #define KEY_Y			21
1431da177e4SLinus Torvalds #define KEY_U			22
1441da177e4SLinus Torvalds #define KEY_I			23
1451da177e4SLinus Torvalds #define KEY_O			24
1461da177e4SLinus Torvalds #define KEY_P			25
1471da177e4SLinus Torvalds #define KEY_LEFTBRACE		26
1481da177e4SLinus Torvalds #define KEY_RIGHTBRACE		27
1491da177e4SLinus Torvalds #define KEY_ENTER		28
1501da177e4SLinus Torvalds #define KEY_LEFTCTRL		29
1511da177e4SLinus Torvalds #define KEY_A			30
1521da177e4SLinus Torvalds #define KEY_S			31
1531da177e4SLinus Torvalds #define KEY_D			32
1541da177e4SLinus Torvalds #define KEY_F			33
1551da177e4SLinus Torvalds #define KEY_G			34
1561da177e4SLinus Torvalds #define KEY_H			35
1571da177e4SLinus Torvalds #define KEY_J			36
1581da177e4SLinus Torvalds #define KEY_K			37
1591da177e4SLinus Torvalds #define KEY_L			38
1601da177e4SLinus Torvalds #define KEY_SEMICOLON		39
1611da177e4SLinus Torvalds #define KEY_APOSTROPHE		40
1621da177e4SLinus Torvalds #define KEY_GRAVE		41
1631da177e4SLinus Torvalds #define KEY_LEFTSHIFT		42
1641da177e4SLinus Torvalds #define KEY_BACKSLASH		43
1651da177e4SLinus Torvalds #define KEY_Z			44
1661da177e4SLinus Torvalds #define KEY_X			45
1671da177e4SLinus Torvalds #define KEY_C			46
1681da177e4SLinus Torvalds #define KEY_V			47
1691da177e4SLinus Torvalds #define KEY_B			48
1701da177e4SLinus Torvalds #define KEY_N			49
1711da177e4SLinus Torvalds #define KEY_M			50
1721da177e4SLinus Torvalds #define KEY_COMMA		51
1731da177e4SLinus Torvalds #define KEY_DOT			52
1741da177e4SLinus Torvalds #define KEY_SLASH		53
1751da177e4SLinus Torvalds #define KEY_RIGHTSHIFT		54
1761da177e4SLinus Torvalds #define KEY_KPASTERISK		55
1771da177e4SLinus Torvalds #define KEY_LEFTALT		56
1781da177e4SLinus Torvalds #define KEY_SPACE		57
1791da177e4SLinus Torvalds #define KEY_CAPSLOCK		58
1801da177e4SLinus Torvalds #define KEY_F1			59
1811da177e4SLinus Torvalds #define KEY_F2			60
1821da177e4SLinus Torvalds #define KEY_F3			61
1831da177e4SLinus Torvalds #define KEY_F4			62
1841da177e4SLinus Torvalds #define KEY_F5			63
1851da177e4SLinus Torvalds #define KEY_F6			64
1861da177e4SLinus Torvalds #define KEY_F7			65
1871da177e4SLinus Torvalds #define KEY_F8			66
1881da177e4SLinus Torvalds #define KEY_F9			67
1891da177e4SLinus Torvalds #define KEY_F10			68
1901da177e4SLinus Torvalds #define KEY_NUMLOCK		69
1911da177e4SLinus Torvalds #define KEY_SCROLLLOCK		70
1921da177e4SLinus Torvalds #define KEY_KP7			71
1931da177e4SLinus Torvalds #define KEY_KP8			72
1941da177e4SLinus Torvalds #define KEY_KP9			73
1951da177e4SLinus Torvalds #define KEY_KPMINUS		74
1961da177e4SLinus Torvalds #define KEY_KP4			75
1971da177e4SLinus Torvalds #define KEY_KP5			76
1981da177e4SLinus Torvalds #define KEY_KP6			77
1991da177e4SLinus Torvalds #define KEY_KPPLUS		78
2001da177e4SLinus Torvalds #define KEY_KP1			79
2011da177e4SLinus Torvalds #define KEY_KP2			80
2021da177e4SLinus Torvalds #define KEY_KP3			81
2031da177e4SLinus Torvalds #define KEY_KP0			82
2041da177e4SLinus Torvalds #define KEY_KPDOT		83
2051da177e4SLinus Torvalds 
2061da177e4SLinus Torvalds #define KEY_ZENKAKUHANKAKU	85
2071da177e4SLinus Torvalds #define KEY_102ND		86
2081da177e4SLinus Torvalds #define KEY_F11			87
2091da177e4SLinus Torvalds #define KEY_F12			88
2101da177e4SLinus Torvalds #define KEY_RO			89
2111da177e4SLinus Torvalds #define KEY_KATAKANA		90
2121da177e4SLinus Torvalds #define KEY_HIRAGANA		91
2131da177e4SLinus Torvalds #define KEY_HENKAN		92
2141da177e4SLinus Torvalds #define KEY_KATAKANAHIRAGANA	93
2151da177e4SLinus Torvalds #define KEY_MUHENKAN		94
2161da177e4SLinus Torvalds #define KEY_KPJPCOMMA		95
2171da177e4SLinus Torvalds #define KEY_KPENTER		96
2181da177e4SLinus Torvalds #define KEY_RIGHTCTRL		97
2191da177e4SLinus Torvalds #define KEY_KPSLASH		98
2201da177e4SLinus Torvalds #define KEY_SYSRQ		99
2211da177e4SLinus Torvalds #define KEY_RIGHTALT		100
2221da177e4SLinus Torvalds #define KEY_LINEFEED		101
2231da177e4SLinus Torvalds #define KEY_HOME		102
2241da177e4SLinus Torvalds #define KEY_UP			103
2251da177e4SLinus Torvalds #define KEY_PAGEUP		104
2261da177e4SLinus Torvalds #define KEY_LEFT		105
2271da177e4SLinus Torvalds #define KEY_RIGHT		106
2281da177e4SLinus Torvalds #define KEY_END			107
2291da177e4SLinus Torvalds #define KEY_DOWN		108
2301da177e4SLinus Torvalds #define KEY_PAGEDOWN		109
2311da177e4SLinus Torvalds #define KEY_INSERT		110
2321da177e4SLinus Torvalds #define KEY_DELETE		111
2331da177e4SLinus Torvalds #define KEY_MACRO		112
2341da177e4SLinus Torvalds #define KEY_MUTE		113
2351da177e4SLinus Torvalds #define KEY_VOLUMEDOWN		114
2361da177e4SLinus Torvalds #define KEY_VOLUMEUP		115
2374e4eda86SDmitry Torokhov #define KEY_POWER		116	/* SC System Power Down */
2381da177e4SLinus Torvalds #define KEY_KPEQUAL		117
2391da177e4SLinus Torvalds #define KEY_KPPLUSMINUS		118
2401da177e4SLinus Torvalds #define KEY_PAUSE		119
241437184aeSHenrik Rydberg #define KEY_SCALE		120	/* AL Compiz Scale (Expose) */
2421da177e4SLinus Torvalds 
2431da177e4SLinus Torvalds #define KEY_KPCOMMA		121
244b9ab58ddSJerome Pinot #define KEY_HANGEUL		122
245b9ab58ddSJerome Pinot #define KEY_HANGUEL		KEY_HANGEUL
2461da177e4SLinus Torvalds #define KEY_HANJA		123
2471da177e4SLinus Torvalds #define KEY_YEN			124
2481da177e4SLinus Torvalds #define KEY_LEFTMETA		125
2491da177e4SLinus Torvalds #define KEY_RIGHTMETA		126
2501da177e4SLinus Torvalds #define KEY_COMPOSE		127
2511da177e4SLinus Torvalds 
2524e4eda86SDmitry Torokhov #define KEY_STOP		128	/* AC Stop */
2531da177e4SLinus Torvalds #define KEY_AGAIN		129
2544e4eda86SDmitry Torokhov #define KEY_PROPS		130	/* AC Properties */
2554e4eda86SDmitry Torokhov #define KEY_UNDO		131	/* AC Undo */
2561da177e4SLinus Torvalds #define KEY_FRONT		132
2574e4eda86SDmitry Torokhov #define KEY_COPY		133	/* AC Copy */
2584e4eda86SDmitry Torokhov #define KEY_OPEN		134	/* AC Open */
2594e4eda86SDmitry Torokhov #define KEY_PASTE		135	/* AC Paste */
2604e4eda86SDmitry Torokhov #define KEY_FIND		136	/* AC Search */
2614e4eda86SDmitry Torokhov #define KEY_CUT			137	/* AC Cut */
2624e4eda86SDmitry Torokhov #define KEY_HELP		138	/* AL Integrated Help Center */
2634e4eda86SDmitry Torokhov #define KEY_MENU		139	/* Menu (show menu) */
2644e4eda86SDmitry Torokhov #define KEY_CALC		140	/* AL Calculator */
2651da177e4SLinus Torvalds #define KEY_SETUP		141
2664e4eda86SDmitry Torokhov #define KEY_SLEEP		142	/* SC System Sleep */
2674e4eda86SDmitry Torokhov #define KEY_WAKEUP		143	/* System Wake Up */
2684e4eda86SDmitry Torokhov #define KEY_FILE		144	/* AL Local Machine Browser */
2691da177e4SLinus Torvalds #define KEY_SENDFILE		145
2701da177e4SLinus Torvalds #define KEY_DELETEFILE		146
2711da177e4SLinus Torvalds #define KEY_XFER		147
2721da177e4SLinus Torvalds #define KEY_PROG1		148
2731da177e4SLinus Torvalds #define KEY_PROG2		149
2744e4eda86SDmitry Torokhov #define KEY_WWW			150	/* AL Internet Browser */
2751da177e4SLinus Torvalds #define KEY_MSDOS		151
2764e4eda86SDmitry Torokhov #define KEY_COFFEE		152	/* AL Terminal Lock/Screensaver */
2774e4eda86SDmitry Torokhov #define KEY_SCREENLOCK		KEY_COFFEE
2781da177e4SLinus Torvalds #define KEY_DIRECTION		153
2791da177e4SLinus Torvalds #define KEY_CYCLEWINDOWS	154
2801da177e4SLinus Torvalds #define KEY_MAIL		155
2814e4eda86SDmitry Torokhov #define KEY_BOOKMARKS		156	/* AC Bookmarks */
2821da177e4SLinus Torvalds #define KEY_COMPUTER		157
2834e4eda86SDmitry Torokhov #define KEY_BACK		158	/* AC Back */
2844e4eda86SDmitry Torokhov #define KEY_FORWARD		159	/* AC Forward */
2851da177e4SLinus Torvalds #define KEY_CLOSECD		160
2861da177e4SLinus Torvalds #define KEY_EJECTCD		161
2871da177e4SLinus Torvalds #define KEY_EJECTCLOSECD	162
2881da177e4SLinus Torvalds #define KEY_NEXTSONG		163
2891da177e4SLinus Torvalds #define KEY_PLAYPAUSE		164
2901da177e4SLinus Torvalds #define KEY_PREVIOUSSONG	165
2911da177e4SLinus Torvalds #define KEY_STOPCD		166
2921da177e4SLinus Torvalds #define KEY_RECORD		167
2931da177e4SLinus Torvalds #define KEY_REWIND		168
2944e4eda86SDmitry Torokhov #define KEY_PHONE		169	/* Media Select Telephone */
2951da177e4SLinus Torvalds #define KEY_ISO			170
2964e4eda86SDmitry Torokhov #define KEY_CONFIG		171	/* AL Consumer Control Configuration */
2974e4eda86SDmitry Torokhov #define KEY_HOMEPAGE		172	/* AC Home */
2984e4eda86SDmitry Torokhov #define KEY_REFRESH		173	/* AC Refresh */
2994e4eda86SDmitry Torokhov #define KEY_EXIT		174	/* AC Exit */
3001da177e4SLinus Torvalds #define KEY_MOVE		175
3011da177e4SLinus Torvalds #define KEY_EDIT		176
3021da177e4SLinus Torvalds #define KEY_SCROLLUP		177
3031da177e4SLinus Torvalds #define KEY_SCROLLDOWN		178
3041da177e4SLinus Torvalds #define KEY_KPLEFTPAREN		179
3051da177e4SLinus Torvalds #define KEY_KPRIGHTPAREN	180
3064e4eda86SDmitry Torokhov #define KEY_NEW			181	/* AC New */
3074e4eda86SDmitry Torokhov #define KEY_REDO		182	/* AC Redo/Repeat */
3081da177e4SLinus Torvalds 
3091da177e4SLinus Torvalds #define KEY_F13			183
3101da177e4SLinus Torvalds #define KEY_F14			184
3111da177e4SLinus Torvalds #define KEY_F15			185
3121da177e4SLinus Torvalds #define KEY_F16			186
3131da177e4SLinus Torvalds #define KEY_F17			187
3141da177e4SLinus Torvalds #define KEY_F18			188
3151da177e4SLinus Torvalds #define KEY_F19			189
3161da177e4SLinus Torvalds #define KEY_F20			190
3171da177e4SLinus Torvalds #define KEY_F21			191
3181da177e4SLinus Torvalds #define KEY_F22			192
3191da177e4SLinus Torvalds #define KEY_F23			193
3201da177e4SLinus Torvalds #define KEY_F24			194
3211da177e4SLinus Torvalds 
3221da177e4SLinus Torvalds #define KEY_PLAYCD		200
3231da177e4SLinus Torvalds #define KEY_PAUSECD		201
3241da177e4SLinus Torvalds #define KEY_PROG3		202
3251da177e4SLinus Torvalds #define KEY_PROG4		203
326437184aeSHenrik Rydberg #define KEY_DASHBOARD		204	/* AL Dashboard */
3271da177e4SLinus Torvalds #define KEY_SUSPEND		205
3284e4eda86SDmitry Torokhov #define KEY_CLOSE		206	/* AC Close */
3291da177e4SLinus Torvalds #define KEY_PLAY		207
3301da177e4SLinus Torvalds #define KEY_FASTFORWARD		208
3311da177e4SLinus Torvalds #define KEY_BASSBOOST		209
3324e4eda86SDmitry Torokhov #define KEY_PRINT		210	/* AC Print */
3331da177e4SLinus Torvalds #define KEY_HP			211
3341da177e4SLinus Torvalds #define KEY_CAMERA		212
3351da177e4SLinus Torvalds #define KEY_SOUND		213
3361da177e4SLinus Torvalds #define KEY_QUESTION		214
3371da177e4SLinus Torvalds #define KEY_EMAIL		215
3381da177e4SLinus Torvalds #define KEY_CHAT		216
3391da177e4SLinus Torvalds #define KEY_SEARCH		217
3401da177e4SLinus Torvalds #define KEY_CONNECT		218
3414e4eda86SDmitry Torokhov #define KEY_FINANCE		219	/* AL Checkbook/Finance */
3421da177e4SLinus Torvalds #define KEY_SPORT		220
3431da177e4SLinus Torvalds #define KEY_SHOP		221
3441da177e4SLinus Torvalds #define KEY_ALTERASE		222
3454e4eda86SDmitry Torokhov #define KEY_CANCEL		223	/* AC Cancel */
3461da177e4SLinus Torvalds #define KEY_BRIGHTNESSDOWN	224
3471da177e4SLinus Torvalds #define KEY_BRIGHTNESSUP	225
3481da177e4SLinus Torvalds #define KEY_MEDIA		226
3491da177e4SLinus Torvalds 
35055178537SDmitry Torokhov #define KEY_SWITCHVIDEOMODE	227	/* Cycle between available video
35155178537SDmitry Torokhov 					   outputs (Monitor/LCD/TV-out/etc) */
352146a4b3bSAndreas Jaggi #define KEY_KBDILLUMTOGGLE	228
353146a4b3bSAndreas Jaggi #define KEY_KBDILLUMDOWN	229
354146a4b3bSAndreas Jaggi #define KEY_KBDILLUMUP		230
355146a4b3bSAndreas Jaggi 
3564e4eda86SDmitry Torokhov #define KEY_SEND		231	/* AC Send */
3574e4eda86SDmitry Torokhov #define KEY_REPLY		232	/* AC Reply */
3584e4eda86SDmitry Torokhov #define KEY_FORWARDMAIL		233	/* AC Forward Msg */
3594e4eda86SDmitry Torokhov #define KEY_SAVE		234	/* AC Save */
3608a409b01SVojtech Pavlik #define KEY_DOCUMENTS		235
3618a409b01SVojtech Pavlik 
362f39b25beSMatthew Garrett #define KEY_BATTERY		236
363f39b25beSMatthew Garrett 
36490da1151SLennart Poettering #define KEY_BLUETOOTH		237
36590da1151SLennart Poettering #define KEY_WLAN		238
366e0665486SIvo van Doorn #define KEY_UWB			239
36790da1151SLennart Poettering 
3681da177e4SLinus Torvalds #define KEY_UNKNOWN		240
3691da177e4SLinus Torvalds 
370a7ecd1eaSYu Luming #define KEY_VIDEO_NEXT		241	/* drive next video source */
371a7ecd1eaSYu Luming #define KEY_VIDEO_PREV		242	/* drive previous video source */
372a7ecd1eaSYu Luming #define KEY_BRIGHTNESS_CYCLE	243	/* brightness up, after max is min */
373a7ecd1eaSYu Luming #define KEY_BRIGHTNESS_ZERO	244	/* brightness off, use ambient */
374a7ecd1eaSYu Luming #define KEY_DISPLAY_OFF		245	/* display device to off state */
375a7ecd1eaSYu Luming 
376303d9bf6SIñaky Pérez-González #define KEY_WIMAX		246
377303d9bf6SIñaky Pérez-González 
378f6d65610SDmitry Torokhov /* Range 248 - 255 is reserved for special needs of AT keyboard driver */
379f6d65610SDmitry Torokhov 
3801da177e4SLinus Torvalds #define BTN_MISC		0x100
3811da177e4SLinus Torvalds #define BTN_0			0x100
3821da177e4SLinus Torvalds #define BTN_1			0x101
3831da177e4SLinus Torvalds #define BTN_2			0x102
3841da177e4SLinus Torvalds #define BTN_3			0x103
3851da177e4SLinus Torvalds #define BTN_4			0x104
3861da177e4SLinus Torvalds #define BTN_5			0x105
3871da177e4SLinus Torvalds #define BTN_6			0x106
3881da177e4SLinus Torvalds #define BTN_7			0x107
3891da177e4SLinus Torvalds #define BTN_8			0x108
3901da177e4SLinus Torvalds #define BTN_9			0x109
3911da177e4SLinus Torvalds 
3921da177e4SLinus Torvalds #define BTN_MOUSE		0x110
3931da177e4SLinus Torvalds #define BTN_LEFT		0x110
3941da177e4SLinus Torvalds #define BTN_RIGHT		0x111
3951da177e4SLinus Torvalds #define BTN_MIDDLE		0x112
3961da177e4SLinus Torvalds #define BTN_SIDE		0x113
3971da177e4SLinus Torvalds #define BTN_EXTRA		0x114
3981da177e4SLinus Torvalds #define BTN_FORWARD		0x115
3991da177e4SLinus Torvalds #define BTN_BACK		0x116
4001da177e4SLinus Torvalds #define BTN_TASK		0x117
4011da177e4SLinus Torvalds 
4021da177e4SLinus Torvalds #define BTN_JOYSTICK		0x120
4031da177e4SLinus Torvalds #define BTN_TRIGGER		0x120
4041da177e4SLinus Torvalds #define BTN_THUMB		0x121
4051da177e4SLinus Torvalds #define BTN_THUMB2		0x122
4061da177e4SLinus Torvalds #define BTN_TOP			0x123
4071da177e4SLinus Torvalds #define BTN_TOP2		0x124
4081da177e4SLinus Torvalds #define BTN_PINKIE		0x125
4091da177e4SLinus Torvalds #define BTN_BASE		0x126
4101da177e4SLinus Torvalds #define BTN_BASE2		0x127
4111da177e4SLinus Torvalds #define BTN_BASE3		0x128
4121da177e4SLinus Torvalds #define BTN_BASE4		0x129
4131da177e4SLinus Torvalds #define BTN_BASE5		0x12a
4141da177e4SLinus Torvalds #define BTN_BASE6		0x12b
4151da177e4SLinus Torvalds #define BTN_DEAD		0x12f
4161da177e4SLinus Torvalds 
4171da177e4SLinus Torvalds #define BTN_GAMEPAD		0x130
4181da177e4SLinus Torvalds #define BTN_A			0x130
4191da177e4SLinus Torvalds #define BTN_B			0x131
4201da177e4SLinus Torvalds #define BTN_C			0x132
4211da177e4SLinus Torvalds #define BTN_X			0x133
4221da177e4SLinus Torvalds #define BTN_Y			0x134
4231da177e4SLinus Torvalds #define BTN_Z			0x135
4241da177e4SLinus Torvalds #define BTN_TL			0x136
4251da177e4SLinus Torvalds #define BTN_TR			0x137
4261da177e4SLinus Torvalds #define BTN_TL2			0x138
4271da177e4SLinus Torvalds #define BTN_TR2			0x139
4281da177e4SLinus Torvalds #define BTN_SELECT		0x13a
4291da177e4SLinus Torvalds #define BTN_START		0x13b
4301da177e4SLinus Torvalds #define BTN_MODE		0x13c
4311da177e4SLinus Torvalds #define BTN_THUMBL		0x13d
4321da177e4SLinus Torvalds #define BTN_THUMBR		0x13e
4331da177e4SLinus Torvalds 
4341da177e4SLinus Torvalds #define BTN_DIGI		0x140
4351da177e4SLinus Torvalds #define BTN_TOOL_PEN		0x140
4361da177e4SLinus Torvalds #define BTN_TOOL_RUBBER		0x141
4371da177e4SLinus Torvalds #define BTN_TOOL_BRUSH		0x142
4381da177e4SLinus Torvalds #define BTN_TOOL_PENCIL		0x143
4391da177e4SLinus Torvalds #define BTN_TOOL_AIRBRUSH	0x144
4401da177e4SLinus Torvalds #define BTN_TOOL_FINGER		0x145
4411da177e4SLinus Torvalds #define BTN_TOOL_MOUSE		0x146
4421da177e4SLinus Torvalds #define BTN_TOOL_LENS		0x147
4431da177e4SLinus Torvalds #define BTN_TOUCH		0x14a
4441da177e4SLinus Torvalds #define BTN_STYLUS		0x14b
4451da177e4SLinus Torvalds #define BTN_STYLUS2		0x14c
4461da177e4SLinus Torvalds #define BTN_TOOL_DOUBLETAP	0x14d
4471da177e4SLinus Torvalds #define BTN_TOOL_TRIPLETAP	0x14e
448*6916d97fSHenrik Rydberg #define BTN_TOOL_QUADTAP	0x14f	/* Four fingers on trackpad */
4491da177e4SLinus Torvalds 
4501da177e4SLinus Torvalds #define BTN_WHEEL		0x150
4511da177e4SLinus Torvalds #define BTN_GEAR_DOWN		0x150
4521da177e4SLinus Torvalds #define BTN_GEAR_UP		0x151
4531da177e4SLinus Torvalds 
4541da177e4SLinus Torvalds #define KEY_OK			0x160
4551da177e4SLinus Torvalds #define KEY_SELECT		0x161
4561da177e4SLinus Torvalds #define KEY_GOTO		0x162
4571da177e4SLinus Torvalds #define KEY_CLEAR		0x163
4581da177e4SLinus Torvalds #define KEY_POWER2		0x164
4591da177e4SLinus Torvalds #define KEY_OPTION		0x165
4604e4eda86SDmitry Torokhov #define KEY_INFO		0x166	/* AL OEM Features/Tips/Tutorial */
4611da177e4SLinus Torvalds #define KEY_TIME		0x167
4621da177e4SLinus Torvalds #define KEY_VENDOR		0x168
4631da177e4SLinus Torvalds #define KEY_ARCHIVE		0x169
4644e4eda86SDmitry Torokhov #define KEY_PROGRAM		0x16a	/* Media Select Program Guide */
4651da177e4SLinus Torvalds #define KEY_CHANNEL		0x16b
4661da177e4SLinus Torvalds #define KEY_FAVORITES		0x16c
4671da177e4SLinus Torvalds #define KEY_EPG			0x16d
4684e4eda86SDmitry Torokhov #define KEY_PVR			0x16e	/* Media Select Home */
4691da177e4SLinus Torvalds #define KEY_MHP			0x16f
4701da177e4SLinus Torvalds #define KEY_LANGUAGE		0x170
4711da177e4SLinus Torvalds #define KEY_TITLE		0x171
4721da177e4SLinus Torvalds #define KEY_SUBTITLE		0x172
4731da177e4SLinus Torvalds #define KEY_ANGLE		0x173
4741da177e4SLinus Torvalds #define KEY_ZOOM		0x174
4751da177e4SLinus Torvalds #define KEY_MODE		0x175
4761da177e4SLinus Torvalds #define KEY_KEYBOARD		0x176
4771da177e4SLinus Torvalds #define KEY_SCREEN		0x177
4784e4eda86SDmitry Torokhov #define KEY_PC			0x178	/* Media Select Computer */
4794e4eda86SDmitry Torokhov #define KEY_TV			0x179	/* Media Select TV */
4804e4eda86SDmitry Torokhov #define KEY_TV2			0x17a	/* Media Select Cable */
4814e4eda86SDmitry Torokhov #define KEY_VCR			0x17b	/* Media Select VCR */
4824e4eda86SDmitry Torokhov #define KEY_VCR2		0x17c	/* VCR Plus */
4834e4eda86SDmitry Torokhov #define KEY_SAT			0x17d	/* Media Select Satellite */
4841da177e4SLinus Torvalds #define KEY_SAT2		0x17e
4854e4eda86SDmitry Torokhov #define KEY_CD			0x17f	/* Media Select CD */
4864e4eda86SDmitry Torokhov #define KEY_TAPE		0x180	/* Media Select Tape */
4871da177e4SLinus Torvalds #define KEY_RADIO		0x181
4884e4eda86SDmitry Torokhov #define KEY_TUNER		0x182	/* Media Select Tuner */
4891da177e4SLinus Torvalds #define KEY_PLAYER		0x183
4901da177e4SLinus Torvalds #define KEY_TEXT		0x184
4914e4eda86SDmitry Torokhov #define KEY_DVD			0x185	/* Media Select DVD */
4921da177e4SLinus Torvalds #define KEY_AUX			0x186
4931da177e4SLinus Torvalds #define KEY_MP3			0x187
4941da177e4SLinus Torvalds #define KEY_AUDIO		0x188
4951da177e4SLinus Torvalds #define KEY_VIDEO		0x189
4961da177e4SLinus Torvalds #define KEY_DIRECTORY		0x18a
4971da177e4SLinus Torvalds #define KEY_LIST		0x18b
4984e4eda86SDmitry Torokhov #define KEY_MEMO		0x18c	/* Media Select Messages */
4991da177e4SLinus Torvalds #define KEY_CALENDAR		0x18d
5001da177e4SLinus Torvalds #define KEY_RED			0x18e
5011da177e4SLinus Torvalds #define KEY_GREEN		0x18f
5021da177e4SLinus Torvalds #define KEY_YELLOW		0x190
5031da177e4SLinus Torvalds #define KEY_BLUE		0x191
5044e4eda86SDmitry Torokhov #define KEY_CHANNELUP		0x192	/* Channel Increment */
5054e4eda86SDmitry Torokhov #define KEY_CHANNELDOWN		0x193	/* Channel Decrement */
5061da177e4SLinus Torvalds #define KEY_FIRST		0x194
5074e4eda86SDmitry Torokhov #define KEY_LAST		0x195	/* Recall Last */
5081da177e4SLinus Torvalds #define KEY_AB			0x196
5091da177e4SLinus Torvalds #define KEY_NEXT		0x197
5101da177e4SLinus Torvalds #define KEY_RESTART		0x198
5111da177e4SLinus Torvalds #define KEY_SLOW		0x199
5121da177e4SLinus Torvalds #define KEY_SHUFFLE		0x19a
5131da177e4SLinus Torvalds #define KEY_BREAK		0x19b
5141da177e4SLinus Torvalds #define KEY_PREVIOUS		0x19c
5151da177e4SLinus Torvalds #define KEY_DIGITS		0x19d
5161da177e4SLinus Torvalds #define KEY_TEEN		0x19e
5171da177e4SLinus Torvalds #define KEY_TWEN		0x19f
5184e4eda86SDmitry Torokhov #define KEY_VIDEOPHONE		0x1a0	/* Media Select Video Phone */
5194e4eda86SDmitry Torokhov #define KEY_GAMES		0x1a1	/* Media Select Games */
5204e4eda86SDmitry Torokhov #define KEY_ZOOMIN		0x1a2	/* AC Zoom In */
5214e4eda86SDmitry Torokhov #define KEY_ZOOMOUT		0x1a3	/* AC Zoom Out */
5224e4eda86SDmitry Torokhov #define KEY_ZOOMRESET		0x1a4	/* AC Zoom */
5234e4eda86SDmitry Torokhov #define KEY_WORDPROCESSOR	0x1a5	/* AL Word Processor */
5244e4eda86SDmitry Torokhov #define KEY_EDITOR		0x1a6	/* AL Text Editor */
5254e4eda86SDmitry Torokhov #define KEY_SPREADSHEET		0x1a7	/* AL Spreadsheet */
5264e4eda86SDmitry Torokhov #define KEY_GRAPHICSEDITOR	0x1a8	/* AL Graphics Editor */
5274e4eda86SDmitry Torokhov #define KEY_PRESENTATION	0x1a9	/* AL Presentation App */
5284e4eda86SDmitry Torokhov #define KEY_DATABASE		0x1aa	/* AL Database App */
5294e4eda86SDmitry Torokhov #define KEY_NEWS		0x1ab	/* AL Newsreader */
5304e4eda86SDmitry Torokhov #define KEY_VOICEMAIL		0x1ac	/* AL Voicemail */
5314e4eda86SDmitry Torokhov #define KEY_ADDRESSBOOK		0x1ad	/* AL Contacts/Address Book */
5324e4eda86SDmitry Torokhov #define KEY_MESSENGER		0x1ae	/* AL Instant Messaging */
5336480e2a2SEric Piel #define KEY_DISPLAYTOGGLE	0x1af	/* Turn display (LCD) on and off */
5344dc21a80SJiri Kosina #define KEY_SPELLCHECK		0x1b0   /* AL Spell Check */
535e2bca074SKhelben Blackstaff #define KEY_LOGOFF		0x1b1   /* AL Logoff */
5361da177e4SLinus Torvalds 
537f7852be6SCarlos Corbacho #define KEY_DOLLAR		0x1b2
538f7852be6SCarlos Corbacho #define KEY_EURO		0x1b3
539f7852be6SCarlos Corbacho 
540c23f1f9cSAristeu Rozanski #define KEY_FRAMEBACK		0x1b4	/* Consumer - transport controls */
541c23f1f9cSAristeu Rozanski #define KEY_FRAMEFORWARD	0x1b5
54235baef2aSAristeu Rozanski #define KEY_CONTEXT_MENU	0x1b6	/* GenDesc - system context menu */
5434bbff7e4SBastien Nocera #define KEY_MEDIA_REPEAT	0x1b7	/* Consumer - transport control */
54435baef2aSAristeu Rozanski 
5451da177e4SLinus Torvalds #define KEY_DEL_EOL		0x1c0
5461da177e4SLinus Torvalds #define KEY_DEL_EOS		0x1c1
5471da177e4SLinus Torvalds #define KEY_INS_LINE		0x1c2
5481da177e4SLinus Torvalds #define KEY_DEL_LINE		0x1c3
5491da177e4SLinus Torvalds 
5501da177e4SLinus Torvalds #define KEY_FN			0x1d0
5511da177e4SLinus Torvalds #define KEY_FN_ESC		0x1d1
5521da177e4SLinus Torvalds #define KEY_FN_F1		0x1d2
5531da177e4SLinus Torvalds #define KEY_FN_F2		0x1d3
5541da177e4SLinus Torvalds #define KEY_FN_F3		0x1d4
5551da177e4SLinus Torvalds #define KEY_FN_F4		0x1d5
5561da177e4SLinus Torvalds #define KEY_FN_F5		0x1d6
5571da177e4SLinus Torvalds #define KEY_FN_F6		0x1d7
5581da177e4SLinus Torvalds #define KEY_FN_F7		0x1d8
5591da177e4SLinus Torvalds #define KEY_FN_F8		0x1d9
5601da177e4SLinus Torvalds #define KEY_FN_F9		0x1da
5611da177e4SLinus Torvalds #define KEY_FN_F10		0x1db
5621da177e4SLinus Torvalds #define KEY_FN_F11		0x1dc
5631da177e4SLinus Torvalds #define KEY_FN_F12		0x1dd
5641da177e4SLinus Torvalds #define KEY_FN_1		0x1de
5651da177e4SLinus Torvalds #define KEY_FN_2		0x1df
5661da177e4SLinus Torvalds #define KEY_FN_D		0x1e0
5671da177e4SLinus Torvalds #define KEY_FN_E		0x1e1
5681da177e4SLinus Torvalds #define KEY_FN_F		0x1e2
5691da177e4SLinus Torvalds #define KEY_FN_S		0x1e3
5701da177e4SLinus Torvalds #define KEY_FN_B		0x1e4
5711da177e4SLinus Torvalds 
572b9ec4e10SSamuel Thibault #define KEY_BRL_DOT1		0x1f1
573b9ec4e10SSamuel Thibault #define KEY_BRL_DOT2		0x1f2
574b9ec4e10SSamuel Thibault #define KEY_BRL_DOT3		0x1f3
575b9ec4e10SSamuel Thibault #define KEY_BRL_DOT4		0x1f4
576b9ec4e10SSamuel Thibault #define KEY_BRL_DOT5		0x1f5
577b9ec4e10SSamuel Thibault #define KEY_BRL_DOT6		0x1f6
578b9ec4e10SSamuel Thibault #define KEY_BRL_DOT7		0x1f7
579b9ec4e10SSamuel Thibault #define KEY_BRL_DOT8		0x1f8
5809e3d3d07SSamuel Thibault #define KEY_BRL_DOT9		0x1f9
5819e3d3d07SSamuel Thibault #define KEY_BRL_DOT10		0x1fa
582b9ec4e10SSamuel Thibault 
5835a599a15SAristeu Rozanski #define KEY_NUMERIC_0		0x200	/* used by phones, remote controls, */
5845a599a15SAristeu Rozanski #define KEY_NUMERIC_1		0x201	/* and other keypads */
5855a599a15SAristeu Rozanski #define KEY_NUMERIC_2		0x202
5865a599a15SAristeu Rozanski #define KEY_NUMERIC_3		0x203
5875a599a15SAristeu Rozanski #define KEY_NUMERIC_4		0x204
5885a599a15SAristeu Rozanski #define KEY_NUMERIC_5		0x205
5895a599a15SAristeu Rozanski #define KEY_NUMERIC_6		0x206
5905a599a15SAristeu Rozanski #define KEY_NUMERIC_7		0x207
5915a599a15SAristeu Rozanski #define KEY_NUMERIC_8		0x208
5925a599a15SAristeu Rozanski #define KEY_NUMERIC_9		0x209
5935a599a15SAristeu Rozanski #define KEY_NUMERIC_STAR	0x20a
5945a599a15SAristeu Rozanski #define KEY_NUMERIC_POUND	0x20b
5955a599a15SAristeu Rozanski 
5961d8f430cSRusty Russell /* We avoid low common keys in module aliases so they don't get huge. */
5971d8f430cSRusty Russell #define KEY_MIN_INTERESTING	KEY_MUTE
59803bac96fSDmitry Torokhov #define KEY_MAX			0x2ff
5997b19ada2SJiri Slaby #define KEY_CNT			(KEY_MAX+1)
6001da177e4SLinus Torvalds 
6011da177e4SLinus Torvalds /*
6021da177e4SLinus Torvalds  * Relative axes
6031da177e4SLinus Torvalds  */
6041da177e4SLinus Torvalds 
6051da177e4SLinus Torvalds #define REL_X			0x00
6061da177e4SLinus Torvalds #define REL_Y			0x01
6071da177e4SLinus Torvalds #define REL_Z			0x02
6081da177e4SLinus Torvalds #define REL_RX			0x03
6091da177e4SLinus Torvalds #define REL_RY			0x04
6101da177e4SLinus Torvalds #define REL_RZ			0x05
6111da177e4SLinus Torvalds #define REL_HWHEEL		0x06
6121da177e4SLinus Torvalds #define REL_DIAL		0x07
6131da177e4SLinus Torvalds #define REL_WHEEL		0x08
6141da177e4SLinus Torvalds #define REL_MISC		0x09
6151da177e4SLinus Torvalds #define REL_MAX			0x0f
6167b19ada2SJiri Slaby #define REL_CNT			(REL_MAX+1)
6171da177e4SLinus Torvalds 
6181da177e4SLinus Torvalds /*
6191da177e4SLinus Torvalds  * Absolute axes
6201da177e4SLinus Torvalds  */
6211da177e4SLinus Torvalds 
6221da177e4SLinus Torvalds #define ABS_X			0x00
6231da177e4SLinus Torvalds #define ABS_Y			0x01
6241da177e4SLinus Torvalds #define ABS_Z			0x02
6251da177e4SLinus Torvalds #define ABS_RX			0x03
6261da177e4SLinus Torvalds #define ABS_RY			0x04
6271da177e4SLinus Torvalds #define ABS_RZ			0x05
6281da177e4SLinus Torvalds #define ABS_THROTTLE		0x06
6291da177e4SLinus Torvalds #define ABS_RUDDER		0x07
6301da177e4SLinus Torvalds #define ABS_WHEEL		0x08
6311da177e4SLinus Torvalds #define ABS_GAS			0x09
6321da177e4SLinus Torvalds #define ABS_BRAKE		0x0a
6331da177e4SLinus Torvalds #define ABS_HAT0X		0x10
6341da177e4SLinus Torvalds #define ABS_HAT0Y		0x11
6351da177e4SLinus Torvalds #define ABS_HAT1X		0x12
6361da177e4SLinus Torvalds #define ABS_HAT1Y		0x13
6371da177e4SLinus Torvalds #define ABS_HAT2X		0x14
6381da177e4SLinus Torvalds #define ABS_HAT2Y		0x15
6391da177e4SLinus Torvalds #define ABS_HAT3X		0x16
6401da177e4SLinus Torvalds #define ABS_HAT3Y		0x17
6411da177e4SLinus Torvalds #define ABS_PRESSURE		0x18
6421da177e4SLinus Torvalds #define ABS_DISTANCE		0x19
6431da177e4SLinus Torvalds #define ABS_TILT_X		0x1a
6441da177e4SLinus Torvalds #define ABS_TILT_Y		0x1b
6451da177e4SLinus Torvalds #define ABS_TOOL_WIDTH		0x1c
6461da177e4SLinus Torvalds #define ABS_VOLUME		0x20
6471da177e4SLinus Torvalds #define ABS_MISC		0x28
6481da177e4SLinus Torvalds #define ABS_MAX			0x3f
6497b19ada2SJiri Slaby #define ABS_CNT			(ABS_MAX+1)
6501da177e4SLinus Torvalds 
6511da177e4SLinus Torvalds /*
65231581066SRichard Purdie  * Switch events
65331581066SRichard Purdie  */
65431581066SRichard Purdie 
655ed8f9e2fSRichard Purdie #define SW_LID			0x00  /* set = lid shut */
656ed8f9e2fSRichard Purdie #define SW_TABLET_MODE		0x01  /* set = tablet mode */
657ed8f9e2fSRichard Purdie #define SW_HEADPHONE_INSERT	0x02  /* set = inserted */
6585adad013SHenrique de Moraes Holschuh #define SW_RFKILL_ALL		0x03  /* rfkill master switch, type "any"
6595adad013SHenrique de Moraes Holschuh 					 set = radio enabled */
6605adad013SHenrique de Moraes Holschuh #define SW_RADIO		SW_RFKILL_ALL	/* deprecated */
6615ec461d0SMark Brown #define SW_MICROPHONE_INSERT	0x04  /* set = inserted */
66292c49890SMatthew Garrett #define SW_DOCK			0x05  /* set = plugged into dock */
663a53ccab3SMatthew Ranostay #define SW_LINEOUT_INSERT	0x06  /* set = inserted */
664cdc69364SMark Brown #define SW_JACK_PHYSICAL_INSERT 0x07  /* set = mechanical switch set */
665d506fc32SJani Nikula #define SW_VIDEOOUT_INSERT	0x08  /* set = inserted */
66631581066SRichard Purdie #define SW_MAX			0x0f
6677b19ada2SJiri Slaby #define SW_CNT			(SW_MAX+1)
66831581066SRichard Purdie 
66931581066SRichard Purdie /*
6701da177e4SLinus Torvalds  * Misc events
6711da177e4SLinus Torvalds  */
6721da177e4SLinus Torvalds 
6731da177e4SLinus Torvalds #define MSC_SERIAL		0x00
6741da177e4SLinus Torvalds #define MSC_PULSELED		0x01
6751da177e4SLinus Torvalds #define MSC_GESTURE		0x02
6761da177e4SLinus Torvalds #define MSC_RAW			0x03
6771da177e4SLinus Torvalds #define MSC_SCAN		0x04
6781da177e4SLinus Torvalds #define MSC_MAX			0x07
6797b19ada2SJiri Slaby #define MSC_CNT			(MSC_MAX+1)
6801da177e4SLinus Torvalds 
6811da177e4SLinus Torvalds /*
6821da177e4SLinus Torvalds  * LEDs
6831da177e4SLinus Torvalds  */
6841da177e4SLinus Torvalds 
6851da177e4SLinus Torvalds #define LED_NUML		0x00
6861da177e4SLinus Torvalds #define LED_CAPSL		0x01
6871da177e4SLinus Torvalds #define LED_SCROLLL		0x02
6881da177e4SLinus Torvalds #define LED_COMPOSE		0x03
6891da177e4SLinus Torvalds #define LED_KANA		0x04
6901da177e4SLinus Torvalds #define LED_SLEEP		0x05
6911da177e4SLinus Torvalds #define LED_SUSPEND		0x06
6921da177e4SLinus Torvalds #define LED_MUTE		0x07
6931da177e4SLinus Torvalds #define LED_MISC		0x08
6941da177e4SLinus Torvalds #define LED_MAIL		0x09
6951da177e4SLinus Torvalds #define LED_CHARGING		0x0a
6961da177e4SLinus Torvalds #define LED_MAX			0x0f
6977b19ada2SJiri Slaby #define LED_CNT			(LED_MAX+1)
6981da177e4SLinus Torvalds 
6991da177e4SLinus Torvalds /*
7001da177e4SLinus Torvalds  * Autorepeat values
7011da177e4SLinus Torvalds  */
7021da177e4SLinus Torvalds 
7031da177e4SLinus Torvalds #define REP_DELAY		0x00
7041da177e4SLinus Torvalds #define REP_PERIOD		0x01
7051da177e4SLinus Torvalds #define REP_MAX			0x01
7061da177e4SLinus Torvalds 
7071da177e4SLinus Torvalds /*
7081da177e4SLinus Torvalds  * Sounds
7091da177e4SLinus Torvalds  */
7101da177e4SLinus Torvalds 
7111da177e4SLinus Torvalds #define SND_CLICK		0x00
7121da177e4SLinus Torvalds #define SND_BELL		0x01
7131da177e4SLinus Torvalds #define SND_TONE		0x02
7141da177e4SLinus Torvalds #define SND_MAX			0x07
7157b19ada2SJiri Slaby #define SND_CNT			(SND_MAX+1)
7161da177e4SLinus Torvalds 
7171da177e4SLinus Torvalds /*
7181da177e4SLinus Torvalds  * IDs.
7191da177e4SLinus Torvalds  */
7201da177e4SLinus Torvalds 
7211da177e4SLinus Torvalds #define ID_BUS			0
7221da177e4SLinus Torvalds #define ID_VENDOR		1
7231da177e4SLinus Torvalds #define ID_PRODUCT		2
7241da177e4SLinus Torvalds #define ID_VERSION		3
7251da177e4SLinus Torvalds 
7261da177e4SLinus Torvalds #define BUS_PCI			0x01
7271da177e4SLinus Torvalds #define BUS_ISAPNP		0x02
7281da177e4SLinus Torvalds #define BUS_USB			0x03
7291da177e4SLinus Torvalds #define BUS_HIL			0x04
7301da177e4SLinus Torvalds #define BUS_BLUETOOTH		0x05
7319a87fddeSMichael Hanselmann #define BUS_VIRTUAL		0x06
7321da177e4SLinus Torvalds 
7331da177e4SLinus Torvalds #define BUS_ISA			0x10
7341da177e4SLinus Torvalds #define BUS_I8042		0x11
7351da177e4SLinus Torvalds #define BUS_XTKBD		0x12
7361da177e4SLinus Torvalds #define BUS_RS232		0x13
7371da177e4SLinus Torvalds #define BUS_GAMEPORT		0x14
7381da177e4SLinus Torvalds #define BUS_PARPORT		0x15
7391da177e4SLinus Torvalds #define BUS_AMIGA		0x16
7401da177e4SLinus Torvalds #define BUS_ADB			0x17
7411da177e4SLinus Torvalds #define BUS_I2C			0x18
7421da177e4SLinus Torvalds #define BUS_HOST		0x19
7436ab0f5cdSMatthew Wilcox #define BUS_GSC			0x1A
744c04cb856SMichael Schmitz #define BUS_ATARI		0x1B
7451da177e4SLinus Torvalds 
7461da177e4SLinus Torvalds /*
747e4477d2dSRandy Dunlap  * Values describing the status of a force-feedback effect
7481da177e4SLinus Torvalds  */
7491da177e4SLinus Torvalds #define FF_STATUS_STOPPED	0x00
7501da177e4SLinus Torvalds #define FF_STATUS_PLAYING	0x01
7511da177e4SLinus Torvalds #define FF_STATUS_MAX		0x01
7521da177e4SLinus Torvalds 
7531da177e4SLinus Torvalds /*
7541da177e4SLinus Torvalds  * Structures used in ioctls to upload effects to a device
7558b8277a1SAnssi Hannula  * They are pieces of a bigger structure (called ff_effect)
7561da177e4SLinus Torvalds  */
7571da177e4SLinus Torvalds 
7588b8277a1SAnssi Hannula /*
7598b8277a1SAnssi Hannula  * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
7608b8277a1SAnssi Hannula  * should not be used and have unspecified results.
7618b8277a1SAnssi Hannula  */
7628b8277a1SAnssi Hannula 
7638b8277a1SAnssi Hannula /**
764e4477d2dSRandy Dunlap  * struct ff_replay - defines scheduling of the force-feedback effect
7658b8277a1SAnssi Hannula  * @length: duration of the effect
7668b8277a1SAnssi Hannula  * @delay: delay before effect should start playing
7678b8277a1SAnssi Hannula  */
7681da177e4SLinus Torvalds struct ff_replay {
7698b8277a1SAnssi Hannula 	__u16 length;
7708b8277a1SAnssi Hannula 	__u16 delay;
7711da177e4SLinus Torvalds };
7721da177e4SLinus Torvalds 
7738b8277a1SAnssi Hannula /**
774e4477d2dSRandy Dunlap  * struct ff_trigger - defines what triggers the force-feedback effect
7758b8277a1SAnssi Hannula  * @button: number of the button triggering the effect
7768b8277a1SAnssi Hannula  * @interval: controls how soon the effect can be re-triggered
7778b8277a1SAnssi Hannula  */
7781da177e4SLinus Torvalds struct ff_trigger {
7798b8277a1SAnssi Hannula 	__u16 button;
7808b8277a1SAnssi Hannula 	__u16 interval;
7811da177e4SLinus Torvalds };
7821da177e4SLinus Torvalds 
7838b8277a1SAnssi Hannula /**
784e4477d2dSRandy Dunlap  * struct ff_envelope - generic force-feedback effect envelope
7858b8277a1SAnssi Hannula  * @attack_length: duration of the attack (ms)
7868b8277a1SAnssi Hannula  * @attack_level: level at the beginning of the attack
7878b8277a1SAnssi Hannula  * @fade_length: duration of fade (ms)
7888b8277a1SAnssi Hannula  * @fade_level: level at the end of fade
7898b8277a1SAnssi Hannula  *
7908b8277a1SAnssi Hannula  * The @attack_level and @fade_level are absolute values; when applying
7918b8277a1SAnssi Hannula  * envelope force-feedback core will convert to positive/negative
7928b8277a1SAnssi Hannula  * value based on polarity of the default level of the effect.
7938b8277a1SAnssi Hannula  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
7948b8277a1SAnssi Hannula  */
7951da177e4SLinus Torvalds struct ff_envelope {
7968b8277a1SAnssi Hannula 	__u16 attack_length;
7978b8277a1SAnssi Hannula 	__u16 attack_level;
7988b8277a1SAnssi Hannula 	__u16 fade_length;
7998b8277a1SAnssi Hannula 	__u16 fade_level;
8001da177e4SLinus Torvalds };
8011da177e4SLinus Torvalds 
8028b8277a1SAnssi Hannula /**
803e4477d2dSRandy Dunlap  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
8048b8277a1SAnssi Hannula  * @level: strength of the effect; may be negative
8058b8277a1SAnssi Hannula  * @envelope: envelope data
8068b8277a1SAnssi Hannula  */
8071da177e4SLinus Torvalds struct ff_constant_effect {
8088b8277a1SAnssi Hannula 	__s16 level;
8091da177e4SLinus Torvalds 	struct ff_envelope envelope;
8101da177e4SLinus Torvalds };
8111da177e4SLinus Torvalds 
8128b8277a1SAnssi Hannula /**
813e4477d2dSRandy Dunlap  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
8148b8277a1SAnssi Hannula  * @start_level: beginning strength of the effect; may be negative
8158b8277a1SAnssi Hannula  * @end_level: final strength of the effect; may be negative
8168b8277a1SAnssi Hannula  * @envelope: envelope data
8178b8277a1SAnssi Hannula  */
8181da177e4SLinus Torvalds struct ff_ramp_effect {
8191da177e4SLinus Torvalds 	__s16 start_level;
8201da177e4SLinus Torvalds 	__s16 end_level;
8211da177e4SLinus Torvalds 	struct ff_envelope envelope;
8221da177e4SLinus Torvalds };
8231da177e4SLinus Torvalds 
8248b8277a1SAnssi Hannula /**
825e4477d2dSRandy Dunlap  * struct ff_condition_effect - defines a spring or friction force-feedback effect
8268b8277a1SAnssi Hannula  * @right_saturation: maximum level when joystick moved all way to the right
8278b8277a1SAnssi Hannula  * @left_saturation: same for the left side
8288b8277a1SAnssi Hannula  * @right_coeff: controls how fast the force grows when the joystick moves
8298b8277a1SAnssi Hannula  *	to the right
8308b8277a1SAnssi Hannula  * @left_coeff: same for the left side
8318b8277a1SAnssi Hannula  * @deadband: size of the dead zone, where no force is produced
8328b8277a1SAnssi Hannula  * @center: position of the dead zone
8338b8277a1SAnssi Hannula  */
8341da177e4SLinus Torvalds struct ff_condition_effect {
8358b8277a1SAnssi Hannula 	__u16 right_saturation;
8368b8277a1SAnssi Hannula 	__u16 left_saturation;
8371da177e4SLinus Torvalds 
8388b8277a1SAnssi Hannula 	__s16 right_coeff;
8398b8277a1SAnssi Hannula 	__s16 left_coeff;
8401da177e4SLinus Torvalds 
8418b8277a1SAnssi Hannula 	__u16 deadband;
8428b8277a1SAnssi Hannula 	__s16 center;
8431da177e4SLinus Torvalds };
8441da177e4SLinus Torvalds 
8458b8277a1SAnssi Hannula /**
846e4477d2dSRandy Dunlap  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
8478b8277a1SAnssi Hannula  * @waveform: kind of the effect (wave)
8488b8277a1SAnssi Hannula  * @period: period of the wave (ms)
8498b8277a1SAnssi Hannula  * @magnitude: peak value
8508b8277a1SAnssi Hannula  * @offset: mean value of the wave (roughly)
8518b8277a1SAnssi Hannula  * @phase: 'horizontal' shift
8528b8277a1SAnssi Hannula  * @envelope: envelope data
8538b8277a1SAnssi Hannula  * @custom_len: number of samples (FF_CUSTOM only)
8548b8277a1SAnssi Hannula  * @custom_data: buffer of samples (FF_CUSTOM only)
8558b8277a1SAnssi Hannula  *
8568b8277a1SAnssi Hannula  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
8578b8277a1SAnssi Hannula  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
8588b8277a1SAnssi Hannula  * for the time being as no driver supports it yet.
8598b8277a1SAnssi Hannula  *
8608b8277a1SAnssi Hannula  * Note: the data pointed by custom_data is copied by the driver.
8618b8277a1SAnssi Hannula  * You can therefore dispose of the memory after the upload/update.
8628b8277a1SAnssi Hannula  */
8631da177e4SLinus Torvalds struct ff_periodic_effect {
8648b8277a1SAnssi Hannula 	__u16 waveform;
8658b8277a1SAnssi Hannula 	__u16 period;
8668b8277a1SAnssi Hannula 	__s16 magnitude;
8678b8277a1SAnssi Hannula 	__s16 offset;
8688b8277a1SAnssi Hannula 	__u16 phase;
8691da177e4SLinus Torvalds 
8701da177e4SLinus Torvalds 	struct ff_envelope envelope;
8711da177e4SLinus Torvalds 
8728b8277a1SAnssi Hannula 	__u32 custom_len;
8738b8277a1SAnssi Hannula 	__s16 *custom_data;
8741da177e4SLinus Torvalds };
8751da177e4SLinus Torvalds 
8768b8277a1SAnssi Hannula /**
877e4477d2dSRandy Dunlap  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
8788b8277a1SAnssi Hannula  * @strong_magnitude: magnitude of the heavy motor
8798b8277a1SAnssi Hannula  * @weak_magnitude: magnitude of the light one
8808b8277a1SAnssi Hannula  *
8818b8277a1SAnssi Hannula  * Some rumble pads have two motors of different weight. Strong_magnitude
8828b8277a1SAnssi Hannula  * represents the magnitude of the vibration generated by the heavy one.
8831da177e4SLinus Torvalds  */
8841da177e4SLinus Torvalds struct ff_rumble_effect {
8858b8277a1SAnssi Hannula 	__u16 strong_magnitude;
8868b8277a1SAnssi Hannula 	__u16 weak_magnitude;
8871da177e4SLinus Torvalds };
8881da177e4SLinus Torvalds 
8898b8277a1SAnssi Hannula /**
8908b8277a1SAnssi Hannula  * struct ff_effect - defines force feedback effect
8918b8277a1SAnssi Hannula  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
8928b8277a1SAnssi Hannula  *	FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
8938b8277a1SAnssi Hannula  * @id: an unique id assigned to an effect
8948b8277a1SAnssi Hannula  * @direction: direction of the effect
8958b8277a1SAnssi Hannula  * @trigger: trigger conditions (struct ff_trigger)
8968b8277a1SAnssi Hannula  * @replay: scheduling of the effect (struct ff_replay)
8978b8277a1SAnssi Hannula  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
8988b8277a1SAnssi Hannula  *	ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
8998b8277a1SAnssi Hannula  *	defining effect parameters
9008b8277a1SAnssi Hannula  *
9018b8277a1SAnssi Hannula  * This structure is sent through ioctl from the application to the driver.
9028006479cSDmitry Torokhov  * To create a new effect application should set its @id to -1; the kernel
9038b8277a1SAnssi Hannula  * will return assigned @id which can later be used to update or delete
9048b8277a1SAnssi Hannula  * this effect.
9058b8277a1SAnssi Hannula  *
9068b8277a1SAnssi Hannula  * Direction of the effect is encoded as follows:
9078b8277a1SAnssi Hannula  *	0 deg -> 0x0000 (down)
9088b8277a1SAnssi Hannula  *	90 deg -> 0x4000 (left)
9098b8277a1SAnssi Hannula  *	180 deg -> 0x8000 (up)
9108b8277a1SAnssi Hannula  *	270 deg -> 0xC000 (right)
9111da177e4SLinus Torvalds  */
9121da177e4SLinus Torvalds struct ff_effect {
9131da177e4SLinus Torvalds 	__u16 type;
9141da177e4SLinus Torvalds 	__s16 id;
9158b8277a1SAnssi Hannula 	__u16 direction;
9161da177e4SLinus Torvalds 	struct ff_trigger trigger;
9171da177e4SLinus Torvalds 	struct ff_replay replay;
9181da177e4SLinus Torvalds 
9191da177e4SLinus Torvalds 	union {
9201da177e4SLinus Torvalds 		struct ff_constant_effect constant;
9211da177e4SLinus Torvalds 		struct ff_ramp_effect ramp;
9221da177e4SLinus Torvalds 		struct ff_periodic_effect periodic;
9231da177e4SLinus Torvalds 		struct ff_condition_effect condition[2]; /* One for each axis */
9241da177e4SLinus Torvalds 		struct ff_rumble_effect rumble;
9251da177e4SLinus Torvalds 	} u;
9261da177e4SLinus Torvalds };
9271da177e4SLinus Torvalds 
9281da177e4SLinus Torvalds /*
9291da177e4SLinus Torvalds  * Force feedback effect types
9301da177e4SLinus Torvalds  */
9311da177e4SLinus Torvalds 
9321da177e4SLinus Torvalds #define FF_RUMBLE	0x50
9331da177e4SLinus Torvalds #define FF_PERIODIC	0x51
9341da177e4SLinus Torvalds #define FF_CONSTANT	0x52
9351da177e4SLinus Torvalds #define FF_SPRING	0x53
9361da177e4SLinus Torvalds #define FF_FRICTION	0x54
9371da177e4SLinus Torvalds #define FF_DAMPER	0x55
9381da177e4SLinus Torvalds #define FF_INERTIA	0x56
9391da177e4SLinus Torvalds #define FF_RAMP		0x57
9401da177e4SLinus Torvalds 
941509ca1a9SAnssi Hannula #define FF_EFFECT_MIN	FF_RUMBLE
942509ca1a9SAnssi Hannula #define FF_EFFECT_MAX	FF_RAMP
943509ca1a9SAnssi Hannula 
9441da177e4SLinus Torvalds /*
9451da177e4SLinus Torvalds  * Force feedback periodic effect types
9461da177e4SLinus Torvalds  */
9471da177e4SLinus Torvalds 
9481da177e4SLinus Torvalds #define FF_SQUARE	0x58
9491da177e4SLinus Torvalds #define FF_TRIANGLE	0x59
9501da177e4SLinus Torvalds #define FF_SINE		0x5a
9511da177e4SLinus Torvalds #define FF_SAW_UP	0x5b
9521da177e4SLinus Torvalds #define FF_SAW_DOWN	0x5c
9531da177e4SLinus Torvalds #define FF_CUSTOM	0x5d
9541da177e4SLinus Torvalds 
955509ca1a9SAnssi Hannula #define FF_WAVEFORM_MIN	FF_SQUARE
956509ca1a9SAnssi Hannula #define FF_WAVEFORM_MAX	FF_CUSTOM
957509ca1a9SAnssi Hannula 
9581da177e4SLinus Torvalds /*
9591da177e4SLinus Torvalds  * Set ff device properties
9601da177e4SLinus Torvalds  */
9611da177e4SLinus Torvalds 
9621da177e4SLinus Torvalds #define FF_GAIN		0x60
9631da177e4SLinus Torvalds #define FF_AUTOCENTER	0x61
9641da177e4SLinus Torvalds 
9651da177e4SLinus Torvalds #define FF_MAX		0x7f
9667b19ada2SJiri Slaby #define FF_CNT		(FF_MAX+1)
9671da177e4SLinus Torvalds 
9681da177e4SLinus Torvalds #ifdef __KERNEL__
9691da177e4SLinus Torvalds 
9701da177e4SLinus Torvalds /*
9711da177e4SLinus Torvalds  * In-kernel definitions.
9721da177e4SLinus Torvalds  */
9731da177e4SLinus Torvalds 
974ddc5d341SDmitry Torokhov #include <linux/device.h>
9751da177e4SLinus Torvalds #include <linux/fs.h>
9761da177e4SLinus Torvalds #include <linux/timer.h>
977ddc5d341SDmitry Torokhov #include <linux/mod_devicetable.h>
9781da177e4SLinus Torvalds 
9798006479cSDmitry Torokhov /**
9808006479cSDmitry Torokhov  * struct input_dev - represents an input device
9818006479cSDmitry Torokhov  * @name: name of the device
9828006479cSDmitry Torokhov  * @phys: physical path to the device in the system hierarchy
9838006479cSDmitry Torokhov  * @uniq: unique identification code for the device (if device has it)
9848006479cSDmitry Torokhov  * @id: id of the device (struct input_id)
9858006479cSDmitry Torokhov  * @evbit: bitmap of types of events supported by the device (EV_KEY,
9868006479cSDmitry Torokhov  *	EV_REL, etc.)
9878006479cSDmitry Torokhov  * @keybit: bitmap of keys/buttons this device has
9888006479cSDmitry Torokhov  * @relbit: bitmap of relative axes for the device
9898006479cSDmitry Torokhov  * @absbit: bitmap of absolute axes for the device
9908006479cSDmitry Torokhov  * @mscbit: bitmap of miscellaneous events supported by the device
9918006479cSDmitry Torokhov  * @ledbit: bitmap of leds present on the device
9928006479cSDmitry Torokhov  * @sndbit: bitmap of sound effects supported by the device
9938006479cSDmitry Torokhov  * @ffbit: bitmap of force feedback effects supported by the device
9948006479cSDmitry Torokhov  * @swbit: bitmap of switches present on the device
9958006479cSDmitry Torokhov  * @keycodemax: size of keycode table
9968006479cSDmitry Torokhov  * @keycodesize: size of elements in keycode table
9978006479cSDmitry Torokhov  * @keycode: map of scancodes to keycodes for this device
9988006479cSDmitry Torokhov  * @setkeycode: optional method to alter current keymap, used to implement
9998006479cSDmitry Torokhov  *	sparse keymaps. If not supplied default mechanism will be used
10008006479cSDmitry Torokhov  * @getkeycode: optional method to retrieve current keymap. If not supplied
10018006479cSDmitry Torokhov  *	default mechanism will be used
10028006479cSDmitry Torokhov  * @ff: force feedback structure associated with the device if device
10038006479cSDmitry Torokhov  *	supports force feedback effects
10048006479cSDmitry Torokhov  * @repeat_key: stores key code of the last key pressed; used to implement
10058006479cSDmitry Torokhov  *	software autorepeat
10068006479cSDmitry Torokhov  * @timer: timer for software autorepeat
10078006479cSDmitry Torokhov  * @sync: set to 1 when there were no new events since last EV_SYNC
10088006479cSDmitry Torokhov  * @abs: current values for reports from absolute axes
10098006479cSDmitry Torokhov  * @rep: current values for autorepeat parameters (delay, rate)
10108006479cSDmitry Torokhov  * @key: reflects current state of device's keys/buttons
10118006479cSDmitry Torokhov  * @led: reflects current state of device's LEDs
10128006479cSDmitry Torokhov  * @snd: reflects current state of sound effects
10138006479cSDmitry Torokhov  * @sw: reflects current state of device's switches
10148006479cSDmitry Torokhov  * @absmax: maximum values for events coming from absolute axes
10158006479cSDmitry Torokhov  * @absmin: minimum values for events coming from absolute axes
10168006479cSDmitry Torokhov  * @absfuzz: describes noisiness for axes
10178006479cSDmitry Torokhov  * @absflat: size of the center flat position (used by joydev)
10188006479cSDmitry Torokhov  * @open: this method is called when the very first user calls
10198006479cSDmitry Torokhov  *	input_open_device(). The driver must prepare the device
10208006479cSDmitry Torokhov  *	to start generating events (start polling thread,
10218006479cSDmitry Torokhov  *	request an IRQ, submit URB, etc.)
10228006479cSDmitry Torokhov  * @close: this method is called when the very last user calls
10238006479cSDmitry Torokhov  *	input_close_device().
10248006479cSDmitry Torokhov  * @flush: purges the device. Most commonly used to get rid of force
10258006479cSDmitry Torokhov  *	feedback effects loaded into the device when disconnecting
10268006479cSDmitry Torokhov  *	from it
10278006479cSDmitry Torokhov  * @event: event handler for events sent _to_ the device, like EV_LED
10288006479cSDmitry Torokhov  *	or EV_SND. The device is expected to carry out the requested
10298006479cSDmitry Torokhov  *	action (turn on a LED, play sound, etc.) The call is protected
10308006479cSDmitry Torokhov  *	by @event_lock and must not sleep
10318006479cSDmitry Torokhov  * @grab: input handle that currently has the device grabbed (via
10328006479cSDmitry Torokhov  *	EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
10338006479cSDmitry Torokhov  *	recipient for all input events coming from the device
10348006479cSDmitry Torokhov  * @event_lock: this spinlock is is taken when input core receives
10358006479cSDmitry Torokhov  *	and processes a new event for the device (in input_event()).
10368006479cSDmitry Torokhov  *	Code that accesses and/or modifies parameters of a device
10378006479cSDmitry Torokhov  *	(such as keymap or absmin, absmax, absfuzz, etc.) after device
10388006479cSDmitry Torokhov  *	has been registered with input core must take this lock.
10398006479cSDmitry Torokhov  * @mutex: serializes calls to open(), close() and flush() methods
10408006479cSDmitry Torokhov  * @users: stores number of users (input handlers) that opened this
10418006479cSDmitry Torokhov  *	device. It is used by input_open_device() and input_close_device()
10428006479cSDmitry Torokhov  *	to make sure that dev->open() is only called when the first
10438006479cSDmitry Torokhov  *	user opens device and dev->close() is called when the very
10448006479cSDmitry Torokhov  *	last user closes the device
10458006479cSDmitry Torokhov  * @going_away: marks devices that are in a middle of unregistering and
10468006479cSDmitry Torokhov  *	causes input_open_device*() fail with -ENODEV.
10478006479cSDmitry Torokhov  * @dev: driver model's view of this device
10488006479cSDmitry Torokhov  * @h_list: list of input handles associated with the device. When
10498006479cSDmitry Torokhov  *	accessing the list dev->mutex must be held
10508006479cSDmitry Torokhov  * @node: used to place the device onto input_dev_list
10518006479cSDmitry Torokhov  */
10521da177e4SLinus Torvalds struct input_dev {
10535b6271bdSDmitry Torokhov 	const char *name;
10545b6271bdSDmitry Torokhov 	const char *phys;
10555b6271bdSDmitry Torokhov 	const char *uniq;
10561da177e4SLinus Torvalds 	struct input_id id;
10571da177e4SLinus Torvalds 
10587b19ada2SJiri Slaby 	unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
10597b19ada2SJiri Slaby 	unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
10607b19ada2SJiri Slaby 	unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
10617b19ada2SJiri Slaby 	unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
10627b19ada2SJiri Slaby 	unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
10637b19ada2SJiri Slaby 	unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
10647b19ada2SJiri Slaby 	unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
10657b19ada2SJiri Slaby 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
10667b19ada2SJiri Slaby 	unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
10671da177e4SLinus Torvalds 
10681da177e4SLinus Torvalds 	unsigned int keycodemax;
10691da177e4SLinus Torvalds 	unsigned int keycodesize;
10701da177e4SLinus Torvalds 	void *keycode;
1071c8e4c772SMarvin Raaijmakers 	int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
1072c8e4c772SMarvin Raaijmakers 	int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
10731da177e4SLinus Torvalds 
1074509ca1a9SAnssi Hannula 	struct ff_device *ff;
1075509ca1a9SAnssi Hannula 
10761da177e4SLinus Torvalds 	unsigned int repeat_key;
10771da177e4SLinus Torvalds 	struct timer_list timer;
10781da177e4SLinus Torvalds 
10791da177e4SLinus Torvalds 	int sync;
10801da177e4SLinus Torvalds 
10811da177e4SLinus Torvalds 	int abs[ABS_MAX + 1];
10821da177e4SLinus Torvalds 	int rep[REP_MAX + 1];
10831da177e4SLinus Torvalds 
10847b19ada2SJiri Slaby 	unsigned long key[BITS_TO_LONGS(KEY_CNT)];
10857b19ada2SJiri Slaby 	unsigned long led[BITS_TO_LONGS(LED_CNT)];
10867b19ada2SJiri Slaby 	unsigned long snd[BITS_TO_LONGS(SND_CNT)];
10877b19ada2SJiri Slaby 	unsigned long sw[BITS_TO_LONGS(SW_CNT)];
10881da177e4SLinus Torvalds 
10891da177e4SLinus Torvalds 	int absmax[ABS_MAX + 1];
10901da177e4SLinus Torvalds 	int absmin[ABS_MAX + 1];
10911da177e4SLinus Torvalds 	int absfuzz[ABS_MAX + 1];
10921da177e4SLinus Torvalds 	int absflat[ABS_MAX + 1];
10931da177e4SLinus Torvalds 
10941da177e4SLinus Torvalds 	int (*open)(struct input_dev *dev);
10951da177e4SLinus Torvalds 	void (*close)(struct input_dev *dev);
10961da177e4SLinus Torvalds 	int (*flush)(struct input_dev *dev, struct file *file);
10971da177e4SLinus Torvalds 	int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
10981da177e4SLinus Torvalds 
10991da177e4SLinus Torvalds 	struct input_handle *grab;
11000fbf87caSDmitry Torokhov 
11018006479cSDmitry Torokhov 	spinlock_t event_lock;
11028006479cSDmitry Torokhov 	struct mutex mutex;
11038006479cSDmitry Torokhov 
11040fbf87caSDmitry Torokhov 	unsigned int users;
11058006479cSDmitry Torokhov 	int going_away;
11060fbf87caSDmitry Torokhov 
11079657d75cSDmitry Torokhov 	struct device dev;
11081da177e4SLinus Torvalds 
11091da177e4SLinus Torvalds 	struct list_head	h_list;
11101da177e4SLinus Torvalds 	struct list_head	node;
11111da177e4SLinus Torvalds };
11129657d75cSDmitry Torokhov #define to_input_dev(d) container_of(d, struct input_dev, dev)
11131da177e4SLinus Torvalds 
1114ddc5d341SDmitry Torokhov /*
1115ddc5d341SDmitry Torokhov  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1116ddc5d341SDmitry Torokhov  */
1117ddc5d341SDmitry Torokhov 
1118ddc5d341SDmitry Torokhov #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1119ddc5d341SDmitry Torokhov #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1120ddc5d341SDmitry Torokhov #endif
1121ddc5d341SDmitry Torokhov 
1122dc24f0e7SSam Ravnborg #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1123dc24f0e7SSam Ravnborg #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1124dc24f0e7SSam Ravnborg #endif
1125dc24f0e7SSam Ravnborg 
1126ddc5d341SDmitry Torokhov #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1127ddc5d341SDmitry Torokhov #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1128ddc5d341SDmitry Torokhov #endif
1129ddc5d341SDmitry Torokhov 
1130ddc5d341SDmitry Torokhov #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1131ddc5d341SDmitry Torokhov #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1132ddc5d341SDmitry Torokhov #endif
1133ddc5d341SDmitry Torokhov 
1134ddc5d341SDmitry Torokhov #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1135ddc5d341SDmitry Torokhov #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1136ddc5d341SDmitry Torokhov #endif
1137ddc5d341SDmitry Torokhov 
1138ddc5d341SDmitry Torokhov #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1139ddc5d341SDmitry Torokhov #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1140ddc5d341SDmitry Torokhov #endif
1141ddc5d341SDmitry Torokhov 
1142ddc5d341SDmitry Torokhov #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1143ddc5d341SDmitry Torokhov #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1144ddc5d341SDmitry Torokhov #endif
1145ddc5d341SDmitry Torokhov 
1146ddc5d341SDmitry Torokhov #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1147ddc5d341SDmitry Torokhov #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1148ddc5d341SDmitry Torokhov #endif
1149ddc5d341SDmitry Torokhov 
1150ddc5d341SDmitry Torokhov #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1151ddc5d341SDmitry Torokhov #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1152ddc5d341SDmitry Torokhov #endif
1153ddc5d341SDmitry Torokhov 
1154ddc5d341SDmitry Torokhov #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1155ddc5d341SDmitry Torokhov #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1156ddc5d341SDmitry Torokhov #endif
1157ddc5d341SDmitry Torokhov 
11581da177e4SLinus Torvalds #define INPUT_DEVICE_ID_MATCH_DEVICE \
11591da177e4SLinus Torvalds 	(INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
11601da177e4SLinus Torvalds #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
11611da177e4SLinus Torvalds 	(INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
11621da177e4SLinus Torvalds 
11631da177e4SLinus Torvalds struct input_handle;
11641da177e4SLinus Torvalds 
1165c7e8dc6eSDmitry Torokhov /**
1166c7e8dc6eSDmitry Torokhov  * struct input_handler - implements one of interfaces for input devices
1167c7e8dc6eSDmitry Torokhov  * @private: driver-specific data
11688006479cSDmitry Torokhov  * @event: event handler. This method is being called by input core with
11698006479cSDmitry Torokhov  *	interrupts disabled and dev->event_lock spinlock held and so
11708006479cSDmitry Torokhov  *	it may not sleep
1171c7e8dc6eSDmitry Torokhov  * @connect: called when attaching a handler to an input device
1172c7e8dc6eSDmitry Torokhov  * @disconnect: disconnects a handler from input device
1173c7e8dc6eSDmitry Torokhov  * @start: starts handler for given handle. This function is called by
1174c7e8dc6eSDmitry Torokhov  *	input core right after connect() method and also when a process
1175c7e8dc6eSDmitry Torokhov  *	that "grabbed" a device releases it
1176c7e8dc6eSDmitry Torokhov  * @fops: file operations this driver implements
1177c7e8dc6eSDmitry Torokhov  * @minor: beginning of range of 32 minors for devices this driver
1178c7e8dc6eSDmitry Torokhov  *	can provide
1179c7e8dc6eSDmitry Torokhov  * @name: name of the handler, to be shown in /proc/bus/input/handlers
1180c7e8dc6eSDmitry Torokhov  * @id_table: pointer to a table of input_device_ids this driver can
1181c7e8dc6eSDmitry Torokhov  *	handle
11828006479cSDmitry Torokhov  * @blacklist: pointer to a table of input_device_ids this driver should
1183c7e8dc6eSDmitry Torokhov  *	ignore even if they match @id_table
1184c7e8dc6eSDmitry Torokhov  * @h_list: list of input handles associated with the handler
1185c7e8dc6eSDmitry Torokhov  * @node: for placing the driver onto input_handler_list
11868006479cSDmitry Torokhov  *
11878006479cSDmitry Torokhov  * Input handlers attach to input devices and create input handles. There
11888006479cSDmitry Torokhov  * are likely several handlers attached to any given input device at the
11898006479cSDmitry Torokhov  * same time. All of them will get their copy of input event generated by
11908006479cSDmitry Torokhov  * the device.
11918006479cSDmitry Torokhov  *
11928006479cSDmitry Torokhov  * Note that input core serializes calls to connect() and disconnect()
11938006479cSDmitry Torokhov  * methods.
1194c7e8dc6eSDmitry Torokhov  */
11951da177e4SLinus Torvalds struct input_handler {
11961da177e4SLinus Torvalds 
11971da177e4SLinus Torvalds 	void *private;
11981da177e4SLinus Torvalds 
11991da177e4SLinus Torvalds 	void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
12005b2a0826SDmitry Torokhov 	int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
12011da177e4SLinus Torvalds 	void (*disconnect)(struct input_handle *handle);
1202c7e8dc6eSDmitry Torokhov 	void (*start)(struct input_handle *handle);
12031da177e4SLinus Torvalds 
120499ac48f5SArjan van de Ven 	const struct file_operations *fops;
12051da177e4SLinus Torvalds 	int minor;
120666e66118SDmitry Torokhov 	const char *name;
12071da177e4SLinus Torvalds 
120866e66118SDmitry Torokhov 	const struct input_device_id *id_table;
120966e66118SDmitry Torokhov 	const struct input_device_id *blacklist;
12101da177e4SLinus Torvalds 
12111da177e4SLinus Torvalds 	struct list_head	h_list;
12121da177e4SLinus Torvalds 	struct list_head	node;
12131da177e4SLinus Torvalds };
12141da177e4SLinus Torvalds 
12158006479cSDmitry Torokhov /**
12168006479cSDmitry Torokhov  * struct input_handle - links input device with an input handler
12178006479cSDmitry Torokhov  * @private: handler-specific data
12188006479cSDmitry Torokhov  * @open: counter showing whether the handle is 'open', i.e. should deliver
12198006479cSDmitry Torokhov  *	events from its device
12208006479cSDmitry Torokhov  * @name: name given to the handle by handler that created it
12218006479cSDmitry Torokhov  * @dev: input device the handle is attached to
12228006479cSDmitry Torokhov  * @handler: handler that works with the device through this handle
12238006479cSDmitry Torokhov  * @d_node: used to put the handle on device's list of attached handles
12248006479cSDmitry Torokhov  * @h_node: used to put the handle on handler's list of handles from which
12258006479cSDmitry Torokhov  *	it gets events
12268006479cSDmitry Torokhov  */
12271da177e4SLinus Torvalds struct input_handle {
12281da177e4SLinus Torvalds 
12291da177e4SLinus Torvalds 	void *private;
12301da177e4SLinus Torvalds 
12311da177e4SLinus Torvalds 	int open;
123266e66118SDmitry Torokhov 	const char *name;
12331da177e4SLinus Torvalds 
12341da177e4SLinus Torvalds 	struct input_dev *dev;
12351da177e4SLinus Torvalds 	struct input_handler *handler;
12361da177e4SLinus Torvalds 
12371da177e4SLinus Torvalds 	struct list_head	d_node;
12381da177e4SLinus Torvalds 	struct list_head	h_node;
12391da177e4SLinus Torvalds };
12401da177e4SLinus Torvalds 
1241d19fbe8aSDmitry Torokhov struct input_dev *input_allocate_device(void);
1242f60d2b11SDmitry Torokhov void input_free_device(struct input_dev *dev);
1243d19fbe8aSDmitry Torokhov 
1244d19fbe8aSDmitry Torokhov static inline struct input_dev *input_get_device(struct input_dev *dev)
1245d19fbe8aSDmitry Torokhov {
1246a7097ff8SDmitry Torokhov 	return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1247d19fbe8aSDmitry Torokhov }
1248d19fbe8aSDmitry Torokhov 
1249d19fbe8aSDmitry Torokhov static inline void input_put_device(struct input_dev *dev)
1250d19fbe8aSDmitry Torokhov {
1251a7097ff8SDmitry Torokhov 	if (dev)
12529657d75cSDmitry Torokhov 		put_device(&dev->dev);
1253d19fbe8aSDmitry Torokhov }
1254d19fbe8aSDmitry Torokhov 
12553abccf36SDmitry Torokhov static inline void *input_get_drvdata(struct input_dev *dev)
12563abccf36SDmitry Torokhov {
12573797fec1SDmitry Torokhov 	return dev_get_drvdata(&dev->dev);
12583abccf36SDmitry Torokhov }
12593abccf36SDmitry Torokhov 
12603abccf36SDmitry Torokhov static inline void input_set_drvdata(struct input_dev *dev, void *data)
12613abccf36SDmitry Torokhov {
12623797fec1SDmitry Torokhov 	dev_set_drvdata(&dev->dev, data);
12633abccf36SDmitry Torokhov }
12643abccf36SDmitry Torokhov 
1265501cc54cSDmitry Torokhov int __must_check input_register_device(struct input_dev *);
12661da177e4SLinus Torvalds void input_unregister_device(struct input_dev *);
12671da177e4SLinus Torvalds 
1268501cc54cSDmitry Torokhov int __must_check input_register_handler(struct input_handler *);
12691da177e4SLinus Torvalds void input_unregister_handler(struct input_handler *);
12701da177e4SLinus Torvalds 
12715b2a0826SDmitry Torokhov int input_register_handle(struct input_handle *);
12725b2a0826SDmitry Torokhov void input_unregister_handle(struct input_handle *);
12735b2a0826SDmitry Torokhov 
12741da177e4SLinus Torvalds int input_grab_device(struct input_handle *);
12751da177e4SLinus Torvalds void input_release_device(struct input_handle *);
12761da177e4SLinus Torvalds 
12771da177e4SLinus Torvalds int input_open_device(struct input_handle *);
12781da177e4SLinus Torvalds void input_close_device(struct input_handle *);
12791da177e4SLinus Torvalds 
12801da177e4SLinus Torvalds int input_flush_device(struct input_handle* handle, struct file* file);
12811da177e4SLinus Torvalds 
12821da177e4SLinus Torvalds void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
12830e739d28SDmitry Torokhov void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
12841da177e4SLinus Torvalds 
12851da177e4SLinus Torvalds static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
12861da177e4SLinus Torvalds {
12871da177e4SLinus Torvalds 	input_event(dev, EV_KEY, code, !!value);
12881da177e4SLinus Torvalds }
12891da177e4SLinus Torvalds 
12901da177e4SLinus Torvalds static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
12911da177e4SLinus Torvalds {
12921da177e4SLinus Torvalds 	input_event(dev, EV_REL, code, value);
12931da177e4SLinus Torvalds }
12941da177e4SLinus Torvalds 
12951da177e4SLinus Torvalds static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
12961da177e4SLinus Torvalds {
12971da177e4SLinus Torvalds 	input_event(dev, EV_ABS, code, value);
12981da177e4SLinus Torvalds }
12991da177e4SLinus Torvalds 
13001da177e4SLinus Torvalds static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
13011da177e4SLinus Torvalds {
13021da177e4SLinus Torvalds 	input_event(dev, EV_FF_STATUS, code, value);
13031da177e4SLinus Torvalds }
13041da177e4SLinus Torvalds 
130531581066SRichard Purdie static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
130631581066SRichard Purdie {
130731581066SRichard Purdie 	input_event(dev, EV_SW, code, !!value);
130831581066SRichard Purdie }
130931581066SRichard Purdie 
13101da177e4SLinus Torvalds static inline void input_sync(struct input_dev *dev)
13111da177e4SLinus Torvalds {
13121da177e4SLinus Torvalds 	input_event(dev, EV_SYN, SYN_REPORT, 0);
13131da177e4SLinus Torvalds }
13141da177e4SLinus Torvalds 
1315534565f2SDmitry Torokhov void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1316534565f2SDmitry Torokhov 
13171da177e4SLinus Torvalds static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
13181da177e4SLinus Torvalds {
13191da177e4SLinus Torvalds 	dev->absmin[axis] = min;
13201da177e4SLinus Torvalds 	dev->absmax[axis] = max;
13211da177e4SLinus Torvalds 	dev->absfuzz[axis] = fuzz;
13221da177e4SLinus Torvalds 	dev->absflat[axis] = flat;
13231da177e4SLinus Torvalds 
13247b19ada2SJiri Slaby 	dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
13251da177e4SLinus Torvalds }
13261da177e4SLinus Torvalds 
1327f4f37c8eSDmitry Torokhov int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
1328f4f37c8eSDmitry Torokhov int input_set_keycode(struct input_dev *dev, int scancode, int keycode);
1329f4f37c8eSDmitry Torokhov 
1330ea9f240bSGreg Kroah-Hartman extern struct class input_class;
13311da177e4SLinus Torvalds 
1332509ca1a9SAnssi Hannula /**
1333509ca1a9SAnssi Hannula  * struct ff_device - force-feedback part of an input device
1334509ca1a9SAnssi Hannula  * @upload: Called to upload an new effect into device
1335509ca1a9SAnssi Hannula  * @erase: Called to erase an effect from device
1336509ca1a9SAnssi Hannula  * @playback: Called to request device to start playing specified effect
1337509ca1a9SAnssi Hannula  * @set_gain: Called to set specified gain
1338509ca1a9SAnssi Hannula  * @set_autocenter: Called to auto-center device
1339509ca1a9SAnssi Hannula  * @destroy: called by input core when parent input device is being
1340509ca1a9SAnssi Hannula  *	destroyed
1341509ca1a9SAnssi Hannula  * @private: driver-specific data, will be freed automatically
1342509ca1a9SAnssi Hannula  * @ffbit: bitmap of force feedback capabilities truly supported by
1343509ca1a9SAnssi Hannula  *	device (not emulated like ones in input_dev->ffbit)
1344509ca1a9SAnssi Hannula  * @mutex: mutex for serializing access to the device
1345509ca1a9SAnssi Hannula  * @max_effects: maximum number of effects supported by device
1346509ca1a9SAnssi Hannula  * @effects: pointer to an array of effects currently loaded into device
1347509ca1a9SAnssi Hannula  * @effect_owners: array of effect owners; when file handle owning
13488006479cSDmitry Torokhov  *	an effect gets closed the effect is automatically erased
1349509ca1a9SAnssi Hannula  *
1350509ca1a9SAnssi Hannula  * Every force-feedback device must implement upload() and playback()
1351509ca1a9SAnssi Hannula  * methods; erase() is optional. set_gain() and set_autocenter() need
1352509ca1a9SAnssi Hannula  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1353509ca1a9SAnssi Hannula  * bits.
1354509ca1a9SAnssi Hannula  */
1355509ca1a9SAnssi Hannula struct ff_device {
1356509ca1a9SAnssi Hannula 	int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1357509ca1a9SAnssi Hannula 		      struct ff_effect *old);
1358509ca1a9SAnssi Hannula 	int (*erase)(struct input_dev *dev, int effect_id);
1359509ca1a9SAnssi Hannula 
1360509ca1a9SAnssi Hannula 	int (*playback)(struct input_dev *dev, int effect_id, int value);
1361509ca1a9SAnssi Hannula 	void (*set_gain)(struct input_dev *dev, u16 gain);
1362509ca1a9SAnssi Hannula 	void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1363509ca1a9SAnssi Hannula 
1364509ca1a9SAnssi Hannula 	void (*destroy)(struct ff_device *);
1365509ca1a9SAnssi Hannula 
1366509ca1a9SAnssi Hannula 	void *private;
1367509ca1a9SAnssi Hannula 
13687b19ada2SJiri Slaby 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1369509ca1a9SAnssi Hannula 
1370509ca1a9SAnssi Hannula 	struct mutex mutex;
1371509ca1a9SAnssi Hannula 
1372509ca1a9SAnssi Hannula 	int max_effects;
1373509ca1a9SAnssi Hannula 	struct ff_effect *effects;
1374509ca1a9SAnssi Hannula 	struct file *effect_owners[];
1375509ca1a9SAnssi Hannula };
1376509ca1a9SAnssi Hannula 
1377509ca1a9SAnssi Hannula int input_ff_create(struct input_dev *dev, int max_effects);
1378509ca1a9SAnssi Hannula void input_ff_destroy(struct input_dev *dev);
1379509ca1a9SAnssi Hannula 
1380509ca1a9SAnssi Hannula int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1381509ca1a9SAnssi Hannula 
1382509ca1a9SAnssi Hannula int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1383509ca1a9SAnssi Hannula int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1384509ca1a9SAnssi Hannula 
13857d928a2bSAnssi Hannula int input_ff_create_memless(struct input_dev *dev, void *data,
13867d928a2bSAnssi Hannula 		int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
13877d928a2bSAnssi Hannula 
13881da177e4SLinus Torvalds #endif
13891da177e4SLinus Torvalds #endif
1390