1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2/*
3 * Copyright (c) 1999-2002 Vojtech Pavlik
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
8 */
9#ifndef _INPUT_H
10#define _INPUT_H
11
12
13#include <sys/time.h>
14#include <sys/ioctl.h>
15#include <sys/types.h>
16#include <linux/types.h>
17
18#include "input-event-codes.h"
19
20/*
21 * The event structure itself
22 */
23
24struct input_event {
25 struct timeval time;
26 __u16 type;
27 __u16 code;
28 __s32 value;
29};
30
31/*
32 * Protocol version.
33 */
34
35#define EV_VERSION 0x010001
36
37/*
38 * IOCTLs (0x00 - 0x7f)
39 */
40
41struct input_id {
42 __u16 bustype;
43 __u16 vendor;
44 __u16 product;
45 __u16 version;
46};
47
48/**
49 * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
50 * @value: latest reported value for the axis.
51 * @minimum: specifies minimum value for the axis.
52 * @maximum: specifies maximum value for the axis.
53 * @fuzz: specifies fuzz value that is used to filter noise from
54 * the event stream.
55 * @flat: values that are within this value will be discarded by
56 * joydev interface and reported as 0 instead.
57 * @resolution: specifies resolution for the values reported for
58 * the axis.
59 *
60 * Note that input core does not clamp reported values to the
61 * [minimum, maximum] limits, such task is left to userspace.
62 *
63 * The default resolution for main axes (ABS_X, ABS_Y, ABS_Z)
64 * is reported in units per millimeter (units/mm), resolution
65 * for rotational axes (ABS_RX, ABS_RY, ABS_RZ) is reported
66 * in units per radian.
67 * When INPUT_PROP_ACCELEROMETER is set the resolution changes.
68 * The main axes (ABS_X, ABS_Y, ABS_Z) are then reported in
69 * in units per g (units/g) and in units per degree per second
70 * (units/deg/s) for rotational axes (ABS_RX, ABS_RY, ABS_RZ).
71 */
72struct input_absinfo {
73 __s32 value;
74 __s32 minimum;
75 __s32 maximum;
76 __s32 fuzz;
77 __s32 flat;
78 __s32 resolution;
79};
80
81/**
82 * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
83 * @scancode: scancode represented in machine-endian form.
84 * @len: length of the scancode that resides in @scancode buffer.
85 * @index: index in the keymap, may be used instead of scancode
86 * @flags: allows to specify how kernel should handle the request. For
87 * example, setting INPUT_KEYMAP_BY_INDEX flag indicates that kernel
88 * should perform lookup in keymap by @index instead of @scancode
89 * @keycode: key code assigned to this scancode
90 *
91 * The structure is used to retrieve and modify keymap data. Users have
92 * option of performing lookup either by @scancode itself or by @index
93 * in keymap entry. EVIOCGKEYCODE will also return scancode or index
94 * (depending on which element was used to perform lookup).
95 */
96struct input_keymap_entry {
97#define INPUT_KEYMAP_BY_INDEX (1 << 0)
98 __u8 flags;
99 __u8 len;
100 __u16 index;
101 __u32 keycode;
102 __u8 scancode[32];
103};
104
105struct input_mask {
106 __u32 type;
107 __u32 codes_size;
108 __u64 codes_ptr;
109};
110
111#define EVIOCGVERSION _IOR('E', 0x01, int) /* get driver version */
112#define EVIOCGID _IOR('E', 0x02, struct input_id) /* get device ID */
113#define EVIOCGREP _IOR('E', 0x03, unsigned int[2]) /* get repeat settings */
114#define EVIOCSREP _IOW('E', 0x03, unsigned int[2]) /* set repeat settings */
115
116#define EVIOCGKEYCODE _IOR('E', 0x04, unsigned int[2]) /* get keycode */
117#define EVIOCGKEYCODE_V2 _IOR('E', 0x04, struct input_keymap_entry)
118#define EVIOCSKEYCODE _IOW('E', 0x04, unsigned int[2]) /* set keycode */
119#define EVIOCSKEYCODE_V2 _IOW('E', 0x04, struct input_keymap_entry)
120
121#define EVIOCGNAME(len) _IOC(_IOC_READ, 'E', 0x06, len) /* get device name */
122#define EVIOCGPHYS(len) _IOC(_IOC_READ, 'E', 0x07, len) /* get physical location */
123#define EVIOCGUNIQ(len) _IOC(_IOC_READ, 'E', 0x08, len) /* get unique identifier */
124#define EVIOCGPROP(len) _IOC(_IOC_READ, 'E', 0x09, len) /* get device properties */
125
126/**
127 * EVIOCGMTSLOTS(len) - get MT slot values
128 * @len: size of the data buffer in bytes
129 *
130 * The ioctl buffer argument should be binary equivalent to
131 *
132 * struct input_mt_request_layout {
133 * __u32 code;
134 * __s32 values[num_slots];
135 * };
136 *
137 * where num_slots is the (arbitrary) number of MT slots to extract.
138 *
139 * The ioctl size argument (len) is the size of the buffer, which
140 * should satisfy len = (num_slots + 1) * sizeof(__s32). If len is
141 * too small to fit all available slots, the first num_slots are
142 * returned.
143 *
144 * Before the call, code is set to the wanted ABS_MT event type. On
145 * return, values[] is filled with the slot values for the specified
146 * ABS_MT code.
147 *
148 * If the request code is not an ABS_MT value, -EINVAL is returned.
149 */
150#define EVIOCGMTSLOTS(len) _IOC(_IOC_READ, 'E', 0x0a, len)
151
152#define EVIOCGKEY(len) _IOC(_IOC_READ, 'E', 0x18, len) /* get global key state */
153#define EVIOCGLED(len) _IOC(_IOC_READ, 'E', 0x19, len) /* get all LEDs */
154#define EVIOCGSND(len) _IOC(_IOC_READ, 'E', 0x1a, len) /* get all sounds status */
155#define EVIOCGSW(len) _IOC(_IOC_READ, 'E', 0x1b, len) /* get all switch states */
156
157#define EVIOCGBIT(ev,len) _IOC(_IOC_READ, 'E', 0x20 + (ev), len) /* get event bits */
158#define EVIOCGABS(abs) _IOR('E', 0x40 + (abs), struct input_absinfo) /* get abs value/limits */
159#define EVIOCSABS(abs) _IOW('E', 0xc0 + (abs), struct input_absinfo) /* set abs value/limits */
160
161#define EVIOCSFF _IOW('E', 0x80, struct ff_effect) /* send a force effect to a force feedback device */
162#define EVIOCRMFF _IOW('E', 0x81, int) /* Erase a force effect */
163#define EVIOCGEFFECTS _IOR('E', 0x84, int) /* Report number of effects playable at the same time */
164
165#define EVIOCGRAB _IOW('E', 0x90, int) /* Grab/Release device */
166#define EVIOCREVOKE _IOW('E', 0x91, int) /* Revoke device access */
167
168/**
169 * EVIOCGMASK - Retrieve current event mask
170 *
171 * This ioctl allows user to retrieve the current event mask for specific
172 * event type. The argument must be of type "struct input_mask" and
173 * specifies the event type to query, the address of the receive buffer and
174 * the size of the receive buffer.
175 *
176 * The event mask is a per-client mask that specifies which events are
177 * forwarded to the client. Each event code is represented by a single bit
178 * in the event mask. If the bit is set, the event is passed to the client
179 * normally. Otherwise, the event is filtered and will never be queued on
180 * the client's receive buffer.
181 *
182 * Event masks do not affect global state of the input device. They only
183 * affect the file descriptor they are applied to.
184 *
185 * The default event mask for a client has all bits set, i.e. all events
186 * are forwarded to the client. If the kernel is queried for an unknown
187 * event type or if the receive buffer is larger than the number of
188 * event codes known to the kernel, the kernel returns all zeroes for those
189 * codes.
190 *
191 * At maximum, codes_size bytes are copied.
192 *
193 * This ioctl may fail with ENODEV in case the file is revoked, EFAULT
194 * if the receive-buffer points to invalid memory, or EINVAL if the kernel
195 * does not implement the ioctl.
196 */
197#define EVIOCGMASK _IOR('E', 0x92, struct input_mask) /* Get event-masks */
198
199/**
200 * EVIOCSMASK - Set event mask
201 *
202 * This ioctl is the counterpart to EVIOCGMASK. Instead of receiving the
203 * current event mask, this changes the client's event mask for a specific
204 * type. See EVIOCGMASK for a description of event-masks and the
205 * argument-type.
206 *
207 * This ioctl provides full forward compatibility. If the passed event type
208 * is unknown to the kernel, or if the number of event codes specified in
209 * the mask is bigger than what is known to the kernel, the ioctl is still
210 * accepted and applied. However, any unknown codes are left untouched and
211 * stay cleared. That means, the kernel always filters unknown codes
212 * regardless of what the client requests. If the new mask doesn't cover
213 * all known event-codes, all remaining codes are automatically cleared and
214 * thus filtered.
215 *
216 * This ioctl may fail with ENODEV in case the file is revoked. EFAULT is
217 * returned if the receive-buffer points to invalid memory. EINVAL is returned
218 * if the kernel does not implement the ioctl.
219 */
220#define EVIOCSMASK _IOW('E', 0x93, struct input_mask) /* Set event-masks */
221
222#define EVIOCSCLOCKID _IOW('E', 0xa0, int) /* Set clockid to be used for timestamps */
223
224/*
225 * IDs.
226 */
227
228#define ID_BUS 0
229#define ID_VENDOR 1
230#define ID_PRODUCT 2
231#define ID_VERSION 3
232
233#define BUS_PCI 0x01
234#define BUS_ISAPNP 0x02
235#define BUS_USB 0x03
236#define BUS_HIL 0x04
237#define BUS_BLUETOOTH 0x05
238#define BUS_VIRTUAL 0x06
239
240#define BUS_ISA 0x10
241#define BUS_I8042 0x11
242#define BUS_XTKBD 0x12
243#define BUS_RS232 0x13
244#define BUS_GAMEPORT 0x14
245#define BUS_PARPORT 0x15
246#define BUS_AMIGA 0x16
247#define BUS_ADB 0x17
248#define BUS_I2C 0x18
249#define BUS_HOST 0x19
250#define BUS_GSC 0x1A
251#define BUS_ATARI 0x1B
252#define BUS_SPI 0x1C
253#define BUS_RMI 0x1D
254#define BUS_CEC 0x1E
255#define BUS_INTEL_ISHTP 0x1F
256
257/*
258 * MT_TOOL types
259 */
260#define MT_TOOL_FINGER 0
261#define MT_TOOL_PEN 1
262#define MT_TOOL_PALM 2
263#define MT_TOOL_MAX 2
264
265/*
266 * Values describing the status of a force-feedback effect
267 */
268#define FF_STATUS_STOPPED 0x00
269#define FF_STATUS_PLAYING 0x01
270#define FF_STATUS_MAX 0x01
271
272/*
273 * Structures used in ioctls to upload effects to a device
274 * They are pieces of a bigger structure (called ff_effect)
275 */
276
277/*
278 * All duration values are expressed in ms. Values above 32767 ms (0x7fff)
279 * should not be used and have unspecified results.
280 */
281
282/**
283 * struct ff_replay - defines scheduling of the force-feedback effect
284 * @length: duration of the effect
285 * @delay: delay before effect should start playing
286 */
287struct ff_replay {
288 __u16 length;
289 __u16 delay;
290};
291
292/**
293 * struct ff_trigger - defines what triggers the force-feedback effect
294 * @button: number of the button triggering the effect
295 * @interval: controls how soon the effect can be re-triggered
296 */
297struct ff_trigger {
298 __u16 button;
299 __u16 interval;
300};
301
302/**
303 * struct ff_envelope - generic force-feedback effect envelope
304 * @attack_length: duration of the attack (ms)
305 * @attack_level: level at the beginning of the attack
306 * @fade_length: duration of fade (ms)
307 * @fade_level: level at the end of fade
308 *
309 * The @attack_level and @fade_level are absolute values; when applying
310 * envelope force-feedback core will convert to positive/negative
311 * value based on polarity of the default level of the effect.
312 * Valid range for the attack and fade levels is 0x0000 - 0x7fff
313 */
314struct ff_envelope {
315 __u16 attack_length;
316 __u16 attack_level;
317 __u16 fade_length;
318 __u16 fade_level;
319};
320
321/**
322 * struct ff_constant_effect - defines parameters of a constant force-feedback effect
323 * @level: strength of the effect; may be negative
324 * @envelope: envelope data
325 */
326struct ff_constant_effect {
327 __s16 level;
328 struct ff_envelope envelope;
329};
330
331/**
332 * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
333 * @start_level: beginning strength of the effect; may be negative
334 * @end_level: final strength of the effect; may be negative
335 * @envelope: envelope data
336 */
337struct ff_ramp_effect {
338 __s16 start_level;
339 __s16 end_level;
340 struct ff_envelope envelope;
341};
342
343/**
344 * struct ff_condition_effect - defines a spring or friction force-feedback effect
345 * @right_saturation: maximum level when joystick moved all way to the right
346 * @left_saturation: same for the left side
347 * @right_coeff: controls how fast the force grows when the joystick moves
348 * to the right
349 * @left_coeff: same for the left side
350 * @deadband: size of the dead zone, where no force is produced
351 * @center: position of the dead zone
352 */
353struct ff_condition_effect {
354 __u16 right_saturation;
355 __u16 left_saturation;
356
357 __s16 right_coeff;
358 __s16 left_coeff;
359
360 __u16 deadband;
361 __s16 center;
362};
363
364/**
365 * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
366 * @waveform: kind of the effect (wave)
367 * @period: period of the wave (ms)
368 * @magnitude: peak value
369 * @offset: mean value of the wave (roughly)
370 * @phase: 'horizontal' shift
371 * @envelope: envelope data
372 * @custom_len: number of samples (FF_CUSTOM only)
373 * @custom_data: buffer of samples (FF_CUSTOM only)
374 *
375 * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
376 * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
377 * for the time being as no driver supports it yet.
378 *
379 * Note: the data pointed by custom_data is copied by the driver.
380 * You can therefore dispose of the memory after the upload/update.
381 */
382struct ff_periodic_effect {
383 __u16 waveform;
384 __u16 period;
385 __s16 magnitude;
386 __s16 offset;
387 __u16 phase;
388
389 struct ff_envelope envelope;
390
391 __u32 custom_len;
392 __s16 *custom_data;
393};
394
395/**
396 * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
397 * @strong_magnitude: magnitude of the heavy motor
398 * @weak_magnitude: magnitude of the light one
399 *
400 * Some rumble pads have two motors of different weight. Strong_magnitude
401 * represents the magnitude of the vibration generated by the heavy one.
402 */
403struct ff_rumble_effect {
404 __u16 strong_magnitude;
405 __u16 weak_magnitude;
406};
407
408/**
409 * struct ff_effect - defines force feedback effect
410 * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
411 * FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
412 * @id: an unique id assigned to an effect
413 * @direction: direction of the effect
414 * @trigger: trigger conditions (struct ff_trigger)
415 * @replay: scheduling of the effect (struct ff_replay)
416 * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
417 * ff_periodic_effect, ff_condition_effect, ff_rumble_effect) further
418 * defining effect parameters
419 *
420 * This structure is sent through ioctl from the application to the driver.
421 * To create a new effect application should set its @id to -1; the kernel
422 * will return assigned @id which can later be used to update or delete
423 * this effect.
424 *
425 * Direction of the effect is encoded as follows:
426 * 0 deg -> 0x0000 (down)
427 * 90 deg -> 0x4000 (left)
428 * 180 deg -> 0x8000 (up)
429 * 270 deg -> 0xC000 (right)
430 */
431struct ff_effect {
432 __u16 type;
433 __s16 id;
434 __u16 direction;
435 struct ff_trigger trigger;
436 struct ff_replay replay;
437
438 union {
439 struct ff_constant_effect constant;
440 struct ff_ramp_effect ramp;
441 struct ff_periodic_effect periodic;
442 struct ff_condition_effect condition[2]; /* One for each axis */
443 struct ff_rumble_effect rumble;
444 } u;
445};
446
447/*
448 * Force feedback effect types
449 */
450
451#define FF_RUMBLE 0x50
452#define FF_PERIODIC 0x51
453#define FF_CONSTANT 0x52
454#define FF_SPRING 0x53
455#define FF_FRICTION 0x54
456#define FF_DAMPER 0x55
457#define FF_INERTIA 0x56
458#define FF_RAMP 0x57
459
460#define FF_EFFECT_MIN FF_RUMBLE
461#define FF_EFFECT_MAX FF_RAMP
462
463/*
464 * Force feedback periodic effect types
465 */
466
467#define FF_SQUARE 0x58
468#define FF_TRIANGLE 0x59
469#define FF_SINE 0x5a
470#define FF_SAW_UP 0x5b
471#define FF_SAW_DOWN 0x5c
472#define FF_CUSTOM 0x5d
473
474#define FF_WAVEFORM_MIN FF_SQUARE
475#define FF_WAVEFORM_MAX FF_CUSTOM
476
477/*
478 * Set ff device properties
479 */
480
481#define FF_GAIN 0x60
482#define FF_AUTOCENTER 0x61
483
484/*
485 * ff->playback(effect_id = FF_GAIN) is the first effect_id to
486 * cause a collision with another ff method, in this case ff->set_gain().
487 * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
488 * and thus the total number of effects should never exceed FF_GAIN.
489 */
490#define FF_MAX_EFFECTS FF_GAIN
491
492#define FF_MAX 0x7f
493#define FF_CNT (FF_MAX+1)
494
495#endif /* _INPUT_H */
496