audit: reverse arguments to audit_inode_child
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / uinput.h
CommitLineData
1da177e4
LT
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>
221979aa 23 *
1da177e4 24 * Changes/Revisions:
ff462551
AH
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
1da177e4
LT
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 */
ff462551 34
c5b3533a 35#include <linux/types.h>
a830df36
MF
36#include <linux/input.h>
37
ff462551
AH
38#define UINPUT_VERSION 3
39
1da177e4 40#ifdef __KERNEL__
1da177e4
LT
41#define UINPUT_NAME "uinput"
42#define UINPUT_BUFFER_SIZE 16
43#define UINPUT_NUM_REQUESTS 16
44
29506415 45enum uinput_state { UIST_NEW_DEVICE, UIST_SETUP_COMPLETE, UIST_CREATED };
1da177e4
LT
46
47struct uinput_request {
c5b3533a
DT
48 unsigned int id;
49 unsigned int code; /* UI_FF_UPLOAD, UI_FF_ERASE */
1da177e4
LT
50
51 int retval;
0048e603 52 struct completion done;
1da177e4
LT
53
54 union {
c5b3533a 55 unsigned int effect_id;
ff462551
AH
56 struct {
57 struct ff_effect *effect;
58 struct ff_effect *old;
59 } upload;
1da177e4
LT
60 } u;
61};
62
63struct uinput_device {
64 struct input_dev *dev;
221979aa 65 struct mutex mutex;
29506415 66 enum uinput_state state;
1da177e4 67 wait_queue_head_t waitq;
29506415
DT
68 unsigned char ready;
69 unsigned char head;
70 unsigned char tail;
1da177e4 71 struct input_event buff[UINPUT_BUFFER_SIZE];
05be8b81 72 unsigned int ff_effects_max;
1da177e4
LT
73
74 struct uinput_request *requests[UINPUT_NUM_REQUESTS];
75 wait_queue_head_t requests_waitq;
0048e603 76 spinlock_t requests_lock;
1da177e4
LT
77};
78#endif /* __KERNEL__ */
79
80struct uinput_ff_upload {
c5b3533a
DT
81 __u32 request_id;
82 __s32 retval;
1da177e4 83 struct ff_effect effect;
ff462551 84 struct ff_effect old;
1da177e4
LT
85};
86
87struct uinput_ff_erase {
c5b3533a
DT
88 __u32 request_id;
89 __s32 retval;
90 __u32 effect_id;
1da177e4
LT
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*)
59c7c037 107#define UI_SET_SWBIT _IOW(UINPUT_IOCTL_BASE, 109, int)
85b77200 108#define UI_SET_PROPBIT _IOW(UINPUT_IOCTL_BASE, 110, int)
1da177e4
LT
109
110#define UI_BEGIN_FF_UPLOAD _IOWR(UINPUT_IOCTL_BASE, 200, struct uinput_ff_upload)
111#define UI_END_FF_UPLOAD _IOW(UINPUT_IOCTL_BASE, 201, struct uinput_ff_upload)
112#define UI_BEGIN_FF_ERASE _IOWR(UINPUT_IOCTL_BASE, 202, struct uinput_ff_erase)
113#define UI_END_FF_ERASE _IOW(UINPUT_IOCTL_BASE, 203, struct uinput_ff_erase)
114
ff462551
AH
115/*
116 * To write a force-feedback-capable driver, the upload_effect
1da177e4
LT
117 * and erase_effect callbacks in input_dev must be implemented.
118 * The uinput driver will generate a fake input event when one of
119 * these callbacks are invoked. The userspace code then uses
120 * ioctls to retrieve additional parameters and send the return code.
121 * The callback blocks until this return code is sent.
122 *
ff462551
AH
123 * The described callback mechanism is only used if ff_effects_max
124 * is set.
1da177e4
LT
125 *
126 * To implement upload_effect():
ff462551 127 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_UPLOAD.
1da177e4
LT
128 * A request ID will be given in 'value'.
129 * 2. Allocate a uinput_ff_upload struct, fill in request_id with
130 * the 'value' from the EV_UINPUT event.
131 * 3. Issue a UI_BEGIN_FF_UPLOAD ioctl, giving it the
132 * uinput_ff_upload struct. It will be filled in with the
ff462551
AH
133 * ff_effects passed to upload_effect().
134 * 4. Perform the effect upload, and place a return code back into
135 the uinput_ff_upload struct.
1da177e4
LT
136 * 5. Issue a UI_END_FF_UPLOAD ioctl, also giving it the
137 * uinput_ff_upload_effect struct. This will complete execution
138 * of our upload_effect() handler.
139 *
140 * To implement erase_effect():
ff462551 141 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_ERASE.
1da177e4
LT
142 * A request ID will be given in 'value'.
143 * 2. Allocate a uinput_ff_erase struct, fill in request_id with
144 * the 'value' from the EV_UINPUT event.
145 * 3. Issue a UI_BEGIN_FF_ERASE ioctl, giving it the
146 * uinput_ff_erase struct. It will be filled in with the
147 * effect ID passed to erase_effect().
148 * 4. Perform the effect erasure, and place a return code back
149 * into the uinput_ff_erase struct.
1da177e4
LT
150 * 5. Issue a UI_END_FF_ERASE ioctl, also giving it the
151 * uinput_ff_erase_effect struct. This will complete execution
152 * of our erase_effect() handler.
153 */
154
ff462551
AH
155/*
156 * This is the new event type, used only by uinput.
1da177e4
LT
157 * 'code' is UI_FF_UPLOAD or UI_FF_ERASE, and 'value'
158 * is the unique request ID. This number was picked
159 * arbitrarily, above EV_MAX (since the input system
160 * never sees it) but in the range of a 16-bit int.
161 */
162#define EV_UINPUT 0x0101
163#define UI_FF_UPLOAD 1
164#define UI_FF_ERASE 2
165
1da177e4
LT
166#define UINPUT_MAX_NAME_SIZE 80
167struct uinput_user_dev {
168 char name[UINPUT_MAX_NAME_SIZE];
169 struct input_id id;
c5b3533a
DT
170 __u32 ff_effects_max;
171 __s32 absmax[ABS_CNT];
172 __s32 absmin[ABS_CNT];
173 __s32 absfuzz[ABS_CNT];
174 __s32 absflat[ABS_CNT];
1da177e4
LT
175};
176#endif /* __UINPUT_H_ */
177