Linux 3.3-rc6
[linux/fpc-iii.git] / drivers / hid / hidraw.c
blobcf7d6d58e79f25513dd0baedac00e3ddfd5f342f
1 /*
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.
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <linux/fs.h>
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;
49 int ret = 0, len;
50 DECLARE_WAITQUEUE(wait, current);
52 mutex_lock(&list->read_mutex);
54 while (ret == 0) {
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 (file->f_flags & O_NONBLOCK) {
61 ret = -EAGAIN;
62 break;
64 if (signal_pending(current)) {
65 ret = -ERESTARTSYS;
66 break;
68 if (!list->hidraw->exist) {
69 ret = -EIO;
70 break;
73 /* allow O_NONBLOCK to work well from other threads */
74 mutex_unlock(&list->read_mutex);
75 schedule();
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);
84 if (ret)
85 goto out;
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)) {
91 ret = -EFAULT;
92 goto out;
94 ret = len;
96 kfree(list->buffer[list->tail].value);
97 list->tail = (list->tail + 1) & (HIDRAW_BUFFER_SIZE - 1);
99 out:
100 mutex_unlock(&list->read_mutex);
101 return ret;
104 /* The first byte is expected to be a report number.
105 * This function is to be called with the minors_lock mutex held */
106 static ssize_t hidraw_send_report(struct file *file, const char __user *buffer, size_t count, unsigned char report_type)
108 unsigned int minor = iminor(file->f_path.dentry->d_inode);
109 struct hid_device *dev;
110 __u8 *buf;
111 int ret = 0;
113 if (!hidraw_table[minor]) {
114 ret = -ENODEV;
115 goto out;
118 dev = hidraw_table[minor]->hid;
120 if (!dev->hid_output_raw_report) {
121 ret = -ENODEV;
122 goto out;
125 if (count > HID_MAX_BUFFER_SIZE) {
126 hid_warn(dev, "pid %d passed too large report\n",
127 task_pid_nr(current));
128 ret = -EINVAL;
129 goto out;
132 if (count < 2) {
133 hid_warn(dev, "pid %d passed too short report\n",
134 task_pid_nr(current));
135 ret = -EINVAL;
136 goto out;
139 buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
140 if (!buf) {
141 ret = -ENOMEM;
142 goto out;
145 if (copy_from_user(buf, buffer, count)) {
146 ret = -EFAULT;
147 goto out_free;
150 ret = dev->hid_output_raw_report(dev, buf, count, report_type);
151 out_free:
152 kfree(buf);
153 out:
154 return ret;
157 /* the first byte is expected to be a report number */
158 static ssize_t hidraw_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
160 ssize_t ret;
161 mutex_lock(&minors_lock);
162 ret = hidraw_send_report(file, buffer, count, HID_OUTPUT_REPORT);
163 mutex_unlock(&minors_lock);
164 return ret;
168 /* This function performs a Get_Report transfer over the control endpoint
169 * per section 7.2.1 of the HID specification, version 1.1. The first byte
170 * of buffer is the report number to request, or 0x0 if the defice does not
171 * use numbered reports. The report_type parameter can be HID_FEATURE_REPORT
172 * or HID_INPUT_REPORT. This function is to be called with the minors_lock
173 * mutex held. */
174 static ssize_t hidraw_get_report(struct file *file, char __user *buffer, size_t count, unsigned char report_type)
176 unsigned int minor = iminor(file->f_path.dentry->d_inode);
177 struct hid_device *dev;
178 __u8 *buf;
179 int ret = 0, len;
180 unsigned char report_number;
182 dev = hidraw_table[minor]->hid;
184 if (!dev->hid_get_raw_report) {
185 ret = -ENODEV;
186 goto out;
189 if (count > HID_MAX_BUFFER_SIZE) {
190 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
191 task_pid_nr(current));
192 ret = -EINVAL;
193 goto out;
196 if (count < 2) {
197 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
198 task_pid_nr(current));
199 ret = -EINVAL;
200 goto out;
203 buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
204 if (!buf) {
205 ret = -ENOMEM;
206 goto out;
209 /* Read the first byte from the user. This is the report number,
210 * which is passed to dev->hid_get_raw_report(). */
211 if (copy_from_user(&report_number, buffer, 1)) {
212 ret = -EFAULT;
213 goto out_free;
216 ret = dev->hid_get_raw_report(dev, report_number, buf, count, report_type);
218 if (ret < 0)
219 goto out_free;
221 len = (ret < count) ? ret : count;
223 if (copy_to_user(buffer, buf, len)) {
224 ret = -EFAULT;
225 goto out_free;
228 ret = len;
230 out_free:
231 kfree(buf);
232 out:
233 return ret;
236 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
238 struct hidraw_list *list = file->private_data;
240 poll_wait(file, &list->hidraw->wait, wait);
241 if (list->head != list->tail)
242 return POLLIN | POLLRDNORM;
243 if (!list->hidraw->exist)
244 return POLLERR | POLLHUP;
245 return 0;
248 static int hidraw_open(struct inode *inode, struct file *file)
250 unsigned int minor = iminor(inode);
251 struct hidraw *dev;
252 struct hidraw_list *list;
253 int err = 0;
255 if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
256 err = -ENOMEM;
257 goto out;
260 mutex_lock(&minors_lock);
261 if (!hidraw_table[minor]) {
262 err = -ENODEV;
263 goto out_unlock;
266 list->hidraw = hidraw_table[minor];
267 mutex_init(&list->read_mutex);
268 list_add_tail(&list->node, &hidraw_table[minor]->list);
269 file->private_data = list;
271 dev = hidraw_table[minor];
272 if (!dev->open++) {
273 err = hid_hw_power(dev->hid, PM_HINT_FULLON);
274 if (err < 0) {
275 dev->open--;
276 goto out_unlock;
279 err = hid_hw_open(dev->hid);
280 if (err < 0) {
281 hid_hw_power(dev->hid, PM_HINT_NORMAL);
282 dev->open--;
286 out_unlock:
287 mutex_unlock(&minors_lock);
288 out:
289 if (err < 0)
290 kfree(list);
291 return err;
295 static int hidraw_release(struct inode * inode, struct file * file)
297 unsigned int minor = iminor(inode);
298 struct hidraw *dev;
299 struct hidraw_list *list = file->private_data;
300 int ret;
302 mutex_lock(&minors_lock);
303 if (!hidraw_table[minor]) {
304 ret = -ENODEV;
305 goto unlock;
308 list_del(&list->node);
309 dev = hidraw_table[minor];
310 if (!--dev->open) {
311 if (list->hidraw->exist) {
312 hid_hw_power(dev->hid, PM_HINT_NORMAL);
313 hid_hw_close(dev->hid);
314 } else {
315 kfree(list->hidraw);
318 kfree(list);
319 ret = 0;
320 unlock:
321 mutex_unlock(&minors_lock);
323 return ret;
326 static long hidraw_ioctl(struct file *file, unsigned int cmd,
327 unsigned long arg)
329 struct inode *inode = file->f_path.dentry->d_inode;
330 unsigned int minor = iminor(inode);
331 long ret = 0;
332 struct hidraw *dev;
333 void __user *user_arg = (void __user*) arg;
335 mutex_lock(&minors_lock);
336 dev = hidraw_table[minor];
337 if (!dev) {
338 ret = -ENODEV;
339 goto out;
342 switch (cmd) {
343 case HIDIOCGRDESCSIZE:
344 if (put_user(dev->hid->rsize, (int __user *)arg))
345 ret = -EFAULT;
346 break;
348 case HIDIOCGRDESC:
350 __u32 len;
352 if (get_user(len, (int __user *)arg))
353 ret = -EFAULT;
354 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
355 ret = -EINVAL;
356 else if (copy_to_user(user_arg + offsetof(
357 struct hidraw_report_descriptor,
358 value[0]),
359 dev->hid->rdesc,
360 min(dev->hid->rsize, len)))
361 ret = -EFAULT;
362 break;
364 case HIDIOCGRAWINFO:
366 struct hidraw_devinfo dinfo;
368 dinfo.bustype = dev->hid->bus;
369 dinfo.vendor = dev->hid->vendor;
370 dinfo.product = dev->hid->product;
371 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
372 ret = -EFAULT;
373 break;
375 default:
377 struct hid_device *hid = dev->hid;
378 if (_IOC_TYPE(cmd) != 'H') {
379 ret = -EINVAL;
380 break;
383 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCSFEATURE(0))) {
384 int len = _IOC_SIZE(cmd);
385 ret = hidraw_send_report(file, user_arg, len, HID_FEATURE_REPORT);
386 break;
388 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGFEATURE(0))) {
389 int len = _IOC_SIZE(cmd);
390 ret = hidraw_get_report(file, user_arg, len, HID_FEATURE_REPORT);
391 break;
394 /* Begin Read-only ioctls. */
395 if (_IOC_DIR(cmd) != _IOC_READ) {
396 ret = -EINVAL;
397 break;
400 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWNAME(0))) {
401 int len = strlen(hid->name) + 1;
402 if (len > _IOC_SIZE(cmd))
403 len = _IOC_SIZE(cmd);
404 ret = copy_to_user(user_arg, hid->name, len) ?
405 -EFAULT : len;
406 break;
409 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWPHYS(0))) {
410 int len = strlen(hid->phys) + 1;
411 if (len > _IOC_SIZE(cmd))
412 len = _IOC_SIZE(cmd);
413 ret = copy_to_user(user_arg, hid->phys, len) ?
414 -EFAULT : len;
415 break;
419 ret = -ENOTTY;
421 out:
422 mutex_unlock(&minors_lock);
423 return ret;
426 static const struct file_operations hidraw_ops = {
427 .owner = THIS_MODULE,
428 .read = hidraw_read,
429 .write = hidraw_write,
430 .poll = hidraw_poll,
431 .open = hidraw_open,
432 .release = hidraw_release,
433 .unlocked_ioctl = hidraw_ioctl,
434 #ifdef CONFIG_COMPAT
435 .compat_ioctl = hidraw_ioctl,
436 #endif
437 .llseek = noop_llseek,
440 void hidraw_report_event(struct hid_device *hid, u8 *data, int len)
442 struct hidraw *dev = hid->hidraw;
443 struct hidraw_list *list;
445 list_for_each_entry(list, &dev->list, node) {
446 list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC);
447 list->buffer[list->head].len = len;
448 list->head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
449 kill_fasync(&list->fasync, SIGIO, POLL_IN);
452 wake_up_interruptible(&dev->wait);
454 EXPORT_SYMBOL_GPL(hidraw_report_event);
456 int hidraw_connect(struct hid_device *hid)
458 int minor, result;
459 struct hidraw *dev;
461 /* we accept any HID device, no matter the applications */
463 dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
464 if (!dev)
465 return -ENOMEM;
467 result = -EINVAL;
469 mutex_lock(&minors_lock);
471 for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
472 if (hidraw_table[minor])
473 continue;
474 hidraw_table[minor] = dev;
475 result = 0;
476 break;
479 if (result) {
480 mutex_unlock(&minors_lock);
481 kfree(dev);
482 goto out;
485 dev->dev = device_create(hidraw_class, &hid->dev, MKDEV(hidraw_major, minor),
486 NULL, "%s%d", "hidraw", minor);
488 if (IS_ERR(dev->dev)) {
489 hidraw_table[minor] = NULL;
490 mutex_unlock(&minors_lock);
491 result = PTR_ERR(dev->dev);
492 kfree(dev);
493 goto out;
496 mutex_unlock(&minors_lock);
497 init_waitqueue_head(&dev->wait);
498 INIT_LIST_HEAD(&dev->list);
500 dev->hid = hid;
501 dev->minor = minor;
503 dev->exist = 1;
504 hid->hidraw = dev;
506 out:
507 return result;
510 EXPORT_SYMBOL_GPL(hidraw_connect);
512 void hidraw_disconnect(struct hid_device *hid)
514 struct hidraw *hidraw = hid->hidraw;
516 mutex_lock(&minors_lock);
517 hidraw->exist = 0;
519 device_destroy(hidraw_class, MKDEV(hidraw_major, hidraw->minor));
521 hidraw_table[hidraw->minor] = NULL;
523 if (hidraw->open) {
524 hid_hw_close(hid);
525 wake_up_interruptible(&hidraw->wait);
526 } else {
527 kfree(hidraw);
529 mutex_unlock(&minors_lock);
531 EXPORT_SYMBOL_GPL(hidraw_disconnect);
533 int __init hidraw_init(void)
535 int result;
536 dev_t dev_id;
538 result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
539 HIDRAW_MAX_DEVICES, "hidraw");
541 hidraw_major = MAJOR(dev_id);
543 if (result < 0) {
544 pr_warn("can't get major number\n");
545 result = 0;
546 goto out;
549 hidraw_class = class_create(THIS_MODULE, "hidraw");
550 if (IS_ERR(hidraw_class)) {
551 result = PTR_ERR(hidraw_class);
552 unregister_chrdev(hidraw_major, "hidraw");
553 goto out;
556 cdev_init(&hidraw_cdev, &hidraw_ops);
557 cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
558 out:
559 return result;
562 void hidraw_exit(void)
564 dev_t dev_id = MKDEV(hidraw_major, 0);
566 cdev_del(&hidraw_cdev);
567 class_destroy(hidraw_class);
568 unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);