Skip to content

Commit a229657

Browse files
authored
Merge pull request #1167 from Dasharo/dts_usr_fw
docs/dts: Add info on user-supplied FW for HCL
2 parents f92737f + 524c493 commit a229657

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/dasharo-tools-suite/documentation/features.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,46 @@ Legend:
131131
Please report all errors experienced while performing a dump to
132132
[dasharo-issues](https://github.com/Dasharo/dasharo-issues) repository.
133133

134+
### HCL Report Using an External Firmware Binary
135+
136+
_Note: The following feature is available in DTS version 2.7.2 and later._
137+
138+
Proprietary or stock firmware may not support using the internal programmer to
139+
dump the contents of the flash memory that stores the firmware. This results in
140+
a less complete HCL report, which lacks an inbox firmware backup and the results
141+
of automated firmware analysis.
142+
143+
As a workaround, DTS allows users to provide the firmware binary file manually.
144+
The firmware binary can be obtained, for example, by using an
145+
[external programmer](../../variants/asrock_spc741d8/recovery.md)
146+
(_NOTE: link describes writing operation, not reading!_) or by dumping the
147+
firmware via [BMC](https://www.gigabyte.com/Glossary/bmc).
148+
149+
To use a user-provided firmware binary in an HCL report, copy it to the
150+
`/firmware/external/` directory. This can be done manually (for example, by
151+
transferring the binary on a flash drive and copying it to the destination) or
152+
over the network. The following example demonstrates the latter method, copying
153+
the binary via SCP:
154+
155+
1. Boot up the DTS.
156+
1. Enable the SSH server.
157+
1. Copy the firmware binary to the target platform at `/firmware/external/` via
158+
`scp`. An example command is shown below:
159+
160+
```bash
161+
scp <path_to_firmware_binary> root@<target_ip_address>:/firmware/external/
162+
```
163+
164+
1. Proceed with generating the HCL report as usual.
165+
166+
If the internal programmer fails to dump the firmware from the platform, DTS
167+
will automatically use the user-supplied firmware binary. The following message
168+
confirms that this fallback is in use:
169+
170+
```log
171+
Firmware dump not found, but found user-supplied external binary.
172+
```
173+
134174
### BIOS backup
135175

136176
One of the key components of HCL Report is your BIOS backup. To prepare BIOS

0 commit comments

Comments
 (0)