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