2 * User-space I/O driver support for HID subsystem
3 * Copyright (c) 2012 David Herrmann
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the Free
9 * Software Foundation; either version 2 of the License, or (at your option)
13 #include <linux/atomic.h>
14 #include <linux/compat.h>
15 #include <linux/cred.h>
16 #include <linux/device.h>
18 #include <linux/hid.h>
19 #include <linux/input.h>
20 #include <linux/miscdevice.h>
21 #include <linux/module.h>
22 #include <linux/mutex.h>
23 #include <linux/poll.h>
24 #include <linux/sched.h>
25 #include <linux/spinlock.h>
26 #include <linux/uhid.h>
27 #include <linux/wait.h>
29 #define UHID_NAME "uhid"
30 #define UHID_BUFSIZE 32
35 /* This flag tracks whether the HID device is usable for commands from
36 * userspace. The flag is already set before hid_add_device(), which
37 * runs in workqueue context, to allow hid_add_device() to communicate
39 * However, if hid_add_device() fails, the flag is cleared without
41 * We guarantee that if @running changes from true to false while you're
42 * holding @devlock, it's still fine to access @hid.
49 /* When this is NULL, userspace may use UHID_CREATE/UHID_CREATE2. */
50 struct hid_device *hid;
51 struct uhid_event input_buf;
53 wait_queue_head_t waitq;
57 struct uhid_event *outq[UHID_BUFSIZE];
59 /* blocking GET_REPORT support; state changes protected by qlock */
60 struct mutex report_lock;
61 wait_queue_head_t report_wait;
65 struct uhid_event report_buf;
66 struct work_struct worker;
69 static struct miscdevice uhid_misc;
71 static void uhid_device_add_worker(struct work_struct *work)
73 struct uhid_device *uhid = container_of(work, struct uhid_device, worker);
76 ret = hid_add_device(uhid->hid);
78 hid_err(uhid->hid, "Cannot register HID device: error %d\n", ret);
80 /* We used to call hid_destroy_device() here, but that's really
81 * messy to get right because we have to coordinate with
82 * concurrent writes from userspace that might be in the middle
84 * Just leave uhid->hid as-is for now, and clean it up when
85 * userspace tries to close or reinitialize the uhid instance.
87 * However, we do have to clear the ->running flag and do a
88 * wakeup to make sure userspace knows that the device is gone.
90 uhid->running = false;
91 wake_up_interruptible(&uhid->report_wait);
95 static void uhid_queue(struct uhid_device *uhid, struct uhid_event *ev)
99 newhead = (uhid->head + 1) % UHID_BUFSIZE;
101 if (newhead != uhid->tail) {
102 uhid->outq[uhid->head] = ev;
103 uhid->head = newhead;
104 wake_up_interruptible(&uhid->waitq);
106 hid_warn(uhid->hid, "Output queue is full\n");
111 static int uhid_queue_event(struct uhid_device *uhid, __u32 event)
114 struct uhid_event *ev;
116 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
122 spin_lock_irqsave(&uhid->qlock, flags);
123 uhid_queue(uhid, ev);
124 spin_unlock_irqrestore(&uhid->qlock, flags);
129 static int uhid_hid_start(struct hid_device *hid)
131 struct uhid_device *uhid = hid->driver_data;
132 struct uhid_event *ev;
135 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
139 ev->type = UHID_START;
141 if (hid->report_enum[HID_FEATURE_REPORT].numbered)
142 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_FEATURE_REPORTS;
143 if (hid->report_enum[HID_OUTPUT_REPORT].numbered)
144 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_OUTPUT_REPORTS;
145 if (hid->report_enum[HID_INPUT_REPORT].numbered)
146 ev->u.start.dev_flags |= UHID_DEV_NUMBERED_INPUT_REPORTS;
148 spin_lock_irqsave(&uhid->qlock, flags);
149 uhid_queue(uhid, ev);
150 spin_unlock_irqrestore(&uhid->qlock, flags);
155 static void uhid_hid_stop(struct hid_device *hid)
157 struct uhid_device *uhid = hid->driver_data;
160 uhid_queue_event(uhid, UHID_STOP);
163 static int uhid_hid_open(struct hid_device *hid)
165 struct uhid_device *uhid = hid->driver_data;
167 return uhid_queue_event(uhid, UHID_OPEN);
170 static void uhid_hid_close(struct hid_device *hid)
172 struct uhid_device *uhid = hid->driver_data;
174 uhid_queue_event(uhid, UHID_CLOSE);
177 static int uhid_hid_parse(struct hid_device *hid)
179 struct uhid_device *uhid = hid->driver_data;
181 return hid_parse_report(hid, uhid->rd_data, uhid->rd_size);
184 /* must be called with report_lock held */
185 static int __uhid_report_queue_and_wait(struct uhid_device *uhid,
186 struct uhid_event *ev,
192 spin_lock_irqsave(&uhid->qlock, flags);
193 *report_id = ++uhid->report_id;
194 uhid->report_type = ev->type + 1;
195 uhid->report_running = true;
196 uhid_queue(uhid, ev);
197 spin_unlock_irqrestore(&uhid->qlock, flags);
199 ret = wait_event_interruptible_timeout(uhid->report_wait,
200 !uhid->report_running || !uhid->running,
202 if (!ret || !uhid->running || uhid->report_running)
209 uhid->report_running = false;
214 static void uhid_report_wake_up(struct uhid_device *uhid, u32 id,
215 const struct uhid_event *ev)
219 spin_lock_irqsave(&uhid->qlock, flags);
221 /* id for old report; drop it silently */
222 if (uhid->report_type != ev->type || uhid->report_id != id)
224 if (!uhid->report_running)
227 memcpy(&uhid->report_buf, ev, sizeof(*ev));
228 uhid->report_running = false;
229 wake_up_interruptible(&uhid->report_wait);
232 spin_unlock_irqrestore(&uhid->qlock, flags);
235 static int uhid_hid_get_report(struct hid_device *hid, unsigned char rnum,
236 u8 *buf, size_t count, u8 rtype)
238 struct uhid_device *uhid = hid->driver_data;
239 struct uhid_get_report_reply_req *req;
240 struct uhid_event *ev;
246 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
250 ev->type = UHID_GET_REPORT;
251 ev->u.get_report.rnum = rnum;
252 ev->u.get_report.rtype = rtype;
254 ret = mutex_lock_interruptible(&uhid->report_lock);
260 /* this _always_ takes ownership of @ev */
261 ret = __uhid_report_queue_and_wait(uhid, ev, &ev->u.get_report.id);
265 req = &uhid->report_buf.u.get_report_reply;
269 ret = min3(count, (size_t)req->size, (size_t)UHID_DATA_MAX);
270 memcpy(buf, req->data, ret);
274 mutex_unlock(&uhid->report_lock);
278 static int uhid_hid_set_report(struct hid_device *hid, unsigned char rnum,
279 const u8 *buf, size_t count, u8 rtype)
281 struct uhid_device *uhid = hid->driver_data;
282 struct uhid_event *ev;
285 if (!uhid->running || count > UHID_DATA_MAX)
288 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
292 ev->type = UHID_SET_REPORT;
293 ev->u.set_report.rnum = rnum;
294 ev->u.set_report.rtype = rtype;
295 ev->u.set_report.size = count;
296 memcpy(ev->u.set_report.data, buf, count);
298 ret = mutex_lock_interruptible(&uhid->report_lock);
304 /* this _always_ takes ownership of @ev */
305 ret = __uhid_report_queue_and_wait(uhid, ev, &ev->u.set_report.id);
309 if (uhid->report_buf.u.set_report_reply.err)
315 mutex_unlock(&uhid->report_lock);
319 static int uhid_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
320 __u8 *buf, size_t len, unsigned char rtype,
326 case HID_FEATURE_REPORT:
327 u_rtype = UHID_FEATURE_REPORT;
329 case HID_OUTPUT_REPORT:
330 u_rtype = UHID_OUTPUT_REPORT;
332 case HID_INPUT_REPORT:
333 u_rtype = UHID_INPUT_REPORT;
340 case HID_REQ_GET_REPORT:
341 return uhid_hid_get_report(hid, reportnum, buf, len, u_rtype);
342 case HID_REQ_SET_REPORT:
343 return uhid_hid_set_report(hid, reportnum, buf, len, u_rtype);
349 static int uhid_hid_output_raw(struct hid_device *hid, __u8 *buf, size_t count,
350 unsigned char report_type)
352 struct uhid_device *uhid = hid->driver_data;
355 struct uhid_event *ev;
357 switch (report_type) {
358 case HID_FEATURE_REPORT:
359 rtype = UHID_FEATURE_REPORT;
361 case HID_OUTPUT_REPORT:
362 rtype = UHID_OUTPUT_REPORT;
368 if (count < 1 || count > UHID_DATA_MAX)
371 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
375 ev->type = UHID_OUTPUT;
376 ev->u.output.size = count;
377 ev->u.output.rtype = rtype;
378 memcpy(ev->u.output.data, buf, count);
380 spin_lock_irqsave(&uhid->qlock, flags);
381 uhid_queue(uhid, ev);
382 spin_unlock_irqrestore(&uhid->qlock, flags);
387 static int uhid_hid_output_report(struct hid_device *hid, __u8 *buf,
390 return uhid_hid_output_raw(hid, buf, count, HID_OUTPUT_REPORT);
393 struct hid_ll_driver uhid_hid_driver = {
394 .start = uhid_hid_start,
395 .stop = uhid_hid_stop,
396 .open = uhid_hid_open,
397 .close = uhid_hid_close,
398 .parse = uhid_hid_parse,
399 .raw_request = uhid_hid_raw_request,
400 .output_report = uhid_hid_output_report,
401 .max_buffer_size = UHID_DATA_MAX,
403 EXPORT_SYMBOL_GPL(uhid_hid_driver);
407 /* Apparently we haven't stepped on these rakes enough times yet. */
408 struct uhid_create_req_compat {
413 compat_uptr_t rd_data;
421 } __attribute__((__packed__));
423 static int uhid_event_from_user(const char __user *buffer, size_t len,
424 struct uhid_event *event)
426 if (in_compat_syscall()) {
429 if (get_user(type, buffer))
432 if (type == UHID_CREATE) {
434 * This is our messed up request with compat pointer.
435 * It is largish (more than 256 bytes) so we better
436 * allocate it from the heap.
438 struct uhid_create_req_compat *compat;
440 compat = kzalloc(sizeof(*compat), GFP_KERNEL);
444 buffer += sizeof(type);
446 if (copy_from_user(compat, buffer,
447 min(len, sizeof(*compat)))) {
452 /* Shuffle the data over to proper structure */
455 memcpy(event->u.create.name, compat->name,
456 sizeof(compat->name));
457 memcpy(event->u.create.phys, compat->phys,
458 sizeof(compat->phys));
459 memcpy(event->u.create.uniq, compat->uniq,
460 sizeof(compat->uniq));
462 event->u.create.rd_data = compat_ptr(compat->rd_data);
463 event->u.create.rd_size = compat->rd_size;
465 event->u.create.bus = compat->bus;
466 event->u.create.vendor = compat->vendor;
467 event->u.create.product = compat->product;
468 event->u.create.version = compat->version;
469 event->u.create.country = compat->country;
474 /* All others can be copied directly */
477 if (copy_from_user(event, buffer, min(len, sizeof(*event))))
483 static int uhid_event_from_user(const char __user *buffer, size_t len,
484 struct uhid_event *event)
486 if (copy_from_user(event, buffer, min(len, sizeof(*event))))
493 static int uhid_dev_create2(struct uhid_device *uhid,
494 const struct uhid_event *ev)
496 struct hid_device *hid;
504 rd_size = ev->u.create2.rd_size;
505 if (rd_size <= 0 || rd_size > HID_MAX_DESCRIPTOR_SIZE)
508 rd_data = kmemdup(ev->u.create2.rd_data, rd_size, GFP_KERNEL);
512 uhid->rd_size = rd_size;
513 uhid->rd_data = rd_data;
515 hid = hid_allocate_device();
521 /* @hid is zero-initialized, strncpy() is correct, strlcpy() not */
522 len = min(sizeof(hid->name), sizeof(ev->u.create2.name)) - 1;
523 strncpy(hid->name, ev->u.create2.name, len);
524 len = min(sizeof(hid->phys), sizeof(ev->u.create2.phys)) - 1;
525 strncpy(hid->phys, ev->u.create2.phys, len);
526 len = min(sizeof(hid->uniq), sizeof(ev->u.create2.uniq)) - 1;
527 strncpy(hid->uniq, ev->u.create2.uniq, len);
529 hid->ll_driver = &uhid_hid_driver;
530 hid->bus = ev->u.create2.bus;
531 hid->vendor = ev->u.create2.vendor;
532 hid->product = ev->u.create2.product;
533 hid->version = ev->u.create2.version;
534 hid->country = ev->u.create2.country;
535 hid->driver_data = uhid;
536 hid->dev.parent = uhid_misc.this_device;
539 uhid->running = true;
541 /* Adding of a HID device is done through a worker, to allow HID drivers
542 * which use feature requests during .probe to work, without they would
543 * be blocked on devlock, which is held by uhid_char_write.
545 schedule_work(&uhid->worker);
550 kfree(uhid->rd_data);
551 uhid->rd_data = NULL;
556 static int uhid_dev_create(struct uhid_device *uhid,
557 struct uhid_event *ev)
559 struct uhid_create_req orig;
563 if (orig.rd_size <= 0 || orig.rd_size > HID_MAX_DESCRIPTOR_SIZE)
565 if (copy_from_user(&ev->u.create2.rd_data, orig.rd_data, orig.rd_size))
568 memcpy(ev->u.create2.name, orig.name, sizeof(orig.name));
569 memcpy(ev->u.create2.phys, orig.phys, sizeof(orig.phys));
570 memcpy(ev->u.create2.uniq, orig.uniq, sizeof(orig.uniq));
571 ev->u.create2.rd_size = orig.rd_size;
572 ev->u.create2.bus = orig.bus;
573 ev->u.create2.vendor = orig.vendor;
574 ev->u.create2.product = orig.product;
575 ev->u.create2.version = orig.version;
576 ev->u.create2.country = orig.country;
578 return uhid_dev_create2(uhid, ev);
581 static int uhid_dev_destroy(struct uhid_device *uhid)
586 uhid->running = false;
587 wake_up_interruptible(&uhid->report_wait);
589 cancel_work_sync(&uhid->worker);
591 hid_destroy_device(uhid->hid);
593 kfree(uhid->rd_data);
598 static int uhid_dev_input(struct uhid_device *uhid, struct uhid_event *ev)
603 hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input.data,
604 min_t(size_t, ev->u.input.size, UHID_DATA_MAX), 0);
609 static int uhid_dev_input2(struct uhid_device *uhid, struct uhid_event *ev)
614 hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input2.data,
615 min_t(size_t, ev->u.input2.size, UHID_DATA_MAX), 0);
620 static int uhid_dev_get_report_reply(struct uhid_device *uhid,
621 struct uhid_event *ev)
626 uhid_report_wake_up(uhid, ev->u.get_report_reply.id, ev);
630 static int uhid_dev_set_report_reply(struct uhid_device *uhid,
631 struct uhid_event *ev)
636 uhid_report_wake_up(uhid, ev->u.set_report_reply.id, ev);
640 static int uhid_char_open(struct inode *inode, struct file *file)
642 struct uhid_device *uhid;
644 uhid = kzalloc(sizeof(*uhid), GFP_KERNEL);
648 mutex_init(&uhid->devlock);
649 mutex_init(&uhid->report_lock);
650 spin_lock_init(&uhid->qlock);
651 init_waitqueue_head(&uhid->waitq);
652 init_waitqueue_head(&uhid->report_wait);
653 uhid->running = false;
654 INIT_WORK(&uhid->worker, uhid_device_add_worker);
656 file->private_data = uhid;
657 nonseekable_open(inode, file);
662 static int uhid_char_release(struct inode *inode, struct file *file)
664 struct uhid_device *uhid = file->private_data;
667 uhid_dev_destroy(uhid);
669 for (i = 0; i < UHID_BUFSIZE; ++i)
670 kfree(uhid->outq[i]);
677 static ssize_t uhid_char_read(struct file *file, char __user *buffer,
678 size_t count, loff_t *ppos)
680 struct uhid_device *uhid = file->private_data;
685 /* they need at least the "type" member of uhid_event */
686 if (count < sizeof(__u32))
690 if (file->f_flags & O_NONBLOCK) {
691 if (uhid->head == uhid->tail)
694 ret = wait_event_interruptible(uhid->waitq,
695 uhid->head != uhid->tail);
700 ret = mutex_lock_interruptible(&uhid->devlock);
704 if (uhid->head == uhid->tail) {
705 mutex_unlock(&uhid->devlock);
708 len = min(count, sizeof(**uhid->outq));
709 if (copy_to_user(buffer, uhid->outq[uhid->tail], len)) {
712 kfree(uhid->outq[uhid->tail]);
713 uhid->outq[uhid->tail] = NULL;
715 spin_lock_irqsave(&uhid->qlock, flags);
716 uhid->tail = (uhid->tail + 1) % UHID_BUFSIZE;
717 spin_unlock_irqrestore(&uhid->qlock, flags);
721 mutex_unlock(&uhid->devlock);
722 return ret ? ret : len;
725 static ssize_t uhid_char_write(struct file *file, const char __user *buffer,
726 size_t count, loff_t *ppos)
728 struct uhid_device *uhid = file->private_data;
732 /* we need at least the "type" member of uhid_event */
733 if (count < sizeof(__u32))
736 ret = mutex_lock_interruptible(&uhid->devlock);
740 memset(&uhid->input_buf, 0, sizeof(uhid->input_buf));
741 len = min(count, sizeof(uhid->input_buf));
743 ret = uhid_event_from_user(buffer, len, &uhid->input_buf);
747 switch (uhid->input_buf.type) {
750 * 'struct uhid_create_req' contains a __user pointer which is
751 * copied from, so it's unsafe to allow this with elevated
752 * privileges (e.g. from a setuid binary) or via kernel_write().
754 if (file->f_cred != current_cred() || uaccess_kernel()) {
755 pr_err_once("UHID_CREATE from different security context by process %d (%s), this is not allowed.\n",
756 task_tgid_vnr(current), current->comm);
760 ret = uhid_dev_create(uhid, &uhid->input_buf);
763 ret = uhid_dev_create2(uhid, &uhid->input_buf);
766 ret = uhid_dev_destroy(uhid);
769 ret = uhid_dev_input(uhid, &uhid->input_buf);
772 ret = uhid_dev_input2(uhid, &uhid->input_buf);
774 case UHID_GET_REPORT_REPLY:
775 ret = uhid_dev_get_report_reply(uhid, &uhid->input_buf);
777 case UHID_SET_REPORT_REPLY:
778 ret = uhid_dev_set_report_reply(uhid, &uhid->input_buf);
785 mutex_unlock(&uhid->devlock);
787 /* return "count" not "len" to not confuse the caller */
788 return ret ? ret : count;
791 static __poll_t uhid_char_poll(struct file *file, poll_table *wait)
793 struct uhid_device *uhid = file->private_data;
794 __poll_t mask = EPOLLOUT | EPOLLWRNORM; /* uhid is always writable */
796 poll_wait(file, &uhid->waitq, wait);
798 if (uhid->head != uhid->tail)
799 mask |= EPOLLIN | EPOLLRDNORM;
804 static const struct file_operations uhid_fops = {
805 .owner = THIS_MODULE,
806 .open = uhid_char_open,
807 .release = uhid_char_release,
808 .read = uhid_char_read,
809 .write = uhid_char_write,
810 .poll = uhid_char_poll,
814 static struct miscdevice uhid_misc = {
819 module_misc_device(uhid_misc);
821 MODULE_LICENSE("GPL");
822 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
823 MODULE_DESCRIPTION("User-space I/O driver support for HID subsystem");
824 MODULE_ALIAS_MISCDEV(UHID_MINOR);
825 MODULE_ALIAS("devname:" UHID_NAME);