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