2 * HID raw devices, giving access to raw HID events.
4 * In comparison to hiddev, this device does not process the
5 * hid events at all (no parsing, no lookups). This lets applications
6 * to work on raw hid events as they want to, and avoids a need to
7 * use a transport-specific userspace libhid/libusb libraries.
9 * Copyright (c) 2007-2014 Jiri Kosina
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms and conditions of the GNU General Public License,
15 * version 2, as published by the Free Software Foundation.
17 * You should have received a copy of the GNU General Public License along with
18 * this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25 #include <linux/module.h>
26 #include <linux/errno.h>
27 #include <linux/kernel.h>
28 #include <linux/init.h>
29 #include <linux/cdev.h>
30 #include <linux/poll.h>
31 #include <linux/device.h>
32 #include <linux/major.h>
33 #include <linux/slab.h>
34 #include <linux/hid.h>
35 #include <linux/mutex.h>
36 #include <linux/sched.h>
38 #include <linux/hidraw.h>
40 static int hidraw_major;
41 static struct cdev hidraw_cdev;
42 static struct class *hidraw_class;
43 static struct hidraw *hidraw_table[HIDRAW_MAX_DEVICES];
44 static DEFINE_MUTEX(minors_lock);
46 static ssize_t hidraw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
48 struct hidraw_list *list = file->private_data;
50 DECLARE_WAITQUEUE(wait, current);
52 mutex_lock(&list->read_mutex);
55 if (list->head == list->tail) {
56 add_wait_queue(&list->hidraw->wait, &wait);
57 set_current_state(TASK_INTERRUPTIBLE);
59 while (list->head == list->tail) {
60 if (signal_pending(current)) {
64 if (!list->hidraw->exist) {
68 if (file->f_flags & O_NONBLOCK) {
73 /* allow O_NONBLOCK to work well from other threads */
74 mutex_unlock(&list->read_mutex);
76 mutex_lock(&list->read_mutex);
77 set_current_state(TASK_INTERRUPTIBLE);
80 set_current_state(TASK_RUNNING);
81 remove_wait_queue(&list->hidraw->wait, &wait);
87 len = list->buffer[list->tail].len > count ?
88 count : list->buffer[list->tail].len;
90 if (list->buffer[list->tail].value) {
91 if (copy_to_user(buffer, list->buffer[list->tail].value, len)) {
98 kfree(list->buffer[list->tail].value);
99 list->buffer[list->tail].value = NULL;
100 list->tail = (list->tail + 1) & (HIDRAW_BUFFER_SIZE - 1);
103 mutex_unlock(&list->read_mutex);
108 * The first byte of the report buffer is expected to be a report number.
110 * This function is to be called with the minors_lock mutex held.
112 static ssize_t hidraw_send_report(struct file *file, const char __user *buffer, size_t count, unsigned char report_type)
114 unsigned int minor = iminor(file_inode(file));
115 struct hid_device *dev;
119 if (!hidraw_table[minor] || !hidraw_table[minor]->exist) {
124 dev = hidraw_table[minor]->hid;
127 if (count > HID_MAX_BUFFER_SIZE) {
128 hid_warn(dev, "pid %d passed too large report\n",
129 task_pid_nr(current));
135 hid_warn(dev, "pid %d passed too short report\n",
136 task_pid_nr(current));
141 buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
147 if (copy_from_user(buf, buffer, count)) {
152 if ((report_type == HID_OUTPUT_REPORT) &&
153 !(dev->quirks & HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP)) {
154 ret = hid_hw_output_report(dev, buf, count);
156 * compatibility with old implementation of USB-HID and I2C-HID:
157 * if the device does not support receiving output reports,
158 * on an interrupt endpoint, fallback to SET_REPORT HID command.
164 ret = hid_hw_raw_request(dev, buf[0], buf, count, report_type,
173 static ssize_t hidraw_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
176 mutex_lock(&minors_lock);
177 ret = hidraw_send_report(file, buffer, count, HID_OUTPUT_REPORT);
178 mutex_unlock(&minors_lock);
184 * This function performs a Get_Report transfer over the control endpoint
185 * per section 7.2.1 of the HID specification, version 1.1. The first byte
186 * of buffer is the report number to request, or 0x0 if the defice does not
187 * use numbered reports. The report_type parameter can be HID_FEATURE_REPORT
188 * or HID_INPUT_REPORT.
190 * This function is to be called with the minors_lock mutex held.
192 static ssize_t hidraw_get_report(struct file *file, char __user *buffer, size_t count, unsigned char report_type)
194 unsigned int minor = iminor(file_inode(file));
195 struct hid_device *dev;
198 unsigned char report_number;
200 if (!hidraw_table[minor] || !hidraw_table[minor]->exist) {
205 dev = hidraw_table[minor]->hid;
207 if (!dev->ll_driver->raw_request) {
212 if (count > HID_MAX_BUFFER_SIZE) {
213 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
214 task_pid_nr(current));
220 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
221 task_pid_nr(current));
226 buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
233 * Read the first byte from the user. This is the report number,
234 * which is passed to hid_hw_raw_request().
236 if (copy_from_user(&report_number, buffer, 1)) {
241 ret = hid_hw_raw_request(dev, report_number, buf, count, report_type,
247 len = (ret < count) ? ret : count;
249 if (copy_to_user(buffer, buf, len)) {
262 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
264 struct hidraw_list *list = file->private_data;
265 unsigned int mask = POLLOUT | POLLWRNORM; /* hidraw is always writable */
267 poll_wait(file, &list->hidraw->wait, wait);
268 if (list->head != list->tail)
269 mask |= POLLIN | POLLRDNORM;
270 if (!list->hidraw->exist)
271 mask |= POLLERR | POLLHUP;
275 static int hidraw_open(struct inode *inode, struct file *file)
277 unsigned int minor = iminor(inode);
279 struct hidraw_list *list;
283 if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
288 mutex_lock(&minors_lock);
289 if (!hidraw_table[minor] || !hidraw_table[minor]->exist) {
294 dev = hidraw_table[minor];
296 err = hid_hw_power(dev->hid, PM_HINT_FULLON);
302 err = hid_hw_open(dev->hid);
304 hid_hw_power(dev->hid, PM_HINT_NORMAL);
310 list->hidraw = hidraw_table[minor];
311 mutex_init(&list->read_mutex);
312 spin_lock_irqsave(&hidraw_table[minor]->list_lock, flags);
313 list_add_tail(&list->node, &hidraw_table[minor]->list);
314 spin_unlock_irqrestore(&hidraw_table[minor]->list_lock, flags);
315 file->private_data = list;
317 mutex_unlock(&minors_lock);
325 static int hidraw_fasync(int fd, struct file *file, int on)
327 struct hidraw_list *list = file->private_data;
329 return fasync_helper(fd, file, on, &list->fasync);
332 static void drop_ref(struct hidraw *hidraw, int exists_bit)
337 hid_hw_close(hidraw->hid);
338 wake_up_interruptible(&hidraw->wait);
340 device_destroy(hidraw_class,
341 MKDEV(hidraw_major, hidraw->minor));
346 if (!hidraw->exist) {
347 hidraw_table[hidraw->minor] = NULL;
350 /* close device for last reader */
351 hid_hw_power(hidraw->hid, PM_HINT_NORMAL);
352 hid_hw_close(hidraw->hid);
357 static int hidraw_release(struct inode * inode, struct file * file)
359 unsigned int minor = iminor(inode);
360 struct hidraw_list *list = file->private_data;
363 mutex_lock(&minors_lock);
365 spin_lock_irqsave(&hidraw_table[minor]->list_lock, flags);
366 list_del(&list->node);
367 spin_unlock_irqrestore(&hidraw_table[minor]->list_lock, flags);
370 drop_ref(hidraw_table[minor], 0);
372 mutex_unlock(&minors_lock);
376 static long hidraw_ioctl(struct file *file, unsigned int cmd,
379 struct inode *inode = file_inode(file);
380 unsigned int minor = iminor(inode);
383 void __user *user_arg = (void __user*) arg;
385 mutex_lock(&minors_lock);
386 dev = hidraw_table[minor];
387 if (!dev || !dev->exist) {
393 case HIDIOCGRDESCSIZE:
394 if (put_user(dev->hid->rsize, (int __user *)arg))
402 if (get_user(len, (int __user *)arg))
404 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
406 else if (copy_to_user(user_arg + offsetof(
407 struct hidraw_report_descriptor,
410 min(dev->hid->rsize, len)))
416 struct hidraw_devinfo dinfo;
418 dinfo.bustype = dev->hid->bus;
419 dinfo.vendor = dev->hid->vendor;
420 dinfo.product = dev->hid->product;
421 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
427 struct hid_device *hid = dev->hid;
428 if (_IOC_TYPE(cmd) != 'H') {
433 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCSFEATURE(0))) {
434 int len = _IOC_SIZE(cmd);
435 ret = hidraw_send_report(file, user_arg, len, HID_FEATURE_REPORT);
438 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGFEATURE(0))) {
439 int len = _IOC_SIZE(cmd);
440 ret = hidraw_get_report(file, user_arg, len, HID_FEATURE_REPORT);
444 /* Begin Read-only ioctls. */
445 if (_IOC_DIR(cmd) != _IOC_READ) {
450 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWNAME(0))) {
451 int len = strlen(hid->name) + 1;
452 if (len > _IOC_SIZE(cmd))
453 len = _IOC_SIZE(cmd);
454 ret = copy_to_user(user_arg, hid->name, len) ?
459 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWPHYS(0))) {
460 int len = strlen(hid->phys) + 1;
461 if (len > _IOC_SIZE(cmd))
462 len = _IOC_SIZE(cmd);
463 ret = copy_to_user(user_arg, hid->phys, len) ?
472 mutex_unlock(&minors_lock);
476 static const struct file_operations hidraw_ops = {
477 .owner = THIS_MODULE,
479 .write = hidraw_write,
482 .release = hidraw_release,
483 .unlocked_ioctl = hidraw_ioctl,
484 .fasync = hidraw_fasync,
486 .compat_ioctl = hidraw_ioctl,
488 .llseek = noop_llseek,
491 int hidraw_report_event(struct hid_device *hid, u8 *data, int len)
493 struct hidraw *dev = hid->hidraw;
494 struct hidraw_list *list;
498 spin_lock_irqsave(&dev->list_lock, flags);
499 list_for_each_entry(list, &dev->list, node) {
500 int new_head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
502 if (new_head == list->tail)
505 if (!(list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC))) {
509 list->buffer[list->head].len = len;
510 list->head = new_head;
511 kill_fasync(&list->fasync, SIGIO, POLL_IN);
513 spin_unlock_irqrestore(&dev->list_lock, flags);
515 wake_up_interruptible(&dev->wait);
518 EXPORT_SYMBOL_GPL(hidraw_report_event);
520 int hidraw_connect(struct hid_device *hid)
525 /* we accept any HID device, all applications */
527 dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
533 mutex_lock(&minors_lock);
535 for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
536 if (hidraw_table[minor])
538 hidraw_table[minor] = dev;
544 mutex_unlock(&minors_lock);
549 dev->dev = device_create(hidraw_class, &hid->dev, MKDEV(hidraw_major, minor),
550 NULL, "%s%d", "hidraw", minor);
552 if (IS_ERR(dev->dev)) {
553 hidraw_table[minor] = NULL;
554 mutex_unlock(&minors_lock);
555 result = PTR_ERR(dev->dev);
560 init_waitqueue_head(&dev->wait);
561 spin_lock_init(&dev->list_lock);
562 INIT_LIST_HEAD(&dev->list);
570 mutex_unlock(&minors_lock);
575 EXPORT_SYMBOL_GPL(hidraw_connect);
577 void hidraw_disconnect(struct hid_device *hid)
579 struct hidraw *hidraw = hid->hidraw;
581 mutex_lock(&minors_lock);
585 mutex_unlock(&minors_lock);
587 EXPORT_SYMBOL_GPL(hidraw_disconnect);
589 int __init hidraw_init(void)
594 result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
595 HIDRAW_MAX_DEVICES, "hidraw");
597 hidraw_major = MAJOR(dev_id);
600 pr_warn("can't get major number\n");
604 hidraw_class = class_create(THIS_MODULE, "hidraw");
605 if (IS_ERR(hidraw_class)) {
606 result = PTR_ERR(hidraw_class);
610 cdev_init(&hidraw_cdev, &hidraw_ops);
611 result = cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
615 printk(KERN_INFO "hidraw: raw HID events driver (C) Jiri Kosina\n");
620 class_destroy(hidraw_class);
622 unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);
626 void hidraw_exit(void)
628 dev_t dev_id = MKDEV(hidraw_major, 0);
630 cdev_del(&hidraw_cdev);
631 class_destroy(hidraw_class);
632 unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);