Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[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>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
75916fd2 f2b9e8ac

+24 -2
+4 -2
Documentation/DocBook/media/v4l/common.xml
··· 744 744 </para> 745 745 </listitem> 746 746 <listitem> 747 - <para>DV Presets: Digital Video (DV) presets. These are IDs representing a 747 + <para>DV Presets: Digital Video (DV) presets (<emphasis role="bold">deprecated</emphasis>). 748 + These are IDs representing a 748 749 video timing at the input/output. Presets are pre-defined timings implemented 749 750 by the hardware according to video standards. A __u32 data type is used to represent 750 751 a preset unlike the bit mask that is used in &v4l2-std-id; allowing future extensions 751 - to support as many different presets as needed.</para> 752 + to support as many different presets as needed. This API is deprecated in favor of the DV Timings 753 + API.</para> 752 754 </listitem> 753 755 </itemizedlist> 754 756 <para>To enumerate and query the attributes of the DV timings supported by a device,
+4
Documentation/DocBook/media/v4l/compat.xml
··· 2603 2603 <xref linkend="extended-controls" />.</para> 2604 2604 </listitem> 2605 2605 <listitem> 2606 + <para>&VIDIOC-G-DV-PRESET;, &VIDIOC-S-DV-PRESET;, &VIDIOC-ENUM-DV-PRESETS; and 2607 + &VIDIOC-QUERY-DV-PRESET; ioctls. Use the DV Timings API (<xref linkend="dv-timings" />).</para> 2608 + </listitem> 2609 + <listitem> 2606 2610 <para><constant>VIDIOC_SUBDEV_G_CROP</constant> and 2607 2611 <constant>VIDIOC_SUBDEV_S_CROP</constant> ioctls. Use 2608 2612 <constant>VIDIOC_SUBDEV_G_SELECTION</constant> and
+6
Documentation/DocBook/media/v4l/vidioc-g-dv-preset.xml
··· 48 48 49 49 <refsect1> 50 50 <title>Description</title> 51 + 52 + <para>These ioctls are <emphasis role="bold">deprecated</emphasis>. 53 + New drivers and applications should use &VIDIOC-G-DV-TIMINGS; and &VIDIOC-S-DV-TIMINGS; 54 + instead. 55 + </para> 56 + 51 57 <para>To query and select the current DV preset, applications 52 58 use the <constant>VIDIOC_G_DV_PRESET</constant> and <constant>VIDIOC_S_DV_PRESET</constant> 53 59 ioctls which take a pointer to a &v4l2-dv-preset; type as argument.
+4
Documentation/DocBook/media/v4l/vidioc-query-dv-preset.xml
··· 49 49 <refsect1> 50 50 <title>Description</title> 51 51 52 + <para>This ioctl is <emphasis role="bold">deprecated</emphasis>. 53 + New drivers and applications should use &VIDIOC-QUERY-DV-TIMINGS; instead. 54 + </para> 55 + 52 56 <para>The hardware may be able to detect the current DV preset 53 57 automatically, similar to sensing the video standard. To do so, applications 54 58 call <constant> VIDIOC_QUERY_DV_PRESET</constant> with a pointer to a
+6
include/linux/videodev2.h
··· 944 944 __u32 reserved[4]; 945 945 }; 946 946 947 + /* The DV Preset API is deprecated in favor of the DV Timings API. 948 + New drivers shouldn't use this anymore! */ 949 + 947 950 /* 948 951 * V I D E O T I M I N G S D V P R E S E T 949 952 */ ··· 2611 2608 #endif 2612 2609 2613 2610 #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek) 2611 + 2612 + /* These four DV Preset ioctls are deprecated in favor of the DV Timings 2613 + ioctls. */ 2614 2614 #define VIDIOC_ENUM_DV_PRESETS _IOWR('V', 83, struct v4l2_dv_enum_preset) 2615 2615 #define VIDIOC_S_DV_PRESET _IOWR('V', 84, struct v4l2_dv_preset) 2616 2616 #define VIDIOC_G_DV_PRESET _IOWR('V', 85, struct v4l2_dv_preset)