Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 098cbc38 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] DocBook/media/v4l: remove the documentation of the obsolete dv_preset API 



This API is no longer used by any driver and so can be removed from the
documentation.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 02fa6282

Documentation/DocBook/media/v4l/common.xml

+0 −14
Original line number Diff line number Diff line
@@ -749,15 +749,6 @@ polarities, frontporch, backporch etc. The <filename>linux/v4l2-dv-timings.h</fi 
header can be used to get the timings of the formats in the <xref linkend="cea861" /> and

<xref linkend="vesadmt" /> standards.

	</para>

	</listitem>

	<listitem>

	<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. 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,
@@ -766,11 +757,6 @@ API.</para> 
&VIDIOC-S-DV-TIMINGS; ioctl and to get current DV timings they use the

&VIDIOC-G-DV-TIMINGS; ioctl. To detect the DV timings as seen by the video receiver applications

use the &VIDIOC-QUERY-DV-TIMINGS; ioctl.</para>

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

applications use the &VIDIOC-G-DV-PRESET; ioctl and to set a preset they use the

&VIDIOC-S-DV-PRESET; ioctl. To detect the preset as seen by the video receiver applications

use the &VIDIOC-QUERY-DV-PRESET; ioctl.</para>

	<para>Applications can make use of the <xref linkend="input-capabilities" /> and

<xref linkend="output-capabilities"/> flags to decide what ioctls are available to set the

video timings for the device.</para>

Documentation/DocBook/media/v4l/compat.xml

+2 −2
Original line number Diff line number Diff line
@@ -2625,8 +2625,8 @@ 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>

	  <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

Documentation/DocBook/media/v4l/v4l2.xml

+0 −3
Original line number Diff line number Diff line
@@ -544,7 +544,6 @@ and discussions on the V4L mailing list.</revremark> 
    &sub-encoder-cmd;

    &sub-enumaudio;

    &sub-enumaudioout;

    &sub-enum-dv-presets;

    &sub-enum-dv-timings;

    &sub-enum-fmt;

    &sub-enum-framesizes;
@@ -558,7 +557,6 @@ and discussions on the V4L mailing list.</revremark> 
    &sub-g-audioout;

    &sub-g-crop;

    &sub-g-ctrl;

    &sub-g-dv-preset;

    &sub-g-dv-timings;

    &sub-g-enc-index;

    &sub-g-ext-ctrls;
@@ -582,7 +580,6 @@ and discussions on the V4L mailing list.</revremark> 
    &sub-querybuf;

    &sub-querycap;

    &sub-queryctrl;

    &sub-query-dv-preset;

    &sub-query-dv-timings;

    &sub-querystd;

    &sub-reqbufs;

Documentation/DocBook/media/v4l/vidioc-enum-dv-presets.xml

deleted100644 → 0
+0 −240
Original line number Diff line number Diff line 
<refentry id="vidioc-enum-dv-presets">

  <refmeta>

    <refentrytitle>ioctl VIDIOC_ENUM_DV_PRESETS</refentrytitle>

    &manvol;

  </refmeta>



  <refnamediv>

    <refname>VIDIOC_ENUM_DV_PRESETS</refname>

    <refpurpose>Enumerate supported Digital Video presets</refpurpose>

  </refnamediv>



  <refsynopsisdiv>

    <funcsynopsis>

      <funcprototype>

	<funcdef>int <function>ioctl</function></funcdef>

	<paramdef>int <parameter>fd</parameter></paramdef>

	<paramdef>int <parameter>request</parameter></paramdef>

	<paramdef>struct v4l2_dv_enum_preset *<parameter>argp</parameter></paramdef>

      </funcprototype>

    </funcsynopsis>

  </refsynopsisdiv>



  <refsect1>

    <title>Arguments</title>



    <variablelist>

      <varlistentry>

	<term><parameter>fd</parameter></term>

	<listitem>

	  <para>&fd;</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><parameter>request</parameter></term>

	<listitem>

	  <para>VIDIOC_ENUM_DV_PRESETS</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><parameter>argp</parameter></term>

	<listitem>

	  <para></para>

	</listitem>

      </varlistentry>

    </variablelist>

  </refsect1>



  <refsect1>

    <title>Description</title>



    <para>This ioctl is <emphasis role="bold">deprecated</emphasis>.

    New drivers and applications should use &VIDIOC-ENUM-DV-TIMINGS; instead.

    </para>



    <para>To query the attributes of a DV preset, applications initialize the

<structfield>index</structfield> field and zero the reserved array of &v4l2-dv-enum-preset;

and call the <constant>VIDIOC_ENUM_DV_PRESETS</constant> ioctl with a pointer to this

structure. Drivers fill the rest of the structure or return an

&EINVAL; when the index is out of bounds. To enumerate all DV Presets supported,

applications shall begin at index zero, incrementing by one until the

driver returns <errorcode>EINVAL</errorcode>. Drivers may enumerate a

different set of DV presets after switching the video input or

output.</para>



    <table pgwide="1" frame="none" id="v4l2-dv-enum-preset">

      <title>struct <structname>v4l2_dv_enum_presets</structname></title>

      <tgroup cols="3">

	&cs-str;

	<tbody valign="top">

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>index</structfield></entry>

	    <entry>Number of the DV preset, set by the

application.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>preset</structfield></entry>

	    <entry>This field identifies one of the DV preset values listed in <xref linkend="v4l2-dv-presets-vals"/>.</entry>

	  </row>

	  <row>

	    <entry>__u8</entry>

	    <entry><structfield>name</structfield>[24]</entry>

	    <entry>Name of the preset, a NUL-terminated ASCII string, for example: "720P-60", "1080I-60". This information is

intended for the user.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>width</structfield></entry>

	    <entry>Width of the active video in pixels for the DV preset.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>height</structfield></entry>

	    <entry>Height of the active video in lines for the DV preset.</entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>reserved</structfield>[4]</entry>

	    <entry>Reserved for future extensions. Drivers must set the array to zero.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table pgwide="1" frame="none" id="v4l2-dv-presets-vals">

      <title>struct <structname>DV Presets</structname></title>

      <tgroup cols="3">

	&cs-str;

	<tbody valign="top">

	  <row>

	    <entry>Preset</entry>

	    <entry>Preset value</entry>

	    <entry>Description</entry>

	  </row>

	  <row>

	    <entry></entry>

	    <entry></entry>

	    <entry></entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_INVALID</entry>

	    <entry>0</entry>

	    <entry>Invalid preset value.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_480P59_94</entry>

	    <entry>1</entry>

	    <entry>720x480 progressive video at 59.94 fps as per BT.1362.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_576P50</entry>

	    <entry>2</entry>

	    <entry>720x576 progressive video at 50 fps as per BT.1362.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P24</entry>

	    <entry>3</entry>

	    <entry>1280x720 progressive video at 24 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P25</entry>

	    <entry>4</entry>

	    <entry>1280x720 progressive video at 25 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P30</entry>

	    <entry>5</entry>

	    <entry>1280x720 progressive video at 30 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P50</entry>

	    <entry>6</entry>

	    <entry>1280x720 progressive video at 50 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P59_94</entry>

	    <entry>7</entry>

	    <entry>1280x720 progressive video at 59.94 fps as per SMPTE 274M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_720P60</entry>

	    <entry>8</entry>

	    <entry>1280x720 progressive video at 60 fps as per SMPTE 274M/296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080I29_97</entry>

	    <entry>9</entry>

	    <entry>1920x1080 interlaced video at 29.97 fps as per BT.1120/SMPTE 274M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080I30</entry>

	    <entry>10</entry>

	    <entry>1920x1080 interlaced video at 30 fps as per BT.1120/SMPTE 274M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080I25</entry>

	    <entry>11</entry>

	    <entry>1920x1080 interlaced video at 25 fps as per BT.1120.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080I50</entry>

	    <entry>12</entry>

	    <entry>1920x1080 interlaced video at 50 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080I60</entry>

	    <entry>13</entry>

	    <entry>1920x1080 interlaced video at 60 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080P24</entry>

	    <entry>14</entry>

	    <entry>1920x1080 progressive video at 24 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080P25</entry>

	    <entry>15</entry>

	    <entry>1920x1080 progressive video at 25 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080P30</entry>

	    <entry>16</entry>

	    <entry>1920x1080 progressive video at 30 fps as per SMPTE 296M.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080P50</entry>

	    <entry>17</entry>

	    <entry>1920x1080 progressive video at 50 fps as per BT.1120.</entry>

	  </row>

	  <row>

	    <entry>V4L2_DV_1080P60</entry>

	    <entry>18</entry>

	    <entry>1920x1080 progressive video at 60 fps as per BT.1120.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>

  </refsect1>



  <refsect1>

    &return-value;



    <variablelist>

      <varlistentry>

	<term><errorcode>EINVAL</errorcode></term>

	<listitem>

	  <para>The &v4l2-dv-enum-preset; <structfield>index</structfield>

is out of bounds.</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><errorcode>ENODATA</errorcode></term>

	<listitem>

	  <para>Digital video presets are not supported for this input or output.</para>

	</listitem>

      </varlistentry>

    </variablelist>

  </refsect1>

</refentry>

Documentation/DocBook/media/v4l/vidioc-enuminput.xml

+0 −5
Original line number Diff line number Diff line
@@ -277,11 +277,6 @@ input/output interface to linux-media@vger.kernel.org on 19 Oct 2009. 
      <tgroup cols="3">

	&cs-def;

	<tbody valign="top">

	  <row>

	    <entry><constant>V4L2_IN_CAP_PRESETS</constant></entry>

	    <entry>0x00000001</entry>

	    <entry>This input supports setting DV presets by using VIDIOC_S_DV_PRESET.</entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_IN_CAP_DV_TIMINGS</constant></entry>

	    <entry>0x00000002</entry>