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

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

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

~ [ 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