Documentation/linux_tv/media/dvb/fe_property_parameters.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _fe_property_parameters:
   4
   5 ******************************
   6 Digital TV property parameters
   7 ******************************
   8
   9
  10 .. _DTV-UNDEFINED:
  11
  12 DTV_UNDEFINED
  13 =============
  14
  15 Used internally. A GET/SET operation for it won't change or return
  16 anything.
  17
  18
  19 .. _DTV-TUNE:
  20
  21 DTV_TUNE
  22 ========
  23
  24 Interpret the cache of data, build either a traditional frontend
  25 tunerequest so we can pass validation in the ``FE_SET_FRONTEND`` ioctl.
  26
  27
  28 .. _DTV-CLEAR:
  29
  30 DTV_CLEAR
  31 =========
  32
  33 Reset a cache of data specific to the frontend here. This does not
  34 effect hardware.
  35
  36
  37 .. _DTV-FREQUENCY:
  38
  39 DTV_FREQUENCY
  40 =============
  41
  42 Central frequency of the channel.
  43
  44 Notes:
  45
  46 1)For satellite delivery systems, it is measured in kHz. For the other
  47 ones, it is measured in Hz.
  48
  49 2)For ISDB-T, the channels are usually transmitted with an offset of
  50 143kHz. E.g. a valid frequency could be 474143 kHz. The stepping is
  51 bound to the bandwidth of the channel which is 6MHz.
  52
  53 3)As in ISDB-Tsb the channel consists of only one or three segments the
  54 frequency step is 429kHz, 3*429 respectively. As for ISDB-T the central
  55 frequency of the channel is expected.
  56
  57
  58 .. _DTV-MODULATION:
  59
  60 DTV_MODULATION
  61 ==============
  62
  63 Specifies the frontend modulation type for delivery systems that
  64 supports more than one modulation type. The modulation can be one of the
  65 types defined by enum :ref:`fe_modulation <fe-modulation>`.
  66
  67
  68 .. _fe-modulation-t:
  69
  70 Modulation property
  71 -------------------
  72
  73 Most of the digital TV standards currently offers more than one possible
  74 modulation (sometimes called as "constellation" on some standards). This
  75 enum contains the values used by the Kernel. Please note that not all
  76 modulations are supported by a given standard.
  77
  78
  79 .. _fe-modulation:
  80
  81 .. flat-table:: enum fe_modulation
  82     :header-rows:  1
  83     :stub-columns: 0
  84
  85
  86     -  .. row 1
  87
  88        -  ID
  89
  90        -  Description
  91
  92     -  .. row 2
  93
  94        -  .. _`QPSK`:
  95
  96           ``QPSK``
  97
  98        -  QPSK modulation
  99
 100     -  .. row 3
 101
 102        -  .. _`QAM-16`:
 103
 104           ``QAM_16``
 105
 106        -  16-QAM modulation
 107
 108     -  .. row 4
 109
 110        -  .. _`QAM-32`:
 111
 112           ``QAM_32``
 113
 114        -  32-QAM modulation
 115
 116     -  .. row 5
 117
 118        -  .. _`QAM-64`:
 119
 120           ``QAM_64``
 121
 122        -  64-QAM modulation
 123
 124     -  .. row 6
 125
 126        -  .. _`QAM-128`:
 127
 128           ``QAM_128``
 129
 130        -  128-QAM modulation
 131
 132     -  .. row 7
 133
 134        -  .. _`QAM-256`:
 135
 136           ``QAM_256``
 137
 138        -  256-QAM modulation
 139
 140     -  .. row 8
 141
 142        -  .. _`QAM-AUTO`:
 143
 144           ``QAM_AUTO``
 145
 146        -  Autodetect QAM modulation
 147
 148     -  .. row 9
 149
 150        -  .. _`VSB-8`:
 151
 152           ``VSB_8``
 153
 154        -  8-VSB modulation
 155
 156     -  .. row 10
 157
 158        -  .. _`VSB-16`:
 159
 160           ``VSB_16``
 161
 162        -  16-VSB modulation
 163
 164     -  .. row 11
 165
 166        -  .. _`PSK-8`:
 167
 168           ``PSK_8``
 169
 170        -  8-PSK modulation
 171
 172     -  .. row 12
 173
 174        -  .. _`APSK-16`:
 175
 176           ``APSK_16``
 177
 178        -  16-APSK modulation
 179
 180     -  .. row 13
 181
 182        -  .. _`APSK-32`:
 183
 184           ``APSK_32``
 185
 186        -  32-APSK modulation
 187
 188     -  .. row 14
 189
 190        -  .. _`DQPSK`:
 191
 192           ``DQPSK``
 193
 194        -  DQPSK modulation
 195
 196     -  .. row 15
 197
 198        -  .. _`QAM-4-NR`:
 199
 200           ``QAM_4_NR``
 201
 202        -  4-QAM-NR modulation
 203
 204
 205
 206 .. _DTV-BANDWIDTH-HZ:
 207
 208 DTV_BANDWIDTH_HZ
 209 ================
 210
 211 Bandwidth for the channel, in HZ.
 212
 213 Possible values: ``1712000``, ``5000000``, ``6000000``, ``7000000``,
 214 ``8000000``, ``10000000``.
 215
 216 Notes:
 217
 218 1) For ISDB-T it should be always 6000000Hz (6MHz)
 219
 220 2) For ISDB-Tsb it can vary depending on the number of connected
 221 segments
 222
 223 3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth for
 224 DVB-C depends on the symbol rate
 225
 226 4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
 227 other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
 228 DTV_ISDBT_SB_SEGMENT_COUNT).
 229
 230 5) DVB-T supports 6, 7 and 8MHz.
 231
 232 6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.
 233
 234
 235 .. _DTV-INVERSION:
 236
 237 DTV_INVERSION
 238 =============
 239
 240 Specifies if the frontend should do spectral inversion or not.
 241
 242
 243 .. _fe-spectral-inversion-t:
 244
 245 enum fe_modulation: Frontend spectral inversion
 246 -----------------------------------------------
 247
 248 This parameter indicates if spectral inversion should be presumed or
 249 not. In the automatic setting (``INVERSION_AUTO``) the hardware will try
 250 to figure out the correct setting by itself. If the hardware doesn't
 251 support, the DVB core will try to lock at the carrier first with
 252 inversion off. If it fails, it will try to enable inversion.
 253
 254
 255 .. _fe-spectral-inversion:
 256
 257 .. flat-table:: enum fe_modulation
 258     :header-rows:  1
 259     :stub-columns: 0
 260
 261
 262     -  .. row 1
 263
 264        -  ID
 265
 266        -  Description
 267
 268     -  .. row 2
 269
 270        -  .. _`INVERSION-OFF`:
 271
 272           ``INVERSION_OFF``
 273
 274        -  Don't do spectral band inversion.
 275
 276     -  .. row 3
 277
 278        -  .. _`INVERSION-ON`:
 279
 280           ``INVERSION_ON``
 281
 282        -  Do spectral band inversion.
 283
 284     -  .. row 4
 285
 286        -  .. _`INVERSION-AUTO`:
 287
 288           ``INVERSION_AUTO``
 289
 290        -  Autodetect spectral band inversion.
 291
 292
 293
 294 .. _DTV-DISEQC-MASTER:
 295
 296 DTV_DISEQC_MASTER
 297 =================
 298
 299 Currently not implemented.
 300
 301
 302 .. _DTV-SYMBOL-RATE:
 303
 304 DTV_SYMBOL_RATE
 305 ===============
 306
 307 Digital TV symbol rate, in bauds (symbols/second). Used on cable
 308 standards.
 309
 310
 311 .. _DTV-INNER-FEC:
 312
 313 DTV_INNER_FEC
 314 =============
 315
 316 Used cable/satellite transmissions. The acceptable values are:
 317
 318
 319 .. _fe-code-rate-t:
 320
 321 enum fe_code_rate: type of the Forward Error Correction.
 322 --------------------------------------------------------
 323
 324
 325 .. _fe-code-rate:
 326
 327 .. flat-table:: enum fe_code_rate
 328     :header-rows:  1
 329     :stub-columns: 0
 330
 331
 332     -  .. row 1
 333
 334        -  ID
 335
 336        -  Description
 337
 338     -  .. row 2
 339
 340        -  .. _`FEC-NONE`:
 341
 342           ``FEC_NONE``
 343
 344        -  No Forward Error Correction Code
 345
 346     -  .. row 3
 347
 348        -  .. _`FEC-AUTO`:
 349
 350           ``FEC_AUTO``
 351
 352        -  Autodetect Error Correction Code
 353
 354     -  .. row 4
 355
 356        -  .. _`FEC-1-2`:
 357
 358           ``FEC_1_2``
 359
 360        -  Forward Error Correction Code 1/2
 361
 362     -  .. row 5
 363
 364        -  .. _`FEC-2-3`:
 365
 366           ``FEC_2_3``
 367
 368        -  Forward Error Correction Code 2/3
 369
 370     -  .. row 6
 371
 372        -  .. _`FEC-3-4`:
 373
 374           ``FEC_3_4``
 375
 376        -  Forward Error Correction Code 3/4
 377
 378     -  .. row 7
 379
 380        -  .. _`FEC-4-5`:
 381
 382           ``FEC_4_5``
 383
 384        -  Forward Error Correction Code 4/5
 385
 386     -  .. row 8
 387
 388        -  .. _`FEC-5-6`:
 389
 390           ``FEC_5_6``
 391
 392        -  Forward Error Correction Code 5/6
 393
 394     -  .. row 9
 395
 396        -  .. _`FEC-6-7`:
 397
 398           ``FEC_6_7``
 399
 400        -  Forward Error Correction Code 6/7
 401
 402     -  .. row 10
 403
 404        -  .. _`FEC-7-8`:
 405
 406           ``FEC_7_8``
 407
 408        -  Forward Error Correction Code 7/8
 409
 410     -  .. row 11
 411
 412        -  .. _`FEC-8-9`:
 413
 414           ``FEC_8_9``
 415
 416        -  Forward Error Correction Code 8/9
 417
 418     -  .. row 12
 419
 420        -  .. _`FEC-9-10`:
 421
 422           ``FEC_9_10``
 423
 424        -  Forward Error Correction Code 9/10
 425
 426     -  .. row 13
 427
 428        -  .. _`FEC-2-5`:
 429
 430           ``FEC_2_5``
 431
 432        -  Forward Error Correction Code 2/5
 433
 434     -  .. row 14
 435
 436        -  .. _`FEC-3-5`:
 437
 438           ``FEC_3_5``
 439
 440        -  Forward Error Correction Code 3/5
 441
 442
 443
 444 .. _DTV-VOLTAGE:
 445
 446 DTV_VOLTAGE
 447 ===========
 448
 449 The voltage is usually used with non-DiSEqC capable LNBs to switch the
 450 polarzation (horizontal/vertical). When using DiSEqC epuipment this
 451 voltage has to be switched consistently to the DiSEqC commands as
 452 described in the DiSEqC spec.
 453
 454
 455 .. _fe-sec-voltage:
 456
 457 .. flat-table:: enum fe_sec_voltage
 458     :header-rows:  1
 459     :stub-columns: 0
 460
 461
 462     -  .. row 1
 463
 464        -  ID
 465
 466        -  Description
 467
 468     -  .. row 2
 469
 470        -  .. _`SEC-VOLTAGE-13`:
 471
 472           ``SEC_VOLTAGE_13``
 473
 474        -  Set DC voltage level to 13V
 475
 476     -  .. row 3
 477
 478        -  .. _`SEC-VOLTAGE-18`:
 479
 480           ``SEC_VOLTAGE_18``
 481
 482        -  Set DC voltage level to 18V
 483
 484     -  .. row 4
 485
 486        -  .. _`SEC-VOLTAGE-OFF`:
 487
 488           ``SEC_VOLTAGE_OFF``
 489
 490        -  Don't send any voltage to the antenna
 491
 492
 493
 494 .. _DTV-TONE:
 495
 496 DTV_TONE
 497 ========
 498
 499 Currently not used.
 500
 501
 502 .. _DTV-PILOT:
 503
 504 DTV_PILOT
 505 =========
 506
 507 Sets DVB-S2 pilot
 508
 509
 510 .. _fe-pilot-t:
 511
 512 fe_pilot type
 513 -------------
 514
 515
 516 .. _fe-pilot:
 517
 518 .. flat-table:: enum fe_pilot
 519     :header-rows:  1
 520     :stub-columns: 0
 521
 522
 523     -  .. row 1
 524
 525        -  ID
 526
 527        -  Description
 528
 529     -  .. row 2
 530
 531        -  .. _`PILOT-ON`:
 532
 533           ``PILOT_ON``
 534
 535        -  Pilot tones enabled
 536
 537     -  .. row 3
 538
 539        -  .. _`PILOT-OFF`:
 540
 541           ``PILOT_OFF``
 542
 543        -  Pilot tones disabled
 544
 545     -  .. row 4
 546
 547        -  .. _`PILOT-AUTO`:
 548
 549           ``PILOT_AUTO``
 550
 551        -  Autodetect pilot tones
 552
 553
 554
 555 .. _DTV-ROLLOFF:
 556
 557 DTV_ROLLOFF
 558 ===========
 559
 560 Sets DVB-S2 rolloff
 561
 562
 563 .. _fe-rolloff-t:
 564
 565 fe_rolloff type
 566 ---------------
 567
 568
 569 .. _fe-rolloff:
 570
 571 .. flat-table:: enum fe_rolloff
 572     :header-rows:  1
 573     :stub-columns: 0
 574
 575
 576     -  .. row 1
 577
 578        -  ID
 579
 580        -  Description
 581
 582     -  .. row 2
 583
 584        -  .. _`ROLLOFF-35`:
 585
 586           ``ROLLOFF_35``
 587
 588        -  Roloff factor: α=35%
 589
 590     -  .. row 3
 591
 592        -  .. _`ROLLOFF-20`:
 593
 594           ``ROLLOFF_20``
 595
 596        -  Roloff factor: α=20%
 597
 598     -  .. row 4
 599
 600        -  .. _`ROLLOFF-25`:
 601
 602           ``ROLLOFF_25``
 603
 604        -  Roloff factor: α=25%
 605
 606     -  .. row 5
 607
 608        -  .. _`ROLLOFF-AUTO`:
 609
 610           ``ROLLOFF_AUTO``
 611
 612        -  Auto-detect the roloff factor.
 613
 614
 615
 616 .. _DTV-DISEQC-SLAVE-REPLY:
 617
 618 DTV_DISEQC_SLAVE_REPLY
 619 ======================
 620
 621 Currently not implemented.
 622
 623
 624 .. _DTV-FE-CAPABILITY-COUNT:
 625
 626 DTV_FE_CAPABILITY_COUNT
 627 =======================
 628
 629 Currently not implemented.
 630
 631
 632 .. _DTV-FE-CAPABILITY:
 633
 634 DTV_FE_CAPABILITY
 635 =================
 636
 637 Currently not implemented.
 638
 639
 640 .. _DTV-DELIVERY-SYSTEM:
 641
 642 DTV_DELIVERY_SYSTEM
 643 ===================
 644
 645 Specifies the type of Delivery system
 646
 647
 648 .. _fe-delivery-system-t:
 649
 650 fe_delivery_system type
 651 -----------------------
 652
 653 Possible values:
 654
 655
 656 .. _fe-delivery-system:
 657
 658 .. flat-table:: enum fe_delivery_system
 659     :header-rows:  1
 660     :stub-columns: 0
 661
 662
 663     -  .. row 1
 664
 665        -  ID
 666
 667        -  Description
 668
 669     -  .. row 2
 670
 671        -  .. _`SYS-UNDEFINED`:
 672
 673           ``SYS_UNDEFINED``
 674
 675        -  Undefined standard. Generally, indicates an error
 676
 677     -  .. row 3
 678
 679        -  .. _`SYS-DVBC-ANNEX-A`:
 680
 681           ``SYS_DVBC_ANNEX_A``
 682
 683        -  Cable TV: DVB-C following ITU-T J.83 Annex A spec
 684
 685     -  .. row 4
 686
 687        -  .. _`SYS-DVBC-ANNEX-B`:
 688
 689           ``SYS_DVBC_ANNEX_B``
 690
 691        -  Cable TV: DVB-C following ITU-T J.83 Annex B spec (ClearQAM)
 692
 693     -  .. row 5
 694
 695        -  .. _`SYS-DVBC-ANNEX-C`:
 696
 697           ``SYS_DVBC_ANNEX_C``
 698
 699        -  Cable TV: DVB-C following ITU-T J.83 Annex C spec
 700
 701     -  .. row 6
 702
 703        -  .. _`SYS-ISDBC`:
 704
 705           ``SYS_ISDBC``
 706
 707        -  Cable TV: ISDB-C (no drivers yet)
 708
 709     -  .. row 7
 710
 711        -  .. _`SYS-DVBT`:
 712
 713           ``SYS_DVBT``
 714
 715        -  Terrestral TV: DVB-T
 716
 717     -  .. row 8
 718
 719        -  .. _`SYS-DVBT2`:
 720
 721           ``SYS_DVBT2``
 722
 723        -  Terrestral TV: DVB-T2
 724
 725     -  .. row 9
 726
 727        -  .. _`SYS-ISDBT`:
 728
 729           ``SYS_ISDBT``
 730
 731        -  Terrestral TV: ISDB-T
 732
 733     -  .. row 10
 734
 735        -  .. _`SYS-ATSC`:
 736
 737           ``SYS_ATSC``
 738
 739        -  Terrestral TV: ATSC
 740
 741     -  .. row 11
 742
 743        -  .. _`SYS-ATSCMH`:
 744
 745           ``SYS_ATSCMH``
 746
 747        -  Terrestral TV (mobile): ATSC-M/H
 748
 749     -  .. row 12
 750
 751        -  .. _`SYS-DTMB`:
 752
 753           ``SYS_DTMB``
 754
 755        -  Terrestrial TV: DTMB
 756
 757     -  .. row 13
 758
 759        -  .. _`SYS-DVBS`:
 760
 761           ``SYS_DVBS``
 762
 763        -  Satellite TV: DVB-S
 764
 765     -  .. row 14
 766
 767        -  .. _`SYS-DVBS2`:
 768
 769           ``SYS_DVBS2``
 770
 771        -  Satellite TV: DVB-S2
 772
 773     -  .. row 15
 774
 775        -  .. _`SYS-TURBO`:
 776
 777           ``SYS_TURBO``
 778
 779        -  Satellite TV: DVB-S Turbo
 780
 781     -  .. row 16
 782
 783        -  .. _`SYS-ISDBS`:
 784
 785           ``SYS_ISDBS``
 786
 787        -  Satellite TV: ISDB-S
 788
 789     -  .. row 17
 790
 791        -  .. _`SYS-DAB`:
 792
 793           ``SYS_DAB``
 794
 795        -  Digital audio: DAB (not fully supported)
 796
 797     -  .. row 18
 798
 799        -  .. _`SYS-DSS`:
 800
 801           ``SYS_DSS``
 802
 803        -  Satellite TV:"DSS (not fully supported)
 804
 805     -  .. row 19
 806
 807        -  .. _`SYS-CMMB`:
 808
 809           ``SYS_CMMB``
 810
 811        -  Terrestral TV (mobile):CMMB (not fully supported)
 812
 813     -  .. row 20
 814
 815        -  .. _`SYS-DVBH`:
 816
 817           ``SYS_DVBH``
 818
 819        -  Terrestral TV (mobile): DVB-H (standard deprecated)
 820
 821
 822
 823 .. _DTV-ISDBT-PARTIAL-RECEPTION:
 824
 825 DTV_ISDBT_PARTIAL_RECEPTION
 826 ===========================
 827
 828 If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
 829 whether the channel is in partial reception mode or not.
 830
 831 If '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
 832 and ``DTV_ISDBT_LAYERA_SEGMENT_COUNT`` has to be '1'.
 833
 834 If in addition ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'
 835 ``DTV_ISDBT_PARTIAL_RECEPTION`` represents whether this ISDB-Tsb channel
 836 is consisting of one segment and layer or three segments and two layers.
 837
 838 Possible values: 0, 1, -1 (AUTO)
 839
 840
 841 .. _DTV-ISDBT-SOUND-BROADCASTING:
 842
 843 DTV_ISDBT_SOUND_BROADCASTING
 844 ============================
 845
 846 This field represents whether the other DTV_ISDBT_*-parameters are
 847 referring to an ISDB-T and an ISDB-Tsb channel. (See also
 848 ``DTV_ISDBT_PARTIAL_RECEPTION``).
 849
 850 Possible values: 0, 1, -1 (AUTO)
 851
 852
 853 .. _DTV-ISDBT-SB-SUBCHANNEL-ID:
 854
 855 DTV_ISDBT_SB_SUBCHANNEL_ID
 856 ==========================
 857
 858 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
 859
 860 (Note of the author: This might not be the correct description of the
 861 ``SUBCHANNEL-ID`` in all details, but it is my understanding of the
 862 technical background needed to program a device)
 863
 864 An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
 865 set of connected ISDB-Tsb channels. In this set of channels every
 866 channel can be received independently. The number of connected ISDB-Tsb
 867 segment can vary, e.g. depending on the frequency spectrum bandwidth
 868 available.
 869
 870 Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
 871 broadcaster has several possibilities to put those channels in the air:
 872 Assuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
 873 from position 1-8 to 5-13 or anything in between.
 874
 875 The underlying layer of segments are subchannels: each segment is
 876 consisting of several subchannels with a predefined IDs. A sub-channel
 877 is used to help the demodulator to synchronize on the channel.
 878
 879 An ISDB-T channel is always centered over all sub-channels. As for the
 880 example above, in ISDB-Tsb it is no longer as simple as that.
 881
 882 ``The DTV_ISDBT_SB_SUBCHANNEL_ID`` parameter is used to give the
 883 sub-channel ID of the segment to be demodulated.
 884
 885 Possible values: 0 .. 41, -1 (AUTO)
 886
 887
 888 .. _DTV-ISDBT-SB-SEGMENT-IDX:
 889
 890 DTV_ISDBT_SB_SEGMENT_IDX
 891 ========================
 892
 893 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
 894
 895 ``DTV_ISDBT_SB_SEGMENT_IDX`` gives the index of the segment to be
 896 demodulated for an ISDB-Tsb channel where several of them are
 897 transmitted in the connected manner.
 898
 899 Possible values: 0 .. ``DTV_ISDBT_SB_SEGMENT_COUNT`` - 1
 900
 901 Note: This value cannot be determined by an automatic channel search.
 902
 903
 904 .. _DTV-ISDBT-SB-SEGMENT-COUNT:
 905
 906 DTV_ISDBT_SB_SEGMENT_COUNT
 907 ==========================
 908
 909 This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
 910
 911 ``DTV_ISDBT_SB_SEGMENT_COUNT`` gives the total count of connected
 912 ISDB-Tsb channels.
 913
 914 Possible values: 1 .. 13
 915
 916 Note: This value cannot be determined by an automatic channel search.
 917
 918
 919 .. _isdb-hierq-layers:
 920
 921 DTV-ISDBT-LAYER[A-C] parameters
 922 ===============================
 923
 924 ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
 925 ISDB-T hierarchical layers can be decoded simultaneously. For that
 926 reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.
 927
 928 ISDB-T has 3 hierarchical layers which each can use a part of the
 929 available segments. The total number of segments over all layers has to
 930 13 in ISDB-T.
 931
 932 There are 3 parameter sets, for Layers A, B and C.
 933
 934
 935 .. _DTV-ISDBT-LAYER-ENABLED:
 936
 937 DTV_ISDBT_LAYER_ENABLED
 938 -----------------------
 939
 940 Hierarchical reception in ISDB-T is achieved by enabling or disabling
 941 layers in the decoding process. Setting all bits of
 942 ``DTV_ISDBT_LAYER_ENABLED`` to '1' forces all layers (if applicable) to
 943 be demodulated. This is the default.
 944
 945 If the channel is in the partial reception mode
 946 (``DTV_ISDBT_PARTIAL_RECEPTION`` = 1) the central segment can be decoded
 947 independently of the other 12 segments. In that mode layer A has to have
 948 a ``SEGMENT_COUNT`` of 1.
 949
 950 In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
 951 to ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
 952 accordingly.
 953
 954 Only the values of the first 3 bits are used. Other bits will be silently ignored:
 955
 956 ``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
 957
 958 ``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
 959
 960 ``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
 961
 962 ``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
 963
 964
 965 .. _DTV-ISDBT-LAYER-FEC:
 966
 967 DTV_ISDBT_LAYER[A-C]_FEC
 968 ------------------------
 969
 970 Possible values: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
 971 ``FEC_5_6``, ``FEC_7_8``
 972
 973
 974 .. _DTV-ISDBT-LAYER-MODULATION:
 975
 976 DTV_ISDBT_LAYER[A-C]_MODULATION
 977 -------------------------------
 978
 979 Possible values: ``QAM_AUTO``, QP\ ``SK, QAM_16``, ``QAM_64``, ``DQPSK``
 980
 981 Note: If layer C is ``DQPSK`` layer B has to be ``DQPSK``. If layer B is
 982 ``DQPSK`` and ``DTV_ISDBT_PARTIAL_RECEPTION``\ =0 layer has to be
 983 ``DQPSK``.
 984
 985
 986 .. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
 987
 988 DTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
 989 ----------------------------------
 990
 991 Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
 992
 993 Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
 994 ``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
 995
 996
 997 .. _isdbt-layer_seg-cnt-table:
 998
 999 .. flat-table::
1000     :header-rows:  0
1001     :stub-columns: 0
1002
1003
1004     -  .. row 1
1005
1006        -  PR
1007
1008        -  SB
1009
1010        -  Layer A width
1011
1012        -  Layer B width
1013
1014        -  Layer C width
1015
1016        -  total width
1017
1018     -  .. row 2
1019
1020        -  0
1021
1022        -  0
1023
1024        -  1 .. 13
1025
1026        -  1 .. 13
1027
1028        -  1 .. 13
1029
1030        -  13
1031
1032     -  .. row 3
1033
1034        -  1
1035
1036        -  0
1037
1038        -  1
1039
1040        -  1 .. 13
1041
1042        -  1 .. 13
1043
1044        -  13
1045
1046     -  .. row 4
1047
1048        -  0
1049
1050        -  1
1051
1052        -  1
1053
1054        -  0
1055
1056        -  0
1057
1058        -  1
1059
1060     -  .. row 5
1061
1062        -  1
1063
1064        -  1
1065
1066        -  1
1067
1068        -  2
1069
1070        -  0
1071
1072        -  13
1073
1074
1075
1076 .. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
1077
1078 DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
1079 --------------------------------------
1080
1081 Valid values: 0, 1, 2, 4, -1 (AUTO)
1082
1083 when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.
1084
1085 Note: The real time interleaving length depends on the mode (fft-size).
1086 The values here are referring to what can be found in the
1087 TMCC-structure, as shown in the table below.
1088
1089
1090 .. _isdbt-layer-interleaving-table:
1091
1092 .. flat-table::
1093     :header-rows:  0
1094     :stub-columns: 0
1095
1096
1097     -  .. row 1
1098
1099        -  ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
1100
1101        -  Mode 1 (2K FFT)
1102
1103        -  Mode 2 (4K FFT)
1104
1105        -  Mode 3 (8K FFT)
1106
1107     -  .. row 2
1108
1109        -  0
1110
1111        -  0
1112
1113        -  0
1114
1115        -  0
1116
1117     -  .. row 3
1118
1119        -  1
1120
1121        -  4
1122
1123        -  2
1124
1125        -  1
1126
1127     -  .. row 4
1128
1129        -  2
1130
1131        -  8
1132
1133        -  4
1134
1135        -  2
1136
1137     -  .. row 5
1138
1139        -  4
1140
1141        -  16
1142
1143        -  8
1144
1145        -  4
1146
1147
1148
1149 .. _DTV-ATSCMH-FIC-VER:
1150
1151 DTV_ATSCMH_FIC_VER
1152 ------------------
1153
1154 Version number of the FIC (Fast Information Channel) signaling data.
1155
1156 FIC is used for relaying information to allow rapid service acquisition
1157 by the receiver.
1158
1159 Possible values: 0, 1, 2, 3, ..., 30, 31
1160
1161
1162 .. _DTV-ATSCMH-PARADE-ID:
1163
1164 DTV_ATSCMH_PARADE_ID
1165 --------------------
1166
1167 Parade identification number
1168
1169 A parade is a collection of up to eight MH groups, conveying one or two
1170 ensembles.
1171
1172 Possible values: 0, 1, 2, 3, ..., 126, 127
1173
1174
1175 .. _DTV-ATSCMH-NOG:
1176
1177 DTV_ATSCMH_NOG
1178 --------------
1179
1180 Number of MH groups per MH subframe for a designated parade.
1181
1182 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
1183
1184
1185 .. _DTV-ATSCMH-TNOG:
1186
1187 DTV_ATSCMH_TNOG
1188 ---------------
1189
1190 Total number of MH groups including all MH groups belonging to all MH
1191 parades in one MH subframe.
1192
1193 Possible values: 0, 1, 2, 3, ..., 30, 31
1194
1195
1196 .. _DTV-ATSCMH-SGN:
1197
1198 DTV_ATSCMH_SGN
1199 --------------
1200
1201 Start group number.
1202
1203 Possible values: 0, 1, 2, 3, ..., 14, 15
1204
1205
1206 .. _DTV-ATSCMH-PRC:
1207
1208 DTV_ATSCMH_PRC
1209 --------------
1210
1211 Parade repetition cycle.
1212
1213 Possible values: 1, 2, 3, 4, 5, 6, 7, 8
1214
1215
1216 .. _DTV-ATSCMH-RS-FRAME-MODE:
1217
1218 DTV_ATSCMH_RS_FRAME_MODE
1219 ------------------------
1220
1221 Reed Solomon (RS) frame mode.
1222
1223 Possible values are:
1224
1225
1226 .. _atscmh-rs-frame-mode:
1227
1228 .. flat-table:: enum atscmh_rs_frame_mode
1229     :header-rows:  1
1230     :stub-columns: 0
1231
1232
1233     -  .. row 1
1234
1235        -  ID
1236
1237        -  Description
1238
1239     -  .. row 2
1240
1241        -  .. _`ATSCMH-RSFRAME-PRI-ONLY`:
1242
1243           ``ATSCMH_RSFRAME_PRI_ONLY``
1244
1245        -  Single Frame: There is only a primary RS Frame for all Group
1246           Regions.
1247
1248     -  .. row 3
1249
1250        -  .. _`ATSCMH-RSFRAME-PRI-SEC`:
1251
1252           ``ATSCMH_RSFRAME_PRI_SEC``
1253
1254        -  Dual Frame: There are two separate RS Frames: Primary RS Frame for
1255           Group Region A and B and Secondary RS Frame for Group Region C and
1256           D.
1257
1258
1259
1260 .. _DTV-ATSCMH-RS-FRAME-ENSEMBLE:
1261
1262 DTV_ATSCMH_RS_FRAME_ENSEMBLE
1263 ----------------------------
1264
1265 Reed Solomon(RS) frame ensemble.
1266
1267 Possible values are:
1268
1269
1270 .. _atscmh-rs-frame-ensemble:
1271
1272 .. flat-table:: enum atscmh_rs_frame_ensemble
1273     :header-rows:  1
1274     :stub-columns: 0
1275
1276
1277     -  .. row 1
1278
1279        -  ID
1280
1281        -  Description
1282
1283     -  .. row 2
1284
1285        -  .. _`ATSCMH-RSFRAME-ENS-PRI`:
1286
1287           ``ATSCMH_RSFRAME_ENS_PRI``
1288
1289        -  Primary Ensemble.
1290
1291     -  .. row 3
1292
1293        -  .. _`ATSCMH-RSFRAME-ENS-SEC`:
1294
1295           ``AATSCMH_RSFRAME_PRI_SEC``
1296
1297        -  Secondary Ensemble.
1298
1299     -  .. row 4
1300
1301        -  .. _`ATSCMH-RSFRAME-RES`:
1302
1303           ``AATSCMH_RSFRAME_RES``
1304
1305        -  Reserved. Shouldn't be used.
1306
1307
1308
1309 .. _DTV-ATSCMH-RS-CODE-MODE-PRI:
1310
1311 DTV_ATSCMH_RS_CODE_MODE_PRI
1312 ---------------------------
1313
1314 Reed Solomon (RS) code mode (primary).
1315
1316 Possible values are:
1317
1318
1319 .. _atscmh-rs-code-mode:
1320
1321 .. flat-table:: enum atscmh_rs_code_mode
1322     :header-rows:  1
1323     :stub-columns: 0
1324
1325
1326     -  .. row 1
1327
1328        -  ID
1329
1330        -  Description
1331
1332     -  .. row 2
1333
1334        -  .. _`ATSCMH-RSCODE-211-187`:
1335
1336           ``ATSCMH_RSCODE_211_187``
1337
1338        -  Reed Solomon code (211,187).
1339
1340     -  .. row 3
1341
1342        -  .. _`ATSCMH-RSCODE-223-187`:
1343
1344           ``ATSCMH_RSCODE_223_187``
1345
1346        -  Reed Solomon code (223,187).
1347
1348     -  .. row 4
1349
1350        -  .. _`ATSCMH-RSCODE-235-187`:
1351
1352           ``ATSCMH_RSCODE_235_187``
1353
1354        -  Reed Solomon code (235,187).
1355
1356     -  .. row 5
1357
1358        -  .. _`ATSCMH-RSCODE-RES`:
1359
1360           ``ATSCMH_RSCODE_RES``
1361
1362        -  Reserved. Shouldn't be used.
1363
1364
1365
1366 .. _DTV-ATSCMH-RS-CODE-MODE-SEC:
1367
1368 DTV_ATSCMH_RS_CODE_MODE_SEC
1369 ---------------------------
1370
1371 Reed Solomon (RS) code mode (secondary).
1372
1373 Possible values are the same as documented on enum
1374 :ref:`atscmh_rs_code_mode <atscmh-rs-code-mode>`:
1375
1376
1377 .. _DTV-ATSCMH-SCCC-BLOCK-MODE:
1378
1379 DTV_ATSCMH_SCCC_BLOCK_MODE
1380 --------------------------
1381
1382 Series Concatenated Convolutional Code Block Mode.
1383
1384 Possible values are:
1385
1386
1387 .. _atscmh-sccc-block-mode:
1388
1389 .. flat-table:: enum atscmh_scc_block_mode
1390     :header-rows:  1
1391     :stub-columns: 0
1392
1393
1394     -  .. row 1
1395
1396        -  ID
1397
1398        -  Description
1399
1400     -  .. row 2
1401
1402        -  .. _`ATSCMH-SCCC-BLK-SEP`:
1403
1404           ``ATSCMH_SCCC_BLK_SEP``
1405
1406        -  Separate SCCC: the SCCC outer code mode shall be set independently
1407           for each Group Region (A, B, C, D)
1408
1409     -  .. row 3
1410
1411        -  .. _`ATSCMH-SCCC-BLK-COMB`:
1412
1413           ``ATSCMH_SCCC_BLK_COMB``
1414
1415        -  Combined SCCC: all four Regions shall have the same SCCC outer
1416           code mode.
1417
1418     -  .. row 4
1419
1420        -  .. _`ATSCMH-SCCC-BLK-RES`:
1421
1422           ``ATSCMH_SCCC_BLK_RES``
1423
1424        -  Reserved. Shouldn't be used.
1425
1426
1427
1428 .. _DTV-ATSCMH-SCCC-CODE-MODE-A:
1429
1430 DTV_ATSCMH_SCCC_CODE_MODE_A
1431 ---------------------------
1432
1433 Series Concatenated Convolutional Code Rate.
1434
1435 Possible values are:
1436
1437
1438 .. _atscmh-sccc-code-mode:
1439
1440 .. flat-table:: enum atscmh_sccc_code_mode
1441     :header-rows:  1
1442     :stub-columns: 0
1443
1444
1445     -  .. row 1
1446
1447        -  ID
1448
1449        -  Description
1450
1451     -  .. row 2
1452
1453        -  .. _`ATSCMH-SCCC-CODE-HLF`:
1454
1455           ``ATSCMH_SCCC_CODE_HLF``
1456
1457        -  The outer code rate of a SCCC Block is 1/2 rate.
1458
1459     -  .. row 3
1460
1461        -  .. _`ATSCMH-SCCC-CODE-QTR`:
1462
1463           ``ATSCMH_SCCC_CODE_QTR``
1464
1465        -  The outer code rate of a SCCC Block is 1/4 rate.
1466
1467     -  .. row 4
1468
1469        -  .. _`ATSCMH-SCCC-CODE-RES`:
1470
1471           ``ATSCMH_SCCC_CODE_RES``
1472
1473        -  to be documented.
1474
1475
1476
1477 .. _DTV-ATSCMH-SCCC-CODE-MODE-B:
1478
1479 DTV_ATSCMH_SCCC_CODE_MODE_B
1480 ---------------------------
1481
1482 Series Concatenated Convolutional Code Rate.
1483
1484 Possible values are the same as documented on enum
1485 :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`.
1486
1487
1488 .. _DTV-ATSCMH-SCCC-CODE-MODE-C:
1489
1490 DTV_ATSCMH_SCCC_CODE_MODE_C
1491 ---------------------------
1492
1493 Series Concatenated Convolutional Code Rate.
1494
1495 Possible values are the same as documented on enum
1496 :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`.
1497
1498
1499 .. _DTV-ATSCMH-SCCC-CODE-MODE-D:
1500
1501 DTV_ATSCMH_SCCC_CODE_MODE_D
1502 ---------------------------
1503
1504 Series Concatenated Convolutional Code Rate.
1505
1506 Possible values are the same as documented on enum
1507 :ref:`atscmh_sccc_code_mode <atscmh-sccc-code-mode>`.
1508
1509
1510 .. _DTV-API-VERSION:
1511
1512 DTV_API_VERSION
1513 ===============
1514
1515 Returns the major/minor version of the DVB API
1516
1517
1518 .. _DTV-CODE-RATE-HP:
1519
1520 DTV_CODE_RATE_HP
1521 ================
1522
1523 Used on terrestrial transmissions. The acceptable values are the ones
1524 described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`.
1525
1526
1527 .. _DTV-CODE-RATE-LP:
1528
1529 DTV_CODE_RATE_LP
1530 ================
1531
1532 Used on terrestrial transmissions. The acceptable values are the ones
1533 described at :ref:`fe_transmit_mode_t <fe-transmit-mode-t>`.
1534
1535
1536 .. _DTV-GUARD-INTERVAL:
1537
1538 DTV_GUARD_INTERVAL
1539 ==================
1540
1541 Possible values are:
1542
1543
1544 .. _fe-guard-interval-t:
1545
1546 Modulation guard interval
1547 -------------------------
1548
1549
1550 .. _fe-guard-interval:
1551
1552 .. flat-table:: enum fe_guard_interval
1553     :header-rows:  1
1554     :stub-columns: 0
1555
1556
1557     -  .. row 1
1558
1559        -  ID
1560
1561        -  Description
1562
1563     -  .. row 2
1564
1565        -  .. _`GUARD-INTERVAL-AUTO`:
1566
1567           ``GUARD_INTERVAL_AUTO``
1568
1569        -  Autodetect the guard interval
1570
1571     -  .. row 3
1572
1573        -  .. _`GUARD-INTERVAL-1-128`:
1574
1575           ``GUARD_INTERVAL_1_128``
1576
1577        -  Guard interval 1/128
1578
1579     -  .. row 4
1580
1581        -  .. _`GUARD-INTERVAL-1-32`:
1582
1583           ``GUARD_INTERVAL_1_32``
1584
1585        -  Guard interval 1/32
1586
1587     -  .. row 5
1588
1589        -  .. _`GUARD-INTERVAL-1-16`:
1590
1591           ``GUARD_INTERVAL_1_16``
1592
1593        -  Guard interval 1/16
1594
1595     -  .. row 6
1596
1597        -  .. _`GUARD-INTERVAL-1-8`:
1598
1599           ``GUARD_INTERVAL_1_8``
1600
1601        -  Guard interval 1/8
1602
1603     -  .. row 7
1604
1605        -  .. _`GUARD-INTERVAL-1-4`:
1606
1607           ``GUARD_INTERVAL_1_4``
1608
1609        -  Guard interval 1/4
1610
1611     -  .. row 8
1612
1613        -  .. _`GUARD-INTERVAL-19-128`:
1614
1615           ``GUARD_INTERVAL_19_128``
1616
1617        -  Guard interval 19/128
1618
1619     -  .. row 9
1620
1621        -  .. _`GUARD-INTERVAL-19-256`:
1622
1623           ``GUARD_INTERVAL_19_256``
1624
1625        -  Guard interval 19/256
1626
1627     -  .. row 10
1628
1629        -  .. _`GUARD-INTERVAL-PN420`:
1630
1631           ``GUARD_INTERVAL_PN420``
1632
1633        -  PN length 420 (1/4)
1634
1635     -  .. row 11
1636
1637        -  .. _`GUARD-INTERVAL-PN595`:
1638
1639           ``GUARD_INTERVAL_PN595``
1640
1641        -  PN length 595 (1/6)
1642
1643     -  .. row 12
1644
1645        -  .. _`GUARD-INTERVAL-PN945`:
1646
1647           ``GUARD_INTERVAL_PN945``
1648
1649        -  PN length 945 (1/9)
1650
1651
1652 Notes:
1653
1654 1) If ``DTV_GUARD_INTERVAL`` is set the ``GUARD_INTERVAL_AUTO`` the
1655 hardware will try to find the correct guard interval (if capable) and
1656 will use TMCC to fill in the missing parameters.
1657
1658 2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at
1659 present
1660
1661 3) DTMB specifies PN420, PN595 and PN945.
1662
1663
1664 .. _DTV-TRANSMISSION-MODE:
1665
1666 DTV_TRANSMISSION_MODE
1667 =====================
1668
1669 Specifies the number of carriers used by the standard. This is used only
1670 on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB
1671
1672
1673 .. _fe-transmit-mode-t:
1674
1675 enum fe_transmit_mode: Number of carriers per channel
1676 -----------------------------------------------------
1677
1678
1679 .. _fe-transmit-mode:
1680
1681 .. flat-table:: enum fe_transmit_mode
1682     :header-rows:  1
1683     :stub-columns: 0
1684
1685
1686     -  .. row 1
1687
1688        -  ID
1689
1690        -  Description
1691
1692     -  .. row 2
1693
1694        -  .. _`TRANSMISSION-MODE-AUTO`:
1695
1696           ``TRANSMISSION_MODE_AUTO``
1697
1698        -  Autodetect transmission mode. The hardware will try to find the
1699           correct FFT-size (if capable) to fill in the missing parameters.
1700
1701     -  .. row 3
1702
1703        -  .. _`TRANSMISSION-MODE-1K`:
1704
1705           ``TRANSMISSION_MODE_1K``
1706
1707        -  Transmission mode 1K
1708
1709     -  .. row 4
1710
1711        -  .. _`TRANSMISSION-MODE-2K`:
1712
1713           ``TRANSMISSION_MODE_2K``
1714
1715        -  Transmission mode 2K
1716
1717     -  .. row 5
1718
1719        -  .. _`TRANSMISSION-MODE-8K`:
1720
1721           ``TRANSMISSION_MODE_8K``
1722
1723        -  Transmission mode 8K
1724
1725     -  .. row 6
1726
1727        -  .. _`TRANSMISSION-MODE-4K`:
1728
1729           ``TRANSMISSION_MODE_4K``
1730
1731        -  Transmission mode 4K
1732
1733     -  .. row 7
1734
1735        -  .. _`TRANSMISSION-MODE-16K`:
1736
1737           ``TRANSMISSION_MODE_16K``
1738
1739        -  Transmission mode 16K
1740
1741     -  .. row 8
1742
1743        -  .. _`TRANSMISSION-MODE-32K`:
1744
1745           ``TRANSMISSION_MODE_32K``
1746
1747        -  Transmission mode 32K
1748
1749     -  .. row 9
1750
1751        -  .. _`TRANSMISSION-MODE-C1`:
1752
1753           ``TRANSMISSION_MODE_C1``
1754
1755        -  Single Carrier (C=1) transmission mode (DTMB)
1756
1757     -  .. row 10
1758
1759        -  .. _`TRANSMISSION-MODE-C3780`:
1760
1761           ``TRANSMISSION_MODE_C3780``
1762
1763        -  Multi Carrier (C=3780) transmission mode (DTMB)
1764
1765
1766 Notes:
1767
1768 1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
1769 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K
1770
1771 2) If ``DTV_TRANSMISSION_MODE`` is set the ``TRANSMISSION_MODE_AUTO``
1772 the hardware will try to find the correct FFT-size (if capable) and will
1773 use TMCC to fill in the missing parameters.
1774
1775 3) DVB-T specifies 2K and 8K as valid sizes.
1776
1777 4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
1778
1779 5) DTMB specifies C1 and C3780.
1780
1781
1782 .. _DTV-HIERARCHY:
1783
1784 DTV_HIERARCHY
1785 =============
1786
1787 Frontend hierarchy
1788
1789
1790 .. _fe-hierarchy-t:
1791
1792 Frontend hierarchy
1793 ------------------
1794
1795
1796 .. _fe-hierarchy:
1797
1798 .. flat-table:: enum fe_hierarchy
1799     :header-rows:  1
1800     :stub-columns: 0
1801
1802
1803     -  .. row 1
1804
1805        -  ID
1806
1807        -  Description
1808
1809     -  .. row 2
1810
1811        -  .. _`HIERARCHY-NONE`:
1812
1813           ``HIERARCHY_NONE``
1814
1815        -  No hierarchy
1816
1817     -  .. row 3
1818
1819        -  .. _`HIERARCHY-AUTO`:
1820
1821           ``HIERARCHY_AUTO``
1822
1823        -  Autodetect hierarchy (if supported)
1824
1825     -  .. row 4
1826
1827        -  .. _`HIERARCHY-1`:
1828
1829           ``HIERARCHY_1``
1830
1831        -  Hierarchy 1
1832
1833     -  .. row 5
1834
1835        -  .. _`HIERARCHY-2`:
1836
1837           ``HIERARCHY_2``
1838
1839        -  Hierarchy 2
1840
1841     -  .. row 6
1842
1843        -  .. _`HIERARCHY-4`:
1844
1845           ``HIERARCHY_4``
1846
1847        -  Hierarchy 4
1848
1849
1850
1851 .. _DTV-STREAM-ID:
1852
1853 DTV_STREAM_ID
1854 =============
1855
1856 DVB-S2, DVB-T2 and ISDB-S support the transmission of several streams on
1857 a single transport stream. This property enables the DVB driver to
1858 handle substream filtering, when supported by the hardware. By default,
1859 substream filtering is disabled.
1860
1861 For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255.
1862
1863 For ISDB, the valid substream id range is from 1 to 65535.
1864
1865 To disable it, you should use the special macro NO_STREAM_ID_FILTER.
1866
1867 Note: any value outside the id range also disables filtering.
1868
1869
1870 .. _DTV-DVBT2-PLP-ID-LEGACY:
1871
1872 DTV_DVBT2_PLP_ID_LEGACY
1873 =======================
1874
1875 Obsolete, replaced with DTV_STREAM_ID.
1876
1877
1878 .. _DTV-ENUM-DELSYS:
1879
1880 DTV_ENUM_DELSYS
1881 ===============
1882
1883 A Multi standard frontend needs to advertise the delivery systems
1884 provided. Applications need to enumerate the provided delivery systems,
1885 before using any other operation with the frontend. Prior to it's
1886 introduction, FE_GET_INFO was used to determine a frontend type. A
1887 frontend which provides more than a single delivery system,
1888 FE_GET_INFO doesn't help much. Applications which intends to use a
1889 multistandard frontend must enumerate the delivery systems associated
1890 with it, rather than trying to use FE_GET_INFO. In the case of a
1891 legacy frontend, the result is just the same as with FE_GET_INFO, but
1892 in a more structured format
1893
1894
1895 .. _DTV-INTERLEAVING:
1896
1897 DTV_INTERLEAVING
1898 ================
1899
1900 Time interleaving to be used. Currently, used only on DTMB.
1901
1902
1903 .. _fe-interleaving:
1904
1905 .. flat-table:: enum fe_interleaving
1906     :header-rows:  1
1907     :stub-columns: 0
1908
1909
1910     -  .. row 1
1911
1912        -  ID
1913
1914        -  Description
1915
1916     -  .. row 2
1917
1918        -  .. _`INTERLEAVING-NONE`:
1919
1920           ``INTERLEAVING_NONE``
1921
1922        -  No interleaving.
1923
1924     -  .. row 3
1925
1926        -  .. _`INTERLEAVING-AUTO`:
1927
1928           ``INTERLEAVING_AUTO``
1929
1930        -  Auto-detect interleaving.
1931
1932     -  .. row 4
1933
1934        -  .. _`INTERLEAVING-240`:
1935
1936           ``INTERLEAVING_240``
1937
1938        -  Interleaving of 240 symbols.
1939
1940     -  .. row 5
1941
1942        -  .. _`INTERLEAVING-720`:
1943
1944           ``INTERLEAVING_720``
1945
1946        -  Interleaving of 720 symbols.
1947
1948
1949
1950 .. _DTV-LNA:
1951
1952 DTV_LNA
1953 =======
1954
1955 Low-noise amplifier.
1956
1957 Hardware might offer controllable LNA which can be set manually using
1958 that parameter. Usually LNA could be found only from terrestrial devices
1959 if at all.
1960
1961 Possible values: 0, 1, LNA_AUTO
1962
1963 0, LNA off
1964
1965 1, LNA on
1966
1967 use the special macro LNA_AUTO to set LNA auto