Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml

   1 <refentry id="FE_DISEQC_SEND_MASTER_CMD">
   2   <refmeta>
   3     <refentrytitle>ioctl FE_DISEQC_SEND_MASTER_CMD</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>FE_DISEQC_SEND_MASTER_CMD</refname>
   9     <refpurpose>Sends a DiSEqC command</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>struct dvb_diseqc_master_cmd *<parameter>argp</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_MASTER_CMD</para>
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term><parameter>argp</parameter></term>
  40         <listitem>
  41             <para>pointer to &dvb-diseqc-master-cmd;</para>
  42         </listitem>
  43       </varlistentry>
  44     </variablelist>
  45   </refsect1>
  46
  47   <refsect1>
  48     <title>Description</title>
  49
  50     <para>Sends a DiSEqC command to the antenna subsystem.</para>
  51 &return-value-dvb;
  52
  53 <table pgwide="1" frame="none" id="dvb-diseqc-master-cmd">
  54     <title>struct <structname>dvb_diseqc_master_cmd</structname></title>
  55     <tgroup cols="3">
  56     &cs-str;
  57     <tbody valign="top">
  58         <row>
  59         <entry>uint8_t</entry>
  60         <entry>msg[6]</entry>
  61         <entry>DiSEqC message (framing, address, command, data[3])</entry>
  62         </row><row>
  63         <entry>uint8_t</entry>
  64         <entry>msg_len</entry>
  65         <entry>Length of the DiSEqC message. Valid values are 3 to 6</entry>
  66         </row>
  67     </tbody>
  68     </tgroup>
  69 </table>
  70
  71 </refsect1>
  72 </refentry>