blob: 06f14008b346443a50a55cc58c2a2009e1664ecd [file] [log] [blame]
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001/*
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 *
Alan Coxd9b01442008-10-27 15:13:47 -030012 * Authors: Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030013 * 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>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030028#include <asm/uaccess.h>
29#include <asm/system.h>
30
31#include <media/v4l2-common.h>
Hans Verkuil9bea3512008-12-23 07:35:17 -030032#include <media/v4l2-device.h>
Hans Verkuilbec43662008-12-30 06:58:20 -030033#include <media/v4l2-ioctl.h>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030034
35#define VIDEO_NUM_DEVICES 256
36#define VIDEO_NAME "video4linux"
37
38/*
39 * sysfs stuff
40 */
41
42static ssize_t show_index(struct device *cd,
43 struct device_attribute *attr, char *buf)
44{
Hans Verkuildc93a702008-12-19 21:28:27 -030045 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030046
Hans Verkuildc93a702008-12-19 21:28:27 -030047 return sprintf(buf, "%i\n", vdev->index);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030048}
49
50static ssize_t show_name(struct device *cd,
51 struct device_attribute *attr, char *buf)
52{
Hans Verkuildc93a702008-12-19 21:28:27 -030053 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030054
Hans Verkuildc93a702008-12-19 21:28:27 -030055 return sprintf(buf, "%.*s\n", (int)sizeof(vdev->name), vdev->name);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030056}
57
58static 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
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030064/*
65 * Active devices
66 */
67static struct video_device *video_device[VIDEO_NUM_DEVICES];
68static DEFINE_MUTEX(videodev_lock);
Hans Verkuil22e22122009-09-06 07:13:14 -030069static DECLARE_BITMAP(devnode_nums[VFL_TYPE_MAX], VIDEO_NUM_DEVICES);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030070
Hans Verkuil5062cb72009-09-07 03:40:24 -030071/* Device node utility functions */
72
73/* Note: these utility functions all assume that vfl_type is in the range
74 [0, VFL_TYPE_MAX-1]. */
75
76#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
77/* Return the bitmap corresponding to vfl_type. */
78static inline unsigned long *devnode_bits(int vfl_type)
79{
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. */
Hans Verkuil226c0ee2010-08-06 12:48:00 -030083 int idx = (vfl_type > VFL_TYPE_RADIO) ? VFL_TYPE_MAX - 1 : vfl_type;
Hans Verkuil5062cb72009-09-07 03:40:24 -030084
85 return devnode_nums[idx];
86}
87#else
88/* Return the bitmap corresponding to vfl_type. */
89static inline unsigned long *devnode_bits(int vfl_type)
90{
91 return devnode_nums[vfl_type];
92}
93#endif
94
95/* Mark device node number vdev->num as used */
96static inline void devnode_set(struct video_device *vdev)
97{
98 set_bit(vdev->num, devnode_bits(vdev->vfl_type));
99}
100
101/* Mark device node number vdev->num as unused */
102static inline void devnode_clear(struct video_device *vdev)
103{
104 clear_bit(vdev->num, devnode_bits(vdev->vfl_type));
105}
106
107/* Try to find a free device node number in the range [from, to> */
108static inline int devnode_find(struct video_device *vdev, int from, int to)
109{
110 return find_next_zero_bit(devnode_bits(vdev->vfl_type), to, from);
111}
112
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300113struct video_device *video_device_alloc(void)
114{
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300115 return kzalloc(sizeof(struct video_device), GFP_KERNEL);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300116}
117EXPORT_SYMBOL(video_device_alloc);
118
Hans Verkuildc93a702008-12-19 21:28:27 -0300119void video_device_release(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300120{
Hans Verkuildc93a702008-12-19 21:28:27 -0300121 kfree(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300122}
123EXPORT_SYMBOL(video_device_release);
124
Hans Verkuildc93a702008-12-19 21:28:27 -0300125void video_device_release_empty(struct video_device *vdev)
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300126{
127 /* Do nothing */
128 /* Only valid when the video_device struct is a static. */
129}
130EXPORT_SYMBOL(video_device_release_empty);
131
Hans Verkuildc93a702008-12-19 21:28:27 -0300132static inline void video_get(struct video_device *vdev)
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300133{
Hans Verkuildc93a702008-12-19 21:28:27 -0300134 get_device(&vdev->dev);
135}
136
137static inline void video_put(struct video_device *vdev)
138{
139 put_device(&vdev->dev);
140}
141
142/* Called when the last user of the video device exits. */
143static void v4l2_device_release(struct device *cd)
144{
145 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300146 struct v4l2_device *v4l2_dev = vdev->v4l2_dev;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300147
148 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300149 if (video_device[vdev->minor] != vdev) {
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300150 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300151 /* should not happen */
152 WARN_ON(1);
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300153 return;
154 }
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300155
156 /* Free up this device for reuse */
Hans Verkuildc93a702008-12-19 21:28:27 -0300157 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
Hans Verkuil22e22122009-09-06 07:13:14 -0300165 /* Mark device node number as free */
Hans Verkuil5062cb72009-09-07 03:40:24 -0300166 devnode_clear(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300167
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300168 mutex_unlock(&videodev_lock);
169
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300170#if defined(CONFIG_MEDIA_CONTROLLER)
171 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
172 vdev->vfl_type != VFL_TYPE_SUBDEV)
173 media_device_unregister_entity(&vdev->entity);
174#endif
175
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300176 /* Release video_device and perform other
177 cleanups as needed. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300178 vdev->release(vdev);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300179
180 /* Decrease v4l2_device refcount */
181 if (v4l2_dev)
182 v4l2_device_put(v4l2_dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300183}
184
185static struct class video_class = {
186 .name = VIDEO_NAME,
187 .dev_attrs = video_device_attrs,
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300188};
189
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300190struct video_device *video_devdata(struct file *file)
191{
192 return video_device[iminor(file->f_path.dentry->d_inode)];
193}
194EXPORT_SYMBOL(video_devdata);
195
Hans Verkuil02265492010-12-29 10:05:02 -0300196
197/* Priority handling */
198
199static inline bool prio_is_valid(enum v4l2_priority prio)
200{
201 return prio == V4L2_PRIORITY_BACKGROUND ||
202 prio == V4L2_PRIORITY_INTERACTIVE ||
203 prio == V4L2_PRIORITY_RECORD;
204}
205
206void v4l2_prio_init(struct v4l2_prio_state *global)
207{
208 memset(global, 0, sizeof(*global));
209}
210EXPORT_SYMBOL(v4l2_prio_init);
211
212int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
213 enum v4l2_priority new)
214{
215 if (!prio_is_valid(new))
216 return -EINVAL;
217 if (*local == new)
218 return 0;
219
220 atomic_inc(&global->prios[new]);
221 if (prio_is_valid(*local))
222 atomic_dec(&global->prios[*local]);
223 *local = new;
224 return 0;
225}
226EXPORT_SYMBOL(v4l2_prio_change);
227
228void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local)
229{
230 v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT);
231}
232EXPORT_SYMBOL(v4l2_prio_open);
233
234void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local)
235{
236 if (prio_is_valid(local))
237 atomic_dec(&global->prios[local]);
238}
239EXPORT_SYMBOL(v4l2_prio_close);
240
241enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global)
242{
243 if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0)
244 return V4L2_PRIORITY_RECORD;
245 if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0)
246 return V4L2_PRIORITY_INTERACTIVE;
247 if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0)
248 return V4L2_PRIORITY_BACKGROUND;
249 return V4L2_PRIORITY_UNSET;
250}
251EXPORT_SYMBOL(v4l2_prio_max);
252
253int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local)
254{
255 return (local < v4l2_prio_max(global)) ? -EBUSY : 0;
256}
257EXPORT_SYMBOL(v4l2_prio_check);
258
259
Hans Verkuildc93a702008-12-19 21:28:27 -0300260static ssize_t v4l2_read(struct file *filp, char __user *buf,
261 size_t sz, loff_t *off)
262{
263 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300264 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300265
266 if (!vdev->fops->read)
267 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300268 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
269 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300270 if (video_is_registered(vdev))
271 ret = vdev->fops->read(filp, buf, sz, off);
272 if (vdev->lock)
273 mutex_unlock(vdev->lock);
274 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300275}
276
277static ssize_t v4l2_write(struct file *filp, const char __user *buf,
278 size_t sz, loff_t *off)
279{
280 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300281 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300282
283 if (!vdev->fops->write)
284 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300285 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
286 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300287 if (video_is_registered(vdev))
288 ret = vdev->fops->write(filp, buf, sz, off);
289 if (vdev->lock)
290 mutex_unlock(vdev->lock);
291 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300292}
293
294static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
295{
296 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300297 int ret = POLLERR | POLLHUP;
Hans Verkuildc93a702008-12-19 21:28:27 -0300298
Hans Verkuilee6869a2010-09-26 08:47:38 -0300299 if (!vdev->fops->poll)
Hans Verkuil28778422010-11-26 06:43:51 -0300300 return DEFAULT_POLLMASK;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300301 if (vdev->lock)
302 mutex_lock(vdev->lock);
303 if (video_is_registered(vdev))
304 ret = vdev->fops->poll(filp, poll);
305 if (vdev->lock)
306 mutex_unlock(vdev->lock);
307 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300308}
309
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200310static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Hans Verkuildc93a702008-12-19 21:28:27 -0300311{
312 struct video_device *vdev = video_devdata(filp);
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300313 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300314
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200315 if (vdev->fops->unlocked_ioctl) {
Hans Verkuil28778422010-11-26 06:43:51 -0300316 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
317 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300318 if (video_is_registered(vdev))
319 ret = vdev->fops->unlocked_ioctl(filp, cmd, arg);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300320 if (vdev->lock)
321 mutex_unlock(vdev->lock);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200322 } else if (vdev->fops->ioctl) {
Hans Verkuil879aa242010-11-26 06:47:28 -0300323 /* This code path is a replacement for the BKL. It is a major
324 * hack but it will have to do for those drivers that are not
325 * yet converted to use unlocked_ioctl.
326 *
327 * There are two options: if the driver implements struct
328 * v4l2_device, then the lock defined there is used to
329 * serialize the ioctls. Otherwise the v4l2 core lock defined
330 * below is used. This lock is really bad since it serializes
331 * completely independent devices.
332 *
333 * Both variants suffer from the same problem: if the driver
334 * sleeps, then it blocks all ioctls since the lock is still
335 * held. This is very common for VIDIOC_DQBUF since that
336 * normally waits for a frame to arrive. As a result any other
337 * ioctl calls will proceed very, very slowly since each call
338 * will have to wait for the VIDIOC_QBUF to finish. Things that
339 * should take 0.01s may now take 10-20 seconds.
340 *
341 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
342 * This actually works OK for videobuf-based drivers, since
343 * videobuf will take its own internal lock.
344 */
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300345 static DEFINE_MUTEX(v4l2_ioctl_mutex);
Hans Verkuil879aa242010-11-26 06:47:28 -0300346 struct mutex *m = vdev->v4l2_dev ?
347 &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex;
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300348
Hans Verkuil879aa242010-11-26 06:47:28 -0300349 if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m))
350 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300351 if (video_is_registered(vdev))
352 ret = vdev->fops->ioctl(filp, cmd, arg);
Hans Verkuil879aa242010-11-26 06:47:28 -0300353 if (cmd != VIDIOC_DQBUF)
354 mutex_unlock(m);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200355 } else
356 ret = -ENOTTY;
Hans Verkuildc93a702008-12-19 21:28:27 -0300357
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200358 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300359}
360
Bob Liuecc65172011-05-06 05:20:09 -0300361#ifdef CONFIG_MMU
362#define v4l2_get_unmapped_area NULL
363#else
364static unsigned long v4l2_get_unmapped_area(struct file *filp,
365 unsigned long addr, unsigned long len, unsigned long pgoff,
366 unsigned long flags)
367{
368 struct video_device *vdev = video_devdata(filp);
369
370 if (!vdev->fops->get_unmapped_area)
371 return -ENOSYS;
372 if (!video_is_registered(vdev))
373 return -ENODEV;
374 return vdev->fops->get_unmapped_area(filp, addr, len, pgoff, flags);
375}
376#endif
377
Hans Verkuildc93a702008-12-19 21:28:27 -0300378static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
379{
380 struct video_device *vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300381 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300382
Hans Verkuilee6869a2010-09-26 08:47:38 -0300383 if (!vdev->fops->mmap)
384 return ret;
Hans Verkuil28778422010-11-26 06:43:51 -0300385 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
386 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300387 if (video_is_registered(vdev))
388 ret = vdev->fops->mmap(filp, vm);
389 if (vdev->lock)
390 mutex_unlock(vdev->lock);
391 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300392}
393
394/* Override for the open function */
395static int v4l2_open(struct inode *inode, struct file *filp)
396{
397 struct video_device *vdev;
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300398 int ret = 0;
Hans Verkuildc93a702008-12-19 21:28:27 -0300399
400 /* Check if the video device is available */
401 mutex_lock(&videodev_lock);
402 vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300403 /* return ENODEV if the video device has already been removed. */
Hans Verkuilca9afe62010-11-26 06:54:53 -0300404 if (vdev == NULL || !video_is_registered(vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300405 mutex_unlock(&videodev_lock);
406 return -ENODEV;
407 }
408 /* and increase the device refcount */
409 video_get(vdev);
410 mutex_unlock(&videodev_lock);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300411 if (vdev->fops->open) {
Hans Verkuil28778422010-11-26 06:43:51 -0300412 if (vdev->lock && mutex_lock_interruptible(vdev->lock)) {
413 ret = -ERESTARTSYS;
414 goto err;
415 }
Hans Verkuilee6869a2010-09-26 08:47:38 -0300416 if (video_is_registered(vdev))
417 ret = vdev->fops->open(filp);
418 else
419 ret = -ENODEV;
420 if (vdev->lock)
421 mutex_unlock(vdev->lock);
422 }
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300423
Hans Verkuil28778422010-11-26 06:43:51 -0300424err:
Hans Verkuildc93a702008-12-19 21:28:27 -0300425 /* decrease the refcount in case of an error */
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300426 if (ret)
Hans Verkuildc93a702008-12-19 21:28:27 -0300427 video_put(vdev);
428 return ret;
429}
430
431/* Override for the release function */
432static int v4l2_release(struct inode *inode, struct file *filp)
433{
434 struct video_device *vdev = video_devdata(filp);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300435 int ret = 0;
436
Hans Verkuilee6869a2010-09-26 08:47:38 -0300437 if (vdev->fops->release) {
438 if (vdev->lock)
439 mutex_lock(vdev->lock);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300440 vdev->fops->release(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300441 if (vdev->lock)
442 mutex_unlock(vdev->lock);
443 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300444 /* decrease the refcount unconditionally since the release()
445 return value is ignored. */
446 video_put(vdev);
447 return ret;
448}
449
Hans Verkuildc93a702008-12-19 21:28:27 -0300450static const struct file_operations v4l2_fops = {
451 .owner = THIS_MODULE,
452 .read = v4l2_read,
453 .write = v4l2_write,
454 .open = v4l2_open,
Bob Liuecc65172011-05-06 05:20:09 -0300455 .get_unmapped_area = v4l2_get_unmapped_area,
Hans Verkuildc93a702008-12-19 21:28:27 -0300456 .mmap = v4l2_mmap,
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200457 .unlocked_ioctl = v4l2_ioctl,
Hans Verkuildc93a702008-12-19 21:28:27 -0300458#ifdef CONFIG_COMPAT
Hans Verkuil9bb7cde2008-12-30 06:42:40 -0300459 .compat_ioctl = v4l2_compat_ioctl32,
Hans Verkuildc93a702008-12-19 21:28:27 -0300460#endif
461 .release = v4l2_release,
462 .poll = v4l2_poll,
463 .llseek = no_llseek,
464};
465
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300466/**
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300467 * get_index - assign stream index number based on parent device
Hans Verkuildc93a702008-12-19 21:28:27 -0300468 * @vdev: video_device to assign index number to, vdev->parent should be assigned
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300469 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300470 * Note that when this is called the new device has not yet been registered
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300471 * in the video_device array, but it was able to obtain a minor number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300472 *
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300473 * This means that we can always obtain a free stream index number since
474 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
475 * use of the video_device array.
476 *
477 * Returns a free index number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300478 */
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300479static int get_index(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300480{
Hans Verkuil775a05d2009-02-14 11:31:01 -0300481 /* This can be static since this function is called with the global
482 videodev_lock held. */
483 static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300484 int i;
485
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300486 /* Some drivers do not set the parent. In that case always return 0. */
Hans Verkuil806e5b72008-12-19 09:10:56 -0300487 if (vdev->parent == NULL)
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300488 return 0;
Hans Verkuil775a05d2009-02-14 11:31:01 -0300489
490 bitmap_zero(used, VIDEO_NUM_DEVICES);
Hans Verkuil806e5b72008-12-19 09:10:56 -0300491
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300492 for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
493 if (video_device[i] != NULL &&
Hans Verkuil5e85e732008-07-20 06:31:39 -0300494 video_device[i]->parent == vdev->parent) {
Hans Verkuil775a05d2009-02-14 11:31:01 -0300495 set_bit(video_device[i]->index, used);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300496 }
497 }
498
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300499 return find_first_zero_bit(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300500}
501
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300502/**
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300503 * __video_register_device - register video4linux devices
Hans Verkuildc93a702008-12-19 21:28:27 -0300504 * @vdev: video device structure we want to register
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300505 * @type: type of device to register
Hans Verkuil22e22122009-09-06 07:13:14 -0300506 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300507 * -1 == first free)
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300508 * @warn_if_nr_in_use: warn if the desired device node number
509 * was already in use and another number was chosen instead.
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300510 * @owner: module that owns the video device node
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300511 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300512 * The registration code assigns minor numbers and device node numbers
513 * based on the requested type and registers the new device node with
514 * the kernel.
Hans Verkuil46b63372010-12-31 11:47:23 -0300515 *
516 * This function assumes that struct video_device was zeroed when it
517 * was allocated and does not contain any stale date.
518 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300519 * An error is returned if no free minor or device node number could be
520 * found, or if the registration of the device node failed.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300521 *
522 * Zero is returned on success.
523 *
524 * Valid types are
525 *
526 * %VFL_TYPE_GRABBER - A frame grabber
527 *
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300528 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
529 *
530 * %VFL_TYPE_RADIO - A radio card
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300531 *
532 * %VFL_TYPE_SUBDEV - A subdevice
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300533 */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300534int __video_register_device(struct video_device *vdev, int type, int nr,
535 int warn_if_nr_in_use, struct module *owner)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300536{
537 int i = 0;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300538 int ret;
Hans Verkuildd896012008-10-04 08:36:54 -0300539 int minor_offset = 0;
540 int minor_cnt = VIDEO_NUM_DEVICES;
541 const char *name_base;
Hans Verkuildc93a702008-12-19 21:28:27 -0300542
543 /* A minor value of -1 marks this video device as never
544 having been registered */
Trent Piepho428c8d12009-03-03 18:51:52 -0300545 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300546
Hans Verkuild6e74972008-08-23 06:27:59 -0300547 /* the release callback MUST be present */
Trent Piepho428c8d12009-03-03 18:51:52 -0300548 WARN_ON(!vdev->release);
549 if (!vdev->release)
Henrik Kretzschmaree7aa9f2008-08-22 16:41:03 -0300550 return -EINVAL;
551
Sakari Ailus1babcb42010-03-23 09:25:26 -0300552 /* v4l2_fh support */
553 spin_lock_init(&vdev->fh_lock);
554 INIT_LIST_HEAD(&vdev->fh_list);
555
Hans Verkuildc93a702008-12-19 21:28:27 -0300556 /* Part 1: check device type */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300557 switch (type) {
558 case VFL_TYPE_GRABBER:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300559 name_base = "video";
560 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300561 case VFL_TYPE_VBI:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300562 name_base = "vbi";
563 break;
564 case VFL_TYPE_RADIO:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300565 name_base = "radio";
566 break;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300567 case VFL_TYPE_SUBDEV:
568 name_base = "v4l-subdev";
569 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300570 default:
571 printk(KERN_ERR "%s called with unknown type: %d\n",
572 __func__, type);
Henrik Kretzschmar46f2c212008-09-03 16:47:39 -0300573 return -EINVAL;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300574 }
575
Hans Verkuildc93a702008-12-19 21:28:27 -0300576 vdev->vfl_type = type;
577 vdev->cdev = NULL;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300578 if (vdev->v4l2_dev) {
579 if (vdev->v4l2_dev->dev)
580 vdev->parent = vdev->v4l2_dev->dev;
581 if (vdev->ctrl_handler == NULL)
582 vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler;
Hans Verkuilb1a873a2011-03-22 10:14:07 -0300583 /* If the prio state pointer is NULL, then use the v4l2_device
584 prio state. */
585 if (vdev->prio == NULL)
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300586 vdev->prio = &vdev->v4l2_dev->prio;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300587 }
Hans Verkuildd896012008-10-04 08:36:54 -0300588
Hans Verkuil22e22122009-09-06 07:13:14 -0300589 /* Part 2: find a free minor, device node number and device index. */
Hans Verkuildd896012008-10-04 08:36:54 -0300590#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
591 /* Keep the ranges for the first four types for historical
592 * reasons.
593 * Newer devices (not yet in place) should use the range
594 * of 128-191 and just pick the first free minor there
595 * (new style). */
596 switch (type) {
597 case VFL_TYPE_GRABBER:
598 minor_offset = 0;
599 minor_cnt = 64;
600 break;
601 case VFL_TYPE_RADIO:
602 minor_offset = 64;
603 minor_cnt = 64;
604 break;
Hans Verkuildd896012008-10-04 08:36:54 -0300605 case VFL_TYPE_VBI:
606 minor_offset = 224;
607 minor_cnt = 32;
608 break;
609 default:
610 minor_offset = 128;
611 minor_cnt = 64;
612 break;
613 }
614#endif
615
Hans Verkuil22e22122009-09-06 07:13:14 -0300616 /* Pick a device node number */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300617 mutex_lock(&videodev_lock);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300618 nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300619 if (nr == minor_cnt)
Hans Verkuil5062cb72009-09-07 03:40:24 -0300620 nr = devnode_find(vdev, 0, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300621 if (nr == minor_cnt) {
Hans Verkuil22e22122009-09-06 07:13:14 -0300622 printk(KERN_ERR "could not get a free device node number\n");
Hans Verkuildd896012008-10-04 08:36:54 -0300623 mutex_unlock(&videodev_lock);
624 return -ENFILE;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300625 }
Hans Verkuildd896012008-10-04 08:36:54 -0300626#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
Hans Verkuil22e22122009-09-06 07:13:14 -0300627 /* 1-on-1 mapping of device node number to minor number */
Hans Verkuildd896012008-10-04 08:36:54 -0300628 i = nr;
629#else
Hans Verkuil22e22122009-09-06 07:13:14 -0300630 /* The device node number and minor numbers are independent, so
631 we just find the first free minor number. */
Hans Verkuildd896012008-10-04 08:36:54 -0300632 for (i = 0; i < VIDEO_NUM_DEVICES; i++)
633 if (video_device[i] == NULL)
634 break;
635 if (i == VIDEO_NUM_DEVICES) {
636 mutex_unlock(&videodev_lock);
637 printk(KERN_ERR "could not get a free minor\n");
638 return -ENFILE;
639 }
640#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300641 vdev->minor = i + minor_offset;
642 vdev->num = nr;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300643 devnode_set(vdev);
644
Hans Verkuildc93a702008-12-19 21:28:27 -0300645 /* Should not happen since we thought this minor was free */
646 WARN_ON(video_device[vdev->minor] != NULL);
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300647 vdev->index = get_index(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300648 mutex_unlock(&videodev_lock);
649
Hans Verkuildc93a702008-12-19 21:28:27 -0300650 /* Part 3: Initialize the character device */
651 vdev->cdev = cdev_alloc();
652 if (vdev->cdev == NULL) {
653 ret = -ENOMEM;
654 goto cleanup;
655 }
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200656 vdev->cdev->ops = &v4l2_fops;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300657 vdev->cdev->owner = owner;
Hans Verkuildc93a702008-12-19 21:28:27 -0300658 ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300659 if (ret < 0) {
660 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300661 kfree(vdev->cdev);
662 vdev->cdev = NULL;
663 goto cleanup;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300664 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300665
666 /* Part 4: register the device with sysfs */
Hans Verkuildc93a702008-12-19 21:28:27 -0300667 vdev->dev.class = &video_class;
668 vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
669 if (vdev->parent)
670 vdev->dev.parent = vdev->parent;
Hans Verkuil22e22122009-09-06 07:13:14 -0300671 dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num);
Hans Verkuildc93a702008-12-19 21:28:27 -0300672 ret = device_register(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300673 if (ret < 0) {
674 printk(KERN_ERR "%s: device_register failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300675 goto cleanup;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300676 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300677 /* Register the release callback that will be called when the last
678 reference to the device goes away. */
679 vdev->dev.release = v4l2_device_release;
680
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300681 if (nr != -1 && nr != vdev->num && warn_if_nr_in_use)
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300682 printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__,
683 name_base, nr, video_device_node_name(vdev));
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300684
685 /* Increase v4l2_device refcount */
686 if (vdev->v4l2_dev)
687 v4l2_device_get(vdev->v4l2_dev);
688
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300689#if defined(CONFIG_MEDIA_CONTROLLER)
690 /* Part 5: Register the entity. */
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300691 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
692 vdev->vfl_type != VFL_TYPE_SUBDEV) {
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300693 vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L;
694 vdev->entity.name = vdev->name;
695 vdev->entity.v4l.major = VIDEO_MAJOR;
696 vdev->entity.v4l.minor = vdev->minor;
697 ret = media_device_register_entity(vdev->v4l2_dev->mdev,
698 &vdev->entity);
699 if (ret < 0)
700 printk(KERN_WARNING
701 "%s: media_device_register_entity failed\n",
702 __func__);
703 }
704#endif
705 /* Part 6: Activate this minor. The char device can now be used. */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300706 set_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300707 mutex_lock(&videodev_lock);
708 video_device[vdev->minor] = vdev;
709 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300710
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300711 return 0;
712
Hans Verkuildc93a702008-12-19 21:28:27 -0300713cleanup:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300714 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300715 if (vdev->cdev)
716 cdev_del(vdev->cdev);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300717 devnode_clear(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300718 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300719 /* Mark this video device as never having been registered. */
720 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300721 return ret;
722}
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300723EXPORT_SYMBOL(__video_register_device);
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300724
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300725/**
726 * video_unregister_device - unregister a video4linux device
Hans Verkuildc93a702008-12-19 21:28:27 -0300727 * @vdev: the device to unregister
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300728 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300729 * This unregisters the passed device. Future open calls will
730 * be met with errors.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300731 */
Hans Verkuildc93a702008-12-19 21:28:27 -0300732void video_unregister_device(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300733{
Hans Verkuildc93a702008-12-19 21:28:27 -0300734 /* Check if vdev was ever registered at all */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300735 if (!vdev || !video_is_registered(vdev))
Hans Verkuildc93a702008-12-19 21:28:27 -0300736 return;
737
Hans Verkuilca9afe62010-11-26 06:54:53 -0300738 mutex_lock(&videodev_lock);
739 /* This must be in a critical section to prevent a race with v4l2_open.
740 * Once this bit has been cleared video_get may never be called again.
741 */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300742 clear_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuilca9afe62010-11-26 06:54:53 -0300743 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300744 device_unregister(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300745}
746EXPORT_SYMBOL(video_unregister_device);
747
748/*
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300749 * Initialise video for linux
750 */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300751static int __init videodev_init(void)
752{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300753 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300754 int ret;
755
756 printk(KERN_INFO "Linux video capture interface: v2.00\n");
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300757 ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
758 if (ret < 0) {
759 printk(KERN_WARNING "videodev: unable to get major %d\n",
760 VIDEO_MAJOR);
761 return ret;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300762 }
763
764 ret = class_register(&video_class);
765 if (ret < 0) {
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300766 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300767 printk(KERN_WARNING "video_dev: class_register failed\n");
768 return -EIO;
769 }
770
771 return 0;
772}
773
774static void __exit videodev_exit(void)
775{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300776 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
777
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300778 class_unregister(&video_class);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300779 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300780}
781
782module_init(videodev_init)
783module_exit(videodev_exit)
784
785MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
786MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
787MODULE_LICENSE("GPL");
Scott James Remnantcbb72b02009-03-02 15:40:57 -0300788MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300789
790
791/*
792 * Local variables:
793 * c-basic-offset: 8
794 * End:
795 */