blob: 6a07d283456bec1055e301cc4e780de9a94d8c1a [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);
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300149 if (WARN_ON(video_device[vdev->minor] != vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300150 /* should not happen */
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300151 mutex_unlock(&videodev_lock);
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
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300169#if defined(CONFIG_MEDIA_CONTROLLER)
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300170 if (v4l2_dev && v4l2_dev->mdev &&
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300171 vdev->vfl_type != VFL_TYPE_SUBDEV)
172 media_device_unregister_entity(&vdev->entity);
173#endif
174
Hans Verkuil8280b662011-09-06 10:23:18 -0300175 /* Do not call v4l2_device_put if there is no release callback set.
176 * Drivers that have no v4l2_device release callback might free the
177 * v4l2_dev instance in the video_device release callback below, so we
178 * must perform this check here.
179 *
180 * TODO: In the long run all drivers that use v4l2_device should use the
181 * v4l2_device release callback. This check will then be unnecessary.
182 */
Antonio Ospitee58fced2011-10-12 17:59:26 -0300183 if (v4l2_dev && v4l2_dev->release == NULL)
Hans Verkuil8280b662011-09-06 10:23:18 -0300184 v4l2_dev = NULL;
185
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300186 /* Release video_device and perform other
187 cleanups as needed. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300188 vdev->release(vdev);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300189
190 /* Decrease v4l2_device refcount */
191 if (v4l2_dev)
192 v4l2_device_put(v4l2_dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300193}
194
195static struct class video_class = {
196 .name = VIDEO_NAME,
197 .dev_attrs = video_device_attrs,
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300198};
199
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300200struct video_device *video_devdata(struct file *file)
201{
202 return video_device[iminor(file->f_path.dentry->d_inode)];
203}
204EXPORT_SYMBOL(video_devdata);
205
Hans Verkuil02265492010-12-29 10:05:02 -0300206
207/* Priority handling */
208
209static inline bool prio_is_valid(enum v4l2_priority prio)
210{
211 return prio == V4L2_PRIORITY_BACKGROUND ||
212 prio == V4L2_PRIORITY_INTERACTIVE ||
213 prio == V4L2_PRIORITY_RECORD;
214}
215
216void v4l2_prio_init(struct v4l2_prio_state *global)
217{
218 memset(global, 0, sizeof(*global));
219}
220EXPORT_SYMBOL(v4l2_prio_init);
221
222int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
223 enum v4l2_priority new)
224{
225 if (!prio_is_valid(new))
226 return -EINVAL;
227 if (*local == new)
228 return 0;
229
230 atomic_inc(&global->prios[new]);
231 if (prio_is_valid(*local))
232 atomic_dec(&global->prios[*local]);
233 *local = new;
234 return 0;
235}
236EXPORT_SYMBOL(v4l2_prio_change);
237
238void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local)
239{
240 v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT);
241}
242EXPORT_SYMBOL(v4l2_prio_open);
243
244void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local)
245{
246 if (prio_is_valid(local))
247 atomic_dec(&global->prios[local]);
248}
249EXPORT_SYMBOL(v4l2_prio_close);
250
251enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global)
252{
253 if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0)
254 return V4L2_PRIORITY_RECORD;
255 if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0)
256 return V4L2_PRIORITY_INTERACTIVE;
257 if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0)
258 return V4L2_PRIORITY_BACKGROUND;
259 return V4L2_PRIORITY_UNSET;
260}
261EXPORT_SYMBOL(v4l2_prio_max);
262
263int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local)
264{
265 return (local < v4l2_prio_max(global)) ? -EBUSY : 0;
266}
267EXPORT_SYMBOL(v4l2_prio_check);
268
269
Hans Verkuildc93a702008-12-19 21:28:27 -0300270static ssize_t v4l2_read(struct file *filp, char __user *buf,
271 size_t sz, loff_t *off)
272{
273 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300274 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300275
276 if (!vdev->fops->read)
277 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300278 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
279 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300280 if (video_is_registered(vdev))
281 ret = vdev->fops->read(filp, buf, sz, off);
282 if (vdev->lock)
283 mutex_unlock(vdev->lock);
284 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300285}
286
287static ssize_t v4l2_write(struct file *filp, const char __user *buf,
288 size_t sz, loff_t *off)
289{
290 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300291 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300292
293 if (!vdev->fops->write)
294 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300295 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
296 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300297 if (video_is_registered(vdev))
298 ret = vdev->fops->write(filp, buf, sz, off);
299 if (vdev->lock)
300 mutex_unlock(vdev->lock);
301 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300302}
303
304static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
305{
306 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300307 int ret = POLLERR | POLLHUP;
Hans Verkuildc93a702008-12-19 21:28:27 -0300308
Hans Verkuilee6869a2010-09-26 08:47:38 -0300309 if (!vdev->fops->poll)
Hans Verkuil28778422010-11-26 06:43:51 -0300310 return DEFAULT_POLLMASK;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300311 if (vdev->lock)
312 mutex_lock(vdev->lock);
313 if (video_is_registered(vdev))
314 ret = vdev->fops->poll(filp, poll);
315 if (vdev->lock)
316 mutex_unlock(vdev->lock);
317 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300318}
319
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200320static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Hans Verkuildc93a702008-12-19 21:28:27 -0300321{
322 struct video_device *vdev = video_devdata(filp);
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300323 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300324
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200325 if (vdev->fops->unlocked_ioctl) {
Hans Verkuil28778422010-11-26 06:43:51 -0300326 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
327 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300328 if (video_is_registered(vdev))
329 ret = vdev->fops->unlocked_ioctl(filp, cmd, arg);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300330 if (vdev->lock)
331 mutex_unlock(vdev->lock);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200332 } else if (vdev->fops->ioctl) {
Hans Verkuil879aa242010-11-26 06:47:28 -0300333 /* This code path is a replacement for the BKL. It is a major
334 * hack but it will have to do for those drivers that are not
335 * yet converted to use unlocked_ioctl.
336 *
337 * There are two options: if the driver implements struct
338 * v4l2_device, then the lock defined there is used to
339 * serialize the ioctls. Otherwise the v4l2 core lock defined
340 * below is used. This lock is really bad since it serializes
341 * completely independent devices.
342 *
343 * Both variants suffer from the same problem: if the driver
344 * sleeps, then it blocks all ioctls since the lock is still
345 * held. This is very common for VIDIOC_DQBUF since that
346 * normally waits for a frame to arrive. As a result any other
347 * ioctl calls will proceed very, very slowly since each call
348 * will have to wait for the VIDIOC_QBUF to finish. Things that
349 * should take 0.01s may now take 10-20 seconds.
350 *
351 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
352 * This actually works OK for videobuf-based drivers, since
353 * videobuf will take its own internal lock.
354 */
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300355 static DEFINE_MUTEX(v4l2_ioctl_mutex);
Hans Verkuil879aa242010-11-26 06:47:28 -0300356 struct mutex *m = vdev->v4l2_dev ?
357 &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex;
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300358
Hans Verkuil879aa242010-11-26 06:47:28 -0300359 if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m))
360 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300361 if (video_is_registered(vdev))
362 ret = vdev->fops->ioctl(filp, cmd, arg);
Hans Verkuil879aa242010-11-26 06:47:28 -0300363 if (cmd != VIDIOC_DQBUF)
364 mutex_unlock(m);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200365 } else
366 ret = -ENOTTY;
Hans Verkuildc93a702008-12-19 21:28:27 -0300367
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200368 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300369}
370
Bob Liuecc65172011-05-06 05:20:09 -0300371#ifdef CONFIG_MMU
372#define v4l2_get_unmapped_area NULL
373#else
374static unsigned long v4l2_get_unmapped_area(struct file *filp,
375 unsigned long addr, unsigned long len, unsigned long pgoff,
376 unsigned long flags)
377{
378 struct video_device *vdev = video_devdata(filp);
379
380 if (!vdev->fops->get_unmapped_area)
381 return -ENOSYS;
382 if (!video_is_registered(vdev))
383 return -ENODEV;
384 return vdev->fops->get_unmapped_area(filp, addr, len, pgoff, flags);
385}
386#endif
387
Hans Verkuildc93a702008-12-19 21:28:27 -0300388static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
389{
390 struct video_device *vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300391 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300392
Hans Verkuilee6869a2010-09-26 08:47:38 -0300393 if (!vdev->fops->mmap)
394 return ret;
Hans Verkuil28778422010-11-26 06:43:51 -0300395 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
396 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300397 if (video_is_registered(vdev))
398 ret = vdev->fops->mmap(filp, vm);
399 if (vdev->lock)
400 mutex_unlock(vdev->lock);
401 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300402}
403
404/* Override for the open function */
405static int v4l2_open(struct inode *inode, struct file *filp)
406{
407 struct video_device *vdev;
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300408 int ret = 0;
Hans Verkuildc93a702008-12-19 21:28:27 -0300409
410 /* Check if the video device is available */
411 mutex_lock(&videodev_lock);
412 vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300413 /* return ENODEV if the video device has already been removed. */
Hans Verkuilca9afe62010-11-26 06:54:53 -0300414 if (vdev == NULL || !video_is_registered(vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300415 mutex_unlock(&videodev_lock);
416 return -ENODEV;
417 }
418 /* and increase the device refcount */
419 video_get(vdev);
420 mutex_unlock(&videodev_lock);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300421 if (vdev->fops->open) {
Hans Verkuil28778422010-11-26 06:43:51 -0300422 if (vdev->lock && mutex_lock_interruptible(vdev->lock)) {
423 ret = -ERESTARTSYS;
424 goto err;
425 }
Hans Verkuilee6869a2010-09-26 08:47:38 -0300426 if (video_is_registered(vdev))
427 ret = vdev->fops->open(filp);
428 else
429 ret = -ENODEV;
430 if (vdev->lock)
431 mutex_unlock(vdev->lock);
432 }
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300433
Hans Verkuil28778422010-11-26 06:43:51 -0300434err:
Hans Verkuildc93a702008-12-19 21:28:27 -0300435 /* decrease the refcount in case of an error */
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300436 if (ret)
Hans Verkuildc93a702008-12-19 21:28:27 -0300437 video_put(vdev);
438 return ret;
439}
440
441/* Override for the release function */
442static int v4l2_release(struct inode *inode, struct file *filp)
443{
444 struct video_device *vdev = video_devdata(filp);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300445 int ret = 0;
446
Hans Verkuilee6869a2010-09-26 08:47:38 -0300447 if (vdev->fops->release) {
448 if (vdev->lock)
449 mutex_lock(vdev->lock);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300450 vdev->fops->release(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300451 if (vdev->lock)
452 mutex_unlock(vdev->lock);
453 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300454 /* decrease the refcount unconditionally since the release()
455 return value is ignored. */
456 video_put(vdev);
457 return ret;
458}
459
Hans Verkuildc93a702008-12-19 21:28:27 -0300460static const struct file_operations v4l2_fops = {
461 .owner = THIS_MODULE,
462 .read = v4l2_read,
463 .write = v4l2_write,
464 .open = v4l2_open,
Bob Liuecc65172011-05-06 05:20:09 -0300465 .get_unmapped_area = v4l2_get_unmapped_area,
Hans Verkuildc93a702008-12-19 21:28:27 -0300466 .mmap = v4l2_mmap,
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200467 .unlocked_ioctl = v4l2_ioctl,
Hans Verkuildc93a702008-12-19 21:28:27 -0300468#ifdef CONFIG_COMPAT
Hans Verkuil9bb7cde2008-12-30 06:42:40 -0300469 .compat_ioctl = v4l2_compat_ioctl32,
Hans Verkuildc93a702008-12-19 21:28:27 -0300470#endif
471 .release = v4l2_release,
472 .poll = v4l2_poll,
473 .llseek = no_llseek,
474};
475
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300476/**
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300477 * get_index - assign stream index number based on parent device
Hans Verkuildc93a702008-12-19 21:28:27 -0300478 * @vdev: video_device to assign index number to, vdev->parent should be assigned
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300479 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300480 * Note that when this is called the new device has not yet been registered
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300481 * in the video_device array, but it was able to obtain a minor number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300482 *
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300483 * This means that we can always obtain a free stream index number since
484 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
485 * use of the video_device array.
486 *
487 * Returns a free index number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300488 */
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300489static int get_index(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300490{
Hans Verkuil775a05d2009-02-14 11:31:01 -0300491 /* This can be static since this function is called with the global
492 videodev_lock held. */
493 static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300494 int i;
495
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300496 /* Some drivers do not set the parent. In that case always return 0. */
Hans Verkuil806e5b72008-12-19 09:10:56 -0300497 if (vdev->parent == NULL)
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300498 return 0;
Hans Verkuil775a05d2009-02-14 11:31:01 -0300499
500 bitmap_zero(used, VIDEO_NUM_DEVICES);
Hans Verkuil806e5b72008-12-19 09:10:56 -0300501
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300502 for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
503 if (video_device[i] != NULL &&
Hans Verkuil5e85e732008-07-20 06:31:39 -0300504 video_device[i]->parent == vdev->parent) {
Hans Verkuil775a05d2009-02-14 11:31:01 -0300505 set_bit(video_device[i]->index, used);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300506 }
507 }
508
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300509 return find_first_zero_bit(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300510}
511
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300512/**
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300513 * __video_register_device - register video4linux devices
Hans Verkuildc93a702008-12-19 21:28:27 -0300514 * @vdev: video device structure we want to register
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300515 * @type: type of device to register
Hans Verkuil22e22122009-09-06 07:13:14 -0300516 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300517 * -1 == first free)
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300518 * @warn_if_nr_in_use: warn if the desired device node number
519 * was already in use and another number was chosen instead.
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300520 * @owner: module that owns the video device node
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300521 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300522 * The registration code assigns minor numbers and device node numbers
523 * based on the requested type and registers the new device node with
524 * the kernel.
Hans Verkuil46b63372010-12-31 11:47:23 -0300525 *
526 * This function assumes that struct video_device was zeroed when it
527 * was allocated and does not contain any stale date.
528 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300529 * An error is returned if no free minor or device node number could be
530 * found, or if the registration of the device node failed.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300531 *
532 * Zero is returned on success.
533 *
534 * Valid types are
535 *
536 * %VFL_TYPE_GRABBER - A frame grabber
537 *
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300538 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
539 *
540 * %VFL_TYPE_RADIO - A radio card
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300541 *
542 * %VFL_TYPE_SUBDEV - A subdevice
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300543 */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300544int __video_register_device(struct video_device *vdev, int type, int nr,
545 int warn_if_nr_in_use, struct module *owner)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300546{
547 int i = 0;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300548 int ret;
Hans Verkuildd896012008-10-04 08:36:54 -0300549 int minor_offset = 0;
550 int minor_cnt = VIDEO_NUM_DEVICES;
551 const char *name_base;
Hans Verkuildc93a702008-12-19 21:28:27 -0300552
553 /* A minor value of -1 marks this video device as never
554 having been registered */
Trent Piepho428c8d12009-03-03 18:51:52 -0300555 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300556
Hans Verkuild6e74972008-08-23 06:27:59 -0300557 /* the release callback MUST be present */
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300558 if (WARN_ON(!vdev->release))
Henrik Kretzschmaree7aa9f2008-08-22 16:41:03 -0300559 return -EINVAL;
560
Sakari Ailus1babcb42010-03-23 09:25:26 -0300561 /* v4l2_fh support */
562 spin_lock_init(&vdev->fh_lock);
563 INIT_LIST_HEAD(&vdev->fh_list);
564
Hans Verkuildc93a702008-12-19 21:28:27 -0300565 /* Part 1: check device type */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300566 switch (type) {
567 case VFL_TYPE_GRABBER:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300568 name_base = "video";
569 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300570 case VFL_TYPE_VBI:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300571 name_base = "vbi";
572 break;
573 case VFL_TYPE_RADIO:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300574 name_base = "radio";
575 break;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300576 case VFL_TYPE_SUBDEV:
577 name_base = "v4l-subdev";
578 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300579 default:
580 printk(KERN_ERR "%s called with unknown type: %d\n",
581 __func__, type);
Henrik Kretzschmar46f2c212008-09-03 16:47:39 -0300582 return -EINVAL;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300583 }
584
Hans Verkuildc93a702008-12-19 21:28:27 -0300585 vdev->vfl_type = type;
586 vdev->cdev = NULL;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300587 if (vdev->v4l2_dev) {
588 if (vdev->v4l2_dev->dev)
589 vdev->parent = vdev->v4l2_dev->dev;
590 if (vdev->ctrl_handler == NULL)
591 vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler;
Hans Verkuilb1a873a2011-03-22 10:14:07 -0300592 /* If the prio state pointer is NULL, then use the v4l2_device
593 prio state. */
594 if (vdev->prio == NULL)
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300595 vdev->prio = &vdev->v4l2_dev->prio;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300596 }
Hans Verkuildd896012008-10-04 08:36:54 -0300597
Hans Verkuil22e22122009-09-06 07:13:14 -0300598 /* Part 2: find a free minor, device node number and device index. */
Hans Verkuildd896012008-10-04 08:36:54 -0300599#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
600 /* Keep the ranges for the first four types for historical
601 * reasons.
602 * Newer devices (not yet in place) should use the range
603 * of 128-191 and just pick the first free minor there
604 * (new style). */
605 switch (type) {
606 case VFL_TYPE_GRABBER:
607 minor_offset = 0;
608 minor_cnt = 64;
609 break;
610 case VFL_TYPE_RADIO:
611 minor_offset = 64;
612 minor_cnt = 64;
613 break;
Hans Verkuildd896012008-10-04 08:36:54 -0300614 case VFL_TYPE_VBI:
615 minor_offset = 224;
616 minor_cnt = 32;
617 break;
618 default:
619 minor_offset = 128;
620 minor_cnt = 64;
621 break;
622 }
623#endif
624
Hans Verkuil22e22122009-09-06 07:13:14 -0300625 /* Pick a device node number */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300626 mutex_lock(&videodev_lock);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300627 nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300628 if (nr == minor_cnt)
Hans Verkuil5062cb72009-09-07 03:40:24 -0300629 nr = devnode_find(vdev, 0, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300630 if (nr == minor_cnt) {
Hans Verkuil22e22122009-09-06 07:13:14 -0300631 printk(KERN_ERR "could not get a free device node number\n");
Hans Verkuildd896012008-10-04 08:36:54 -0300632 mutex_unlock(&videodev_lock);
633 return -ENFILE;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300634 }
Hans Verkuildd896012008-10-04 08:36:54 -0300635#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
Hans Verkuil22e22122009-09-06 07:13:14 -0300636 /* 1-on-1 mapping of device node number to minor number */
Hans Verkuildd896012008-10-04 08:36:54 -0300637 i = nr;
638#else
Hans Verkuil22e22122009-09-06 07:13:14 -0300639 /* The device node number and minor numbers are independent, so
640 we just find the first free minor number. */
Hans Verkuildd896012008-10-04 08:36:54 -0300641 for (i = 0; i < VIDEO_NUM_DEVICES; i++)
642 if (video_device[i] == NULL)
643 break;
644 if (i == VIDEO_NUM_DEVICES) {
645 mutex_unlock(&videodev_lock);
646 printk(KERN_ERR "could not get a free minor\n");
647 return -ENFILE;
648 }
649#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300650 vdev->minor = i + minor_offset;
651 vdev->num = nr;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300652 devnode_set(vdev);
653
Hans Verkuildc93a702008-12-19 21:28:27 -0300654 /* Should not happen since we thought this minor was free */
655 WARN_ON(video_device[vdev->minor] != NULL);
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300656 vdev->index = get_index(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300657 mutex_unlock(&videodev_lock);
658
Hans Verkuildc93a702008-12-19 21:28:27 -0300659 /* Part 3: Initialize the character device */
660 vdev->cdev = cdev_alloc();
661 if (vdev->cdev == NULL) {
662 ret = -ENOMEM;
663 goto cleanup;
664 }
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200665 vdev->cdev->ops = &v4l2_fops;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300666 vdev->cdev->owner = owner;
Hans Verkuildc93a702008-12-19 21:28:27 -0300667 ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300668 if (ret < 0) {
669 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300670 kfree(vdev->cdev);
671 vdev->cdev = NULL;
672 goto cleanup;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300673 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300674
675 /* Part 4: register the device with sysfs */
Hans Verkuildc93a702008-12-19 21:28:27 -0300676 vdev->dev.class = &video_class;
677 vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
678 if (vdev->parent)
679 vdev->dev.parent = vdev->parent;
Hans Verkuil22e22122009-09-06 07:13:14 -0300680 dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num);
Hans Verkuildc93a702008-12-19 21:28:27 -0300681 ret = device_register(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300682 if (ret < 0) {
683 printk(KERN_ERR "%s: device_register failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300684 goto cleanup;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300685 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300686 /* Register the release callback that will be called when the last
687 reference to the device goes away. */
688 vdev->dev.release = v4l2_device_release;
689
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300690 if (nr != -1 && nr != vdev->num && warn_if_nr_in_use)
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300691 printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__,
692 name_base, nr, video_device_node_name(vdev));
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300693
694 /* Increase v4l2_device refcount */
695 if (vdev->v4l2_dev)
696 v4l2_device_get(vdev->v4l2_dev);
697
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300698#if defined(CONFIG_MEDIA_CONTROLLER)
699 /* Part 5: Register the entity. */
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300700 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
701 vdev->vfl_type != VFL_TYPE_SUBDEV) {
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300702 vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L;
703 vdev->entity.name = vdev->name;
704 vdev->entity.v4l.major = VIDEO_MAJOR;
705 vdev->entity.v4l.minor = vdev->minor;
706 ret = media_device_register_entity(vdev->v4l2_dev->mdev,
707 &vdev->entity);
708 if (ret < 0)
709 printk(KERN_WARNING
710 "%s: media_device_register_entity failed\n",
711 __func__);
712 }
713#endif
714 /* Part 6: Activate this minor. The char device can now be used. */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300715 set_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300716 mutex_lock(&videodev_lock);
717 video_device[vdev->minor] = vdev;
718 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300719
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300720 return 0;
721
Hans Verkuildc93a702008-12-19 21:28:27 -0300722cleanup:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300723 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300724 if (vdev->cdev)
725 cdev_del(vdev->cdev);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300726 devnode_clear(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300727 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300728 /* Mark this video device as never having been registered. */
729 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300730 return ret;
731}
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300732EXPORT_SYMBOL(__video_register_device);
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300733
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300734/**
735 * video_unregister_device - unregister a video4linux device
Hans Verkuildc93a702008-12-19 21:28:27 -0300736 * @vdev: the device to unregister
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300737 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300738 * This unregisters the passed device. Future open calls will
739 * be met with errors.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300740 */
Hans Verkuildc93a702008-12-19 21:28:27 -0300741void video_unregister_device(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300742{
Hans Verkuildc93a702008-12-19 21:28:27 -0300743 /* Check if vdev was ever registered at all */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300744 if (!vdev || !video_is_registered(vdev))
Hans Verkuildc93a702008-12-19 21:28:27 -0300745 return;
746
Hans Verkuilca9afe62010-11-26 06:54:53 -0300747 mutex_lock(&videodev_lock);
748 /* This must be in a critical section to prevent a race with v4l2_open.
749 * Once this bit has been cleared video_get may never be called again.
750 */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300751 clear_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuilca9afe62010-11-26 06:54:53 -0300752 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300753 device_unregister(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300754}
755EXPORT_SYMBOL(video_unregister_device);
756
757/*
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300758 * Initialise video for linux
759 */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300760static int __init videodev_init(void)
761{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300762 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300763 int ret;
764
765 printk(KERN_INFO "Linux video capture interface: v2.00\n");
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300766 ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
767 if (ret < 0) {
768 printk(KERN_WARNING "videodev: unable to get major %d\n",
769 VIDEO_MAJOR);
770 return ret;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300771 }
772
773 ret = class_register(&video_class);
774 if (ret < 0) {
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300775 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300776 printk(KERN_WARNING "video_dev: class_register failed\n");
777 return -EIO;
778 }
779
780 return 0;
781}
782
783static void __exit videodev_exit(void)
784{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300785 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
786
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300787 class_unregister(&video_class);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300788 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300789}
790
791module_init(videodev_init)
792module_exit(videodev_exit)
793
794MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
795MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
796MODULE_LICENSE("GPL");
Scott James Remnantcbb72b02009-03-02 15:40:57 -0300797MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300798
799
800/*
801 * Local variables:
802 * c-basic-offset: 8
803 * End:
804 */