tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[media] DocBook: document new DTV Properties for ATSC-MH delivery system
Document the following properties for controlling an ATSC-MH frontend:
DTV_ATSCMH_FIC_VER - Version number of the FIC signaling data
DTV_ATSCMH_PARADE_ID - Parade identification number
DTV_ATSCMH_NOG - Number of MH groups per MH subframe for a designated parade
DTV_ATSCMH_TNOG - Total number of MH groups in all parades in one subframe
DTV_ATSCMH_SGN - Start group number
DTV_ATSCMH_PRC - Parade repetition cycle
DTV_ATSCMH_RS_FRAME_MODE - RS frame mode
DTV_ATSCMH_RS_FRAME_ENSEMBLE - RS frame ensemble
DTV_ATSCMH_RS_CODE_MODE_PRI - RS code mode (primary)
DTV_ATSCMH_RS_CODE_MODE_SEC - RS code mode (secondary)
DTV_ATSCMH_SCCC_BLOCK_MODE - Series Concatenated Convolutional Code Block Mode
DTV_ATSCMH_SCCC_CODE_MODE_A - Series Concatenated Convolutional Code Rate A
DTV_ATSCMH_SCCC_CODE_MODE_B - Series Concatenated Convolutional Code Rate B
DTV_ATSCMH_SCCC_CODE_MODE_C - Series Concatenated Convolutional Code Rate C
DTV_ATSCMH_SCCC_CODE_MODE_D - Series Concatenated Convolutional Code Rate D
DTV_ATSCMH_FIC_ERR - FIC error count
DTV_ATSCMH_CRC_ERR - CRC error count
DTV_ATSCMH_RS_ERR - RS error count
Signed-off-by: Michael Krufky <mkrufky@linuxtv.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
authored by
Michael Krufky
and committed by
Mauro Carvalho Chehab
edaa136d
ca689488
+178
+178
Documentation/DocBook/media/dvb/dvbproperty.xml
+178
Documentation/DocBook/media/dvb/dvbproperty.xml
···
531
531
here are referring to what can be found in the TMCC-structure -
532
532
independent of the mode.</para>
533
533
</section>
534
+
<section id="DTV-ATSCMH-FIC-VER">
535
+
<title><constant>DTV_ATSCMH_FIC_VER</constant></title>
536
+
<para>Version number of the FIC (Fast Information Channel) signaling data.</para>
537
+
<para>FIC is used for relaying information to allow rapid service acquisition by the receiver.</para>
538
+
<para>Possible values: 0, 1, 2, 3, ..., 30, 31</para>
539
+
</section>
540
+
<section id="DTV-ATSCMH-PARADE-ID">
541
+
<title><constant>DTV_ATSCMH_PARADE_ID</constant></title>
542
+
<para>Parade identification number</para>
543
+
<para>A parade is a collection of up to eight MH groups, conveying one or two ensembles.</para>
544
+
<para>Possible values: 0, 1, 2, 3, ..., 126, 127</para>
545
+
</section>
546
+
<section id="DTV-ATSCMH-NOG">
547
+
<title><constant>DTV_ATSCMH_NOG</constant></title>
548
+
<para>Number of MH groups per MH subframe for a designated parade.</para>
549
+
<para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para>
550
+
</section>
551
+
<section id="DTV-ATSCMH-TNOG">
552
+
<title><constant>DTV_ATSCMH_TNOG</constant></title>
553
+
<para>Total number of MH groups including all MH groups belonging to all MH parades in one MH subframe.</para>
554
+
<para>Possible values: 0, 1, 2, 3, ..., 30, 31</para>
555
+
</section>
556
+
<section id="DTV-ATSCMH-SGN">
557
+
<title><constant>DTV_ATSCMH_SGN</constant></title>
558
+
<para>Start group number.</para>
559
+
<para>Possible values: 0, 1, 2, 3, ..., 14, 15</para>
560
+
</section>
561
+
<section id="DTV-ATSCMH-PRC">
562
+
<title><constant>DTV_ATSCMH_PRC</constant></title>
563
+
<para>Parade repetition cycle.</para>
564
+
<para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para>
565
+
</section>
566
+
<section id="DTV-ATSCMH-RS-FRAME-MODE">
567
+
<title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title>
568
+
<para>RS frame mode.</para>
569
+
<para>Possible values are:</para>
570
+
<programlisting>
571
+
typedef enum atscmh_rs_frame_mode {
572
+
ATSCMH_RSFRAME_PRI_ONLY = 0,
573
+
ATSCMH_RSFRAME_PRI_SEC = 1,
574
+
} atscmh_rs_frame_mode_t;
575
+
</programlisting>
576
+
</section>
577
+
<section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE">
578
+
<title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title>
579
+
<para>RS frame ensemble.</para>
580
+
<para>Possible values are:</para>
581
+
<programlisting>
582
+
typedef enum atscmh_rs_frame_ensemble {
583
+
ATSCMH_RSFRAME_ENS_PRI = 0,
584
+
ATSCMH_RSFRAME_ENS_SEC = 1,
585
+
} atscmh_rs_frame_ensemble_t;
586
+
</programlisting>
587
+
</section>
588
+
<section id="DTV-ATSCMH-RS-CODE-MODE-PRI">
589
+
<title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title>
590
+
<para>RS code mode (primary).</para>
591
+
<para>Possible values are:</para>
592
+
<programlisting>
593
+
typedef enum atscmh_rs_code_mode {
594
+
ATSCMH_RSCODE_211_187 = 0,
595
+
ATSCMH_RSCODE_223_187 = 1,
596
+
ATSCMH_RSCODE_235_187 = 2,
597
+
} atscmh_rs_code_mode_t;
598
+
</programlisting>
599
+
</section>
600
+
<section id="DTV-ATSCMH-RS-CODE-MODE-SEC">
601
+
<title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title>
602
+
<para>RS code mode (secondary).</para>
603
+
<para>Possible values are:</para>
604
+
<programlisting>
605
+
typedef enum atscmh_rs_code_mode {
606
+
ATSCMH_RSCODE_211_187 = 0,
607
+
ATSCMH_RSCODE_223_187 = 1,
608
+
ATSCMH_RSCODE_235_187 = 2,
609
+
} atscmh_rs_code_mode_t;
610
+
</programlisting>
611
+
</section>
612
+
<section id="DTV-ATSCMH-SCCC-BLOCK-MODE">
613
+
<title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title>
614
+
<para>Series Concatenated Convolutional Code Block Mode.</para>
615
+
<para>Possible values are:</para>
616
+
<programlisting>
617
+
typedef enum atscmh_sccc_block_mode {
618
+
ATSCMH_SCCC_BLK_SEP = 0,
619
+
ATSCMH_SCCC_BLK_COMB = 1,
620
+
} atscmh_sccc_block_mode_t;
621
+
</programlisting>
622
+
</section>
623
+
<section id="DTV-ATSCMH-SCCC-CODE-MODE-A">
624
+
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title>
625
+
<para>Series Concatenated Convolutional Code Rate.</para>
626
+
<para>Possible values are:</para>
627
+
<programlisting>
628
+
typedef enum atscmh_sccc_code_mode {
629
+
ATSCMH_SCCC_CODE_HLF = 0,
630
+
ATSCMH_SCCC_CODE_QTR = 1,
631
+
} atscmh_sccc_code_mode_t;
632
+
</programlisting>
633
+
</section>
634
+
<section id="DTV-ATSCMH-SCCC-CODE-MODE-B">
635
+
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title>
636
+
<para>Series Concatenated Convolutional Code Rate.</para>
637
+
<para>Possible values are:</para>
638
+
<programlisting>
639
+
typedef enum atscmh_sccc_code_mode {
640
+
ATSCMH_SCCC_CODE_HLF = 0,
641
+
ATSCMH_SCCC_CODE_QTR = 1,
642
+
} atscmh_sccc_code_mode_t;
643
+
</programlisting>
644
+
</section>
645
+
<section id="DTV-ATSCMH-SCCC-CODE-MODE-C">
646
+
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title>
647
+
<para>Series Concatenated Convolutional Code Rate.</para>
648
+
<para>Possible values are:</para>
649
+
<programlisting>
650
+
typedef enum atscmh_sccc_code_mode {
651
+
ATSCMH_SCCC_CODE_HLF = 0,
652
+
ATSCMH_SCCC_CODE_QTR = 1,
653
+
} atscmh_sccc_code_mode_t;
654
+
</programlisting>
655
+
</section>
656
+
<section id="DTV-ATSCMH-SCCC-CODE-MODE-D">
657
+
<title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title>
658
+
<para>Series Concatenated Convolutional Code Rate.</para>
659
+
<para>Possible values are:</para>
660
+
<programlisting>
661
+
typedef enum atscmh_sccc_code_mode {
662
+
ATSCMH_SCCC_CODE_HLF = 0,
663
+
ATSCMH_SCCC_CODE_QTR = 1,
664
+
} atscmh_sccc_code_mode_t;
665
+
</programlisting>
666
+
</section>
667
+
<section id="DTV-ATSCMH-FIC-ERR">
668
+
<title><constant>DTV_ATSCMH_FIC_ERR</constant></title>
669
+
<para>FIC error count.</para>
670
+
<para>Possible values: 0, 1, 2, 3, ..., 0xffff</para>
671
+
</section>
672
+
<section id="DTV-ATSCMH-CRC-ERR">
673
+
<title><constant>DTV_ATSCMH_CRC_ERR</constant></title>
674
+
<para>CRC error count.</para>
675
+
<para>Possible values: 0, 1, 2, 3, ..., 0xffff</para>
676
+
</section>
677
+
<section id="DTV-ATSCMH-RS-ERR">
678
+
<title><constant>DTV_ATSCMH_RS_ERR</constant></title>
679
+
<para>RS error count.</para>
680
+
<para>Possible values: 0, 1, 2, 3, ..., 0xffff</para>
681
+
</section>
534
682
</section>
535
683
<section id="DTV-API-VERSION">
536
684
<title><constant>DTV_API_VERSION</constant></title>
···
920
772
<listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
921
773
<listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
922
774
<listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
775
+
</itemizedlist>
776
+
</section>
777
+
<section id="atscmh-params">
778
+
<title>ATSC-MH delivery system</title>
779
+
<para>The following parameters are valid for ATSC-MH:</para>
780
+
<itemizedlist mark='opencircle'>
781
+
<listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
782
+
<listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
783
+
<listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
784
+
<listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
785
+
<listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
786
+
<listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
787
+
<listitem><para><link linkend="DTV-ATSCMH-FIC-VER"><constant>DTV_ATSCMH_FIC_VER</constant></link></para></listitem>
788
+
<listitem><para><link linkend="DTV-ATSCMH-PARADE-ID"><constant>DTV_ATSCMH_PARADE_ID</constant></link></para></listitem>
789
+
<listitem><para><link linkend="DTV-ATSCMH-NOG"><constant>DTV_ATSCMH_NOG</constant></link></para></listitem>
790
+
<listitem><para><link linkend="DTV-ATSCMH-TNOG"><constant>DTV_ATSCMH_TNOG</constant></link></para></listitem>
791
+
<listitem><para><link linkend="DTV-ATSCMH-SGN"><constant>DTV_ATSCMH_SGN</constant></link></para></listitem>
792
+
<listitem><para><link linkend="DTV-ATSCMH-PRC"><constant>DTV_ATSCMH_PRC</constant></link></para></listitem>
793
+
<listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-MODE"><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></link></para></listitem>
794
+
<listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-ENSEMBLE"><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></link></para></listitem>
795
+
<listitem><para><link linkend="DTV-ATSCMH-CODE-MODE-PRI"><constant>DTV_ATSCMH_CODE_MODE_PRI</constant></link></para></listitem>
796
+
<listitem><para><link linkend="DTV-ATSCMH-CODE-MODE-SEC"><constant>DTV_ATSCMH_CODE_MODE_SEC</constant></link></para></listitem>
797
+
<listitem><para><link linkend="DTV-ATSCMH-SCCC-BLOCK-MODE"><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></link></para></listitem>
798
+
<listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE_MODE-A"><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></link></para></listitem>
799
+
<listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE_MODE-B"><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></link></para></listitem>
800
+
<listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE_MODE-C"><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></link></para></listitem>
801
+
<listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE_MODE-D"><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></link></para></listitem>
802
+
<listitem><para><link linkend="DTV-ATSCMH-FIC-ERR"><constant>DTV_ATSCMH_FIC_ERR</constant></link></para></listitem>
803
+
<listitem><para><link linkend="DTV-ATSCMH-CRC-ERR"><constant>DTV_ATSCMH_CRC_ERR</constant></link></para></listitem>
804
+
<listitem><para><link linkend="DTV-ATSCMH-RS-ERR"><constant>DTV_ATSCMH_RS_ERR</constant></link></para></listitem>
923
805
</itemizedlist>
924
806
</section>
925
807
</section>