1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3  * Copyright (c) 1999-2002 Vojtech Pavlik
5  * This program is free software; you can redistribute it and/or modify it
10 #define _INPUT_H
15 #include "standard-headers/linux/types.h"
17 #include "standard-headers/linux/input-event-codes.h"
28 #define input_event_sec time.tv_sec
29 #define input_event_usec time.tv_usec
38 #define input_event_sec  __sec
39 #define input_event_usec __usec
50 #define EV_VERSION		0x010001
53  * IOCTLs (0x00 - 0x7f)
64  * struct input_absinfo - used by EVIOCGABS/EVIOCSABS ioctls
100  * struct input_keymap_entry - used by EVIOCGKEYCODE/EVIOCSKEYCODE ioctls
101  * @scancode: scancode represented in machine-endian form.
102  * @len: length of the scancode that resides in @scancode buffer.
110  * option of performing lookup either by @scancode itself or by @index
111  * in keymap entry. EVIOCGKEYCODE will also return scancode or index
115 #define INPUT_KEYMAP_BY_INDEX	(1 << 0)
117 	uint8_t  len;  member
129 #define EVIOCGVERSION		_IOR('E', 0x01, int)			/* get driver version */
130 #define EVIOCGID		_IOR('E', 0x02, struct input_id)	/* get device ID */
131 #define EVIOCGREP		_IOR('E', 0x03, unsigned int[2])	/* get repeat settings */
132 #define EVIOCSREP		_IOW('E', 0x03, unsigned int[2])	/* set repeat settings */
134 #define EVIOCGKEYCODE		_IOR('E', 0x04, unsigned int[2])        /* get keycode */
135 #define EVIOCGKEYCODE_V2	_IOR('E', 0x04, struct input_keymap_entry)
136 #define EVIOCSKEYCODE		_IOW('E', 0x04, unsigned int[2])        /* set keycode */
137 #define EVIOCSKEYCODE_V2	_IOW('E', 0x04, struct input_keymap_entry)
139 #define EVIOCGNAME(len)		_IOC(_IOC_READ, 'E', 0x06, len)		/* get device name */  argument
140 #define EVIOCGPHYS(len)		_IOC(_IOC_READ, 'E', 0x07, len)		/* get physical location */  argument
141 #define EVIOCGUNIQ(len)		_IOC(_IOC_READ, 'E', 0x08, len)		/* get unique identifier */  argument
142 #define EVIOCGPROP(len)		_IOC(_IOC_READ, 'E', 0x09, len)		/* get device properties */  argument
145  * EVIOCGMTSLOTS(len) - get MT slot values
146  * @len: size of the data buffer in bytes
157  * The ioctl size argument (len) is the size of the buffer, which
158  * should satisfy len = (num_slots + 1) * sizeof(int32_t).  If len is
166  * If the request code is not an ABS_MT value, -EINVAL is returned.
168 #define EVIOCGMTSLOTS(len)	_IOC(_IOC_READ, 'E', 0x0a, len)  argument
170 #define EVIOCGKEY(len)		_IOC(_IOC_READ, 'E', 0x18, len)		/* get global key state */  argument
171 #define EVIOCGLED(len)		_IOC(_IOC_READ, 'E', 0x19, len)		/* get all LEDs */  argument
172 #define EVIOCGSND(len)		_IOC(_IOC_READ, 'E', 0x1a, len)		/* get all sounds status */  argument
173 #define EVIOCGSW(len)		_IOC(_IOC_READ, 'E', 0x1b, len)		/* get all switch states */  argument
175 #define EVIOCGBIT(ev,len)	_IOC(_IOC_READ, 'E', 0x20 + (ev), len)	/* get event bits */  argument
176 #define EVIOCGABS(abs)		_IOR('E', 0x40 + (abs), struct input_absinfo)	/* get abs value/limits */
177 #define EVIOCSABS(abs)		_IOW('E', 0xc0 + (abs), struct input_absinfo)	/* set abs value/limits */
179 #define EVIOCSFF		_IOW('E', 0x80, struct ff_effect)	/* send a force effect to a force feedback devi…
180 #define EVIOCRMFF		_IOW('E', 0x81, int)			/* Erase a force effect */
181 #define EVIOCGEFFECTS		_IOR('E', 0x84, int)			/* Report number of effects playable at the same time…
183 #define EVIOCGRAB		_IOW('E', 0x90, int)			/* Grab/Release device */
184 #define EVIOCREVOKE		_IOW('E', 0x91, int)			/* Revoke device access */
187  * EVIOCGMASK - Retrieve current event mask
194  * The event mask is a per-client mask that specifies which events are
205  * event type or if the receive buffer is larger than the number of
212  * if the receive-buffer points to invalid memory, or EINVAL if the kernel
215 #define EVIOCGMASK		_IOR('E', 0x92, struct input_mask)	/* Get event-masks */
218  * EVIOCSMASK - Set event mask
222  * type.  See EVIOCGMASK for a description of event-masks and the
223  * argument-type.
226  * is unknown to the kernel, or if the number of event codes specified in
231  * all known event-codes, all remaining codes are automatically cleared and
235  * returned if the receive-buffer points to invalid memory. EINVAL is returned
238 #define EVIOCSMASK		_IOW('E', 0x93, struct input_mask)	/* Set event-masks */
240 #define EVIOCSCLOCKID		_IOW('E', 0xa0, int)			/* Set clockid to be used for timestamps */
246 #define ID_BUS			0
247 #define ID_VENDOR		1
248 #define ID_PRODUCT		2
249 #define ID_VERSION		3
251 #define BUS_PCI			0x01
252 #define BUS_ISAPNP		0x02
253 #define BUS_USB			0x03
254 #define BUS_HIL			0x04
255 #define BUS_BLUETOOTH		0x05
256 #define BUS_VIRTUAL		0x06
258 #define BUS_ISA			0x10
259 #define BUS_I8042		0x11
260 #define BUS_XTKBD		0x12
261 #define BUS_RS232		0x13
262 #define BUS_GAMEPORT		0x14
263 #define BUS_PARPORT		0x15
264 #define BUS_AMIGA		0x16
265 #define BUS_ADB			0x17
266 #define BUS_I2C			0x18
267 #define BUS_HOST		0x19
268 #define BUS_GSC			0x1A
269 #define BUS_ATARI		0x1B
270 #define BUS_SPI			0x1C
271 #define BUS_RMI			0x1D
272 #define BUS_CEC			0x1E
273 #define BUS_INTEL_ISHTP		0x1F
274 #define BUS_AMD_SFH		0x20
279 #define MT_TOOL_FINGER		0x00
280 #define MT_TOOL_PEN		0x01
281 #define MT_TOOL_PALM		0x02
282 #define MT_TOOL_DIAL		0x0a
283 #define MT_TOOL_MAX		0x0f
286  * Values describing the status of a force-feedback effect
288 #define FF_STATUS_STOPPED	0x00
289 #define FF_STATUS_PLAYING	0x01
290 #define FF_STATUS_MAX		0x01
303  * struct ff_replay - defines scheduling of the force-feedback effect
313  * struct ff_trigger - defines what triggers the force-feedback effect
315  * @interval: controls how soon the effect can be re-triggered
323  * struct ff_envelope - generic force-feedback effect envelope
330  * envelope force-feedback core will convert to positive/negative
332  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
342  * struct ff_constant_effect - defines parameters of a constant force-feedback effect
352  * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
364  * struct ff_condition_effect - defines a spring or friction force-feedback effect
385  * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
395  * Known waveforms - FF_SQUARE, FF_TRIANGLE, FF_SINE, FF_SAW_UP,
416  * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
429  * struct ff_effect - defines force feedback effect
431  *	FF_FRICTION, FF_DAMPER, FF_RUMBLE, FF_INERTIA, or FF_CUSTOM)
436  * @u: effect-specific structure (one of ff_constant_effect, ff_ramp_effect,
441  * To create a new effect application should set its @id to -1; the kernel
442  * will return assigned @id which can later be used to update or delete
446  *	0 deg -> 0x0000 (down)
447  *	90 deg -> 0x4000 (left)
448  *	180 deg -> 0x8000 (up)
449  *	270 deg -> 0xC000 (right)
471 #define FF_RUMBLE	0x50
472 #define FF_PERIODIC	0x51
473 #define FF_CONSTANT	0x52
474 #define FF_SPRING	0x53
475 #define FF_FRICTION	0x54
476 #define FF_DAMPER	0x55
477 #define FF_INERTIA	0x56
478 #define FF_RAMP		0x57
480 #define FF_EFFECT_MIN	FF_RUMBLE
481 #define FF_EFFECT_MAX	FF_RAMP
487 #define FF_SQUARE	0x58
488 #define FF_TRIANGLE	0x59
489 #define FF_SINE		0x5a
490 #define FF_SAW_UP	0x5b
491 #define FF_SAW_DOWN	0x5c
492 #define FF_CUSTOM	0x5d
494 #define FF_WAVEFORM_MIN	FF_SQUARE
495 #define FF_WAVEFORM_MAX	FF_CUSTOM
501 #define FF_GAIN		0x60
502 #define FF_AUTOCENTER	0x61
505  * ff->playback(effect_id = FF_GAIN) is the first effect_id to
506  * cause a collision with another ff method, in this case ff->set_gain().
507  * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
510 #define FF_MAX_EFFECTS	FF_GAIN
512 #define FF_MAX		0x7f
513 #define FF_CNT		(FF_MAX+1)