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.
14 #include <sys/ioctl.h>
15 #include <sys/types.h>
16 #include <linux/types.h>
19 #include "input-event-codes.h"
22 * The event structure itself
36 #define EV_VERSION 0x010001
39 * IOCTLs (0x00 - 0x7f)
50 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
51 * @value: latest reported value for the axis.
52 * @minimum: specifies minimum value for the axis.
53 * @maximum: specifies maximum value for the axis.
54 * @fuzz: specifies fuzz value that is used to filter noise from
56 * @flat: values that are within this value will be discarded by
57 * joydev interface and reported as 0 instead.
58 * @resolution: specifies resolution for the values reported for
61 * Note that input core does not clamp reported values to the
62 * [minimum, maximum] limits, such task is left to userspace.
64 * The default resolution for main axes (ABS_X, ABS_Y, ABS_Z)
65 * is reported in units per millimeter (units/mm), resolution
66 * for rotational axes (ABS_RX, ABS_RY, ABS_RZ) is reported
67 * in units per radian.
68 * When INPUT_PROP_ACCELEROMETER is set the resolution changes.
69 * The main axes (ABS_X, ABS_Y, ABS_Z) are then reported in
70 * in units per g (units/g) and in units per degree per second
71 * (units/deg/s) for rotational axes (ABS_RX, ABS_RY, ABS_RZ).
73 struct input_absinfo {
83 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
84 * @scancode: scancode represented in machine-endian form.
85 * @len: length of the scancode that resides in @scancode buffer.
86 * @index: index in the keymap, may be used instead of scancode
87 * @flags: allows to specify how kernel should handle the request. For
88 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
89 * should perform lookup in keymap by @index instead of @scancode
90 * @keycode: key code assigned to this scancode
92 * The structure is used to retrieve and modify keymap data. Users have
93 * option of performing lookup either by @scancode itself or by @index
94 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
95 * (depending on which element was used to perform lookup).
97 struct input_keymap_entry {
98 #define INPUT_KEYMAP_BY_INDEX (1 << 0)
112 #define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
113 #define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
114 #define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
115 #define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
117 #define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
118 #define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
119 #define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
120 #define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
122 #define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
123 #define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
124 #define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
125 #define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
128 * EVIOCGMTSLOTS(len) - get MT slot values
129 * @len: size of the data buffer in bytes
131 * The ioctl buffer argument should be binary equivalent to
133 * struct input_mt_request_layout {
135 * __s32 values[num_slots];
138 * where num_slots is the (arbitrary) number of MT slots to extract.
140 * The ioctl size argument (len) is the size of the buffer, which
141 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is
142 * too small to fit all available slots, the first num_slots are
145 * Before the call, code is set to the wanted ABS_MT event type. On
146 * return, values[] is filled with the slot values for the specified
149 * If the request code is not an ABS_MT value, -EINVAL is returned.
151 #define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
153 #define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
154 #define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
155 #define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
156 #define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
158 #define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
159 #define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
160 #define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
162 #define EVIOCSFF _IOW('E', 0x80, struct ff_effect) /* send a force effect to a force feedback device */
163 #define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
164 #define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
166 #define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
167 #define EVIOCREVOKE _IOW('E', 0x91, int) /* Revoke device access */
170 * EVIOCGMASK - Retrieve current event mask
172 * This ioctl allows user to retrieve the current event mask for specific
173 * event type. The argument must be of type "struct input_mask" and
174 * specifies the event type to query, the address of the receive buffer and
175 * the size of the receive buffer.
177 * The event mask is a per-client mask that specifies which events are
178 * forwarded to the client. Each event code is represented by a single bit
179 * in the event mask. If the bit is set, the event is passed to the client
180 * normally. Otherwise, the event is filtered and will never be queued on
181 * the client's receive buffer.
183 * Event masks do not affect global state of the input device. They only
184 * affect the file descriptor they are applied to.
186 * The default event mask for a client has all bits set, i.e. all events
187 * are forwarded to the client. If the kernel is queried for an unknown
188 * event type or if the receive buffer is larger than the number of
189 * event codes known to the kernel, the kernel returns all zeroes for those
192 * At maximum, codes_size bytes are copied.
194 * This ioctl may fail with ENODEV in case the file is revoked, EFAULT
195 * if the receive-buffer points to invalid memory, or EINVAL if the kernel
196 * does not implement the ioctl.
198 #define EVIOCGMASK _IOR('E', 0x92, struct input_mask) /* Get event-masks */
201 * EVIOCSMASK - Set event mask
203 * This ioctl is the counterpart to EVIOCGMASK. Instead of receiving the
204 * current event mask, this changes the client's event mask for a specific
205 * type. See EVIOCGMASK for a description of event-masks and the
208 * This ioctl provides full forward compatibility. If the passed event type
209 * is unknown to the kernel, or if the number of event codes specified in
210 * the mask is bigger than what is known to the kernel, the ioctl is still
211 * accepted and applied. However, any unknown codes are left untouched and
212 * stay cleared. That means, the kernel always filters unknown codes
213 * regardless of what the client requests. If the new mask doesn't cover
214 * all known event-codes, all remaining codes are automatically cleared and
217 * This ioctl may fail with ENODEV in case the file is revoked. EFAULT is
218 * returned if the receive-buffer points to invalid memory. EINVAL is returned
219 * if the kernel does not implement the ioctl.
221 #define EVIOCSMASK _IOW('E', 0x93, struct input_mask) /* Set event-masks */
223 #define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
235 #define BUS_ISAPNP 0x02
238 #define BUS_BLUETOOTH 0x05
239 #define BUS_VIRTUAL 0x06
242 #define BUS_I8042 0x11
243 #define BUS_XTKBD 0x12
244 #define BUS_RS232 0x13
245 #define BUS_GAMEPORT 0x14
246 #define BUS_PARPORT 0x15
247 #define BUS_AMIGA 0x16
250 #define BUS_HOST 0x19
252 #define BUS_ATARI 0x1B
256 #define BUS_INTEL_ISHTP 0x1F
261 #define MT_TOOL_FINGER 0
262 #define MT_TOOL_PEN 1
263 #define MT_TOOL_PALM 2
264 #define MT_TOOL_MAX 2
267 * Values describing the status of a force-feedback effect
269 #define FF_STATUS_STOPPED 0x00
270 #define FF_STATUS_PLAYING 0x01
271 #define FF_STATUS_MAX 0x01
274 * Structures used in ioctls to upload effects to a device
275 * They are pieces of a bigger structure (called ff_effect)
279 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
280 * should not be used and have unspecified results.
284 * struct ff_replay - defines scheduling of the force-feedback effect
285 * @length: duration of the effect
286 * @delay: delay before effect should start playing
294 * struct ff_trigger - defines what triggers the force-feedback effect
295 * @button: number of the button triggering the effect
296 * @interval: controls how soon the effect can be re-triggered
304 * struct ff_envelope - generic force-feedback effect envelope
305 * @attack_length: duration of the attack (ms)
306 * @attack_level: level at the beginning of the attack
307 * @fade_length: duration of fade (ms)
308 * @fade_level: level at the end of fade
310 * The @attack_level and @fade_level are absolute values; when applying
311 * envelope force-feedback core will convert to positive/negative
312 * value based on polarity of the default level of the effect.
313 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
323 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
324 * @level: strength of the effect; may be negative
325 * @envelope: envelope data
327 struct ff_constant_effect {
329 struct ff_envelope envelope;
333 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
334 * @start_level: beginning strength of the effect; may be negative
335 * @end_level: final strength of the effect; may be negative
336 * @envelope: envelope data
338 struct ff_ramp_effect {
341 struct ff_envelope envelope;
345 * struct ff_condition_effect - defines a spring or friction force-feedback effect
346 * @right_saturation: maximum level when joystick moved all way to the right
347 * @left_saturation: same for the left side
348 * @right_coeff: controls how fast the force grows when the joystick moves
350 * @left_coeff: same for the left side
351 * @deadband: size of the dead zone, where no force is produced
352 * @center: position of the dead zone
354 struct ff_condition_effect {
355 __u16 right_saturation;
356 __u16 left_saturation;
366 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
367 * @waveform: kind of the effect (wave)
368 * @period: period of the wave (ms)
369 * @magnitude: peak value
370 * @offset: mean value of the wave (roughly)
371 * @phase: 'horizontal' shift
372 * @envelope: envelope data
373 * @custom_len: number of samples (FF_CUSTOM only)
374 * @custom_data: buffer of samples (FF_CUSTOM only)
376 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
377 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
378 * for the time being as no driver supports it yet.
380 * Note: the data pointed by custom_data is copied by the driver.
381 * You can therefore dispose of the memory after the upload/update.
383 struct ff_periodic_effect {
390 struct ff_envelope envelope;
393 __s16 __user *custom_data;
397 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
398 * @strong_magnitude: magnitude of the heavy motor
399 * @weak_magnitude: magnitude of the light one
401 * Some rumble pads have two motors of different weight. Strong_magnitude
402 * represents the magnitude of the vibration generated by the heavy one.
404 struct ff_rumble_effect {
405 __u16 strong_magnitude;
406 __u16 weak_magnitude;
410 * struct ff_effect - defines force feedback effect
411 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
412 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
413 * @id: an unique id assigned to an effect
414 * @direction: direction of the effect
415 * @trigger: trigger conditions (struct ff_trigger)
416 * @replay: scheduling of the effect (struct ff_replay)
417 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
418 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
419 * defining effect parameters
421 * This structure is sent through ioctl from the application to the driver.
422 * To create a new effect application should set its @id to -1; the kernel
423 * will return assigned @id which can later be used to update or delete
426 * Direction of the effect is encoded as follows:
427 * 0 deg -> 0x0000 (down)
428 * 90 deg -> 0x4000 (left)
429 * 180 deg -> 0x8000 (up)
430 * 270 deg -> 0xC000 (right)
436 struct ff_trigger trigger;
437 struct ff_replay replay;
440 struct ff_constant_effect constant;
441 struct ff_ramp_effect ramp;
442 struct ff_periodic_effect periodic;
443 struct ff_condition_effect condition[2]; /* One for each axis */
444 struct ff_rumble_effect rumble;
449 * Force feedback effect types
452 #define FF_RUMBLE 0x50
453 #define FF_PERIODIC 0x51
454 #define FF_CONSTANT 0x52
455 #define FF_SPRING 0x53
456 #define FF_FRICTION 0x54
457 #define FF_DAMPER 0x55
458 #define FF_INERTIA 0x56
461 #define FF_EFFECT_MIN FF_RUMBLE
462 #define FF_EFFECT_MAX FF_RAMP
465 * Force feedback periodic effect types
468 #define FF_SQUARE 0x58
469 #define FF_TRIANGLE 0x59
471 #define FF_SAW_UP 0x5b
472 #define FF_SAW_DOWN 0x5c
473 #define FF_CUSTOM 0x5d
475 #define FF_WAVEFORM_MIN FF_SQUARE
476 #define FF_WAVEFORM_MAX FF_CUSTOM
479 * Set ff device properties
483 #define FF_AUTOCENTER 0x61
486 * ff->playback(effect_id = FF_GAIN) is the first effect_id to
487 * cause a collision with another ff method, in this case ff->set_gain().
488 * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
489 * and thus the total number of effects should never exceed FF_GAIN.
491 #define FF_MAX_EFFECTS FF_GAIN
494 #define FF_CNT (FF_MAX+1)
496 #endif /* _UAPI_INPUT_H */