summaryrefslogtreecommitdiff
path: root/cmd/sbc_harness/static/Documentation/harness_flash_bin.txt
diff options
context:
space:
mode:
authorLuke T. Shumaker <lukeshu@lukeshu.com>2025-02-23 10:58:41 -0700
committerLuke T. Shumaker <lukeshu@lukeshu.com>2025-02-23 10:58:41 -0700
commit53723a43e50863968bb040f5ad4f2f9005bac041 (patch)
tree7ffd6ab41a2ecf7754d3db0eded4c31257613a48 /cmd/sbc_harness/static/Documentation/harness_flash_bin.txt
parent19a41387633e53d64d8a0ae69f3d3d3e35641c8d (diff)
parentc2f977be6492fd93b359c97dee9b2968fe56fef6 (diff)
Merge branch 'lukeshu/docs'
Diffstat (limited to 'cmd/sbc_harness/static/Documentation/harness_flash_bin.txt')
-rw-r--r--cmd/sbc_harness/static/Documentation/harness_flash_bin.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/cmd/sbc_harness/static/Documentation/harness_flash_bin.txt b/cmd/sbc_harness/static/Documentation/harness_flash_bin.txt
new file mode 100644
index 0000000..982d7e0
--- /dev/null
+++ b/cmd/sbc_harness/static/Documentation/harness_flash_bin.txt
@@ -0,0 +1,24 @@
+NAME
+ /harness/flash.bin
+
+DESCRIPTION
+ Access to the flash storage chip (where the harness firmware
+ is stored).
+
+ Any number of readers may read the flash contents.
+
+BUGS
+ - The size of the chip is configured at compile-time. If the
+ firmware is loaded onto hardware with a larger flash chip
+ than it was compiled for, then the upper part of the chip
+ will not be accessible with this file. If the firmware is
+ loaded onto hardware with a smaller flash chip than it was
+ compiled for, then accessing the missing upper part of the
+ chip will crash.
+
+ - This file is not writable; it aught to be possible to update
+ the harness firmware by writing to this file.
+
+AUTHOR
+ Copyright (C) 2025 Luke T. Shumaker <lukeshu@lukeshu.com>
+ SPDX-License-Identifier: AGPL-3.0-or-later