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

Commit 1a777634 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] Docbook: Document struct analog_parameters 



That struct inside dvb-frontend.h stores some parameters
from V4L2 API (videodev2.h), in order to be used by the
hybrid analog/digital TV tuners.

Document it.

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

drivers/media/dvb-core/dvb_frontend.h

+18 −4
Original line number Diff line number Diff line
@@ -91,6 +91,20 @@ struct dvb_tuner_info { 
	u32 bandwidth_step;

};



/**

 * struct analog_parameters - Parameters to tune into an analog/radio channel

 *

 * @frequency:	Frequency used by analog TV tuner (either in 62.5 kHz step,

 * 		for TV, or 62.5 Hz for radio)

 * @mode:	Tuner mode, as defined on enum v4l2_tuner_type

 * @audmode:	Audio mode as defined for the rxsubchans field at videodev2.h,

 * 		e. g. V4L2_TUNER_MODE_*

 * @std:	TV standard bitmap as defined at videodev2.h, e. g. V4L2_STD_*

 *

 * Hybrid tuners should be supported by both V4L2 and DVB APIs. This

 * struct contains the data that are used by the V4L2 side. To avoid

 * dependencies from V4L2 headers, all enums here are declared as integers.

 */

struct analog_parameters {

	unsigned int frequency;

	unsigned int mode;
@@ -111,16 +125,16 @@ enum tuner_param { 
/**

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

 *

 * @DVBFE_ALGO_HW: (Hardware Algorithm)

 * @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.

 *

 * @DVBFE_ALGO_SW: (Software Algorithm)

 * @DVBFE_ALGO_SW: Software Algorithm -

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

 *

 * @DVBFE_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
@@ -128,7 +142,7 @@ enum tuner_param { 
 *	this algorithm, in conjunction with the search and track

 *	callbacks, utilizes the driver specific algorithm.

 *

 * @DVBFE_ALGO_RECOVERY: (Recovery Algorithm)

 * @DVBFE_ALGO_RECOVERY: Recovery Algorithm -

 *	These devices have AUTO recovery capabilities from LOCK failure

 */

enum dvbfe_algo {