home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / src / linux-headers-2.6.28-15 / include / linux / uinput.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-24  |  5.8 KB  |  177 lines

  1. #ifndef __UINPUT_H_
  2. #define __UINPUT_H_
  3. /*
  4.  *  User level driver support for input subsystem
  5.  *
  6.  * Heavily based on evdev.c by Vojtech Pavlik
  7.  *
  8.  * This program is free software; you can redistribute it and/or modify
  9.  * it under the terms of the GNU General Public License as published by
  10.  * the Free Software Foundation; either version 2 of the License, or
  11.  * (at your option) any later version.
  12.  *
  13.  * This program is distributed in the hope that it will be useful,
  14.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.  * GNU General Public License for more details.
  17.  *
  18.  * You should have received a copy of the GNU General Public License
  19.  * along with this program; if not, write to the Free Software
  20.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21.  *
  22.  * Author: Aristeu Sergio Rozanski Filho <aris@cathedrallabs.org>
  23.  *
  24.  * Changes/Revisions:
  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.  
  35. #include <linux/input.h>
  36.  
  37. #define UINPUT_VERSION        3
  38.  
  39. #ifdef __KERNEL__
  40. #define UINPUT_MINOR        223
  41. #define UINPUT_NAME        "uinput"
  42. #define UINPUT_BUFFER_SIZE    16
  43. #define UINPUT_NUM_REQUESTS    16
  44.  
  45. enum uinput_state { UIST_NEW_DEVICE, UIST_SETUP_COMPLETE, UIST_CREATED };
  46.  
  47. struct uinput_request {
  48.     int            id;
  49.     int            code;    /* UI_FF_UPLOAD, UI_FF_ERASE */
  50.  
  51.     int            retval;
  52.     struct completion    done;
  53.  
  54.     union {
  55.         int        effect_id;
  56.         struct {
  57.             struct ff_effect *effect;
  58.             struct ff_effect *old;
  59.         } upload;
  60.     } u;
  61. };
  62.  
  63. struct uinput_device {
  64.     struct input_dev    *dev;
  65.     struct mutex        mutex;
  66.     enum uinput_state    state;
  67.     wait_queue_head_t    waitq;
  68.     unsigned char        ready;
  69.     unsigned char        head;
  70.     unsigned char        tail;
  71.     struct input_event    buff[UINPUT_BUFFER_SIZE];
  72.     int            ff_effects_max;
  73.  
  74.     struct uinput_request    *requests[UINPUT_NUM_REQUESTS];
  75.     wait_queue_head_t    requests_waitq;
  76.     spinlock_t        requests_lock;
  77. };
  78. #endif    /* __KERNEL__ */
  79.  
  80. struct uinput_ff_upload {
  81.     int            request_id;
  82.     int            retval;
  83.     struct ff_effect    effect;
  84.     struct ff_effect    old;
  85. };
  86.  
  87. struct uinput_ff_erase {
  88.     int            request_id;
  89.     int            retval;
  90.     int            effect_id;
  91. };
  92.  
  93. /* ioctl */
  94. #define UINPUT_IOCTL_BASE    'U'
  95. #define UI_DEV_CREATE        _IO(UINPUT_IOCTL_BASE, 1)
  96. #define UI_DEV_DESTROY        _IO(UINPUT_IOCTL_BASE, 2)
  97.  
  98. #define UI_SET_EVBIT        _IOW(UINPUT_IOCTL_BASE, 100, int)
  99. #define UI_SET_KEYBIT        _IOW(UINPUT_IOCTL_BASE, 101, int)
  100. #define UI_SET_RELBIT        _IOW(UINPUT_IOCTL_BASE, 102, int)
  101. #define UI_SET_ABSBIT        _IOW(UINPUT_IOCTL_BASE, 103, int)
  102. #define UI_SET_MSCBIT        _IOW(UINPUT_IOCTL_BASE, 104, int)
  103. #define UI_SET_LEDBIT        _IOW(UINPUT_IOCTL_BASE, 105, int)
  104. #define UI_SET_SNDBIT        _IOW(UINPUT_IOCTL_BASE, 106, int)
  105. #define UI_SET_FFBIT        _IOW(UINPUT_IOCTL_BASE, 107, int)
  106. #define UI_SET_PHYS        _IOW(UINPUT_IOCTL_BASE, 108, char*)
  107. #define UI_SET_SWBIT        _IOW(UINPUT_IOCTL_BASE, 109, int)
  108.  
  109. #define UI_BEGIN_FF_UPLOAD    _IOWR(UINPUT_IOCTL_BASE, 200, struct uinput_ff_upload)
  110. #define UI_END_FF_UPLOAD    _IOW(UINPUT_IOCTL_BASE, 201, struct uinput_ff_upload)
  111. #define UI_BEGIN_FF_ERASE    _IOWR(UINPUT_IOCTL_BASE, 202, struct uinput_ff_erase)
  112. #define UI_END_FF_ERASE        _IOW(UINPUT_IOCTL_BASE, 203, struct uinput_ff_erase)
  113.  
  114. /*
  115.  * To write a force-feedback-capable driver, the upload_effect
  116.  * and erase_effect callbacks in input_dev must be implemented.
  117.  * The uinput driver will generate a fake input event when one of
  118.  * these callbacks are invoked. The userspace code then uses
  119.  * ioctls to retrieve additional parameters and send the return code.
  120.  * The callback blocks until this return code is sent.
  121.  *
  122.  * The described callback mechanism is only used if ff_effects_max
  123.  * is set.
  124.  *
  125.  * To implement upload_effect():
  126.  *   1. Wait for an event with type == EV_UINPUT and code == UI_FF_UPLOAD.
  127.  *      A request ID will be given in 'value'.
  128.  *   2. Allocate a uinput_ff_upload struct, fill in request_id with
  129.  *      the 'value' from the EV_UINPUT event.
  130.  *   3. Issue a UI_BEGIN_FF_UPLOAD ioctl, giving it the
  131.  *      uinput_ff_upload struct. It will be filled in with the
  132.  *      ff_effects passed to upload_effect().
  133.  *   4. Perform the effect upload, and place a return code back into
  134.         the uinput_ff_upload struct.
  135.  *   5. Issue a UI_END_FF_UPLOAD ioctl, also giving it the
  136.  *      uinput_ff_upload_effect struct. This will complete execution
  137.  *      of our upload_effect() handler.
  138.  *
  139.  * To implement erase_effect():
  140.  *   1. Wait for an event with type == EV_UINPUT and code == UI_FF_ERASE.
  141.  *      A request ID will be given in 'value'.
  142.  *   2. Allocate a uinput_ff_erase struct, fill in request_id with
  143.  *      the 'value' from the EV_UINPUT event.
  144.  *   3. Issue a UI_BEGIN_FF_ERASE ioctl, giving it the
  145.  *      uinput_ff_erase struct. It will be filled in with the
  146.  *      effect ID passed to erase_effect().
  147.  *   4. Perform the effect erasure, and place a return code back
  148.  *      into the uinput_ff_erase struct.
  149.  *   5. Issue a UI_END_FF_ERASE ioctl, also giving it the
  150.  *      uinput_ff_erase_effect struct. This will complete execution
  151.  *      of our erase_effect() handler.
  152.  */
  153.  
  154. /*
  155.  * This is the new event type, used only by uinput.
  156.  * 'code' is UI_FF_UPLOAD or UI_FF_ERASE, and 'value'
  157.  * is the unique request ID. This number was picked
  158.  * arbitrarily, above EV_MAX (since the input system
  159.  * never sees it) but in the range of a 16-bit int.
  160.  */
  161. #define EV_UINPUT        0x0101
  162. #define UI_FF_UPLOAD        1
  163. #define UI_FF_ERASE        2
  164.  
  165. #define UINPUT_MAX_NAME_SIZE    80
  166. struct uinput_user_dev {
  167.     char name[UINPUT_MAX_NAME_SIZE];
  168.     struct input_id id;
  169.         int ff_effects_max;
  170.         int absmax[ABS_MAX + 1];
  171.         int absmin[ABS_MAX + 1];
  172.         int absfuzz[ABS_MAX + 1];
  173.         int absflat[ABS_MAX + 1];
  174. };
  175. #endif    /* __UINPUT_H_ */
  176.  
  177.