drivers/hid/hidraw.c

   1 /*
   2  * HID raw devices, giving access to raw HID events.
   3  *
   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.
   8  *
   9  *  Copyright (c) 2007 Jiri Kosina
  10  */
  11
  12 /*
  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.
  16  *
  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.
  20  */
  21
  22 #include <linux/fs.h>
  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>
  34
  35 #include <linux/hidraw.h>
  36
  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);
  42
  43 static ssize_t hidraw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
  44 {
  45         struct hidraw_list *list = file->private_data;
  46         int ret = 0, len;
  47         char *report;
  48         DECLARE_WAITQUEUE(wait, current);
  49
  50         while (ret == 0) {
  51
  52                 mutex_lock(&list->read_mutex);
  53
  54                 if (list->head == list->tail) {
  55                         add_wait_queue(&list->hidraw->wait, &wait);
  56                         set_current_state(TASK_INTERRUPTIBLE);
  57
  58                         while (list->head == list->tail) {
  59                                 if (file->f_flags & O_NONBLOCK) {
  60                                         ret = -EAGAIN;
  61                                         break;
  62                                 }
  63                                 if (signal_pending(current)) {
  64                                         ret = -ERESTARTSYS;
  65                                         break;
  66                                 }
  67                                 if (!list->hidraw->exist) {
  68                                         ret = -EIO;
  69                                         break;
  70                                 }
  71
  72                                 /* allow O_NONBLOCK to work well from other threads */
  73                                 mutex_unlock(&list->read_mutex);
  74                                 schedule();
  75                                 mutex_lock(&list->read_mutex);
  76                                 set_current_state(TASK_INTERRUPTIBLE);
  77                         }
  78
  79                         set_current_state(TASK_RUNNING);
  80                         remove_wait_queue(&list->hidraw->wait, &wait);
  81                 }
  82
  83                 if (ret)
  84                         goto out;
  85
  86                 report = list->buffer[list->tail].value;
  87                 len = list->buffer[list->tail].len > count ?
  88                         count : list->buffer[list->tail].len;
  89
  90                 if (copy_to_user(buffer, list->buffer[list->tail].value, len)) {
  91                         ret = -EFAULT;
  92                         goto out;
  93                 }
  94                 ret += len;
  95
  96                 kfree(list->buffer[list->tail].value);
  97                 list->tail = (list->tail + 1) & (HIDRAW_BUFFER_SIZE - 1);
  98         }
  99 out:
 100         mutex_unlock(&list->read_mutex);
 101         return ret;
 102 }
 103
 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)
 106 {
 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;
 110         __u8 *buf;
 111         int ret = 0;
 112
 113         if (!dev->hid_output_raw_report)
 114                 return -ENODEV;
 115
 116         if (count > HID_MIN_BUFFER_SIZE) {
 117                 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
 118                                 task_pid_nr(current));
 119                 return -EINVAL;
 120         }
 121
 122         if (count < 2) {
 123                 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
 124                                 task_pid_nr(current));
 125                 return -EINVAL;
 126         }
 127
 128         buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
 129         if (!buf)
 130                 return -ENOMEM;
 131
 132         if (copy_from_user(buf, buffer, count)) {
 133                 ret = -EFAULT;
 134                 goto out;
 135         }
 136
 137         ret = dev->hid_output_raw_report(dev, buf, count);
 138 out:
 139         kfree(buf);
 140         return ret;
 141 }
 142
 143 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
 144 {
 145         struct hidraw_list *list = file->private_data;
 146
 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;
 152         return 0;
 153 }
 154
 155 static int hidraw_open(struct inode *inode, struct file *file)
 156 {
 157         unsigned int minor = iminor(inode);
 158         struct hidraw *dev;
 159         struct hidraw_list *list;
 160         int err = 0;
 161
 162         lock_kernel();
 163         if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
 164                 err = -ENOMEM;
 165                 goto out;
 166         }
 167
 168         spin_lock(&minors_lock);
 169         if (!hidraw_table[minor]) {
 170                 printk(KERN_EMERG "hidraw device with minor %d doesn't exist\n",
 171                                 minor);
 172                 kfree(list);
 173                 err = -ENODEV;
 174                 goto out_unlock;
 175         }
 176
 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;
 181
 182         dev = hidraw_table[minor];
 183         if (!dev->open++)
 184                 dev->hid->hid_open(dev->hid);
 185
 186 out_unlock:
 187         spin_unlock(&minors_lock);
 188 out:
 189         unlock_kernel();
 190         return err;
 191
 192 }
 193
 194 static int hidraw_release(struct inode * inode, struct file * file)
 195 {
 196         unsigned int minor = iminor(inode);
 197         struct hidraw *dev;
 198         struct hidraw_list *list = file->private_data;
 199
 200         if (!hidraw_table[minor]) {
 201                 printk(KERN_EMERG "hidraw device with minor %d doesn't exist\n",
 202                                 minor);
 203                 return -ENODEV;
 204         }
 205
 206         list_del(&list->node);
 207         dev = hidraw_table[minor];
 208         if (!dev->open--) {
 209                 if (list->hidraw->exist)
 210                         dev->hid->hid_close(dev->hid);
 211                 else
 212                         kfree(list->hidraw);
 213         }
 214
 215         return 0;
 216 }
 217
 218 static long hidraw_ioctl(struct file *file, unsigned int cmd,
 219                                                         unsigned long arg)
 220 {
 221         struct inode *inode = file->f_path.dentry->d_inode;
 222         unsigned int minor = iminor(inode);
 223         long ret = 0;
 224         /* FIXME: What stops hidraw_table going NULL */
 225         struct hidraw *dev = hidraw_table[minor];
 226         void __user *user_arg = (void __user*) arg;
 227
 228         lock_kernel();
 229         switch (cmd) {
 230                 case HIDIOCGRDESCSIZE:
 231                         if (put_user(dev->hid->rsize, (int __user *)arg))
 232                                 ret = -EFAULT;
 233                         break;
 234
 235                 case HIDIOCGRDESC:
 236                         {
 237                                 __u32 len;
 238
 239                                 if (get_user(len, (int __user *)arg))
 240                                         ret = -EFAULT;
 241                                 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
 242                                         ret = -EINVAL;
 243                                 else if (copy_to_user(user_arg + offsetof(
 244                                         struct hidraw_report_descriptor,
 245                                         value[0]),
 246                                         dev->hid->rdesc,
 247                                         min(dev->hid->rsize, len)))
 248                                         ret = -EFAULT;
 249                                 break;
 250                         }
 251                 case HIDIOCGRAWINFO:
 252                         {
 253                                 struct hidraw_devinfo dinfo;
 254
 255                                 dinfo.bustype = dev->hid->bus;
 256                                 dinfo.vendor = dev->hid->vendor;
 257                                 dinfo.product = dev->hid->product;
 258                                 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
 259                                         ret = -EFAULT;
 260                                 break;
 261                         }
 262                 default:
 263                         ret = -ENOTTY;
 264         }
 265         return ret;
 266 }
 267
 268 static const struct file_operations hidraw_ops = {
 269         .owner =        THIS_MODULE,
 270         .read =         hidraw_read,
 271         .write =        hidraw_write,
 272         .poll =         hidraw_poll,
 273         .open =         hidraw_open,
 274         .release =      hidraw_release,
 275         .unlocked_ioctl = hidraw_ioctl,
 276 };
 277
 278 void hidraw_report_event(struct hid_device *hid, u8 *data, int len)
 279 {
 280         struct hidraw *dev = hid->hidraw;
 281         struct hidraw_list *list;
 282
 283         list_for_each_entry(list, &dev->list, node) {
 284                 list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC);
 285                 list->buffer[list->head].len = len;
 286                 list->head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
 287                 kill_fasync(&list->fasync, SIGIO, POLL_IN);
 288         }
 289
 290         wake_up_interruptible(&dev->wait);
 291 }
 292 EXPORT_SYMBOL_GPL(hidraw_report_event);
 293
 294 int hidraw_connect(struct hid_device *hid)
 295 {
 296         int minor, result;
 297         struct hidraw *dev;
 298
 299         /* TODO currently we accept any HID device. This should later
 300          * probably be fixed to accept only those devices which provide
 301          * non-input applications
 302          */
 303
 304         dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
 305         if (!dev)
 306                 return -ENOMEM;
 307
 308         result = -EINVAL;
 309
 310         spin_lock(&minors_lock);
 311
 312         for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
 313                 if (hidraw_table[minor])
 314                         continue;
 315                 hidraw_table[minor] = dev;
 316                 result = 0;
 317                 break;
 318         }
 319
 320         spin_unlock(&minors_lock);
 321
 322         if (result) {
 323                 kfree(dev);
 324                 goto out;
 325         }
 326
 327         dev->dev = device_create_drvdata(hidraw_class, NULL,
 328                                          MKDEV(hidraw_major, minor), NULL,
 329                                          "%s%d", "hidraw", minor);
 330
 331         if (IS_ERR(dev->dev)) {
 332                 spin_lock(&minors_lock);
 333                 hidraw_table[minor] = NULL;
 334                 spin_unlock(&minors_lock);
 335                 result = PTR_ERR(dev->dev);
 336                 kfree(dev);
 337                 goto out;
 338         }
 339
 340         init_waitqueue_head(&dev->wait);
 341         INIT_LIST_HEAD(&dev->list);
 342
 343         dev->hid = hid;
 344         dev->minor = minor;
 345
 346         dev->exist = 1;
 347         hid->hidraw = dev;
 348
 349 out:
 350         return result;
 351
 352 }
 353 EXPORT_SYMBOL_GPL(hidraw_connect);
 354
 355 void hidraw_disconnect(struct hid_device *hid)
 356 {
 357         struct hidraw *hidraw = hid->hidraw;
 358
 359         hidraw->exist = 0;
 360
 361         spin_lock(&minors_lock);
 362         hidraw_table[hidraw->minor] = NULL;
 363         spin_unlock(&minors_lock);
 364
 365         device_destroy(hidraw_class, MKDEV(hidraw_major, hidraw->minor));
 366
 367         if (hidraw->open) {
 368                 hid->hid_close(hid);
 369                 wake_up_interruptible(&hidraw->wait);
 370         } else {
 371                 kfree(hidraw);
 372         }
 373 }
 374 EXPORT_SYMBOL_GPL(hidraw_disconnect);
 375
 376 int __init hidraw_init(void)
 377 {
 378         int result;
 379         dev_t dev_id;
 380
 381         result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
 382                         HIDRAW_MAX_DEVICES, "hidraw");
 383
 384         hidraw_major = MAJOR(dev_id);
 385
 386         if (result < 0) {
 387                 printk(KERN_WARNING "hidraw: can't get major number\n");
 388                 result = 0;
 389                 goto out;
 390         }
 391
 392         hidraw_class = class_create(THIS_MODULE, "hidraw");
 393         if (IS_ERR(hidraw_class)) {
 394                 result = PTR_ERR(hidraw_class);
 395                 unregister_chrdev(hidraw_major, "hidraw");
 396                 goto out;
 397         }
 398
 399         cdev_init(&hidraw_cdev, &hidraw_ops);
 400         cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
 401 out:
 402         return result;
 403 }
 404
 405 void __exit hidraw_exit(void)
 406 {
 407         dev_t dev_id = MKDEV(hidraw_major, 0);
 408
 409         cdev_del(&hidraw_cdev);
 410         class_destroy(hidraw_class);
 411         unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);
 412
 413 }