[media] DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std way
Use the standard way of documenting ioctls for FE_GET_PROPERTY and FE_SET_PROPERTY. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab
parent
56599d4196
commit
ffec8bceac
1 changed files with 118 additions and 96 deletions
|
|
@ -7,6 +7,7 @@ the capability ioctls weren't implemented yet via the new way.</para>
|
||||||
<para>The typical usage for the <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant>
|
<para>The typical usage for the <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant>
|
||||||
API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">
|
API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">
|
||||||
struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
|
struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
|
||||||
|
|
||||||
<section id="dtv-stats">
|
<section id="dtv-stats">
|
||||||
<title>DTV stats type</title>
|
<title>DTV stats type</title>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
|
|
@ -66,102 +67,6 @@ struct dtv_properties {
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="FE_GET_PROPERTY">
|
|
||||||
<title>FE_GET_PROPERTY</title>
|
|
||||||
<para>DESCRIPTION
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="1"><tbody><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>This ioctl call returns one or more frontend properties. This call only
|
|
||||||
requires read-only access to the device.</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
<para>SYNOPSIS
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="1"><tbody><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>int ioctl(int fd, int request = <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>,
|
|
||||||
dtv_properties ⋆props);</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
<para>PARAMETERS
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="2"><tbody><row><entry align="char">
|
|
||||||
<para>int fd</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>File descriptor returned by a previous call to open().</para>
|
|
||||||
</entry>
|
|
||||||
</row><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>int num</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>Equals <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link> for this command.</para>
|
|
||||||
</entry>
|
|
||||||
</row><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>struct dtv_property *props</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>Points to the location where the front-end property commands are stored.</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
&return-value-dvb;
|
|
||||||
<informaltable><tgroup cols="2"><tbody><row>
|
|
||||||
<entry align="char"><para>EOPNOTSUPP</para></entry>
|
|
||||||
<entry align="char"><para>Property type not supported.</para></entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="FE_SET_PROPERTY">
|
|
||||||
<title>FE_SET_PROPERTY</title>
|
|
||||||
<para>DESCRIPTION
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="1"><tbody><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>This ioctl call sets one or more frontend properties. This call
|
|
||||||
requires read/write access to the device.</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
<para>SYNOPSIS
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="1"><tbody><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>int ioctl(int fd, int request = <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
|
|
||||||
dtv_properties ⋆props);</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
<para>PARAMETERS
|
|
||||||
</para>
|
|
||||||
<informaltable><tgroup cols="2"><tbody><row><entry align="char">
|
|
||||||
<para>int fd</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>File descriptor returned by a previous call to open().</para>
|
|
||||||
</entry>
|
|
||||||
</row><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>int num</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>Equals <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link> for this command.</para>
|
|
||||||
</entry>
|
|
||||||
</row><row><entry
|
|
||||||
align="char">
|
|
||||||
<para>struct dtv_property *props</para>
|
|
||||||
</entry><entry
|
|
||||||
align="char">
|
|
||||||
<para>Points to the location where the front-end property commands are stored.</para>
|
|
||||||
</entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
&return-value-dvb;
|
|
||||||
<informaltable><tgroup cols="2"><tbody><row>
|
|
||||||
<entry align="char"><para>EOPNOTSUPP</para></entry>
|
|
||||||
<entry align="char"><para>Property type not supported.</para></entry>
|
|
||||||
</row></tbody></tgroup></informaltable>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<title>Property types</title>
|
<title>Property types</title>
|
||||||
<para>
|
<para>
|
||||||
|
|
@ -1315,3 +1220,120 @@ enum fe_interleaving {
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<refentry id="FE_GET_PROPERTY">
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>ioctl FE_GET_PROPERTY</refentrytitle>
|
||||||
|
&manvol;
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>FE_GET_PROPERTY</refname>
|
||||||
|
<refpurpose>Returns one or more frontend properties. This call only
|
||||||
|
requires read-only access to the device</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<funcsynopsis>
|
||||||
|
<funcprototype>
|
||||||
|
<funcdef>int <function>ioctl</function></funcdef>
|
||||||
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
||||||
|
<paramdef>int <parameter>request</parameter></paramdef>
|
||||||
|
<paramdef>&dtv-property; *<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>FE_GET_PROPERTY</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><parameter>argp</parameter></term>
|
||||||
|
<listitem>
|
||||||
|
<para>pointer to &dtv-property;</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>All DVB frontend devices support the
|
||||||
|
<constant>FE_GET_PROPERTY</constant> ioctl. It is used to get properties and
|
||||||
|
statistics from the frontend.
|
||||||
|
&return-value-dvb;.
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
|
||||||
|
<refentry id="FE_SET_PROPERTY">
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>ioctl FE_SET_PROPERTY</refentrytitle>
|
||||||
|
&manvol;
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>FE_SET_PROPERTY</refname>
|
||||||
|
<refpurpose>Sets one or more frontend properties. This call
|
||||||
|
requires read/write access to the device</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<funcsynopsis>
|
||||||
|
<funcprototype>
|
||||||
|
<funcdef>int <function>ioctl</function></funcdef>
|
||||||
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
||||||
|
<paramdef>int <parameter>request</parameter></paramdef>
|
||||||
|
<paramdef>&dtv-property; *<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>FE_SET_PROPERTY</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><parameter>argp</parameter></term>
|
||||||
|
<listitem>
|
||||||
|
<para>pointer to &dtv-property;</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>All DVB frontend devices support the
|
||||||
|
<constant>FE_SET_PROPERTY</constant> ioctl. It is used to sets one or more
|
||||||
|
frontend properties. This is the basic command to request the frontend to tune
|
||||||
|
into some frequency and to start decoding the digital TV signal.
|
||||||
|
&return-value-dvb;.
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue