Commit 0d27bbfe authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] frontend.h, Docbook: Improve status documentation

No functional changes. It just improves the description of the frontend
status, using Documentation/kernel-doc-nano-HOWTO.txt for the status
enumeration, and a table inside the DocBook.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 322c183c
...@@ -207,18 +207,44 @@ spec.</para> ...@@ -207,18 +207,44 @@ spec.</para>
<para>Several functions of the frontend device use the fe_status data type defined <para>Several functions of the frontend device use the fe_status data type defined
by</para> by</para>
<programlisting> <programlisting>
typedef enum fe_status { typedef enum fe_status {
FE_HAS_SIGNAL = 0x01, /&#x22C6; found something above the noise level &#x22C6;/ FE_HAS_SIGNAL = 0x01,
FE_HAS_CARRIER = 0x02, /&#x22C6; found a DVB signal &#x22C6;/ FE_HAS_CARRIER = 0x02,
FE_HAS_VITERBI = 0x04, /&#x22C6; FEC is stable &#x22C6;/ FE_HAS_VITERBI = 0x04,
FE_HAS_SYNC = 0x08, /&#x22C6; found sync bytes &#x22C6;/ FE_HAS_SYNC = 0x08,
FE_HAS_LOCK = 0x10, /&#x22C6; everything's working... &#x22C6;/ FE_HAS_LOCK = 0x10,
FE_TIMEDOUT = 0x20, /&#x22C6; no lock within the last ~2 seconds &#x22C6;/ FE_TIMEDOUT = 0x20,
FE_REINIT = 0x40 /&#x22C6; frontend was reinitialized, &#x22C6;/ FE_REINIT = 0x40,
} fe_status_t; /&#x22C6; application is recommned to reset &#x22C6;/ } fe_status_t;
</programlisting> </programlisting>
<para>to indicate the current state and/or state changes of the frontend hardware. <para>to indicate the current state and/or state changes of the frontend hardware:
</para> </para>
<informaltable><tgroup cols="2"><tbody>
<row>
<entry align="char">FE_HAS_SIGNAL</entry>
<entry align="char">The frontend has found something above the noise level</entry>
</row><row>
<entry align="char">FE_HAS_CARRIER</entry>
<entry align="char">The frontend has found a DVB signal</entry>
</row><row>
<entry align="char">FE_HAS_VITERBI</entry>
<entry align="char">The frontend FEC code is stable</entry>
</row><row>
<entry align="char">FE_HAS_SYNC</entry>
<entry align="char">Syncronization bytes was found</entry>
</row><row>
<entry align="char">FE_HAS_LOCK</entry>
<entry align="char">The DVB were locked and everything is working</entry>
</row><row>
<entry align="char">FE_TIMEDOUT</entry>
<entry align="char">no lock within the last about 2 seconds</entry>
</row><row>
<entry align="char">FE_REINIT</entry>
<entry align="char">The frontend was reinitialized, application is
recommended to reset DiSEqC, tone and parameters</entry>
</row>
</tbody></tgroup></informaltable>
</section> </section>
......
...@@ -121,16 +121,27 @@ typedef enum fe_sec_mini_cmd { ...@@ -121,16 +121,27 @@ typedef enum fe_sec_mini_cmd {
} fe_sec_mini_cmd_t; } fe_sec_mini_cmd_t;
/**
* enum fe_status - enumerates the possible frontend status
* @FE_HAS_SIGNAL: found something above the noise level
* @FE_HAS_CARRIER: found a DVB signal
* @FE_HAS_VITERBI: FEC is stable
* @FE_HAS_SYNC: found sync bytes
* @FE_HAS_LOCK: everything's working
* @FE_TIMEDOUT: no lock within the last ~2 seconds
* @FE_REINIT: frontend was reinitialized, application is recommended
* to reset DiSEqC, tone and parameters
*/
typedef enum fe_status { typedef enum fe_status {
FE_HAS_SIGNAL = 0x01, /* found something above the noise level */ FE_HAS_SIGNAL = 0x01,
FE_HAS_CARRIER = 0x02, /* found a DVB signal */ FE_HAS_CARRIER = 0x02,
FE_HAS_VITERBI = 0x04, /* FEC is stable */ FE_HAS_VITERBI = 0x04,
FE_HAS_SYNC = 0x08, /* found sync bytes */ FE_HAS_SYNC = 0x08,
FE_HAS_LOCK = 0x10, /* everything's working... */ FE_HAS_LOCK = 0x10,
FE_TIMEDOUT = 0x20, /* no lock within the last ~2 seconds */ FE_TIMEDOUT = 0x20,
FE_REINIT = 0x40 /* frontend was reinitialized, */ FE_REINIT = 0x40,
} fe_status_t; /* application is recommended to reset */ } fe_status_t;
/* DiSEqC, tone and parameters */
typedef enum fe_spectral_inversion { typedef enum fe_spectral_inversion {
INVERSION_OFF, INVERSION_OFF,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment