[PATCH 0/4] mfd: max77686: Remove unneeded non-OF code in driver

[PATCH 0/4] mfd: max77686: Remove unneeded non-OF code in driver

[Javier Martinez Canillas]

Hello Lee,

This series contains cleanups for the max77686 PMIC MFD driver.
The driver is only used in DT platforms and so all the code
related with the i2c_device_id table can be removed.

Best regards,
Javier


Javier Martinez Canillas (4):
  mfd: max77686: Don't attempt to get i2c_device_id .data
  mfd: max77686: Use of_device_get_match_data() helper
  mfd: max77686: Use the struct i2c_driver .probe_new instead of .probe
  mfd: max77686: Remove I2C device ID table

 drivers/mfd/max77686.c | 25 ++++---------------------
 1 file changed, 4 insertions(+), 21 deletions(-)

-- 
2.7.4

[PATCH 1/4] mfd: max77686: Don't attempt to get i2c_device_id .data

[Javier Martinez Canillas]

The driver is only used in platforms that have DT support so always the
I2C device .data will be get from the matched OF node and never will be
from the I2C device ID table.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

 drivers/mfd/max77686.c | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
index 7b68ed72e9cb..ddae3bf3e46c 100644
--- a/drivers/mfd/max77686.c
+++ b/drivers/mfd/max77686.c
@@ -188,14 +188,11 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
 	if (!max77686)
 		return -ENOMEM;
 
-	if (i2c->dev.of_node) {
-		match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
-		if (!match)
-			return -EINVAL;
-
-		max77686->type = (unsigned long)match->data;
-	} else
-		max77686->type = id->driver_data;
+	match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
+	if (!match)
+		return -EINVAL;
+
+	max77686->type = (unsigned long)match->data;
 
 	i2c_set_clientdata(i2c, max77686);
 	max77686->dev = &i2c->dev;
-- 
2.7.4

[PATCH 2/4] mfd: max77686: Use of_device_get_match_data() helper

[Javier Martinez Canillas]

Use the generic helper to get the matched of_device_id .data,
instead of open coding it.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

 drivers/mfd/max77686.c | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
index ddae3bf3e46c..33dd09493605 100644
--- a/drivers/mfd/max77686.c
+++ b/drivers/mfd/max77686.c
@@ -34,6 +34,7 @@
 #include <linux/mfd/max77686-private.h>
 #include <linux/err.h>
 #include <linux/of.h>
+#include <linux/of_device.h>
 
 static const struct mfd_cell max77686_devs[] = {
 	{ .name = "max77686-pmic", },
@@ -175,7 +176,6 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
 			      const struct i2c_device_id *id)
 {
 	struct max77686_dev *max77686 = NULL;
-	const struct of_device_id *match;
 	unsigned int data;
 	int ret = 0;
 	const struct regmap_config *config;
@@ -188,13 +188,8 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
 	if (!max77686)
 		return -ENOMEM;
 
-	match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
-	if (!match)
-		return -EINVAL;
-
-	max77686->type = (unsigned long)match->data;
-
 	i2c_set_clientdata(i2c, max77686);
+	max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
 	max77686->dev = &i2c->dev;
 	max77686->i2c = i2c;
 
-- 
2.7.4

[PATCH 3/4] mfd: max77686: Use the struct i2c_driver .probe_new instead of .probe

[Javier Martinez Canillas]

If a driver is only used in DT platforms, there's no need to get the
i2c_device_id as an argument of the probe function. Since this data
can be get from the matching of_device_id.

There's a temporary .probe_new field in struct i2c_driver that can be
used as probe callback for the case when i2c_device_id won't be used.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

 drivers/mfd/max77686.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
index 33dd09493605..896c1bf85acc 100644
--- a/drivers/mfd/max77686.c
+++ b/drivers/mfd/max77686.c
@@ -172,8 +172,7 @@ static const struct of_device_id max77686_pmic_dt_match[] = {
 };
 MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
 
-static int max77686_i2c_probe(struct i2c_client *i2c,
-			      const struct i2c_device_id *id)
+static int max77686_i2c_probe(struct i2c_client *i2c)
 {
 	struct max77686_dev *max77686 = NULL;
 	unsigned int data;
@@ -294,7 +293,7 @@ static struct i2c_driver max77686_i2c_driver = {
 		   .pm = &max77686_pm,
 		   .of_match_table = of_match_ptr(max77686_pmic_dt_match),
 	},
-	.probe = max77686_i2c_probe,
+	.probe_new = max77686_i2c_probe,
 	.id_table = max77686_i2c_id,
 };
 
-- 
2.7.4

[PATCH 4/4] mfd: max77686: Remove I2C device ID table

[Javier Martinez Canillas]

The driver is only used in DT platforms so there's no need to
have an i2c_device_id table.

Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

---

 drivers/mfd/max77686.c | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
index 896c1bf85acc..b0e8e13c0049 100644
--- a/drivers/mfd/max77686.c
+++ b/drivers/mfd/max77686.c
@@ -241,13 +241,6 @@ static int max77686_i2c_probe(struct i2c_client *i2c)
 	return 0;
 }
 
-static const struct i2c_device_id max77686_i2c_id[] = {
-	{ "max77686", TYPE_MAX77686 },
-	{ "max77802", TYPE_MAX77802 },
-	{ }
-};
-MODULE_DEVICE_TABLE(i2c, max77686_i2c_id);
-
 #ifdef CONFIG_PM_SLEEP
 static int max77686_suspend(struct device *dev)
 {
@@ -294,7 +287,6 @@ static struct i2c_driver max77686_i2c_driver = {
 		   .of_match_table = of_match_ptr(max77686_pmic_dt_match),
 	},
 	.probe_new = max77686_i2c_probe,
-	.id_table = max77686_i2c_id,
 };
 
 module_i2c_driver(max77686_i2c_driver);
-- 
2.7.4

Re: [PATCH 0/4] mfd: max77686: Remove unneeded non-OF code in driver

[Laxman Dewangan]

On Thursday 12 January 2017 07:17 PM, Javier Martinez Canillas wrote:
> Hello Lee,
>
> This series contains cleanups for the max77686 PMIC MFD driver.
> The driver is only used in DT platforms and so all the code
> related with the i2c_device_id table can be removed.
>
> Best regards,
> Javier
>
>

LGTM, let me also review the max77620 on similar cleanups.

Acked-by: Laxman Dewangan <ldewangan@nvidia.com>

Re: [PATCH 1/4] mfd: max77686: Don't attempt to get i2c_device_id .data

[Krzysztof Kozlowski]

On Thu, Jan 12, 2017 at 10:47:34AM -0300, Javier Martinez Canillas wrote:
> The driver is only used in platforms that have DT support so always the
> I2C device .data will be get from the matched OF node and never will be
> from the I2C device ID table.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> ---
> 
>  drivers/mfd/max77686.c | 13 +++++--------
>  1 file changed, 5 insertions(+), 8 deletions(-)
> 

Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Tested-by: Krzysztof Kozlowski <krzk@kernel.org>

Best regards,
Krzysztof

Re: [PATCH 2/4] mfd: max77686: Use of_device_get_match_data() helper

[Krzysztof Kozlowski]

On Thu, Jan 12, 2017 at 10:47:35AM -0300, Javier Martinez Canillas wrote:
> Use the generic helper to get the matched of_device_id .data,
> instead of open coding it.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> ---
> 
>  drivers/mfd/max77686.c | 9 ++-------
>  1 file changed, 2 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
> index ddae3bf3e46c..33dd09493605 100644
> --- a/drivers/mfd/max77686.c
> +++ b/drivers/mfd/max77686.c
> @@ -34,6 +34,7 @@
>  #include <linux/mfd/max77686-private.h>
>  #include <linux/err.h>
>  #include <linux/of.h>
> +#include <linux/of_device.h>
>  
>  static const struct mfd_cell max77686_devs[] = {
>  	{ .name = "max77686-pmic", },
> @@ -175,7 +176,6 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
>  			      const struct i2c_device_id *id)
>  {
>  	struct max77686_dev *max77686 = NULL;
> -	const struct of_device_id *match;
>  	unsigned int data;
>  	int ret = 0;
>  	const struct regmap_config *config;
> @@ -188,13 +188,8 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
>  	if (!max77686)
>  		return -ENOMEM;
>  
> -	match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
> -	if (!match)
> -		return -EINVAL;

The commit message would suggest that the code is equivalent (except usage
of helper) but it is not the same entirely. You are not checking for
matched data. Returned NULL will be cast back to type to valid
TYPE_MAX77686. This should not happen but either mention the removal of
check in commit msg or make it:
enum max77686_types {
	TYPE_MAX77686_UNKNOWN
	...
}
if (max77686->type == TYPE_MAX77686_UNKNOWN)
	return -EINVAL;

Best regards,
Krzysztof

> -
> -	max77686->type = (unsigned long)match->data;
> -
>  	i2c_set_clientdata(i2c, max77686);
> +	max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
>  	max77686->dev = &i2c->dev;
>  	max77686->i2c = i2c;
>  
> -- 
> 2.7.4
> 

Re: [PATCH 3/4] mfd: max77686: Use the struct i2c_driver .probe_new instead of .probe

[Krzysztof Kozlowski]

On Thu, Jan 12, 2017 at 10:47:36AM -0300, Javier Martinez Canillas wrote:
> If a driver is only used in DT platforms, there's no need to get the
> i2c_device_id as an argument of the probe function. Since this data
> can be get from the matching of_device_id.
> 
> There's a temporary .probe_new field in struct i2c_driver that can be
> used as probe callback for the case when i2c_device_id won't be used.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> ---
> 
>  drivers/mfd/max77686.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)

Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Tested-by: Krzysztof Kozlowski <krzk@kernel.org>

Best regards,
Krzysztof

Re: [PATCH 2/4] mfd: max77686: Use of_device_get_match_data() helper

[Javier Martinez Canillas]

Hello Krzysztof,

Thanks for the feedback.

On 01/13/2017 10:04 AM, Krzysztof Kozlowski wrote:
> On Thu, Jan 12, 2017 at 10:47:35AM -0300, Javier Martinez Canillas wrote:
>> Use the generic helper to get the matched of_device_id .data,
>> instead of open coding it.
>>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
>> ---
>>
>>  drivers/mfd/max77686.c | 9 ++-------
>>  1 file changed, 2 insertions(+), 7 deletions(-)
>>
>> diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
>> index ddae3bf3e46c..33dd09493605 100644
>> --- a/drivers/mfd/max77686.c
>> +++ b/drivers/mfd/max77686.c
>> @@ -34,6 +34,7 @@
>>  #include <linux/mfd/max77686-private.h>
>>  #include <linux/err.h>
>>  #include <linux/of.h>
>> +#include <linux/of_device.h>
>>  
>>  static const struct mfd_cell max77686_devs[] = {
>>  	{ .name = "max77686-pmic", },
>> @@ -175,7 +176,6 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
>>  			      const struct i2c_device_id *id)
>>  {
>>  	struct max77686_dev *max77686 = NULL;
>> -	const struct of_device_id *match;
>>  	unsigned int data;
>>  	int ret = 0;
>>  	const struct regmap_config *config;
>> @@ -188,13 +188,8 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
>>  	if (!max77686)
>>  		return -ENOMEM;
>>  
>> -	match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
>> -	if (!match)
>> -		return -EINVAL;
> 
> The commit message would suggest that the code is equivalent (except usage
> of helper) but it is not the same entirely. You are not checking for
> matched data. Returned NULL will be cast back to type to valid
> TYPE_MAX77686. This should not happen but either mention the removal of
> check in commit msg or make it:

Yes, the check didn't make too much sense since as you said this can't happen.
IOW, the probe being called means that OF registered a platform device with a
valid compatible from the OF match table so the match will always succeed.

But you are right that I should had mentioned in the commit, will do in v2.

> enum max77686_types {
> 	TYPE_MAX77686_UNKNOWN
> 	...
> }
> if (max77686->type == TYPE_MAX77686_UNKNOWN)
> 	return -EINVAL;
>

I prefer the former, this will just add code that will never be used.
 
> Best regards,
> Krzysztof
> 

Best regards,
-- 
Javier Martinez Canillas
Open Source Group
Samsung Research America

Re: [PATCH 4/4] mfd: max77686: Remove I2C device ID table

[Krzysztof Kozlowski]

On Thu, Jan 12, 2017 at 10:47:37AM -0300, Javier Martinez Canillas wrote:
> The driver is only used in DT platforms so there's no need to
> have an i2c_device_id table.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> 
> ---
> 
>  drivers/mfd/max77686.c | 8 --------
>  1 file changed, 8 deletions(-)
> 

Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Tested-by: Krzysztof Kozlowski <krzk@kernel.org>

Best regards,
Krzysztof

Re: [PATCH 1/4] mfd: max77686: Don't attempt to get i2c_device_id .data

[Lee Jones]

On Thu, 12 Jan 2017, Javier Martinez Canillas wrote:

> The driver is only used in platforms that have DT support so always the
> I2C device .data will be get from the matched OF node and never will be
> from the I2C device ID table.
> 
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> ---
> 
>  drivers/mfd/max77686.c | 13 +++++--------
>  1 file changed, 5 insertions(+), 8 deletions(-)

Applied, thanks.

> diff --git a/drivers/mfd/max77686.c b/drivers/mfd/max77686.c
> index 7b68ed72e9cb..ddae3bf3e46c 100644
> --- a/drivers/mfd/max77686.c
> +++ b/drivers/mfd/max77686.c
> @@ -188,14 +188,11 @@ static int max77686_i2c_probe(struct i2c_client *i2c,
>  	if (!max77686)
>  		return -ENOMEM;
>  
> -	if (i2c->dev.of_node) {
> -		match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
> -		if (!match)
> -			return -EINVAL;
> -
> -		max77686->type = (unsigned long)match->data;
> -	} else
> -		max77686->type = id->driver_data;
> +	match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
> +	if (!match)
> +		return -EINVAL;
> +
> +	max77686->type = (unsigned long)match->data;
>  
>  	i2c_set_clientdata(i2c, max77686);
>  	max77686->dev = &i2c->dev;

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog