提交 506bb54b 编写于 作者: M Mauro Carvalho Chehab

[media] v4l-dv-timings.h: Add to device-drivers DocBook

There are already markups for documentation at v4l-dv-timings.h,
however, they're not properly formatted.

Convert them to the right format and add this file to
the device-drivers DocBook.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: NJonathan Corbet <corbet@lwn.net>
上级 b6fce850
...@@ -233,8 +233,8 @@ X!Isound/sound_firmware.c ...@@ -233,8 +233,8 @@ X!Isound/sound_firmware.c
!Idrivers/media/dvb-core/dvb_ringbuffer.h !Idrivers/media/dvb-core/dvb_ringbuffer.h
!Iinclude/media/v4l2-ctrls.h !Iinclude/media/v4l2-ctrls.h
!Iinclude/media/v4l2-event.h !Iinclude/media/v4l2-event.h
!Iinclude/media/v4l2-dv-timings.h
<!-- FIXME: Removed for now due to document generation inconsistency <!-- FIXME: Removed for now due to document generation inconsistency
X!Iinclude/media/v4l2-dv-timings.h
X!Iinclude/media/v4l2-mediabus.h X!Iinclude/media/v4l2-mediabus.h
X!Iinclude/media/videobuf2-memops.h X!Iinclude/media/videobuf2-memops.h
X!Iinclude/media/videobuf2-core.h X!Iinclude/media/videobuf2-core.h
......
...@@ -23,11 +23,14 @@ ...@@ -23,11 +23,14 @@
#include <linux/videodev2.h> #include <linux/videodev2.h>
/** v4l2_dv_timings_presets: list of all dv_timings presets. /**
* v4l2_dv_timings_presets: list of all dv_timings presets.
*/ */
extern const struct v4l2_dv_timings v4l2_dv_timings_presets[]; extern const struct v4l2_dv_timings v4l2_dv_timings_presets[];
/** v4l2_check_dv_timings_fnc - timings check callback /**
* v4l2_check_dv_timings_fnc - timings check callback
*
* @t: the v4l2_dv_timings struct. * @t: the v4l2_dv_timings struct.
* @handle: a handle from the driver. * @handle: a handle from the driver.
* *
...@@ -35,7 +38,9 @@ extern const struct v4l2_dv_timings v4l2_dv_timings_presets[]; ...@@ -35,7 +38,9 @@ extern const struct v4l2_dv_timings v4l2_dv_timings_presets[];
*/ */
typedef bool v4l2_check_dv_timings_fnc(const struct v4l2_dv_timings *t, void *handle); typedef bool v4l2_check_dv_timings_fnc(const struct v4l2_dv_timings *t, void *handle);
/** v4l2_valid_dv_timings() - are these timings valid? /**
* v4l2_valid_dv_timings() - are these timings valid?
*
* @t: the v4l2_dv_timings struct. * @t: the v4l2_dv_timings struct.
* @cap: the v4l2_dv_timings_cap capabilities. * @cap: the v4l2_dv_timings_cap capabilities.
* @fnc: callback to check if this timing is OK. May be NULL. * @fnc: callback to check if this timing is OK. May be NULL.
...@@ -50,7 +55,10 @@ bool v4l2_valid_dv_timings(const struct v4l2_dv_timings *t, ...@@ -50,7 +55,10 @@ bool v4l2_valid_dv_timings(const struct v4l2_dv_timings *t,
v4l2_check_dv_timings_fnc fnc, v4l2_check_dv_timings_fnc fnc,
void *fnc_handle); void *fnc_handle);
/** v4l2_enum_dv_timings_cap() - Helper function to enumerate possible DV timings based on capabilities /**
* v4l2_enum_dv_timings_cap() - Helper function to enumerate possible DV
* timings based on capabilities
*
* @t: the v4l2_enum_dv_timings struct. * @t: the v4l2_enum_dv_timings struct.
* @cap: the v4l2_dv_timings_cap capabilities. * @cap: the v4l2_dv_timings_cap capabilities.
* @fnc: callback to check if this timing is OK. May be NULL. * @fnc: callback to check if this timing is OK. May be NULL.
...@@ -68,7 +76,9 @@ int v4l2_enum_dv_timings_cap(struct v4l2_enum_dv_timings *t, ...@@ -68,7 +76,9 @@ int v4l2_enum_dv_timings_cap(struct v4l2_enum_dv_timings *t,
v4l2_check_dv_timings_fnc fnc, v4l2_check_dv_timings_fnc fnc,
void *fnc_handle); void *fnc_handle);
/** v4l2_find_dv_timings_cap() - Find the closest timings struct /**
* v4l2_find_dv_timings_cap() - Find the closest timings struct
*
* @t: the v4l2_enum_dv_timings struct. * @t: the v4l2_enum_dv_timings struct.
* @cap: the v4l2_dv_timings_cap capabilities. * @cap: the v4l2_dv_timings_cap capabilities.
* @pclock_delta: maximum delta between t->pixelclock and the timing struct * @pclock_delta: maximum delta between t->pixelclock and the timing struct
...@@ -90,7 +100,9 @@ bool v4l2_find_dv_timings_cap(struct v4l2_dv_timings *t, ...@@ -90,7 +100,9 @@ bool v4l2_find_dv_timings_cap(struct v4l2_dv_timings *t,
v4l2_check_dv_timings_fnc fnc, v4l2_check_dv_timings_fnc fnc,
void *fnc_handle); void *fnc_handle);
/** v4l2_match_dv_timings() - do two timings match? /**
* v4l2_match_dv_timings() - do two timings match?
*
* @measured: the measured timings data. * @measured: the measured timings data.
* @standard: the timings according to the standard. * @standard: the timings according to the standard.
* @pclock_delta: maximum delta in Hz between standard->pixelclock and * @pclock_delta: maximum delta in Hz between standard->pixelclock and
...@@ -102,7 +114,8 @@ bool v4l2_match_dv_timings(const struct v4l2_dv_timings *measured, ...@@ -102,7 +114,8 @@ bool v4l2_match_dv_timings(const struct v4l2_dv_timings *measured,
const struct v4l2_dv_timings *standard, const struct v4l2_dv_timings *standard,
unsigned pclock_delta); unsigned pclock_delta);
/** v4l2_print_dv_timings() - log the contents of a dv_timings struct /**
* v4l2_print_dv_timings() - log the contents of a dv_timings struct
* @dev_prefix:device prefix for each log line. * @dev_prefix:device prefix for each log line.
* @prefix: additional prefix for each log line, may be NULL. * @prefix: additional prefix for each log line, may be NULL.
* @t: the timings data. * @t: the timings data.
...@@ -111,7 +124,9 @@ bool v4l2_match_dv_timings(const struct v4l2_dv_timings *measured, ...@@ -111,7 +124,9 @@ bool v4l2_match_dv_timings(const struct v4l2_dv_timings *measured,
void v4l2_print_dv_timings(const char *dev_prefix, const char *prefix, void v4l2_print_dv_timings(const char *dev_prefix, const char *prefix,
const struct v4l2_dv_timings *t, bool detailed); const struct v4l2_dv_timings *t, bool detailed);
/** v4l2_detect_cvt - detect if the given timings follow the CVT standard /**
* v4l2_detect_cvt - detect if the given timings follow the CVT standard
*
* @frame_height - the total height of the frame (including blanking) in lines. * @frame_height - the total height of the frame (including blanking) in lines.
* @hfreq - the horizontal frequency in Hz. * @hfreq - the horizontal frequency in Hz.
* @vsync - the height of the vertical sync in lines. * @vsync - the height of the vertical sync in lines.
...@@ -131,7 +146,9 @@ bool v4l2_detect_cvt(unsigned frame_height, unsigned hfreq, unsigned vsync, ...@@ -131,7 +146,9 @@ bool v4l2_detect_cvt(unsigned frame_height, unsigned hfreq, unsigned vsync,
unsigned active_width, u32 polarities, bool interlaced, unsigned active_width, u32 polarities, bool interlaced,
struct v4l2_dv_timings *fmt); struct v4l2_dv_timings *fmt);
/** v4l2_detect_gtf - detect if the given timings follow the GTF standard /**
* v4l2_detect_gtf - detect if the given timings follow the GTF standard
*
* @frame_height - the total height of the frame (including blanking) in lines. * @frame_height - the total height of the frame (including blanking) in lines.
* @hfreq - the horizontal frequency in Hz. * @hfreq - the horizontal frequency in Hz.
* @vsync - the height of the vertical sync in lines. * @vsync - the height of the vertical sync in lines.
...@@ -153,8 +170,10 @@ bool v4l2_detect_gtf(unsigned frame_height, unsigned hfreq, unsigned vsync, ...@@ -153,8 +170,10 @@ bool v4l2_detect_gtf(unsigned frame_height, unsigned hfreq, unsigned vsync,
u32 polarities, bool interlaced, struct v4l2_fract aspect, u32 polarities, bool interlaced, struct v4l2_fract aspect,
struct v4l2_dv_timings *fmt); struct v4l2_dv_timings *fmt);
/** v4l2_calc_aspect_ratio - calculate the aspect ratio based on bytes /**
* v4l2_calc_aspect_ratio - calculate the aspect ratio based on bytes
* 0x15 and 0x16 from the EDID. * 0x15 and 0x16 from the EDID.
*
* @hor_landscape - byte 0x15 from the EDID. * @hor_landscape - byte 0x15 from the EDID.
* @vert_portrait - byte 0x16 from the EDID. * @vert_portrait - byte 0x16 from the EDID.
* *
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册