Re: [PATCH] V4L - Digital Video Timings API documentation
On Wednesday 18 November 2009 20:02:58 m-kariche...@ti.com wrote: From: Muralidharan Karicheri m-kariche...@ti.com Fixing a typo in the subject... This patch updates the v4l2-dvb documentation for the new video timings API added. Hi Murali, Here is my review: Signed-off-by: Muralidharan Karicheri m-kariche...@ti.com --- diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/common.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/common.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/common.xml 2009-11-12 09:21:05.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/common.xml 2009-11-18 12:13:34.0 -0500 @@ -716,6 +716,41 @@ } /programlisting /example + section id=dv-timings + titleDigital Video (DV) Timings/title + para + The video standards discussed so far has been dealing with Analog TV and the s/has/have/ +corresponding video timings. Today there are many more different hardware interfaces +such as High Definition TV interfaces (HDMI), VGA, DVI connectors etc., that carries s/carries/carry/ +video signals and there is a need to extend the API to allow settings video timings s/allow settings/select the/ + on these interfaces. Since it is not possible to extend the v4l2-std-id due to s/on/for/ +the limited bits available, a new set of IOCTLs are added to set/get video timings at +the input and output:- /paraitemizedlist Please use just ':' rather than ':-' and no spaces before the ':'. That applies to this whole patch. + listitem + para DV Presets :- Digital Video (DV) presets. These are IDs representing a +video timing at the input/output. Presets can be thought of pre-defined timings implemented s/can be thought of/are/ +by the hardware like standards. A __u32 data type is used to represent a preset unlike the s/like/according to video/ + bit mask that is used in v4l2-std-id; allowing future extensions to support many +different presets as needed/para s/needed/needed./ + /listitem + listitem + para Custom DV Timings :- This will allow applications to define a more detailed s/a more/more/ +custom video timings at the interface. This includes parameters such as width, height, + polarities, frontporch, backporch etc. + /para + /listitem + /itemizedlist + para To Enumerate and query the attributes of DV presets supported by a device, Don't capitalize 'Enumerate', 'Get', etc. It looks odd and there is no need for it. + applications use the VIDIOC-ENUM-DV-PRESETS; ioctl. To Get the current DV preset, + application use the VIDIOC-G-DV-PRESET; ioctl and to Set a preset it uses the + VIDIOC-S-DV-PRESET; ioctl./para + para To Set a Custom DV timings at the device, applications use the + VIDIOC-S-DV-TIMINGS; ioctl and to Get current Custom DV timings, it uses the + VIDIOC-G-DV-TIMINGS; ioctl./para + para Applications can make use of the xref linkend=input-capabilities / and +xref linkend=output-capabilities/ flags to decide what ioctls available to set the s/ioctls available/ioctls are available/ +video timings at the device./para s/at/for/ + /section /section sub-controls; diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/v4l2.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/v4l2.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/v4l2.xml 2009-11-12 09:21:05.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/v4l2.xml 2009-11-18 12:13:57.0 -0500 @@ -416,6 +416,10 @@ sub-enum-frameintervals; sub-enuminput; sub-enumoutput; +sub-enum-dv-presets; +sub-g-dv-preset; +sub-query-dv-preset; +sub-g-dv-timings; sub-enumstd; sub-g-audio; sub-g-audioout; diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml 1969-12-31 19:00:00.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml 2009-11-18 12:14:25.0 -0500 @@ -0,0 +1,167 @@ +refentry id=vidioc-enum-dv-presets + refmeta +refentrytitleioctl VIDIOC_ENUM_DV_PRESETS/refentrytitle +manvol; + /refmeta + + refnamediv +refnameVIDIOC_ENUM_DV_PRESETS/refname +refpurposeEnumerate supported Digital Video Presets/refpurpose + /refnamediv + + refsynopsisdiv +funcsynopsis + funcprototype + funcdefint functionioctl/function/funcdef + paramdefint parameterfd/parameter/paramdef + paramdefint parameterrequest/parameter/paramdef + paramdefstruct v4l2_dv_enum_preset *parameterargp/parameter/paramdef + /funcprototype +
[PATCH] V4L - Digital Video Timings API documentation
From: Muralidharan Karicheri m-kariche...@ti.com Fixing a typo in the subject... This patch updates the v4l2-dvb documentation for the new video timings API added. Signed-off-by: Muralidharan Karicheri m-kariche...@ti.com --- diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/common.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/common.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/common.xml 2009-11-12 09:21:05.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/common.xml 2009-11-18 12:13:34.0 -0500 @@ -716,6 +716,41 @@ } /programlisting /example + section id=dv-timings + titleDigital Video (DV) Timings/title + para + The video standards discussed so far has been dealing with Analog TV and the +corresponding video timings. Today there are many more different hardware interfaces +such as High Definition TV interfaces (HDMI), VGA, DVI connectors etc., that carries +video signals and there is a need to extend the API to allow settings video timings + on these interfaces. Since it is not possible to extend the v4l2-std-id due to +the limited bits available, a new set of IOCTLs are added to set/get video timings at +the input and output:- /paraitemizedlist + listitem + para DV Presets :- Digital Video (DV) presets. These are IDs representing a +video timing at the input/output. Presets can be thought of pre-defined timings implemented +by the hardware like standards. A __u32 data type is used to represent a preset unlike the + bit mask that is used in v4l2-std-id; allowing future extensions to support many +different presets as needed/para + /listitem + listitem + para Custom DV Timings :- This will allow applications to define a more detailed +custom video timings at the interface. This includes parameters such as width, height, + polarities, frontporch, backporch etc. + /para + /listitem + /itemizedlist + para To Enumerate and query the attributes of DV presets supported by a device, + applications use the VIDIOC-ENUM-DV-PRESETS; ioctl. To Get the current DV preset, + application use the VIDIOC-G-DV-PRESET; ioctl and to Set a preset it uses the + VIDIOC-S-DV-PRESET; ioctl./para + para To Set a Custom DV timings at the device, applications use the + VIDIOC-S-DV-TIMINGS; ioctl and to Get current Custom DV timings, it uses the + VIDIOC-G-DV-TIMINGS; ioctl./para + para Applications can make use of the xref linkend=input-capabilities / and +xref linkend=output-capabilities/ flags to decide what ioctls available to set the +video timings at the device./para + /section /section sub-controls; diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/v4l2.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/v4l2.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/v4l2.xml 2009-11-12 09:21:05.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/v4l2.xml 2009-11-18 12:13:57.0 -0500 @@ -416,6 +416,10 @@ sub-enum-frameintervals; sub-enuminput; sub-enumoutput; +sub-enum-dv-presets; +sub-g-dv-preset; +sub-query-dv-preset; +sub-g-dv-timings; sub-enumstd; sub-g-audio; sub-g-audioout; diff -uNr v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml --- v4l-dvb-aba823ecaea6/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml 1969-12-31 19:00:00.0 -0500 +++ v4l-dvb-aba823ecaea6_new/linux/Documentation/DocBook/v4l/vidioc-enum-dv-presets.xml 2009-11-18 12:14:25.0 -0500 @@ -0,0 +1,167 @@ +refentry id=vidioc-enum-dv-presets + refmeta +refentrytitleioctl VIDIOC_ENUM_DV_PRESETS/refentrytitle +manvol; + /refmeta + + refnamediv +refnameVIDIOC_ENUM_DV_PRESETS/refname +refpurposeEnumerate supported Digital Video Presets/refpurpose + /refnamediv + + refsynopsisdiv +funcsynopsis + funcprototype + funcdefint functionioctl/function/funcdef + paramdefint parameterfd/parameter/paramdef + paramdefint parameterrequest/parameter/paramdef + paramdefstruct v4l2_dv_enum_preset *parameterargp/parameter/paramdef + /funcprototype +/funcsynopsis + /refsynopsisdiv + + refsect1 +titleArguments/title + +variablelist + varlistentry + termparameterfd/parameter/term + listitem + parafd;/para + /listitem + /varlistentry + varlistentry + termparameterrequest/parameter/term + listitem + paraVIDIOC_ENUM_DV_PRESETS/para + /listitem + /varlistentry + varlistentry + termparameterargp/parameter/term + listitem + para/para + /listitem + /varlistentry +/variablelist + /refsect1 + + refsect1 +titleDescription/title + +
