Skip to contentSkip to conversation

gpio: wcove: remove platform_set_drvdata() + cleanup probe

PATCH In review Alexandru Ardelean 2 participants 3 messages Jul 7, 2021 – Jul 8, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gpio: wcove: remove platform_set_drvdata() + cleanup probe

The platform_set_drvdata() call is only useful if we need to retrieve back the private information.
Since the driver doesn't do that, it's not useful to have it.

This change also changes the probe order a bit, moving the devm_gpiochip_add_data() as the last call. This means that when the gpiochip is registered [and available to consumers], it should be initialized.

It's still possible that the devm_gpiochip_add_data() call could fail, leaving the chip in a partially initialized state, but that was possible even before this change; it was just some other partially initialized state.

---
 drivers/gpio/gpio-wcove.c | 10 +---------
 1 file changed, 1 insertion(+), 9 deletions(-)
drivers/gpio/gpio-wcove.c +1 -9
index a19eeef6cf1e..2109610f5dad 100644
@@ -428,8 +428,6 @@ static int wcove_gpio_probe(struct platform_device *pdev)
 
 	wg->regmap_irq_chip = pmic->irq_chip_data;
 
-	platform_set_drvdata(pdev, wg);
-
 	mutex_init(&wg->buslock);
 	wg->chip.label = KBUILD_MODNAME;
 	wg->chip.direction_input = wcove_gpio_dir_in;
@@ -469,12 +467,6 @@ static int wcove_gpio_probe(struct platform_device *pdev)
 		return ret;
 	}
 
-	ret = devm_gpiochip_add_data(dev, &wg->chip, wg);
-	if (ret) {
-		dev_err(dev, "Failed to add gpiochip: %d\n", ret);
-		return ret;
-	}
-
 	/* Enable GPIO0 interrupts */
 	ret = regmap_clear_bits(wg->regmap, IRQ_MASK_BASE + 0, GPIO_IRQ0_MASK);
 	if (ret)
@@ -485,7 +477,7 @@ static int wcove_gpio_probe(struct platform_device *pdev)
 	if (ret)
 		return ret;
 
-	return 0;
+	return devm_gpiochip_add_data(dev, &wg->chip, wg);
 }
 
 /*
Signature · 1 line
2.31.1
#1 lore raw
Quoted 3 lines · Alexandru Ardelean

The platform_set_drvdata() call is only useful if we need to retrieve back the private information.
Since the driver doesn't do that, it's not useful to have it.

This is fine.

Quoted 9 lines

This change also changes the probe order a bit, moving the devm_gpiochip_add_data() as the last call. This means that when the gpiochip is registered [and available to consumers], it should be initialized.

It's still possible that the devm_gpiochip_add_data() call could fail, leaving the chip in a partially initialized state, but that was possible even before this change; it was just some other partially initialized state.

...

Quoted 1 line

/* Enable GPIO0 interrupts */

^^^^^

drivers/gpio/gpio-wcove.c static int wcove_gpio_probe(struct platform_device *pdev) · line 480

Quoted 1 line
drivers/gpio/gpio-wcove.c +1 -0
+	return devm_gpiochip_add_data(dev, &wg->chip, wg);

This is dangerous change. How did you test it?

The handler now can be called before chip and actual handling code is registered. It means at least two possible (bad) scenarios:
1) the handler may dereference dangling or NULL pointer;
2) the IRQ may be level interrupt and we may got 100000 IRQs and IRQ core will disable it leaving device completely unfunctional.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 26 lines · Andy Shevchenko
Quoted 3 lines · Alexandru Ardelean

The platform_set_drvdata() call is only useful if we need to retrieve back the private information.
Since the driver doesn't do that, it's not useful to have it.

This is fine.

Quoted 9 lines

This change also changes the probe order a bit, moving the devm_gpiochip_add_data() as the last call. This means that when the gpiochip is registered [and available to consumers], it should be initialized.

It's still possible that the devm_gpiochip_add_data() call could fail, leaving the chip in a partially initialized state, but that was possible even before this change; it was just some other partially initialized state.

...

Quoted 1 line
      /* Enable GPIO0 interrupts */

^^^^^

Quoted 1 line

+ return devm_gpiochip_add_data(dev, &wg->chip, wg);

Quoted 7 lines

This is dangerous change. How did you test it?

The handler now can be called before chip and actual handling code is registered. It means at least two possible (bad) scenarios:
1) the handler may dereference dangling or NULL pointer;
2) the IRQ may be level interrupt and we may got 100000 IRQs and IRQ core will disable it leaving device completely unfunctional.

Makes sense.
Let's drop this :)

Quoted 6 lines

--
With Best Regards,
Andy Shevchenko