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