diff mbox

[05/66] rtl2830: convert driver to kernel I2C model

Message ID 1419367799-14263-5-git-send-email-crope@iki.fi (mailing list archive)
State New, archived
Headers show

Commit Message

Antti Palosaari Dec. 23, 2014, 8:48 p.m. UTC
Convert driver to kernel I2C model. Old DVB proprietary model is
still left there also.

Signed-off-by: Antti Palosaari <crope@iki.fi>
---
 drivers/media/dvb-frontends/Kconfig        |   2 +-
 drivers/media/dvb-frontends/rtl2830.c      | 167 +++++++++++++++++++++++++++++
 drivers/media/dvb-frontends/rtl2830.h      |  31 ++++++
 drivers/media/dvb-frontends/rtl2830_priv.h |   2 +
 4 files changed, 201 insertions(+), 1 deletion(-)

Comments

Mauro Carvalho Chehab Jan. 27, 2015, 1:10 p.m. UTC | #1
Em Tue, 23 Dec 2014 22:48:58 +0200
Antti Palosaari <crope@iki.fi> escreveu:

> Convert driver to kernel I2C model. Old DVB proprietary model is
> still left there also.
> 
> Signed-off-by: Antti Palosaari <crope@iki.fi>
> ---
>  drivers/media/dvb-frontends/Kconfig        |   2 +-
>  drivers/media/dvb-frontends/rtl2830.c      | 167 +++++++++++++++++++++++++++++
>  drivers/media/dvb-frontends/rtl2830.h      |  31 ++++++
>  drivers/media/dvb-frontends/rtl2830_priv.h |   2 +
>  4 files changed, 201 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/media/dvb-frontends/Kconfig b/drivers/media/dvb-frontends/Kconfig
> index 6c75418..e8827fc 100644
> --- a/drivers/media/dvb-frontends/Kconfig
> +++ b/drivers/media/dvb-frontends/Kconfig
> @@ -443,7 +443,7 @@ config DVB_CXD2820R
>  
>  config DVB_RTL2830
>  	tristate "Realtek RTL2830 DVB-T"
> -	depends on DVB_CORE && I2C
> +	depends on DVB_CORE && I2C && I2C_MUX
>  	default m if !MEDIA_SUBDRV_AUTOSELECT
>  	help
>  	  Say Y when you want to support this frontend.
> diff --git a/drivers/media/dvb-frontends/rtl2830.c b/drivers/media/dvb-frontends/rtl2830.c
> index 50e8b63..ec4a19c 100644
> --- a/drivers/media/dvb-frontends/rtl2830.c
> +++ b/drivers/media/dvb-frontends/rtl2830.c
> @@ -767,6 +767,173 @@ static struct dvb_frontend_ops rtl2830_ops = {
>  	.read_signal_strength = rtl2830_read_signal_strength,
>  };
>  
> +/*
> + * I2C gate/repeater logic
> + * We must use unlocked i2c_transfer() here because I2C lock is already taken
> + * by tuner driver. Gate is closed automatically after single I2C xfer.
> + */
> +static int rtl2830_select(struct i2c_adapter *adap, void *mux_priv, u32 chan_id)
> +{
> +	struct i2c_client *client = mux_priv;
> +	struct rtl2830_priv *priv = i2c_get_clientdata(client);
> +	struct i2c_msg select_reg_page_msg[1] = {
> +		{
> +			.addr = priv->cfg.i2c_addr,
> +			.flags = 0,
> +			.len = 2,
> +			.buf = "\x00\x01",
> +		}
> +	};
> +	struct i2c_msg gate_open_msg[1] = {
> +		{
> +			.addr = priv->cfg.i2c_addr,
> +			.flags = 0,
> +			.len = 2,
> +			.buf = "\x01\x08",
> +		}
> +	};
> +	int ret;
> +
> +	/* select register page */
> +	ret = __i2c_transfer(adap, select_reg_page_msg, 1);
> +	if (ret != 1) {
> +		dev_warn(&client->dev, "i2c write failed %d\n", ret);
> +		if (ret >= 0)
> +			ret = -EREMOTEIO;
> +		goto err;
> +	}
> +
> +	priv->page = 1;
> +
> +	/* open tuner I2C repeater for 1 xfer, closes automatically */
> +	ret = __i2c_transfer(adap, gate_open_msg, 1);
> +	if (ret != 1) {
> +		dev_warn(&client->dev, "i2c write failed %d\n", ret);
> +		if (ret >= 0)
> +			ret = -EREMOTEIO;
> +		goto err;
> +	}
> +
> +	return 0;
> +
> +err:
> +	dev_dbg(&client->dev, "%s: failed=%d\n", __func__, ret);
> +	return ret;
> +}
> +
> +static struct dvb_frontend *rtl2830_get_dvb_frontend(struct i2c_client *client)
> +{
> +	struct rtl2830_priv *priv = i2c_get_clientdata(client);
> +
> +	dev_dbg(&client->dev, "\n");
> +
> +	return &priv->fe;
> +}
> +
> +static struct i2c_adapter *rtl2830_get_i2c_adapter(struct i2c_client *client)
> +{
> +	struct rtl2830_priv *priv = i2c_get_clientdata(client);
> +
> +	dev_dbg(&client->dev, "\n");
> +
> +	return priv->adapter;
> +}
> +
> +static int rtl2830_probe(struct i2c_client *client,
> +		const struct i2c_device_id *id)
> +{
> +	struct rtl2830_platform_data *pdata = client->dev.platform_data;
> +	struct i2c_adapter *i2c = client->adapter;
> +	struct rtl2830_priv *priv;
> +	int ret;
> +	u8 u8tmp;
> +
> +	dev_dbg(&client->dev, "\n");
> +
> +	if (pdata == NULL) {
> +		ret = -EINVAL;
> +		goto err;
> +	}
> +
> +	/* allocate memory for the internal state */
> +	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
> +	if (priv == NULL) {
> +		ret = -ENOMEM;
> +		goto err;
> +	}
> +
> +	/* setup the state */
> +	i2c_set_clientdata(client, priv);
> +	priv->i2c = i2c;
> +	priv->sleeping = true;
> +	priv->cfg.i2c_addr = client->addr;
> +	priv->cfg.xtal = pdata->clk;
> +	priv->cfg.spec_inv = pdata->spec_inv;
> +	priv->cfg.vtop = pdata->vtop;
> +	priv->cfg.krf = pdata->krf;
> +	priv->cfg.agc_targ_val = pdata->agc_targ_val;
> +
> +	/* check if the demod is there */
> +	ret = rtl2830_rd_reg(priv, 0x000, &u8tmp);
> +	if (ret)
> +		goto err_kfree;
> +
> +	/* create muxed i2c adapter for tuner */
> +	priv->adapter = i2c_add_mux_adapter(client->adapter, &client->dev,
> +			client, 0, 0, 0, rtl2830_select, NULL);
> +	if (priv->adapter == NULL) {
> +		ret = -ENODEV;
> +		goto err_kfree;
> +	}
> +
> +	/* create dvb frontend */
> +	memcpy(&priv->fe.ops, &rtl2830_ops, sizeof(priv->fe.ops));
> +	priv->fe.ops.release = NULL;
> +	priv->fe.demodulator_priv = priv;
> +
> +	/* setup callbacks */
> +	pdata->get_dvb_frontend = rtl2830_get_dvb_frontend;
> +	pdata->get_i2c_adapter = rtl2830_get_i2c_adapter;
> +
> +	dev_info(&client->dev, "Realtek RTL2830 successfully attached\n");
> +	return 0;
> +
> +err_kfree:
> +	kfree(priv);
> +err:
> +	dev_dbg(&client->dev, "failed=%d\n", ret);
> +	return ret;
> +}
> +
> +static int rtl2830_remove(struct i2c_client *client)
> +{
> +	struct rtl2830_priv *priv = i2c_get_clientdata(client);
> +
> +	dev_dbg(&client->dev, "\n");
> +
> +	i2c_del_mux_adapter(priv->adapter);
> +	kfree(priv);
> +	return 0;
> +}
> +
> +static const struct i2c_device_id rtl2830_id_table[] = {
> +	{"rtl2830", 0},
> +	{}
> +};
> +MODULE_DEVICE_TABLE(i2c, rtl2830_id_table);
> +
> +static struct i2c_driver rtl2830_driver = {
> +	.driver = {
> +		.owner	= THIS_MODULE,
> +		.name	= "rtl2830",
> +	},
> +	.probe		= rtl2830_probe,
> +	.remove		= rtl2830_remove,
> +	.id_table	= rtl2830_id_table,
> +};
> +
> +module_i2c_driver(rtl2830_driver);
> +
>  MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
>  MODULE_DESCRIPTION("Realtek RTL2830 DVB-T demodulator driver");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/media/dvb-frontends/rtl2830.h b/drivers/media/dvb-frontends/rtl2830.h
> index 3313847..b925ea5 100644
> --- a/drivers/media/dvb-frontends/rtl2830.h
> +++ b/drivers/media/dvb-frontends/rtl2830.h
> @@ -24,6 +24,37 @@
>  #include <linux/kconfig.h>
>  #include <linux/dvb/frontend.h>
>  
> +struct rtl2830_platform_data {
> +	/*
> +	 * Clock frequency.
> +	 * Hz
> +	 * 4000000, 16000000, 25000000, 28800000
> +	 */
> +	u32 clk;
> +
> +	/*
> +	 * Spectrum inversion.
> +	 */
> +	bool spec_inv;
> +
> +	/*
> +	 */
> +	u8 vtop;
> +
> +	/*
> +	 */
> +	u8 krf;
> +
> +	/*
> +	 */
> +	u8 agc_targ_val;
> +
> +	/*
> +	 */
> +	struct dvb_frontend* (*get_dvb_frontend)(struct i2c_client *);
> +	struct i2c_adapter* (*get_i2c_adapter)(struct i2c_client *);
> +};

Please fix this to follow the Kernel CodingStyle for struct/function/...
documentation:
	Documentation/kernel-doc-nano-HOWTO.txt

Sometimes, I just leave things like that to pass, but the above one is too
ugly, with empty multiple line comments, uncommented arguments, etc.


> +
>  struct rtl2830_config {
>  	/*
>  	 * Demodulator I2C address.
> diff --git a/drivers/media/dvb-frontends/rtl2830_priv.h b/drivers/media/dvb-frontends/rtl2830_priv.h
> index fab10ec..1a78351 100644
> --- a/drivers/media/dvb-frontends/rtl2830_priv.h
> +++ b/drivers/media/dvb-frontends/rtl2830_priv.h
> @@ -24,8 +24,10 @@
>  #include "dvb_frontend.h"
>  #include "dvb_math.h"
>  #include "rtl2830.h"
> +#include <linux/i2c-mux.h>
>  
>  struct rtl2830_priv {
> +	struct i2c_adapter *adapter;
>  	struct i2c_adapter *i2c;
>  	struct dvb_frontend fe;
>  	struct rtl2830_config cfg;
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Antti Palosaari Feb. 2, 2015, 5:50 p.m. UTC | #2
On 01/27/2015 03:10 PM, Mauro Carvalho Chehab wrote:
> Em Tue, 23 Dec 2014 22:48:58 +0200
> Antti Palosaari <crope@iki.fi> escreveu:
>
>> Convert driver to kernel I2C model. Old DVB proprietary model is
>> still left there also.
>>
>> Signed-off-by: Antti Palosaari <crope@iki.fi>

>> +struct rtl2830_platform_data {
>> +	/*
>> +	 * Clock frequency.
>> +	 * Hz
>> +	 * 4000000, 16000000, 25000000, 28800000
>> +	 */
>> +	u32 clk;
>> +
>> +	/*
>> +	 * Spectrum inversion.
>> +	 */
>> +	bool spec_inv;
>> +
>> +	/*
>> +	 */
>> +	u8 vtop;
>> +
>> +	/*
>> +	 */
>> +	u8 krf;
>> +
>> +	/*
>> +	 */
>> +	u8 agc_targ_val;
>> +
>> +	/*
>> +	 */
>> +	struct dvb_frontend* (*get_dvb_frontend)(struct i2c_client *);
>> +	struct i2c_adapter* (*get_i2c_adapter)(struct i2c_client *);
>> +};
>
> Please fix this to follow the Kernel CodingStyle for struct/function/...
> documentation:
> 	Documentation/kernel-doc-nano-HOWTO.txt
>
> Sometimes, I just leave things like that to pass, but the above one is too
> ugly, with empty multiple line comments, uncommented arguments, etc.

I added kernel-doc comments for rtl2830, rtl2832 and rtl2832_sdr driver 
platform data. PULL request is already updated.

And next time please start keep noise earlier - I have written tens of 
these drivers and that was first time you ask kernel-doc format comments 
for driver configurations structures. I see those should be as 
kernel-doc-nano-HOWTO.txt says, but it was first time I hear about that 
rule.

regards
Antti
diff mbox

Patch

diff --git a/drivers/media/dvb-frontends/Kconfig b/drivers/media/dvb-frontends/Kconfig
index 6c75418..e8827fc 100644
--- a/drivers/media/dvb-frontends/Kconfig
+++ b/drivers/media/dvb-frontends/Kconfig
@@ -443,7 +443,7 @@  config DVB_CXD2820R
 
 config DVB_RTL2830
 	tristate "Realtek RTL2830 DVB-T"
-	depends on DVB_CORE && I2C
+	depends on DVB_CORE && I2C && I2C_MUX
 	default m if !MEDIA_SUBDRV_AUTOSELECT
 	help
 	  Say Y when you want to support this frontend.
diff --git a/drivers/media/dvb-frontends/rtl2830.c b/drivers/media/dvb-frontends/rtl2830.c
index 50e8b63..ec4a19c 100644
--- a/drivers/media/dvb-frontends/rtl2830.c
+++ b/drivers/media/dvb-frontends/rtl2830.c
@@ -767,6 +767,173 @@  static struct dvb_frontend_ops rtl2830_ops = {
 	.read_signal_strength = rtl2830_read_signal_strength,
 };
 
+/*
+ * I2C gate/repeater logic
+ * We must use unlocked i2c_transfer() here because I2C lock is already taken
+ * by tuner driver. Gate is closed automatically after single I2C xfer.
+ */
+static int rtl2830_select(struct i2c_adapter *adap, void *mux_priv, u32 chan_id)
+{
+	struct i2c_client *client = mux_priv;
+	struct rtl2830_priv *priv = i2c_get_clientdata(client);
+	struct i2c_msg select_reg_page_msg[1] = {
+		{
+			.addr = priv->cfg.i2c_addr,
+			.flags = 0,
+			.len = 2,
+			.buf = "\x00\x01",
+		}
+	};
+	struct i2c_msg gate_open_msg[1] = {
+		{
+			.addr = priv->cfg.i2c_addr,
+			.flags = 0,
+			.len = 2,
+			.buf = "\x01\x08",
+		}
+	};
+	int ret;
+
+	/* select register page */
+	ret = __i2c_transfer(adap, select_reg_page_msg, 1);
+	if (ret != 1) {
+		dev_warn(&client->dev, "i2c write failed %d\n", ret);
+		if (ret >= 0)
+			ret = -EREMOTEIO;
+		goto err;
+	}
+
+	priv->page = 1;
+
+	/* open tuner I2C repeater for 1 xfer, closes automatically */
+	ret = __i2c_transfer(adap, gate_open_msg, 1);
+	if (ret != 1) {
+		dev_warn(&client->dev, "i2c write failed %d\n", ret);
+		if (ret >= 0)
+			ret = -EREMOTEIO;
+		goto err;
+	}
+
+	return 0;
+
+err:
+	dev_dbg(&client->dev, "%s: failed=%d\n", __func__, ret);
+	return ret;
+}
+
+static struct dvb_frontend *rtl2830_get_dvb_frontend(struct i2c_client *client)
+{
+	struct rtl2830_priv *priv = i2c_get_clientdata(client);
+
+	dev_dbg(&client->dev, "\n");
+
+	return &priv->fe;
+}
+
+static struct i2c_adapter *rtl2830_get_i2c_adapter(struct i2c_client *client)
+{
+	struct rtl2830_priv *priv = i2c_get_clientdata(client);
+
+	dev_dbg(&client->dev, "\n");
+
+	return priv->adapter;
+}
+
+static int rtl2830_probe(struct i2c_client *client,
+		const struct i2c_device_id *id)
+{
+	struct rtl2830_platform_data *pdata = client->dev.platform_data;
+	struct i2c_adapter *i2c = client->adapter;
+	struct rtl2830_priv *priv;
+	int ret;
+	u8 u8tmp;
+
+	dev_dbg(&client->dev, "\n");
+
+	if (pdata == NULL) {
+		ret = -EINVAL;
+		goto err;
+	}
+
+	/* allocate memory for the internal state */
+	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
+	if (priv == NULL) {
+		ret = -ENOMEM;
+		goto err;
+	}
+
+	/* setup the state */
+	i2c_set_clientdata(client, priv);
+	priv->i2c = i2c;
+	priv->sleeping = true;
+	priv->cfg.i2c_addr = client->addr;
+	priv->cfg.xtal = pdata->clk;
+	priv->cfg.spec_inv = pdata->spec_inv;
+	priv->cfg.vtop = pdata->vtop;
+	priv->cfg.krf = pdata->krf;
+	priv->cfg.agc_targ_val = pdata->agc_targ_val;
+
+	/* check if the demod is there */
+	ret = rtl2830_rd_reg(priv, 0x000, &u8tmp);
+	if (ret)
+		goto err_kfree;
+
+	/* create muxed i2c adapter for tuner */
+	priv->adapter = i2c_add_mux_adapter(client->adapter, &client->dev,
+			client, 0, 0, 0, rtl2830_select, NULL);
+	if (priv->adapter == NULL) {
+		ret = -ENODEV;
+		goto err_kfree;
+	}
+
+	/* create dvb frontend */
+	memcpy(&priv->fe.ops, &rtl2830_ops, sizeof(priv->fe.ops));
+	priv->fe.ops.release = NULL;
+	priv->fe.demodulator_priv = priv;
+
+	/* setup callbacks */
+	pdata->get_dvb_frontend = rtl2830_get_dvb_frontend;
+	pdata->get_i2c_adapter = rtl2830_get_i2c_adapter;
+
+	dev_info(&client->dev, "Realtek RTL2830 successfully attached\n");
+	return 0;
+
+err_kfree:
+	kfree(priv);
+err:
+	dev_dbg(&client->dev, "failed=%d\n", ret);
+	return ret;
+}
+
+static int rtl2830_remove(struct i2c_client *client)
+{
+	struct rtl2830_priv *priv = i2c_get_clientdata(client);
+
+	dev_dbg(&client->dev, "\n");
+
+	i2c_del_mux_adapter(priv->adapter);
+	kfree(priv);
+	return 0;
+}
+
+static const struct i2c_device_id rtl2830_id_table[] = {
+	{"rtl2830", 0},
+	{}
+};
+MODULE_DEVICE_TABLE(i2c, rtl2830_id_table);
+
+static struct i2c_driver rtl2830_driver = {
+	.driver = {
+		.owner	= THIS_MODULE,
+		.name	= "rtl2830",
+	},
+	.probe		= rtl2830_probe,
+	.remove		= rtl2830_remove,
+	.id_table	= rtl2830_id_table,
+};
+
+module_i2c_driver(rtl2830_driver);
+
 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
 MODULE_DESCRIPTION("Realtek RTL2830 DVB-T demodulator driver");
 MODULE_LICENSE("GPL");
diff --git a/drivers/media/dvb-frontends/rtl2830.h b/drivers/media/dvb-frontends/rtl2830.h
index 3313847..b925ea5 100644
--- a/drivers/media/dvb-frontends/rtl2830.h
+++ b/drivers/media/dvb-frontends/rtl2830.h
@@ -24,6 +24,37 @@ 
 #include <linux/kconfig.h>
 #include <linux/dvb/frontend.h>
 
+struct rtl2830_platform_data {
+	/*
+	 * Clock frequency.
+	 * Hz
+	 * 4000000, 16000000, 25000000, 28800000
+	 */
+	u32 clk;
+
+	/*
+	 * Spectrum inversion.
+	 */
+	bool spec_inv;
+
+	/*
+	 */
+	u8 vtop;
+
+	/*
+	 */
+	u8 krf;
+
+	/*
+	 */
+	u8 agc_targ_val;
+
+	/*
+	 */
+	struct dvb_frontend* (*get_dvb_frontend)(struct i2c_client *);
+	struct i2c_adapter* (*get_i2c_adapter)(struct i2c_client *);
+};
+
 struct rtl2830_config {
 	/*
 	 * Demodulator I2C address.
diff --git a/drivers/media/dvb-frontends/rtl2830_priv.h b/drivers/media/dvb-frontends/rtl2830_priv.h
index fab10ec..1a78351 100644
--- a/drivers/media/dvb-frontends/rtl2830_priv.h
+++ b/drivers/media/dvb-frontends/rtl2830_priv.h
@@ -24,8 +24,10 @@ 
 #include "dvb_frontend.h"
 #include "dvb_math.h"
 #include "rtl2830.h"
+#include <linux/i2c-mux.h>
 
 struct rtl2830_priv {
+	struct i2c_adapter *adapter;
 	struct i2c_adapter *i2c;
 	struct dvb_frontend fe;
 	struct rtl2830_config cfg;