logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

input.h (16217B)


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