fe_property_parameters.rst 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. _fe_property_parameters:
  3. ******************************
  4. Digital TV property parameters
  5. ******************************
  6. There are several different Digital TV parameters that can be used by
  7. :ref:`FE_SET_PROPERTY and FE_GET_PROPERTY ioctls<FE_GET_PROPERTY>`.
  8. This section describes each of them. Please notice, however, that only
  9. a subset of them are needed to setup a frontend.
  10. .. _DTV-UNDEFINED:
  11. DTV_UNDEFINED
  12. =============
  13. Used internally. A GET/SET operation for it won't change or return
  14. anything.
  15. .. _DTV-TUNE:
  16. DTV_TUNE
  17. ========
  18. Interpret the cache of data, build either a traditional frontend
  19. tunerequest so we can pass validation in the ``FE_SET_FRONTEND`` ioctl.
  20. .. _DTV-CLEAR:
  21. DTV_CLEAR
  22. =========
  23. Reset a cache of data specific to the frontend here. This does not
  24. effect hardware.
  25. .. _DTV-FREQUENCY:
  26. DTV_FREQUENCY
  27. =============
  28. Frequency of the digital TV transponder/channel.
  29. .. note::
  30. #. For satellite delivery systems, the frequency is in kHz.
  31. #. For cable and terrestrial delivery systems, the frequency is in
  32. Hz.
  33. #. On most delivery systems, the frequency is the center frequency
  34. of the transponder/channel. The exception is for ISDB-T, where
  35. the main carrier has a 1/7 offset from the center.
  36. #. For ISDB-T, the channels are usually transmitted with an offset of
  37. about 143kHz. E.g. a valid frequency could be 474,143 kHz. The
  38. stepping is bound to the bandwidth of the channel which is
  39. typically 6MHz.
  40. #. In ISDB-Tsb, the channel consists of only one or three segments the
  41. frequency step is 429kHz, 3*429 respectively.
  42. .. _DTV-MODULATION:
  43. DTV_MODULATION
  44. ==============
  45. Specifies the frontend modulation type for delivery systems that
  46. supports more multiple modulations.
  47. The modulation can be one of the types defined by enum :c:type:`fe_modulation`.
  48. Most of the digital TV standards offers more than one possible
  49. modulation type.
  50. The table below presents a summary of the types of modulation types
  51. supported by each delivery system, as currently defined by specs.
  52. ======================= =======================================================
  53. Standard Modulation types
  54. ======================= =======================================================
  55. ATSC (version 1) 8-VSB and 16-VSB.
  56. DMTB 4-QAM, 16-QAM, 32-QAM, 64-QAM and 4-QAM-NR.
  57. DVB-C Annex A/C 16-QAM, 32-QAM, 64-QAM and 256-QAM.
  58. DVB-C Annex B 64-QAM.
  59. DVB-C2 QPSK, 16-QAM, 64-QAM, 256-QAM, 1024-QAM and 4096-QAM.
  60. DVB-T QPSK, 16-QAM and 64-QAM.
  61. DVB-T2 QPSK, 16-QAM, 64-QAM and 256-QAM.
  62. DVB-S No need to set. It supports only QPSK.
  63. DVB-S2 QPSK, 8-PSK, 16-APSK and 32-APSK.
  64. DVB-S2X 8-APSK-L, 16-APSK-L, 32-APSK-L, 64-APSK and 64-APSK-L.
  65. ISDB-T QPSK, DQPSK, 16-QAM and 64-QAM.
  66. ISDB-S 8-PSK, QPSK and BPSK.
  67. ======================= =======================================================
  68. .. note::
  69. As DVB-S2X specifies extensions to the DVB-S2 standard, the same
  70. delivery system enum value is used (SYS_DVBS2).
  71. Please notice that some of the above modulation types may not be
  72. defined currently at the Kernel. The reason is simple: no driver
  73. needed such definition yet.
  74. .. _DTV-BANDWIDTH-HZ:
  75. DTV_BANDWIDTH_HZ
  76. ================
  77. Bandwidth for the channel, in HZ.
  78. Should be set only for terrestrial delivery systems.
  79. Possible values: ``1712000``, ``5000000``, ``6000000``, ``7000000``,
  80. ``8000000``, ``10000000``.
  81. ======================= =======================================================
  82. Terrestrial Standard Possible values for bandwidth
  83. ======================= =======================================================
  84. ATSC (version 1) No need to set. It is always 6MHz.
  85. DMTB No need to set. It is always 8MHz.
  86. DVB-T 6MHz, 7MHz and 8MHz.
  87. DVB-T2 1.172 MHz, 5MHz, 6MHz, 7MHz, 8MHz and 10MHz
  88. ISDB-T 5MHz, 6MHz, 7MHz and 8MHz, although most places
  89. use 6MHz.
  90. ======================= =======================================================
  91. .. note::
  92. #. For ISDB-Tsb, the bandwidth can vary depending on the number of
  93. connected segments.
  94. It can be easily derived from other parameters
  95. (DTV_ISDBT_SB_SEGMENT_IDX, DTV_ISDBT_SB_SEGMENT_COUNT).
  96. #. On Satellite and Cable delivery systems, the bandwidth depends on
  97. the symbol rate. So, the Kernel will silently ignore any setting
  98. :ref:`DTV-BANDWIDTH-HZ`. I will however fill it back with a
  99. bandwidth estimation.
  100. Such bandwidth estimation takes into account the symbol rate set with
  101. :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
  102. DVB-C and DVB-S.
  103. For DVB-S2, the rolloff should also be set via :ref:`DTV-ROLLOFF`.
  104. .. _DTV-INVERSION:
  105. DTV_INVERSION
  106. =============
  107. Specifies if the frontend should do spectral inversion or not.
  108. The acceptable values are defined by :c:type:`fe_spectral_inversion`.
  109. .. _DTV-DISEQC-MASTER:
  110. DTV_DISEQC_MASTER
  111. =================
  112. Currently not implemented.
  113. .. _DTV-SYMBOL-RATE:
  114. DTV_SYMBOL_RATE
  115. ===============
  116. Used on cable and satellite delivery systems.
  117. Digital TV symbol rate, in bauds (symbols/second).
  118. .. _DTV-INNER-FEC:
  119. DTV_INNER_FEC
  120. =============
  121. Used on cable and satellite delivery systems.
  122. The acceptable values are defined by :c:type:`fe_code_rate`.
  123. .. _DTV-VOLTAGE:
  124. DTV_VOLTAGE
  125. ===========
  126. Used on satellite delivery systems.
  127. The voltage is usually used with non-DiSEqC capable LNBs to switch the
  128. polarzation (horizontal/vertical). When using DiSEqC epuipment this
  129. voltage has to be switched consistently to the DiSEqC commands as
  130. described in the DiSEqC spec.
  131. The acceptable values are defined by :c:type:`fe_sec_voltage`.
  132. .. _DTV-TONE:
  133. DTV_TONE
  134. ========
  135. Currently not used.
  136. .. _DTV-PILOT:
  137. DTV_PILOT
  138. =========
  139. Used on DVB-S2.
  140. Sets DVB-S2 pilot.
  141. The acceptable values are defined by :c:type:`fe_pilot`.
  142. .. _DTV-ROLLOFF:
  143. DTV_ROLLOFF
  144. ===========
  145. Used on DVB-S2.
  146. Sets DVB-S2 rolloff.
  147. The acceptable values are defined by :c:type:`fe_rolloff`.
  148. .. _DTV-DISEQC-SLAVE-REPLY:
  149. DTV_DISEQC_SLAVE_REPLY
  150. ======================
  151. Currently not implemented.
  152. .. _DTV-FE-CAPABILITY-COUNT:
  153. DTV_FE_CAPABILITY_COUNT
  154. =======================
  155. Currently not implemented.
  156. .. _DTV-FE-CAPABILITY:
  157. DTV_FE_CAPABILITY
  158. =================
  159. Currently not implemented.
  160. .. _DTV-DELIVERY-SYSTEM:
  161. DTV_DELIVERY_SYSTEM
  162. ===================
  163. Specifies the type of the delivery system.
  164. The acceptable values are defined by :c:type:`fe_delivery_system`.
  165. .. _DTV-ISDBT-PARTIAL-RECEPTION:
  166. DTV_ISDBT_PARTIAL_RECEPTION
  167. ===========================
  168. Used only on ISDB.
  169. If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
  170. whether the channel is in partial reception mode or not.
  171. If '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
  172. and ``DTV_ISDBT_LAYERA_SEGMENT_COUNT`` has to be '1'.
  173. If in addition ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'
  174. ``DTV_ISDBT_PARTIAL_RECEPTION`` represents whether this ISDB-Tsb channel
  175. is consisting of one segment and layer or three segments and two layers.
  176. Possible values: 0, 1, -1 (AUTO)
  177. .. _DTV-ISDBT-SOUND-BROADCASTING:
  178. DTV_ISDBT_SOUND_BROADCASTING
  179. ============================
  180. Used only on ISDB.
  181. This field represents whether the other DTV_ISDBT_*-parameters are
  182. referring to an ISDB-T and an ISDB-Tsb channel. (See also
  183. ``DTV_ISDBT_PARTIAL_RECEPTION``).
  184. Possible values: 0, 1, -1 (AUTO)
  185. .. _DTV-ISDBT-SB-SUBCHANNEL-ID:
  186. DTV_ISDBT_SB_SUBCHANNEL_ID
  187. ==========================
  188. Used only on ISDB.
  189. This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
  190. (Note of the author: This might not be the correct description of the
  191. ``SUBCHANNEL-ID`` in all details, but it is my understanding of the
  192. technical background needed to program a device)
  193. An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
  194. set of connected ISDB-Tsb channels. In this set of channels every
  195. channel can be received independently. The number of connected ISDB-Tsb
  196. segment can vary, e.g. depending on the frequency spectrum bandwidth
  197. available.
  198. Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
  199. broadcaster has several possibilities to put those channels in the air:
  200. Assuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
  201. from position 1-8 to 5-13 or anything in between.
  202. The underlying layer of segments are subchannels: each segment is
  203. consisting of several subchannels with a predefined IDs. A sub-channel
  204. is used to help the demodulator to synchronize on the channel.
  205. An ISDB-T channel is always centered over all sub-channels. As for the
  206. example above, in ISDB-Tsb it is no longer as simple as that.
  207. ``The DTV_ISDBT_SB_SUBCHANNEL_ID`` parameter is used to give the
  208. sub-channel ID of the segment to be demodulated.
  209. Possible values: 0 .. 41, -1 (AUTO)
  210. .. _DTV-ISDBT-SB-SEGMENT-IDX:
  211. DTV_ISDBT_SB_SEGMENT_IDX
  212. ========================
  213. Used only on ISDB.
  214. This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
  215. ``DTV_ISDBT_SB_SEGMENT_IDX`` gives the index of the segment to be
  216. demodulated for an ISDB-Tsb channel where several of them are
  217. transmitted in the connected manner.
  218. Possible values: 0 .. ``DTV_ISDBT_SB_SEGMENT_COUNT`` - 1
  219. Note: This value cannot be determined by an automatic channel search.
  220. .. _DTV-ISDBT-SB-SEGMENT-COUNT:
  221. DTV_ISDBT_SB_SEGMENT_COUNT
  222. ==========================
  223. Used only on ISDB.
  224. This field only applies if ``DTV_ISDBT_SOUND_BROADCASTING`` is '1'.
  225. ``DTV_ISDBT_SB_SEGMENT_COUNT`` gives the total count of connected
  226. ISDB-Tsb channels.
  227. Possible values: 1 .. 13
  228. Note: This value cannot be determined by an automatic channel search.
  229. .. _isdb-hierq-layers:
  230. DTV-ISDBT-LAYER[A-C] parameters
  231. ===============================
  232. Used only on ISDB.
  233. ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
  234. ISDB-T hierarchical layers can be decoded simultaneously. For that
  235. reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.
  236. ISDB-T has 3 hierarchical layers which each can use a part of the
  237. available segments. The total number of segments over all layers has to
  238. 13 in ISDB-T.
  239. There are 3 parameter sets, for Layers A, B and C.
  240. .. _DTV-ISDBT-LAYER-ENABLED:
  241. DTV_ISDBT_LAYER_ENABLED
  242. -----------------------
  243. Used only on ISDB.
  244. Hierarchical reception in ISDB-T is achieved by enabling or disabling
  245. layers in the decoding process. Setting all bits of
  246. ``DTV_ISDBT_LAYER_ENABLED`` to '1' forces all layers (if applicable) to
  247. be demodulated. This is the default.
  248. If the channel is in the partial reception mode
  249. (``DTV_ISDBT_PARTIAL_RECEPTION`` = 1) the central segment can be decoded
  250. independently of the other 12 segments. In that mode layer A has to have
  251. a ``SEGMENT_COUNT`` of 1.
  252. In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb according
  253. to ``DTV_ISDBT_PARTIAL_RECEPTION``. ``SEGMENT_COUNT`` must be filled
  254. accordingly.
  255. Only the values of the first 3 bits are used. Other bits will be silently ignored:
  256. ``DTV_ISDBT_LAYER_ENABLED`` bit 0: layer A enabled
  257. ``DTV_ISDBT_LAYER_ENABLED`` bit 1: layer B enabled
  258. ``DTV_ISDBT_LAYER_ENABLED`` bit 2: layer C enabled
  259. ``DTV_ISDBT_LAYER_ENABLED`` bits 3-31: unused
  260. .. _DTV-ISDBT-LAYER-FEC:
  261. DTV_ISDBT_LAYER[A-C]_FEC
  262. ------------------------
  263. Used only on ISDB.
  264. The Forward Error Correction mechanism used by a given ISDB Layer, as
  265. defined by :c:type:`fe_code_rate`.
  266. Possible values are: ``FEC_AUTO``, ``FEC_1_2``, ``FEC_2_3``, ``FEC_3_4``,
  267. ``FEC_5_6``, ``FEC_7_8``
  268. .. _DTV-ISDBT-LAYER-MODULATION:
  269. DTV_ISDBT_LAYER[A-C]_MODULATION
  270. -------------------------------
  271. Used only on ISDB.
  272. The modulation used by a given ISDB Layer, as defined by
  273. :c:type:`fe_modulation`.
  274. Possible values are: ``QAM_AUTO``, ``QPSK``, ``QAM_16``, ``QAM_64``, ``DQPSK``
  275. .. note::
  276. #. If layer C is ``DQPSK``, then layer B has to be ``DQPSK``.
  277. #. If layer B is ``DQPSK`` and ``DTV_ISDBT_PARTIAL_RECEPTION``\ = 0,
  278. then layer has to be ``DQPSK``.
  279. .. _DTV-ISDBT-LAYER-SEGMENT-COUNT:
  280. DTV_ISDBT_LAYER[A-C]_SEGMENT_COUNT
  281. ----------------------------------
  282. Used only on ISDB.
  283. Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)
  284. Note: Truth table for ``DTV_ISDBT_SOUND_BROADCASTING`` and
  285. ``DTV_ISDBT_PARTIAL_RECEPTION`` and ``LAYER[A-C]_SEGMENT_COUNT``
  286. .. _isdbt-layer_seg-cnt-table:
  287. .. flat-table:: Truth table for ISDB-T Sound Broadcasting
  288. :header-rows: 1
  289. :stub-columns: 0
  290. - .. row 1
  291. - Partial Reception
  292. - Sound Broadcasting
  293. - Layer A width
  294. - Layer B width
  295. - Layer C width
  296. - total width
  297. - .. row 2
  298. - 0
  299. - 0
  300. - 1 .. 13
  301. - 1 .. 13
  302. - 1 .. 13
  303. - 13
  304. - .. row 3
  305. - 1
  306. - 0
  307. - 1
  308. - 1 .. 13
  309. - 1 .. 13
  310. - 13
  311. - .. row 4
  312. - 0
  313. - 1
  314. - 1
  315. - 0
  316. - 0
  317. - 1
  318. - .. row 5
  319. - 1
  320. - 1
  321. - 1
  322. - 2
  323. - 0
  324. - 13
  325. .. _DTV-ISDBT-LAYER-TIME-INTERLEAVING:
  326. DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING
  327. --------------------------------------
  328. Used only on ISDB.
  329. Valid values: 0, 1, 2, 4, -1 (AUTO)
  330. when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.
  331. Note: The real time interleaving length depends on the mode (fft-size).
  332. The values here are referring to what can be found in the
  333. TMCC-structure, as shown in the table below.
  334. .. c:type:: isdbt_layer_interleaving_table
  335. .. flat-table:: ISDB-T time interleaving modes
  336. :header-rows: 1
  337. :stub-columns: 0
  338. - .. row 1
  339. - ``DTV_ISDBT_LAYER[A-C]_TIME_INTERLEAVING``
  340. - Mode 1 (2K FFT)
  341. - Mode 2 (4K FFT)
  342. - Mode 3 (8K FFT)
  343. - .. row 2
  344. - 0
  345. - 0
  346. - 0
  347. - 0
  348. - .. row 3
  349. - 1
  350. - 4
  351. - 2
  352. - 1
  353. - .. row 4
  354. - 2
  355. - 8
  356. - 4
  357. - 2
  358. - .. row 5
  359. - 4
  360. - 16
  361. - 8
  362. - 4
  363. .. _DTV-ATSCMH-FIC-VER:
  364. DTV_ATSCMH_FIC_VER
  365. ------------------
  366. Used only on ATSC-MH.
  367. Version number of the FIC (Fast Information Channel) signaling data.
  368. FIC is used for relaying information to allow rapid service acquisition
  369. by the receiver.
  370. Possible values: 0, 1, 2, 3, ..., 30, 31
  371. .. _DTV-ATSCMH-PARADE-ID:
  372. DTV_ATSCMH_PARADE_ID
  373. --------------------
  374. Used only on ATSC-MH.
  375. Parade identification number
  376. A parade is a collection of up to eight MH groups, conveying one or two
  377. ensembles.
  378. Possible values: 0, 1, 2, 3, ..., 126, 127
  379. .. _DTV-ATSCMH-NOG:
  380. DTV_ATSCMH_NOG
  381. --------------
  382. Used only on ATSC-MH.
  383. Number of MH groups per MH subframe for a designated parade.
  384. Possible values: 1, 2, 3, 4, 5, 6, 7, 8
  385. .. _DTV-ATSCMH-TNOG:
  386. DTV_ATSCMH_TNOG
  387. ---------------
  388. Used only on ATSC-MH.
  389. Total number of MH groups including all MH groups belonging to all MH
  390. parades in one MH subframe.
  391. Possible values: 0, 1, 2, 3, ..., 30, 31
  392. .. _DTV-ATSCMH-SGN:
  393. DTV_ATSCMH_SGN
  394. --------------
  395. Used only on ATSC-MH.
  396. Start group number.
  397. Possible values: 0, 1, 2, 3, ..., 14, 15
  398. .. _DTV-ATSCMH-PRC:
  399. DTV_ATSCMH_PRC
  400. --------------
  401. Used only on ATSC-MH.
  402. Parade repetition cycle.
  403. Possible values: 1, 2, 3, 4, 5, 6, 7, 8
  404. .. _DTV-ATSCMH-RS-FRAME-MODE:
  405. DTV_ATSCMH_RS_FRAME_MODE
  406. ------------------------
  407. Used only on ATSC-MH.
  408. Reed Solomon (RS) frame mode.
  409. The acceptable values are defined by :c:type:`atscmh_rs_frame_mode`.
  410. .. _DTV-ATSCMH-RS-FRAME-ENSEMBLE:
  411. DTV_ATSCMH_RS_FRAME_ENSEMBLE
  412. ----------------------------
  413. Used only on ATSC-MH.
  414. Reed Solomon(RS) frame ensemble.
  415. The acceptable values are defined by :c:type:`atscmh_rs_frame_ensemble`.
  416. .. _DTV-ATSCMH-RS-CODE-MODE-PRI:
  417. DTV_ATSCMH_RS_CODE_MODE_PRI
  418. ---------------------------
  419. Used only on ATSC-MH.
  420. Reed Solomon (RS) code mode (primary).
  421. The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
  422. .. _DTV-ATSCMH-RS-CODE-MODE-SEC:
  423. DTV_ATSCMH_RS_CODE_MODE_SEC
  424. ---------------------------
  425. Used only on ATSC-MH.
  426. Reed Solomon (RS) code mode (secondary).
  427. The acceptable values are defined by :c:type:`atscmh_rs_code_mode`.
  428. .. _DTV-ATSCMH-SCCC-BLOCK-MODE:
  429. DTV_ATSCMH_SCCC_BLOCK_MODE
  430. --------------------------
  431. Used only on ATSC-MH.
  432. Series Concatenated Convolutional Code Block Mode.
  433. The acceptable values are defined by :c:type:`atscmh_sccc_block_mode`.
  434. .. _DTV-ATSCMH-SCCC-CODE-MODE-A:
  435. DTV_ATSCMH_SCCC_CODE_MODE_A
  436. ---------------------------
  437. Used only on ATSC-MH.
  438. Series Concatenated Convolutional Code Rate.
  439. The acceptable values are defined by :c:type:`atscmh_sccc_code_mode`.
  440. .. _DTV-ATSCMH-SCCC-CODE-MODE-B:
  441. DTV_ATSCMH_SCCC_CODE_MODE_B
  442. ---------------------------
  443. Used only on ATSC-MH.
  444. Series Concatenated Convolutional Code Rate.
  445. Possible values are the same as documented on enum
  446. :c:type:`atscmh_sccc_code_mode`.
  447. .. _DTV-ATSCMH-SCCC-CODE-MODE-C:
  448. DTV_ATSCMH_SCCC_CODE_MODE_C
  449. ---------------------------
  450. Used only on ATSC-MH.
  451. Series Concatenated Convolutional Code Rate.
  452. Possible values are the same as documented on enum
  453. :c:type:`atscmh_sccc_code_mode`.
  454. .. _DTV-ATSCMH-SCCC-CODE-MODE-D:
  455. DTV_ATSCMH_SCCC_CODE_MODE_D
  456. ---------------------------
  457. Used only on ATSC-MH.
  458. Series Concatenated Convolutional Code Rate.
  459. Possible values are the same as documented on enum
  460. :c:type:`atscmh_sccc_code_mode`.
  461. .. _DTV-API-VERSION:
  462. DTV_API_VERSION
  463. ===============
  464. Returns the major/minor version of the Digital TV API
  465. .. _DTV-CODE-RATE-HP:
  466. DTV_CODE_RATE_HP
  467. ================
  468. Used on terrestrial transmissions.
  469. The acceptable values are defined by :c:type:`fe_transmit_mode`.
  470. .. _DTV-CODE-RATE-LP:
  471. DTV_CODE_RATE_LP
  472. ================
  473. Used on terrestrial transmissions.
  474. The acceptable values are defined by :c:type:`fe_transmit_mode`.
  475. .. _DTV-GUARD-INTERVAL:
  476. DTV_GUARD_INTERVAL
  477. ==================
  478. The acceptable values are defined by :c:type:`fe_guard_interval`.
  479. .. note::
  480. #. If ``DTV_GUARD_INTERVAL`` is set the ``GUARD_INTERVAL_AUTO`` the
  481. hardware will try to find the correct guard interval (if capable) and
  482. will use TMCC to fill in the missing parameters.
  483. #. Interval ``GUARD_INTERVAL_1_64`` is used only for DVB-C2.
  484. #. Interval ``GUARD_INTERVAL_1_128`` is used for both DVB-C2 and DVB_T2.
  485. #. Intervals ``GUARD_INTERVAL_19_128`` and ``GUARD_INTERVAL_19_256`` are
  486. used only for DVB-T2.
  487. #. Intervals ``GUARD_INTERVAL_PN420``, ``GUARD_INTERVAL_PN595`` and
  488. ``GUARD_INTERVAL_PN945`` are used only for DMTB at the present.
  489. On such standard, only those intervals and ``GUARD_INTERVAL_AUTO``
  490. are valid.
  491. .. _DTV-TRANSMISSION-MODE:
  492. DTV_TRANSMISSION_MODE
  493. =====================
  494. Used only on OFTM-based standards, e. g. DVB-T/T2, ISDB-T, DTMB.
  495. Specifies the FFT size (with corresponds to the approximate number of
  496. carriers) used by the standard.
  497. The acceptable values are defined by :c:type:`fe_transmit_mode`.
  498. .. note::
  499. #. ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
  500. **mode** on such standard, and are numbered from 1 to 3:
  501. ==== ======== ========================
  502. Mode FFT size Transmission mode
  503. ==== ======== ========================
  504. 1 2K ``TRANSMISSION_MODE_2K``
  505. 2 4K ``TRANSMISSION_MODE_4K``
  506. 3 8K ``TRANSMISSION_MODE_8K``
  507. ==== ======== ========================
  508. #. If ``DTV_TRANSMISSION_MODE`` is set the ``TRANSMISSION_MODE_AUTO``
  509. the hardware will try to find the correct FFT-size (if capable) and
  510. will use TMCC to fill in the missing parameters.
  511. #. DVB-T specifies 2K and 8K as valid sizes.
  512. #. DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
  513. #. DTMB specifies C1 and C3780.
  514. .. _DTV-HIERARCHY:
  515. DTV_HIERARCHY
  516. =============
  517. Used only on DVB-T and DVB-T2.
  518. Frontend hierarchy.
  519. The acceptable values are defined by :c:type:`fe_hierarchy`.
  520. .. _DTV-STREAM-ID:
  521. DTV_STREAM_ID
  522. =============
  523. Used on DVB-C2, DVB-S2, DVB-T2 and ISDB-S.
  524. DVB-C2, DVB-S2, DVB-T2 and ISDB-S support the transmission of several
  525. streams on a single transport stream. This property enables the digital
  526. TV driver to handle substream filtering, when supported by the hardware.
  527. By default, substream filtering is disabled.
  528. For DVB-C2, DVB-S2 and DVB-T2, the valid substream id range is from 0 to
  529. 255.
  530. For ISDB, the valid substream id range is from 1 to 65535.
  531. To disable it, you should use the special macro NO_STREAM_ID_FILTER.
  532. Note: any value outside the id range also disables filtering.
  533. .. _DTV-DVBT2-PLP-ID-LEGACY:
  534. DTV_DVBT2_PLP_ID_LEGACY
  535. =======================
  536. Obsolete, replaced with DTV_STREAM_ID.
  537. .. _DTV-ENUM-DELSYS:
  538. DTV_ENUM_DELSYS
  539. ===============
  540. A Multi standard frontend needs to advertise the delivery systems
  541. provided. Applications need to enumerate the provided delivery systems,
  542. before using any other operation with the frontend. Prior to it's
  543. introduction, FE_GET_INFO was used to determine a frontend type. A
  544. frontend which provides more than a single delivery system,
  545. FE_GET_INFO doesn't help much. Applications which intends to use a
  546. multistandard frontend must enumerate the delivery systems associated
  547. with it, rather than trying to use FE_GET_INFO. In the case of a
  548. legacy frontend, the result is just the same as with FE_GET_INFO, but
  549. in a more structured format
  550. The acceptable values are defined by :c:type:`fe_delivery_system`.
  551. .. _DTV-INTERLEAVING:
  552. DTV_INTERLEAVING
  553. ================
  554. Time interleaving to be used.
  555. The acceptable values are defined by :c:type:`fe_interleaving`.
  556. .. _DTV-LNA:
  557. DTV_LNA
  558. =======
  559. Low-noise amplifier.
  560. Hardware might offer controllable LNA which can be set manually using
  561. that parameter. Usually LNA could be found only from terrestrial devices
  562. if at all.
  563. Possible values: 0, 1, LNA_AUTO
  564. 0, LNA off
  565. 1, LNA on
  566. use the special macro LNA_AUTO to set LNA auto
  567. .. _DTV-SCRAMBLING-SEQUENCE-INDEX:
  568. DTV_SCRAMBLING_SEQUENCE_INDEX
  569. =============================
  570. Used on DVB-S2.
  571. This 18 bit field, when present, carries the index of the DVB-S2 physical
  572. layer scrambling sequence as defined in clause 5.5.4 of EN 302 307.
  573. There is no explicit signalling method to convey scrambling sequence index
  574. to the receiver. If S2 satellite delivery system descriptor is available
  575. it can be used to read the scrambling sequence index (EN 300 468 table 41).
  576. By default, gold scrambling sequence index 0 is used.
  577. The valid scrambling sequence index range is from 0 to 262142.