2 * Copyright (c) 1999-2002 Vojtech Pavlik
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
13 #include <sys/types.h>
14 #include "standard-headers/linux/types.h"
16 #include "standard-headers/linux/input-event-codes.h"
19 * The event structure itself
33 #define EV_VERSION 0x010001
36 * IOCTLs (0x00 - 0x7f)
47 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
48 * @value: latest reported value for the axis.
49 * @minimum: specifies minimum value for the axis.
50 * @maximum: specifies maximum value for the axis.
51 * @fuzz: specifies fuzz value that is used to filter noise from
53 * @flat: values that are within this value will be discarded by
54 * joydev interface and reported as 0 instead.
55 * @resolution: specifies resolution for the values reported for
58 * Note that input core does not clamp reported values to the
59 * [minimum, maximum] limits, such task is left to userspace.
61 * Resolution for main axes (ABS_X, ABS_Y, ABS_Z) is reported in
62 * units per millimeter (units/mm), resolution for rotational axes
63 * (ABS_RX, ABS_RY, ABS_RZ) is reported in units per radian.
65 struct input_absinfo {
75 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
76 * @scancode: scancode represented in machine-endian form.
77 * @len: length of the scancode that resides in @scancode buffer.
78 * @index: index in the keymap, may be used instead of scancode
79 * @flags: allows to specify how kernel should handle the request. For
80 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
81 * should perform lookup in keymap by @index instead of @scancode
82 * @keycode: key code assigned to this scancode
84 * The structure is used to retrieve and modify keymap data. Users have
85 * option of performing lookup either by @scancode itself or by @index
86 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
87 * (depending on which element was used to perform lookup).
89 struct input_keymap_entry {
90 #define INPUT_KEYMAP_BY_INDEX (1 << 0)
104 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
105 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
106 #define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
107 #define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
109 #define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
110 #define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
111 #define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
112 #define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
114 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
115 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
116 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
117 #define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
120 * EVIOCGMTSLOTS(len) - get MT slot values
121 * @len: size of the data buffer in bytes
123 * The ioctl buffer argument should be binary equivalent to
125 * struct input_mt_request_layout {
127 * int32_t values[num_slots];
130 * where num_slots is the (arbitrary) number of MT slots to extract.
132 * The ioctl size argument (len) is the size of the buffer, which
133 * should satisfy len = (num_slots + 1) * sizeof(int32_t). If len is
134 * too small to fit all available slots, the first num_slots are
137 * Before the call, code is set to the wanted ABS_MT event type. On
138 * return, values[] is filled with the slot values for the specified
141 * If the request code is not an ABS_MT value, -EINVAL is returned.
143 #define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
145 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
146 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
147 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
148 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
150 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
151 #define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
152 #define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
154 #define EVIOCSFF _IOW('E', 0x80, struct ff_effect) /* send a force effect to a force feedback device */
155 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
156 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
158 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
159 #define EVIOCREVOKE _IOW('E', 0x91, int) /* Revoke device access */
162 * EVIOCGMASK - Retrieve current event mask
164 * This ioctl allows user to retrieve the current event mask for specific
165 * event type. The argument must be of type "struct input_mask" and
166 * specifies the event type to query, the address of the receive buffer and
167 * the size of the receive buffer.
169 * The event mask is a per-client mask that specifies which events are
170 * forwarded to the client. Each event code is represented by a single bit
171 * in the event mask. If the bit is set, the event is passed to the client
172 * normally. Otherwise, the event is filtered and will never be queued on
173 * the client's receive buffer.
175 * Event masks do not affect global state of the input device. They only
176 * affect the file descriptor they are applied to.
178 * The default event mask for a client has all bits set, i.e. all events
179 * are forwarded to the client. If the kernel is queried for an unknown
180 * event type or if the receive buffer is larger than the number of
181 * event codes known to the kernel, the kernel returns all zeroes for those
184 * At maximum, codes_size bytes are copied.
186 * This ioctl may fail with ENODEV in case the file is revoked, EFAULT
187 * if the receive-buffer points to invalid memory, or EINVAL if the kernel
188 * does not implement the ioctl.
190 #define EVIOCGMASK _IOR('E', 0x92, struct input_mask) /* Get event-masks */
193 * EVIOCSMASK - Set event mask
195 * This ioctl is the counterpart to EVIOCGMASK. Instead of receiving the
196 * current event mask, this changes the client's event mask for a specific
197 * type. See EVIOCGMASK for a description of event-masks and the
200 * This ioctl provides full forward compatibility. If the passed event type
201 * is unknown to the kernel, or if the number of event codes specified in
202 * the mask is bigger than what is known to the kernel, the ioctl is still
203 * accepted and applied. However, any unknown codes are left untouched and
204 * stay cleared. That means, the kernel always filters unknown codes
205 * regardless of what the client requests. If the new mask doesn't cover
206 * all known event-codes, all remaining codes are automatically cleared and
209 * This ioctl may fail with ENODEV in case the file is revoked. EFAULT is
210 * returned if the receive-buffer points to invalid memory. EINVAL is returned
211 * if the kernel does not implement the ioctl.
213 #define EVIOCSMASK _IOW('E', 0x93, struct input_mask) /* Set event-masks */
215 #define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
227 #define BUS_ISAPNP 0x02
230 #define BUS_BLUETOOTH 0x05
231 #define BUS_VIRTUAL 0x06
234 #define BUS_I8042 0x11
235 #define BUS_XTKBD 0x12
236 #define BUS_RS232 0x13
237 #define BUS_GAMEPORT 0x14
238 #define BUS_PARPORT 0x15
239 #define BUS_AMIGA 0x16
242 #define BUS_HOST 0x19
244 #define BUS_ATARI 0x1B
251 #define MT_TOOL_FINGER 0
252 #define MT_TOOL_PEN 1
253 #define MT_TOOL_PALM 2
254 #define MT_TOOL_MAX 2
257 * Values describing the status of a force-feedback effect
259 #define FF_STATUS_STOPPED 0x00
260 #define FF_STATUS_PLAYING 0x01
261 #define FF_STATUS_MAX 0x01
264 * Structures used in ioctls to upload effects to a device
265 * They are pieces of a bigger structure (called ff_effect)
269 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
270 * should not be used and have unspecified results.
274 * struct ff_replay - defines scheduling of the force-feedback effect
275 * @length: duration of the effect
276 * @delay: delay before effect should start playing
284 * struct ff_trigger - defines what triggers the force-feedback effect
285 * @button: number of the button triggering the effect
286 * @interval: controls how soon the effect can be re-triggered
294 * struct ff_envelope - generic force-feedback effect envelope
295 * @attack_length: duration of the attack (ms)
296 * @attack_level: level at the beginning of the attack
297 * @fade_length: duration of fade (ms)
298 * @fade_level: level at the end of fade
300 * The @attack_level and @fade_level are absolute values; when applying
301 * envelope force-feedback core will convert to positive/negative
302 * value based on polarity of the default level of the effect.
303 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
306 uint16_t attack_length;
307 uint16_t attack_level;
308 uint16_t fade_length;
313 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
314 * @level: strength of the effect; may be negative
315 * @envelope: envelope data
317 struct ff_constant_effect {
319 struct ff_envelope envelope;
323 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
324 * @start_level: beginning strength of the effect; may be negative
325 * @end_level: final strength of the effect; may be negative
326 * @envelope: envelope data
328 struct ff_ramp_effect {
331 struct ff_envelope envelope;
335 * struct ff_condition_effect - defines a spring or friction force-feedback effect
336 * @right_saturation: maximum level when joystick moved all way to the right
337 * @left_saturation: same for the left side
338 * @right_coeff: controls how fast the force grows when the joystick moves
340 * @left_coeff: same for the left side
341 * @deadband: size of the dead zone, where no force is produced
342 * @center: position of the dead zone
344 struct ff_condition_effect {
345 uint16_t right_saturation;
346 uint16_t left_saturation;
356 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
357 * @waveform: kind of the effect (wave)
358 * @period: period of the wave (ms)
359 * @magnitude: peak value
360 * @offset: mean value of the wave (roughly)
361 * @phase: 'horizontal' shift
362 * @envelope: envelope data
363 * @custom_len: number of samples (FF_CUSTOM only)
364 * @custom_data: buffer of samples (FF_CUSTOM only)
366 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
367 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
368 * for the time being as no driver supports it yet.
370 * Note: the data pointed by custom_data is copied by the driver.
371 * You can therefore dispose of the memory after the upload/update.
373 struct ff_periodic_effect {
380 struct ff_envelope envelope;
383 int16_t *custom_data;
387 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
388 * @strong_magnitude: magnitude of the heavy motor
389 * @weak_magnitude: magnitude of the light one
391 * Some rumble pads have two motors of different weight. Strong_magnitude
392 * represents the magnitude of the vibration generated by the heavy one.
394 struct ff_rumble_effect {
395 uint16_t strong_magnitude;
396 uint16_t weak_magnitude;
400 * struct ff_effect - defines force feedback effect
401 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
402 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
403 * @id: an unique id assigned to an effect
404 * @direction: direction of the effect
405 * @trigger: trigger conditions (struct ff_trigger)
406 * @replay: scheduling of the effect (struct ff_replay)
407 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
408 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
409 * defining effect parameters
411 * This structure is sent through ioctl from the application to the driver.
412 * To create a new effect application should set its @id to -1; the kernel
413 * will return assigned @id which can later be used to update or delete
416 * Direction of the effect is encoded as follows:
417 * 0 deg -> 0x0000 (down)
418 * 90 deg -> 0x4000 (left)
419 * 180 deg -> 0x8000 (up)
420 * 270 deg -> 0xC000 (right)
426 struct ff_trigger trigger;
427 struct ff_replay replay;
430 struct ff_constant_effect constant;
431 struct ff_ramp_effect ramp;
432 struct ff_periodic_effect periodic;
433 struct ff_condition_effect condition[2]; /* One for each axis */
434 struct ff_rumble_effect rumble;
439 * Force feedback effect types
442 #define FF_RUMBLE 0x50
443 #define FF_PERIODIC 0x51
444 #define FF_CONSTANT 0x52
445 #define FF_SPRING 0x53
446 #define FF_FRICTION 0x54
447 #define FF_DAMPER 0x55
448 #define FF_INERTIA 0x56
451 #define FF_EFFECT_MIN FF_RUMBLE
452 #define FF_EFFECT_MAX FF_RAMP
455 * Force feedback periodic effect types
458 #define FF_SQUARE 0x58
459 #define FF_TRIANGLE 0x59
461 #define FF_SAW_UP 0x5b
462 #define FF_SAW_DOWN 0x5c
463 #define FF_CUSTOM 0x5d
465 #define FF_WAVEFORM_MIN FF_SQUARE
466 #define FF_WAVEFORM_MAX FF_CUSTOM
469 * Set ff device properties
473 #define FF_AUTOCENTER 0x61
476 * ff->playback(effect_id = FF_GAIN) is the first effect_id to
477 * cause a collision with another ff method, in this case ff->set_gain().
478 * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
479 * and thus the total number of effects should never exceed FF_GAIN.
481 #define FF_MAX_EFFECTS FF_GAIN
484 #define FF_CNT (FF_MAX+1)
486 #endif /* _INPUT_H */