Barebox automatically fixes up several properties to the root and
chosen node of the device tree passed to the booted system.
These entries contain information about the hardware, reset source
and the barebox version string.
Add documentation on how to query these information from the booted
linux system.
Signed-off-by: Johannes Zink <j.zink@xxxxxxxxxxxxxx>
---
Changelog:
v1 -> v2: Correct errors in content spotted by Ahmad. While at it, fix some typos.
Documentation/devicetree/index.rst | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index 36fa69058d1d..f85ce6608d14 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -151,3 +151,25 @@ Contents:
bindings/regulator/*
bindings/rtc/*
bindings/watchdog/*
+
+Automatic Boot Argument Fixups to the Devicetree
+------------------------------------------------
+
+barebox automatically fixes up some boot and system information in the device tree.
+
+In the device tree root, barebox fixes up
+
+ * serial-number (if available)
+ * machine compatible (if overridden)
+
+In the ``chosen``-node, barebox fixes up
+
+ * barebox-version
+ * reset-source
+ * reset-source-instance (if available)
+ * reset-source-device (node-path, only if available)
+ * bootsource
+ * boot-hartid (only on RISC-V)
+
+These values can be read from the booted linux system in ``/proc/device-tree/``
+or ``/sys/firmware/devicetree/base``.
--
2.30.2
