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