diff options
Diffstat (limited to 'Documentation/DocBook/media/dvb/frontend.xml')
| -rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 71 |
1 files changed, 50 insertions, 21 deletions
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index aeaed59d0f1f..426c2526a454 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml | |||
| @@ -66,7 +66,7 @@ supported via the new <link linkend="FE_GET_SET_PROPERTY">FE_GET_PROPERTY/FE_GET | |||
| 66 | 66 | ||
| 67 | <para>The usage of this field is deprecated, as it doesn't report all supported standards, and | 67 | <para>The usage of this field is deprecated, as it doesn't report all supported standards, and |
| 68 | will provide an incomplete information for frontends that support multiple delivery systems. | 68 | will provide an incomplete information for frontends that support multiple delivery systems. |
| 69 | Please use <link linkend="DTV_ENUM_DELSYS">DTV_ENUM_DELSYS</link> instead.</para> | 69 | Please use <link linkend="DTV-ENUM-DELSYS">DTV_ENUM_DELSYS</link> instead.</para> |
| 70 | </section> | 70 | </section> |
| 71 | 71 | ||
| 72 | <section id="fe-caps-t"> | 72 | <section id="fe-caps-t"> |
| @@ -101,6 +101,7 @@ a specific frontend type.</para> | |||
| 101 | FE_CAN_8VSB = 0x200000, | 101 | FE_CAN_8VSB = 0x200000, |
| 102 | FE_CAN_16VSB = 0x400000, | 102 | FE_CAN_16VSB = 0x400000, |
| 103 | FE_HAS_EXTENDED_CAPS = 0x800000, | 103 | FE_HAS_EXTENDED_CAPS = 0x800000, |
| 104 | FE_CAN_MULTISTREAM = 0x4000000, | ||
| 104 | FE_CAN_TURBO_FEC = 0x8000000, | 105 | FE_CAN_TURBO_FEC = 0x8000000, |
| 105 | FE_CAN_2G_MODULATION = 0x10000000, | 106 | FE_CAN_2G_MODULATION = 0x10000000, |
| 106 | FE_NEEDS_BENDING = 0x20000000, | 107 | FE_NEEDS_BENDING = 0x20000000, |
| @@ -207,18 +208,44 @@ spec.</para> | |||
| 207 | <para>Several functions of the frontend device use the fe_status data type defined | 208 | <para>Several functions of the frontend device use the fe_status data type defined |
| 208 | by</para> | 209 | by</para> |
| 209 | <programlisting> | 210 | <programlisting> |
| 210 | typedef enum fe_status { | 211 | typedef enum fe_status { |
| 211 | FE_HAS_SIGNAL = 0x01, /⋆ found something above the noise level ⋆/ | 212 | FE_HAS_SIGNAL = 0x01, |
| 212 | FE_HAS_CARRIER = 0x02, /⋆ found a DVB signal ⋆/ | 213 | FE_HAS_CARRIER = 0x02, |
| 213 | FE_HAS_VITERBI = 0x04, /⋆ FEC is stable ⋆/ | 214 | FE_HAS_VITERBI = 0x04, |
| 214 | FE_HAS_SYNC = 0x08, /⋆ found sync bytes ⋆/ | 215 | FE_HAS_SYNC = 0x08, |
| 215 | FE_HAS_LOCK = 0x10, /⋆ everything's working... ⋆/ | 216 | FE_HAS_LOCK = 0x10, |
| 216 | FE_TIMEDOUT = 0x20, /⋆ no lock within the last ~2 seconds ⋆/ | 217 | FE_TIMEDOUT = 0x20, |
| 217 | FE_REINIT = 0x40 /⋆ frontend was reinitialized, ⋆/ | 218 | FE_REINIT = 0x40, |
| 218 | } fe_status_t; /⋆ application is recommned to reset ⋆/ | 219 | } fe_status_t; |
| 219 | </programlisting> | 220 | </programlisting> |
| 220 | <para>to indicate the current state and/or state changes of the frontend hardware. | 221 | <para>to indicate the current state and/or state changes of the frontend hardware: |
| 221 | </para> | 222 | </para> |
| 223 | |||
| 224 | <informaltable><tgroup cols="2"><tbody> | ||
| 225 | <row> | ||
| 226 | <entry align="char">FE_HAS_SIGNAL</entry> | ||
| 227 | <entry align="char">The frontend has found something above the noise level</entry> | ||
| 228 | </row><row> | ||
| 229 | <entry align="char">FE_HAS_CARRIER</entry> | ||
| 230 | <entry align="char">The frontend has found a DVB signal</entry> | ||
| 231 | </row><row> | ||
| 232 | <entry align="char">FE_HAS_VITERBI</entry> | ||
| 233 | <entry align="char">The frontend FEC code is stable</entry> | ||
| 234 | </row><row> | ||
| 235 | <entry align="char">FE_HAS_SYNC</entry> | ||
| 236 | <entry align="char">Syncronization bytes was found</entry> | ||
| 237 | </row><row> | ||
| 238 | <entry align="char">FE_HAS_LOCK</entry> | ||
| 239 | <entry align="char">The DVB were locked and everything is working</entry> | ||
| 240 | </row><row> | ||
| 241 | <entry align="char">FE_TIMEDOUT</entry> | ||
| 242 | <entry align="char">no lock within the last about 2 seconds</entry> | ||
| 243 | </row><row> | ||
| 244 | <entry align="char">FE_REINIT</entry> | ||
| 245 | <entry align="char">The frontend was reinitialized, application is | ||
| 246 | recommended to reset DiSEqC, tone and parameters</entry> | ||
| 247 | </row> | ||
| 248 | </tbody></tgroup></informaltable> | ||
| 222 | 249 | ||
| 223 | </section> | 250 | </section> |
| 224 | 251 | ||
| @@ -238,7 +265,7 @@ and to add newer delivery systems.</para> | |||
| 238 | <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in | 265 | <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in |
| 239 | order to be able to support the newer System Delivery like DVB-S2, DVB-T2, | 266 | order to be able to support the newer System Delivery like DVB-S2, DVB-T2, |
| 240 | DVB-C2, ISDB, etc.</para> | 267 | DVB-C2, ISDB, etc.</para> |
| 241 | <para>All kinds of parameters are combined as an union in the FrontendParameters structure:</para> | 268 | <para>All kinds of parameters are combined as an union in the FrontendParameters structure: |
| 242 | <programlisting> | 269 | <programlisting> |
| 243 | struct dvb_frontend_parameters { | 270 | struct dvb_frontend_parameters { |
| 244 | uint32_t frequency; /⋆ (absolute) frequency in Hz for QAM/OFDM ⋆/ | 271 | uint32_t frequency; /⋆ (absolute) frequency in Hz for QAM/OFDM ⋆/ |
| @@ -251,12 +278,13 @@ struct dvb_frontend_parameters { | |||
| 251 | struct dvb_vsb_parameters vsb; | 278 | struct dvb_vsb_parameters vsb; |
| 252 | } u; | 279 | } u; |
| 253 | }; | 280 | }; |
| 254 | </programlisting> | 281 | </programlisting></para> |
| 255 | <para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate | 282 | <para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate |
| 256 | frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of | 283 | frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of |
| 257 | the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and | 284 | the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and |
| 258 | OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz. | 285 | OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz. |
| 259 | </para> | 286 | </para> |
| 287 | |||
| 260 | <section id="dvb-qpsk-parameters"> | 288 | <section id="dvb-qpsk-parameters"> |
| 261 | <title>QPSK parameters</title> | 289 | <title>QPSK parameters</title> |
| 262 | <para>For satellite QPSK frontends you have to use the <constant>dvb_qpsk_parameters</constant> structure:</para> | 290 | <para>For satellite QPSK frontends you have to use the <constant>dvb_qpsk_parameters</constant> structure:</para> |
| @@ -321,8 +349,8 @@ itself. | |||
| 321 | <section id="fe-code-rate-t"> | 349 | <section id="fe-code-rate-t"> |
| 322 | <title>frontend code rate</title> | 350 | <title>frontend code rate</title> |
| 323 | <para>The possible values for the <constant>fec_inner</constant> field used on | 351 | <para>The possible values for the <constant>fec_inner</constant> field used on |
| 324 | <link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and | 352 | <link linkend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and |
| 325 | <link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are: | 353 | <link linkend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are: |
| 326 | </para> | 354 | </para> |
| 327 | <programlisting> | 355 | <programlisting> |
| 328 | typedef enum fe_code_rate { | 356 | typedef enum fe_code_rate { |
| @@ -347,9 +375,9 @@ detection. | |||
| 347 | <section id="fe-modulation-t"> | 375 | <section id="fe-modulation-t"> |
| 348 | <title>frontend modulation type for QAM, OFDM and VSB</title> | 376 | <title>frontend modulation type for QAM, OFDM and VSB</title> |
| 349 | <para>For cable and terrestrial frontends, e. g. for | 377 | <para>For cable and terrestrial frontends, e. g. for |
| 350 | <link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>, | 378 | <link linkend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>, |
| 351 | <link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and | 379 | <link linkend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and |
| 352 | <link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>, | 380 | <link linkend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>, |
| 353 | it needs to specify the quadrature modulation mode which can be one of the following: | 381 | it needs to specify the quadrature modulation mode which can be one of the following: |
| 354 | </para> | 382 | </para> |
| 355 | <programlisting> | 383 | <programlisting> |
| @@ -370,8 +398,8 @@ it needs to specify the quadrature modulation mode which can be one of the follo | |||
| 370 | } fe_modulation_t; | 398 | } fe_modulation_t; |
| 371 | </programlisting> | 399 | </programlisting> |
| 372 | </section> | 400 | </section> |
| 373 | <para>Finally, there are several more parameters for OFDM: | 401 | <section> |
| 374 | </para> | 402 | <title>More OFDM parameters</title> |
| 375 | <section id="fe-transmit-mode-t"> | 403 | <section id="fe-transmit-mode-t"> |
| 376 | <title>Number of carriers per channel</title> | 404 | <title>Number of carriers per channel</title> |
| 377 | <programlisting> | 405 | <programlisting> |
| @@ -427,6 +455,7 @@ typedef enum fe_hierarchy { | |||
| 427 | } fe_hierarchy_t; | 455 | } fe_hierarchy_t; |
| 428 | </programlisting> | 456 | </programlisting> |
| 429 | </section> | 457 | </section> |
| 458 | </section> | ||
| 430 | 459 | ||
| 431 | </section> | 460 | </section> |
| 432 | 461 | ||
