summaryrefslogtreecommitdiff
path: root/doc/README.bootcount
diff options
context:
space:
mode:
authorVasileios Amoiridis <[email protected]>2024-06-28 19:35:42 +0200
committerTom Rini <[email protected]>2024-07-16 12:46:34 -0600
commit1c1e484ba856fa03122a01cd9e7b8e038fa5d1bc (patch)
tree885de66f1cc2afbfe97270f2b365945660ec3d98 /doc/README.bootcount
parent1d7e2120af8ddf1abbdb6f34e3a39174cf54736f (diff)
doc: api: bootcount: Convert to rST documentation
Move to the new documentation style with rST formatting. Signed-off-by: Vasileios Amoiridis <[email protected]>
Diffstat (limited to 'doc/README.bootcount')
-rw-r--r--doc/README.bootcount53
1 files changed, 0 insertions, 53 deletions
diff --git a/doc/README.bootcount b/doc/README.bootcount
deleted file mode 100644
index 0f4ffb68285..00000000000
--- a/doc/README.bootcount
+++ /dev/null
@@ -1,53 +0,0 @@
-.. SPDX-License-Identifier: GPL-2.0+
-
-Boot Count Limit
-================
-
-This is enabled by CONFIG_BOOTCOUNT_LIMIT.
-
-This allows to detect multiple failed attempts to boot Linux.
-
-After a power-on reset, the "bootcount" variable will be initialized to 1, and
-each reboot will increment the value by 1.
-
-If, after a reboot, the new value of "bootcount" exceeds the value of
-"bootlimit", then instead of the standard boot action (executing the contents of
-"bootcmd"), an alternate boot action will be performed, and the contents of
-"altbootcmd" will be executed.
-
-If the variable "bootlimit" is not defined in the environment, the Boot Count
-Limit feature is disabled. If it is enabled, but "altbootcmd" is not defined,
-then U-Boot will drop into interactive mode and remain there.
-
-It is the responsibility of some application code (typically a Linux
-application) to reset the variable "bootcount" to 0 when the system booted
-successfully, thus allowing for more boot cycles.
-
-CONFIG_BOOTCOUNT_FS
---------------------
-
-This adds support for maintaining boot count in a file on a filesystem.
-Supported filesystems are FAT and EXT. The file to use is defined by:
-
-CONFIG_SYS_BOOTCOUNT_FS_INTERFACE
-CONFIG_SYS_BOOTCOUNT_FS_DEVPART
-CONFIG_SYS_BOOTCOUNT_FS_NAME
-
-The format of the file is:
-
-==== =================
-type entry
-==== =================
-u8 magic
-u8 version
-u8 bootcount
-u8 upgrade_available
-==== =================
-
-To prevent unattended usage of "altbootcmd", the "upgrade_available" variable is
-used.
-If "upgrade_available" is 0, "bootcount" is not saved.
-If "upgrade_available" is 1, "bootcount" is saved.
-So a userspace application should take care of setting the "upgrade_available"
-and "bootcount" variables to 0, if the system boots successfully.
-This also avoids writing the "bootcount" information on all reboots.