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

Commit be9b53c8 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: dvb-frontends: complete kernel-doc markups 



For the dvb-frontends that are now part of the documentation,
complete the kernel-doc markups, in order for them to be
properly used at the driver's kAPI documentation.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent e61edeb1

drivers/media/dvb-frontends/af9013.h

+15 −9
Original line number Diff line number Diff line
@@ -38,6 +38,13 @@ 
 * @api_version: Firmware API version.

 * @gpio: GPIOs.

 * @get_dvb_frontend: Get DVB frontend callback.

 *

 * AF9013/5 GPIOs (mostly guessed):

 *   * demod#1-gpio#0 - set demod#2 i2c-addr for dual devices

 *   * demod#1-gpio#1 - xtal setting (?)

 *   * demod#1-gpio#3 - tuner#1

 *   * demod#2-gpio#0 - tuner#2

 *   * demod#2-gpio#1 - xtal setting (?)

 */

struct af9013_platform_data {

	/*
@@ -89,16 +96,15 @@ struct af9013_platform_data { 
#define AF9013_TS_PARALLEL  AF9013_TS_MODE_PARALLEL

#define AF9013_TS_SERIAL    AF9013_TS_MODE_SERIAL



/*

 * AF9013/5 GPIOs (mostly guessed)

 * demod#1-gpio#0 - set demod#2 i2c-addr for dual devices

 * demod#1-gpio#1 - xtal setting (?)

 * demod#1-gpio#3 - tuner#1

 * demod#2-gpio#0 - tuner#2

 * demod#2-gpio#1 - xtal setting (?)

 */



#if IS_REACHABLE(CONFIG_DVB_AF9013)

/**

 * Attach an af9013 demod

 *

 * @config: pointer to &struct af9013_config with demod configuration.

 * @i2c: i2c adapter to use.

 *

 * return: FE pointer on success, NULL on failure.

 */

extern struct dvb_frontend *af9013_attach(const struct af9013_config *config,

	struct i2c_adapter *i2c);

#else

drivers/media/dvb-frontends/ascot2e.h

+9 −0
Original line number Diff line number Diff line
@@ -41,6 +41,15 @@ struct ascot2e_config { 
};



#if IS_REACHABLE(CONFIG_DVB_ASCOT2E)

/**

 * Attach an ascot2e tuner

 *

 * @fe: frontend to be attached

 * @config: pointer to &struct ascot2e_config with tuner configuration.

 * @i2c: i2c adapter to use.

 *

 * return: FE pointer on success, NULL on failure.

 */

extern struct dvb_frontend *ascot2e_attach(struct dvb_frontend *fe,

					const struct ascot2e_config *config,

					struct i2c_adapter *i2c);

drivers/media/dvb-frontends/cxd2820r.h

+23 −1
Original line number Diff line number Diff line
@@ -49,7 +49,6 @@ 
 * @gpio_chip_base: GPIO.

 * @get_dvb_frontend: Get DVB frontend.

 */



struct cxd2820r_platform_data {

	u8 ts_mode;

	bool ts_clk_inv;
@@ -62,6 +61,17 @@ struct cxd2820r_platform_data { 
	bool attach_in_use;

};



/**

 * struct cxd2820r_config - configuration for cxd2020r demod

 *

 * @i2c_address: Demodulator I2C address. Driver determines DVB-C slave I2C

 *		 address automatically from master address.

 *		 Default: none, must set. Values: 0x6c, 0x6d.

 * @ts_mode:	TS output mode. Default: none, must set. Values: FIXME?

 * @ts_clock_inv: TS clock inverted. Default: 0. Values: 0, 1.

 * @if_agc_polarity: Default: 0. Values: 0, 1

 * @spec_inv:	Spectrum inversion. Default: 0. Values: 0, 1.

 */

struct cxd2820r_config {

	/* Demodulator I2C address.

	 * Driver determines DVB-C slave I2C address automatically from master
@@ -98,6 +108,18 @@ struct cxd2820r_config { 




#if IS_REACHABLE(CONFIG_DVB_CXD2820R)

/**

 * Attach a cxd2820r demod

 *

 * @config: pointer to &struct cxd2820r_config with demod configuration.

 * @i2c: i2c adapter to use.

 * @gpio_chip_base: if zero, disables GPIO setting. Otherwise, if

 *		    CONFIG_GPIOLIB is set dynamically allocate

 *		    gpio base; if is not set, use its value to

 *		    setup the GPIO pins.

 *

 * return: FE pointer on success, NULL on failure.

 */

extern struct dvb_frontend *cxd2820r_attach(

	const struct cxd2820r_config *config,

	struct i2c_adapter *i2c,

drivers/media/dvb-frontends/drxk.h

+8 −0
Original line number Diff line number Diff line
@@ -53,6 +53,14 @@ struct drxk_config { 
};



#if IS_REACHABLE(CONFIG_DVB_DRXK)

/**

 * Attach a drxk demod

 *

 * @config: pointer to &struct drxk_config with demod configuration.

 * @i2c: i2c adapter to use.

 *

 * return: FE pointer on success, NULL on failure.

 */

extern struct dvb_frontend *drxk_attach(const struct drxk_config *config,

					struct i2c_adapter *i2c);

#else

drivers/media/dvb-frontends/dvb-pll.h

+1 −1
Original line number Diff line number Diff line
@@ -30,6 +30,7 @@ 
#define DVB_PLL_TDEE4		       18

#define DVB_PLL_THOMSON_DTT7520X       19



#if IS_REACHABLE(CONFIG_DVB_PLL)

/**

 * Attach a dvb-pll to the supplied frontend structure.

 *
@@ -40,7 +41,6 @@ 
 *

 * return: Frontend pointer on success, NULL on failure

 */

#if IS_REACHABLE(CONFIG_DVB_PLL)

extern struct dvb_frontend *dvb_pll_attach(struct dvb_frontend *fe,

					   int pll_addr,

					   struct i2c_adapter *i2c,