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