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

[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

Documentation/DocBook/media/dvb/frontend.xml

+37 −11
Original line number Diff line number Diff line
@@ -208,18 +208,44 @@ spec.</para> 
by</para>

<programlisting>

typedef enum fe_status {

	 FE_HAS_SIGNAL     = 0x01,   /&#x22C6;  found something above the noise level &#x22C6;/

	 FE_HAS_CARRIER    = 0x02,   /&#x22C6;  found a DVB signal  &#x22C6;/

	 FE_HAS_VITERBI    = 0x04,   /&#x22C6;  FEC is stable  &#x22C6;/

	 FE_HAS_SYNC       = 0x08,   /&#x22C6;  found sync bytes  &#x22C6;/

	 FE_HAS_LOCK       = 0x10,   /&#x22C6;  everything's working... &#x22C6;/

	 FE_TIMEDOUT       = 0x20,   /&#x22C6;  no lock within the last ~2 seconds &#x22C6;/

	 FE_REINIT         = 0x40    /&#x22C6;  frontend was reinitialized,  &#x22C6;/

 } fe_status_t;                      /&#x22C6;  application is recommned to reset &#x22C6;/

	FE_HAS_SIGNAL		= 0x01,

	FE_HAS_CARRIER		= 0x02,

	FE_HAS_VITERBI		= 0x04,

	FE_HAS_SYNC		= 0x08,

	FE_HAS_LOCK		= 0x10,

	FE_TIMEDOUT		= 0x20,

	FE_REINIT		= 0x40,

} fe_status_t;

</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>



<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 id="dvb-frontend-parameters">

include/linux/dvb/frontend.h

+20 −9
Original line number Diff line number Diff line
@@ -121,16 +121,27 @@ typedef enum fe_sec_mini_cmd { 
} 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 {

	FE_HAS_SIGNAL	= 0x01,   /* found something above the noise level */

	FE_HAS_CARRIER	= 0x02,   /* found a DVB signal  */

	FE_HAS_VITERBI	= 0x04,   /* FEC is stable  */

	FE_HAS_SYNC	= 0x08,   /* found sync bytes  */

	FE_HAS_LOCK	= 0x10,   /* everything's working... */

	FE_TIMEDOUT	= 0x20,   /* no lock within the last ~2 seconds */

	FE_REINIT	= 0x40    /* frontend was reinitialized,  */

} fe_status_t;			  /* application is recommended to reset */

				  /* DiSEqC, tone and parameters */

	FE_HAS_SIGNAL		= 0x01,

	FE_HAS_CARRIER		= 0x02,

	FE_HAS_VITERBI		= 0x04,

	FE_HAS_SYNC		= 0x08,

	FE_HAS_LOCK		= 0x10,

	FE_TIMEDOUT		= 0x20,

	FE_REINIT		= 0x40,

} fe_status_t;



typedef enum fe_spectral_inversion {

	INVERSION_OFF,