Skip to content

Commit

Permalink
[media] V4L2: Mark the DV Preset API as deprecated
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Hans Verkuil authored and Mauro Carvalho Chehab committed May 20, 2012
1 parent f2b9e8a commit 75916fd
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Documentation/DocBook/media/v4l/common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 4 additions & 0 deletions Documentation/DocBook/media/v4l/compat.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2602,6 +2602,10 @@ interfaces and should not be implemented in new drivers.</para>
<constant>VIDIOC_S_MPEGCOMP</constant> ioctls. Use Extended Controls,
<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
Expand Down
6 changes: 6 additions & 0 deletions Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions include/linux/videodev2.h
Original file line number Diff line number Diff line change
Expand Up @@ -944,6 +944,9 @@ struct v4l2_standard {
__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
*/
Expand Down Expand Up @@ -2608,6 +2611,9 @@ struct v4l2_create_buffers {
#endif

#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_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset)
#define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)
Expand Down

0 comments on commit 75916fd

Please sign in to comment.