summaryrefslogtreecommitdiffstats
path: root/Documentation/user
diff options
context:
space:
mode:
authorAhmad Fatoum <ahmad@a3f.at>2021-04-01 08:46:14 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2021-04-13 14:24:02 +0200
commit749bc1657988e4ce24d380c8f68f8f9fa8928886 (patch)
tree3bbf38446db3e08fc4fcd66071aac1408c973058 /Documentation/user
parent0199332f6b772149e47303b4244af06867247344 (diff)
downloadbarebox-749bc1657988e4ce24d380c8f68f8f9fa8928886.tar.gz
barebox-749bc1657988e4ce24d380c8f68f8f9fa8928886.tar.xz
Documentation: reboot-mode: fix headings
What was supposed to be subheadings of the Disambiguation headings weren't by mistake. Bump up the other headings to restore the balance. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/user')
-rw-r--r--Documentation/user/reboot-mode.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/user/reboot-mode.rst b/Documentation/user/reboot-mode.rst
index 9321d928f4..8717e39342 100644
--- a/Documentation/user/reboot-mode.rst
+++ b/Documentation/user/reboot-mode.rst
@@ -1,7 +1,8 @@
.. _reboot_mode:
+###########
Reboot Mode
------------
+###########
To simplify debugging, many BootROMs sample registers that survive
a warm reset to customize the boot. These registers can e.g. indicate
@@ -23,7 +24,7 @@ modes in the device tree. If a match is found the associated magic
is written to the location referenced in the device tree node.
User API
-~~~~~~~~
+========
Devices registered with the reboot mode API gain two parameters:
@@ -46,7 +47,7 @@ priority has its parameters aliased as ``$global.system.reboot_mode.prev``
and ``$global.system.reboot_mode.next``.
Reset
-~~~~~
+=====
Reboot modes can be stored on a syscon wrapping general purpose registers
that survives warm resets. If the system instead did reset via an external
@@ -57,7 +58,7 @@ reset provider. In barebox, multiple reset providers may co-exist. They
``reset`` command allows listing and choosing a specific reboot mode.
Disambiguation
-~~~~~~~~~~~~~~
+==============
Some uses of reboot modes partially overlap with other barebox
functionality. They all ultimately serve different purposes, however.