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(video_nums
[VFL_TYPE_MAX
], VIDEO_NUM_DEVICES
);
71 struct video_device
*video_device_alloc(void)
73 return kzalloc(sizeof(struct video_device
), GFP_KERNEL
);
75 EXPORT_SYMBOL(video_device_alloc
);
77 void video_device_release(struct video_device
*vdev
)
81 EXPORT_SYMBOL(video_device_release
);
83 void video_device_release_empty(struct video_device
*vdev
)
86 /* Only valid when the video_device struct is a static. */
88 EXPORT_SYMBOL(video_device_release_empty
);
90 static inline void video_get(struct video_device
*vdev
)
92 get_device(&vdev
->dev
);
95 static inline void video_put(struct video_device
*vdev
)
97 put_device(&vdev
->dev
);
100 /* Called when the last user of the video device exits. */
101 static void v4l2_device_release(struct device
*cd
)
103 struct video_device
*vdev
= to_video_device(cd
);
105 mutex_lock(&videodev_lock
);
106 if (video_device
[vdev
->minor
] != vdev
) {
107 mutex_unlock(&videodev_lock
);
108 /* should not happen */
113 /* Free up this device for reuse */
114 video_device
[vdev
->minor
] = NULL
;
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. */
122 /* Mark minor as free */
123 clear_bit(vdev
->num
, video_nums
[vdev
->vfl_type
]);
125 mutex_unlock(&videodev_lock
);
127 /* Release video_device and perform other
128 cleanups as needed. */
132 static struct class video_class
= {
134 .dev_attrs
= video_device_attrs
,
137 struct video_device
*video_devdata(struct file
*file
)
139 return video_device
[iminor(file
->f_path
.dentry
->d_inode
)];
141 EXPORT_SYMBOL(video_devdata
);
143 static ssize_t
v4l2_read(struct file
*filp
, char __user
*buf
,
144 size_t sz
, loff_t
*off
)
146 struct video_device
*vdev
= video_devdata(filp
);
148 if (!vdev
->fops
->read
)
150 if (video_is_unregistered(vdev
))
152 return vdev
->fops
->read(filp
, buf
, sz
, off
);
155 static ssize_t
v4l2_write(struct file
*filp
, const char __user
*buf
,
156 size_t sz
, loff_t
*off
)
158 struct video_device
*vdev
= video_devdata(filp
);
160 if (!vdev
->fops
->write
)
162 if (video_is_unregistered(vdev
))
164 return vdev
->fops
->write(filp
, buf
, sz
, off
);
167 static unsigned int v4l2_poll(struct file
*filp
, struct poll_table_struct
*poll
)
169 struct video_device
*vdev
= video_devdata(filp
);
171 if (!vdev
->fops
->poll
|| video_is_unregistered(vdev
))
172 return DEFAULT_POLLMASK
;
173 return vdev
->fops
->poll(filp
, poll
);
176 static int v4l2_ioctl(struct inode
*inode
, struct file
*filp
,
177 unsigned int cmd
, unsigned long arg
)
179 struct video_device
*vdev
= video_devdata(filp
);
181 if (!vdev
->fops
->ioctl
)
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(filp
, cmd
, arg
);
188 static long v4l2_unlocked_ioctl(struct file
*filp
,
189 unsigned int cmd
, unsigned long arg
)
191 struct video_device
*vdev
= video_devdata(filp
);
193 if (!vdev
->fops
->unlocked_ioctl
)
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
);
201 #define v4l2_get_unmapped_area NULL
203 static unsigned long v4l2_get_unmapped_area(struct file
*filp
,
204 unsigned long addr
, unsigned long len
, unsigned long pgoff
,
207 struct video_device
*vdev
= video_devdata(filp
);
209 if (!vdev
->fops
->get_unmapped_area
)
211 if (video_is_unregistered(vdev
))
213 return vdev
->fops
->get_unmapped_area(filp
, addr
, len
, pgoff
, flags
);
217 static int v4l2_mmap(struct file
*filp
, struct vm_area_struct
*vm
)
219 struct video_device
*vdev
= video_devdata(filp
);
221 if (!vdev
->fops
->mmap
||
222 video_is_unregistered(vdev
))
224 return vdev
->fops
->mmap(filp
, vm
);
227 /* Override for the open function */
228 static int v4l2_open(struct inode
*inode
, struct file
*filp
)
230 struct video_device
*vdev
;
233 /* Check if the video device is available */
234 mutex_lock(&videodev_lock
);
235 vdev
= video_devdata(filp
);
236 /* return ENODEV if the video device has been removed
237 already or if it is not registered anymore. */
238 if (vdev
== NULL
|| video_is_unregistered(vdev
)) {
239 mutex_unlock(&videodev_lock
);
242 /* and increase the device refcount */
244 mutex_unlock(&videodev_lock
);
245 if (vdev
->fops
->open
)
246 ret
= vdev
->fops
->open(filp
);
248 /* decrease the refcount in case of an error */
254 /* Override for the release function */
255 static int v4l2_release(struct inode
*inode
, struct file
*filp
)
257 struct video_device
*vdev
= video_devdata(filp
);
260 if (vdev
->fops
->release
)
261 vdev
->fops
->release(filp
);
263 /* decrease the refcount unconditionally since the release()
264 return value is ignored. */
269 static const struct file_operations v4l2_unlocked_fops
= {
270 .owner
= THIS_MODULE
,
274 .get_unmapped_area
= v4l2_get_unmapped_area
,
276 .unlocked_ioctl
= v4l2_unlocked_ioctl
,
278 .compat_ioctl
= v4l2_compat_ioctl32
,
280 .release
= v4l2_release
,
285 static const struct file_operations v4l2_fops
= {
286 .owner
= THIS_MODULE
,
290 .get_unmapped_area
= v4l2_get_unmapped_area
,
294 .compat_ioctl
= v4l2_compat_ioctl32
,
296 .release
= v4l2_release
,
302 * get_index - assign stream number based on parent device
303 * @vdev: video_device to assign index number to, vdev->parent should be assigned
304 * @num: -1 if auto assign, requested number otherwise
306 * Note that when this is called the new device has not yet been registered
307 * in the video_device array.
309 * Returns -ENFILE if num is already in use, a free index number if
312 static int get_index(struct video_device
*vdev
, int num
)
314 /* This can be static since this function is called with the global
315 videodev_lock held. */
316 static DECLARE_BITMAP(used
, VIDEO_NUM_DEVICES
);
319 if (num
>= VIDEO_NUM_DEVICES
) {
320 printk(KERN_ERR
"videodev: %s num is too large\n", __func__
);
324 /* Some drivers do not set the parent. In that case always return
326 if (vdev
->parent
== NULL
)
327 return num
>= 0 ? num
: 0;
329 bitmap_zero(used
, VIDEO_NUM_DEVICES
);
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
);
339 if (test_bit(num
, used
))
344 i
= find_first_zero_bit(used
, VIDEO_NUM_DEVICES
);
345 return i
== VIDEO_NUM_DEVICES
? -ENFILE
: i
;
348 int video_register_device(struct video_device
*vdev
, int type
, int nr
)
350 return video_register_device_index(vdev
, type
, nr
, -1);
352 EXPORT_SYMBOL(video_register_device
);
355 * video_register_device_index - register video4linux devices
356 * @vdev: video device structure we want to register
357 * @type: type of device to register
358 * @nr: which device number (0 == /dev/video0, 1 == /dev/video1, ...
360 * @index: stream number based on parent device;
361 * -1 if auto assign, requested number otherwise
363 * The registration code assigns minor numbers based on the type
364 * requested. -ENFILE is returned in all the device slots for this
365 * category are full. If not then the minor field is set and the
366 * driver initialize function is called (if non %NULL).
368 * Zero is returned on success.
372 * %VFL_TYPE_GRABBER - A frame grabber
374 * %VFL_TYPE_VTX - A teletext device
376 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
378 * %VFL_TYPE_RADIO - A radio card
380 int video_register_device_index(struct video_device
*vdev
, int type
, int nr
,
385 int minor_offset
= 0;
386 int minor_cnt
= VIDEO_NUM_DEVICES
;
387 const char *name_base
;
388 void *priv
= video_get_drvdata(vdev
);
390 /* A minor value of -1 marks this video device as never
391 having been registered */
394 /* the release callback MUST be present */
395 WARN_ON(!vdev
->release
);
399 /* Part 1: check device type */
401 case VFL_TYPE_GRABBER
:
414 printk(KERN_ERR
"%s called with unknown type: %d\n",
419 vdev
->vfl_type
= type
;
421 if (vdev
->v4l2_dev
&& vdev
->v4l2_dev
->dev
)
422 vdev
->parent
= vdev
->v4l2_dev
->dev
;
424 /* Part 2: find a free minor, kernel number and device index. */
425 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
426 /* Keep the ranges for the first four types for historical
428 * Newer devices (not yet in place) should use the range
429 * of 128-191 and just pick the first free minor there
432 case VFL_TYPE_GRABBER
:
455 /* Pick a minor number */
456 mutex_lock(&videodev_lock
);
457 nr
= find_next_zero_bit(video_nums
[type
], minor_cnt
, nr
== -1 ? 0 : nr
);
459 nr
= find_first_zero_bit(video_nums
[type
], minor_cnt
);
460 if (nr
== minor_cnt
) {
461 printk(KERN_ERR
"could not get a free kernel number\n");
462 mutex_unlock(&videodev_lock
);
465 #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
466 /* 1-on-1 mapping of kernel number to minor number */
469 /* The kernel number and minor numbers are independent */
470 for (i
= 0; i
< VIDEO_NUM_DEVICES
; i
++)
471 if (video_device
[i
] == NULL
)
473 if (i
== VIDEO_NUM_DEVICES
) {
474 mutex_unlock(&videodev_lock
);
475 printk(KERN_ERR
"could not get a free minor\n");
479 vdev
->minor
= i
+ minor_offset
;
481 set_bit(nr
, video_nums
[type
]);
482 /* Should not happen since we thought this minor was free */
483 WARN_ON(video_device
[vdev
->minor
] != NULL
);
484 ret
= vdev
->index
= get_index(vdev
, index
);
485 mutex_unlock(&videodev_lock
);
488 printk(KERN_ERR
"%s: get_index failed\n", __func__
);
492 /* Part 3: Initialize the character device */
493 vdev
->cdev
= cdev_alloc();
494 if (vdev
->cdev
== NULL
) {
498 if (vdev
->fops
->unlocked_ioctl
)
499 vdev
->cdev
->ops
= &v4l2_unlocked_fops
;
501 vdev
->cdev
->ops
= &v4l2_fops
;
502 vdev
->cdev
->owner
= vdev
->fops
->owner
;
503 ret
= cdev_add(vdev
->cdev
, MKDEV(VIDEO_MAJOR
, vdev
->minor
), 1);
505 printk(KERN_ERR
"%s: cdev_add failed\n", __func__
);
511 /* Part 4: register the device with sysfs */
512 memset(&vdev
->dev
, 0, sizeof(vdev
->dev
));
513 /* The memset above cleared the device's drvdata, so
514 put back the copy we made earlier. */
515 video_set_drvdata(vdev
, priv
);
516 vdev
->dev
.class = &video_class
;
517 vdev
->dev
.devt
= MKDEV(VIDEO_MAJOR
, vdev
->minor
);
519 vdev
->dev
.parent
= vdev
->parent
;
520 dev_set_name(&vdev
->dev
, "%s%d", name_base
, nr
);
521 ret
= device_register(&vdev
->dev
);
523 printk(KERN_ERR
"%s: device_register failed\n", __func__
);
526 /* Register the release callback that will be called when the last
527 reference to the device goes away. */
528 vdev
->dev
.release
= v4l2_device_release
;
530 /* Part 5: Activate this minor. The char device can now be used. */
531 mutex_lock(&videodev_lock
);
532 video_device
[vdev
->minor
] = vdev
;
533 mutex_unlock(&videodev_lock
);
537 mutex_lock(&videodev_lock
);
539 cdev_del(vdev
->cdev
);
540 clear_bit(vdev
->num
, video_nums
[type
]);
541 mutex_unlock(&videodev_lock
);
542 /* Mark this video device as never having been registered. */
546 EXPORT_SYMBOL(video_register_device_index
);
549 * video_unregister_device - unregister a video4linux device
550 * @vdev: the device to unregister
552 * This unregisters the passed device. Future open calls will
553 * be met with errors.
555 void video_unregister_device(struct video_device
*vdev
)
557 /* Check if vdev was ever registered at all */
558 if (!vdev
|| vdev
->minor
< 0)
561 mutex_lock(&videodev_lock
);
562 set_bit(V4L2_FL_UNREGISTERED
, &vdev
->flags
);
563 mutex_unlock(&videodev_lock
);
564 device_unregister(&vdev
->dev
);
566 EXPORT_SYMBOL(video_unregister_device
);
569 * Initialise video for linux
571 static int __init
videodev_init(void)
573 dev_t dev
= MKDEV(VIDEO_MAJOR
, 0);
576 printk(KERN_INFO
"Linux video capture interface: v2.00\n");
577 ret
= register_chrdev_region(dev
, VIDEO_NUM_DEVICES
, VIDEO_NAME
);
579 printk(KERN_WARNING
"videodev: unable to get major %d\n",
584 ret
= class_register(&video_class
);
586 unregister_chrdev_region(dev
, VIDEO_NUM_DEVICES
);
587 printk(KERN_WARNING
"video_dev: class_register failed\n");
594 static void __exit
videodev_exit(void)
596 dev_t dev
= MKDEV(VIDEO_MAJOR
, 0);
598 class_unregister(&video_class
);
599 unregister_chrdev_region(dev
, VIDEO_NUM_DEVICES
);
602 module_init(videodev_init
)
603 module_exit(videodev_exit
)
605 MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
606 MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
607 MODULE_LICENSE("GPL");
608 MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR
);