diff mbox series

[v2,1/1] device property: Add a note to the fwnode.h

Message ID 20250331163540.280606-1-andriy.shevchenko@linux.intel.com (mailing list archive)
State New
Headers show
Series [v2,1/1] device property: Add a note to the fwnode.h | expand

Commit Message

Andy Shevchenko March 31, 2025, 4:35 p.m. UTC 
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.

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

v2: added "...into the driver" piece at the end to remove ambiguity

 include/linux/fwnode.h | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 6fa0a268d538..4c4d3f93534c 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -2,6 +2,12 @@ 
 /*
  * fwnode.h - Firmware device node object handle type definition.
  *
+ * Note, this header is not meant to be used by the leaf drivers.
+ * It provides the low level data types and definitions for the firmware
+ * and device property providers. The respective API headers should
+ * guarantee all the required data types and definitions without including
+ * this header directly into the driver.
+ *
  * Copyright (C) 2015, Intel Corporation
  * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  */