[v6,070/102] dm: doc: Add a note about of-platdata and header files
diff mbox series

Message ID 20191206213936.v6.70.I9b25f07ad6fbccec824c9d46fc6c9b998699e68d@changeid
State Accepted
Delegated to: Bin Meng
Headers show
Series
  • x86: Add initial support for apollolake
Related show

Commit Message

Simon Glass Dec. 7, 2019, 4:42 a.m. UTC
We don't want to include dt-structs.h in header files, so add a note about
that.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
---

Changes in v6: None
Changes in v5: None
Changes in v4:
- Add a patch to explain of-platdata and header files

Changes in v3: None
Changes in v2: None

 doc/driver-model/of-plat.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Bin Meng Dec. 8, 2019, 3:43 a.m. UTC | #1
On Sat, Dec 7, 2019 at 12:51 PM Simon Glass <sjg@chromium.org> wrote:
>
> We don't want to include dt-structs.h in header files, so add a note about
> that.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
> ---
>
> Changes in v6: None
> Changes in v5: None
> Changes in v4:
> - Add a patch to explain of-platdata and header files
>
> Changes in v3: None
> Changes in v2: None
>

applied to u-boot-x86/next, thanks!

Patch
diff mbox series

diff --git a/doc/driver-model/of-plat.rst b/doc/driver-model/of-plat.rst
index 557957d2a1..034a68bb4e 100644
--- a/doc/driver-model/of-plat.rst
+++ b/doc/driver-model/of-plat.rst
@@ -279,6 +279,12 @@  For example:
     };
 
 
+Note that struct mmc_platdata is defined in the C file, not in a header. This
+is to avoid needing to include dt-structs.h in a header file. The idea is to
+keep the use of each of-platdata struct to the smallest possible code area.
+There is just one driver C file for each struct, that can convert from the
+of-platdata struct to the standard one used by the driver.
+
 In the case where SPL_OF_PLATDATA is enabled, platdata_auto_alloc_size is
 still used to allocate space for the platform data. This is different from
 the normal behaviour and is triggered by the use of of-platdata (strictly