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
103 * Synchronization events.
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
134 #define KEY_BACKSPACE 14
146 #define KEY_LEFTBRACE 26
147 #define KEY_RIGHTBRACE 27
149 #define KEY_LEFTCTRL 29
159 #define KEY_SEMICOLON 39
160 #define KEY_APOSTROPHE 40
162 #define KEY_LEFTSHIFT 42
163 #define KEY_BACKSLASH 43
174 #define KEY_RIGHTSHIFT 54
175 #define KEY_KPASTERISK 55
176 #define KEY_LEFTALT 56
178 #define KEY_CAPSLOCK 58
189 #define KEY_NUMLOCK 69
190 #define KEY_SCROLLLOCK 70
194 #define KEY_KPMINUS 74
198 #define KEY_KPPLUS 78
205 #define KEY_ZENKAKUHANKAKU 85
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
220 #define KEY_RIGHTALT 100
221 #define KEY_LINEFEED 101
224 #define KEY_PAGEUP 104
226 #define KEY_RIGHT 106
229 #define KEY_PAGEDOWN 109
230 #define KEY_INSERT 110
231 #define KEY_DELETE 111
232 #define KEY_MACRO 112
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
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
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
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 */
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 */
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 */
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 */
327 #define KEY_FASTFORWARD 208
328 #define KEY_BASSBOOST 209
329 #define KEY_PRINT 210 /* AC Print */
331 #define KEY_CAMERA 212
332 #define KEY_SOUND 213
333 #define KEY_QUESTION 214
334 #define KEY_EMAIL 215
336 #define KEY_SEARCH 217
337 #define KEY_CONNECT 218
338 #define KEY_FINANCE 219 /* AL Checkbook/Finance */
339 #define KEY_SPORT 220
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
365 #define KEY_UNKNOWN 240
367 #define KEY_VIDEO_NEXT 241 /* drive next video source */
368 #define KEY_VIDEO_PREV 242 /* drive previous video source */
369 #define KEY_BRIGHTNESS_CYCLE 243 /* brightness up, after max is min */
370 #define KEY_BRIGHTNESS_ZERO 244 /* brightness off, use ambient */
371 #define KEY_DISPLAY_OFF 245 /* display device to off state */
373 #define BTN_MISC 0x100
385 #define BTN_MOUSE 0x110
386 #define BTN_LEFT 0x110
387 #define BTN_RIGHT 0x111
388 #define BTN_MIDDLE 0x112
389 #define BTN_SIDE 0x113
390 #define BTN_EXTRA 0x114
391 #define BTN_FORWARD 0x115
392 #define BTN_BACK 0x116
393 #define BTN_TASK 0x117
395 #define BTN_JOYSTICK 0x120
396 #define BTN_TRIGGER 0x120
397 #define BTN_THUMB 0x121
398 #define BTN_THUMB2 0x122
399 #define BTN_TOP 0x123
400 #define BTN_TOP2 0x124
401 #define BTN_PINKIE 0x125
402 #define BTN_BASE 0x126
403 #define BTN_BASE2 0x127
404 #define BTN_BASE3 0x128
405 #define BTN_BASE4 0x129
406 #define BTN_BASE5 0x12a
407 #define BTN_BASE6 0x12b
408 #define BTN_DEAD 0x12f
410 #define BTN_GAMEPAD 0x130
419 #define BTN_TL2 0x138
420 #define BTN_TR2 0x139
421 #define BTN_SELECT 0x13a
422 #define BTN_START 0x13b
423 #define BTN_MODE 0x13c
424 #define BTN_THUMBL 0x13d
425 #define BTN_THUMBR 0x13e
427 #define BTN_DIGI 0x140
428 #define BTN_TOOL_PEN 0x140
429 #define BTN_TOOL_RUBBER 0x141
430 #define BTN_TOOL_BRUSH 0x142
431 #define BTN_TOOL_PENCIL 0x143
432 #define BTN_TOOL_AIRBRUSH 0x144
433 #define BTN_TOOL_FINGER 0x145
434 #define BTN_TOOL_MOUSE 0x146
435 #define BTN_TOOL_LENS 0x147
436 #define BTN_TOUCH 0x14a
437 #define BTN_STYLUS 0x14b
438 #define BTN_STYLUS2 0x14c
439 #define BTN_TOOL_DOUBLETAP 0x14d
440 #define BTN_TOOL_TRIPLETAP 0x14e
442 #define BTN_WHEEL 0x150
443 #define BTN_GEAR_DOWN 0x150
444 #define BTN_GEAR_UP 0x151
447 #define KEY_SELECT 0x161
448 #define KEY_GOTO 0x162
449 #define KEY_CLEAR 0x163
450 #define KEY_POWER2 0x164
451 #define KEY_OPTION 0x165
452 #define KEY_INFO 0x166 /* AL OEM Features/Tips/Tutorial */
453 #define KEY_TIME 0x167
454 #define KEY_VENDOR 0x168
455 #define KEY_ARCHIVE 0x169
456 #define KEY_PROGRAM 0x16a /* Media Select Program Guide */
457 #define KEY_CHANNEL 0x16b
458 #define KEY_FAVORITES 0x16c
459 #define KEY_EPG 0x16d
460 #define KEY_PVR 0x16e /* Media Select Home */
461 #define KEY_MHP 0x16f
462 #define KEY_LANGUAGE 0x170
463 #define KEY_TITLE 0x171
464 #define KEY_SUBTITLE 0x172
465 #define KEY_ANGLE 0x173
466 #define KEY_ZOOM 0x174
467 #define KEY_MODE 0x175
468 #define KEY_KEYBOARD 0x176
469 #define KEY_SCREEN 0x177
470 #define KEY_PC 0x178 /* Media Select Computer */
471 #define KEY_TV 0x179 /* Media Select TV */
472 #define KEY_TV2 0x17a /* Media Select Cable */
473 #define KEY_VCR 0x17b /* Media Select VCR */
474 #define KEY_VCR2 0x17c /* VCR Plus */
475 #define KEY_SAT 0x17d /* Media Select Satellite */
476 #define KEY_SAT2 0x17e
477 #define KEY_CD 0x17f /* Media Select CD */
478 #define KEY_TAPE 0x180 /* Media Select Tape */
479 #define KEY_RADIO 0x181
480 #define KEY_TUNER 0x182 /* Media Select Tuner */
481 #define KEY_PLAYER 0x183
482 #define KEY_TEXT 0x184
483 #define KEY_DVD 0x185 /* Media Select DVD */
484 #define KEY_AUX 0x186
485 #define KEY_MP3 0x187
486 #define KEY_AUDIO 0x188
487 #define KEY_VIDEO 0x189
488 #define KEY_DIRECTORY 0x18a
489 #define KEY_LIST 0x18b
490 #define KEY_MEMO 0x18c /* Media Select Messages */
491 #define KEY_CALENDAR 0x18d
492 #define KEY_RED 0x18e
493 #define KEY_GREEN 0x18f
494 #define KEY_YELLOW 0x190
495 #define KEY_BLUE 0x191
496 #define KEY_CHANNELUP 0x192 /* Channel Increment */
497 #define KEY_CHANNELDOWN 0x193 /* Channel Decrement */
498 #define KEY_FIRST 0x194
499 #define KEY_LAST 0x195 /* Recall Last */
501 #define KEY_NEXT 0x197
502 #define KEY_RESTART 0x198
503 #define KEY_SLOW 0x199
504 #define KEY_SHUFFLE 0x19a
505 #define KEY_BREAK 0x19b
506 #define KEY_PREVIOUS 0x19c
507 #define KEY_DIGITS 0x19d
508 #define KEY_TEEN 0x19e
509 #define KEY_TWEN 0x19f
510 #define KEY_VIDEOPHONE 0x1a0 /* Media Select Video Phone */
511 #define KEY_GAMES 0x1a1 /* Media Select Games */
512 #define KEY_ZOOMIN 0x1a2 /* AC Zoom In */
513 #define KEY_ZOOMOUT 0x1a3 /* AC Zoom Out */
514 #define KEY_ZOOMRESET 0x1a4 /* AC Zoom */
515 #define KEY_WORDPROCESSOR 0x1a5 /* AL Word Processor */
516 #define KEY_EDITOR 0x1a6 /* AL Text Editor */
517 #define KEY_SPREADSHEET 0x1a7 /* AL Spreadsheet */
518 #define KEY_GRAPHICSEDITOR 0x1a8 /* AL Graphics Editor */
519 #define KEY_PRESENTATION 0x1a9 /* AL Presentation App */
520 #define KEY_DATABASE 0x1aa /* AL Database App */
521 #define KEY_NEWS 0x1ab /* AL Newsreader */
522 #define KEY_VOICEMAIL 0x1ac /* AL Voicemail */
523 #define KEY_ADDRESSBOOK 0x1ad /* AL Contacts/Address Book */
524 #define KEY_MESSENGER 0x1ae /* AL Instant Messaging */
525 #define KEY_DISPLAYTOGGLE 0x1af /* Turn display (LCD) on and off */
526 #define KEY_SPELLCHECK 0x1b0 /* AL Spell Check */
527 #define KEY_LOGOFF 0x1b1 /* AL Logoff */
529 #define KEY_DEL_EOL 0x1c0
530 #define KEY_DEL_EOS 0x1c1
531 #define KEY_INS_LINE 0x1c2
532 #define KEY_DEL_LINE 0x1c3
535 #define KEY_FN_ESC 0x1d1
536 #define KEY_FN_F1 0x1d2
537 #define KEY_FN_F2 0x1d3
538 #define KEY_FN_F3 0x1d4
539 #define KEY_FN_F4 0x1d5
540 #define KEY_FN_F5 0x1d6
541 #define KEY_FN_F6 0x1d7
542 #define KEY_FN_F7 0x1d8
543 #define KEY_FN_F8 0x1d9
544 #define KEY_FN_F9 0x1da
545 #define KEY_FN_F10 0x1db
546 #define KEY_FN_F11 0x1dc
547 #define KEY_FN_F12 0x1dd
548 #define KEY_FN_1 0x1de
549 #define KEY_FN_2 0x1df
550 #define KEY_FN_D 0x1e0
551 #define KEY_FN_E 0x1e1
552 #define KEY_FN_F 0x1e2
553 #define KEY_FN_S 0x1e3
554 #define KEY_FN_B 0x1e4
556 #define KEY_BRL_DOT1 0x1f1
557 #define KEY_BRL_DOT2 0x1f2
558 #define KEY_BRL_DOT3 0x1f3
559 #define KEY_BRL_DOT4 0x1f4
560 #define KEY_BRL_DOT5 0x1f5
561 #define KEY_BRL_DOT6 0x1f6
562 #define KEY_BRL_DOT7 0x1f7
563 #define KEY_BRL_DOT8 0x1f8
564 #define KEY_BRL_DOT9 0x1f9
565 #define KEY_BRL_DOT10 0x1fa
567 /* We avoid low common keys in module aliases so they don't get huge. */
568 #define KEY_MIN_INTERESTING KEY_MUTE
569 #define KEY_MAX 0x1ff
581 #define REL_HWHEEL 0x06
582 #define REL_DIAL 0x07
583 #define REL_WHEEL 0x08
584 #define REL_MISC 0x09
597 #define ABS_THROTTLE 0x06
598 #define ABS_RUDDER 0x07
599 #define ABS_WHEEL 0x08
601 #define ABS_BRAKE 0x0a
602 #define ABS_HAT0X 0x10
603 #define ABS_HAT0Y 0x11
604 #define ABS_HAT1X 0x12
605 #define ABS_HAT1Y 0x13
606 #define ABS_HAT2X 0x14
607 #define ABS_HAT2Y 0x15
608 #define ABS_HAT3X 0x16
609 #define ABS_HAT3Y 0x17
610 #define ABS_PRESSURE 0x18
611 #define ABS_DISTANCE 0x19
612 #define ABS_TILT_X 0x1a
613 #define ABS_TILT_Y 0x1b
614 #define ABS_TOOL_WIDTH 0x1c
615 #define ABS_VOLUME 0x20
616 #define ABS_MISC 0x28
623 #define SW_LID 0x00 /* set = lid shut */
624 #define SW_TABLET_MODE 0x01 /* set = tablet mode */
625 #define SW_HEADPHONE_INSERT 0x02 /* set = inserted */
626 #define SW_RADIO 0x03 /* set = radio enabled */
633 #define MSC_SERIAL 0x00
634 #define MSC_PULSELED 0x01
635 #define MSC_GESTURE 0x02
637 #define MSC_SCAN 0x04
644 #define LED_NUML 0x00
645 #define LED_CAPSL 0x01
646 #define LED_SCROLLL 0x02
647 #define LED_COMPOSE 0x03
648 #define LED_KANA 0x04
649 #define LED_SLEEP 0x05
650 #define LED_SUSPEND 0x06
651 #define LED_MUTE 0x07
652 #define LED_MISC 0x08
653 #define LED_MAIL 0x09
654 #define LED_CHARGING 0x0a
661 #define REP_DELAY 0x00
662 #define REP_PERIOD 0x01
669 #define SND_CLICK 0x00
670 #define SND_BELL 0x01
671 #define SND_TONE 0x02
684 #define BUS_ISAPNP 0x02
687 #define BUS_BLUETOOTH 0x05
688 #define BUS_VIRTUAL 0x06
691 #define BUS_I8042 0x11
692 #define BUS_XTKBD 0x12
693 #define BUS_RS232 0x13
694 #define BUS_GAMEPORT 0x14
695 #define BUS_PARPORT 0x15
696 #define BUS_AMIGA 0x16
699 #define BUS_HOST 0x19
701 #define BUS_ATARI 0x1B
704 * Values describing the status of a force-feedback effect
706 #define FF_STATUS_STOPPED 0x00
707 #define FF_STATUS_PLAYING 0x01
708 #define FF_STATUS_MAX 0x01
711 * Structures used in ioctls to upload effects to a device
712 * They are pieces of a bigger structure (called ff_effect)
716 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
717 * should not be used and have unspecified results.
721 * struct ff_replay - defines scheduling of the force-feedback effect
722 * @length: duration of the effect
723 * @delay: delay before effect should start playing
731 * struct ff_trigger - defines what triggers the force-feedback effect
732 * @button: number of the button triggering the effect
733 * @interval: controls how soon the effect can be re-triggered
741 * struct ff_envelope - generic force-feedback effect envelope
742 * @attack_length: duration of the attack (ms)
743 * @attack_level: level at the beginning of the attack
744 * @fade_length: duration of fade (ms)
745 * @fade_level: level at the end of fade
747 * The @attack_level and @fade_level are absolute values; when applying
748 * envelope force-feedback core will convert to positive/negative
749 * value based on polarity of the default level of the effect.
750 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
760 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
761 * @level: strength of the effect; may be negative
762 * @envelope: envelope data
764 struct ff_constant_effect
{
766 struct ff_envelope envelope
;
770 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
771 * @start_level: beginning strength of the effect; may be negative
772 * @end_level: final strength of the effect; may be negative
773 * @envelope: envelope data
775 struct ff_ramp_effect
{
778 struct ff_envelope envelope
;
782 * struct ff_condition_effect - defines a spring or friction force-feedback effect
783 * @right_saturation: maximum level when joystick moved all way to the right
784 * @left_saturation: same for the left side
785 * @right_coeff: controls how fast the force grows when the joystick moves
787 * @left_coeff: same for the left side
788 * @deadband: size of the dead zone, where no force is produced
789 * @center: position of the dead zone
791 struct ff_condition_effect
{
792 __u16 right_saturation
;
793 __u16 left_saturation
;
803 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
804 * @waveform: kind of the effect (wave)
805 * @period: period of the wave (ms)
806 * @magnitude: peak value
807 * @offset: mean value of the wave (roughly)
808 * @phase: 'horizontal' shift
809 * @envelope: envelope data
810 * @custom_len: number of samples (FF_CUSTOM only)
811 * @custom_data: buffer of samples (FF_CUSTOM only)
813 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
814 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
815 * for the time being as no driver supports it yet.
817 * Note: the data pointed by custom_data is copied by the driver.
818 * You can therefore dispose of the memory after the upload/update.
820 struct ff_periodic_effect
{
827 struct ff_envelope envelope
;
834 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
835 * @strong_magnitude: magnitude of the heavy motor
836 * @weak_magnitude: magnitude of the light one
838 * Some rumble pads have two motors of different weight. Strong_magnitude
839 * represents the magnitude of the vibration generated by the heavy one.
841 struct ff_rumble_effect
{
842 __u16 strong_magnitude
;
843 __u16 weak_magnitude
;
847 * struct ff_effect - defines force feedback effect
848 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
849 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
850 * @id: an unique id assigned to an effect
851 * @direction: direction of the effect
852 * @trigger: trigger conditions (struct ff_trigger)
853 * @replay: scheduling of the effect (struct ff_replay)
854 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
855 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
856 * defining effect parameters
858 * This structure is sent through ioctl from the application to the driver.
859 * To create a new effect aplication should set its @id to -1; the kernel
860 * will return assigned @id which can later be used to update or delete
863 * Direction of the effect is encoded as follows:
864 * 0 deg -> 0x0000 (down)
865 * 90 deg -> 0x4000 (left)
866 * 180 deg -> 0x8000 (up)
867 * 270 deg -> 0xC000 (right)
873 struct ff_trigger trigger
;
874 struct ff_replay replay
;
877 struct ff_constant_effect constant
;
878 struct ff_ramp_effect ramp
;
879 struct ff_periodic_effect periodic
;
880 struct ff_condition_effect condition
[2]; /* One for each axis */
881 struct ff_rumble_effect rumble
;
886 * Force feedback effect types
889 #define FF_RUMBLE 0x50
890 #define FF_PERIODIC 0x51
891 #define FF_CONSTANT 0x52
892 #define FF_SPRING 0x53
893 #define FF_FRICTION 0x54
894 #define FF_DAMPER 0x55
895 #define FF_INERTIA 0x56
898 #define FF_EFFECT_MIN FF_RUMBLE
899 #define FF_EFFECT_MAX FF_RAMP
902 * Force feedback periodic effect types
905 #define FF_SQUARE 0x58
906 #define FF_TRIANGLE 0x59
908 #define FF_SAW_UP 0x5b
909 #define FF_SAW_DOWN 0x5c
910 #define FF_CUSTOM 0x5d
912 #define FF_WAVEFORM_MIN FF_SQUARE
913 #define FF_WAVEFORM_MAX FF_CUSTOM
916 * Set ff device properties
920 #define FF_AUTOCENTER 0x61
927 * In-kernel definitions.
930 #include <linux/device.h>
931 #include <linux/fs.h>
932 #include <linux/timer.h>
933 #include <linux/mod_devicetable.h>
935 #define NBITS(x) (((x)/BITS_PER_LONG)+1)
936 #define BIT(x) (1UL<<((x)%BITS_PER_LONG))
937 #define LONG(x) ((x)/BITS_PER_LONG)
948 unsigned long evbit
[NBITS(EV_MAX
)];
949 unsigned long keybit
[NBITS(KEY_MAX
)];
950 unsigned long relbit
[NBITS(REL_MAX
)];
951 unsigned long absbit
[NBITS(ABS_MAX
)];
952 unsigned long mscbit
[NBITS(MSC_MAX
)];
953 unsigned long ledbit
[NBITS(LED_MAX
)];
954 unsigned long sndbit
[NBITS(SND_MAX
)];
955 unsigned long ffbit
[NBITS(FF_MAX
)];
956 unsigned long swbit
[NBITS(SW_MAX
)];
958 unsigned int keycodemax
;
959 unsigned int keycodesize
;
961 int (*setkeycode
)(struct input_dev
*dev
, int scancode
, int keycode
);
962 int (*getkeycode
)(struct input_dev
*dev
, int scancode
, int *keycode
);
964 struct ff_device
*ff
;
966 unsigned int repeat_key
;
967 struct timer_list timer
;
973 int abs
[ABS_MAX
+ 1];
974 int rep
[REP_MAX
+ 1];
976 unsigned long key
[NBITS(KEY_MAX
)];
977 unsigned long led
[NBITS(LED_MAX
)];
978 unsigned long snd
[NBITS(SND_MAX
)];
979 unsigned long sw
[NBITS(SW_MAX
)];
981 int absmax
[ABS_MAX
+ 1];
982 int absmin
[ABS_MAX
+ 1];
983 int absfuzz
[ABS_MAX
+ 1];
984 int absflat
[ABS_MAX
+ 1];
986 int (*open
)(struct input_dev
*dev
);
987 void (*close
)(struct input_dev
*dev
);
988 int (*flush
)(struct input_dev
*dev
, struct file
*file
);
989 int (*event
)(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
991 struct input_handle
*grab
;
993 struct mutex mutex
; /* serializes open and close operations */
997 union { /* temporarily so while we switching to struct device */
1001 struct list_head h_list
;
1002 struct list_head node
;
1004 #define to_input_dev(d) container_of(d, struct input_dev, dev)
1007 * Verify that we are in sync with input_device_id mod_devicetable.h #defines
1010 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
1011 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
1014 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
1015 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
1018 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
1019 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
1022 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
1023 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
1026 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
1027 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
1030 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
1031 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
1034 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
1035 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
1038 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
1039 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
1042 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
1043 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
1046 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
1047 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
1050 #define INPUT_DEVICE_ID_MATCH_DEVICE \
1051 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
1052 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
1053 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
1055 struct input_handle
;
1058 * struct input_handler - implements one of interfaces for input devices
1059 * @private: driver-specific data
1060 * @event: event handler
1061 * @connect: called when attaching a handler to an input device
1062 * @disconnect: disconnects a handler from input device
1063 * @start: starts handler for given handle. This function is called by
1064 * input core right after connect() method and also when a process
1065 * that "grabbed" a device releases it
1066 * @fops: file operations this driver implements
1067 * @minor: beginning of range of 32 minors for devices this driver
1069 * @name: name of the handler, to be shown in /proc/bus/input/handlers
1070 * @id_table: pointer to a table of input_device_ids this driver can
1072 * @blacklist: prointer to a table of input_device_ids this driver should
1073 * ignore even if they match @id_table
1074 * @h_list: list of input handles associated with the handler
1075 * @node: for placing the driver onto input_handler_list
1077 struct input_handler
{
1081 void (*event
)(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
1082 int (*connect
)(struct input_handler
*handler
, struct input_dev
*dev
, const struct input_device_id
*id
);
1083 void (*disconnect
)(struct input_handle
*handle
);
1084 void (*start
)(struct input_handle
*handle
);
1086 const struct file_operations
*fops
;
1090 const struct input_device_id
*id_table
;
1091 const struct input_device_id
*blacklist
;
1093 struct list_head h_list
;
1094 struct list_head node
;
1097 struct input_handle
{
1104 struct input_dev
*dev
;
1105 struct input_handler
*handler
;
1107 struct list_head d_node
;
1108 struct list_head h_node
;
1111 #define to_dev(n) container_of(n, struct input_dev, node)
1112 #define to_handler(n) container_of(n, struct input_handler, node)
1113 #define to_handle(n) container_of(n, struct input_handle, d_node)
1114 #define to_handle_h(n) container_of(n, struct input_handle, h_node)
1116 struct input_dev
*input_allocate_device(void);
1117 void input_free_device(struct input_dev
*dev
);
1119 static inline struct input_dev
*input_get_device(struct input_dev
*dev
)
1121 return to_input_dev(get_device(&dev
->dev
));
1124 static inline void input_put_device(struct input_dev
*dev
)
1126 put_device(&dev
->dev
);
1129 static inline void *input_get_drvdata(struct input_dev
*dev
)
1131 return dev
->private;
1134 static inline void input_set_drvdata(struct input_dev
*dev
, void *data
)
1136 dev
->private = data
;
1139 int input_register_device(struct input_dev
*);
1140 void input_unregister_device(struct input_dev
*);
1142 int input_register_handler(struct input_handler
*);
1143 void input_unregister_handler(struct input_handler
*);
1145 int input_register_handle(struct input_handle
*);
1146 void input_unregister_handle(struct input_handle
*);
1148 int input_grab_device(struct input_handle
*);
1149 void input_release_device(struct input_handle
*);
1151 int input_open_device(struct input_handle
*);
1152 void input_close_device(struct input_handle
*);
1154 int input_flush_device(struct input_handle
* handle
, struct file
* file
);
1156 void input_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
1157 void input_inject_event(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
1159 static inline void input_report_key(struct input_dev
*dev
, unsigned int code
, int value
)
1161 input_event(dev
, EV_KEY
, code
, !!value
);
1164 static inline void input_report_rel(struct input_dev
*dev
, unsigned int code
, int value
)
1166 input_event(dev
, EV_REL
, code
, value
);
1169 static inline void input_report_abs(struct input_dev
*dev
, unsigned int code
, int value
)
1171 input_event(dev
, EV_ABS
, code
, value
);
1174 static inline void input_report_ff_status(struct input_dev
*dev
, unsigned int code
, int value
)
1176 input_event(dev
, EV_FF_STATUS
, code
, value
);
1179 static inline void input_report_switch(struct input_dev
*dev
, unsigned int code
, int value
)
1181 input_event(dev
, EV_SW
, code
, !!value
);
1184 static inline void input_sync(struct input_dev
*dev
)
1186 input_event(dev
, EV_SYN
, SYN_REPORT
, 0);
1189 void input_set_capability(struct input_dev
*dev
, unsigned int type
, unsigned int code
);
1191 static inline void input_set_abs_params(struct input_dev
*dev
, int axis
, int min
, int max
, int fuzz
, int flat
)
1193 dev
->absmin
[axis
] = min
;
1194 dev
->absmax
[axis
] = max
;
1195 dev
->absfuzz
[axis
] = fuzz
;
1196 dev
->absflat
[axis
] = flat
;
1198 dev
->absbit
[LONG(axis
)] |= BIT(axis
);
1201 extern struct class input_class
;
1204 * struct ff_device - force-feedback part of an input device
1205 * @upload: Called to upload an new effect into device
1206 * @erase: Called to erase an effect from device
1207 * @playback: Called to request device to start playing specified effect
1208 * @set_gain: Called to set specified gain
1209 * @set_autocenter: Called to auto-center device
1210 * @destroy: called by input core when parent input device is being
1212 * @private: driver-specific data, will be freed automatically
1213 * @ffbit: bitmap of force feedback capabilities truly supported by
1214 * device (not emulated like ones in input_dev->ffbit)
1215 * @mutex: mutex for serializing access to the device
1216 * @max_effects: maximum number of effects supported by device
1217 * @effects: pointer to an array of effects currently loaded into device
1218 * @effect_owners: array of effect owners; when file handle owning
1219 * an effect gets closed the effcet is automatically erased
1221 * Every force-feedback device must implement upload() and playback()
1222 * methods; erase() is optional. set_gain() and set_autocenter() need
1223 * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
1227 int (*upload
)(struct input_dev
*dev
, struct ff_effect
*effect
,
1228 struct ff_effect
*old
);
1229 int (*erase
)(struct input_dev
*dev
, int effect_id
);
1231 int (*playback
)(struct input_dev
*dev
, int effect_id
, int value
);
1232 void (*set_gain
)(struct input_dev
*dev
, u16 gain
);
1233 void (*set_autocenter
)(struct input_dev
*dev
, u16 magnitude
);
1235 void (*destroy
)(struct ff_device
*);
1239 unsigned long ffbit
[NBITS(FF_MAX
)];
1244 struct ff_effect
*effects
;
1245 struct file
*effect_owners
[];
1248 int input_ff_create(struct input_dev
*dev
, int max_effects
);
1249 void input_ff_destroy(struct input_dev
*dev
);
1251 int input_ff_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
1253 int input_ff_upload(struct input_dev
*dev
, struct ff_effect
*effect
, struct file
*file
);
1254 int input_ff_erase(struct input_dev
*dev
, int effect_id
, struct file
*file
);
1256 int input_ff_create_memless(struct input_dev
*dev
, void *data
,
1257 int (*play_effect
)(struct input_dev
*, void *, struct ff_effect
*));