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

Commit 2f74b7c2 authored by Antti Palosaari's avatar Antti Palosaari Committed by Mauro Carvalho Chehab
Browse files

[media] rtl2832: add kernel-doc comments for platform_data 



Add kernel-doc comments for platform_data configuration structure.

Signed-off-by: default avatarAntti Palosaari <crope@iki.fi>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 61c309ff

drivers/media/dvb-frontends/rtl2832.h

+12 −11
Original line number Diff line number Diff line
@@ -25,16 +25,20 @@ 
#include <linux/dvb/frontend.h>

#include <linux/i2c-mux.h>



struct rtl2832_platform_data {

	/*

	 * Clock frequency.

	 * Hz

	 * 4000000, 16000000, 25000000, 28800000

/**

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

 */

	u32 clk;



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);