blob: de1e9ab7db9910169a1f94ee5f4617336a54e6eb [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>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030029
30#include <media/v4l2-common.h>
Hans Verkuil9bea3512008-12-23 07:35:17 -030031#include <media/v4l2-device.h>
Hans Verkuilbec43662008-12-30 06:58:20 -030032#include <media/v4l2-ioctl.h>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030033
34#define VIDEO_NUM_DEVICES 256
35#define VIDEO_NAME "video4linux"
36
37/*
38 * sysfs stuff
39 */
40
41static ssize_t show_index(struct device *cd,
42 struct device_attribute *attr, char *buf)
43{
Hans Verkuildc93a702008-12-19 21:28:27 -030044 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030045
Hans Verkuildc93a702008-12-19 21:28:27 -030046 return sprintf(buf, "%i\n", vdev->index);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030047}
48
Hans Verkuil80131fe02012-06-22 06:37:38 -030049static ssize_t show_debug(struct device *cd,
50 struct device_attribute *attr, char *buf)
51{
52 struct video_device *vdev = to_video_device(cd);
53
54 return sprintf(buf, "%i\n", vdev->debug);
55}
56
57static ssize_t set_debug(struct device *cd, struct device_attribute *attr,
58 const char *buf, size_t len)
59{
60 struct video_device *vdev = to_video_device(cd);
61 int res = 0;
62 u16 value;
63
64 res = kstrtou16(buf, 0, &value);
65 if (res)
66 return res;
67
68 vdev->debug = value;
69 return len;
70}
71
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030072static ssize_t show_name(struct device *cd,
73 struct device_attribute *attr, char *buf)
74{
Hans Verkuildc93a702008-12-19 21:28:27 -030075 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030076
Hans Verkuildc93a702008-12-19 21:28:27 -030077 return sprintf(buf, "%.*s\n", (int)sizeof(vdev->name), vdev->name);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030078}
79
80static struct device_attribute video_device_attrs[] = {
81 __ATTR(name, S_IRUGO, show_name, NULL),
Hans Verkuil80131fe02012-06-22 06:37:38 -030082 __ATTR(debug, 0644, show_debug, set_debug),
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030083 __ATTR(index, S_IRUGO, show_index, NULL),
84 __ATTR_NULL
85};
86
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030087/*
88 * Active devices
89 */
90static struct video_device *video_device[VIDEO_NUM_DEVICES];
91static DEFINE_MUTEX(videodev_lock);
Hans Verkuil22e22122009-09-06 07:13:14 -030092static DECLARE_BITMAP(devnode_nums[VFL_TYPE_MAX], VIDEO_NUM_DEVICES);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030093
Hans Verkuil5062cb72009-09-07 03:40:24 -030094/* Device node utility functions */
95
96/* Note: these utility functions all assume that vfl_type is in the range
97 [0, VFL_TYPE_MAX-1]. */
98
99#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
100/* Return the bitmap corresponding to vfl_type. */
101static inline unsigned long *devnode_bits(int vfl_type)
102{
103 /* Any types not assigned to fixed minor ranges must be mapped to
104 one single bitmap for the purposes of finding a free node number
105 since all those unassigned types use the same minor range. */
Hans Verkuil226c0ee2010-08-06 12:48:00 -0300106 int idx = (vfl_type > VFL_TYPE_RADIO) ? VFL_TYPE_MAX - 1 : vfl_type;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300107
108 return devnode_nums[idx];
109}
110#else
111/* Return the bitmap corresponding to vfl_type. */
112static inline unsigned long *devnode_bits(int vfl_type)
113{
114 return devnode_nums[vfl_type];
115}
116#endif
117
118/* Mark device node number vdev->num as used */
119static inline void devnode_set(struct video_device *vdev)
120{
121 set_bit(vdev->num, devnode_bits(vdev->vfl_type));
122}
123
124/* Mark device node number vdev->num as unused */
125static inline void devnode_clear(struct video_device *vdev)
126{
127 clear_bit(vdev->num, devnode_bits(vdev->vfl_type));
128}
129
130/* Try to find a free device node number in the range [from, to> */
131static inline int devnode_find(struct video_device *vdev, int from, int to)
132{
133 return find_next_zero_bit(devnode_bits(vdev->vfl_type), to, from);
134}
135
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300136struct video_device *video_device_alloc(void)
137{
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300138 return kzalloc(sizeof(struct video_device), GFP_KERNEL);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300139}
140EXPORT_SYMBOL(video_device_alloc);
141
Hans Verkuildc93a702008-12-19 21:28:27 -0300142void video_device_release(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300143{
Hans Verkuildc93a702008-12-19 21:28:27 -0300144 kfree(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300145}
146EXPORT_SYMBOL(video_device_release);
147
Hans Verkuildc93a702008-12-19 21:28:27 -0300148void video_device_release_empty(struct video_device *vdev)
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300149{
150 /* Do nothing */
151 /* Only valid when the video_device struct is a static. */
152}
153EXPORT_SYMBOL(video_device_release_empty);
154
Hans Verkuildc93a702008-12-19 21:28:27 -0300155static inline void video_get(struct video_device *vdev)
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300156{
Hans Verkuildc93a702008-12-19 21:28:27 -0300157 get_device(&vdev->dev);
158}
159
160static inline void video_put(struct video_device *vdev)
161{
162 put_device(&vdev->dev);
163}
164
165/* Called when the last user of the video device exits. */
166static void v4l2_device_release(struct device *cd)
167{
168 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300169 struct v4l2_device *v4l2_dev = vdev->v4l2_dev;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300170
171 mutex_lock(&videodev_lock);
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300172 if (WARN_ON(video_device[vdev->minor] != vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300173 /* should not happen */
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300174 mutex_unlock(&videodev_lock);
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300175 return;
176 }
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300177
178 /* Free up this device for reuse */
Hans Verkuildc93a702008-12-19 21:28:27 -0300179 video_device[vdev->minor] = NULL;
180
181 /* Delete the cdev on this minor as well */
182 cdev_del(vdev->cdev);
183 /* Just in case some driver tries to access this from
184 the release() callback. */
185 vdev->cdev = NULL;
186
Hans Verkuil22e22122009-09-06 07:13:14 -0300187 /* Mark device node number as free */
Hans Verkuil5062cb72009-09-07 03:40:24 -0300188 devnode_clear(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300189
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300190 mutex_unlock(&videodev_lock);
191
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300192#if defined(CONFIG_MEDIA_CONTROLLER)
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300193 if (v4l2_dev && v4l2_dev->mdev &&
Laurent Pinchartc064b8e2011-06-15 05:20:34 -0300194 vdev->vfl_type != VFL_TYPE_SUBDEV)
195 media_device_unregister_entity(&vdev->entity);
196#endif
197
Hans Verkuil8280b662011-09-06 10:23:18 -0300198 /* Do not call v4l2_device_put if there is no release callback set.
199 * Drivers that have no v4l2_device release callback might free the
200 * v4l2_dev instance in the video_device release callback below, so we
201 * must perform this check here.
202 *
203 * TODO: In the long run all drivers that use v4l2_device should use the
204 * v4l2_device release callback. This check will then be unnecessary.
205 */
Antonio Ospitee58fced2011-10-12 17:59:26 -0300206 if (v4l2_dev && v4l2_dev->release == NULL)
Hans Verkuil8280b662011-09-06 10:23:18 -0300207 v4l2_dev = NULL;
208
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300209 /* Release video_device and perform other
210 cleanups as needed. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300211 vdev->release(vdev);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300212
213 /* Decrease v4l2_device refcount */
214 if (v4l2_dev)
215 v4l2_device_put(v4l2_dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300216}
217
218static struct class video_class = {
219 .name = VIDEO_NAME,
220 .dev_attrs = video_device_attrs,
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300221};
222
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300223struct video_device *video_devdata(struct file *file)
224{
Al Viro496ad9a2013-01-23 17:07:38 -0500225 return video_device[iminor(file_inode(file))];
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300226}
227EXPORT_SYMBOL(video_devdata);
228
Hans Verkuil02265492010-12-29 10:05:02 -0300229
230/* Priority handling */
231
232static inline bool prio_is_valid(enum v4l2_priority prio)
233{
234 return prio == V4L2_PRIORITY_BACKGROUND ||
235 prio == V4L2_PRIORITY_INTERACTIVE ||
236 prio == V4L2_PRIORITY_RECORD;
237}
238
239void v4l2_prio_init(struct v4l2_prio_state *global)
240{
241 memset(global, 0, sizeof(*global));
242}
243EXPORT_SYMBOL(v4l2_prio_init);
244
245int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
246 enum v4l2_priority new)
247{
248 if (!prio_is_valid(new))
249 return -EINVAL;
250 if (*local == new)
251 return 0;
252
253 atomic_inc(&global->prios[new]);
254 if (prio_is_valid(*local))
255 atomic_dec(&global->prios[*local]);
256 *local = new;
257 return 0;
258}
259EXPORT_SYMBOL(v4l2_prio_change);
260
261void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local)
262{
263 v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT);
264}
265EXPORT_SYMBOL(v4l2_prio_open);
266
267void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local)
268{
269 if (prio_is_valid(local))
270 atomic_dec(&global->prios[local]);
271}
272EXPORT_SYMBOL(v4l2_prio_close);
273
274enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global)
275{
276 if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0)
277 return V4L2_PRIORITY_RECORD;
278 if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0)
279 return V4L2_PRIORITY_INTERACTIVE;
280 if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0)
281 return V4L2_PRIORITY_BACKGROUND;
282 return V4L2_PRIORITY_UNSET;
283}
284EXPORT_SYMBOL(v4l2_prio_max);
285
286int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local)
287{
288 return (local < v4l2_prio_max(global)) ? -EBUSY : 0;
289}
290EXPORT_SYMBOL(v4l2_prio_check);
291
292
Hans Verkuildc93a702008-12-19 21:28:27 -0300293static ssize_t v4l2_read(struct file *filp, char __user *buf,
294 size_t sz, loff_t *off)
295{
296 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300297 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300298
299 if (!vdev->fops->read)
300 return -EINVAL;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300301 if (video_is_registered(vdev))
302 ret = vdev->fops->read(filp, buf, sz, off);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300303 if (vdev->debug)
304 printk(KERN_DEBUG "%s: read: %zd (%d)\n",
305 video_device_node_name(vdev), sz, ret);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300306 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300307}
308
309static ssize_t v4l2_write(struct file *filp, const char __user *buf,
310 size_t sz, loff_t *off)
311{
312 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300313 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300314
315 if (!vdev->fops->write)
316 return -EINVAL;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300317 if (video_is_registered(vdev))
318 ret = vdev->fops->write(filp, buf, sz, off);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300319 if (vdev->debug)
320 printk(KERN_DEBUG "%s: write: %zd (%d)\n",
321 video_device_node_name(vdev), sz, ret);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300322 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300323}
324
325static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
326{
327 struct video_device *vdev = video_devdata(filp);
Hans Verkuilcf533732012-07-31 04:02:25 -0300328 unsigned int res = POLLERR | POLLHUP;
Hans Verkuildc93a702008-12-19 21:28:27 -0300329
Hans Verkuilee6869a2010-09-26 08:47:38 -0300330 if (!vdev->fops->poll)
Hans Verkuil28778422010-11-26 06:43:51 -0300331 return DEFAULT_POLLMASK;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300332 if (video_is_registered(vdev))
Hans Verkuilcf533732012-07-31 04:02:25 -0300333 res = vdev->fops->poll(filp, poll);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300334 if (vdev->debug)
335 printk(KERN_DEBUG "%s: poll: %08x\n",
Hans Verkuilcf533732012-07-31 04:02:25 -0300336 video_device_node_name(vdev), res);
337 return res;
Hans Verkuildc93a702008-12-19 21:28:27 -0300338}
339
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200340static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Hans Verkuildc93a702008-12-19 21:28:27 -0300341{
342 struct video_device *vdev = video_devdata(filp);
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300343 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300344
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200345 if (vdev->fops->unlocked_ioctl) {
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300346 struct mutex *lock = v4l2_ioctl_get_lock(vdev, cmd);
Hans Verkuil8ab75e32012-05-10 02:51:31 -0300347
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300348 if (lock && mutex_lock_interruptible(lock))
349 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300350 if (video_is_registered(vdev))
351 ret = vdev->fops->unlocked_ioctl(filp, cmd, arg);
Hans Verkuil5a5adf62012-06-22 07:29:35 -0300352 if (lock)
353 mutex_unlock(lock);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200354 } else if (vdev->fops->ioctl) {
Hans Verkuil879aa242010-11-26 06:47:28 -0300355 /* This code path is a replacement for the BKL. It is a major
356 * hack but it will have to do for those drivers that are not
357 * yet converted to use unlocked_ioctl.
358 *
359 * There are two options: if the driver implements struct
360 * v4l2_device, then the lock defined there is used to
361 * serialize the ioctls. Otherwise the v4l2 core lock defined
362 * below is used. This lock is really bad since it serializes
363 * completely independent devices.
364 *
365 * Both variants suffer from the same problem: if the driver
366 * sleeps, then it blocks all ioctls since the lock is still
367 * held. This is very common for VIDIOC_DQBUF since that
368 * normally waits for a frame to arrive. As a result any other
369 * ioctl calls will proceed very, very slowly since each call
370 * will have to wait for the VIDIOC_QBUF to finish. Things that
371 * should take 0.01s may now take 10-20 seconds.
372 *
373 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
374 * This actually works OK for videobuf-based drivers, since
375 * videobuf will take its own internal lock.
376 */
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300377 static DEFINE_MUTEX(v4l2_ioctl_mutex);
Hans Verkuil879aa242010-11-26 06:47:28 -0300378 struct mutex *m = vdev->v4l2_dev ?
379 &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex;
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300380
Hans Verkuil879aa242010-11-26 06:47:28 -0300381 if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m))
382 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300383 if (video_is_registered(vdev))
384 ret = vdev->fops->ioctl(filp, cmd, arg);
Hans Verkuil879aa242010-11-26 06:47:28 -0300385 if (cmd != VIDIOC_DQBUF)
386 mutex_unlock(m);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200387 } else
388 ret = -ENOTTY;
Hans Verkuildc93a702008-12-19 21:28:27 -0300389
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200390 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300391}
392
Bob Liuecc65172011-05-06 05:20:09 -0300393#ifdef CONFIG_MMU
394#define v4l2_get_unmapped_area NULL
395#else
396static unsigned long v4l2_get_unmapped_area(struct file *filp,
397 unsigned long addr, unsigned long len, unsigned long pgoff,
398 unsigned long flags)
399{
400 struct video_device *vdev = video_devdata(filp);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300401 int ret;
Bob Liuecc65172011-05-06 05:20:09 -0300402
403 if (!vdev->fops->get_unmapped_area)
404 return -ENOSYS;
405 if (!video_is_registered(vdev))
406 return -ENODEV;
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300407 ret = vdev->fops->get_unmapped_area(filp, addr, len, pgoff, flags);
408 if (vdev->debug)
409 printk(KERN_DEBUG "%s: get_unmapped_area (%d)\n",
410 video_device_node_name(vdev), ret);
411 return ret;
Bob Liuecc65172011-05-06 05:20:09 -0300412}
413#endif
414
Hans Verkuildc93a702008-12-19 21:28:27 -0300415static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
416{
417 struct video_device *vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300418 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300419
Hans Verkuilee6869a2010-09-26 08:47:38 -0300420 if (!vdev->fops->mmap)
Hans Verkuilcf533732012-07-31 04:02:25 -0300421 return -ENODEV;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300422 if (video_is_registered(vdev))
423 ret = vdev->fops->mmap(filp, vm);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300424 if (vdev->debug)
425 printk(KERN_DEBUG "%s: mmap (%d)\n",
426 video_device_node_name(vdev), ret);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300427 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300428}
429
430/* Override for the open function */
431static int v4l2_open(struct inode *inode, struct file *filp)
432{
433 struct video_device *vdev;
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300434 int ret = 0;
Hans Verkuildc93a702008-12-19 21:28:27 -0300435
436 /* Check if the video device is available */
437 mutex_lock(&videodev_lock);
438 vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300439 /* return ENODEV if the video device has already been removed. */
Hans Verkuilca9afe62010-11-26 06:54:53 -0300440 if (vdev == NULL || !video_is_registered(vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300441 mutex_unlock(&videodev_lock);
442 return -ENODEV;
443 }
444 /* and increase the device refcount */
445 video_get(vdev);
446 mutex_unlock(&videodev_lock);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300447 if (vdev->fops->open) {
Hans Verkuilee6869a2010-09-26 08:47:38 -0300448 if (video_is_registered(vdev))
449 ret = vdev->fops->open(filp);
450 else
451 ret = -ENODEV;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300452 }
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300453
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300454 if (vdev->debug)
455 printk(KERN_DEBUG "%s: open (%d)\n",
456 video_device_node_name(vdev), ret);
Ezequiel García8f695d32012-07-26 07:59:04 -0300457 /* decrease the refcount in case of an error */
458 if (ret)
459 video_put(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300460 return ret;
461}
462
463/* Override for the release function */
464static int v4l2_release(struct inode *inode, struct file *filp)
465{
466 struct video_device *vdev = video_devdata(filp);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300467 int ret = 0;
468
Hans Verkuilcf533732012-07-31 04:02:25 -0300469 if (vdev->fops->release)
470 ret = vdev->fops->release(filp);
Hans Verkuilcc4b7e72012-06-09 12:13:29 -0300471 if (vdev->debug)
472 printk(KERN_DEBUG "%s: release\n",
473 video_device_node_name(vdev));
Hans Verkuilcf533732012-07-31 04:02:25 -0300474
Ezequiel García8f695d32012-07-26 07:59:04 -0300475 /* decrease the refcount unconditionally since the release()
476 return value is ignored. */
477 video_put(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300478 return ret;
479}
480
Hans Verkuildc93a702008-12-19 21:28:27 -0300481static const struct file_operations v4l2_fops = {
482 .owner = THIS_MODULE,
483 .read = v4l2_read,
484 .write = v4l2_write,
485 .open = v4l2_open,
Bob Liuecc65172011-05-06 05:20:09 -0300486 .get_unmapped_area = v4l2_get_unmapped_area,
Hans Verkuildc93a702008-12-19 21:28:27 -0300487 .mmap = v4l2_mmap,
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200488 .unlocked_ioctl = v4l2_ioctl,
Hans Verkuildc93a702008-12-19 21:28:27 -0300489#ifdef CONFIG_COMPAT
Hans Verkuil9bb7cde2008-12-30 06:42:40 -0300490 .compat_ioctl = v4l2_compat_ioctl32,
Hans Verkuildc93a702008-12-19 21:28:27 -0300491#endif
492 .release = v4l2_release,
493 .poll = v4l2_poll,
494 .llseek = no_llseek,
495};
496
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300497/**
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300498 * get_index - assign stream index number based on parent device
Hans Verkuildc93a702008-12-19 21:28:27 -0300499 * @vdev: video_device to assign index number to, vdev->parent should be assigned
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300500 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300501 * Note that when this is called the new device has not yet been registered
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300502 * in the video_device array, but it was able to obtain a minor number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300503 *
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300504 * This means that we can always obtain a free stream index number since
505 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
506 * use of the video_device array.
507 *
508 * Returns a free index number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300509 */
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300510static int get_index(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300511{
Hans Verkuil775a05d2009-02-14 11:31:01 -0300512 /* This can be static since this function is called with the global
513 videodev_lock held. */
514 static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300515 int i;
516
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300517 /* Some drivers do not set the parent. In that case always return 0. */
Hans Verkuil806e5b72008-12-19 09:10:56 -0300518 if (vdev->parent == NULL)
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300519 return 0;
Hans Verkuil775a05d2009-02-14 11:31:01 -0300520
521 bitmap_zero(used, VIDEO_NUM_DEVICES);
Hans Verkuil806e5b72008-12-19 09:10:56 -0300522
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300523 for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
524 if (video_device[i] != NULL &&
Hans Verkuil5e85e732008-07-20 06:31:39 -0300525 video_device[i]->parent == vdev->parent) {
Hans Verkuil775a05d2009-02-14 11:31:01 -0300526 set_bit(video_device[i]->index, used);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300527 }
528 }
529
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300530 return find_first_zero_bit(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300531}
532
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300533#define SET_VALID_IOCTL(ops, cmd, op) \
534 if (ops->op) \
535 set_bit(_IOC_NR(cmd), valid_ioctls)
536
537/* This determines which ioctls are actually implemented in the driver.
538 It's a one-time thing which simplifies video_ioctl2 as it can just do
539 a bit test.
540
541 Note that drivers can override this by setting bits to 1 in
542 vdev->valid_ioctls. If an ioctl is marked as 1 when this function is
543 called, then that ioctl will actually be marked as unimplemented.
544
545 It does that by first setting up the local valid_ioctls bitmap, and
546 at the end do a:
547
548 vdev->valid_ioctls = valid_ioctls & ~(vdev->valid_ioctls)
549 */
550static void determine_valid_ioctls(struct video_device *vdev)
551{
552 DECLARE_BITMAP(valid_ioctls, BASE_VIDIOC_PRIVATE);
553 const struct v4l2_ioctl_ops *ops = vdev->ioctl_ops;
Hans Verkuil4b202592012-09-14 07:03:35 -0300554 bool is_vid = vdev->vfl_type == VFL_TYPE_GRABBER;
555 bool is_vbi = vdev->vfl_type == VFL_TYPE_VBI;
556 bool is_radio = vdev->vfl_type == VFL_TYPE_RADIO;
557 bool is_rx = vdev->vfl_dir != VFL_DIR_TX;
558 bool is_tx = vdev->vfl_dir != VFL_DIR_RX;
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300559
560 bitmap_zero(valid_ioctls, BASE_VIDIOC_PRIVATE);
561
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300562 /* vfl_type and vfl_dir independent ioctls */
563
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300564 SET_VALID_IOCTL(ops, VIDIOC_QUERYCAP, vidioc_querycap);
565 if (ops->vidioc_g_priority ||
566 test_bit(V4L2_FL_USE_FH_PRIO, &vdev->flags))
567 set_bit(_IOC_NR(VIDIOC_G_PRIORITY), valid_ioctls);
568 if (ops->vidioc_s_priority ||
569 test_bit(V4L2_FL_USE_FH_PRIO, &vdev->flags))
570 set_bit(_IOC_NR(VIDIOC_S_PRIORITY), valid_ioctls);
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300571 SET_VALID_IOCTL(ops, VIDIOC_STREAMON, vidioc_streamon);
572 SET_VALID_IOCTL(ops, VIDIOC_STREAMOFF, vidioc_streamoff);
573 /* Note: the control handler can also be passed through the filehandle,
574 and that can't be tested here. If the bit for these control ioctls
575 is set, then the ioctl is valid. But if it is 0, then it can still
576 be valid if the filehandle passed the control handler. */
577 if (vdev->ctrl_handler || ops->vidioc_queryctrl)
578 set_bit(_IOC_NR(VIDIOC_QUERYCTRL), valid_ioctls);
579 if (vdev->ctrl_handler || ops->vidioc_g_ctrl || ops->vidioc_g_ext_ctrls)
580 set_bit(_IOC_NR(VIDIOC_G_CTRL), valid_ioctls);
581 if (vdev->ctrl_handler || ops->vidioc_s_ctrl || ops->vidioc_s_ext_ctrls)
582 set_bit(_IOC_NR(VIDIOC_S_CTRL), valid_ioctls);
583 if (vdev->ctrl_handler || ops->vidioc_g_ext_ctrls)
584 set_bit(_IOC_NR(VIDIOC_G_EXT_CTRLS), valid_ioctls);
585 if (vdev->ctrl_handler || ops->vidioc_s_ext_ctrls)
586 set_bit(_IOC_NR(VIDIOC_S_EXT_CTRLS), valid_ioctls);
587 if (vdev->ctrl_handler || ops->vidioc_try_ext_ctrls)
588 set_bit(_IOC_NR(VIDIOC_TRY_EXT_CTRLS), valid_ioctls);
589 if (vdev->ctrl_handler || ops->vidioc_querymenu)
590 set_bit(_IOC_NR(VIDIOC_QUERYMENU), valid_ioctls);
591 SET_VALID_IOCTL(ops, VIDIOC_G_FREQUENCY, vidioc_g_frequency);
592 SET_VALID_IOCTL(ops, VIDIOC_S_FREQUENCY, vidioc_s_frequency);
593 SET_VALID_IOCTL(ops, VIDIOC_LOG_STATUS, vidioc_log_status);
594#ifdef CONFIG_VIDEO_ADV_DEBUG
595 SET_VALID_IOCTL(ops, VIDIOC_DBG_G_REGISTER, vidioc_g_register);
596 SET_VALID_IOCTL(ops, VIDIOC_DBG_S_REGISTER, vidioc_s_register);
597#endif
598 SET_VALID_IOCTL(ops, VIDIOC_DBG_G_CHIP_IDENT, vidioc_g_chip_ident);
599 /* yes, really vidioc_subscribe_event */
600 SET_VALID_IOCTL(ops, VIDIOC_DQEVENT, vidioc_subscribe_event);
601 SET_VALID_IOCTL(ops, VIDIOC_SUBSCRIBE_EVENT, vidioc_subscribe_event);
602 SET_VALID_IOCTL(ops, VIDIOC_UNSUBSCRIBE_EVENT, vidioc_unsubscribe_event);
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300603 if (ops->vidioc_enum_freq_bands || ops->vidioc_g_tuner || ops->vidioc_g_modulator)
604 set_bit(_IOC_NR(VIDIOC_ENUM_FREQ_BANDS), valid_ioctls);
605
Hans Verkuil4b202592012-09-14 07:03:35 -0300606 if (is_vid) {
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300607 /* video specific ioctls */
Hans Verkuil4b202592012-09-14 07:03:35 -0300608 if ((is_rx && (ops->vidioc_enum_fmt_vid_cap ||
609 ops->vidioc_enum_fmt_vid_cap_mplane ||
610 ops->vidioc_enum_fmt_vid_overlay)) ||
611 (is_tx && (ops->vidioc_enum_fmt_vid_out ||
612 ops->vidioc_enum_fmt_vid_out_mplane)))
613 set_bit(_IOC_NR(VIDIOC_ENUM_FMT), valid_ioctls);
614 if ((is_rx && (ops->vidioc_g_fmt_vid_cap ||
615 ops->vidioc_g_fmt_vid_cap_mplane ||
616 ops->vidioc_g_fmt_vid_overlay)) ||
617 (is_tx && (ops->vidioc_g_fmt_vid_out ||
618 ops->vidioc_g_fmt_vid_out_mplane ||
619 ops->vidioc_g_fmt_vid_out_overlay)))
620 set_bit(_IOC_NR(VIDIOC_G_FMT), valid_ioctls);
621 if ((is_rx && (ops->vidioc_s_fmt_vid_cap ||
622 ops->vidioc_s_fmt_vid_cap_mplane ||
623 ops->vidioc_s_fmt_vid_overlay)) ||
624 (is_tx && (ops->vidioc_s_fmt_vid_out ||
625 ops->vidioc_s_fmt_vid_out_mplane ||
626 ops->vidioc_s_fmt_vid_out_overlay)))
627 set_bit(_IOC_NR(VIDIOC_S_FMT), valid_ioctls);
628 if ((is_rx && (ops->vidioc_try_fmt_vid_cap ||
629 ops->vidioc_try_fmt_vid_cap_mplane ||
630 ops->vidioc_try_fmt_vid_overlay)) ||
631 (is_tx && (ops->vidioc_try_fmt_vid_out ||
632 ops->vidioc_try_fmt_vid_out_mplane ||
633 ops->vidioc_try_fmt_vid_out_overlay)))
634 set_bit(_IOC_NR(VIDIOC_TRY_FMT), valid_ioctls);
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300635 SET_VALID_IOCTL(ops, VIDIOC_OVERLAY, vidioc_overlay);
636 SET_VALID_IOCTL(ops, VIDIOC_G_FBUF, vidioc_g_fbuf);
637 SET_VALID_IOCTL(ops, VIDIOC_S_FBUF, vidioc_s_fbuf);
638 SET_VALID_IOCTL(ops, VIDIOC_G_JPEGCOMP, vidioc_g_jpegcomp);
639 SET_VALID_IOCTL(ops, VIDIOC_S_JPEGCOMP, vidioc_s_jpegcomp);
640 SET_VALID_IOCTL(ops, VIDIOC_G_ENC_INDEX, vidioc_g_enc_index);
641 SET_VALID_IOCTL(ops, VIDIOC_ENCODER_CMD, vidioc_encoder_cmd);
642 SET_VALID_IOCTL(ops, VIDIOC_TRY_ENCODER_CMD, vidioc_try_encoder_cmd);
643 SET_VALID_IOCTL(ops, VIDIOC_DECODER_CMD, vidioc_decoder_cmd);
644 SET_VALID_IOCTL(ops, VIDIOC_TRY_DECODER_CMD, vidioc_try_decoder_cmd);
645 SET_VALID_IOCTL(ops, VIDIOC_ENUM_FRAMESIZES, vidioc_enum_framesizes);
646 SET_VALID_IOCTL(ops, VIDIOC_ENUM_FRAMEINTERVALS, vidioc_enum_frameintervals);
Hans Verkuil4b202592012-09-14 07:03:35 -0300647 } else if (is_vbi) {
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300648 /* vbi specific ioctls */
Hans Verkuil4b202592012-09-14 07:03:35 -0300649 if ((is_rx && (ops->vidioc_g_fmt_vbi_cap ||
650 ops->vidioc_g_fmt_sliced_vbi_cap)) ||
651 (is_tx && (ops->vidioc_g_fmt_vbi_out ||
652 ops->vidioc_g_fmt_sliced_vbi_out)))
653 set_bit(_IOC_NR(VIDIOC_G_FMT), valid_ioctls);
654 if ((is_rx && (ops->vidioc_s_fmt_vbi_cap ||
655 ops->vidioc_s_fmt_sliced_vbi_cap)) ||
656 (is_tx && (ops->vidioc_s_fmt_vbi_out ||
657 ops->vidioc_s_fmt_sliced_vbi_out)))
658 set_bit(_IOC_NR(VIDIOC_S_FMT), valid_ioctls);
659 if ((is_rx && (ops->vidioc_try_fmt_vbi_cap ||
660 ops->vidioc_try_fmt_sliced_vbi_cap)) ||
661 (is_tx && (ops->vidioc_try_fmt_vbi_out ||
662 ops->vidioc_try_fmt_sliced_vbi_out)))
663 set_bit(_IOC_NR(VIDIOC_TRY_FMT), valid_ioctls);
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300664 SET_VALID_IOCTL(ops, VIDIOC_G_SLICED_VBI_CAP, vidioc_g_sliced_vbi_cap);
Hans Verkuil4b202592012-09-14 07:03:35 -0300665 }
Hans Verkuil4b202592012-09-14 07:03:35 -0300666 if (!is_radio) {
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300667 /* ioctls valid for video or vbi */
Frank Schaefer5815d0c2013-01-22 15:51:55 -0300668 SET_VALID_IOCTL(ops, VIDIOC_REQBUFS, vidioc_reqbufs);
669 SET_VALID_IOCTL(ops, VIDIOC_QUERYBUF, vidioc_querybuf);
670 SET_VALID_IOCTL(ops, VIDIOC_QBUF, vidioc_qbuf);
671 SET_VALID_IOCTL(ops, VIDIOC_EXPBUF, vidioc_expbuf);
672 SET_VALID_IOCTL(ops, VIDIOC_DQBUF, vidioc_dqbuf);
673 SET_VALID_IOCTL(ops, VIDIOC_CREATE_BUFS, vidioc_create_bufs);
674 SET_VALID_IOCTL(ops, VIDIOC_PREPARE_BUF, vidioc_prepare_buf);
Hans Verkuil4b202592012-09-14 07:03:35 -0300675 if (ops->vidioc_s_std)
676 set_bit(_IOC_NR(VIDIOC_ENUMSTD), valid_ioctls);
677 if (ops->vidioc_g_std || vdev->current_norm)
678 set_bit(_IOC_NR(VIDIOC_G_STD), valid_ioctls);
679 SET_VALID_IOCTL(ops, VIDIOC_S_STD, vidioc_s_std);
Hans Verkuil4b202592012-09-14 07:03:35 -0300680 if (is_rx) {
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300681 SET_VALID_IOCTL(ops, VIDIOC_QUERYSTD, vidioc_querystd);
Hans Verkuil4b202592012-09-14 07:03:35 -0300682 SET_VALID_IOCTL(ops, VIDIOC_ENUMINPUT, vidioc_enum_input);
683 SET_VALID_IOCTL(ops, VIDIOC_G_INPUT, vidioc_g_input);
684 SET_VALID_IOCTL(ops, VIDIOC_S_INPUT, vidioc_s_input);
685 SET_VALID_IOCTL(ops, VIDIOC_ENUMAUDIO, vidioc_enumaudio);
686 SET_VALID_IOCTL(ops, VIDIOC_G_AUDIO, vidioc_g_audio);
687 SET_VALID_IOCTL(ops, VIDIOC_S_AUDIO, vidioc_s_audio);
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300688 SET_VALID_IOCTL(ops, VIDIOC_QUERY_DV_PRESET, vidioc_query_dv_preset);
689 SET_VALID_IOCTL(ops, VIDIOC_QUERY_DV_TIMINGS, vidioc_query_dv_timings);
Hans Verkuil4b202592012-09-14 07:03:35 -0300690 }
691 if (is_tx) {
692 SET_VALID_IOCTL(ops, VIDIOC_ENUMOUTPUT, vidioc_enum_output);
693 SET_VALID_IOCTL(ops, VIDIOC_G_OUTPUT, vidioc_g_output);
694 SET_VALID_IOCTL(ops, VIDIOC_S_OUTPUT, vidioc_s_output);
695 SET_VALID_IOCTL(ops, VIDIOC_ENUMAUDOUT, vidioc_enumaudout);
696 SET_VALID_IOCTL(ops, VIDIOC_G_AUDOUT, vidioc_g_audout);
697 SET_VALID_IOCTL(ops, VIDIOC_S_AUDOUT, vidioc_s_audout);
698 }
Hans Verkuil4b202592012-09-14 07:03:35 -0300699 if (ops->vidioc_g_crop || ops->vidioc_g_selection)
700 set_bit(_IOC_NR(VIDIOC_G_CROP), valid_ioctls);
701 if (ops->vidioc_s_crop || ops->vidioc_s_selection)
702 set_bit(_IOC_NR(VIDIOC_S_CROP), valid_ioctls);
703 SET_VALID_IOCTL(ops, VIDIOC_G_SELECTION, vidioc_g_selection);
704 SET_VALID_IOCTL(ops, VIDIOC_S_SELECTION, vidioc_s_selection);
705 if (ops->vidioc_cropcap || ops->vidioc_g_selection)
706 set_bit(_IOC_NR(VIDIOC_CROPCAP), valid_ioctls);
Hans Verkuil4b202592012-09-14 07:03:35 -0300707 if (ops->vidioc_g_parm || (vdev->vfl_type == VFL_TYPE_GRABBER &&
Hans Verkuila5338192012-09-14 06:45:43 -0300708 (ops->vidioc_g_std || vdev->current_norm)))
Hans Verkuil4b202592012-09-14 07:03:35 -0300709 set_bit(_IOC_NR(VIDIOC_G_PARM), valid_ioctls);
710 SET_VALID_IOCTL(ops, VIDIOC_S_PARM, vidioc_s_parm);
Hans Verkuil4b202592012-09-14 07:03:35 -0300711 SET_VALID_IOCTL(ops, VIDIOC_ENUM_DV_PRESETS, vidioc_enum_dv_presets);
712 SET_VALID_IOCTL(ops, VIDIOC_S_DV_PRESET, vidioc_s_dv_preset);
713 SET_VALID_IOCTL(ops, VIDIOC_G_DV_PRESET, vidioc_g_dv_preset);
Hans Verkuil4b202592012-09-14 07:03:35 -0300714 SET_VALID_IOCTL(ops, VIDIOC_S_DV_TIMINGS, vidioc_s_dv_timings);
715 SET_VALID_IOCTL(ops, VIDIOC_G_DV_TIMINGS, vidioc_g_dv_timings);
716 SET_VALID_IOCTL(ops, VIDIOC_ENUM_DV_TIMINGS, vidioc_enum_dv_timings);
Hans Verkuil4b202592012-09-14 07:03:35 -0300717 SET_VALID_IOCTL(ops, VIDIOC_DV_TIMINGS_CAP, vidioc_dv_timings_cap);
718 }
Hans Verkuil90d0fc42012-09-14 07:06:08 -0300719 if (is_tx) {
720 /* transmitter only ioctls */
721 SET_VALID_IOCTL(ops, VIDIOC_G_MODULATOR, vidioc_g_modulator);
722 SET_VALID_IOCTL(ops, VIDIOC_S_MODULATOR, vidioc_s_modulator);
723 }
724 if (is_rx) {
725 /* receiver only ioctls */
726 SET_VALID_IOCTL(ops, VIDIOC_G_TUNER, vidioc_g_tuner);
727 SET_VALID_IOCTL(ops, VIDIOC_S_TUNER, vidioc_s_tuner);
728 SET_VALID_IOCTL(ops, VIDIOC_S_HW_FREQ_SEEK, vidioc_s_hw_freq_seek);
729 }
730
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300731 bitmap_andnot(vdev->valid_ioctls, valid_ioctls, vdev->valid_ioctls,
732 BASE_VIDIOC_PRIVATE);
733}
734
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300735/**
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300736 * __video_register_device - register video4linux devices
Hans Verkuildc93a702008-12-19 21:28:27 -0300737 * @vdev: video device structure we want to register
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300738 * @type: type of device to register
Hans Verkuil22e22122009-09-06 07:13:14 -0300739 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300740 * -1 == first free)
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300741 * @warn_if_nr_in_use: warn if the desired device node number
742 * was already in use and another number was chosen instead.
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300743 * @owner: module that owns the video device node
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300744 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300745 * The registration code assigns minor numbers and device node numbers
746 * based on the requested type and registers the new device node with
747 * the kernel.
Hans Verkuil46b63372010-12-31 11:47:23 -0300748 *
749 * This function assumes that struct video_device was zeroed when it
750 * was allocated and does not contain any stale date.
751 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300752 * An error is returned if no free minor or device node number could be
753 * found, or if the registration of the device node failed.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300754 *
755 * Zero is returned on success.
756 *
757 * Valid types are
758 *
759 * %VFL_TYPE_GRABBER - A frame grabber
760 *
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300761 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
762 *
763 * %VFL_TYPE_RADIO - A radio card
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300764 *
765 * %VFL_TYPE_SUBDEV - A subdevice
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300766 */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300767int __video_register_device(struct video_device *vdev, int type, int nr,
768 int warn_if_nr_in_use, struct module *owner)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300769{
770 int i = 0;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300771 int ret;
Hans Verkuildd896012008-10-04 08:36:54 -0300772 int minor_offset = 0;
773 int minor_cnt = VIDEO_NUM_DEVICES;
774 const char *name_base;
Hans Verkuildc93a702008-12-19 21:28:27 -0300775
776 /* A minor value of -1 marks this video device as never
777 having been registered */
Trent Piepho428c8d12009-03-03 18:51:52 -0300778 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300779
Hans Verkuild6e74972008-08-23 06:27:59 -0300780 /* the release callback MUST be present */
Guennadi Liakhovetski1fc2b5f2011-12-06 05:33:03 -0300781 if (WARN_ON(!vdev->release))
Henrik Kretzschmaree7aa9f2008-08-22 16:41:03 -0300782 return -EINVAL;
783
Sakari Ailus1babcb42010-03-23 09:25:26 -0300784 /* v4l2_fh support */
785 spin_lock_init(&vdev->fh_lock);
786 INIT_LIST_HEAD(&vdev->fh_list);
787
Hans Verkuildc93a702008-12-19 21:28:27 -0300788 /* Part 1: check device type */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300789 switch (type) {
790 case VFL_TYPE_GRABBER:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300791 name_base = "video";
792 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300793 case VFL_TYPE_VBI:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300794 name_base = "vbi";
795 break;
796 case VFL_TYPE_RADIO:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300797 name_base = "radio";
798 break;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300799 case VFL_TYPE_SUBDEV:
800 name_base = "v4l-subdev";
801 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300802 default:
803 printk(KERN_ERR "%s called with unknown type: %d\n",
804 __func__, type);
Henrik Kretzschmar46f2c212008-09-03 16:47:39 -0300805 return -EINVAL;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300806 }
807
Hans Verkuildc93a702008-12-19 21:28:27 -0300808 vdev->vfl_type = type;
809 vdev->cdev = NULL;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300810 if (vdev->v4l2_dev) {
811 if (vdev->v4l2_dev->dev)
812 vdev->parent = vdev->v4l2_dev->dev;
813 if (vdev->ctrl_handler == NULL)
814 vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler;
Hans Verkuilb1a873a2011-03-22 10:14:07 -0300815 /* If the prio state pointer is NULL, then use the v4l2_device
816 prio state. */
817 if (vdev->prio == NULL)
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300818 vdev->prio = &vdev->v4l2_dev->prio;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300819 }
Hans Verkuildd896012008-10-04 08:36:54 -0300820
Hans Verkuil22e22122009-09-06 07:13:14 -0300821 /* Part 2: find a free minor, device node number and device index. */
Hans Verkuildd896012008-10-04 08:36:54 -0300822#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
823 /* Keep the ranges for the first four types for historical
824 * reasons.
825 * Newer devices (not yet in place) should use the range
826 * of 128-191 and just pick the first free minor there
827 * (new style). */
828 switch (type) {
829 case VFL_TYPE_GRABBER:
830 minor_offset = 0;
831 minor_cnt = 64;
832 break;
833 case VFL_TYPE_RADIO:
834 minor_offset = 64;
835 minor_cnt = 64;
836 break;
Hans Verkuildd896012008-10-04 08:36:54 -0300837 case VFL_TYPE_VBI:
838 minor_offset = 224;
839 minor_cnt = 32;
840 break;
841 default:
842 minor_offset = 128;
843 minor_cnt = 64;
844 break;
845 }
846#endif
847
Hans Verkuil22e22122009-09-06 07:13:14 -0300848 /* Pick a device node number */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300849 mutex_lock(&videodev_lock);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300850 nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300851 if (nr == minor_cnt)
Hans Verkuil5062cb72009-09-07 03:40:24 -0300852 nr = devnode_find(vdev, 0, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300853 if (nr == minor_cnt) {
Hans Verkuil22e22122009-09-06 07:13:14 -0300854 printk(KERN_ERR "could not get a free device node number\n");
Hans Verkuildd896012008-10-04 08:36:54 -0300855 mutex_unlock(&videodev_lock);
856 return -ENFILE;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300857 }
Hans Verkuildd896012008-10-04 08:36:54 -0300858#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
Hans Verkuil22e22122009-09-06 07:13:14 -0300859 /* 1-on-1 mapping of device node number to minor number */
Hans Verkuildd896012008-10-04 08:36:54 -0300860 i = nr;
861#else
Hans Verkuil22e22122009-09-06 07:13:14 -0300862 /* The device node number and minor numbers are independent, so
863 we just find the first free minor number. */
Hans Verkuildd896012008-10-04 08:36:54 -0300864 for (i = 0; i < VIDEO_NUM_DEVICES; i++)
865 if (video_device[i] == NULL)
866 break;
867 if (i == VIDEO_NUM_DEVICES) {
868 mutex_unlock(&videodev_lock);
869 printk(KERN_ERR "could not get a free minor\n");
870 return -ENFILE;
871 }
872#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300873 vdev->minor = i + minor_offset;
874 vdev->num = nr;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300875 devnode_set(vdev);
876
Hans Verkuildc93a702008-12-19 21:28:27 -0300877 /* Should not happen since we thought this minor was free */
878 WARN_ON(video_device[vdev->minor] != NULL);
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300879 vdev->index = get_index(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300880 mutex_unlock(&videodev_lock);
881
Hans Verkuil48ea0be2012-05-10 05:36:00 -0300882 if (vdev->ioctl_ops)
883 determine_valid_ioctls(vdev);
884
Hans Verkuildc93a702008-12-19 21:28:27 -0300885 /* Part 3: Initialize the character device */
886 vdev->cdev = cdev_alloc();
887 if (vdev->cdev == NULL) {
888 ret = -ENOMEM;
889 goto cleanup;
890 }
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200891 vdev->cdev->ops = &v4l2_fops;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300892 vdev->cdev->owner = owner;
Hans Verkuildc93a702008-12-19 21:28:27 -0300893 ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300894 if (ret < 0) {
895 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300896 kfree(vdev->cdev);
897 vdev->cdev = NULL;
898 goto cleanup;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300899 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300900
901 /* Part 4: register the device with sysfs */
Hans Verkuildc93a702008-12-19 21:28:27 -0300902 vdev->dev.class = &video_class;
903 vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
904 if (vdev->parent)
905 vdev->dev.parent = vdev->parent;
Hans Verkuil22e22122009-09-06 07:13:14 -0300906 dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num);
Hans Verkuildc93a702008-12-19 21:28:27 -0300907 ret = device_register(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300908 if (ret < 0) {
909 printk(KERN_ERR "%s: device_register failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300910 goto cleanup;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300911 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300912 /* Register the release callback that will be called when the last
913 reference to the device goes away. */
914 vdev->dev.release = v4l2_device_release;
915
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300916 if (nr != -1 && nr != vdev->num && warn_if_nr_in_use)
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300917 printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__,
918 name_base, nr, video_device_node_name(vdev));
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300919
920 /* Increase v4l2_device refcount */
921 if (vdev->v4l2_dev)
922 v4l2_device_get(vdev->v4l2_dev);
923
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300924#if defined(CONFIG_MEDIA_CONTROLLER)
925 /* Part 5: Register the entity. */
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300926 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
927 vdev->vfl_type != VFL_TYPE_SUBDEV) {
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300928 vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L;
929 vdev->entity.name = vdev->name;
Clemens Ladischfa5034c2011-11-05 18:42:01 -0300930 vdev->entity.info.v4l.major = VIDEO_MAJOR;
931 vdev->entity.info.v4l.minor = vdev->minor;
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300932 ret = media_device_register_entity(vdev->v4l2_dev->mdev,
933 &vdev->entity);
934 if (ret < 0)
935 printk(KERN_WARNING
936 "%s: media_device_register_entity failed\n",
937 __func__);
938 }
939#endif
940 /* Part 6: Activate this minor. The char device can now be used. */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300941 set_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300942 mutex_lock(&videodev_lock);
943 video_device[vdev->minor] = vdev;
944 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300945
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300946 return 0;
947
Hans Verkuildc93a702008-12-19 21:28:27 -0300948cleanup:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300949 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300950 if (vdev->cdev)
951 cdev_del(vdev->cdev);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300952 devnode_clear(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300953 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300954 /* Mark this video device as never having been registered. */
955 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300956 return ret;
957}
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300958EXPORT_SYMBOL(__video_register_device);
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300959
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300960/**
961 * video_unregister_device - unregister a video4linux device
Hans Verkuildc93a702008-12-19 21:28:27 -0300962 * @vdev: the device to unregister
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300963 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300964 * This unregisters the passed device. Future open calls will
965 * be met with errors.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300966 */
Hans Verkuildc93a702008-12-19 21:28:27 -0300967void video_unregister_device(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300968{
Hans Verkuildc93a702008-12-19 21:28:27 -0300969 /* Check if vdev was ever registered at all */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300970 if (!vdev || !video_is_registered(vdev))
Hans Verkuildc93a702008-12-19 21:28:27 -0300971 return;
972
Hans Verkuilca9afe62010-11-26 06:54:53 -0300973 mutex_lock(&videodev_lock);
974 /* This must be in a critical section to prevent a race with v4l2_open.
975 * Once this bit has been cleared video_get may never be called again.
976 */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300977 clear_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuilca9afe62010-11-26 06:54:53 -0300978 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300979 device_unregister(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300980}
981EXPORT_SYMBOL(video_unregister_device);
982
983/*
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300984 * Initialise video for linux
985 */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300986static int __init videodev_init(void)
987{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300988 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300989 int ret;
990
991 printk(KERN_INFO "Linux video capture interface: v2.00\n");
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300992 ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
993 if (ret < 0) {
994 printk(KERN_WARNING "videodev: unable to get major %d\n",
995 VIDEO_MAJOR);
996 return ret;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300997 }
998
999 ret = class_register(&video_class);
1000 if (ret < 0) {
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -03001001 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001002 printk(KERN_WARNING "video_dev: class_register failed\n");
1003 return -EIO;
1004 }
1005
1006 return 0;
1007}
1008
1009static void __exit videodev_exit(void)
1010{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -03001011 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
1012
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001013 class_unregister(&video_class);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -03001014 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001015}
1016
Bhupesh Sharmaee981c62012-03-12 05:09:02 -03001017subsys_initcall(videodev_init);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001018module_exit(videodev_exit)
1019
1020MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
1021MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
1022MODULE_LICENSE("GPL");
Scott James Remnantcbb72b02009-03-02 15:40:57 -03001023MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001024
1025
1026/*
1027 * Local variables:
1028 * c-basic-offset: 8
1029 * End:
1030 */