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