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