dvbproperty.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
  1. <section id="FE_GET_SET_PROPERTY">
  2. <title>FE_GET_PROPERTY/FE_SET_PROPERTY</title>
  3. <programlisting>
  4. /* Reserved fields should be set to 0 */
  5. struct dtv_property {
  6. __u32 cmd;
  7. union {
  8. __u32 data;
  9. struct {
  10. __u8 data[32];
  11. __u32 len;
  12. __u32 reserved1[3];
  13. void *reserved2;
  14. } buffer;
  15. } u;
  16. int result;
  17. } __attribute__ ((packed));
  18. /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
  19. #define DTV_IOCTL_MAX_MSGS 64
  20. struct dtv_properties {
  21. __u32 num;
  22. struct dtv_property *props;
  23. };
  24. </programlisting>
  25. <section id="FE_GET_PROPERTY">
  26. <title>FE_GET_PROPERTY</title>
  27. <para>DESCRIPTION
  28. </para>
  29. <informaltable><tgroup cols="1"><tbody><row><entry
  30. align="char">
  31. <para>This ioctl call returns one or more frontend properties. This call only
  32. requires read-only access to the device.</para>
  33. </entry>
  34. </row></tbody></tgroup></informaltable>
  35. <para>SYNOPSIS
  36. </para>
  37. <informaltable><tgroup cols="1"><tbody><row><entry
  38. align="char">
  39. <para>int ioctl(int fd, int request = <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>,
  40. dtv_properties &#x22C6;props);</para>
  41. </entry>
  42. </row></tbody></tgroup></informaltable>
  43. <para>PARAMETERS
  44. </para>
  45. <informaltable><tgroup cols="2"><tbody><row><entry align="char">
  46. <para>int fd</para>
  47. </entry><entry
  48. align="char">
  49. <para>File descriptor returned by a previous call to open().</para>
  50. </entry>
  51. </row><row><entry
  52. align="char">
  53. <para>int num</para>
  54. </entry><entry
  55. align="char">
  56. <para>Equals <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link> for this command.</para>
  57. </entry>
  58. </row><row><entry
  59. align="char">
  60. <para>struct dtv_property *props</para>
  61. </entry><entry
  62. align="char">
  63. <para>Points to the location where the front-end property commands are stored.</para>
  64. </entry>
  65. </row></tbody></tgroup></informaltable>
  66. <para>ERRORS</para>
  67. <informaltable><tgroup cols="2"><tbody><row>
  68. <entry align="char"><para>EINVAL</para></entry>
  69. <entry align="char"><para>Invalid parameter(s) received or number of parameters out of the range.</para></entry>
  70. </row><row>
  71. <entry align="char"><para>ENOMEM</para></entry>
  72. <entry align="char"><para>Out of memory.</para></entry>
  73. </row><row>
  74. <entry align="char"><para>EFAULT</para></entry>
  75. <entry align="char"><para>Failure while copying data from/to userspace.</para></entry>
  76. </row><row>
  77. <entry align="char"><para>EOPNOTSUPP</para></entry>
  78. <entry align="char"><para>Property type not supported.</para></entry>
  79. </row></tbody></tgroup></informaltable>
  80. </section>
  81. <section id="FE_SET_PROPERTY">
  82. <title>FE_SET_PROPERTY</title>
  83. <para>DESCRIPTION
  84. </para>
  85. <informaltable><tgroup cols="1"><tbody><row><entry
  86. align="char">
  87. <para>This ioctl call sets one or more frontend properties. This call only
  88. requires read-only access to the device.</para>
  89. </entry>
  90. </row></tbody></tgroup></informaltable>
  91. <para>SYNOPSIS
  92. </para>
  93. <informaltable><tgroup cols="1"><tbody><row><entry
  94. align="char">
  95. <para>int ioctl(int fd, int request = <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
  96. dtv_properties &#x22C6;props);</para>
  97. </entry>
  98. </row></tbody></tgroup></informaltable>
  99. <para>PARAMETERS
  100. </para>
  101. <informaltable><tgroup cols="2"><tbody><row><entry align="char">
  102. <para>int fd</para>
  103. </entry><entry
  104. align="char">
  105. <para>File descriptor returned by a previous call to open().</para>
  106. </entry>
  107. </row><row><entry
  108. align="char">
  109. <para>int num</para>
  110. </entry><entry
  111. align="char">
  112. <para>Equals <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link> for this command.</para>
  113. </entry>
  114. </row><row><entry
  115. align="char">
  116. <para>struct dtv_property *props</para>
  117. </entry><entry
  118. align="char">
  119. <para>Points to the location where the front-end property commands are stored.</para>
  120. </entry>
  121. </row></tbody></tgroup></informaltable>
  122. <para>ERRORS
  123. </para>
  124. <informaltable><tgroup cols="2"><tbody><row>
  125. <entry align="char"><para>EINVAL</para></entry>
  126. <entry align="char"><para>Invalid parameter(s) received or number of parameters out of the range.</para></entry>
  127. </row><row>
  128. <entry align="char"><para>ENOMEM</para></entry>
  129. <entry align="char"><para>Out of memory.</para></entry>
  130. </row><row>
  131. <entry align="char"><para>EFAULT</para></entry>
  132. <entry align="char"><para>Failure while copying data from/to userspace.</para></entry>
  133. </row><row>
  134. <entry align="char"><para>EOPNOTSUPP</para></entry>
  135. <entry align="char"><para>Property type not supported.</para></entry>
  136. </row></tbody></tgroup></informaltable>
  137. </section>
  138. <section>
  139. <title>Property types</title>
  140. <para>
  141. On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>/<link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
  142. the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to
  143. get/set up to 64 properties. The actual meaning of each property is described on the next sections.
  144. </para>
  145. <para>The available frontend property types are:</para>
  146. <para><link linkend="DTV-UNDEFINED">DTV_UNDEFINED</link></para>
  147. <para><link linkend="DTV-TUNE">DTV_TUNE</link></para>
  148. <para><link linkend="DTV-CLEAR">DTV_CLEAR</link></para>
  149. <para><link linkend="DTV-FREQUENCY">DTV_FREQUENCY</link></para>
  150. <para><link linkend="DTV-MODULATION">DTV_MODULATION</link></para>
  151. <para><link linkend="DTV-BANDWIDTH-HZ">DTV_BANDWIDTH_HZ</link></para>
  152. <para><link linkend="DTV-INVERSION">DTV_INVERSION</link></para>
  153. <para><link linkend="DTV-DISEQC-MASTER">DTV_DISEQC_MASTER</link></para>
  154. <para><link linkend="DTV-SYMBOL-RATE">DTV_SYMBOL_RATE</link></para>
  155. <para><link linkend="DTV-INNER-FEC">DTV_INNER_FEC</link></para>
  156. <para><link linkend="DTV-VOLTAGE">DTV_VOLTAGE</link></para>
  157. <para><link linkend="DTV-TONE">DTV_TONE</link></para>
  158. <para><link linkend="DTV-PILOT">DTV_PILOT</link></para>
  159. <para><link linkend="DTV-ROLLOFF">DTV_ROLLOFF</link></para>
  160. <para><link linkend="DTV-DISEQC-SLAVE-REPLY">DTV_DISEQC_SLAVE_REPLY</link></para>
  161. <para><link linkend="DTV-FE-CAPABILITY-COUNT">DTV_FE_CAPABILITY_COUNT</link></para>
  162. <para><link linkend="DTV-FE-CAPABILITY">DTV_FE_CAPABILITY</link></para>
  163. <para><link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link></para>
  164. <para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION">DTV_ISDBT_PARTIAL_RECEPTION</link></para>
  165. <para><link linkend="DTV-ISDBT-SOUND-BROADCASTING">DTV_ISDBT_SOUND_BROADCASTING</link></para>
  166. <para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID">DTV_ISDBT_SB_SUBCHANNEL_ID</link></para>
  167. <para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX">DTV_ISDBT_SB_SEGMENT_IDX</link></para>
  168. <para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT">DTV_ISDBT_SB_SEGMENT_COUNT</link></para>
  169. <para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERA_FEC</link></para>
  170. <para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERA_MODULATION</link></para>
  171. <para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERA_SEGMENT_COUNT</link></para>
  172. <para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERA_TIME_INTERLEAVING</link></para>
  173. <para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERB_FEC</link></para>
  174. <para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERB_MODULATION</link></para>
  175. <para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERB_SEGMENT_COUNT</link></para>
  176. <para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERB_TIME_INTERLEAVING</link></para>
  177. <para><link linkend="DTV-ISDBT-LAYER-FEC">DTV_ISDBT_LAYERC_FEC</link></para>
  178. <para><link linkend="DTV-ISDBT-LAYER-MODULATION">DTV_ISDBT_LAYERC_MODULATION</link></para>
  179. <para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT">DTV_ISDBT_LAYERC_SEGMENT_COUNT</link></para>
  180. <para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING">DTV_ISDBT_LAYERC_TIME_INTERLEAVING</link></para>
  181. <para><link linkend="DTV-API-VERSION">DTV_API_VERSION</link></para>
  182. <para><link linkend="DTV-CODE-RATE-HP">DTV_CODE_RATE_HP</link></para>
  183. <para><link linkend="DTV-CODE-RATE-LP">DTV_CODE_RATE_LP</link></para>
  184. <para><link linkend="DTV-GUARD-INTERVAL">DTV_GUARD_INTERVAL</link></para>
  185. <para><link linkend="DTV-TRANSMISSION-MODE">DTV_TRANSMISSION_MODE</link></para>
  186. <para><link linkend="DTV-HIERARCHY">DTV_HIERARCHY</link></para>
  187. <para><link linkend="DTV-ISDBT-LAYER-ENABLED">DTV_ISDBT_LAYER_ENABLED</link></para>
  188. <para><link linkend="DTV-ISDBS-TS-ID">DTV_ISDBS_TS_ID</link></para>
  189. <para><link linkend="DTV-DVBT2-PLP-ID">DTV_DVBT2_PLP_ID</link></para>
  190. </section>
  191. <section id="fe_property_parameters">
  192. <title>Digital TV property parameters</title>
  193. <section id="DTV-UNDEFINED">
  194. <title><constant>DTV_UNDEFINED</constant></title>
  195. <para>Used internally. A GET/SET operation for it won't change or return anything.</para>
  196. </section>
  197. <section id="DTV-TUNE">
  198. <title><constant>DTV_TUNE</constant></title>
  199. <para>Interpret the cache of data, build either a traditional frontend tunerequest so we can pass validation in the <constant>FE_SET_FRONTEND</constant> ioctl.</para>
  200. </section>
  201. <section id="DTV-CLEAR">
  202. <title><constant>DTV_CLEAR</constant></title>
  203. <para>Reset a cache of data specific to the frontend here. This does not effect hardware.</para>
  204. </section>
  205. <section id="DTV-FREQUENCY">
  206. <title><constant>DTV_FREQUENCY</constant></title>
  207. <para>Central frequency of the channel, in HZ.</para>
  208. <para>Notes:</para>
  209. <para>1)For ISDB-T, the channels are usually transmitted with an offset of 143kHz.
  210. E.g. a valid frequncy could be 474143 kHz. The stepping is bound to the bandwidth of
  211. the channel which is 6MHz.</para>
  212. <para>2)As in ISDB-Tsb the channel consists of only one or three segments the
  213. frequency step is 429kHz, 3*429 respectively. As for ISDB-T the
  214. central frequency of the channel is expected.</para>
  215. </section>
  216. <section id="DTV-MODULATION">
  217. <title><constant>DTV_MODULATION</constant></title>
  218. <para>Specifies the frontend modulation type for cable and satellite types. The modulation can be one of the types bellow:</para>
  219. <programlisting>
  220. typedef enum fe_modulation {
  221. QPSK,
  222. QAM_16,
  223. QAM_32,
  224. QAM_64,
  225. QAM_128,
  226. QAM_256,
  227. QAM_AUTO,
  228. VSB_8,
  229. VSB_16,
  230. PSK_8,
  231. APSK_16,
  232. APSK_32,
  233. DQPSK,
  234. } fe_modulation_t;
  235. </programlisting>
  236. </section>
  237. <section id="DTV-BANDWIDTH-HZ">
  238. <title><constant>DTV_BANDWIDTH_HZ</constant></title>
  239. <para>Bandwidth for the channel, in HZ.</para>
  240. <para>Possible values:
  241. <constant>1712000</constant>,
  242. <constant>5000000</constant>,
  243. <constant>6000000</constant>,
  244. <constant>7000000</constant>,
  245. <constant>8000000</constant>,
  246. <constant>10000000</constant>.
  247. </para>
  248. <para>Notes:</para>
  249. <para>1) For ISDB-T it should be always 6000000Hz (6MHz)</para>
  250. <para>2) For ISDB-Tsb it can vary depending on the number of connected segments</para>
  251. <para>3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth
  252. for DVB-C depends on the symbol rate</para>
  253. <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
  254. other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
  255. DTV_ISDBT_SB_SEGMENT_COUNT).</para>
  256. <para>5) DVB-T supports 6, 7 and 8MHz.</para>
  257. <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para>
  258. </section>
  259. <section id="DTV-INVERSION">
  260. <title><constant>DTV_INVERSION</constant></title>
  261. <para>The Inversion field can take one of these values:
  262. </para>
  263. <programlisting>
  264. typedef enum fe_spectral_inversion {
  265. INVERSION_OFF,
  266. INVERSION_ON,
  267. INVERSION_AUTO
  268. } fe_spectral_inversion_t;
  269. </programlisting>
  270. <para>It indicates if spectral inversion should be presumed or not. In the automatic setting
  271. (<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
  272. itself.
  273. </para>
  274. </section>
  275. <section id="DTV-DISEQC-MASTER">
  276. <title><constant>DTV_DISEQC_MASTER</constant></title>
  277. <para>Currently not implemented.</para>
  278. </section>
  279. <section id="DTV-SYMBOL-RATE">
  280. <title><constant>DTV_SYMBOL_RATE</constant></title>
  281. <para>Digital TV symbol rate, in bauds (symbols/second). Used on cable standards.</para>
  282. </section>
  283. <section id="DTV-INNER-FEC">
  284. <title><constant>DTV_INNER_FEC</constant></title>
  285. <para>Used cable/satellite transmissions. The acceptable values are:
  286. </para>
  287. <programlisting>
  288. typedef enum fe_code_rate {
  289. FEC_NONE = 0,
  290. FEC_1_2,
  291. FEC_2_3,
  292. FEC_3_4,
  293. FEC_4_5,
  294. FEC_5_6,
  295. FEC_6_7,
  296. FEC_7_8,
  297. FEC_8_9,
  298. FEC_AUTO,
  299. FEC_3_5,
  300. FEC_9_10,
  301. } fe_code_rate_t;
  302. </programlisting>
  303. <para>which correspond to error correction rates of 1/2, 2/3, etc.,
  304. no error correction or auto detection.</para>
  305. </section>
  306. <section id="DTV-VOLTAGE">
  307. <title><constant>DTV_VOLTAGE</constant></title>
  308. <para>The voltage is usually used with non-DiSEqC capable LNBs to switch
  309. the polarzation (horizontal/vertical). When using DiSEqC epuipment this
  310. voltage has to be switched consistently to the DiSEqC commands as
  311. described in the DiSEqC spec.</para>
  312. <programlisting>
  313. typedef enum fe_sec_voltage {
  314. SEC_VOLTAGE_13,
  315. SEC_VOLTAGE_18
  316. } fe_sec_voltage_t;
  317. </programlisting>
  318. </section>
  319. <section id="DTV-TONE">
  320. <title><constant>DTV_TONE</constant></title>
  321. <para>Currently not used.</para>
  322. </section>
  323. <section id="DTV-PILOT">
  324. <title><constant>DTV_PILOT</constant></title>
  325. <para>Sets DVB-S2 pilot</para>
  326. <section id="fe-pilot-t">
  327. <title>fe_pilot type</title>
  328. <programlisting>
  329. typedef enum fe_pilot {
  330. PILOT_ON,
  331. PILOT_OFF,
  332. PILOT_AUTO,
  333. } fe_pilot_t;
  334. </programlisting>
  335. </section>
  336. </section>
  337. <section id="DTV-ROLLOFF">
  338. <title><constant>DTV_ROLLOFF</constant></title>
  339. <para>Sets DVB-S2 rolloff</para>
  340. <section id="fe-rolloff-t">
  341. <title>fe_rolloff type</title>
  342. <programlisting>
  343. typedef enum fe_rolloff {
  344. ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
  345. ROLLOFF_20,
  346. ROLLOFF_25,
  347. ROLLOFF_AUTO,
  348. } fe_rolloff_t;
  349. </programlisting>
  350. </section>
  351. </section>
  352. <section id="DTV-DISEQC-SLAVE-REPLY">
  353. <title><constant>DTV_DISEQC_SLAVE_REPLY</constant></title>
  354. <para>Currently not implemented.</para>
  355. </section>
  356. <section id="DTV-FE-CAPABILITY-COUNT">
  357. <title><constant>DTV_FE_CAPABILITY_COUNT</constant></title>
  358. <para>Currently not implemented.</para>
  359. </section>
  360. <section id="DTV-FE-CAPABILITY">
  361. <title><constant>DTV_FE_CAPABILITY</constant></title>
  362. <para>Currently not implemented.</para>
  363. </section>
  364. <section id="DTV-DELIVERY-SYSTEM">
  365. <title><constant>DTV_DELIVERY_SYSTEM</constant></title>
  366. <para>Specifies the type of Delivery system</para>
  367. <section id="fe-delivery-system-t">
  368. <title>fe_delivery_system type</title>
  369. <para>Possible values: </para>
  370. <programlisting>
  371. typedef enum fe_delivery_system {
  372. SYS_UNDEFINED,
  373. SYS_DVBC_ANNEX_AC,
  374. SYS_DVBC_ANNEX_B,
  375. SYS_DVBT,
  376. SYS_DSS,
  377. SYS_DVBS,
  378. SYS_DVBS2,
  379. SYS_DVBH,
  380. SYS_ISDBT,
  381. SYS_ISDBS,
  382. SYS_ISDBC,
  383. SYS_ATSC,
  384. SYS_ATSCMH,
  385. SYS_DMBTH,
  386. SYS_CMMB,
  387. SYS_DAB,
  388. SYS_DVBT2,
  389. } fe_delivery_system_t;
  390. </programlisting>
  391. </section>
  392. </section>
  393. <section id="DTV-ISDBT-PARTIAL-RECEPTION">
  394. <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title>
  395. <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether
  396. the channel is in partial reception mode or not.</para>
  397. <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and
  398. <constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant> has to be '1'.</para>
  399. <para>If in addition <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'
  400. <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> represents whether this ISDB-Tsb channel
  401. is consisting of one segment and layer or three segments and two layers.</para>
  402. <para>Possible values: 0, 1, -1 (AUTO)</para>
  403. </section>
  404. <section id="DTV-ISDBT-SOUND-BROADCASTING">
  405. <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title>
  406. <para>This field represents whether the other DTV_ISDBT_*-parameters are
  407. referring to an ISDB-T and an ISDB-Tsb channel. (See also
  408. <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>).</para>
  409. <para>Possible values: 0, 1, -1 (AUTO)</para>
  410. </section>
  411. <section id="DTV-ISDBT-SB-SUBCHANNEL-ID">
  412. <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title>
  413. <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
  414. <para>(Note of the author: This might not be the correct description of the
  415. <constant>SUBCHANNEL-ID</constant> in all details, but it is my understanding of the technical
  416. background needed to program a device)</para>
  417. <para>An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
  418. set of connected ISDB-Tsb channels. In this set of channels every
  419. channel can be received independently. The number of connected
  420. ISDB-Tsb segment can vary, e.g. depending on the frequency spectrum
  421. bandwidth available.</para>
  422. <para>Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
  423. broadcaster has several possibilities to put those channels in the
  424. air: Assuming a normal 13-segment ISDB-T spectrum he can align the 8
  425. segments from position 1-8 to 5-13 or anything in between.</para>
  426. <para>The underlying layer of segments are subchannels: each segment is
  427. consisting of several subchannels with a predefined IDs. A sub-channel
  428. is used to help the demodulator to synchronize on the channel.</para>
  429. <para>An ISDB-T channel is always centered over all sub-channels. As for
  430. the example above, in ISDB-Tsb it is no longer as simple as that.</para>
  431. <para><constant>The DTV_ISDBT_SB_SUBCHANNEL_ID</constant> parameter is used to give the
  432. sub-channel ID of the segment to be demodulated.</para>
  433. <para>Possible values: 0 .. 41, -1 (AUTO)</para>
  434. </section>
  435. <section id="DTV-ISDBT-SB-SEGMENT-IDX">
  436. <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title>
  437. <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
  438. <para><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> gives the index of the segment to be
  439. demodulated for an ISDB-Tsb channel where several of them are
  440. transmitted in the connected manner.</para>
  441. <para>Possible values: 0 .. <constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> - 1</para>
  442. <para>Note: This value cannot be determined by an automatic channel search.</para>
  443. </section>
  444. <section id="DTV-ISDBT-SB-SEGMENT-COUNT">
  445. <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title>
  446. <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
  447. <para><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> gives the total count of connected ISDB-Tsb
  448. channels.</para>
  449. <para>Possible values: 1 .. 13</para>
  450. <para>Note: This value cannot be determined by an automatic channel search.</para>
  451. </section>
  452. <section id="isdb-hierq-layers">
  453. <title>Hierarchical layers</title>
  454. <para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
  455. ISDB-T hierarchical layers can be decoded simultaneously. For that
  456. reason a ISDB-T demodulator has 3 viterbi and 3 reed-solomon-decoders.</para>
  457. <para>ISDB-T has 3 hierarchical layers which each can use a part of the
  458. available segments. The total number of segments over all layers has
  459. to 13 in ISDB-T.</para>
  460. <section id="DTV-ISDBT-LAYER-ENABLED">
  461. <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title>
  462. <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling
  463. layers in the decoding process. Setting all bits of
  464. <constant>DTV_ISDBT_LAYER_ENABLED</constant> to '1' forces all layers (if applicable) to be
  465. demodulated. This is the default.</para>
  466. <para>If the channel is in the partial reception mode
  467. (<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> = 1) the central segment can be decoded
  468. independently of the other 12 segments. In that mode layer A has to
  469. have a <constant>SEGMENT_COUNT</constant> of 1.</para>
  470. <para>In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb
  471. according to <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>. <constant>SEGMENT_COUNT</constant> must be filled
  472. accordingly.</para>
  473. <para>Possible values: 0x1, 0x2, 0x4 (|-able)</para>
  474. <para><constant>DTV_ISDBT_LAYER_ENABLED[0:0]</constant> - layer A</para>
  475. <para><constant>DTV_ISDBT_LAYER_ENABLED[1:1]</constant> - layer B</para>
  476. <para><constant>DTV_ISDBT_LAYER_ENABLED[2:2]</constant> - layer C</para>
  477. <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para>
  478. </section>
  479. <section id="DTV-ISDBT-LAYER-FEC">
  480. <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title>
  481. <para>Possible values: <constant>FEC_AUTO</constant>, <constant>FEC_1_2</constant>, <constant>FEC_2_3</constant>, <constant>FEC_3_4</constant>, <constant>FEC_5_6</constant>, <constant>FEC_7_8</constant></para>
  482. </section>
  483. <section id="DTV-ISDBT-LAYER-MODULATION">
  484. <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title>
  485. <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para>
  486. <para>Note: If layer C is <constant>DQPSK</constant> layer B has to be <constant>DQPSK</constant>. If layer B is <constant>DQPSK</constant>
  487. and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para>
  488. </section>
  489. <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT">
  490. <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title>
  491. <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para>
  492. <para>Note: Truth table for <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> and
  493. <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> and <constant>LAYER</constant>*_SEGMENT_COUNT</para>
  494. <informaltable id="isdbt-layer_seg-cnt-table">
  495. <tgroup cols="6">
  496. <tbody>
  497. <row>
  498. <entry>PR</entry>
  499. <entry>SB</entry>
  500. <entry>Layer A width</entry>
  501. <entry>Layer B width</entry>
  502. <entry>Layer C width</entry>
  503. <entry>total width</entry>
  504. </row>
  505. <row>
  506. <entry>0</entry>
  507. <entry>0</entry>
  508. <entry>1 .. 13</entry>
  509. <entry>1 .. 13</entry>
  510. <entry>1 .. 13</entry>
  511. <entry>13</entry>
  512. </row>
  513. <row>
  514. <entry>1</entry>
  515. <entry>0</entry>
  516. <entry>1</entry>
  517. <entry>1 .. 13</entry>
  518. <entry>1 .. 13</entry>
  519. <entry>13</entry>
  520. </row>
  521. <row>
  522. <entry>0</entry>
  523. <entry>1</entry>
  524. <entry>1</entry>
  525. <entry>0</entry>
  526. <entry>0</entry>
  527. <entry>1</entry>
  528. </row>
  529. <row>
  530. <entry>1</entry>
  531. <entry>1</entry>
  532. <entry>1</entry>
  533. <entry>2</entry>
  534. <entry>0</entry>
  535. <entry>13</entry>
  536. </row>
  537. </tbody>
  538. </tgroup>
  539. </informaltable>
  540. </section>
  541. <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING">
  542. <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title>
  543. <para>Possible values: 0, 1, 2, 3, -1 (AUTO)</para>
  544. <para>Note: The real inter-leaver depth-names depend on the mode (fft-size); the values
  545. here are referring to what can be found in the TMCC-structure -
  546. independent of the mode.</para>
  547. </section>
  548. </section>
  549. <section id="DTV-API-VERSION">
  550. <title><constant>DTV_API_VERSION</constant></title>
  551. <para>Returns the major/minor version of the DVB API</para>
  552. </section>
  553. <section id="DTV-CODE-RATE-HP">
  554. <title><constant>DTV_CODE_RATE_HP</constant></title>
  555. <para>Used on terrestrial transmissions. The acceptable values are:
  556. </para>
  557. <programlisting>
  558. typedef enum fe_code_rate {
  559. FEC_NONE = 0,
  560. FEC_1_2,
  561. FEC_2_3,
  562. FEC_3_4,
  563. FEC_4_5,
  564. FEC_5_6,
  565. FEC_6_7,
  566. FEC_7_8,
  567. FEC_8_9,
  568. FEC_AUTO,
  569. FEC_3_5,
  570. FEC_9_10,
  571. } fe_code_rate_t;
  572. </programlisting>
  573. </section>
  574. <section id="DTV-CODE-RATE-LP">
  575. <title><constant>DTV_CODE_RATE_LP</constant></title>
  576. <para>Used on terrestrial transmissions. The acceptable values are:
  577. </para>
  578. <programlisting>
  579. typedef enum fe_code_rate {
  580. FEC_NONE = 0,
  581. FEC_1_2,
  582. FEC_2_3,
  583. FEC_3_4,
  584. FEC_4_5,
  585. FEC_5_6,
  586. FEC_6_7,
  587. FEC_7_8,
  588. FEC_8_9,
  589. FEC_AUTO,
  590. FEC_3_5,
  591. FEC_9_10,
  592. } fe_code_rate_t;
  593. </programlisting>
  594. </section>
  595. <section id="DTV-GUARD-INTERVAL">
  596. <title><constant>DTV_GUARD_INTERVAL</constant></title>
  597. <para>Possible values are:</para>
  598. <programlisting>
  599. typedef enum fe_guard_interval {
  600. GUARD_INTERVAL_1_32,
  601. GUARD_INTERVAL_1_16,
  602. GUARD_INTERVAL_1_8,
  603. GUARD_INTERVAL_1_4,
  604. GUARD_INTERVAL_AUTO,
  605. GUARD_INTERVAL_1_128,
  606. GUARD_INTERVAL_19_128,
  607. GUARD_INTERVAL_19_256,
  608. } fe_guard_interval_t;
  609. </programlisting>
  610. <para>Notes:</para>
  611. <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
  612. try to find the correct guard interval (if capable) and will use TMCC to fill
  613. in the missing parameters.</para>
  614. <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
  615. </section>
  616. <section id="DTV-TRANSMISSION-MODE">
  617. <title><constant>DTV_TRANSMISSION_MODE</constant></title>
  618. <para>Specifies the number of carriers used by the standard</para>
  619. <para>Possible values are:</para>
  620. <programlisting>
  621. typedef enum fe_transmit_mode {
  622. TRANSMISSION_MODE_2K,
  623. TRANSMISSION_MODE_8K,
  624. TRANSMISSION_MODE_AUTO,
  625. TRANSMISSION_MODE_4K,
  626. TRANSMISSION_MODE_1K,
  627. TRANSMISSION_MODE_16K,
  628. TRANSMISSION_MODE_32K,
  629. } fe_transmit_mode_t;
  630. </programlisting>
  631. <para>Notes:</para>
  632. <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
  633. 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para>
  634. <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the
  635. hardware will try to find the correct FFT-size (if capable) and will
  636. use TMCC to fill in the missing parameters.</para>
  637. <para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
  638. <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
  639. </section>
  640. <section id="DTV-HIERARCHY">
  641. <title><constant>DTV_HIERARCHY</constant></title>
  642. <para>Frontend hierarchy</para>
  643. <programlisting>
  644. typedef enum fe_hierarchy {
  645. HIERARCHY_NONE,
  646. HIERARCHY_1,
  647. HIERARCHY_2,
  648. HIERARCHY_4,
  649. HIERARCHY_AUTO
  650. } fe_hierarchy_t;
  651. </programlisting>
  652. </section>
  653. <section id="DTV-ISDBS-TS-ID">
  654. <title><constant>DTV_ISDBS_TS_ID</constant></title>
  655. <para>Currently unused.</para>
  656. </section>
  657. <section id="DTV-DVBT2-PLP-ID">
  658. <title><constant>DTV_DVBT2_PLP_ID</constant></title>
  659. <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of
  660. many data types via a single multiplex. The API will soon support this
  661. at which point this section will be expanded.</para>
  662. </section>
  663. <section id="frontend-property-dtv-types">
  664. <title>Properties used by each DTV type</title>
  665. <section id="isdbt">
  666. <title>ISDB-T frontend</title>
  667. <para>This section describes shortly what are the possible parameters in the Linux
  668. DVB-API called "S2API" and now DVB API 5 in order to tune an ISDB-T/ISDB-Tsb
  669. demodulator:</para>
  670. <para>This ISDB-T/ISDB-Tsb API extension should reflect all information
  671. needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible
  672. that some very sophisticated devices won't need certain parameters to
  673. tune.</para>
  674. <para>The information given here should help application writers to know how
  675. to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.</para>
  676. <para>The details given here about ISDB-T and ISDB-Tsb are just enough to
  677. basically show the dependencies between the needed parameter values,
  678. but surely some information is left out. For more detailed information
  679. see the following documents:</para>
  680. <para>ARIB STD-B31 - "Transmission System for Digital Terrestrial
  681. Television Broadcasting" and</para>
  682. <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial
  683. Television Broadcasting".</para>
  684. <para>In order to read this document one has to have some knowledge the
  685. channel structure in ISDB-T and ISDB-Tsb. I.e. it has to be known to
  686. the reader that an ISDB-T channel consists of 13 segments, that it can
  687. have up to 3 layer sharing those segments, and things like that.</para>
  688. </section>
  689. <section id="dvbt2-params">
  690. <title>DVB-T2 parameters</title>
  691. <para>This section covers parameters that apply only to the DVB-T2 delivery method. DVB-T2
  692. support is currently in the early stages development so expect this section to grow
  693. and become more detailed with time.</para>
  694. </section>
  695. </section>
  696. </section>
  697. </section>