blob: 772835938a526ed2575f6bc187619fe962ac0e6c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * User level driver support for input subsystem
3 *
4 * Heavily based on evdev.c by Vojtech Pavlik
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * Author: Aristeu Sergio Rozanski Filho <aris@cathedrallabs.org>
21 *
22 * Changes/Revisions:
Anssi Hannulaff462552006-07-19 01:41:09 -040023 * 0.3 09/04/2006 (Anssi Hannula <anssi.hannula@gmail.com>)
24 * - updated ff support for the changes in kernel interface
25 * - added MODULE_VERSION
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 * 0.2 16/10/2004 (Micah Dowty <micah@navi.cx>)
27 * - added force feedback support
28 * - added UI_SET_PHYS
29 * 0.1 20/06/2002
30 * - first public version
31 */
32#include <linux/poll.h>
Alexey Dobriyana99bbaf2009-10-04 16:11:37 +040033#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/slab.h>
35#include <linux/module.h>
36#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/fs.h>
38#include <linux/miscdevice.h>
39#include <linux/uinput.h>
Henrik Rydberg47c78e82010-11-27 09:16:48 +010040#include <linux/input/mt.h>
Philip Langdale2d56f3a2008-10-16 22:31:42 -040041#include "../input-compat.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Dmitry Torokhov54ce1652012-07-29 22:48:32 -070043static int uinput_dev_event(struct input_dev *dev,
44 unsigned int type, unsigned int code, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045{
Dmitry Torokhov373f9712007-04-12 01:34:33 -040046 struct uinput_device *udev = input_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48 udev->buff[udev->head].type = type;
49 udev->buff[udev->head].code = code;
50 udev->buff[udev->head].value = value;
51 do_gettimeofday(&udev->buff[udev->head].time);
52 udev->head = (udev->head + 1) % UINPUT_BUFFER_SIZE;
53
54 wake_up_interruptible(&udev->waitq);
55
56 return 0;
57}
58
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -070059/* Atomically allocate an ID for the given request. Returns 0 on success. */
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070060static bool uinput_request_alloc_id(struct uinput_device *udev,
61 struct uinput_request *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062{
Dmitry Torokhovc5b35332012-07-29 22:48:32 -070063 unsigned int id;
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070064 bool reserved = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Dmitry Torokhov0048e602005-06-30 00:48:14 -050066 spin_lock(&udev->requests_lock);
Dmitry Torokhov152c12f2005-06-30 00:47:50 -050067
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -070068 for (id = 0; id < UINPUT_NUM_REQUESTS; id++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 if (!udev->requests[id]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 request->id = id;
Dmitry Torokhov0048e602005-06-30 00:48:14 -050071 udev->requests[id] = request;
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070072 reserved = true;
Dmitry Torokhov152c12f2005-06-30 00:47:50 -050073 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 }
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -070075 }
Dmitry Torokhov152c12f2005-06-30 00:47:50 -050076
Dmitry Torokhov0048e602005-06-30 00:48:14 -050077 spin_unlock(&udev->requests_lock);
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070078 return reserved;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079}
80
Dmitry Torokhovc5b35332012-07-29 22:48:32 -070081static struct uinput_request *uinput_request_find(struct uinput_device *udev,
82 unsigned int id)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{
84 /* Find an input request, by ID. Returns NULL if the ID isn't valid. */
Dmitry Torokhovc5b35332012-07-29 22:48:32 -070085 if (id >= UINPUT_NUM_REQUESTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 return NULL;
Philip Langdale2d56f3a2008-10-16 22:31:42 -040087
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 return udev->requests[id];
89}
90
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070091static int uinput_request_reserve_slot(struct uinput_device *udev,
92 struct uinput_request *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
Dmitry Torokhov0048e602005-06-30 00:48:14 -050094 /* Allocate slot. If none are available right away, wait. */
95 return wait_event_interruptible(udev->requests_waitq,
Dmitry Torokhov00ce7562012-07-29 22:48:32 -070096 uinput_request_alloc_id(udev, request));
Linus Torvalds1da177e2005-04-16 15:20:36 -070097}
98
Dmitry Torokhov54ce1652012-07-29 22:48:32 -070099static void uinput_request_done(struct uinput_device *udev,
100 struct uinput_request *request)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500102 /* Mark slot as available */
103 udev->requests[request->id] = NULL;
Dmitry Torokhove597f0c82005-11-20 00:51:43 -0500104 wake_up(&udev->requests_waitq);
Dmitry Torokhove7507ed2005-10-17 16:43:32 -0700105
106 complete(&request->done);
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500107}
108
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700109static int uinput_request_send(struct uinput_device *udev,
110 struct uinput_request *request)
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500111{
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700112 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700114 retval = mutex_lock_interruptible(&udev->mutex);
115 if (retval)
116 return retval;
117
118 if (udev->state != UIST_CREATED) {
119 retval = -ENODEV;
120 goto out;
121 }
122
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700123 init_completion(&request->done);
124
125 /*
126 * Tell our userspace application about this new request
127 * by queueing an input event.
128 */
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700129 uinput_dev_event(udev->dev, EV_UINPUT, request->code, request->id);
130
131 out:
132 mutex_unlock(&udev->mutex);
133 return retval;
134}
135
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700136static int uinput_request_submit(struct uinput_device *udev,
137 struct uinput_request *request)
138{
139 int error;
140
141 error = uinput_request_reserve_slot(udev, request);
142 if (error)
143 return error;
144
145 error = uinput_request_send(udev, request);
146 if (error) {
147 uinput_request_done(udev, request);
148 return error;
149 }
150
151 wait_for_completion(&request->done);
152 return request->retval;
153}
154
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700155/*
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700156 * Fail all outstanding requests so handlers don't wait for the userspace
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700157 * to finish processing them.
158 */
159static void uinput_flush_requests(struct uinput_device *udev)
160{
161 struct uinput_request *request;
162 int i;
163
164 spin_lock(&udev->requests_lock);
165
166 for (i = 0; i < UINPUT_NUM_REQUESTS; i++) {
167 request = udev->requests[i];
168 if (request) {
169 request->retval = -ENODEV;
170 uinput_request_done(udev, request);
171 }
172 }
173
174 spin_unlock(&udev->requests_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175}
176
Anssi Hannulaff462552006-07-19 01:41:09 -0400177static void uinput_dev_set_gain(struct input_dev *dev, u16 gain)
178{
179 uinput_dev_event(dev, EV_FF, FF_GAIN, gain);
180}
181
182static void uinput_dev_set_autocenter(struct input_dev *dev, u16 magnitude)
183{
184 uinput_dev_event(dev, EV_FF, FF_AUTOCENTER, magnitude);
185}
186
187static int uinput_dev_playback(struct input_dev *dev, int effect_id, int value)
188{
189 return uinput_dev_event(dev, EV_FF, effect_id, value);
190}
191
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700192static int uinput_dev_upload_effect(struct input_dev *dev,
193 struct ff_effect *effect,
194 struct ff_effect *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195{
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700196 struct uinput_device *udev = input_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct uinput_request request;
198
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400199 /*
200 * uinput driver does not currently support periodic effects with
201 * custom waveform since it does not have a way to pass buffer of
202 * samples (custom_data) to userspace. If ever there is a device
203 * supporting custom waveforms we would need to define an additional
204 * ioctl (UI_UPLOAD_SAMPLES) but for now we just bail out.
205 */
206 if (effect->type == FF_PERIODIC &&
207 effect->u.periodic.waveform == FF_CUSTOM)
208 return -EINVAL;
209
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500210 request.code = UI_FF_UPLOAD;
Anssi Hannulaff462552006-07-19 01:41:09 -0400211 request.u.upload.effect = effect;
212 request.u.upload.old = old;
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500213
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700214 return uinput_request_submit(udev, &request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215}
216
217static int uinput_dev_erase_effect(struct input_dev *dev, int effect_id)
218{
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700219 struct uinput_device *udev = input_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 struct uinput_request request;
221
222 if (!test_bit(EV_FF, dev->evbit))
223 return -ENOSYS;
224
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500225 request.code = UI_FF_ERASE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 request.u.effect_id = effect_id;
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500227
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700228 return uinput_request_submit(udev, &request);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229}
230
Dmitry Torokhov29506412005-11-20 00:51:22 -0500231static void uinput_destroy_device(struct uinput_device *udev)
232{
233 const char *name, *phys;
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700234 struct input_dev *dev = udev->dev;
235 enum uinput_state old_state = udev->state;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500236
Aristeu Sergio Rozanski Filho05cebd32009-05-14 22:01:57 -0700237 udev->state = UIST_NEW_DEVICE;
238
239 if (dev) {
240 name = dev->name;
241 phys = dev->phys;
242 if (old_state == UIST_CREATED) {
243 uinput_flush_requests(udev);
244 input_unregister_device(dev);
245 } else {
246 input_free_device(dev);
247 }
Dmitry Torokhov29506412005-11-20 00:51:22 -0500248 kfree(name);
249 kfree(phys);
250 udev->dev = NULL;
251 }
Dmitry Torokhov29506412005-11-20 00:51:22 -0500252}
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254static int uinput_create_device(struct uinput_device *udev)
255{
Anssi Hannulaff462552006-07-19 01:41:09 -0400256 struct input_dev *dev = udev->dev;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500257 int error;
258
259 if (udev->state != UIST_SETUP_COMPLETE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 printk(KERN_DEBUG "%s: write device info first\n", UINPUT_NAME);
261 return -EINVAL;
262 }
263
Anssi Hannulaff462552006-07-19 01:41:09 -0400264 if (udev->ff_effects_max) {
265 error = input_ff_create(dev, udev->ff_effects_max);
266 if (error)
267 goto fail1;
268
269 dev->ff->upload = uinput_dev_upload_effect;
270 dev->ff->erase = uinput_dev_erase_effect;
271 dev->ff->playback = uinput_dev_playback;
272 dev->ff->set_gain = uinput_dev_set_gain;
273 dev->ff->set_autocenter = uinput_dev_set_autocenter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 }
275
Anssi Hannulaff462552006-07-19 01:41:09 -0400276 error = input_register_device(udev->dev);
277 if (error)
278 goto fail2;
279
Dmitry Torokhov29506412005-11-20 00:51:22 -0500280 udev->state = UIST_CREATED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282 return 0;
Anssi Hannulaff462552006-07-19 01:41:09 -0400283
284 fail2: input_ff_destroy(dev);
285 fail1: uinput_destroy_device(udev);
286 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287}
288
289static int uinput_open(struct inode *inode, struct file *file)
290{
Dmitry Torokhov29506412005-11-20 00:51:22 -0500291 struct uinput_device *newdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Dmitry Torokhov29506412005-11-20 00:51:22 -0500293 newdev = kzalloc(sizeof(struct uinput_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 if (!newdev)
Dmitry Torokhov29506412005-11-20 00:51:22 -0500295 return -ENOMEM;
296
Dmitry Torokhov221979a2006-02-19 00:22:36 -0500297 mutex_init(&newdev->mutex);
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500298 spin_lock_init(&newdev->requests_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 init_waitqueue_head(&newdev->requests_waitq);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500300 init_waitqueue_head(&newdev->waitq);
301 newdev->state = UIST_NEW_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303 file->private_data = newdev;
Dmitry Torokhovdaf8a962010-02-04 00:30:39 -0800304 nonseekable_open(inode, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307}
308
309static int uinput_validate_absbits(struct input_dev *dev)
310{
311 unsigned int cnt;
312 int retval = 0;
313
Daniel Mack81c2a3b2010-05-20 22:52:58 -0700314 for (cnt = 0; cnt < ABS_CNT; cnt++) {
Peter Hutterera718d792011-03-30 22:25:34 -0700315 int min, max;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 if (!test_bit(cnt, dev->absbit))
317 continue;
318
Peter Hutterera718d792011-03-30 22:25:34 -0700319 min = input_abs_get_min(dev, cnt);
320 max = input_abs_get_max(dev, cnt);
321
322 if ((min != 0 || max != 0) && max <= min) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 printk(KERN_DEBUG
324 "%s: invalid abs[%02x] min:%d max:%d\n",
325 UINPUT_NAME, cnt,
Daniel Mack987a6c02010-08-02 20:15:17 -0700326 input_abs_get_min(dev, cnt),
327 input_abs_get_max(dev, cnt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 retval = -EINVAL;
329 break;
330 }
331
Daniel Mack987a6c02010-08-02 20:15:17 -0700332 if (input_abs_get_flat(dev, cnt) >
333 input_abs_get_max(dev, cnt) - input_abs_get_min(dev, cnt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 printk(KERN_DEBUG
Daniel Mack987a6c02010-08-02 20:15:17 -0700335 "%s: abs_flat #%02x out of range: %d "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 "(min:%d/max:%d)\n",
Daniel Mack987a6c02010-08-02 20:15:17 -0700337 UINPUT_NAME, cnt,
338 input_abs_get_flat(dev, cnt),
339 input_abs_get_min(dev, cnt),
340 input_abs_get_max(dev, cnt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 retval = -EINVAL;
342 break;
343 }
344 }
345 return retval;
346}
347
Dmitry Torokhov29506412005-11-20 00:51:22 -0500348static int uinput_allocate_device(struct uinput_device *udev)
349{
350 udev->dev = input_allocate_device();
351 if (!udev->dev)
352 return -ENOMEM;
353
354 udev->dev->event = uinput_dev_event;
Dmitry Torokhov373f9712007-04-12 01:34:33 -0400355 input_set_drvdata(udev->dev, udev);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500356
357 return 0;
358}
359
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700360static int uinput_setup_device(struct uinput_device *udev,
361 const char __user *buffer, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362{
363 struct uinput_user_dev *user_dev;
364 struct input_dev *dev;
David Herrmann5d9d6e92011-02-11 01:10:44 -0800365 int i;
Dmitry Torokhov152c12f2005-06-30 00:47:50 -0500366 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Dmitry Torokhov29506412005-11-20 00:51:22 -0500368 if (count != sizeof(struct uinput_user_dev))
369 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Dmitry Torokhov29506412005-11-20 00:51:22 -0500371 if (!udev->dev) {
372 retval = uinput_allocate_device(udev);
373 if (retval)
374 return retval;
375 }
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 dev = udev->dev;
378
Dmitry Torokhov4dfcc272011-02-11 01:10:45 -0800379 user_dev = memdup_user(buffer, sizeof(struct uinput_user_dev));
Dan Carpenter163d2772011-02-18 08:30:52 -0800380 if (IS_ERR(user_dev))
Dmitry Torokhov4dfcc272011-02-11 01:10:45 -0800381 return PTR_ERR(user_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Anssi Hannulaff462552006-07-19 01:41:09 -0400383 udev->ff_effects_max = user_dev->ff_effects_max;
384
David Herrmann5d9d6e92011-02-11 01:10:44 -0800385 /* Ensure name is filled in */
386 if (!user_dev->name[0]) {
Dmitry Torokhov29506412005-11-20 00:51:22 -0500387 retval = -EINVAL;
388 goto exit;
389 }
390
391 kfree(dev->name);
David Herrmann5d9d6e92011-02-11 01:10:44 -0800392 dev->name = kstrndup(user_dev->name, UINPUT_MAX_NAME_SIZE,
393 GFP_KERNEL);
394 if (!dev->name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 retval = -ENOMEM;
396 goto exit;
397 }
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 dev->id.bustype = user_dev->id.bustype;
400 dev->id.vendor = user_dev->id.vendor;
401 dev->id.product = user_dev->id.product;
402 dev->id.version = user_dev->id.version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Daniel Mack987a6c02010-08-02 20:15:17 -0700404 for (i = 0; i < ABS_CNT; i++) {
405 input_abs_set_max(dev, i, user_dev->absmax[i]);
406 input_abs_set_min(dev, i, user_dev->absmin[i]);
407 input_abs_set_fuzz(dev, i, user_dev->absfuzz[i]);
408 input_abs_set_flat(dev, i, user_dev->absflat[i]);
409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411 /* check if absmin/absmax/absfuzz/absflat are filled as
412 * told in Documentation/input/input-programming.txt */
413 if (test_bit(EV_ABS, dev->evbit)) {
Dmitry Torokhov29506412005-11-20 00:51:22 -0500414 retval = uinput_validate_absbits(dev);
415 if (retval < 0)
416 goto exit;
Henrik Rydberg38e7afe2010-09-19 16:25:36 -0700417 if (test_bit(ABS_MT_SLOT, dev->absbit)) {
418 int nslot = input_abs_get_max(dev, ABS_MT_SLOT) + 1;
Henrik Rydbergb4adbbe2012-08-11 22:07:55 +0200419 input_mt_init_slots(dev, nslot, 0);
Henrik Rydberg38e7afe2010-09-19 16:25:36 -0700420 } else if (test_bit(ABS_MT_POSITION_X, dev->absbit)) {
421 input_set_events_per_packet(dev, 60);
422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 }
424
Dmitry Torokhov29506412005-11-20 00:51:22 -0500425 udev->state = UIST_SETUP_COMPLETE;
426 retval = count;
427
428 exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 kfree(user_dev);
430 return retval;
431}
432
Ryan Malloncbf05412013-09-18 12:40:47 -0700433static ssize_t uinput_inject_events(struct uinput_device *udev,
434 const char __user *buffer, size_t count)
Dmitry Torokhov29506412005-11-20 00:51:22 -0500435{
436 struct input_event ev;
Ryan Malloncbf05412013-09-18 12:40:47 -0700437 size_t bytes = 0;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500438
Ryan Malloncbf05412013-09-18 12:40:47 -0700439 if (count != 0 && count < input_event_size())
Dmitry Torokhov29506412005-11-20 00:51:22 -0500440 return -EINVAL;
441
Ryan Malloncbf05412013-09-18 12:40:47 -0700442 while (bytes + input_event_size() <= count) {
443 /*
444 * Note that even if some events were fetched successfully
445 * we are still going to return EFAULT instead of partial
446 * count to let userspace know that it got it's buffers
447 * all wrong.
448 */
449 if (input_event_from_user(buffer + bytes, &ev))
450 return -EFAULT;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500451
Ryan Malloncbf05412013-09-18 12:40:47 -0700452 input_event(udev->dev, ev.type, ev.code, ev.value);
453 bytes += input_event_size();
454 }
Dmitry Torokhov29506412005-11-20 00:51:22 -0500455
Ryan Malloncbf05412013-09-18 12:40:47 -0700456 return bytes;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500457}
458
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700459static ssize_t uinput_write(struct file *file, const char __user *buffer,
460 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
462 struct uinput_device *udev = file->private_data;
Dmitry Torokhov29506412005-11-20 00:51:22 -0500463 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700465 if (count == 0)
466 return 0;
467
Dmitry Torokhov221979a2006-02-19 00:22:36 -0500468 retval = mutex_lock_interruptible(&udev->mutex);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500469 if (retval)
470 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Dmitry Torokhov29506412005-11-20 00:51:22 -0500472 retval = udev->state == UIST_CREATED ?
Ryan Malloncbf05412013-09-18 12:40:47 -0700473 uinput_inject_events(udev, buffer, count) :
Dmitry Torokhov29506412005-11-20 00:51:22 -0500474 uinput_setup_device(udev, buffer, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Dmitry Torokhov221979a2006-02-19 00:22:36 -0500476 mutex_unlock(&udev->mutex);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500477
478 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479}
480
Dmitry Torokhov929d1af2012-07-29 22:48:31 -0700481static bool uinput_fetch_next_event(struct uinput_device *udev,
482 struct input_event *event)
483{
484 bool have_event;
485
486 spin_lock_irq(&udev->dev->event_lock);
487
488 have_event = udev->head != udev->tail;
489 if (have_event) {
490 *event = udev->buff[udev->tail];
491 udev->tail = (udev->tail + 1) % UINPUT_BUFFER_SIZE;
492 }
493
494 spin_unlock_irq(&udev->dev->event_lock);
495
496 return have_event;
497}
498
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700499static ssize_t uinput_events_to_user(struct uinput_device *udev,
500 char __user *buffer, size_t count)
501{
502 struct input_event event;
503 size_t read = 0;
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700504
505 while (read + input_event_size() <= count &&
506 uinput_fetch_next_event(udev, &event)) {
507
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700508 if (input_event_to_user(buffer + read, &event))
509 return -EFAULT;
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700510
511 read += input_event_size();
512 }
513
Dmitry Torokhov00ce7562012-07-29 22:48:32 -0700514 return read;
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700515}
516
517static ssize_t uinput_read(struct file *file, char __user *buffer,
518 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
520 struct uinput_device *udev = file->private_data;
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700521 ssize_t retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
David Herrmannf40033a2012-07-29 22:48:31 -0700523 if (count != 0 && count < input_event_size())
524 return -EINVAL;
525
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700526 do {
527 retval = mutex_lock_interruptible(&udev->mutex);
528 if (retval)
529 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700531 if (udev->state != UIST_CREATED)
532 retval = -ENODEV;
533 else if (udev->head == udev->tail &&
534 (file->f_flags & O_NONBLOCK))
535 retval = -EAGAIN;
536 else
537 retval = uinput_events_to_user(udev, buffer, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700539 mutex_unlock(&udev->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700541 if (retval || count == 0)
542 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Dmitry Torokhov22ae19c2012-07-29 22:48:31 -0700544 if (!(file->f_flags & O_NONBLOCK))
545 retval = wait_event_interruptible(udev->waitq,
546 udev->head != udev->tail ||
547 udev->state != UIST_CREATED);
548 } while (retval == 0);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return retval;
551}
552
553static unsigned int uinput_poll(struct file *file, poll_table *wait)
554{
555 struct uinput_device *udev = file->private_data;
556
557 poll_wait(file, &udev->waitq, wait);
558
559 if (udev->head != udev->tail)
560 return POLLIN | POLLRDNORM;
561
562 return 0;
563}
564
Dmitry Torokhov29506412005-11-20 00:51:22 -0500565static int uinput_release(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Dmitry Torokhov29506412005-11-20 00:51:22 -0500567 struct uinput_device *udev = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Dmitry Torokhov29506412005-11-20 00:51:22 -0500569 uinput_destroy_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 kfree(udev);
571
572 return 0;
573}
574
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400575#ifdef CONFIG_COMPAT
576struct uinput_ff_upload_compat {
Dmitry Torokhovc5b35332012-07-29 22:48:32 -0700577 __u32 request_id;
578 __s32 retval;
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400579 struct ff_effect_compat effect;
580 struct ff_effect_compat old;
581};
582
583static int uinput_ff_upload_to_user(char __user *buffer,
584 const struct uinput_ff_upload *ff_up)
585{
586 if (INPUT_COMPAT_TEST) {
587 struct uinput_ff_upload_compat ff_up_compat;
588
589 ff_up_compat.request_id = ff_up->request_id;
590 ff_up_compat.retval = ff_up->retval;
591 /*
592 * It so happens that the pointer that gives us the trouble
593 * is the last field in the structure. Since we don't support
594 * custom waveforms in uinput anyway we can just copy the whole
595 * thing (to the compat size) and ignore the pointer.
596 */
597 memcpy(&ff_up_compat.effect, &ff_up->effect,
598 sizeof(struct ff_effect_compat));
599 memcpy(&ff_up_compat.old, &ff_up->old,
600 sizeof(struct ff_effect_compat));
601
602 if (copy_to_user(buffer, &ff_up_compat,
603 sizeof(struct uinput_ff_upload_compat)))
604 return -EFAULT;
605 } else {
606 if (copy_to_user(buffer, ff_up,
607 sizeof(struct uinput_ff_upload)))
608 return -EFAULT;
609 }
610
611 return 0;
612}
613
614static int uinput_ff_upload_from_user(const char __user *buffer,
615 struct uinput_ff_upload *ff_up)
616{
617 if (INPUT_COMPAT_TEST) {
618 struct uinput_ff_upload_compat ff_up_compat;
619
620 if (copy_from_user(&ff_up_compat, buffer,
621 sizeof(struct uinput_ff_upload_compat)))
622 return -EFAULT;
623
624 ff_up->request_id = ff_up_compat.request_id;
625 ff_up->retval = ff_up_compat.retval;
626 memcpy(&ff_up->effect, &ff_up_compat.effect,
627 sizeof(struct ff_effect_compat));
628 memcpy(&ff_up->old, &ff_up_compat.old,
629 sizeof(struct ff_effect_compat));
630
631 } else {
632 if (copy_from_user(ff_up, buffer,
633 sizeof(struct uinput_ff_upload)))
634 return -EFAULT;
635 }
636
637 return 0;
638}
639
640#else
641
642static int uinput_ff_upload_to_user(char __user *buffer,
643 const struct uinput_ff_upload *ff_up)
644{
645 if (copy_to_user(buffer, ff_up, sizeof(struct uinput_ff_upload)))
646 return -EFAULT;
647
648 return 0;
649}
650
651static int uinput_ff_upload_from_user(const char __user *buffer,
652 struct uinput_ff_upload *ff_up)
653{
654 if (copy_from_user(ff_up, buffer, sizeof(struct uinput_ff_upload)))
655 return -EFAULT;
656
657 return 0;
658}
659
660#endif
661
Dmitry Torokhov29506412005-11-20 00:51:22 -0500662#define uinput_set_bit(_arg, _bit, _max) \
663({ \
664 int __ret = 0; \
665 if (udev->state == UIST_CREATED) \
666 __ret = -EINVAL; \
667 else if ((_arg) > (_max)) \
668 __ret = -EINVAL; \
669 else set_bit((_arg), udev->dev->_bit); \
670 __ret; \
671})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400673static long uinput_ioctl_handler(struct file *file, unsigned int cmd,
674 unsigned long arg, void __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
Dmitry Torokhov29506412005-11-20 00:51:22 -0500676 int retval;
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400677 struct uinput_device *udev = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 struct uinput_ff_upload ff_up;
679 struct uinput_ff_erase ff_erase;
680 struct uinput_request *req;
Dmitry Torokhov5b6271b2005-06-30 00:50:38 -0500681 char *phys;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Dmitry Torokhov221979a2006-02-19 00:22:36 -0500683 retval = mutex_lock_interruptible(&udev->mutex);
Dmitry Torokhov29506412005-11-20 00:51:22 -0500684 if (retval)
685 return retval;
686
687 if (!udev->dev) {
688 retval = uinput_allocate_device(udev);
689 if (retval)
690 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 }
692
693 switch (cmd) {
694 case UI_DEV_CREATE:
695 retval = uinput_create_device(udev);
696 break;
697
698 case UI_DEV_DESTROY:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500699 uinput_destroy_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 break;
701
702 case UI_SET_EVBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500703 retval = uinput_set_bit(arg, evbit, EV_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 break;
705
706 case UI_SET_KEYBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500707 retval = uinput_set_bit(arg, keybit, KEY_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 break;
709
710 case UI_SET_RELBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500711 retval = uinput_set_bit(arg, relbit, REL_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 break;
713
714 case UI_SET_ABSBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500715 retval = uinput_set_bit(arg, absbit, ABS_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 break;
717
718 case UI_SET_MSCBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500719 retval = uinput_set_bit(arg, mscbit, MSC_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 break;
721
722 case UI_SET_LEDBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500723 retval = uinput_set_bit(arg, ledbit, LED_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 break;
725
726 case UI_SET_SNDBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500727 retval = uinput_set_bit(arg, sndbit, SND_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 break;
729
730 case UI_SET_FFBIT:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500731 retval = uinput_set_bit(arg, ffbit, FF_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 break;
733
Dmitry Torokhov59c7c032005-11-20 00:51:33 -0500734 case UI_SET_SWBIT:
735 retval = uinput_set_bit(arg, swbit, SW_MAX);
736 break;
737
Henrik Rydberg85b77202010-12-18 20:51:13 +0100738 case UI_SET_PROPBIT:
739 retval = uinput_set_bit(arg, propbit, INPUT_PROP_MAX);
740 break;
741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 case UI_SET_PHYS:
Dmitry Torokhov29506412005-11-20 00:51:22 -0500743 if (udev->state == UIST_CREATED) {
744 retval = -EINVAL;
745 goto out;
746 }
Dmitry Torokhov4dfcc272011-02-11 01:10:45 -0800747
748 phys = strndup_user(p, 1024);
749 if (IS_ERR(phys)) {
750 retval = PTR_ERR(phys);
751 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
Dmitry Torokhov4dfcc272011-02-11 01:10:45 -0800753
Dmitry Torokhov5b6271b2005-06-30 00:50:38 -0500754 kfree(udev->dev->phys);
Dmitry Torokhov4dfcc272011-02-11 01:10:45 -0800755 udev->dev->phys = phys;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 break;
757
758 case UI_BEGIN_FF_UPLOAD:
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400759 retval = uinput_ff_upload_from_user(p, &ff_up);
760 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 break;
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 req = uinput_request_find(udev, ff_up.request_id);
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700764 if (!req || req->code != UI_FF_UPLOAD ||
765 !req->u.upload.effect) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 retval = -EINVAL;
767 break;
768 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 ff_up.retval = 0;
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400771 ff_up.effect = *req->u.upload.effect;
Anssi Hannulaff462552006-07-19 01:41:09 -0400772 if (req->u.upload.old)
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400773 ff_up.old = *req->u.upload.old;
Anssi Hannulaff462552006-07-19 01:41:09 -0400774 else
775 memset(&ff_up.old, 0, sizeof(struct ff_effect));
776
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400777 retval = uinput_ff_upload_to_user(p, &ff_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 break;
779
780 case UI_BEGIN_FF_ERASE:
781 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
782 retval = -EFAULT;
783 break;
784 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 req = uinput_request_find(udev, ff_erase.request_id);
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400787 if (!req || req->code != UI_FF_ERASE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 retval = -EINVAL;
789 break;
790 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 ff_erase.retval = 0;
793 ff_erase.effect_id = req->u.effect_id;
794 if (copy_to_user(p, &ff_erase, sizeof(ff_erase))) {
795 retval = -EFAULT;
796 break;
797 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 break;
800
801 case UI_END_FF_UPLOAD:
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400802 retval = uinput_ff_upload_from_user(p, &ff_up);
803 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 break;
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 req = uinput_request_find(udev, ff_up.request_id);
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400807 if (!req || req->code != UI_FF_UPLOAD ||
808 !req->u.upload.effect) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 retval = -EINVAL;
810 break;
811 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 req->retval = ff_up.retval;
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500814 uinput_request_done(udev, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 break;
816
817 case UI_END_FF_ERASE:
818 if (copy_from_user(&ff_erase, p, sizeof(ff_erase))) {
819 retval = -EFAULT;
820 break;
821 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400822
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 req = uinput_request_find(udev, ff_erase.request_id);
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400824 if (!req || req->code != UI_FF_ERASE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 retval = -EINVAL;
826 break;
827 }
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 req->retval = ff_erase.retval;
Dmitry Torokhov0048e602005-06-30 00:48:14 -0500830 uinput_request_done(udev, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 break;
832
833 default:
834 retval = -EINVAL;
835 }
Dmitry Torokhov29506412005-11-20 00:51:22 -0500836
837 out:
Dmitry Torokhov221979a2006-02-19 00:22:36 -0500838 mutex_unlock(&udev->mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 return retval;
840}
841
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400842static long uinput_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
843{
844 return uinput_ioctl_handler(file, cmd, arg, (void __user *)arg);
845}
846
847#ifdef CONFIG_COMPAT
Dmitry Torokhov54ce1652012-07-29 22:48:32 -0700848static long uinput_compat_ioctl(struct file *file,
849 unsigned int cmd, unsigned long arg)
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400850{
851 return uinput_ioctl_handler(file, cmd, arg, compat_ptr(arg));
852}
853#endif
854
Arjan van de Ven2b8693c2007-02-12 00:55:32 -0800855static const struct file_operations uinput_fops = {
Dmitry Torokhov29506412005-11-20 00:51:22 -0500856 .owner = THIS_MODULE,
857 .open = uinput_open,
858 .release = uinput_release,
859 .read = uinput_read,
860 .write = uinput_write,
861 .poll = uinput_poll,
862 .unlocked_ioctl = uinput_ioctl,
Philip Langdale2d56f3a2008-10-16 22:31:42 -0400863#ifdef CONFIG_COMPAT
864 .compat_ioctl = uinput_compat_ioctl,
865#endif
Arnd Bergmann6038f372010-08-15 18:52:59 +0200866 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867};
868
869static struct miscdevice uinput_misc = {
Dmitry Torokhov29506412005-11-20 00:51:22 -0500870 .fops = &uinput_fops,
871 .minor = UINPUT_MINOR,
872 .name = UINPUT_NAME,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873};
Kay Sievers8905aaa2010-08-19 09:52:28 -0700874MODULE_ALIAS_MISCDEV(UINPUT_MINOR);
875MODULE_ALIAS("devname:" UINPUT_NAME);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
877static int __init uinput_init(void)
878{
879 return misc_register(&uinput_misc);
880}
881
882static void __exit uinput_exit(void)
883{
884 misc_deregister(&uinput_misc);
885}
886
887MODULE_AUTHOR("Aristeu Sergio Rozanski Filho");
888MODULE_DESCRIPTION("User level driver support for input subsystem");
889MODULE_LICENSE("GPL");
Anssi Hannulaff462552006-07-19 01:41:09 -0400890MODULE_VERSION("0.3");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892module_init(uinput_init);
893module_exit(uinput_exit);