blob: 2aa2881b0df98a6faaee25917da8b9d499c533c7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Dmitry Torokhov221979a2006-02-19 00:22:36 -050023 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * Changes/Revisions:
Anssi Hannulaff462552006-07-19 01:41:09 -040025 * 0.3 24/05/2006 (Anssi Hannula <anssi.hannulagmail.com>)
26 * - update ff support for the changes in kernel interface
27 * - add UINPUT_VERSION
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * 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 */
Anssi Hannulaff462552006-07-19 01:41:09 -040034
Mike Frysingera830df32007-05-03 00:55:34 -040035#include <linux/input.h>
36
Anssi Hannulaff462552006-07-19 01:41:09 -040037#define UINPUT_VERSION 3
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#define UINPUT_NAME "uinput"
41#define UINPUT_BUFFER_SIZE 16
42#define UINPUT_NUM_REQUESTS 16
43
Dmitry Torokhov29506412005-11-20 00:51:22 -050044enum uinput_state { UIST_NEW_DEVICE, UIST_SETUP_COMPLETE, UIST_CREATED };
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46struct uinput_request {
47 int id;
48 int code; /* UI_FF_UPLOAD, UI_FF_ERASE */
49
50 int retval;
Dmitry Torokhov0048e602005-06-30 00:48:14 -050051 struct completion done;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53 union {
54 int effect_id;
Anssi Hannulaff462552006-07-19 01:41:09 -040055 struct {
56 struct ff_effect *effect;
57 struct ff_effect *old;
58 } upload;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 } u;
60};
61
62struct uinput_device {
63 struct input_dev *dev;
Dmitry Torokhov221979a2006-02-19 00:22:36 -050064 struct mutex mutex;
Dmitry Torokhov29506412005-11-20 00:51:22 -050065 enum uinput_state state;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 wait_queue_head_t waitq;
Dmitry Torokhov29506412005-11-20 00:51:22 -050067 unsigned char ready;
68 unsigned char head;
69 unsigned char tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 struct input_event buff[UINPUT_BUFFER_SIZE];
Dan Carpenter05be8b82011-10-12 21:05:53 -070071 unsigned int ff_effects_max;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73 struct uinput_request *requests[UINPUT_NUM_REQUESTS];
74 wait_queue_head_t requests_waitq;
Dmitry Torokhov0048e602005-06-30 00:48:14 -050075 spinlock_t requests_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076};
77#endif /* __KERNEL__ */
78
79struct uinput_ff_upload {
80 int request_id;
81 int retval;
82 struct ff_effect effect;
Anssi Hannulaff462552006-07-19 01:41:09 -040083 struct ff_effect old;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084};
85
86struct uinput_ff_erase {
87 int request_id;
88 int retval;
89 int effect_id;
90};
91
92/* ioctl */
93#define UINPUT_IOCTL_BASE 'U'
94#define UI_DEV_CREATE _IO(UINPUT_IOCTL_BASE, 1)
95#define UI_DEV_DESTROY _IO(UINPUT_IOCTL_BASE, 2)
96
97#define UI_SET_EVBIT _IOW(UINPUT_IOCTL_BASE, 100, int)
98#define UI_SET_KEYBIT _IOW(UINPUT_IOCTL_BASE, 101, int)
99#define UI_SET_RELBIT _IOW(UINPUT_IOCTL_BASE, 102, int)
100#define UI_SET_ABSBIT _IOW(UINPUT_IOCTL_BASE, 103, int)
101#define UI_SET_MSCBIT _IOW(UINPUT_IOCTL_BASE, 104, int)
102#define UI_SET_LEDBIT _IOW(UINPUT_IOCTL_BASE, 105, int)
103#define UI_SET_SNDBIT _IOW(UINPUT_IOCTL_BASE, 106, int)
104#define UI_SET_FFBIT _IOW(UINPUT_IOCTL_BASE, 107, int)
105#define UI_SET_PHYS _IOW(UINPUT_IOCTL_BASE, 108, char*)
Dmitry Torokhov59c7c032005-11-20 00:51:33 -0500106#define UI_SET_SWBIT _IOW(UINPUT_IOCTL_BASE, 109, int)
Henrik Rydberg85b77202010-12-18 20:51:13 +0100107#define UI_SET_PROPBIT _IOW(UINPUT_IOCTL_BASE, 110, int)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
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
Anssi Hannulaff462552006-07-19 01:41:09 -0400114/*
115 * To write a force-feedback-capable driver, the upload_effect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 * 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 *
Anssi Hannulaff462552006-07-19 01:41:09 -0400122 * The described callback mechanism is only used if ff_effects_max
123 * is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 *
125 * To implement upload_effect():
Anssi Hannulaff462552006-07-19 01:41:09 -0400126 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_UPLOAD.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 * 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
Anssi Hannulaff462552006-07-19 01:41:09 -0400132 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 * 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():
Anssi Hannulaff462552006-07-19 01:41:09 -0400140 * 1. Wait for an event with type == EV_UINPUT and code == UI_FF_ERASE.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * 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
Anssi Hannulaff462552006-07-19 01:41:09 -0400154/*
155 * This is the new event type, used only by uinput.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 * '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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165#define UINPUT_MAX_NAME_SIZE 80
166struct uinput_user_dev {
167 char name[UINPUT_MAX_NAME_SIZE];
168 struct input_id id;
Daniel Mack81c2a3b2010-05-20 22:52:58 -0700169 int ff_effects_max;
170 int absmax[ABS_CNT];
171 int absmin[ABS_CNT];
172 int absfuzz[ABS_CNT];
173 int absflat[ABS_CNT];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174};
175#endif /* __UINPUT_H_ */
176