Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml

   1 <refentry id="FE_DISEQC_SEND_BURST">
   2   <refmeta>
   3     <refentrytitle>ioctl FE_DISEQC_SEND_BURST</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>FE_DISEQC_SEND_BURST</refname>
   9     <refpurpose>Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.</refpurpose>
  10   </refnamediv>
  11
  12   <refsynopsisdiv>
  13     <funcsynopsis>
  14       <funcprototype>
  15         <funcdef>int <function>ioctl</function></funcdef>
  16         <paramdef>int <parameter>fd</parameter></paramdef>
  17         <paramdef>int <parameter>request</parameter></paramdef>
  18         <paramdef>enum fe_sec_mini_cmd *<parameter>tone</parameter></paramdef>
  19       </funcprototype>
  20     </funcsynopsis>
  21   </refsynopsisdiv>
  22
  23   <refsect1>
  24     <title>Arguments</title>
  25         <variablelist>
  26       <varlistentry>
  27         <term><parameter>fd</parameter></term>
  28         <listitem>
  29           <para>&fe_fd;</para>
  30         </listitem>
  31       </varlistentry>
  32       <varlistentry>
  33         <term><parameter>request</parameter></term>
  34         <listitem>
  35           <para>FE_DISEQC_SEND_BURST</para>
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term><parameter>tone</parameter></term>
  40         <listitem>
  41           <para>pointer to &fe-sec-mini-cmd;</para>
  42         </listitem>
  43       </varlistentry>
  44     </variablelist>
  45   </refsect1>
  46
  47   <refsect1>
  48     <title>Description</title>
  49
  50 <para>This ioctl is used to set the generation of a 22kHz tone burst for mini
  51     DiSEqC satellite
  52     selection for 2x1 switches.
  53     This call requires read/write permissions.</para>
  54 <para>It provides support for what's specified at
  55     <ulink url="http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf">Digital Satellite Equipment Control
  56         (DiSEqC) - Simple "ToneBurst" Detection Circuit specification.</ulink>
  57     </para>
  58 &return-value-dvb;
  59 </refsect1>
  60
  61 <refsect1 id="fe-sec-mini-cmd-t">
  62 <title>enum fe_sec_mini_cmd</title>
  63
  64 <table pgwide="1" frame="none" id="fe-sec-mini-cmd">
  65     <title>enum fe_sec_mini_cmd</title>
  66     <tgroup cols="2">
  67         &cs-def;
  68         <thead>
  69         <row>
  70             <entry>ID</entry>
  71             <entry>Description</entry>
  72         </row>
  73         </thead>
  74         <tbody valign="top">
  75         <row>
  76             <entry align="char" id="SEC-MINI-A"><constant>SEC_MINI_A</constant></entry>
  77             <entry align="char">Sends a mini-DiSEqC 22kHz '0' Tone Burst to
  78                 select satellite-A</entry>
  79         </row><row>
  80             <entry align="char" id="SEC-MINI-B"><constant>SEC_MINI_B</constant></entry>
  81             <entry align="char">Sends a mini-DiSEqC 22kHz '1' Data Burst to
  82                 select satellite-B</entry>
  83         </row>
  84         </tbody>
  85     </tgroup>
  86 </table>
  87 </refsect1>
  88
  89 </refentry>