Skip to content

Commit

Permalink
Merge pull request #853 from Dasharo/docs-update-2-0-0
Browse files Browse the repository at this point in the history
dasharo-tools-suite: Add NovaCustom V54/56 and update image
  • Loading branch information
m-iwanicki authored Jul 19, 2024
2 parents a02b67d + 9c22b4d commit 574280a
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 34 deletions.
105 changes: 72 additions & 33 deletions docs/dasharo-tools-suite/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ that it boots on the following platforms:
report](https://docs.google.com/spreadsheets/d/1LOXY9HCu-fMitkYwX08iLsQdSNenzyU0LnMdVbZB5Do/edit#gid=536764189&range=A161)),
* NovaCustom NS5x/7x ([test
report](https://docs.google.com/spreadsheets/d/1LOXY9HCu-fMitkYwX08iLsQdSNenzyU0LnMdVbZB5Do/edit#gid=38447675&range=A174)),
* NovaCustom V54x/56x ([test
report](https://docs.google.com/spreadsheets/d/1wSE6xA3K3nXewwLn5lV39_2wZL1kg5AkGb4mvmG3bwE/edit?gid=382389731#gid=382389731))
* PC Engines apu2/3/4/6.

## Running
Expand Down Expand Up @@ -104,11 +106,12 @@ gzip -cdk dts-base-image-v1.1.0.wic.gz | \
sudo dd of=/dev/sdX bs=16M status=progress conv=fdatasync
```

> Notes:
> * this is an example done on the v1.1.0 image.
> * replace "sdX" with the letter of your USB disk device. For example: sda,
> sdb, sdc. It should not be partition number (for example, not sda1
> or sda2).
!!! note "Notes"

* this is an example done on the v1.1.0 image.
* replace "sdX" with the letter of your USB disk device. For example: sda,
sdb, sdc. It should not be partition number (for example, not sda1
or sda2).

* insert the USB stick into a USB in your device,
* boot from the USB stick,
Expand Down Expand Up @@ -177,6 +180,7 @@ cat kas/cache.yml
output:
```bash
---
header:
version: 11

Expand Down Expand Up @@ -303,6 +307,10 @@ This feature is supported on the following platforms:
* NovaCustom NV4x,
* NovaCustom NS5x/7x.

And partially (only EC firmware flashing) on:

* NovaCustom V54x/56x.

### HCL Report

DTS allows the generation of a package with logs containing hardware
Expand All @@ -311,7 +319,7 @@ If you would like to send the report to our servers, please remember about
connecting the ethernet cable. More information can be found in
[glossary](../glossary.md#dasharo-hardware-compatibility-list-report).

![](./images/dts-hcl-run.jpg)
![](./images/dts-hcl-run.png)

#### HCL Report correctness

Expand Down Expand Up @@ -377,14 +385,14 @@ Please consider the following options depending on your situation:
storage available, so the report, and your BIOS backup are stored in
temporary memory and will not be available after reboot. Please make sure
to move HCL Report to not volatile storage. This can be done using option
`9) Shell`,
`S to enter shell`,
+ **USB Boot** - HCL Report and BIOS backup are saved to USB storage root
directory.

### Firmware update

DTS can be used to update Dasharo firmware. To achieve this, boot it on platform
with flashed Dasharo and choose option number `5`. You may see additional
with flashed Dasharo and choose option number `2`. You may see additional
information about available updates if you are not [Dasharo Entry
Subscription](https://docs.dasharo.com/ways-you-can-help-us/#become-a-dasharo-entry-subscription-subscriber)
subscriber.
Expand All @@ -408,36 +416,62 @@ Procedure execution ends automatically on the reboot of the platform (unless it
requires otherwise). After restarting the device, you can enjoy the updated
version of Dasharo, which we provide for given hardware.

Below we provide an example of updating Dasharo firmware from version v1.0.0 to
Below we provide an example of updating Dasharo firmware from version v1.1.0 to
v1.1.1 on MSI PRO Z690-A DDR4.

```bash
DTS version v1.2.0
1) Dasharo HCL report - dump hardware information from this device
3) Restore firmware from Dasharo HCL report
4) Load SE keys
5) Update Dasharo firmware
9) Shell
10) Power off system
11) Reboot system
Enter an option: 5
Dasharo Tools Suite Script 2.0.0-rc1
(c) Dasharo <[email protected]>
Report issues at: https://github.com/Dasharo/dasharo-issues
*********************************************************
** HARDWARE INFORMATION
*********************************************************
** System Inf.: Micro-Star International Co., Ltd. MS-7D25
** Baseboard Inf.: Micro-Star International Co., Ltd. PRO Z690-A WIFI DDR4(MS-7D25)
** CPU Inf.: 12th Gen Intel(R) Core(TM) i5-12600K
** RAM Channel-0-DIMM-0: KF3600C17D4/8GX
** RAM Channel-0-DIMM-1: KF3600C17D4/8GX
** RAM Channel-0-DIMM-0: KF3600C17D4/8GX
** RAM Channel-0-DIMM-1: KF3600C17D4/8GX
*********************************************************
** FIRMWARE INFORMATION
*********************************************************
** BIOS Inf.: 3mdeb Dasharo (coreboot+UEFI) v1.1.0
*********************************************************
** 1) Dasharo HCL report
** 2) Update Dasharo Firmware
** 3) Restore firmware from Dasharo HCL report
** 4) Load your DES keys
*********************************************************
Select a menu option or
R to reboot P to poweroff S to enter shell
K to launch SSH server
2
Waiting for network connection ...
Network connection established.
Checking if board is Dasharo compatible.
Gathering flash chip and chipset information...
Flash information: vendor="Programmer" name="Opaque flash chip"
Flash size: 32M
Getting platform specific GPG key... Done
Waiting for system clock to be synced ...
Checking for the latest Dasharo update available...
Current Dasharo version: 1.0.0
Current Dasharo version: 1.1.0
Latest available Dasharo version: 1.1.1
Are you sure you want to proceed with update? (Y|n) y
Downloading Dasharo firmware...Done
Please verify detected hardware!
Board vendor: Micro-Star International Co., Ltd.
System model: MS-7D25
Board model: PRO Z690-A WIFI DDR4(MS-7D25)
Does it match your actual specification? (Y|n)y
Does it match your actual specification? (Y|n) y
Following firmware will be used to install Dasharo
Dasharo BIOS firmware:
Expand All @@ -448,13 +482,16 @@ You can learn more about this release on: https://docs.dasharo.com/
Do you want to update Dasharo firmware on your hardware? (Y|n) y
Downloading Dasharo firmware update...
########################################################################### 100.0%
Checking sha256sum...
/tmp/biosupdate.rom: OK
Checking Dasharo firmware checksum... Verified.
Checking Dasharo firmware signature... Verified.
Backing up firmware configuration... Done.
Found file config at 0xc24c0, type raw, compressed 5418, size 19725
Checking flash layout.
Checking vboot keys.
Updating Dasharo firmware...
This will take around 3 minutes. Please be patient and do not reset your
computer, or touch keyboard!
This may take several minutes. Please be patient and do not power off your
computer or touch the keyboard!
Successfully updated Dasharo firmware
Syncing disks... Done.
The computer will reboot automatically in 5 seconds
Expand All @@ -470,7 +507,7 @@ Rebooting
#### Local firmware update
To flash a local BIOS image (e.g. mounted from a USB stick), you can drop to the
shell (option `9`) and use the `flashrom` binary provided inside DTS directly.
shell (option `S`) and use the `flashrom` binary provided inside DTS directly.
**DANGER**: Failure to use `flashrom` correctly **_may result in an unbootable
device_**. For example, never flash an image that does not contain an Intel
Expand Down Expand Up @@ -524,9 +561,11 @@ BIOS lock is turned off this time.
DTS allows performing full Embedded Controller firmware transition from the
proprietary vendor EC firmware to the Dasharo EC firmware. Currently, this
functionality is supported on the [NovaCustom
NS5x/NS7x](/variants/novacustom_ns5x_tgl/releases/)) and [NovaCustom
NV4x](/variants/novacustom_nv4x_tgl/releases/) only.
functionality is supported on the
[NovaCustom NS5x/NS7x](/variants/novacustom_ns5x_tgl/releases/),
[NovaCustom NV4x](/variants/novacustom_nv4x_tgl/releases/),
[NovaCustom V54x](/variants/novacustom_v540tu/releases/) and
[NovaCustom V56x](/variants/novacustom_v560tu/releases/) only.
Starting from DTS v1.2.0 to perform EC transition please run
[firmware update](#firmware-update) on the platform with proprietary vendor EC
Expand Down
Binary file removed docs/dasharo-tools-suite/images/dts-hcl-run.jpg
Binary file not shown.
Binary file added docs/dasharo-tools-suite/images/dts-hcl-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/unified/novacustom/initial-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ devices.
1. Install the EC firmware:

```bash
flashrom -p ite_ec:boardmismatch=force,romsize=256K -w path/to/ec.rom
flashrom -p ite_ec:boardmismatch=force,romsize=128K -w path/to/ec.rom
```

### BIOS installation
Expand Down

0 comments on commit 574280a

Please sign in to comment.