uapi/linux/input.h

1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3  * Copyright (c) 1999-2002 Vojtech Pavlik
17 #include <linux/types.h>
20 #include "input-event-codes.h"
23  * The event structure itself
56  * IOCTLs (0x00 - 0x7f)
67  * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
72  *	the event stream.
103  * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
104  * @scancode: scancode represented in machine-endian form.
148  * EVIOCGMTSLOTS(len) - get MT slot values
165  * Before the call, code is set to the wanted ABS_MT event type. On
169  * If the request code is not an ABS_MT value, -EINVAL is returned.
178 #define EVIOCGBIT(ev,len)	_IOC(_IOC_READ, 'E', 0x20 + (ev), len)	/* get event bits */
190  * EVIOCGMASK - Retrieve current event mask
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
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
203  * Event masks do not affect global state of the input device. They only
206  * The default event mask for a client has all bits set, i.e. all events
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.
215  * if the receive-buffer points to invalid memory, or EINVAL if the kernel
218 #define EVIOCGMASK		_IOR('E', 0x92, struct input_mask)	/* Get event-masks */
221  * EVIOCSMASK - Set event mask
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.
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
231  * accepted and applied. However, any unknown codes are left untouched and
232  * stay cleared. That means, the kernel always filters unknown codes
234  * all known event-codes, all remaining codes are automatically cleared and
238  * returned if the receive-buffer points to invalid memory. EINVAL is returned
241 #define EVIOCSMASK		_IOW('E', 0x93, struct input_mask)	/* Set event-masks */
289  * Values describing the status of a force-feedback effect
306  * struct ff_replay - defines scheduling of the force-feedback effect
316  * struct ff_trigger - defines what triggers the force-feedback effect
318  * @interval: controls how soon the effect can be re-triggered
326  * struct ff_envelope - generic force-feedback effect envelope
333  * envelope force-feedback core will convert to positive/negative
335  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
345  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
355  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
367  * struct ff_condition_effect - defines a spring or friction force-feedback effect
388  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
398  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
419  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
432  * struct ff_effect - defines force feedback effect
439  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
444  * To create a new effect application should set its @id to -1; the kernel
449  *	0 deg -> 0x0000 (down)
450  *	90 deg -> 0x4000 (left)
451  *	180 deg -> 0x8000 (up)
452  *	270 deg -> 0xC000 (right)
508  * ff->playback(effect_id = FF_GAIN) is the first effect_id to
509  * cause a collision with another ff method, in this case ff->set_gain().
510  * Therefore the greatest safe value for effect_id is FF_GAIN - 1,