Commit 75916fd2 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

[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: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent f2b9e8ac
...@@ -744,11 +744,13 @@ header can be used to get the timings of the formats in the <xref linkend="cea86 ...@@ -744,11 +744,13 @@ header can be used to get the timings of the formats in the <xref linkend="cea86
</para> </para>
</listitem> </listitem>
<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 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 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 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> </listitem>
</itemizedlist> </itemizedlist>
<para>To enumerate and query the attributes of the DV timings supported by a device, <para>To enumerate and query the attributes of the DV timings supported by a device,
......
...@@ -2602,6 +2602,10 @@ interfaces and should not be implemented in new drivers.</para> ...@@ -2602,6 +2602,10 @@ interfaces and should not be implemented in new drivers.</para>
<constant>VIDIOC_S_MPEGCOMP</constant> ioctls. Use Extended Controls, <constant>VIDIOC_S_MPEGCOMP</constant> ioctls. Use Extended Controls,
<xref linkend="extended-controls" />.</para> <xref linkend="extended-controls" />.</para>
</listitem> </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> <listitem>
<para><constant>VIDIOC_SUBDEV_G_CROP</constant> and <para><constant>VIDIOC_SUBDEV_G_CROP</constant> and
<constant>VIDIOC_SUBDEV_S_CROP</constant> ioctls. Use <constant>VIDIOC_SUBDEV_S_CROP</constant> ioctls. Use
......
...@@ -48,6 +48,12 @@ ...@@ -48,6 +48,12 @@
<refsect1> <refsect1>
<title>Description</title> <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 <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> 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. ioctls which take a pointer to a &v4l2-dv-preset; type as argument.
......
...@@ -49,6 +49,10 @@ input</refpurpose> ...@@ -49,6 +49,10 @@ input</refpurpose>
<refsect1> <refsect1>
<title>Description</title> <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 <para>The hardware may be able to detect the current DV preset
automatically, similar to sensing the video standard. To do so, applications automatically, similar to sensing the video standard. To do so, applications
call <constant> VIDIOC_QUERY_DV_PRESET</constant> with a pointer to a call <constant> VIDIOC_QUERY_DV_PRESET</constant> with a pointer to a
......
...@@ -944,6 +944,9 @@ struct v4l2_standard { ...@@ -944,6 +944,9 @@ struct v4l2_standard {
__u32 reserved[4]; __u32 reserved[4];
}; };
/* The DV Preset API is deprecated in favor of the DV Timings API.
New drivers shouldn't use this anymore! */
/* /*
* V I D E O T I M I N G S D V P R E S E T * V I D E O T I M I N G S D V P R E S E T
*/ */
...@@ -2608,6 +2611,9 @@ struct v4l2_create_buffers { ...@@ -2608,6 +2611,9 @@ struct v4l2_create_buffers {
#endif #endif
#define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek) #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
/* These four DV Preset ioctls are deprecated in favor of the DV Timings
ioctls. */
#define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset) #define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset)
#define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset) #define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset) #define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment