Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 4f1c1868 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: add dvb_frontend.h to documentation 



There are already some comments at dvb_frontend.h that are ready
for DocBook, although not properly formatted.

Convert them, and add this file to the device-drivers DocBook.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
parent fbefb1a8

Documentation/DocBook/device-drivers.tmpl

+1 −1
Original line number Diff line number Diff line
@@ -228,6 +228,7 @@ X!Isound/sound_firmware.c 
!Iinclude/media/v4l2-subdev.h

!Iinclude/media/rc-core.h

!Idrivers/media/dvb-core/dvb_ca_en50221.h

!Idrivers/media/dvb-core/dvb_frontend.h

<!-- FIXME: Removed for now due to document generation inconsistency

X!Iinclude/media/v4l2-ctrls.h

X!Iinclude/media/v4l2-dv-timings.h
@@ -237,7 +238,6 @@ X!Iinclude/media/videobuf2-memops.h 
X!Iinclude/media/videobuf2-core.h

X!Iinclude/media/lirc.h

X!Edrivers/media/dvb-core/dvb_demux.c

X!Idrivers/media/dvb-core/dvb_frontend.h

X!Idrivers/media/dvb-core/dvbdev.h

X!Edrivers/media/dvb-core/dvb_net.c

X!Idrivers/media/dvb-core/dvb_ringbuffer.h

drivers/media/dvb-core/dvb_frontend.h

+33 −35
Original line number Diff line number Diff line
@@ -121,20 +121,19 @@ enum tuner_param { 
	DVBFE_TUNER_DUMMY		= (1 << 31)

};



/*

 * ALGO_HW: (Hardware Algorithm)

 * ----------------------------------------------------------------

/**

 * enum dvbfe_algo - defines the algorithm used to tune into a channel

 *

 * @DVBFE_ALGO_HW: (Hardware Algorithm)

 *	Devices that support this algorithm do everything in hardware

 *	and no software support is needed to handle them.

 *	Requesting these devices to LOCK is the only thing required,

 *	device is supposed to do everything in the hardware.

 *

 * ALGO_SW: (Software Algorithm)

 * ----------------------------------------------------------------

 * @DVBFE_ALGO_SW: (Software Algorithm)

 * These are dumb devices, that require software to do everything

 *

 * ALGO_CUSTOM: (Customizable Agorithm)

 * ----------------------------------------------------------------

 * @DVBFE_ALGO_CUSTOM: (Customizable Agorithm)

 *	Devices having this algorithm can be customized to have specific

 *	algorithms in the frontend driver, rather than simply doing a

 *	software zig-zag. In this case the zigzag maybe hardware assisted
@@ -142,8 +141,7 @@ enum tuner_param { 
 *	this algorithm, in conjunction with the search and track

 *	callbacks, utilizes the driver specific algorithm.

 *

 * ALGO_RECOVERY: (Recovery Algorithm)

 * ----------------------------------------------------------------

 * @DVBFE_ALGO_RECOVERY: (Recovery Algorithm)

 *	These devices have AUTO recovery capabilities from LOCK failure

 */

enum dvbfe_algo {
@@ -162,26 +160,26 @@ struct tuner_state { 
	u32 refclock;

};



/*

 * search callback possible return status

/**

 * enum dvbfe_search - search callback possible return status

 *

 * DVBFE_ALGO_SEARCH_SUCCESS

 * @DVBFE_ALGO_SEARCH_SUCCESS:

 *	The frontend search algorithm completed and returned successfully

 *

 * DVBFE_ALGO_SEARCH_ASLEEP

 * @DVBFE_ALGO_SEARCH_ASLEEP:

 *	The frontend search algorithm is sleeping

 *

 * DVBFE_ALGO_SEARCH_FAILED

 * @DVBFE_ALGO_SEARCH_FAILED:

 *	The frontend search for a signal failed

 *

 * DVBFE_ALGO_SEARCH_INVALID

 * @DVBFE_ALGO_SEARCH_INVALID:

 *	The frontend search algorith was probably supplied with invalid

 *	parameters and the search is an invalid one

 *

 * DVBFE_ALGO_SEARCH_ERROR

 * @DVBFE_ALGO_SEARCH_ERROR:

 *	The frontend search algorithm failed due to some error

 *

 * DVBFE_ALGO_SEARCH_AGAIN

 * @DVBFE_ALGO_SEARCH_AGAIN:

 *	The frontend search algorithm was requested to search again

 */

enum dvbfe_search {