Commit d9d3d176 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] doc-rst: document v4l2-dev.h

Add documentation for v4l2-dev.h, and put it at v4l2-framework.rst,
where struct video_device is currently documented.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 041d8211
...@@ -699,3 +699,8 @@ methods. ...@@ -699,3 +699,8 @@ methods.
It is expected that once the CCF becomes available on all relevant It is expected that once the CCF becomes available on all relevant
architectures this API will be removed. architectures this API will be removed.
video_device kAPI
^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-dev.h
...@@ -812,40 +812,6 @@ static int video_register_media_controller(struct video_device *vdev, int type) ...@@ -812,40 +812,6 @@ static int video_register_media_controller(struct video_device *vdev, int type)
return 0; return 0;
} }
/**
* __video_register_device - register video4linux devices
* @vdev: video device structure we want to register
* @type: type of device to register
* @nr: which device node number (0 == /dev/video0, 1 == /dev/video1, ...
* -1 == first free)
* @warn_if_nr_in_use: warn if the desired device node number
* was already in use and another number was chosen instead.
* @owner: module that owns the video device node
*
* The registration code assigns minor numbers and device node numbers
* based on the requested type and registers the new device node with
* the kernel.
*
* This function assumes that struct video_device was zeroed when it
* was allocated and does not contain any stale date.
*
* An error is returned if no free minor or device node number could be
* found, or if the registration of the device node failed.
*
* Zero is returned on success.
*
* Valid types are
*
* %VFL_TYPE_GRABBER - A frame grabber
*
* %VFL_TYPE_VBI - Vertical blank data (undecoded)
*
* %VFL_TYPE_RADIO - A radio card
*
* %VFL_TYPE_SUBDEV - A subdevice
*
* %VFL_TYPE_SDR - Software Defined Radio
*/
int __video_register_device(struct video_device *vdev, int type, int nr, int __video_register_device(struct video_device *vdev, int type, int nr,
int warn_if_nr_in_use, struct module *owner) int warn_if_nr_in_use, struct module *owner)
{ {
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment