Skip to contentSkip to conversation

gpio: 74x164: Refactor and clean up the driver

PATCH Superseded Andy Shevchenko 5 participants 16 messages Feb 3, 2025 – Feb 11, 2025 GPIO

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover gpio: 74x164: Refactor and clean up the driver

Seems like I have had a cleanup series for 74x164, but forgot to send it last year, here it is.

Andy Shevchenko (7):
gpio: 74x164: Remove unneeded dependency to OF_GPIO
gpio: 74x164: Simplify code with cleanup helpers
gpio: 74x164: Annotate buffer with __counted_by()
gpio: 74x164: Make use of the macros from bits.h
gpio: 74x164: Fully convert to use managed resources
gpio: 74x164: Switch to use dev_err_probe()
gpio: 74x164: Utilise temporary variable for struct device

 drivers/gpio/Kconfig       |  1 -
 drivers/gpio/gpio-74x164.c | 63 +++++++++++++++++++++-----------------
 2 files changed, 35 insertions(+), 29 deletions(-)
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#1 lore raw

PATCH 1/7 gpio: 74x164: Remove unneeded dependency to OF_GPIO

Remove unneeded dependency to OF_GPIO which driver does not use.

Fixes 3c7469514dbe ("gpio: 74x164: Make use of device properties")
---
 drivers/gpio/Kconfig | 1 -
 1 file changed, 1 deletion(-)
drivers/gpio/Kconfig +0 -1
index add5ad29a673..56c1f30ac195 100644
@@ -1790,7 +1790,6 @@ menu "SPI GPIO expanders"
 
 config GPIO_74X164
 	tristate "74x164 serial-in/parallel-out 8-bits shift register"
-	depends on OF_GPIO
 	help
 	  Driver for 74x164 compatible serial-in/parallel-out 8-outputs
 	  shift registers. This driver can be used to provide access
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#2 lore raw

Re: [PATCH v1 1/7] gpio: 74x164: Remove unneeded dependency to OF_GPIO

Quoted 22 lines · Andy Shevchenko

Remove unneeded dependency to OF_GPIO which driver does not use.

Fixes 3c7469514dbe ("gpio: 74x164: Make use of device properties")
---
 drivers/gpio/Kconfig | 1 -
 1 file changed, 1 deletion(-)
drivers/gpio/Kconfig +0 -2
index add5ad29a673..56c1f30ac195 100644
@@ -1790,7 +1790,6 @@ menu "SPI GPIO expanders"
 
 config GPIO_74X164
        tristate "74x164 serial-in/parallel-out 8-bits shift register"
-       depends on OF_GPIO
        help
          Driver for 74x164 compatible serial-in/parallel-out 8-outputs
          shift registers. This driver can be used to provide access
--
Quoted 2 lines

2.43.0.rc1.1336.g36b5255a03ac

Geert: Just Cc'ing you here because you yelled at me last time I removed all dependencies. This driver is under the SPI section so it does have the CONFIG_SPI_MASTER dependency. I think it's fine to drop OF_GPIO here but I just wanted to run it by you.

Bart

Reviewed-by
#3 lore raw

Re: [PATCH v1 1/7] gpio: 74x164: Remove unneeded dependency to OF_GPIO

Hi Bartosz,

Quoted 17 lines · Bartosz Golaszewski
Quoted 15 lines · Andy Shevchenko

Remove unneeded dependency to OF_GPIO which driver does not use.

Fixes 3c7469514dbe ("gpio: 74x164: Make use of device properties")
---
 drivers/gpio/Kconfig | 1 -
 1 file changed, 1 deletion(-)
drivers/gpio/Kconfig +0 -0
index add5ad29a673..56c1f30ac195 100644
@@ -1790,7 +1790,6 @@ menu "SPI GPIO expanders"
 
Quoted 12 lines

drivers/gpio/Kconfig menu "SPI GPIO expanders" · line 1795

Quoted 6 lines
drivers/gpio/Kconfig +0 -1
 config GPIO_74X164
        tristate "74x164 serial-in/parallel-out 8-bits shift register"
-       depends on OF_GPIO
        help
          Driver for 74x164 compatible serial-in/parallel-out 8-outputs
          shift registers. This driver can be used to provide access

Geert: Just Cc'ing you here because you yelled at me last time I removed all dependencies. This driver is under the SPI section so it does have the CONFIG_SPI_MASTER dependency. I think it's fine to drop OF_GPIO here but I just wanted to run it by you.

That's fine, as there is still the SPI_MASTER dependency, and the driver uses device properties.

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
#4 lore raw

PATCH 2/7 gpio: 74x164: Simplify code with cleanup helpers

In reply to Andy Shevchenko

Use macros defined in linux/cleanup.h to automate resource lifetime control in the driver.

---
 drivers/gpio/gpio-74x164.c | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)
drivers/gpio/gpio-74x164.c +7 -9
index fca6cd2eb1dd..70c662bbca7b 100644
@@ -7,6 +7,7 @@
  */
 
 #include <linux/bitops.h>
+#include <linux/cleanup.h>
 #include <linux/gpio/consumer.h>
 #include <linux/gpio/driver.h>
 #include <linux/module.h>
@@ -43,13 +44,10 @@ static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
 	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
 	u8 bank = chip->registers - 1 - offset / 8;
 	u8 pin = offset % 8;
-	int ret;
 
-	mutex_lock(&chip->lock);
-	ret = (chip->buffer[bank] >> pin) & 0x1;
-	mutex_unlock(&chip->lock);
+	guard(mutex)(&chip->lock);
 
-	return ret;
+	return (chip->buffer[bank] >> pin) & 0x1;
 }
 
 static void gen_74x164_set_value(struct gpio_chip *gc,
@@ -59,14 +57,14 @@ static void gen_74x164_set_value(struct gpio_chip *gc,
 	u8 bank = chip->registers - 1 - offset / 8;
 	u8 pin = offset % 8;
 
-	mutex_lock(&chip->lock);
+	guard(mutex)(&chip->lock);
+
 	if (val)
 		chip->buffer[bank] |= (1 << pin);
 	else
 		chip->buffer[bank] &= ~(1 << pin);
 
 	__gen_74x164_write_config(chip);
-	mutex_unlock(&chip->lock);
 }
 
 static void gen_74x164_set_multiple(struct gpio_chip *gc, unsigned long *mask,
@@ -78,7 +76,8 @@ static void gen_74x164_set_multiple(struct gpio_chip *gc, unsigned long *mask,
 	size_t bank;
 	unsigned long bitmask;
 
-	mutex_lock(&chip->lock);
+	guard(mutex)(&chip->lock);
+
 	for_each_set_clump8(offset, bankmask, mask, chip->registers * 8) {
 		bank = chip->registers - 1 - offset / 8;
 		bitmask = bitmap_get_value8(bits, offset) & bankmask;
@@ -87,7 +86,6 @@ static void gen_74x164_set_multiple(struct gpio_chip *gc, unsigned long *mask,
 		chip->buffer[bank] |= bitmask;
 	}
 	__gen_74x164_write_config(chip);
-	mutex_unlock(&chip->lock);
 }
 
 static int gen_74x164_direction_output(struct gpio_chip *gc,
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#6 lore raw

PATCH 3/7 gpio: 74x164: Annotate buffer with __counted_by()

In reply to Andy Shevchenko

Add the __counted_by() compiler attribute to the flexible array member volumes to improve access bounds-checking via CONFIG_UBSAN_BOUNDS and CONFIG_FORTIFY_SOURCE.

Use struct_size() instead of manually calculating the number of bytes to allocate the private structure with a buffer.

---
 drivers/gpio/gpio-74x164.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/gpio/gpio-74x164.c +5 -5
index 70c662bbca7b..7844f8a58834 100644
@@ -30,7 +30,7 @@ struct gen_74x164_chip {
 	 * register at the end of the transfer. So, to have a logical
 	 * numbering, store the bytes in reverse order.
 	 */
-	u8			buffer[];
+	u8			buffer[] __counted_by(registers);
 };
 
 static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
@@ -97,6 +97,7 @@ static int gen_74x164_direction_output(struct gpio_chip *gc,
 
 static int gen_74x164_probe(struct spi_device *spi)
 {
+	struct device *dev = &spi->dev;
 	struct gen_74x164_chip *chip;
 	u32 nregs;
 	int ret;
@@ -116,10 +117,12 @@ static int gen_74x164_probe(struct spi_device *spi)
 		return -EINVAL;
 	}
 
-	chip = devm_kzalloc(&spi->dev, sizeof(*chip) + nregs, GFP_KERNEL);
+	chip = devm_kzalloc(dev, struct_size(chip, buffer, nregs), GFP_KERNEL);
 	if (!chip)
 		return -ENOMEM;
 
+	chip->registers = nregs;
+
 	chip->gpiod_oe = devm_gpiod_get_optional(&spi->dev, "enable",
 						 GPIOD_OUT_LOW);
 	if (IS_ERR(chip->gpiod_oe))
@@ -133,10 +136,7 @@ static int gen_74x164_probe(struct spi_device *spi)
 	chip->gpio_chip.set = gen_74x164_set_value;
 	chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
 	chip->gpio_chip.base = -1;
-
-	chip->registers = nregs;
 	chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
-
 	chip->gpio_chip.can_sleep = true;
 	chip->gpio_chip.parent = &spi->dev;
 	chip->gpio_chip.owner = THIS_MODULE;
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
Reviewed-by on v1 3/7
#7 lore raw

Re: [PATCH v1 3/7] gpio: 74x164: Annotate buffer with __counted_by()

Quoted 8 lines · Andy Shevchenko

Add the __counted_by() compiler attribute to the flexible array member volumes to improve access bounds-checking via CONFIG_UBSAN_BOUNDS and CONFIG_FORTIFY_SOURCE.

Use struct_size() instead of manually calculating the number of bytes to allocate the private structure with a buffer.

Thanks!
--
Gustavo

Quoted 50 lines
---
  drivers/gpio/gpio-74x164.c | 10 +++++-----
  1 file changed, 5 insertions(+), 5 deletions(-)
drivers/gpio/gpio-74x164.c +5 -5
index 70c662bbca7b..7844f8a58834 100644
@@ -30,7 +30,7 @@ struct gen_74x164_chip {
  	 * register at the end of the transfer. So, to have a logical
  	 * numbering, store the bytes in reverse order.
  	 */
-	u8			buffer[];
+	u8			buffer[] __counted_by(registers);
  };
 
  static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
@@ -97,6 +97,7 @@ static int gen_74x164_direction_output(struct gpio_chip *gc,
 
  static int gen_74x164_probe(struct spi_device *spi)
  {
+	struct device *dev = &spi->dev;
  	struct gen_74x164_chip *chip;
  	u32 nregs;
  	int ret;
@@ -116,10 +117,12 @@ static int gen_74x164_probe(struct spi_device *spi)
  		return -EINVAL;
  	}
 
-	chip = devm_kzalloc(&spi->dev, sizeof(*chip) + nregs, GFP_KERNEL);
+	chip = devm_kzalloc(dev, struct_size(chip, buffer, nregs), GFP_KERNEL);
  	if (!chip)
  		return -ENOMEM;
 
+	chip->registers = nregs;
+
  	chip->gpiod_oe = devm_gpiod_get_optional(&spi->dev, "enable",
  						 GPIOD_OUT_LOW);
  	if (IS_ERR(chip->gpiod_oe))
@@ -133,10 +136,7 @@ static int gen_74x164_probe(struct spi_device *spi)
  	chip->gpio_chip.set = gen_74x164_set_value;
  	chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
  	chip->gpio_chip.base = -1;
-
-	chip->registers = nregs;
  	chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
-
  	chip->gpio_chip.can_sleep = true;
  	chip->gpio_chip.parent = &spi->dev;
  	chip->gpio_chip.owner = THIS_MODULE;
#8 lore raw

PATCH 4/7 gpio: 74x164: Make use of the macros from bits.h

In reply to Andy Shevchenko

Make use of BIT() and GENMASK() where it makes sense.

---
 drivers/gpio/gpio-74x164.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/gpio/gpio-74x164.c +3 -3
index 7844f8a58834..0f720d539fa7 100644
@@ -47,7 +47,7 @@ static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
 
 	guard(mutex)(&chip->lock);
 
-	return (chip->buffer[bank] >> pin) & 0x1;
+	return !!(chip->buffer[bank] & BIT(pin));
 }
 
 static void gen_74x164_set_value(struct gpio_chip *gc,
@@ -60,9 +60,9 @@ static void gen_74x164_set_value(struct gpio_chip *gc,
 	guard(mutex)(&chip->lock);
 
 	if (val)
-		chip->buffer[bank] |= (1 << pin);
+		chip->buffer[bank] |= BIT(pin);
 	else
-		chip->buffer[bank] &= ~(1 << pin);
+		chip->buffer[bank] &= ~BIT(pin);
 
 	__gen_74x164_write_config(chip);
 }
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#11 lore raw

PATCH 5/7 gpio: 74x164: Fully convert to use managed resources

In reply to Andy Shevchenko

Convert the driver probe stage to use managed resources.

---
 drivers/gpio/gpio-74x164.c | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)
drivers/gpio/gpio-74x164.c +16 -4
index 0f720d539fa7..920d3b9c1087 100644
@@ -95,6 +95,19 @@ static int gen_74x164_direction_output(struct gpio_chip *gc,
 	return 0;
 }
 
+static void gen_74x164_deactivate(void *data)
+{
+	struct gen_74x164_chip *chip = data;
+
+	gpiod_set_value_cansleep(chip->gpiod_oe, 0);
+}
+
+static int gen_74x164_activate(struct device *dev, struct gen_74x164_chip *chip)
+{
+	gpiod_set_value_cansleep(chip->gpiod_oe, 1);
+	return devm_add_action_or_reset(dev, gen_74x164_deactivate, chip);
+}
+
 static int gen_74x164_probe(struct spi_device *spi)
 {
 	struct device *dev = &spi->dev;
@@ -128,8 +141,6 @@ static int gen_74x164_probe(struct spi_device *spi)
 	if (IS_ERR(chip->gpiod_oe))
 		return PTR_ERR(chip->gpiod_oe);
 
-	spi_set_drvdata(spi, chip);
-
 	chip->gpio_chip.label = spi->modalias;
 	chip->gpio_chip.direction_output = gen_74x164_direction_output;
 	chip->gpio_chip.get = gen_74x164_get_value;
@@ -149,7 +160,9 @@ static int gen_74x164_probe(struct spi_device *spi)
 	if (ret)
 		return dev_err_probe(&spi->dev, ret, "Config write failed\n");
 
-	gpiod_set_value_cansleep(chip->gpiod_oe, 1);
+	ret = gen_74x164_activate(dev, chip);
+	if (ret)
+		return ret;
 
 	return devm_gpiochip_add_data(&spi->dev, &chip->gpio_chip, chip);
 }
@@ -181,7 +194,6 @@ static struct spi_driver gen_74x164_driver = {
 		.of_match_table	= gen_74x164_dt_ids,
 	},
 	.probe		= gen_74x164_probe,
-	.remove		= gen_74x164_remove,
 	.id_table	= gen_74x164_spi_ids,
 };
 module_spi_driver(gen_74x164_driver);
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#12 lore raw

Re: [PATCH v1 5/7] gpio: 74x164: Fully convert to use managed resources

Quoted 53 lines · Andy Shevchenko

Convert the driver probe stage to use managed resources.

---
 drivers/gpio/gpio-74x164.c | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)
drivers/gpio/gpio-74x164.c +16 -3
index 0f720d539fa7..920d3b9c1087 100644
@@ -95,6 +95,19 @@ static int gen_74x164_direction_output(struct gpio_chip *gc,
        return 0;
 }
 
+static void gen_74x164_deactivate(void *data)
+{
+       struct gen_74x164_chip *chip = data;
+
+       gpiod_set_value_cansleep(chip->gpiod_oe, 0);
+}
+
+static int gen_74x164_activate(struct device *dev, struct gen_74x164_chip *chip)
+{
+       gpiod_set_value_cansleep(chip->gpiod_oe, 1);
+       return devm_add_action_or_reset(dev, gen_74x164_deactivate, chip);
+}
+
 static int gen_74x164_probe(struct spi_device *spi)
 {
        struct device *dev = &spi->dev;
@@ -128,8 +141,6 @@ static int gen_74x164_probe(struct spi_device *spi)
        if (IS_ERR(chip->gpiod_oe))
                return PTR_ERR(chip->gpiod_oe);
 
-       spi_set_drvdata(spi, chip);
-
        chip->gpio_chip.label = spi->modalias;
        chip->gpio_chip.direction_output = gen_74x164_direction_output;
        chip->gpio_chip.get = gen_74x164_get_value;
@@ -149,7 +160,9 @@ static int gen_74x164_probe(struct spi_device *spi)
        if (ret)
                return dev_err_probe(&spi->dev, ret, "Config write failed\n");
 
-       gpiod_set_value_cansleep(chip->gpiod_oe, 1);
+       ret = gen_74x164_activate(dev, chip);
+       if (ret)
+               return ret;
 
        return devm_gpiochip_add_data(&spi->dev, &chip->gpio_chip, chip);
 }

drivers/gpio/gpio-74x164.c static struct spi_driver gen_74x164_driver = { · line 184

Quoted 4 lines
drivers/gpio/gpio-74x164.c +0 -1
@@ -181,7 +194,6 @@ static struct spi_driver gen_74x164_driver = {
                .of_match_table = gen_74x164_dt_ids,
        },
        .probe          = gen_74x164_probe,
-       .remove         = gen_74x164_remove,

Did you forget to remove gen_74x164_remove()?

Bart

Quoted 6 lines
drivers/gpio/gpio-74x164.c +0 -1
        .id_table       = gen_74x164_spi_ids,
 };
 module_spi_driver(gen_74x164_driver);
--

2.43.0.rc1.1336.g36b5255a03ac

#13 lore raw

PATCH 6/7 gpio: 74x164: Switch to use dev_err_probe()

In reply to Andy Shevchenko

Switch to use dev_err_probe() to simplify the error path and unify a message template.

---
 drivers/gpio/gpio-74x164.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
drivers/gpio/gpio-74x164.c +2 -4
index 920d3b9c1087..2cf77c0a5615 100644
@@ -125,10 +125,8 @@ static int gen_74x164_probe(struct spi_device *spi)
 		return ret;
 
 	ret = device_property_read_u32(&spi->dev, "registers-number", &nregs);
-	if (ret) {
-		dev_err(&spi->dev, "Missing 'registers-number' property.\n");
-		return -EINVAL;
-	}
+	if (ret)
+		return dev_err_probe(dev, ret, "Missing 'registers-number' property.\n");
 
 	chip = devm_kzalloc(dev, struct_size(chip, buffer, nregs), GFP_KERNEL);
 	if (!chip)
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#15 lore raw

PATCH 7/7 gpio: 74x164: Utilise temporary variable for struct device

In reply to Andy Shevchenko

We have a temporary variable to keep a pointer to struct device. Utilise it where it makes sense.

---
 drivers/gpio/gpio-74x164.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/gpio/gpio-74x164.c +3 -4
index 2cf77c0a5615..4f7837515e7a 100644
@@ -124,7 +124,7 @@ static int gen_74x164_probe(struct spi_device *spi)
 	if (ret < 0)
 		return ret;
 
-	ret = device_property_read_u32(&spi->dev, "registers-number", &nregs);
+	ret = device_property_read_u32(dev, "registers-number", &nregs);
 	if (ret)
 		return dev_err_probe(dev, ret, "Missing 'registers-number' property.\n");
 
@@ -134,8 +134,7 @@ static int gen_74x164_probe(struct spi_device *spi)
 
 	chip->registers = nregs;
 
-	chip->gpiod_oe = devm_gpiod_get_optional(&spi->dev, "enable",
-						 GPIOD_OUT_LOW);
+	chip->gpiod_oe = devm_gpiod_get_optional(dev, "enable", GPIOD_OUT_LOW);
 	if (IS_ERR(chip->gpiod_oe))
 		return PTR_ERR(chip->gpiod_oe);
 
@@ -147,7 +146,7 @@ static int gen_74x164_probe(struct spi_device *spi)
 	chip->gpio_chip.base = -1;
 	chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
 	chip->gpio_chip.can_sleep = true;
-	chip->gpio_chip.parent = &spi->dev;
+	chip->gpio_chip.parent = dev;
 	chip->gpio_chip.owner = THIS_MODULE;
 
 	ret = devm_mutex_init(&spi->dev, &chip->lock);
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac