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 40 struct uinput_ff_upload { 41 int request_id; 42 int retval; 43 struct ff_effect effect; 44 struct ff_effect old; 45 }; 46 47 struct uinput_ff_erase { 48 int request_id; 49 int retval; 50 int effect_id; 51 }; 52 53 /* ioctl */ 54 #define UINPUT_IOCTL_BASE 'U' 55 #define UI_DEV_CREATE _IO(UINPUT_IOCTL_BASE, 1) 56 #define UI_DEV_DESTROY _IO(UINPUT_IOCTL_BASE, 2) 57 58 #define UI_SET_EVBIT _IOW(UINPUT_IOCTL_BASE, 100, int) 59 #define UI_SET_KEYBIT _IOW(UINPUT_IOCTL_BASE, 101, int) 60 #define UI_SET_RELBIT _IOW(UINPUT_IOCTL_BASE, 102, int) 61 #define UI_SET_ABSBIT _IOW(UINPUT_IOCTL_BASE, 103, int) 62 #define UI_SET_MSCBIT _IOW(UINPUT_IOCTL_BASE, 104, int) 63 #define UI_SET_LEDBIT _IOW(UINPUT_IOCTL_BASE, 105, int) 64 #define UI_SET_SNDBIT _IOW(UINPUT_IOCTL_BASE, 106, int) 65 #define UI_SET_FFBIT _IOW(UINPUT_IOCTL_BASE, 107, int) 66 #define UI_SET_PHYS _IOW(UINPUT_IOCTL_BASE, 108, char*) 67 #define UI_SET_SWBIT _IOW(UINPUT_IOCTL_BASE, 109, int) 68 69 #define UI_BEGIN_FF_UPLOAD _IOWR(UINPUT_IOCTL_BASE, 200, struct uinput_ff_upload) 70 #define UI_END_FF_UPLOAD _IOW(UINPUT_IOCTL_BASE, 201, struct uinput_ff_upload) 71 #define UI_BEGIN_FF_ERASE _IOWR(UINPUT_IOCTL_BASE, 202, struct uinput_ff_erase) 72 #define UI_END_FF_ERASE _IOW(UINPUT_IOCTL_BASE, 203, struct uinput_ff_erase) 73 74 /* 75 * To write a force-feedback-capable driver, the upload_effect 76 * and erase_effect callbacks in input_dev must be implemented. 77 * The uinput driver will generate a fake input event when one of 78 * these callbacks are invoked. The userspace code then uses 79 * ioctls to retrieve additional parameters and send the return code. 80 * The callback blocks until this return code is sent. 81 * 82 * The described callback mechanism is only used if ff_effects_max 83 * is set. 84 * 85 * To implement upload_effect(): 86 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_UPLOAD. 87 * A request ID will be given in 'value'. 88 * 2. Allocate a uinput_ff_upload struct, fill in request_id with 89 * the 'value' from the EV_UINPUT event. 90 * 3. Issue a UI_BEGIN_FF_UPLOAD ioctl, giving it the 91 * uinput_ff_upload struct. It will be filled in with the 92 * ff_effects passed to upload_effect(). 93 * 4. Perform the effect upload, and place a return code back into 94 the uinput_ff_upload struct. 95 * 5. Issue a UI_END_FF_UPLOAD ioctl, also giving it the 96 * uinput_ff_upload_effect struct. This will complete execution 97 * of our upload_effect() handler. 98 * 99 * To implement erase_effect(): 100 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_ERASE. 101 * A request ID will be given in 'value'. 102 * 2. Allocate a uinput_ff_erase struct, fill in request_id with 103 * the 'value' from the EV_UINPUT event. 104 * 3. Issue a UI_BEGIN_FF_ERASE ioctl, giving it the 105 * uinput_ff_erase struct. It will be filled in with the 106 * effect ID passed to erase_effect(). 107 * 4. Perform the effect erasure, and place a return code back 108 * into the uinput_ff_erase struct. 109 * 5. Issue a UI_END_FF_ERASE ioctl, also giving it the 110 * uinput_ff_erase_effect struct. This will complete execution 111 * of our erase_effect() handler. 112 */ 113 114 /* 115 * This is the new event type, used only by uinput. 116 * 'code' is UI_FF_UPLOAD or UI_FF_ERASE, and 'value' 117 * is the unique request ID. This number was picked 118 * arbitrarily, above EV_MAX (since the input system 119 * never sees it) but in the range of a 16-bit int. 120 */ 121 #define EV_UINPUT 0x0101 122 #define UI_FF_UPLOAD 1 123 #define UI_FF_ERASE 2 124 125 #define UINPUT_MAX_NAME_SIZE 80 126 struct uinput_user_dev { 127 char name[UINPUT_MAX_NAME_SIZE]; 128 struct input_id id; 129 int ff_effects_max; 130 int absmax[ABS_MAX + 1]; 131 int absmin[ABS_MAX + 1]; 132 int absfuzz[ABS_MAX + 1]; 133 int absflat[ABS_MAX + 1]; 134 }; 135 #endif /* __UINPUT_H_ */ 136 137