~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/uapi/linux/input.h

Version: ~ [ linux-5.13-rc2 ] ~ [ linux-5.12.4 ] ~ [ linux-5.11.21 ] ~ [ linux-5.10.37 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.119 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.190 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.232 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.268 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.268 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp