From 524c493c9a0384ba1a9b461c03b28a2b4a5a5342 Mon Sep 17 00:00:00 2001 From: Mateusz Kusiak Date: Wed, 8 Oct 2025 15:38:16 +0200 Subject: [PATCH] docs/dts: Add info on user-supplied FW for HCL Add manual on how to use user-supplied firmware binaries for HCL report as a backup and for automatic analysis. The reason is proprietary BIOS can prohibit using internal programmer, but the firmware can be obtained from other places like BMC or as a result of using external programmer. Signed-off-by: Mateusz Kusiak --- .../documentation/features.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 3290167777..21bbf67a33 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -131,6 +131,46 @@ Legend: Please report all errors experienced while performing a dump to [dasharo-issues](https://github.com/Dasharo/dasharo-issues) repository. +### HCL Report Using an External Firmware Binary + +_Note: The following feature is available in DTS version 2.7.2 and later._ + +Proprietary or stock firmware may not support using the internal programmer to +dump the contents of the flash memory that stores the firmware. This results in +a less complete HCL report, which lacks an inbox firmware backup and the results +of automated firmware analysis. + +As a workaround, DTS allows users to provide the firmware binary file manually. +The firmware binary can be obtained, for example, by using an +[external programmer](../../variants/asrock_spc741d8/recovery.md) +(_NOTE: link describes writing operation, not reading!_) or by dumping the +firmware via [BMC](https://www.gigabyte.com/Glossary/bmc). + +To use a user-provided firmware binary in an HCL report, copy it to the +`/firmware/external/` directory. This can be done manually (for example, by +transferring the binary on a flash drive and copying it to the destination) or +over the network. The following example demonstrates the latter method, copying +the binary via SCP: + +1. Boot up the DTS. +1. Enable the SSH server. +1. Copy the firmware binary to the target platform at `/firmware/external/` via + `scp`. An example command is shown below: + + ```bash + scp root@:/firmware/external/ + ``` + +1. Proceed with generating the HCL report as usual. + +If the internal programmer fails to dump the firmware from the platform, DTS +will automatically use the user-supplied firmware binary. The following message +confirms that this fallback is in use: + +```log +Firmware dump not found, but found user-supplied external binary. +``` + ### BIOS backup One of the key components of HCL Report is your BIOS backup. To prepare BIOS