1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * User-space I/O driver support for HID subsystem
4 * Copyright (c) 2012 David Herrmann
10 #include <linux/atomic.h>
11 #include <linux/compat.h>
12 #include <linux/cred.h>
13 #include <linux/device.h>
15 #include <linux/hid.h>
16 #include <linux/input.h>
17 #include <linux/miscdevice.h>
18 #include <linux/module.h>
19 #include <linux/mutex.h>
20 #include <linux/poll.h>
21 #include <linux/sched.h>
22 #include <linux/spinlock.h>
23 #include <linux/uhid.h>
24 #include <linux/wait.h>
26 #define UHID_NAME "uhid"
27 #define UHID_BUFSIZE 32
32 /* This flag tracks whether the HID device is usable for commands from
33 * userspace. The flag is already set before hid_add_device(), which
34 * runs in workqueue context, to allow hid_add_device() to communicate
36 * However, if hid_add_device() fails, the flag is cleared without
38 * We guarantee that if @running changes from true to false while you're
39 * holding @devlock, it's still fine to access @hid.
46 /* When this is NULL, userspace may use UHID_CREATE/UHID_CREATE2. */
47 struct hid_device *hid;
48 struct uhid_event input_buf;
50 wait_queue_head_t waitq;
54 struct uhid_event *outq[UHID_BUFSIZE];
56 /* blocking GET_REPORT support; state changes protected by qlock */
57 struct mutex report_lock;
58 wait_queue_head_t report_wait;
62 struct uhid_event report_buf;
63 struct work_struct worker;
66 static struct miscdevice uhid_misc;
68 static void uhid_device_add_worker(struct work_struct *work)
70 struct uhid_device *uhid = container_of(work, struct uhid_device, worker);
73 ret = hid_add_device(uhid->hid);
75 hid_err(uhid->hid, "Cannot register HID device: error %d\n", ret);
77 /* We used to call hid_destroy_device() here, but that's really
78 * messy to get right because we have to coordinate with
79 * concurrent writes from userspace that might be in the middle
81 * Just leave uhid->hid as-is for now, and clean it up when
82 * userspace tries to close or reinitialize the uhid instance.
84 * However, we do have to clear the ->running flag and do a
85 * wakeup to make sure userspace knows that the device is gone.
87 WRITE_ONCE(uhid->running, false);
88 wake_up_interruptible(&uhid->report_wait);
92 static void uhid_queue(struct uhid_device *uhid, struct uhid_event *ev)
96 newhead = (uhid->head + 1) % UHID_BUFSIZE;
98 if (newhead != uhid->tail) {
99 uhid->outq[uhid->head] = ev;
100 uhid->head = newhead;
101 wake_up_interruptible(&uhid->waitq);
103 hid_warn(uhid->hid, "Output queue is full\n");
108 static int uhid_queue_event(struct uhid_device *uhid, __u32 event)
111 struct uhid_event *ev;
113 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
119 spin_lock_irqsave(&uhid->qlock, flags);
120 uhid_queue(uhid, ev);
121 spin_unlock_irqrestore(&uhid->qlock, flags);
126 static int uhid_hid_start(struct hid_device *hid)
128 struct uhid_device *uhid = hid->driver_data;
129 struct uhid_event *ev;
132 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
136 ev->type = UHID_START;
138 if (hid->report_enum[HID_FEATURE_REPORT].numbered)
139 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_FEATURE_REPORTS;
140 if (hid->report_enum[HID_OUTPUT_REPORT].numbered)
141 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_OUTPUT_REPORTS;
142 if (hid->report_enum[HID_INPUT_REPORT].numbered)
143 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_INPUT_REPORTS;
145 spin_lock_irqsave(&uhid->qlock, flags);
146 uhid_queue(uhid, ev);
147 spin_unlock_irqrestore(&uhid->qlock, flags);
152 static void uhid_hid_stop(struct hid_device *hid)
154 struct uhid_device *uhid = hid->driver_data;
157 uhid_queue_event(uhid, UHID_STOP);
160 static int uhid_hid_open(struct hid_device *hid)
162 struct uhid_device *uhid = hid->driver_data;
164 return uhid_queue_event(uhid, UHID_OPEN);
167 static void uhid_hid_close(struct hid_device *hid)
169 struct uhid_device *uhid = hid->driver_data;
171 uhid_queue_event(uhid, UHID_CLOSE);
174 static int uhid_hid_parse(struct hid_device *hid)
176 struct uhid_device *uhid = hid->driver_data;
178 return hid_parse_report(hid, uhid->rd_data, uhid->rd_size);
181 /* must be called with report_lock held */
182 static int __uhid_report_queue_and_wait(struct uhid_device *uhid,
183 struct uhid_event *ev,
189 spin_lock_irqsave(&uhid->qlock, flags);
190 *report_id = ++uhid->report_id;
191 uhid->report_type = ev->type + 1;
192 uhid->report_running = true;
193 uhid_queue(uhid, ev);
194 spin_unlock_irqrestore(&uhid->qlock, flags);
196 ret = wait_event_interruptible_timeout(uhid->report_wait,
197 !uhid->report_running || !READ_ONCE(uhid->running),
199 if (!ret || !READ_ONCE(uhid->running) || uhid->report_running)
206 uhid->report_running = false;
211 static void uhid_report_wake_up(struct uhid_device *uhid, u32 id,
212 const struct uhid_event *ev)
216 spin_lock_irqsave(&uhid->qlock, flags);
218 /* id for old report; drop it silently */
219 if (uhid->report_type != ev->type || uhid->report_id != id)
221 if (!uhid->report_running)
224 memcpy(&uhid->report_buf, ev, sizeof(*ev));
225 uhid->report_running = false;
226 wake_up_interruptible(&uhid->report_wait);
229 spin_unlock_irqrestore(&uhid->qlock, flags);
232 static int uhid_hid_get_report(struct hid_device *hid, unsigned char rnum,
233 u8 *buf, size_t count, u8 rtype)
235 struct uhid_device *uhid = hid->driver_data;
236 struct uhid_get_report_reply_req *req;
237 struct uhid_event *ev;
240 if (!READ_ONCE(uhid->running))
243 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
247 ev->type = UHID_GET_REPORT;
248 ev->u.get_report.rnum = rnum;
249 ev->u.get_report.rtype = rtype;
251 ret = mutex_lock_interruptible(&uhid->report_lock);
257 /* this _always_ takes ownership of @ev */
258 ret = __uhid_report_queue_and_wait(uhid, ev, &ev->u.get_report.id);
262 req = &uhid->report_buf.u.get_report_reply;
266 ret = min3(count, (size_t)req->size, (size_t)UHID_DATA_MAX);
267 memcpy(buf, req->data, ret);
271 mutex_unlock(&uhid->report_lock);
275 static int uhid_hid_set_report(struct hid_device *hid, unsigned char rnum,
276 const u8 *buf, size_t count, u8 rtype)
278 struct uhid_device *uhid = hid->driver_data;
279 struct uhid_event *ev;
282 if (!READ_ONCE(uhid->running) || count > UHID_DATA_MAX)
285 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
289 ev->type = UHID_SET_REPORT;
290 ev->u.set_report.rnum = rnum;
291 ev->u.set_report.rtype = rtype;
292 ev->u.set_report.size = count;
293 memcpy(ev->u.set_report.data, buf, count);
295 ret = mutex_lock_interruptible(&uhid->report_lock);
301 /* this _always_ takes ownership of @ev */
302 ret = __uhid_report_queue_and_wait(uhid, ev, &ev->u.set_report.id);
306 if (uhid->report_buf.u.set_report_reply.err)
312 mutex_unlock(&uhid->report_lock);
316 static int uhid_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
317 __u8 *buf, size_t len, unsigned char rtype,
323 case HID_FEATURE_REPORT:
324 u_rtype = UHID_FEATURE_REPORT;
326 case HID_OUTPUT_REPORT:
327 u_rtype = UHID_OUTPUT_REPORT;
329 case HID_INPUT_REPORT:
330 u_rtype = UHID_INPUT_REPORT;
337 case HID_REQ_GET_REPORT:
338 return uhid_hid_get_report(hid, reportnum, buf, len, u_rtype);
339 case HID_REQ_SET_REPORT:
340 return uhid_hid_set_report(hid, reportnum, buf, len, u_rtype);
346 static int uhid_hid_output_raw(struct hid_device *hid, __u8 *buf, size_t count,
347 unsigned char report_type)
349 struct uhid_device *uhid = hid->driver_data;
352 struct uhid_event *ev;
354 switch (report_type) {
355 case HID_FEATURE_REPORT:
356 rtype = UHID_FEATURE_REPORT;
358 case HID_OUTPUT_REPORT:
359 rtype = UHID_OUTPUT_REPORT;
365 if (count < 1 || count > UHID_DATA_MAX)
368 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
372 ev->type = UHID_OUTPUT;
373 ev->u.output.size = count;
374 ev->u.output.rtype = rtype;
375 memcpy(ev->u.output.data, buf, count);
377 spin_lock_irqsave(&uhid->qlock, flags);
378 uhid_queue(uhid, ev);
379 spin_unlock_irqrestore(&uhid->qlock, flags);
384 static int uhid_hid_output_report(struct hid_device *hid, __u8 *buf,
387 return uhid_hid_output_raw(hid, buf, count, HID_OUTPUT_REPORT);
390 static const struct hid_ll_driver uhid_hid_driver = {
391 .start = uhid_hid_start,
392 .stop = uhid_hid_stop,
393 .open = uhid_hid_open,
394 .close = uhid_hid_close,
395 .parse = uhid_hid_parse,
396 .raw_request = uhid_hid_raw_request,
397 .output_report = uhid_hid_output_report,
398 .max_buffer_size = UHID_DATA_MAX,
403 /* Apparently we haven't stepped on these rakes enough times yet. */
404 struct uhid_create_req_compat {
409 compat_uptr_t rd_data;
417 } __attribute__((__packed__));
419 static int uhid_event_from_user(const char __user *buffer, size_t len,
420 struct uhid_event *event)
422 if (in_compat_syscall()) {
425 if (get_user(type, buffer))
428 if (type == UHID_CREATE) {
430 * This is our messed up request with compat pointer.
431 * It is largish (more than 256 bytes) so we better
432 * allocate it from the heap.
434 struct uhid_create_req_compat *compat;
436 compat = kzalloc(sizeof(*compat), GFP_KERNEL);
440 buffer += sizeof(type);
442 if (copy_from_user(compat, buffer,
443 min(len, sizeof(*compat)))) {
448 /* Shuffle the data over to proper structure */
451 memcpy(event->u.create.name, compat->name,
452 sizeof(compat->name));
453 memcpy(event->u.create.phys, compat->phys,
454 sizeof(compat->phys));
455 memcpy(event->u.create.uniq, compat->uniq,
456 sizeof(compat->uniq));
458 event->u.create.rd_data = compat_ptr(compat->rd_data);
459 event->u.create.rd_size = compat->rd_size;
461 event->u.create.bus = compat->bus;
462 event->u.create.vendor = compat->vendor;
463 event->u.create.product = compat->product;
464 event->u.create.version = compat->version;
465 event->u.create.country = compat->country;
470 /* All others can be copied directly */
473 if (copy_from_user(event, buffer, min(len, sizeof(*event))))
479 static int uhid_event_from_user(const char __user *buffer, size_t len,
480 struct uhid_event *event)
482 if (copy_from_user(event, buffer, min(len, sizeof(*event))))
489 static int uhid_dev_create2(struct uhid_device *uhid,
490 const struct uhid_event *ev)
492 struct hid_device *hid;
500 rd_size = ev->u.create2.rd_size;
501 if (rd_size <= 0 || rd_size > HID_MAX_DESCRIPTOR_SIZE)
504 rd_data = kmemdup(ev->u.create2.rd_data, rd_size, GFP_KERNEL);
508 uhid->rd_size = rd_size;
509 uhid->rd_data = rd_data;
511 hid = hid_allocate_device();
517 /* @hid is zero-initialized, strncpy() is correct, strlcpy() not */
518 len = min(sizeof(hid->name), sizeof(ev->u.create2.name)) - 1;
519 strncpy(hid->name, ev->u.create2.name, len);
520 len = min(sizeof(hid->phys), sizeof(ev->u.create2.phys)) - 1;
521 strncpy(hid->phys, ev->u.create2.phys, len);
522 len = min(sizeof(hid->uniq), sizeof(ev->u.create2.uniq)) - 1;
523 strncpy(hid->uniq, ev->u.create2.uniq, len);
525 hid->ll_driver = &uhid_hid_driver;
526 hid->bus = ev->u.create2.bus;
527 hid->vendor = ev->u.create2.vendor;
528 hid->product = ev->u.create2.product;
529 hid->version = ev->u.create2.version;
530 hid->country = ev->u.create2.country;
531 hid->driver_data = uhid;
532 hid->dev.parent = uhid_misc.this_device;
535 uhid->running = true;
537 /* Adding of a HID device is done through a worker, to allow HID drivers
538 * which use feature requests during .probe to work, without they would
539 * be blocked on devlock, which is held by uhid_char_write.
541 schedule_work(&uhid->worker);
546 kfree(uhid->rd_data);
547 uhid->rd_data = NULL;
552 static int uhid_dev_create(struct uhid_device *uhid,
553 struct uhid_event *ev)
555 struct uhid_create_req orig;
559 if (orig.rd_size <= 0 || orig.rd_size > HID_MAX_DESCRIPTOR_SIZE)
561 if (copy_from_user(&ev->u.create2.rd_data, orig.rd_data, orig.rd_size))
564 memcpy(ev->u.create2.name, orig.name, sizeof(orig.name));
565 memcpy(ev->u.create2.phys, orig.phys, sizeof(orig.phys));
566 memcpy(ev->u.create2.uniq, orig.uniq, sizeof(orig.uniq));
567 ev->u.create2.rd_size = orig.rd_size;
568 ev->u.create2.bus = orig.bus;
569 ev->u.create2.vendor = orig.vendor;
570 ev->u.create2.product = orig.product;
571 ev->u.create2.version = orig.version;
572 ev->u.create2.country = orig.country;
574 return uhid_dev_create2(uhid, ev);
577 static int uhid_dev_destroy(struct uhid_device *uhid)
582 WRITE_ONCE(uhid->running, false);
583 wake_up_interruptible(&uhid->report_wait);
585 cancel_work_sync(&uhid->worker);
587 hid_destroy_device(uhid->hid);
589 kfree(uhid->rd_data);
594 static int uhid_dev_input(struct uhid_device *uhid, struct uhid_event *ev)
596 if (!READ_ONCE(uhid->running))
599 hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input.data,
600 min_t(size_t, ev->u.input.size, UHID_DATA_MAX), 0);
605 static int uhid_dev_input2(struct uhid_device *uhid, struct uhid_event *ev)
607 if (!READ_ONCE(uhid->running))
610 hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input2.data,
611 min_t(size_t, ev->u.input2.size, UHID_DATA_MAX), 0);
616 static int uhid_dev_get_report_reply(struct uhid_device *uhid,
617 struct uhid_event *ev)
619 if (!READ_ONCE(uhid->running))
622 uhid_report_wake_up(uhid, ev->u.get_report_reply.id, ev);
626 static int uhid_dev_set_report_reply(struct uhid_device *uhid,
627 struct uhid_event *ev)
629 if (!READ_ONCE(uhid->running))
632 uhid_report_wake_up(uhid, ev->u.set_report_reply.id, ev);
636 static int uhid_char_open(struct inode *inode, struct file *file)
638 struct uhid_device *uhid;
640 uhid = kzalloc(sizeof(*uhid), GFP_KERNEL);
644 mutex_init(&uhid->devlock);
645 mutex_init(&uhid->report_lock);
646 spin_lock_init(&uhid->qlock);
647 init_waitqueue_head(&uhid->waitq);
648 init_waitqueue_head(&uhid->report_wait);
649 uhid->running = false;
650 INIT_WORK(&uhid->worker, uhid_device_add_worker);
652 file->private_data = uhid;
653 stream_open(inode, file);
658 static int uhid_char_release(struct inode *inode, struct file *file)
660 struct uhid_device *uhid = file->private_data;
663 uhid_dev_destroy(uhid);
665 for (i = 0; i < UHID_BUFSIZE; ++i)
666 kfree(uhid->outq[i]);
673 static ssize_t uhid_char_read(struct file *file, char __user *buffer,
674 size_t count, loff_t *ppos)
676 struct uhid_device *uhid = file->private_data;
681 /* they need at least the "type" member of uhid_event */
682 if (count < sizeof(__u32))
686 if (file->f_flags & O_NONBLOCK) {
687 if (uhid->head == uhid->tail)
690 ret = wait_event_interruptible(uhid->waitq,
691 uhid->head != uhid->tail);
696 ret = mutex_lock_interruptible(&uhid->devlock);
700 if (uhid->head == uhid->tail) {
701 mutex_unlock(&uhid->devlock);
704 len = min(count, sizeof(**uhid->outq));
705 if (copy_to_user(buffer, uhid->outq[uhid->tail], len)) {
708 kfree(uhid->outq[uhid->tail]);
709 uhid->outq[uhid->tail] = NULL;
711 spin_lock_irqsave(&uhid->qlock, flags);
712 uhid->tail = (uhid->tail + 1) % UHID_BUFSIZE;
713 spin_unlock_irqrestore(&uhid->qlock, flags);
717 mutex_unlock(&uhid->devlock);
718 return ret ? ret : len;
721 static ssize_t uhid_char_write(struct file *file, const char __user *buffer,
722 size_t count, loff_t *ppos)
724 struct uhid_device *uhid = file->private_data;
728 /* we need at least the "type" member of uhid_event */
729 if (count < sizeof(__u32))
732 ret = mutex_lock_interruptible(&uhid->devlock);
736 memset(&uhid->input_buf, 0, sizeof(uhid->input_buf));
737 len = min(count, sizeof(uhid->input_buf));
739 ret = uhid_event_from_user(buffer, len, &uhid->input_buf);
743 switch (uhid->input_buf.type) {
746 * 'struct uhid_create_req' contains a __user pointer which is
747 * copied from, so it's unsafe to allow this with elevated
748 * privileges (e.g. from a setuid binary) or via kernel_write().
750 if (file->f_cred != current_cred()) {
751 pr_err_once("UHID_CREATE from different security context by process %d (%s), this is not allowed.\n",
752 task_tgid_vnr(current), current->comm);
756 ret = uhid_dev_create(uhid, &uhid->input_buf);
759 ret = uhid_dev_create2(uhid, &uhid->input_buf);
762 ret = uhid_dev_destroy(uhid);
765 ret = uhid_dev_input(uhid, &uhid->input_buf);
768 ret = uhid_dev_input2(uhid, &uhid->input_buf);
770 case UHID_GET_REPORT_REPLY:
771 ret = uhid_dev_get_report_reply(uhid, &uhid->input_buf);
773 case UHID_SET_REPORT_REPLY:
774 ret = uhid_dev_set_report_reply(uhid, &uhid->input_buf);
781 mutex_unlock(&uhid->devlock);
783 /* return "count" not "len" to not confuse the caller */
784 return ret ? ret : count;
787 static __poll_t uhid_char_poll(struct file *file, poll_table *wait)
789 struct uhid_device *uhid = file->private_data;
790 __poll_t mask = EPOLLOUT | EPOLLWRNORM; /* uhid is always writable */
792 poll_wait(file, &uhid->waitq, wait);
794 if (uhid->head != uhid->tail)
795 mask |= EPOLLIN | EPOLLRDNORM;
800 static const struct file_operations uhid_fops = {
801 .owner = THIS_MODULE,
802 .open = uhid_char_open,
803 .release = uhid_char_release,
804 .read = uhid_char_read,
805 .write = uhid_char_write,
806 .poll = uhid_char_poll,
810 static struct miscdevice uhid_misc = {
815 module_misc_device(uhid_misc);
817 MODULE_LICENSE("GPL");
818 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
819 MODULE_DESCRIPTION("User-space I/O driver support for HID subsystem");
820 MODULE_ALIAS_MISCDEV(UHID_MINOR);
821 MODULE_ALIAS("devname:" UHID_NAME);