1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
10 .. _fe_property_parameters:
12 ******************************
13 Digital TV property parameters
14 ******************************
16 There are several different Digital TV parameters that can be used by
17 :ref:`FE_SET_PROPERTY and FE_GET_PROPERTY ioctls<FE_GET_PROPERTY>`.
18 This section describes each of them. Please notice, however, that only
19 a subset of them are needed to setup a frontend.
27 Used internally. A GET/SET operation for it won't change or return
36 Interpret the cache of data, build either a traditional frontend
37 tunerequest so we can pass validation in the ``FE_SET_FRONTEND`` ioctl.
45 Reset a cache of data specific to the frontend here. This does not
54 Frequency of the digital TV transponder/channel.
58 #. For satellite delivery systems, the frequency is in kHz.
60 #. For cable and terrestrial delivery systems, the frequency is in
63 #. On most delivery systems, the frequency is the center frequency
64 of the transponder/channel. The exception is for ISDB-T, where
65 the main carrier has a 1/7 offset from the center.
67 #. For ISDB-T, the channels are usually transmitted with an offset of
68 about 143kHz. E.g. a valid frequency could be 474,143 kHz. The
69 stepping is bound to the bandwidth of the channel which is
72 #. In ISDB-Tsb, the channel consists of only one or three segments the
73 frequency step is 429kHz, 3*429 respectively.
81 Specifies the frontend modulation type for delivery systems that
82 supports more multiple modulations.
84 The modulation can be one of the types defined by enum :c:type:`fe_modulation`.
86 Most of the digital TV standards offers more than one possible
89 The table below presents a summary of the types of modulation types
90 supported by each delivery system, as currently defined by specs.
92 ======================= =======================================================
93 Standard Modulation types
94 ======================= =======================================================
95 ATSC (version 1) 8-VSB and 16-VSB.
96 DMTB 4-QAM, 16-QAM, 32-QAM, 64-QAM and 4-QAM-NR.
97 DVB-C Annex A/C 16-QAM, 32-QAM, 64-QAM and 256-QAM.
99 DVB-T QPSK, 16-QAM and 64-QAM.
100 DVB-T2 QPSK, 16-QAM, 64-QAM and 256-QAM.
101 DVB-S No need to set. It supports only QPSK.
102 DVB-S2 QPSK, 8-PSK, 16-APSK and 32-APSK.
103 ISDB-T QPSK, DQPSK, 16-QAM and 64-QAM.
104 ISDB-S 8-PSK, QPSK and BPSK.
105 ======================= =======================================================
109 Please notice that some of the above modulation types may not be
110 defined currently at the Kernel. The reason is simple: no driver
111 needed such definition yet.
114 .. _DTV-BANDWIDTH-HZ:
119 Bandwidth for the channel, in HZ.
121 Should be set only for terrestrial delivery systems.
123 Possible values: ``1712000``, ``5000000``, ``6000000``, ``7000000``,
124 ``8000000``, ``10000000``.
126 ======================= =======================================================
127 Terrestrial Standard Possible values for bandwidth
128 ======================= =======================================================
129 ATSC (version 1) No need to set. It is always 6MHz.
130 DMTB No need to set. It is always 8MHz.
131 DVB-T 6MHz, 7MHz and 8MHz.
132 DVB-T2 1.172 MHz, 5MHz, 6MHz, 7MHz, 8MHz and 10MHz
133 ISDB-T 5MHz, 6MHz, 7MHz and 8MHz, although most places
135 ======================= =======================================================
141 #. For ISDB-Tsb, the bandwidth can vary depending on the number of
144 It can be easily derived from other parameters
145 (DTV_ISDBT_SB_SEGMENT_IDX, DTV_ISDBT_SB_SEGMENT_COUNT).
147 #. On Satellite and Cable delivery systems, the bandwidth depends on
148 the symbol rate. So, the Kernel will silently ignore any setting
149 :ref:`DTV-BANDWIDTH-HZ`. I will however fill it back with a
150 bandwidth estimation.
152 Such bandwidth estimation takes into account the symbol rate set with
153 :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
156 For DVB-S2, the rolloff should also be set via :ref:`DTV-ROLLOFF`.
164 Specifies if the frontend should do spectral inversion or not.
166 The acceptable values are defined by :c:type:`fe_spectral_inversion`.
169 .. _DTV-DISEQC-MASTER:
174 Currently not implemented.
182 Used on cable and satellite delivery systems.
184 Digital TV symbol rate, in bauds (symbols/second).
192 Used on cable and satellite delivery systems.
194 The acceptable values are defined by :c:type:`fe_code_rate`.
202 Used on satellite delivery systems.
204 The voltage is usually used with non-DiSEqC capable LNBs to switch the
205 polarzation (horizontal/vertical). When using DiSEqC epuipment this
206 voltage has to be switched consistently to the DiSEqC commands as
207 described in the DiSEqC spec.
209 The acceptable values are defined by :c:type:`fe_sec_voltage`.
229 The acceptable values are defined by :c:type:`fe_pilot`.
241 The acceptable values are defined by :c:type:`fe_rolloff`.
244 .. _DTV-DISEQC-SLAVE-REPLY:
246 DTV_DISEQC_SLAVE_REPLY
247 ======================
249 Currently not implemented.
252 .. _DTV-FE-CAPABILITY-COUNT:
254 DTV_FE_CAPABILITY_COUNT
255 =======================
257 Currently not implemented.
260 .. _DTV-FE-CAPABILITY:
265 Currently not implemented.
268 .. _DTV-DELIVERY-SYSTEM:
273 Specifies the type of the delivery system.
275 The acceptable values are defined by :c:type:`fe_delivery_system`.
278 .. _DTV-ISDBT-PARTIAL-RECEPTION:
280 DTV_ISDBT_PARTIAL_RECEPTION
281 ===========================
285 If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
286 whether the channel is in partial reception mode or not.
288 If '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
289 and ``DTV_ISDBT_LAYERA_SEGMENT_COUNT`` has to be '1'.
291 If in addition ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'
292 ``DTV_ISDBT_PARTIAL_RECEPTION`` represents whether this ISDB-Tsb channel
293 is consisting of one segment and layer or three segments and two layers.
295 Possible values: 0, 1, -1 (AUTO)
298 .. _DTV-ISDBT-SOUND-BROADCASTING:
300 DTV_ISDBT_SOUND_BROADCASTING
301 ============================
305 This field represents whether the other DTV_ISDBT_*-parameters are
306 referring to an ISDB-T and an ISDB-Tsb channel. (See also
307 ``DTV_ISDBT_PARTIAL_RECEPTION``).
309 Possible values: 0, 1, -1 (AUTO)
312 .. _DTV-ISDBT-SB-SUBCHANNEL-ID:
314 DTV_ISDBT_SB_SUBCHANNEL_ID
315 ==========================
319 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
321 (Note of the author: This might not be the correct description of the
322 ``SUBCHANNEL-ID`` in all details, but it is my understanding of the
323 technical background needed to program a device)
325 An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
326 set of connected ISDB-Tsb channels. In this set of channels every
327 channel can be received independently. The number of connected ISDB-Tsb
328 segment can vary, e.g. depending on the frequency spectrum bandwidth
331 Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
332 broadcaster has several possibilities to put those channels in the air:
333 Assuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
334 from position 1-8 to 5-13 or anything in between.
336 The underlying layer of segments are subchannels: each segment is
337 consisting of several subchannels with a predefined IDs. A sub-channel
338 is used to help the demodulator to synchronize on the channel.
340 An ISDB-T channel is always centered over all sub-channels. As for the
341 example above, in ISDB-Tsb it is no longer as simple as that.
343 ``The DTV_ISDBT_SB_SUBCHANNEL_ID`` parameter is used to give the
344 sub-channel ID of the segment to be demodulated.
346 Possible values: 0 .. 41, -1 (AUTO)
349 .. _DTV-ISDBT-SB-SEGMENT-IDX:
351 DTV_ISDBT_SB_SEGMENT_IDX
352 ========================
356 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
358 ``DTV_ISDBT_SB_SEGMENT_IDX`` gives the index of the segment to be
359 demodulated for an ISDB-Tsb channel where several of them are
360 transmitted in the connected manner.
362 Possible values: 0 .. ``DTV_ISDBT_SB_SEGMENT_COUNT`` - 1
364 Note: This value cannot be determined by an automatic channel search.
367 .. _DTV-ISDBT-SB-SEGMENT-COUNT:
369 DTV_ISDBT_SB_SEGMENT_COUNT
370 ==========================
374 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
376 ``DTV_ISDBT_SB_SEGMENT_COUNT`` gives the total count of connected
379 Possible values: 1 .. 13
381 Note: This value cannot be determined by an automatic channel search.
384 .. _isdb-hierq-layers:
386 DTV-ISDBT-LAYER[A-C] parameters
387 ===============================
391 ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
392 ISDB-T hierarchical layers can be decoded simultaneously. For that
393 reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.
395 ISDB-T has 3 hierarchical layers which each can use a part of the
396 available segments. The total number of segments over all layers has to
399 There are 3 parameter sets, for Layers A, B and C.
402 .. _DTV-ISDBT-LAYER-ENABLED:
404 DTV_ISDBT_LAYER_ENABLED
405 -----------------------
409 Hierarchical reception in ISDB-T is achieved by enabling or disabling
410 layers in the decoding process. Setting all bits of
411 ``DTV_ISDBT_LAYER_ENABLED`` to '1' forces all layers (if applicable) to
412 be demodulated. This is the default.
414 If the channel is in the partial reception mode
415 (``DTV_ISDBT_PARTIAL_RECEPTION`` = 1) the central segment can be decoded
416 independently of the other 12 segments. In that mode layer A has to have
417 a ``SEGMENT_COUNT`` of 1.
419 In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
420 to ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
423 Only the values of the first 3 bits are used. Other bits will be silently ignored:
425 ``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
427 ``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
429 ``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
431 ``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
434 .. _DTV-ISDBT-LAYER-FEC:
436 DTV_ISDBT_LAYER[A-C]_FEC
437 ------------------------
441 The Forward Error Correction mechanism used by a given ISDB Layer, as
442 defined by :c:type:`fe_code_rate`.
445 Possible values are: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
446 ``FEC_5_6``, ``FEC_7_8``
449 .. _DTV-ISDBT-LAYER-MODULATION:
451 DTV_ISDBT_LAYER[A-C]_MODULATION
452 -------------------------------
456 The modulation used by a given ISDB Layer, as defined by
457 :c:type:`fe_modulation`.
459 Possible values are: ``QAM_AUTO``, ``QPSK``, ``QAM_16``, ``QAM_64``, ``DQPSK``
463 #. If layer C is ``DQPSK``, then layer B has to be ``DQPSK``.
465 #. If layer B is ``DQPSK`` and ``DTV_ISDBT_PARTIAL_RECEPTION``\ = 0,
466 then layer has to be ``DQPSK``.
469 .. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
471 DTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
472 ----------------------------------
476 Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
478 Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
479 ``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
481 .. _isdbt-layer_seg-cnt-table:
483 .. flat-table:: Truth table for ISDB-T Sound Broadcasting
560 .. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
562 DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
563 --------------------------------------
567 Valid values: 0, 1, 2, 4, -1 (AUTO)
569 when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.
571 Note: The real time interleaving length depends on the mode (fft-size).
572 The values here are referring to what can be found in the
573 TMCC-structure, as shown in the table below.
576 .. c:type:: isdbt_layer_interleaving_table
578 .. flat-table:: ISDB-T time interleaving modes
585 - ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
635 .. _DTV-ATSCMH-FIC-VER:
640 Used only on ATSC-MH.
642 Version number of the FIC (Fast Information Channel) signaling data.
644 FIC is used for relaying information to allow rapid service acquisition
647 Possible values: 0, 1, 2, 3, ..., 30, 31
650 .. _DTV-ATSCMH-PARADE-ID:
655 Used only on ATSC-MH.
657 Parade identification number
659 A parade is a collection of up to eight MH groups, conveying one or two
662 Possible values: 0, 1, 2, 3, ..., 126, 127
670 Used only on ATSC-MH.
672 Number of MH groups per MH subframe for a designated parade.
674 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
682 Used only on ATSC-MH.
684 Total number of MH groups including all MH groups belonging to all MH
685 parades in one MH subframe.
687 Possible values: 0, 1, 2, 3, ..., 30, 31
695 Used only on ATSC-MH.
699 Possible values: 0, 1, 2, 3, ..., 14, 15
707 Used only on ATSC-MH.
709 Parade repetition cycle.
711 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
714 .. _DTV-ATSCMH-RS-FRAME-MODE:
716 DTV_ATSCMH_RS_FRAME_MODE
717 ------------------------
719 Used only on ATSC-MH.
721 Reed Solomon (RS) frame mode.
723 The acceptable values are defined by :c:type:`atscmh_rs_frame_mode`.
726 .. _DTV-ATSCMH-RS-FRAME-ENSEMBLE:
728 DTV_ATSCMH_RS_FRAME_ENSEMBLE
729 ----------------------------
731 Used only on ATSC-MH.
733 Reed Solomon(RS) frame ensemble.
735 The acceptable values are defined by :c:type:`atscmh_rs_frame_ensemble`.
738 .. _DTV-ATSCMH-RS-CODE-MODE-PRI:
740 DTV_ATSCMH_RS_CODE_MODE_PRI
741 ---------------------------
743 Used only on ATSC-MH.
745 Reed Solomon (RS) code mode (primary).
747 The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
750 .. _DTV-ATSCMH-RS-CODE-MODE-SEC:
752 DTV_ATSCMH_RS_CODE_MODE_SEC
753 ---------------------------
755 Used only on ATSC-MH.
757 Reed Solomon (RS) code mode (secondary).
759 The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
762 .. _DTV-ATSCMH-SCCC-BLOCK-MODE:
764 DTV_ATSCMH_SCCC_BLOCK_MODE
765 --------------------------
767 Used only on ATSC-MH.
769 Series Concatenated Convolutional Code Block Mode.
771 The acceptable values are defined by :c:type:`atscmh_sccc_block_mode`.
774 .. _DTV-ATSCMH-SCCC-CODE-MODE-A:
776 DTV_ATSCMH_SCCC_CODE_MODE_A
777 ---------------------------
779 Used only on ATSC-MH.
781 Series Concatenated Convolutional Code Rate.
783 The acceptable values are defined by :c:type:`atscmh_sccc_code_mode`.
785 .. _DTV-ATSCMH-SCCC-CODE-MODE-B:
787 DTV_ATSCMH_SCCC_CODE_MODE_B
788 ---------------------------
790 Used only on ATSC-MH.
792 Series Concatenated Convolutional Code Rate.
794 Possible values are the same as documented on enum
795 :c:type:`atscmh_sccc_code_mode`.
798 .. _DTV-ATSCMH-SCCC-CODE-MODE-C:
800 DTV_ATSCMH_SCCC_CODE_MODE_C
801 ---------------------------
803 Used only on ATSC-MH.
805 Series Concatenated Convolutional Code Rate.
807 Possible values are the same as documented on enum
808 :c:type:`atscmh_sccc_code_mode`.
811 .. _DTV-ATSCMH-SCCC-CODE-MODE-D:
813 DTV_ATSCMH_SCCC_CODE_MODE_D
814 ---------------------------
816 Used only on ATSC-MH.
818 Series Concatenated Convolutional Code Rate.
820 Possible values are the same as documented on enum
821 :c:type:`atscmh_sccc_code_mode`.
829 Returns the major/minor version of the Digital TV API
832 .. _DTV-CODE-RATE-HP:
837 Used on terrestrial transmissions.
839 The acceptable values are defined by :c:type:`fe_transmit_mode`.
842 .. _DTV-CODE-RATE-LP:
847 Used on terrestrial transmissions.
849 The acceptable values are defined by :c:type:`fe_transmit_mode`.
852 .. _DTV-GUARD-INTERVAL:
857 The acceptable values are defined by :c:type:`fe_guard_interval`.
861 #. If ``DTV_GUARD_INTERVAL`` is set the ``GUARD_INTERVAL_AUTO`` the
862 hardware will try to find the correct guard interval (if capable) and
863 will use TMCC to fill in the missing parameters.
864 #. Intervals ``GUARD_INTERVAL_1_128``, ``GUARD_INTERVAL_19_128``
865 and ``GUARD_INTERVAL_19_256`` are used only for DVB-T2 at
867 #. Intervals ``GUARD_INTERVAL_PN420``, ``GUARD_INTERVAL_PN595`` and
868 ``GUARD_INTERVAL_PN945`` are used only for DMTB at the present.
869 On such standard, only those intervals and ``GUARD_INTERVAL_AUTO``
872 .. _DTV-TRANSMISSION-MODE:
874 DTV_TRANSMISSION_MODE
875 =====================
878 Used only on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB.
880 Specifies the FFT size (with corresponds to the approximate number of
881 carriers) used by the standard.
883 The acceptable values are defined by :c:type:`fe_transmit_mode`.
887 #. ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
888 **mode** on such standard, and are numbered from 1 to 3:
890 ==== ======== ========================
891 Mode FFT size Transmission mode
892 ==== ======== ========================
893 1 2K ``TRANSMISSION_MODE_2K``
894 2 4K ``TRANSMISSION_MODE_4K``
895 3 8K ``TRANSMISSION_MODE_8K``
896 ==== ======== ========================
898 #. If ``DTV_TRANSMISSION_MODE`` is set the ``TRANSMISSION_MODE_AUTO``
899 the hardware will try to find the correct FFT-size (if capable) and
900 will use TMCC to fill in the missing parameters.
902 #. DVB-T specifies 2K and 8K as valid sizes.
904 #. DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
906 #. DTMB specifies C1 and C3780.
914 Used only on DVB-T and DVB-T2.
918 The acceptable values are defined by :c:type:`fe_hierarchy`.
926 Used on DVB-S2, DVB-T2 and ISDB-S.
928 DVB-S2, DVB-T2 and ISDB-S support the transmission of several streams on
929 a single transport stream. This property enables the digital TV driver to
930 handle substream filtering, when supported by the hardware. By default,
931 substream filtering is disabled.
933 For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255.
935 For ISDB, the valid substream id range is from 1 to 65535.
937 To disable it, you should use the special macro NO_STREAM_ID_FILTER.
939 Note: any value outside the id range also disables filtering.
942 .. _DTV-DVBT2-PLP-ID-LEGACY:
944 DTV_DVBT2_PLP_ID_LEGACY
945 =======================
947 Obsolete, replaced with DTV_STREAM_ID.
955 A Multi standard frontend needs to advertise the delivery systems
956 provided. Applications need to enumerate the provided delivery systems,
957 before using any other operation with the frontend. Prior to it's
958 introduction, FE_GET_INFO was used to determine a frontend type. A
959 frontend which provides more than a single delivery system,
960 FE_GET_INFO doesn't help much. Applications which intends to use a
961 multistandard frontend must enumerate the delivery systems associated
962 with it, rather than trying to use FE_GET_INFO. In the case of a
963 legacy frontend, the result is just the same as with FE_GET_INFO, but
964 in a more structured format
966 The acceptable values are defined by :c:type:`fe_delivery_system`.
969 .. _DTV-INTERLEAVING:
974 Time interleaving to be used.
976 The acceptable values are defined by :c:type:`fe_interleaving`.
986 Hardware might offer controllable LNA which can be set manually using
987 that parameter. Usually LNA could be found only from terrestrial devices
990 Possible values: 0, 1, LNA_AUTO
996 use the special macro LNA_AUTO to set LNA auto
999 .. _DTV-SCRAMBLING-SEQUENCE-INDEX:
1001 DTV_SCRAMBLING_SEQUENCE_INDEX
1002 =============================
1006 This 18 bit field, when present, carries the index of the DVB-S2 physical
1007 layer scrambling sequence as defined in clause 5.5.4 of EN 302 307.
1008 There is no explicit signalling method to convey scrambling sequence index
1009 to the receiver. If S2 satellite delivery system descriptor is available
1010 it can be used to read the scrambling sequence index (EN 300 468 table 41).
1012 By default, gold scrambling sequence index 0 is used.
1014 The valid scrambling sequence index range is from 0 to 262142.