drivers/media/video/v4l2-dev.c

   1 /*
   2  * Video capture interface for Linux version 2
   3  *
   4  *      A generic video device interface for the LINUX operating system
   5  *      using a set of device structures/vectors for low level operations.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  *
  12  * Authors:     Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1)
  13  *              Mauro Carvalho Chehab <mchehab@infradead.org> (version 2)
  14  *
  15  * Fixes:       20000516  Claudio Matsuoka <claudio@conectiva.com>
  16  *              - Added procfs support
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/types.h>
  21 #include <linux/kernel.h>
  22 #include <linux/mm.h>
  23 #include <linux/string.h>
  24 #include <linux/errno.h>
  25 #include <linux/init.h>
  26 #include <linux/kmod.h>
  27 #include <linux/slab.h>
  28 #include <linux/smp_lock.h>
  29 #include <asm/uaccess.h>
  30 #include <asm/system.h>
  31
  32 #include <media/v4l2-common.h>
  33 #include <media/v4l2-device.h>
  34 #include <media/v4l2-ioctl.h>
  35
  36 #define VIDEO_NUM_DEVICES       256
  37 #define VIDEO_NAME              "video4linux"
  38
  39 /*
  40  *      sysfs stuff
  41  */
  42
  43 static ssize_t show_index(struct device *cd,
  44                          struct device_attribute *attr, char *buf)
  45 {
  46         struct video_device *vdev = to_video_device(cd);
  47
  48         return sprintf(buf, "%i\n", vdev->index);
  49 }
  50
  51 static ssize_t show_name(struct device *cd,
  52                          struct device_attribute *attr, char *buf)
  53 {
  54         struct video_device *vdev = to_video_device(cd);
  55
  56         return sprintf(buf, "%.*s\n", (int)sizeof(vdev->name), vdev->name);
  57 }
  58
  59 static struct device_attribute video_device_attrs[] = {
  60         __ATTR(name, S_IRUGO, show_name, NULL),
  61         __ATTR(index, S_IRUGO, show_index, NULL),
  62         __ATTR_NULL
  63 };
  64
  65 /*
  66  *      Active devices
  67  */
  68 static struct video_device *video_device[VIDEO_NUM_DEVICES];
  69 static DEFINE_MUTEX(videodev_lock);
  70 static DECLARE_BITMAP(video_nums[VFL_TYPE_MAX], VIDEO_NUM_DEVICES);
  71
  72 struct video_device *video_device_alloc(void)
  73 {
  74         return kzalloc(sizeof(struct video_device), GFP_KERNEL);
  75 }
  76 EXPORT_SYMBOL(video_device_alloc);
  77
  78 void video_device_release(struct video_device *vdev)
  79 {
  80         kfree(vdev);
  81 }
  82 EXPORT_SYMBOL(video_device_release);
  83
  84 void video_device_release_empty(struct video_device *vdev)
  85 {
  86         /* Do nothing */
  87         /* Only valid when the video_device struct is a static. */
  88 }
  89 EXPORT_SYMBOL(video_device_release_empty);
  90
  91 static inline void video_get(struct video_device *vdev)
  92 {
  93         get_device(&vdev->dev);
  94 }
  95
  96 static inline void video_put(struct video_device *vdev)
  97 {
  98         put_device(&vdev->dev);
  99 }
 100
 101 /* Called when the last user of the video device exits. */
 102 static void v4l2_device_release(struct device *cd)
 103 {
 104         struct video_device *vdev = to_video_device(cd);
 105
 106         mutex_lock(&videodev_lock);
 107         if (video_device[vdev->minor] != vdev) {
 108                 mutex_unlock(&videodev_lock);
 109                 /* should not happen */
 110                 WARN_ON(1);
 111                 return;
 112         }
 113
 114         /* Free up this device for reuse */
 115         video_device[vdev->minor] = NULL;
 116
 117         /* Delete the cdev on this minor as well */
 118         cdev_del(vdev->cdev);
 119         /* Just in case some driver tries to access this from
 120            the release() callback. */
 121         vdev->cdev = NULL;
 122
 123         /* Mark minor as free */
 124         clear_bit(vdev->num, video_nums[vdev->vfl_type]);
 125
 126         mutex_unlock(&videodev_lock);
 127
 128         /* Release video_device and perform other
 129            cleanups as needed. */
 130         vdev->release(vdev);
 131 }
 132
 133 static struct class video_class = {
 134         .name = VIDEO_NAME,
 135         .dev_attrs = video_device_attrs,
 136 };
 137
 138 struct video_device *video_devdata(struct file *file)
 139 {
 140         return video_device[iminor(file->f_path.dentry->d_inode)];
 141 }
 142 EXPORT_SYMBOL(video_devdata);
 143
 144 static ssize_t v4l2_read(struct file *filp, char __user *buf,
 145                 size_t sz, loff_t *off)
 146 {
 147         struct video_device *vdev = video_devdata(filp);
 148
 149         if (!vdev->fops->read)
 150                 return -EINVAL;
 151         if (video_is_unregistered(vdev))
 152                 return -EIO;
 153         return vdev->fops->read(filp, buf, sz, off);
 154 }
 155
 156 static ssize_t v4l2_write(struct file *filp, const char __user *buf,
 157                 size_t sz, loff_t *off)
 158 {
 159         struct video_device *vdev = video_devdata(filp);
 160
 161         if (!vdev->fops->write)
 162                 return -EINVAL;
 163         if (video_is_unregistered(vdev))
 164                 return -EIO;
 165         return vdev->fops->write(filp, buf, sz, off);
 166 }
 167
 168 static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
 169 {
 170         struct video_device *vdev = video_devdata(filp);
 171
 172         if (!vdev->fops->poll || video_is_unregistered(vdev))
 173                 return DEFAULT_POLLMASK;
 174         return vdev->fops->poll(filp, poll);
 175 }
 176
 177 static int v4l2_ioctl(struct inode *inode, struct file *filp,
 178                 unsigned int cmd, unsigned long arg)
 179 {
 180         struct video_device *vdev = video_devdata(filp);
 181
 182         if (!vdev->fops->ioctl)
 183                 return -ENOTTY;
 184         /* Allow ioctl to continue even if the device was unregistered.
 185            Things like dequeueing buffers might still be useful. */
 186         return vdev->fops->ioctl(filp, cmd, arg);
 187 }
 188
 189 static long v4l2_unlocked_ioctl(struct file *filp,
 190                 unsigned int cmd, unsigned long arg)
 191 {
 192         struct video_device *vdev = video_devdata(filp);
 193
 194         if (!vdev->fops->unlocked_ioctl)
 195                 return -ENOTTY;
 196         /* Allow ioctl to continue even if the device was unregistered.
 197            Things like dequeueing buffers might still be useful. */
 198         return vdev->fops->unlocked_ioctl(filp, cmd, arg);
 199 }
 200
 201 static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
 202 {
 203         struct video_device *vdev = video_devdata(filp);
 204
 205         if (!vdev->fops->mmap ||
 206             video_is_unregistered(vdev))
 207                 return -ENODEV;
 208         return vdev->fops->mmap(filp, vm);
 209 }
 210
 211 /* Override for the open function */
 212 static int v4l2_open(struct inode *inode, struct file *filp)
 213 {
 214         struct video_device *vdev;
 215         int ret;
 216
 217         /* Check if the video device is available */
 218         mutex_lock(&videodev_lock);
 219         vdev = video_devdata(filp);
 220         /* return ENODEV if the video device has been removed
 221            already or if it is not registered anymore. */
 222         if (vdev == NULL || video_is_unregistered(vdev)) {
 223                 mutex_unlock(&videodev_lock);
 224                 return -ENODEV;
 225         }
 226         /* and increase the device refcount */
 227         video_get(vdev);
 228         mutex_unlock(&videodev_lock);
 229         ret = vdev->fops->open(filp);
 230         /* decrease the refcount in case of an error */
 231         if (ret)
 232                 video_put(vdev);
 233         return ret;
 234 }
 235
 236 /* Override for the release function */
 237 static int v4l2_release(struct inode *inode, struct file *filp)
 238 {
 239         struct video_device *vdev = video_devdata(filp);
 240         int ret = vdev->fops->release(filp);
 241
 242         /* decrease the refcount unconditionally since the release()
 243            return value is ignored. */
 244         video_put(vdev);
 245         return ret;
 246 }
 247
 248 static const struct file_operations v4l2_unlocked_fops = {
 249         .owner = THIS_MODULE,
 250         .read = v4l2_read,
 251         .write = v4l2_write,
 252         .open = v4l2_open,
 253         .mmap = v4l2_mmap,
 254         .unlocked_ioctl = v4l2_unlocked_ioctl,
 255 #ifdef CONFIG_COMPAT
 256         .compat_ioctl = v4l2_compat_ioctl32,
 257 #endif
 258         .release = v4l2_release,
 259         .poll = v4l2_poll,
 260         .llseek = no_llseek,
 261 };
 262
 263 static const struct file_operations v4l2_fops = {
 264         .owner = THIS_MODULE,
 265         .read = v4l2_read,
 266         .write = v4l2_write,
 267         .open = v4l2_open,
 268         .mmap = v4l2_mmap,
 269         .ioctl = v4l2_ioctl,
 270 #ifdef CONFIG_COMPAT
 271         .compat_ioctl = v4l2_compat_ioctl32,
 272 #endif
 273         .release = v4l2_release,
 274         .poll = v4l2_poll,
 275         .llseek = no_llseek,
 276 };
 277
 278 /**
 279  * get_index - assign stream number based on parent device
 280  * @vdev: video_device to assign index number to, vdev->parent should be assigned
 281  * @num:  -1 if auto assign, requested number otherwise
 282  *
 283  * Note that when this is called the new device has not yet been registered
 284  * in the video_device array.
 285  *
 286  * Returns -ENFILE if num is already in use, a free index number if
 287  * successful.
 288  */
 289 static int get_index(struct video_device *vdev, int num)
 290 {
 291         /* This can be static since this function is called with the global
 292            videodev_lock held. */
 293         static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
 294         int i;
 295
 296         if (num >= VIDEO_NUM_DEVICES) {
 297                 printk(KERN_ERR "videodev: %s num is too large\n", __func__);
 298                 return -EINVAL;
 299         }
 300
 301         /* Some drivers do not set the parent. In that case always return
 302            num or 0. */
 303         if (vdev->parent == NULL)
 304                 return num >= 0 ? num : 0;
 305
 306         bitmap_zero(used, VIDEO_NUM_DEVICES);
 307
 308         for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
 309                 if (video_device[i] != NULL &&
 310                     video_device[i]->parent == vdev->parent) {
 311                         set_bit(video_device[i]->index, used);
 312                 }
 313         }
 314
 315         if (num >= 0) {
 316                 if (test_bit(num, used))
 317                         return -ENFILE;
 318                 return num;
 319         }
 320
 321         i = find_first_zero_bit(used, VIDEO_NUM_DEVICES);
 322         return i == VIDEO_NUM_DEVICES ? -ENFILE : i;
 323 }
 324
 325 int video_register_device(struct video_device *vdev, int type, int nr)
 326 {
 327         return video_register_device_index(vdev, type, nr, -1);
 328 }
 329 EXPORT_SYMBOL(video_register_device);
 330
 331 /**
 332  *      video_register_device_index - register video4linux devices
 333  *      @vdev: video device structure we want to register
 334  *      @type: type of device to register
 335  *      @nr:   which device number (0 == /dev/video0, 1 == /dev/video1, ...
 336  *             -1 == first free)
 337  *      @index: stream number based on parent device;
 338  *              -1 if auto assign, requested number otherwise
 339  *
 340  *      The registration code assigns minor numbers based on the type
 341  *      requested. -ENFILE is returned in all the device slots for this
 342  *      category are full. If not then the minor field is set and the
 343  *      driver initialize function is called (if non %NULL).
 344  *
 345  *      Zero is returned on success.
 346  *
 347  *      Valid types are
 348  *
 349  *      %VFL_TYPE_GRABBER - A frame grabber
 350  *
 351  *      %VFL_TYPE_VTX - A teletext device
 352  *
 353  *      %VFL_TYPE_VBI - Vertical blank data (undecoded)
 354  *
 355  *      %VFL_TYPE_RADIO - A radio card
 356  */
 357 int video_register_device_index(struct video_device *vdev, int type, int nr,
 358                                         int index)
 359 {
 360         int i = 0;
 361         int ret;
 362         int minor_offset = 0;
 363         int minor_cnt = VIDEO_NUM_DEVICES;
 364         const char *name_base;
 365         void *priv = video_get_drvdata(vdev);
 366
 367         /* A minor value of -1 marks this video device as never
 368            having been registered */
 369         if (vdev)
 370                 vdev->minor = -1;
 371
 372         /* the release callback MUST be present */
 373         WARN_ON(!vdev || !vdev->release);
 374         if (!vdev || !vdev->release)
 375                 return -EINVAL;
 376
 377         /* Part 1: check device type */
 378         switch (type) {
 379         case VFL_TYPE_GRABBER:
 380                 name_base = "video";
 381                 break;
 382         case VFL_TYPE_VTX:
 383                 name_base = "vtx";
 384                 break;
 385         case VFL_TYPE_VBI:
 386                 name_base = "vbi";
 387                 break;
 388         case VFL_TYPE_RADIO:
 389                 name_base = "radio";
 390                 break;
 391         default:
 392                 printk(KERN_ERR "%s called with unknown type: %d\n",
 393                        __func__, type);
 394                 return -EINVAL;
 395         }
 396
 397         vdev->vfl_type = type;
 398         vdev->cdev = NULL;
 399         if (vdev->v4l2_dev)
 400                 vdev->parent = vdev->v4l2_dev->dev;
 401
 402         /* Part 2: find a free minor, kernel number and device index. */
 403 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
 404         /* Keep the ranges for the first four types for historical
 405          * reasons.
 406          * Newer devices (not yet in place) should use the range
 407          * of 128-191 and just pick the first free minor there
 408          * (new style). */
 409         switch (type) {
 410         case VFL_TYPE_GRABBER:
 411                 minor_offset = 0;
 412                 minor_cnt = 64;
 413                 break;
 414         case VFL_TYPE_RADIO:
 415                 minor_offset = 64;
 416                 minor_cnt = 64;
 417                 break;
 418         case VFL_TYPE_VTX:
 419                 minor_offset = 192;
 420                 minor_cnt = 32;
 421                 break;
 422         case VFL_TYPE_VBI:
 423                 minor_offset = 224;
 424                 minor_cnt = 32;
 425                 break;
 426         default:
 427                 minor_offset = 128;
 428                 minor_cnt = 64;
 429                 break;
 430         }
 431 #endif
 432
 433         /* Pick a minor number */
 434         mutex_lock(&videodev_lock);
 435         nr = find_next_zero_bit(video_nums[type], minor_cnt, nr == -1 ? 0 : nr);
 436         if (nr == minor_cnt)
 437                 nr = find_first_zero_bit(video_nums[type], minor_cnt);
 438         if (nr == minor_cnt) {
 439                 printk(KERN_ERR "could not get a free kernel number\n");
 440                 mutex_unlock(&videodev_lock);
 441                 return -ENFILE;
 442         }
 443 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
 444         /* 1-on-1 mapping of kernel number to minor number */
 445         i = nr;
 446 #else
 447         /* The kernel number and minor numbers are independent */
 448         for (i = 0; i < VIDEO_NUM_DEVICES; i++)
 449                 if (video_device[i] == NULL)
 450                         break;
 451         if (i == VIDEO_NUM_DEVICES) {
 452                 mutex_unlock(&videodev_lock);
 453                 printk(KERN_ERR "could not get a free minor\n");
 454                 return -ENFILE;
 455         }
 456 #endif
 457         vdev->minor = i + minor_offset;
 458         vdev->num = nr;
 459         set_bit(nr, video_nums[type]);
 460         /* Should not happen since we thought this minor was free */
 461         WARN_ON(video_device[vdev->minor] != NULL);
 462         ret = vdev->index = get_index(vdev, index);
 463         mutex_unlock(&videodev_lock);
 464
 465         if (ret < 0) {
 466                 printk(KERN_ERR "%s: get_index failed\n", __func__);
 467                 goto cleanup;
 468         }
 469
 470         /* Part 3: Initialize the character device */
 471         vdev->cdev = cdev_alloc();
 472         if (vdev->cdev == NULL) {
 473                 ret = -ENOMEM;
 474                 goto cleanup;
 475         }
 476         if (vdev->fops->unlocked_ioctl)
 477                 vdev->cdev->ops = &v4l2_unlocked_fops;
 478         else
 479                 vdev->cdev->ops = &v4l2_fops;
 480         vdev->cdev->owner = vdev->fops->owner;
 481         ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
 482         if (ret < 0) {
 483                 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
 484                 kfree(vdev->cdev);
 485                 vdev->cdev = NULL;
 486                 goto cleanup;
 487         }
 488
 489         /* Part 4: register the device with sysfs */
 490         memset(&vdev->dev, 0, sizeof(vdev->dev));
 491         /* The memset above cleared the device's drvdata, so
 492            put back the copy we made earlier. */
 493         video_set_drvdata(vdev, priv);
 494         vdev->dev.class = &video_class;
 495         vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
 496         if (vdev->parent)
 497                 vdev->dev.parent = vdev->parent;
 498         dev_set_name(&vdev->dev, "%s%d", name_base, nr);
 499         ret = device_register(&vdev->dev);
 500         if (ret < 0) {
 501                 printk(KERN_ERR "%s: device_register failed\n", __func__);
 502                 goto cleanup;
 503         }
 504         /* Register the release callback that will be called when the last
 505            reference to the device goes away. */
 506         vdev->dev.release = v4l2_device_release;
 507
 508         /* Part 5: Activate this minor. The char device can now be used. */
 509         mutex_lock(&videodev_lock);
 510         video_device[vdev->minor] = vdev;
 511         mutex_unlock(&videodev_lock);
 512         return 0;
 513
 514 cleanup:
 515         mutex_lock(&videodev_lock);
 516         if (vdev->cdev)
 517                 cdev_del(vdev->cdev);
 518         clear_bit(vdev->num, video_nums[type]);
 519         mutex_unlock(&videodev_lock);
 520         /* Mark this video device as never having been registered. */
 521         vdev->minor = -1;
 522         return ret;
 523 }
 524 EXPORT_SYMBOL(video_register_device_index);
 525
 526 /**
 527  *      video_unregister_device - unregister a video4linux device
 528  *      @vdev: the device to unregister
 529  *
 530  *      This unregisters the passed device. Future open calls will
 531  *      be met with errors.
 532  */
 533 void video_unregister_device(struct video_device *vdev)
 534 {
 535         /* Check if vdev was ever registered at all */
 536         if (!vdev || vdev->minor < 0)
 537                 return;
 538
 539         mutex_lock(&videodev_lock);
 540         set_bit(V4L2_FL_UNREGISTERED, &vdev->flags);
 541         mutex_unlock(&videodev_lock);
 542         device_unregister(&vdev->dev);
 543 }
 544 EXPORT_SYMBOL(video_unregister_device);
 545
 546 /*
 547  *      Initialise video for linux
 548  */
 549 static int __init videodev_init(void)
 550 {
 551         dev_t dev = MKDEV(VIDEO_MAJOR, 0);
 552         int ret;
 553
 554         printk(KERN_INFO "Linux video capture interface: v2.00\n");
 555         ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
 556         if (ret < 0) {
 557                 printk(KERN_WARNING "videodev: unable to get major %d\n",
 558                                 VIDEO_MAJOR);
 559                 return ret;
 560         }
 561
 562         ret = class_register(&video_class);
 563         if (ret < 0) {
 564                 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
 565                 printk(KERN_WARNING "video_dev: class_register failed\n");
 566                 return -EIO;
 567         }
 568
 569         return 0;
 570 }
 571
 572 static void __exit videodev_exit(void)
 573 {
 574         dev_t dev = MKDEV(VIDEO_MAJOR, 0);
 575
 576         class_unregister(&video_class);
 577         unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
 578 }
 579
 580 module_init(videodev_init)
 581 module_exit(videodev_exit)
 582
 583 MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
 584 MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
 585 MODULE_LICENSE("GPL");
 586
 587
 588 /*
 589  * Local variables:
 590  * c-basic-offset: 8
 591  * End:
 592  */