device property: Add a note to the fwnode.h
Subsystems (3)
Andy Shevchenko
reviewerPATCH v3 1/1 device property: Add a note to the fwnode.h
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.
---
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(+)
include/linux/fwnode.h +5 -0
@@ -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 <[email protected]> */
Signature · 1 line
2.47.2
Quoted 8 lines · Andy Shevchenko
Add a note to the
fwnode.hthat 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 <[email protected]>
Quoted 24 lines
---
v3: reworded the note, added problem statement into commit message (Rafael)
v2: added "...into the driver" piece at the end to remove ambiguityinclude/linux/fwnode.h | 5 +++++ 1 file changed, 5 insertions(+)include/linux/fwnode.h +5
-0@@ -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 <[email protected]> */
Signature · 3 lines
Regards, Sakari Ailus
Quoted 22 lines · Andy Shevchenko
Add a note to the
fwnode.hthat 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 <[email protected]>---
v3: reworded the note, added problem statement into commit message (Rafael)
v2: added "...into the driver" piece at the end to remove ambiguityinclude/linux/fwnode.h | 5 +++++ 1 file changed, 5 insertions(+)include/linux/fwnode.h +0
-0@@ -2,6 +2,11 @@/*
include/linux/fwnode.h line 12
Quoted 10 lines
include/linux/fwnode.h +5
-0* 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 <[email protected]> */
Quoted 9 lines · Andy Shevchenko
Add a note to the
fwnode.hthat 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 <[email protected]>
Quoted 27 lines
---
v3: reworded the note, added problem statement into commit message (Rafael)
v2: added "...into the driver" piece at the end to remove ambiguityinclude/linux/fwnode.h | 5 +++++ 1 file changed, 5 insertions(+)include/linux/fwnode.h +5
-1@@ -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 <[email protected]> */ --2.47.2