0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002
0003 .. _fe_property_parameters:
0004
0005 ******************************
0006 Digital TV property parameters
0007 ******************************
0008
0009 There are several different Digital TV parameters that can be used by
0010 :ref:`FE_SET_PROPERTY and FE_GET_PROPERTY ioctls<FE_GET_PROPERTY>`.
0011 This section describes each of them. Please notice, however, that only
0012 a subset of them are needed to setup a frontend.
0013
0014
0015 .. _DTV-UNDEFINED:
0016
0017 DTV_UNDEFINED
0018 =============
0019
0020 Used internally. A GET/SET operation for it won't change or return
0021 anything.
0022
0023
0024 .. _DTV-TUNE:
0025
0026 DTV_TUNE
0027 ========
0028
0029 Interpret the cache of data, build either a traditional frontend
0030 tunerequest so we can pass validation in the ``FE_SET_FRONTEND`` ioctl.
0031
0032
0033 .. _DTV-CLEAR:
0034
0035 DTV_CLEAR
0036 =========
0037
0038 Reset a cache of data specific to the frontend here. This does not
0039 effect hardware.
0040
0041
0042 .. _DTV-FREQUENCY:
0043
0044 DTV_FREQUENCY
0045 =============
0046
0047 Frequency of the digital TV transponder/channel.
0048
0049 .. note::
0050
0051 #. For satellite delivery systems, the frequency is in kHz.
0052
0053 #. For cable and terrestrial delivery systems, the frequency is in
0054 Hz.
0055
0056 #. On most delivery systems, the frequency is the center frequency
0057 of the transponder/channel. The exception is for ISDB-T, where
0058 the main carrier has a 1/7 offset from the center.
0059
0060 #. For ISDB-T, the channels are usually transmitted with an offset of
0061 about 143kHz. E.g. a valid frequency could be 474,143 kHz. The
0062 stepping is bound to the bandwidth of the channel which is
0063 typically 6MHz.
0064
0065 #. In ISDB-Tsb, the channel consists of only one or three segments the
0066 frequency step is 429kHz, 3*429 respectively.
0067
0068
0069 .. _DTV-MODULATION:
0070
0071 DTV_MODULATION
0072 ==============
0073
0074 Specifies the frontend modulation type for delivery systems that
0075 supports more multiple modulations.
0076
0077 The modulation can be one of the types defined by enum :c:type:`fe_modulation`.
0078
0079 Most of the digital TV standards offers more than one possible
0080 modulation type.
0081
0082 The table below presents a summary of the types of modulation types
0083 supported by each delivery system, as currently defined by specs.
0084
0085 ======================= =======================================================
0086 Standard Modulation types
0087 ======================= =======================================================
0088 ATSC (version 1) 8-VSB and 16-VSB.
0089 DMTB 4-QAM, 16-QAM, 32-QAM, 64-QAM and 4-QAM-NR.
0090 DVB-C Annex A/C 16-QAM, 32-QAM, 64-QAM and 256-QAM.
0091 DVB-C Annex B 64-QAM.
0092 DVB-T QPSK, 16-QAM and 64-QAM.
0093 DVB-T2 QPSK, 16-QAM, 64-QAM and 256-QAM.
0094 DVB-S No need to set. It supports only QPSK.
0095 DVB-S2 QPSK, 8-PSK, 16-APSK and 32-APSK.
0096 ISDB-T QPSK, DQPSK, 16-QAM and 64-QAM.
0097 ISDB-S 8-PSK, QPSK and BPSK.
0098 ======================= =======================================================
0099
0100 .. note::
0101
0102 Please notice that some of the above modulation types may not be
0103 defined currently at the Kernel. The reason is simple: no driver
0104 needed such definition yet.
0105
0106
0107 .. _DTV-BANDWIDTH-HZ:
0108
0109 DTV_BANDWIDTH_HZ
0110 ================
0111
0112 Bandwidth for the channel, in HZ.
0113
0114 Should be set only for terrestrial delivery systems.
0115
0116 Possible values: ``1712000``, ``5000000``, ``6000000``, ``7000000``,
0117 ``8000000``, ``10000000``.
0118
0119 ======================= =======================================================
0120 Terrestrial Standard Possible values for bandwidth
0121 ======================= =======================================================
0122 ATSC (version 1) No need to set. It is always 6MHz.
0123 DMTB No need to set. It is always 8MHz.
0124 DVB-T 6MHz, 7MHz and 8MHz.
0125 DVB-T2 1.172 MHz, 5MHz, 6MHz, 7MHz, 8MHz and 10MHz
0126 ISDB-T 5MHz, 6MHz, 7MHz and 8MHz, although most places
0127 use 6MHz.
0128 ======================= =======================================================
0129
0130
0131 .. note::
0132
0133
0134 #. For ISDB-Tsb, the bandwidth can vary depending on the number of
0135 connected segments.
0136
0137 It can be easily derived from other parameters
0138 (DTV_ISDBT_SB_SEGMENT_IDX, DTV_ISDBT_SB_SEGMENT_COUNT).
0139
0140 #. On Satellite and Cable delivery systems, the bandwidth depends on
0141 the symbol rate. So, the Kernel will silently ignore any setting
0142 :ref:`DTV-BANDWIDTH-HZ`. I will however fill it back with a
0143 bandwidth estimation.
0144
0145 Such bandwidth estimation takes into account the symbol rate set with
0146 :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
0147 DVB-C and DVB-S.
0148
0149 For DVB-S2, the rolloff should also be set via :ref:`DTV-ROLLOFF`.
0150
0151
0152 .. _DTV-INVERSION:
0153
0154 DTV_INVERSION
0155 =============
0156
0157 Specifies if the frontend should do spectral inversion or not.
0158
0159 The acceptable values are defined by :c:type:`fe_spectral_inversion`.
0160
0161
0162 .. _DTV-DISEQC-MASTER:
0163
0164 DTV_DISEQC_MASTER
0165 =================
0166
0167 Currently not implemented.
0168
0169
0170 .. _DTV-SYMBOL-RATE:
0171
0172 DTV_SYMBOL_RATE
0173 ===============
0174
0175 Used on cable and satellite delivery systems.
0176
0177 Digital TV symbol rate, in bauds (symbols/second).
0178
0179
0180 .. _DTV-INNER-FEC:
0181
0182 DTV_INNER_FEC
0183 =============
0184
0185 Used on cable and satellite delivery systems.
0186
0187 The acceptable values are defined by :c:type:`fe_code_rate`.
0188
0189
0190 .. _DTV-VOLTAGE:
0191
0192 DTV_VOLTAGE
0193 ===========
0194
0195 Used on satellite delivery systems.
0196
0197 The voltage is usually used with non-DiSEqC capable LNBs to switch the
0198 polarzation (horizontal/vertical). When using DiSEqC epuipment this
0199 voltage has to be switched consistently to the DiSEqC commands as
0200 described in the DiSEqC spec.
0201
0202 The acceptable values are defined by :c:type:`fe_sec_voltage`.
0203
0204
0205 .. _DTV-TONE:
0206
0207 DTV_TONE
0208 ========
0209
0210 Currently not used.
0211
0212
0213 .. _DTV-PILOT:
0214
0215 DTV_PILOT
0216 =========
0217
0218 Used on DVB-S2.
0219
0220 Sets DVB-S2 pilot.
0221
0222 The acceptable values are defined by :c:type:`fe_pilot`.
0223
0224
0225 .. _DTV-ROLLOFF:
0226
0227 DTV_ROLLOFF
0228 ===========
0229
0230 Used on DVB-S2.
0231
0232 Sets DVB-S2 rolloff.
0233
0234 The acceptable values are defined by :c:type:`fe_rolloff`.
0235
0236
0237 .. _DTV-DISEQC-SLAVE-REPLY:
0238
0239 DTV_DISEQC_SLAVE_REPLY
0240 ======================
0241
0242 Currently not implemented.
0243
0244
0245 .. _DTV-FE-CAPABILITY-COUNT:
0246
0247 DTV_FE_CAPABILITY_COUNT
0248 =======================
0249
0250 Currently not implemented.
0251
0252
0253 .. _DTV-FE-CAPABILITY:
0254
0255 DTV_FE_CAPABILITY
0256 =================
0257
0258 Currently not implemented.
0259
0260
0261 .. _DTV-DELIVERY-SYSTEM:
0262
0263 DTV_DELIVERY_SYSTEM
0264 ===================
0265
0266 Specifies the type of the delivery system.
0267
0268 The acceptable values are defined by :c:type:`fe_delivery_system`.
0269
0270
0271 .. _DTV-ISDBT-PARTIAL-RECEPTION:
0272
0273 DTV_ISDBT_PARTIAL_RECEPTION
0274 ===========================
0275
0276 Used only on ISDB.
0277
0278 If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
0279 whether the channel is in partial reception mode or not.
0280
0281 If '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
0282 and ``DTV_ISDBT_LAYERA_SEGMENT_COUNT`` has to be '1'.
0283
0284 If in addition ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'
0285 ``DTV_ISDBT_PARTIAL_RECEPTION`` represents whether this ISDB-Tsb channel
0286 is consisting of one segment and layer or three segments and two layers.
0287
0288 Possible values: 0, 1, -1 (AUTO)
0289
0290
0291 .. _DTV-ISDBT-SOUND-BROADCASTING:
0292
0293 DTV_ISDBT_SOUND_BROADCASTING
0294 ============================
0295
0296 Used only on ISDB.
0297
0298 This field represents whether the other DTV_ISDBT_*-parameters are
0299 referring to an ISDB-T and an ISDB-Tsb channel. (See also
0300 ``DTV_ISDBT_PARTIAL_RECEPTION``).
0301
0302 Possible values: 0, 1, -1 (AUTO)
0303
0304
0305 .. _DTV-ISDBT-SB-SUBCHANNEL-ID:
0306
0307 DTV_ISDBT_SB_SUBCHANNEL_ID
0308 ==========================
0309
0310 Used only on ISDB.
0311
0312 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
0313
0314 (Note of the author: This might not be the correct description of the
0315 ``SUBCHANNEL-ID`` in all details, but it is my understanding of the
0316 technical background needed to program a device)
0317
0318 An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
0319 set of connected ISDB-Tsb channels. In this set of channels every
0320 channel can be received independently. The number of connected ISDB-Tsb
0321 segment can vary, e.g. depending on the frequency spectrum bandwidth
0322 available.
0323
0324 Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
0325 broadcaster has several possibilities to put those channels in the air:
0326 Assuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
0327 from position 1-8 to 5-13 or anything in between.
0328
0329 The underlying layer of segments are subchannels: each segment is
0330 consisting of several subchannels with a predefined IDs. A sub-channel
0331 is used to help the demodulator to synchronize on the channel.
0332
0333 An ISDB-T channel is always centered over all sub-channels. As for the
0334 example above, in ISDB-Tsb it is no longer as simple as that.
0335
0336 ``The DTV_ISDBT_SB_SUBCHANNEL_ID`` parameter is used to give the
0337 sub-channel ID of the segment to be demodulated.
0338
0339 Possible values: 0 .. 41, -1 (AUTO)
0340
0341
0342 .. _DTV-ISDBT-SB-SEGMENT-IDX:
0343
0344 DTV_ISDBT_SB_SEGMENT_IDX
0345 ========================
0346
0347 Used only on ISDB.
0348
0349 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
0350
0351 ``DTV_ISDBT_SB_SEGMENT_IDX`` gives the index of the segment to be
0352 demodulated for an ISDB-Tsb channel where several of them are
0353 transmitted in the connected manner.
0354
0355 Possible values: 0 .. ``DTV_ISDBT_SB_SEGMENT_COUNT`` - 1
0356
0357 Note: This value cannot be determined by an automatic channel search.
0358
0359
0360 .. _DTV-ISDBT-SB-SEGMENT-COUNT:
0361
0362 DTV_ISDBT_SB_SEGMENT_COUNT
0363 ==========================
0364
0365 Used only on ISDB.
0366
0367 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
0368
0369 ``DTV_ISDBT_SB_SEGMENT_COUNT`` gives the total count of connected
0370 ISDB-Tsb channels.
0371
0372 Possible values: 1 .. 13
0373
0374 Note: This value cannot be determined by an automatic channel search.
0375
0376
0377 .. _isdb-hierq-layers:
0378
0379 DTV-ISDBT-LAYER[A-C] parameters
0380 ===============================
0381
0382 Used only on ISDB.
0383
0384 ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
0385 ISDB-T hierarchical layers can be decoded simultaneously. For that
0386 reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.
0387
0388 ISDB-T has 3 hierarchical layers which each can use a part of the
0389 available segments. The total number of segments over all layers has to
0390 13 in ISDB-T.
0391
0392 There are 3 parameter sets, for Layers A, B and C.
0393
0394
0395 .. _DTV-ISDBT-LAYER-ENABLED:
0396
0397 DTV_ISDBT_LAYER_ENABLED
0398 -----------------------
0399
0400 Used only on ISDB.
0401
0402 Hierarchical reception in ISDB-T is achieved by enabling or disabling
0403 layers in the decoding process. Setting all bits of
0404 ``DTV_ISDBT_LAYER_ENABLED`` to '1' forces all layers (if applicable) to
0405 be demodulated. This is the default.
0406
0407 If the channel is in the partial reception mode
0408 (``DTV_ISDBT_PARTIAL_RECEPTION`` = 1) the central segment can be decoded
0409 independently of the other 12 segments. In that mode layer A has to have
0410 a ``SEGMENT_COUNT`` of 1.
0411
0412 In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
0413 to ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
0414 accordingly.
0415
0416 Only the values of the first 3 bits are used. Other bits will be silently ignored:
0417
0418 ``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
0419
0420 ``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
0421
0422 ``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
0423
0424 ``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
0425
0426
0427 .. _DTV-ISDBT-LAYER-FEC:
0428
0429 DTV_ISDBT_LAYER[A-C]_FEC
0430 ------------------------
0431
0432 Used only on ISDB.
0433
0434 The Forward Error Correction mechanism used by a given ISDB Layer, as
0435 defined by :c:type:`fe_code_rate`.
0436
0437
0438 Possible values are: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
0439 ``FEC_5_6``, ``FEC_7_8``
0440
0441
0442 .. _DTV-ISDBT-LAYER-MODULATION:
0443
0444 DTV_ISDBT_LAYER[A-C]_MODULATION
0445 -------------------------------
0446
0447 Used only on ISDB.
0448
0449 The modulation used by a given ISDB Layer, as defined by
0450 :c:type:`fe_modulation`.
0451
0452 Possible values are: ``QAM_AUTO``, ``QPSK``, ``QAM_16``, ``QAM_64``, ``DQPSK``
0453
0454 .. note::
0455
0456 #. If layer C is ``DQPSK``, then layer B has to be ``DQPSK``.
0457
0458 #. If layer B is ``DQPSK`` and ``DTV_ISDBT_PARTIAL_RECEPTION``\ = 0,
0459 then layer has to be ``DQPSK``.
0460
0461
0462 .. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
0463
0464 DTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
0465 ----------------------------------
0466
0467 Used only on ISDB.
0468
0469 Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
0470
0471 Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
0472 ``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
0473
0474 .. _isdbt-layer_seg-cnt-table:
0475
0476 .. flat-table:: Truth table for ISDB-T Sound Broadcasting
0477 :header-rows: 1
0478 :stub-columns: 0
0479
0480
0481 - .. row 1
0482
0483 - Partial Reception
0484
0485 - Sound Broadcasting
0486
0487 - Layer A width
0488
0489 - Layer B width
0490
0491 - Layer C width
0492
0493 - total width
0494
0495 - .. row 2
0496
0497 - 0
0498
0499 - 0
0500
0501 - 1 .. 13
0502
0503 - 1 .. 13
0504
0505 - 1 .. 13
0506
0507 - 13
0508
0509 - .. row 3
0510
0511 - 1
0512
0513 - 0
0514
0515 - 1
0516
0517 - 1 .. 13
0518
0519 - 1 .. 13
0520
0521 - 13
0522
0523 - .. row 4
0524
0525 - 0
0526
0527 - 1
0528
0529 - 1
0530
0531 - 0
0532
0533 - 0
0534
0535 - 1
0536
0537 - .. row 5
0538
0539 - 1
0540
0541 - 1
0542
0543 - 1
0544
0545 - 2
0546
0547 - 0
0548
0549 - 13
0550
0551
0552
0553 .. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
0554
0555 DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
0556 --------------------------------------
0557
0558 Used only on ISDB.
0559
0560 Valid values: 0, 1, 2, 4, -1 (AUTO)
0561
0562 when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.
0563
0564 Note: The real time interleaving length depends on the mode (fft-size).
0565 The values here are referring to what can be found in the
0566 TMCC-structure, as shown in the table below.
0567
0568
0569 .. c:type:: isdbt_layer_interleaving_table
0570
0571 .. flat-table:: ISDB-T time interleaving modes
0572 :header-rows: 1
0573 :stub-columns: 0
0574
0575
0576 - .. row 1
0577
0578 - ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
0579
0580 - Mode 1 (2K FFT)
0581
0582 - Mode 2 (4K FFT)
0583
0584 - Mode 3 (8K FFT)
0585
0586 - .. row 2
0587
0588 - 0
0589
0590 - 0
0591
0592 - 0
0593
0594 - 0
0595
0596 - .. row 3
0597
0598 - 1
0599
0600 - 4
0601
0602 - 2
0603
0604 - 1
0605
0606 - .. row 4
0607
0608 - 2
0609
0610 - 8
0611
0612 - 4
0613
0614 - 2
0615
0616 - .. row 5
0617
0618 - 4
0619
0620 - 16
0621
0622 - 8
0623
0624 - 4
0625
0626
0627
0628 .. _DTV-ATSCMH-FIC-VER:
0629
0630 DTV_ATSCMH_FIC_VER
0631 ------------------
0632
0633 Used only on ATSC-MH.
0634
0635 Version number of the FIC (Fast Information Channel) signaling data.
0636
0637 FIC is used for relaying information to allow rapid service acquisition
0638 by the receiver.
0639
0640 Possible values: 0, 1, 2, 3, ..., 30, 31
0641
0642
0643 .. _DTV-ATSCMH-PARADE-ID:
0644
0645 DTV_ATSCMH_PARADE_ID
0646 --------------------
0647
0648 Used only on ATSC-MH.
0649
0650 Parade identification number
0651
0652 A parade is a collection of up to eight MH groups, conveying one or two
0653 ensembles.
0654
0655 Possible values: 0, 1, 2, 3, ..., 126, 127
0656
0657
0658 .. _DTV-ATSCMH-NOG:
0659
0660 DTV_ATSCMH_NOG
0661 --------------
0662
0663 Used only on ATSC-MH.
0664
0665 Number of MH groups per MH subframe for a designated parade.
0666
0667 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
0668
0669
0670 .. _DTV-ATSCMH-TNOG:
0671
0672 DTV_ATSCMH_TNOG
0673 ---------------
0674
0675 Used only on ATSC-MH.
0676
0677 Total number of MH groups including all MH groups belonging to all MH
0678 parades in one MH subframe.
0679
0680 Possible values: 0, 1, 2, 3, ..., 30, 31
0681
0682
0683 .. _DTV-ATSCMH-SGN:
0684
0685 DTV_ATSCMH_SGN
0686 --------------
0687
0688 Used only on ATSC-MH.
0689
0690 Start group number.
0691
0692 Possible values: 0, 1, 2, 3, ..., 14, 15
0693
0694
0695 .. _DTV-ATSCMH-PRC:
0696
0697 DTV_ATSCMH_PRC
0698 --------------
0699
0700 Used only on ATSC-MH.
0701
0702 Parade repetition cycle.
0703
0704 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
0705
0706
0707 .. _DTV-ATSCMH-RS-FRAME-MODE:
0708
0709 DTV_ATSCMH_RS_FRAME_MODE
0710 ------------------------
0711
0712 Used only on ATSC-MH.
0713
0714 Reed Solomon (RS) frame mode.
0715
0716 The acceptable values are defined by :c:type:`atscmh_rs_frame_mode`.
0717
0718
0719 .. _DTV-ATSCMH-RS-FRAME-ENSEMBLE:
0720
0721 DTV_ATSCMH_RS_FRAME_ENSEMBLE
0722 ----------------------------
0723
0724 Used only on ATSC-MH.
0725
0726 Reed Solomon(RS) frame ensemble.
0727
0728 The acceptable values are defined by :c:type:`atscmh_rs_frame_ensemble`.
0729
0730
0731 .. _DTV-ATSCMH-RS-CODE-MODE-PRI:
0732
0733 DTV_ATSCMH_RS_CODE_MODE_PRI
0734 ---------------------------
0735
0736 Used only on ATSC-MH.
0737
0738 Reed Solomon (RS) code mode (primary).
0739
0740 The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
0741
0742
0743 .. _DTV-ATSCMH-RS-CODE-MODE-SEC:
0744
0745 DTV_ATSCMH_RS_CODE_MODE_SEC
0746 ---------------------------
0747
0748 Used only on ATSC-MH.
0749
0750 Reed Solomon (RS) code mode (secondary).
0751
0752 The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
0753
0754
0755 .. _DTV-ATSCMH-SCCC-BLOCK-MODE:
0756
0757 DTV_ATSCMH_SCCC_BLOCK_MODE
0758 --------------------------
0759
0760 Used only on ATSC-MH.
0761
0762 Series Concatenated Convolutional Code Block Mode.
0763
0764 The acceptable values are defined by :c:type:`atscmh_sccc_block_mode`.
0765
0766
0767 .. _DTV-ATSCMH-SCCC-CODE-MODE-A:
0768
0769 DTV_ATSCMH_SCCC_CODE_MODE_A
0770 ---------------------------
0771
0772 Used only on ATSC-MH.
0773
0774 Series Concatenated Convolutional Code Rate.
0775
0776 The acceptable values are defined by :c:type:`atscmh_sccc_code_mode`.
0777
0778 .. _DTV-ATSCMH-SCCC-CODE-MODE-B:
0779
0780 DTV_ATSCMH_SCCC_CODE_MODE_B
0781 ---------------------------
0782
0783 Used only on ATSC-MH.
0784
0785 Series Concatenated Convolutional Code Rate.
0786
0787 Possible values are the same as documented on enum
0788 :c:type:`atscmh_sccc_code_mode`.
0789
0790
0791 .. _DTV-ATSCMH-SCCC-CODE-MODE-C:
0792
0793 DTV_ATSCMH_SCCC_CODE_MODE_C
0794 ---------------------------
0795
0796 Used only on ATSC-MH.
0797
0798 Series Concatenated Convolutional Code Rate.
0799
0800 Possible values are the same as documented on enum
0801 :c:type:`atscmh_sccc_code_mode`.
0802
0803
0804 .. _DTV-ATSCMH-SCCC-CODE-MODE-D:
0805
0806 DTV_ATSCMH_SCCC_CODE_MODE_D
0807 ---------------------------
0808
0809 Used only on ATSC-MH.
0810
0811 Series Concatenated Convolutional Code Rate.
0812
0813 Possible values are the same as documented on enum
0814 :c:type:`atscmh_sccc_code_mode`.
0815
0816
0817 .. _DTV-API-VERSION:
0818
0819 DTV_API_VERSION
0820 ===============
0821
0822 Returns the major/minor version of the Digital TV API
0823
0824
0825 .. _DTV-CODE-RATE-HP:
0826
0827 DTV_CODE_RATE_HP
0828 ================
0829
0830 Used on terrestrial transmissions.
0831
0832 The acceptable values are defined by :c:type:`fe_transmit_mode`.
0833
0834
0835 .. _DTV-CODE-RATE-LP:
0836
0837 DTV_CODE_RATE_LP
0838 ================
0839
0840 Used on terrestrial transmissions.
0841
0842 The acceptable values are defined by :c:type:`fe_transmit_mode`.
0843
0844
0845 .. _DTV-GUARD-INTERVAL:
0846
0847 DTV_GUARD_INTERVAL
0848 ==================
0849
0850 The acceptable values are defined by :c:type:`fe_guard_interval`.
0851
0852 .. note::
0853
0854 #. If ``DTV_GUARD_INTERVAL`` is set the ``GUARD_INTERVAL_AUTO`` the
0855 hardware will try to find the correct guard interval (if capable) and
0856 will use TMCC to fill in the missing parameters.
0857 #. Intervals ``GUARD_INTERVAL_1_128``, ``GUARD_INTERVAL_19_128``
0858 and ``GUARD_INTERVAL_19_256`` are used only for DVB-T2 at
0859 present.
0860 #. Intervals ``GUARD_INTERVAL_PN420``, ``GUARD_INTERVAL_PN595`` and
0861 ``GUARD_INTERVAL_PN945`` are used only for DMTB at the present.
0862 On such standard, only those intervals and ``GUARD_INTERVAL_AUTO``
0863 are valid.
0864
0865 .. _DTV-TRANSMISSION-MODE:
0866
0867 DTV_TRANSMISSION_MODE
0868 =====================
0869
0870
0871 Used only on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB.
0872
0873 Specifies the FFT size (with corresponds to the approximate number of
0874 carriers) used by the standard.
0875
0876 The acceptable values are defined by :c:type:`fe_transmit_mode`.
0877
0878 .. note::
0879
0880 #. ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
0881 **mode** on such standard, and are numbered from 1 to 3:
0882
0883 ==== ======== ========================
0884 Mode FFT size Transmission mode
0885 ==== ======== ========================
0886 1 2K ``TRANSMISSION_MODE_2K``
0887 2 4K ``TRANSMISSION_MODE_4K``
0888 3 8K ``TRANSMISSION_MODE_8K``
0889 ==== ======== ========================
0890
0891 #. If ``DTV_TRANSMISSION_MODE`` is set the ``TRANSMISSION_MODE_AUTO``
0892 the hardware will try to find the correct FFT-size (if capable) and
0893 will use TMCC to fill in the missing parameters.
0894
0895 #. DVB-T specifies 2K and 8K as valid sizes.
0896
0897 #. DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
0898
0899 #. DTMB specifies C1 and C3780.
0900
0901
0902 .. _DTV-HIERARCHY:
0903
0904 DTV_HIERARCHY
0905 =============
0906
0907 Used only on DVB-T and DVB-T2.
0908
0909 Frontend hierarchy.
0910
0911 The acceptable values are defined by :c:type:`fe_hierarchy`.
0912
0913
0914 .. _DTV-STREAM-ID:
0915
0916 DTV_STREAM_ID
0917 =============
0918
0919 Used on DVB-S2, DVB-T2 and ISDB-S.
0920
0921 DVB-S2, DVB-T2 and ISDB-S support the transmission of several streams on
0922 a single transport stream. This property enables the digital TV driver to
0923 handle substream filtering, when supported by the hardware. By default,
0924 substream filtering is disabled.
0925
0926 For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255.
0927
0928 For ISDB, the valid substream id range is from 1 to 65535.
0929
0930 To disable it, you should use the special macro NO_STREAM_ID_FILTER.
0931
0932 Note: any value outside the id range also disables filtering.
0933
0934
0935 .. _DTV-DVBT2-PLP-ID-LEGACY:
0936
0937 DTV_DVBT2_PLP_ID_LEGACY
0938 =======================
0939
0940 Obsolete, replaced with DTV_STREAM_ID.
0941
0942
0943 .. _DTV-ENUM-DELSYS:
0944
0945 DTV_ENUM_DELSYS
0946 ===============
0947
0948 A Multi standard frontend needs to advertise the delivery systems
0949 provided. Applications need to enumerate the provided delivery systems,
0950 before using any other operation with the frontend. Prior to it's
0951 introduction, FE_GET_INFO was used to determine a frontend type. A
0952 frontend which provides more than a single delivery system,
0953 FE_GET_INFO doesn't help much. Applications which intends to use a
0954 multistandard frontend must enumerate the delivery systems associated
0955 with it, rather than trying to use FE_GET_INFO. In the case of a
0956 legacy frontend, the result is just the same as with FE_GET_INFO, but
0957 in a more structured format
0958
0959 The acceptable values are defined by :c:type:`fe_delivery_system`.
0960
0961
0962 .. _DTV-INTERLEAVING:
0963
0964 DTV_INTERLEAVING
0965 ================
0966
0967 Time interleaving to be used.
0968
0969 The acceptable values are defined by :c:type:`fe_interleaving`.
0970
0971
0972 .. _DTV-LNA:
0973
0974 DTV_LNA
0975 =======
0976
0977 Low-noise amplifier.
0978
0979 Hardware might offer controllable LNA which can be set manually using
0980 that parameter. Usually LNA could be found only from terrestrial devices
0981 if at all.
0982
0983 Possible values: 0, 1, LNA_AUTO
0984
0985 0, LNA off
0986
0987 1, LNA on
0988
0989 use the special macro LNA_AUTO to set LNA auto
0990
0991
0992 .. _DTV-SCRAMBLING-SEQUENCE-INDEX:
0993
0994 DTV_SCRAMBLING_SEQUENCE_INDEX
0995 =============================
0996
0997 Used on DVB-S2.
0998
0999 This 18 bit field, when present, carries the index of the DVB-S2 physical
1000 layer scrambling sequence as defined in clause 5.5.4 of EN 302 307.
1001 There is no explicit signalling method to convey scrambling sequence index
1002 to the receiver. If S2 satellite delivery system descriptor is available
1003 it can be used to read the scrambling sequence index (EN 300 468 table 41).
1004
1005 By default, gold scrambling sequence index 0 is used.
1006
1007 The valid scrambling sequence index range is from 0 to 262142.
