summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJohannes Zink <j.zink@pengutronix.de>2023-03-17 13:19:37 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2023-03-21 09:10:35 +0100
commit979aa1e6729283760f07597744a289750efdcdf6 (patch)
treeae2d80b8ad0f79b03fdc6bfd4e7ad4090c5e4b25 /Documentation
parent90d152cd026d18dabeb53ae471b8056730b3e656 (diff)
downloadbarebox-979aa1e6729283760f07597744a289750efdcdf6.tar.gz
Documentation: devicetree: list automatic boot argument fixups
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@pengutronix.de> Reviewed-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20230317121937.958131-1-j.zink@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index 36fa69058d..f85ce6608d 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``.