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)
230 struct hiddev_list *list = file->private_data;
232 return fasync_helper(fd, file, on, &list->fasync);
239 static int hiddev_release(struct inode * inode, struct file * file)
241 struct hiddev_list *list = file->private_data;
244 spin_lock_irqsave(&list->hiddev->list_lock, flags);
245 list_del(&list->node);
246 spin_unlock_irqrestore(&list->hiddev->list_lock, flags);
248 if (!--list->hiddev->open) {
249 if (list->hiddev->exist)
250 usbhid_close(list->hiddev->hid);
263 static int hiddev_open(struct inode *inode, struct file *file)
265 struct hiddev_list *list;
268 int i = iminor(inode) - HIDDEV_MINOR_BASE;
270 if (i >= HIDDEV_MINORS || i < 0 || !hiddev_table[i])
273 if (!(list = kzalloc(sizeof(struct hiddev_list), GFP_KERNEL)))
275 mutex_init(&list->thread_lock);
277 list->hiddev = hiddev_table[i];
280 file->private_data = list;
283 * no need for locking because the USB major number
284 * is shared which usbcore guards against disconnect
286 if (list->hiddev->exist) {
287 if (!list->hiddev->open++) {
288 res = usbhid_open(hiddev_table[i]->hid);
299 spin_lock_irq(&list->hiddev->list_lock);
300 list_add_tail(&list->node, &hiddev_table[i]->list);
301 spin_unlock_irq(&list->hiddev->list_lock);
305 file->private_data = NULL;
313 static ssize_t hiddev_write(struct file * file, const char __user * buffer, size_t count, loff_t *ppos)
321 static ssize_t hiddev_read(struct file * file, char __user * buffer, size_t count, loff_t *ppos)
323 DECLARE_WAITQUEUE(wait, current);
324 struct hiddev_list *list = file->private_data;
328 event_size = ((list->flags & HIDDEV_FLAG_UREF) != 0) ?
329 sizeof(struct hiddev_usage_ref) : sizeof(struct hiddev_event);
331 if (count < event_size)
334 /* lock against other threads */
335 retval = mutex_lock_interruptible(&list->thread_lock);
339 while (retval == 0) {
340 if (list->head == list->tail) {
341 prepare_to_wait(&list->hiddev->wait, &wait, TASK_INTERRUPTIBLE);
343 while (list->head == list->tail) {
344 if (file->f_flags & O_NONBLOCK) {
348 if (signal_pending(current)) {
349 retval = -ERESTARTSYS;
352 if (!list->hiddev->exist) {
357 /* let O_NONBLOCK tasks run */
358 mutex_unlock(&list->thread_lock);
360 if (mutex_lock_interruptible(&list->thread_lock))
362 set_current_state(TASK_INTERRUPTIBLE);
364 finish_wait(&list->hiddev->wait, &wait);
369 mutex_unlock(&list->thread_lock);
374 while (list->head != list->tail &&
375 retval + event_size <= count) {
376 if ((list->flags & HIDDEV_FLAG_UREF) == 0) {
377 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE) {
378 struct hiddev_event event;
380 event.hid = list->buffer[list->tail].usage_code;
381 event.value = list->buffer[list->tail].value;
382 if (copy_to_user(buffer + retval, &event, sizeof(struct hiddev_event))) {
383 mutex_unlock(&list->thread_lock);
386 retval += sizeof(struct hiddev_event);
389 if (list->buffer[list->tail].field_index != HID_FIELD_INDEX_NONE ||
390 (list->flags & HIDDEV_FLAG_REPORT) != 0) {
392 if (copy_to_user(buffer + retval, list->buffer + list->tail, sizeof(struct hiddev_usage_ref))) {
393 mutex_unlock(&list->thread_lock);
396 retval += sizeof(struct hiddev_usage_ref);
399 list->tail = (list->tail + 1) & (HIDDEV_BUFFER_SIZE - 1);
403 mutex_unlock(&list->thread_lock);
410 * No kernel lock - fine
412 static unsigned int hiddev_poll(struct file *file, poll_table *wait)
414 struct hiddev_list *list = file->private_data;
416 poll_wait(file, &list->hiddev->wait, wait);
417 if (list->head != list->tail)
418 return POLLIN | POLLRDNORM;
419 if (!list->hiddev->exist)
420 return POLLERR | POLLHUP;
427 static noinline int hiddev_ioctl_usage(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
429 struct hid_device *hid = hiddev->hid;
430 struct hiddev_report_info rinfo;
431 struct hiddev_usage_ref_multi *uref_multi = NULL;
432 struct hiddev_usage_ref *uref;
433 struct hid_report *report;
434 struct hid_field *field;
437 uref_multi = kmalloc(sizeof(struct hiddev_usage_ref_multi), GFP_KERNEL);
441 uref = &uref_multi->uref;
442 if (cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) {
443 if (copy_from_user(uref_multi, user_arg,
444 sizeof(*uref_multi)))
447 if (copy_from_user(uref, user_arg, sizeof(*uref)))
453 rinfo.report_type = uref->report_type;
454 rinfo.report_id = uref->report_id;
455 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
458 if (uref->field_index >= report->maxfield)
461 field = report->field[uref->field_index];
462 if (uref->usage_index >= field->maxusage)
465 uref->usage_code = field->usage[uref->usage_index].hid;
467 if (copy_to_user(user_arg, uref, sizeof(*uref)))
473 if (cmd != HIDIOCGUSAGE &&
474 cmd != HIDIOCGUSAGES &&
475 uref->report_type == HID_REPORT_TYPE_INPUT)
478 if (uref->report_id == HID_REPORT_ID_UNKNOWN) {
479 field = hiddev_lookup_usage(hid, uref);
483 rinfo.report_type = uref->report_type;
484 rinfo.report_id = uref->report_id;
485 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
488 if (uref->field_index >= report->maxfield)
491 field = report->field[uref->field_index];
493 if (cmd == HIDIOCGCOLLECTIONINDEX) {
494 if (uref->usage_index >= field->maxusage)
496 } else if (uref->usage_index >= field->report_count)
499 else if ((cmd == HIDIOCGUSAGES || cmd == HIDIOCSUSAGES) &&
500 (uref_multi->num_values > HID_MAX_MULTI_USAGES ||
501 uref->usage_index + uref_multi->num_values > field->report_count))
507 uref->value = field->value[uref->usage_index];
508 if (copy_to_user(user_arg, uref, sizeof(*uref)))
513 field->value[uref->usage_index] = uref->value;
516 case HIDIOCGCOLLECTIONINDEX:
518 return field->usage[uref->usage_index].collection_index;
520 for (i = 0; i < uref_multi->num_values; i++)
521 uref_multi->values[i] =
522 field->value[uref->usage_index + i];
523 if (copy_to_user(user_arg, uref_multi,
524 sizeof(*uref_multi)))
528 for (i = 0; i < uref_multi->num_values; i++)
529 field->value[uref->usage_index + i] =
530 uref_multi->values[i];
549 static noinline int hiddev_ioctl_string(struct hiddev *hiddev, unsigned int cmd, void __user *user_arg)
551 struct hid_device *hid = hiddev->hid;
552 struct usb_device *dev = hid_to_usb_dev(hid);
556 if (get_user(idx, (int __user *)user_arg))
559 if ((buf = kmalloc(HID_STRING_SIZE, GFP_KERNEL)) == NULL)
562 if ((len = usb_string(dev, idx, buf, HID_STRING_SIZE-1)) < 0) {
567 if (copy_to_user(user_arg+sizeof(int), buf, len+1)) {
577 static long hiddev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
579 struct hiddev_list *list = file->private_data;
580 struct hiddev *hiddev = list->hiddev;
581 struct hid_device *hid = hiddev->hid;
582 struct usb_device *dev = hid_to_usb_dev(hid);
583 struct hiddev_collection_info cinfo;
584 struct hiddev_report_info rinfo;
585 struct hiddev_field_info finfo;
586 struct hiddev_devinfo dinfo;
587 struct hid_report *report;
588 struct hid_field *field;
589 struct usbhid_device *usbhid = hid->driver_data;
590 void __user *user_arg = (void __user *)arg;
593 /* Called without BKL by compat methods so no BKL taken */
595 /* FIXME: Who or what stop this racing with a disconnect ?? */
602 return put_user(HID_VERSION, (int __user *)arg);
604 case HIDIOCAPPLICATION:
605 if (arg < 0 || arg >= hid->maxapplication)
608 for (i = 0; i < hid->maxcollection; i++)
609 if (hid->collection[i].type ==
610 HID_COLLECTION_APPLICATION && arg-- == 0)
613 if (i == hid->maxcollection)
616 return hid->collection[i].usage;
619 dinfo.bustype = BUS_USB;
620 dinfo.busnum = dev->bus->busnum;
621 dinfo.devnum = dev->devnum;
622 dinfo.ifnum = usbhid->ifnum;
623 dinfo.vendor = le16_to_cpu(dev->descriptor.idVendor);
624 dinfo.product = le16_to_cpu(dev->descriptor.idProduct);
625 dinfo.version = le16_to_cpu(dev->descriptor.bcdDevice);
626 dinfo.num_applications = hid->maxapplication;
627 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
633 if (put_user(list->flags, (int __user *)arg))
641 if (get_user(newflags, (int __user *)arg))
644 if ((newflags & ~HIDDEV_FLAGS) != 0 ||
645 ((newflags & HIDDEV_FLAG_REPORT) != 0 &&
646 (newflags & HIDDEV_FLAG_UREF) == 0))
649 list->flags = newflags;
655 mutex_lock(&hiddev->existancelock);
657 r = hiddev_ioctl_string(hiddev, cmd, user_arg);
660 mutex_unlock(&hiddev->existancelock);
663 case HIDIOCINITREPORT:
664 mutex_lock(&hiddev->existancelock);
665 if (!hiddev->exist) {
666 mutex_unlock(&hiddev->existancelock);
669 usbhid_init_reports(hid);
670 mutex_unlock(&hiddev->existancelock);
675 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
678 if (rinfo.report_type == HID_REPORT_TYPE_OUTPUT)
681 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
684 mutex_lock(&hiddev->existancelock);
686 usbhid_submit_report(hid, report, USB_DIR_IN);
689 mutex_unlock(&hiddev->existancelock);
694 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
697 if (rinfo.report_type == HID_REPORT_TYPE_INPUT)
700 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
703 mutex_lock(&hiddev->existancelock);
705 usbhid_submit_report(hid, report, USB_DIR_OUT);
708 mutex_unlock(&hiddev->existancelock);
712 case HIDIOCGREPORTINFO:
713 if (copy_from_user(&rinfo, user_arg, sizeof(rinfo)))
716 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
719 rinfo.num_fields = report->maxfield;
721 if (copy_to_user(user_arg, &rinfo, sizeof(rinfo)))
726 case HIDIOCGFIELDINFO:
727 if (copy_from_user(&finfo, user_arg, sizeof(finfo)))
729 rinfo.report_type = finfo.report_type;
730 rinfo.report_id = finfo.report_id;
731 if ((report = hiddev_lookup_report(hid, &rinfo)) == NULL)
734 if (finfo.field_index >= report->maxfield)
737 field = report->field[finfo.field_index];
738 memset(&finfo, 0, sizeof(finfo));
739 finfo.report_type = rinfo.report_type;
740 finfo.report_id = rinfo.report_id;
741 finfo.field_index = field->report_count - 1;
742 finfo.maxusage = field->maxusage;
743 finfo.flags = field->flags;
744 finfo.physical = field->physical;
745 finfo.logical = field->logical;
746 finfo.application = field->application;
747 finfo.logical_minimum = field->logical_minimum;
748 finfo.logical_maximum = field->logical_maximum;
749 finfo.physical_minimum = field->physical_minimum;
750 finfo.physical_maximum = field->physical_maximum;
751 finfo.unit_exponent = field->unit_exponent;
752 finfo.unit = field->unit;
754 if (copy_to_user(user_arg, &finfo, sizeof(finfo)))
765 case HIDIOCGCOLLECTIONINDEX:
766 mutex_lock(&hiddev->existancelock);
768 r = hiddev_ioctl_usage(hiddev, cmd, user_arg);
771 mutex_unlock(&hiddev->existancelock);
774 case HIDIOCGCOLLECTIONINFO:
775 if (copy_from_user(&cinfo, user_arg, sizeof(cinfo)))
778 if (cinfo.index >= hid->maxcollection)
781 cinfo.type = hid->collection[cinfo.index].type;
782 cinfo.usage = hid->collection[cinfo.index].usage;
783 cinfo.level = hid->collection[cinfo.index].level;
785 if (copy_to_user(user_arg, &cinfo, sizeof(cinfo)))
791 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ)
794 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGNAME(0))) {
798 len = strlen(hid->name) + 1;
799 if (len > _IOC_SIZE(cmd))
800 len = _IOC_SIZE(cmd);
801 return copy_to_user(user_arg, hid->name, len) ?
805 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGPHYS(0))) {
809 len = strlen(hid->phys) + 1;
810 if (len > _IOC_SIZE(cmd))
811 len = _IOC_SIZE(cmd);
812 return copy_to_user(user_arg, hid->phys, len) ?
820 static long hiddev_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
822 return hiddev_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
826 static const struct file_operations hiddev_fops = {
827 .owner = THIS_MODULE,
829 .write = hiddev_write,
832 .release = hiddev_release,
833 .unlocked_ioctl = hiddev_ioctl,
834 .fasync = hiddev_fasync,
836 .compat_ioctl = hiddev_compat_ioctl,
840 static struct usb_class_driver hiddev_class = {
842 .fops = &hiddev_fops,
843 .minor_base = HIDDEV_MINOR_BASE,
847 * This is where hid.c calls us to connect a hid device to the hiddev driver
849 int hiddev_connect(struct hid_device *hid, unsigned int force)
851 struct hiddev *hiddev;
852 struct usbhid_device *usbhid = hid->driver_data;
857 for (i = 0; i < hid->maxcollection; i++)
858 if (hid->collection[i].type ==
859 HID_COLLECTION_APPLICATION &&
860 !IS_INPUT_APPLICATION(hid->collection[i].usage))
863 if (i == hid->maxcollection)
867 if (!(hiddev = kzalloc(sizeof(struct hiddev), GFP_KERNEL)))
870 init_waitqueue_head(&hiddev->wait);
871 INIT_LIST_HEAD(&hiddev->list);
872 spin_lock_init(&hiddev->list_lock);
873 mutex_init(&hiddev->existancelock);
874 hid->hiddev = hiddev;
878 retval = usb_register_dev(usbhid->intf, &hiddev_class);
880 err_hid("Not able to get a minor for this device.");
885 hid->minor = usbhid->intf->minor;
886 hiddev_table[usbhid->intf->minor - HIDDEV_MINOR_BASE] = hiddev;
893 * This is where hid.c calls us to disconnect a hiddev device from the
894 * corresponding hid device (usually because the usb device has disconnected)
896 static struct usb_class_driver hiddev_class;
897 void hiddev_disconnect(struct hid_device *hid)
899 struct hiddev *hiddev = hid->hiddev;
900 struct usbhid_device *usbhid = hid->driver_data;
902 mutex_lock(&hiddev->existancelock);
904 mutex_unlock(&hiddev->existancelock);
906 hiddev_table[hiddev->hid->minor - HIDDEV_MINOR_BASE] = NULL;
907 usb_deregister_dev(usbhid->intf, &hiddev_class);
910 usbhid_close(hiddev->hid);
911 wake_up_interruptible(&hiddev->wait);
917 /* Currently this driver is a USB driver. It's not a conventional one in
918 * the sense that it doesn't probe at the USB level. Instead it waits to
919 * be connected by HID through the hiddev_connect / hiddev_disconnect
920 * routines. The reason to register as a USB device is to gain part of the
921 * minor number space from the USB major.
923 * In theory, should the HID code be generalized to more than one physical
924 * medium (say, IEEE 1384), this driver will probably need to register its
925 * own major number, and in doing so, no longer need to register with USB.
926 * At that point the probe routine and hiddev_driver struct below will no
931 /* We never attach in this manner, and rely on HID to connect us. This
932 * is why there is no disconnect routine defined in the usb_driver either.
934 static int hiddev_usbd_probe(struct usb_interface *intf,
935 const struct usb_device_id *hiddev_info)
941 static /* const */ struct usb_driver hiddev_driver = {
943 .probe = hiddev_usbd_probe,
946 int __init hiddev_init(void)
948 return usb_register(&hiddev_driver);
951 void hiddev_exit(void)
953 usb_deregister(&hiddev_driver);