aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorSteve Kerrison <steve@stevekerrison.com>2011-05-08 15:17:20 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-05-20 18:09:12 -0400
commitcf75f9badabe399d496be76835993c6a916c726f (patch)
tree8fb29e9df9a418a327449aec8304d492e085d63b /Documentation/DocBook
parent15ed9d01b6d4f0df6ca282da0f840b7abfd7549d (diff)
[media] DocBook/dvb: Update to include DVB-T2 additions
A few new capabilities added to frontend.h for DVB-T2. Added these to the documentation plus some notes explaining that they are used by the T2 delivery system. Signed-off-by: Steve Kerrison <steve@stevekerrison.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/dvb/dvbproperty.xml36
-rw-r--r--Documentation/DocBook/dvb/frontend.h.xml20
2 files changed, 49 insertions, 7 deletions
diff --git a/Documentation/DocBook/dvb/dvbproperty.xml b/Documentation/DocBook/dvb/dvbproperty.xml
index 05ce60362e23..52d5e3c7cf6c 100644
--- a/Documentation/DocBook/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/dvb/dvbproperty.xml
@@ -217,9 +217,12 @@ get/set up to 64 properties. The actual meaning of each property is described on
217 <para>Bandwidth for the channel, in HZ.</para> 217 <para>Bandwidth for the channel, in HZ.</para>
218 218
219 <para>Possible values: 219 <para>Possible values:
220 <constant>1712000</constant>,
221 <constant>5000000</constant>,
220 <constant>6000000</constant>, 222 <constant>6000000</constant>,
221 <constant>7000000</constant>, 223 <constant>7000000</constant>,
222 <constant>8000000</constant>. 224 <constant>8000000</constant>,
225 <constant>10000000</constant>.
223 </para> 226 </para>
224 227
225 <para>Notes:</para> 228 <para>Notes:</para>
@@ -231,6 +234,8 @@ get/set up to 64 properties. The actual meaning of each property is described on
231 <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from 234 <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
232 other parameters (DTV_ISDBT_SB_SEGMENT_IDX, 235 other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
233 DTV_ISDBT_SB_SEGMENT_COUNT).</para> 236 DTV_ISDBT_SB_SEGMENT_COUNT).</para>
237 <para>5) DVB-T supports 6, 7 and 8MHz.</para>
238 <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para>
234 </section> 239 </section>
235 240
236 <section id="DTV_DELIVERY_SYSTEM"> 241 <section id="DTV_DELIVERY_SYSTEM">
@@ -257,6 +262,7 @@ typedef enum fe_delivery_system {
257 SYS_DMBTH, 262 SYS_DMBTH,
258 SYS_CMMB, 263 SYS_CMMB,
259 SYS_DAB, 264 SYS_DAB,
265 SYS_DVBT2,
260} fe_delivery_system_t; 266} fe_delivery_system_t;
261</programlisting> 267</programlisting>
262 268
@@ -273,7 +279,10 @@ typedef enum fe_transmit_mode {
273 TRANSMISSION_MODE_2K, 279 TRANSMISSION_MODE_2K,
274 TRANSMISSION_MODE_8K, 280 TRANSMISSION_MODE_8K,
275 TRANSMISSION_MODE_AUTO, 281 TRANSMISSION_MODE_AUTO,
276 TRANSMISSION_MODE_4K 282 TRANSMISSION_MODE_4K,
283 TRANSMISSION_MODE_1K,
284 TRANSMISSION_MODE_16K,
285 TRANSMISSION_MODE_32K,
277} fe_transmit_mode_t; 286} fe_transmit_mode_t;
278</programlisting> 287</programlisting>
279 288
@@ -284,6 +293,8 @@ typedef enum fe_transmit_mode {
284 <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the 293 <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the
285 hardware will try to find the correct FFT-size (if capable) and will 294 hardware will try to find the correct FFT-size (if capable) and will
286 use TMCC to fill in the missing parameters.</para> 295 use TMCC to fill in the missing parameters.</para>
296 <para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
297 <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
287 </section> 298 </section>
288 299
289 <section id="DTV_GUARD_INTERVAL"> 300 <section id="DTV_GUARD_INTERVAL">
@@ -296,7 +307,10 @@ typedef enum fe_guard_interval {
296 GUARD_INTERVAL_1_16, 307 GUARD_INTERVAL_1_16,
297 GUARD_INTERVAL_1_8, 308 GUARD_INTERVAL_1_8,
298 GUARD_INTERVAL_1_4, 309 GUARD_INTERVAL_1_4,
299 GUARD_INTERVAL_AUTO 310 GUARD_INTERVAL_AUTO,
311 GUARD_INTERVAL_1_128,
312 GUARD_INTERVAL_19_128,
313 GUARD_INTERVAL_19_256,
300} fe_guard_interval_t; 314} fe_guard_interval_t;
301</programlisting> 315</programlisting>
302 316
@@ -304,6 +318,7 @@ typedef enum fe_guard_interval {
304 <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will 318 <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
305 try to find the correct guard interval (if capable) and will use TMCC to fill 319 try to find the correct guard interval (if capable) and will use TMCC to fill
306 in the missing parameters.</para> 320 in the missing parameters.</para>
321 <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
307 </section> 322 </section>
308</section> 323</section>
309 324
@@ -553,5 +568,20 @@ typedef enum fe_guard_interval {
553 </section> 568 </section>
554 </section> 569 </section>
555 </section> 570 </section>
571 <section id="dvbt2-params">
572 <title>DVB-T2 parameters</title>
573
574 <para>This section covers parameters that apply only to the DVB-T2 delivery method. DVB-T2
575 support is currently in the early stages development so expect this section to grow
576 and become more detailed with time.</para>
577
578 <section id="dvbt2-plp-id">
579 <title><constant>DTV_DVBT2_PLP_ID</constant></title>
580
581 <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of
582 many data types via a single multiplex. The API will soon support this
583 at which point this section will be expanded.</para>
584 </section>
585 </section>
556</section> 586</section>
557</section> 587</section>
diff --git a/Documentation/DocBook/dvb/frontend.h.xml b/Documentation/DocBook/dvb/frontend.h.xml
index d08e0d401418..d792f789ad3b 100644
--- a/Documentation/DocBook/dvb/frontend.h.xml
+++ b/Documentation/DocBook/dvb/frontend.h.xml
@@ -176,14 +176,20 @@ typedef enum fe_transmit_mode {
176 TRANSMISSION_MODE_2K, 176 TRANSMISSION_MODE_2K,
177 TRANSMISSION_MODE_8K, 177 TRANSMISSION_MODE_8K,
178 TRANSMISSION_MODE_AUTO, 178 TRANSMISSION_MODE_AUTO,
179 TRANSMISSION_MODE_4K 179 TRANSMISSION_MODE_4K,
180 TRANSMISSION_MODE_1K,
181 TRANSMISSION_MODE_16K,
182 TRANSMISSION_MODE_32K,
180} fe_transmit_mode_t; 183} fe_transmit_mode_t;
181 184
182typedef enum fe_bandwidth { 185typedef enum fe_bandwidth {
183 BANDWIDTH_8_MHZ, 186 BANDWIDTH_8_MHZ,
184 BANDWIDTH_7_MHZ, 187 BANDWIDTH_7_MHZ,
185 BANDWIDTH_6_MHZ, 188 BANDWIDTH_6_MHZ,
186 BANDWIDTH_AUTO 189 BANDWIDTH_AUTO,
190 BANDWIDTH_5_MHZ,
191 BANDWIDTH_10_MHZ,
192 BANDWIDTH_1_712_MHZ,
187} fe_bandwidth_t; 193} fe_bandwidth_t;
188 194
189 195
@@ -192,7 +198,10 @@ typedef enum fe_guard_interval {
192 GUARD_INTERVAL_1_16, 198 GUARD_INTERVAL_1_16,
193 GUARD_INTERVAL_1_8, 199 GUARD_INTERVAL_1_8,
194 GUARD_INTERVAL_1_4, 200 GUARD_INTERVAL_1_4,
195 GUARD_INTERVAL_AUTO 201 GUARD_INTERVAL_AUTO,
202 GUARD_INTERVAL_1_128,
203 GUARD_INTERVAL_19_128,
204 GUARD_INTERVAL_19_256,
196} fe_guard_interval_t; 205} fe_guard_interval_t;
197 206
198 207
@@ -306,7 +315,9 @@ struct dvb_frontend_event {
306 315
307#define DTV_ISDBS_TS_ID 42 316#define DTV_ISDBS_TS_ID 42
308 317
309#define DTV_MAX_COMMAND DTV_ISDBS_TS_ID 318#define DTV_DVBT2_PLP_ID 43
319
320#define DTV_MAX_COMMAND DTV_DVBT2_PLP_ID
310 321
311typedef enum fe_pilot { 322typedef enum fe_pilot {
312 PILOT_ON, 323 PILOT_ON,
@@ -338,6 +349,7 @@ typedef enum fe_delivery_system {
338 SYS_DMBTH, 349 SYS_DMBTH,
339 SYS_CMMB, 350 SYS_CMMB,
340 SYS_DAB, 351 SYS_DAB,
352 SYS_DVBT2,
341} fe_delivery_system_t; 353} fe_delivery_system_t;
342 354
343struct dtv_cmds_h { 355struct dtv_cmds_h {