m68knommu: fix definition of MCFDMA_DIR_INV
[linux-2.6/libata-dev.git] / include / linux / input.h
blobe02c6a66b2ba74fecdb015b202933541dc3f5257
1 #ifndef _INPUT_H
2 #define _INPUT_H
4 /*
5 * Copyright (c) 1999-2002 Vojtech Pavlik
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.
12 #ifdef __KERNEL__
13 #include <linux/time.h>
14 #include <linux/list.h>
15 #else
16 #include <sys/time.h>
17 #include <sys/ioctl.h>
18 #include <sys/types.h>
19 #include <asm/types.h>
20 #endif
23 * The event structure itself
26 struct input_event {
27 struct timeval time;
28 __u16 type;
29 __u16 code;
30 __s32 value;
34 * Protocol version.
37 #define EV_VERSION 0x010000
40 * IOCTLs (0x00 - 0x7f)
43 struct input_id {
44 __u16 bustype;
45 __u16 vendor;
46 __u16 product;
47 __u16 version;
50 struct input_absinfo {
51 __s32 value;
52 __s32 minimum;
53 __s32 maximum;
54 __s32 fuzz;
55 __s32 flat;
58 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
59 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
60 #define EVIOCGREP _IOR('E', 0x03, int[2]) /* get repeat settings */
61 #define EVIOCSREP _IOW('E', 0x03, int[2]) /* set repeat settings */
62 #define EVIOCGKEYCODE _IOR('E', 0x04, int[2]) /* get keycode */
63 #define EVIOCSKEYCODE _IOW('E', 0x04, int[2]) /* set keycode */
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 */
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 */
72 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
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 */
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 */
82 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
85 * Event types
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
93 #define EV_SW 0x05
94 #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
103 * Synchronization events.
106 #define SYN_REPORT 0
107 #define SYN_CONFIG 1
110 * Keys and buttons
112 * Most of the keys/buttons are modeled after USB HUT 1.12
113 * (see http://www.usb.org/developers/hidpage).
114 * Abbreviations in the comments:
115 * AC - Application Control
116 * AL - Application Launch Button
117 * SC - System Control
120 #define KEY_RESERVED 0
121 #define KEY_ESC 1
122 #define KEY_1 2
123 #define KEY_2 3
124 #define KEY_3 4
125 #define KEY_4 5
126 #define KEY_5 6
127 #define KEY_6 7
128 #define KEY_7 8
129 #define KEY_8 9
130 #define KEY_9 10
131 #define KEY_0 11
132 #define KEY_MINUS 12
133 #define KEY_EQUAL 13
134 #define KEY_BACKSPACE 14
135 #define KEY_TAB 15
136 #define KEY_Q 16
137 #define KEY_W 17
138 #define KEY_E 18
139 #define KEY_R 19
140 #define KEY_T 20
141 #define KEY_Y 21
142 #define KEY_U 22
143 #define KEY_I 23
144 #define KEY_O 24
145 #define KEY_P 25
146 #define KEY_LEFTBRACE 26
147 #define KEY_RIGHTBRACE 27
148 #define KEY_ENTER 28
149 #define KEY_LEFTCTRL 29
150 #define KEY_A 30
151 #define KEY_S 31
152 #define KEY_D 32
153 #define KEY_F 33
154 #define KEY_G 34
155 #define KEY_H 35
156 #define KEY_J 36
157 #define KEY_K 37
158 #define KEY_L 38
159 #define KEY_SEMICOLON 39
160 #define KEY_APOSTROPHE 40
161 #define KEY_GRAVE 41
162 #define KEY_LEFTSHIFT 42
163 #define KEY_BACKSLASH 43
164 #define KEY_Z 44
165 #define KEY_X 45
166 #define KEY_C 46
167 #define KEY_V 47
168 #define KEY_B 48
169 #define KEY_N 49
170 #define KEY_M 50
171 #define KEY_COMMA 51
172 #define KEY_DOT 52
173 #define KEY_SLASH 53
174 #define KEY_RIGHTSHIFT 54
175 #define KEY_KPASTERISK 55
176 #define KEY_LEFTALT 56
177 #define KEY_SPACE 57
178 #define KEY_CAPSLOCK 58
179 #define KEY_F1 59
180 #define KEY_F2 60
181 #define KEY_F3 61
182 #define KEY_F4 62
183 #define KEY_F5 63
184 #define KEY_F6 64
185 #define KEY_F7 65
186 #define KEY_F8 66
187 #define KEY_F9 67
188 #define KEY_F10 68
189 #define KEY_NUMLOCK 69
190 #define KEY_SCROLLLOCK 70
191 #define KEY_KP7 71
192 #define KEY_KP8 72
193 #define KEY_KP9 73
194 #define KEY_KPMINUS 74
195 #define KEY_KP4 75
196 #define KEY_KP5 76
197 #define KEY_KP6 77
198 #define KEY_KPPLUS 78
199 #define KEY_KP1 79
200 #define KEY_KP2 80
201 #define KEY_KP3 81
202 #define KEY_KP0 82
203 #define KEY_KPDOT 83
205 #define KEY_ZENKAKUHANKAKU 85
206 #define KEY_102ND 86
207 #define KEY_F11 87
208 #define KEY_F12 88
209 #define KEY_RO 89
210 #define KEY_KATAKANA 90
211 #define KEY_HIRAGANA 91
212 #define KEY_HENKAN 92
213 #define KEY_KATAKANAHIRAGANA 93
214 #define KEY_MUHENKAN 94
215 #define KEY_KPJPCOMMA 95
216 #define KEY_KPENTER 96
217 #define KEY_RIGHTCTRL 97
218 #define KEY_KPSLASH 98
219 #define KEY_SYSRQ 99
220 #define KEY_RIGHTALT 100
221 #define KEY_LINEFEED 101
222 #define KEY_HOME 102
223 #define KEY_UP 103
224 #define KEY_PAGEUP 104
225 #define KEY_LEFT 105
226 #define KEY_RIGHT 106
227 #define KEY_END 107
228 #define KEY_DOWN 108
229 #define KEY_PAGEDOWN 109
230 #define KEY_INSERT 110
231 #define KEY_DELETE 111
232 #define KEY_MACRO 112
233 #define KEY_MUTE 113
234 #define KEY_VOLUMEDOWN 114
235 #define KEY_VOLUMEUP 115
236 #define KEY_POWER 116 /* SC System Power Down */
237 #define KEY_KPEQUAL 117
238 #define KEY_KPPLUSMINUS 118
239 #define KEY_PAUSE 119
241 #define KEY_KPCOMMA 121
242 #define KEY_HANGEUL 122
243 #define KEY_HANGUEL KEY_HANGEUL
244 #define KEY_HANJA 123
245 #define KEY_YEN 124
246 #define KEY_LEFTMETA 125
247 #define KEY_RIGHTMETA 126
248 #define KEY_COMPOSE 127
250 #define KEY_STOP 128 /* AC Stop */
251 #define KEY_AGAIN 129
252 #define KEY_PROPS 130 /* AC Properties */
253 #define KEY_UNDO 131 /* AC Undo */
254 #define KEY_FRONT 132
255 #define KEY_COPY 133 /* AC Copy */
256 #define KEY_OPEN 134 /* AC Open */
257 #define KEY_PASTE 135 /* AC Paste */
258 #define KEY_FIND 136 /* AC Search */
259 #define KEY_CUT 137 /* AC Cut */
260 #define KEY_HELP 138 /* AL Integrated Help Center */
261 #define KEY_MENU 139 /* Menu (show menu) */
262 #define KEY_CALC 140 /* AL Calculator */
263 #define KEY_SETUP 141
264 #define KEY_SLEEP 142 /* SC System Sleep */
265 #define KEY_WAKEUP 143 /* System Wake Up */
266 #define KEY_FILE 144 /* AL Local Machine Browser */
267 #define KEY_SENDFILE 145
268 #define KEY_DELETEFILE 146
269 #define KEY_XFER 147
270 #define KEY_PROG1 148
271 #define KEY_PROG2 149
272 #define KEY_WWW 150 /* AL Internet Browser */
273 #define KEY_MSDOS 151
274 #define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */
275 #define KEY_SCREENLOCK KEY_COFFEE
276 #define KEY_DIRECTION 153
277 #define KEY_CYCLEWINDOWS 154
278 #define KEY_MAIL 155
279 #define KEY_BOOKMARKS 156 /* AC Bookmarks */
280 #define KEY_COMPUTER 157
281 #define KEY_BACK 158 /* AC Back */
282 #define KEY_FORWARD 159 /* AC Forward */
283 #define KEY_CLOSECD 160
284 #define KEY_EJECTCD 161
285 #define KEY_EJECTCLOSECD 162
286 #define KEY_NEXTSONG 163
287 #define KEY_PLAYPAUSE 164
288 #define KEY_PREVIOUSSONG 165
289 #define KEY_STOPCD 166
290 #define KEY_RECORD 167
291 #define KEY_REWIND 168
292 #define KEY_PHONE 169 /* Media Select Telephone */
293 #define KEY_ISO 170
294 #define KEY_CONFIG 171 /* AL Consumer Control Configuration */
295 #define KEY_HOMEPAGE 172 /* AC Home */
296 #define KEY_REFRESH 173 /* AC Refresh */
297 #define KEY_EXIT 174 /* AC Exit */
298 #define KEY_MOVE 175
299 #define KEY_EDIT 176
300 #define KEY_SCROLLUP 177
301 #define KEY_SCROLLDOWN 178
302 #define KEY_KPLEFTPAREN 179
303 #define KEY_KPRIGHTPAREN 180
304 #define KEY_NEW 181 /* AC New */
305 #define KEY_REDO 182 /* AC Redo/Repeat */
307 #define KEY_F13 183
308 #define KEY_F14 184
309 #define KEY_F15 185
310 #define KEY_F16 186
311 #define KEY_F17 187
312 #define KEY_F18 188
313 #define KEY_F19 189
314 #define KEY_F20 190
315 #define KEY_F21 191
316 #define KEY_F22 192
317 #define KEY_F23 193
318 #define KEY_F24 194
320 #define KEY_PLAYCD 200
321 #define KEY_PAUSECD 201
322 #define KEY_PROG3 202
323 #define KEY_PROG4 203
324 #define KEY_SUSPEND 205
325 #define KEY_CLOSE 206 /* AC Close */
326 #define KEY_PLAY 207
327 #define KEY_FASTFORWARD 208
328 #define KEY_BASSBOOST 209
329 #define KEY_PRINT 210 /* AC Print */
330 #define KEY_HP 211
331 #define KEY_CAMERA 212
332 #define KEY_SOUND 213
333 #define KEY_QUESTION 214
334 #define KEY_EMAIL 215
335 #define KEY_CHAT 216
336 #define KEY_SEARCH 217
337 #define KEY_CONNECT 218
338 #define KEY_FINANCE 219 /* AL Checkbook/Finance */
339 #define KEY_SPORT 220
340 #define KEY_SHOP 221
341 #define KEY_ALTERASE 222
342 #define KEY_CANCEL 223 /* AC Cancel */
343 #define KEY_BRIGHTNESSDOWN 224
344 #define KEY_BRIGHTNESSUP 225
345 #define KEY_MEDIA 226
347 #define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video
348 outputs (Monitor/LCD/TV-out/etc) */
349 #define KEY_KBDILLUMTOGGLE 228
350 #define KEY_KBDILLUMDOWN 229
351 #define KEY_KBDILLUMUP 230
353 #define KEY_SEND 231 /* AC Send */
354 #define KEY_REPLY 232 /* AC Reply */
355 #define KEY_FORWARDMAIL 233 /* AC Forward Msg */
356 #define KEY_SAVE 234 /* AC Save */
357 #define KEY_DOCUMENTS 235
359 #define KEY_BATTERY 236
361 #define KEY_BLUETOOTH 237
362 #define KEY_WLAN 238
364 #define KEY_UNKNOWN 240
366 #define BTN_MISC 0x100
367 #define BTN_0 0x100
368 #define BTN_1 0x101
369 #define BTN_2 0x102
370 #define BTN_3 0x103
371 #define BTN_4 0x104
372 #define BTN_5 0x105
373 #define BTN_6 0x106
374 #define BTN_7 0x107
375 #define BTN_8 0x108
376 #define BTN_9 0x109
378 #define BTN_MOUSE 0x110
379 #define BTN_LEFT 0x110
380 #define BTN_RIGHT 0x111
381 #define BTN_MIDDLE 0x112
382 #define BTN_SIDE 0x113
383 #define BTN_EXTRA 0x114
384 #define BTN_FORWARD 0x115
385 #define BTN_BACK 0x116
386 #define BTN_TASK 0x117
388 #define BTN_JOYSTICK 0x120
389 #define BTN_TRIGGER 0x120
390 #define BTN_THUMB 0x121
391 #define BTN_THUMB2 0x122
392 #define BTN_TOP 0x123
393 #define BTN_TOP2 0x124
394 #define BTN_PINKIE 0x125
395 #define BTN_BASE 0x126
396 #define BTN_BASE2 0x127
397 #define BTN_BASE3 0x128
398 #define BTN_BASE4 0x129
399 #define BTN_BASE5 0x12a
400 #define BTN_BASE6 0x12b
401 #define BTN_DEAD 0x12f
403 #define BTN_GAMEPAD 0x130
404 #define BTN_A 0x130
405 #define BTN_B 0x131
406 #define BTN_C 0x132
407 #define BTN_X 0x133
408 #define BTN_Y 0x134
409 #define BTN_Z 0x135
410 #define BTN_TL 0x136
411 #define BTN_TR 0x137
412 #define BTN_TL2 0x138
413 #define BTN_TR2 0x139
414 #define BTN_SELECT 0x13a
415 #define BTN_START 0x13b
416 #define BTN_MODE 0x13c
417 #define BTN_THUMBL 0x13d
418 #define BTN_THUMBR 0x13e
420 #define BTN_DIGI 0x140
421 #define BTN_TOOL_PEN 0x140
422 #define BTN_TOOL_RUBBER 0x141
423 #define BTN_TOOL_BRUSH 0x142
424 #define BTN_TOOL_PENCIL 0x143
425 #define BTN_TOOL_AIRBRUSH 0x144
426 #define BTN_TOOL_FINGER 0x145
427 #define BTN_TOOL_MOUSE 0x146
428 #define BTN_TOOL_LENS 0x147
429 #define BTN_TOUCH 0x14a
430 #define BTN_STYLUS 0x14b
431 #define BTN_STYLUS2 0x14c
432 #define BTN_TOOL_DOUBLETAP 0x14d
433 #define BTN_TOOL_TRIPLETAP 0x14e
435 #define BTN_WHEEL 0x150
436 #define BTN_GEAR_DOWN 0x150
437 #define BTN_GEAR_UP 0x151
439 #define KEY_OK 0x160
440 #define KEY_SELECT 0x161
441 #define KEY_GOTO 0x162
442 #define KEY_CLEAR 0x163
443 #define KEY_POWER2 0x164
444 #define KEY_OPTION 0x165
445 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
446 #define KEY_TIME 0x167
447 #define KEY_VENDOR 0x168
448 #define KEY_ARCHIVE 0x169
449 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */
450 #define KEY_CHANNEL 0x16b
451 #define KEY_FAVORITES 0x16c
452 #define KEY_EPG 0x16d
453 #define KEY_PVR 0x16e /* Media Select Home */
454 #define KEY_MHP 0x16f
455 #define KEY_LANGUAGE 0x170
456 #define KEY_TITLE 0x171
457 #define KEY_SUBTITLE 0x172
458 #define KEY_ANGLE 0x173
459 #define KEY_ZOOM 0x174
460 #define KEY_MODE 0x175
461 #define KEY_KEYBOARD 0x176
462 #define KEY_SCREEN 0x177
463 #define KEY_PC 0x178 /* Media Select Computer */
464 #define KEY_TV 0x179 /* Media Select TV */
465 #define KEY_TV2 0x17a /* Media Select Cable */
466 #define KEY_VCR 0x17b /* Media Select VCR */
467 #define KEY_VCR2 0x17c /* VCR Plus */
468 #define KEY_SAT 0x17d /* Media Select Satellite */
469 #define KEY_SAT2 0x17e
470 #define KEY_CD 0x17f /* Media Select CD */
471 #define KEY_TAPE 0x180 /* Media Select Tape */
472 #define KEY_RADIO 0x181
473 #define KEY_TUNER 0x182 /* Media Select Tuner */
474 #define KEY_PLAYER 0x183
475 #define KEY_TEXT 0x184
476 #define KEY_DVD 0x185 /* Media Select DVD */
477 #define KEY_AUX 0x186
478 #define KEY_MP3 0x187
479 #define KEY_AUDIO 0x188
480 #define KEY_VIDEO 0x189
481 #define KEY_DIRECTORY 0x18a
482 #define KEY_LIST 0x18b
483 #define KEY_MEMO 0x18c /* Media Select Messages */
484 #define KEY_CALENDAR 0x18d
485 #define KEY_RED 0x18e
486 #define KEY_GREEN 0x18f
487 #define KEY_YELLOW 0x190
488 #define KEY_BLUE 0x191
489 #define KEY_CHANNELUP 0x192 /* Channel Increment */
490 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
491 #define KEY_FIRST 0x194
492 #define KEY_LAST 0x195 /* Recall Last */
493 #define KEY_AB 0x196
494 #define KEY_NEXT 0x197
495 #define KEY_RESTART 0x198
496 #define KEY_SLOW 0x199
497 #define KEY_SHUFFLE 0x19a
498 #define KEY_BREAK 0x19b
499 #define KEY_PREVIOUS 0x19c
500 #define KEY_DIGITS 0x19d
501 #define KEY_TEEN 0x19e
502 #define KEY_TWEN 0x19f
503 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
504 #define KEY_GAMES 0x1a1 /* Media Select Games */
505 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
506 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
507 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
508 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
509 #define KEY_EDITOR 0x1a6 /* AL Text Editor */
510 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
511 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
512 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
513 #define KEY_DATABASE 0x1aa /* AL Database App */
514 #define KEY_NEWS 0x1ab /* AL Newsreader */
515 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
516 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
517 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
518 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
520 #define KEY_DEL_EOL 0x1c0
521 #define KEY_DEL_EOS 0x1c1
522 #define KEY_INS_LINE 0x1c2
523 #define KEY_DEL_LINE 0x1c3
525 #define KEY_FN 0x1d0
526 #define KEY_FN_ESC 0x1d1
527 #define KEY_FN_F1 0x1d2
528 #define KEY_FN_F2 0x1d3
529 #define KEY_FN_F3 0x1d4
530 #define KEY_FN_F4 0x1d5
531 #define KEY_FN_F5 0x1d6
532 #define KEY_FN_F6 0x1d7
533 #define KEY_FN_F7 0x1d8
534 #define KEY_FN_F8 0x1d9
535 #define KEY_FN_F9 0x1da
536 #define KEY_FN_F10 0x1db
537 #define KEY_FN_F11 0x1dc
538 #define KEY_FN_F12 0x1dd
539 #define KEY_FN_1 0x1de
540 #define KEY_FN_2 0x1df
541 #define KEY_FN_D 0x1e0
542 #define KEY_FN_E 0x1e1
543 #define KEY_FN_F 0x1e2
544 #define KEY_FN_S 0x1e3
545 #define KEY_FN_B 0x1e4
547 #define KEY_BRL_DOT1 0x1f1
548 #define KEY_BRL_DOT2 0x1f2
549 #define KEY_BRL_DOT3 0x1f3
550 #define KEY_BRL_DOT4 0x1f4
551 #define KEY_BRL_DOT5 0x1f5
552 #define KEY_BRL_DOT6 0x1f6
553 #define KEY_BRL_DOT7 0x1f7
554 #define KEY_BRL_DOT8 0x1f8
556 /* We avoid low common keys in module aliases so they don't get huge. */
557 #define KEY_MIN_INTERESTING KEY_MUTE
558 #define KEY_MAX 0x1ff
561 * Relative axes
564 #define REL_X 0x00
565 #define REL_Y 0x01
566 #define REL_Z 0x02
567 #define REL_RX 0x03
568 #define REL_RY 0x04
569 #define REL_RZ 0x05
570 #define REL_HWHEEL 0x06
571 #define REL_DIAL 0x07
572 #define REL_WHEEL 0x08
573 #define REL_MISC 0x09
574 #define REL_MAX 0x0f
577 * Absolute axes
580 #define ABS_X 0x00
581 #define ABS_Y 0x01
582 #define ABS_Z 0x02
583 #define ABS_RX 0x03
584 #define ABS_RY 0x04
585 #define ABS_RZ 0x05
586 #define ABS_THROTTLE 0x06
587 #define ABS_RUDDER 0x07
588 #define ABS_WHEEL 0x08
589 #define ABS_GAS 0x09
590 #define ABS_BRAKE 0x0a
591 #define ABS_HAT0X 0x10
592 #define ABS_HAT0Y 0x11
593 #define ABS_HAT1X 0x12
594 #define ABS_HAT1Y 0x13
595 #define ABS_HAT2X 0x14
596 #define ABS_HAT2Y 0x15
597 #define ABS_HAT3X 0x16
598 #define ABS_HAT3Y 0x17
599 #define ABS_PRESSURE 0x18
600 #define ABS_DISTANCE 0x19
601 #define ABS_TILT_X 0x1a
602 #define ABS_TILT_Y 0x1b
603 #define ABS_TOOL_WIDTH 0x1c
604 #define ABS_VOLUME 0x20
605 #define ABS_MISC 0x28
606 #define ABS_MAX 0x3f
609 * Switch events
612 #define SW_LID 0x00 /* set = lid shut */
613 #define SW_TABLET_MODE 0x01 /* set = tablet mode */
614 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
615 #define SW_RADIO 0x03 /* set = radio enabled */
616 #define SW_MAX 0x0f
619 * Misc events
622 #define MSC_SERIAL 0x00
623 #define MSC_PULSELED 0x01
624 #define MSC_GESTURE 0x02
625 #define MSC_RAW 0x03
626 #define MSC_SCAN 0x04
627 #define MSC_MAX 0x07
630 * LEDs
633 #define LED_NUML 0x00
634 #define LED_CAPSL 0x01
635 #define LED_SCROLLL 0x02
636 #define LED_COMPOSE 0x03
637 #define LED_KANA 0x04
638 #define LED_SLEEP 0x05
639 #define LED_SUSPEND 0x06
640 #define LED_MUTE 0x07
641 #define LED_MISC 0x08
642 #define LED_MAIL 0x09
643 #define LED_CHARGING 0x0a
644 #define LED_MAX 0x0f
647 * Autorepeat values
650 #define REP_DELAY 0x00
651 #define REP_PERIOD 0x01
652 #define REP_MAX 0x01
655 * Sounds
658 #define SND_CLICK 0x00
659 #define SND_BELL 0x01
660 #define SND_TONE 0x02
661 #define SND_MAX 0x07
664 * IDs.
667 #define ID_BUS 0
668 #define ID_VENDOR 1
669 #define ID_PRODUCT 2
670 #define ID_VERSION 3
672 #define BUS_PCI 0x01
673 #define BUS_ISAPNP 0x02
674 #define BUS_USB 0x03
675 #define BUS_HIL 0x04
676 #define BUS_BLUETOOTH 0x05
677 #define BUS_VIRTUAL 0x06
679 #define BUS_ISA 0x10
680 #define BUS_I8042 0x11
681 #define BUS_XTKBD 0x12
682 #define BUS_RS232 0x13
683 #define BUS_GAMEPORT 0x14
684 #define BUS_PARPORT 0x15
685 #define BUS_AMIGA 0x16
686 #define BUS_ADB 0x17
687 #define BUS_I2C 0x18
688 #define BUS_HOST 0x19
689 #define BUS_GSC 0x1A
690 #define BUS_ATARI 0x1B
693 * Values describing the status of a force-feedback effect
695 #define FF_STATUS_STOPPED 0x00
696 #define FF_STATUS_PLAYING 0x01
697 #define FF_STATUS_MAX 0x01
700 * Structures used in ioctls to upload effects to a device
701 * They are pieces of a bigger structure (called ff_effect)
705 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
706 * should not be used and have unspecified results.
710 * struct ff_replay - defines scheduling of the force-feedback effect
711 * @length: duration of the effect
712 * @delay: delay before effect should start playing
714 struct ff_replay {
715 __u16 length;
716 __u16 delay;
720 * struct ff_trigger - defines what triggers the force-feedback effect
721 * @button: number of the button triggering the effect
722 * @interval: controls how soon the effect can be re-triggered
724 struct ff_trigger {
725 __u16 button;
726 __u16 interval;
730 * struct ff_envelope - generic force-feedback effect envelope
731 * @attack_length: duration of the attack (ms)
732 * @attack_level: level at the beginning of the attack
733 * @fade_length: duration of fade (ms)
734 * @fade_level: level at the end of fade
736 * The @attack_level and @fade_level are absolute values; when applying
737 * envelope force-feedback core will convert to positive/negative
738 * value based on polarity of the default level of the effect.
739 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
741 struct ff_envelope {
742 __u16 attack_length;
743 __u16 attack_level;
744 __u16 fade_length;
745 __u16 fade_level;
749 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
750 * @level: strength of the effect; may be negative
751 * @envelope: envelope data
753 struct ff_constant_effect {
754 __s16 level;
755 struct ff_envelope envelope;
759 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
760 * @start_level: beginning strength of the effect; may be negative
761 * @end_level: final strength of the effect; may be negative
762 * @envelope: envelope data
764 struct ff_ramp_effect {
765 __s16 start_level;
766 __s16 end_level;
767 struct ff_envelope envelope;
771 * struct ff_condition_effect - defines a spring or friction force-feedback effect
772 * @right_saturation: maximum level when joystick moved all way to the right
773 * @left_saturation: same for the left side
774 * @right_coeff: controls how fast the force grows when the joystick moves
775 * to the right
776 * @left_coeff: same for the left side
777 * @deadband: size of the dead zone, where no force is produced
778 * @center: position of the dead zone
780 struct ff_condition_effect {
781 __u16 right_saturation;
782 __u16 left_saturation;
784 __s16 right_coeff;
785 __s16 left_coeff;
787 __u16 deadband;
788 __s16 center;
792 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
793 * @waveform: kind of the effect (wave)
794 * @period: period of the wave (ms)
795 * @magnitude: peak value
796 * @offset: mean value of the wave (roughly)
797 * @phase: 'horizontal' shift
798 * @envelope: envelope data
799 * @custom_len: number of samples (FF_CUSTOM only)
800 * @custom_data: buffer of samples (FF_CUSTOM only)
802 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
803 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
804 * for the time being as no driver supports it yet.
806 * Note: the data pointed by custom_data is copied by the driver.
807 * You can therefore dispose of the memory after the upload/update.
809 struct ff_periodic_effect {
810 __u16 waveform;
811 __u16 period;
812 __s16 magnitude;
813 __s16 offset;
814 __u16 phase;
816 struct ff_envelope envelope;
818 __u32 custom_len;
819 __s16 *custom_data;
823 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
824 * @strong_magnitude: magnitude of the heavy motor
825 * @weak_magnitude: magnitude of the light one
827 * Some rumble pads have two motors of different weight. Strong_magnitude
828 * represents the magnitude of the vibration generated by the heavy one.
830 struct ff_rumble_effect {
831 __u16 strong_magnitude;
832 __u16 weak_magnitude;
836 * struct ff_effect - defines force feedback effect
837 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
838 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
839 * @id: an unique id assigned to an effect
840 * @direction: direction of the effect
841 * @trigger: trigger conditions (struct ff_trigger)
842 * @replay: scheduling of the effect (struct ff_replay)
843 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
844 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
845 * defining effect parameters
847 * This structure is sent through ioctl from the application to the driver.
848 * To create a new effect aplication should set its @id to -1; the kernel
849 * will return assigned @id which can later be used to update or delete
850 * this effect.
852 * Direction of the effect is encoded as follows:
853 * 0 deg -> 0x0000 (down)
854 * 90 deg -> 0x4000 (left)
855 * 180 deg -> 0x8000 (up)
856 * 270 deg -> 0xC000 (right)
858 struct ff_effect {
859 __u16 type;
860 __s16 id;
861 __u16 direction;
862 struct ff_trigger trigger;
863 struct ff_replay replay;
865 union {
866 struct ff_constant_effect constant;
867 struct ff_ramp_effect ramp;
868 struct ff_periodic_effect periodic;
869 struct ff_condition_effect condition[2]; /* One for each axis */
870 struct ff_rumble_effect rumble;
871 } u;
875 * Force feedback effect types
878 #define FF_RUMBLE 0x50
879 #define FF_PERIODIC 0x51
880 #define FF_CONSTANT 0x52
881 #define FF_SPRING 0x53
882 #define FF_FRICTION 0x54
883 #define FF_DAMPER 0x55
884 #define FF_INERTIA 0x56
885 #define FF_RAMP 0x57
887 #define FF_EFFECT_MIN FF_RUMBLE
888 #define FF_EFFECT_MAX FF_RAMP
891 * Force feedback periodic effect types
894 #define FF_SQUARE 0x58
895 #define FF_TRIANGLE 0x59
896 #define FF_SINE 0x5a
897 #define FF_SAW_UP 0x5b
898 #define FF_SAW_DOWN 0x5c
899 #define FF_CUSTOM 0x5d
901 #define FF_WAVEFORM_MIN FF_SQUARE
902 #define FF_WAVEFORM_MAX FF_CUSTOM
905 * Set ff device properties
908 #define FF_GAIN 0x60
909 #define FF_AUTOCENTER 0x61
911 #define FF_MAX 0x7f
913 #ifdef __KERNEL__
916 * In-kernel definitions.
919 #include <linux/device.h>
920 #include <linux/fs.h>
921 #include <linux/timer.h>
922 #include <linux/mod_devicetable.h>
924 #define NBITS(x) (((x)/BITS_PER_LONG)+1)
925 #define BIT(x) (1UL<<((x)%BITS_PER_LONG))
926 #define LONG(x) ((x)/BITS_PER_LONG)
928 struct input_dev {
930 void *private;
932 const char *name;
933 const char *phys;
934 const char *uniq;
935 struct input_id id;
937 unsigned long evbit[NBITS(EV_MAX)];
938 unsigned long keybit[NBITS(KEY_MAX)];
939 unsigned long relbit[NBITS(REL_MAX)];
940 unsigned long absbit[NBITS(ABS_MAX)];
941 unsigned long mscbit[NBITS(MSC_MAX)];
942 unsigned long ledbit[NBITS(LED_MAX)];
943 unsigned long sndbit[NBITS(SND_MAX)];
944 unsigned long ffbit[NBITS(FF_MAX)];
945 unsigned long swbit[NBITS(SW_MAX)];
947 unsigned int keycodemax;
948 unsigned int keycodesize;
949 void *keycode;
950 int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
951 int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
953 struct ff_device *ff;
955 unsigned int repeat_key;
956 struct timer_list timer;
958 int state;
960 int sync;
962 int abs[ABS_MAX + 1];
963 int rep[REP_MAX + 1];
965 unsigned long key[NBITS(KEY_MAX)];
966 unsigned long led[NBITS(LED_MAX)];
967 unsigned long snd[NBITS(SND_MAX)];
968 unsigned long sw[NBITS(SW_MAX)];
970 int absmax[ABS_MAX + 1];
971 int absmin[ABS_MAX + 1];
972 int absfuzz[ABS_MAX + 1];
973 int absflat[ABS_MAX + 1];
975 int (*open)(struct input_dev *dev);
976 void (*close)(struct input_dev *dev);
977 int (*flush)(struct input_dev *dev, struct file *file);
978 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
980 struct input_handle *grab;
982 struct mutex mutex; /* serializes open and close operations */
983 unsigned int users;
985 struct device dev;
986 union { /* temporarily so while we switching to struct device */
987 struct device *dev;
988 } cdev;
990 struct list_head h_list;
991 struct list_head node;
993 #define to_input_dev(d) container_of(d, struct input_dev, dev)
996 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
999 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1000 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1001 #endif
1003 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1004 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1005 #endif
1007 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1008 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1009 #endif
1011 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1012 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1013 #endif
1015 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1016 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1017 #endif
1019 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1020 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1021 #endif
1023 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1024 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1025 #endif
1027 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1028 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1029 #endif
1031 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1032 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1033 #endif
1035 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1036 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1037 #endif
1039 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1040 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1041 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1042 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1044 struct input_handle;
1047 * struct input_handler - implements one of interfaces for input devices
1048 * @private: driver-specific data
1049 * @event: event handler
1050 * @connect: called when attaching a handler to an input device
1051 * @disconnect: disconnects a handler from input device
1052 * @start: starts handler for given handle. This function is called by
1053 * input core right after connect() method and also when a process
1054 * that "grabbed" a device releases it
1055 * @fops: file operations this driver implements
1056 * @minor: beginning of range of 32 minors for devices this driver
1057 * can provide
1058 * @name: name of the handler, to be shown in /proc/bus/input/handlers
1059 * @id_table: pointer to a table of input_device_ids this driver can
1060 * handle
1061 * @blacklist: prointer to a table of input_device_ids this driver should
1062 * ignore even if they match @id_table
1063 * @h_list: list of input handles associated with the handler
1064 * @node: for placing the driver onto input_handler_list
1066 struct input_handler {
1068 void *private;
1070 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1071 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1072 void (*disconnect)(struct input_handle *handle);
1073 void (*start)(struct input_handle *handle);
1075 const struct file_operations *fops;
1076 int minor;
1077 const char *name;
1079 const struct input_device_id *id_table;
1080 const struct input_device_id *blacklist;
1082 struct list_head h_list;
1083 struct list_head node;
1086 struct input_handle {
1088 void *private;
1090 int open;
1091 const char *name;
1093 struct input_dev *dev;
1094 struct input_handler *handler;
1096 struct list_head d_node;
1097 struct list_head h_node;
1100 #define to_dev(n) container_of(n, struct input_dev, node)
1101 #define to_handler(n) container_of(n, struct input_handler, node)
1102 #define to_handle(n) container_of(n, struct input_handle, d_node)
1103 #define to_handle_h(n) container_of(n, struct input_handle, h_node)
1105 struct input_dev *input_allocate_device(void);
1106 void input_free_device(struct input_dev *dev);
1108 static inline struct input_dev *input_get_device(struct input_dev *dev)
1110 return to_input_dev(get_device(&dev->dev));
1113 static inline void input_put_device(struct input_dev *dev)
1115 put_device(&dev->dev);
1118 static inline void *input_get_drvdata(struct input_dev *dev)
1120 return dev->private;
1123 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1125 dev->private = data;
1128 int input_register_device(struct input_dev *);
1129 void input_unregister_device(struct input_dev *);
1131 int input_register_handler(struct input_handler *);
1132 void input_unregister_handler(struct input_handler *);
1134 int input_register_handle(struct input_handle *);
1135 void input_unregister_handle(struct input_handle *);
1137 int input_grab_device(struct input_handle *);
1138 void input_release_device(struct input_handle *);
1140 int input_open_device(struct input_handle *);
1141 void input_close_device(struct input_handle *);
1143 int input_flush_device(struct input_handle* handle, struct file* file);
1145 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1146 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1148 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1150 input_event(dev, EV_KEY, code, !!value);
1153 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1155 input_event(dev, EV_REL, code, value);
1158 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1160 input_event(dev, EV_ABS, code, value);
1163 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1165 input_event(dev, EV_FF_STATUS, code, value);
1168 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1170 input_event(dev, EV_SW, code, !!value);
1173 static inline void input_sync(struct input_dev *dev)
1175 input_event(dev, EV_SYN, SYN_REPORT, 0);
1178 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1180 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1182 dev->absmin[axis] = min;
1183 dev->absmax[axis] = max;
1184 dev->absfuzz[axis] = fuzz;
1185 dev->absflat[axis] = flat;
1187 dev->absbit[LONG(axis)] |= BIT(axis);
1190 extern struct class input_class;
1193 * struct ff_device - force-feedback part of an input device
1194 * @upload: Called to upload an new effect into device
1195 * @erase: Called to erase an effect from device
1196 * @playback: Called to request device to start playing specified effect
1197 * @set_gain: Called to set specified gain
1198 * @set_autocenter: Called to auto-center device
1199 * @destroy: called by input core when parent input device is being
1200 * destroyed
1201 * @private: driver-specific data, will be freed automatically
1202 * @ffbit: bitmap of force feedback capabilities truly supported by
1203 * device (not emulated like ones in input_dev->ffbit)
1204 * @mutex: mutex for serializing access to the device
1205 * @max_effects: maximum number of effects supported by device
1206 * @effects: pointer to an array of effects currently loaded into device
1207 * @effect_owners: array of effect owners; when file handle owning
1208 * an effect gets closed the effcet is automatically erased
1210 * Every force-feedback device must implement upload() and playback()
1211 * methods; erase() is optional. set_gain() and set_autocenter() need
1212 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1213 * bits.
1215 struct ff_device {
1216 int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1217 struct ff_effect *old);
1218 int (*erase)(struct input_dev *dev, int effect_id);
1220 int (*playback)(struct input_dev *dev, int effect_id, int value);
1221 void (*set_gain)(struct input_dev *dev, u16 gain);
1222 void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1224 void (*destroy)(struct ff_device *);
1226 void *private;
1228 unsigned long ffbit[NBITS(FF_MAX)];
1230 struct mutex mutex;
1232 int max_effects;
1233 struct ff_effect *effects;
1234 struct file *effect_owners[];
1237 int input_ff_create(struct input_dev *dev, int max_effects);
1238 void input_ff_destroy(struct input_dev *dev);
1240 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1242 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1243 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1245 int input_ff_create_memless(struct input_dev *dev, void *data,
1246 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1248 #endif
1249 #endif