From 2f74b7c2f818c7b0c86e1073c2dd49a95078844f Mon Sep 17 00:00:00 2001 From: Antti Palosaari Date: Mon, 2 Feb 2015 14:20:01 -0300 Subject: [PATCH] [media] rtl2832: add kernel-doc comments for platform_data Add kernel-doc comments for platform_data configuration structure. Signed-off-by: Antti Palosaari Signed-off-by: Mauro Carvalho Chehab --- drivers/media/dvb-frontends/rtl2832.h | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/drivers/media/dvb-frontends/rtl2832.h b/drivers/media/dvb-frontends/rtl2832.h index e5f67cf0a65b..a8e912e679a5 100644 --- a/drivers/media/dvb-frontends/rtl2832.h +++ b/drivers/media/dvb-frontends/rtl2832.h @@ -25,16 +25,20 @@ #include #include -struct rtl2832_platform_data { - /* - * Clock frequency. - * Hz - * 4000000, 16000000, 25000000, 28800000 - */ - u32 clk; +/** + * struct rtl2832_platform_data - Platform data for the rtl2832 driver + * @clk: Clock frequency (4000000, 16000000, 25000000, 28800000). + * @tuner: Used tuner model. + * @get_dvb_frontend: Get DVB frontend. + * @get_i2c_adapter: Get I2C adapter. + * @enable_slave_ts: Enable slave TS IF. + * @pid_filter: Set PID to PID filter. + * @pid_filter_ctrl: Control PID filter. + */ +struct rtl2832_platform_data { + u32 clk; /* - * Tuner. * XXX: This list must be kept sync with dvb_usb_rtl28xxu USB IF driver. */ #define RTL2832_TUNER_TUA9001 0x24 @@ -45,15 +49,12 @@ struct rtl2832_platform_data { #define RTL2832_TUNER_R828D 0x2b u8 tuner; - /* - * Callbacks. - */ struct dvb_frontend* (*get_dvb_frontend)(struct i2c_client *); struct i2c_adapter* (*get_i2c_adapter)(struct i2c_client *); int (*enable_slave_ts)(struct i2c_client *); int (*pid_filter)(struct dvb_frontend *, u8, u16, int); int (*pid_filter_ctrl)(struct dvb_frontend *, int); - /* Register access for SDR module */ +/* private: Register access for SDR module use only */ int (*bulk_read)(struct i2c_client *, unsigned int, void *, size_t); int (*bulk_write)(struct i2c_client *, unsigned int, const void *, size_t); int (*update_bits)(struct i2c_client *, unsigned int, unsigned int, unsigned int);