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 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.
23 #include <linux/module.h>
24 #include <linux/errno.h>
25 #include <linux/kernel.h>
26 #include <linux/init.h>
27 #include <linux/cdev.h>
28 #include <linux/poll.h>
29 #include <linux/device.h>
30 #include <linux/major.h>
31 #include <linux/hid.h>
32 #include <linux/mutex.h>
33 #include <linux/smp_lock.h>
35 #include <linux/hidraw.h>
37 static int hidraw_major;
38 static struct cdev hidraw_cdev;
39 static struct class *hidraw_class;
40 static struct hidraw *hidraw_table[HIDRAW_MAX_DEVICES];
41 static DEFINE_SPINLOCK(minors_lock);
43 static ssize_t hidraw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
45 struct hidraw_list *list = file->private_data;
48 DECLARE_WAITQUEUE(wait, current);
52 mutex_lock(&list->read_mutex);
54 if (list->head == list->tail) {
55 add_wait_queue(&list->hidraw->wait, &wait);
56 set_current_state(TASK_INTERRUPTIBLE);
58 while (list->head == list->tail) {
59 if (file->f_flags & O_NONBLOCK) {
63 if (signal_pending(current)) {
67 if (!list->hidraw->exist) {
72 /* allow O_NONBLOCK to work well from other threads */
73 mutex_unlock(&list->read_mutex);
75 mutex_lock(&list->read_mutex);
76 set_current_state(TASK_INTERRUPTIBLE);
79 set_current_state(TASK_RUNNING);
80 remove_wait_queue(&list->hidraw->wait, &wait);
86 report = list->buffer[list->tail].value;
87 len = list->buffer[list->tail].len > count ?
88 count : list->buffer[list->tail].len;
90 if (copy_to_user(buffer, list->buffer[list->tail].value, len)) {
96 kfree(list->buffer[list->tail].value);
97 list->tail = (list->tail + 1) & (HIDRAW_BUFFER_SIZE - 1);
100 mutex_unlock(&list->read_mutex);
104 /* the first byte is expected to be a report number */
105 static ssize_t hidraw_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
107 unsigned int minor = iminor(file->f_path.dentry->d_inode);
108 /* FIXME: What stops hidraw_table going NULL */
109 struct hid_device *dev = hidraw_table[minor]->hid;
113 if (!dev->hid_output_raw_report)
116 if (count > HID_MAX_BUFFER_SIZE) {
117 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
118 task_pid_nr(current));
123 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
124 task_pid_nr(current));
128 buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
132 if (copy_from_user(buf, buffer, count)) {
137 ret = dev->hid_output_raw_report(dev, buf, count);
143 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
145 struct hidraw_list *list = file->private_data;
147 poll_wait(file, &list->hidraw->wait, wait);
148 if (list->head != list->tail)
149 return POLLIN | POLLRDNORM;
150 if (!list->hidraw->exist)
151 return POLLERR | POLLHUP;
155 static int hidraw_open(struct inode *inode, struct file *file)
157 unsigned int minor = iminor(inode);
159 struct hidraw_list *list;
163 if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
168 spin_lock(&minors_lock);
169 if (!hidraw_table[minor]) {
170 printk(KERN_EMERG "hidraw device with minor %d doesn't exist\n",
177 list->hidraw = hidraw_table[minor];
178 mutex_init(&list->read_mutex);
179 list_add_tail(&list->node, &hidraw_table[minor]->list);
180 file->private_data = list;
182 dev = hidraw_table[minor];
184 dev->hid->ll_driver->open(dev->hid);
187 spin_unlock(&minors_lock);
194 static int hidraw_release(struct inode * inode, struct file * file)
196 unsigned int minor = iminor(inode);
198 struct hidraw_list *list = file->private_data;
200 if (!hidraw_table[minor]) {
201 printk(KERN_EMERG "hidraw device with minor %d doesn't exist\n",
206 list_del(&list->node);
207 dev = hidraw_table[minor];
209 if (list->hidraw->exist)
210 dev->hid->ll_driver->close(dev->hid);
220 static long hidraw_ioctl(struct file *file, unsigned int cmd,
223 struct inode *inode = file->f_path.dentry->d_inode;
224 unsigned int minor = iminor(inode);
226 /* FIXME: What stops hidraw_table going NULL */
227 struct hidraw *dev = hidraw_table[minor];
228 void __user *user_arg = (void __user*) arg;
232 case HIDIOCGRDESCSIZE:
233 if (put_user(dev->hid->rsize, (int __user *)arg))
241 if (get_user(len, (int __user *)arg))
243 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
245 else if (copy_to_user(user_arg + offsetof(
246 struct hidraw_report_descriptor,
249 min(dev->hid->rsize, len)))
255 struct hidraw_devinfo dinfo;
257 dinfo.bustype = dev->hid->bus;
258 dinfo.vendor = dev->hid->vendor;
259 dinfo.product = dev->hid->product;
260 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
271 static const struct file_operations hidraw_ops = {
272 .owner = THIS_MODULE,
274 .write = hidraw_write,
277 .release = hidraw_release,
278 .unlocked_ioctl = hidraw_ioctl,
281 void hidraw_report_event(struct hid_device *hid, u8 *data, int len)
283 struct hidraw *dev = hid->hidraw;
284 struct hidraw_list *list;
286 list_for_each_entry(list, &dev->list, node) {
287 list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC);
288 list->buffer[list->head].len = len;
289 list->head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
290 kill_fasync(&list->fasync, SIGIO, POLL_IN);
293 wake_up_interruptible(&dev->wait);
295 EXPORT_SYMBOL_GPL(hidraw_report_event);
297 int hidraw_connect(struct hid_device *hid)
302 /* TODO currently we accept any HID device. This should later
303 * probably be fixed to accept only those devices which provide
304 * non-input applications
307 dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
313 spin_lock(&minors_lock);
315 for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
316 if (hidraw_table[minor])
318 hidraw_table[minor] = dev;
323 spin_unlock(&minors_lock);
330 dev->dev = device_create(hidraw_class, NULL, MKDEV(hidraw_major, minor),
331 NULL, "%s%d", "hidraw", minor);
333 if (IS_ERR(dev->dev)) {
334 spin_lock(&minors_lock);
335 hidraw_table[minor] = NULL;
336 spin_unlock(&minors_lock);
337 result = PTR_ERR(dev->dev);
342 init_waitqueue_head(&dev->wait);
343 INIT_LIST_HEAD(&dev->list);
355 EXPORT_SYMBOL_GPL(hidraw_connect);
357 void hidraw_disconnect(struct hid_device *hid)
359 struct hidraw *hidraw = hid->hidraw;
363 spin_lock(&minors_lock);
364 hidraw_table[hidraw->minor] = NULL;
365 spin_unlock(&minors_lock);
367 device_destroy(hidraw_class, MKDEV(hidraw_major, hidraw->minor));
370 hid->ll_driver->close(hid);
371 wake_up_interruptible(&hidraw->wait);
376 EXPORT_SYMBOL_GPL(hidraw_disconnect);
378 int __init hidraw_init(void)
383 result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
384 HIDRAW_MAX_DEVICES, "hidraw");
386 hidraw_major = MAJOR(dev_id);
389 printk(KERN_WARNING "hidraw: can't get major number\n");
394 hidraw_class = class_create(THIS_MODULE, "hidraw");
395 if (IS_ERR(hidraw_class)) {
396 result = PTR_ERR(hidraw_class);
397 unregister_chrdev(hidraw_major, "hidraw");
401 cdev_init(&hidraw_cdev, &hidraw_ops);
402 cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
407 void hidraw_exit(void)
409 dev_t dev_id = MKDEV(hidraw_major, 0);
411 cdev_del(&hidraw_cdev);
412 class_destroy(hidraw_class);
413 unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);