Commit | Line | Data |
---|---|---|
27a5e6d3 HV |
1 | /* |
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 | * | |
d9b01449 | 12 | * Authors: Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1) |
27a5e6d3 HV |
13 | * 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> | |
27a5e6d3 HV |
28 | #include <asm/uaccess.h> |
29 | #include <asm/system.h> | |
30 | ||
31 | #include <media/v4l2-common.h> | |
9bea3514 | 32 | #include <media/v4l2-device.h> |
bec43661 | 33 | #include <media/v4l2-ioctl.h> |
27a5e6d3 HV |
34 | |
35 | #define VIDEO_NUM_DEVICES 256 | |
36 | #define VIDEO_NAME "video4linux" | |
37 | ||
38 | /* | |
39 | * sysfs stuff | |
40 | */ | |
41 | ||
42 | static ssize_t show_index(struct device *cd, | |
43 | struct device_attribute *attr, char *buf) | |
44 | { | |
dc93a70c | 45 | struct video_device *vdev = to_video_device(cd); |
bfa8a273 | 46 | |
dc93a70c | 47 | return sprintf(buf, "%i\n", vdev->index); |
27a5e6d3 HV |
48 | } |
49 | ||
50 | static ssize_t show_name(struct device *cd, | |
51 | struct device_attribute *attr, char *buf) | |
52 | { | |
dc93a70c | 53 | struct video_device *vdev = to_video_device(cd); |
bfa8a273 | 54 | |
dc93a70c | 55 | return sprintf(buf, "%.*s\n", (int)sizeof(vdev->name), vdev->name); |
27a5e6d3 HV |
56 | } |
57 | ||
58 | static 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 | ||
7f8ecfab HV |
64 | /* |
65 | * Active devices | |
66 | */ | |
67 | static struct video_device *video_device[VIDEO_NUM_DEVICES]; | |
68 | static DEFINE_MUTEX(videodev_lock); | |
22e22125 | 69 | static DECLARE_BITMAP(devnode_nums[VFL_TYPE_MAX], VIDEO_NUM_DEVICES); |
7f8ecfab | 70 | |
5062cb70 HV |
71 | /* 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. */ | |
78 | static 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. */ | |
226c0eea | 83 | int idx = (vfl_type > VFL_TYPE_RADIO) ? VFL_TYPE_MAX - 1 : vfl_type; |
5062cb70 HV |
84 | |
85 | return devnode_nums[idx]; | |
86 | } | |
87 | #else | |
88 | /* Return the bitmap corresponding to vfl_type. */ | |
89 | static 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 */ | |
96 | static 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 */ | |
102 | static 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> */ | |
108 | static 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 | ||
27a5e6d3 HV |
113 | struct video_device *video_device_alloc(void) |
114 | { | |
bfa8a273 | 115 | return kzalloc(sizeof(struct video_device), GFP_KERNEL); |
27a5e6d3 HV |
116 | } |
117 | EXPORT_SYMBOL(video_device_alloc); | |
118 | ||
dc93a70c | 119 | void video_device_release(struct video_device *vdev) |
27a5e6d3 | 120 | { |
dc93a70c | 121 | kfree(vdev); |
27a5e6d3 HV |
122 | } |
123 | EXPORT_SYMBOL(video_device_release); | |
124 | ||
dc93a70c | 125 | void video_device_release_empty(struct video_device *vdev) |
f9e86b5e HV |
126 | { |
127 | /* Do nothing */ | |
128 | /* Only valid when the video_device struct is a static. */ | |
129 | } | |
130 | EXPORT_SYMBOL(video_device_release_empty); | |
131 | ||
dc93a70c | 132 | static inline void video_get(struct video_device *vdev) |
7f8ecfab | 133 | { |
dc93a70c HV |
134 | get_device(&vdev->dev); |
135 | } | |
136 | ||
137 | static 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. */ | |
143 | static void v4l2_device_release(struct device *cd) | |
144 | { | |
145 | struct video_device *vdev = to_video_device(cd); | |
bedf8bcf | 146 | struct v4l2_device *v4l2_dev = vdev->v4l2_dev; |
7f8ecfab HV |
147 | |
148 | mutex_lock(&videodev_lock); | |
dc93a70c | 149 | if (video_device[vdev->minor] != vdev) { |
6ea9a182 | 150 | mutex_unlock(&videodev_lock); |
dc93a70c HV |
151 | /* should not happen */ |
152 | WARN_ON(1); | |
6ea9a182 HV |
153 | return; |
154 | } | |
7f8ecfab HV |
155 | |
156 | /* Free up this device for reuse */ | |
dc93a70c | 157 | video_device[vdev->minor] = NULL; |
7f8ecfab | 158 | |
dc93a70c HV |
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; | |
7f8ecfab | 164 | |
22e22125 | 165 | /* Mark device node number as free */ |
5062cb70 | 166 | devnode_clear(vdev); |
7f8ecfab | 167 | |
dc93a70c | 168 | mutex_unlock(&videodev_lock); |
27a5e6d3 | 169 | |
c064b8ea LP |
170 | #if defined(CONFIG_MEDIA_CONTROLLER) |
171 | if (vdev->v4l2_dev && vdev->v4l2_dev->mdev && | |
172 | vdev->vfl_type != VFL_TYPE_SUBDEV) | |
173 | media_device_unregister_entity(&vdev->entity); | |
174 | #endif | |
175 | ||
dc93a70c HV |
176 | /* Release video_device and perform other |
177 | cleanups as needed. */ | |
178 | vdev->release(vdev); | |
bedf8bcf HV |
179 | |
180 | /* Decrease v4l2_device refcount */ | |
181 | if (v4l2_dev) | |
182 | v4l2_device_put(v4l2_dev); | |
27a5e6d3 HV |
183 | } |
184 | ||
185 | static struct class video_class = { | |
186 | .name = VIDEO_NAME, | |
187 | .dev_attrs = video_device_attrs, | |
27a5e6d3 HV |
188 | }; |
189 | ||
27a5e6d3 HV |
190 | struct video_device *video_devdata(struct file *file) |
191 | { | |
192 | return video_device[iminor(file->f_path.dentry->d_inode)]; | |
193 | } | |
194 | EXPORT_SYMBOL(video_devdata); | |
195 | ||
02265493 HV |
196 | |
197 | /* Priority handling */ | |
198 | ||
199 | static inline bool prio_is_valid(enum v4l2_priority prio) | |
200 | { | |
201 | return prio == V4L2_PRIORITY_BACKGROUND || | |
202 | prio == V4L2_PRIORITY_INTERACTIVE || | |
203 | prio == V4L2_PRIORITY_RECORD; | |
204 | } | |
205 | ||
206 | void v4l2_prio_init(struct v4l2_prio_state *global) | |
207 | { | |
208 | memset(global, 0, sizeof(*global)); | |
209 | } | |
210 | EXPORT_SYMBOL(v4l2_prio_init); | |
211 | ||
212 | int v4l2_prio_change(struct v4l2_prio_state *global, enum v4l2_priority *local, | |
213 | enum v4l2_priority new) | |
214 | { | |
215 | if (!prio_is_valid(new)) | |
216 | return -EINVAL; | |
217 | if (*local == new) | |
218 | return 0; | |
219 | ||
220 | atomic_inc(&global->prios[new]); | |
221 | if (prio_is_valid(*local)) | |
222 | atomic_dec(&global->prios[*local]); | |
223 | *local = new; | |
224 | return 0; | |
225 | } | |
226 | EXPORT_SYMBOL(v4l2_prio_change); | |
227 | ||
228 | void v4l2_prio_open(struct v4l2_prio_state *global, enum v4l2_priority *local) | |
229 | { | |
230 | v4l2_prio_change(global, local, V4L2_PRIORITY_DEFAULT); | |
231 | } | |
232 | EXPORT_SYMBOL(v4l2_prio_open); | |
233 | ||
234 | void v4l2_prio_close(struct v4l2_prio_state *global, enum v4l2_priority local) | |
235 | { | |
236 | if (prio_is_valid(local)) | |
237 | atomic_dec(&global->prios[local]); | |
238 | } | |
239 | EXPORT_SYMBOL(v4l2_prio_close); | |
240 | ||
241 | enum v4l2_priority v4l2_prio_max(struct v4l2_prio_state *global) | |
242 | { | |
243 | if (atomic_read(&global->prios[V4L2_PRIORITY_RECORD]) > 0) | |
244 | return V4L2_PRIORITY_RECORD; | |
245 | if (atomic_read(&global->prios[V4L2_PRIORITY_INTERACTIVE]) > 0) | |
246 | return V4L2_PRIORITY_INTERACTIVE; | |
247 | if (atomic_read(&global->prios[V4L2_PRIORITY_BACKGROUND]) > 0) | |
248 | return V4L2_PRIORITY_BACKGROUND; | |
249 | return V4L2_PRIORITY_UNSET; | |
250 | } | |
251 | EXPORT_SYMBOL(v4l2_prio_max); | |
252 | ||
253 | int v4l2_prio_check(struct v4l2_prio_state *global, enum v4l2_priority local) | |
254 | { | |
255 | return (local < v4l2_prio_max(global)) ? -EBUSY : 0; | |
256 | } | |
257 | EXPORT_SYMBOL(v4l2_prio_check); | |
258 | ||
259 | ||
dc93a70c HV |
260 | static ssize_t v4l2_read(struct file *filp, char __user *buf, |
261 | size_t sz, loff_t *off) | |
262 | { | |
263 | struct video_device *vdev = video_devdata(filp); | |
2877842d | 264 | int ret = -ENODEV; |
dc93a70c HV |
265 | |
266 | if (!vdev->fops->read) | |
267 | return -EINVAL; | |
2877842d HV |
268 | if (vdev->lock && mutex_lock_interruptible(vdev->lock)) |
269 | return -ERESTARTSYS; | |
ee6869af HV |
270 | if (video_is_registered(vdev)) |
271 | ret = vdev->fops->read(filp, buf, sz, off); | |
272 | if (vdev->lock) | |
273 | mutex_unlock(vdev->lock); | |
274 | return ret; | |
dc93a70c HV |
275 | } |
276 | ||
277 | static ssize_t v4l2_write(struct file *filp, const char __user *buf, | |
278 | size_t sz, loff_t *off) | |
279 | { | |
280 | struct video_device *vdev = video_devdata(filp); | |
2877842d | 281 | int ret = -ENODEV; |
dc93a70c HV |
282 | |
283 | if (!vdev->fops->write) | |
284 | return -EINVAL; | |
2877842d HV |
285 | if (vdev->lock && mutex_lock_interruptible(vdev->lock)) |
286 | return -ERESTARTSYS; | |
ee6869af HV |
287 | if (video_is_registered(vdev)) |
288 | ret = vdev->fops->write(filp, buf, sz, off); | |
289 | if (vdev->lock) | |
290 | mutex_unlock(vdev->lock); | |
291 | return ret; | |
dc93a70c HV |
292 | } |
293 | ||
294 | static unsigned int v4l2_poll(struct file *filp, struct poll_table_struct *poll) | |
295 | { | |
296 | struct video_device *vdev = video_devdata(filp); | |
2877842d | 297 | int ret = POLLERR | POLLHUP; |
ee6869af HV |
298 | |
299 | if (!vdev->fops->poll) | |
2877842d | 300 | return DEFAULT_POLLMASK; |
ee6869af HV |
301 | if (vdev->lock) |
302 | mutex_lock(vdev->lock); | |
303 | if (video_is_registered(vdev)) | |
304 | ret = vdev->fops->poll(filp, poll); | |
305 | if (vdev->lock) | |
306 | mutex_unlock(vdev->lock); | |
307 | return ret; | |
dc93a70c HV |
308 | } |
309 | ||
86a5ef7d | 310 | static long v4l2_ioctl(struct file *filp, unsigned int cmd, unsigned long arg) |
dc93a70c HV |
311 | { |
312 | struct video_device *vdev = video_devdata(filp); | |
72420630 | 313 | int ret = -ENODEV; |
dc93a70c | 314 | |
86a5ef7d | 315 | if (vdev->fops->unlocked_ioctl) { |
2877842d HV |
316 | if (vdev->lock && mutex_lock_interruptible(vdev->lock)) |
317 | return -ERESTARTSYS; | |
72420630 MCC |
318 | if (video_is_registered(vdev)) |
319 | ret = vdev->fops->unlocked_ioctl(filp, cmd, arg); | |
ee6869af HV |
320 | if (vdev->lock) |
321 | mutex_unlock(vdev->lock); | |
86a5ef7d | 322 | } else if (vdev->fops->ioctl) { |
879aa24d HV |
323 | /* This code path is a replacement for the BKL. It is a major |
324 | * hack but it will have to do for those drivers that are not | |
325 | * yet converted to use unlocked_ioctl. | |
326 | * | |
327 | * There are two options: if the driver implements struct | |
328 | * v4l2_device, then the lock defined there is used to | |
329 | * serialize the ioctls. Otherwise the v4l2 core lock defined | |
330 | * below is used. This lock is really bad since it serializes | |
331 | * completely independent devices. | |
332 | * | |
333 | * Both variants suffer from the same problem: if the driver | |
334 | * sleeps, then it blocks all ioctls since the lock is still | |
335 | * held. This is very common for VIDIOC_DQBUF since that | |
336 | * normally waits for a frame to arrive. As a result any other | |
337 | * ioctl calls will proceed very, very slowly since each call | |
338 | * will have to wait for the VIDIOC_QBUF to finish. Things that | |
339 | * should take 0.01s may now take 10-20 seconds. | |
340 | * | |
341 | * The workaround is to *not* take the lock for VIDIOC_DQBUF. | |
342 | * This actually works OK for videobuf-based drivers, since | |
343 | * videobuf will take its own internal lock. | |
344 | */ | |
0edf2e5e | 345 | static DEFINE_MUTEX(v4l2_ioctl_mutex); |
879aa24d HV |
346 | struct mutex *m = vdev->v4l2_dev ? |
347 | &vdev->v4l2_dev->ioctl_lock : &v4l2_ioctl_mutex; | |
0edf2e5e | 348 | |
879aa24d HV |
349 | if (cmd != VIDIOC_DQBUF && mutex_lock_interruptible(m)) |
350 | return -ERESTARTSYS; | |
72420630 MCC |
351 | if (video_is_registered(vdev)) |
352 | ret = vdev->fops->ioctl(filp, cmd, arg); | |
879aa24d HV |
353 | if (cmd != VIDIOC_DQBUF) |
354 | mutex_unlock(m); | |
86a5ef7d AB |
355 | } else |
356 | ret = -ENOTTY; | |
dc93a70c | 357 | |
86a5ef7d | 358 | return ret; |
dc93a70c HV |
359 | } |
360 | ||
ecc6517d BL |
361 | #ifdef CONFIG_MMU |
362 | #define v4l2_get_unmapped_area NULL | |
363 | #else | |
364 | static unsigned long v4l2_get_unmapped_area(struct file *filp, | |
365 | unsigned long addr, unsigned long len, unsigned long pgoff, | |
366 | unsigned long flags) | |
367 | { | |
368 | struct video_device *vdev = video_devdata(filp); | |
369 | ||
370 | if (!vdev->fops->get_unmapped_area) | |
371 | return -ENOSYS; | |
372 | if (!video_is_registered(vdev)) | |
373 | return -ENODEV; | |
374 | return vdev->fops->get_unmapped_area(filp, addr, len, pgoff, flags); | |
375 | } | |
376 | #endif | |
377 | ||
dc93a70c HV |
378 | static int v4l2_mmap(struct file *filp, struct vm_area_struct *vm) |
379 | { | |
380 | struct video_device *vdev = video_devdata(filp); | |
ee6869af HV |
381 | int ret = -ENODEV; |
382 | ||
383 | if (!vdev->fops->mmap) | |
384 | return ret; | |
2877842d HV |
385 | if (vdev->lock && mutex_lock_interruptible(vdev->lock)) |
386 | return -ERESTARTSYS; | |
ee6869af HV |
387 | if (video_is_registered(vdev)) |
388 | ret = vdev->fops->mmap(filp, vm); | |
389 | if (vdev->lock) | |
390 | mutex_unlock(vdev->lock); | |
391 | return ret; | |
dc93a70c HV |
392 | } |
393 | ||
394 | /* Override for the open function */ | |
395 | static int v4l2_open(struct inode *inode, struct file *filp) | |
396 | { | |
397 | struct video_device *vdev; | |
65d9ff9c | 398 | int ret = 0; |
dc93a70c HV |
399 | |
400 | /* Check if the video device is available */ | |
401 | mutex_lock(&videodev_lock); | |
402 | vdev = video_devdata(filp); | |
ee6869af | 403 | /* return ENODEV if the video device has already been removed. */ |
ca9afe6f | 404 | if (vdev == NULL || !video_is_registered(vdev)) { |
dc93a70c HV |
405 | mutex_unlock(&videodev_lock); |
406 | return -ENODEV; | |
407 | } | |
408 | /* and increase the device refcount */ | |
409 | video_get(vdev); | |
410 | mutex_unlock(&videodev_lock); | |
ee6869af | 411 | if (vdev->fops->open) { |
2877842d HV |
412 | if (vdev->lock && mutex_lock_interruptible(vdev->lock)) { |
413 | ret = -ERESTARTSYS; | |
414 | goto err; | |
415 | } | |
ee6869af HV |
416 | if (video_is_registered(vdev)) |
417 | ret = vdev->fops->open(filp); | |
418 | else | |
419 | ret = -ENODEV; | |
420 | if (vdev->lock) | |
421 | mutex_unlock(vdev->lock); | |
422 | } | |
65d9ff9c | 423 | |
2877842d | 424 | err: |
dc93a70c | 425 | /* decrease the refcount in case of an error */ |
c064b8ea | 426 | if (ret) |
dc93a70c HV |
427 | video_put(vdev); |
428 | return ret; | |
429 | } | |
430 | ||
431 | /* Override for the release function */ | |
432 | static int v4l2_release(struct inode *inode, struct file *filp) | |
433 | { | |
434 | struct video_device *vdev = video_devdata(filp); | |
65d9ff9c HV |
435 | int ret = 0; |
436 | ||
ee6869af HV |
437 | if (vdev->fops->release) { |
438 | if (vdev->lock) | |
439 | mutex_lock(vdev->lock); | |
65d9ff9c | 440 | vdev->fops->release(filp); |
ee6869af HV |
441 | if (vdev->lock) |
442 | mutex_unlock(vdev->lock); | |
443 | } | |
dc93a70c HV |
444 | /* decrease the refcount unconditionally since the release() |
445 | return value is ignored. */ | |
446 | video_put(vdev); | |
447 | return ret; | |
448 | } | |
449 | ||
dc93a70c HV |
450 | static const struct file_operations v4l2_fops = { |
451 | .owner = THIS_MODULE, | |
452 | .read = v4l2_read, | |
453 | .write = v4l2_write, | |
454 | .open = v4l2_open, | |
ecc6517d | 455 | .get_unmapped_area = v4l2_get_unmapped_area, |
dc93a70c | 456 | .mmap = v4l2_mmap, |
86a5ef7d | 457 | .unlocked_ioctl = v4l2_ioctl, |
dc93a70c | 458 | #ifdef CONFIG_COMPAT |
9bb7cde7 | 459 | .compat_ioctl = v4l2_compat_ioctl32, |
dc93a70c HV |
460 | #endif |
461 | .release = v4l2_release, | |
462 | .poll = v4l2_poll, | |
463 | .llseek = no_llseek, | |
464 | }; | |
465 | ||
27a5e6d3 | 466 | /** |
7ae0cd9b | 467 | * get_index - assign stream index number based on parent device |
dc93a70c | 468 | * @vdev: video_device to assign index number to, vdev->parent should be assigned |
27a5e6d3 | 469 | * |
dc93a70c | 470 | * Note that when this is called the new device has not yet been registered |
7ae0cd9b | 471 | * in the video_device array, but it was able to obtain a minor number. |
27a5e6d3 | 472 | * |
7ae0cd9b HV |
473 | * This means that we can always obtain a free stream index number since |
474 | * the worst case scenario is that there are VIDEO_NUM_DEVICES - 1 slots in | |
475 | * use of the video_device array. | |
476 | * | |
477 | * Returns a free index number. | |
27a5e6d3 | 478 | */ |
7ae0cd9b | 479 | static int get_index(struct video_device *vdev) |
27a5e6d3 | 480 | { |
775a05dd HV |
481 | /* This can be static since this function is called with the global |
482 | videodev_lock held. */ | |
483 | static DECLARE_BITMAP(used, VIDEO_NUM_DEVICES); | |
27a5e6d3 HV |
484 | int i; |
485 | ||
7ae0cd9b | 486 | /* Some drivers do not set the parent. In that case always return 0. */ |
806e5b7c | 487 | if (vdev->parent == NULL) |
7ae0cd9b | 488 | return 0; |
775a05dd HV |
489 | |
490 | bitmap_zero(used, VIDEO_NUM_DEVICES); | |
806e5b7c | 491 | |
27a5e6d3 HV |
492 | for (i = 0; i < VIDEO_NUM_DEVICES; i++) { |
493 | if (video_device[i] != NULL && | |
5e85e732 | 494 | video_device[i]->parent == vdev->parent) { |
775a05dd | 495 | set_bit(video_device[i]->index, used); |
27a5e6d3 HV |
496 | } |
497 | } | |
498 | ||
7ae0cd9b | 499 | return find_first_zero_bit(used, VIDEO_NUM_DEVICES); |
27a5e6d3 HV |
500 | } |
501 | ||
27a5e6d3 | 502 | /** |
2096a5dc | 503 | * __video_register_device - register video4linux devices |
dc93a70c | 504 | * @vdev: video device structure we want to register |
27a5e6d3 | 505 | * @type: type of device to register |
22e22125 | 506 | * @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ... |
27a5e6d3 | 507 | * -1 == first free) |
6b5270d2 HV |
508 | * @warn_if_nr_in_use: warn if the desired device node number |
509 | * was already in use and another number was chosen instead. | |
2096a5dc | 510 | * @owner: module that owns the video device node |
27a5e6d3 | 511 | * |
22e22125 HV |
512 | * The registration code assigns minor numbers and device node numbers |
513 | * based on the requested type and registers the new device node with | |
514 | * the kernel. | |
46b63377 HV |
515 | * |
516 | * This function assumes that struct video_device was zeroed when it | |
517 | * was allocated and does not contain any stale date. | |
518 | * | |
22e22125 HV |
519 | * An error is returned if no free minor or device node number could be |
520 | * found, or if the registration of the device node failed. | |
27a5e6d3 HV |
521 | * |
522 | * Zero is returned on success. | |
523 | * | |
524 | * Valid types are | |
525 | * | |
526 | * %VFL_TYPE_GRABBER - A frame grabber | |
527 | * | |
27a5e6d3 HV |
528 | * %VFL_TYPE_VBI - Vertical blank data (undecoded) |
529 | * | |
530 | * %VFL_TYPE_RADIO - A radio card | |
2096a5dc LP |
531 | * |
532 | * %VFL_TYPE_SUBDEV - A subdevice | |
27a5e6d3 | 533 | */ |
2096a5dc LP |
534 | int __video_register_device(struct video_device *vdev, int type, int nr, |
535 | int warn_if_nr_in_use, struct module *owner) | |
27a5e6d3 HV |
536 | { |
537 | int i = 0; | |
27a5e6d3 | 538 | int ret; |
dd89601d HV |
539 | int minor_offset = 0; |
540 | int minor_cnt = VIDEO_NUM_DEVICES; | |
541 | const char *name_base; | |
27a5e6d3 | 542 | |
dc93a70c HV |
543 | /* A minor value of -1 marks this video device as never |
544 | having been registered */ | |
428c8d19 | 545 | vdev->minor = -1; |
ee7aa9f8 | 546 | |
dc93a70c | 547 | /* the release callback MUST be present */ |
428c8d19 TP |
548 | WARN_ON(!vdev->release); |
549 | if (!vdev->release) | |
f3b9f50e HK |
550 | return -EINVAL; |
551 | ||
1babcb46 SA |
552 | /* v4l2_fh support */ |
553 | spin_lock_init(&vdev->fh_lock); | |
554 | INIT_LIST_HEAD(&vdev->fh_list); | |
555 | ||
dc93a70c | 556 | /* Part 1: check device type */ |
27a5e6d3 HV |
557 | switch (type) { |
558 | case VFL_TYPE_GRABBER: | |
27a5e6d3 HV |
559 | name_base = "video"; |
560 | break; | |
27a5e6d3 | 561 | case VFL_TYPE_VBI: |
27a5e6d3 HV |
562 | name_base = "vbi"; |
563 | break; | |
564 | case VFL_TYPE_RADIO: | |
27a5e6d3 HV |
565 | name_base = "radio"; |
566 | break; | |
2096a5dc LP |
567 | case VFL_TYPE_SUBDEV: |
568 | name_base = "v4l-subdev"; | |
569 | break; | |
27a5e6d3 HV |
570 | default: |
571 | printk(KERN_ERR "%s called with unknown type: %d\n", | |
572 | __func__, type); | |
46f2c21c | 573 | return -EINVAL; |
27a5e6d3 HV |
574 | } |
575 | ||
dc93a70c HV |
576 | vdev->vfl_type = type; |
577 | vdev->cdev = NULL; | |
11bbc1ca HV |
578 | if (vdev->v4l2_dev) { |
579 | if (vdev->v4l2_dev->dev) | |
580 | vdev->parent = vdev->v4l2_dev->dev; | |
581 | if (vdev->ctrl_handler == NULL) | |
582 | vdev->ctrl_handler = vdev->v4l2_dev->ctrl_handler; | |
b1a873a3 HV |
583 | /* If the prio state pointer is NULL, then use the v4l2_device |
584 | prio state. */ | |
585 | if (vdev->prio == NULL) | |
0f62fd6a | 586 | vdev->prio = &vdev->v4l2_dev->prio; |
11bbc1ca | 587 | } |
dd89601d | 588 | |
22e22125 | 589 | /* Part 2: find a free minor, device node number and device index. */ |
dd89601d HV |
590 | #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES |
591 | /* Keep the ranges for the first four types for historical | |
592 | * reasons. | |
593 | * Newer devices (not yet in place) should use the range | |
594 | * of 128-191 and just pick the first free minor there | |
595 | * (new style). */ | |
596 | switch (type) { | |
597 | case VFL_TYPE_GRABBER: | |
598 | minor_offset = 0; | |
599 | minor_cnt = 64; | |
600 | break; | |
601 | case VFL_TYPE_RADIO: | |
602 | minor_offset = 64; | |
603 | minor_cnt = 64; | |
604 | break; | |
dd89601d HV |
605 | case VFL_TYPE_VBI: |
606 | minor_offset = 224; | |
607 | minor_cnt = 32; | |
608 | break; | |
609 | default: | |
610 | minor_offset = 128; | |
611 | minor_cnt = 64; | |
612 | break; | |
613 | } | |
614 | #endif | |
615 | ||
22e22125 | 616 | /* Pick a device node number */ |
27a5e6d3 | 617 | mutex_lock(&videodev_lock); |
5062cb70 | 618 | nr = devnode_find(vdev, nr == -1 ? 0 : nr, minor_cnt); |
dd89601d | 619 | if (nr == minor_cnt) |
5062cb70 | 620 | nr = devnode_find(vdev, 0, minor_cnt); |
dd89601d | 621 | if (nr == minor_cnt) { |
22e22125 | 622 | printk(KERN_ERR "could not get a free device node number\n"); |
dd89601d HV |
623 | mutex_unlock(&videodev_lock); |
624 | return -ENFILE; | |
27a5e6d3 | 625 | } |
dd89601d | 626 | #ifdef CONFIG_VIDEO_FIXED_MINOR_RANGES |
22e22125 | 627 | /* 1-on-1 mapping of device node number to minor number */ |
dd89601d HV |
628 | i = nr; |
629 | #else | |
22e22125 HV |
630 | /* The device node number and minor numbers are independent, so |
631 | we just find the first free minor number. */ | |
dd89601d HV |
632 | for (i = 0; i < VIDEO_NUM_DEVICES; i++) |
633 | if (video_device[i] == NULL) | |
634 | break; | |
635 | if (i == VIDEO_NUM_DEVICES) { | |
636 | mutex_unlock(&videodev_lock); | |
637 | printk(KERN_ERR "could not get a free minor\n"); | |
638 | return -ENFILE; | |
639 | } | |
640 | #endif | |
dc93a70c HV |
641 | vdev->minor = i + minor_offset; |
642 | vdev->num = nr; | |
5062cb70 HV |
643 | devnode_set(vdev); |
644 | ||
dc93a70c HV |
645 | /* Should not happen since we thought this minor was free */ |
646 | WARN_ON(video_device[vdev->minor] != NULL); | |
7ae0cd9b | 647 | vdev->index = get_index(vdev); |
27a5e6d3 HV |
648 | mutex_unlock(&videodev_lock); |
649 | ||
dc93a70c HV |
650 | /* Part 3: Initialize the character device */ |
651 | vdev->cdev = cdev_alloc(); | |
652 | if (vdev->cdev == NULL) { | |
653 | ret = -ENOMEM; | |
654 | goto cleanup; | |
655 | } | |
86a5ef7d | 656 | vdev->cdev->ops = &v4l2_fops; |
2096a5dc | 657 | vdev->cdev->owner = owner; |
dc93a70c | 658 | ret = cdev_add(vdev->cdev, MKDEV(VIDEO_MAJOR, vdev->minor), 1); |
7f8ecfab HV |
659 | if (ret < 0) { |
660 | printk(KERN_ERR "%s: cdev_add failed\n", __func__); | |
dc93a70c HV |
661 | kfree(vdev->cdev); |
662 | vdev->cdev = NULL; | |
663 | goto cleanup; | |
7f8ecfab | 664 | } |
dc93a70c HV |
665 | |
666 | /* Part 4: register the device with sysfs */ | |
dc93a70c HV |
667 | vdev->dev.class = &video_class; |
668 | vdev->dev.devt = MKDEV(VIDEO_MAJOR, vdev->minor); | |
669 | if (vdev->parent) | |
670 | vdev->dev.parent = vdev->parent; | |
22e22125 | 671 | dev_set_name(&vdev->dev, "%s%d", name_base, vdev->num); |
dc93a70c | 672 | ret = device_register(&vdev->dev); |
27a5e6d3 HV |
673 | if (ret < 0) { |
674 | printk(KERN_ERR "%s: device_register failed\n", __func__); | |
dc93a70c | 675 | goto cleanup; |
27a5e6d3 | 676 | } |
dc93a70c HV |
677 | /* Register the release callback that will be called when the last |
678 | reference to the device goes away. */ | |
679 | vdev->dev.release = v4l2_device_release; | |
27a5e6d3 | 680 | |
6b5270d2 | 681 | if (nr != -1 && nr != vdev->num && warn_if_nr_in_use) |
eac8ea53 LP |
682 | printk(KERN_WARNING "%s: requested %s%d, got %s\n", __func__, |
683 | name_base, nr, video_device_node_name(vdev)); | |
bedf8bcf HV |
684 | |
685 | /* Increase v4l2_device refcount */ | |
686 | if (vdev->v4l2_dev) | |
687 | v4l2_device_get(vdev->v4l2_dev); | |
688 | ||
2c0ab67b LP |
689 | #if defined(CONFIG_MEDIA_CONTROLLER) |
690 | /* Part 5: Register the entity. */ | |
c4f0b78a LP |
691 | if (vdev->v4l2_dev && vdev->v4l2_dev->mdev && |
692 | vdev->vfl_type != VFL_TYPE_SUBDEV) { | |
2c0ab67b LP |
693 | vdev->entity.type = MEDIA_ENT_T_DEVNODE_V4L; |
694 | vdev->entity.name = vdev->name; | |
695 | vdev->entity.v4l.major = VIDEO_MAJOR; | |
696 | vdev->entity.v4l.minor = vdev->minor; | |
697 | ret = media_device_register_entity(vdev->v4l2_dev->mdev, | |
698 | &vdev->entity); | |
699 | if (ret < 0) | |
700 | printk(KERN_WARNING | |
701 | "%s: media_device_register_entity failed\n", | |
702 | __func__); | |
703 | } | |
704 | #endif | |
705 | /* Part 6: Activate this minor. The char device can now be used. */ | |
957b4aa9 | 706 | set_bit(V4L2_FL_REGISTERED, &vdev->flags); |
dc93a70c HV |
707 | mutex_lock(&videodev_lock); |
708 | video_device[vdev->minor] = vdev; | |
709 | mutex_unlock(&videodev_lock); | |
2c0ab67b | 710 | |
dc93a70c | 711 | return 0; |
7f8ecfab | 712 | |
dc93a70c | 713 | cleanup: |
27a5e6d3 | 714 | mutex_lock(&videodev_lock); |
dc93a70c HV |
715 | if (vdev->cdev) |
716 | cdev_del(vdev->cdev); | |
5062cb70 | 717 | devnode_clear(vdev); |
27a5e6d3 | 718 | mutex_unlock(&videodev_lock); |
dc93a70c HV |
719 | /* Mark this video device as never having been registered. */ |
720 | vdev->minor = -1; | |
27a5e6d3 HV |
721 | return ret; |
722 | } | |
2096a5dc | 723 | EXPORT_SYMBOL(__video_register_device); |
6b5270d2 | 724 | |
27a5e6d3 HV |
725 | /** |
726 | * video_unregister_device - unregister a video4linux device | |
dc93a70c | 727 | * @vdev: the device to unregister |
27a5e6d3 | 728 | * |
dc93a70c HV |
729 | * This unregisters the passed device. Future open calls will |
730 | * be met with errors. | |
27a5e6d3 | 731 | */ |
dc93a70c | 732 | void video_unregister_device(struct video_device *vdev) |
27a5e6d3 | 733 | { |
dc93a70c | 734 | /* Check if vdev was ever registered at all */ |
957b4aa9 | 735 | if (!vdev || !video_is_registered(vdev)) |
dc93a70c HV |
736 | return; |
737 | ||
ca9afe6f HV |
738 | mutex_lock(&videodev_lock); |
739 | /* This must be in a critical section to prevent a race with v4l2_open. | |
740 | * Once this bit has been cleared video_get may never be called again. | |
741 | */ | |
957b4aa9 | 742 | clear_bit(V4L2_FL_REGISTERED, &vdev->flags); |
ca9afe6f | 743 | mutex_unlock(&videodev_lock); |
dc93a70c | 744 | device_unregister(&vdev->dev); |
27a5e6d3 HV |
745 | } |
746 | EXPORT_SYMBOL(video_unregister_device); | |
747 | ||
27a5e6d3 HV |
748 | /* |
749 | * Initialise video for linux | |
750 | */ | |
27a5e6d3 HV |
751 | static int __init videodev_init(void) |
752 | { | |
7f8ecfab | 753 | dev_t dev = MKDEV(VIDEO_MAJOR, 0); |
27a5e6d3 HV |
754 | int ret; |
755 | ||
756 | printk(KERN_INFO "Linux video capture interface: v2.00\n"); | |
7f8ecfab HV |
757 | ret = register_chrdev_region(dev, VIDEO_NUM_DEVICES, VIDEO_NAME); |
758 | if (ret < 0) { | |
759 | printk(KERN_WARNING "videodev: unable to get major %d\n", | |
760 | VIDEO_MAJOR); | |
761 | return ret; | |
27a5e6d3 HV |
762 | } |
763 | ||
764 | ret = class_register(&video_class); | |
765 | if (ret < 0) { | |
7f8ecfab | 766 | unregister_chrdev_region(dev, VIDEO_NUM_DEVICES); |
27a5e6d3 HV |
767 | printk(KERN_WARNING "video_dev: class_register failed\n"); |
768 | return -EIO; | |
769 | } | |
770 | ||
771 | return 0; | |
772 | } | |
773 | ||
774 | static void __exit videodev_exit(void) | |
775 | { | |
7f8ecfab HV |
776 | dev_t dev = MKDEV(VIDEO_MAJOR, 0); |
777 | ||
27a5e6d3 | 778 | class_unregister(&video_class); |
7f8ecfab | 779 | unregister_chrdev_region(dev, VIDEO_NUM_DEVICES); |
27a5e6d3 HV |
780 | } |
781 | ||
782 | module_init(videodev_init) | |
783 | module_exit(videodev_exit) | |
784 | ||
785 | MODULE_AUTHOR("Alan Cox, Mauro Carvalho Chehab <mchehab@infradead.org>"); | |
786 | MODULE_DESCRIPTION("Device registrar for Video4Linux drivers v2"); | |
787 | MODULE_LICENSE("GPL"); | |
cbb72b0f | 788 | MODULE_ALIAS_CHARDEV_MAJOR(VIDEO_MAJOR); |
27a5e6d3 HV |
789 | |
790 | ||
791 | /* | |
792 | * Local variables: | |
793 | * c-basic-offset: 8 | |
794 | * End: | |
795 | */ |