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