blob: 65d546f35ef4f21725d0a46d2d473f91cc2fbc75 [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 Verkuil7f8ecfa2008-08-29 17:31:35 -0300146
147 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300148 if (video_device[vdev->minor] != vdev) {
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300149 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300150 /* should not happen */
151 WARN_ON(1);
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300152 return;
153 }
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300154
155 /* Free up this device for reuse */
Hans Verkuildc93a702008-12-19 21:28:27 -0300156 video_device[vdev->minor] = NULL;
157
158 /* Delete the cdev on this minor as well */
159 cdev_del(vdev->cdev);
160 /* Just in case some driver tries to access this from
161 the release() callback. */
162 vdev->cdev = NULL;
163
Hans Verkuil22e22122009-09-06 07:13:14 -0300164 /* Mark device node number as free */
Hans Verkuil5062cb72009-09-07 03:40:24 -0300165 devnode_clear(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300166
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300167 mutex_unlock(&videodev_lock);
168
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300169 /* Release video_device and perform other
170 cleanups as needed. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300171 vdev->release(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300172}
173
174static struct class video_class = {
175 .name = VIDEO_NAME,
176 .dev_attrs = video_device_attrs,
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300177};
178
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300179struct video_device *video_devdata(struct file *file)
180{
181 return video_device[iminor(file->f_path.dentry->d_inode)];
182}
183EXPORT_SYMBOL(video_devdata);
184
Hans Verkuil02265492010-12-29 10:05:02 -0300185
186/* Priority handling */
187
188static inline bool prio_is_valid(enum v4l2_priority prio)
189{
190 return prio == V4L2_PRIORITY_BACKGROUND ||
191 prio == V4L2_PRIORITY_INTERACTIVE ||
192 prio == V4L2_PRIORITY_RECORD;
193}
194
195void v4l2_prio_init(struct v4l2_prio_state *global)
196{
197 memset(global, 0, sizeof(*global));
198}
199EXPORT_SYMBOL(v4l2_prio_init);
200
201int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
202 enum v4l2_priority new)
203{
204 if (!prio_is_valid(new))
205 return -EINVAL;
206 if (*local == new)
207 return 0;
208
209 atomic_inc(&global->prios[new]);
210 if (prio_is_valid(*local))
211 atomic_dec(&global->prios[*local]);
212 *local = new;
213 return 0;
214}
215EXPORT_SYMBOL(v4l2_prio_change);
216
217void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local)
218{
219 v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT);
220}
221EXPORT_SYMBOL(v4l2_prio_open);
222
223void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local)
224{
225 if (prio_is_valid(local))
226 atomic_dec(&global->prios[local]);
227}
228EXPORT_SYMBOL(v4l2_prio_close);
229
230enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global)
231{
232 if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0)
233 return V4L2_PRIORITY_RECORD;
234 if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0)
235 return V4L2_PRIORITY_INTERACTIVE;
236 if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0)
237 return V4L2_PRIORITY_BACKGROUND;
238 return V4L2_PRIORITY_UNSET;
239}
240EXPORT_SYMBOL(v4l2_prio_max);
241
242int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local)
243{
244 return (local < v4l2_prio_max(global)) ? -EBUSY : 0;
245}
246EXPORT_SYMBOL(v4l2_prio_check);
247
248
Hans Verkuildc93a702008-12-19 21:28:27 -0300249static ssize_t v4l2_read(struct file *filp, char __user *buf,
250 size_t sz, loff_t *off)
251{
252 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300253 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300254
255 if (!vdev->fops->read)
256 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300257 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
258 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300259 if (video_is_registered(vdev))
260 ret = vdev->fops->read(filp, buf, sz, off);
261 if (vdev->lock)
262 mutex_unlock(vdev->lock);
263 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300264}
265
266static ssize_t v4l2_write(struct file *filp, const char __user *buf,
267 size_t sz, loff_t *off)
268{
269 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300270 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300271
272 if (!vdev->fops->write)
273 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300274 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
275 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300276 if (video_is_registered(vdev))
277 ret = vdev->fops->write(filp, buf, sz, off);
278 if (vdev->lock)
279 mutex_unlock(vdev->lock);
280 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300281}
282
283static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
284{
285 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300286 int ret = POLLERR | POLLHUP;
Hans Verkuildc93a702008-12-19 21:28:27 -0300287
Hans Verkuilee6869a2010-09-26 08:47:38 -0300288 if (!vdev->fops->poll)
Hans Verkuil28778422010-11-26 06:43:51 -0300289 return DEFAULT_POLLMASK;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300290 if (vdev->lock)
291 mutex_lock(vdev->lock);
292 if (video_is_registered(vdev))
293 ret = vdev->fops->poll(filp, poll);
294 if (vdev->lock)
295 mutex_unlock(vdev->lock);
296 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300297}
298
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200299static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Hans Verkuildc93a702008-12-19 21:28:27 -0300300{
301 struct video_device *vdev = video_devdata(filp);
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300302 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300303
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200304 if (vdev->fops->unlocked_ioctl) {
Hans Verkuil28778422010-11-26 06:43:51 -0300305 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
306 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300307 if (video_is_registered(vdev))
308 ret = vdev->fops->unlocked_ioctl(filp, cmd, arg);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300309 if (vdev->lock)
310 mutex_unlock(vdev->lock);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200311 } else if (vdev->fops->ioctl) {
Hans Verkuil879aa242010-11-26 06:47:28 -0300312 /* This code path is a replacement for the BKL. It is a major
313 * hack but it will have to do for those drivers that are not
314 * yet converted to use unlocked_ioctl.
315 *
316 * There are two options: if the driver implements struct
317 * v4l2_device, then the lock defined there is used to
318 * serialize the ioctls. Otherwise the v4l2 core lock defined
319 * below is used. This lock is really bad since it serializes
320 * completely independent devices.
321 *
322 * Both variants suffer from the same problem: if the driver
323 * sleeps, then it blocks all ioctls since the lock is still
324 * held. This is very common for VIDIOC_DQBUF since that
325 * normally waits for a frame to arrive. As a result any other
326 * ioctl calls will proceed very, very slowly since each call
327 * will have to wait for the VIDIOC_QBUF to finish. Things that
328 * should take 0.01s may now take 10-20 seconds.
329 *
330 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
331 * This actually works OK for videobuf-based drivers, since
332 * videobuf will take its own internal lock.
333 */
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300334 static DEFINE_MUTEX(v4l2_ioctl_mutex);
Hans Verkuil879aa242010-11-26 06:47:28 -0300335 struct mutex *m = vdev->v4l2_dev ?
336 &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex;
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300337
Hans Verkuil879aa242010-11-26 06:47:28 -0300338 if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m))
339 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300340 if (video_is_registered(vdev))
341 ret = vdev->fops->ioctl(filp, cmd, arg);
Hans Verkuil879aa242010-11-26 06:47:28 -0300342 if (cmd != VIDIOC_DQBUF)
343 mutex_unlock(m);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200344 } else
345 ret = -ENOTTY;
Hans Verkuildc93a702008-12-19 21:28:27 -0300346
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200347 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300348}
349
Hans Verkuildc93a702008-12-19 21:28:27 -0300350static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
351{
352 struct video_device *vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300353 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300354
Hans Verkuilee6869a2010-09-26 08:47:38 -0300355 if (!vdev->fops->mmap)
356 return ret;
Hans Verkuil28778422010-11-26 06:43:51 -0300357 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
358 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300359 if (video_is_registered(vdev))
360 ret = vdev->fops->mmap(filp, vm);
361 if (vdev->lock)
362 mutex_unlock(vdev->lock);
363 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300364}
365
366/* Override for the open function */
367static int v4l2_open(struct inode *inode, struct file *filp)
368{
369 struct video_device *vdev;
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300370#if defined(CONFIG_MEDIA_CONTROLLER)
371 struct media_entity *entity = NULL;
372#endif
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300373 int ret = 0;
Hans Verkuildc93a702008-12-19 21:28:27 -0300374
375 /* Check if the video device is available */
376 mutex_lock(&videodev_lock);
377 vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300378 /* return ENODEV if the video device has already been removed. */
Hans Verkuilca9afe62010-11-26 06:54:53 -0300379 if (vdev == NULL || !video_is_registered(vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300380 mutex_unlock(&videodev_lock);
381 return -ENODEV;
382 }
383 /* and increase the device refcount */
384 video_get(vdev);
385 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300386#if defined(CONFIG_MEDIA_CONTROLLER)
387 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev) {
388 entity = media_entity_get(&vdev->entity);
389 if (!entity) {
390 ret = -EBUSY;
391 video_put(vdev);
392 return ret;
393 }
394 }
395#endif
Hans Verkuilee6869a2010-09-26 08:47:38 -0300396 if (vdev->fops->open) {
Hans Verkuil28778422010-11-26 06:43:51 -0300397 if (vdev->lock && mutex_lock_interruptible(vdev->lock)) {
398 ret = -ERESTARTSYS;
399 goto err;
400 }
Hans Verkuilee6869a2010-09-26 08:47:38 -0300401 if (video_is_registered(vdev))
402 ret = vdev->fops->open(filp);
403 else
404 ret = -ENODEV;
405 if (vdev->lock)
406 mutex_unlock(vdev->lock);
407 }
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300408
Hans Verkuil28778422010-11-26 06:43:51 -0300409err:
Hans Verkuildc93a702008-12-19 21:28:27 -0300410 /* decrease the refcount in case of an error */
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300411 if (ret) {
412#if defined(CONFIG_MEDIA_CONTROLLER)
413 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev)
414 media_entity_put(entity);
415#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300416 video_put(vdev);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300417 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300418 return ret;
419}
420
421/* Override for the release function */
422static int v4l2_release(struct inode *inode, struct file *filp)
423{
424 struct video_device *vdev = video_devdata(filp);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300425 int ret = 0;
426
Hans Verkuilee6869a2010-09-26 08:47:38 -0300427 if (vdev->fops->release) {
428 if (vdev->lock)
429 mutex_lock(vdev->lock);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300430 vdev->fops->release(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300431 if (vdev->lock)
432 mutex_unlock(vdev->lock);
433 }
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300434#if defined(CONFIG_MEDIA_CONTROLLER)
435 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev)
436 media_entity_put(&vdev->entity);
437#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300438 /* decrease the refcount unconditionally since the release()
439 return value is ignored. */
440 video_put(vdev);
441 return ret;
442}
443
Hans Verkuildc93a702008-12-19 21:28:27 -0300444static const struct file_operations v4l2_fops = {
445 .owner = THIS_MODULE,
446 .read = v4l2_read,
447 .write = v4l2_write,
448 .open = v4l2_open,
449 .mmap = v4l2_mmap,
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200450 .unlocked_ioctl = v4l2_ioctl,
Hans Verkuildc93a702008-12-19 21:28:27 -0300451#ifdef CONFIG_COMPAT
Hans Verkuil9bb7cde2008-12-30 06:42:40 -0300452 .compat_ioctl = v4l2_compat_ioctl32,
Hans Verkuildc93a702008-12-19 21:28:27 -0300453#endif
454 .release = v4l2_release,
455 .poll = v4l2_poll,
456 .llseek = no_llseek,
457};
458
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300459/**
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300460 * get_index - assign stream index number based on parent device
Hans Verkuildc93a702008-12-19 21:28:27 -0300461 * @vdev: video_device to assign index number to, vdev->parent should be assigned
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300462 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300463 * Note that when this is called the new device has not yet been registered
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300464 * in the video_device array, but it was able to obtain a minor number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300465 *
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300466 * This means that we can always obtain a free stream index number since
467 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
468 * use of the video_device array.
469 *
470 * Returns a free index number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300471 */
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300472static int get_index(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300473{
Hans Verkuil775a05d2009-02-14 11:31:01 -0300474 /* This can be static since this function is called with the global
475 videodev_lock held. */
476 static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300477 int i;
478
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300479 /* Some drivers do not set the parent. In that case always return 0. */
Hans Verkuil806e5b72008-12-19 09:10:56 -0300480 if (vdev->parent == NULL)
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300481 return 0;
Hans Verkuil775a05d2009-02-14 11:31:01 -0300482
483 bitmap_zero(used, VIDEO_NUM_DEVICES);
Hans Verkuil806e5b72008-12-19 09:10:56 -0300484
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300485 for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
486 if (video_device[i] != NULL &&
Hans Verkuil5e85e732008-07-20 06:31:39 -0300487 video_device[i]->parent == vdev->parent) {
Hans Verkuil775a05d2009-02-14 11:31:01 -0300488 set_bit(video_device[i]->index, used);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300489 }
490 }
491
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300492 return find_first_zero_bit(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300493}
494
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300495/**
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300496 * __video_register_device - register video4linux devices
Hans Verkuildc93a702008-12-19 21:28:27 -0300497 * @vdev: video device structure we want to register
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300498 * @type: type of device to register
Hans Verkuil22e22122009-09-06 07:13:14 -0300499 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300500 * -1 == first free)
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300501 * @warn_if_nr_in_use: warn if the desired device node number
502 * was already in use and another number was chosen instead.
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300503 * @owner: module that owns the video device node
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300504 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300505 * The registration code assigns minor numbers and device node numbers
506 * based on the requested type and registers the new device node with
507 * the kernel.
Hans Verkuil46b63372010-12-31 11:47:23 -0300508 *
509 * This function assumes that struct video_device was zeroed when it
510 * was allocated and does not contain any stale date.
511 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300512 * An error is returned if no free minor or device node number could be
513 * found, or if the registration of the device node failed.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300514 *
515 * Zero is returned on success.
516 *
517 * Valid types are
518 *
519 * %VFL_TYPE_GRABBER - A frame grabber
520 *
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300521 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
522 *
523 * %VFL_TYPE_RADIO - A radio card
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300524 *
525 * %VFL_TYPE_SUBDEV - A subdevice
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300526 */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300527int __video_register_device(struct video_device *vdev, int type, int nr,
528 int warn_if_nr_in_use, struct module *owner)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300529{
530 int i = 0;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300531 int ret;
Hans Verkuildd896012008-10-04 08:36:54 -0300532 int minor_offset = 0;
533 int minor_cnt = VIDEO_NUM_DEVICES;
534 const char *name_base;
Hans Verkuildc93a702008-12-19 21:28:27 -0300535
536 /* A minor value of -1 marks this video device as never
537 having been registered */
Trent Piepho428c8d12009-03-03 18:51:52 -0300538 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300539
Hans Verkuild6e74972008-08-23 06:27:59 -0300540 /* the release callback MUST be present */
Trent Piepho428c8d12009-03-03 18:51:52 -0300541 WARN_ON(!vdev->release);
542 if (!vdev->release)
Henrik Kretzschmaree7aa9f2008-08-22 16:41:03 -0300543 return -EINVAL;
544
Sakari Ailus1babcb42010-03-23 09:25:26 -0300545 /* v4l2_fh support */
546 spin_lock_init(&vdev->fh_lock);
547 INIT_LIST_HEAD(&vdev->fh_list);
548
Hans Verkuildc93a702008-12-19 21:28:27 -0300549 /* Part 1: check device type */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300550 switch (type) {
551 case VFL_TYPE_GRABBER:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300552 name_base = "video";
553 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300554 case VFL_TYPE_VBI:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300555 name_base = "vbi";
556 break;
557 case VFL_TYPE_RADIO:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300558 name_base = "radio";
559 break;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300560 case VFL_TYPE_SUBDEV:
561 name_base = "v4l-subdev";
562 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300563 default:
564 printk(KERN_ERR "%s called with unknown type: %d\n",
565 __func__, type);
Henrik Kretzschmar46f2c212008-09-03 16:47:39 -0300566 return -EINVAL;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300567 }
568
Hans Verkuildc93a702008-12-19 21:28:27 -0300569 vdev->vfl_type = type;
570 vdev->cdev = NULL;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300571 if (vdev->v4l2_dev) {
572 if (vdev->v4l2_dev->dev)
573 vdev->parent = vdev->v4l2_dev->dev;
574 if (vdev->ctrl_handler == NULL)
575 vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler;
576 }
Hans Verkuildd896012008-10-04 08:36:54 -0300577
Hans Verkuil22e22122009-09-06 07:13:14 -0300578 /* Part 2: find a free minor, device node number and device index. */
Hans Verkuildd896012008-10-04 08:36:54 -0300579#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
580 /* Keep the ranges for the first four types for historical
581 * reasons.
582 * Newer devices (not yet in place) should use the range
583 * of 128-191 and just pick the first free minor there
584 * (new style). */
585 switch (type) {
586 case VFL_TYPE_GRABBER:
587 minor_offset = 0;
588 minor_cnt = 64;
589 break;
590 case VFL_TYPE_RADIO:
591 minor_offset = 64;
592 minor_cnt = 64;
593 break;
Hans Verkuildd896012008-10-04 08:36:54 -0300594 case VFL_TYPE_VBI:
595 minor_offset = 224;
596 minor_cnt = 32;
597 break;
598 default:
599 minor_offset = 128;
600 minor_cnt = 64;
601 break;
602 }
603#endif
604
Hans Verkuil22e22122009-09-06 07:13:14 -0300605 /* Pick a device node number */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300606 mutex_lock(&videodev_lock);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300607 nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300608 if (nr == minor_cnt)
Hans Verkuil5062cb72009-09-07 03:40:24 -0300609 nr = devnode_find(vdev, 0, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300610 if (nr == minor_cnt) {
Hans Verkuil22e22122009-09-06 07:13:14 -0300611 printk(KERN_ERR "could not get a free device node number\n");
Hans Verkuildd896012008-10-04 08:36:54 -0300612 mutex_unlock(&videodev_lock);
613 return -ENFILE;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300614 }
Hans Verkuildd896012008-10-04 08:36:54 -0300615#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
Hans Verkuil22e22122009-09-06 07:13:14 -0300616 /* 1-on-1 mapping of device node number to minor number */
Hans Verkuildd896012008-10-04 08:36:54 -0300617 i = nr;
618#else
Hans Verkuil22e22122009-09-06 07:13:14 -0300619 /* The device node number and minor numbers are independent, so
620 we just find the first free minor number. */
Hans Verkuildd896012008-10-04 08:36:54 -0300621 for (i = 0; i < VIDEO_NUM_DEVICES; i++)
622 if (video_device[i] == NULL)
623 break;
624 if (i == VIDEO_NUM_DEVICES) {
625 mutex_unlock(&videodev_lock);
626 printk(KERN_ERR "could not get a free minor\n");
627 return -ENFILE;
628 }
629#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300630 vdev->minor = i + minor_offset;
631 vdev->num = nr;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300632 devnode_set(vdev);
633
Hans Verkuildc93a702008-12-19 21:28:27 -0300634 /* Should not happen since we thought this minor was free */
635 WARN_ON(video_device[vdev->minor] != NULL);
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300636 vdev->index = get_index(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300637 mutex_unlock(&videodev_lock);
638
Hans Verkuildc93a702008-12-19 21:28:27 -0300639 /* Part 3: Initialize the character device */
640 vdev->cdev = cdev_alloc();
641 if (vdev->cdev == NULL) {
642 ret = -ENOMEM;
643 goto cleanup;
644 }
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200645 vdev->cdev->ops = &v4l2_fops;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300646 vdev->cdev->owner = owner;
Hans Verkuildc93a702008-12-19 21:28:27 -0300647 ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300648 if (ret < 0) {
649 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300650 kfree(vdev->cdev);
651 vdev->cdev = NULL;
652 goto cleanup;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300653 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300654
655 /* Part 4: register the device with sysfs */
Hans Verkuildc93a702008-12-19 21:28:27 -0300656 vdev->dev.class = &video_class;
657 vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
658 if (vdev->parent)
659 vdev->dev.parent = vdev->parent;
Hans Verkuil22e22122009-09-06 07:13:14 -0300660 dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num);
Hans Verkuildc93a702008-12-19 21:28:27 -0300661 ret = device_register(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300662 if (ret < 0) {
663 printk(KERN_ERR "%s: device_register failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300664 goto cleanup;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300665 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300666 /* Register the release callback that will be called when the last
667 reference to the device goes away. */
668 vdev->dev.release = v4l2_device_release;
669
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300670 if (nr != -1 && nr != vdev->num && warn_if_nr_in_use)
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300671 printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__,
672 name_base, nr, video_device_node_name(vdev));
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300673#if defined(CONFIG_MEDIA_CONTROLLER)
674 /* Part 5: Register the entity. */
675 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev) {
676 vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L;
677 vdev->entity.name = vdev->name;
678 vdev->entity.v4l.major = VIDEO_MAJOR;
679 vdev->entity.v4l.minor = vdev->minor;
680 ret = media_device_register_entity(vdev->v4l2_dev->mdev,
681 &vdev->entity);
682 if (ret < 0)
683 printk(KERN_WARNING
684 "%s: media_device_register_entity failed\n",
685 __func__);
686 }
687#endif
688 /* Part 6: Activate this minor. The char device can now be used. */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300689 set_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300690 mutex_lock(&videodev_lock);
691 video_device[vdev->minor] = vdev;
692 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300693
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300694 return 0;
695
Hans Verkuildc93a702008-12-19 21:28:27 -0300696cleanup:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300697 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300698 if (vdev->cdev)
699 cdev_del(vdev->cdev);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300700 devnode_clear(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300701 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300702 /* Mark this video device as never having been registered. */
703 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300704 return ret;
705}
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300706EXPORT_SYMBOL(__video_register_device);
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300707
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300708/**
709 * video_unregister_device - unregister a video4linux device
Hans Verkuildc93a702008-12-19 21:28:27 -0300710 * @vdev: the device to unregister
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300711 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300712 * This unregisters the passed device. Future open calls will
713 * be met with errors.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300714 */
Hans Verkuildc93a702008-12-19 21:28:27 -0300715void video_unregister_device(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300716{
Hans Verkuildc93a702008-12-19 21:28:27 -0300717 /* Check if vdev was ever registered at all */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300718 if (!vdev || !video_is_registered(vdev))
Hans Verkuildc93a702008-12-19 21:28:27 -0300719 return;
720
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300721#if defined(CONFIG_MEDIA_CONTROLLER)
722 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev)
723 media_device_unregister_entity(&vdev->entity);
724#endif
725
Hans Verkuilca9afe62010-11-26 06:54:53 -0300726 mutex_lock(&videodev_lock);
727 /* This must be in a critical section to prevent a race with v4l2_open.
728 * Once this bit has been cleared video_get may never be called again.
729 */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300730 clear_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuilca9afe62010-11-26 06:54:53 -0300731 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300732 device_unregister(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300733}
734EXPORT_SYMBOL(video_unregister_device);
735
736/*
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300737 * Initialise video for linux
738 */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300739static int __init videodev_init(void)
740{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300741 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300742 int ret;
743
744 printk(KERN_INFO "Linux video capture interface: v2.00\n");
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300745 ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
746 if (ret < 0) {
747 printk(KERN_WARNING "videodev: unable to get major %d\n",
748 VIDEO_MAJOR);
749 return ret;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300750 }
751
752 ret = class_register(&video_class);
753 if (ret < 0) {
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300754 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300755 printk(KERN_WARNING "video_dev: class_register failed\n");
756 return -EIO;
757 }
758
759 return 0;
760}
761
762static void __exit videodev_exit(void)
763{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300764 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
765
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300766 class_unregister(&video_class);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300767 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300768}
769
770module_init(videodev_init)
771module_exit(videodev_exit)
772
773MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
774MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
775MODULE_LICENSE("GPL");
Scott James Remnantcbb72b02009-03-02 15:40:57 -0300776MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300777
778
779/*
780 * Local variables:
781 * c-basic-offset: 8
782 * End:
783 */