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 <asm/types.h>
22 * The event structure itself
36 #define EV_VERSION 0x010000
39 * IOCTLs (0x00 - 0x7f)
49 struct input_absinfo
{
57 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
58 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
59 #define EVIOCGREP _IOR('E', 0x03, int[2]) /* get repeat settings */
60 #define EVIOCSREP _IOW('E', 0x03, int[2]) /* get repeat settings */
61 #define EVIOCGKEYCODE _IOR('E', 0x04, int[2]) /* get keycode */
62 #define EVIOCSKEYCODE _IOW('E', 0x04, int[2]) /* set keycode */
64 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
65 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
66 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
68 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global keystate */
69 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
70 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
72 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + ev, len) /* get event bits */
73 #define EVIOCGABS(abs) _IOR('E', 0x40 + abs, struct input_absinfo) /* get abs value/limits */
74 #define EVIOCSABS(abs) _IOW('E', 0xc0 + abs, struct input_absinfo) /* set abs value/limits */
76 #define EVIOCSFF _IOC(_IOC_WRITE, 'E', 0x80, sizeof(struct ff_effect)) /* send a force effect to a force feedback device */
77 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
78 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
94 #define EV_FF_STATUS 0x17
98 * Synchronization events.
108 #define KEY_RESERVED 0
122 #define KEY_BACKSPACE 14
134 #define KEY_LEFTBRACE 26
135 #define KEY_RIGHTBRACE 27
137 #define KEY_LEFTCTRL 29
147 #define KEY_SEMICOLON 39
148 #define KEY_APOSTROPHE 40
150 #define KEY_LEFTSHIFT 42
151 #define KEY_BACKSLASH 43
162 #define KEY_RIGHTSHIFT 54
163 #define KEY_KPASTERISK 55
164 #define KEY_LEFTALT 56
166 #define KEY_CAPSLOCK 58
177 #define KEY_NUMLOCK 69
178 #define KEY_SCROLLLOCK 70
182 #define KEY_KPMINUS 74
186 #define KEY_KPPLUS 78
204 #define KEY_KPENTER 96
205 #define KEY_RIGHTCTRL 97
206 #define KEY_KPSLASH 98
208 #define KEY_RIGHTALT 100
209 #define KEY_LINEFEED 101
212 #define KEY_PAGEUP 104
214 #define KEY_RIGHT 106
217 #define KEY_PAGEDOWN 109
218 #define KEY_INSERT 110
219 #define KEY_DELETE 111
220 #define KEY_MACRO 112
222 #define KEY_VOLUMEDOWN 114
223 #define KEY_VOLUMEUP 115
224 #define KEY_POWER 116
225 #define KEY_KPEQUAL 117
226 #define KEY_KPPLUSMINUS 118
227 #define KEY_PAUSE 119
232 #define KEY_KPCOMMA 124
233 #define KEY_LEFTMETA 125
234 #define KEY_RIGHTMETA 126
235 #define KEY_COMPOSE 127
238 #define KEY_AGAIN 129
239 #define KEY_PROPS 130
241 #define KEY_FRONT 132
244 #define KEY_PASTE 135
250 #define KEY_SETUP 141
251 #define KEY_SLEEP 142
252 #define KEY_WAKEUP 143
254 #define KEY_SENDFILE 145
255 #define KEY_DELETEFILE 146
257 #define KEY_PROG1 148
258 #define KEY_PROG2 149
260 #define KEY_MSDOS 151
261 #define KEY_COFFEE 152
262 #define KEY_DIRECTION 153
263 #define KEY_CYCLEWINDOWS 154
265 #define KEY_BOOKMARKS 156
266 #define KEY_COMPUTER 157
268 #define KEY_FORWARD 159
269 #define KEY_CLOSECD 160
270 #define KEY_EJECTCD 161
271 #define KEY_EJECTCLOSECD 162
272 #define KEY_NEXTSONG 163
273 #define KEY_PLAYPAUSE 164
274 #define KEY_PREVIOUSSONG 165
275 #define KEY_STOPCD 166
276 #define KEY_RECORD 167
277 #define KEY_REWIND 168
278 #define KEY_PHONE 169
280 #define KEY_CONFIG 171
281 #define KEY_HOMEPAGE 172
282 #define KEY_REFRESH 173
286 #define KEY_SCROLLUP 177
287 #define KEY_SCROLLDOWN 178
288 #define KEY_KPLEFTPAREN 179
289 #define KEY_KPRIGHTPAREN 180
291 #define KEY_INTL1 181
292 #define KEY_INTL2 182
293 #define KEY_INTL3 183
294 #define KEY_INTL4 184
295 #define KEY_INTL5 185
296 #define KEY_INTL6 186
297 #define KEY_INTL7 187
298 #define KEY_INTL8 188
299 #define KEY_INTL9 189
300 #define KEY_LANG1 190
301 #define KEY_LANG2 191
302 #define KEY_LANG3 192
303 #define KEY_LANG4 193
304 #define KEY_LANG5 194
305 #define KEY_LANG6 195
306 #define KEY_LANG7 196
307 #define KEY_LANG8 197
308 #define KEY_LANG9 198
310 #define KEY_PLAYCD 200
311 #define KEY_PAUSECD 201
312 #define KEY_PROG3 202
313 #define KEY_PROG4 203
314 #define KEY_SUSPEND 205
315 #define KEY_CLOSE 206
317 #define KEY_FASTFORWARD 208
318 #define KEY_BASSBOOST 209
319 #define KEY_PRINT 210
321 #define KEY_CAMERA 212
322 #define KEY_SOUND 213
323 #define KEY_QUESTION 214
324 #define KEY_EMAIL 215
326 #define KEY_SEARCH 217
327 #define KEY_CONNECT 218
328 #define KEY_FINANCE 219
329 #define KEY_SPORT 220
331 #define KEY_ALTERASE 222
332 #define KEY_CANCEL 223
333 #define KEY_BRIGHTNESSDOWN 224
334 #define KEY_BRIGHTNESSUP 225
335 #define KEY_MEDIA 226
337 #define KEY_UNKNOWN 240
339 #define BTN_MISC 0x100
351 #define BTN_MOUSE 0x110
352 #define BTN_LEFT 0x110
353 #define BTN_RIGHT 0x111
354 #define BTN_MIDDLE 0x112
355 #define BTN_SIDE 0x113
356 #define BTN_EXTRA 0x114
357 #define BTN_FORWARD 0x115
358 #define BTN_BACK 0x116
360 #define BTN_JOYSTICK 0x120
361 #define BTN_TRIGGER 0x120
362 #define BTN_THUMB 0x121
363 #define BTN_THUMB2 0x122
364 #define BTN_TOP 0x123
365 #define BTN_TOP2 0x124
366 #define BTN_PINKIE 0x125
367 #define BTN_BASE 0x126
368 #define BTN_BASE2 0x127
369 #define BTN_BASE3 0x128
370 #define BTN_BASE4 0x129
371 #define BTN_BASE5 0x12a
372 #define BTN_BASE6 0x12b
373 #define BTN_DEAD 0x12f
375 #define BTN_GAMEPAD 0x130
384 #define BTN_TL2 0x138
385 #define BTN_TR2 0x139
386 #define BTN_SELECT 0x13a
387 #define BTN_START 0x13b
388 #define BTN_MODE 0x13c
389 #define BTN_THUMBL 0x13d
390 #define BTN_THUMBR 0x13e
392 #define BTN_DIGI 0x140
393 #define BTN_TOOL_PEN 0x140
394 #define BTN_TOOL_RUBBER 0x141
395 #define BTN_TOOL_BRUSH 0x142
396 #define BTN_TOOL_PENCIL 0x143
397 #define BTN_TOOL_AIRBRUSH 0x144
398 #define BTN_TOOL_FINGER 0x145
399 #define BTN_TOOL_MOUSE 0x146
400 #define BTN_TOOL_LENS 0x147
401 #define BTN_TOUCH 0x14a
402 #define BTN_STYLUS 0x14b
403 #define BTN_STYLUS2 0x14c
405 #define BTN_WHEEL 0x150
406 #define BTN_GEAR_DOWN 0x150
407 #define BTN_GEAR_UP 0x151
410 #define KEY_SELECT 0x161
411 #define KEY_GOTO 0x162
412 #define KEY_CLEAR 0x163
413 #define KEY_POWER2 0x164
414 #define KEY_OPTION 0x165
415 #define KEY_INFO 0x166
416 #define KEY_TIME 0x167
417 #define KEY_VENDOR 0x168
418 #define KEY_ARCHIVE 0x169
419 #define KEY_PROGRAM 0x16a
420 #define KEY_CHANNEL 0x16b
421 #define KEY_FAVORITES 0x16c
422 #define KEY_EPG 0x16d
423 #define KEY_PVR 0x16e
424 #define KEY_MHP 0x16f
425 #define KEY_LANGUAGE 0x170
426 #define KEY_TITLE 0x171
427 #define KEY_SUBTITLE 0x172
428 #define KEY_ANGLE 0x173
429 #define KEY_ZOOM 0x174
430 #define KEY_MODE 0x175
431 #define KEY_KEYBOARD 0x176
432 #define KEY_SCREEN 0x177
435 #define KEY_TV2 0x17a
436 #define KEY_VCR 0x17b
437 #define KEY_VCR2 0x17c
438 #define KEY_SAT 0x17d
439 #define KEY_SAT2 0x17e
441 #define KEY_TAPE 0x180
442 #define KEY_RADIO 0x181
443 #define KEY_TUNER 0x182
444 #define KEY_PLAYER 0x183
445 #define KEY_TEXT 0x184
446 #define KEY_DVD 0x185
447 #define KEY_AUX 0x186
448 #define KEY_MP3 0x187
449 #define KEY_AUDIO 0x188
450 #define KEY_VIDEO 0x189
451 #define KEY_DIRECTORY 0x18a
452 #define KEY_LIST 0x18b
453 #define KEY_MEMO 0x18c
454 #define KEY_CALENDAR 0x18d
455 #define KEY_RED 0x18e
456 #define KEY_GREEN 0x18f
457 #define KEY_YELLOW 0x190
458 #define KEY_BLUE 0x191
459 #define KEY_CHANNELUP 0x192
460 #define KEY_CHANNELDOWN 0x193
461 #define KEY_FIRST 0x194
462 #define KEY_LAST 0x195
464 #define KEY_NEXT 0x197
465 #define KEY_RESTART 0x198
466 #define KEY_SLOW 0x199
467 #define KEY_SHUFFLE 0x19a
468 #define KEY_BREAK 0x19b
469 #define KEY_PREVIOUS 0x19c
470 #define KEY_DIGITS 0x19d
471 #define KEY_TEEN 0x19e
472 #define KEY_TWEN 0x19f
474 #define KEY_MAX 0x1ff
483 #define REL_HWHEEL 0x06
484 #define REL_DIAL 0x07
485 #define REL_WHEEL 0x08
486 #define REL_MISC 0x09
499 #define ABS_THROTTLE 0x06
500 #define ABS_RUDDER 0x07
501 #define ABS_WHEEL 0x08
503 #define ABS_BRAKE 0x0a
504 #define ABS_HAT0X 0x10
505 #define ABS_HAT0Y 0x11
506 #define ABS_HAT1X 0x12
507 #define ABS_HAT1Y 0x13
508 #define ABS_HAT2X 0x14
509 #define ABS_HAT2Y 0x15
510 #define ABS_HAT3X 0x16
511 #define ABS_HAT3Y 0x17
512 #define ABS_PRESSURE 0x18
513 #define ABS_DISTANCE 0x19
514 #define ABS_TILT_X 0x1a
515 #define ABS_TILT_Y 0x1b
516 #define ABS_VOLUME 0x20
517 #define ABS_MISC 0x28
524 #define MSC_SERIAL 0x00
525 #define MSC_PULSELED 0x01
532 #define LED_NUML 0x00
533 #define LED_CAPSL 0x01
534 #define LED_SCROLLL 0x02
535 #define LED_COMPOSE 0x03
536 #define LED_KANA 0x04
537 #define LED_SLEEP 0x05
538 #define LED_SUSPEND 0x06
539 #define LED_MUTE 0x07
540 #define LED_MISC 0x08
547 #define REP_DELAY 0x00
548 #define REP_PERIOD 0x01
555 #define SND_CLICK 0x00
556 #define SND_BELL 0x01
557 #define SND_TONE 0x02
570 #define BUS_ISAPNP 0x02
575 #define BUS_I8042 0x11
576 #define BUS_XTKBD 0x12
577 #define BUS_RS232 0x13
578 #define BUS_GAMEPORT 0x14
579 #define BUS_PARPORT 0x15
580 #define BUS_AMIGA 0x16
583 #define BUS_HOST 0x19
586 * Values describing the status of an effect
588 #define FF_STATUS_STOPPED 0x00
589 #define FF_STATUS_PLAYING 0x01
590 #define FF_STATUS_MAX 0x01
593 * Structures used in ioctls to upload effects to a device
594 * The first structures are not passed directly by using ioctls.
595 * They are sub-structures of the actually sent structure (called ff_effect)
599 __u16 length
; /* Duration of an effect in ms. All other times are also expressed in ms */
600 __u16 delay
; /* Time to wait before to start playing an effect */
604 __u16 button
; /* Number of button triggering an effect */
605 __u16 interval
; /* Time to wait before an effect can be re-triggered (ms) */
609 __u16 attack_length
; /* Duration of attack (ms) */
610 __u16 attack_level
; /* Level at beginning of attack */
611 __u16 fade_length
; /* Duration of fade (ms) */
612 __u16 fade_level
; /* Level at end of fade */
616 struct ff_constant_effect
{
617 __s16 level
; /* Strength of effect. Negative values are OK */
618 struct ff_envelope envelope
;
622 struct ff_ramp_effect
{
625 struct ff_envelope envelope
;
628 /* FF_SPRING of FF_FRICTION */
629 struct ff_condition_effect
{
630 __u16 right_saturation
; /* Max level when joystick is on the right */
631 __u16 left_saturation
; /* Max level when joystick in on the left */
633 __s16 right_coeff
; /* Indicates how fast the force grows when the
634 joystick moves to the right */
635 __s16 left_coeff
; /* Same for left side */
637 __u16 deadband
; /* Size of area where no force is produced */
638 __s16 center
; /* Position of dead zone */
643 struct ff_periodic_effect
{
644 __u16 waveform
; /* Kind of wave (sine, square...) */
645 __u16 period
; /* in ms */
646 __s16 magnitude
; /* Peak value */
647 __s16 offset
; /* Mean value of wave (roughly) */
648 __u16 phase
; /* 'Horizontal' shift */
650 struct ff_envelope envelope
;
652 /* Only used if waveform == FF_CUSTOM */
653 __u32 custom_len
; /* Number of samples */
654 __s16
*custom_data
; /* Buffer of samples */
655 /* Note: the data pointed by custom_data is copied by the driver. You can
656 * therefore dispose of the memory after the upload/update */
660 /* Some rumble pads have two motors of different weight.
661 strong_magnitude represents the magnitude of the vibration generated
664 struct ff_rumble_effect
{
665 __u16 strong_magnitude
; /* Magnitude of the heavy motor */
666 __u16 weak_magnitude
; /* Magnitude of the light one */
670 * Structure sent through ioctl from the application to the driver
674 /* Following field denotes the unique id assigned to an effect.
675 * If user sets if to -1, a new effect is created, and its id is returned in the same field
676 * Else, the user sets it to the effect id it wants to update.
680 __u16 direction
; /* Direction. 0 deg -> 0x0000 (down)
681 90 deg -> 0x4000 (left)
682 180 deg -> 0x8000 (up)
683 270 deg -> 0xC000 (right)
686 struct ff_trigger trigger
;
687 struct ff_replay replay
;
690 struct ff_constant_effect constant
;
691 struct ff_ramp_effect ramp
;
692 struct ff_periodic_effect periodic
;
693 struct ff_condition_effect condition
[2]; /* One for each axis */
694 struct ff_rumble_effect rumble
;
699 * Force feedback effect types
702 #define FF_RUMBLE 0x50
703 #define FF_PERIODIC 0x51
704 #define FF_CONSTANT 0x52
705 #define FF_SPRING 0x53
706 #define FF_FRICTION 0x54
707 #define FF_DAMPER 0x55
708 #define FF_INERTIA 0x56
712 * Force feedback periodic effect types
715 #define FF_SQUARE 0x58
716 #define FF_TRIANGLE 0x59
718 #define FF_SAW_UP 0x5b
719 #define FF_SAW_DOWN 0x5c
720 #define FF_CUSTOM 0x5d
723 * Set ff device properties
727 #define FF_AUTOCENTER 0x61
734 * In-kernel definitions.
737 #include <linux/devfs_fs_kernel.h>
738 #include <linux/fs.h>
739 #include <linux/timer.h>
741 #define NBITS(x) ((((x)-1)/BITS_PER_LONG)+1)
742 #define BIT(x) (1UL<<((x)%BITS_PER_LONG))
743 #define LONG(x) ((x)/BITS_PER_LONG)
745 #define INPUT_KEYCODE(dev, scancode) ((dev->keycodesize == 1) ? ((u8*)dev->keycode)[scancode] : \
746 ((dev->keycodesize == 1) ? ((u16*)dev->keycode)[scancode] : (((u32*)dev->keycode)[scancode])))
748 #define init_input_dev(dev) do { INIT_LIST_HEAD(&((dev)->h_list)); INIT_LIST_HEAD(&((dev)->node)); } while (0)
759 unsigned long evbit
[NBITS(EV_MAX
)];
760 unsigned long keybit
[NBITS(KEY_MAX
)];
761 unsigned long relbit
[NBITS(REL_MAX
)];
762 unsigned long absbit
[NBITS(ABS_MAX
)];
763 unsigned long mscbit
[NBITS(MSC_MAX
)];
764 unsigned long ledbit
[NBITS(LED_MAX
)];
765 unsigned long sndbit
[NBITS(SND_MAX
)];
766 unsigned long ffbit
[NBITS(FF_MAX
)];
769 unsigned int keycodemax
;
770 unsigned int keycodesize
;
773 unsigned int repeat_key
;
774 struct timer_list timer
;
776 struct pm_dev
*pm_dev
;
781 int abs
[ABS_MAX
+ 1];
782 int rep
[REP_MAX
+ 1];
784 unsigned long key
[NBITS(KEY_MAX
)];
785 unsigned long led
[NBITS(LED_MAX
)];
786 unsigned long snd
[NBITS(SND_MAX
)];
788 int absmax
[ABS_MAX
+ 1];
789 int absmin
[ABS_MAX
+ 1];
790 int absfuzz
[ABS_MAX
+ 1];
791 int absflat
[ABS_MAX
+ 1];
793 int (*open
)(struct input_dev
*dev
);
794 void (*close
)(struct input_dev
*dev
);
795 int (*accept
)(struct input_dev
*dev
, struct file
*file
);
796 int (*flush
)(struct input_dev
*dev
, struct file
*file
);
797 int (*event
)(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
798 int (*upload_effect
)(struct input_dev
*dev
, struct ff_effect
*effect
);
799 int (*erase_effect
)(struct input_dev
*dev
, int effect_id
);
801 struct list_head h_list
;
802 struct list_head node
;
806 * Structure for hotplug & device<->driver matching.
809 #define INPUT_DEVICE_ID_MATCH_BUS 1
810 #define INPUT_DEVICE_ID_MATCH_VENDOR 2
811 #define INPUT_DEVICE_ID_MATCH_PRODUCT 4
812 #define INPUT_DEVICE_ID_MATCH_VERSION 8
814 #define INPUT_DEVICE_ID_MATCH_EVBIT 0x010
815 #define INPUT_DEVICE_ID_MATCH_KEYBIT 0x020
816 #define INPUT_DEVICE_ID_MATCH_RELBIT 0x040
817 #define INPUT_DEVICE_ID_MATCH_ABSBIT 0x080
818 #define INPUT_DEVICE_ID_MATCH_MSCIT 0x100
819 #define INPUT_DEVICE_ID_MATCH_LEDBIT 0x200
820 #define INPUT_DEVICE_ID_MATCH_SNDBIT 0x400
821 #define INPUT_DEVICE_ID_MATCH_FFBIT 0x800
823 #define INPUT_DEVICE_ID_MATCH_DEVICE\
824 (INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
825 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION\
826 (INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
828 struct input_device_id
{
834 unsigned long evbit
[NBITS(EV_MAX
)];
835 unsigned long keybit
[NBITS(KEY_MAX
)];
836 unsigned long relbit
[NBITS(REL_MAX
)];
837 unsigned long absbit
[NBITS(ABS_MAX
)];
838 unsigned long mscbit
[NBITS(MSC_MAX
)];
839 unsigned long ledbit
[NBITS(LED_MAX
)];
840 unsigned long sndbit
[NBITS(SND_MAX
)];
841 unsigned long ffbit
[NBITS(FF_MAX
)];
843 unsigned long driver_info
;
848 struct input_handler
{
852 void (*event
)(struct input_handle
*handle
, unsigned int type
, unsigned int code
, int value
);
853 struct input_handle
* (*connect
)(struct input_handler
*handler
, struct input_dev
*dev
, struct input_device_id
*id
);
854 void (*disconnect
)(struct input_handle
*handle
);
856 struct file_operations
*fops
;
860 struct input_device_id
*id_table
;
862 struct list_head h_list
;
863 struct list_head node
;
866 struct input_handle
{
873 struct input_dev
*dev
;
874 struct input_handler
*handler
;
876 struct list_head d_node
;
877 struct list_head h_node
;
880 #define to_dev(n) container_of(n,struct input_dev,node)
881 #define to_handler(n) container_of(n,struct input_handler,node);
882 #define to_handle(n) container_of(n,struct input_handle,d_node)
883 #define to_handle_h(n) container_of(n,struct input_handle,h_node)
885 void input_register_device(struct input_dev
*);
886 void input_unregister_device(struct input_dev
*);
888 void input_register_handler(struct input_handler
*);
889 void input_unregister_handler(struct input_handler
*);
891 int input_open_device(struct input_handle
*);
892 void input_close_device(struct input_handle
*);
894 int input_accept_process(struct input_handle
*handle
, struct file
*file
);
895 int input_flush_device(struct input_handle
* handle
, struct file
* file
);
897 devfs_handle_t
input_register_minor(char *name
, int minor
, int minor_base
);
898 void input_unregister_minor(devfs_handle_t handle
);
900 void input_event(struct input_dev
*dev
, unsigned int type
, unsigned int code
, int value
);
902 #define input_sync(a) input_event(a, EV_SYN, SYN_REPORT, 0)
903 #define input_report_key(a,b,c) input_event(a, EV_KEY, b, !!(c))
904 #define input_report_rel(a,b,c) input_event(a, EV_REL, b, c)
905 #define input_report_abs(a,b,c) input_event(a, EV_ABS, b, c)
906 #define input_report_ff(a,b,c) input_event(a, EV_FF, b, c)
907 #define input_report_ff_status(a,b,c) input_event(a, EV_FF_STATUS, b, c)
909 extern struct device_class input_devclass
;