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