[v1] gpiolib: use the required minimum set of headers

[PATCH] gpiolib: use the required minimum set of headers

Posted by Bartosz Golaszewski 11 months, 3 weeks ago

From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Andy suggested we should keep a fine-grained scheme for includes and
only pull in stuff required within individual ifdef sections. Let's
revert commit dea69f2d1cc8 ("gpiolib: move all includes to the top of
gpio/consumer.h") and make the headers situation even more fine-grained
by only including the first level headers containing requireded symbols
except for bug.h where checkpatch.pl warns against including asm/bug.h.

Fixes: dea69f2d1cc8 ("gpiolib: move all includes to the top of gpio/consumer.h")
Suggested-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Closes: https://lore.kernel.org/all/Z7XPcYtaA4COHDYj@smile.fi.intel.com/
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
 include/linux/gpio/consumer.h | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/include/linux/gpio/consumer.h b/include/linux/gpio/consumer.h
index 0b2b56199c36..f53cd8a1eb1e 100644
--- a/include/linux/gpio/consumer.h
+++ b/include/linux/gpio/consumer.h
@@ -3,10 +3,7 @@
 #define __LINUX_GPIO_CONSUMER_H
 
 #include <linux/bits.h>
-#include <linux/bug.h>
 #include <linux/err.h>
-#include <linux/errno.h>
-#include <linux/kernel.h>
 #include <linux/types.h>
 
 struct acpi_device;
@@ -185,6 +182,9 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
 
 #else /* CONFIG_GPIOLIB */
 
+#include <linux/bug.h>
+#include <linux/kernel.h>
+
 static inline int gpiod_count(struct device *dev, const char *con_id)
 {
 	return 0;
@@ -549,6 +549,10 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
 int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags);
 int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags);
 #else
+
+#include <linux/bug.h>
+#include <asm/errno.h>
+
 static inline int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc,
 					       unsigned long flags)
 {
@@ -615,6 +619,8 @@ int devm_acpi_dev_add_driver_gpios(struct device *dev,
 
 #else  /* CONFIG_GPIOLIB && CONFIG_ACPI */
 
+#include <asm/errno.h>
+
 static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
 			      const struct acpi_gpio_mapping *gpios)
 {
@@ -640,6 +646,8 @@ void gpiod_unexport(struct gpio_desc *desc);
 
 #else  /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */
 
+#include <asm/errno.h>
+
 static inline int gpiod_export(struct gpio_desc *desc,
 			       bool direction_may_change)
 {
-- 
2.45.2

Re: [PATCH] gpiolib: use the required minimum set of headers

Posted by Andy Shevchenko 11 months, 2 weeks ago

On Fri, Feb 21, 2025 at 01:30:01PM +0100, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> 
> Andy suggested we should keep a fine-grained scheme for includes and
> only pull in stuff required within individual ifdef sections. Let's
> revert commit dea69f2d1cc8 ("gpiolib: move all includes to the top of
> gpio/consumer.h") and make the headers situation even more fine-grained
> by only including the first level headers containing requireded symbols
> except for bug.h where checkpatch.pl warns against including asm/bug.h.

>  #include <linux/bits.h>
> -#include <linux/bug.h>
>  #include <linux/err.h>
> -#include <linux/errno.h>
> -#include <linux/kernel.h>
>  #include <linux/types.h>

...

> +#include <asm/errno.h>

> +#include <asm/errno.h>

> +#include <asm/errno.h>

These are redundant as err.h guarantees to include asm/errno.h
Dropping this will also satisfy the `make includecheck`.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] gpiolib: use the required minimum set of headers

Posted by Andy Shevchenko 11 months, 3 weeks ago

On Fri, Feb 21, 2025 at 01:30:01PM +0100, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Thanks for taking my suggestion into account!

> Andy suggested we should keep a fine-grained scheme for includes and
> only pull in stuff required within individual ifdef sections. Let's
> revert commit dea69f2d1cc8 ("gpiolib: move all includes to the top of
> gpio/consumer.h") and make the headers situation even more fine-grained
> by only including the first level headers containing requireded symbols
> except for bug.h where checkpatch.pl warns against including asm/bug.h.

I'm not sure we should consider the checkpatch.pl in this case.

...

This change is definitely an improvement from the current state in your
gpio/for-next branch, if you are really strong about linux/bug.h, let me more
time to check that header and see if there any potential issues.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] gpiolib: use the required minimum set of headers

Posted by Bartosz Golaszewski 11 months, 3 weeks ago

On Fri, Feb 21, 2025 at 5:00 PM Andy Shevchenko
<andriy.shevchenko@intel.com> wrote:
>
> On Fri, Feb 21, 2025 at 01:30:01PM +0100, Bartosz Golaszewski wrote:
> > From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>
> Thanks for taking my suggestion into account!
>
> > Andy suggested we should keep a fine-grained scheme for includes and
> > only pull in stuff required within individual ifdef sections. Let's
> > revert commit dea69f2d1cc8 ("gpiolib: move all includes to the top of
> > gpio/consumer.h") and make the headers situation even more fine-grained
> > by only including the first level headers containing requireded symbols
> > except for bug.h where checkpatch.pl warns against including asm/bug.h.
>
> I'm not sure we should consider the checkpatch.pl in this case.
>
> ...
>
> This change is definitely an improvement from the current state in your
> gpio/for-next branch, if you are really strong about linux/bug.h, let me more
> time to check that header and see if there any potential issues.
>

Sure, take your time. For some reason checkpatch does recommend using
linux/foo.h over asm/foo.h if the former includes the latter but I
don't know the history of this.

Bart

Re: [PATCH] gpiolib: use the required minimum set of headers

Posted by Andy Shevchenko 11 months, 3 weeks ago

On Fri, Feb 21, 2025 at 05:17:50PM +0100, Bartosz Golaszewski wrote:
> On Fri, Feb 21, 2025 at 5:00 PM Andy Shevchenko
> <andriy.shevchenko@intel.com> wrote:
> > On Fri, Feb 21, 2025 at 01:30:01PM +0100, Bartosz Golaszewski wrote:
> > > From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> >
> > Thanks for taking my suggestion into account!
> >
> > > Andy suggested we should keep a fine-grained scheme for includes and
> > > only pull in stuff required within individual ifdef sections. Let's
> > > revert commit dea69f2d1cc8 ("gpiolib: move all includes to the top of
> > > gpio/consumer.h") and make the headers situation even more fine-grained
> > > by only including the first level headers containing requireded symbols
> > > except for bug.h where checkpatch.pl warns against including asm/bug.h.
> >
> > I'm not sure we should consider the checkpatch.pl in this case.

...

> > This change is definitely an improvement from the current state in your
> > gpio/for-next branch, if you are really strong about linux/bug.h, let me more
> > time to check that header and see if there any potential issues.
> 
> Sure, take your time. For some reason checkpatch does recommend using
> linux/foo.h over asm/foo.h if the former includes the latter but I
> don't know the history of this.

I know the history of this, lately (last year) it was again a discussion result
of which is linux/unaligned.h. But this recommendation is only for the leaf files
or custom (local) headers and code, it doesn't fully applicable to the globally
accessed headers, like gpio/consumer.h. I consider this as false positive by
checkpatch.

Yes, I will check more on the header nevertheless.

-- 
With Best Regards,
Andy Shevchenko