Documentation/media/uapi/dvb/frontend-property-terrestrial-systems.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _frontend-property-terrestrial-systems:
  11
  12 ***********************************************
  13 Properties used on terrestrial delivery systems
  14 ***********************************************
  15
  16
  17 .. _dvbt-params:
  18
  19 DVB-T delivery system
  20 =====================
  21
  22 The following parameters are valid for DVB-T:
  23
  24 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
  25
  26 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
  27
  28 -  :ref:`DTV_TUNE <DTV-TUNE>`
  29
  30 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
  31
  32 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
  33
  34 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
  35
  36 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
  37
  38 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
  39
  40 -  :ref:`DTV_CODE_RATE_HP <DTV-CODE-RATE-HP>`
  41
  42 -  :ref:`DTV_CODE_RATE_LP <DTV-CODE-RATE-LP>`
  43
  44 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
  45
  46 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
  47
  48 -  :ref:`DTV_HIERARCHY <DTV-HIERARCHY>`
  49
  50 -  :ref:`DTV_LNA <DTV-LNA>`
  51
  52 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
  53 are also valid.
  54
  55
  56 .. _dvbt2-params:
  57
  58 DVB-T2 delivery system
  59 ======================
  60
  61 DVB-T2 support is currently in the early stages of development, so
  62 expect that this section maygrow and become more detailed with time.
  63
  64 The following parameters are valid for DVB-T2:
  65
  66 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
  67
  68 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
  69
  70 -  :ref:`DTV_TUNE <DTV-TUNE>`
  71
  72 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
  73
  74 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
  75
  76 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
  77
  78 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
  79
  80 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
  81
  82 -  :ref:`DTV_CODE_RATE_HP <DTV-CODE-RATE-HP>`
  83
  84 -  :ref:`DTV_CODE_RATE_LP <DTV-CODE-RATE-LP>`
  85
  86 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
  87
  88 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
  89
  90 -  :ref:`DTV_HIERARCHY <DTV-HIERARCHY>`
  91
  92 -  :ref:`DTV_STREAM_ID <DTV-STREAM-ID>`
  93
  94 -  :ref:`DTV_LNA <DTV-LNA>`
  95
  96 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
  97 are also valid.
  98
  99
 100 .. _isdbt:
 101
 102 ISDB-T delivery system
 103 ======================
 104
 105 This ISDB-T/ISDB-Tsb API extension should reflect all information needed
 106 to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible that some
 107 very sophisticated devices won't need certain parameters to tune.
 108
 109 The information given here should help application writers to know how
 110 to handle ISDB-T and ISDB-Tsb hardware using the Linux Digital TV API.
 111
 112 The details given here about ISDB-T and ISDB-Tsb are just enough to
 113 basically show the dependencies between the needed parameter values, but
 114 surely some information is left out. For more detailed information see
 115 the following documents:
 116
 117 ARIB STD-B31 - "Transmission System for Digital Terrestrial Television
 118 Broadcasting" and
 119
 120 ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial Television
 121 Broadcasting".
 122
 123 In order to understand the ISDB specific parameters, one has to have
 124 some knowledge the channel structure in ISDB-T and ISDB-Tsb. I.e. it has
 125 to be known to the reader that an ISDB-T channel consists of 13
 126 segments, that it can have up to 3 layer sharing those segments, and
 127 things like that.
 128
 129 The following parameters are valid for ISDB-T:
 130
 131 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
 132
 133 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
 134
 135 -  :ref:`DTV_TUNE <DTV-TUNE>`
 136
 137 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
 138
 139 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
 140
 141 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
 142
 143 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
 144
 145 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
 146
 147 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
 148
 149 -  :ref:`DTV_ISDBT_LAYER_ENABLED <DTV-ISDBT-LAYER-ENABLED>`
 150
 151 -  :ref:`DTV_ISDBT_PARTIAL_RECEPTION <DTV-ISDBT-PARTIAL-RECEPTION>`
 152
 153 -  :ref:`DTV_ISDBT_SOUND_BROADCASTING <DTV-ISDBT-SOUND-BROADCASTING>`
 154
 155 -  :ref:`DTV_ISDBT_SB_SUBCHANNEL_ID <DTV-ISDBT-SB-SUBCHANNEL-ID>`
 156
 157 -  :ref:`DTV_ISDBT_SB_SEGMENT_IDX <DTV-ISDBT-SB-SEGMENT-IDX>`
 158
 159 -  :ref:`DTV_ISDBT_SB_SEGMENT_COUNT <DTV-ISDBT-SB-SEGMENT-COUNT>`
 160
 161 -  :ref:`DTV_ISDBT_LAYERA_FEC <DTV-ISDBT-LAYER-FEC>`
 162
 163 -  :ref:`DTV_ISDBT_LAYERA_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
 164
 165 -  :ref:`DTV_ISDBT_LAYERA_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
 166
 167 -  :ref:`DTV_ISDBT_LAYERA_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
 168
 169 -  :ref:`DTV_ISDBT_LAYERB_FEC <DTV-ISDBT-LAYER-FEC>`
 170
 171 -  :ref:`DTV_ISDBT_LAYERB_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
 172
 173 -  :ref:`DTV_ISDBT_LAYERB_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
 174
 175 -  :ref:`DTV_ISDBT_LAYERB_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
 176
 177 -  :ref:`DTV_ISDBT_LAYERC_FEC <DTV-ISDBT-LAYER-FEC>`
 178
 179 -  :ref:`DTV_ISDBT_LAYERC_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
 180
 181 -  :ref:`DTV_ISDBT_LAYERC_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
 182
 183 -  :ref:`DTV_ISDBT_LAYERC_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
 184
 185 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
 186 are also valid.
 187
 188
 189 .. _atsc-params:
 190
 191 ATSC delivery system
 192 ====================
 193
 194 The following parameters are valid for ATSC:
 195
 196 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
 197
 198 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
 199
 200 -  :ref:`DTV_TUNE <DTV-TUNE>`
 201
 202 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
 203
 204 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
 205
 206 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
 207
 208 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
 209
 210 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
 211 are also valid.
 212
 213
 214 .. _atscmh-params:
 215
 216 ATSC-MH delivery system
 217 =======================
 218
 219 The following parameters are valid for ATSC-MH:
 220
 221 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
 222
 223 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
 224
 225 -  :ref:`DTV_TUNE <DTV-TUNE>`
 226
 227 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
 228
 229 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
 230
 231 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
 232
 233 -  :ref:`DTV_ATSCMH_FIC_VER <DTV-ATSCMH-FIC-VER>`
 234
 235 -  :ref:`DTV_ATSCMH_PARADE_ID <DTV-ATSCMH-PARADE-ID>`
 236
 237 -  :ref:`DTV_ATSCMH_NOG <DTV-ATSCMH-NOG>`
 238
 239 -  :ref:`DTV_ATSCMH_TNOG <DTV-ATSCMH-TNOG>`
 240
 241 -  :ref:`DTV_ATSCMH_SGN <DTV-ATSCMH-SGN>`
 242
 243 -  :ref:`DTV_ATSCMH_PRC <DTV-ATSCMH-PRC>`
 244
 245 -  :ref:`DTV_ATSCMH_RS_FRAME_MODE <DTV-ATSCMH-RS-FRAME-MODE>`
 246
 247 -  :ref:`DTV_ATSCMH_RS_FRAME_ENSEMBLE <DTV-ATSCMH-RS-FRAME-ENSEMBLE>`
 248
 249 -  :ref:`DTV_ATSCMH_RS_CODE_MODE_PRI <DTV-ATSCMH-RS-CODE-MODE-PRI>`
 250
 251 -  :ref:`DTV_ATSCMH_RS_CODE_MODE_SEC <DTV-ATSCMH-RS-CODE-MODE-SEC>`
 252
 253 -  :ref:`DTV_ATSCMH_SCCC_BLOCK_MODE <DTV-ATSCMH-SCCC-BLOCK-MODE>`
 254
 255 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_A <DTV-ATSCMH-SCCC-CODE-MODE-A>`
 256
 257 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_B <DTV-ATSCMH-SCCC-CODE-MODE-B>`
 258
 259 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_C <DTV-ATSCMH-SCCC-CODE-MODE-C>`
 260
 261 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_D <DTV-ATSCMH-SCCC-CODE-MODE-D>`
 262
 263 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
 264 are also valid.
 265
 266
 267 .. _dtmb-params:
 268
 269 DTMB delivery system
 270 ====================
 271
 272 The following parameters are valid for DTMB:
 273
 274 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
 275
 276 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
 277
 278 -  :ref:`DTV_TUNE <DTV-TUNE>`
 279
 280 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
 281
 282 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
 283
 284 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
 285
 286 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
 287
 288 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
 289
 290 -  :ref:`DTV_INNER_FEC <DTV-INNER-FEC>`
 291
 292 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
 293
 294 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
 295
 296 -  :ref:`DTV_INTERLEAVING <DTV-INTERLEAVING>`
 297
 298 -  :ref:`DTV_LNA <DTV-LNA>`
 299
 300 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
 301 are also valid.