blob: 19d5ae2937802a41e8784bf691400162c57c9152 [file] [log] [blame]
Hans Verkuil27a5e6d2008-07-20 08:43:17 -03001/*
2 * Video capture interface for Linux version 2
3 *
4 * A generic video device interface for the LINUX operating system
5 * using a set of device structures/vectors for low level operations.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
Alan Coxd9b01442008-10-27 15:13:47 -030012 * Authors: Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030013 * Mauro Carvalho Chehab <mchehab@infradead.org> (version 2)
14 *
15 * Fixes: 20000516 Claudio Matsuoka <claudio@conectiva.com>
16 * - Added procfs support
17 */
18
19#include <linux/module.h>
20#include <linux/types.h>
21#include <linux/kernel.h>
22#include <linux/mm.h>
23#include <linux/string.h>
24#include <linux/errno.h>
25#include <linux/init.h>
26#include <linux/kmod.h>
27#include <linux/slab.h>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030028#include <asm/uaccess.h>
29#include <asm/system.h>
30
31#include <media/v4l2-common.h>
Hans Verkuil9bea3512008-12-23 07:35:17 -030032#include <media/v4l2-device.h>
Hans Verkuilbec43662008-12-30 06:58:20 -030033#include <media/v4l2-ioctl.h>
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030034
35#define VIDEO_NUM_DEVICES 256
36#define VIDEO_NAME "video4linux"
37
38/*
39 * sysfs stuff
40 */
41
42static ssize_t show_index(struct device *cd,
43 struct device_attribute *attr, char *buf)
44{
Hans Verkuildc93a702008-12-19 21:28:27 -030045 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030046
Hans Verkuildc93a702008-12-19 21:28:27 -030047 return sprintf(buf, "%i\n", vdev->index);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030048}
49
50static ssize_t show_name(struct device *cd,
51 struct device_attribute *attr, char *buf)
52{
Hans Verkuildc93a702008-12-19 21:28:27 -030053 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbfa8a272008-08-23 07:48:38 -030054
Hans Verkuildc93a702008-12-19 21:28:27 -030055 return sprintf(buf, "%.*s\n", (int)sizeof(vdev->name), vdev->name);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -030056}
57
58static struct device_attribute video_device_attrs[] = {
59 __ATTR(name, S_IRUGO, show_name, NULL),
60 __ATTR(index, S_IRUGO, show_index, NULL),
61 __ATTR_NULL
62};
63
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030064/*
65 * Active devices
66 */
67static struct video_device *video_device[VIDEO_NUM_DEVICES];
68static DEFINE_MUTEX(videodev_lock);
Hans Verkuil22e22122009-09-06 07:13:14 -030069static DECLARE_BITMAP(devnode_nums[VFL_TYPE_MAX], VIDEO_NUM_DEVICES);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -030070
Hans Verkuil5062cb72009-09-07 03:40:24 -030071/* Device node utility functions */
72
73/* Note: these utility functions all assume that vfl_type is in the range
74 [0, VFL_TYPE_MAX-1]. */
75
76#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
77/* Return the bitmap corresponding to vfl_type. */
78static inline unsigned long *devnode_bits(int vfl_type)
79{
80 /* Any types not assigned to fixed minor ranges must be mapped to
81 one single bitmap for the purposes of finding a free node number
82 since all those unassigned types use the same minor range. */
Hans Verkuil226c0ee2010-08-06 12:48:00 -030083 int idx = (vfl_type > VFL_TYPE_RADIO) ? VFL_TYPE_MAX - 1 : vfl_type;
Hans Verkuil5062cb72009-09-07 03:40:24 -030084
85 return devnode_nums[idx];
86}
87#else
88/* Return the bitmap corresponding to vfl_type. */
89static inline unsigned long *devnode_bits(int vfl_type)
90{
91 return devnode_nums[vfl_type];
92}
93#endif
94
95/* Mark device node number vdev->num as used */
96static inline void devnode_set(struct video_device *vdev)
97{
98 set_bit(vdev->num, devnode_bits(vdev->vfl_type));
99}
100
101/* Mark device node number vdev->num as unused */
102static inline void devnode_clear(struct video_device *vdev)
103{
104 clear_bit(vdev->num, devnode_bits(vdev->vfl_type));
105}
106
107/* Try to find a free device node number in the range [from, to> */
108static inline int devnode_find(struct video_device *vdev, int from, int to)
109{
110 return find_next_zero_bit(devnode_bits(vdev->vfl_type), to, from);
111}
112
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300113struct video_device *video_device_alloc(void)
114{
Hans Verkuilbfa8a272008-08-23 07:48:38 -0300115 return kzalloc(sizeof(struct video_device), GFP_KERNEL);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300116}
117EXPORT_SYMBOL(video_device_alloc);
118
Hans Verkuildc93a702008-12-19 21:28:27 -0300119void video_device_release(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300120{
Hans Verkuildc93a702008-12-19 21:28:27 -0300121 kfree(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300122}
123EXPORT_SYMBOL(video_device_release);
124
Hans Verkuildc93a702008-12-19 21:28:27 -0300125void video_device_release_empty(struct video_device *vdev)
Hans Verkuilf9e86b52008-08-23 05:47:41 -0300126{
127 /* Do nothing */
128 /* Only valid when the video_device struct is a static. */
129}
130EXPORT_SYMBOL(video_device_release_empty);
131
Hans Verkuildc93a702008-12-19 21:28:27 -0300132static inline void video_get(struct video_device *vdev)
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300133{
Hans Verkuildc93a702008-12-19 21:28:27 -0300134 get_device(&vdev->dev);
135}
136
137static inline void video_put(struct video_device *vdev)
138{
139 put_device(&vdev->dev);
140}
141
142/* Called when the last user of the video device exits. */
143static void v4l2_device_release(struct device *cd)
144{
145 struct video_device *vdev = to_video_device(cd);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300146 struct v4l2_device *v4l2_dev = vdev->v4l2_dev;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300147
148 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300149 if (video_device[vdev->minor] != vdev) {
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300150 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300151 /* should not happen */
152 WARN_ON(1);
Hans Verkuil6ea9a182008-08-30 09:40:47 -0300153 return;
154 }
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300155
156 /* Free up this device for reuse */
Hans Verkuildc93a702008-12-19 21:28:27 -0300157 video_device[vdev->minor] = NULL;
158
159 /* Delete the cdev on this minor as well */
160 cdev_del(vdev->cdev);
161 /* Just in case some driver tries to access this from
162 the release() callback. */
163 vdev->cdev = NULL;
164
Hans Verkuil22e22122009-09-06 07:13:14 -0300165 /* Mark device node number as free */
Hans Verkuil5062cb72009-09-07 03:40:24 -0300166 devnode_clear(vdev);
Hans Verkuildc93a702008-12-19 21:28:27 -0300167
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300168 mutex_unlock(&videodev_lock);
169
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300170 /* Release video_device and perform other
171 cleanups as needed. */
Hans Verkuildc93a702008-12-19 21:28:27 -0300172 vdev->release(vdev);
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300173
174 /* Decrease v4l2_device refcount */
175 if (v4l2_dev)
176 v4l2_device_put(v4l2_dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300177}
178
179static struct class video_class = {
180 .name = VIDEO_NAME,
181 .dev_attrs = video_device_attrs,
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300182};
183
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300184struct video_device *video_devdata(struct file *file)
185{
186 return video_device[iminor(file->f_path.dentry->d_inode)];
187}
188EXPORT_SYMBOL(video_devdata);
189
Hans Verkuil02265492010-12-29 10:05:02 -0300190
191/* Priority handling */
192
193static inline bool prio_is_valid(enum v4l2_priority prio)
194{
195 return prio == V4L2_PRIORITY_BACKGROUND ||
196 prio == V4L2_PRIORITY_INTERACTIVE ||
197 prio == V4L2_PRIORITY_RECORD;
198}
199
200void v4l2_prio_init(struct v4l2_prio_state *global)
201{
202 memset(global, 0, sizeof(*global));
203}
204EXPORT_SYMBOL(v4l2_prio_init);
205
206int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local,
207 enum v4l2_priority new)
208{
209 if (!prio_is_valid(new))
210 return -EINVAL;
211 if (*local == new)
212 return 0;
213
214 atomic_inc(&global->prios[new]);
215 if (prio_is_valid(*local))
216 atomic_dec(&global->prios[*local]);
217 *local = new;
218 return 0;
219}
220EXPORT_SYMBOL(v4l2_prio_change);
221
222void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local)
223{
224 v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT);
225}
226EXPORT_SYMBOL(v4l2_prio_open);
227
228void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local)
229{
230 if (prio_is_valid(local))
231 atomic_dec(&global->prios[local]);
232}
233EXPORT_SYMBOL(v4l2_prio_close);
234
235enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global)
236{
237 if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0)
238 return V4L2_PRIORITY_RECORD;
239 if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0)
240 return V4L2_PRIORITY_INTERACTIVE;
241 if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0)
242 return V4L2_PRIORITY_BACKGROUND;
243 return V4L2_PRIORITY_UNSET;
244}
245EXPORT_SYMBOL(v4l2_prio_max);
246
247int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local)
248{
249 return (local < v4l2_prio_max(global)) ? -EBUSY : 0;
250}
251EXPORT_SYMBOL(v4l2_prio_check);
252
253
Hans Verkuildc93a702008-12-19 21:28:27 -0300254static ssize_t v4l2_read(struct file *filp, char __user *buf,
255 size_t sz, loff_t *off)
256{
257 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300258 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300259
260 if (!vdev->fops->read)
261 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300262 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
263 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300264 if (video_is_registered(vdev))
265 ret = vdev->fops->read(filp, buf, sz, off);
266 if (vdev->lock)
267 mutex_unlock(vdev->lock);
268 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300269}
270
271static ssize_t v4l2_write(struct file *filp, const char __user *buf,
272 size_t sz, loff_t *off)
273{
274 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300275 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300276
277 if (!vdev->fops->write)
278 return -EINVAL;
Hans Verkuil28778422010-11-26 06:43:51 -0300279 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
280 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300281 if (video_is_registered(vdev))
282 ret = vdev->fops->write(filp, buf, sz, off);
283 if (vdev->lock)
284 mutex_unlock(vdev->lock);
285 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300286}
287
288static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll)
289{
290 struct video_device *vdev = video_devdata(filp);
Hans Verkuil28778422010-11-26 06:43:51 -0300291 int ret = POLLERR | POLLHUP;
Hans Verkuildc93a702008-12-19 21:28:27 -0300292
Hans Verkuilee6869a2010-09-26 08:47:38 -0300293 if (!vdev->fops->poll)
Hans Verkuil28778422010-11-26 06:43:51 -0300294 return DEFAULT_POLLMASK;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300295 if (vdev->lock)
296 mutex_lock(vdev->lock);
297 if (video_is_registered(vdev))
298 ret = vdev->fops->poll(filp, poll);
299 if (vdev->lock)
300 mutex_unlock(vdev->lock);
301 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300302}
303
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200304static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
Hans Verkuildc93a702008-12-19 21:28:27 -0300305{
306 struct video_device *vdev = video_devdata(filp);
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300307 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300308
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200309 if (vdev->fops->unlocked_ioctl) {
Hans Verkuil28778422010-11-26 06:43:51 -0300310 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
311 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300312 if (video_is_registered(vdev))
313 ret = vdev->fops->unlocked_ioctl(filp, cmd, arg);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300314 if (vdev->lock)
315 mutex_unlock(vdev->lock);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200316 } else if (vdev->fops->ioctl) {
Hans Verkuil879aa242010-11-26 06:47:28 -0300317 /* This code path is a replacement for the BKL. It is a major
318 * hack but it will have to do for those drivers that are not
319 * yet converted to use unlocked_ioctl.
320 *
321 * There are two options: if the driver implements struct
322 * v4l2_device, then the lock defined there is used to
323 * serialize the ioctls. Otherwise the v4l2 core lock defined
324 * below is used. This lock is really bad since it serializes
325 * completely independent devices.
326 *
327 * Both variants suffer from the same problem: if the driver
328 * sleeps, then it blocks all ioctls since the lock is still
329 * held. This is very common for VIDIOC_DQBUF since that
330 * normally waits for a frame to arrive. As a result any other
331 * ioctl calls will proceed very, very slowly since each call
332 * will have to wait for the VIDIOC_QBUF to finish. Things that
333 * should take 0.01s may now take 10-20 seconds.
334 *
335 * The workaround is to *not* take the lock for VIDIOC_DQBUF.
336 * This actually works OK for videobuf-based drivers, since
337 * videobuf will take its own internal lock.
338 */
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300339 static DEFINE_MUTEX(v4l2_ioctl_mutex);
Hans Verkuil879aa242010-11-26 06:47:28 -0300340 struct mutex *m = vdev->v4l2_dev ?
341 &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex;
Arnd Bergmann0edf2e52010-10-27 09:30:32 -0300342
Hans Verkuil879aa242010-11-26 06:47:28 -0300343 if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m))
344 return -ERESTARTSYS;
Mauro Carvalho Chehab72420632010-10-09 16:43:40 -0300345 if (video_is_registered(vdev))
346 ret = vdev->fops->ioctl(filp, cmd, arg);
Hans Verkuil879aa242010-11-26 06:47:28 -0300347 if (cmd != VIDIOC_DQBUF)
348 mutex_unlock(m);
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200349 } else
350 ret = -ENOTTY;
Hans Verkuildc93a702008-12-19 21:28:27 -0300351
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200352 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300353}
354
Bob Liuecc65172011-05-06 05:20:09 -0300355#ifdef CONFIG_MMU
356#define v4l2_get_unmapped_area NULL
357#else
358static unsigned long v4l2_get_unmapped_area(struct file *filp,
359 unsigned long addr, unsigned long len, unsigned long pgoff,
360 unsigned long flags)
361{
362 struct video_device *vdev = video_devdata(filp);
363
364 if (!vdev->fops->get_unmapped_area)
365 return -ENOSYS;
366 if (!video_is_registered(vdev))
367 return -ENODEV;
368 return vdev->fops->get_unmapped_area(filp, addr, len, pgoff, flags);
369}
370#endif
371
Hans Verkuildc93a702008-12-19 21:28:27 -0300372static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm)
373{
374 struct video_device *vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300375 int ret = -ENODEV;
Hans Verkuildc93a702008-12-19 21:28:27 -0300376
Hans Verkuilee6869a2010-09-26 08:47:38 -0300377 if (!vdev->fops->mmap)
378 return ret;
Hans Verkuil28778422010-11-26 06:43:51 -0300379 if (vdev->lock && mutex_lock_interruptible(vdev->lock))
380 return -ERESTARTSYS;
Hans Verkuilee6869a2010-09-26 08:47:38 -0300381 if (video_is_registered(vdev))
382 ret = vdev->fops->mmap(filp, vm);
383 if (vdev->lock)
384 mutex_unlock(vdev->lock);
385 return ret;
Hans Verkuildc93a702008-12-19 21:28:27 -0300386}
387
388/* Override for the open function */
389static int v4l2_open(struct inode *inode, struct file *filp)
390{
391 struct video_device *vdev;
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300392#if defined(CONFIG_MEDIA_CONTROLLER)
393 struct media_entity *entity = NULL;
394#endif
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300395 int ret = 0;
Hans Verkuildc93a702008-12-19 21:28:27 -0300396
397 /* Check if the video device is available */
398 mutex_lock(&videodev_lock);
399 vdev = video_devdata(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300400 /* return ENODEV if the video device has already been removed. */
Hans Verkuilca9afe62010-11-26 06:54:53 -0300401 if (vdev == NULL || !video_is_registered(vdev)) {
Hans Verkuildc93a702008-12-19 21:28:27 -0300402 mutex_unlock(&videodev_lock);
403 return -ENODEV;
404 }
405 /* and increase the device refcount */
406 video_get(vdev);
407 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300408#if defined(CONFIG_MEDIA_CONTROLLER)
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300409 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
410 vdev->vfl_type != VFL_TYPE_SUBDEV) {
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300411 entity = media_entity_get(&vdev->entity);
412 if (!entity) {
413 ret = -EBUSY;
414 video_put(vdev);
415 return ret;
416 }
417 }
418#endif
Hans Verkuilee6869a2010-09-26 08:47:38 -0300419 if (vdev->fops->open) {
Hans Verkuil28778422010-11-26 06:43:51 -0300420 if (vdev->lock && mutex_lock_interruptible(vdev->lock)) {
421 ret = -ERESTARTSYS;
422 goto err;
423 }
Hans Verkuilee6869a2010-09-26 08:47:38 -0300424 if (video_is_registered(vdev))
425 ret = vdev->fops->open(filp);
426 else
427 ret = -ENODEV;
428 if (vdev->lock)
429 mutex_unlock(vdev->lock);
430 }
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300431
Hans Verkuil28778422010-11-26 06:43:51 -0300432err:
Hans Verkuildc93a702008-12-19 21:28:27 -0300433 /* decrease the refcount in case of an error */
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300434 if (ret) {
435#if defined(CONFIG_MEDIA_CONTROLLER)
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300436 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
437 vdev->vfl_type != VFL_TYPE_SUBDEV)
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300438 media_entity_put(entity);
439#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300440 video_put(vdev);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300441 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300442 return ret;
443}
444
445/* Override for the release function */
446static int v4l2_release(struct inode *inode, struct file *filp)
447{
448 struct video_device *vdev = video_devdata(filp);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300449 int ret = 0;
450
Hans Verkuilee6869a2010-09-26 08:47:38 -0300451 if (vdev->fops->release) {
452 if (vdev->lock)
453 mutex_lock(vdev->lock);
Hans Verkuil65d9ff92009-03-29 20:19:38 -0300454 vdev->fops->release(filp);
Hans Verkuilee6869a2010-09-26 08:47:38 -0300455 if (vdev->lock)
456 mutex_unlock(vdev->lock);
457 }
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300458#if defined(CONFIG_MEDIA_CONTROLLER)
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300459 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
460 vdev->vfl_type != VFL_TYPE_SUBDEV)
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300461 media_entity_put(&vdev->entity);
462#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300463 /* decrease the refcount unconditionally since the release()
464 return value is ignored. */
465 video_put(vdev);
466 return ret;
467}
468
Hans Verkuildc93a702008-12-19 21:28:27 -0300469static const struct file_operations v4l2_fops = {
470 .owner = THIS_MODULE,
471 .read = v4l2_read,
472 .write = v4l2_write,
473 .open = v4l2_open,
Bob Liuecc65172011-05-06 05:20:09 -0300474 .get_unmapped_area = v4l2_get_unmapped_area,
Hans Verkuildc93a702008-12-19 21:28:27 -0300475 .mmap = v4l2_mmap,
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200476 .unlocked_ioctl = v4l2_ioctl,
Hans Verkuildc93a702008-12-19 21:28:27 -0300477#ifdef CONFIG_COMPAT
Hans Verkuil9bb7cde2008-12-30 06:42:40 -0300478 .compat_ioctl = v4l2_compat_ioctl32,
Hans Verkuildc93a702008-12-19 21:28:27 -0300479#endif
480 .release = v4l2_release,
481 .poll = v4l2_poll,
482 .llseek = no_llseek,
483};
484
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300485/**
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300486 * get_index - assign stream index number based on parent device
Hans Verkuildc93a702008-12-19 21:28:27 -0300487 * @vdev: video_device to assign index number to, vdev->parent should be assigned
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300488 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300489 * Note that when this is called the new device has not yet been registered
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300490 * in the video_device array, but it was able to obtain a minor number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300491 *
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300492 * This means that we can always obtain a free stream index number since
493 * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in
494 * use of the video_device array.
495 *
496 * Returns a free index number.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300497 */
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300498static int get_index(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300499{
Hans Verkuil775a05d2009-02-14 11:31:01 -0300500 /* This can be static since this function is called with the global
501 videodev_lock held. */
502 static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300503 int i;
504
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300505 /* Some drivers do not set the parent. In that case always return 0. */
Hans Verkuil806e5b72008-12-19 09:10:56 -0300506 if (vdev->parent == NULL)
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300507 return 0;
Hans Verkuil775a05d2009-02-14 11:31:01 -0300508
509 bitmap_zero(used, VIDEO_NUM_DEVICES);
Hans Verkuil806e5b72008-12-19 09:10:56 -0300510
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300511 for (i = 0; i < VIDEO_NUM_DEVICES; i++) {
512 if (video_device[i] != NULL &&
Hans Verkuil5e85e732008-07-20 06:31:39 -0300513 video_device[i]->parent == vdev->parent) {
Hans Verkuil775a05d2009-02-14 11:31:01 -0300514 set_bit(video_device[i]->index, used);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300515 }
516 }
517
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300518 return find_first_zero_bit(used, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300519}
520
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300521/**
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300522 * __video_register_device - register video4linux devices
Hans Verkuildc93a702008-12-19 21:28:27 -0300523 * @vdev: video device structure we want to register
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300524 * @type: type of device to register
Hans Verkuil22e22122009-09-06 07:13:14 -0300525 * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300526 * -1 == first free)
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300527 * @warn_if_nr_in_use: warn if the desired device node number
528 * was already in use and another number was chosen instead.
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300529 * @owner: module that owns the video device node
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300530 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300531 * The registration code assigns minor numbers and device node numbers
532 * based on the requested type and registers the new device node with
533 * the kernel.
Hans Verkuil46b63372010-12-31 11:47:23 -0300534 *
535 * This function assumes that struct video_device was zeroed when it
536 * was allocated and does not contain any stale date.
537 *
Hans Verkuil22e22122009-09-06 07:13:14 -0300538 * An error is returned if no free minor or device node number could be
539 * found, or if the registration of the device node failed.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300540 *
541 * Zero is returned on success.
542 *
543 * Valid types are
544 *
545 * %VFL_TYPE_GRABBER - A frame grabber
546 *
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300547 * %VFL_TYPE_VBI - Vertical blank data (undecoded)
548 *
549 * %VFL_TYPE_RADIO - A radio card
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300550 *
551 * %VFL_TYPE_SUBDEV - A subdevice
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300552 */
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300553int __video_register_device(struct video_device *vdev, int type, int nr,
554 int warn_if_nr_in_use, struct module *owner)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300555{
556 int i = 0;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300557 int ret;
Hans Verkuildd896012008-10-04 08:36:54 -0300558 int minor_offset = 0;
559 int minor_cnt = VIDEO_NUM_DEVICES;
560 const char *name_base;
Hans Verkuildc93a702008-12-19 21:28:27 -0300561
562 /* A minor value of -1 marks this video device as never
563 having been registered */
Trent Piepho428c8d12009-03-03 18:51:52 -0300564 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300565
Hans Verkuild6e74972008-08-23 06:27:59 -0300566 /* the release callback MUST be present */
Trent Piepho428c8d12009-03-03 18:51:52 -0300567 WARN_ON(!vdev->release);
568 if (!vdev->release)
Henrik Kretzschmaree7aa9f2008-08-22 16:41:03 -0300569 return -EINVAL;
570
Sakari Ailus1babcb42010-03-23 09:25:26 -0300571 /* v4l2_fh support */
572 spin_lock_init(&vdev->fh_lock);
573 INIT_LIST_HEAD(&vdev->fh_list);
574
Hans Verkuildc93a702008-12-19 21:28:27 -0300575 /* Part 1: check device type */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300576 switch (type) {
577 case VFL_TYPE_GRABBER:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300578 name_base = "video";
579 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300580 case VFL_TYPE_VBI:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300581 name_base = "vbi";
582 break;
583 case VFL_TYPE_RADIO:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300584 name_base = "radio";
585 break;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300586 case VFL_TYPE_SUBDEV:
587 name_base = "v4l-subdev";
588 break;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300589 default:
590 printk(KERN_ERR "%s called with unknown type: %d\n",
591 __func__, type);
Henrik Kretzschmar46f2c212008-09-03 16:47:39 -0300592 return -EINVAL;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300593 }
594
Hans Verkuildc93a702008-12-19 21:28:27 -0300595 vdev->vfl_type = type;
596 vdev->cdev = NULL;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300597 if (vdev->v4l2_dev) {
598 if (vdev->v4l2_dev->dev)
599 vdev->parent = vdev->v4l2_dev->dev;
600 if (vdev->ctrl_handler == NULL)
601 vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler;
Hans Verkuilb1a873a2011-03-22 10:14:07 -0300602 /* If the prio state pointer is NULL, then use the v4l2_device
603 prio state. */
604 if (vdev->prio == NULL)
Hans Verkuil0f62fd62011-02-24 10:42:24 -0300605 vdev->prio = &vdev->v4l2_dev->prio;
Hans Verkuil11bbc1c2010-05-16 09:24:06 -0300606 }
Hans Verkuildd896012008-10-04 08:36:54 -0300607
Hans Verkuil22e22122009-09-06 07:13:14 -0300608 /* Part 2: find a free minor, device node number and device index. */
Hans Verkuildd896012008-10-04 08:36:54 -0300609#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
610 /* Keep the ranges for the first four types for historical
611 * reasons.
612 * Newer devices (not yet in place) should use the range
613 * of 128-191 and just pick the first free minor there
614 * (new style). */
615 switch (type) {
616 case VFL_TYPE_GRABBER:
617 minor_offset = 0;
618 minor_cnt = 64;
619 break;
620 case VFL_TYPE_RADIO:
621 minor_offset = 64;
622 minor_cnt = 64;
623 break;
Hans Verkuildd896012008-10-04 08:36:54 -0300624 case VFL_TYPE_VBI:
625 minor_offset = 224;
626 minor_cnt = 32;
627 break;
628 default:
629 minor_offset = 128;
630 minor_cnt = 64;
631 break;
632 }
633#endif
634
Hans Verkuil22e22122009-09-06 07:13:14 -0300635 /* Pick a device node number */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300636 mutex_lock(&videodev_lock);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300637 nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300638 if (nr == minor_cnt)
Hans Verkuil5062cb72009-09-07 03:40:24 -0300639 nr = devnode_find(vdev, 0, minor_cnt);
Hans Verkuildd896012008-10-04 08:36:54 -0300640 if (nr == minor_cnt) {
Hans Verkuil22e22122009-09-06 07:13:14 -0300641 printk(KERN_ERR "could not get a free device node number\n");
Hans Verkuildd896012008-10-04 08:36:54 -0300642 mutex_unlock(&videodev_lock);
643 return -ENFILE;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300644 }
Hans Verkuildd896012008-10-04 08:36:54 -0300645#ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES
Hans Verkuil22e22122009-09-06 07:13:14 -0300646 /* 1-on-1 mapping of device node number to minor number */
Hans Verkuildd896012008-10-04 08:36:54 -0300647 i = nr;
648#else
Hans Verkuil22e22122009-09-06 07:13:14 -0300649 /* The device node number and minor numbers are independent, so
650 we just find the first free minor number. */
Hans Verkuildd896012008-10-04 08:36:54 -0300651 for (i = 0; i < VIDEO_NUM_DEVICES; i++)
652 if (video_device[i] == NULL)
653 break;
654 if (i == VIDEO_NUM_DEVICES) {
655 mutex_unlock(&videodev_lock);
656 printk(KERN_ERR "could not get a free minor\n");
657 return -ENFILE;
658 }
659#endif
Hans Verkuildc93a702008-12-19 21:28:27 -0300660 vdev->minor = i + minor_offset;
661 vdev->num = nr;
Hans Verkuil5062cb72009-09-07 03:40:24 -0300662 devnode_set(vdev);
663
Hans Verkuildc93a702008-12-19 21:28:27 -0300664 /* Should not happen since we thought this minor was free */
665 WARN_ON(video_device[vdev->minor] != NULL);
Hans Verkuil7ae0cd92009-06-19 11:32:56 -0300666 vdev->index = get_index(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300667 mutex_unlock(&videodev_lock);
668
Hans Verkuildc93a702008-12-19 21:28:27 -0300669 /* Part 3: Initialize the character device */
670 vdev->cdev = cdev_alloc();
671 if (vdev->cdev == NULL) {
672 ret = -ENOMEM;
673 goto cleanup;
674 }
Arnd Bergmann86a5ef72010-07-04 00:15:09 +0200675 vdev->cdev->ops = &v4l2_fops;
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300676 vdev->cdev->owner = owner;
Hans Verkuildc93a702008-12-19 21:28:27 -0300677 ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300678 if (ret < 0) {
679 printk(KERN_ERR "%s: cdev_add failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300680 kfree(vdev->cdev);
681 vdev->cdev = NULL;
682 goto cleanup;
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300683 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300684
685 /* Part 4: register the device with sysfs */
Hans Verkuildc93a702008-12-19 21:28:27 -0300686 vdev->dev.class = &video_class;
687 vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor);
688 if (vdev->parent)
689 vdev->dev.parent = vdev->parent;
Hans Verkuil22e22122009-09-06 07:13:14 -0300690 dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num);
Hans Verkuildc93a702008-12-19 21:28:27 -0300691 ret = device_register(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300692 if (ret < 0) {
693 printk(KERN_ERR "%s: device_register failed\n", __func__);
Hans Verkuildc93a702008-12-19 21:28:27 -0300694 goto cleanup;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300695 }
Hans Verkuildc93a702008-12-19 21:28:27 -0300696 /* Register the release callback that will be called when the last
697 reference to the device goes away. */
698 vdev->dev.release = v4l2_device_release;
699
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300700 if (nr != -1 && nr != vdev->num && warn_if_nr_in_use)
Laurent Pincharteac8ea52009-11-27 13:56:50 -0300701 printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__,
702 name_base, nr, video_device_node_name(vdev));
Hans Verkuilbedf8bc2011-03-12 06:37:19 -0300703
704 /* Increase v4l2_device refcount */
705 if (vdev->v4l2_dev)
706 v4l2_device_get(vdev->v4l2_dev);
707
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300708#if defined(CONFIG_MEDIA_CONTROLLER)
709 /* Part 5: Register the entity. */
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300710 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
711 vdev->vfl_type != VFL_TYPE_SUBDEV) {
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300712 vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L;
713 vdev->entity.name = vdev->name;
714 vdev->entity.v4l.major = VIDEO_MAJOR;
715 vdev->entity.v4l.minor = vdev->minor;
716 ret = media_device_register_entity(vdev->v4l2_dev->mdev,
717 &vdev->entity);
718 if (ret < 0)
719 printk(KERN_WARNING
720 "%s: media_device_register_entity failed\n",
721 __func__);
722 }
723#endif
724 /* Part 6: Activate this minor. The char device can now be used. */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300725 set_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuildc93a702008-12-19 21:28:27 -0300726 mutex_lock(&videodev_lock);
727 video_device[vdev->minor] = vdev;
728 mutex_unlock(&videodev_lock);
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300729
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300730 return 0;
731
Hans Verkuildc93a702008-12-19 21:28:27 -0300732cleanup:
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300733 mutex_lock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300734 if (vdev->cdev)
735 cdev_del(vdev->cdev);
Hans Verkuil5062cb72009-09-07 03:40:24 -0300736 devnode_clear(vdev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300737 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300738 /* Mark this video device as never having been registered. */
739 vdev->minor = -1;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300740 return ret;
741}
Laurent Pinchart2096a5d2009-12-09 08:38:49 -0300742EXPORT_SYMBOL(__video_register_device);
Hans Verkuil6b5270d2009-09-06 07:54:00 -0300743
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300744/**
745 * video_unregister_device - unregister a video4linux device
Hans Verkuildc93a702008-12-19 21:28:27 -0300746 * @vdev: the device to unregister
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300747 *
Hans Verkuildc93a702008-12-19 21:28:27 -0300748 * This unregisters the passed device. Future open calls will
749 * be met with errors.
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300750 */
Hans Verkuildc93a702008-12-19 21:28:27 -0300751void video_unregister_device(struct video_device *vdev)
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300752{
Hans Verkuildc93a702008-12-19 21:28:27 -0300753 /* Check if vdev was ever registered at all */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300754 if (!vdev || !video_is_registered(vdev))
Hans Verkuildc93a702008-12-19 21:28:27 -0300755 return;
756
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300757#if defined(CONFIG_MEDIA_CONTROLLER)
Laurent Pinchartc4f0b782011-04-08 09:04:06 -0300758 if (vdev->v4l2_dev && vdev->v4l2_dev->mdev &&
759 vdev->vfl_type != VFL_TYPE_SUBDEV)
Laurent Pinchart2c0ab672009-12-09 08:40:10 -0300760 media_device_unregister_entity(&vdev->entity);
761#endif
762
Hans Verkuilca9afe62010-11-26 06:54:53 -0300763 mutex_lock(&videodev_lock);
764 /* This must be in a critical section to prevent a race with v4l2_open.
765 * Once this bit has been cleared video_get may never be called again.
766 */
Laurent Pinchart957b4aa2009-11-27 13:57:22 -0300767 clear_bit(V4L2_FL_REGISTERED, &vdev->flags);
Hans Verkuilca9afe62010-11-26 06:54:53 -0300768 mutex_unlock(&videodev_lock);
Hans Verkuildc93a702008-12-19 21:28:27 -0300769 device_unregister(&vdev->dev);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300770}
771EXPORT_SYMBOL(video_unregister_device);
772
773/*
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300774 * Initialise video for linux
775 */
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300776static int __init videodev_init(void)
777{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300778 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300779 int ret;
780
781 printk(KERN_INFO "Linux video capture interface: v2.00\n");
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300782 ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME);
783 if (ret < 0) {
784 printk(KERN_WARNING "videodev: unable to get major %d\n",
785 VIDEO_MAJOR);
786 return ret;
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300787 }
788
789 ret = class_register(&video_class);
790 if (ret < 0) {
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300791 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300792 printk(KERN_WARNING "video_dev: class_register failed\n");
793 return -EIO;
794 }
795
796 return 0;
797}
798
799static void __exit videodev_exit(void)
800{
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300801 dev_t dev = MKDEV(VIDEO_MAJOR, 0);
802
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300803 class_unregister(&video_class);
Hans Verkuil7f8ecfa2008-08-29 17:31:35 -0300804 unregister_chrdev_region(dev, VIDEO_NUM_DEVICES);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300805}
806
807module_init(videodev_init)
808module_exit(videodev_exit)
809
810MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>");
811MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2");
812MODULE_LICENSE("GPL");
Scott James Remnantcbb72b02009-03-02 15:40:57 -0300813MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR);
Hans Verkuil27a5e6d2008-07-20 08:43:17 -0300814
815
816/*
817 * Local variables:
818 * c-basic-offset: 8
819 * End:
820 */