2 * Copyright (c) 2001 Paul Stewart
3 * Copyright (c) 2001 Vojtech Pavlik
5 * HID char devices, giving access to raw HID device events.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Should you need to contact me, the author, you can do so either by
25 * e-mail - mail your message to Paul Stewart <stewart@wetlogic.net>
28 #include <linux/poll.h>
29 #include <linux/slab.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/smp_lock.h>
33 #include <linux/input.h>
34 #include <linux/usb.h>
35 #include <linux/hid.h>
36 #include <linux/hiddev.h>
37 #include <linux/compat.h>
40 #ifdef CONFIG_USB_DYNAMIC_MINORS
41 #define HIDDEV_MINOR_BASE 0
42 #define HIDDEV_MINORS 256
44 #define HIDDEV_MINOR_BASE 96
45 #define HIDDEV_MINORS 16
47 #define HIDDEV_BUFFER_SIZE 64
52 struct mutex existancelock;
53 wait_queue_head_t wait;
54 struct hid_device *hid;
55 struct list_head list;
60 struct hiddev_usage_ref buffer[HIDDEV_BUFFER_SIZE];
64 struct fasync_struct *fasync;
65 struct hiddev *hiddev;
66 struct list_head node;
67 struct mutex thread_lock;
70 static struct hiddev *hiddev_table[HIDDEV_MINORS];
73 * Find a report, given the report's type and ID. The ID can be specified
74 * indirectly by REPORT_ID_FIRST (which returns the first report of the given
75 * type) or by (REPORT_ID_NEXT | old_id), which returns the next report of the
76 * given type which follows old_id.
78 static struct hid_report *
79 hiddev_lookup_report(struct hid_device *hid, struct hiddev_report_info *rinfo)
81 unsigned int flags = rinfo->report_id & ~HID_REPORT_ID_MASK;
82 unsigned int rid = rinfo->report_id & HID_REPORT_ID_MASK;
83 struct hid_report_enum *report_enum;
84 struct hid_report *report;
85 struct list_head *list;
87 if (rinfo->report_type < HID_REPORT_TYPE_MIN ||
88 rinfo->report_type > HID_REPORT_TYPE_MAX)
91 report_enum = hid->report_enum +
92 (rinfo->report_type - HID_REPORT_TYPE_MIN);
95 case 0: /* Nothing to do -- report_id is already set correctly */
98 case HID_REPORT_ID_FIRST:
99 if (list_empty(&report_enum->report_list))
102 list = report_enum->report_list.next;
103 report = list_entry(list, struct hid_report, list);
104 rinfo->report_id = report->id;
107 case HID_REPORT_ID_NEXT:
108 report = report_enum->report_id_hash[rid];
112 list = report->list.next;
113 if (list == &report_enum->report_list)
116 report = list_entry(list, struct hid_report, list);
117 rinfo->report_id = report->id;
124 return report_enum->report_id_hash[rinfo->report_id];
128 * Perform an exhaustive search of the report table for a usage, given its
131 static struct hid_field *
132 hiddev_lookup_usage(struct hid_device *hid, struct hiddev_usage_ref *uref)
135 struct hid_report *report;
136 struct hid_report_enum *report_enum;
137 struct hid_field *field;
139 if (uref->report_type < HID_REPORT_TYPE_MIN ||
140 uref->report_type > HID_REPORT_TYPE_MAX)
143 report_enum = hid->report_enum +
144 (uref->report_type - HID_REPORT_TYPE_MIN);
146 list_for_each_entry(report, &report_enum->report_list, list) {
147 for (i = 0; i < report->maxfield; i++) {
148 field = report->field[i];
149 for (j = 0; j < field->maxusage; j++) {
150 if (field->usage[j].hid == uref->usage_code) {
151 uref->report_id = report->id;
152 uref->field_index = i;
153 uref->usage_index = j;
163 static void hiddev_send_event(struct hid_device *hid,
164 struct hiddev_usage_ref *uref)
166 struct hiddev *hiddev = hid->hiddev;
167 struct hiddev_list *list;
170 spin_lock_irqsave(&hiddev->list_lock, flags);
171 list_for_each_entry(list, &hiddev->list, node) {
172 if (uref->field_index != HID_FIELD_INDEX_NONE ||
173 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
174 list->buffer[list->head] = *uref;
175 list->head = (list->head + 1) &
176 (HIDDEV_BUFFER_SIZE - 1);
177 kill_fasync(&list->fasync, SIGIO, POLL_IN);
180 spin_unlock_irqrestore(&hiddev->list_lock, flags);
182 wake_up_interruptible(&hiddev->wait);
186 * This is where hid.c calls into hiddev to pass an event that occurred over
189 void hiddev_hid_event(struct hid_device *hid, struct hid_field *field,
190 struct hid_usage *usage, __s32 value)
192 unsigned type = field->report_type;
193 struct hiddev_usage_ref uref;
196 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
197 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
198 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
199 uref.report_id = field->report->id;
200 uref.field_index = field->index;
201 uref.usage_index = (usage - field->usage);
202 uref.usage_code = usage->hid;
205 hiddev_send_event(hid, &uref);
207 EXPORT_SYMBOL_GPL(hiddev_hid_event);
209 void hiddev_report_event(struct hid_device *hid, struct hid_report *report)
211 unsigned type = report->type;
212 struct hiddev_usage_ref uref;
214 memset(&uref, 0, sizeof(uref));
216 (type == HID_INPUT_REPORT) ? HID_REPORT_TYPE_INPUT :
217 ((type == HID_OUTPUT_REPORT) ? HID_REPORT_TYPE_OUTPUT :
218 ((type == HID_FEATURE_REPORT) ? HID_REPORT_TYPE_FEATURE : 0));
219 uref.report_id = report->id;
220 uref.field_index = HID_FIELD_INDEX_NONE;
222 hiddev_send_event(hid, &uref);
228 static int hiddev_fasync(int fd, struct file *file, int on)
231 struct hiddev_list *list = file->private_data;
233 retval = fasync_helper(fd, file, on, &list->fasync);
235 return retval < 0 ? retval : 0;
242 static int hiddev_release(struct inode * inode, struct file * file)
244 struct hiddev_list *list = file->private_data;
247 spin_lock_irqsave(&list->hiddev->list_lock, flags);
248 list_del(&list->node);
249 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
251 if (!--list->hiddev->open) {
252 if (list->hiddev->exist)
253 usbhid_close(list->hiddev->hid);
266 static int hiddev_open(struct inode *inode, struct file *file)
268 struct hiddev_list *list;
271 int i = iminor(inode) - HIDDEV_MINOR_BASE;
273 if (i >= HIDDEV_MINORS || i < 0 || !hiddev_table[i])
276 if (!(list = kzalloc(sizeof(struct hiddev_list), GFP_KERNEL)))
278 mutex_init(&list->thread_lock);
280 list->hiddev = hiddev_table[i];
283 file->private_data = list;
286 * no need for locking because the USB major number
287 * is shared which usbcore guards against disconnect
289 if (list->hiddev->exist) {
290 if (!list->hiddev->open++) {
291 res = usbhid_open(hiddev_table[i]->hid);
302 spin_lock_irq(&list->hiddev->list_lock);
303 list_add_tail(&list->node, &hiddev_table[i]->list);
304 spin_unlock_irq(&list->hiddev->list_lock);
308 file->private_data = NULL;
316 static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
324 static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
326 DECLARE_WAITQUEUE(wait, current);
327 struct hiddev_list *list = file->private_data;
331 event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
332 sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);
334 if (count < event_size)
337 /* lock against other threads */
338 retval = mutex_lock_interruptible(&list->thread_lock);
342 while (retval == 0) {
343 if (list->head == list->tail) {
344 prepare_to_wait(&list->hiddev->wait, &wait, TASK_INTERRUPTIBLE);
346 while (list->head == list->tail) {
347 if (file->f_flags & O_NONBLOCK) {
351 if (signal_pending(current)) {
352 retval = -ERESTARTSYS;
355 if (!list->hiddev->exist) {
360 /* let O_NONBLOCK tasks run */
361 mutex_unlock(&list->thread_lock);
363 if (mutex_lock_interruptible(&list->thread_lock))
365 set_current_state(TASK_INTERRUPTIBLE);
367 finish_wait(&list->hiddev->wait, &wait);
372 mutex_unlock(&list->thread_lock);
377 while (list->head != list->tail &&
378 retval + event_size <= count) {
379 if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
380 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE) {
381 struct hiddev_event event;
383 event.hid = list->buffer[list->tail].usage_code;
384 event.value = list->buffer[list->tail].value;
385 if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event))) {
386 mutex_unlock(&list->thread_lock);
389 retval += sizeof(struct hiddev_event);
392 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
393 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
395 if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref))) {
396 mutex_unlock(&list->thread_lock);
399 retval += sizeof(struct hiddev_usage_ref);
402 list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
406 mutex_unlock(&list->thread_lock);
413 * No kernel lock - fine
415 static unsigned int hiddev_poll(struct file *file, poll_table *wait)
417 struct hiddev_list *list = file->private_data;
419 poll_wait(file, &list->hiddev->wait, wait);
420 if (list->head != list->tail)
421 return POLLIN | POLLRDNORM;
422 if (!list->hiddev->exist)
423 return POLLERR | POLLHUP;
430 static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
432 struct hid_device *hid = hiddev->hid;
433 struct hiddev_report_info rinfo;
434 struct hiddev_usage_ref_multi *uref_multi = NULL;
435 struct hiddev_usage_ref *uref;
436 struct hid_report *report;
437 struct hid_field *field;
440 uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
444 uref = &uref_multi->uref;
445 if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
446 if (copy_from_user(uref_multi, user_arg,
447 sizeof(*uref_multi)))
450 if (copy_from_user(uref, user_arg, sizeof(*uref)))
456 rinfo.report_type = uref->report_type;
457 rinfo.report_id = uref->report_id;
458 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
461 if (uref->field_index >= report->maxfield)
464 field = report->field[uref->field_index];
465 if (uref->usage_index >= field->maxusage)
468 uref->usage_code = field->usage[uref->usage_index].hid;
470 if (copy_to_user(user_arg, uref, sizeof(*uref)))
476 if (cmd != HIDIOCGUSAGE &&
477 cmd != HIDIOCGUSAGES &&
478 uref->report_type == HID_REPORT_TYPE_INPUT)
481 if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
482 field = hiddev_lookup_usage(hid, uref);
486 rinfo.report_type = uref->report_type;
487 rinfo.report_id = uref->report_id;
488 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
491 if (uref->field_index >= report->maxfield)
494 field = report->field[uref->field_index];
496 if (cmd == HIDIOCGCOLLECTIONINDEX) {
497 if (uref->usage_index >= field->maxusage)
499 } else if (uref->usage_index >= field->report_count)
502 else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
503 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
504 uref->usage_index + uref_multi->num_values > field->report_count))
510 uref->value = field->value[uref->usage_index];
511 if (copy_to_user(user_arg, uref, sizeof(*uref)))
516 field->value[uref->usage_index] = uref->value;
519 case HIDIOCGCOLLECTIONINDEX:
521 return field->usage[uref->usage_index].collection_index;
523 for (i = 0; i < uref_multi->num_values; i++)
524 uref_multi->values[i] =
525 field->value[uref->usage_index + i];
526 if (copy_to_user(user_arg, uref_multi,
527 sizeof(*uref_multi)))
531 for (i = 0; i < uref_multi->num_values; i++)
532 field->value[uref->usage_index + i] =
533 uref_multi->values[i];
552 static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
554 struct hid_device *hid = hiddev->hid;
555 struct usb_device *dev = hid_to_usb_dev(hid);
559 if (get_user(idx, (int __user *)user_arg))
562 if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
565 if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
570 if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
580 static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
582 struct hiddev_list *list = file->private_data;
583 struct hiddev *hiddev = list->hiddev;
584 struct hid_device *hid = hiddev->hid;
585 struct usb_device *dev = hid_to_usb_dev(hid);
586 struct hiddev_collection_info cinfo;
587 struct hiddev_report_info rinfo;
588 struct hiddev_field_info finfo;
589 struct hiddev_devinfo dinfo;
590 struct hid_report *report;
591 struct hid_field *field;
592 struct usbhid_device *usbhid = hid->driver_data;
593 void __user *user_arg = (void __user *)arg;
596 /* Called without BKL by compat methods so no BKL taken */
598 /* FIXME: Who or what stop this racing with a disconnect ?? */
605 return put_user(HID_VERSION, (int __user *)arg);
607 case HIDIOCAPPLICATION:
608 if (arg < 0 || arg >= hid->maxapplication)
611 for (i = 0; i < hid->maxcollection; i++)
612 if (hid->collection[i].type ==
613 HID_COLLECTION_APPLICATION && arg-- == 0)
616 if (i == hid->maxcollection)
619 return hid->collection[i].usage;
622 dinfo.bustype = BUS_USB;
623 dinfo.busnum = dev->bus->busnum;
624 dinfo.devnum = dev->devnum;
625 dinfo.ifnum = usbhid->ifnum;
626 dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
627 dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
628 dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
629 dinfo.num_applications = hid->maxapplication;
630 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
636 if (put_user(list->flags, (int __user *)arg))
644 if (get_user(newflags, (int __user *)arg))
647 if ((newflags & ~HIDDEV_FLAGS) != 0 ||
648 ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
649 (newflags & HIDDEV_FLAG_UREF) == 0))
652 list->flags = newflags;
658 mutex_lock(&hiddev->existancelock);
660 r = hiddev_ioctl_string(hiddev, cmd, user_arg);
663 mutex_unlock(&hiddev->existancelock);
666 case HIDIOCINITREPORT:
667 mutex_lock(&hiddev->existancelock);
668 if (!hiddev->exist) {
669 mutex_unlock(&hiddev->existancelock);
672 usbhid_init_reports(hid);
673 mutex_unlock(&hiddev->existancelock);
678 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
681 if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
684 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
687 mutex_lock(&hiddev->existancelock);
689 usbhid_submit_report(hid, report, USB_DIR_IN);
692 mutex_unlock(&hiddev->existancelock);
697 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
700 if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
703 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
706 mutex_lock(&hiddev->existancelock);
708 usbhid_submit_report(hid, report, USB_DIR_OUT);
711 mutex_unlock(&hiddev->existancelock);
715 case HIDIOCGREPORTINFO:
716 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
719 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
722 rinfo.num_fields = report->maxfield;
724 if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
729 case HIDIOCGFIELDINFO:
730 if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
732 rinfo.report_type = finfo.report_type;
733 rinfo.report_id = finfo.report_id;
734 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
737 if (finfo.field_index >= report->maxfield)
740 field = report->field[finfo.field_index];
741 memset(&finfo, 0, sizeof(finfo));
742 finfo.report_type = rinfo.report_type;
743 finfo.report_id = rinfo.report_id;
744 finfo.field_index = field->report_count - 1;
745 finfo.maxusage = field->maxusage;
746 finfo.flags = field->flags;
747 finfo.physical = field->physical;
748 finfo.logical = field->logical;
749 finfo.application = field->application;
750 finfo.logical_minimum = field->logical_minimum;
751 finfo.logical_maximum = field->logical_maximum;
752 finfo.physical_minimum = field->physical_minimum;
753 finfo.physical_maximum = field->physical_maximum;
754 finfo.unit_exponent = field->unit_exponent;
755 finfo.unit = field->unit;
757 if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
768 case HIDIOCGCOLLECTIONINDEX:
769 mutex_lock(&hiddev->existancelock);
771 r = hiddev_ioctl_usage(hiddev, cmd, user_arg);
774 mutex_unlock(&hiddev->existancelock);
777 case HIDIOCGCOLLECTIONINFO:
778 if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
781 if (cinfo.index >= hid->maxcollection)
784 cinfo.type = hid->collection[cinfo.index].type;
785 cinfo.usage = hid->collection[cinfo.index].usage;
786 cinfo.level = hid->collection[cinfo.index].level;
788 if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
794 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
797 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
801 len = strlen(hid->name) + 1;
802 if (len > _IOC_SIZE(cmd))
803 len = _IOC_SIZE(cmd);
804 return copy_to_user(user_arg, hid->name, len) ?
808 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
812 len = strlen(hid->phys) + 1;
813 if (len > _IOC_SIZE(cmd))
814 len = _IOC_SIZE(cmd);
815 return copy_to_user(user_arg, hid->phys, len) ?
823 static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
825 return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
829 static const struct file_operations hiddev_fops = {
830 .owner = THIS_MODULE,
832 .write = hiddev_write,
835 .release = hiddev_release,
836 .unlocked_ioctl = hiddev_ioctl,
837 .fasync = hiddev_fasync,
839 .compat_ioctl = hiddev_compat_ioctl,
843 static struct usb_class_driver hiddev_class = {
845 .fops = &hiddev_fops,
846 .minor_base = HIDDEV_MINOR_BASE,
850 * This is where hid.c calls us to connect a hid device to the hiddev driver
852 int hiddev_connect(struct hid_device *hid, unsigned int force)
854 struct hiddev *hiddev;
855 struct usbhid_device *usbhid = hid->driver_data;
860 for (i = 0; i < hid->maxcollection; i++)
861 if (hid->collection[i].type ==
862 HID_COLLECTION_APPLICATION &&
863 !IS_INPUT_APPLICATION(hid->collection[i].usage))
866 if (i == hid->maxcollection)
870 if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
873 init_waitqueue_head(&hiddev->wait);
874 INIT_LIST_HEAD(&hiddev->list);
875 spin_lock_init(&hiddev->list_lock);
876 mutex_init(&hiddev->existancelock);
880 retval = usb_register_dev(usbhid->intf, &hiddev_class);
882 err_hid("Not able to get a minor for this device.");
886 hid->minor = usbhid->intf->minor;
887 hiddev_table[usbhid->intf->minor - HIDDEV_MINOR_BASE] = hiddev;
894 * This is where hid.c calls us to disconnect a hiddev device from the
895 * corresponding hid device (usually because the usb device has disconnected)
897 static struct usb_class_driver hiddev_class;
898 void hiddev_disconnect(struct hid_device *hid)
900 struct hiddev *hiddev = hid->hiddev;
901 struct usbhid_device *usbhid = hid->driver_data;
903 mutex_lock(&hiddev->existancelock);
905 mutex_unlock(&hiddev->existancelock);
907 hiddev_table[hiddev->hid->minor - HIDDEV_MINOR_BASE] = NULL;
908 usb_deregister_dev(usbhid->intf, &hiddev_class);
911 usbhid_close(hiddev->hid);
912 wake_up_interruptible(&hiddev->wait);
918 /* Currently this driver is a USB driver. It's not a conventional one in
919 * the sense that it doesn't probe at the USB level. Instead it waits to
920 * be connected by HID through the hiddev_connect / hiddev_disconnect
921 * routines. The reason to register as a USB device is to gain part of the
922 * minor number space from the USB major.
924 * In theory, should the HID code be generalized to more than one physical
925 * medium (say, IEEE 1384), this driver will probably need to register its
926 * own major number, and in doing so, no longer need to register with USB.
927 * At that point the probe routine and hiddev_driver struct below will no
932 /* We never attach in this manner, and rely on HID to connect us. This
933 * is why there is no disconnect routine defined in the usb_driver either.
935 static int hiddev_usbd_probe(struct usb_interface *intf,
936 const struct usb_device_id *hiddev_info)
942 static /* const */ struct usb_driver hiddev_driver = {
944 .probe = hiddev_usbd_probe,
947 int __init hiddev_init(void)
949 return usb_register(&hiddev_driver);
952 void hiddev_exit(void)
954 usb_deregister(&hiddev_driver);