diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-10-05 14:05:25 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-12-18 11:55:02 -0500 |
| commit | 63b31ffd1c7614966abd2d2cf59bf33734acc60c (patch) | |
| tree | 68a1ff77ba11c769662a077f9f97fb336dc9ccfc /include | |
| parent | 468fde0b79f3c36494eea6d3d7eb20cfb8f38a50 (diff) | |
media: v4l2-dev: document video_device flags
Convert #defines to enums and add kernel-doc markups for V4L2
video_device flags.
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/media/v4l2-dev.h | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/include/media/v4l2-dev.h b/include/media/v4l2-dev.h index ed5b513f5161..88773a67a806 100644 --- a/include/media/v4l2-dev.h +++ b/include/media/v4l2-dev.h @@ -62,12 +62,22 @@ struct video_device; struct v4l2_device; struct v4l2_ctrl_handler; -/* Flag to mark the video_device struct as registered. - Drivers can clear this flag if they want to block all future - device access. It is cleared by video_unregister_device. */ -#define V4L2_FL_REGISTERED (0) -/* file->private_data points to struct v4l2_fh */ -#define V4L2_FL_USES_V4L2_FH (1) +/** + * enum v4l2_video_device_flags - Flags used by &struct video_device + * + * @V4L2_FL_REGISTERED: + * indicates that a &struct video_device is registered. + * Drivers can clear this flag if they want to block all future + * device access. It is cleared by video_unregister_device. + * @V4L2_FL_USES_V4L2_FH: + * indicates that file->private_data points to &struct v4l2_fh. + * This flag is set by the core when v4l2_fh_init() is called. + * All new drivers should use it. + */ +enum v4l2_video_device_flags { + V4L2_FL_REGISTERED = 0, + V4L2_FL_USES_V4L2_FH = 1, +}; /* Priority helper functions */ @@ -215,7 +225,8 @@ struct v4l2_file_operations { * @vfl_dir: V4L receiver, transmitter or m2m * @minor: device node 'minor'. It is set to -1 if the registration failed * @num: number of the video device node - * @flags: video device flags. Use bitops to set/clear/test flags + * @flags: video device flags. Use bitops to set/clear/test flags. + * Contains a set of &enum v4l2_video_device_flags. * @index: attribute to differentiate multiple indices on one physical device * @fh_lock: Lock for all v4l2_fhs * @fh_list: List of &struct v4l2_fh |