This series includes a documentation update to clarify how U-Boot makes use of devicetree and its requirements when working with other firmware projects.
Once agreed it should provide more clarity in this area, which seems to have devolved into a confusing mire recently.
My goal here is to sort out this area one and for all, clearly documenting the use cases and implications of them. I hope that the end result of this (substantial) effort will be a shared understanding of how to move forward in U-Boot and hopefully some ideas for firmware in general.
It also cleans up the config binding since this has got a bit out-of-date.
Changes in v3: - Add missing period - Fix 'bootsercure' typo - Fix typos linst suppled receive EFL - Drop 'and' before 'self-defeating' - Reword mention of control of QEMU's devicetree generation - Add mention of dropping CONFIG_OF_BOARD - Clarify the 'Once this bug is fixed' paragraph a bit - Expand ways that CONFIG_OF_PRIOR_STAGE can support the U-Boot devicetree - Add a note at the top explaining that his patch covers 'now', not 'future' - Add note 'Note: Some boards use a devicetree in U-Boot which does not match'
Changes in v2: - Add a new patch to tidy up the /config bindings - Add new patch to document remaining runtime-config options - Fix typos per Sean (thank you!) and a few others - Add a 'Use of U-Boot /config node' section - Drop mention of dm-verity since that actually uses the kernel cmdline - Explain that OF_BOARD will still work after these changes (in 'Once this bug is fixed...' paragraph) - Expand a bit on the reason why the 'Current situation' is bad - Clarify in a second place that Linux and U-Boot use the same devicetree in 'To be clear, while U-Boot...' - Expand on why we should have rules for other projects in 'Devicetree in another project' - Add a comment as to why devicetree in U-Boot is not 'bad design' - Reword 'in-tree U-Boot devicetree' to 'devicetree source in U-Boot' - Rewrite 'Devicetree generated on-the-fly in another project' to cover points raised on v1 - Add 'Why does U-Boot have its nodes and properties?' - Add 'Why not have two devicetrees?'
Simon Glass (3): doc: Tidy up the bindings for the config/ node doc: Complete the list of available runtime-config options RFC: doc: Add documentation about devicetree usage
doc/develop/index.rst | 1 + doc/develop/package/devicetree.rst | 583 ++++++++++++++++++++++++++++ doc/develop/package/index.rst | 1 + doc/device-tree-bindings/config.txt | 83 +++- 4 files changed, 652 insertions(+), 16 deletions(-) create mode 100644 doc/develop/package/devicetree.rst