dm: doc: Add a note about of-platdata and header files

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>
This commit is contained in:
Simon Glass 2019-12-06 21:42:43 -07:00 committed by Bin Meng
parent 75214b051b
commit c59f2ac175

View file

@ -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 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 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 the normal behaviour and is triggered by the use of of-platdata (strictly