[PATCH 0/7] iio: light: veml6070: update code to current IIO best practices

[PATCH 0/7] iio: light: veml6070: update code to current IIO best practices

[Javier Carrasco]

This series updates the driver in preparation to add new features. The
cleanup consists of:

1. Device-managed registering for:
- iio device
- action (unregister i2c device)
- regulator

2. Code update to use a guard for the mutex handling and
   dev_err_probe in the probe function.

3. Devicetree support (document the device bindings and register the
compatible in the driver).

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
Javier Carrasco (7):
      iio: light: veml6070: add action for i2c_unregister_device
      iio: light: veml6070: use guard to handle mutex
      iio: light: veml6070: use device managed iio_device_register
      iio: light: veml6070: add support for a regulator
      dt-bindings: iio: light: vishay,veml6075: add vishay,veml6070
      iio: light: veml6070: add devicetree support
      iio: light: veml6070: use dev_err_probe in probe function

 .../bindings/iio/light/vishay,veml6075.yaml        |  3 +-
 drivers/iio/light/veml6070.c                       | 63 +++++++++++-----------
 2 files changed, 35 insertions(+), 31 deletions(-)
---
base-commit: 4057951fb272efda718dca665f6607c348d5785b
change-id: 20240929-veml6070-cleanup-70b609bb1f0f

Best regards,
-- 
Javier Carrasco <javier.carrasco.cruz@gmail.com>

[PATCH 1/7] iio: light: veml6070: add action for i2c_unregister_device

[Javier Carrasco]

Simplify the code by adding an action to call i2c_unregister_device(),
which removes the need for a 'fail' label, gotos to it, and an explicit
call in veml6070_remove().

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index f8321d346d77..3c476b6f6122 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -135,6 +135,13 @@ static const struct iio_info veml6070_info = {
 	.read_raw = veml6070_read_raw,
 };
 
+static void veml6070_i2c_unreg(void *p)
+{
+	struct veml6070_data *data = p;
+
+	i2c_unregister_device(data->client2);
+}
+
 static int veml6070_probe(struct i2c_client *client)
 {
 	struct veml6070_data *data;
@@ -166,17 +173,13 @@ static int veml6070_probe(struct i2c_client *client)
 		VEML6070_COMMAND_SD;
 	ret = i2c_smbus_write_byte(data->client1, data->config);
 	if (ret < 0)
-		goto fail;
+		return ret;
 
-	ret = iio_device_register(indio_dev);
+	ret = devm_add_action_or_reset(&client->dev, veml6070_i2c_unreg, data);
 	if (ret < 0)
-		goto fail;
+		return ret;
 
-	return ret;
-
-fail:
-	i2c_unregister_device(data->client2);
-	return ret;
+	return iio_device_register(indio_dev);
 }
 
 static void veml6070_remove(struct i2c_client *client)
@@ -185,7 +188,6 @@ static void veml6070_remove(struct i2c_client *client)
 	struct veml6070_data *data = iio_priv(indio_dev);
 
 	iio_device_unregister(indio_dev);
-	i2c_unregister_device(data->client2);
 }
 
 static const struct i2c_device_id veml6070_id[] = {

-- 
2.43.0

[PATCH 2/7] iio: light: veml6070: use guard to handle mutex

[Javier Carrasco]

Simplify the mutext handling by using a guard to automate the mutex
unlocking.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index 3c476b6f6122..945ef58beead 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -42,36 +42,36 @@ static int veml6070_read(struct veml6070_data *data)
 	int ret;
 	u8 msb, lsb;
 
-	mutex_lock(&data->lock);
+	guard(mutex)(&data->lock);
 
 	/* disable shutdown */
 	ret = i2c_smbus_write_byte(data->client1,
 	    data->config & ~VEML6070_COMMAND_SD);
 	if (ret < 0)
-		goto out;
+		return ret;
 
 	msleep(125 + 10); /* measurement takes up to 125 ms for IT 1x */
 
 	ret = i2c_smbus_read_byte(data->client2); /* read MSB, address 0x39 */
 	if (ret < 0)
-		goto out;
+		return ret;
+
 	msb = ret;
 
 	ret = i2c_smbus_read_byte(data->client1); /* read LSB, address 0x38 */
 	if (ret < 0)
-		goto out;
+		return ret;
+
 	lsb = ret;
 
 	/* shutdown again */
 	ret = i2c_smbus_write_byte(data->client1, data->config);
 	if (ret < 0)
-		goto out;
+		return ret;
 
 	ret = (msb << 8) | lsb;
 
-out:
-	mutex_unlock(&data->lock);
-	return ret;
+	return 0;
 }
 
 static const struct iio_chan_spec veml6070_channels[] = {

-- 
2.43.0

[PATCH 3/7] iio: light: veml6070: use device managed iio_device_register

[Javier Carrasco]

Simplify the code by using devm_iio_device_register(), which removes the
need for a 'remove' function, as there are no more actions to take.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 11 +----------
 1 file changed, 1 insertion(+), 10 deletions(-)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index 945ef58beead..d15caebdc959 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -179,15 +179,7 @@ static int veml6070_probe(struct i2c_client *client)
 	if (ret < 0)
 		return ret;
 
-	return iio_device_register(indio_dev);
-}
-
-static void veml6070_remove(struct i2c_client *client)
-{
-	struct iio_dev *indio_dev = i2c_get_clientdata(client);
-	struct veml6070_data *data = iio_priv(indio_dev);
-
-	iio_device_unregister(indio_dev);
+	return devm_iio_device_register(&client->dev, indio_dev);
 }
 
 static const struct i2c_device_id veml6070_id[] = {
@@ -201,7 +193,6 @@ static struct i2c_driver veml6070_driver = {
 		.name   = VEML6070_DRV_NAME,
 	},
 	.probe = veml6070_probe,
-	.remove  = veml6070_remove,
 	.id_table = veml6070_id,
 };
 

-- 
2.43.0

[PATCH 4/7] iio: light: veml6070: add support for a regulator

[Javier Carrasco]

Add support for a device-managed regulator with the reference name
provided in the datasheet (vdd).

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index d15caebdc959..faba04e1da98 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -163,6 +163,10 @@ static int veml6070_probe(struct i2c_client *client)
 	indio_dev->name = VEML6070_DRV_NAME;
 	indio_dev->modes = INDIO_DIRECT_MODE;
 
+	ret = devm_regulator_get_enable(&client->dev, "vdd");
+	if (ret < 0)
+		return ret;
+
 	data->client2 = i2c_new_dummy_device(client->adapter, VEML6070_ADDR_DATA_LSB);
 	if (IS_ERR(data->client2)) {
 		dev_err(&client->dev, "i2c device for second chip address failed\n");

-- 
2.43.0

[PATCH 5/7] dt-bindings: iio: light: vishay,veml6075: add vishay,veml6070

[Javier Carrasco]

This UVA device with I2C has the same properties as the veml6075, and
the same dt-bindings can cover it too.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml b/Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml
index ecf2339e02f6..96c1317541fa 100644
--- a/Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml
+++ b/Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml
@@ -4,7 +4,7 @@
 $id: http://devicetree.org/schemas/iio/light/vishay,veml6075.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: Vishay VEML6075 UVA/B and VEML6040 RGBW sensors
+title: Vishay VEML6070 UVA, VEML6075 UVA/B and VEML6040 RGBW sensors
 
 maintainers:
   - Javier Carrasco <javier.carrasco.cruz@gmail.com>
@@ -16,6 +16,7 @@ properties:
   compatible:
     enum:
       - vishay,veml6040
+      - vishay,veml6070
       - vishay,veml6075
 
   reg:

-- 
2.43.0

Re: [PATCH 5/7] dt-bindings: iio: light: vishay,veml6075: add vishay,veml6070

[Krzysztof Kozlowski]

On Sun, Sep 29, 2024 at 10:38:50PM +0200, Javier Carrasco wrote:
> This UVA device with I2C has the same properties as the veml6075, and
> the same dt-bindings can cover it too.
> 
> Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
> ---
>  Documentation/devicetree/bindings/iio/light/vishay,veml6075.yaml | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof

[PATCH 6/7] iio: light: veml6070: add devicetree support

[Javier Carrasco]

Register the compatible from the dt-bindings.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index faba04e1da98..8d02899028d8 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -192,9 +192,16 @@ static const struct i2c_device_id veml6070_id[] = {
 };
 MODULE_DEVICE_TABLE(i2c, veml6070_id);
 
+static const struct of_device_id veml6070_of_match[] = {
+	{ .compatible = "vishay,veml6070" },
+	{}
+};
+MODULE_DEVICE_TABLE(of, veml6070_of_match);
+
 static struct i2c_driver veml6070_driver = {
 	.driver = {
 		.name   = VEML6070_DRV_NAME,
+		.of_match_table = veml6070_of_match,
 	},
 	.probe = veml6070_probe,
 	.id_table = veml6070_id,

-- 
2.43.0

Re: [PATCH 6/7] iio: light: veml6070: add devicetree support

[Jonathan Cameron]

On Sun, 29 Sep 2024 22:38:51 +0200
Javier Carrasco <javier.carrasco.cruz@gmail.com> wrote:

> Register the compatible from the dt-bindings.
> 
> Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
> ---
>  drivers/iio/light/veml6070.c | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
> index faba04e1da98..8d02899028d8 100644
> --- a/drivers/iio/light/veml6070.c
> +++ b/drivers/iio/light/veml6070.c
> @@ -192,9 +192,16 @@ static const struct i2c_device_id veml6070_id[] = {
>  };
>  MODULE_DEVICE_TABLE(i2c, veml6070_id);
>  
> +static const struct of_device_id veml6070_of_match[] = {
> +	{ .compatible = "vishay,veml6070" },
> +	{}
I tweaked this to { }

> +};
> +MODULE_DEVICE_TABLE(of, veml6070_of_match);
> +
>  static struct i2c_driver veml6070_driver = {
>  	.driver = {
>  		.name   = VEML6070_DRV_NAME,
> +		.of_match_table = veml6070_of_match,
>  	},
>  	.probe = veml6070_probe,
>  	.id_table = veml6070_id,
> 

[PATCH 7/7] iio: light: veml6070: use dev_err_probe in probe function

[Javier Carrasco]

Drop the common 'dev_err() + return' combination in the probe function
and use 'return dev_err_probe()' instead.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
---
 drivers/iio/light/veml6070.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/drivers/iio/light/veml6070.c b/drivers/iio/light/veml6070.c
index 8d02899028d8..6221d07aa840 100644
--- a/drivers/iio/light/veml6070.c
+++ b/drivers/iio/light/veml6070.c
@@ -168,10 +168,9 @@ static int veml6070_probe(struct i2c_client *client)
 		return ret;
 
 	data->client2 = i2c_new_dummy_device(client->adapter, VEML6070_ADDR_DATA_LSB);
-	if (IS_ERR(data->client2)) {
-		dev_err(&client->dev, "i2c device for second chip address failed\n");
-		return PTR_ERR(data->client2);
-	}
+	if (IS_ERR(data->client2))
+		return dev_err_probe(&client->dev, PTR_ERR(data->client2),
+				     "i2c device for second chip address failed\n");
 
 	data->config = VEML6070_IT_10 | VEML6070_COMMAND_RSRVD |
 		VEML6070_COMMAND_SD;

-- 
2.43.0

Re: [PATCH 0/7] iio: light: veml6070: update code to current IIO best practices

[Jonathan Cameron]

On Sun, 29 Sep 2024 22:38:45 +0200
Javier Carrasco <javier.carrasco.cruz@gmail.com> wrote:

> This series updates the driver in preparation to add new features. The
> cleanup consists of:
> 
> 1. Device-managed registering for:
> - iio device
> - action (unregister i2c device)
> - regulator
> 
> 2. Code update to use a guard for the mutex handling and
>    dev_err_probe in the probe function.
> 
> 3. Devicetree support (document the device bindings and register the
> compatible in the driver).
> 
> Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Nice.  Applied to the togreg branch of iio.git and pushed out as testing.

thanks,

Jonathan

> ---
> Javier Carrasco (7):
>       iio: light: veml6070: add action for i2c_unregister_device
>       iio: light: veml6070: use guard to handle mutex
>       iio: light: veml6070: use device managed iio_device_register
>       iio: light: veml6070: add support for a regulator
>       dt-bindings: iio: light: vishay,veml6075: add vishay,veml6070
>       iio: light: veml6070: add devicetree support
>       iio: light: veml6070: use dev_err_probe in probe function
> 
>  .../bindings/iio/light/vishay,veml6075.yaml        |  3 +-
>  drivers/iio/light/veml6070.c                       | 63 +++++++++++-----------
>  2 files changed, 35 insertions(+), 31 deletions(-)
> ---
> base-commit: 4057951fb272efda718dca665f6607c348d5785b
> change-id: 20240929-veml6070-cleanup-70b609bb1f0f
> 
> Best regards,