Commit 079dda54 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

[media] DocBook media: drop 'experimental' annotations

Drop the 'experimental' annotations. The only remaining part of the API
that is still marked 'experimental' are the debug ioctls/structs, and
that is intentional. Only the v4l2-dbg application should use those.

All others have been around for years, so it is time to drop the
'experimental' designation.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 57c75987
...@@ -2685,10 +2685,6 @@ hardware may support both.</para> ...@@ -2685,10 +2685,6 @@ hardware may support both.</para>
and may change in the future.</para> and may change in the future.</para>
<itemizedlist> <itemizedlist>
<listitem>
<para>Video Output Overlay (OSD) Interface, <xref
linkend="osd" />.</para>
</listitem>
<listitem> <listitem>
<para>&VIDIOC-DBG-G-REGISTER; and &VIDIOC-DBG-S-REGISTER; <para>&VIDIOC-DBG-G-REGISTER; and &VIDIOC-DBG-S-REGISTER;
ioctls.</para> ioctls.</para>
...@@ -2696,40 +2692,6 @@ ioctls.</para> ...@@ -2696,40 +2692,6 @@ ioctls.</para>
<listitem> <listitem>
<para>&VIDIOC-DBG-G-CHIP-INFO; ioctl.</para> <para>&VIDIOC-DBG-G-CHIP-INFO; ioctl.</para>
</listitem> </listitem>
<listitem>
<para>&VIDIOC-ENUM-DV-TIMINGS;, &VIDIOC-QUERY-DV-TIMINGS; and
&VIDIOC-DV-TIMINGS-CAP; ioctls.</para>
</listitem>
<listitem>
<para>Flash API. <xref linkend="flash-controls" /></para>
</listitem>
<listitem>
<para>&VIDIOC-CREATE-BUFS; and &VIDIOC-PREPARE-BUF; ioctls.</para>
</listitem>
<listitem>
<para>Selection API. <xref linkend="selection-api" /></para>
</listitem>
<listitem>
<para>Sub-device selection API: &VIDIOC-SUBDEV-G-SELECTION;
and &VIDIOC-SUBDEV-S-SELECTION; ioctls.</para>
</listitem>
<listitem>
<para>Support for frequency band enumeration: &VIDIOC-ENUM-FREQ-BANDS; ioctl.</para>
</listitem>
<listitem>
<para>Vendor and device specific media bus pixel formats.
<xref linkend="v4l2-mbus-vendor-spec-fmts" />.</para>
</listitem>
<listitem>
<para>Importing DMABUF file descriptors as a new IO method described
in <xref linkend="dmabuf" />.</para>
</listitem>
<listitem>
<para>Exporting DMABUF files using &VIDIOC-EXPBUF; ioctl.</para>
</listitem>
<listitem>
<para>Software Defined Radio (SDR) Interface, <xref linkend="sdr" />.</para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>
......
...@@ -4272,13 +4272,6 @@ manually or automatically if set to zero. Unit, range and step are driver-specif ...@@ -4272,13 +4272,6 @@ manually or automatically if set to zero. Unit, range and step are driver-specif
<section id="flash-controls"> <section id="flash-controls">
<title>Flash Control Reference</title> <title>Flash Control Reference</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para> <para>
The V4L2 flash controls are intended to provide generic access The V4L2 flash controls are intended to provide generic access
to flash controller devices. Flash controller devices are to flash controller devices. Flash controller devices are
...@@ -4743,14 +4736,6 @@ interface and may change in the future.</para> ...@@ -4743,14 +4736,6 @@ interface and may change in the future.</para>
<section id="image-source-controls"> <section id="image-source-controls">
<title>Image Source Control Reference</title> <title>Image Source Control Reference</title>
<note>
<title>Experimental</title>
<para>This is an <link
linkend="experimental">experimental</link> interface and may
change in the future.</para>
</note>
<para> <para>
The Image Source control class is intended for low-level The Image Source control class is intended for low-level
control of image source devices such as image sensors. The control of image source devices such as image sensors. The
...@@ -4862,14 +4847,6 @@ interface and may change in the future.</para> ...@@ -4862,14 +4847,6 @@ interface and may change in the future.</para>
<section id="image-process-controls"> <section id="image-process-controls">
<title>Image Process Control Reference</title> <title>Image Process Control Reference</title>
<note>
<title>Experimental</title>
<para>This is an <link
linkend="experimental">experimental</link> interface and may
change in the future.</para>
</note>
<para> <para>
The Image Process control class is intended for low-level control of The Image Process control class is intended for low-level control of
image processing functions. Unlike image processing functions. Unlike
...@@ -4955,14 +4932,6 @@ interface and may change in the future.</para> ...@@ -4955,14 +4932,6 @@ interface and may change in the future.</para>
<section id="dv-controls"> <section id="dv-controls">
<title>Digital Video Control Reference</title> <title>Digital Video Control Reference</title>
<note>
<title>Experimental</title>
<para>This is an <link
linkend="experimental">experimental</link> interface and may
change in the future.</para>
</note>
<para> <para>
The Digital Video control class is intended to control receivers The Digital Video control class is intended to control receivers
and transmitters for <ulink url="http://en.wikipedia.org/wiki/Vga">VGA</ulink>, and transmitters for <ulink url="http://en.wikipedia.org/wiki/Vga">VGA</ulink>,
......
<title>Software Defined Radio Interface (SDR)</title> <title>Software Defined Radio Interface (SDR)</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para> <para>
SDR is an abbreviation of Software Defined Radio, the radio device SDR is an abbreviation of Software Defined Radio, the radio device
which uses application software for modulation or demodulation. This interface which uses application software for modulation or demodulation. This interface
......
<title>Sub-device Interface</title> <title>Sub-device Interface</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>The complex nature of V4L2 devices, where hardware is often made of <para>The complex nature of V4L2 devices, where hardware is often made of
several integrated circuits that need to interact with each other in a several integrated circuits that need to interact with each other in a
controlled way, leads to complex V4L2 drivers. The drivers usually reflect controlled way, leads to complex V4L2 drivers. The drivers usually reflect
......
...@@ -475,12 +475,6 @@ rest should be evident.</para> ...@@ -475,12 +475,6 @@ rest should be evident.</para>
<section id="dmabuf"> <section id="dmabuf">
<title>Streaming I/O (DMA buffer importing)</title> <title>Streaming I/O (DMA buffer importing)</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>The DMABUF framework provides a generic method for sharing buffers <para>The DMABUF framework provides a generic method for sharing buffers
between multiple devices. Device drivers that support DMABUF can export a DMA between multiple devices. Device drivers that support DMABUF can export a DMA
buffer to userspace as a file descriptor (known as the exporter role), import a buffer to userspace as a file descriptor (known as the exporter role), import a
......
<section id="selection-api"> <section id="selection-api">
<title>Experimental API for cropping, composing and scaling</title> <title>API for cropping, composing and scaling</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<section> <section>
<title>Introduction</title> <title>Introduction</title>
......
...@@ -4002,12 +4002,6 @@ see <xref linkend="colorspaces" />.</entry> ...@@ -4002,12 +4002,6 @@ see <xref linkend="colorspaces" />.</entry>
<section id="v4l2-mbus-vendor-spec-fmts"> <section id="v4l2-mbus-vendor-spec-fmts">
<title>Vendor and Device Specific Formats</title> <title>Vendor and Device Specific Formats</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>This section lists complex data formats that are either vendor or <para>This section lists complex data formats that are either vendor or
device specific. device specific.
</para> </para>
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>This ioctl is used to create buffers for <link linkend="mmap">memory <para>This ioctl is used to create buffers for <link linkend="mmap">memory
mapped</link> or <link linkend="userp">user pointer</link> or <link mapped</link> or <link linkend="userp">user pointer</link> or <link
linkend="dmabuf">DMA buffer</link> I/O. It can be used as an alternative or in linkend="dmabuf">DMA buffer</link> I/O. It can be used as an alternative or in
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>To query the capabilities of the DV receiver/transmitter applications initialize the <para>To query the capabilities of the DV receiver/transmitter applications initialize the
<structfield>pad</structfield> field to 0, zero the reserved array of &v4l2-dv-timings-cap; <structfield>pad</structfield> field to 0, zero the reserved array of &v4l2-dv-timings-cap;
and call the <constant>VIDIOC_DV_TIMINGS_CAP</constant> ioctl on a video node and call the <constant>VIDIOC_DV_TIMINGS_CAP</constant> ioctl on a video node
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>While some DV receivers or transmitters support a wide range of timings, others <para>While some DV receivers or transmitters support a wide range of timings, others
support only a limited number of timings. With this ioctl applications can enumerate a list support only a limited number of timings. With this ioctl applications can enumerate a list
of known supported timings. Call &VIDIOC-DV-TIMINGS-CAP; to check if it also supports other of known supported timings. Call &VIDIOC-DV-TIMINGS-CAP; to check if it also supports other
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>Enumerates the frequency bands that a tuner or modulator supports. <para>Enumerates the frequency bands that a tuner or modulator supports.
To do this applications initialize the <structfield>tuner</structfield>, To do this applications initialize the <structfield>tuner</structfield>,
<structfield>type</structfield> and <structfield>index</structfield> fields, <structfield>type</structfield> and <structfield>index</structfield> fields,
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>This ioctl is an extension to the <link linkend="mmap">memory <para>This ioctl is an extension to the <link linkend="mmap">memory
mapping</link> I/O method, therefore it is available only for mapping</link> I/O method, therefore it is available only for
<constant>V4L2_MEMORY_MMAP</constant> buffers. It can be used to export a <constant>V4L2_MEMORY_MMAP</constant> buffers. It can be used to export a
......
...@@ -50,12 +50,6 @@ ...@@ -50,12 +50,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>The ioctls are used to query and configure selection rectangles.</para> <para>The ioctls are used to query and configure selection rectangles.</para>
<para>To query the cropping (composing) rectangle set &v4l2-selection; <para>To query the cropping (composing) rectangle set &v4l2-selection;
......
...@@ -48,12 +48,6 @@ ...@@ -48,12 +48,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>Applications can optionally call the <para>Applications can optionally call the
<constant>VIDIOC_PREPARE_BUF</constant> ioctl to pass ownership of the buffer <constant>VIDIOC_PREPARE_BUF</constant> ioctl to pass ownership of the buffer
to the driver before actually enqueuing it, using the to the driver before actually enqueuing it, using the
......
...@@ -50,12 +50,6 @@ input</refpurpose> ...@@ -50,12 +50,6 @@ input</refpurpose>
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental"> experimental </link>
interface and may change in the future.</para>
</note>
<para>The hardware may be able to detect the current DV timings <para>The hardware may be able to detect the current DV timings
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_TIMINGS</constant> with a pointer to a call <constant>VIDIOC_QUERY_DV_TIMINGS</constant> with a pointer to a
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>This ioctl lets applications enumerate available frame intervals on a <para>This ioctl lets applications enumerate available frame intervals on a
given sub-device pad. Frame intervals only makes sense for sub-devices that given sub-device pad. Frame intervals only makes sense for sub-devices that
can control the frame period on their own. This includes, for instance, can control the frame period on their own. This includes, for instance,
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>This ioctl allows applications to enumerate all frame sizes <para>This ioctl allows applications to enumerate all frame sizes
supported by a sub-device on the given pad for the given media bus format. supported by a sub-device on the given pad for the given media bus format.
Supported formats can be retrieved with the &VIDIOC-SUBDEV-ENUM-MBUS-CODE; Supported formats can be retrieved with the &VIDIOC-SUBDEV-ENUM-MBUS-CODE;
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>To enumerate media bus formats available at a given sub-device pad <para>To enumerate media bus formats available at a given sub-device pad
applications initialize the <structfield>pad</structfield>, <structfield>which</structfield> applications initialize the <structfield>pad</structfield>, <structfield>which</structfield>
and <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and and <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and
......
...@@ -50,12 +50,6 @@ ...@@ -50,12 +50,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>These ioctls are used to negotiate the frame format at specific <para>These ioctls are used to negotiate the frame format at specific
subdev pads in the image pipeline.</para> subdev pads in the image pipeline.</para>
......
...@@ -50,12 +50,6 @@ ...@@ -50,12 +50,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>These ioctls are used to get and set the frame interval at specific <para>These ioctls are used to get and set the frame interval at specific
subdev pads in the image pipeline. The frame interval only makes sense for subdev pads in the image pipeline. The frame interval only makes sense for
sub-devices that can control the frame period on their own. This includes, sub-devices that can control the frame period on their own. This includes,
......
...@@ -49,12 +49,6 @@ ...@@ -49,12 +49,6 @@
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<note>
<title>Experimental</title>
<para>This is an <link linkend="experimental">experimental</link>
interface and may change in the future.</para>
</note>
<para>The selections are used to configure various image <para>The selections are used to configure various image
processing functionality performed by the subdevs which affect the processing functionality performed by the subdevs which affect the
image size. This currently includes cropping, scaling and image size. This currently includes cropping, scaling and
......
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