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/sched.h>
  34 #include <linux/smp_lock.h>
  35
  36 #include <linux/hidraw.h>
  37
  38 static int hidraw_major;
  39 static struct cdev hidraw_cdev;
  40 static struct class *hidraw_class;
  41 static struct hidraw *hidraw_table[HIDRAW_MAX_DEVICES];
  42 static DEFINE_MUTEX(minors_lock);
  43
  44 static ssize_t hidraw_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
  45 {
  46         struct hidraw_list *list = file->private_data;
  47         int ret = 0, len;
  48         char *report;
  49         DECLARE_WAITQUEUE(wait, current);
  50
  51         mutex_lock(&list->read_mutex);
  52
  53         while (ret == 0) {
  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         struct hid_device *dev;
 109         __u8 *buf;
 110         int ret = 0;
 111
 112         mutex_lock(&minors_lock);
 113         dev = hidraw_table[minor]->hid;
 114
 115         if (!dev->hid_output_raw_report) {
 116                 ret = -ENODEV;
 117                 goto out;
 118         }
 119
 120         if (count > HID_MAX_BUFFER_SIZE) {
 121                 printk(KERN_WARNING "hidraw: pid %d passed too large report\n",
 122                                 task_pid_nr(current));
 123                 ret = -EINVAL;
 124                 goto out;
 125         }
 126
 127         if (count < 2) {
 128                 printk(KERN_WARNING "hidraw: pid %d passed too short report\n",
 129                                 task_pid_nr(current));
 130                 ret = -EINVAL;
 131                 goto out;
 132         }
 133
 134         buf = kmalloc(count * sizeof(__u8), GFP_KERNEL);
 135         if (!buf) {
 136                 ret = -ENOMEM;
 137                 goto out;
 138         }
 139
 140         if (copy_from_user(buf, buffer, count)) {
 141                 ret = -EFAULT;
 142                 goto out_free;
 143         }
 144
 145         ret = dev->hid_output_raw_report(dev, buf, count, HID_OUTPUT_REPORT);
 146 out_free:
 147         kfree(buf);
 148 out:
 149         mutex_unlock(&minors_lock);
 150         return ret;
 151 }
 152
 153 static unsigned int hidraw_poll(struct file *file, poll_table *wait)
 154 {
 155         struct hidraw_list *list = file->private_data;
 156
 157         poll_wait(file, &list->hidraw->wait, wait);
 158         if (list->head != list->tail)
 159                 return POLLIN | POLLRDNORM;
 160         if (!list->hidraw->exist)
 161                 return POLLERR | POLLHUP;
 162         return 0;
 163 }
 164
 165 static int hidraw_open(struct inode *inode, struct file *file)
 166 {
 167         unsigned int minor = iminor(inode);
 168         struct hidraw *dev;
 169         struct hidraw_list *list;
 170         int err = 0;
 171
 172         if (!(list = kzalloc(sizeof(struct hidraw_list), GFP_KERNEL))) {
 173                 err = -ENOMEM;
 174                 goto out;
 175         }
 176
 177         mutex_lock(&minors_lock);
 178         if (!hidraw_table[minor]) {
 179                 kfree(list);
 180                 err = -ENODEV;
 181                 goto out_unlock;
 182         }
 183
 184         list->hidraw = hidraw_table[minor];
 185         mutex_init(&list->read_mutex);
 186         list_add_tail(&list->node, &hidraw_table[minor]->list);
 187         file->private_data = list;
 188
 189         dev = hidraw_table[minor];
 190         if (!dev->open++) {
 191                 if (dev->hid->ll_driver->power) {
 192                         err = dev->hid->ll_driver->power(dev->hid, PM_HINT_FULLON);
 193                         if (err < 0)
 194                                 goto out_unlock;
 195                 }
 196                 err = dev->hid->ll_driver->open(dev->hid);
 197                 if (err < 0) {
 198                         if (dev->hid->ll_driver->power)
 199                                 dev->hid->ll_driver->power(dev->hid, PM_HINT_NORMAL);
 200                         dev->open--;
 201                 }
 202         }
 203
 204 out_unlock:
 205         mutex_unlock(&minors_lock);
 206 out:
 207         return err;
 208
 209 }
 210
 211 static int hidraw_release(struct inode * inode, struct file * file)
 212 {
 213         unsigned int minor = iminor(inode);
 214         struct hidraw *dev;
 215         struct hidraw_list *list = file->private_data;
 216
 217         if (!hidraw_table[minor])
 218                 return -ENODEV;
 219
 220         list_del(&list->node);
 221         dev = hidraw_table[minor];
 222         if (!--dev->open) {
 223                 if (list->hidraw->exist) {
 224                         if (dev->hid->ll_driver->power)
 225                                 dev->hid->ll_driver->power(dev->hid, PM_HINT_NORMAL);
 226                         dev->hid->ll_driver->close(dev->hid);
 227                 } else {
 228                         kfree(list->hidraw);
 229                 }
 230         }
 231
 232         kfree(list);
 233
 234         return 0;
 235 }
 236
 237 static long hidraw_ioctl(struct file *file, unsigned int cmd,
 238                                                         unsigned long arg)
 239 {
 240         struct inode *inode = file->f_path.dentry->d_inode;
 241         unsigned int minor = iminor(inode);
 242         long ret = 0;
 243         struct hidraw *dev;
 244         void __user *user_arg = (void __user*) arg;
 245
 246         mutex_lock(&minors_lock);
 247         dev = hidraw_table[minor];
 248
 249         switch (cmd) {
 250                 case HIDIOCGRDESCSIZE:
 251                         if (put_user(dev->hid->rsize, (int __user *)arg))
 252                                 ret = -EFAULT;
 253                         break;
 254
 255                 case HIDIOCGRDESC:
 256                         {
 257                                 __u32 len;
 258
 259                                 if (get_user(len, (int __user *)arg))
 260                                         ret = -EFAULT;
 261                                 else if (len > HID_MAX_DESCRIPTOR_SIZE - 1)
 262                                         ret = -EINVAL;
 263                                 else if (copy_to_user(user_arg + offsetof(
 264                                         struct hidraw_report_descriptor,
 265                                         value[0]),
 266                                         dev->hid->rdesc,
 267                                         min(dev->hid->rsize, len)))
 268                                         ret = -EFAULT;
 269                                 break;
 270                         }
 271                 case HIDIOCGRAWINFO:
 272                         {
 273                                 struct hidraw_devinfo dinfo;
 274
 275                                 dinfo.bustype = dev->hid->bus;
 276                                 dinfo.vendor = dev->hid->vendor;
 277                                 dinfo.product = dev->hid->product;
 278                                 if (copy_to_user(user_arg, &dinfo, sizeof(dinfo)))
 279                                         ret = -EFAULT;
 280                                 break;
 281                         }
 282                 default:
 283                         {
 284                                 struct hid_device *hid = dev->hid;
 285                                 if (_IOC_TYPE(cmd) != 'H' || _IOC_DIR(cmd) != _IOC_READ) {
 286                                         ret = -EINVAL;
 287                                         break;
 288                                 }
 289
 290                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWNAME(0))) {
 291                                         int len;
 292                                         if (!hid->name) {
 293                                                 ret = 0;
 294                                                 break;
 295                                         }
 296                                         len = strlen(hid->name) + 1;
 297                                         if (len > _IOC_SIZE(cmd))
 298                                                 len = _IOC_SIZE(cmd);
 299                                         ret = copy_to_user(user_arg, hid->name, len) ?
 300                                                 -EFAULT : len;
 301                                         break;
 302                                 }
 303
 304                                 if (_IOC_NR(cmd) == _IOC_NR(HIDIOCGRAWPHYS(0))) {
 305                                         int len;
 306                                         if (!hid->phys) {
 307                                                 ret = 0;
 308                                                 break;
 309                                         }
 310                                         len = strlen(hid->phys) + 1;
 311                                         if (len > _IOC_SIZE(cmd))
 312                                                 len = _IOC_SIZE(cmd);
 313                                         ret = copy_to_user(user_arg, hid->phys, len) ?
 314                                                 -EFAULT : len;
 315                                         break;
 316                                 }
 317                 }
 318
 319                 ret = -ENOTTY;
 320         }
 321         mutex_unlock(&minors_lock);
 322         return ret;
 323 }
 324
 325 static const struct file_operations hidraw_ops = {
 326         .owner =        THIS_MODULE,
 327         .read =         hidraw_read,
 328         .write =        hidraw_write,
 329         .poll =         hidraw_poll,
 330         .open =         hidraw_open,
 331         .release =      hidraw_release,
 332         .unlocked_ioctl = hidraw_ioctl,
 333 };
 334
 335 void hidraw_report_event(struct hid_device *hid, u8 *data, int len)
 336 {
 337         struct hidraw *dev = hid->hidraw;
 338         struct hidraw_list *list;
 339
 340         list_for_each_entry(list, &dev->list, node) {
 341                 list->buffer[list->head].value = kmemdup(data, len, GFP_ATOMIC);
 342                 list->buffer[list->head].len = len;
 343                 list->head = (list->head + 1) & (HIDRAW_BUFFER_SIZE - 1);
 344                 kill_fasync(&list->fasync, SIGIO, POLL_IN);
 345         }
 346
 347         wake_up_interruptible(&dev->wait);
 348 }
 349 EXPORT_SYMBOL_GPL(hidraw_report_event);
 350
 351 int hidraw_connect(struct hid_device *hid)
 352 {
 353         int minor, result;
 354         struct hidraw *dev;
 355
 356         /* we accept any HID device, no matter the applications */
 357
 358         dev = kzalloc(sizeof(struct hidraw), GFP_KERNEL);
 359         if (!dev)
 360                 return -ENOMEM;
 361
 362         result = -EINVAL;
 363
 364         mutex_lock(&minors_lock);
 365
 366         for (minor = 0; minor < HIDRAW_MAX_DEVICES; minor++) {
 367                 if (hidraw_table[minor])
 368                         continue;
 369                 hidraw_table[minor] = dev;
 370                 result = 0;
 371                 break;
 372         }
 373
 374         if (result) {
 375                 mutex_unlock(&minors_lock);
 376                 kfree(dev);
 377                 goto out;
 378         }
 379
 380         dev->dev = device_create(hidraw_class, &hid->dev, MKDEV(hidraw_major, minor),
 381                                  NULL, "%s%d", "hidraw", minor);
 382
 383         if (IS_ERR(dev->dev)) {
 384                 hidraw_table[minor] = NULL;
 385                 mutex_unlock(&minors_lock);
 386                 result = PTR_ERR(dev->dev);
 387                 kfree(dev);
 388                 goto out;
 389         }
 390
 391         mutex_unlock(&minors_lock);
 392         init_waitqueue_head(&dev->wait);
 393         INIT_LIST_HEAD(&dev->list);
 394
 395         dev->hid = hid;
 396         dev->minor = minor;
 397
 398         dev->exist = 1;
 399         hid->hidraw = dev;
 400
 401 out:
 402         return result;
 403
 404 }
 405 EXPORT_SYMBOL_GPL(hidraw_connect);
 406
 407 void hidraw_disconnect(struct hid_device *hid)
 408 {
 409         struct hidraw *hidraw = hid->hidraw;
 410
 411         hidraw->exist = 0;
 412
 413         mutex_lock(&minors_lock);
 414         hidraw_table[hidraw->minor] = NULL;
 415         mutex_unlock(&minors_lock);
 416
 417         device_destroy(hidraw_class, MKDEV(hidraw_major, hidraw->minor));
 418
 419         if (hidraw->open) {
 420                 hid->ll_driver->close(hid);
 421                 wake_up_interruptible(&hidraw->wait);
 422         } else {
 423                 kfree(hidraw);
 424         }
 425 }
 426 EXPORT_SYMBOL_GPL(hidraw_disconnect);
 427
 428 int __init hidraw_init(void)
 429 {
 430         int result;
 431         dev_t dev_id;
 432
 433         result = alloc_chrdev_region(&dev_id, HIDRAW_FIRST_MINOR,
 434                         HIDRAW_MAX_DEVICES, "hidraw");
 435
 436         hidraw_major = MAJOR(dev_id);
 437
 438         if (result < 0) {
 439                 printk(KERN_WARNING "hidraw: can't get major number\n");
 440                 result = 0;
 441                 goto out;
 442         }
 443
 444         hidraw_class = class_create(THIS_MODULE, "hidraw");
 445         if (IS_ERR(hidraw_class)) {
 446                 result = PTR_ERR(hidraw_class);
 447                 unregister_chrdev(hidraw_major, "hidraw");
 448                 goto out;
 449         }
 450
 451         cdev_init(&hidraw_cdev, &hidraw_ops);
 452         cdev_add(&hidraw_cdev, dev_id, HIDRAW_MAX_DEVICES);
 453 out:
 454         return result;
 455 }
 456
 457 void hidraw_exit(void)
 458 {
 459         dev_t dev_id = MKDEV(hidraw_major, 0);
 460
 461         cdev_del(&hidraw_cdev);
 462         class_destroy(hidraw_class);
 463         unregister_chrdev_region(dev_id, HIDRAW_MAX_DEVICES);
 464
 465 }