diff options
| author | Hans Verkuil <hans.verkuil@cisco.com> | 2012-05-01 05:29:07 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-05-20 08:31:52 -0300 |
| commit | 75916fd279323fd1b1636625a127838962677dfd (patch) | |
| tree | a656c25d0da35921eb85e6021426bd65401001d0 /Documentation | |
| parent | f2b9e8acaa5555afac53f3d5490fa89506df37a2 (diff) | |
[media] V4L2: Mark the DV Preset API as deprecated
The DV Preset API will be phased out in favor of the more flexible DV Timings
API. Mark the preset API accordingly in the header and documentation.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation')
4 files changed, 18 insertions, 2 deletions
diff --git a/Documentation/DocBook/media/v4l/common.xml b/Documentation/DocBook/media/v4l/common.xml index 81b7cf384a3..4101aeb5654 100644 --- a/Documentation/DocBook/media/v4l/common.xml +++ b/Documentation/DocBook/media/v4l/common.xml @@ -744,11 +744,13 @@ header can be used to get the timings of the formats in the <xref linkend="cea86 </para> </listitem> <listitem> - <para>DV Presets: Digital Video (DV) presets. These are IDs representing a + <para>DV Presets: Digital Video (DV) presets (<emphasis role="bold">deprecated</emphasis>). + These are IDs representing a video timing at the input/output. Presets are pre-defined timings implemented by the hardware according to video 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 as many different presets as needed.</para> +to support as many different presets as needed. This API is deprecated in favor of the DV Timings +API.</para> </listitem> </itemizedlist> <para>To enumerate and query the attributes of the DV timings supported by a device, diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index cd19d21085d..ea42ef82494 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml @@ -2603,6 +2603,10 @@ interfaces and should not be implemented in new drivers.</para> <xref linkend="extended-controls" />.</para> </listitem> <listitem> + <para>&VIDIOC-G-DV-PRESET;, &VIDIOC-S-DV-PRESET;, &VIDIOC-ENUM-DV-PRESETS; and + &VIDIOC-QUERY-DV-PRESET; ioctls. Use the DV Timings API (<xref linkend="dv-timings" />).</para> + </listitem> + <listitem> <para><constant>VIDIOC_SUBDEV_G_CROP</constant> and <constant>VIDIOC_SUBDEV_S_CROP</constant> ioctls. Use <constant>VIDIOC_SUBDEV_G_SELECTION</constant> and diff --git a/Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml b/Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml index 7940c114939..61be9fa3803 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml @@ -48,6 +48,12 @@ <refsect1> <title>Description</title> + + <para>These ioctls are <emphasis role="bold">deprecated</emphasis>. + New drivers and applications should use &VIDIOC-G-DV-TIMINGS; and &VIDIOC-S-DV-TIMINGS; + instead. + </para> + <para>To query and select the current DV preset, applications use the <constant>VIDIOC_G_DV_PRESET</constant> and <constant>VIDIOC_S_DV_PRESET</constant> ioctls which take a pointer to a &v4l2-dv-preset; type as argument. diff --git a/Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml b/Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml index 23b17f60421..1bc8aeb3ff1 100644 --- a/Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml +++ b/Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml @@ -49,6 +49,10 @@ input</refpurpose> <refsect1> <title>Description</title> + <para>This ioctl is <emphasis role="bold">deprecated</emphasis>. + New drivers and applications should use &VIDIOC-QUERY-DV-TIMINGS; instead. + </para> + <para>The hardware may be able to detect the current DV preset automatically, similar to sensing the video standard. To do so, applications call <constant> VIDIOC_QUERY_DV_PRESET</constant> with a pointer to a |