standard-headers/linux/input.h

6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
20  * The event structure itself
65  * @value: latest reported value for the axis.
66  * @minimum: specifies minimum value for the axis.
67  * @maximum: specifies maximum value for the axis.
69  *	the event stream.
72  * @resolution: specifies resolution for the values reported for
73  *	the axis.
75  * Note that input core does not clamp reported values to the
78  * The default resolution for main axes (ABS_X, ABS_Y, ABS_Z,
82  * The resolution for the size axes (ABS_MT_TOUCH_MAJOR,
85  * When INPUT_PROP_ACCELEROMETER is set the resolution changes.
86  * The main axes (ABS_X, ABS_Y, ABS_Z) are then reported in
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
109  * The structure is used to retrieve and modify keymap data. Users have
146  * @len: size of the data buffer in bytes
148  * The ioctl buffer argument should be binary equivalent to
155  * where num_slots is the (arbitrary) number of MT slots to extract.
157  * The ioctl size argument (len) is the size of the buffer, which
159  * too small to fit all available slots, the first num_slots are
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
166  * If the request code is not an ABS_MT value, -EINVAL is returned.
181 #define EVIOCGEFFECTS		_IOR('E', 0x84, int)			/* Report number of effects playable at the same time…
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.
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.
200  * Event masks do not affect global state of the input device. They only
201  * affect the file descriptor they are applied to.
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
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.
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
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
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
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.
286  * Values describing the status of a force-feedback effect
303  * struct ff_replay - defines scheduling of the force-feedback effect
304  * @length: duration of the effect
313  * struct ff_trigger - defines what triggers the force-feedback effect
314  * @button: number of the button triggering the effect
315  * @interval: controls how soon the effect can be re-triggered
324  * @attack_length: duration of the attack (ms)
325  * @attack_level: level at the beginning of the attack
327  * @fade_level: level at the end of fade
329  * The @attack_level and @fade_level are absolute values; when applying
331  * value based on polarity of the default level of the effect.
332  * Valid range for the attack and fade levels is 0x0000 - 0x7fff
343  * @level: strength of the effect; may be negative
353  * @start_level: beginning strength of the effect; may be negative
354  * @end_level: final strength of the effect; may be negative
365  * @right_saturation: maximum level when joystick moved all way to the right
366  * @left_saturation: same for the left side
367  * @right_coeff: controls how fast the force grows when the joystick moves
368  *	to the right
369  * @left_coeff: same for the left side
370  * @deadband: size of the dead zone, where no force is produced
371  * @center: position of the dead zone
386  * @waveform: kind of the effect (wave)
387  * @period: period of the wave (ms)
389  * @offset: mean value of the wave (roughly)
396  * FF_SAW_DOWN, FF_CUSTOM. The exact syntax FF_CUSTOM is undefined
397  * for the time being as no driver supports it yet.
399  * Note: the data pointed by custom_data is copied by the driver.
400  * You can therefore dispose of the memory after the upload/update.
417  * @strong_magnitude: magnitude of the heavy motor
418  * @weak_magnitude: magnitude of the light one
421  * represents the magnitude of the vibration generated by the heavy one.
430  * @type: type of the effect (FF_CONSTANT, FF_PERIODIC, FF_RAMP, FF_SPRING,
433  * @direction: direction of the effect
435  * @replay: scheduling of the effect (struct ff_replay)
440  * This structure is sent through ioctl from the application to the driver.
441  * To create a new effect application should set its @id to -1; the kernel
445  * Direction of the effect is encoded as follows:
505  * ff->playback(effect_id = FF_GAIN) is the first effect_id to
507  * Therefore the greatest safe value for effect_id is FF_GAIN - 1,
508  * and thus the total number of effects should never exceed FF_GAIN.