uinput.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. /*
  2. * User level driver support for input subsystem
  3. *
  4. * Heavily based on evdev.c by Vojtech Pavlik
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19. *
  20. * Author: Aristeu Sergio Rozanski Filho <aris@cathedrallabs.org>
  21. *
  22. * Changes/Revisions:
  23. * 0.4 01/09/2014 (Benjamin Tissoires <benjamin.tissoires@redhat.com>)
  24. * - add UI_GET_SYSNAME ioctl
  25. * 0.3 24/05/2006 (Anssi Hannula <anssi.hannulagmail.com>)
  26. * - update ff support for the changes in kernel interface
  27. * - add UINPUT_VERSION
  28. * 0.2 16/10/2004 (Micah Dowty <micah@navi.cx>)
  29. * - added force feedback support
  30. * - added UI_SET_PHYS
  31. * 0.1 20/06/2002
  32. * - first public version
  33. */
  34. #ifndef __UINPUT_H_
  35. #define __UINPUT_H_
  36. #include <linux/types.h>
  37. #include <linux/input.h>
  38. #define UINPUT_VERSION 4
  39. struct uinput_ff_upload {
  40. __u32 request_id;
  41. __s32 retval;
  42. struct ff_effect effect;
  43. struct ff_effect old;
  44. };
  45. struct uinput_ff_erase {
  46. __u32 request_id;
  47. __s32 retval;
  48. __u32 effect_id;
  49. };
  50. /* ioctl */
  51. #define UINPUT_IOCTL_BASE 'U'
  52. #define UI_DEV_CREATE _IO(UINPUT_IOCTL_BASE, 1)
  53. #define UI_DEV_DESTROY _IO(UINPUT_IOCTL_BASE, 2)
  54. #define UI_SET_EVBIT _IOW(UINPUT_IOCTL_BASE, 100, int)
  55. #define UI_SET_KEYBIT _IOW(UINPUT_IOCTL_BASE, 101, int)
  56. #define UI_SET_RELBIT _IOW(UINPUT_IOCTL_BASE, 102, int)
  57. #define UI_SET_ABSBIT _IOW(UINPUT_IOCTL_BASE, 103, int)
  58. #define UI_SET_MSCBIT _IOW(UINPUT_IOCTL_BASE, 104, int)
  59. #define UI_SET_LEDBIT _IOW(UINPUT_IOCTL_BASE, 105, int)
  60. #define UI_SET_SNDBIT _IOW(UINPUT_IOCTL_BASE, 106, int)
  61. #define UI_SET_FFBIT _IOW(UINPUT_IOCTL_BASE, 107, int)
  62. #define UI_SET_PHYS _IOW(UINPUT_IOCTL_BASE, 108, char*)
  63. #define UI_SET_SWBIT _IOW(UINPUT_IOCTL_BASE, 109, int)
  64. #define UI_SET_PROPBIT _IOW(UINPUT_IOCTL_BASE, 110, int)
  65. #define UI_BEGIN_FF_UPLOAD _IOWR(UINPUT_IOCTL_BASE, 200, struct uinput_ff_upload)
  66. #define UI_END_FF_UPLOAD _IOW(UINPUT_IOCTL_BASE, 201, struct uinput_ff_upload)
  67. #define UI_BEGIN_FF_ERASE _IOWR(UINPUT_IOCTL_BASE, 202, struct uinput_ff_erase)
  68. #define UI_END_FF_ERASE _IOW(UINPUT_IOCTL_BASE, 203, struct uinput_ff_erase)
  69. /**
  70. * UI_GET_SYSNAME - get the sysfs name of the created uinput device
  71. *
  72. * @return the sysfs name of the created virtual input device.
  73. * The complete sysfs path is then /sys/devices/virtual/input/--NAME--
  74. * Usually, it is in the form "inputN"
  75. */
  76. #define UI_GET_SYSNAME(len) _IOC(_IOC_READ, UINPUT_IOCTL_BASE, 44, len)
  77. /**
  78. * UI_GET_VERSION - Return version of uinput protocol
  79. *
  80. * This writes uinput protocol version implemented by the kernel into
  81. * the integer pointed to by the ioctl argument. The protocol version
  82. * is hard-coded in the kernel and is independent of the uinput device.
  83. */
  84. #define UI_GET_VERSION _IOR(UINPUT_IOCTL_BASE, 45, unsigned int)
  85. /*
  86. * To write a force-feedback-capable driver, the upload_effect
  87. * and erase_effect callbacks in input_dev must be implemented.
  88. * The uinput driver will generate a fake input event when one of
  89. * these callbacks are invoked. The userspace code then uses
  90. * ioctls to retrieve additional parameters and send the return code.
  91. * The callback blocks until this return code is sent.
  92. *
  93. * The described callback mechanism is only used if ff_effects_max
  94. * is set.
  95. *
  96. * To implement upload_effect():
  97. * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_UPLOAD.
  98. * A request ID will be given in 'value'.
  99. * 2. Allocate a uinput_ff_upload struct, fill in request_id with
  100. * the 'value' from the EV_UINPUT event.
  101. * 3. Issue a UI_BEGIN_FF_UPLOAD ioctl, giving it the
  102. * uinput_ff_upload struct. It will be filled in with the
  103. * ff_effects passed to upload_effect().
  104. * 4. Perform the effect upload, and place a return code back into
  105. the uinput_ff_upload struct.
  106. * 5. Issue a UI_END_FF_UPLOAD ioctl, also giving it the
  107. * uinput_ff_upload_effect struct. This will complete execution
  108. * of our upload_effect() handler.
  109. *
  110. * To implement erase_effect():
  111. * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_ERASE.
  112. * A request ID will be given in 'value'.
  113. * 2. Allocate a uinput_ff_erase struct, fill in request_id with
  114. * the 'value' from the EV_UINPUT event.
  115. * 3. Issue a UI_BEGIN_FF_ERASE ioctl, giving it the
  116. * uinput_ff_erase struct. It will be filled in with the
  117. * effect ID passed to erase_effect().
  118. * 4. Perform the effect erasure, and place a return code back
  119. * into the uinput_ff_erase struct.
  120. * 5. Issue a UI_END_FF_ERASE ioctl, also giving it the
  121. * uinput_ff_erase_effect struct. This will complete execution
  122. * of our erase_effect() handler.
  123. */
  124. /*
  125. * This is the new event type, used only by uinput.
  126. * 'code' is UI_FF_UPLOAD or UI_FF_ERASE, and 'value'
  127. * is the unique request ID. This number was picked
  128. * arbitrarily, above EV_MAX (since the input system
  129. * never sees it) but in the range of a 16-bit int.
  130. */
  131. #define EV_UINPUT 0x0101
  132. #define UI_FF_UPLOAD 1
  133. #define UI_FF_ERASE 2
  134. #define UINPUT_MAX_NAME_SIZE 80
  135. struct uinput_user_dev {
  136. char name[UINPUT_MAX_NAME_SIZE];
  137. struct input_id id;
  138. __u32 ff_effects_max;
  139. __s32 absmax[ABS_CNT];
  140. __s32 absmin[ABS_CNT];
  141. __s32 absfuzz[ABS_CNT];
  142. __s32 absflat[ABS_CNT];
  143. };
  144. #endif /* __UINPUT_H_ */