Commit 63b31ffd authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: v4l2-dev: document video_device flags 



Convert #defines to enums and add kernel-doc markups for V4L2
video_device flags.

Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 468fde0b

include/media/v4l2-dev.h

+18 −7
Original line number Original line Diff line number Diff line
@@ -62,12 +62,22 @@ struct video_device; 
struct v4l2_device;

struct v4l2_device;

struct v4l2_ctrl_handler;

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

 * enum v4l2_video_device_flags - Flags used by &struct video_device

   device access. It is cleared by video_unregister_device. */

 *

#define V4L2_FL_REGISTERED	(0)

 * @V4L2_FL_REGISTERED:

/* file->private_data points to struct v4l2_fh */

 * 	indicates that a &struct video_device is registered.

#define V4L2_FL_USES_V4L2_FH	(1)

 *	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 */

/* Priority helper functions */
@@ -215,7 +225,8 @@ struct v4l2_file_operations { 
 * @vfl_dir: V4L receiver, transmitter or m2m

 * @vfl_dir: V4L receiver, transmitter or m2m

 * @minor: device node 'minor'. It is set to -1 if the registration failed

 * @minor: device node 'minor'. It is set to -1 if the registration failed

 * @num: number of the video device node

 * @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

 * @index: attribute to differentiate multiple indices on one physical device

 * @fh_lock: Lock for all v4l2_fhs

 * @fh_lock: Lock for all v4l2_fhs

 * @fh_list: List of &struct v4l2_fh

 * @fh_list: List of &struct v4l2_fh