xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/fe_property_parameters.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun.. _fe_property_parameters:
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun******************************
6*4882a593SmuzhiyunDigital TV property parameters
7*4882a593Smuzhiyun******************************
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunThere are several different Digital TV parameters that can be used by
10*4882a593Smuzhiyun:ref:`FE_SET_PROPERTY and FE_GET_PROPERTY ioctls<FE_GET_PROPERTY>`.
11*4882a593SmuzhiyunThis section describes each of them. Please notice, however, that only
12*4882a593Smuzhiyuna subset of them are needed to setup a frontend.
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun.. _DTV-UNDEFINED:
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunDTV_UNDEFINED
18*4882a593Smuzhiyun=============
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunUsed internally. A GET/SET operation for it won't change or return
21*4882a593Smuzhiyunanything.
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun.. _DTV-TUNE:
25*4882a593Smuzhiyun
26*4882a593SmuzhiyunDTV_TUNE
27*4882a593Smuzhiyun========
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunInterpret the cache of data, build either a traditional frontend
30*4882a593Smuzhiyuntunerequest so we can pass validation in the ``FE_SET_FRONTEND`` ioctl.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun.. _DTV-CLEAR:
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunDTV_CLEAR
36*4882a593Smuzhiyun=========
37*4882a593Smuzhiyun
38*4882a593SmuzhiyunReset a cache of data specific to the frontend here. This does not
39*4882a593Smuzhiyuneffect hardware.
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun.. _DTV-FREQUENCY:
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunDTV_FREQUENCY
45*4882a593Smuzhiyun=============
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunFrequency of the digital TV transponder/channel.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun.. note::
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun  #. For satellite delivery systems, the frequency is in kHz.
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun  #. For cable and terrestrial delivery systems, the frequency is in
54*4882a593Smuzhiyun     Hz.
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun  #. On most delivery systems, the frequency is the center frequency
57*4882a593Smuzhiyun     of the transponder/channel. The exception is for ISDB-T, where
58*4882a593Smuzhiyun     the main carrier has a 1/7 offset from the center.
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun  #. For ISDB-T, the channels are usually transmitted with an offset of
61*4882a593Smuzhiyun     about 143kHz. E.g. a valid frequency could be 474,143 kHz. The
62*4882a593Smuzhiyun     stepping is  bound to the bandwidth of the channel which is
63*4882a593Smuzhiyun     typically 6MHz.
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun  #. In ISDB-Tsb, the channel consists of only one or three segments the
66*4882a593Smuzhiyun     frequency step is 429kHz, 3*429 respectively.
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun.. _DTV-MODULATION:
70*4882a593Smuzhiyun
71*4882a593SmuzhiyunDTV_MODULATION
72*4882a593Smuzhiyun==============
73*4882a593Smuzhiyun
74*4882a593SmuzhiyunSpecifies the frontend modulation type for delivery systems that
75*4882a593Smuzhiyunsupports more multiple modulations.
76*4882a593Smuzhiyun
77*4882a593SmuzhiyunThe modulation can be one of the types defined by enum :c:type:`fe_modulation`.
78*4882a593Smuzhiyun
79*4882a593SmuzhiyunMost of the digital TV standards offers more than one possible
80*4882a593Smuzhiyunmodulation type.
81*4882a593Smuzhiyun
82*4882a593SmuzhiyunThe table below presents a summary of the types of modulation types
83*4882a593Smuzhiyunsupported by each delivery system, as currently defined by specs.
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun======================= =======================================================
86*4882a593SmuzhiyunStandard		Modulation types
87*4882a593Smuzhiyun======================= =======================================================
88*4882a593SmuzhiyunATSC (version 1)	8-VSB and 16-VSB.
89*4882a593SmuzhiyunDMTB			4-QAM, 16-QAM, 32-QAM, 64-QAM and 4-QAM-NR.
90*4882a593SmuzhiyunDVB-C Annex A/C		16-QAM, 32-QAM, 64-QAM and 256-QAM.
91*4882a593SmuzhiyunDVB-C Annex B		64-QAM.
92*4882a593SmuzhiyunDVB-T			QPSK, 16-QAM and 64-QAM.
93*4882a593SmuzhiyunDVB-T2			QPSK, 16-QAM, 64-QAM and 256-QAM.
94*4882a593SmuzhiyunDVB-S			No need to set. It supports only QPSK.
95*4882a593SmuzhiyunDVB-S2			QPSK, 8-PSK, 16-APSK and 32-APSK.
96*4882a593SmuzhiyunISDB-T			QPSK, DQPSK, 16-QAM and 64-QAM.
97*4882a593SmuzhiyunISDB-S			8-PSK, QPSK and BPSK.
98*4882a593Smuzhiyun======================= =======================================================
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun.. note::
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun   Please notice that some of the above modulation types may not be
103*4882a593Smuzhiyun   defined currently at the Kernel. The reason is simple: no driver
104*4882a593Smuzhiyun   needed such definition yet.
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun.. _DTV-BANDWIDTH-HZ:
108*4882a593Smuzhiyun
109*4882a593SmuzhiyunDTV_BANDWIDTH_HZ
110*4882a593Smuzhiyun================
111*4882a593Smuzhiyun
112*4882a593SmuzhiyunBandwidth for the channel, in HZ.
113*4882a593Smuzhiyun
114*4882a593SmuzhiyunShould be set only for terrestrial delivery systems.
115*4882a593Smuzhiyun
116*4882a593SmuzhiyunPossible values: ``1712000``, ``5000000``, ``6000000``, ``7000000``,
117*4882a593Smuzhiyun``8000000``, ``10000000``.
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun======================= =======================================================
120*4882a593SmuzhiyunTerrestrial Standard	Possible values for bandwidth
121*4882a593Smuzhiyun======================= =======================================================
122*4882a593SmuzhiyunATSC (version 1)	No need to set. It is always 6MHz.
123*4882a593SmuzhiyunDMTB			No need to set. It is always 8MHz.
124*4882a593SmuzhiyunDVB-T			6MHz, 7MHz and 8MHz.
125*4882a593SmuzhiyunDVB-T2			1.172 MHz, 5MHz, 6MHz, 7MHz, 8MHz and 10MHz
126*4882a593SmuzhiyunISDB-T			5MHz, 6MHz, 7MHz and 8MHz, although most places
127*4882a593Smuzhiyun			use 6MHz.
128*4882a593Smuzhiyun======================= =======================================================
129*4882a593Smuzhiyun
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun.. note::
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun  #. For ISDB-Tsb, the bandwidth can vary depending on the number of
135*4882a593Smuzhiyun     connected segments.
136*4882a593Smuzhiyun
137*4882a593Smuzhiyun     It can be easily derived from other parameters
138*4882a593Smuzhiyun     (DTV_ISDBT_SB_SEGMENT_IDX, DTV_ISDBT_SB_SEGMENT_COUNT).
139*4882a593Smuzhiyun
140*4882a593Smuzhiyun  #. On Satellite and Cable delivery systems, the bandwidth depends on
141*4882a593Smuzhiyun     the symbol rate. So, the Kernel will silently ignore any setting
142*4882a593Smuzhiyun     :ref:`DTV-BANDWIDTH-HZ`. I will however fill it back with a
143*4882a593Smuzhiyun     bandwidth estimation.
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun     Such bandwidth estimation takes into account the symbol rate set with
146*4882a593Smuzhiyun     :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
147*4882a593Smuzhiyun     DVB-C and DVB-S.
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun     For DVB-S2, the rolloff should also be set via :ref:`DTV-ROLLOFF`.
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun.. _DTV-INVERSION:
153*4882a593Smuzhiyun
154*4882a593SmuzhiyunDTV_INVERSION
155*4882a593Smuzhiyun=============
156*4882a593Smuzhiyun
157*4882a593SmuzhiyunSpecifies if the frontend should do spectral inversion or not.
158*4882a593Smuzhiyun
159*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_spectral_inversion`.
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun.. _DTV-DISEQC-MASTER:
163*4882a593Smuzhiyun
164*4882a593SmuzhiyunDTV_DISEQC_MASTER
165*4882a593Smuzhiyun=================
166*4882a593Smuzhiyun
167*4882a593SmuzhiyunCurrently not implemented.
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun
170*4882a593Smuzhiyun.. _DTV-SYMBOL-RATE:
171*4882a593Smuzhiyun
172*4882a593SmuzhiyunDTV_SYMBOL_RATE
173*4882a593Smuzhiyun===============
174*4882a593Smuzhiyun
175*4882a593SmuzhiyunUsed on cable and satellite delivery systems.
176*4882a593Smuzhiyun
177*4882a593SmuzhiyunDigital TV symbol rate, in bauds (symbols/second).
178*4882a593Smuzhiyun
179*4882a593Smuzhiyun
180*4882a593Smuzhiyun.. _DTV-INNER-FEC:
181*4882a593Smuzhiyun
182*4882a593SmuzhiyunDTV_INNER_FEC
183*4882a593Smuzhiyun=============
184*4882a593Smuzhiyun
185*4882a593SmuzhiyunUsed on cable and satellite delivery systems.
186*4882a593Smuzhiyun
187*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_code_rate`.
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun
190*4882a593Smuzhiyun.. _DTV-VOLTAGE:
191*4882a593Smuzhiyun
192*4882a593SmuzhiyunDTV_VOLTAGE
193*4882a593Smuzhiyun===========
194*4882a593Smuzhiyun
195*4882a593SmuzhiyunUsed on satellite delivery systems.
196*4882a593Smuzhiyun
197*4882a593SmuzhiyunThe voltage is usually used with non-DiSEqC capable LNBs to switch the
198*4882a593Smuzhiyunpolarzation (horizontal/vertical). When using DiSEqC epuipment this
199*4882a593Smuzhiyunvoltage has to be switched consistently to the DiSEqC commands as
200*4882a593Smuzhiyundescribed in the DiSEqC spec.
201*4882a593Smuzhiyun
202*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_sec_voltage`.
203*4882a593Smuzhiyun
204*4882a593Smuzhiyun
205*4882a593Smuzhiyun.. _DTV-TONE:
206*4882a593Smuzhiyun
207*4882a593SmuzhiyunDTV_TONE
208*4882a593Smuzhiyun========
209*4882a593Smuzhiyun
210*4882a593SmuzhiyunCurrently not used.
211*4882a593Smuzhiyun
212*4882a593Smuzhiyun
213*4882a593Smuzhiyun.. _DTV-PILOT:
214*4882a593Smuzhiyun
215*4882a593SmuzhiyunDTV_PILOT
216*4882a593Smuzhiyun=========
217*4882a593Smuzhiyun
218*4882a593SmuzhiyunUsed on DVB-S2.
219*4882a593Smuzhiyun
220*4882a593SmuzhiyunSets DVB-S2 pilot.
221*4882a593Smuzhiyun
222*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_pilot`.
223*4882a593Smuzhiyun
224*4882a593Smuzhiyun
225*4882a593Smuzhiyun.. _DTV-ROLLOFF:
226*4882a593Smuzhiyun
227*4882a593SmuzhiyunDTV_ROLLOFF
228*4882a593Smuzhiyun===========
229*4882a593Smuzhiyun
230*4882a593SmuzhiyunUsed on DVB-S2.
231*4882a593Smuzhiyun
232*4882a593SmuzhiyunSets DVB-S2 rolloff.
233*4882a593Smuzhiyun
234*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_rolloff`.
235*4882a593Smuzhiyun
236*4882a593Smuzhiyun
237*4882a593Smuzhiyun.. _DTV-DISEQC-SLAVE-REPLY:
238*4882a593Smuzhiyun
239*4882a593SmuzhiyunDTV_DISEQC_SLAVE_REPLY
240*4882a593Smuzhiyun======================
241*4882a593Smuzhiyun
242*4882a593SmuzhiyunCurrently not implemented.
243*4882a593Smuzhiyun
244*4882a593Smuzhiyun
245*4882a593Smuzhiyun.. _DTV-FE-CAPABILITY-COUNT:
246*4882a593Smuzhiyun
247*4882a593SmuzhiyunDTV_FE_CAPABILITY_COUNT
248*4882a593Smuzhiyun=======================
249*4882a593Smuzhiyun
250*4882a593SmuzhiyunCurrently not implemented.
251*4882a593Smuzhiyun
252*4882a593Smuzhiyun
253*4882a593Smuzhiyun.. _DTV-FE-CAPABILITY:
254*4882a593Smuzhiyun
255*4882a593SmuzhiyunDTV_FE_CAPABILITY
256*4882a593Smuzhiyun=================
257*4882a593Smuzhiyun
258*4882a593SmuzhiyunCurrently not implemented.
259*4882a593Smuzhiyun
260*4882a593Smuzhiyun
261*4882a593Smuzhiyun.. _DTV-DELIVERY-SYSTEM:
262*4882a593Smuzhiyun
263*4882a593SmuzhiyunDTV_DELIVERY_SYSTEM
264*4882a593Smuzhiyun===================
265*4882a593Smuzhiyun
266*4882a593SmuzhiyunSpecifies the type of the delivery system.
267*4882a593Smuzhiyun
268*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_delivery_system`.
269*4882a593Smuzhiyun
270*4882a593Smuzhiyun
271*4882a593Smuzhiyun.. _DTV-ISDBT-PARTIAL-RECEPTION:
272*4882a593Smuzhiyun
273*4882a593SmuzhiyunDTV_ISDBT_PARTIAL_RECEPTION
274*4882a593Smuzhiyun===========================
275*4882a593Smuzhiyun
276*4882a593SmuzhiyunUsed only on ISDB.
277*4882a593Smuzhiyun
278*4882a593SmuzhiyunIf ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
279*4882a593Smuzhiyunwhether the channel is in partial reception mode or not.
280*4882a593Smuzhiyun
281*4882a593SmuzhiyunIf '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
282*4882a593Smuzhiyunand ``DTV_ISDBT_LAYERA_SEGMENT_COUNT`` has to be '1'.
283*4882a593Smuzhiyun
284*4882a593SmuzhiyunIf in addition ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'
285*4882a593Smuzhiyun``DTV_ISDBT_PARTIAL_RECEPTION`` represents whether this ISDB-Tsb channel
286*4882a593Smuzhiyunis consisting of one segment and layer or three segments and two layers.
287*4882a593Smuzhiyun
288*4882a593SmuzhiyunPossible values: 0, 1, -1 (AUTO)
289*4882a593Smuzhiyun
290*4882a593Smuzhiyun
291*4882a593Smuzhiyun.. _DTV-ISDBT-SOUND-BROADCASTING:
292*4882a593Smuzhiyun
293*4882a593SmuzhiyunDTV_ISDBT_SOUND_BROADCASTING
294*4882a593Smuzhiyun============================
295*4882a593Smuzhiyun
296*4882a593SmuzhiyunUsed only on ISDB.
297*4882a593Smuzhiyun
298*4882a593SmuzhiyunThis field represents whether the other DTV_ISDBT_*-parameters are
299*4882a593Smuzhiyunreferring to an ISDB-T and an ISDB-Tsb channel. (See also
300*4882a593Smuzhiyun``DTV_ISDBT_PARTIAL_RECEPTION``).
301*4882a593Smuzhiyun
302*4882a593SmuzhiyunPossible values: 0, 1, -1 (AUTO)
303*4882a593Smuzhiyun
304*4882a593Smuzhiyun
305*4882a593Smuzhiyun.. _DTV-ISDBT-SB-SUBCHANNEL-ID:
306*4882a593Smuzhiyun
307*4882a593SmuzhiyunDTV_ISDBT_SB_SUBCHANNEL_ID
308*4882a593Smuzhiyun==========================
309*4882a593Smuzhiyun
310*4882a593SmuzhiyunUsed only on ISDB.
311*4882a593Smuzhiyun
312*4882a593SmuzhiyunThis field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
313*4882a593Smuzhiyun
314*4882a593Smuzhiyun(Note of the author: This might not be the correct description of the
315*4882a593Smuzhiyun``SUBCHANNEL-ID`` in all details, but it is my understanding of the
316*4882a593Smuzhiyuntechnical background needed to program a device)
317*4882a593Smuzhiyun
318*4882a593SmuzhiyunAn ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
319*4882a593Smuzhiyunset of connected ISDB-Tsb channels. In this set of channels every
320*4882a593Smuzhiyunchannel can be received independently. The number of connected ISDB-Tsb
321*4882a593Smuzhiyunsegment can vary, e.g. depending on the frequency spectrum bandwidth
322*4882a593Smuzhiyunavailable.
323*4882a593Smuzhiyun
324*4882a593SmuzhiyunExample: Assume 8 ISDB-Tsb connected segments are broadcasted. The
325*4882a593Smuzhiyunbroadcaster has several possibilities to put those channels in the air:
326*4882a593SmuzhiyunAssuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
327*4882a593Smuzhiyunfrom position 1-8 to 5-13 or anything in between.
328*4882a593Smuzhiyun
329*4882a593SmuzhiyunThe underlying layer of segments are subchannels: each segment is
330*4882a593Smuzhiyunconsisting of several subchannels with a predefined IDs. A sub-channel
331*4882a593Smuzhiyunis used to help the demodulator to synchronize on the channel.
332*4882a593Smuzhiyun
333*4882a593SmuzhiyunAn ISDB-T channel is always centered over all sub-channels. As for the
334*4882a593Smuzhiyunexample above, in ISDB-Tsb it is no longer as simple as that.
335*4882a593Smuzhiyun
336*4882a593Smuzhiyun``The DTV_ISDBT_SB_SUBCHANNEL_ID`` parameter is used to give the
337*4882a593Smuzhiyunsub-channel ID of the segment to be demodulated.
338*4882a593Smuzhiyun
339*4882a593SmuzhiyunPossible values: 0 .. 41, -1 (AUTO)
340*4882a593Smuzhiyun
341*4882a593Smuzhiyun
342*4882a593Smuzhiyun.. _DTV-ISDBT-SB-SEGMENT-IDX:
343*4882a593Smuzhiyun
344*4882a593SmuzhiyunDTV_ISDBT_SB_SEGMENT_IDX
345*4882a593Smuzhiyun========================
346*4882a593Smuzhiyun
347*4882a593SmuzhiyunUsed only on ISDB.
348*4882a593Smuzhiyun
349*4882a593SmuzhiyunThis field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
350*4882a593Smuzhiyun
351*4882a593Smuzhiyun``DTV_ISDBT_SB_SEGMENT_IDX`` gives the index of the segment to be
352*4882a593Smuzhiyundemodulated for an ISDB-Tsb channel where several of them are
353*4882a593Smuzhiyuntransmitted in the connected manner.
354*4882a593Smuzhiyun
355*4882a593SmuzhiyunPossible values: 0 .. ``DTV_ISDBT_SB_SEGMENT_COUNT`` - 1
356*4882a593Smuzhiyun
357*4882a593SmuzhiyunNote: This value cannot be determined by an automatic channel search.
358*4882a593Smuzhiyun
359*4882a593Smuzhiyun
360*4882a593Smuzhiyun.. _DTV-ISDBT-SB-SEGMENT-COUNT:
361*4882a593Smuzhiyun
362*4882a593SmuzhiyunDTV_ISDBT_SB_SEGMENT_COUNT
363*4882a593Smuzhiyun==========================
364*4882a593Smuzhiyun
365*4882a593SmuzhiyunUsed only on ISDB.
366*4882a593Smuzhiyun
367*4882a593SmuzhiyunThis field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
368*4882a593Smuzhiyun
369*4882a593Smuzhiyun``DTV_ISDBT_SB_SEGMENT_COUNT`` gives the total count of connected
370*4882a593SmuzhiyunISDB-Tsb channels.
371*4882a593Smuzhiyun
372*4882a593SmuzhiyunPossible values: 1 .. 13
373*4882a593Smuzhiyun
374*4882a593SmuzhiyunNote: This value cannot be determined by an automatic channel search.
375*4882a593Smuzhiyun
376*4882a593Smuzhiyun
377*4882a593Smuzhiyun.. _isdb-hierq-layers:
378*4882a593Smuzhiyun
379*4882a593SmuzhiyunDTV-ISDBT-LAYER[A-C] parameters
380*4882a593Smuzhiyun===============================
381*4882a593Smuzhiyun
382*4882a593SmuzhiyunUsed only on ISDB.
383*4882a593Smuzhiyun
384*4882a593SmuzhiyunISDB-T channels can be coded hierarchically. As opposed to DVB-T in
385*4882a593SmuzhiyunISDB-T hierarchical layers can be decoded simultaneously. For that
386*4882a593Smuzhiyunreason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.
387*4882a593Smuzhiyun
388*4882a593SmuzhiyunISDB-T has 3 hierarchical layers which each can use a part of the
389*4882a593Smuzhiyunavailable segments. The total number of segments over all layers has to
390*4882a593Smuzhiyun13 in ISDB-T.
391*4882a593Smuzhiyun
392*4882a593SmuzhiyunThere are 3 parameter sets, for Layers A, B and C.
393*4882a593Smuzhiyun
394*4882a593Smuzhiyun
395*4882a593Smuzhiyun.. _DTV-ISDBT-LAYER-ENABLED:
396*4882a593Smuzhiyun
397*4882a593SmuzhiyunDTV_ISDBT_LAYER_ENABLED
398*4882a593Smuzhiyun-----------------------
399*4882a593Smuzhiyun
400*4882a593SmuzhiyunUsed only on ISDB.
401*4882a593Smuzhiyun
402*4882a593SmuzhiyunHierarchical reception in ISDB-T is achieved by enabling or disabling
403*4882a593Smuzhiyunlayers in the decoding process. Setting all bits of
404*4882a593Smuzhiyun``DTV_ISDBT_LAYER_ENABLED`` to '1' forces all layers (if applicable) to
405*4882a593Smuzhiyunbe demodulated. This is the default.
406*4882a593Smuzhiyun
407*4882a593SmuzhiyunIf the channel is in the partial reception mode
408*4882a593Smuzhiyun(``DTV_ISDBT_PARTIAL_RECEPTION`` = 1) the central segment can be decoded
409*4882a593Smuzhiyunindependently of the other 12 segments. In that mode layer A has to have
410*4882a593Smuzhiyuna ``SEGMENT_COUNT`` of 1.
411*4882a593Smuzhiyun
412*4882a593SmuzhiyunIn ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
413*4882a593Smuzhiyunto ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
414*4882a593Smuzhiyunaccordingly.
415*4882a593Smuzhiyun
416*4882a593SmuzhiyunOnly the values of the first 3 bits are used. Other bits will be silently ignored:
417*4882a593Smuzhiyun
418*4882a593Smuzhiyun``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
419*4882a593Smuzhiyun
420*4882a593Smuzhiyun``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
421*4882a593Smuzhiyun
422*4882a593Smuzhiyun``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
423*4882a593Smuzhiyun
424*4882a593Smuzhiyun``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
425*4882a593Smuzhiyun
426*4882a593Smuzhiyun
427*4882a593Smuzhiyun.. _DTV-ISDBT-LAYER-FEC:
428*4882a593Smuzhiyun
429*4882a593SmuzhiyunDTV_ISDBT_LAYER[A-C]_FEC
430*4882a593Smuzhiyun------------------------
431*4882a593Smuzhiyun
432*4882a593SmuzhiyunUsed only on ISDB.
433*4882a593Smuzhiyun
434*4882a593SmuzhiyunThe Forward Error Correction mechanism used by a given ISDB Layer, as
435*4882a593Smuzhiyundefined by :c:type:`fe_code_rate`.
436*4882a593Smuzhiyun
437*4882a593Smuzhiyun
438*4882a593SmuzhiyunPossible values are: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
439*4882a593Smuzhiyun``FEC_5_6``, ``FEC_7_8``
440*4882a593Smuzhiyun
441*4882a593Smuzhiyun
442*4882a593Smuzhiyun.. _DTV-ISDBT-LAYER-MODULATION:
443*4882a593Smuzhiyun
444*4882a593SmuzhiyunDTV_ISDBT_LAYER[A-C]_MODULATION
445*4882a593Smuzhiyun-------------------------------
446*4882a593Smuzhiyun
447*4882a593SmuzhiyunUsed only on ISDB.
448*4882a593Smuzhiyun
449*4882a593SmuzhiyunThe modulation used by a given ISDB Layer, as defined by
450*4882a593Smuzhiyun:c:type:`fe_modulation`.
451*4882a593Smuzhiyun
452*4882a593SmuzhiyunPossible values are: ``QAM_AUTO``, ``QPSK``, ``QAM_16``, ``QAM_64``, ``DQPSK``
453*4882a593Smuzhiyun
454*4882a593Smuzhiyun.. note::
455*4882a593Smuzhiyun
456*4882a593Smuzhiyun   #. If layer C is ``DQPSK``, then layer B has to be ``DQPSK``.
457*4882a593Smuzhiyun
458*4882a593Smuzhiyun   #. If layer B is ``DQPSK`` and ``DTV_ISDBT_PARTIAL_RECEPTION``\ = 0,
459*4882a593Smuzhiyun      then layer has to be ``DQPSK``.
460*4882a593Smuzhiyun
461*4882a593Smuzhiyun
462*4882a593Smuzhiyun.. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
463*4882a593Smuzhiyun
464*4882a593SmuzhiyunDTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
465*4882a593Smuzhiyun----------------------------------
466*4882a593Smuzhiyun
467*4882a593SmuzhiyunUsed only on ISDB.
468*4882a593Smuzhiyun
469*4882a593SmuzhiyunPossible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
470*4882a593Smuzhiyun
471*4882a593SmuzhiyunNote: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
472*4882a593Smuzhiyun``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
473*4882a593Smuzhiyun
474*4882a593Smuzhiyun.. _isdbt-layer_seg-cnt-table:
475*4882a593Smuzhiyun
476*4882a593Smuzhiyun.. flat-table:: Truth table for ISDB-T Sound Broadcasting
477*4882a593Smuzhiyun    :header-rows:  1
478*4882a593Smuzhiyun    :stub-columns: 0
479*4882a593Smuzhiyun
480*4882a593Smuzhiyun
481*4882a593Smuzhiyun    -  .. row 1
482*4882a593Smuzhiyun
483*4882a593Smuzhiyun       -  Partial Reception
484*4882a593Smuzhiyun
485*4882a593Smuzhiyun       -  Sound Broadcasting
486*4882a593Smuzhiyun
487*4882a593Smuzhiyun       -  Layer A width
488*4882a593Smuzhiyun
489*4882a593Smuzhiyun       -  Layer B width
490*4882a593Smuzhiyun
491*4882a593Smuzhiyun       -  Layer C width
492*4882a593Smuzhiyun
493*4882a593Smuzhiyun       -  total width
494*4882a593Smuzhiyun
495*4882a593Smuzhiyun    -  .. row 2
496*4882a593Smuzhiyun
497*4882a593Smuzhiyun       -  0
498*4882a593Smuzhiyun
499*4882a593Smuzhiyun       -  0
500*4882a593Smuzhiyun
501*4882a593Smuzhiyun       -  1 .. 13
502*4882a593Smuzhiyun
503*4882a593Smuzhiyun       -  1 .. 13
504*4882a593Smuzhiyun
505*4882a593Smuzhiyun       -  1 .. 13
506*4882a593Smuzhiyun
507*4882a593Smuzhiyun       -  13
508*4882a593Smuzhiyun
509*4882a593Smuzhiyun    -  .. row 3
510*4882a593Smuzhiyun
511*4882a593Smuzhiyun       -  1
512*4882a593Smuzhiyun
513*4882a593Smuzhiyun       -  0
514*4882a593Smuzhiyun
515*4882a593Smuzhiyun       -  1
516*4882a593Smuzhiyun
517*4882a593Smuzhiyun       -  1 .. 13
518*4882a593Smuzhiyun
519*4882a593Smuzhiyun       -  1 .. 13
520*4882a593Smuzhiyun
521*4882a593Smuzhiyun       -  13
522*4882a593Smuzhiyun
523*4882a593Smuzhiyun    -  .. row 4
524*4882a593Smuzhiyun
525*4882a593Smuzhiyun       -  0
526*4882a593Smuzhiyun
527*4882a593Smuzhiyun       -  1
528*4882a593Smuzhiyun
529*4882a593Smuzhiyun       -  1
530*4882a593Smuzhiyun
531*4882a593Smuzhiyun       -  0
532*4882a593Smuzhiyun
533*4882a593Smuzhiyun       -  0
534*4882a593Smuzhiyun
535*4882a593Smuzhiyun       -  1
536*4882a593Smuzhiyun
537*4882a593Smuzhiyun    -  .. row 5
538*4882a593Smuzhiyun
539*4882a593Smuzhiyun       -  1
540*4882a593Smuzhiyun
541*4882a593Smuzhiyun       -  1
542*4882a593Smuzhiyun
543*4882a593Smuzhiyun       -  1
544*4882a593Smuzhiyun
545*4882a593Smuzhiyun       -  2
546*4882a593Smuzhiyun
547*4882a593Smuzhiyun       -  0
548*4882a593Smuzhiyun
549*4882a593Smuzhiyun       -  13
550*4882a593Smuzhiyun
551*4882a593Smuzhiyun
552*4882a593Smuzhiyun
553*4882a593Smuzhiyun.. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
554*4882a593Smuzhiyun
555*4882a593SmuzhiyunDTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
556*4882a593Smuzhiyun--------------------------------------
557*4882a593Smuzhiyun
558*4882a593SmuzhiyunUsed only on ISDB.
559*4882a593Smuzhiyun
560*4882a593SmuzhiyunValid values: 0, 1, 2, 4, -1 (AUTO)
561*4882a593Smuzhiyun
562*4882a593Smuzhiyunwhen DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.
563*4882a593Smuzhiyun
564*4882a593SmuzhiyunNote: The real time interleaving length depends on the mode (fft-size).
565*4882a593SmuzhiyunThe values here are referring to what can be found in the
566*4882a593SmuzhiyunTMCC-structure, as shown in the table below.
567*4882a593Smuzhiyun
568*4882a593Smuzhiyun
569*4882a593Smuzhiyun.. c:type:: isdbt_layer_interleaving_table
570*4882a593Smuzhiyun
571*4882a593Smuzhiyun.. flat-table:: ISDB-T time interleaving modes
572*4882a593Smuzhiyun    :header-rows:  1
573*4882a593Smuzhiyun    :stub-columns: 0
574*4882a593Smuzhiyun
575*4882a593Smuzhiyun
576*4882a593Smuzhiyun    -  .. row 1
577*4882a593Smuzhiyun
578*4882a593Smuzhiyun       -  ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
579*4882a593Smuzhiyun
580*4882a593Smuzhiyun       -  Mode 1 (2K FFT)
581*4882a593Smuzhiyun
582*4882a593Smuzhiyun       -  Mode 2 (4K FFT)
583*4882a593Smuzhiyun
584*4882a593Smuzhiyun       -  Mode 3 (8K FFT)
585*4882a593Smuzhiyun
586*4882a593Smuzhiyun    -  .. row 2
587*4882a593Smuzhiyun
588*4882a593Smuzhiyun       -  0
589*4882a593Smuzhiyun
590*4882a593Smuzhiyun       -  0
591*4882a593Smuzhiyun
592*4882a593Smuzhiyun       -  0
593*4882a593Smuzhiyun
594*4882a593Smuzhiyun       -  0
595*4882a593Smuzhiyun
596*4882a593Smuzhiyun    -  .. row 3
597*4882a593Smuzhiyun
598*4882a593Smuzhiyun       -  1
599*4882a593Smuzhiyun
600*4882a593Smuzhiyun       -  4
601*4882a593Smuzhiyun
602*4882a593Smuzhiyun       -  2
603*4882a593Smuzhiyun
604*4882a593Smuzhiyun       -  1
605*4882a593Smuzhiyun
606*4882a593Smuzhiyun    -  .. row 4
607*4882a593Smuzhiyun
608*4882a593Smuzhiyun       -  2
609*4882a593Smuzhiyun
610*4882a593Smuzhiyun       -  8
611*4882a593Smuzhiyun
612*4882a593Smuzhiyun       -  4
613*4882a593Smuzhiyun
614*4882a593Smuzhiyun       -  2
615*4882a593Smuzhiyun
616*4882a593Smuzhiyun    -  .. row 5
617*4882a593Smuzhiyun
618*4882a593Smuzhiyun       -  4
619*4882a593Smuzhiyun
620*4882a593Smuzhiyun       -  16
621*4882a593Smuzhiyun
622*4882a593Smuzhiyun       -  8
623*4882a593Smuzhiyun
624*4882a593Smuzhiyun       -  4
625*4882a593Smuzhiyun
626*4882a593Smuzhiyun
627*4882a593Smuzhiyun
628*4882a593Smuzhiyun.. _DTV-ATSCMH-FIC-VER:
629*4882a593Smuzhiyun
630*4882a593SmuzhiyunDTV_ATSCMH_FIC_VER
631*4882a593Smuzhiyun------------------
632*4882a593Smuzhiyun
633*4882a593SmuzhiyunUsed only on ATSC-MH.
634*4882a593Smuzhiyun
635*4882a593SmuzhiyunVersion number of the FIC (Fast Information Channel) signaling data.
636*4882a593Smuzhiyun
637*4882a593SmuzhiyunFIC is used for relaying information to allow rapid service acquisition
638*4882a593Smuzhiyunby the receiver.
639*4882a593Smuzhiyun
640*4882a593SmuzhiyunPossible values: 0, 1, 2, 3, ..., 30, 31
641*4882a593Smuzhiyun
642*4882a593Smuzhiyun
643*4882a593Smuzhiyun.. _DTV-ATSCMH-PARADE-ID:
644*4882a593Smuzhiyun
645*4882a593SmuzhiyunDTV_ATSCMH_PARADE_ID
646*4882a593Smuzhiyun--------------------
647*4882a593Smuzhiyun
648*4882a593SmuzhiyunUsed only on ATSC-MH.
649*4882a593Smuzhiyun
650*4882a593SmuzhiyunParade identification number
651*4882a593Smuzhiyun
652*4882a593SmuzhiyunA parade is a collection of up to eight MH groups, conveying one or two
653*4882a593Smuzhiyunensembles.
654*4882a593Smuzhiyun
655*4882a593SmuzhiyunPossible values: 0, 1, 2, 3, ..., 126, 127
656*4882a593Smuzhiyun
657*4882a593Smuzhiyun
658*4882a593Smuzhiyun.. _DTV-ATSCMH-NOG:
659*4882a593Smuzhiyun
660*4882a593SmuzhiyunDTV_ATSCMH_NOG
661*4882a593Smuzhiyun--------------
662*4882a593Smuzhiyun
663*4882a593SmuzhiyunUsed only on ATSC-MH.
664*4882a593Smuzhiyun
665*4882a593SmuzhiyunNumber of MH groups per MH subframe for a designated parade.
666*4882a593Smuzhiyun
667*4882a593SmuzhiyunPossible values: 1, 2, 3, 4, 5, 6, 7, 8
668*4882a593Smuzhiyun
669*4882a593Smuzhiyun
670*4882a593Smuzhiyun.. _DTV-ATSCMH-TNOG:
671*4882a593Smuzhiyun
672*4882a593SmuzhiyunDTV_ATSCMH_TNOG
673*4882a593Smuzhiyun---------------
674*4882a593Smuzhiyun
675*4882a593SmuzhiyunUsed only on ATSC-MH.
676*4882a593Smuzhiyun
677*4882a593SmuzhiyunTotal number of MH groups including all MH groups belonging to all MH
678*4882a593Smuzhiyunparades in one MH subframe.
679*4882a593Smuzhiyun
680*4882a593SmuzhiyunPossible values: 0, 1, 2, 3, ..., 30, 31
681*4882a593Smuzhiyun
682*4882a593Smuzhiyun
683*4882a593Smuzhiyun.. _DTV-ATSCMH-SGN:
684*4882a593Smuzhiyun
685*4882a593SmuzhiyunDTV_ATSCMH_SGN
686*4882a593Smuzhiyun--------------
687*4882a593Smuzhiyun
688*4882a593SmuzhiyunUsed only on ATSC-MH.
689*4882a593Smuzhiyun
690*4882a593SmuzhiyunStart group number.
691*4882a593Smuzhiyun
692*4882a593SmuzhiyunPossible values: 0, 1, 2, 3, ..., 14, 15
693*4882a593Smuzhiyun
694*4882a593Smuzhiyun
695*4882a593Smuzhiyun.. _DTV-ATSCMH-PRC:
696*4882a593Smuzhiyun
697*4882a593SmuzhiyunDTV_ATSCMH_PRC
698*4882a593Smuzhiyun--------------
699*4882a593Smuzhiyun
700*4882a593SmuzhiyunUsed only on ATSC-MH.
701*4882a593Smuzhiyun
702*4882a593SmuzhiyunParade repetition cycle.
703*4882a593Smuzhiyun
704*4882a593SmuzhiyunPossible values: 1, 2, 3, 4, 5, 6, 7, 8
705*4882a593Smuzhiyun
706*4882a593Smuzhiyun
707*4882a593Smuzhiyun.. _DTV-ATSCMH-RS-FRAME-MODE:
708*4882a593Smuzhiyun
709*4882a593SmuzhiyunDTV_ATSCMH_RS_FRAME_MODE
710*4882a593Smuzhiyun------------------------
711*4882a593Smuzhiyun
712*4882a593SmuzhiyunUsed only on ATSC-MH.
713*4882a593Smuzhiyun
714*4882a593SmuzhiyunReed Solomon (RS) frame mode.
715*4882a593Smuzhiyun
716*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_rs_frame_mode`.
717*4882a593Smuzhiyun
718*4882a593Smuzhiyun
719*4882a593Smuzhiyun.. _DTV-ATSCMH-RS-FRAME-ENSEMBLE:
720*4882a593Smuzhiyun
721*4882a593SmuzhiyunDTV_ATSCMH_RS_FRAME_ENSEMBLE
722*4882a593Smuzhiyun----------------------------
723*4882a593Smuzhiyun
724*4882a593SmuzhiyunUsed only on ATSC-MH.
725*4882a593Smuzhiyun
726*4882a593SmuzhiyunReed Solomon(RS) frame ensemble.
727*4882a593Smuzhiyun
728*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_rs_frame_ensemble`.
729*4882a593Smuzhiyun
730*4882a593Smuzhiyun
731*4882a593Smuzhiyun.. _DTV-ATSCMH-RS-CODE-MODE-PRI:
732*4882a593Smuzhiyun
733*4882a593SmuzhiyunDTV_ATSCMH_RS_CODE_MODE_PRI
734*4882a593Smuzhiyun---------------------------
735*4882a593Smuzhiyun
736*4882a593SmuzhiyunUsed only on ATSC-MH.
737*4882a593Smuzhiyun
738*4882a593SmuzhiyunReed Solomon (RS) code mode (primary).
739*4882a593Smuzhiyun
740*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
741*4882a593Smuzhiyun
742*4882a593Smuzhiyun
743*4882a593Smuzhiyun.. _DTV-ATSCMH-RS-CODE-MODE-SEC:
744*4882a593Smuzhiyun
745*4882a593SmuzhiyunDTV_ATSCMH_RS_CODE_MODE_SEC
746*4882a593Smuzhiyun---------------------------
747*4882a593Smuzhiyun
748*4882a593SmuzhiyunUsed only on ATSC-MH.
749*4882a593Smuzhiyun
750*4882a593SmuzhiyunReed Solomon (RS) code mode (secondary).
751*4882a593Smuzhiyun
752*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
753*4882a593Smuzhiyun
754*4882a593Smuzhiyun
755*4882a593Smuzhiyun.. _DTV-ATSCMH-SCCC-BLOCK-MODE:
756*4882a593Smuzhiyun
757*4882a593SmuzhiyunDTV_ATSCMH_SCCC_BLOCK_MODE
758*4882a593Smuzhiyun--------------------------
759*4882a593Smuzhiyun
760*4882a593SmuzhiyunUsed only on ATSC-MH.
761*4882a593Smuzhiyun
762*4882a593SmuzhiyunSeries Concatenated Convolutional Code Block Mode.
763*4882a593Smuzhiyun
764*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_sccc_block_mode`.
765*4882a593Smuzhiyun
766*4882a593Smuzhiyun
767*4882a593Smuzhiyun.. _DTV-ATSCMH-SCCC-CODE-MODE-A:
768*4882a593Smuzhiyun
769*4882a593SmuzhiyunDTV_ATSCMH_SCCC_CODE_MODE_A
770*4882a593Smuzhiyun---------------------------
771*4882a593Smuzhiyun
772*4882a593SmuzhiyunUsed only on ATSC-MH.
773*4882a593Smuzhiyun
774*4882a593SmuzhiyunSeries Concatenated Convolutional Code Rate.
775*4882a593Smuzhiyun
776*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`atscmh_sccc_code_mode`.
777*4882a593Smuzhiyun
778*4882a593Smuzhiyun.. _DTV-ATSCMH-SCCC-CODE-MODE-B:
779*4882a593Smuzhiyun
780*4882a593SmuzhiyunDTV_ATSCMH_SCCC_CODE_MODE_B
781*4882a593Smuzhiyun---------------------------
782*4882a593Smuzhiyun
783*4882a593SmuzhiyunUsed only on ATSC-MH.
784*4882a593Smuzhiyun
785*4882a593SmuzhiyunSeries Concatenated Convolutional Code Rate.
786*4882a593Smuzhiyun
787*4882a593SmuzhiyunPossible values are the same as documented on enum
788*4882a593Smuzhiyun:c:type:`atscmh_sccc_code_mode`.
789*4882a593Smuzhiyun
790*4882a593Smuzhiyun
791*4882a593Smuzhiyun.. _DTV-ATSCMH-SCCC-CODE-MODE-C:
792*4882a593Smuzhiyun
793*4882a593SmuzhiyunDTV_ATSCMH_SCCC_CODE_MODE_C
794*4882a593Smuzhiyun---------------------------
795*4882a593Smuzhiyun
796*4882a593SmuzhiyunUsed only on ATSC-MH.
797*4882a593Smuzhiyun
798*4882a593SmuzhiyunSeries Concatenated Convolutional Code Rate.
799*4882a593Smuzhiyun
800*4882a593SmuzhiyunPossible values are the same as documented on enum
801*4882a593Smuzhiyun:c:type:`atscmh_sccc_code_mode`.
802*4882a593Smuzhiyun
803*4882a593Smuzhiyun
804*4882a593Smuzhiyun.. _DTV-ATSCMH-SCCC-CODE-MODE-D:
805*4882a593Smuzhiyun
806*4882a593SmuzhiyunDTV_ATSCMH_SCCC_CODE_MODE_D
807*4882a593Smuzhiyun---------------------------
808*4882a593Smuzhiyun
809*4882a593SmuzhiyunUsed only on ATSC-MH.
810*4882a593Smuzhiyun
811*4882a593SmuzhiyunSeries Concatenated Convolutional Code Rate.
812*4882a593Smuzhiyun
813*4882a593SmuzhiyunPossible values are the same as documented on enum
814*4882a593Smuzhiyun:c:type:`atscmh_sccc_code_mode`.
815*4882a593Smuzhiyun
816*4882a593Smuzhiyun
817*4882a593Smuzhiyun.. _DTV-API-VERSION:
818*4882a593Smuzhiyun
819*4882a593SmuzhiyunDTV_API_VERSION
820*4882a593Smuzhiyun===============
821*4882a593Smuzhiyun
822*4882a593SmuzhiyunReturns the major/minor version of the Digital TV API
823*4882a593Smuzhiyun
824*4882a593Smuzhiyun
825*4882a593Smuzhiyun.. _DTV-CODE-RATE-HP:
826*4882a593Smuzhiyun
827*4882a593SmuzhiyunDTV_CODE_RATE_HP
828*4882a593Smuzhiyun================
829*4882a593Smuzhiyun
830*4882a593SmuzhiyunUsed on terrestrial transmissions.
831*4882a593Smuzhiyun
832*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_transmit_mode`.
833*4882a593Smuzhiyun
834*4882a593Smuzhiyun
835*4882a593Smuzhiyun.. _DTV-CODE-RATE-LP:
836*4882a593Smuzhiyun
837*4882a593SmuzhiyunDTV_CODE_RATE_LP
838*4882a593Smuzhiyun================
839*4882a593Smuzhiyun
840*4882a593SmuzhiyunUsed on terrestrial transmissions.
841*4882a593Smuzhiyun
842*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_transmit_mode`.
843*4882a593Smuzhiyun
844*4882a593Smuzhiyun
845*4882a593Smuzhiyun.. _DTV-GUARD-INTERVAL:
846*4882a593Smuzhiyun
847*4882a593SmuzhiyunDTV_GUARD_INTERVAL
848*4882a593Smuzhiyun==================
849*4882a593Smuzhiyun
850*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_guard_interval`.
851*4882a593Smuzhiyun
852*4882a593Smuzhiyun.. note::
853*4882a593Smuzhiyun
854*4882a593Smuzhiyun   #. If ``DTV_GUARD_INTERVAL`` is set the ``GUARD_INTERVAL_AUTO`` the
855*4882a593Smuzhiyun      hardware will try to find the correct guard interval (if capable) and
856*4882a593Smuzhiyun      will use TMCC to fill in the missing parameters.
857*4882a593Smuzhiyun   #. Intervals ``GUARD_INTERVAL_1_128``, ``GUARD_INTERVAL_19_128``
858*4882a593Smuzhiyun      and ``GUARD_INTERVAL_19_256`` are used only for DVB-T2 at
859*4882a593Smuzhiyun      present.
860*4882a593Smuzhiyun   #. Intervals ``GUARD_INTERVAL_PN420``, ``GUARD_INTERVAL_PN595`` and
861*4882a593Smuzhiyun      ``GUARD_INTERVAL_PN945`` are used only for DMTB at the present.
862*4882a593Smuzhiyun      On such standard, only those intervals and ``GUARD_INTERVAL_AUTO``
863*4882a593Smuzhiyun      are valid.
864*4882a593Smuzhiyun
865*4882a593Smuzhiyun.. _DTV-TRANSMISSION-MODE:
866*4882a593Smuzhiyun
867*4882a593SmuzhiyunDTV_TRANSMISSION_MODE
868*4882a593Smuzhiyun=====================
869*4882a593Smuzhiyun
870*4882a593Smuzhiyun
871*4882a593SmuzhiyunUsed only on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB.
872*4882a593Smuzhiyun
873*4882a593SmuzhiyunSpecifies the FFT size (with corresponds to the approximate number of
874*4882a593Smuzhiyuncarriers) used by the standard.
875*4882a593Smuzhiyun
876*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_transmit_mode`.
877*4882a593Smuzhiyun
878*4882a593Smuzhiyun.. note::
879*4882a593Smuzhiyun
880*4882a593Smuzhiyun   #. ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
881*4882a593Smuzhiyun      **mode** on such standard, and are numbered from 1 to 3:
882*4882a593Smuzhiyun
883*4882a593Smuzhiyun      ====	========	========================
884*4882a593Smuzhiyun      Mode	FFT size	Transmission mode
885*4882a593Smuzhiyun      ====	========	========================
886*4882a593Smuzhiyun      1		2K		``TRANSMISSION_MODE_2K``
887*4882a593Smuzhiyun      2		4K		``TRANSMISSION_MODE_4K``
888*4882a593Smuzhiyun      3		8K		``TRANSMISSION_MODE_8K``
889*4882a593Smuzhiyun      ====	========	========================
890*4882a593Smuzhiyun
891*4882a593Smuzhiyun   #. If ``DTV_TRANSMISSION_MODE`` is set the ``TRANSMISSION_MODE_AUTO``
892*4882a593Smuzhiyun      the hardware will try to find the correct FFT-size (if capable) and
893*4882a593Smuzhiyun      will use TMCC to fill in the missing parameters.
894*4882a593Smuzhiyun
895*4882a593Smuzhiyun   #. DVB-T specifies 2K and 8K as valid sizes.
896*4882a593Smuzhiyun
897*4882a593Smuzhiyun   #. DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
898*4882a593Smuzhiyun
899*4882a593Smuzhiyun   #. DTMB specifies C1 and C3780.
900*4882a593Smuzhiyun
901*4882a593Smuzhiyun
902*4882a593Smuzhiyun.. _DTV-HIERARCHY:
903*4882a593Smuzhiyun
904*4882a593SmuzhiyunDTV_HIERARCHY
905*4882a593Smuzhiyun=============
906*4882a593Smuzhiyun
907*4882a593SmuzhiyunUsed only on DVB-T and DVB-T2.
908*4882a593Smuzhiyun
909*4882a593SmuzhiyunFrontend hierarchy.
910*4882a593Smuzhiyun
911*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_hierarchy`.
912*4882a593Smuzhiyun
913*4882a593Smuzhiyun
914*4882a593Smuzhiyun.. _DTV-STREAM-ID:
915*4882a593Smuzhiyun
916*4882a593SmuzhiyunDTV_STREAM_ID
917*4882a593Smuzhiyun=============
918*4882a593Smuzhiyun
919*4882a593SmuzhiyunUsed on DVB-S2, DVB-T2 and ISDB-S.
920*4882a593Smuzhiyun
921*4882a593SmuzhiyunDVB-S2, DVB-T2 and ISDB-S support the transmission of several streams on
922*4882a593Smuzhiyuna single transport stream. This property enables the digital TV driver to
923*4882a593Smuzhiyunhandle substream filtering, when supported by the hardware. By default,
924*4882a593Smuzhiyunsubstream filtering is disabled.
925*4882a593Smuzhiyun
926*4882a593SmuzhiyunFor DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255.
927*4882a593Smuzhiyun
928*4882a593SmuzhiyunFor ISDB, the valid substream id range is from 1 to 65535.
929*4882a593Smuzhiyun
930*4882a593SmuzhiyunTo disable it, you should use the special macro NO_STREAM_ID_FILTER.
931*4882a593Smuzhiyun
932*4882a593SmuzhiyunNote: any value outside the id range also disables filtering.
933*4882a593Smuzhiyun
934*4882a593Smuzhiyun
935*4882a593Smuzhiyun.. _DTV-DVBT2-PLP-ID-LEGACY:
936*4882a593Smuzhiyun
937*4882a593SmuzhiyunDTV_DVBT2_PLP_ID_LEGACY
938*4882a593Smuzhiyun=======================
939*4882a593Smuzhiyun
940*4882a593SmuzhiyunObsolete, replaced with DTV_STREAM_ID.
941*4882a593Smuzhiyun
942*4882a593Smuzhiyun
943*4882a593Smuzhiyun.. _DTV-ENUM-DELSYS:
944*4882a593Smuzhiyun
945*4882a593SmuzhiyunDTV_ENUM_DELSYS
946*4882a593Smuzhiyun===============
947*4882a593Smuzhiyun
948*4882a593SmuzhiyunA Multi standard frontend needs to advertise the delivery systems
949*4882a593Smuzhiyunprovided. Applications need to enumerate the provided delivery systems,
950*4882a593Smuzhiyunbefore using any other operation with the frontend. Prior to it's
951*4882a593Smuzhiyunintroduction, FE_GET_INFO was used to determine a frontend type. A
952*4882a593Smuzhiyunfrontend which provides more than a single delivery system,
953*4882a593SmuzhiyunFE_GET_INFO doesn't help much. Applications which intends to use a
954*4882a593Smuzhiyunmultistandard frontend must enumerate the delivery systems associated
955*4882a593Smuzhiyunwith it, rather than trying to use FE_GET_INFO. In the case of a
956*4882a593Smuzhiyunlegacy frontend, the result is just the same as with FE_GET_INFO, but
957*4882a593Smuzhiyunin a more structured format
958*4882a593Smuzhiyun
959*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_delivery_system`.
960*4882a593Smuzhiyun
961*4882a593Smuzhiyun
962*4882a593Smuzhiyun.. _DTV-INTERLEAVING:
963*4882a593Smuzhiyun
964*4882a593SmuzhiyunDTV_INTERLEAVING
965*4882a593Smuzhiyun================
966*4882a593Smuzhiyun
967*4882a593SmuzhiyunTime interleaving to be used.
968*4882a593Smuzhiyun
969*4882a593SmuzhiyunThe acceptable values are defined by :c:type:`fe_interleaving`.
970*4882a593Smuzhiyun
971*4882a593Smuzhiyun
972*4882a593Smuzhiyun.. _DTV-LNA:
973*4882a593Smuzhiyun
974*4882a593SmuzhiyunDTV_LNA
975*4882a593Smuzhiyun=======
976*4882a593Smuzhiyun
977*4882a593SmuzhiyunLow-noise amplifier.
978*4882a593Smuzhiyun
979*4882a593SmuzhiyunHardware might offer controllable LNA which can be set manually using
980*4882a593Smuzhiyunthat parameter. Usually LNA could be found only from terrestrial devices
981*4882a593Smuzhiyunif at all.
982*4882a593Smuzhiyun
983*4882a593SmuzhiyunPossible values: 0, 1, LNA_AUTO
984*4882a593Smuzhiyun
985*4882a593Smuzhiyun0, LNA off
986*4882a593Smuzhiyun
987*4882a593Smuzhiyun1, LNA on
988*4882a593Smuzhiyun
989*4882a593Smuzhiyunuse the special macro LNA_AUTO to set LNA auto
990*4882a593Smuzhiyun
991*4882a593Smuzhiyun
992*4882a593Smuzhiyun.. _DTV-SCRAMBLING-SEQUENCE-INDEX:
993*4882a593Smuzhiyun
994*4882a593SmuzhiyunDTV_SCRAMBLING_SEQUENCE_INDEX
995*4882a593Smuzhiyun=============================
996*4882a593Smuzhiyun
997*4882a593SmuzhiyunUsed on DVB-S2.
998*4882a593Smuzhiyun
999*4882a593SmuzhiyunThis 18 bit field, when present, carries the index of the DVB-S2 physical
1000*4882a593Smuzhiyunlayer scrambling sequence as defined in clause 5.5.4 of EN 302 307.
1001*4882a593SmuzhiyunThere is no explicit signalling method to convey scrambling sequence index
1002*4882a593Smuzhiyunto the receiver. If S2 satellite delivery system descriptor is available
1003*4882a593Smuzhiyunit can be used to read the scrambling sequence index (EN 300 468 table 41).
1004*4882a593Smuzhiyun
1005*4882a593SmuzhiyunBy default, gold scrambling sequence index 0 is used.
1006*4882a593Smuzhiyun
1007*4882a593SmuzhiyunThe valid scrambling sequence index range is from 0 to 262142.
1008