input.h

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