2 * Copyright (c) 2016 Oleksandr Tymoshenko <gonzo@FreeBSD.org>
3 * Copyright (c) 2015-2016 Vladimir Kondratyev <wulf@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #ifndef _EVDEV_INPUT_H
31 #define _EVDEV_INPUT_H
34 #include <sys/ioccom.h>
36 #include <sys/types.h>
39 #include "input-event-codes.h"
48 #define EV_VERSION 0x010001
57 struct input_absinfo {
66 #define INPUT_KEYMAP_BY_INDEX (1 << 0)
68 struct input_keymap_entry {
76 #define EVDEV_IOC_MAGIC 'E'
77 #define EVIOCGVERSION _IOR(EVDEV_IOC_MAGIC, 0x01, int) /* get driver version */
78 #define EVIOCGID _IOR(EVDEV_IOC_MAGIC, 0x02, struct input_id) /* get device ID */
79 #define EVIOCGREP _IOR(EVDEV_IOC_MAGIC, 0x03, unsigned int[2]) /* get repeat settings */
80 #define EVIOCSREP _IOW(EVDEV_IOC_MAGIC, 0x03, unsigned int[2]) /* set repeat settings */
82 #define EVIOCGKEYCODE _IOWR(EVDEV_IOC_MAGIC, 0x04, unsigned int[2]) /* get keycode */
83 #define EVIOCGKEYCODE_V2 _IOWR(EVDEV_IOC_MAGIC, 0x04, struct input_keymap_entry)
84 #define EVIOCSKEYCODE _IOW(EVDEV_IOC_MAGIC, 0x04, unsigned int[2]) /* set keycode */
85 #define EVIOCSKEYCODE_V2 _IOW(EVDEV_IOC_MAGIC, 0x04, struct input_keymap_entry)
87 #define EVIOCGNAME(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x06, len) /* get device name */
88 #define EVIOCGPHYS(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x07, len) /* get physical location */
89 #define EVIOCGUNIQ(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x08, len) /* get unique identifier */
90 #define EVIOCGPROP(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x09, len) /* get device properties */
92 #define EVIOCGMTSLOTS(len) _IOC(IOC_INOUT, EVDEV_IOC_MAGIC, 0x0a, len) /* get MT slots values */
94 #define EVIOCGKEY(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x18, len) /* get global key state */
95 #define EVIOCGLED(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x19, len) /* get all LEDs */
96 #define EVIOCGSND(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x1a, len) /* get all sounds status */
97 #define EVIOCGSW(len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x1b, len) /* get all switch states */
99 #define EVIOCGBIT(ev,len) _IOC(IOC_OUT, EVDEV_IOC_MAGIC, 0x20 + (ev), len) /* get event bits */
100 #define EVIOCGABS(abs) _IOR(EVDEV_IOC_MAGIC, 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
101 #define EVIOCSABS(abs) _IOW(EVDEV_IOC_MAGIC, 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
103 #define EVIOCSFF _IOW(EVDEV_IOC_MAGIC, 0x80, struct ff_effect) /* send a force effect to a force feedback device */
104 #define EVIOCRMFF _IOWINT(EVDEV_IOC_MAGIC, 0x81) /* Erase a force effect */
105 #define EVIOCGEFFECTS _IOR(EVDEV_IOC_MAGIC, 0x84, int) /* Report number of effects playable at the same time */
107 #define EVIOCGRAB _IOWINT(EVDEV_IOC_MAGIC, 0x90) /* Grab/Release device */
108 #define EVIOCREVOKE _IOWINT(EVDEV_IOC_MAGIC, 0x91) /* Revoke device access */
110 #define EVIOCSCLOCKID _IOW(EVDEV_IOC_MAGIC, 0xa0, int) /* Set clockid to be used for timestamps */
122 #define BUS_ISAPNP 0x02
125 #define BUS_BLUETOOTH 0x05
126 #define BUS_VIRTUAL 0x06
129 #define BUS_I8042 0x11
130 #define BUS_XTKBD 0x12
131 #define BUS_RS232 0x13
132 #define BUS_GAMEPORT 0x14
133 #define BUS_PARPORT 0x15
134 #define BUS_AMIGA 0x16
137 #define BUS_HOST 0x19
139 #define BUS_ATARI 0x1B
145 #define MT_TOOL_FINGER 0
146 #define MT_TOOL_PEN 1
147 #define MT_TOOL_PALM 2
148 #define MT_TOOL_MAX 2
151 * Values describing the status of a force-feedback effect
153 #define FF_STATUS_STOPPED 0x00
154 #define FF_STATUS_PLAYING 0x01
155 #define FF_STATUS_MAX 0x01
157 /* scheduling info for force feedback effect */
159 uint16_t length; /* length of the effect (ms) */
160 uint16_t delay; /* delay before effect starts (ms) */
163 /* trigger for force feedback effect */
165 uint16_t button; /* trigger button number */
166 uint16_t interval; /* delay between re-triggers */
169 /* force feedback effect envelop */
171 uint16_t attack_length; /* duration of the attach (ms) */
172 uint16_t attack_level; /* level at the beginning (0x0000 - 0x7fff) */
173 uint16_t fade_length; /* duratin of fade (ms) */
174 uint16_t fade_level; /* level at the end of fade */
177 struct ff_constant_effect {
179 struct ff_envelope envelope;
182 struct ff_ramp_effect {
185 struct ff_envelope envelope;
188 struct ff_condition_effect {
189 /* maximum level when joystick moved to respective side */
190 uint16_t right_saturation;
192 uint16_t left_saturation;
193 /* how fast force grows when joystick move to the respective side */
197 uint16_t deadband; /* size of dead zone when no force is produced */
198 int16_t center; /* center of dead zone */
202 * Force feedback periodic effect types
205 #define FF_SQUARE 0x58
206 #define FF_TRIANGLE 0x59
208 #define FF_SAW_UP 0x5b
209 #define FF_SAW_DOWN 0x5c
210 #define FF_CUSTOM 0x5d
212 #define FF_WAVEFORM_MIN FF_SQUARE
213 #define FF_WAVEFORM_MAX FF_CUSTOM
215 struct ff_periodic_effect {
217 uint16_t period; /* ms */
218 int16_t magnitude; /* peak */
219 int16_t offset; /* mean, roughly */
220 uint16_t phase; /* horizontal shift */
221 struct ff_envelope envelope;
222 uint32_t custom_len; /* FF_CUSTOM waveform only */
223 int16_t *custom_data; /* FF_CUSTOM waveform only */
226 struct ff_rumble_effect {
227 uint16_t strong_magnitude; /* magnitude of the heavy motor */
228 uint16_t weak_magnitude; /* magnitude of the light motor */
232 * Force feedback effect types
235 #define FF_RUMBLE 0x50
236 #define FF_PERIODIC 0x51
237 #define FF_CONSTANT 0x52
238 #define FF_SPRING 0x53
239 #define FF_FRICTION 0x54
240 #define FF_DAMPER 0x55
241 #define FF_INERTIA 0x56
244 #define FF_EFFECT_MIN FF_RUMBLE
245 #define FF_EFFECT_MAX FF_RAMP
250 uint16_t direction; /* [0 .. 360) degrees -> [0 .. 0x10000) */
251 struct ff_trigger trigger;
252 struct ff_replay replay;
255 struct ff_constant_effect constant;
256 struct ff_ramp_effect ramp;
257 struct ff_periodic_effect periodic;
258 struct ff_condition_effect condition[2]; /* One for each axis */
259 struct ff_rumble_effect rumble;
264 * force feedback device properties
268 #define FF_AUTOCENTER 0x61
271 #define FF_CNT (FF_MAX+1)
273 #endif /* _EVDEV_INPUT_H */