]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/input.h
Merge tag 'stable/for-linus-3.6-rc0-tag' of git://git.kernel.org/pub/scm/linux/kernel...
[mirror_ubuntu-artful-kernel.git] / include / linux / input.h
1 #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 <sys/types.h>
19 #include <linux/types.h>
20 #endif
21
22 /*
23 * The event structure itself
24 */
25
26 struct 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 0x010001
38
39 /*
40 * IOCTLs (0x00 - 0x7f)
41 */
42
43 struct input_id {
44 __u16 bustype;
45 __u16 vendor;
46 __u16 product;
47 __u16 version;
48 };
49
50 /**
51 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
52 * @value: latest reported value for the axis.
53 * @minimum: specifies minimum value for the axis.
54 * @maximum: specifies maximum value for the axis.
55 * @fuzz: specifies fuzz value that is used to filter noise from
56 * the event stream.
57 * @flat: values that are within this value will be discarded by
58 * joydev interface and reported as 0 instead.
59 * @resolution: specifies resolution for the values reported for
60 * the axis.
61 *
62 * Note that input core does not clamp reported values to the
63 * [minimum, maximum] limits, such task is left to userspace.
64 *
65 * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
66 * units per millimeter (units/mm), resolution for rotational axes
67 * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
68 */
69 struct input_absinfo {
70 __s32 value;
71 __s32 minimum;
72 __s32 maximum;
73 __s32 fuzz;
74 __s32 flat;
75 __s32 resolution;
76 };
77
78 /**
79 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
80 * @scancode: scancode represented in machine-endian form.
81 * @len: length of the scancode that resides in @scancode buffer.
82 * @index: index in the keymap, may be used instead of scancode
83 * @flags: allows to specify how kernel should handle the request. For
84 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
85 * should perform lookup in keymap by @index instead of @scancode
86 * @keycode: key code assigned to this scancode
87 *
88 * The structure is used to retrieve and modify keymap data. Users have
89 * option of performing lookup either by @scancode itself or by @index
90 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
91 * (depending on which element was used to perform lookup).
92 */
93 struct input_keymap_entry {
94 #define INPUT_KEYMAP_BY_INDEX (1 << 0)
95 __u8 flags;
96 __u8 len;
97 __u16 index;
98 __u32 keycode;
99 __u8 scancode[32];
100 };
101
102 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
103 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
104 #define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
105 #define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
106
107 #define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
108 #define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
109 #define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
110 #define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
111
112 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
113 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
114 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
115 #define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
116
117 /**
118 * EVIOCGMTSLOTS(len) - get MT slot values
119 * @len: size of the data buffer in bytes
120 *
121 * The ioctl buffer argument should be binary equivalent to
122 *
123 * struct input_mt_request_layout {
124 * __u32 code;
125 * __s32 values[num_slots];
126 * };
127 *
128 * where num_slots is the (arbitrary) number of MT slots to extract.
129 *
130 * The ioctl size argument (len) is the size of the buffer, which
131 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is
132 * too small to fit all available slots, the first num_slots are
133 * returned.
134 *
135 * Before the call, code is set to the wanted ABS_MT event type. On
136 * return, values[] is filled with the slot values for the specified
137 * ABS_MT code.
138 *
139 * If the request code is not an ABS_MT value, -EINVAL is returned.
140 */
141 #define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
142
143 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
144 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
145 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
146 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
147
148 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
149 #define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
150 #define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
151
152 #define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */
153 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
154 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
155
156 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
157
158 #define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
159
160 /*
161 * Device properties and quirks
162 */
163
164 #define INPUT_PROP_POINTER 0x00 /* needs a pointer */
165 #define INPUT_PROP_DIRECT 0x01 /* direct input devices */
166 #define INPUT_PROP_BUTTONPAD 0x02 /* has button(s) under pad */
167 #define INPUT_PROP_SEMI_MT 0x03 /* touch rectangle only */
168
169 #define INPUT_PROP_MAX 0x1f
170 #define INPUT_PROP_CNT (INPUT_PROP_MAX + 1)
171
172 /*
173 * Event types
174 */
175
176 #define EV_SYN 0x00
177 #define EV_KEY 0x01
178 #define EV_REL 0x02
179 #define EV_ABS 0x03
180 #define EV_MSC 0x04
181 #define EV_SW 0x05
182 #define EV_LED 0x11
183 #define EV_SND 0x12
184 #define EV_REP 0x14
185 #define EV_FF 0x15
186 #define EV_PWR 0x16
187 #define EV_FF_STATUS 0x17
188 #define EV_MAX 0x1f
189 #define EV_CNT (EV_MAX+1)
190
191 /*
192 * Synchronization events.
193 */
194
195 #define SYN_REPORT 0
196 #define SYN_CONFIG 1
197 #define SYN_MT_REPORT 2
198 #define SYN_DROPPED 3
199
200 /*
201 * Keys and buttons
202 *
203 * Most of the keys/buttons are modeled after USB HUT 1.12
204 * (see http://www.usb.org/developers/hidpage).
205 * Abbreviations in the comments:
206 * AC - Application Control
207 * AL - Application Launch Button
208 * SC - System Control
209 */
210
211 #define KEY_RESERVED 0
212 #define KEY_ESC 1
213 #define KEY_1 2
214 #define KEY_2 3
215 #define KEY_3 4
216 #define KEY_4 5
217 #define KEY_5 6
218 #define KEY_6 7
219 #define KEY_7 8
220 #define KEY_8 9
221 #define KEY_9 10
222 #define KEY_0 11
223 #define KEY_MINUS 12
224 #define KEY_EQUAL 13
225 #define KEY_BACKSPACE 14
226 #define KEY_TAB 15
227 #define KEY_Q 16
228 #define KEY_W 17
229 #define KEY_E 18
230 #define KEY_R 19
231 #define KEY_T 20
232 #define KEY_Y 21
233 #define KEY_U 22
234 #define KEY_I 23
235 #define KEY_O 24
236 #define KEY_P 25
237 #define KEY_LEFTBRACE 26
238 #define KEY_RIGHTBRACE 27
239 #define KEY_ENTER 28
240 #define KEY_LEFTCTRL 29
241 #define KEY_A 30
242 #define KEY_S 31
243 #define KEY_D 32
244 #define KEY_F 33
245 #define KEY_G 34
246 #define KEY_H 35
247 #define KEY_J 36
248 #define KEY_K 37
249 #define KEY_L 38
250 #define KEY_SEMICOLON 39
251 #define KEY_APOSTROPHE 40
252 #define KEY_GRAVE 41
253 #define KEY_LEFTSHIFT 42
254 #define KEY_BACKSLASH 43
255 #define KEY_Z 44
256 #define KEY_X 45
257 #define KEY_C 46
258 #define KEY_V 47
259 #define KEY_B 48
260 #define KEY_N 49
261 #define KEY_M 50
262 #define KEY_COMMA 51
263 #define KEY_DOT 52
264 #define KEY_SLASH 53
265 #define KEY_RIGHTSHIFT 54
266 #define KEY_KPASTERISK 55
267 #define KEY_LEFTALT 56
268 #define KEY_SPACE 57
269 #define KEY_CAPSLOCK 58
270 #define KEY_F1 59
271 #define KEY_F2 60
272 #define KEY_F3 61
273 #define KEY_F4 62
274 #define KEY_F5 63
275 #define KEY_F6 64
276 #define KEY_F7 65
277 #define KEY_F8 66
278 #define KEY_F9 67
279 #define KEY_F10 68
280 #define KEY_NUMLOCK 69
281 #define KEY_SCROLLLOCK 70
282 #define KEY_KP7 71
283 #define KEY_KP8 72
284 #define KEY_KP9 73
285 #define KEY_KPMINUS 74
286 #define KEY_KP4 75
287 #define KEY_KP5 76
288 #define KEY_KP6 77
289 #define KEY_KPPLUS 78
290 #define KEY_KP1 79
291 #define KEY_KP2 80
292 #define KEY_KP3 81
293 #define KEY_KP0 82
294 #define KEY_KPDOT 83
295
296 #define KEY_ZENKAKUHANKAKU 85
297 #define KEY_102ND 86
298 #define KEY_F11 87
299 #define KEY_F12 88
300 #define KEY_RO 89
301 #define KEY_KATAKANA 90
302 #define KEY_HIRAGANA 91
303 #define KEY_HENKAN 92
304 #define KEY_KATAKANAHIRAGANA 93
305 #define KEY_MUHENKAN 94
306 #define KEY_KPJPCOMMA 95
307 #define KEY_KPENTER 96
308 #define KEY_RIGHTCTRL 97
309 #define KEY_KPSLASH 98
310 #define KEY_SYSRQ 99
311 #define KEY_RIGHTALT 100
312 #define KEY_LINEFEED 101
313 #define KEY_HOME 102
314 #define KEY_UP 103
315 #define KEY_PAGEUP 104
316 #define KEY_LEFT 105
317 #define KEY_RIGHT 106
318 #define KEY_END 107
319 #define KEY_DOWN 108
320 #define KEY_PAGEDOWN 109
321 #define KEY_INSERT 110
322 #define KEY_DELETE 111
323 #define KEY_MACRO 112
324 #define KEY_MUTE 113
325 #define KEY_VOLUMEDOWN 114
326 #define KEY_VOLUMEUP 115
327 #define KEY_POWER 116 /* SC System Power Down */
328 #define KEY_KPEQUAL 117
329 #define KEY_KPPLUSMINUS 118
330 #define KEY_PAUSE 119
331 #define KEY_SCALE 120 /* AL Compiz Scale (Expose) */
332
333 #define KEY_KPCOMMA 121
334 #define KEY_HANGEUL 122
335 #define KEY_HANGUEL KEY_HANGEUL
336 #define KEY_HANJA 123
337 #define KEY_YEN 124
338 #define KEY_LEFTMETA 125
339 #define KEY_RIGHTMETA 126
340 #define KEY_COMPOSE 127
341
342 #define KEY_STOP 128 /* AC Stop */
343 #define KEY_AGAIN 129
344 #define KEY_PROPS 130 /* AC Properties */
345 #define KEY_UNDO 131 /* AC Undo */
346 #define KEY_FRONT 132
347 #define KEY_COPY 133 /* AC Copy */
348 #define KEY_OPEN 134 /* AC Open */
349 #define KEY_PASTE 135 /* AC Paste */
350 #define KEY_FIND 136 /* AC Search */
351 #define KEY_CUT 137 /* AC Cut */
352 #define KEY_HELP 138 /* AL Integrated Help Center */
353 #define KEY_MENU 139 /* Menu (show menu) */
354 #define KEY_CALC 140 /* AL Calculator */
355 #define KEY_SETUP 141
356 #define KEY_SLEEP 142 /* SC System Sleep */
357 #define KEY_WAKEUP 143 /* System Wake Up */
358 #define KEY_FILE 144 /* AL Local Machine Browser */
359 #define KEY_SENDFILE 145
360 #define KEY_DELETEFILE 146
361 #define KEY_XFER 147
362 #define KEY_PROG1 148
363 #define KEY_PROG2 149
364 #define KEY_WWW 150 /* AL Internet Browser */
365 #define KEY_MSDOS 151
366 #define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */
367 #define KEY_SCREENLOCK KEY_COFFEE
368 #define KEY_DIRECTION 153
369 #define KEY_CYCLEWINDOWS 154
370 #define KEY_MAIL 155
371 #define KEY_BOOKMARKS 156 /* AC Bookmarks */
372 #define KEY_COMPUTER 157
373 #define KEY_BACK 158 /* AC Back */
374 #define KEY_FORWARD 159 /* AC Forward */
375 #define KEY_CLOSECD 160
376 #define KEY_EJECTCD 161
377 #define KEY_EJECTCLOSECD 162
378 #define KEY_NEXTSONG 163
379 #define KEY_PLAYPAUSE 164
380 #define KEY_PREVIOUSSONG 165
381 #define KEY_STOPCD 166
382 #define KEY_RECORD 167
383 #define KEY_REWIND 168
384 #define KEY_PHONE 169 /* Media Select Telephone */
385 #define KEY_ISO 170
386 #define KEY_CONFIG 171 /* AL Consumer Control Configuration */
387 #define KEY_HOMEPAGE 172 /* AC Home */
388 #define KEY_REFRESH 173 /* AC Refresh */
389 #define KEY_EXIT 174 /* AC Exit */
390 #define KEY_MOVE 175
391 #define KEY_EDIT 176
392 #define KEY_SCROLLUP 177
393 #define KEY_SCROLLDOWN 178
394 #define KEY_KPLEFTPAREN 179
395 #define KEY_KPRIGHTPAREN 180
396 #define KEY_NEW 181 /* AC New */
397 #define KEY_REDO 182 /* AC Redo/Repeat */
398
399 #define KEY_F13 183
400 #define KEY_F14 184
401 #define KEY_F15 185
402 #define KEY_F16 186
403 #define KEY_F17 187
404 #define KEY_F18 188
405 #define KEY_F19 189
406 #define KEY_F20 190
407 #define KEY_F21 191
408 #define KEY_F22 192
409 #define KEY_F23 193
410 #define KEY_F24 194
411
412 #define KEY_PLAYCD 200
413 #define KEY_PAUSECD 201
414 #define KEY_PROG3 202
415 #define KEY_PROG4 203
416 #define KEY_DASHBOARD 204 /* AL Dashboard */
417 #define KEY_SUSPEND 205
418 #define KEY_CLOSE 206 /* AC Close */
419 #define KEY_PLAY 207
420 #define KEY_FASTFORWARD 208
421 #define KEY_BASSBOOST 209
422 #define KEY_PRINT 210 /* AC Print */
423 #define KEY_HP 211
424 #define KEY_CAMERA 212
425 #define KEY_SOUND 213
426 #define KEY_QUESTION 214
427 #define KEY_EMAIL 215
428 #define KEY_CHAT 216
429 #define KEY_SEARCH 217
430 #define KEY_CONNECT 218
431 #define KEY_FINANCE 219 /* AL Checkbook/Finance */
432 #define KEY_SPORT 220
433 #define KEY_SHOP 221
434 #define KEY_ALTERASE 222
435 #define KEY_CANCEL 223 /* AC Cancel */
436 #define KEY_BRIGHTNESSDOWN 224
437 #define KEY_BRIGHTNESSUP 225
438 #define KEY_MEDIA 226
439
440 #define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video
441 outputs (Monitor/LCD/TV-out/etc) */
442 #define KEY_KBDILLUMTOGGLE 228
443 #define KEY_KBDILLUMDOWN 229
444 #define KEY_KBDILLUMUP 230
445
446 #define KEY_SEND 231 /* AC Send */
447 #define KEY_REPLY 232 /* AC Reply */
448 #define KEY_FORWARDMAIL 233 /* AC Forward Msg */
449 #define KEY_SAVE 234 /* AC Save */
450 #define KEY_DOCUMENTS 235
451
452 #define KEY_BATTERY 236
453
454 #define KEY_BLUETOOTH 237
455 #define KEY_WLAN 238
456 #define KEY_UWB 239
457
458 #define KEY_UNKNOWN 240
459
460 #define KEY_VIDEO_NEXT 241 /* drive next video source */
461 #define KEY_VIDEO_PREV 242 /* drive previous video source */
462 #define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */
463 #define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */
464 #define KEY_DISPLAY_OFF 245 /* display device to off state */
465
466 #define KEY_WIMAX 246
467 #define KEY_RFKILL 247 /* Key that controls all radios */
468
469 #define KEY_MICMUTE 248 /* Mute / unmute the microphone */
470
471 /* Code 255 is reserved for special needs of AT keyboard driver */
472
473 #define BTN_MISC 0x100
474 #define BTN_0 0x100
475 #define BTN_1 0x101
476 #define BTN_2 0x102
477 #define BTN_3 0x103
478 #define BTN_4 0x104
479 #define BTN_5 0x105
480 #define BTN_6 0x106
481 #define BTN_7 0x107
482 #define BTN_8 0x108
483 #define BTN_9 0x109
484
485 #define BTN_MOUSE 0x110
486 #define BTN_LEFT 0x110
487 #define BTN_RIGHT 0x111
488 #define BTN_MIDDLE 0x112
489 #define BTN_SIDE 0x113
490 #define BTN_EXTRA 0x114
491 #define BTN_FORWARD 0x115
492 #define BTN_BACK 0x116
493 #define BTN_TASK 0x117
494
495 #define BTN_JOYSTICK 0x120
496 #define BTN_TRIGGER 0x120
497 #define BTN_THUMB 0x121
498 #define BTN_THUMB2 0x122
499 #define BTN_TOP 0x123
500 #define BTN_TOP2 0x124
501 #define BTN_PINKIE 0x125
502 #define BTN_BASE 0x126
503 #define BTN_BASE2 0x127
504 #define BTN_BASE3 0x128
505 #define BTN_BASE4 0x129
506 #define BTN_BASE5 0x12a
507 #define BTN_BASE6 0x12b
508 #define BTN_DEAD 0x12f
509
510 #define BTN_GAMEPAD 0x130
511 #define BTN_A 0x130
512 #define BTN_B 0x131
513 #define BTN_C 0x132
514 #define BTN_X 0x133
515 #define BTN_Y 0x134
516 #define BTN_Z 0x135
517 #define BTN_TL 0x136
518 #define BTN_TR 0x137
519 #define BTN_TL2 0x138
520 #define BTN_TR2 0x139
521 #define BTN_SELECT 0x13a
522 #define BTN_START 0x13b
523 #define BTN_MODE 0x13c
524 #define BTN_THUMBL 0x13d
525 #define BTN_THUMBR 0x13e
526
527 #define BTN_DIGI 0x140
528 #define BTN_TOOL_PEN 0x140
529 #define BTN_TOOL_RUBBER 0x141
530 #define BTN_TOOL_BRUSH 0x142
531 #define BTN_TOOL_PENCIL 0x143
532 #define BTN_TOOL_AIRBRUSH 0x144
533 #define BTN_TOOL_FINGER 0x145
534 #define BTN_TOOL_MOUSE 0x146
535 #define BTN_TOOL_LENS 0x147
536 #define BTN_TOOL_QUINTTAP 0x148 /* Five fingers on trackpad */
537 #define BTN_TOUCH 0x14a
538 #define BTN_STYLUS 0x14b
539 #define BTN_STYLUS2 0x14c
540 #define BTN_TOOL_DOUBLETAP 0x14d
541 #define BTN_TOOL_TRIPLETAP 0x14e
542 #define BTN_TOOL_QUADTAP 0x14f /* Four fingers on trackpad */
543
544 #define BTN_WHEEL 0x150
545 #define BTN_GEAR_DOWN 0x150
546 #define BTN_GEAR_UP 0x151
547
548 #define KEY_OK 0x160
549 #define KEY_SELECT 0x161
550 #define KEY_GOTO 0x162
551 #define KEY_CLEAR 0x163
552 #define KEY_POWER2 0x164
553 #define KEY_OPTION 0x165
554 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
555 #define KEY_TIME 0x167
556 #define KEY_VENDOR 0x168
557 #define KEY_ARCHIVE 0x169
558 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */
559 #define KEY_CHANNEL 0x16b
560 #define KEY_FAVORITES 0x16c
561 #define KEY_EPG 0x16d
562 #define KEY_PVR 0x16e /* Media Select Home */
563 #define KEY_MHP 0x16f
564 #define KEY_LANGUAGE 0x170
565 #define KEY_TITLE 0x171
566 #define KEY_SUBTITLE 0x172
567 #define KEY_ANGLE 0x173
568 #define KEY_ZOOM 0x174
569 #define KEY_MODE 0x175
570 #define KEY_KEYBOARD 0x176
571 #define KEY_SCREEN 0x177
572 #define KEY_PC 0x178 /* Media Select Computer */
573 #define KEY_TV 0x179 /* Media Select TV */
574 #define KEY_TV2 0x17a /* Media Select Cable */
575 #define KEY_VCR 0x17b /* Media Select VCR */
576 #define KEY_VCR2 0x17c /* VCR Plus */
577 #define KEY_SAT 0x17d /* Media Select Satellite */
578 #define KEY_SAT2 0x17e
579 #define KEY_CD 0x17f /* Media Select CD */
580 #define KEY_TAPE 0x180 /* Media Select Tape */
581 #define KEY_RADIO 0x181
582 #define KEY_TUNER 0x182 /* Media Select Tuner */
583 #define KEY_PLAYER 0x183
584 #define KEY_TEXT 0x184
585 #define KEY_DVD 0x185 /* Media Select DVD */
586 #define KEY_AUX 0x186
587 #define KEY_MP3 0x187
588 #define KEY_AUDIO 0x188 /* AL Audio Browser */
589 #define KEY_VIDEO 0x189 /* AL Movie Browser */
590 #define KEY_DIRECTORY 0x18a
591 #define KEY_LIST 0x18b
592 #define KEY_MEMO 0x18c /* Media Select Messages */
593 #define KEY_CALENDAR 0x18d
594 #define KEY_RED 0x18e
595 #define KEY_GREEN 0x18f
596 #define KEY_YELLOW 0x190
597 #define KEY_BLUE 0x191
598 #define KEY_CHANNELUP 0x192 /* Channel Increment */
599 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
600 #define KEY_FIRST 0x194
601 #define KEY_LAST 0x195 /* Recall Last */
602 #define KEY_AB 0x196
603 #define KEY_NEXT 0x197
604 #define KEY_RESTART 0x198
605 #define KEY_SLOW 0x199
606 #define KEY_SHUFFLE 0x19a
607 #define KEY_BREAK 0x19b
608 #define KEY_PREVIOUS 0x19c
609 #define KEY_DIGITS 0x19d
610 #define KEY_TEEN 0x19e
611 #define KEY_TWEN 0x19f
612 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
613 #define KEY_GAMES 0x1a1 /* Media Select Games */
614 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
615 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
616 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
617 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
618 #define KEY_EDITOR 0x1a6 /* AL Text Editor */
619 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
620 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
621 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
622 #define KEY_DATABASE 0x1aa /* AL Database App */
623 #define KEY_NEWS 0x1ab /* AL Newsreader */
624 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
625 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
626 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
627 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
628 #define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */
629 #define KEY_LOGOFF 0x1b1 /* AL Logoff */
630
631 #define KEY_DOLLAR 0x1b2
632 #define KEY_EURO 0x1b3
633
634 #define KEY_FRAMEBACK 0x1b4 /* Consumer - transport controls */
635 #define KEY_FRAMEFORWARD 0x1b5
636 #define KEY_CONTEXT_MENU 0x1b6 /* GenDesc - system context menu */
637 #define KEY_MEDIA_REPEAT 0x1b7 /* Consumer - transport control */
638 #define KEY_10CHANNELSUP 0x1b8 /* 10 channels up (10+) */
639 #define KEY_10CHANNELSDOWN 0x1b9 /* 10 channels down (10-) */
640 #define KEY_IMAGES 0x1ba /* AL Image Browser */
641
642 #define KEY_DEL_EOL 0x1c0
643 #define KEY_DEL_EOS 0x1c1
644 #define KEY_INS_LINE 0x1c2
645 #define KEY_DEL_LINE 0x1c3
646
647 #define KEY_FN 0x1d0
648 #define KEY_FN_ESC 0x1d1
649 #define KEY_FN_F1 0x1d2
650 #define KEY_FN_F2 0x1d3
651 #define KEY_FN_F3 0x1d4
652 #define KEY_FN_F4 0x1d5
653 #define KEY_FN_F5 0x1d6
654 #define KEY_FN_F6 0x1d7
655 #define KEY_FN_F7 0x1d8
656 #define KEY_FN_F8 0x1d9
657 #define KEY_FN_F9 0x1da
658 #define KEY_FN_F10 0x1db
659 #define KEY_FN_F11 0x1dc
660 #define KEY_FN_F12 0x1dd
661 #define KEY_FN_1 0x1de
662 #define KEY_FN_2 0x1df
663 #define KEY_FN_D 0x1e0
664 #define KEY_FN_E 0x1e1
665 #define KEY_FN_F 0x1e2
666 #define KEY_FN_S 0x1e3
667 #define KEY_FN_B 0x1e4
668
669 #define KEY_BRL_DOT1 0x1f1
670 #define KEY_BRL_DOT2 0x1f2
671 #define KEY_BRL_DOT3 0x1f3
672 #define KEY_BRL_DOT4 0x1f4
673 #define KEY_BRL_DOT5 0x1f5
674 #define KEY_BRL_DOT6 0x1f6
675 #define KEY_BRL_DOT7 0x1f7
676 #define KEY_BRL_DOT8 0x1f8
677 #define KEY_BRL_DOT9 0x1f9
678 #define KEY_BRL_DOT10 0x1fa
679
680 #define KEY_NUMERIC_0 0x200 /* used by phones, remote controls, */
681 #define KEY_NUMERIC_1 0x201 /* and other keypads */
682 #define KEY_NUMERIC_2 0x202
683 #define KEY_NUMERIC_3 0x203
684 #define KEY_NUMERIC_4 0x204
685 #define KEY_NUMERIC_5 0x205
686 #define KEY_NUMERIC_6 0x206
687 #define KEY_NUMERIC_7 0x207
688 #define KEY_NUMERIC_8 0x208
689 #define KEY_NUMERIC_9 0x209
690 #define KEY_NUMERIC_STAR 0x20a
691 #define KEY_NUMERIC_POUND 0x20b
692
693 #define KEY_CAMERA_FOCUS 0x210
694 #define KEY_WPS_BUTTON 0x211 /* WiFi Protected Setup key */
695
696 #define KEY_TOUCHPAD_TOGGLE 0x212 /* Request switch touchpad on or off */
697 #define KEY_TOUCHPAD_ON 0x213
698 #define KEY_TOUCHPAD_OFF 0x214
699
700 #define KEY_CAMERA_ZOOMIN 0x215
701 #define KEY_CAMERA_ZOOMOUT 0x216
702 #define KEY_CAMERA_UP 0x217
703 #define KEY_CAMERA_DOWN 0x218
704 #define KEY_CAMERA_LEFT 0x219
705 #define KEY_CAMERA_RIGHT 0x21a
706
707 #define BTN_TRIGGER_HAPPY 0x2c0
708 #define BTN_TRIGGER_HAPPY1 0x2c0
709 #define BTN_TRIGGER_HAPPY2 0x2c1
710 #define BTN_TRIGGER_HAPPY3 0x2c2
711 #define BTN_TRIGGER_HAPPY4 0x2c3
712 #define BTN_TRIGGER_HAPPY5 0x2c4
713 #define BTN_TRIGGER_HAPPY6 0x2c5
714 #define BTN_TRIGGER_HAPPY7 0x2c6
715 #define BTN_TRIGGER_HAPPY8 0x2c7
716 #define BTN_TRIGGER_HAPPY9 0x2c8
717 #define BTN_TRIGGER_HAPPY10 0x2c9
718 #define BTN_TRIGGER_HAPPY11 0x2ca
719 #define BTN_TRIGGER_HAPPY12 0x2cb
720 #define BTN_TRIGGER_HAPPY13 0x2cc
721 #define BTN_TRIGGER_HAPPY14 0x2cd
722 #define BTN_TRIGGER_HAPPY15 0x2ce
723 #define BTN_TRIGGER_HAPPY16 0x2cf
724 #define BTN_TRIGGER_HAPPY17 0x2d0
725 #define BTN_TRIGGER_HAPPY18 0x2d1
726 #define BTN_TRIGGER_HAPPY19 0x2d2
727 #define BTN_TRIGGER_HAPPY20 0x2d3
728 #define BTN_TRIGGER_HAPPY21 0x2d4
729 #define BTN_TRIGGER_HAPPY22 0x2d5
730 #define BTN_TRIGGER_HAPPY23 0x2d6
731 #define BTN_TRIGGER_HAPPY24 0x2d7
732 #define BTN_TRIGGER_HAPPY25 0x2d8
733 #define BTN_TRIGGER_HAPPY26 0x2d9
734 #define BTN_TRIGGER_HAPPY27 0x2da
735 #define BTN_TRIGGER_HAPPY28 0x2db
736 #define BTN_TRIGGER_HAPPY29 0x2dc
737 #define BTN_TRIGGER_HAPPY30 0x2dd
738 #define BTN_TRIGGER_HAPPY31 0x2de
739 #define BTN_TRIGGER_HAPPY32 0x2df
740 #define BTN_TRIGGER_HAPPY33 0x2e0
741 #define BTN_TRIGGER_HAPPY34 0x2e1
742 #define BTN_TRIGGER_HAPPY35 0x2e2
743 #define BTN_TRIGGER_HAPPY36 0x2e3
744 #define BTN_TRIGGER_HAPPY37 0x2e4
745 #define BTN_TRIGGER_HAPPY38 0x2e5
746 #define BTN_TRIGGER_HAPPY39 0x2e6
747 #define BTN_TRIGGER_HAPPY40 0x2e7
748
749 /* We avoid low common keys in module aliases so they don't get huge. */
750 #define KEY_MIN_INTERESTING KEY_MUTE
751 #define KEY_MAX 0x2ff
752 #define KEY_CNT (KEY_MAX+1)
753
754 /*
755 * Relative axes
756 */
757
758 #define REL_X 0x00
759 #define REL_Y 0x01
760 #define REL_Z 0x02
761 #define REL_RX 0x03
762 #define REL_RY 0x04
763 #define REL_RZ 0x05
764 #define REL_HWHEEL 0x06
765 #define REL_DIAL 0x07
766 #define REL_WHEEL 0x08
767 #define REL_MISC 0x09
768 #define REL_MAX 0x0f
769 #define REL_CNT (REL_MAX+1)
770
771 /*
772 * Absolute axes
773 */
774
775 #define ABS_X 0x00
776 #define ABS_Y 0x01
777 #define ABS_Z 0x02
778 #define ABS_RX 0x03
779 #define ABS_RY 0x04
780 #define ABS_RZ 0x05
781 #define ABS_THROTTLE 0x06
782 #define ABS_RUDDER 0x07
783 #define ABS_WHEEL 0x08
784 #define ABS_GAS 0x09
785 #define ABS_BRAKE 0x0a
786 #define ABS_HAT0X 0x10
787 #define ABS_HAT0Y 0x11
788 #define ABS_HAT1X 0x12
789 #define ABS_HAT1Y 0x13
790 #define ABS_HAT2X 0x14
791 #define ABS_HAT2Y 0x15
792 #define ABS_HAT3X 0x16
793 #define ABS_HAT3Y 0x17
794 #define ABS_PRESSURE 0x18
795 #define ABS_DISTANCE 0x19
796 #define ABS_TILT_X 0x1a
797 #define ABS_TILT_Y 0x1b
798 #define ABS_TOOL_WIDTH 0x1c
799
800 #define ABS_VOLUME 0x20
801
802 #define ABS_MISC 0x28
803
804 #define ABS_MT_SLOT 0x2f /* MT slot being modified */
805 #define ABS_MT_TOUCH_MAJOR 0x30 /* Major axis of touching ellipse */
806 #define ABS_MT_TOUCH_MINOR 0x31 /* Minor axis (omit if circular) */
807 #define ABS_MT_WIDTH_MAJOR 0x32 /* Major axis of approaching ellipse */
808 #define ABS_MT_WIDTH_MINOR 0x33 /* Minor axis (omit if circular) */
809 #define ABS_MT_ORIENTATION 0x34 /* Ellipse orientation */
810 #define ABS_MT_POSITION_X 0x35 /* Center X ellipse position */
811 #define ABS_MT_POSITION_Y 0x36 /* Center Y ellipse position */
812 #define ABS_MT_TOOL_TYPE 0x37 /* Type of touching device */
813 #define ABS_MT_BLOB_ID 0x38 /* Group a set of packets as a blob */
814 #define ABS_MT_TRACKING_ID 0x39 /* Unique ID of initiated contact */
815 #define ABS_MT_PRESSURE 0x3a /* Pressure on contact area */
816 #define ABS_MT_DISTANCE 0x3b /* Contact hover distance */
817
818 #ifdef __KERNEL__
819 /* Implementation details, userspace should not care about these */
820 #define ABS_MT_FIRST ABS_MT_TOUCH_MAJOR
821 #define ABS_MT_LAST ABS_MT_DISTANCE
822 #endif
823
824 #define ABS_MAX 0x3f
825 #define ABS_CNT (ABS_MAX+1)
826
827 /*
828 * Switch events
829 */
830
831 #define SW_LID 0x00 /* set = lid shut */
832 #define SW_TABLET_MODE 0x01 /* set = tablet mode */
833 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
834 #define SW_RFKILL_ALL 0x03 /* rfkill master switch, type "any"
835 set = radio enabled */
836 #define SW_RADIO SW_RFKILL_ALL /* deprecated */
837 #define SW_MICROPHONE_INSERT 0x04 /* set = inserted */
838 #define SW_DOCK 0x05 /* set = plugged into dock */
839 #define SW_LINEOUT_INSERT 0x06 /* set = inserted */
840 #define SW_JACK_PHYSICAL_INSERT 0x07 /* set = mechanical switch set */
841 #define SW_VIDEOOUT_INSERT 0x08 /* set = inserted */
842 #define SW_CAMERA_LENS_COVER 0x09 /* set = lens covered */
843 #define SW_KEYPAD_SLIDE 0x0a /* set = keypad slide out */
844 #define SW_FRONT_PROXIMITY 0x0b /* set = front proximity sensor active */
845 #define SW_ROTATE_LOCK 0x0c /* set = rotate locked/disabled */
846 #define SW_LINEIN_INSERT 0x0d /* set = inserted */
847 #define SW_MAX 0x0f
848 #define SW_CNT (SW_MAX+1)
849
850 /*
851 * Misc events
852 */
853
854 #define MSC_SERIAL 0x00
855 #define MSC_PULSELED 0x01
856 #define MSC_GESTURE 0x02
857 #define MSC_RAW 0x03
858 #define MSC_SCAN 0x04
859 #define MSC_MAX 0x07
860 #define MSC_CNT (MSC_MAX+1)
861
862 /*
863 * LEDs
864 */
865
866 #define LED_NUML 0x00
867 #define LED_CAPSL 0x01
868 #define LED_SCROLLL 0x02
869 #define LED_COMPOSE 0x03
870 #define LED_KANA 0x04
871 #define LED_SLEEP 0x05
872 #define LED_SUSPEND 0x06
873 #define LED_MUTE 0x07
874 #define LED_MISC 0x08
875 #define LED_MAIL 0x09
876 #define LED_CHARGING 0x0a
877 #define LED_MAX 0x0f
878 #define LED_CNT (LED_MAX+1)
879
880 /*
881 * Autorepeat values
882 */
883
884 #define REP_DELAY 0x00
885 #define REP_PERIOD 0x01
886 #define REP_MAX 0x01
887 #define REP_CNT (REP_MAX+1)
888
889 /*
890 * Sounds
891 */
892
893 #define SND_CLICK 0x00
894 #define SND_BELL 0x01
895 #define SND_TONE 0x02
896 #define SND_MAX 0x07
897 #define SND_CNT (SND_MAX+1)
898
899 /*
900 * IDs.
901 */
902
903 #define ID_BUS 0
904 #define ID_VENDOR 1
905 #define ID_PRODUCT 2
906 #define ID_VERSION 3
907
908 #define BUS_PCI 0x01
909 #define BUS_ISAPNP 0x02
910 #define BUS_USB 0x03
911 #define BUS_HIL 0x04
912 #define BUS_BLUETOOTH 0x05
913 #define BUS_VIRTUAL 0x06
914
915 #define BUS_ISA 0x10
916 #define BUS_I8042 0x11
917 #define BUS_XTKBD 0x12
918 #define BUS_RS232 0x13
919 #define BUS_GAMEPORT 0x14
920 #define BUS_PARPORT 0x15
921 #define BUS_AMIGA 0x16
922 #define BUS_ADB 0x17
923 #define BUS_I2C 0x18
924 #define BUS_HOST 0x19
925 #define BUS_GSC 0x1A
926 #define BUS_ATARI 0x1B
927 #define BUS_SPI 0x1C
928
929 /*
930 * MT_TOOL types
931 */
932 #define MT_TOOL_FINGER 0
933 #define MT_TOOL_PEN 1
934 #define MT_TOOL_MAX 1
935
936 /*
937 * Values describing the status of a force-feedback effect
938 */
939 #define FF_STATUS_STOPPED 0x00
940 #define FF_STATUS_PLAYING 0x01
941 #define FF_STATUS_MAX 0x01
942
943 /*
944 * Structures used in ioctls to upload effects to a device
945 * They are pieces of a bigger structure (called ff_effect)
946 */
947
948 /*
949 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
950 * should not be used and have unspecified results.
951 */
952
953 /**
954 * struct ff_replay - defines scheduling of the force-feedback effect
955 * @length: duration of the effect
956 * @delay: delay before effect should start playing
957 */
958 struct ff_replay {
959 __u16 length;
960 __u16 delay;
961 };
962
963 /**
964 * struct ff_trigger - defines what triggers the force-feedback effect
965 * @button: number of the button triggering the effect
966 * @interval: controls how soon the effect can be re-triggered
967 */
968 struct ff_trigger {
969 __u16 button;
970 __u16 interval;
971 };
972
973 /**
974 * struct ff_envelope - generic force-feedback effect envelope
975 * @attack_length: duration of the attack (ms)
976 * @attack_level: level at the beginning of the attack
977 * @fade_length: duration of fade (ms)
978 * @fade_level: level at the end of fade
979 *
980 * The @attack_level and @fade_level are absolute values; when applying
981 * envelope force-feedback core will convert to positive/negative
982 * value based on polarity of the default level of the effect.
983 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
984 */
985 struct ff_envelope {
986 __u16 attack_length;
987 __u16 attack_level;
988 __u16 fade_length;
989 __u16 fade_level;
990 };
991
992 /**
993 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
994 * @level: strength of the effect; may be negative
995 * @envelope: envelope data
996 */
997 struct ff_constant_effect {
998 __s16 level;
999 struct ff_envelope envelope;
1000 };
1001
1002 /**
1003 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
1004 * @start_level: beginning strength of the effect; may be negative
1005 * @end_level: final strength of the effect; may be negative
1006 * @envelope: envelope data
1007 */
1008 struct ff_ramp_effect {
1009 __s16 start_level;
1010 __s16 end_level;
1011 struct ff_envelope envelope;
1012 };
1013
1014 /**
1015 * struct ff_condition_effect - defines a spring or friction force-feedback effect
1016 * @right_saturation: maximum level when joystick moved all way to the right
1017 * @left_saturation: same for the left side
1018 * @right_coeff: controls how fast the force grows when the joystick moves
1019 * to the right
1020 * @left_coeff: same for the left side
1021 * @deadband: size of the dead zone, where no force is produced
1022 * @center: position of the dead zone
1023 */
1024 struct ff_condition_effect {
1025 __u16 right_saturation;
1026 __u16 left_saturation;
1027
1028 __s16 right_coeff;
1029 __s16 left_coeff;
1030
1031 __u16 deadband;
1032 __s16 center;
1033 };
1034
1035 /**
1036 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
1037 * @waveform: kind of the effect (wave)
1038 * @period: period of the wave (ms)
1039 * @magnitude: peak value
1040 * @offset: mean value of the wave (roughly)
1041 * @phase: 'horizontal' shift
1042 * @envelope: envelope data
1043 * @custom_len: number of samples (FF_CUSTOM only)
1044 * @custom_data: buffer of samples (FF_CUSTOM only)
1045 *
1046 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
1047 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
1048 * for the time being as no driver supports it yet.
1049 *
1050 * Note: the data pointed by custom_data is copied by the driver.
1051 * You can therefore dispose of the memory after the upload/update.
1052 */
1053 struct ff_periodic_effect {
1054 __u16 waveform;
1055 __u16 period;
1056 __s16 magnitude;
1057 __s16 offset;
1058 __u16 phase;
1059
1060 struct ff_envelope envelope;
1061
1062 __u32 custom_len;
1063 __s16 __user *custom_data;
1064 };
1065
1066 /**
1067 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
1068 * @strong_magnitude: magnitude of the heavy motor
1069 * @weak_magnitude: magnitude of the light one
1070 *
1071 * Some rumble pads have two motors of different weight. Strong_magnitude
1072 * represents the magnitude of the vibration generated by the heavy one.
1073 */
1074 struct ff_rumble_effect {
1075 __u16 strong_magnitude;
1076 __u16 weak_magnitude;
1077 };
1078
1079 /**
1080 * struct ff_effect - defines force feedback effect
1081 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
1082 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
1083 * @id: an unique id assigned to an effect
1084 * @direction: direction of the effect
1085 * @trigger: trigger conditions (struct ff_trigger)
1086 * @replay: scheduling of the effect (struct ff_replay)
1087 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
1088 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
1089 * defining effect parameters
1090 *
1091 * This structure is sent through ioctl from the application to the driver.
1092 * To create a new effect application should set its @id to -1; the kernel
1093 * will return assigned @id which can later be used to update or delete
1094 * this effect.
1095 *
1096 * Direction of the effect is encoded as follows:
1097 * 0 deg -> 0x0000 (down)
1098 * 90 deg -> 0x4000 (left)
1099 * 180 deg -> 0x8000 (up)
1100 * 270 deg -> 0xC000 (right)
1101 */
1102 struct ff_effect {
1103 __u16 type;
1104 __s16 id;
1105 __u16 direction;
1106 struct ff_trigger trigger;
1107 struct ff_replay replay;
1108
1109 union {
1110 struct ff_constant_effect constant;
1111 struct ff_ramp_effect ramp;
1112 struct ff_periodic_effect periodic;
1113 struct ff_condition_effect condition[2]; /* One for each axis */
1114 struct ff_rumble_effect rumble;
1115 } u;
1116 };
1117
1118 /*
1119 * Force feedback effect types
1120 */
1121
1122 #define FF_RUMBLE 0x50
1123 #define FF_PERIODIC 0x51
1124 #define FF_CONSTANT 0x52
1125 #define FF_SPRING 0x53
1126 #define FF_FRICTION 0x54
1127 #define FF_DAMPER 0x55
1128 #define FF_INERTIA 0x56
1129 #define FF_RAMP 0x57
1130
1131 #define FF_EFFECT_MIN FF_RUMBLE
1132 #define FF_EFFECT_MAX FF_RAMP
1133
1134 /*
1135 * Force feedback periodic effect types
1136 */
1137
1138 #define FF_SQUARE 0x58
1139 #define FF_TRIANGLE 0x59
1140 #define FF_SINE 0x5a
1141 #define FF_SAW_UP 0x5b
1142 #define FF_SAW_DOWN 0x5c
1143 #define FF_CUSTOM 0x5d
1144
1145 #define FF_WAVEFORM_MIN FF_SQUARE
1146 #define FF_WAVEFORM_MAX FF_CUSTOM
1147
1148 /*
1149 * Set ff device properties
1150 */
1151
1152 #define FF_GAIN 0x60
1153 #define FF_AUTOCENTER 0x61
1154
1155 #define FF_MAX 0x7f
1156 #define FF_CNT (FF_MAX+1)
1157
1158 #ifdef __KERNEL__
1159
1160 /*
1161 * In-kernel definitions.
1162 */
1163
1164 #include <linux/device.h>
1165 #include <linux/fs.h>
1166 #include <linux/timer.h>
1167 #include <linux/mod_devicetable.h>
1168
1169 /**
1170 * struct input_dev - represents an input device
1171 * @name: name of the device
1172 * @phys: physical path to the device in the system hierarchy
1173 * @uniq: unique identification code for the device (if device has it)
1174 * @id: id of the device (struct input_id)
1175 * @propbit: bitmap of device properties and quirks
1176 * @evbit: bitmap of types of events supported by the device (EV_KEY,
1177 * EV_REL, etc.)
1178 * @keybit: bitmap of keys/buttons this device has
1179 * @relbit: bitmap of relative axes for the device
1180 * @absbit: bitmap of absolute axes for the device
1181 * @mscbit: bitmap of miscellaneous events supported by the device
1182 * @ledbit: bitmap of leds present on the device
1183 * @sndbit: bitmap of sound effects supported by the device
1184 * @ffbit: bitmap of force feedback effects supported by the device
1185 * @swbit: bitmap of switches present on the device
1186 * @hint_events_per_packet: average number of events generated by the
1187 * device in a packet (between EV_SYN/SYN_REPORT events). Used by
1188 * event handlers to estimate size of the buffer needed to hold
1189 * events.
1190 * @keycodemax: size of keycode table
1191 * @keycodesize: size of elements in keycode table
1192 * @keycode: map of scancodes to keycodes for this device
1193 * @getkeycode: optional legacy method to retrieve current keymap.
1194 * @setkeycode: optional method to alter current keymap, used to implement
1195 * sparse keymaps. If not supplied default mechanism will be used.
1196 * The method is being called while holding event_lock and thus must
1197 * not sleep
1198 * @ff: force feedback structure associated with the device if device
1199 * supports force feedback effects
1200 * @repeat_key: stores key code of the last key pressed; used to implement
1201 * software autorepeat
1202 * @timer: timer for software autorepeat
1203 * @rep: current values for autorepeat parameters (delay, rate)
1204 * @mt: pointer to array of struct input_mt_slot holding current values
1205 * of tracked contacts
1206 * @mtsize: number of MT slots the device uses
1207 * @slot: MT slot currently being transmitted
1208 * @trkid: stores MT tracking ID for the current contact
1209 * @absinfo: array of &struct input_absinfo elements holding information
1210 * about absolute axes (current value, min, max, flat, fuzz,
1211 * resolution)
1212 * @key: reflects current state of device's keys/buttons
1213 * @led: reflects current state of device's LEDs
1214 * @snd: reflects current state of sound effects
1215 * @sw: reflects current state of device's switches
1216 * @open: this method is called when the very first user calls
1217 * input_open_device(). The driver must prepare the device
1218 * to start generating events (start polling thread,
1219 * request an IRQ, submit URB, etc.)
1220 * @close: this method is called when the very last user calls
1221 * input_close_device().
1222 * @flush: purges the device. Most commonly used to get rid of force
1223 * feedback effects loaded into the device when disconnecting
1224 * from it
1225 * @event: event handler for events sent _to_ the device, like EV_LED
1226 * or EV_SND. The device is expected to carry out the requested
1227 * action (turn on a LED, play sound, etc.) The call is protected
1228 * by @event_lock and must not sleep
1229 * @grab: input handle that currently has the device grabbed (via
1230 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1231 * recipient for all input events coming from the device
1232 * @event_lock: this spinlock is is taken when input core receives
1233 * and processes a new event for the device (in input_event()).
1234 * Code that accesses and/or modifies parameters of a device
1235 * (such as keymap or absmin, absmax, absfuzz, etc.) after device
1236 * has been registered with input core must take this lock.
1237 * @mutex: serializes calls to open(), close() and flush() methods
1238 * @users: stores number of users (input handlers) that opened this
1239 * device. It is used by input_open_device() and input_close_device()
1240 * to make sure that dev->open() is only called when the first
1241 * user opens device and dev->close() is called when the very
1242 * last user closes the device
1243 * @going_away: marks devices that are in a middle of unregistering and
1244 * causes input_open_device*() fail with -ENODEV.
1245 * @sync: set to %true when there were no new events since last EV_SYN
1246 * @dev: driver model's view of this device
1247 * @h_list: list of input handles associated with the device. When
1248 * accessing the list dev->mutex must be held
1249 * @node: used to place the device onto input_dev_list
1250 */
1251 struct input_dev {
1252 const char *name;
1253 const char *phys;
1254 const char *uniq;
1255 struct input_id id;
1256
1257 unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
1258
1259 unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1260 unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1261 unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1262 unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1263 unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1264 unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1265 unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1266 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1267 unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
1268
1269 unsigned int hint_events_per_packet;
1270
1271 unsigned int keycodemax;
1272 unsigned int keycodesize;
1273 void *keycode;
1274
1275 int (*setkeycode)(struct input_dev *dev,
1276 const struct input_keymap_entry *ke,
1277 unsigned int *old_keycode);
1278 int (*getkeycode)(struct input_dev *dev,
1279 struct input_keymap_entry *ke);
1280
1281 struct ff_device *ff;
1282
1283 unsigned int repeat_key;
1284 struct timer_list timer;
1285
1286 int rep[REP_CNT];
1287
1288 struct input_mt_slot *mt;
1289 int mtsize;
1290 int slot;
1291 int trkid;
1292
1293 struct input_absinfo *absinfo;
1294
1295 unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1296 unsigned long led[BITS_TO_LONGS(LED_CNT)];
1297 unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1298 unsigned long sw[BITS_TO_LONGS(SW_CNT)];
1299
1300 int (*open)(struct input_dev *dev);
1301 void (*close)(struct input_dev *dev);
1302 int (*flush)(struct input_dev *dev, struct file *file);
1303 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1304
1305 struct input_handle __rcu *grab;
1306
1307 spinlock_t event_lock;
1308 struct mutex mutex;
1309
1310 unsigned int users;
1311 bool going_away;
1312
1313 bool sync;
1314
1315 struct device dev;
1316
1317 struct list_head h_list;
1318 struct list_head node;
1319 };
1320 #define to_input_dev(d) container_of(d, struct input_dev, dev)
1321
1322 /*
1323 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1324 */
1325
1326 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1327 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1328 #endif
1329
1330 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1331 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1332 #endif
1333
1334 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1335 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1336 #endif
1337
1338 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1339 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1340 #endif
1341
1342 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1343 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1344 #endif
1345
1346 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1347 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1348 #endif
1349
1350 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1351 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1352 #endif
1353
1354 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1355 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1356 #endif
1357
1358 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1359 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1360 #endif
1361
1362 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1363 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1364 #endif
1365
1366 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1367 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1368 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1369 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1370
1371 struct input_handle;
1372
1373 /**
1374 * struct input_handler - implements one of interfaces for input devices
1375 * @private: driver-specific data
1376 * @event: event handler. This method is being called by input core with
1377 * interrupts disabled and dev->event_lock spinlock held and so
1378 * it may not sleep
1379 * @filter: similar to @event; separates normal event handlers from
1380 * "filters".
1381 * @match: called after comparing device's id with handler's id_table
1382 * to perform fine-grained matching between device and handler
1383 * @connect: called when attaching a handler to an input device
1384 * @disconnect: disconnects a handler from input device
1385 * @start: starts handler for given handle. This function is called by
1386 * input core right after connect() method and also when a process
1387 * that "grabbed" a device releases it
1388 * @fops: file operations this driver implements
1389 * @minor: beginning of range of 32 minors for devices this driver
1390 * can provide
1391 * @name: name of the handler, to be shown in /proc/bus/input/handlers
1392 * @id_table: pointer to a table of input_device_ids this driver can
1393 * handle
1394 * @h_list: list of input handles associated with the handler
1395 * @node: for placing the driver onto input_handler_list
1396 *
1397 * Input handlers attach to input devices and create input handles. There
1398 * are likely several handlers attached to any given input device at the
1399 * same time. All of them will get their copy of input event generated by
1400 * the device.
1401 *
1402 * The very same structure is used to implement input filters. Input core
1403 * allows filters to run first and will not pass event to regular handlers
1404 * if any of the filters indicate that the event should be filtered (by
1405 * returning %true from their filter() method).
1406 *
1407 * Note that input core serializes calls to connect() and disconnect()
1408 * methods.
1409 */
1410 struct input_handler {
1411
1412 void *private;
1413
1414 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1415 bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1416 bool (*match)(struct input_handler *handler, struct input_dev *dev);
1417 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1418 void (*disconnect)(struct input_handle *handle);
1419 void (*start)(struct input_handle *handle);
1420
1421 const struct file_operations *fops;
1422 int minor;
1423 const char *name;
1424
1425 const struct input_device_id *id_table;
1426
1427 struct list_head h_list;
1428 struct list_head node;
1429 };
1430
1431 /**
1432 * struct input_handle - links input device with an input handler
1433 * @private: handler-specific data
1434 * @open: counter showing whether the handle is 'open', i.e. should deliver
1435 * events from its device
1436 * @name: name given to the handle by handler that created it
1437 * @dev: input device the handle is attached to
1438 * @handler: handler that works with the device through this handle
1439 * @d_node: used to put the handle on device's list of attached handles
1440 * @h_node: used to put the handle on handler's list of handles from which
1441 * it gets events
1442 */
1443 struct input_handle {
1444
1445 void *private;
1446
1447 int open;
1448 const char *name;
1449
1450 struct input_dev *dev;
1451 struct input_handler *handler;
1452
1453 struct list_head d_node;
1454 struct list_head h_node;
1455 };
1456
1457 struct input_dev *input_allocate_device(void);
1458 void input_free_device(struct input_dev *dev);
1459
1460 static inline struct input_dev *input_get_device(struct input_dev *dev)
1461 {
1462 return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1463 }
1464
1465 static inline void input_put_device(struct input_dev *dev)
1466 {
1467 if (dev)
1468 put_device(&dev->dev);
1469 }
1470
1471 static inline void *input_get_drvdata(struct input_dev *dev)
1472 {
1473 return dev_get_drvdata(&dev->dev);
1474 }
1475
1476 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1477 {
1478 dev_set_drvdata(&dev->dev, data);
1479 }
1480
1481 int __must_check input_register_device(struct input_dev *);
1482 void input_unregister_device(struct input_dev *);
1483
1484 void input_reset_device(struct input_dev *);
1485
1486 int __must_check input_register_handler(struct input_handler *);
1487 void input_unregister_handler(struct input_handler *);
1488
1489 int input_handler_for_each_handle(struct input_handler *, void *data,
1490 int (*fn)(struct input_handle *, void *));
1491
1492 int input_register_handle(struct input_handle *);
1493 void input_unregister_handle(struct input_handle *);
1494
1495 int input_grab_device(struct input_handle *);
1496 void input_release_device(struct input_handle *);
1497
1498 int input_open_device(struct input_handle *);
1499 void input_close_device(struct input_handle *);
1500
1501 int input_flush_device(struct input_handle *handle, struct file *file);
1502
1503 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1504 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1505
1506 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1507 {
1508 input_event(dev, EV_KEY, code, !!value);
1509 }
1510
1511 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1512 {
1513 input_event(dev, EV_REL, code, value);
1514 }
1515
1516 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1517 {
1518 input_event(dev, EV_ABS, code, value);
1519 }
1520
1521 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1522 {
1523 input_event(dev, EV_FF_STATUS, code, value);
1524 }
1525
1526 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1527 {
1528 input_event(dev, EV_SW, code, !!value);
1529 }
1530
1531 static inline void input_sync(struct input_dev *dev)
1532 {
1533 input_event(dev, EV_SYN, SYN_REPORT, 0);
1534 }
1535
1536 static inline void input_mt_sync(struct input_dev *dev)
1537 {
1538 input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
1539 }
1540
1541 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1542
1543 /**
1544 * input_set_events_per_packet - tell handlers about the driver event rate
1545 * @dev: the input device used by the driver
1546 * @n_events: the average number of events between calls to input_sync()
1547 *
1548 * If the event rate sent from a device is unusually large, use this
1549 * function to set the expected event rate. This will allow handlers
1550 * to set up an appropriate buffer size for the event stream, in order
1551 * to minimize information loss.
1552 */
1553 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
1554 {
1555 dev->hint_events_per_packet = n_events;
1556 }
1557
1558 void input_alloc_absinfo(struct input_dev *dev);
1559 void input_set_abs_params(struct input_dev *dev, unsigned int axis,
1560 int min, int max, int fuzz, int flat);
1561
1562 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item) \
1563 static inline int input_abs_get_##_suffix(struct input_dev *dev, \
1564 unsigned int axis) \
1565 { \
1566 return dev->absinfo ? dev->absinfo[axis]._item : 0; \
1567 } \
1568 \
1569 static inline void input_abs_set_##_suffix(struct input_dev *dev, \
1570 unsigned int axis, int val) \
1571 { \
1572 input_alloc_absinfo(dev); \
1573 if (dev->absinfo) \
1574 dev->absinfo[axis]._item = val; \
1575 }
1576
1577 INPUT_GENERATE_ABS_ACCESSORS(val, value)
1578 INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
1579 INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
1580 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
1581 INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
1582 INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
1583
1584 int input_scancode_to_scalar(const struct input_keymap_entry *ke,
1585 unsigned int *scancode);
1586
1587 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
1588 int input_set_keycode(struct input_dev *dev,
1589 const struct input_keymap_entry *ke);
1590
1591 extern struct class input_class;
1592
1593 /**
1594 * struct ff_device - force-feedback part of an input device
1595 * @upload: Called to upload an new effect into device
1596 * @erase: Called to erase an effect from device
1597 * @playback: Called to request device to start playing specified effect
1598 * @set_gain: Called to set specified gain
1599 * @set_autocenter: Called to auto-center device
1600 * @destroy: called by input core when parent input device is being
1601 * destroyed
1602 * @private: driver-specific data, will be freed automatically
1603 * @ffbit: bitmap of force feedback capabilities truly supported by
1604 * device (not emulated like ones in input_dev->ffbit)
1605 * @mutex: mutex for serializing access to the device
1606 * @max_effects: maximum number of effects supported by device
1607 * @effects: pointer to an array of effects currently loaded into device
1608 * @effect_owners: array of effect owners; when file handle owning
1609 * an effect gets closed the effect is automatically erased
1610 *
1611 * Every force-feedback device must implement upload() and playback()
1612 * methods; erase() is optional. set_gain() and set_autocenter() need
1613 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1614 * bits.
1615 *
1616 * Note that playback(), set_gain() and set_autocenter() are called with
1617 * dev->event_lock spinlock held and interrupts off and thus may not
1618 * sleep.
1619 */
1620 struct ff_device {
1621 int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1622 struct ff_effect *old);
1623 int (*erase)(struct input_dev *dev, int effect_id);
1624
1625 int (*playback)(struct input_dev *dev, int effect_id, int value);
1626 void (*set_gain)(struct input_dev *dev, u16 gain);
1627 void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1628
1629 void (*destroy)(struct ff_device *);
1630
1631 void *private;
1632
1633 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1634
1635 struct mutex mutex;
1636
1637 int max_effects;
1638 struct ff_effect *effects;
1639 struct file *effect_owners[];
1640 };
1641
1642 int input_ff_create(struct input_dev *dev, unsigned int max_effects);
1643 void input_ff_destroy(struct input_dev *dev);
1644
1645 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1646
1647 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1648 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1649
1650 int input_ff_create_memless(struct input_dev *dev, void *data,
1651 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
1652
1653 #endif
1654 #endif