summaryrefslogtreecommitdiff
path: root/Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
blob: 9f6a68f32de3146e1d7162ae99c8cba2b5e49ad8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<refentry id="FE_DISEQC_SEND_BURST">
  <refmeta>
    <refentrytitle>ioctl FE_DISEQC_SEND_BURST</refentrytitle>
    &manvol;
  </refmeta>

  <refnamediv>
    <refname>FE_DISEQC_SEND_BURST</refname>
    <refpurpose>Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcprototype>
	<funcdef>int <function>ioctl</function></funcdef>
	<paramdef>int <parameter>fd</parameter></paramdef>
	<paramdef>int <parameter>request</parameter></paramdef>
	<paramdef>enum fe_sec_mini_cmd *<parameter>tone</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_DISEQC_SEND_BURST</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter>tone</parameter></term>
	<listitem>
	  <para>pointer to &fe-sec-mini-cmd;</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Description</title>

<para>This ioctl is used to set the generation of a 22kHz tone burst for mini
    DiSEqC satellite
    selection for 2x1 switches.
    This call requires read/write permissions.</para>
<para>It provides support for what's specified at
    <ulink url="http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf">Digital Satellite Equipment Control
	(DiSEqC) - Simple "ToneBurst" Detection Circuit specification.</ulink>
    </para>
&return-value-dvb;
</refsect1>

<refsect1 id="fe-sec-mini-cmd-t">
<title>enum fe_sec_mini_cmd</title>

<table pgwide="1" frame="none" id="fe-sec-mini-cmd">
    <title>enum fe_sec_mini_cmd</title>
    <tgroup cols="2">
	&cs-def;
	<thead>
	<row>
	    <entry>ID</entry>
	    <entry>Description</entry>
	</row>
	</thead>
	<tbody valign="top">
	<row>
	    <entry align="char" id="SEC-MINI-A"><constant>SEC_MINI_A</constant></entry>
	    <entry align="char">Sends a mini-DiSEqC 22kHz '0' Tone Burst to
		select satellite-A</entry>
	</row><row>
	    <entry align="char" id="SEC-MINI-B"><constant>SEC_MINI_B</constant></entry>
	    <entry align="char">Sends a mini-DiSEqC 22kHz '1' Data Burst to
		select satellite-B</entry>
	</row>
        </tbody>
    </tgroup>
</table>
</refsect1>

</refentry>