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.
13 #include <linux/time.h>
14 #include <linux/list.h>
17 #include <sys/ioctl.h>
18 #include <sys/types.h>
19 #include <asm/types.h>
23 * The event structure itself
37 #define EV_VERSION 0x010000
40 * IOCTLs (0x00 - 0x7f)
50 struct input_absinfo {
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 */
99 #define EV_FF_STATUS 0x17
101 #define EV_CNT (EV_MAX+1)
104 * Synchronization events.
113 * Most of the keys/buttons are modeled after USB HUT 1.12
114 * (see http://www.usb.org/developers/hidpage).
115 * Abbreviations in the comments:
116 * AC - Application Control
117 * AL - Application Launch Button
118 * SC - System Control
121 #define KEY_RESERVED 0
135 #define KEY_BACKSPACE 14
147 #define KEY_LEFTBRACE 26
148 #define KEY_RIGHTBRACE 27
150 #define KEY_LEFTCTRL 29
160 #define KEY_SEMICOLON 39
161 #define KEY_APOSTROPHE 40
163 #define KEY_LEFTSHIFT 42
164 #define KEY_BACKSLASH 43
175 #define KEY_RIGHTSHIFT 54
176 #define KEY_KPASTERISK 55
177 #define KEY_LEFTALT 56
179 #define KEY_CAPSLOCK 58
190 #define KEY_NUMLOCK 69
191 #define KEY_SCROLLLOCK 70
195 #define KEY_KPMINUS 74
199 #define KEY_KPPLUS 78
206 #define KEY_ZENKAKUHANKAKU 85
211 #define KEY_KATAKANA 90
212 #define KEY_HIRAGANA 91
213 #define KEY_HENKAN 92
214 #define KEY_KATAKANAHIRAGANA 93
215 #define KEY_MUHENKAN 94
216 #define KEY_KPJPCOMMA 95
217 #define KEY_KPENTER 96
218 #define KEY_RIGHTCTRL 97
219 #define KEY_KPSLASH 98
221 #define KEY_RIGHTALT 100
222 #define KEY_LINEFEED 101
225 #define KEY_PAGEUP 104
227 #define KEY_RIGHT 106
230 #define KEY_PAGEDOWN 109
231 #define KEY_INSERT 110
232 #define KEY_DELETE 111
233 #define KEY_MACRO 112
235 #define KEY_VOLUMEDOWN 114
236 #define KEY_VOLUMEUP 115
237 #define KEY_POWER 116 /* SC System Power Down */
238 #define KEY_KPEQUAL 117
239 #define KEY_KPPLUSMINUS 118
240 #define KEY_PAUSE 119
242 #define KEY_KPCOMMA 121
243 #define KEY_HANGEUL 122
244 #define KEY_HANGUEL KEY_HANGEUL
245 #define KEY_HANJA 123
247 #define KEY_LEFTMETA 125
248 #define KEY_RIGHTMETA 126
249 #define KEY_COMPOSE 127
251 #define KEY_STOP 128 /* AC Stop */
252 #define KEY_AGAIN 129
253 #define KEY_PROPS 130 /* AC Properties */
254 #define KEY_UNDO 131 /* AC Undo */
255 #define KEY_FRONT 132
256 #define KEY_COPY 133 /* AC Copy */
257 #define KEY_OPEN 134 /* AC Open */
258 #define KEY_PASTE 135 /* AC Paste */
259 #define KEY_FIND 136 /* AC Search */
260 #define KEY_CUT 137 /* AC Cut */
261 #define KEY_HELP 138 /* AL Integrated Help Center */
262 #define KEY_MENU 139 /* Menu (show menu) */
263 #define KEY_CALC 140 /* AL Calculator */
264 #define KEY_SETUP 141
265 #define KEY_SLEEP 142 /* SC System Sleep */
266 #define KEY_WAKEUP 143 /* System Wake Up */
267 #define KEY_FILE 144 /* AL Local Machine Browser */
268 #define KEY_SENDFILE 145
269 #define KEY_DELETEFILE 146
271 #define KEY_PROG1 148
272 #define KEY_PROG2 149
273 #define KEY_WWW 150 /* AL Internet Browser */
274 #define KEY_MSDOS 151
275 #define KEY_COFFEE 152 /* AL Terminal Lock/Screensaver */
276 #define KEY_SCREENLOCK KEY_COFFEE
277 #define KEY_DIRECTION 153
278 #define KEY_CYCLEWINDOWS 154
280 #define KEY_BOOKMARKS 156 /* AC Bookmarks */
281 #define KEY_COMPUTER 157
282 #define KEY_BACK 158 /* AC Back */
283 #define KEY_FORWARD 159 /* AC Forward */
284 #define KEY_CLOSECD 160
285 #define KEY_EJECTCD 161
286 #define KEY_EJECTCLOSECD 162
287 #define KEY_NEXTSONG 163
288 #define KEY_PLAYPAUSE 164
289 #define KEY_PREVIOUSSONG 165
290 #define KEY_STOPCD 166
291 #define KEY_RECORD 167
292 #define KEY_REWIND 168
293 #define KEY_PHONE 169 /* Media Select Telephone */
295 #define KEY_CONFIG 171 /* AL Consumer Control Configuration */
296 #define KEY_HOMEPAGE 172 /* AC Home */
297 #define KEY_REFRESH 173 /* AC Refresh */
298 #define KEY_EXIT 174 /* AC Exit */
301 #define KEY_SCROLLUP 177
302 #define KEY_SCROLLDOWN 178
303 #define KEY_KPLEFTPAREN 179
304 #define KEY_KPRIGHTPAREN 180
305 #define KEY_NEW 181 /* AC New */
306 #define KEY_REDO 182 /* AC Redo/Repeat */
321 #define KEY_PLAYCD 200
322 #define KEY_PAUSECD 201
323 #define KEY_PROG3 202
324 #define KEY_PROG4 203
325 #define KEY_SUSPEND 205
326 #define KEY_CLOSE 206 /* AC Close */
328 #define KEY_FASTFORWARD 208
329 #define KEY_BASSBOOST 209
330 #define KEY_PRINT 210 /* AC Print */
332 #define KEY_CAMERA 212
333 #define KEY_SOUND 213
334 #define KEY_QUESTION 214
335 #define KEY_EMAIL 215
337 #define KEY_SEARCH 217
338 #define KEY_CONNECT 218
339 #define KEY_FINANCE 219 /* AL Checkbook/Finance */
340 #define KEY_SPORT 220
342 #define KEY_ALTERASE 222
343 #define KEY_CANCEL 223 /* AC Cancel */
344 #define KEY_BRIGHTNESSDOWN 224
345 #define KEY_BRIGHTNESSUP 225
346 #define KEY_MEDIA 226
348 #define KEY_SWITCHVIDEOMODE 227 /* Cycle between available video
349 outputs (Monitor/LCD/TV-out/etc) */
350 #define KEY_KBDILLUMTOGGLE 228
351 #define KEY_KBDILLUMDOWN 229
352 #define KEY_KBDILLUMUP 230
354 #define KEY_SEND 231 /* AC Send */
355 #define KEY_REPLY 232 /* AC Reply */
356 #define KEY_FORWARDMAIL 233 /* AC Forward Msg */
357 #define KEY_SAVE 234 /* AC Save */
358 #define KEY_DOCUMENTS 235
360 #define KEY_BATTERY 236
362 #define KEY_BLUETOOTH 237
366 #define KEY_UNKNOWN 240
368 #define KEY_VIDEO_NEXT 241 /* drive next video source */
369 #define KEY_VIDEO_PREV 242 /* drive previous video source */
370 #define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */
371 #define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */
372 #define KEY_DISPLAY_OFF 245 /* display device to off state */
374 #define KEY_WIMAX 246
376 /* Range 248 - 255 is reserved for special needs of AT keyboard driver */
378 #define BTN_MISC 0x100
390 #define BTN_MOUSE 0x110
391 #define BTN_LEFT 0x110
392 #define BTN_RIGHT 0x111
393 #define BTN_MIDDLE 0x112
394 #define BTN_SIDE 0x113
395 #define BTN_EXTRA 0x114
396 #define BTN_FORWARD 0x115
397 #define BTN_BACK 0x116
398 #define BTN_TASK 0x117
400 #define BTN_JOYSTICK 0x120
401 #define BTN_TRIGGER 0x120
402 #define BTN_THUMB 0x121
403 #define BTN_THUMB2 0x122
404 #define BTN_TOP 0x123
405 #define BTN_TOP2 0x124
406 #define BTN_PINKIE 0x125
407 #define BTN_BASE 0x126
408 #define BTN_BASE2 0x127
409 #define BTN_BASE3 0x128
410 #define BTN_BASE4 0x129
411 #define BTN_BASE5 0x12a
412 #define BTN_BASE6 0x12b
413 #define BTN_DEAD 0x12f
415 #define BTN_GAMEPAD 0x130
424 #define BTN_TL2 0x138
425 #define BTN_TR2 0x139
426 #define BTN_SELECT 0x13a
427 #define BTN_START 0x13b
428 #define BTN_MODE 0x13c
429 #define BTN_THUMBL 0x13d
430 #define BTN_THUMBR 0x13e
432 #define BTN_DIGI 0x140
433 #define BTN_TOOL_PEN 0x140
434 #define BTN_TOOL_RUBBER 0x141
435 #define BTN_TOOL_BRUSH 0x142
436 #define BTN_TOOL_PENCIL 0x143
437 #define BTN_TOOL_AIRBRUSH 0x144
438 #define BTN_TOOL_FINGER 0x145
439 #define BTN_TOOL_MOUSE 0x146
440 #define BTN_TOOL_LENS 0x147
441 #define BTN_TOUCH 0x14a
442 #define BTN_STYLUS 0x14b
443 #define BTN_STYLUS2 0x14c
444 #define BTN_TOOL_DOUBLETAP 0x14d
445 #define BTN_TOOL_TRIPLETAP 0x14e
447 #define BTN_WHEEL 0x150
448 #define BTN_GEAR_DOWN 0x150
449 #define BTN_GEAR_UP 0x151
452 #define KEY_SELECT 0x161
453 #define KEY_GOTO 0x162
454 #define KEY_CLEAR 0x163
455 #define KEY_POWER2 0x164
456 #define KEY_OPTION 0x165
457 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
458 #define KEY_TIME 0x167
459 #define KEY_VENDOR 0x168
460 #define KEY_ARCHIVE 0x169
461 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */
462 #define KEY_CHANNEL 0x16b
463 #define KEY_FAVORITES 0x16c
464 #define KEY_EPG 0x16d
465 #define KEY_PVR 0x16e /* Media Select Home */
466 #define KEY_MHP 0x16f
467 #define KEY_LANGUAGE 0x170
468 #define KEY_TITLE 0x171
469 #define KEY_SUBTITLE 0x172
470 #define KEY_ANGLE 0x173
471 #define KEY_ZOOM 0x174
472 #define KEY_MODE 0x175
473 #define KEY_KEYBOARD 0x176
474 #define KEY_SCREEN 0x177
475 #define KEY_PC 0x178 /* Media Select Computer */
476 #define KEY_TV 0x179 /* Media Select TV */
477 #define KEY_TV2 0x17a /* Media Select Cable */
478 #define KEY_VCR 0x17b /* Media Select VCR */
479 #define KEY_VCR2 0x17c /* VCR Plus */
480 #define KEY_SAT 0x17d /* Media Select Satellite */
481 #define KEY_SAT2 0x17e
482 #define KEY_CD 0x17f /* Media Select CD */
483 #define KEY_TAPE 0x180 /* Media Select Tape */
484 #define KEY_RADIO 0x181
485 #define KEY_TUNER 0x182 /* Media Select Tuner */
486 #define KEY_PLAYER 0x183
487 #define KEY_TEXT 0x184
488 #define KEY_DVD 0x185 /* Media Select DVD */
489 #define KEY_AUX 0x186
490 #define KEY_MP3 0x187
491 #define KEY_AUDIO 0x188
492 #define KEY_VIDEO 0x189
493 #define KEY_DIRECTORY 0x18a
494 #define KEY_LIST 0x18b
495 #define KEY_MEMO 0x18c /* Media Select Messages */
496 #define KEY_CALENDAR 0x18d
497 #define KEY_RED 0x18e
498 #define KEY_GREEN 0x18f
499 #define KEY_YELLOW 0x190
500 #define KEY_BLUE 0x191
501 #define KEY_CHANNELUP 0x192 /* Channel Increment */
502 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
503 #define KEY_FIRST 0x194
504 #define KEY_LAST 0x195 /* Recall Last */
506 #define KEY_NEXT 0x197
507 #define KEY_RESTART 0x198
508 #define KEY_SLOW 0x199
509 #define KEY_SHUFFLE 0x19a
510 #define KEY_BREAK 0x19b
511 #define KEY_PREVIOUS 0x19c
512 #define KEY_DIGITS 0x19d
513 #define KEY_TEEN 0x19e
514 #define KEY_TWEN 0x19f
515 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
516 #define KEY_GAMES 0x1a1 /* Media Select Games */
517 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
518 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
519 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
520 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
521 #define KEY_EDITOR 0x1a6 /* AL Text Editor */
522 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
523 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
524 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
525 #define KEY_DATABASE 0x1aa /* AL Database App */
526 #define KEY_NEWS 0x1ab /* AL Newsreader */
527 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
528 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
529 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
530 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
531 #define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */
532 #define KEY_LOGOFF 0x1b1 /* AL Logoff */
534 #define KEY_DOLLAR 0x1b2
535 #define KEY_EURO 0x1b3
537 #define KEY_FRAMEBACK 0x1b4 /* Consumer - transport controls */
538 #define KEY_FRAMEFORWARD 0x1b5
539 #define KEY_CONTEXT_MENU 0x1b6 /* GenDesc - system context menu */
540 #define KEY_MEDIA_REPEAT 0x1b7 /* Consumer - transport control */
542 #define KEY_DEL_EOL 0x1c0
543 #define KEY_DEL_EOS 0x1c1
544 #define KEY_INS_LINE 0x1c2
545 #define KEY_DEL_LINE 0x1c3
548 #define KEY_FN_ESC 0x1d1
549 #define KEY_FN_F1 0x1d2
550 #define KEY_FN_F2 0x1d3
551 #define KEY_FN_F3 0x1d4
552 #define KEY_FN_F4 0x1d5
553 #define KEY_FN_F5 0x1d6
554 #define KEY_FN_F6 0x1d7
555 #define KEY_FN_F7 0x1d8
556 #define KEY_FN_F8 0x1d9
557 #define KEY_FN_F9 0x1da
558 #define KEY_FN_F10 0x1db
559 #define KEY_FN_F11 0x1dc
560 #define KEY_FN_F12 0x1dd
561 #define KEY_FN_1 0x1de
562 #define KEY_FN_2 0x1df
563 #define KEY_FN_D 0x1e0
564 #define KEY_FN_E 0x1e1
565 #define KEY_FN_F 0x1e2
566 #define KEY_FN_S 0x1e3
567 #define KEY_FN_B 0x1e4
569 #define KEY_BRL_DOT1 0x1f1
570 #define KEY_BRL_DOT2 0x1f2
571 #define KEY_BRL_DOT3 0x1f3
572 #define KEY_BRL_DOT4 0x1f4
573 #define KEY_BRL_DOT5 0x1f5
574 #define KEY_BRL_DOT6 0x1f6
575 #define KEY_BRL_DOT7 0x1f7
576 #define KEY_BRL_DOT8 0x1f8
577 #define KEY_BRL_DOT9 0x1f9
578 #define KEY_BRL_DOT10 0x1fa
580 /* We avoid low common keys in module aliases so they don't get huge. */
581 #define KEY_MIN_INTERESTING KEY_MUTE
582 #define KEY_MAX 0x1ff
583 #define KEY_CNT (KEY_MAX+1)
595 #define REL_HWHEEL 0x06
596 #define REL_DIAL 0x07
597 #define REL_WHEEL 0x08
598 #define REL_MISC 0x09
600 #define REL_CNT (REL_MAX+1)
612 #define ABS_THROTTLE 0x06
613 #define ABS_RUDDER 0x07
614 #define ABS_WHEEL 0x08
616 #define ABS_BRAKE 0x0a
617 #define ABS_HAT0X 0x10
618 #define ABS_HAT0Y 0x11
619 #define ABS_HAT1X 0x12
620 #define ABS_HAT1Y 0x13
621 #define ABS_HAT2X 0x14
622 #define ABS_HAT2Y 0x15
623 #define ABS_HAT3X 0x16
624 #define ABS_HAT3Y 0x17
625 #define ABS_PRESSURE 0x18
626 #define ABS_DISTANCE 0x19
627 #define ABS_TILT_X 0x1a
628 #define ABS_TILT_Y 0x1b
629 #define ABS_TOOL_WIDTH 0x1c
630 #define ABS_VOLUME 0x20
631 #define ABS_MISC 0x28
633 #define ABS_CNT (ABS_MAX+1)
639 #define SW_LID 0x00 /* set = lid shut */
640 #define SW_TABLET_MODE 0x01 /* set = tablet mode */
641 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
642 #define SW_RFKILL_ALL 0x03 /* rfkill master switch, type "any"
643 set = radio enabled */
644 #define SW_RADIO SW_RFKILL_ALL /* deprecated */
645 #define SW_MICROPHONE_INSERT 0x04 /* set = inserted */
646 #define SW_DOCK 0x05 /* set = plugged into dock */
647 #define SW_LINEOUT_INSERT 0x06 /* set = inserted */
649 #define SW_CNT (SW_MAX+1)
655 #define MSC_SERIAL 0x00
656 #define MSC_PULSELED 0x01
657 #define MSC_GESTURE 0x02
659 #define MSC_SCAN 0x04
661 #define MSC_CNT (MSC_MAX+1)
667 #define LED_NUML 0x00
668 #define LED_CAPSL 0x01
669 #define LED_SCROLLL 0x02
670 #define LED_COMPOSE 0x03
671 #define LED_KANA 0x04
672 #define LED_SLEEP 0x05
673 #define LED_SUSPEND 0x06
674 #define LED_MUTE 0x07
675 #define LED_MISC 0x08
676 #define LED_MAIL 0x09
677 #define LED_CHARGING 0x0a
679 #define LED_CNT (LED_MAX+1)
685 #define REP_DELAY 0x00
686 #define REP_PERIOD 0x01
693 #define SND_CLICK 0x00
694 #define SND_BELL 0x01
695 #define SND_TONE 0x02
697 #define SND_CNT (SND_MAX+1)
709 #define BUS_ISAPNP 0x02
712 #define BUS_BLUETOOTH 0x05
713 #define BUS_VIRTUAL 0x06
716 #define BUS_I8042 0x11
717 #define BUS_XTKBD 0x12
718 #define BUS_RS232 0x13
719 #define BUS_GAMEPORT 0x14
720 #define BUS_PARPORT 0x15
721 #define BUS_AMIGA 0x16
724 #define BUS_HOST 0x19
726 #define BUS_ATARI 0x1B
729 * Values describing the status of a force-feedback effect
731 #define FF_STATUS_STOPPED 0x00
732 #define FF_STATUS_PLAYING 0x01
733 #define FF_STATUS_MAX 0x01
736 * Structures used in ioctls to upload effects to a device
737 * They are pieces of a bigger structure (called ff_effect)
741 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
742 * should not be used and have unspecified results.
746 * struct ff_replay - defines scheduling of the force-feedback effect
747 * @length: duration of the effect
748 * @delay: delay before effect should start playing
756 * struct ff_trigger - defines what triggers the force-feedback effect
757 * @button: number of the button triggering the effect
758 * @interval: controls how soon the effect can be re-triggered
766 * struct ff_envelope - generic force-feedback effect envelope
767 * @attack_length: duration of the attack (ms)
768 * @attack_level: level at the beginning of the attack
769 * @fade_length: duration of fade (ms)
770 * @fade_level: level at the end of fade
772 * The @attack_level and @fade_level are absolute values; when applying
773 * envelope force-feedback core will convert to positive/negative
774 * value based on polarity of the default level of the effect.
775 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
785 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
786 * @level: strength of the effect; may be negative
787 * @envelope: envelope data
789 struct ff_constant_effect {
791 struct ff_envelope envelope;
795 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
796 * @start_level: beginning strength of the effect; may be negative
797 * @end_level: final strength of the effect; may be negative
798 * @envelope: envelope data
800 struct ff_ramp_effect {
803 struct ff_envelope envelope;
807 * struct ff_condition_effect - defines a spring or friction force-feedback effect
808 * @right_saturation: maximum level when joystick moved all way to the right
809 * @left_saturation: same for the left side
810 * @right_coeff: controls how fast the force grows when the joystick moves
812 * @left_coeff: same for the left side
813 * @deadband: size of the dead zone, where no force is produced
814 * @center: position of the dead zone
816 struct ff_condition_effect {
817 __u16 right_saturation;
818 __u16 left_saturation;
828 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
829 * @waveform: kind of the effect (wave)
830 * @period: period of the wave (ms)
831 * @magnitude: peak value
832 * @offset: mean value of the wave (roughly)
833 * @phase: 'horizontal' shift
834 * @envelope: envelope data
835 * @custom_len: number of samples (FF_CUSTOM only)
836 * @custom_data: buffer of samples (FF_CUSTOM only)
838 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
839 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
840 * for the time being as no driver supports it yet.
842 * Note: the data pointed by custom_data is copied by the driver.
843 * You can therefore dispose of the memory after the upload/update.
845 struct ff_periodic_effect {
852 struct ff_envelope envelope;
859 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
860 * @strong_magnitude: magnitude of the heavy motor
861 * @weak_magnitude: magnitude of the light one
863 * Some rumble pads have two motors of different weight. Strong_magnitude
864 * represents the magnitude of the vibration generated by the heavy one.
866 struct ff_rumble_effect {
867 __u16 strong_magnitude;
868 __u16 weak_magnitude;
872 * struct ff_effect - defines force feedback effect
873 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
874 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
875 * @id: an unique id assigned to an effect
876 * @direction: direction of the effect
877 * @trigger: trigger conditions (struct ff_trigger)
878 * @replay: scheduling of the effect (struct ff_replay)
879 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
880 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
881 * defining effect parameters
883 * This structure is sent through ioctl from the application to the driver.
884 * To create a new effect application should set its @id to -1; the kernel
885 * will return assigned @id which can later be used to update or delete
888 * Direction of the effect is encoded as follows:
889 * 0 deg -> 0x0000 (down)
890 * 90 deg -> 0x4000 (left)
891 * 180 deg -> 0x8000 (up)
892 * 270 deg -> 0xC000 (right)
898 struct ff_trigger trigger;
899 struct ff_replay replay;
902 struct ff_constant_effect constant;
903 struct ff_ramp_effect ramp;
904 struct ff_periodic_effect periodic;
905 struct ff_condition_effect condition[2]; /* One for each axis */
906 struct ff_rumble_effect rumble;
911 * Force feedback effect types
914 #define FF_RUMBLE 0x50
915 #define FF_PERIODIC 0x51
916 #define FF_CONSTANT 0x52
917 #define FF_SPRING 0x53
918 #define FF_FRICTION 0x54
919 #define FF_DAMPER 0x55
920 #define FF_INERTIA 0x56
923 #define FF_EFFECT_MIN FF_RUMBLE
924 #define FF_EFFECT_MAX FF_RAMP
927 * Force feedback periodic effect types
930 #define FF_SQUARE 0x58
931 #define FF_TRIANGLE 0x59
933 #define FF_SAW_UP 0x5b
934 #define FF_SAW_DOWN 0x5c
935 #define FF_CUSTOM 0x5d
937 #define FF_WAVEFORM_MIN FF_SQUARE
938 #define FF_WAVEFORM_MAX FF_CUSTOM
941 * Set ff device properties
945 #define FF_AUTOCENTER 0x61
948 #define FF_CNT (FF_MAX+1)
953 * In-kernel definitions.
956 #include <linux/device.h>
957 #include <linux/fs.h>
958 #include <linux/timer.h>
959 #include <linux/mod_devicetable.h>
962 * struct input_dev - represents an input device
963 * @name: name of the device
964 * @phys: physical path to the device in the system hierarchy
965 * @uniq: unique identification code for the device (if device has it)
966 * @id: id of the device (struct input_id)
967 * @evbit: bitmap of types of events supported by the device (EV_KEY,
969 * @keybit: bitmap of keys/buttons this device has
970 * @relbit: bitmap of relative axes for the device
971 * @absbit: bitmap of absolute axes for the device
972 * @mscbit: bitmap of miscellaneous events supported by the device
973 * @ledbit: bitmap of leds present on the device
974 * @sndbit: bitmap of sound effects supported by the device
975 * @ffbit: bitmap of force feedback effects supported by the device
976 * @swbit: bitmap of switches present on the device
977 * @keycodemax: size of keycode table
978 * @keycodesize: size of elements in keycode table
979 * @keycode: map of scancodes to keycodes for this device
980 * @setkeycode: optional method to alter current keymap, used to implement
981 * sparse keymaps. If not supplied default mechanism will be used
982 * @getkeycode: optional method to retrieve current keymap. If not supplied
983 * default mechanism will be used
984 * @ff: force feedback structure associated with the device if device
985 * supports force feedback effects
986 * @repeat_key: stores key code of the last key pressed; used to implement
987 * software autorepeat
988 * @timer: timer for software autorepeat
989 * @sync: set to 1 when there were no new events since last EV_SYNC
990 * @abs: current values for reports from absolute axes
991 * @rep: current values for autorepeat parameters (delay, rate)
992 * @key: reflects current state of device's keys/buttons
993 * @led: reflects current state of device's LEDs
994 * @snd: reflects current state of sound effects
995 * @sw: reflects current state of device's switches
996 * @absmax: maximum values for events coming from absolute axes
997 * @absmin: minimum values for events coming from absolute axes
998 * @absfuzz: describes noisiness for axes
999 * @absflat: size of the center flat position (used by joydev)
1000 * @open: this method is called when the very first user calls
1001 * input_open_device(). The driver must prepare the device
1002 * to start generating events (start polling thread,
1003 * request an IRQ, submit URB, etc.)
1004 * @close: this method is called when the very last user calls
1005 * input_close_device().
1006 * @flush: purges the device. Most commonly used to get rid of force
1007 * feedback effects loaded into the device when disconnecting
1009 * @event: event handler for events sent _to_ the device, like EV_LED
1010 * or EV_SND. The device is expected to carry out the requested
1011 * action (turn on a LED, play sound, etc.) The call is protected
1012 * by @event_lock and must not sleep
1013 * @grab: input handle that currently has the device grabbed (via
1014 * EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
1015 * recipient for all input events coming from the device
1016 * @event_lock: this spinlock is is taken when input core receives
1017 * and processes a new event for the device (in input_event()).
1018 * Code that accesses and/or modifies parameters of a device
1019 * (such as keymap or absmin, absmax, absfuzz, etc.) after device
1020 * has been registered with input core must take this lock.
1021 * @mutex: serializes calls to open(), close() and flush() methods
1022 * @users: stores number of users (input handlers) that opened this
1023 * device. It is used by input_open_device() and input_close_device()
1024 * to make sure that dev->open() is only called when the first
1025 * user opens device and dev->close() is called when the very
1026 * last user closes the device
1027 * @going_away: marks devices that are in a middle of unregistering and
1028 * causes input_open_device*() fail with -ENODEV.
1029 * @dev: driver model's view of this device
1030 * @h_list: list of input handles associated with the device. When
1031 * accessing the list dev->mutex must be held
1032 * @node: used to place the device onto input_dev_list
1040 unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
1041 unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
1042 unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
1043 unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
1044 unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
1045 unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
1046 unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
1047 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1048 unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
1050 unsigned int keycodemax;
1051 unsigned int keycodesize;
1053 int (*setkeycode)(struct input_dev *dev, int scancode, int keycode);
1054 int (*getkeycode)(struct input_dev *dev, int scancode, int *keycode);
1056 struct ff_device *ff;
1058 unsigned int repeat_key;
1059 struct timer_list timer;
1063 int abs[ABS_MAX + 1];
1064 int rep[REP_MAX + 1];
1066 unsigned long key[BITS_TO_LONGS(KEY_CNT)];
1067 unsigned long led[BITS_TO_LONGS(LED_CNT)];
1068 unsigned long snd[BITS_TO_LONGS(SND_CNT)];
1069 unsigned long sw[BITS_TO_LONGS(SW_CNT)];
1071 int absmax[ABS_MAX + 1];
1072 int absmin[ABS_MAX + 1];
1073 int absfuzz[ABS_MAX + 1];
1074 int absflat[ABS_MAX + 1];
1076 int (*open)(struct input_dev *dev);
1077 void (*close)(struct input_dev *dev);
1078 int (*flush)(struct input_dev *dev, struct file *file);
1079 int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1081 struct input_handle *grab;
1083 spinlock_t event_lock;
1091 struct list_head h_list;
1092 struct list_head node;
1094 #define to_input_dev(d) container_of(d, struct input_dev, dev)
1097 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1100 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1101 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1104 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1105 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1108 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1109 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1112 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1113 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1116 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1117 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1120 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1121 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1124 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1125 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1128 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1129 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1132 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1133 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1136 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1137 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1140 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1141 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1142 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1143 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1145 struct input_handle;
1148 * struct input_handler - implements one of interfaces for input devices
1149 * @private: driver-specific data
1150 * @event: event handler. This method is being called by input core with
1151 * interrupts disabled and dev->event_lock spinlock held and so
1153 * @connect: called when attaching a handler to an input device
1154 * @disconnect: disconnects a handler from input device
1155 * @start: starts handler for given handle. This function is called by
1156 * input core right after connect() method and also when a process
1157 * that "grabbed" a device releases it
1158 * @fops: file operations this driver implements
1159 * @minor: beginning of range of 32 minors for devices this driver
1161 * @name: name of the handler, to be shown in /proc/bus/input/handlers
1162 * @id_table: pointer to a table of input_device_ids this driver can
1164 * @blacklist: pointer to a table of input_device_ids this driver should
1165 * ignore even if they match @id_table
1166 * @h_list: list of input handles associated with the handler
1167 * @node: for placing the driver onto input_handler_list
1169 * Input handlers attach to input devices and create input handles. There
1170 * are likely several handlers attached to any given input device at the
1171 * same time. All of them will get their copy of input event generated by
1174 * Note that input core serializes calls to connect() and disconnect()
1177 struct input_handler {
1181 void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1182 int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
1183 void (*disconnect)(struct input_handle *handle);
1184 void (*start)(struct input_handle *handle);
1186 const struct file_operations *fops;
1190 const struct input_device_id *id_table;
1191 const struct input_device_id *blacklist;
1193 struct list_head h_list;
1194 struct list_head node;
1198 * struct input_handle - links input device with an input handler
1199 * @private: handler-specific data
1200 * @open: counter showing whether the handle is 'open', i.e. should deliver
1201 * events from its device
1202 * @name: name given to the handle by handler that created it
1203 * @dev: input device the handle is attached to
1204 * @handler: handler that works with the device through this handle
1205 * @d_node: used to put the handle on device's list of attached handles
1206 * @h_node: used to put the handle on handler's list of handles from which
1209 struct input_handle {
1216 struct input_dev *dev;
1217 struct input_handler *handler;
1219 struct list_head d_node;
1220 struct list_head h_node;
1223 struct input_dev *input_allocate_device(void);
1224 void input_free_device(struct input_dev *dev);
1226 static inline struct input_dev *input_get_device(struct input_dev *dev)
1228 return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
1231 static inline void input_put_device(struct input_dev *dev)
1234 put_device(&dev->dev);
1237 static inline void *input_get_drvdata(struct input_dev *dev)
1239 return dev_get_drvdata(&dev->dev);
1242 static inline void input_set_drvdata(struct input_dev *dev, void *data)
1244 dev_set_drvdata(&dev->dev, data);
1247 int __must_check input_register_device(struct input_dev *);
1248 void input_unregister_device(struct input_dev *);
1250 int __must_check input_register_handler(struct input_handler *);
1251 void input_unregister_handler(struct input_handler *);
1253 int input_register_handle(struct input_handle *);
1254 void input_unregister_handle(struct input_handle *);
1256 int input_grab_device(struct input_handle *);
1257 void input_release_device(struct input_handle *);
1259 int input_open_device(struct input_handle *);
1260 void input_close_device(struct input_handle *);
1262 int input_flush_device(struct input_handle* handle, struct file* file);
1264 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1265 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
1267 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
1269 input_event(dev, EV_KEY, code, !!value);
1272 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
1274 input_event(dev, EV_REL, code, value);
1277 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
1279 input_event(dev, EV_ABS, code, value);
1282 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
1284 input_event(dev, EV_FF_STATUS, code, value);
1287 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
1289 input_event(dev, EV_SW, code, !!value);
1292 static inline void input_sync(struct input_dev *dev)
1294 input_event(dev, EV_SYN, SYN_REPORT, 0);
1297 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
1299 static inline void input_set_abs_params(struct input_dev *dev, int axis, int min, int max, int fuzz, int flat)
1301 dev->absmin[axis] = min;
1302 dev->absmax[axis] = max;
1303 dev->absfuzz[axis] = fuzz;
1304 dev->absflat[axis] = flat;
1306 dev->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
1309 int input_get_keycode(struct input_dev *dev, int scancode, int *keycode);
1310 int input_set_keycode(struct input_dev *dev, int scancode, int keycode);
1312 extern struct class input_class;
1315 * struct ff_device - force-feedback part of an input device
1316 * @upload: Called to upload an new effect into device
1317 * @erase: Called to erase an effect from device
1318 * @playback: Called to request device to start playing specified effect
1319 * @set_gain: Called to set specified gain
1320 * @set_autocenter: Called to auto-center device
1321 * @destroy: called by input core when parent input device is being
1323 * @private: driver-specific data, will be freed automatically
1324 * @ffbit: bitmap of force feedback capabilities truly supported by
1325 * device (not emulated like ones in input_dev->ffbit)
1326 * @mutex: mutex for serializing access to the device
1327 * @max_effects: maximum number of effects supported by device
1328 * @effects: pointer to an array of effects currently loaded into device
1329 * @effect_owners: array of effect owners; when file handle owning
1330 * an effect gets closed the effect is automatically erased
1332 * Every force-feedback device must implement upload() and playback()
1333 * methods; erase() is optional. set_gain() and set_autocenter() need
1334 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1338 int (*upload)(struct input_dev *dev, struct ff_effect *effect,
1339 struct ff_effect *old);
1340 int (*erase)(struct input_dev *dev, int effect_id);
1342 int (*playback)(struct input_dev *dev, int effect_id, int value);
1343 void (*set_gain)(struct input_dev *dev, u16 gain);
1344 void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
1346 void (*destroy)(struct ff_device *);
1350 unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
1355 struct ff_effect *effects;
1356 struct file *effect_owners[];
1359 int input_ff_create(struct input_dev *dev, int max_effects);
1360 void input_ff_destroy(struct input_dev *dev);
1362 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
1364 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
1365 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
1367 int input_ff_create_memless(struct input_dev *dev, void *data,
1368 int (*play_effect)(struct input_dev *, void *, struct ff_effect *));