diff options
| author | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-02-22 00:30:47 -0700 |
|---|---|---|
| committer | Luke T. Shumaker <lukeshu@lukeshu.com> | 2025-02-23 10:55:12 -0700 |
| commit | c2f977be6492fd93b359c97dee9b2968fe56fef6 (patch) | |
| tree | 7ffd6ab41a2ecf7754d3db0eded4c31257613a48 /cmd/sbc_harness/static/Documentation/harness_flash_bin.txt | |
| parent | c990e16bb4754e17a4858274ebd59f1e0859b16f (diff) | |
cmd/sbc_harness: Add documentation for rom.bin and flash.bin
Diffstat (limited to 'cmd/sbc_harness/static/Documentation/harness_flash_bin.txt')
| -rw-r--r-- | cmd/sbc_harness/static/Documentation/harness_flash_bin.txt | 24 |
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 |