2 * Video capture interface for Linux version 2
4 * A generic video device interface for the LINUX operating system
5 * using a set of device structures/vectors for low level operations.
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.
12 * Authors: Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1)
13 * Mauro Carvalho Chehab <mchehab@infradead.org> (version 2)
15 * Fixes: 20000516 Claudio Matsuoka <claudio@conectiva.com>
16 * - Added procfs support
19 #include <linux/module.h>
20 #include <linux/types.h>
21 #include <linux/kernel.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 <asm/uaccess.h>
29 #include <asm/system.h>
31 #include <media/v4l2-common.h>
32 #include <media/v4l2-device.h>
33 #include <media/v4l2-ioctl.h>
35 #define VIDEO_NUM_DEVICES 256
36 #define VIDEO_NAME "video4linux"
42 static ssize_t
show_index(struct device
*cd
,
43 struct device_attribute
*attr
, char *buf
)
45 struct video_device
*vdev
= to_video_device(cd
);
47 return sprintf(buf
, "%i\n", vdev
->index
);
50 static ssize_t
show_name(struct device
*cd
,
51 struct device_attribute
*attr
, char *buf
)
53 struct video_device
*vdev
= to_video_device(cd
);
55 return sprintf(buf
, "%.*s\n", (int)sizeof(vdev
->name
), vdev
->name
);
58 static struct device_attribute video_device_attrs
[] = {
59 __ATTR(name
, S_IRUGO
, show_name
, NULL
),
60 __ATTR(index
, S_IRUGO
, show_index
, NULL
),
67 static struct video_device
*video_device
[VIDEO_NUM_DEVICES
];
68 static DEFINE_MUTEX(videodev_lock
);
69 static DECLARE_BITMAP(devnode_nums
[VFL_TYPE_MAX
], VIDEO_NUM_DEVICES
);
71 /* Device node utility functions */
73 /* Note: these utility functions all assume that vfl_type is in the range
74 [0, VFL_TYPE_MAX-1]. */
76 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
77 /* Return the bitmap corresponding to vfl_type. */
78 static inline unsigned long *devnode_bits(int vfl_type
)
80 /* Any types not assigned to fixed minor ranges must be mapped to
81 one single bitmap for the purposes of finding a free node number
82 since all those unassigned types use the same minor range. */
83 int idx
= (vfl_type
> VFL_TYPE_RADIO
) ? VFL_TYPE_MAX
- 1 : vfl_type
;
85 return devnode_nums
[idx
];
88 /* Return the bitmap corresponding to vfl_type. */
89 static inline unsigned long *devnode_bits(int vfl_type
)
91 return devnode_nums
[vfl_type
];
95 /* Mark device node number vdev->num as used */
96 static inline void devnode_set(struct video_device
*vdev
)
98 set_bit(vdev
->num
, devnode_bits(vdev
->vfl_type
));
101 /* Mark device node number vdev->num as unused */
102 static inline void devnode_clear(struct video_device
*vdev
)
104 clear_bit(vdev
->num
, devnode_bits(vdev
->vfl_type
));
107 /* Try to find a free device node number in the range [from, to> */
108 static inline int devnode_find(struct video_device
*vdev
, int from
, int to
)
110 return find_next_zero_bit(devnode_bits(vdev
->vfl_type
), to
, from
);
113 struct video_device
*video_device_alloc(void)
115 return kzalloc(sizeof(struct video_device
), GFP_KERNEL
);
117 EXPORT_SYMBOL(video_device_alloc
);
119 void video_device_release(struct video_device
*vdev
)
123 EXPORT_SYMBOL(video_device_release
);
125 void video_device_release_empty(struct video_device
*vdev
)
128 /* Only valid when the video_device struct is a static. */
130 EXPORT_SYMBOL(video_device_release_empty
);
132 static inline void video_get(struct video_device
*vdev
)
134 get_device(&vdev
->dev
);
137 static inline void video_put(struct video_device
*vdev
)
139 put_device(&vdev
->dev
);
142 /* Called when the last user of the video device exits. */
143 static void v4l2_device_release(struct device
*cd
)
145 struct video_device
*vdev
= to_video_device(cd
);
146 struct v4l2_device
*v4l2_dev
= vdev
->v4l2_dev
;
148 mutex_lock(&videodev_lock
);
149 if (video_device
[vdev
->minor
] != vdev
) {
150 mutex_unlock(&videodev_lock
);
151 /* should not happen */
156 /* Free up this device for reuse */
157 video_device
[vdev
->minor
] = NULL
;
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. */
165 /* Mark device node number as free */
168 mutex_unlock(&videodev_lock
);
170 /* Release video_device and perform other
171 cleanups as needed. */
174 /* Decrease v4l2_device refcount */
176 v4l2_device_put(v4l2_dev
);
179 static struct class video_class
= {
181 .dev_attrs
= video_device_attrs
,
184 struct video_device
*video_devdata(struct file
*file
)
186 return video_device
[iminor(file
->f_path
.dentry
->d_inode
)];
188 EXPORT_SYMBOL(video_devdata
);
191 /* Priority handling */
193 static inline bool prio_is_valid(enum v4l2_priority prio
)
195 return prio
== V4L2_PRIORITY_BACKGROUND
||
196 prio
== V4L2_PRIORITY_INTERACTIVE
||
197 prio
== V4L2_PRIORITY_RECORD
;
200 void v4l2_prio_init(struct v4l2_prio_state
*global
)
202 memset(global
, 0, sizeof(*global
));
204 EXPORT_SYMBOL(v4l2_prio_init
);
206 int v4l2_prio_change(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
,
207 enum v4l2_priority
new)
209 if (!prio_is_valid(new))
214 atomic_inc(&global
->prios
[new]);
215 if (prio_is_valid(*local
))
216 atomic_dec(&global
->prios
[*local
]);
220 EXPORT_SYMBOL(v4l2_prio_change
);
222 void v4l2_prio_open(struct v4l2_prio_state
*global
, enum v4l2_priority
*local
)
224 v4l2_prio_change(global
, local
, V4L2_PRIORITY_DEFAULT
);
226 EXPORT_SYMBOL(v4l2_prio_open
);
228 void v4l2_prio_close(struct v4l2_prio_state
*global
, enum v4l2_priority local
)
230 if (prio_is_valid(local
))
231 atomic_dec(&global
->prios
[local
]);
233 EXPORT_SYMBOL(v4l2_prio_close
);
235 enum v4l2_priority
v4l2_prio_max(struct v4l2_prio_state
*global
)
237 if (atomic_read(&global
->prios
[V4L2_PRIORITY_RECORD
]) > 0)
238 return V4L2_PRIORITY_RECORD
;
239 if (atomic_read(&global
->prios
[V4L2_PRIORITY_INTERACTIVE
]) > 0)
240 return V4L2_PRIORITY_INTERACTIVE
;
241 if (atomic_read(&global
->prios
[V4L2_PRIORITY_BACKGROUND
]) > 0)
242 return V4L2_PRIORITY_BACKGROUND
;
243 return V4L2_PRIORITY_UNSET
;
245 EXPORT_SYMBOL(v4l2_prio_max
);
247 int v4l2_prio_check(struct v4l2_prio_state
*global
, enum v4l2_priority local
)
249 return (local
< v4l2_prio_max(global
)) ? -EBUSY
: 0;
251 EXPORT_SYMBOL(v4l2_prio_check
);
254 static ssize_t
v4l2_read(struct file
*filp
, char __user
*buf
,
255 size_t sz
, loff_t
*off
)
257 struct video_device
*vdev
= video_devdata(filp
);
260 if (!vdev
->fops
->read
)
262 if (vdev
->lock
&& mutex_lock_interruptible(vdev
->lock
))
264 if (video_is_registered(vdev
))
265 ret
= vdev
->fops
->read(filp
, buf
, sz
, off
);
267 mutex_unlock(vdev
->lock
);
271 static ssize_t
v4l2_write(struct file
*filp
, const char __user
*buf
,
272 size_t sz
, loff_t
*off
)
274 struct video_device
*vdev
= video_devdata(filp
);
277 if (!vdev
->fops
->write
)
279 if (vdev
->lock
&& mutex_lock_interruptible(vdev
->lock
))
281 if (video_is_registered(vdev
))
282 ret
= vdev
->fops
->write(filp
, buf
, sz
, off
);
284 mutex_unlock(vdev
->lock
);
288 static unsigned int v4l2_poll(struct file
*filp
, struct poll_table_struct
*poll
)
290 struct video_device
*vdev
= video_devdata(filp
);
291 int ret
= POLLERR
| POLLHUP
;
293 if (!vdev
->fops
->poll
)
294 return DEFAULT_POLLMASK
;
296 mutex_lock(vdev
->lock
);
297 if (video_is_registered(vdev
))
298 ret
= vdev
->fops
->poll(filp
, poll
);
300 mutex_unlock(vdev
->lock
);
304 static long v4l2_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
306 struct video_device
*vdev
= video_devdata(filp
);
309 if (vdev
->fops
->unlocked_ioctl
) {
310 if (vdev
->lock
&& mutex_lock_interruptible(vdev
->lock
))
312 if (video_is_registered(vdev
))
313 ret
= vdev
->fops
->unlocked_ioctl(filp
, cmd
, arg
);
315 mutex_unlock(vdev
->lock
);
316 } else if (vdev
->fops
->ioctl
) {
317 /* This code path is a replacement for the BKL. It is a major
318 * hack but it will have to do for those drivers that are not
319 * yet converted to use unlocked_ioctl.
321 * There are two options: if the driver implements struct
322 * v4l2_device, then the lock defined there is used to
323 * serialize the ioctls. Otherwise the v4l2 core lock defined
324 * below is used. This lock is really bad since it serializes
325 * completely independent devices.
327 * Both variants suffer from the same problem: if the driver
328 * sleeps, then it blocks all ioctls since the lock is still
329 * held. This is very common for VIDIOC_DQBUF since that
330 * normally waits for a frame to arrive. As a result any other
331 * ioctl calls will proceed very, very slowly since each call
332 * will have to wait for the VIDIOC_QBUF to finish. Things that
333 * should take 0.01s may now take 10-20 seconds.
335 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
336 * This actually works OK for videobuf-based drivers, since
337 * videobuf will take its own internal lock.
339 static DEFINE_MUTEX(v4l2_ioctl_mutex
);
340 struct mutex
*m
= vdev
->v4l2_dev
?
341 &vdev
->v4l2_dev
->ioctl_lock
: &v4l2_ioctl_mutex
;
343 if (cmd
!= VIDIOC_DQBUF
&& mutex_lock_interruptible(m
))
345 if (video_is_registered(vdev
))
346 ret
= vdev
->fops
->ioctl(filp
, cmd
, arg
);
347 if (cmd
!= VIDIOC_DQBUF
)
355 static int v4l2_mmap(struct file
*filp
, struct vm_area_struct
*vm
)
357 struct video_device
*vdev
= video_devdata(filp
);
360 if (!vdev
->fops
->mmap
)
362 if (vdev
->lock
&& mutex_lock_interruptible(vdev
->lock
))
364 if (video_is_registered(vdev
))
365 ret
= vdev
->fops
->mmap(filp
, vm
);
367 mutex_unlock(vdev
->lock
);
371 /* Override for the open function */
372 static int v4l2_open(struct inode
*inode
, struct file
*filp
)
374 struct video_device
*vdev
;
375 #if defined(CONFIG_MEDIA_CONTROLLER)
376 struct media_entity
*entity
= NULL
;
380 /* Check if the video device is available */
381 mutex_lock(&videodev_lock
);
382 vdev
= video_devdata(filp
);
383 /* return ENODEV if the video device has already been removed. */
384 if (vdev
== NULL
|| !video_is_registered(vdev
)) {
385 mutex_unlock(&videodev_lock
);
388 /* and increase the device refcount */
390 mutex_unlock(&videodev_lock
);
391 #if defined(CONFIG_MEDIA_CONTROLLER)
392 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->mdev
) {
393 entity
= media_entity_get(&vdev
->entity
);
401 if (vdev
->fops
->open
) {
402 if (vdev
->lock
&& mutex_lock_interruptible(vdev
->lock
)) {
406 if (video_is_registered(vdev
))
407 ret
= vdev
->fops
->open(filp
);
411 mutex_unlock(vdev
->lock
);
415 /* decrease the refcount in case of an error */
417 #if defined(CONFIG_MEDIA_CONTROLLER)
418 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->mdev
)
419 media_entity_put(entity
);
426 /* Override for the release function */
427 static int v4l2_release(struct inode
*inode
, struct file
*filp
)
429 struct video_device
*vdev
= video_devdata(filp
);
432 if (vdev
->fops
->release
) {
434 mutex_lock(vdev
->lock
);
435 vdev
->fops
->release(filp
);
437 mutex_unlock(vdev
->lock
);
439 #if defined(CONFIG_MEDIA_CONTROLLER)
440 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->mdev
)
441 media_entity_put(&vdev
->entity
);
443 /* decrease the refcount unconditionally since the release()
444 return value is ignored. */
449 static const struct file_operations v4l2_fops
= {
450 .owner
= THIS_MODULE
,
455 .unlocked_ioctl
= v4l2_ioctl
,
457 .compat_ioctl
= v4l2_compat_ioctl32
,
459 .release
= v4l2_release
,
465 * get_index - assign stream index number based on parent device
466 * @vdev: video_device to assign index number to, vdev->parent should be assigned
468 * Note that when this is called the new device has not yet been registered
469 * in the video_device array, but it was able to obtain a minor number.
471 * This means that we can always obtain a free stream index number since
472 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
473 * use of the video_device array.
475 * Returns a free index number.
477 static int get_index(struct video_device
*vdev
)
479 /* This can be static since this function is called with the global
480 videodev_lock held. */
481 static DECLARE_BITMAP(used
, VIDEO_NUM_DEVICES
);
484 /* Some drivers do not set the parent. In that case always return 0. */
485 if (vdev
->parent
== NULL
)
488 bitmap_zero(used
, VIDEO_NUM_DEVICES
);
490 for (i
= 0; i
< VIDEO_NUM_DEVICES
; i
++) {
491 if (video_device
[i
] != NULL
&&
492 video_device
[i
]->parent
== vdev
->parent
) {
493 set_bit(video_device
[i
]->index
, used
);
497 return find_first_zero_bit(used
, VIDEO_NUM_DEVICES
);
501 * __video_register_device - register video4linux devices
502 * @vdev: video device structure we want to register
503 * @type: type of device to register
504 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
506 * @warn_if_nr_in_use: warn if the desired device node number
507 * was already in use and another number was chosen instead.
508 * @owner: module that owns the video device node
510 * The registration code assigns minor numbers and device node numbers
511 * based on the requested type and registers the new device node with
514 * This function assumes that struct video_device was zeroed when it
515 * was allocated and does not contain any stale date.
517 * An error is returned if no free minor or device node number could be
518 * found, or if the registration of the device node failed.
520 * Zero is returned on success.
524 * %VFL_TYPE_GRABBER - A frame grabber
526 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
528 * %VFL_TYPE_RADIO - A radio card
530 * %VFL_TYPE_SUBDEV - A subdevice
532 int __video_register_device(struct video_device
*vdev
, int type
, int nr
,
533 int warn_if_nr_in_use
, struct module
*owner
)
537 int minor_offset
= 0;
538 int minor_cnt
= VIDEO_NUM_DEVICES
;
539 const char *name_base
;
541 /* A minor value of -1 marks this video device as never
542 having been registered */
545 /* the release callback MUST be present */
546 WARN_ON(!vdev
->release
);
550 /* v4l2_fh support */
551 spin_lock_init(&vdev
->fh_lock
);
552 INIT_LIST_HEAD(&vdev
->fh_list
);
554 /* Part 1: check device type */
556 case VFL_TYPE_GRABBER
:
565 case VFL_TYPE_SUBDEV
:
566 name_base
= "v4l-subdev";
569 printk(KERN_ERR
"%s called with unknown type: %d\n",
574 vdev
->vfl_type
= type
;
576 if (vdev
->v4l2_dev
) {
577 if (vdev
->v4l2_dev
->dev
)
578 vdev
->parent
= vdev
->v4l2_dev
->dev
;
579 if (vdev
->ctrl_handler
== NULL
)
580 vdev
->ctrl_handler
= vdev
->v4l2_dev
->ctrl_handler
;
581 /* If the prio state pointer is NULL, then use the v4l2_device
583 if (vdev
->prio
== NULL
)
584 vdev
->prio
= &vdev
->v4l2_dev
->prio
;
587 /* Part 2: find a free minor, device node number and device index. */
588 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
589 /* Keep the ranges for the first four types for historical
591 * Newer devices (not yet in place) should use the range
592 * of 128-191 and just pick the first free minor there
595 case VFL_TYPE_GRABBER
:
614 /* Pick a device node number */
615 mutex_lock(&videodev_lock
);
616 nr
= devnode_find(vdev
, nr
== -1 ? 0 : nr
, minor_cnt
);
618 nr
= devnode_find(vdev
, 0, minor_cnt
);
619 if (nr
== minor_cnt
) {
620 printk(KERN_ERR
"could not get a free device node number\n");
621 mutex_unlock(&videodev_lock
);
624 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
625 /* 1-on-1 mapping of device node number to minor number */
628 /* The device node number and minor numbers are independent, so
629 we just find the first free minor number. */
630 for (i
= 0; i
< VIDEO_NUM_DEVICES
; i
++)
631 if (video_device
[i
] == NULL
)
633 if (i
== VIDEO_NUM_DEVICES
) {
634 mutex_unlock(&videodev_lock
);
635 printk(KERN_ERR
"could not get a free minor\n");
639 vdev
->minor
= i
+ minor_offset
;
643 /* Should not happen since we thought this minor was free */
644 WARN_ON(video_device
[vdev
->minor
] != NULL
);
645 vdev
->index
= get_index(vdev
);
646 mutex_unlock(&videodev_lock
);
648 /* Part 3: Initialize the character device */
649 vdev
->cdev
= cdev_alloc();
650 if (vdev
->cdev
== NULL
) {
654 vdev
->cdev
->ops
= &v4l2_fops
;
655 vdev
->cdev
->owner
= owner
;
656 ret
= cdev_add(vdev
->cdev
, MKDEV(VIDEO_MAJOR
, vdev
->minor
), 1);
658 printk(KERN_ERR
"%s: cdev_add failed\n", __func__
);
664 /* Part 4: register the device with sysfs */
665 vdev
->dev
.class = &video_class
;
666 vdev
->dev
.devt
= MKDEV(VIDEO_MAJOR
, vdev
->minor
);
668 vdev
->dev
.parent
= vdev
->parent
;
669 dev_set_name(&vdev
->dev
, "%s%d", name_base
, vdev
->num
);
670 ret
= device_register(&vdev
->dev
);
672 printk(KERN_ERR
"%s: device_register failed\n", __func__
);
675 /* Register the release callback that will be called when the last
676 reference to the device goes away. */
677 vdev
->dev
.release
= v4l2_device_release
;
679 if (nr
!= -1 && nr
!= vdev
->num
&& warn_if_nr_in_use
)
680 printk(KERN_WARNING
"%s: requested %s%d, got %s\n", __func__
,
681 name_base
, nr
, video_device_node_name(vdev
));
683 /* Increase v4l2_device refcount */
685 v4l2_device_get(vdev
->v4l2_dev
);
687 #if defined(CONFIG_MEDIA_CONTROLLER)
688 /* Part 5: Register the entity. */
689 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->mdev
) {
690 vdev
->entity
.type
= MEDIA_ENT_T_DEVNODE_V4L
;
691 vdev
->entity
.name
= vdev
->name
;
692 vdev
->entity
.v4l
.major
= VIDEO_MAJOR
;
693 vdev
->entity
.v4l
.minor
= vdev
->minor
;
694 ret
= media_device_register_entity(vdev
->v4l2_dev
->mdev
,
698 "%s: media_device_register_entity failed\n",
702 /* Part 6: Activate this minor. The char device can now be used. */
703 set_bit(V4L2_FL_REGISTERED
, &vdev
->flags
);
704 mutex_lock(&videodev_lock
);
705 video_device
[vdev
->minor
] = vdev
;
706 mutex_unlock(&videodev_lock
);
711 mutex_lock(&videodev_lock
);
713 cdev_del(vdev
->cdev
);
715 mutex_unlock(&videodev_lock
);
716 /* Mark this video device as never having been registered. */
720 EXPORT_SYMBOL(__video_register_device
);
723 * video_unregister_device - unregister a video4linux device
724 * @vdev: the device to unregister
726 * This unregisters the passed device. Future open calls will
727 * be met with errors.
729 void video_unregister_device(struct video_device
*vdev
)
731 /* Check if vdev was ever registered at all */
732 if (!vdev
|| !video_is_registered(vdev
))
735 #if defined(CONFIG_MEDIA_CONTROLLER)
736 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->mdev
)
737 media_device_unregister_entity(&vdev
->entity
);
740 mutex_lock(&videodev_lock
);
741 /* This must be in a critical section to prevent a race with v4l2_open.
742 * Once this bit has been cleared video_get may never be called again.
744 clear_bit(V4L2_FL_REGISTERED
, &vdev
->flags
);
745 mutex_unlock(&videodev_lock
);
746 device_unregister(&vdev
->dev
);
748 EXPORT_SYMBOL(video_unregister_device
);
751 * Initialise video for linux
753 static int __init
videodev_init(void)
755 dev_t dev
= MKDEV(VIDEO_MAJOR
, 0);
758 printk(KERN_INFO
"Linux video capture interface: v2.00\n");
759 ret
= register_chrdev_region(dev
, VIDEO_NUM_DEVICES
, VIDEO_NAME
);
761 printk(KERN_WARNING
"videodev: unable to get major %d\n",
766 ret
= class_register(&video_class
);
768 unregister_chrdev_region(dev
, VIDEO_NUM_DEVICES
);
769 printk(KERN_WARNING
"video_dev: class_register failed\n");
776 static void __exit
videodev_exit(void)
778 dev_t dev
= MKDEV(VIDEO_MAJOR
, 0);
780 class_unregister(&video_class
);
781 unregister_chrdev_region(dev
, VIDEO_NUM_DEVICES
);
784 module_init(videodev_init
)
785 module_exit(videodev_exit
)
787 MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
788 MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
789 MODULE_LICENSE("GPL");
790 MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR
);