From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>,
Ilias Apalodimas <ilias.apalodimas@linaro.org>,
Mark Kettenis <mark.kettenis@xs4all.nl>,
Tom Rini <trini@konsulko.com>, Sean Anderson <seanga2@gmail.com>,
Simon Glass <sjg@chromium.org>, Bin Meng <bmeng.cn@gmail.com>
Subject: [PATCH v2 0/3] doc: Clarify how U-Boot makes use of devicetree
Date: Sat, 28 Aug 2021 10:46:26 -0600 [thread overview]
Message-ID: <20210828164630.81050-1-sjg@chromium.org> (raw)
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 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 | 563 ++++++++++++++++++++++++++++
doc/develop/package/index.rst | 1 +
doc/device-tree-bindings/config.txt | 83 +++-
4 files changed, 632 insertions(+), 16 deletions(-)
create mode 100644 doc/develop/package/devicetree.rst
--
2.33.0.259.gc128427fd7-goog
next reply other threads:[~2021-08-28 16:46 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-28 16:46 Simon Glass [this message]
2021-08-28 16:46 ` [PATCH v2 1/3] doc: Tidy up the bindings for the config/ node Simon Glass
2021-08-30 14:45 ` Marcel Ziswiler
2021-08-28 16:46 ` [PATCH v2 2/3] doc: Complete the list of available runtime-config options Simon Glass
2021-08-30 14:53 ` Marcel Ziswiler
2021-08-28 16:46 ` [PATCH v2 3/3] RFC: doc: Add documentation about devicetree usage Simon Glass
2021-08-30 12:46 ` Ilias Apalodimas
2021-08-30 14:30 ` Heinrich Schuchardt
2021-08-30 14:48 ` Tom Rini
2021-08-30 15:14 ` Heinrich Schuchardt
2021-08-30 16:15 ` Tom Rini
2021-09-03 8:53 ` Simon Glass
2021-09-03 8:53 ` Simon Glass
2021-09-10 14:00 ` Tom Rini
2021-10-22 3:05 ` Simon Glass
2021-08-30 14:53 ` Marcel Ziswiler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210828164630.81050-1-sjg@chromium.org \
--to=sjg@chromium.org \
--cc=bmeng.cn@gmail.com \
--cc=ilias.apalodimas@linaro.org \
--cc=mark.kettenis@xs4all.nl \
--cc=seanga2@gmail.com \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
--cc=xypron.glpk@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox