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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  23
  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>
  37
  38 #include <linux/hidraw.h>
  39
  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);
  45
  46 static ssize_t hidraw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
  47 {
  48         struct hidraw_list *list = file->private_data;
  49         int ret = 0, len;
  50         DECLARE_WAITQUEUE(wait, current);
  51
  52         mutex_lock(&list->read_mutex);
  53
  54         while (ret == 0) {
  55                 if (list->head == list->tail) {
  56                         add_wait_queue(&list->hidraw->wait, &wait);
  57                         set_current_state(TASK_INTERRUPTIBLE);
  58
  59                         while (list->head == list->tail) {
  60                                 if (signal_pending(current)) {
  61                                         ret = -ERESTARTSYS;
  62                                         break;
  63                                 }
  64                                 if (!list->hidraw->exist) {
  65                                         ret = -EIO;
  66                                         break;
  67                                 }
  68                                 if (file->f_flags & O_NONBLOCK) {
  69                                         ret = -EAGAIN;
  70                                         break;
  71                                 }
  72
  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);
  78                         }
  79
  80                         set_current_state(TASK_RUNNING);
  81                         remove_wait_queue(&list->hidraw->wait, &wait);
  82                 }
  83
  84                 if (ret)
  85                         goto out;
  86
  87                 len = list->buffer[list->tail].len > count ?
  88                         count : list->buffer[list->tail].len;
  89
  90                 if (list->buffer[list->tail].value) {
  91                         if (copy_to_user(buffer, list->buffer[list->tail].value, len)) {
  92                                 ret = -EFAULT;
  93                                 goto out;
  94                         }
  95                         ret = len;
  96                 }
  97
  98                 kfree(list->buffer[list->tail].value);
  99                 list->buffer[list->tail].value = NULL;
 100                 list->tail = (list->tail + 1) & (HIDRAW_BUFFER_SIZE - 1);
 101         }
 102 out:
 103         mutex_unlock(&list->read_mutex);
 104         return ret;
 105 }
 106
 107 /* The first byte is expected to be a report number.
 108  * This function is to be called with the minors_lock mutex held */
 109 static ssize_t hidraw_send_report(struct file *file, const char __user *buffer, size_t count, unsigned char report_type)
 110 {
 111         unsigned int minor = iminor(file_inode(file));
 112         struct hid_device *dev;
 113         __u8 *buf;
 114         int ret = 0;
 115
 116         if (!hidraw_table[minor] || !hidraw_table[minor]->exist) {
 117                 ret = -ENODEV;
 118                 goto out;
 119         }
 120
 121         dev = hidraw_table[minor]->hid;
 122
 123         if (!dev->hid_output_raw_report) {
 124                 ret = -ENODEV;
 125                 goto out;
 126         }
 127
 128         if (count > HID_MAX_BUFFER_SIZE) {
 129                 hid_warn(dev, "pid %d passed too large report\n",
 130                          task_pid_nr(current));
 131                 ret = -EINVAL;
 132                 goto out;
 133         }
 134
 135         if (count < 2) {
 136                 hid_warn(dev, "pid %d passed too short report\n",
 137                          task_pid_nr(current));
 138                 ret = -EINVAL;
 139                 goto out;
 140         }
 141
 142         buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
 143         if (!buf) {
 144                 ret = -ENOMEM;
 145                 goto out;
 146         }
 147
 148         if (copy_from_user(buf, buffer, count)) {
 149                 ret = -EFAULT;
 150                 goto out_free;
 151         }
 152
 153         ret = dev->hid_output_raw_report(dev, buf, count, report_type);
 154 out_free:
 155         kfree(buf);
 156 out:
 157         return ret;
 158 }
 159
 160 /* the first byte is expected to be a report number */
 161 static ssize_t hidraw_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
 162 {
 163         ssize_t ret;
 164         mutex_lock(&minors_lock);
 165         ret = hidraw_send_report(file, buffer, count, HID_OUTPUT_REPORT);
 166         mutex_unlock(&minors_lock);
 167         return ret;
 168 }
 169
 170
 171 /* This function performs a Get_Report transfer over the control endpoint
 172  * per section 7.2.1 of the HID specification, version 1.1.  The first byte
 173  * of buffer is the report number to request, or 0x0 if the defice does not
 174  * use numbered reports. The report_type parameter can be HID_FEATURE_REPORT
 175  * or HID_INPUT_REPORT.  This function is to be called with the minors_lock
 176  *  mutex held. */
 177 static ssize_t hidraw_get_report(struct file *file, char __user *buffer, size_t count, unsigned char report_type)
 178 {
 179         unsigned int minor = iminor(file_inode(file));
 180         struct hid_device *dev;
 181         __u8 *buf;
 182         int ret = 0, len;
 183         unsigned char report_number;
 184
 185         dev = hidraw_table[minor]->hid;
 186
 187         if (!dev->hid_get_raw_report) {
 188                 ret = -ENODEV;
 189                 goto out;
 190         }
 191
 192         if (count > HID_MAX_BUFFER_SIZE) {
 193                 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
 194                                 task_pid_nr(current));
 195                 ret = -EINVAL;
 196                 goto out;
 197         }
 198
 199         if (count < 2) {
 200                 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
 201                                 task_pid_nr(current));
 202                 ret = -EINVAL;
 203                 goto out;
 204         }
 205
 206         buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
 207         if (!buf) {
 208                 ret = -ENOMEM;
 209                 goto out;
 210         }
 211
 212         /* Read the first byte from the user. This is the report number,
 213          * which is passed to dev->hid_get_raw_report(). */
 214         if (copy_from_user(&report_number, buffer, 1)) {
 215                 ret = -EFAULT;
 216                 goto out_free;
 217         }
 218
 219         ret = dev->hid_get_raw_report(dev, report_number, buf, count, report_type);
 220
 221         if (ret < 0)
 222                 goto out_free;
 223
 224         len = (ret < count) ? ret : count;
 225
 226         if (copy_to_user(buffer, buf, len)) {
 227                 ret = -EFAULT;
 228                 goto out_free;
 229         }
 230
 231         ret = len;
 232
 233 out_free:
 234         kfree(buf);
 235 out:
 236         return ret;
 237 }
 238
 239 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
 240 {
 241         struct hidraw_list *list = file->private_data;
 242
 243         poll_wait(file, &list->hidraw->wait, wait);
 244         if (list->head != list->tail)
 245                 return POLLIN | POLLRDNORM;
 246         if (!list->hidraw->exist)
 247                 return POLLERR | POLLHUP;
 248         return 0;
 249 }
 250
 251 static int hidraw_open(struct inode *inode, struct file *file)
 252 {
 253         unsigned int minor = iminor(inode);
 254         struct hidraw *dev;
 255         struct hidraw_list *list;
 256         unsigned long flags;
 257         int err = 0;
 258
 259         if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
 260                 err = -ENOMEM;
 261                 goto out;
 262         }
 263
 264         mutex_lock(&minors_lock);
 265         if (!hidraw_table[minor] || !hidraw_table[minor]->exist) {
 266                 err = -ENODEV;
 267                 goto out_unlock;
 268         }
 269
 270         dev = hidraw_table[minor];
 271         if (!dev->open++) {
 272                 err = hid_hw_power(dev->hid, PM_HINT_FULLON);
 273                 if (err < 0) {
 274                         dev->open--;
 275                         goto out_unlock;
 276                 }
 277
 278                 err = hid_hw_open(dev->hid);
 279                 if (err < 0) {
 280                         hid_hw_power(dev->hid, PM_HINT_NORMAL);
 281                         dev->open--;
 282                         goto out_unlock;
 283                 }
 284         }
 285
 286         list->hidraw = hidraw_table[minor];
 287         mutex_init(&list->read_mutex);
 288         spin_lock_irqsave(&hidraw_table[minor]->list_lock, flags);
 289         list_add_tail(&list->node, &hidraw_table[minor]->list);
 290         spin_unlock_irqrestore(&hidraw_table[minor]->list_lock, flags);
 291         file->private_data = list;
 292 out_unlock:
 293         mutex_unlock(&minors_lock);
 294 out:
 295         if (err < 0)
 296                 kfree(list);
 297         return err;
 298
 299 }
 300
 301 static int hidraw_fasync(int fd, struct file *file, int on)
 302 {
 303         struct hidraw_list *list = file->private_data;
 304
 305         return fasync_helper(fd, file, on, &list->fasync);
 306 }
 307
 308 static void drop_ref(struct hidraw *hidraw, int exists_bit)
 309 {
 310         if (exists_bit) {
 311                 hidraw->exist = 0;
 312                 if (hidraw->open) {
 313                         hid_hw_close(hidraw->hid);
 314                         wake_up_interruptible(&hidraw->wait);
 315                 }
 316         } else {
 317                 --hidraw->open;
 318         }
 319         if (!hidraw->open) {
 320                 if (!hidraw->exist) {
 321                         device_destroy(hidraw_class,
 322                                         MKDEV(hidraw_major, hidraw->minor));
 323                         hidraw_table[hidraw->minor] = NULL;
 324                         kfree(hidraw);
 325                 } else {
 326                         /* close device for last reader */
 327                         hid_hw_power(hidraw->hid, PM_HINT_NORMAL);
 328                         hid_hw_close(hidraw->hid);
 329                 }
 330         }
 331 }
 332
 333 static int hidraw_release(struct inode * inode, struct file * file)
 334 {
 335         unsigned int minor = iminor(inode);
 336         struct hidraw_list *list = file->private_data;
 337         unsigned long flags;
 338
 339         mutex_lock(&minors_lock);
 340
 341         spin_lock_irqsave(&hidraw_table[minor]->list_lock, flags);
 342         list_del(&list->node);
 343         spin_unlock_irqrestore(&hidraw_table[minor]->list_lock, flags);
 344         kfree(list);
 345
 346         drop_ref(hidraw_table[minor], 0);
 347
 348         mutex_unlock(&minors_lock);
 349         return 0;
 350 }
 351
 352 static long hidraw_ioctl(struct file *file, unsigned int cmd,
 353                                                         unsigned long arg)
 354 {
 355         struct inode *inode = file_inode(file);
 356         unsigned int minor = iminor(inode);
 357         long ret = 0;
 358         struct hidraw *dev;
 359         void __user *user_arg = (void __user*) arg;
 360
 361         mutex_lock(&minors_lock);
 362         dev = hidraw_table[minor];
 363         if (!dev) {
 364                 ret = -ENODEV;
 365                 goto out;
 366         }
 367
 368         switch (cmd) {
 369                 case HIDIOCGRDESCSIZE:
 370                         if (put_user(dev->hid->rsize, (int __user *)arg))
 371                                 ret = -EFAULT;
 372                         break;
 373
 374                 case HIDIOCGRDESC:
 375                         {
 376                                 __u32 len;
 377
 378                                 if (get_user(len, (int __user *)arg))
 379                                         ret = -EFAULT;
 380                                 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
 381                                         ret = -EINVAL;
 382                                 else if (copy_to_user(user_arg + offsetof(
 383                                         struct hidraw_report_descriptor,
 384                                         value[0]),
 385                                         dev->hid->rdesc,
 386                                         min(dev->hid->rsize, len)))
 387                                         ret = -EFAULT;
 388                                 break;
 389                         }
 390                 case HIDIOCGRAWINFO:
 391                         {
 392                                 struct hidraw_devinfo dinfo;
 393
 394                                 dinfo.bustype = dev->hid->bus;
 395                                 dinfo.vendor = dev->hid->vendor;
 396                                 dinfo.product = dev->hid->product;
 397                                 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
 398                                         ret = -EFAULT;
 399                                 break;
 400                         }
 401                 default:
 402                         {
 403                                 struct hid_device *hid = dev->hid;
 404                                 if (_IOC_TYPE(cmd) != 'H') {
 405                                         ret = -EINVAL;
 406                                         break;
 407                                 }
 408
 409                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCSFEATURE(0))) {
 410                                         int len = _IOC_SIZE(cmd);
 411                                         ret = hidraw_send_report(file, user_arg, len, HID_FEATURE_REPORT);
 412                                         break;
 413                                 }
 414                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGFEATURE(0))) {
 415                                         int len = _IOC_SIZE(cmd);
 416                                         ret = hidraw_get_report(file, user_arg, len, HID_FEATURE_REPORT);
 417                                         break;
 418                                 }
 419
 420                                 /* Begin Read-only ioctls. */
 421                                 if (_IOC_DIR(cmd) != _IOC_READ) {
 422                                         ret = -EINVAL;
 423                                         break;
 424                                 }
 425
 426                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWNAME(0))) {
 427                                         int len = strlen(hid->name) + 1;
 428                                         if (len > _IOC_SIZE(cmd))
 429                                                 len = _IOC_SIZE(cmd);
 430                                         ret = copy_to_user(user_arg, hid->name, len) ?
 431                                                 -EFAULT : len;
 432                                         break;
 433                                 }
 434
 435                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWPHYS(0))) {
 436                                         int len = strlen(hid->phys) + 1;
 437                                         if (len > _IOC_SIZE(cmd))
 438                                                 len = _IOC_SIZE(cmd);
 439                                         ret = copy_to_user(user_arg, hid->phys, len) ?
 440                                                 -EFAULT : len;
 441                                         break;
 442                                 }
 443                         }
 444
 445                 ret = -ENOTTY;
 446         }
 447 out:
 448         mutex_unlock(&minors_lock);
 449         return ret;
 450 }
 451
 452 static const struct file_operations hidraw_ops = {
 453         .owner =        THIS_MODULE,
 454         .read =         hidraw_read,
 455         .write =        hidraw_write,
 456         .poll =         hidraw_poll,
 457         .open =         hidraw_open,
 458         .release =      hidraw_release,
 459         .unlocked_ioctl = hidraw_ioctl,
 460         .fasync =       hidraw_fasync,
 461 #ifdef CONFIG_COMPAT
 462         .compat_ioctl   = hidraw_ioctl,
 463 #endif
 464         .llseek =       noop_llseek,
 465 };
 466
 467 int hidraw_report_event(struct hid_device *hid, u8 *data, int len)
 468 {
 469         struct hidraw *dev = hid->hidraw;
 470         struct hidraw_list *list;
 471         int ret = 0;
 472         unsigned long flags;
 473
 474         spin_lock_irqsave(&dev->list_lock, flags);
 475         list_for_each_entry(list, &dev->list, node) {
 476                 int new_head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
 477
 478                 if (new_head == list->tail)
 479                         continue;
 480
 481                 if (!(list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC))) {
 482                         ret = -ENOMEM;
 483                         break;
 484                 }
 485                 list->buffer[list->head].len = len;
 486                 list->head = new_head;
 487                 kill_fasync(&list->fasync, SIGIO, POLL_IN);
 488         }
 489         spin_unlock_irqrestore(&dev->list_lock, flags);
 490
 491         wake_up_interruptible(&dev->wait);
 492         return ret;
 493 }
 494 EXPORT_SYMBOL_GPL(hidraw_report_event);
 495
 496 int hidraw_connect(struct hid_device *hid)
 497 {
 498         int minor, result;
 499         struct hidraw *dev;
 500
 501         /* we accept any HID device, no matter the applications */
 502
 503         dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
 504         if (!dev)
 505                 return -ENOMEM;
 506
 507         result = -EINVAL;
 508
 509         mutex_lock(&minors_lock);
 510
 511         for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
 512                 if (hidraw_table[minor])
 513                         continue;
 514                 hidraw_table[minor] = dev;
 515                 result = 0;
 516                 break;
 517         }
 518
 519         if (result) {
 520                 mutex_unlock(&minors_lock);
 521                 kfree(dev);
 522                 goto out;
 523         }
 524
 525         dev->dev = device_create(hidraw_class, &hid->dev, MKDEV(hidraw_major, minor),
 526                                  NULL, "%s%d", "hidraw", minor);
 527
 528         if (IS_ERR(dev->dev)) {
 529                 hidraw_table[minor] = NULL;
 530                 mutex_unlock(&minors_lock);
 531                 result = PTR_ERR(dev->dev);
 532                 kfree(dev);
 533                 goto out;
 534         }
 535
 536         init_waitqueue_head(&dev->wait);
 537         spin_lock_init(&dev->list_lock);
 538         INIT_LIST_HEAD(&dev->list);
 539
 540         dev->hid = hid;
 541         dev->minor = minor;
 542
 543         dev->exist = 1;
 544         hid->hidraw = dev;
 545
 546         mutex_unlock(&minors_lock);
 547 out:
 548         return result;
 549
 550 }
 551 EXPORT_SYMBOL_GPL(hidraw_connect);
 552
 553 void hidraw_disconnect(struct hid_device *hid)
 554 {
 555         struct hidraw *hidraw = hid->hidraw;
 556
 557         mutex_lock(&minors_lock);
 558
 559         drop_ref(hidraw, 1);
 560
 561         mutex_unlock(&minors_lock);
 562 }
 563 EXPORT_SYMBOL_GPL(hidraw_disconnect);
 564
 565 int __init hidraw_init(void)
 566 {
 567         int result;
 568         dev_t dev_id;
 569
 570         result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
 571                         HIDRAW_MAX_DEVICES, "hidraw");
 572
 573         hidraw_major = MAJOR(dev_id);
 574
 575         if (result < 0) {
 576                 pr_warn("can't get major number\n");
 577                 goto out;
 578         }
 579
 580         hidraw_class = class_create(THIS_MODULE, "hidraw");
 581         if (IS_ERR(hidraw_class)) {
 582                 result = PTR_ERR(hidraw_class);
 583                 goto error_cdev;
 584         }
 585
 586         cdev_init(&hidraw_cdev, &hidraw_ops);
 587         result = cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
 588         if (result < 0)
 589                 goto error_class;
 590
 591         printk(KERN_INFO "hidraw: raw HID events driver (C) Jiri Kosina\n");
 592 out:
 593         return result;
 594
 595 error_class:
 596         class_destroy(hidraw_class);
 597 error_cdev:
 598         unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);
 599         goto out;
 600 }
 601
 602 void hidraw_exit(void)
 603 {
 604         dev_t dev_id = MKDEV(hidraw_major, 0);
 605
 606         cdev_del(&hidraw_cdev);
 607         class_destroy(hidraw_class);
 608         unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);
 609
 610 }