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/config.h>
29 #include <linux/poll.h>
30 #include <linux/slab.h>
31 #include <linux/module.h>
32 #include <linux/init.h>
33 #include <linux/smp_lock.h>
34 #include <linux/input.h>
35 #include <linux/usb.h>
37 #include <linux/hiddev.h>
38 #include <linux/devfs_fs_kernel.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 wait_queue_head_t wait
;
53 struct hid_device
*hid
;
54 struct hiddev_list
*list
;
58 struct hiddev_usage_ref buffer
[HIDDEV_BUFFER_SIZE
];
62 struct fasync_struct
*fasync
;
63 struct hiddev
*hiddev
;
64 struct hiddev_list
*next
;
67 static struct hiddev
*hiddev_table
[HIDDEV_MINORS
];
70 * Find a report, given the report's type and ID. The ID can be specified
71 * indirectly by REPORT_ID_FIRST (which returns the first report of the given
72 * type) or by (REPORT_ID_NEXT | old_id), which returns the next report of the
73 * given type which follows old_id.
75 static struct hid_report
*
76 hiddev_lookup_report(struct hid_device
*hid
, struct hiddev_report_info
*rinfo
)
78 unsigned flags
= rinfo
->report_id
& ~HID_REPORT_ID_MASK
;
79 struct hid_report_enum
*report_enum
;
80 struct list_head
*list
;
82 if (rinfo
->report_type
< HID_REPORT_TYPE_MIN
||
83 rinfo
->report_type
> HID_REPORT_TYPE_MAX
) return NULL
;
85 report_enum
= hid
->report_enum
+
86 (rinfo
->report_type
- HID_REPORT_TYPE_MIN
);
89 case 0: /* Nothing to do -- report_id is already set correctly */
92 case HID_REPORT_ID_FIRST
:
93 list
= report_enum
->report_list
.next
;
94 if (list
== &report_enum
->report_list
)
96 rinfo
->report_id
= ((struct hid_report
*) list
)->id
;
99 case HID_REPORT_ID_NEXT
:
100 list
= (struct list_head
*)
101 report_enum
->report_id_hash
[rinfo
->report_id
& HID_REPORT_ID_MASK
];
105 if (list
== &report_enum
->report_list
)
107 rinfo
->report_id
= ((struct hid_report
*) list
)->id
;
114 return report_enum
->report_id_hash
[rinfo
->report_id
];
118 * Perform an exhaustive search of the report table for a usage, given its
121 static struct hid_field
*
122 hiddev_lookup_usage(struct hid_device
*hid
, struct hiddev_usage_ref
*uref
)
125 struct hid_report
*report
;
126 struct hid_report_enum
*report_enum
;
127 struct hid_field
*field
;
129 if (uref
->report_type
< HID_REPORT_TYPE_MIN
||
130 uref
->report_type
> HID_REPORT_TYPE_MAX
) return NULL
;
132 report_enum
= hid
->report_enum
+
133 (uref
->report_type
- HID_REPORT_TYPE_MIN
);
135 list_for_each_entry(report
, &report_enum
->report_list
, list
)
136 for (i
= 0; i
< report
->maxfield
; i
++) {
137 field
= report
->field
[i
];
138 for (j
= 0; j
< field
->maxusage
; j
++) {
139 if (field
->usage
[j
].hid
== uref
->usage_code
) {
140 uref
->report_id
= report
->id
;
141 uref
->field_index
= i
;
142 uref
->usage_index
= j
;
151 static void hiddev_send_event(struct hid_device
*hid
,
152 struct hiddev_usage_ref
*uref
)
154 struct hiddev
*hiddev
= hid
->hiddev
;
155 struct hiddev_list
*list
= hiddev
->list
;
158 if (uref
->field_index
!= HID_FIELD_INDEX_NONE
||
159 (list
->flags
& HIDDEV_FLAG_REPORT
) != 0) {
160 list
->buffer
[list
->head
] = *uref
;
161 list
->head
= (list
->head
+ 1) &
162 (HIDDEV_BUFFER_SIZE
- 1);
163 kill_fasync(&list
->fasync
, SIGIO
, POLL_IN
);
169 wake_up_interruptible(&hiddev
->wait
);
173 * This is where hid.c calls into hiddev to pass an event that occurred over
176 void hiddev_hid_event(struct hid_device
*hid
, struct hid_field
*field
,
177 struct hid_usage
*usage
, __s32 value
, struct pt_regs
*regs
)
179 unsigned type
= field
->report_type
;
180 struct hiddev_usage_ref uref
;
183 (type
== HID_INPUT_REPORT
) ? HID_REPORT_TYPE_INPUT
:
184 ((type
== HID_OUTPUT_REPORT
) ? HID_REPORT_TYPE_OUTPUT
:
185 ((type
== HID_FEATURE_REPORT
) ? HID_REPORT_TYPE_FEATURE
:0));
186 uref
.report_id
= field
->report
->id
;
187 uref
.field_index
= field
->index
;
188 uref
.usage_index
= (usage
- field
->usage
);
189 uref
.usage_code
= usage
->hid
;
192 hiddev_send_event(hid
, &uref
);
196 void hiddev_report_event(struct hid_device
*hid
, struct hid_report
*report
)
198 unsigned type
= report
->type
;
199 struct hiddev_usage_ref uref
;
201 memset(&uref
, 0, sizeof(uref
));
203 (type
== HID_INPUT_REPORT
) ? HID_REPORT_TYPE_INPUT
:
204 ((type
== HID_OUTPUT_REPORT
) ? HID_REPORT_TYPE_OUTPUT
:
205 ((type
== HID_FEATURE_REPORT
) ? HID_REPORT_TYPE_FEATURE
:0));
206 uref
.report_id
= report
->id
;
207 uref
.field_index
= HID_FIELD_INDEX_NONE
;
209 hiddev_send_event(hid
, &uref
);
214 static int hiddev_fasync(int fd
, struct file
*file
, int on
)
217 struct hiddev_list
*list
= file
->private_data
;
218 retval
= fasync_helper(fd
, file
, on
, &list
->fasync
);
219 return retval
< 0 ? retval
: 0;
226 static int hiddev_release(struct inode
* inode
, struct file
* file
)
228 struct hiddev_list
*list
= file
->private_data
;
229 struct hiddev_list
**listptr
;
231 listptr
= &list
->hiddev
->list
;
232 hiddev_fasync(-1, file
, 0);
234 while (*listptr
&& (*listptr
!= list
))
235 listptr
= &((*listptr
)->next
);
236 *listptr
= (*listptr
)->next
;
238 if (!--list
->hiddev
->open
) {
239 if (list
->hiddev
->exist
)
240 hid_close(list
->hiddev
->hid
);
253 static int hiddev_open(struct inode
* inode
, struct file
* file
) {
254 struct hiddev_list
*list
;
256 int i
= iminor(inode
) - HIDDEV_MINOR_BASE
;
258 if (i
>= HIDDEV_MINORS
|| !hiddev_table
[i
])
261 if (!(list
= kmalloc(sizeof(struct hiddev_list
), GFP_KERNEL
)))
263 memset(list
, 0, sizeof(struct hiddev_list
));
265 list
->hiddev
= hiddev_table
[i
];
266 list
->next
= hiddev_table
[i
]->list
;
267 hiddev_table
[i
]->list
= list
;
269 file
->private_data
= list
;
271 if (!list
->hiddev
->open
++)
272 if (list
->hiddev
->exist
)
273 hid_open(hiddev_table
[i
]->hid
);
281 static ssize_t
hiddev_write(struct file
* file
, const char __user
* buffer
, size_t count
, loff_t
*ppos
)
289 static ssize_t
hiddev_read(struct file
* file
, char __user
* buffer
, size_t count
, loff_t
*ppos
)
291 DECLARE_WAITQUEUE(wait
, current
);
292 struct hiddev_list
*list
= file
->private_data
;
296 event_size
= ((list
->flags
& HIDDEV_FLAG_UREF
) != 0) ?
297 sizeof(struct hiddev_usage_ref
) : sizeof(struct hiddev_event
);
299 if (count
< event_size
)
302 while (retval
== 0) {
303 if (list
->head
== list
->tail
) {
304 add_wait_queue(&list
->hiddev
->wait
, &wait
);
305 set_current_state(TASK_INTERRUPTIBLE
);
307 while (list
->head
== list
->tail
) {
308 if (file
->f_flags
& O_NONBLOCK
) {
312 if (signal_pending(current
)) {
313 retval
= -ERESTARTSYS
;
316 if (!list
->hiddev
->exist
) {
324 set_current_state(TASK_RUNNING
);
325 remove_wait_queue(&list
->hiddev
->wait
, &wait
);
332 while (list
->head
!= list
->tail
&&
333 retval
+ event_size
<= count
) {
334 if ((list
->flags
& HIDDEV_FLAG_UREF
) == 0) {
335 if (list
->buffer
[list
->tail
].field_index
!=
336 HID_FIELD_INDEX_NONE
) {
337 struct hiddev_event event
;
338 event
.hid
= list
->buffer
[list
->tail
].usage_code
;
339 event
.value
= list
->buffer
[list
->tail
].value
;
340 if (copy_to_user(buffer
+ retval
, &event
, sizeof(struct hiddev_event
)))
342 retval
+= sizeof(struct hiddev_event
);
345 if (list
->buffer
[list
->tail
].field_index
!= HID_FIELD_INDEX_NONE
||
346 (list
->flags
& HIDDEV_FLAG_REPORT
) != 0) {
347 if (copy_to_user(buffer
+ retval
, list
->buffer
+ list
->tail
, sizeof(struct hiddev_usage_ref
)))
349 retval
+= sizeof(struct hiddev_usage_ref
);
352 list
->tail
= (list
->tail
+ 1) & (HIDDEV_BUFFER_SIZE
- 1);
362 * No kernel lock - fine
364 static unsigned int hiddev_poll(struct file
*file
, poll_table
*wait
)
366 struct hiddev_list
*list
= file
->private_data
;
367 poll_wait(file
, &list
->hiddev
->wait
, wait
);
368 if (list
->head
!= list
->tail
)
369 return POLLIN
| POLLRDNORM
;
370 if (!list
->hiddev
->exist
)
371 return POLLERR
| POLLHUP
;
378 static int hiddev_ioctl(struct inode
*inode
, struct file
*file
, unsigned int cmd
, unsigned long arg
)
380 struct hiddev_list
*list
= file
->private_data
;
381 struct hiddev
*hiddev
= list
->hiddev
;
382 struct hid_device
*hid
= hiddev
->hid
;
383 struct usb_device
*dev
= hid
->dev
;
384 struct hiddev_collection_info cinfo
;
385 struct hiddev_report_info rinfo
;
386 struct hiddev_field_info finfo
;
387 struct hiddev_usage_ref_multi
*uref_multi
=NULL
;
388 struct hiddev_usage_ref
*uref
;
389 struct hiddev_devinfo dinfo
;
390 struct hid_report
*report
;
391 struct hid_field
*field
;
392 void __user
*user_arg
= (void __user
*)arg
;
401 return put_user(HID_VERSION
, (int __user
*)arg
);
403 case HIDIOCAPPLICATION
:
404 if (arg
< 0 || arg
>= hid
->maxapplication
)
407 for (i
= 0; i
< hid
->maxcollection
; i
++)
408 if (hid
->collection
[i
].type
==
409 HID_COLLECTION_APPLICATION
&& arg
-- == 0)
412 if (i
== hid
->maxcollection
)
415 return hid
->collection
[i
].usage
;
418 dinfo
.bustype
= BUS_USB
;
419 dinfo
.busnum
= dev
->bus
->busnum
;
420 dinfo
.devnum
= dev
->devnum
;
421 dinfo
.ifnum
= hid
->ifnum
;
422 dinfo
.vendor
= le16_to_cpu(dev
->descriptor
.idVendor
);
423 dinfo
.product
= le16_to_cpu(dev
->descriptor
.idProduct
);
424 dinfo
.version
= le16_to_cpu(dev
->descriptor
.bcdDevice
);
425 dinfo
.num_applications
= hid
->maxapplication
;
426 if (copy_to_user(user_arg
, &dinfo
, sizeof(dinfo
)))
432 if (put_user(list
->flags
, (int __user
*)arg
))
440 if (get_user(newflags
, (int __user
*)arg
))
443 if ((newflags
& ~HIDDEV_FLAGS
) != 0 ||
444 ((newflags
& HIDDEV_FLAG_REPORT
) != 0 &&
445 (newflags
& HIDDEV_FLAG_UREF
) == 0))
448 list
->flags
= newflags
;
458 if (get_user(idx
, (int __user
*)arg
))
461 if ((buf
= kmalloc(HID_STRING_SIZE
, GFP_KERNEL
)) == NULL
)
464 if ((len
= usb_string(dev
, idx
, buf
, HID_STRING_SIZE
-1)) < 0) {
469 if (copy_to_user(user_arg
+sizeof(int), buf
, len
+1)) {
479 case HIDIOCINITREPORT
:
480 hid_init_reports(hid
);
485 if (copy_from_user(&rinfo
, user_arg
, sizeof(rinfo
)))
488 if (rinfo
.report_type
== HID_REPORT_TYPE_OUTPUT
)
491 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
494 hid_submit_report(hid
, report
, USB_DIR_IN
);
500 if (copy_from_user(&rinfo
, user_arg
, sizeof(rinfo
)))
503 if (rinfo
.report_type
== HID_REPORT_TYPE_INPUT
)
506 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
509 hid_submit_report(hid
, report
, USB_DIR_OUT
);
513 case HIDIOCGREPORTINFO
:
514 if (copy_from_user(&rinfo
, user_arg
, sizeof(rinfo
)))
517 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
520 rinfo
.num_fields
= report
->maxfield
;
522 if (copy_to_user(user_arg
, &rinfo
, sizeof(rinfo
)))
527 case HIDIOCGFIELDINFO
:
528 if (copy_from_user(&finfo
, user_arg
, sizeof(finfo
)))
530 rinfo
.report_type
= finfo
.report_type
;
531 rinfo
.report_id
= finfo
.report_id
;
532 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
535 if (finfo
.field_index
>= report
->maxfield
)
538 field
= report
->field
[finfo
.field_index
];
539 memset(&finfo
, 0, sizeof(finfo
));
540 finfo
.report_type
= rinfo
.report_type
;
541 finfo
.report_id
= rinfo
.report_id
;
542 finfo
.field_index
= field
->report_count
- 1;
543 finfo
.maxusage
= field
->maxusage
;
544 finfo
.flags
= field
->flags
;
545 finfo
.physical
= field
->physical
;
546 finfo
.logical
= field
->logical
;
547 finfo
.application
= field
->application
;
548 finfo
.logical_minimum
= field
->logical_minimum
;
549 finfo
.logical_maximum
= field
->logical_maximum
;
550 finfo
.physical_minimum
= field
->physical_minimum
;
551 finfo
.physical_maximum
= field
->physical_maximum
;
552 finfo
.unit_exponent
= field
->unit_exponent
;
553 finfo
.unit
= field
->unit
;
555 if (copy_to_user(user_arg
, &finfo
, sizeof(finfo
)))
561 uref_multi
= kmalloc(sizeof(struct hiddev_usage_ref_multi
), GFP_KERNEL
);
564 uref
= &uref_multi
->uref
;
565 if (copy_from_user(uref
, user_arg
, sizeof(*uref
)))
568 rinfo
.report_type
= uref
->report_type
;
569 rinfo
.report_id
= uref
->report_id
;
570 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
573 if (uref
->field_index
>= report
->maxfield
)
576 field
= report
->field
[uref
->field_index
];
577 if (uref
->usage_index
>= field
->maxusage
)
580 uref
->usage_code
= field
->usage
[uref
->usage_index
].hid
;
582 if (copy_to_user(user_arg
, uref
, sizeof(*uref
)))
592 case HIDIOCGCOLLECTIONINDEX
:
593 uref_multi
= kmalloc(sizeof(struct hiddev_usage_ref_multi
), GFP_KERNEL
);
596 uref
= &uref_multi
->uref
;
597 if (cmd
== HIDIOCGUSAGES
|| cmd
== HIDIOCSUSAGES
) {
598 if (copy_from_user(uref_multi
, user_arg
,
599 sizeof(*uref_multi
)))
602 if (copy_from_user(uref
, user_arg
, sizeof(*uref
)))
606 if (cmd
!= HIDIOCGUSAGE
&&
607 cmd
!= HIDIOCGUSAGES
&&
608 uref
->report_type
== HID_REPORT_TYPE_INPUT
)
611 if (uref
->report_id
== HID_REPORT_ID_UNKNOWN
) {
612 field
= hiddev_lookup_usage(hid
, uref
);
616 rinfo
.report_type
= uref
->report_type
;
617 rinfo
.report_id
= uref
->report_id
;
618 if ((report
= hiddev_lookup_report(hid
, &rinfo
)) == NULL
)
621 if (uref
->field_index
>= report
->maxfield
)
624 field
= report
->field
[uref
->field_index
];
626 if (cmd
== HIDIOCGCOLLECTIONINDEX
) {
627 if (uref
->usage_index
>= field
->maxusage
)
629 } else if (uref
->usage_index
>= field
->report_count
)
632 else if ((cmd
== HIDIOCGUSAGES
|| cmd
== HIDIOCSUSAGES
) &&
633 (uref_multi
->num_values
> HID_MAX_MULTI_USAGES
||
634 uref
->usage_index
+ uref_multi
->num_values
>= field
->report_count
))
640 uref
->value
= field
->value
[uref
->usage_index
];
641 if (copy_to_user(user_arg
, uref
, sizeof(*uref
)))
646 field
->value
[uref
->usage_index
] = uref
->value
;
649 case HIDIOCGCOLLECTIONINDEX
:
651 return field
->usage
[uref
->usage_index
].collection_index
;
653 for (i
= 0; i
< uref_multi
->num_values
; i
++)
654 uref_multi
->values
[i
] =
655 field
->value
[uref
->usage_index
+ i
];
656 if (copy_to_user(user_arg
, uref_multi
,
657 sizeof(*uref_multi
)))
661 for (i
= 0; i
< uref_multi
->num_values
; i
++)
662 field
->value
[uref
->usage_index
+ i
] =
663 uref_multi
->values
[i
];
677 case HIDIOCGCOLLECTIONINFO
:
678 if (copy_from_user(&cinfo
, user_arg
, sizeof(cinfo
)))
681 if (cinfo
.index
>= hid
->maxcollection
)
684 cinfo
.type
= hid
->collection
[cinfo
.index
].type
;
685 cinfo
.usage
= hid
->collection
[cinfo
.index
].usage
;
686 cinfo
.level
= hid
->collection
[cinfo
.index
].level
;
688 if (copy_to_user(user_arg
, &cinfo
, sizeof(cinfo
)))
694 if (_IOC_TYPE(cmd
) != 'H' || _IOC_DIR(cmd
) != _IOC_READ
)
697 if (_IOC_NR(cmd
) == _IOC_NR(HIDIOCGNAME(0))) {
701 len
= strlen(hid
->name
) + 1;
702 if (len
> _IOC_SIZE(cmd
))
703 len
= _IOC_SIZE(cmd
);
704 return copy_to_user(user_arg
, hid
->name
, len
) ?
708 if (_IOC_NR(cmd
) == _IOC_NR(HIDIOCGPHYS(0))) {
712 len
= strlen(hid
->phys
) + 1;
713 if (len
> _IOC_SIZE(cmd
))
714 len
= _IOC_SIZE(cmd
);
715 return copy_to_user(user_arg
, hid
->phys
, len
) ?
722 static struct file_operations hiddev_fops
= {
723 .owner
= THIS_MODULE
,
725 .write
= hiddev_write
,
728 .release
= hiddev_release
,
729 .ioctl
= hiddev_ioctl
,
730 .fasync
= hiddev_fasync
,
733 static struct usb_class_driver hiddev_class
= {
734 .name
= "usb/hid/hiddev%d",
735 .fops
= &hiddev_fops
,
736 .mode
= S_IFCHR
| S_IRUGO
| S_IWUSR
,
737 .minor_base
= HIDDEV_MINOR_BASE
,
741 * This is where hid.c calls us to connect a hid device to the hiddev driver
743 int hiddev_connect(struct hid_device
*hid
)
745 struct hiddev
*hiddev
;
749 for (i
= 0; i
< hid
->maxcollection
; i
++)
750 if (hid
->collection
[i
].type
==
751 HID_COLLECTION_APPLICATION
&&
752 !IS_INPUT_APPLICATION(hid
->collection
[i
].usage
))
755 if (i
== hid
->maxcollection
&& (hid
->quirks
& HID_QUIRK_HIDDEV
) == 0)
758 if (!(hiddev
= kmalloc(sizeof(struct hiddev
), GFP_KERNEL
)))
760 memset(hiddev
, 0, sizeof(struct hiddev
));
762 retval
= usb_register_dev(hid
->intf
, &hiddev_class
);
764 err("Not able to get a minor for this device.");
769 init_waitqueue_head(&hiddev
->wait
);
771 hiddev_table
[hid
->intf
->minor
- HIDDEV_MINOR_BASE
] = hiddev
;
776 hid
->minor
= hid
->intf
->minor
;
777 hid
->hiddev
= hiddev
;
783 * This is where hid.c calls us to disconnect a hiddev device from the
784 * corresponding hid device (usually because the usb device has disconnected)
786 static struct usb_class_driver hiddev_class
;
787 void hiddev_disconnect(struct hid_device
*hid
)
789 struct hiddev
*hiddev
= hid
->hiddev
;
793 hiddev_table
[hiddev
->hid
->minor
- HIDDEV_MINOR_BASE
] = NULL
;
794 usb_deregister_dev(hiddev
->hid
->intf
, &hiddev_class
);
797 hid_close(hiddev
->hid
);
798 wake_up_interruptible(&hiddev
->wait
);
804 /* Currently this driver is a USB driver. It's not a conventional one in
805 * the sense that it doesn't probe at the USB level. Instead it waits to
806 * be connected by HID through the hiddev_connect / hiddev_disconnect
807 * routines. The reason to register as a USB device is to gain part of the
808 * minor number space from the USB major.
810 * In theory, should the HID code be generalized to more than one physical
811 * medium (say, IEEE 1384), this driver will probably need to register its
812 * own major number, and in doing so, no longer need to register with USB.
813 * At that point the probe routine and hiddev_driver struct below will no
818 /* We never attach in this manner, and rely on HID to connect us. This
819 * is why there is no disconnect routine defined in the usb_driver either.
821 static int hiddev_usbd_probe(struct usb_interface
*intf
,
822 const struct usb_device_id
*hiddev_info
)
828 static /* const */ struct usb_driver hiddev_driver
= {
829 .owner
= THIS_MODULE
,
831 .probe
= hiddev_usbd_probe
,
834 int __init
hiddev_init(void)
836 devfs_mk_dir("usb/hid");
837 return usb_register(&hiddev_driver
);
840 void hiddev_exit(void)
842 usb_deregister(&hiddev_driver
);
843 devfs_remove("usb/hid");