blob: ce1a756c4c30ba260b316c750178fb51aaf69f0c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _INPUT_H
2#define _INPUT_H
3
4/*
5 * Copyright (c) 1999-2002 Vojtech Pavlik
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published by
9 * the Free Software Foundation.
10 */
11
12#ifdef __KERNEL__
13#include <linux/time.h>
14#include <linux/list.h>
15#else
16#include <sys/time.h>
17#include <sys/ioctl.h>
18#include <asm/types.h>
19#endif
20
21/*
22 * The event structure itself
23 */
24
25struct input_event {
26 struct timeval time;
27 __u16 type;
28 __u16 code;
29 __s32 value;
30};
31
32/*
33 * Protocol version.
34 */
35
36#define EV_VERSION 0x010000
37
38/*
39 * IOCTLs (0x00 - 0x7f)
40 */
41
42struct input_id {
43 __u16 bustype;
44 __u16 vendor;
45 __u16 product;
46 __u16 version;
47};
48
49struct input_absinfo {
50 __s32 value;
51 __s32 minimum;
52 __s32 maximum;
53 __s32 fuzz;
54 __s32 flat;
55};
56
57#define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
58#define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
Dmitry Torokhov08791e52006-04-29 01:13:21 -040059#define EVIOCGREP _IOR('E', 0x03, int[2]) /* get repeat settings */
60#define EVIOCSREP _IOW('E', 0x03, int[2]) /* set repeat settings */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#define EVIOCGKEYCODE _IOR('E', 0x04, int[2]) /* get keycode */
62#define EVIOCSKEYCODE _IOW('E', 0x04, int[2]) /* set keycode */
63
64#define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
65#define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
66#define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
67
68#define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global keystate */
69#define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
70#define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
Richard Purdie31581062005-09-06 15:19:06 -070071#define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73#define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + ev, len) /* get event bits */
74#define EVIOCGABS(abs) _IOR('E', 0x40 + abs, struct input_absinfo) /* get abs value/limits */
75#define EVIOCSABS(abs) _IOW('E', 0xc0 + abs, struct input_absinfo) /* set abs value/limits */
76
77#define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */
78#define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
79#define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
80
81#define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
82
83/*
84 * Event types
85 */
86
87#define EV_SYN 0x00
88#define EV_KEY 0x01
89#define EV_REL 0x02
90#define EV_ABS 0x03
91#define EV_MSC 0x04
Richard Purdie31581062005-09-06 15:19:06 -070092#define EV_SW 0x05
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#define EV_LED 0x11
94#define EV_SND 0x12
95#define EV_REP 0x14
96#define EV_FF 0x15
97#define EV_PWR 0x16
98#define EV_FF_STATUS 0x17
99#define EV_MAX 0x1f
100
101/*
102 * Synchronization events.
103 */
104
105#define SYN_REPORT 0
106#define SYN_CONFIG 1
107
108/*
109 * Keys and buttons
110 */
111
112#define KEY_RESERVED 0
113#define KEY_ESC 1
114#define KEY_1 2
115#define KEY_2 3
116#define KEY_3 4
117#define KEY_4 5
118#define KEY_5 6
119#define KEY_6 7
120#define KEY_7 8
121#define KEY_8 9
122#define KEY_9 10
123#define KEY_0 11
124#define KEY_MINUS 12
125#define KEY_EQUAL 13
126#define KEY_BACKSPACE 14
127#define KEY_TAB 15
128#define KEY_Q 16
129#define KEY_W 17
130#define KEY_E 18
131#define KEY_R 19
132#define KEY_T 20
133#define KEY_Y 21
134#define KEY_U 22
135#define KEY_I 23
136#define KEY_O 24
137#define KEY_P 25
138#define KEY_LEFTBRACE 26
139#define KEY_RIGHTBRACE 27
140#define KEY_ENTER 28
141#define KEY_LEFTCTRL 29
142#define KEY_A 30
143#define KEY_S 31
144#define KEY_D 32
145#define KEY_F 33
146#define KEY_G 34
147#define KEY_H 35
148#define KEY_J 36
149#define KEY_K 37
150#define KEY_L 38
151#define KEY_SEMICOLON 39
152#define KEY_APOSTROPHE 40
153#define KEY_GRAVE 41
154#define KEY_LEFTSHIFT 42
155#define KEY_BACKSLASH 43
156#define KEY_Z 44
157#define KEY_X 45
158#define KEY_C 46
159#define KEY_V 47
160#define KEY_B 48
161#define KEY_N 49
162#define KEY_M 50
163#define KEY_COMMA 51
164#define KEY_DOT 52
165#define KEY_SLASH 53
166#define KEY_RIGHTSHIFT 54
167#define KEY_KPASTERISK 55
168#define KEY_LEFTALT 56
169#define KEY_SPACE 57
170#define KEY_CAPSLOCK 58
171#define KEY_F1 59
172#define KEY_F2 60
173#define KEY_F3 61
174#define KEY_F4 62
175#define KEY_F5 63
176#define KEY_F6 64
177#define KEY_F7 65
178#define KEY_F8 66
179#define KEY_F9 67
180#define KEY_F10 68
181#define KEY_NUMLOCK 69
182#define KEY_SCROLLLOCK 70
183#define KEY_KP7 71
184#define KEY_KP8 72
185#define KEY_KP9 73
186#define KEY_KPMINUS 74
187#define KEY_KP4 75
188#define KEY_KP5 76
189#define KEY_KP6 77
190#define KEY_KPPLUS 78
191#define KEY_KP1 79
192#define KEY_KP2 80
193#define KEY_KP3 81
194#define KEY_KP0 82
195#define KEY_KPDOT 83
196
197#define KEY_ZENKAKUHANKAKU 85
198#define KEY_102ND 86
199#define KEY_F11 87
200#define KEY_F12 88
201#define KEY_RO 89
202#define KEY_KATAKANA 90
203#define KEY_HIRAGANA 91
204#define KEY_HENKAN 92
205#define KEY_KATAKANAHIRAGANA 93
206#define KEY_MUHENKAN 94
207#define KEY_KPJPCOMMA 95
208#define KEY_KPENTER 96
209#define KEY_RIGHTCTRL 97
210#define KEY_KPSLASH 98
211#define KEY_SYSRQ 99
212#define KEY_RIGHTALT 100
213#define KEY_LINEFEED 101
214#define KEY_HOME 102
215#define KEY_UP 103
216#define KEY_PAGEUP 104
217#define KEY_LEFT 105
218#define KEY_RIGHT 106
219#define KEY_END 107
220#define KEY_DOWN 108
221#define KEY_PAGEDOWN 109
222#define KEY_INSERT 110
223#define KEY_DELETE 111
224#define KEY_MACRO 112
225#define KEY_MUTE 113
226#define KEY_VOLUMEDOWN 114
227#define KEY_VOLUMEUP 115
228#define KEY_POWER 116
229#define KEY_KPEQUAL 117
230#define KEY_KPPLUSMINUS 118
231#define KEY_PAUSE 119
232
233#define KEY_KPCOMMA 121
234#define KEY_HANGUEL 122
235#define KEY_HANJA 123
236#define KEY_YEN 124
237#define KEY_LEFTMETA 125
238#define KEY_RIGHTMETA 126
239#define KEY_COMPOSE 127
240
241#define KEY_STOP 128
242#define KEY_AGAIN 129
243#define KEY_PROPS 130
244#define KEY_UNDO 131
245#define KEY_FRONT 132
246#define KEY_COPY 133
247#define KEY_OPEN 134
248#define KEY_PASTE 135
249#define KEY_FIND 136
250#define KEY_CUT 137
251#define KEY_HELP 138
252#define KEY_MENU 139
253#define KEY_CALC 140
254#define KEY_SETUP 141
255#define KEY_SLEEP 142
256#define KEY_WAKEUP 143
257#define KEY_FILE 144
258#define KEY_SENDFILE 145
259#define KEY_DELETEFILE 146
260#define KEY_XFER 147
261#define KEY_PROG1 148
262#define KEY_PROG2 149
263#define KEY_WWW 150
264#define KEY_MSDOS 151
265#define KEY_COFFEE 152
266#define KEY_DIRECTION 153
267#define KEY_CYCLEWINDOWS 154
268#define KEY_MAIL 155
269#define KEY_BOOKMARKS 156
270#define KEY_COMPUTER 157
271#define KEY_BACK 158
272#define KEY_FORWARD 159
273#define KEY_CLOSECD 160
274#define KEY_EJECTCD 161
275#define KEY_EJECTCLOSECD 162
276#define KEY_NEXTSONG 163
277#define KEY_PLAYPAUSE 164
278#define KEY_PREVIOUSSONG 165
279#define KEY_STOPCD 166
280#define KEY_RECORD 167
281#define KEY_REWIND 168
282#define KEY_PHONE 169
283#define KEY_ISO 170
284#define KEY_CONFIG 171
285#define KEY_HOMEPAGE 172
286#define KEY_REFRESH 173
287#define KEY_EXIT 174
288#define KEY_MOVE 175
289#define KEY_EDIT 176
290#define KEY_SCROLLUP 177
291#define KEY_SCROLLDOWN 178
292#define KEY_KPLEFTPAREN 179
293#define KEY_KPRIGHTPAREN 180
Vojtech Pavlik8a409b02005-09-05 00:08:08 -0500294#define KEY_NEW 181
295#define KEY_REDO 182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297#define KEY_F13 183
298#define KEY_F14 184
299#define KEY_F15 185
300#define KEY_F16 186
301#define KEY_F17 187
302#define KEY_F18 188
303#define KEY_F19 189
304#define KEY_F20 190
305#define KEY_F21 191
306#define KEY_F22 192
307#define KEY_F23 193
308#define KEY_F24 194
309
310#define KEY_PLAYCD 200
311#define KEY_PAUSECD 201
312#define KEY_PROG3 202
313#define KEY_PROG4 203
314#define KEY_SUSPEND 205
315#define KEY_CLOSE 206
316#define KEY_PLAY 207
317#define KEY_FASTFORWARD 208
318#define KEY_BASSBOOST 209
319#define KEY_PRINT 210
320#define KEY_HP 211
321#define KEY_CAMERA 212
322#define KEY_SOUND 213
323#define KEY_QUESTION 214
324#define KEY_EMAIL 215
325#define KEY_CHAT 216
326#define KEY_SEARCH 217
327#define KEY_CONNECT 218
328#define KEY_FINANCE 219
329#define KEY_SPORT 220
330#define KEY_SHOP 221
331#define KEY_ALTERASE 222
332#define KEY_CANCEL 223
333#define KEY_BRIGHTNESSDOWN 224
334#define KEY_BRIGHTNESSUP 225
335#define KEY_MEDIA 226
336
Andreas Jaggi146a4b32005-05-01 08:58:41 -0700337#define KEY_SWITCHVIDEOMODE 227
338#define KEY_KBDILLUMTOGGLE 228
339#define KEY_KBDILLUMDOWN 229
340#define KEY_KBDILLUMUP 230
341
Vojtech Pavlik8a409b02005-09-05 00:08:08 -0500342#define KEY_SEND 231
343#define KEY_REPLY 232
344#define KEY_FORWARDMAIL 233
345#define KEY_SAVE 234
346#define KEY_DOCUMENTS 235
347
Matthew Garrettf39b25b2006-05-29 23:27:39 -0400348#define KEY_BATTERY 236
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350#define KEY_UNKNOWN 240
351
352#define BTN_MISC 0x100
353#define BTN_0 0x100
354#define BTN_1 0x101
355#define BTN_2 0x102
356#define BTN_3 0x103
357#define BTN_4 0x104
358#define BTN_5 0x105
359#define BTN_6 0x106
360#define BTN_7 0x107
361#define BTN_8 0x108
362#define BTN_9 0x109
363
364#define BTN_MOUSE 0x110
365#define BTN_LEFT 0x110
366#define BTN_RIGHT 0x111
367#define BTN_MIDDLE 0x112
368#define BTN_SIDE 0x113
369#define BTN_EXTRA 0x114
370#define BTN_FORWARD 0x115
371#define BTN_BACK 0x116
372#define BTN_TASK 0x117
373
374#define BTN_JOYSTICK 0x120
375#define BTN_TRIGGER 0x120
376#define BTN_THUMB 0x121
377#define BTN_THUMB2 0x122
378#define BTN_TOP 0x123
379#define BTN_TOP2 0x124
380#define BTN_PINKIE 0x125
381#define BTN_BASE 0x126
382#define BTN_BASE2 0x127
383#define BTN_BASE3 0x128
384#define BTN_BASE4 0x129
385#define BTN_BASE5 0x12a
386#define BTN_BASE6 0x12b
387#define BTN_DEAD 0x12f
388
389#define BTN_GAMEPAD 0x130
390#define BTN_A 0x130
391#define BTN_B 0x131
392#define BTN_C 0x132
393#define BTN_X 0x133
394#define BTN_Y 0x134
395#define BTN_Z 0x135
396#define BTN_TL 0x136
397#define BTN_TR 0x137
398#define BTN_TL2 0x138
399#define BTN_TR2 0x139
400#define BTN_SELECT 0x13a
401#define BTN_START 0x13b
402#define BTN_MODE 0x13c
403#define BTN_THUMBL 0x13d
404#define BTN_THUMBR 0x13e
405
406#define BTN_DIGI 0x140
407#define BTN_TOOL_PEN 0x140
408#define BTN_TOOL_RUBBER 0x141
409#define BTN_TOOL_BRUSH 0x142
410#define BTN_TOOL_PENCIL 0x143
411#define BTN_TOOL_AIRBRUSH 0x144
412#define BTN_TOOL_FINGER 0x145
413#define BTN_TOOL_MOUSE 0x146
414#define BTN_TOOL_LENS 0x147
415#define BTN_TOUCH 0x14a
416#define BTN_STYLUS 0x14b
417#define BTN_STYLUS2 0x14c
418#define BTN_TOOL_DOUBLETAP 0x14d
419#define BTN_TOOL_TRIPLETAP 0x14e
420
421#define BTN_WHEEL 0x150
422#define BTN_GEAR_DOWN 0x150
423#define BTN_GEAR_UP 0x151
424
425#define KEY_OK 0x160
Dmitry Torokhov493a7e02006-03-14 00:09:05 -0500426#define KEY_SELECT 0x161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427#define KEY_GOTO 0x162
428#define KEY_CLEAR 0x163
429#define KEY_POWER2 0x164
430#define KEY_OPTION 0x165
431#define KEY_INFO 0x166
432#define KEY_TIME 0x167
433#define KEY_VENDOR 0x168
434#define KEY_ARCHIVE 0x169
435#define KEY_PROGRAM 0x16a
436#define KEY_CHANNEL 0x16b
437#define KEY_FAVORITES 0x16c
438#define KEY_EPG 0x16d
439#define KEY_PVR 0x16e
440#define KEY_MHP 0x16f
441#define KEY_LANGUAGE 0x170
442#define KEY_TITLE 0x171
443#define KEY_SUBTITLE 0x172
444#define KEY_ANGLE 0x173
445#define KEY_ZOOM 0x174
446#define KEY_MODE 0x175
447#define KEY_KEYBOARD 0x176
448#define KEY_SCREEN 0x177
449#define KEY_PC 0x178
450#define KEY_TV 0x179
451#define KEY_TV2 0x17a
452#define KEY_VCR 0x17b
453#define KEY_VCR2 0x17c
454#define KEY_SAT 0x17d
455#define KEY_SAT2 0x17e
456#define KEY_CD 0x17f
457#define KEY_TAPE 0x180
458#define KEY_RADIO 0x181
459#define KEY_TUNER 0x182
460#define KEY_PLAYER 0x183
461#define KEY_TEXT 0x184
462#define KEY_DVD 0x185
463#define KEY_AUX 0x186
464#define KEY_MP3 0x187
465#define KEY_AUDIO 0x188
466#define KEY_VIDEO 0x189
467#define KEY_DIRECTORY 0x18a
468#define KEY_LIST 0x18b
469#define KEY_MEMO 0x18c
470#define KEY_CALENDAR 0x18d
471#define KEY_RED 0x18e
472#define KEY_GREEN 0x18f
473#define KEY_YELLOW 0x190
474#define KEY_BLUE 0x191
475#define KEY_CHANNELUP 0x192
476#define KEY_CHANNELDOWN 0x193
477#define KEY_FIRST 0x194
478#define KEY_LAST 0x195
479#define KEY_AB 0x196
480#define KEY_NEXT 0x197
481#define KEY_RESTART 0x198
482#define KEY_SLOW 0x199
483#define KEY_SHUFFLE 0x19a
484#define KEY_BREAK 0x19b
485#define KEY_PREVIOUS 0x19c
486#define KEY_DIGITS 0x19d
487#define KEY_TEEN 0x19e
488#define KEY_TWEN 0x19f
489
490#define KEY_DEL_EOL 0x1c0
491#define KEY_DEL_EOS 0x1c1
492#define KEY_INS_LINE 0x1c2
493#define KEY_DEL_LINE 0x1c3
494
495#define KEY_FN 0x1d0
496#define KEY_FN_ESC 0x1d1
497#define KEY_FN_F1 0x1d2
498#define KEY_FN_F2 0x1d3
499#define KEY_FN_F3 0x1d4
500#define KEY_FN_F4 0x1d5
501#define KEY_FN_F5 0x1d6
502#define KEY_FN_F6 0x1d7
503#define KEY_FN_F7 0x1d8
504#define KEY_FN_F8 0x1d9
505#define KEY_FN_F9 0x1da
506#define KEY_FN_F10 0x1db
507#define KEY_FN_F11 0x1dc
508#define KEY_FN_F12 0x1dd
509#define KEY_FN_1 0x1de
510#define KEY_FN_2 0x1df
511#define KEY_FN_D 0x1e0
512#define KEY_FN_E 0x1e1
513#define KEY_FN_F 0x1e2
514#define KEY_FN_S 0x1e3
515#define KEY_FN_B 0x1e4
516
Samuel Thibaultb9ec4e12006-04-02 00:10:28 -0500517#define KEY_BRL_DOT1 0x1f1
518#define KEY_BRL_DOT2 0x1f2
519#define KEY_BRL_DOT3 0x1f3
520#define KEY_BRL_DOT4 0x1f4
521#define KEY_BRL_DOT5 0x1f5
522#define KEY_BRL_DOT6 0x1f6
523#define KEY_BRL_DOT7 0x1f7
524#define KEY_BRL_DOT8 0x1f8
525
Rusty Russell1d8f4302005-12-07 21:40:34 +0100526/* We avoid low common keys in module aliases so they don't get huge. */
527#define KEY_MIN_INTERESTING KEY_MUTE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528#define KEY_MAX 0x1ff
529
530/*
531 * Relative axes
532 */
533
534#define REL_X 0x00
535#define REL_Y 0x01
536#define REL_Z 0x02
537#define REL_RX 0x03
538#define REL_RY 0x04
539#define REL_RZ 0x05
540#define REL_HWHEEL 0x06
541#define REL_DIAL 0x07
542#define REL_WHEEL 0x08
543#define REL_MISC 0x09
544#define REL_MAX 0x0f
545
546/*
547 * Absolute axes
548 */
549
550#define ABS_X 0x00
551#define ABS_Y 0x01
552#define ABS_Z 0x02
553#define ABS_RX 0x03
554#define ABS_RY 0x04
555#define ABS_RZ 0x05
556#define ABS_THROTTLE 0x06
557#define ABS_RUDDER 0x07
558#define ABS_WHEEL 0x08
559#define ABS_GAS 0x09
560#define ABS_BRAKE 0x0a
561#define ABS_HAT0X 0x10
562#define ABS_HAT0Y 0x11
563#define ABS_HAT1X 0x12
564#define ABS_HAT1Y 0x13
565#define ABS_HAT2X 0x14
566#define ABS_HAT2Y 0x15
567#define ABS_HAT3X 0x16
568#define ABS_HAT3Y 0x17
569#define ABS_PRESSURE 0x18
570#define ABS_DISTANCE 0x19
571#define ABS_TILT_X 0x1a
572#define ABS_TILT_Y 0x1b
573#define ABS_TOOL_WIDTH 0x1c
574#define ABS_VOLUME 0x20
575#define ABS_MISC 0x28
576#define ABS_MAX 0x3f
577
578/*
Richard Purdie31581062005-09-06 15:19:06 -0700579 * Switch events
580 */
581
Richard Purdieed8f9e22006-05-29 23:31:03 -0400582#define SW_LID 0x00 /* set = lid shut */
583#define SW_TABLET_MODE 0x01 /* set = tablet mode */
584#define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
Dmitry Torokhovddc5d342006-04-26 00:14:19 -0400585#define SW_MAX 0x0f
Richard Purdie31581062005-09-06 15:19:06 -0700586
587/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 * Misc events
589 */
590
591#define MSC_SERIAL 0x00
592#define MSC_PULSELED 0x01
593#define MSC_GESTURE 0x02
594#define MSC_RAW 0x03
595#define MSC_SCAN 0x04
596#define MSC_MAX 0x07
597
598/*
599 * LEDs
600 */
601
602#define LED_NUML 0x00
603#define LED_CAPSL 0x01
604#define LED_SCROLLL 0x02
605#define LED_COMPOSE 0x03
606#define LED_KANA 0x04
607#define LED_SLEEP 0x05
608#define LED_SUSPEND 0x06
609#define LED_MUTE 0x07
610#define LED_MISC 0x08
611#define LED_MAIL 0x09
612#define LED_CHARGING 0x0a
613#define LED_MAX 0x0f
614
615/*
616 * Autorepeat values
617 */
618
619#define REP_DELAY 0x00
620#define REP_PERIOD 0x01
621#define REP_MAX 0x01
622
623/*
624 * Sounds
625 */
626
627#define SND_CLICK 0x00
628#define SND_BELL 0x01
629#define SND_TONE 0x02
630#define SND_MAX 0x07
631
632/*
633 * IDs.
634 */
635
636#define ID_BUS 0
637#define ID_VENDOR 1
638#define ID_PRODUCT 2
639#define ID_VERSION 3
640
641#define BUS_PCI 0x01
642#define BUS_ISAPNP 0x02
643#define BUS_USB 0x03
644#define BUS_HIL 0x04
645#define BUS_BLUETOOTH 0x05
646
647#define BUS_ISA 0x10
648#define BUS_I8042 0x11
649#define BUS_XTKBD 0x12
650#define BUS_RS232 0x13
651#define BUS_GAMEPORT 0x14
652#define BUS_PARPORT 0x15
653#define BUS_AMIGA 0x16
654#define BUS_ADB 0x17
655#define BUS_I2C 0x18
656#define BUS_HOST 0x19
Matthew Wilcox6ab0f5c2005-10-21 22:58:51 -0400657#define BUS_GSC 0x1A
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
659/*
660 * Values describing the status of an effect
661 */
662#define FF_STATUS_STOPPED 0x00
663#define FF_STATUS_PLAYING 0x01
664#define FF_STATUS_MAX 0x01
665
666/*
667 * Structures used in ioctls to upload effects to a device
668 * The first structures are not passed directly by using ioctls.
669 * They are sub-structures of the actually sent structure (called ff_effect)
670 */
671
672struct ff_replay {
673 __u16 length; /* Duration of an effect in ms. All other times are also expressed in ms */
674 __u16 delay; /* Time to wait before to start playing an effect */
675};
676
677struct ff_trigger {
678 __u16 button; /* Number of button triggering an effect */
679 __u16 interval; /* Time to wait before an effect can be re-triggered (ms) */
680};
681
682struct ff_envelope {
683 __u16 attack_length; /* Duration of attack (ms) */
684 __u16 attack_level; /* Level at beginning of attack */
685 __u16 fade_length; /* Duration of fade (ms) */
686 __u16 fade_level; /* Level at end of fade */
687};
688
689/* FF_CONSTANT */
690struct ff_constant_effect {
691 __s16 level; /* Strength of effect. Negative values are OK */
692 struct ff_envelope envelope;
693};
694
695/* FF_RAMP */
696struct ff_ramp_effect {
697 __s16 start_level;
698 __s16 end_level;
699 struct ff_envelope envelope;
700};
701
702/* FF_SPRING of FF_FRICTION */
703struct ff_condition_effect {
704 __u16 right_saturation; /* Max level when joystick is on the right */
705 __u16 left_saturation; /* Max level when joystick in on the left */
706
707 __s16 right_coeff; /* Indicates how fast the force grows when the
708 joystick moves to the right */
709 __s16 left_coeff; /* Same for left side */
710
711 __u16 deadband; /* Size of area where no force is produced */
712 __s16 center; /* Position of dead zone */
713
714};
715
716/* FF_PERIODIC */
717struct ff_periodic_effect {
718 __u16 waveform; /* Kind of wave (sine, square...) */
719 __u16 period; /* in ms */
720 __s16 magnitude; /* Peak value */
721 __s16 offset; /* Mean value of wave (roughly) */
722 __u16 phase; /* 'Horizontal' shift */
723
724 struct ff_envelope envelope;
725
726/* Only used if waveform == FF_CUSTOM */
727 __u32 custom_len; /* Number of samples */
728 __s16 *custom_data; /* Buffer of samples */
729/* Note: the data pointed by custom_data is copied by the driver. You can
730 * therefore dispose of the memory after the upload/update */
731};
732
733/* FF_RUMBLE */
734/* Some rumble pads have two motors of different weight.
735 strong_magnitude represents the magnitude of the vibration generated
736 by the heavy motor.
737*/
738struct ff_rumble_effect {
739 __u16 strong_magnitude; /* Magnitude of the heavy motor */
740 __u16 weak_magnitude; /* Magnitude of the light one */
741};
742
743/*
744 * Structure sent through ioctl from the application to the driver
745 */
746struct ff_effect {
747 __u16 type;
748/* Following field denotes the unique id assigned to an effect.
749 * If user sets if to -1, a new effect is created, and its id is returned in the same field
750 * Else, the user sets it to the effect id it wants to update.
751 */
752 __s16 id;
753
754 __u16 direction; /* Direction. 0 deg -> 0x0000 (down)
755 90 deg -> 0x4000 (left)
756 180 deg -> 0x8000 (up)
757 270 deg -> 0xC000 (right)
758 */
759
760 struct ff_trigger trigger;
761 struct ff_replay replay;
762
763 union {
764 struct ff_constant_effect constant;
765 struct ff_ramp_effect ramp;
766 struct ff_periodic_effect periodic;
767 struct ff_condition_effect condition[2]; /* One for each axis */
768 struct ff_rumble_effect rumble;
769 } u;
770};
771
772/*
773 * Force feedback effect types
774 */
775
776#define FF_RUMBLE 0x50
777#define FF_PERIODIC 0x51
778#define FF_CONSTANT 0x52
779#define FF_SPRING 0x53
780#define FF_FRICTION 0x54
781#define FF_DAMPER 0x55
782#define FF_INERTIA 0x56
783#define FF_RAMP 0x57
784
785/*
786 * Force feedback periodic effect types
787 */
788
789#define FF_SQUARE 0x58
790#define FF_TRIANGLE 0x59
791#define FF_SINE 0x5a
792#define FF_SAW_UP 0x5b
793#define FF_SAW_DOWN 0x5c
794#define FF_CUSTOM 0x5d
795
796/*
797 * Set ff device properties
798 */
799
800#define FF_GAIN 0x60
801#define FF_AUTOCENTER 0x61
802
803#define FF_MAX 0x7f
804
805#ifdef __KERNEL__
806
807/*
808 * In-kernel definitions.
809 */
810
Dmitry Torokhovddc5d342006-04-26 00:14:19 -0400811#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812#include <linux/fs.h>
813#include <linux/timer.h>
Dmitry Torokhovddc5d342006-04-26 00:14:19 -0400814#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816#define NBITS(x) (((x)/BITS_PER_LONG)+1)
817#define BIT(x) (1UL<<((x)%BITS_PER_LONG))
818#define LONG(x) ((x)/BITS_PER_LONG)
819
820#define INPUT_KEYCODE(dev, scancode) ((dev->keycodesize == 1) ? ((u8*)dev->keycode)[scancode] : \
821 ((dev->keycodesize == 2) ? ((u16*)dev->keycode)[scancode] : (((u32*)dev->keycode)[scancode])))
822
823#define SET_INPUT_KEYCODE(dev, scancode, val) \
824 ({ unsigned __old; \
825 switch (dev->keycodesize) { \
826 case 1: { \
827 u8 *k = (u8 *)dev->keycode; \
828 __old = k[scancode]; \
829 k[scancode] = val; \
830 break; \
831 } \
832 case 2: { \
833 u16 *k = (u16 *)dev->keycode; \
834 __old = k[scancode]; \
835 k[scancode] = val; \
836 break; \
837 } \
838 default: { \
839 u32 *k = (u32 *)dev->keycode; \
840 __old = k[scancode]; \
841 k[scancode] = val; \
842 break; \
843 } \
844 } \
845 __old; })
846
847struct input_dev {
848
849 void *private;
850
Dmitry Torokhov5b6271b2005-06-30 00:50:38 -0500851 const char *name;
852 const char *phys;
853 const char *uniq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 struct input_id id;
855
856 unsigned long evbit[NBITS(EV_MAX)];
857 unsigned long keybit[NBITS(KEY_MAX)];
858 unsigned long relbit[NBITS(REL_MAX)];
859 unsigned long absbit[NBITS(ABS_MAX)];
860 unsigned long mscbit[NBITS(MSC_MAX)];
861 unsigned long ledbit[NBITS(LED_MAX)];
862 unsigned long sndbit[NBITS(SND_MAX)];
863 unsigned long ffbit[NBITS(FF_MAX)];
Richard Purdie31581062005-09-06 15:19:06 -0700864 unsigned long swbit[NBITS(SW_MAX)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 int ff_effects_max;
866
867 unsigned int keycodemax;
868 unsigned int keycodesize;
869 void *keycode;
870
871 unsigned int repeat_key;
872 struct timer_list timer;
873
874 struct pt_regs *regs;
875 int state;
876
877 int sync;
878
879 int abs[ABS_MAX + 1];
880 int rep[REP_MAX + 1];
881
882 unsigned long key[NBITS(KEY_MAX)];
883 unsigned long led[NBITS(LED_MAX)];
884 unsigned long snd[NBITS(SND_MAX)];
Richard Purdie31581062005-09-06 15:19:06 -0700885 unsigned long sw[NBITS(SW_MAX)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
887 int absmax[ABS_MAX + 1];
888 int absmin[ABS_MAX + 1];
889 int absfuzz[ABS_MAX + 1];
890 int absflat[ABS_MAX + 1];
891
892 int (*open)(struct input_dev *dev);
893 void (*close)(struct input_dev *dev);
894 int (*accept)(struct input_dev *dev, struct file *file);
895 int (*flush)(struct input_dev *dev, struct file *file);
896 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
897 int (*upload_effect)(struct input_dev *dev, struct ff_effect *effect);
898 int (*erase_effect)(struct input_dev *dev, int effect_id);
899
900 struct input_handle *grab;
Dmitry Torokhov0fbf87c2005-05-29 02:29:25 -0500901
Jes Sorensene676c232006-02-19 00:21:46 -0500902 struct mutex mutex; /* serializes open and close operations */
Dmitry Torokhov0fbf87c2005-05-29 02:29:25 -0500903 unsigned int users;
904
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -0500905 struct class_device cdev;
906 struct device *dev; /* will be removed soon */
907
908 int dynalloc; /* temporarily */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
910 struct list_head h_list;
911 struct list_head node;
912};
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -0500913#define to_input_dev(d) container_of(d, struct input_dev, cdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Dmitry Torokhovddc5d342006-04-26 00:14:19 -0400915/*
916 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
917 */
918
919#if EV_MAX != INPUT_DEVICE_ID_EV_MAX
920#error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
921#endif
922
923#if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
924#error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
925#endif
926
927#if REL_MAX != INPUT_DEVICE_ID_REL_MAX
928#error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
929#endif
930
931#if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
932#error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
933#endif
934
935#if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
936#error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
937#endif
938
939#if LED_MAX != INPUT_DEVICE_ID_LED_MAX
940#error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
941#endif
942
943#if SND_MAX != INPUT_DEVICE_ID_SND_MAX
944#error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
945#endif
946
947#if FF_MAX != INPUT_DEVICE_ID_FF_MAX
948#error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
949#endif
950
951#if SW_MAX != INPUT_DEVICE_ID_SW_MAX
952#error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
953#endif
954
955#define INPUT_DEVICE_ID_MATCH_DEVICE \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
Dmitry Torokhovddc5d342006-04-26 00:14:19 -0400957#define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960struct input_handle;
961
962struct input_handler {
963
964 void *private;
965
966 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
967 struct input_handle* (*connect)(struct input_handler *handler, struct input_dev *dev, struct input_device_id *id);
968 void (*disconnect)(struct input_handle *handle);
969
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800970 const struct file_operations *fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 int minor;
972 char *name;
973
974 struct input_device_id *id_table;
975 struct input_device_id *blacklist;
976
977 struct list_head h_list;
978 struct list_head node;
979};
980
981struct input_handle {
982
983 void *private;
984
985 int open;
986 char *name;
987
988 struct input_dev *dev;
989 struct input_handler *handler;
990
991 struct list_head d_node;
992 struct list_head h_node;
993};
994
995#define to_dev(n) container_of(n,struct input_dev,node)
996#define to_handler(n) container_of(n,struct input_handler,node);
997#define to_handle(n) container_of(n,struct input_handle,d_node)
998#define to_handle_h(n) container_of(n,struct input_handle,h_node)
999
1000static inline void init_input_dev(struct input_dev *dev)
1001{
1002 INIT_LIST_HEAD(&dev->h_list);
1003 INIT_LIST_HEAD(&dev->node);
1004}
1005
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001006struct input_dev *input_allocate_device(void);
1007
Dmitry Torokhovd19fbe82005-09-15 02:01:39 -05001008static inline struct input_dev *input_get_device(struct input_dev *dev)
1009{
1010 return to_input_dev(class_device_get(&dev->cdev));
1011}
1012
1013static inline void input_put_device(struct input_dev *dev)
1014{
1015 class_device_put(&dev->cdev);
1016}
1017
Dmitry Torokhov493a7e02006-03-14 00:09:05 -05001018static inline void input_free_device(struct input_dev *dev)
1019{
Dmitry Torokhov1a0ccec2006-04-26 00:13:57 -04001020 if (dev)
1021 input_put_device(dev);
Dmitry Torokhov493a7e02006-03-14 00:09:05 -05001022}
1023
Dmitry Torokhov5f945482005-11-02 22:51:46 -05001024int input_register_device(struct input_dev *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025void input_unregister_device(struct input_dev *);
1026
1027void input_register_handler(struct input_handler *);
1028void input_unregister_handler(struct input_handler *);
1029
1030int input_grab_device(struct input_handle *);
1031void input_release_device(struct input_handle *);
1032
1033int input_open_device(struct input_handle *);
1034void input_close_device(struct input_handle *);
1035
1036int input_accept_process(struct input_handle *handle, struct file *file);
1037int input_flush_device(struct input_handle* handle, struct file* file);
1038
1039void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1040
1041static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1042{
1043 input_event(dev, EV_KEY, code, !!value);
1044}
1045
1046static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1047{
1048 input_event(dev, EV_REL, code, value);
1049}
1050
1051static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1052{
1053 input_event(dev, EV_ABS, code, value);
1054}
1055
1056static inline void input_report_ff(struct input_dev *dev, unsigned int code, int value)
1057{
1058 input_event(dev, EV_FF, code, value);
1059}
1060
1061static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1062{
1063 input_event(dev, EV_FF_STATUS, code, value);
1064}
1065
Richard Purdie31581062005-09-06 15:19:06 -07001066static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1067{
1068 input_event(dev, EV_SW, code, !!value);
1069}
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071static inline void input_regs(struct input_dev *dev, struct pt_regs *regs)
1072{
1073 dev->regs = regs;
1074}
1075
1076static inline void input_sync(struct input_dev *dev)
1077{
1078 input_event(dev, EV_SYN, SYN_REPORT, 0);
1079 dev->regs = NULL;
1080}
1081
1082static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1083{
1084 dev->absmin[axis] = min;
1085 dev->absmax[axis] = max;
1086 dev->absfuzz[axis] = fuzz;
1087 dev->absflat[axis] = flat;
1088
1089 dev->absbit[LONG(axis)] |= BIT(axis);
1090}
1091
Greg Kroah-Hartmanea9f2402005-10-27 22:25:43 -07001092extern struct class input_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
1094#endif
1095#endif