[PATCH v3 1/1] device property: Add a note to the fwnode.h

[PATCH v3 1/1] device property: Add a note to the fwnode.h

[Andy Shevchenko]

Add a note to the fwnode.h that the header should not be used
directly in the leaf drivers, they all should use the higher
level APIs and the respective headers.

The purpose of this note is to give guidance to driver writers
to avoid repeating a common mistake.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---

v3: reworded the note, added problem statement into commit message (Rafael)
v2: added "...into the driver" piece at the end to remove ambiguity

 include/linux/fwnode.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 87b183595ba1..900ecd8f45a1 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -2,6 +2,11 @@
 /*
  * fwnode.h - Firmware device node object handle type definition.
  *
+ * This header file provides low-level data types and definitions for firmware
+ * and device property providers. The respective API header files supplied by
+ * them should contain all of the requisite data types and definitions for end
+ * users, so including it directly should not be necessary.
+ *
  * Copyright (C) 2015, Intel Corporation
  * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  */
-- 
2.47.2

Re: [PATCH v3 1/1] device property: Add a note to the fwnode.h

[Sakari Ailus]

On Tue, Apr 08, 2025 at 12:48:55PM +0300, Andy Shevchenko wrote:
> Add a note to the fwnode.h that the header should not be used
> directly in the leaf drivers, they all should use the higher
> level APIs and the respective headers.
> 
> The purpose of this note is to give guidance to driver writers
> to avoid repeating a common mistake.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>

> ---
> 
> v3: reworded the note, added problem statement into commit message (Rafael)
> v2: added "...into the driver" piece at the end to remove ambiguity
> 
>  include/linux/fwnode.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 87b183595ba1..900ecd8f45a1 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -2,6 +2,11 @@
>  /*
>   * fwnode.h - Firmware device node object handle type definition.
>   *
> + * This header file provides low-level data types and definitions for firmware
> + * and device property providers. The respective API header files supplied by
> + * them should contain all of the requisite data types and definitions for end
> + * users, so including it directly should not be necessary.
> + *
>   * Copyright (C) 2015, Intel Corporation
>   * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
>   */

-- 
Regards,

Sakari Ailus

Re: [PATCH v3 1/1] device property: Add a note to the fwnode.h

[Zijun Hu]

On 2025/4/8 17:48, Andy Shevchenko wrote:
> Add a note to the fwnode.h that the header should not be used
> directly in the leaf drivers, they all should use the higher
> level APIs and the respective headers.
> 
> The purpose of this note is to give guidance to driver writers
> to avoid repeating a common mistake.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
> 
> v3: reworded the note, added problem statement into commit message (Rafael)
> v2: added "...into the driver" piece at the end to remove ambiguity
> 
>  include/linux/fwnode.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 87b183595ba1..900ecd8f45a1 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -2,6 +2,11 @@
>  /*
>   * fwnode.h - Firmware device node object handle type definition.
>   *
> + * This header file provides low-level data types and definitions for firmware
> + * and device property providers. The respective API header files supplied by
> + * them should contain all of the requisite data types and definitions for end
> + * users, so including it directly should not be necessary.
> + *
>   * Copyright (C) 2015, Intel Corporation
>   * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
>   */

Reviewed-by: Zijun Hu <quic_zijuhu@quicinc.com>

Re: [PATCH v3 1/1] device property: Add a note to the fwnode.h

[Rafael J. Wysocki]

On Tue, Apr 8, 2025 at 11:52 AM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> Add a note to the fwnode.h that the header should not be used
> directly in the leaf drivers, they all should use the higher
> level APIs and the respective headers.
>
> The purpose of this note is to give guidance to driver writers
> to avoid repeating a common mistake.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> ---
>
> v3: reworded the note, added problem statement into commit message (Rafael)
> v2: added "...into the driver" piece at the end to remove ambiguity
>
>  include/linux/fwnode.h | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
> index 87b183595ba1..900ecd8f45a1 100644
> --- a/include/linux/fwnode.h
> +++ b/include/linux/fwnode.h
> @@ -2,6 +2,11 @@
>  /*
>   * fwnode.h - Firmware device node object handle type definition.
>   *
> + * This header file provides low-level data types and definitions for firmware
> + * and device property providers. The respective API header files supplied by
> + * them should contain all of the requisite data types and definitions for end
> + * users, so including it directly should not be necessary.
> + *
>   * Copyright (C) 2015, Intel Corporation
>   * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
>   */
> --
> 2.47.2
>