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/device.h>
17 #include <linux/hid.h>
18 #include <linux/input.h>
19 #include <linux/miscdevice.h>
20 #include <linux/module.h>
21 #include <linux/mutex.h>
22 #include <linux/poll.h>
23 #include <linux/sched.h>
24 #include <linux/spinlock.h>
25 #include <linux/uhid.h>
26 #include <linux/wait.h>
28 #define UHID_NAME "uhid"
29 #define UHID_BUFSIZE 32
38 struct hid_device
*hid
;
39 struct uhid_event input_buf
;
41 wait_queue_head_t waitq
;
45 struct uhid_event
*outq
[UHID_BUFSIZE
];
47 /* blocking GET_REPORT support; state changes protected by qlock */
48 struct mutex report_lock
;
49 wait_queue_head_t report_wait
;
53 struct uhid_event report_buf
;
56 static struct miscdevice uhid_misc
;
58 static void uhid_queue(struct uhid_device
*uhid
, struct uhid_event
*ev
)
62 newhead
= (uhid
->head
+ 1) % UHID_BUFSIZE
;
64 if (newhead
!= uhid
->tail
) {
65 uhid
->outq
[uhid
->head
] = ev
;
67 wake_up_interruptible(&uhid
->waitq
);
69 hid_warn(uhid
->hid
, "Output queue is full\n");
74 static int uhid_queue_event(struct uhid_device
*uhid
, __u32 event
)
77 struct uhid_event
*ev
;
79 ev
= kzalloc(sizeof(*ev
), GFP_KERNEL
);
85 spin_lock_irqsave(&uhid
->qlock
, flags
);
87 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
92 static int uhid_hid_start(struct hid_device
*hid
)
94 struct uhid_device
*uhid
= hid
->driver_data
;
95 struct uhid_event
*ev
;
98 ev
= kzalloc(sizeof(*ev
), GFP_KERNEL
);
102 ev
->type
= UHID_START
;
104 if (hid
->report_enum
[HID_FEATURE_REPORT
].numbered
)
105 ev
->u
.start
.dev_flags
|= UHID_DEV_NUMBERED_FEATURE_REPORTS
;
106 if (hid
->report_enum
[HID_OUTPUT_REPORT
].numbered
)
107 ev
->u
.start
.dev_flags
|= UHID_DEV_NUMBERED_OUTPUT_REPORTS
;
108 if (hid
->report_enum
[HID_INPUT_REPORT
].numbered
)
109 ev
->u
.start
.dev_flags
|= UHID_DEV_NUMBERED_INPUT_REPORTS
;
111 spin_lock_irqsave(&uhid
->qlock
, flags
);
112 uhid_queue(uhid
, ev
);
113 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
118 static void uhid_hid_stop(struct hid_device
*hid
)
120 struct uhid_device
*uhid
= hid
->driver_data
;
123 uhid_queue_event(uhid
, UHID_STOP
);
126 static int uhid_hid_open(struct hid_device
*hid
)
128 struct uhid_device
*uhid
= hid
->driver_data
;
130 return uhid_queue_event(uhid
, UHID_OPEN
);
133 static void uhid_hid_close(struct hid_device
*hid
)
135 struct uhid_device
*uhid
= hid
->driver_data
;
137 uhid_queue_event(uhid
, UHID_CLOSE
);
140 static int uhid_hid_parse(struct hid_device
*hid
)
142 struct uhid_device
*uhid
= hid
->driver_data
;
144 return hid_parse_report(hid
, uhid
->rd_data
, uhid
->rd_size
);
147 /* must be called with report_lock held */
148 static int __uhid_report_queue_and_wait(struct uhid_device
*uhid
,
149 struct uhid_event
*ev
,
155 spin_lock_irqsave(&uhid
->qlock
, flags
);
156 *report_id
= ++uhid
->report_id
;
157 uhid
->report_type
= ev
->type
+ 1;
158 uhid
->report_running
= true;
159 uhid_queue(uhid
, ev
);
160 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
162 ret
= wait_event_interruptible_timeout(uhid
->report_wait
,
163 !uhid
->report_running
|| !uhid
->running
,
165 if (!ret
|| !uhid
->running
|| uhid
->report_running
)
172 uhid
->report_running
= false;
177 static void uhid_report_wake_up(struct uhid_device
*uhid
, u32 id
,
178 const struct uhid_event
*ev
)
182 spin_lock_irqsave(&uhid
->qlock
, flags
);
184 /* id for old report; drop it silently */
185 if (uhid
->report_type
!= ev
->type
|| uhid
->report_id
!= id
)
187 if (!uhid
->report_running
)
190 memcpy(&uhid
->report_buf
, ev
, sizeof(*ev
));
191 uhid
->report_running
= false;
192 wake_up_interruptible(&uhid
->report_wait
);
195 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
198 static int uhid_hid_get_report(struct hid_device
*hid
, unsigned char rnum
,
199 u8
*buf
, size_t count
, u8 rtype
)
201 struct uhid_device
*uhid
= hid
->driver_data
;
202 struct uhid_get_report_reply_req
*req
;
203 struct uhid_event
*ev
;
209 ev
= kzalloc(sizeof(*ev
), GFP_KERNEL
);
213 ev
->type
= UHID_GET_REPORT
;
214 ev
->u
.get_report
.rnum
= rnum
;
215 ev
->u
.get_report
.rtype
= rtype
;
217 ret
= mutex_lock_interruptible(&uhid
->report_lock
);
223 /* this _always_ takes ownership of @ev */
224 ret
= __uhid_report_queue_and_wait(uhid
, ev
, &ev
->u
.get_report
.id
);
228 req
= &uhid
->report_buf
.u
.get_report_reply
;
232 ret
= min3(count
, (size_t)req
->size
, (size_t)UHID_DATA_MAX
);
233 memcpy(buf
, req
->data
, ret
);
237 mutex_unlock(&uhid
->report_lock
);
241 static int uhid_hid_set_report(struct hid_device
*hid
, unsigned char rnum
,
242 const u8
*buf
, size_t count
, u8 rtype
)
244 struct uhid_device
*uhid
= hid
->driver_data
;
245 struct uhid_event
*ev
;
248 if (!uhid
->running
|| count
> UHID_DATA_MAX
)
251 ev
= kzalloc(sizeof(*ev
), GFP_KERNEL
);
255 ev
->type
= UHID_SET_REPORT
;
256 ev
->u
.set_report
.rnum
= rnum
;
257 ev
->u
.set_report
.rtype
= rtype
;
258 ev
->u
.set_report
.size
= count
;
259 memcpy(ev
->u
.set_report
.data
, buf
, count
);
261 ret
= mutex_lock_interruptible(&uhid
->report_lock
);
267 /* this _always_ takes ownership of @ev */
268 ret
= __uhid_report_queue_and_wait(uhid
, ev
, &ev
->u
.set_report
.id
);
272 if (uhid
->report_buf
.u
.set_report_reply
.err
)
278 mutex_unlock(&uhid
->report_lock
);
282 static int uhid_hid_raw_request(struct hid_device
*hid
, unsigned char reportnum
,
283 __u8
*buf
, size_t len
, unsigned char rtype
,
289 case HID_FEATURE_REPORT
:
290 u_rtype
= UHID_FEATURE_REPORT
;
292 case HID_OUTPUT_REPORT
:
293 u_rtype
= UHID_OUTPUT_REPORT
;
295 case HID_INPUT_REPORT
:
296 u_rtype
= UHID_INPUT_REPORT
;
303 case HID_REQ_GET_REPORT
:
304 return uhid_hid_get_report(hid
, reportnum
, buf
, len
, u_rtype
);
305 case HID_REQ_SET_REPORT
:
306 return uhid_hid_set_report(hid
, reportnum
, buf
, len
, u_rtype
);
312 static int uhid_hid_output_raw(struct hid_device
*hid
, __u8
*buf
, size_t count
,
313 unsigned char report_type
)
315 struct uhid_device
*uhid
= hid
->driver_data
;
318 struct uhid_event
*ev
;
320 switch (report_type
) {
321 case HID_FEATURE_REPORT
:
322 rtype
= UHID_FEATURE_REPORT
;
324 case HID_OUTPUT_REPORT
:
325 rtype
= UHID_OUTPUT_REPORT
;
331 if (count
< 1 || count
> UHID_DATA_MAX
)
334 ev
= kzalloc(sizeof(*ev
), GFP_KERNEL
);
338 ev
->type
= UHID_OUTPUT
;
339 ev
->u
.output
.size
= count
;
340 ev
->u
.output
.rtype
= rtype
;
341 memcpy(ev
->u
.output
.data
, buf
, count
);
343 spin_lock_irqsave(&uhid
->qlock
, flags
);
344 uhid_queue(uhid
, ev
);
345 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
350 static int uhid_hid_output_report(struct hid_device
*hid
, __u8
*buf
,
353 return uhid_hid_output_raw(hid
, buf
, count
, HID_OUTPUT_REPORT
);
356 static struct hid_ll_driver uhid_hid_driver
= {
357 .start
= uhid_hid_start
,
358 .stop
= uhid_hid_stop
,
359 .open
= uhid_hid_open
,
360 .close
= uhid_hid_close
,
361 .parse
= uhid_hid_parse
,
362 .raw_request
= uhid_hid_raw_request
,
363 .output_report
= uhid_hid_output_report
,
368 /* Apparently we haven't stepped on these rakes enough times yet. */
369 struct uhid_create_req_compat
{
374 compat_uptr_t rd_data
;
382 } __attribute__((__packed__
));
384 static int uhid_event_from_user(const char __user
*buffer
, size_t len
,
385 struct uhid_event
*event
)
387 if (in_compat_syscall()) {
390 if (get_user(type
, buffer
))
393 if (type
== UHID_CREATE
) {
395 * This is our messed up request with compat pointer.
396 * It is largish (more than 256 bytes) so we better
397 * allocate it from the heap.
399 struct uhid_create_req_compat
*compat
;
401 compat
= kzalloc(sizeof(*compat
), GFP_KERNEL
);
405 buffer
+= sizeof(type
);
407 if (copy_from_user(compat
, buffer
,
408 min(len
, sizeof(*compat
)))) {
413 /* Shuffle the data over to proper structure */
416 memcpy(event
->u
.create
.name
, compat
->name
,
417 sizeof(compat
->name
));
418 memcpy(event
->u
.create
.phys
, compat
->phys
,
419 sizeof(compat
->phys
));
420 memcpy(event
->u
.create
.uniq
, compat
->uniq
,
421 sizeof(compat
->uniq
));
423 event
->u
.create
.rd_data
= compat_ptr(compat
->rd_data
);
424 event
->u
.create
.rd_size
= compat
->rd_size
;
426 event
->u
.create
.bus
= compat
->bus
;
427 event
->u
.create
.vendor
= compat
->vendor
;
428 event
->u
.create
.product
= compat
->product
;
429 event
->u
.create
.version
= compat
->version
;
430 event
->u
.create
.country
= compat
->country
;
435 /* All others can be copied directly */
438 if (copy_from_user(event
, buffer
, min(len
, sizeof(*event
))))
444 static int uhid_event_from_user(const char __user
*buffer
, size_t len
,
445 struct uhid_event
*event
)
447 if (copy_from_user(event
, buffer
, min(len
, sizeof(*event
))))
454 static int uhid_dev_create2(struct uhid_device
*uhid
,
455 const struct uhid_event
*ev
)
457 struct hid_device
*hid
;
465 rd_size
= ev
->u
.create2
.rd_size
;
466 if (rd_size
<= 0 || rd_size
> HID_MAX_DESCRIPTOR_SIZE
)
469 rd_data
= kmemdup(ev
->u
.create2
.rd_data
, rd_size
, GFP_KERNEL
);
473 uhid
->rd_size
= rd_size
;
474 uhid
->rd_data
= rd_data
;
476 hid
= hid_allocate_device();
482 len
= min(sizeof(hid
->name
), sizeof(ev
->u
.create2
.name
)) - 1;
483 strncpy(hid
->name
, ev
->u
.create2
.name
, len
);
484 len
= min(sizeof(hid
->phys
), sizeof(ev
->u
.create2
.phys
)) - 1;
485 strncpy(hid
->phys
, ev
->u
.create2
.phys
, len
);
486 len
= min(sizeof(hid
->uniq
), sizeof(ev
->u
.create2
.uniq
)) - 1;
487 strncpy(hid
->uniq
, ev
->u
.create2
.uniq
, len
);
489 hid
->ll_driver
= &uhid_hid_driver
;
490 hid
->bus
= ev
->u
.create2
.bus
;
491 hid
->vendor
= ev
->u
.create2
.vendor
;
492 hid
->product
= ev
->u
.create2
.product
;
493 hid
->version
= ev
->u
.create2
.version
;
494 hid
->country
= ev
->u
.create2
.country
;
495 hid
->driver_data
= uhid
;
496 hid
->dev
.parent
= uhid_misc
.this_device
;
499 uhid
->running
= true;
501 ret
= hid_add_device(hid
);
503 hid_err(hid
, "Cannot register HID device\n");
510 hid_destroy_device(hid
);
512 uhid
->running
= false;
514 kfree(uhid
->rd_data
);
515 uhid
->rd_data
= NULL
;
520 static int uhid_dev_create(struct uhid_device
*uhid
,
521 struct uhid_event
*ev
)
523 struct uhid_create_req orig
;
527 if (orig
.rd_size
<= 0 || orig
.rd_size
> HID_MAX_DESCRIPTOR_SIZE
)
529 if (copy_from_user(&ev
->u
.create2
.rd_data
, orig
.rd_data
, orig
.rd_size
))
532 memcpy(ev
->u
.create2
.name
, orig
.name
, sizeof(orig
.name
));
533 memcpy(ev
->u
.create2
.phys
, orig
.phys
, sizeof(orig
.phys
));
534 memcpy(ev
->u
.create2
.uniq
, orig
.uniq
, sizeof(orig
.uniq
));
535 ev
->u
.create2
.rd_size
= orig
.rd_size
;
536 ev
->u
.create2
.bus
= orig
.bus
;
537 ev
->u
.create2
.vendor
= orig
.vendor
;
538 ev
->u
.create2
.product
= orig
.product
;
539 ev
->u
.create2
.version
= orig
.version
;
540 ev
->u
.create2
.country
= orig
.country
;
542 return uhid_dev_create2(uhid
, ev
);
545 static int uhid_dev_destroy(struct uhid_device
*uhid
)
550 uhid
->running
= false;
551 wake_up_interruptible(&uhid
->report_wait
);
553 hid_destroy_device(uhid
->hid
);
554 kfree(uhid
->rd_data
);
559 static int uhid_dev_input(struct uhid_device
*uhid
, struct uhid_event
*ev
)
564 hid_input_report(uhid
->hid
, HID_INPUT_REPORT
, ev
->u
.input
.data
,
565 min_t(size_t, ev
->u
.input
.size
, UHID_DATA_MAX
), 0);
570 static int uhid_dev_input2(struct uhid_device
*uhid
, struct uhid_event
*ev
)
575 hid_input_report(uhid
->hid
, HID_INPUT_REPORT
, ev
->u
.input2
.data
,
576 min_t(size_t, ev
->u
.input2
.size
, UHID_DATA_MAX
), 0);
581 static int uhid_dev_get_report_reply(struct uhid_device
*uhid
,
582 struct uhid_event
*ev
)
587 uhid_report_wake_up(uhid
, ev
->u
.get_report_reply
.id
, ev
);
591 static int uhid_dev_set_report_reply(struct uhid_device
*uhid
,
592 struct uhid_event
*ev
)
597 uhid_report_wake_up(uhid
, ev
->u
.set_report_reply
.id
, ev
);
601 static int uhid_char_open(struct inode
*inode
, struct file
*file
)
603 struct uhid_device
*uhid
;
605 uhid
= kzalloc(sizeof(*uhid
), GFP_KERNEL
);
609 mutex_init(&uhid
->devlock
);
610 mutex_init(&uhid
->report_lock
);
611 spin_lock_init(&uhid
->qlock
);
612 init_waitqueue_head(&uhid
->waitq
);
613 init_waitqueue_head(&uhid
->report_wait
);
614 uhid
->running
= false;
616 file
->private_data
= uhid
;
617 nonseekable_open(inode
, file
);
622 static int uhid_char_release(struct inode
*inode
, struct file
*file
)
624 struct uhid_device
*uhid
= file
->private_data
;
627 uhid_dev_destroy(uhid
);
629 for (i
= 0; i
< UHID_BUFSIZE
; ++i
)
630 kfree(uhid
->outq
[i
]);
637 static ssize_t
uhid_char_read(struct file
*file
, char __user
*buffer
,
638 size_t count
, loff_t
*ppos
)
640 struct uhid_device
*uhid
= file
->private_data
;
645 /* they need at least the "type" member of uhid_event */
646 if (count
< sizeof(__u32
))
650 if (file
->f_flags
& O_NONBLOCK
) {
651 if (uhid
->head
== uhid
->tail
)
654 ret
= wait_event_interruptible(uhid
->waitq
,
655 uhid
->head
!= uhid
->tail
);
660 ret
= mutex_lock_interruptible(&uhid
->devlock
);
664 if (uhid
->head
== uhid
->tail
) {
665 mutex_unlock(&uhid
->devlock
);
668 len
= min(count
, sizeof(**uhid
->outq
));
669 if (copy_to_user(buffer
, uhid
->outq
[uhid
->tail
], len
)) {
672 kfree(uhid
->outq
[uhid
->tail
]);
673 uhid
->outq
[uhid
->tail
] = NULL
;
675 spin_lock_irqsave(&uhid
->qlock
, flags
);
676 uhid
->tail
= (uhid
->tail
+ 1) % UHID_BUFSIZE
;
677 spin_unlock_irqrestore(&uhid
->qlock
, flags
);
681 mutex_unlock(&uhid
->devlock
);
682 return ret
? ret
: len
;
685 static ssize_t
uhid_char_write(struct file
*file
, const char __user
*buffer
,
686 size_t count
, loff_t
*ppos
)
688 struct uhid_device
*uhid
= file
->private_data
;
692 /* we need at least the "type" member of uhid_event */
693 if (count
< sizeof(__u32
))
696 ret
= mutex_lock_interruptible(&uhid
->devlock
);
700 memset(&uhid
->input_buf
, 0, sizeof(uhid
->input_buf
));
701 len
= min(count
, sizeof(uhid
->input_buf
));
703 ret
= uhid_event_from_user(buffer
, len
, &uhid
->input_buf
);
707 switch (uhid
->input_buf
.type
) {
709 ret
= uhid_dev_create(uhid
, &uhid
->input_buf
);
712 ret
= uhid_dev_create2(uhid
, &uhid
->input_buf
);
715 ret
= uhid_dev_destroy(uhid
);
718 ret
= uhid_dev_input(uhid
, &uhid
->input_buf
);
721 ret
= uhid_dev_input2(uhid
, &uhid
->input_buf
);
723 case UHID_GET_REPORT_REPLY
:
724 ret
= uhid_dev_get_report_reply(uhid
, &uhid
->input_buf
);
726 case UHID_SET_REPORT_REPLY
:
727 ret
= uhid_dev_set_report_reply(uhid
, &uhid
->input_buf
);
734 mutex_unlock(&uhid
->devlock
);
736 /* return "count" not "len" to not confuse the caller */
737 return ret
? ret
: count
;
740 static unsigned int uhid_char_poll(struct file
*file
, poll_table
*wait
)
742 struct uhid_device
*uhid
= file
->private_data
;
744 poll_wait(file
, &uhid
->waitq
, wait
);
746 if (uhid
->head
!= uhid
->tail
)
747 return POLLIN
| POLLRDNORM
;
752 static const struct file_operations uhid_fops
= {
753 .owner
= THIS_MODULE
,
754 .open
= uhid_char_open
,
755 .release
= uhid_char_release
,
756 .read
= uhid_char_read
,
757 .write
= uhid_char_write
,
758 .poll
= uhid_char_poll
,
762 static struct miscdevice uhid_misc
= {
768 static int __init
uhid_init(void)
770 return misc_register(&uhid_misc
);
773 static void __exit
uhid_exit(void)
775 misc_deregister(&uhid_misc
);
778 module_init(uhid_init
);
779 module_exit(uhid_exit
);
780 MODULE_LICENSE("GPL");
781 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
782 MODULE_DESCRIPTION("User-space I/O driver support for HID subsystem");
783 MODULE_ALIAS_MISCDEV(UHID_MINOR
);
784 MODULE_ALIAS("devname:" UHID_NAME
);