Skip to contentSkip to conversation

gpiolib: improve coding style for local variables

PATCH Superseded Bartosz Golaszewski 2 participants 9 messages Nov 24, 2021 – Dec 2, 2021 GPIO

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/2 gpiolib: improve coding style for local variables

Drop unneeded whitespaces and put the variables of the same type together for consistency with the rest of the code.

---
v1 -> v2:
- keep initializations on separate lines

 drivers/gpio/gpiolib.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/gpio/gpiolib.c +4 -4
index abfbf546d159..ede8b8a7aa18 100644
@@ -594,11 +594,11 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 			       struct lock_class_key *request_key)
 {
 	struct fwnode_handle *fwnode = gc->parent ? dev_fwnode(gc->parent) : NULL;
-	unsigned long	flags;
-	int		ret = 0;
-	unsigned	i;
-	int		base = gc->base;
 	struct gpio_device *gdev;
+	unsigned long flags;
+	int base = gc->base;
+	unsigned int i;
+	int ret = 0;
 
 	/*
 	 * First: allocate and populate the internal stat container, and
Signature · 1 line
2.25.1
#1 lore raw

PATCH v3 2/2 gpiolib: check the 'ngpios' property in core gpiolib code

Several drivers read the 'ngpios' device property on their own, but since it's defined as a standard GPIO property in the device tree bindings anyway, it's a good candidate for generalization. If the driver didn't set its gc->ngpio, try to read the 'ngpios' property from the GPIO device's firmware node before bailing out.

---
v1 -> v2:
- use device_property_read_u32() instead of fwnode_property_read_u32()
- reverse the error check logic

v2 -> v3:
- don't shadow errors other than -ENODATA in device_property_read_u32()

 drivers/gpio/gpiolib.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/gpio/gpiolib.c +12 -3
index ede8b8a7aa18..f79fd2551cf7 100644
@@ -599,6 +599,7 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	int base = gc->base;
 	unsigned int i;
 	int ret = 0;
+	u32 ngpios;
 
 	/*
 	 * First: allocate and populate the internal stat container, and
@@ -647,9 +648,17 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	}
 
 	if (gc->ngpio == 0) {
-		chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
-		ret = -EINVAL;
-		goto err_free_descs;
+		ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+		if (ret) {
+			if (ret == -ENODATA) {
+				chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+				ret = -EINVAL;
+			}
+
+			goto err_free_descs;
+		}
+
+		gc->ngpio = ngpios;
 	}
 
 	if (gc->ngpio > FASTPATH_NGPIO)
Signature · 1 line
2.25.1
#2 lore raw

Re: [PATCH v3 2/2] gpiolib: check the 'ngpios' property in core gpiolib code

Quoted 38 lines · Bartosz Golaszewski

Several drivers read the 'ngpios' device property on their own, but since it's defined as a standard GPIO property in the device tree bindings anyway, it's a good candidate for generalization. If the driver didn't set its gc->ngpio, try to read the 'ngpios' property from the GPIO device's firmware node before bailing out.

---
v1 -> v2:
- use device_property_read_u32() instead of fwnode_property_read_u32()
- reverse the error check logic

v2 -> v3:
- don't shadow errors other than -ENODATA in device_property_read_u32()

 drivers/gpio/gpiolib.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/gpio/gpiolib.c +1 -2
index ede8b8a7aa18..f79fd2551cf7 100644
@@ -599,6 +599,7 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	int base = gc->base;
 	unsigned int i;
 	int ret = 0;
+	u32 ngpios;
 
 	/*
 	 * First: allocate and populate the internal stat container, and
@@ -647,9 +648,17 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	}
 
 	if (gc->ngpio == 0) {
-		chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
-		ret = -EINVAL;

drivers/gpio/gpiolib.c int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data, · line 659

Quoted 10 lines
drivers/gpio/gpiolib.c +9 -1
-		goto err_free_descs;
+		ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+		if (ret) {
+			if (ret == -ENODATA) {
+				chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+				ret = -EINVAL;
+			}
+
+			goto err_free_descs;
+		}

And if the property returns 0 in ngpios?

What about the modified suggestion from previous version:

	if (gc->ngpio == 0) {
		ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
		/*
		 * -ENODATA means that there is no property found and
		 * we want to issue the error message to the user. Besides
		 * that, we want to return different error code to state
		 * that supplied value is not valid.
		 */
		if (ret == -ENODATA)
			ngpios = 0;
		else if (ret)
			return ret;

		gc->ngpio = ngpios;
	}

	if (gc->ngpio == 0) {
		chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
		ret = -EINVAL;
		goto err_free_descs;
	}

?

Quoted 7 lines
drivers/gpio/gpiolib.c +1 -0
+		gc->ngpio = ngpios;
 	}
 
 	if (gc->ngpio > FASTPATH_NGPIO)
Signature · 1 line
2.25.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko
Reviewed-by
#3 lore raw

Re: [PATCH v3 2/2] gpiolib: check the 'ngpios' property in core gpiolib code

Quoted 6 lines · Andy Shevchenko
Quoted 5 lines · Bartosz Golaszewski

Several drivers read the 'ngpios' device property on their own, but since it's defined as a standard GPIO property in the device tree bindings anyway, it's a good candidate for generalization. If the driver didn't set its gc->ngpio, try to read the 'ngpios' property from the GPIO device's firmware node before bailing out.

...

Quoted 24 lines

What about the modified suggestion from previous version:

	if (gc->ngpio == 0) {
		ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
		/*
		 * -ENODATA means that there is no property found and
		 * we want to issue the error message to the user. Besides
		 * that, we want to return different error code to state
		 * that supplied value is not valid.
		 */
		if (ret == -ENODATA)
			ngpios = 0;
		else if (ret)
			return ret;

		gc->ngpio = ngpios;
	}

	if (gc->ngpio == 0) {
		chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
		ret = -EINVAL;
		goto err_free_descs;
	}
Quoted 1 line

?

If you okay to go with this code,

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#4 lore raw

Re: [PATCH v3 2/2] gpiolib: check the 'ngpios' property in core gpiolib code

In reply to Andy Shevchenko
Quoted 51 lines · Andy Shevchenko
Quoted 38 lines · Bartosz Golaszewski

Several drivers read the 'ngpios' device property on their own, but since it's defined as a standard GPIO property in the device tree bindings anyway, it's a good candidate for generalization. If the driver didn't set its gc->ngpio, try to read the 'ngpios' property from the GPIO device's firmware node before bailing out.

---
v1 -> v2:
- use device_property_read_u32() instead of fwnode_property_read_u32()
- reverse the error check logic

v2 -> v3:
- don't shadow errors other than -ENODATA in device_property_read_u32()

 drivers/gpio/gpiolib.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/gpio/gpiolib.c +1 -2
index ede8b8a7aa18..f79fd2551cf7 100644
@@ -599,6 +599,7 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
      int base = gc->base;
      unsigned int i;
      int ret = 0;
+     u32 ngpios;
 
      /*
       * First: allocate and populate the internal stat container, and
@@ -647,9 +648,17 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
      }
 
      if (gc->ngpio == 0) {
-             chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
-             ret = -EINVAL;

drivers/gpio/gpiolib.c int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data, · line 659

Quoted 10 lines
drivers/gpio/gpiolib.c +9 -1
-             goto err_free_descs;
+             ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+             if (ret) {
+                     if (ret == -ENODATA) {
+                             chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+                             ret = -EINVAL;
+                     }
+
+                     goto err_free_descs;
+             }
Quoted 6 lines

And if the property returns 0 in ngpios?

What about the modified suggestion from previous version:

        if (gc->ngpio == 0) {
                ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);

The comment is a good idea but other than that - it's overcomplicating things.

Quoted 4 lines
                if (ret == -ENODATA)
                        ngpios = 0;
                else if (ret)
                        return ret;

You still need to goto err_free_descs here.

Quoted 5 lines
                gc->ngpio = ngpios;
        }

        if (gc->ngpio == 0) {

Why check that again? We already know the driver set it to 0, we checked it a couple lines before. If we can't get the setting from the properties then it won't be non 0 here right?

Quoted 10 lines
                chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
                ret = -EINVAL;
                goto err_free_descs;
        }

?

Quoted 3 lines
drivers/gpio/gpiolib.c +1 -0
+             gc->ngpio = ngpios;
      }
 
Quoted 10 lines
Quoted 4 lines
drivers/gpio/gpiolib.c +0 -1
      if (gc->ngpio > FASTPATH_NGPIO)
--

2.25.1

--
With Best Regards,
Andy Shevchenko

I suggest the following:

drivers/gpio/gpiolib.c +0 -0
index ede8b8a7aa18..08c1e8fc0dfa 100644
@@ -599,6 +599,7 @@ int gpiochip_add_data_with_key(struct gpio_chip

*gc, void *data,

     int base = gc->base;
     unsigned int i;
     int ret = 0;

+ u32 ngpios;

/*
* First: allocate and populate the internal stat container, and
@@ -647,9 +648,23 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,

     }

     if (gc->ngpio == 0) {
-        chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
-        ret = -EINVAL;
-        goto err_free_descs;
+        /*
+         * If the driver didn't specify the number of GPIOs, try to
+         * get this value from the device properties as a fall-back.
+         */
+        ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+        if (ret) {
+            /*
+             * -ENODATA means that there is no property found and
+             * we want to issue the error message to the user.
+             * Besides that, we want to return different error code
+             * to state that supplied value is not valid.
+             * */

+ if (ret == -ENODATA) {
+ chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+ ret = -EINVAL;
+ }
+
+ goto err_free_descs;
+ }
+

+        gc->ngpio = ngpios;
     }

     if (gc->ngpio > FASTPATH_NGPIO)
#5 lore raw

Re: [PATCH v3 2/2] gpiolib: check the 'ngpios' property in core gpiolib code

Quoted 3 lines · Bartosz Golaszewski
Quoted 1 line · Andy Shevchenko

On Wed, Nov 24, 2021 at 01:28:50PM +0100, Bartosz Golaszewski wrote:

...

Quoted 10 lines
Quoted 10 lines
Quoted 9 lines
(quoted diff) +9 -0
+             ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+             if (ret) {
+                     if (ret == -ENODATA) {
+                             chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+                             ret = -EINVAL;
+                     }
+
+                     goto err_free_descs;
+             }
Quoted 8 lines
Quoted 6 lines

And if the property returns 0 in ngpios?

What about the modified suggestion from previous version:

        if (gc->ngpio == 0) {
                ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);

The comment is a good idea but other than that - it's overcomplicating things.

I don't think so. It is plain and self-explaining each step. See at the end of the message how.

Quoted 6 lines
Quoted 4 lines
                if (ret == -ENODATA)
                        ngpios = 0;
                else if (ret)
                        return ret;

You still need to goto err_free_descs here.

Right, this doesn't affect the main point / logic here.

Quoted 8 lines
Quoted 4 lines
                gc->ngpio = ngpios;
        }

        if (gc->ngpio == 0) {

Why check that again? We already know the driver set it to 0, we checked it a couple lines before. If we can't get the setting from the properties then it won't be non 0 here right?

No, it's not right. The check is needed to tell that properties supplied 0.

Quoted 5 lines
Quoted 5 lines
                chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
                ret = -EINVAL;
                goto err_free_descs;
        }
Quoted 8 lines
Quoted 6 lines

?

Quoted 4 lines
+             gc->ngpio = ngpios;
      }

      if (gc->ngpio > FASTPATH_NGPIO)

I suggest the following:

It's buggy as submitted version (I actually haven't found any difference in the code, but comments).

You see, I propose less changes and straight forward logic:

1. Check if the supplied ->ngpio equal to 0
2. If so, try device properties
2.1. If there is no property found, make sure we a) don't use uninitialized

     variable, b) we don't change ->ngpio, so it stays 0

2.2. If there is an error, return it as is to the caller
2.3. Assign ->ngpio by value from property (which very well may be 0!)
3. Check ->ngpio for 0 again, if so, issue a message and return -EINVAL to the user.

We have three places where ->ngpio can be 0, all of them I covered.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#6 lore raw

Re: [PATCH v3 2/2] gpiolib: check the 'ngpios' property in core gpiolib code

Quoted 67 lines · Andy Shevchenko
Quoted 3 lines · Bartosz Golaszewski
Quoted 1 line · Andy Shevchenko

On Wed, Nov 24, 2021 at 01:28:50PM +0100, Bartosz Golaszewski wrote:

...

Quoted 10 lines
Quoted 10 lines
Quoted 9 lines
(quoted diff) +9 -0
+             ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
+             if (ret) {
+                     if (ret == -ENODATA) {
+                             chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
+                             ret = -EINVAL;
+                     }
+
+                     goto err_free_descs;
+             }
Quoted 8 lines
Quoted 6 lines

And if the property returns 0 in ngpios?

What about the modified suggestion from previous version:

        if (gc->ngpio == 0) {
                ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);

The comment is a good idea but other than that - it's overcomplicating things.

I don't think so. It is plain and self-explaining each step. See at the end of the message how.

Quoted 6 lines
Quoted 4 lines
                if (ret == -ENODATA)
                        ngpios = 0;
                else if (ret)
                        return ret;

You still need to goto err_free_descs here.

Right, this doesn't affect the main point / logic here.

Quoted 8 lines
Quoted 4 lines
                gc->ngpio = ngpios;
        }

        if (gc->ngpio == 0) {

Why check that again? We already know the driver set it to 0, we checked it a couple lines before. If we can't get the setting from the properties then it won't be non 0 here right?

No, it's not right. The check is needed to tell that properties supplied 0.

Quoted 5 lines
Quoted 5 lines
                chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
                ret = -EINVAL;
                goto err_free_descs;
        }
Quoted 8 lines
Quoted 6 lines

?

Quoted 4 lines
+             gc->ngpio = ngpios;
      }

      if (gc->ngpio > FASTPATH_NGPIO)

I suggest the following:

It's buggy as submitted version (I actually haven't found any difference in the code, but comments).

Quoted 8 lines

You see, I propose less changes and straight forward logic:

1. Check if the supplied ->ngpio equal to 0
2. If so, try device properties
2.1. If there is no property found, make sure we a) don't use uninitialized

     variable, b) we don't change ->ngpio, so it stays 0

2.2. If there is an error, return it as is to the caller 2.3. Assign ->ngpio by value from property (which very well may be 0!)

Ok, this is the thing I didn't realize, the property can indeed be 0 so your approach is correct.

Bart

Quoted 10 lines

3. Check ->ngpio for 0 again, if so, issue a message and return -EINVAL to the user.

We have three places where ->ngpio can be 0, all of them I covered.

--
With Best Regards,
Andy Shevchenko

Reviewed-by on v3 1/2
#7 lore raw
In reply to Bartosz Golaszewski
Quoted 2 lines · Bartosz Golaszewski

Drop unneeded whitespaces and put the variables of the same type together for consistency with the rest of the code.

I thought I gave my tag, nevermind, here we are

Quoted 32 lines

---
v1 -> v2:
- keep initializations on separate lines

 drivers/gpio/gpiolib.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/gpio/gpiolib.c +4 -4
index abfbf546d159..ede8b8a7aa18 100644
@@ -594,11 +594,11 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 			       struct lock_class_key *request_key)
 {
 	struct fwnode_handle *fwnode = gc->parent ? dev_fwnode(gc->parent) : NULL;
-	unsigned long	flags;
-	int		ret = 0;
-	unsigned	i;
-	int		base = gc->base;
 	struct gpio_device *gdev;
+	unsigned long flags;
+	int base = gc->base;
+	unsigned int i;
+	int ret = 0;
 
 	/*
 	 * First: allocate and populate the internal stat container, and
Signature · 1 line
2.25.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw
Quoted 8 lines · Andy Shevchenko
Quoted 2 lines · Bartosz Golaszewski

Drop unneeded whitespaces and put the variables of the same type together for consistency with the rest of the code.

I thought I gave my tag, nevermind, here we are

I removed it because the patch changed. Thanks!

Bart