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

Commit 0f16290e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: move FE_GET_PROPERTY to its own xml file 



That helps the xref logic at the Makefile to point to the
right place. Also, it becomes more organized and easier to
maintain if each ioctl have its own xml file.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 09c3b4a0

Documentation/DocBook/media/dvb/dvbproperty.xml

+2 −82
Original line number Diff line number Diff line
@@ -35,6 +35,8 @@ the capability ioctls weren't implemented yet via the new way.</para> 
API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">

struct <constant>dvb_frontend_parameters</constant></link> were used.</para>



&sub-fe-get-property;



<section id="dtv-stats">

<title>DTV stats type</title>

<programlisting>
@@ -1247,85 +1249,3 @@ enum fe_interleaving { 
	</section>

	</section>

</section>
 


<refentry id="FE_GET_PROPERTY">

  <refmeta>

    <refentrytitle>ioctl FE_SET_PROPERTY, FE_GET_PROPERTY</refentrytitle>

    &manvol;

  </refmeta>



  <refnamediv>

      <refname>FE_SET_PROPERTY</refname>

      <refname>FE_GET_PROPERTY</refname>

    <refpurpose>FE_SET_PROPERTY sets one or more frontend properties.

	FE_GET_PROPERTY returns one or more frontend properties.</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>&fe_fd;</para>

	</listitem>

      </varlistentry>

      <varlistentry>

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

	<listitem>

	  <para>FE_SET_PROPERTY, 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_SET_PROPERTY</constant> and <constant>FE_GET_PROPERTY</constant>

ioctls. The supported properties and statistics depends on the delivery system

and on the device:</para>

<itemizedlist>

<listitem>

    <para><constant>FE_SET_PROPERTY:</constant></para>

<itemizedlist>

<listitem>This ioctl is used to set one or more

	frontend properties.</listitem>

<listitem>This is the basic command to request the frontend to tune into some

    frequency and to start decoding the digital TV signal.</listitem>

<listitem>This call requires read/write access to the device.</listitem>

<listitem>At return, the values are updated to reflect the

    actual parameters used.</listitem>

</itemizedlist>

</listitem>

<listitem>

    <para><constant>FE_GET_PROPERTY:</constant></para>

<itemizedlist>

<listitem>This ioctl is used to get properties and

statistics from the frontend.</listitem>

<listitem>No properties are changed, and statistics aren't reset.</listitem>

<listitem>This call only requires read-only access to the device.</listitem>

</itemizedlist>

</listitem>

</itemizedlist>

&return-value-dvb;.

</refsect1>

</refentry>

Documentation/DocBook/media/dvb/fe-get-property.xml

0 → 100644
+81 −0
Original line number Diff line number Diff line 
<refentry id="FE_GET_PROPERTY">

  <refmeta>

    <refentrytitle>ioctl FE_SET_PROPERTY, FE_GET_PROPERTY</refentrytitle>

    &manvol;

  </refmeta>



  <refnamediv>

      <refname>FE_SET_PROPERTY</refname>

      <refname>FE_GET_PROPERTY</refname>

    <refpurpose>FE_SET_PROPERTY sets one or more frontend properties.

	FE_GET_PROPERTY returns one or more frontend properties.</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>&fe_fd;</para>

	</listitem>

      </varlistentry>

      <varlistentry>

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

	<listitem>

	  <para>FE_SET_PROPERTY, 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_SET_PROPERTY</constant> and <constant>FE_GET_PROPERTY</constant>

ioctls. The supported properties and statistics depends on the delivery system

and on the device:</para>

<itemizedlist>

<listitem>

    <para><constant>FE_SET_PROPERTY:</constant></para>

<itemizedlist>

<listitem>This ioctl is used to set one or more

	frontend properties.</listitem>

<listitem>This is the basic command to request the frontend to tune into some

    frequency and to start decoding the digital TV signal.</listitem>

<listitem>This call requires read/write access to the device.</listitem>

<listitem>At return, the values are updated to reflect the

    actual parameters used.</listitem>

</itemizedlist>

</listitem>

<listitem>

    <para><constant>FE_GET_PROPERTY:</constant></para>

<itemizedlist>

<listitem>This ioctl is used to get properties and

statistics from the frontend.</listitem>

<listitem>No properties are changed, and statistics aren't reset.</listitem>

<listitem>This call only requires read-only access to the device.</listitem>

</itemizedlist>

</listitem>

</itemizedlist>

&return-value-dvb;.

</refsect1>

</refentry>