Commit 26b2574f authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: better document FE_DISEQC_RESET_OVERLOAD 



Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.

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

Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml

0 → 100644
+51 −0
Original line number Diff line number Diff line 
<refentry id="FE_DISEQC_RESET_OVERLOAD">

  <refmeta>

    <refentrytitle>ioctl FE_DISEQC_RESET_OVERLOAD</refentrytitle>

    &manvol;

  </refmeta>



  <refnamediv>

    <refname>FE_DISEQC_RESET_OVERLOAD</refname>

    <refpurpose>Restores the power to the antenna subsystem, if it was powered

	off due to power overload.</refpurpose>

  </refnamediv>



  <refsynopsisdiv>

    <funcsynopsis>

      <funcprototype>

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

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

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

	<paramdef>NULL</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_DISEQC_RESET_OVERLOAD</para>

	</listitem>

      </varlistentry>

    </variablelist>

  </refsect1>



  <refsect1>

    <title>Description</title>



    <para>If the bus has been automatically powered off due to power overload, this ioctl

 call restores the power to the bus. The call requires read/write access to the

 device. This call has no effect if the device is manually powered off. Not all

 DVB adapters support this ioctl.</para>

&return-value-dvb;

</refsect1>

</refentry>

Documentation/DocBook/media/dvb/frontend.xml

+1 −44
Original line number Diff line number Diff line
@@ -333,50 +333,7 @@ typedef enum fe_hierarchy { 
 </row></tbody></tgroup></informaltable>

</section>





<section id="FE_DISEQC_RESET_OVERLOAD">

<title>FE_DISEQC_RESET_OVERLOAD</title>

<para>DESCRIPTION

</para>

<informaltable><tgroup cols="1"><tbody><row><entry

 align="char">

<para>If the bus has been automatically powered off due to power overload, this ioctl

 call restores the power to the bus. The call requires read/write access to the

 device. This call has no effect if the device is manually powered off. Not all

 DVB adapters support this ioctl.</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_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</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 request</para>

</entry><entry

 align="char">

<para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this

 command.</para>

</entry>

 </row></tbody></tgroup></informaltable>



&return-value-dvb;

</section>



&sub-fe-diseqc-reset-overload;

&sub-fe-diseqc-send-master-cmd;

&sub-fe-diseqc-recv-slave-reply;

&sub-fe-diseqc-send-burst;