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