xref: /linux-6.15/drivers/input/evdev.c (revision 81b4d1d2)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Event char devices, giving access to raw input device events.
4  *
5  * Copyright (c) 1999-2002 Vojtech Pavlik
6  */
7 
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 
10 #define EVDEV_MINOR_BASE	64
11 #define EVDEV_MINORS		32
12 #define EVDEV_MIN_BUFFER_SIZE	64U
13 #define EVDEV_BUF_PACKETS	8
14 
15 #include <linux/poll.h>
16 #include <linux/sched.h>
17 #include <linux/slab.h>
18 #include <linux/vmalloc.h>
19 #include <linux/mm.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/input/mt.h>
23 #include <linux/major.h>
24 #include <linux/device.h>
25 #include <linux/cdev.h>
26 #include "input-compat.h"
27 
28 struct evdev {
29 	int open;
30 	struct input_handle handle;
31 	wait_queue_head_t wait;
32 	struct evdev_client __rcu *grab;
33 	struct list_head client_list;
34 	spinlock_t client_lock; /* protects client_list */
35 	struct mutex mutex;
36 	struct device dev;
37 	struct cdev cdev;
38 	bool exist;
39 };
40 
41 struct evdev_client {
42 	unsigned int head;
43 	unsigned int tail;
44 	unsigned int packet_head; /* [future] position of the first element of next packet */
45 	spinlock_t buffer_lock; /* protects access to buffer, head and tail */
46 	struct fasync_struct *fasync;
47 	struct evdev *evdev;
48 	struct list_head node;
49 	enum input_clock_type clk_type;
50 	bool revoked;
51 	unsigned long *evmasks[EV_CNT];
52 	unsigned int bufsize;
53 	struct input_event buffer[];
54 };
55 
56 static size_t evdev_get_mask_cnt(unsigned int type)
57 {
58 	static const size_t counts[EV_CNT] = {
59 		/* EV_SYN==0 is EV_CNT, _not_ SYN_CNT, see EVIOCGBIT */
60 		[EV_SYN]	= EV_CNT,
61 		[EV_KEY]	= KEY_CNT,
62 		[EV_REL]	= REL_CNT,
63 		[EV_ABS]	= ABS_CNT,
64 		[EV_MSC]	= MSC_CNT,
65 		[EV_SW]		= SW_CNT,
66 		[EV_LED]	= LED_CNT,
67 		[EV_SND]	= SND_CNT,
68 		[EV_FF]		= FF_CNT,
69 	};
70 
71 	return (type < EV_CNT) ? counts[type] : 0;
72 }
73 
74 /* requires the buffer lock to be held */
75 static bool __evdev_is_filtered(struct evdev_client *client,
76 				unsigned int type,
77 				unsigned int code)
78 {
79 	unsigned long *mask;
80 	size_t cnt;
81 
82 	/* EV_SYN and unknown codes are never filtered */
83 	if (type == EV_SYN || type >= EV_CNT)
84 		return false;
85 
86 	/* first test whether the type is filtered */
87 	mask = client->evmasks[0];
88 	if (mask && !test_bit(type, mask))
89 		return true;
90 
91 	/* unknown values are never filtered */
92 	cnt = evdev_get_mask_cnt(type);
93 	if (!cnt || code >= cnt)
94 		return false;
95 
96 	mask = client->evmasks[type];
97 	return mask && !test_bit(code, mask);
98 }
99 
100 /* flush queued events of type @type, caller must hold client->buffer_lock */
101 static void __evdev_flush_queue(struct evdev_client *client, unsigned int type)
102 {
103 	unsigned int i, head, num;
104 	unsigned int mask = client->bufsize - 1;
105 	bool is_report;
106 	struct input_event *ev;
107 
108 	BUG_ON(type == EV_SYN);
109 
110 	head = client->tail;
111 	client->packet_head = client->tail;
112 
113 	/* init to 1 so a leading SYN_REPORT will not be dropped */
114 	num = 1;
115 
116 	for (i = client->tail; i != client->head; i = (i + 1) & mask) {
117 		ev = &client->buffer[i];
118 		is_report = ev->type == EV_SYN && ev->code == SYN_REPORT;
119 
120 		if (ev->type == type) {
121 			/* drop matched entry */
122 			continue;
123 		} else if (is_report && !num) {
124 			/* drop empty SYN_REPORT groups */
125 			continue;
126 		} else if (head != i) {
127 			/* move entry to fill the gap */
128 			client->buffer[head] = *ev;
129 		}
130 
131 		num++;
132 		head = (head + 1) & mask;
133 
134 		if (is_report) {
135 			num = 0;
136 			client->packet_head = head;
137 		}
138 	}
139 
140 	client->head = head;
141 }
142 
143 static void __evdev_queue_syn_dropped(struct evdev_client *client)
144 {
145 	ktime_t *ev_time = input_get_timestamp(client->evdev->handle.dev);
146 	struct timespec64 ts = ktime_to_timespec64(ev_time[client->clk_type]);
147 	struct input_event ev;
148 
149 	ev.input_event_sec = ts.tv_sec;
150 	ev.input_event_usec = ts.tv_nsec / NSEC_PER_USEC;
151 	ev.type = EV_SYN;
152 	ev.code = SYN_DROPPED;
153 	ev.value = 0;
154 
155 	client->buffer[client->head++] = ev;
156 	client->head &= client->bufsize - 1;
157 
158 	if (unlikely(client->head == client->tail)) {
159 		/* drop queue but keep our SYN_DROPPED event */
160 		client->tail = (client->head - 1) & (client->bufsize - 1);
161 		client->packet_head = client->tail;
162 	}
163 }
164 
165 static void evdev_queue_syn_dropped(struct evdev_client *client)
166 {
167 	unsigned long flags;
168 
169 	spin_lock_irqsave(&client->buffer_lock, flags);
170 	__evdev_queue_syn_dropped(client);
171 	spin_unlock_irqrestore(&client->buffer_lock, flags);
172 }
173 
174 static int evdev_set_clk_type(struct evdev_client *client, unsigned int clkid)
175 {
176 	unsigned long flags;
177 	enum input_clock_type clk_type;
178 
179 	switch (clkid) {
180 
181 	case CLOCK_REALTIME:
182 		clk_type = INPUT_CLK_REAL;
183 		break;
184 	case CLOCK_MONOTONIC:
185 		clk_type = INPUT_CLK_MONO;
186 		break;
187 	case CLOCK_BOOTTIME:
188 		clk_type = INPUT_CLK_BOOT;
189 		break;
190 	default:
191 		return -EINVAL;
192 	}
193 
194 	if (client->clk_type != clk_type) {
195 		client->clk_type = clk_type;
196 
197 		/*
198 		 * Flush pending events and queue SYN_DROPPED event,
199 		 * but only if the queue is not empty.
200 		 */
201 		spin_lock_irqsave(&client->buffer_lock, flags);
202 
203 		if (client->head != client->tail) {
204 			client->packet_head = client->head = client->tail;
205 			__evdev_queue_syn_dropped(client);
206 		}
207 
208 		spin_unlock_irqrestore(&client->buffer_lock, flags);
209 	}
210 
211 	return 0;
212 }
213 
214 static void __pass_event(struct evdev_client *client,
215 			 const struct input_event *event)
216 {
217 	client->buffer[client->head++] = *event;
218 	client->head &= client->bufsize - 1;
219 
220 	if (unlikely(client->head == client->tail)) {
221 		/*
222 		 * This effectively "drops" all unconsumed events, leaving
223 		 * EV_SYN/SYN_DROPPED plus the newest event in the queue.
224 		 */
225 		client->tail = (client->head - 2) & (client->bufsize - 1);
226 
227 		client->buffer[client->tail].input_event_sec =
228 						event->input_event_sec;
229 		client->buffer[client->tail].input_event_usec =
230 						event->input_event_usec;
231 		client->buffer[client->tail].type = EV_SYN;
232 		client->buffer[client->tail].code = SYN_DROPPED;
233 		client->buffer[client->tail].value = 0;
234 
235 		client->packet_head = client->tail;
236 	}
237 
238 	if (event->type == EV_SYN && event->code == SYN_REPORT) {
239 		client->packet_head = client->head;
240 		kill_fasync(&client->fasync, SIGIO, POLL_IN);
241 	}
242 }
243 
244 static void evdev_pass_values(struct evdev_client *client,
245 			const struct input_value *vals, unsigned int count,
246 			ktime_t *ev_time)
247 {
248 	struct evdev *evdev = client->evdev;
249 	const struct input_value *v;
250 	struct input_event event;
251 	struct timespec64 ts;
252 	bool wakeup = false;
253 
254 	if (client->revoked)
255 		return;
256 
257 	ts = ktime_to_timespec64(ev_time[client->clk_type]);
258 	event.input_event_sec = ts.tv_sec;
259 	event.input_event_usec = ts.tv_nsec / NSEC_PER_USEC;
260 
261 	/* Interrupts are disabled, just acquire the lock. */
262 	spin_lock(&client->buffer_lock);
263 
264 	for (v = vals; v != vals + count; v++) {
265 		if (__evdev_is_filtered(client, v->type, v->code))
266 			continue;
267 
268 		if (v->type == EV_SYN && v->code == SYN_REPORT) {
269 			/* drop empty SYN_REPORT */
270 			if (client->packet_head == client->head)
271 				continue;
272 
273 			wakeup = true;
274 		}
275 
276 		event.type = v->type;
277 		event.code = v->code;
278 		event.value = v->value;
279 		__pass_event(client, &event);
280 	}
281 
282 	spin_unlock(&client->buffer_lock);
283 
284 	if (wakeup)
285 		wake_up_interruptible_poll(&evdev->wait,
286 			EPOLLIN | EPOLLOUT | EPOLLRDNORM | EPOLLWRNORM);
287 }
288 
289 /*
290  * Pass incoming events to all connected clients.
291  */
292 static void evdev_events(struct input_handle *handle,
293 			 const struct input_value *vals, unsigned int count)
294 {
295 	struct evdev *evdev = handle->private;
296 	struct evdev_client *client;
297 	ktime_t *ev_time = input_get_timestamp(handle->dev);
298 
299 	rcu_read_lock();
300 
301 	client = rcu_dereference(evdev->grab);
302 
303 	if (client)
304 		evdev_pass_values(client, vals, count, ev_time);
305 	else
306 		list_for_each_entry_rcu(client, &evdev->client_list, node)
307 			evdev_pass_values(client, vals, count, ev_time);
308 
309 	rcu_read_unlock();
310 }
311 
312 /*
313  * Pass incoming event to all connected clients.
314  */
315 static void evdev_event(struct input_handle *handle,
316 			unsigned int type, unsigned int code, int value)
317 {
318 	struct input_value vals[] = { { type, code, value } };
319 
320 	evdev_events(handle, vals, 1);
321 }
322 
323 static int evdev_fasync(int fd, struct file *file, int on)
324 {
325 	struct evdev_client *client = file->private_data;
326 
327 	return fasync_helper(fd, file, on, &client->fasync);
328 }
329 
330 static int evdev_flush(struct file *file, fl_owner_t id)
331 {
332 	struct evdev_client *client = file->private_data;
333 	struct evdev *evdev = client->evdev;
334 
335 	mutex_lock(&evdev->mutex);
336 
337 	if (evdev->exist && !client->revoked)
338 		input_flush_device(&evdev->handle, file);
339 
340 	mutex_unlock(&evdev->mutex);
341 	return 0;
342 }
343 
344 static void evdev_free(struct device *dev)
345 {
346 	struct evdev *evdev = container_of(dev, struct evdev, dev);
347 
348 	input_put_device(evdev->handle.dev);
349 	kfree(evdev);
350 }
351 
352 /*
353  * Grabs an event device (along with underlying input device).
354  * This function is called with evdev->mutex taken.
355  */
356 static int evdev_grab(struct evdev *evdev, struct evdev_client *client)
357 {
358 	int error;
359 
360 	if (evdev->grab)
361 		return -EBUSY;
362 
363 	error = input_grab_device(&evdev->handle);
364 	if (error)
365 		return error;
366 
367 	rcu_assign_pointer(evdev->grab, client);
368 
369 	return 0;
370 }
371 
372 static int evdev_ungrab(struct evdev *evdev, struct evdev_client *client)
373 {
374 	struct evdev_client *grab = rcu_dereference_protected(evdev->grab,
375 					lockdep_is_held(&evdev->mutex));
376 
377 	if (grab != client)
378 		return  -EINVAL;
379 
380 	rcu_assign_pointer(evdev->grab, NULL);
381 	synchronize_rcu();
382 	input_release_device(&evdev->handle);
383 
384 	return 0;
385 }
386 
387 static void evdev_attach_client(struct evdev *evdev,
388 				struct evdev_client *client)
389 {
390 	spin_lock(&evdev->client_lock);
391 	list_add_tail_rcu(&client->node, &evdev->client_list);
392 	spin_unlock(&evdev->client_lock);
393 }
394 
395 static void evdev_detach_client(struct evdev *evdev,
396 				struct evdev_client *client)
397 {
398 	spin_lock(&evdev->client_lock);
399 	list_del_rcu(&client->node);
400 	spin_unlock(&evdev->client_lock);
401 	synchronize_rcu();
402 }
403 
404 static int evdev_open_device(struct evdev *evdev)
405 {
406 	int retval;
407 
408 	retval = mutex_lock_interruptible(&evdev->mutex);
409 	if (retval)
410 		return retval;
411 
412 	if (!evdev->exist)
413 		retval = -ENODEV;
414 	else if (!evdev->open++) {
415 		retval = input_open_device(&evdev->handle);
416 		if (retval)
417 			evdev->open--;
418 	}
419 
420 	mutex_unlock(&evdev->mutex);
421 	return retval;
422 }
423 
424 static void evdev_close_device(struct evdev *evdev)
425 {
426 	mutex_lock(&evdev->mutex);
427 
428 	if (evdev->exist && !--evdev->open)
429 		input_close_device(&evdev->handle);
430 
431 	mutex_unlock(&evdev->mutex);
432 }
433 
434 /*
435  * Wake up users waiting for IO so they can disconnect from
436  * dead device.
437  */
438 static void evdev_hangup(struct evdev *evdev)
439 {
440 	struct evdev_client *client;
441 
442 	spin_lock(&evdev->client_lock);
443 	list_for_each_entry(client, &evdev->client_list, node)
444 		kill_fasync(&client->fasync, SIGIO, POLL_HUP);
445 	spin_unlock(&evdev->client_lock);
446 
447 	wake_up_interruptible_poll(&evdev->wait, EPOLLHUP | EPOLLERR);
448 }
449 
450 static int evdev_release(struct inode *inode, struct file *file)
451 {
452 	struct evdev_client *client = file->private_data;
453 	struct evdev *evdev = client->evdev;
454 	unsigned int i;
455 
456 	mutex_lock(&evdev->mutex);
457 	evdev_ungrab(evdev, client);
458 	mutex_unlock(&evdev->mutex);
459 
460 	evdev_detach_client(evdev, client);
461 
462 	for (i = 0; i < EV_CNT; ++i)
463 		bitmap_free(client->evmasks[i]);
464 
465 	kvfree(client);
466 
467 	evdev_close_device(evdev);
468 
469 	return 0;
470 }
471 
472 static unsigned int evdev_compute_buffer_size(struct input_dev *dev)
473 {
474 	unsigned int n_events =
475 		max(dev->hint_events_per_packet * EVDEV_BUF_PACKETS,
476 		    EVDEV_MIN_BUFFER_SIZE);
477 
478 	return roundup_pow_of_two(n_events);
479 }
480 
481 static int evdev_open(struct inode *inode, struct file *file)
482 {
483 	struct evdev *evdev = container_of(inode->i_cdev, struct evdev, cdev);
484 	unsigned int bufsize = evdev_compute_buffer_size(evdev->handle.dev);
485 	struct evdev_client *client;
486 	int error;
487 
488 	client = kzalloc(struct_size(client, buffer, bufsize),
489 			 GFP_KERNEL | __GFP_NOWARN);
490 	if (!client)
491 		client = vzalloc(struct_size(client, buffer, bufsize));
492 	if (!client)
493 		return -ENOMEM;
494 
495 	client->bufsize = bufsize;
496 	spin_lock_init(&client->buffer_lock);
497 	client->evdev = evdev;
498 	evdev_attach_client(evdev, client);
499 
500 	error = evdev_open_device(evdev);
501 	if (error)
502 		goto err_free_client;
503 
504 	file->private_data = client;
505 	stream_open(inode, file);
506 
507 	return 0;
508 
509  err_free_client:
510 	evdev_detach_client(evdev, client);
511 	kvfree(client);
512 	return error;
513 }
514 
515 static ssize_t evdev_write(struct file *file, const char __user *buffer,
516 			   size_t count, loff_t *ppos)
517 {
518 	struct evdev_client *client = file->private_data;
519 	struct evdev *evdev = client->evdev;
520 	struct input_event event;
521 	int retval = 0;
522 
523 	if (count != 0 && count < input_event_size())
524 		return -EINVAL;
525 
526 	retval = mutex_lock_interruptible(&evdev->mutex);
527 	if (retval)
528 		return retval;
529 
530 	if (!evdev->exist || client->revoked) {
531 		retval = -ENODEV;
532 		goto out;
533 	}
534 
535 	while (retval + input_event_size() <= count) {
536 
537 		if (input_event_from_user(buffer + retval, &event)) {
538 			retval = -EFAULT;
539 			goto out;
540 		}
541 		retval += input_event_size();
542 
543 		input_inject_event(&evdev->handle,
544 				   event.type, event.code, event.value);
545 		cond_resched();
546 	}
547 
548  out:
549 	mutex_unlock(&evdev->mutex);
550 	return retval;
551 }
552 
553 static int evdev_fetch_next_event(struct evdev_client *client,
554 				  struct input_event *event)
555 {
556 	int have_event;
557 
558 	spin_lock_irq(&client->buffer_lock);
559 
560 	have_event = client->packet_head != client->tail;
561 	if (have_event) {
562 		*event = client->buffer[client->tail++];
563 		client->tail &= client->bufsize - 1;
564 	}
565 
566 	spin_unlock_irq(&client->buffer_lock);
567 
568 	return have_event;
569 }
570 
571 static ssize_t evdev_read(struct file *file, char __user *buffer,
572 			  size_t count, loff_t *ppos)
573 {
574 	struct evdev_client *client = file->private_data;
575 	struct evdev *evdev = client->evdev;
576 	struct input_event event;
577 	size_t read = 0;
578 	int error;
579 
580 	if (count != 0 && count < input_event_size())
581 		return -EINVAL;
582 
583 	for (;;) {
584 		if (!evdev->exist || client->revoked)
585 			return -ENODEV;
586 
587 		if (client->packet_head == client->tail &&
588 		    (file->f_flags & O_NONBLOCK))
589 			return -EAGAIN;
590 
591 		/*
592 		 * count == 0 is special - no IO is done but we check
593 		 * for error conditions (see above).
594 		 */
595 		if (count == 0)
596 			break;
597 
598 		while (read + input_event_size() <= count &&
599 		       evdev_fetch_next_event(client, &event)) {
600 
601 			if (input_event_to_user(buffer + read, &event))
602 				return -EFAULT;
603 
604 			read += input_event_size();
605 		}
606 
607 		if (read)
608 			break;
609 
610 		if (!(file->f_flags & O_NONBLOCK)) {
611 			error = wait_event_interruptible(evdev->wait,
612 					client->packet_head != client->tail ||
613 					!evdev->exist || client->revoked);
614 			if (error)
615 				return error;
616 		}
617 	}
618 
619 	return read;
620 }
621 
622 /* No kernel lock - fine */
623 static __poll_t evdev_poll(struct file *file, poll_table *wait)
624 {
625 	struct evdev_client *client = file->private_data;
626 	struct evdev *evdev = client->evdev;
627 	__poll_t mask;
628 
629 	poll_wait(file, &evdev->wait, wait);
630 
631 	if (evdev->exist && !client->revoked)
632 		mask = EPOLLOUT | EPOLLWRNORM;
633 	else
634 		mask = EPOLLHUP | EPOLLERR;
635 
636 	if (client->packet_head != client->tail)
637 		mask |= EPOLLIN | EPOLLRDNORM;
638 
639 	return mask;
640 }
641 
642 #ifdef CONFIG_COMPAT
643 
644 #define BITS_PER_LONG_COMPAT (sizeof(compat_long_t) * 8)
645 #define BITS_TO_LONGS_COMPAT(x) ((((x) - 1) / BITS_PER_LONG_COMPAT) + 1)
646 
647 #ifdef __BIG_ENDIAN
648 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
649 			unsigned int maxlen, void __user *p, int compat)
650 {
651 	int len, i;
652 
653 	if (compat) {
654 		len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
655 		if (len > maxlen)
656 			len = maxlen;
657 
658 		for (i = 0; i < len / sizeof(compat_long_t); i++)
659 			if (copy_to_user((compat_long_t __user *) p + i,
660 					 (compat_long_t *) bits +
661 						i + 1 - ((i % 2) << 1),
662 					 sizeof(compat_long_t)))
663 				return -EFAULT;
664 	} else {
665 		len = BITS_TO_LONGS(maxbit) * sizeof(long);
666 		if (len > maxlen)
667 			len = maxlen;
668 
669 		if (copy_to_user(p, bits, len))
670 			return -EFAULT;
671 	}
672 
673 	return len;
674 }
675 
676 static int bits_from_user(unsigned long *bits, unsigned int maxbit,
677 			  unsigned int maxlen, const void __user *p, int compat)
678 {
679 	int len, i;
680 
681 	if (compat) {
682 		if (maxlen % sizeof(compat_long_t))
683 			return -EINVAL;
684 
685 		len = BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t);
686 		if (len > maxlen)
687 			len = maxlen;
688 
689 		for (i = 0; i < len / sizeof(compat_long_t); i++)
690 			if (copy_from_user((compat_long_t *) bits +
691 						i + 1 - ((i % 2) << 1),
692 					   (compat_long_t __user *) p + i,
693 					   sizeof(compat_long_t)))
694 				return -EFAULT;
695 		if (i % 2)
696 			*((compat_long_t *) bits + i - 1) = 0;
697 
698 	} else {
699 		if (maxlen % sizeof(long))
700 			return -EINVAL;
701 
702 		len = BITS_TO_LONGS(maxbit) * sizeof(long);
703 		if (len > maxlen)
704 			len = maxlen;
705 
706 		if (copy_from_user(bits, p, len))
707 			return -EFAULT;
708 	}
709 
710 	return len;
711 }
712 
713 #else
714 
715 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
716 			unsigned int maxlen, void __user *p, int compat)
717 {
718 	int len = compat ?
719 			BITS_TO_LONGS_COMPAT(maxbit) * sizeof(compat_long_t) :
720 			BITS_TO_LONGS(maxbit) * sizeof(long);
721 
722 	if (len > maxlen)
723 		len = maxlen;
724 
725 	return copy_to_user(p, bits, len) ? -EFAULT : len;
726 }
727 
728 static int bits_from_user(unsigned long *bits, unsigned int maxbit,
729 			  unsigned int maxlen, const void __user *p, int compat)
730 {
731 	size_t chunk_size = compat ? sizeof(compat_long_t) : sizeof(long);
732 	int len;
733 
734 	if (maxlen % chunk_size)
735 		return -EINVAL;
736 
737 	len = compat ? BITS_TO_LONGS_COMPAT(maxbit) : BITS_TO_LONGS(maxbit);
738 	len *= chunk_size;
739 	if (len > maxlen)
740 		len = maxlen;
741 
742 	return copy_from_user(bits, p, len) ? -EFAULT : len;
743 }
744 
745 #endif /* __BIG_ENDIAN */
746 
747 #else
748 
749 static int bits_to_user(unsigned long *bits, unsigned int maxbit,
750 			unsigned int maxlen, void __user *p, int compat)
751 {
752 	int len = BITS_TO_LONGS(maxbit) * sizeof(long);
753 
754 	if (len > maxlen)
755 		len = maxlen;
756 
757 	return copy_to_user(p, bits, len) ? -EFAULT : len;
758 }
759 
760 static int bits_from_user(unsigned long *bits, unsigned int maxbit,
761 			  unsigned int maxlen, const void __user *p, int compat)
762 {
763 	int len;
764 
765 	if (maxlen % sizeof(long))
766 		return -EINVAL;
767 
768 	len = BITS_TO_LONGS(maxbit) * sizeof(long);
769 	if (len > maxlen)
770 		len = maxlen;
771 
772 	return copy_from_user(bits, p, len) ? -EFAULT : len;
773 }
774 
775 #endif /* CONFIG_COMPAT */
776 
777 static int str_to_user(const char *str, unsigned int maxlen, void __user *p)
778 {
779 	int len;
780 
781 	if (!str)
782 		return -ENOENT;
783 
784 	len = strlen(str) + 1;
785 	if (len > maxlen)
786 		len = maxlen;
787 
788 	return copy_to_user(p, str, len) ? -EFAULT : len;
789 }
790 
791 static int handle_eviocgbit(struct input_dev *dev,
792 			    unsigned int type, unsigned int size,
793 			    void __user *p, int compat_mode)
794 {
795 	unsigned long *bits;
796 	int len;
797 
798 	switch (type) {
799 
800 	case      0: bits = dev->evbit;  len = EV_MAX;  break;
801 	case EV_KEY: bits = dev->keybit; len = KEY_MAX; break;
802 	case EV_REL: bits = dev->relbit; len = REL_MAX; break;
803 	case EV_ABS: bits = dev->absbit; len = ABS_MAX; break;
804 	case EV_MSC: bits = dev->mscbit; len = MSC_MAX; break;
805 	case EV_LED: bits = dev->ledbit; len = LED_MAX; break;
806 	case EV_SND: bits = dev->sndbit; len = SND_MAX; break;
807 	case EV_FF:  bits = dev->ffbit;  len = FF_MAX;  break;
808 	case EV_SW:  bits = dev->swbit;  len = SW_MAX;  break;
809 	default: return -EINVAL;
810 	}
811 
812 	return bits_to_user(bits, len, size, p, compat_mode);
813 }
814 
815 static int evdev_handle_get_keycode(struct input_dev *dev, void __user *p)
816 {
817 	struct input_keymap_entry ke = {
818 		.len	= sizeof(unsigned int),
819 		.flags	= 0,
820 	};
821 	int __user *ip = (int __user *)p;
822 	int error;
823 
824 	/* legacy case */
825 	if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
826 		return -EFAULT;
827 
828 	error = input_get_keycode(dev, &ke);
829 	if (error)
830 		return error;
831 
832 	if (put_user(ke.keycode, ip + 1))
833 		return -EFAULT;
834 
835 	return 0;
836 }
837 
838 static int evdev_handle_get_keycode_v2(struct input_dev *dev, void __user *p)
839 {
840 	struct input_keymap_entry ke;
841 	int error;
842 
843 	if (copy_from_user(&ke, p, sizeof(ke)))
844 		return -EFAULT;
845 
846 	error = input_get_keycode(dev, &ke);
847 	if (error)
848 		return error;
849 
850 	if (copy_to_user(p, &ke, sizeof(ke)))
851 		return -EFAULT;
852 
853 	return 0;
854 }
855 
856 static int evdev_handle_set_keycode(struct input_dev *dev, void __user *p)
857 {
858 	struct input_keymap_entry ke = {
859 		.len	= sizeof(unsigned int),
860 		.flags	= 0,
861 	};
862 	int __user *ip = (int __user *)p;
863 
864 	if (copy_from_user(ke.scancode, p, sizeof(unsigned int)))
865 		return -EFAULT;
866 
867 	if (get_user(ke.keycode, ip + 1))
868 		return -EFAULT;
869 
870 	return input_set_keycode(dev, &ke);
871 }
872 
873 static int evdev_handle_set_keycode_v2(struct input_dev *dev, void __user *p)
874 {
875 	struct input_keymap_entry ke;
876 
877 	if (copy_from_user(&ke, p, sizeof(ke)))
878 		return -EFAULT;
879 
880 	if (ke.len > sizeof(ke.scancode))
881 		return -EINVAL;
882 
883 	return input_set_keycode(dev, &ke);
884 }
885 
886 /*
887  * If we transfer state to the user, we should flush all pending events
888  * of the same type from the client's queue. Otherwise, they might end up
889  * with duplicate events, which can screw up client's state tracking.
890  * If bits_to_user fails after flushing the queue, we queue a SYN_DROPPED
891  * event so user-space will notice missing events.
892  *
893  * LOCKING:
894  * We need to take event_lock before buffer_lock to avoid dead-locks. But we
895  * need the even_lock only to guarantee consistent state. We can safely release
896  * it while flushing the queue. This allows input-core to handle filters while
897  * we flush the queue.
898  */
899 static int evdev_handle_get_val(struct evdev_client *client,
900 				struct input_dev *dev, unsigned int type,
901 				unsigned long *bits, unsigned int maxbit,
902 				unsigned int maxlen, void __user *p,
903 				int compat)
904 {
905 	int ret;
906 	unsigned long *mem;
907 
908 	mem = bitmap_alloc(maxbit, GFP_KERNEL);
909 	if (!mem)
910 		return -ENOMEM;
911 
912 	spin_lock_irq(&dev->event_lock);
913 	spin_lock(&client->buffer_lock);
914 
915 	bitmap_copy(mem, bits, maxbit);
916 
917 	spin_unlock(&dev->event_lock);
918 
919 	__evdev_flush_queue(client, type);
920 
921 	spin_unlock_irq(&client->buffer_lock);
922 
923 	ret = bits_to_user(mem, maxbit, maxlen, p, compat);
924 	if (ret < 0)
925 		evdev_queue_syn_dropped(client);
926 
927 	bitmap_free(mem);
928 
929 	return ret;
930 }
931 
932 static int evdev_handle_mt_request(struct input_dev *dev,
933 				   unsigned int size,
934 				   int __user *ip)
935 {
936 	const struct input_mt *mt = dev->mt;
937 	unsigned int code;
938 	int max_slots;
939 	int i;
940 
941 	if (get_user(code, &ip[0]))
942 		return -EFAULT;
943 	if (!mt || !input_is_mt_value(code))
944 		return -EINVAL;
945 
946 	max_slots = (size - sizeof(__u32)) / sizeof(__s32);
947 	for (i = 0; i < mt->num_slots && i < max_slots; i++) {
948 		int value = input_mt_get_value(&mt->slots[i], code);
949 		if (put_user(value, &ip[1 + i]))
950 			return -EFAULT;
951 	}
952 
953 	return 0;
954 }
955 
956 static int evdev_revoke(struct evdev *evdev, struct evdev_client *client,
957 			struct file *file)
958 {
959 	client->revoked = true;
960 	evdev_ungrab(evdev, client);
961 	input_flush_device(&evdev->handle, file);
962 	wake_up_interruptible_poll(&evdev->wait, EPOLLHUP | EPOLLERR);
963 
964 	return 0;
965 }
966 
967 /* must be called with evdev-mutex held */
968 static int evdev_set_mask(struct evdev_client *client,
969 			  unsigned int type,
970 			  const void __user *codes,
971 			  u32 codes_size,
972 			  int compat)
973 {
974 	unsigned long flags, *mask, *oldmask;
975 	size_t cnt;
976 	int error;
977 
978 	/* we allow unknown types and 'codes_size > size' for forward-compat */
979 	cnt = evdev_get_mask_cnt(type);
980 	if (!cnt)
981 		return 0;
982 
983 	mask = bitmap_zalloc(cnt, GFP_KERNEL);
984 	if (!mask)
985 		return -ENOMEM;
986 
987 	error = bits_from_user(mask, cnt - 1, codes_size, codes, compat);
988 	if (error < 0) {
989 		bitmap_free(mask);
990 		return error;
991 	}
992 
993 	spin_lock_irqsave(&client->buffer_lock, flags);
994 	oldmask = client->evmasks[type];
995 	client->evmasks[type] = mask;
996 	spin_unlock_irqrestore(&client->buffer_lock, flags);
997 
998 	bitmap_free(oldmask);
999 
1000 	return 0;
1001 }
1002 
1003 /* must be called with evdev-mutex held */
1004 static int evdev_get_mask(struct evdev_client *client,
1005 			  unsigned int type,
1006 			  void __user *codes,
1007 			  u32 codes_size,
1008 			  int compat)
1009 {
1010 	unsigned long *mask;
1011 	size_t cnt, size, xfer_size;
1012 	int i;
1013 	int error;
1014 
1015 	/* we allow unknown types and 'codes_size > size' for forward-compat */
1016 	cnt = evdev_get_mask_cnt(type);
1017 	size = sizeof(unsigned long) * BITS_TO_LONGS(cnt);
1018 	xfer_size = min_t(size_t, codes_size, size);
1019 
1020 	if (cnt > 0) {
1021 		mask = client->evmasks[type];
1022 		if (mask) {
1023 			error = bits_to_user(mask, cnt - 1,
1024 					     xfer_size, codes, compat);
1025 			if (error < 0)
1026 				return error;
1027 		} else {
1028 			/* fake mask with all bits set */
1029 			for (i = 0; i < xfer_size; i++)
1030 				if (put_user(0xffU, (u8 __user *)codes + i))
1031 					return -EFAULT;
1032 		}
1033 	}
1034 
1035 	if (xfer_size < codes_size)
1036 		if (clear_user(codes + xfer_size, codes_size - xfer_size))
1037 			return -EFAULT;
1038 
1039 	return 0;
1040 }
1041 
1042 static long evdev_do_ioctl(struct file *file, unsigned int cmd,
1043 			   void __user *p, int compat_mode)
1044 {
1045 	struct evdev_client *client = file->private_data;
1046 	struct evdev *evdev = client->evdev;
1047 	struct input_dev *dev = evdev->handle.dev;
1048 	struct input_absinfo abs;
1049 	struct input_mask mask;
1050 	struct ff_effect effect;
1051 	int __user *ip = (int __user *)p;
1052 	unsigned int i, t, u, v;
1053 	unsigned int size;
1054 	int error;
1055 
1056 	/* First we check for fixed-length commands */
1057 	switch (cmd) {
1058 
1059 	case EVIOCGVERSION:
1060 		return put_user(EV_VERSION, ip);
1061 
1062 	case EVIOCGID:
1063 		if (copy_to_user(p, &dev->id, sizeof(struct input_id)))
1064 			return -EFAULT;
1065 		return 0;
1066 
1067 	case EVIOCGREP:
1068 		if (!test_bit(EV_REP, dev->evbit))
1069 			return -ENOSYS;
1070 		if (put_user(dev->rep[REP_DELAY], ip))
1071 			return -EFAULT;
1072 		if (put_user(dev->rep[REP_PERIOD], ip + 1))
1073 			return -EFAULT;
1074 		return 0;
1075 
1076 	case EVIOCSREP:
1077 		if (!test_bit(EV_REP, dev->evbit))
1078 			return -ENOSYS;
1079 		if (get_user(u, ip))
1080 			return -EFAULT;
1081 		if (get_user(v, ip + 1))
1082 			return -EFAULT;
1083 
1084 		input_inject_event(&evdev->handle, EV_REP, REP_DELAY, u);
1085 		input_inject_event(&evdev->handle, EV_REP, REP_PERIOD, v);
1086 
1087 		return 0;
1088 
1089 	case EVIOCRMFF:
1090 		return input_ff_erase(dev, (int)(unsigned long) p, file);
1091 
1092 	case EVIOCGEFFECTS:
1093 		i = test_bit(EV_FF, dev->evbit) ?
1094 				dev->ff->max_effects : 0;
1095 		if (put_user(i, ip))
1096 			return -EFAULT;
1097 		return 0;
1098 
1099 	case EVIOCGRAB:
1100 		if (p)
1101 			return evdev_grab(evdev, client);
1102 		else
1103 			return evdev_ungrab(evdev, client);
1104 
1105 	case EVIOCREVOKE:
1106 		if (p)
1107 			return -EINVAL;
1108 		else
1109 			return evdev_revoke(evdev, client, file);
1110 
1111 	case EVIOCGMASK: {
1112 		void __user *codes_ptr;
1113 
1114 		if (copy_from_user(&mask, p, sizeof(mask)))
1115 			return -EFAULT;
1116 
1117 		codes_ptr = (void __user *)(unsigned long)mask.codes_ptr;
1118 		return evdev_get_mask(client,
1119 				      mask.type, codes_ptr, mask.codes_size,
1120 				      compat_mode);
1121 	}
1122 
1123 	case EVIOCSMASK: {
1124 		const void __user *codes_ptr;
1125 
1126 		if (copy_from_user(&mask, p, sizeof(mask)))
1127 			return -EFAULT;
1128 
1129 		codes_ptr = (const void __user *)(unsigned long)mask.codes_ptr;
1130 		return evdev_set_mask(client,
1131 				      mask.type, codes_ptr, mask.codes_size,
1132 				      compat_mode);
1133 	}
1134 
1135 	case EVIOCSCLOCKID:
1136 		if (copy_from_user(&i, p, sizeof(unsigned int)))
1137 			return -EFAULT;
1138 
1139 		return evdev_set_clk_type(client, i);
1140 
1141 	case EVIOCGKEYCODE:
1142 		return evdev_handle_get_keycode(dev, p);
1143 
1144 	case EVIOCSKEYCODE:
1145 		return evdev_handle_set_keycode(dev, p);
1146 
1147 	case EVIOCGKEYCODE_V2:
1148 		return evdev_handle_get_keycode_v2(dev, p);
1149 
1150 	case EVIOCSKEYCODE_V2:
1151 		return evdev_handle_set_keycode_v2(dev, p);
1152 	}
1153 
1154 	size = _IOC_SIZE(cmd);
1155 
1156 	/* Now check variable-length commands */
1157 #define EVIOC_MASK_SIZE(nr)	((nr) & ~(_IOC_SIZEMASK << _IOC_SIZESHIFT))
1158 	switch (EVIOC_MASK_SIZE(cmd)) {
1159 
1160 	case EVIOCGPROP(0):
1161 		return bits_to_user(dev->propbit, INPUT_PROP_MAX,
1162 				    size, p, compat_mode);
1163 
1164 	case EVIOCGMTSLOTS(0):
1165 		return evdev_handle_mt_request(dev, size, ip);
1166 
1167 	case EVIOCGKEY(0):
1168 		return evdev_handle_get_val(client, dev, EV_KEY, dev->key,
1169 					    KEY_MAX, size, p, compat_mode);
1170 
1171 	case EVIOCGLED(0):
1172 		return evdev_handle_get_val(client, dev, EV_LED, dev->led,
1173 					    LED_MAX, size, p, compat_mode);
1174 
1175 	case EVIOCGSND(0):
1176 		return evdev_handle_get_val(client, dev, EV_SND, dev->snd,
1177 					    SND_MAX, size, p, compat_mode);
1178 
1179 	case EVIOCGSW(0):
1180 		return evdev_handle_get_val(client, dev, EV_SW, dev->sw,
1181 					    SW_MAX, size, p, compat_mode);
1182 
1183 	case EVIOCGNAME(0):
1184 		return str_to_user(dev->name, size, p);
1185 
1186 	case EVIOCGPHYS(0):
1187 		return str_to_user(dev->phys, size, p);
1188 
1189 	case EVIOCGUNIQ(0):
1190 		return str_to_user(dev->uniq, size, p);
1191 
1192 	case EVIOC_MASK_SIZE(EVIOCSFF):
1193 		if (input_ff_effect_from_user(p, size, &effect))
1194 			return -EFAULT;
1195 
1196 		error = input_ff_upload(dev, &effect, file);
1197 		if (error)
1198 			return error;
1199 
1200 		if (put_user(effect.id, &(((struct ff_effect __user *)p)->id)))
1201 			return -EFAULT;
1202 
1203 		return 0;
1204 	}
1205 
1206 	/* Multi-number variable-length handlers */
1207 	if (_IOC_TYPE(cmd) != 'E')
1208 		return -EINVAL;
1209 
1210 	if (_IOC_DIR(cmd) == _IOC_READ) {
1211 
1212 		if ((_IOC_NR(cmd) & ~EV_MAX) == _IOC_NR(EVIOCGBIT(0, 0)))
1213 			return handle_eviocgbit(dev,
1214 						_IOC_NR(cmd) & EV_MAX, size,
1215 						p, compat_mode);
1216 
1217 		if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCGABS(0))) {
1218 
1219 			if (!dev->absinfo)
1220 				return -EINVAL;
1221 
1222 			t = _IOC_NR(cmd) & ABS_MAX;
1223 			abs = dev->absinfo[t];
1224 
1225 			if (copy_to_user(p, &abs, min_t(size_t,
1226 					size, sizeof(struct input_absinfo))))
1227 				return -EFAULT;
1228 
1229 			return 0;
1230 		}
1231 	}
1232 
1233 	if (_IOC_DIR(cmd) == _IOC_WRITE) {
1234 
1235 		if ((_IOC_NR(cmd) & ~ABS_MAX) == _IOC_NR(EVIOCSABS(0))) {
1236 
1237 			if (!dev->absinfo)
1238 				return -EINVAL;
1239 
1240 			t = _IOC_NR(cmd) & ABS_MAX;
1241 
1242 			if (copy_from_user(&abs, p, min_t(size_t,
1243 					size, sizeof(struct input_absinfo))))
1244 				return -EFAULT;
1245 
1246 			if (size < sizeof(struct input_absinfo))
1247 				abs.resolution = 0;
1248 
1249 			/* We can't change number of reserved MT slots */
1250 			if (t == ABS_MT_SLOT)
1251 				return -EINVAL;
1252 
1253 			/*
1254 			 * Take event lock to ensure that we are not
1255 			 * changing device parameters in the middle
1256 			 * of event.
1257 			 */
1258 			spin_lock_irq(&dev->event_lock);
1259 			dev->absinfo[t] = abs;
1260 			spin_unlock_irq(&dev->event_lock);
1261 
1262 			return 0;
1263 		}
1264 	}
1265 
1266 	return -EINVAL;
1267 }
1268 
1269 static long evdev_ioctl_handler(struct file *file, unsigned int cmd,
1270 				void __user *p, int compat_mode)
1271 {
1272 	struct evdev_client *client = file->private_data;
1273 	struct evdev *evdev = client->evdev;
1274 	int retval;
1275 
1276 	retval = mutex_lock_interruptible(&evdev->mutex);
1277 	if (retval)
1278 		return retval;
1279 
1280 	if (!evdev->exist || client->revoked) {
1281 		retval = -ENODEV;
1282 		goto out;
1283 	}
1284 
1285 	retval = evdev_do_ioctl(file, cmd, p, compat_mode);
1286 
1287  out:
1288 	mutex_unlock(&evdev->mutex);
1289 	return retval;
1290 }
1291 
1292 static long evdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1293 {
1294 	return evdev_ioctl_handler(file, cmd, (void __user *)arg, 0);
1295 }
1296 
1297 #ifdef CONFIG_COMPAT
1298 static long evdev_ioctl_compat(struct file *file,
1299 				unsigned int cmd, unsigned long arg)
1300 {
1301 	return evdev_ioctl_handler(file, cmd, compat_ptr(arg), 1);
1302 }
1303 #endif
1304 
1305 static const struct file_operations evdev_fops = {
1306 	.owner		= THIS_MODULE,
1307 	.read		= evdev_read,
1308 	.write		= evdev_write,
1309 	.poll		= evdev_poll,
1310 	.open		= evdev_open,
1311 	.release	= evdev_release,
1312 	.unlocked_ioctl	= evdev_ioctl,
1313 #ifdef CONFIG_COMPAT
1314 	.compat_ioctl	= evdev_ioctl_compat,
1315 #endif
1316 	.fasync		= evdev_fasync,
1317 	.flush		= evdev_flush,
1318 	.llseek		= no_llseek,
1319 };
1320 
1321 /*
1322  * Mark device non-existent. This disables writes, ioctls and
1323  * prevents new users from opening the device. Already posted
1324  * blocking reads will stay, however new ones will fail.
1325  */
1326 static void evdev_mark_dead(struct evdev *evdev)
1327 {
1328 	mutex_lock(&evdev->mutex);
1329 	evdev->exist = false;
1330 	mutex_unlock(&evdev->mutex);
1331 }
1332 
1333 static void evdev_cleanup(struct evdev *evdev)
1334 {
1335 	struct input_handle *handle = &evdev->handle;
1336 
1337 	evdev_mark_dead(evdev);
1338 	evdev_hangup(evdev);
1339 
1340 	/* evdev is marked dead so no one else accesses evdev->open */
1341 	if (evdev->open) {
1342 		input_flush_device(handle, NULL);
1343 		input_close_device(handle);
1344 	}
1345 }
1346 
1347 /*
1348  * Create new evdev device. Note that input core serializes calls
1349  * to connect and disconnect.
1350  */
1351 static int evdev_connect(struct input_handler *handler, struct input_dev *dev,
1352 			 const struct input_device_id *id)
1353 {
1354 	struct evdev *evdev;
1355 	int minor;
1356 	int dev_no;
1357 	int error;
1358 
1359 	minor = input_get_new_minor(EVDEV_MINOR_BASE, EVDEV_MINORS, true);
1360 	if (minor < 0) {
1361 		error = minor;
1362 		pr_err("failed to reserve new minor: %d\n", error);
1363 		return error;
1364 	}
1365 
1366 	evdev = kzalloc(sizeof(struct evdev), GFP_KERNEL);
1367 	if (!evdev) {
1368 		error = -ENOMEM;
1369 		goto err_free_minor;
1370 	}
1371 
1372 	INIT_LIST_HEAD(&evdev->client_list);
1373 	spin_lock_init(&evdev->client_lock);
1374 	mutex_init(&evdev->mutex);
1375 	init_waitqueue_head(&evdev->wait);
1376 	evdev->exist = true;
1377 
1378 	dev_no = minor;
1379 	/* Normalize device number if it falls into legacy range */
1380 	if (dev_no < EVDEV_MINOR_BASE + EVDEV_MINORS)
1381 		dev_no -= EVDEV_MINOR_BASE;
1382 	dev_set_name(&evdev->dev, "event%d", dev_no);
1383 
1384 	evdev->handle.dev = input_get_device(dev);
1385 	evdev->handle.name = dev_name(&evdev->dev);
1386 	evdev->handle.handler = handler;
1387 	evdev->handle.private = evdev;
1388 
1389 	evdev->dev.devt = MKDEV(INPUT_MAJOR, minor);
1390 	evdev->dev.class = &input_class;
1391 	evdev->dev.parent = &dev->dev;
1392 	evdev->dev.release = evdev_free;
1393 	device_initialize(&evdev->dev);
1394 
1395 	error = input_register_handle(&evdev->handle);
1396 	if (error)
1397 		goto err_free_evdev;
1398 
1399 	cdev_init(&evdev->cdev, &evdev_fops);
1400 
1401 	error = cdev_device_add(&evdev->cdev, &evdev->dev);
1402 	if (error)
1403 		goto err_cleanup_evdev;
1404 
1405 	return 0;
1406 
1407  err_cleanup_evdev:
1408 	evdev_cleanup(evdev);
1409 	input_unregister_handle(&evdev->handle);
1410  err_free_evdev:
1411 	put_device(&evdev->dev);
1412  err_free_minor:
1413 	input_free_minor(minor);
1414 	return error;
1415 }
1416 
1417 static void evdev_disconnect(struct input_handle *handle)
1418 {
1419 	struct evdev *evdev = handle->private;
1420 
1421 	cdev_device_del(&evdev->cdev, &evdev->dev);
1422 	evdev_cleanup(evdev);
1423 	input_free_minor(MINOR(evdev->dev.devt));
1424 	input_unregister_handle(handle);
1425 	put_device(&evdev->dev);
1426 }
1427 
1428 static const struct input_device_id evdev_ids[] = {
1429 	{ .driver_info = 1 },	/* Matches all devices */
1430 	{ },			/* Terminating zero entry */
1431 };
1432 
1433 MODULE_DEVICE_TABLE(input, evdev_ids);
1434 
1435 static struct input_handler evdev_handler = {
1436 	.event		= evdev_event,
1437 	.events		= evdev_events,
1438 	.connect	= evdev_connect,
1439 	.disconnect	= evdev_disconnect,
1440 	.legacy_minors	= true,
1441 	.minor		= EVDEV_MINOR_BASE,
1442 	.name		= "evdev",
1443 	.id_table	= evdev_ids,
1444 };
1445 
1446 static int __init evdev_init(void)
1447 {
1448 	return input_register_handler(&evdev_handler);
1449 }
1450 
1451 static void __exit evdev_exit(void)
1452 {
1453 	input_unregister_handler(&evdev_handler);
1454 }
1455 
1456 module_init(evdev_init);
1457 module_exit(evdev_exit);
1458 
1459 MODULE_AUTHOR("Vojtech Pavlik <[email protected]>");
1460 MODULE_DESCRIPTION("Input driver event char devices");
1461 MODULE_LICENSE("GPL");
1462