Merge branch 'for-3.0' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound...

[pandora-kernel.git] / Documentation / DocBook / dvb / dvbproperty.xml

diff --git a/Documentation/DocBook/dvb/dvbproperty.xml b/Documentation/DocBook/dvb/dvbproperty.xml
index 05ce603..b5365f6 100644 (file)
--- a/Documentation/DocBook/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/dvb/dvbproperty.xml
@@ -141,13 +141,15 @@ struct dtv_properties {
  </row></tbody></tgroup></informaltable>
 </section>
 
+<section>
+       <title>Property types</title>
 <para>
 On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>/<link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
 the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to
 get/set up to 64 properties. The actual meaning of each property is described on the next sections.
 </para>
 
-<para>The Available frontend property types are:</para>
+<para>The available frontend property types are:</para>
 <programlisting>
 #define DTV_UNDEFINED          0
 #define DTV_TUNE               1
@@ -193,6 +195,7 @@ get/set up to 64 properties. The actual meaning of each property is described on
 #define DTV_ISDBT_LAYER_ENABLED        41
 #define DTV_ISDBS_TS_ID                42
 </programlisting>
+</section>
 
 <section id="fe_property_common">
        <title>Parameters that are common to all Digital TV standards</title>
@@ -217,9 +220,12 @@ get/set up to 64 properties. The actual meaning of each property is described on
                <para>Bandwidth for the channel, in HZ.</para>
 
                <para>Possible values:
+                       <constant>1712000</constant>,
+                       <constant>5000000</constant>,
                        <constant>6000000</constant>,
                        <constant>7000000</constant>,
-                       <constant>8000000</constant>.
+                       <constant>8000000</constant>,
+                       <constant>10000000</constant>.
                </para>
 
                <para>Notes:</para>
@@ -231,6 +237,8 @@ get/set up to 64 properties. The actual meaning of each property is described on
                <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
                        other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
                        DTV_ISDBT_SB_SEGMENT_COUNT).</para>
+               <para>5) DVB-T supports 6, 7 and 8MHz.</para>
+               <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para>
        </section>
 
        <section id="DTV_DELIVERY_SYSTEM">
@@ -257,6 +265,7 @@ typedef enum fe_delivery_system {
        SYS_DMBTH,
        SYS_CMMB,
        SYS_DAB,
+       SYS_DVBT2,
 } fe_delivery_system_t;
 </programlisting>
 
@@ -273,7 +282,10 @@ typedef enum fe_transmit_mode {
        TRANSMISSION_MODE_2K,
        TRANSMISSION_MODE_8K,
        TRANSMISSION_MODE_AUTO,
-       TRANSMISSION_MODE_4K
+       TRANSMISSION_MODE_4K,
+       TRANSMISSION_MODE_1K,
+       TRANSMISSION_MODE_16K,
+       TRANSMISSION_MODE_32K,
 } fe_transmit_mode_t;
 </programlisting>
 
@@ -284,6 +296,8 @@ typedef enum fe_transmit_mode {
                <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the
                        hardware will try to find the correct FFT-size (if capable) and will
                        use TMCC to fill in the missing parameters.</para>
+               <para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
+               <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
        </section>
 
        <section id="DTV_GUARD_INTERVAL">
@@ -296,7 +310,10 @@ typedef enum fe_guard_interval {
        GUARD_INTERVAL_1_16,
        GUARD_INTERVAL_1_8,
        GUARD_INTERVAL_1_4,
-       GUARD_INTERVAL_AUTO
+       GUARD_INTERVAL_AUTO,
+       GUARD_INTERVAL_1_128,
+       GUARD_INTERVAL_19_128,
+       GUARD_INTERVAL_19_256,
 } fe_guard_interval_t;
 </programlisting>
 
@@ -304,6 +321,7 @@ typedef enum fe_guard_interval {
                <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
                        try to find the correct guard interval (if capable) and will use TMCC to fill
                        in the missing parameters.</para>
+               <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
        </section>
 </section>
 
@@ -553,5 +571,20 @@ typedef enum fe_guard_interval {
                        </section>
                </section>
        </section>
+       <section id="dvbt2-params">
+               <title>DVB-T2 parameters</title>
+               
+               <para>This section covers parameters that apply only to the DVB-T2 delivery method. DVB-T2
+                       support is currently in the early stages development so expect this section to grow
+                       and become more detailed with time.</para>
+
+               <section id="dvbt2-plp-id">
+                       <title><constant>DTV_DVBT2_PLP_ID</constant></title>
+
+                       <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of
+                               many data types via a single multiplex. The API will soon support this
+                               at which point this section will be expanded.</para>
+               </section>
+       </section>
 </section>
 </section>