Merge tag 'staging-5.8-rc3' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / frontend-property-terrestrial-systems.rst
blob1079522b2425095c0505235e16432498a407abd5
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/userspace-api/media/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
10 .. _frontend-property-terrestrial-systems:
12 ***********************************************
13 Properties used on terrestrial delivery systems
14 ***********************************************
17 .. _dvbt-params:
19 DVB-T delivery system
20 =====================
22 The following parameters are valid for DVB-T:
24 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
26 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
28 -  :ref:`DTV_TUNE <DTV-TUNE>`
30 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
32 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
34 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
36 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
38 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
40 -  :ref:`DTV_CODE_RATE_HP <DTV-CODE-RATE-HP>`
42 -  :ref:`DTV_CODE_RATE_LP <DTV-CODE-RATE-LP>`
44 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
46 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
48 -  :ref:`DTV_HIERARCHY <DTV-HIERARCHY>`
50 -  :ref:`DTV_LNA <DTV-LNA>`
52 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
53 are also valid.
56 .. _dvbt2-params:
58 DVB-T2 delivery system
59 ======================
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.
64 The following parameters are valid for DVB-T2:
66 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
68 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
70 -  :ref:`DTV_TUNE <DTV-TUNE>`
72 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
74 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
76 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
78 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
80 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
82 -  :ref:`DTV_CODE_RATE_HP <DTV-CODE-RATE-HP>`
84 -  :ref:`DTV_CODE_RATE_LP <DTV-CODE-RATE-LP>`
86 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
88 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
90 -  :ref:`DTV_HIERARCHY <DTV-HIERARCHY>`
92 -  :ref:`DTV_STREAM_ID <DTV-STREAM-ID>`
94 -  :ref:`DTV_LNA <DTV-LNA>`
96 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
97 are also valid.
100 .. _isdbt:
102 ISDB-T delivery system
103 ======================
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.
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.
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:
117 ARIB STD-B31 - "Transmission System for Digital Terrestrial Television
118 Broadcasting" and
120 ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial Television
121 Broadcasting".
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.
129 The following parameters are valid for ISDB-T:
131 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
133 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
135 -  :ref:`DTV_TUNE <DTV-TUNE>`
137 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
139 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
141 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
143 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
145 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
147 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
149 -  :ref:`DTV_ISDBT_LAYER_ENABLED <DTV-ISDBT-LAYER-ENABLED>`
151 -  :ref:`DTV_ISDBT_PARTIAL_RECEPTION <DTV-ISDBT-PARTIAL-RECEPTION>`
153 -  :ref:`DTV_ISDBT_SOUND_BROADCASTING <DTV-ISDBT-SOUND-BROADCASTING>`
155 -  :ref:`DTV_ISDBT_SB_SUBCHANNEL_ID <DTV-ISDBT-SB-SUBCHANNEL-ID>`
157 -  :ref:`DTV_ISDBT_SB_SEGMENT_IDX <DTV-ISDBT-SB-SEGMENT-IDX>`
159 -  :ref:`DTV_ISDBT_SB_SEGMENT_COUNT <DTV-ISDBT-SB-SEGMENT-COUNT>`
161 -  :ref:`DTV_ISDBT_LAYERA_FEC <DTV-ISDBT-LAYER-FEC>`
163 -  :ref:`DTV_ISDBT_LAYERA_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
165 -  :ref:`DTV_ISDBT_LAYERA_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
167 -  :ref:`DTV_ISDBT_LAYERA_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
169 -  :ref:`DTV_ISDBT_LAYERB_FEC <DTV-ISDBT-LAYER-FEC>`
171 -  :ref:`DTV_ISDBT_LAYERB_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
173 -  :ref:`DTV_ISDBT_LAYERB_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
175 -  :ref:`DTV_ISDBT_LAYERB_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
177 -  :ref:`DTV_ISDBT_LAYERC_FEC <DTV-ISDBT-LAYER-FEC>`
179 -  :ref:`DTV_ISDBT_LAYERC_MODULATION <DTV-ISDBT-LAYER-MODULATION>`
181 -  :ref:`DTV_ISDBT_LAYERC_SEGMENT_COUNT <DTV-ISDBT-LAYER-SEGMENT-COUNT>`
183 -  :ref:`DTV_ISDBT_LAYERC_TIME_INTERLEAVING <DTV-ISDBT-LAYER-TIME-INTERLEAVING>`
185 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
186 are also valid.
189 .. _atsc-params:
191 ATSC delivery system
192 ====================
194 The following parameters are valid for ATSC:
196 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
198 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
200 -  :ref:`DTV_TUNE <DTV-TUNE>`
202 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
204 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
206 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
208 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
210 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
211 are also valid.
214 .. _atscmh-params:
216 ATSC-MH delivery system
217 =======================
219 The following parameters are valid for ATSC-MH:
221 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
223 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
225 -  :ref:`DTV_TUNE <DTV-TUNE>`
227 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
229 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
231 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
233 -  :ref:`DTV_ATSCMH_FIC_VER <DTV-ATSCMH-FIC-VER>`
235 -  :ref:`DTV_ATSCMH_PARADE_ID <DTV-ATSCMH-PARADE-ID>`
237 -  :ref:`DTV_ATSCMH_NOG <DTV-ATSCMH-NOG>`
239 -  :ref:`DTV_ATSCMH_TNOG <DTV-ATSCMH-TNOG>`
241 -  :ref:`DTV_ATSCMH_SGN <DTV-ATSCMH-SGN>`
243 -  :ref:`DTV_ATSCMH_PRC <DTV-ATSCMH-PRC>`
245 -  :ref:`DTV_ATSCMH_RS_FRAME_MODE <DTV-ATSCMH-RS-FRAME-MODE>`
247 -  :ref:`DTV_ATSCMH_RS_FRAME_ENSEMBLE <DTV-ATSCMH-RS-FRAME-ENSEMBLE>`
249 -  :ref:`DTV_ATSCMH_RS_CODE_MODE_PRI <DTV-ATSCMH-RS-CODE-MODE-PRI>`
251 -  :ref:`DTV_ATSCMH_RS_CODE_MODE_SEC <DTV-ATSCMH-RS-CODE-MODE-SEC>`
253 -  :ref:`DTV_ATSCMH_SCCC_BLOCK_MODE <DTV-ATSCMH-SCCC-BLOCK-MODE>`
255 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_A <DTV-ATSCMH-SCCC-CODE-MODE-A>`
257 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_B <DTV-ATSCMH-SCCC-CODE-MODE-B>`
259 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_C <DTV-ATSCMH-SCCC-CODE-MODE-C>`
261 -  :ref:`DTV_ATSCMH_SCCC_CODE_MODE_D <DTV-ATSCMH-SCCC-CODE-MODE-D>`
263 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
264 are also valid.
267 .. _dtmb-params:
269 DTMB delivery system
270 ====================
272 The following parameters are valid for DTMB:
274 -  :ref:`DTV_API_VERSION <DTV-API-VERSION>`
276 -  :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
278 -  :ref:`DTV_TUNE <DTV-TUNE>`
280 -  :ref:`DTV_CLEAR <DTV-CLEAR>`
282 -  :ref:`DTV_FREQUENCY <DTV-FREQUENCY>`
284 -  :ref:`DTV_MODULATION <DTV-MODULATION>`
286 -  :ref:`DTV_BANDWIDTH_HZ <DTV-BANDWIDTH-HZ>`
288 -  :ref:`DTV_INVERSION <DTV-INVERSION>`
290 -  :ref:`DTV_INNER_FEC <DTV-INNER-FEC>`
292 -  :ref:`DTV_GUARD_INTERVAL <DTV-GUARD-INTERVAL>`
294 -  :ref:`DTV_TRANSMISSION_MODE <DTV-TRANSMISSION-MODE>`
296 -  :ref:`DTV_INTERLEAVING <DTV-INTERLEAVING>`
298 -  :ref:`DTV_LNA <DTV-LNA>`
300 In addition, the :ref:`DTV QoS statistics <frontend-stat-properties>`
301 are also valid.