aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-07 19:52:33 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:48 -0400
commit994e262e3e52bf9840f0f079c29696e5ab50057f (patch)
treed05083c6e4a8025154c367c4ffaf04f0b03fcdf6 /Documentation/DocBook
parentdf2692a6dd89fc00929a18735b83204b352ebb52 (diff)
[media] DocBook/dvbproperty.xml: Document the terrestrial delivery systems
Instead of repeating duplicate parameters to each delivery system, just add a section for each specific delivery system, showing what's applicable to each case. This helps userspace app developers to know what DVB parameters are applicable to each delivery system. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/dvb/dvbproperty.xml168
1 files changed, 103 insertions, 65 deletions
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml
index d8a642475ad8..4c45f3c1ba79 100644
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -1,6 +1,12 @@
1<section id="FE_GET_SET_PROPERTY"> 1<section id="FE_GET_SET_PROPERTY">
2<title>FE_GET_PROPERTY/FE_SET_PROPERTY</title> 2<title><constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></title>
3 3<para>This section describes the DVB version 5 extention of the DVB-API, also
4called "S2API", as this API were added to provide support for DVB-S2. It was
5designed to be able to replace the old frontend API. Yet, the DISEQC and
6the capability ioctls weren't implemented yet via the new way.</para>
7<para>The typical usage for the <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant>
8API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">
9struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
4<programlisting> 10<programlisting>
5/* Reserved fields should be set to 0 */ 11/* Reserved fields should be set to 0 */
6struct dtv_property { 12struct dtv_property {
@@ -149,52 +155,7 @@ the actual action is determined by the dtv_property cmd/data pairs. With one sin
149get/set up to 64 properties. The actual meaning of each property is described on the next sections. 155get/set up to 64 properties. The actual meaning of each property is described on the next sections.
150</para> 156</para>
151 157
152<para>The available frontend property types are:</para> 158<para>The available frontend property types are shown on the next section.</para>
153
154<para><link linkend="DTV-UNDEFINED">DTV_UNDEFINED</link></para>
155<para><link linkend="DTV-TUNE">DTV_TUNE</link></para>
156<para><link linkend="DTV-CLEAR">DTV_CLEAR</link></para>
157<para><link linkend="DTV-FREQUENCY">DTV_FREQUENCY</link></para>
158<para><link linkend="DTV-MODULATION">DTV_MODULATION</link></para>
159<para><link linkend="DTV-BANDWIDTH-HZ">DTV_BANDWIDTH_HZ</link></para>
160<para><link linkend="DTV-INVERSION">DTV_INVERSION</link></para>
161<para><link linkend="DTV-DISEQC-MASTER">DTV_DISEQC_MASTER</link></para>
162<para><link linkend="DTV-SYMBOL-RATE">DTV_SYMBOL_RATE</link></para>
163<para><link linkend="DTV-INNER-FEC">DTV_INNER_FEC</link></para>
164<para><link linkend="DTV-VOLTAGE">DTV_VOLTAGE</link></para>
165<para><link linkend="DTV-TONE">DTV_TONE</link></para>
166<para><link linkend="DTV-PILOT">DTV_PILOT</link></para>
167<para><link linkend="DTV-ROLLOFF">DTV_ROLLOFF</link></para>
168<para><link linkend="DTV-DISEQC-SLAVE-REPLY">DTV_DISEQC_SLAVE_REPLY</link></para>
169<para><link linkend="DTV-FE-CAPABILITY-COUNT">DTV_FE_CAPABILITY_COUNT</link></para>
170<para><link linkend="DTV-FE-CAPABILITY">DTV_FE_CAPABILITY</link></para>
171<para><link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link></para>
172<para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION">DTV_ISDBT_PARTIAL_RECEPTION</link></para>
173<para><link linkend="DTV-ISDBT-SOUND-BROADCASTING">DTV_ISDBT_SOUND_BROADCASTING</link></para>
174<para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID">DTV_ISDBT_SB_SUBCHANNEL_ID</link></para>
175<para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX">DTV_ISDBT_SB_SEGMENT_IDX</link></para>
176<para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT">DTV_ISDBT_SB_SEGMENT_COUNT</link></para>
177<para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERA_FEC</link></para>
178<para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERA_MODULATION</link></para>
179<para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERA_SEGMENT_COUNT</link></para>
180<para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERA_TIME_INTERLEAVING</link></para>
181<para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERB_FEC</link></para>
182<para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERB_MODULATION</link></para>
183<para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERB_SEGMENT_COUNT</link></para>
184<para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERB_TIME_INTERLEAVING</link></para>
185<para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERC_FEC</link></para>
186<para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERC_MODULATION</link></para>
187<para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERC_SEGMENT_COUNT</link></para>
188<para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERC_TIME_INTERLEAVING</link></para>
189<para><link linkend="DTV-API-VERSION">DTV_API_VERSION</link></para>
190<para><link linkend="DTV-CODE-RATE-HP">DTV_CODE_RATE_HP</link></para>
191<para><link linkend="DTV-CODE-RATE-LP">DTV_CODE_RATE_LP</link></para>
192<para><link linkend="DTV-GUARD-INTERVAL">DTV_GUARD_INTERVAL</link></para>
193<para><link linkend="DTV-TRANSMISSION-MODE">DTV_TRANSMISSION_MODE</link></para>
194<para><link linkend="DTV-HIERARCHY">DTV_HIERARCHY</link></para>
195<para><link linkend="DTV-ISDBT-LAYER-ENABLED">DTV_ISDBT_LAYER_ENABLED</link></para>
196<para><link linkend="DTV-ISDBS-TS-ID">DTV_ISDBS_TS_ID</link></para>
197<para><link linkend="DTV-DVBT2-PLP-ID">DTV_DVBT2_PLP_ID</link></para>
198</section> 159</section>
199 160
200<section id="fe_property_parameters"> 161<section id="fe_property_parameters">
@@ -696,13 +657,53 @@ typedef enum fe_hierarchy {
696 many data types via a single multiplex. The API will soon support this 657 many data types via a single multiplex. The API will soon support this
697 at which point this section will be expanded.</para> 658 at which point this section will be expanded.</para>
698 </section> 659 </section>
699 <section id="frontend-property-dtv-types"> 660</section>
700 <title>Properties used by each DTV type</title> 661 <section id="frontend-property-terrestrial-systems">
662 <title>Properties used on terrestrial delivery systems</title>
663 <section id="dvbt-params">
664 <title>DVB-T delivery system</title>
665 <para>The following parameters are valid for DVB-T:</para>
666 <itemizedlist mark='opencircle'>
667 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
668 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
669 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
670 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
671 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
672 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
673 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
674 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
675 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
676 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
677 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
678 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
679 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
680 </itemizedlist>
681 </section>
682 <section id="dvbt2-params">
683 <title>DVB-T2 delivery system</title>
684 <para>DVB-T2support is currently in the early stages
685 of development so expect this section to grow and become
686 more detailed with time.</para>
687 <para>The following parameters are valid for DVB-T2:</para>
688 <itemizedlist mark='opencircle'>
689 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
690 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
691 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
692 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
693 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
694 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
695 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
696 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
697 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
698 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
699 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
700 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
701 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
702 <listitem><para><link linkend="DTV-DVBT2-PLP-ID"><constant>DTV_DVBT2_PLP_ID</constant></link></para></listitem>
703 </itemizedlist>
704 </section>
701 <section id="isdbt"> 705 <section id="isdbt">
702 <title>ISDB-T frontend</title> 706 <title>ISDB-T delivery system</title>
703 <para>This section describes shortly what are the possible parameters in the Linux
704 DVB-API called "S2API" and now DVB API 5 in order to tune an ISDB-T/ISDB-Tsb
705 demodulator:</para>
706 <para>This ISDB-T/ISDB-Tsb API extension should reflect all information 707 <para>This ISDB-T/ISDB-Tsb API extension should reflect all information
707 needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible 708 needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible
708 that some very sophisticated devices won't need certain parameters to 709 that some very sophisticated devices won't need certain parameters to
@@ -717,17 +718,54 @@ typedef enum fe_hierarchy {
717 Television Broadcasting" and</para> 718 Television Broadcasting" and</para>
718 <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial 719 <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial
719 Television Broadcasting".</para> 720 Television Broadcasting".</para>
720 <para>In order to read this document one has to have some knowledge the 721 <para>In order to understand the ISDB specific parameters,
721 channel structure in ISDB-T and ISDB-Tsb. I.e. it has to be known to 722 one has to have some knowledge the channel structure in
722 the reader that an ISDB-T channel consists of 13 segments, that it can 723 ISDB-T and ISDB-Tsb. I.e. it has to be known to
723 have up to 3 layer sharing those segments, and things like that.</para> 724 the reader that an ISDB-T channel consists of 13 segments,
724 </section> 725 that it can have up to 3 layer sharing those segments,
725 <section id="dvbt2-params"> 726 and things like that.</para>
726 <title>DVB-T2 parameters</title> 727 <para>The following parameters are valid for ISDB-T:</para>
727 <para>This section covers parameters that apply only to the DVB-T2 delivery method. DVB-T2 728 <itemizedlist mark='opencircle'>
728 support is currently in the early stages development so expect this section to grow 729 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
729 and become more detailed with time.</para> 730 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
731 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
732 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
733 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
734 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
735 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
736 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
737 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
738 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
739 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
740 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
741 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
742 <listitem><para><link linkend="DTV-ISDBT-LAYER-ENABLED"><constant>DTV_ISDBT_LAYER_ENABLED</constant></link></para></listitem>
743 <listitem><para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION"><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></link></para></listitem>
744 <listitem><para><link linkend="DTV-ISDBT-SOUND-BROADCASTING"><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></link></para></listitem>
745 <listitem><para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID"><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></link></para></listitem>
746 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX"><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></link></para></listitem>
747 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT"><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></link></para></listitem>
748 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERA_FEC</constant></link></para></listitem>
749 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERA_MODULATION</constant></link></para></listitem>
750 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant></link></para></listitem>
751 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERA_TIME_INTERLEAVING</constant></link></para></listitem>
752 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERB_FEC</constant></link></para></listitem>
753 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERB_MODULATION</constant></link></para></listitem>
754 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERB_SEGMENT_COUNT</constant></link></para></listitem>
755 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERB_TIME_INTERLEAVING</constant></link></para></listitem>
756 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERC_FEC</constant></link></para></listitem>
757 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERC_MODULATION</constant></link></para></listitem>
758 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERC_SEGMENT_COUNT</constant></link></para></listitem>
759 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERC_TIME_INTERLEAVING</constant></link></para></listitem>
760 </itemizedlist>
730 </section> 761 </section>
731 </section> 762 </section>
732</section> 763 <section id="frontend-property-cable-systems">
764 <title>Properties used on cable delivery systems</title>
765 <para>TODO</para>
766 </section>
767 <section id="frontend-property-satellital-systems">
768 <title>Properties used on satellital delivery systems</title>
769 <para>TODO</para>
770 </section>
733</section> 771</section>
generated by cgit v1.2.2 (git 2.25.0) at 2024-11-19 09:12:06 -0500