From 8d189bbf32ca1b4a12e6f790cb82ceb576e74618 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Tue, 10 Dec 2024 19:27:19 +0100 Subject: [PATCH 01/15] docs/dasharo-tools-suite: Split DTS documentation Split the content of documentation.md file into the following structure: documentation/ building.md features.md running.md supported-hardware.md Signed-off-by: Eduard Kaverinskyi --- .../documentation/building.md | 142 ++++++++++ .../features.md} | 258 ------------------ .../documentation/running.md | 94 +++++++ .../documentation/supported-hardware.md | 17 ++ mkdocs.yml | 6 +- 5 files changed, 258 insertions(+), 259 deletions(-) create mode 100644 docs/dasharo-tools-suite/documentation/building.md rename docs/dasharo-tools-suite/{documentation.md => documentation/features.md} (68%) create mode 100644 docs/dasharo-tools-suite/documentation/running.md create mode 100644 docs/dasharo-tools-suite/documentation/supported-hardware.md diff --git a/docs/dasharo-tools-suite/documentation/building.md b/docs/dasharo-tools-suite/documentation/building.md new file mode 100644 index 0000000000..24b4a32d31 --- /dev/null +++ b/docs/dasharo-tools-suite/documentation/building.md @@ -0,0 +1,142 @@ +## Building + +We choose [Yocto Project](https://www.yoctoproject.org/) to prepare Dasharo +Tools Suite system. DTS image can be built using publicly available sources. +Thanks to publishing the build cache on +[cache.dasharo.com](https://cache.dasharo.com/yocto/dts/) the time needed to +finish the process should be significantly decreased. + +### Prerequisites + +The following must be met to build DTS: + +* Linux PC (tested on `Ubuntu 20.04 LTS`), +* [docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) installed, +* [kas-container 3.0.2](https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container) + script downloaded and available in [PATH](https://en.wikipedia.org/wiki/PATH_(variable)), + +```bash +wget -O ~/bin/kas-container https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container +``` + +```bash +chmod +x ~/bin/kas-container +``` + +* `meta-dts` repository cloned. + +```bash +mkdir yocto && cd yocto +``` + +```bash +git clone https://github.com/Dasharo/meta-dts.git +``` + +### Build + +From `yocto` directory, run: + +```shell +SHELL=/bin/bash kas-container build meta-dts/kas.yml +``` + +Image build takes time, so be patient, and the build's finished, you should see +something similar to (tasks number may differ): + +```shell +Initialising tasks: 100% |###########################################################################################| Time: 0:00:01 +Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete) +NOTE: Executing Tasks +NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded. +``` + +Using the cache is enabled in `kas/cache.yml` file and can be disabled by +removing content of that file. + +```bash +cat kas/cache.yml +``` + +output: + +```bash +--- +header: + version: 11 + +local_conf_header: + yocto-cache: | + SSTATE_MIRRORS ?= "file://.* http://${LOCAL_PREMIRROR_SERVER}/${PROJECT_NAME}/sstate-cache/PATH" + SOURCE_MIRROR_URL ?= "http://${LOCAL_PREMIRROR_SERVER}/${PROJECT_NAME}/downloads" + INHERIT += "own-mirrors" + LOCAL_PREMIRROR_SERVER ?= "cache.dasharo.com" + PROJECT_NAME ?= "yocto/dts" +``` + +#### Build image with UEFI Secure Boot support + +From `yocto` directory run: + +```shell +SHELL=/bin/bash kas-container build meta-dts/kas-uefi-sb.yml +``` + +Image build takes time, so be patient and after build's finish you should see +something similar to (the exact tasks numbers may differ): + +```shell +Initialising tasks: 100% |###########################################################################################| Time: 0:00:04 +Checking sstate mirror object availability: 100% |###################################################################| Time: 0:00:03 +Sstate summary: Wanted 892 Local 672 Mirrors 212 Missed 8 Current 1560 (99% match, 99% complete) +NOTE: Executing Tasks +NOTE: Tasks Summary: Attempted 5860 tasks of which 5841 didn't need to be rerun and all succeeded. +``` + +Image created with `kas-uefi-sb.yml` configuration file enable integration of +UEFI Secure Boot into DTS using +[meta-secure-core](https://github.com/jiazhang0/meta-secure-core/). Building the +image allow to prepare a PoC version with [uses sample +keys](https://github.com/jiazhang0/meta-secure-core/tree/master/meta-efi-secure-boot#sample-keys) +which by no mean should used in production. For user keys the script +[create-user-key-store.sh](https://github.com/jiazhang0/meta-secure-core/blob/master/meta-signing-key/scripts/create-user-key-store.sh) +can be used but it was not tested yet. Quick start with instructions on how to +use image are described in +[meta-efi-secure-boot](https://github.com/jiazhang0/meta-secure-core/tree/master/meta-efi-secure-boot#quick-start-for-the-first-boot). + +### Flash + +* Find out your device name. + +```shell +fdisk -l +``` + +output: + +```shell +(...) +Device Boot Start End Sectors Size Id Type +/dev/sdx1 * 8192 131433 123242 60,2M c W95 FAT32 (LBA) +/dev/sdx2 139264 186667 47404 23,2M 83 Linux +``` + +In this case the device name is `/dev/sdx`, **but be aware, in the next steps, +replace `/dev/sdx` with the right device name on your platform, or else you can +damage your system!** + +* From where you ran image build type. + +```shell +sudo umount /dev/sdx* +``` + +```shell +cd build/tmp/deploy/images/genericx86-64 +``` + +Here the file `dts-base-image-genericx86-64.wic.gz` should be available, which +is the image of DTS. To flash image, you can use the same command shown in +[running section](#launching-dts_1). Just change the file name. + +* Boot the platform. diff --git a/docs/dasharo-tools-suite/documentation.md b/docs/dasharo-tools-suite/documentation/features.md similarity index 68% rename from docs/dasharo-tools-suite/documentation.md rename to docs/dasharo-tools-suite/documentation/features.md index 51943a54b6..277b6fe13d 100644 --- a/docs/dasharo-tools-suite/documentation.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -1,261 +1,3 @@ -# Documentation - -## Supported hardware - -Dasharo Tools Suite was prepared to run on x86 platforms, but we can confirm -that it boots on the following platforms: - -* ASUS KGPE-D16, -* Dell OptiPlex 7010/9010, -* MSI PRO Z690-A DDR4, -* MSI PRO Z690-A DDR5, -* MSI PRO Z790-P DDR4, -* MSI PRO Z790-P DDR5, -* NovaCustom NV4x -* NovaCustom NS5x/7x, -* NovaCustom V540TU/TND, -* NovaCustom V560TU/TND/TNE, -* PC Engines apu2/3/4/6. -* ODROID-H4+ - -## Running - -The Dasharo Tools Suite can be started in various ways. Currently, there are -two options: - -* bootable over a network (iPXE), -* bootable USB stick image. - -The first one should always be preferred if possible, as it is the easiest one -to use. - -### Bootable over a network - -This section describes how to boot DTS using iPXE. - -#### Requirements - -Below are the requirements that must be met to run DTS over a network on the -platform: - -* Dasharo device with DTS functionality integrated, -* wired network connection, -* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), -* If device if flashed with Dasharo and support following functionality - + disabled BIOS lock feature, - + disabled SMM BIOS write protection feature. - -#### Launching DTS - -To access Dasharo Tools Suite: - -* attach a wired network cable to the device's Ethernet port, -* power on the device, holding down the Boot Menu entry key, -* in the Boot Menu, select the `iPXE Network Boot` option, -* in the Network Boot menu, select the `Dasharo Tools Suite` option, or enter - iPXE shell and type by hand: - - ```bash - dhcp net0 - chain https://boot.dasharo.com/dts/dts.ipxe - ``` - - !!! warning - - Because of misconfigured iPXE on some firmware releases, booting over - HTTPS is impossible, and the above command will fail. In that case, we - recommend downloading the DTS image to USB. If you feel there is no - risk of an MITM attack, you can proceed with - `http://boot.dasharo.com/dts/dts.ipxe` at your own risk. - -* the DTS menu will now appear. - -### Bootable USB stick - -This section describes how to boot DTS using a USB stick. - -#### Requirements - -Below are the requirements that must be met to run DTS from a USB device on the -platform: - -* USB stick (at least 2GB), -* Latest image from [releases](https://github.com/Dasharo/meta-dts/releases) - section. - with Dasharo). -* Wired network connection, -* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), -* If device if flashed with Dasharo and support following functionality - + disabled BIOS lock feature, - + disabled SMM BIOS write protection feature. - -#### Launching DTS - -To access Dasharo Tools Suite: - -* flash the downloaded image onto USB stick, - + you can use a cross-platform GUI installer - [Etcher](https://www.balena.io/etcher/) - + you can also use `dd` to flash from the command line - -```bash -gzip -cdk dts-base-image-v1.1.0.wic.gz | \ -sudo dd of=/dev/sdX bs=16M status=progress conv=fdatasync -``` - -!!! 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, -* the DTS menu will now appear. - -## Building - -We choose [Yocto Project](https://www.yoctoproject.org/) to prepare Dasharo -Tools Suite system. DTS image can be built using publicly available sources. -Thanks to publishing the build cache on -[cache.dasharo.com](https://cache.dasharo.com/yocto/dts/) the time needed to -finish the process should be significantly decreased. - -### Prerequisites - -The following must be met to build DTS: - -* Linux PC (tested on `Ubuntu 20.04 LTS`), -* [docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) installed, -* [kas-container 3.0.2](https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container) - script downloaded and available in [PATH](https://en.wikipedia.org/wiki/PATH_(variable)), - -```bash -wget -O ~/bin/kas-container https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container -``` - -```bash -chmod +x ~/bin/kas-container -``` - -* `meta-dts` repository cloned. - -```bash -mkdir yocto && cd yocto -``` - -```bash -git clone https://github.com/Dasharo/meta-dts.git -``` - -### Build - -From `yocto` directory, run: - -```shell -SHELL=/bin/bash kas-container build meta-dts/kas.yml -``` - -Image build takes time, so be patient, and the build's finished, you should see -something similar to (tasks number may differ): - -```shell -Initialising tasks: 100% |###########################################################################################| Time: 0:00:01 -Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete) -NOTE: Executing Tasks -NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded. -``` - -Using the cache is enabled in `kas/cache.yml` file and can be disabled by -removing content of that file. - -```bash -cat kas/cache.yml -``` - -output: - -```bash ---- -header: - version: 11 - -local_conf_header: - yocto-cache: | - SSTATE_MIRRORS ?= "file://.* http://${LOCAL_PREMIRROR_SERVER}/${PROJECT_NAME}/sstate-cache/PATH" - SOURCE_MIRROR_URL ?= "http://${LOCAL_PREMIRROR_SERVER}/${PROJECT_NAME}/downloads" - INHERIT += "own-mirrors" - LOCAL_PREMIRROR_SERVER ?= "cache.dasharo.com" - PROJECT_NAME ?= "yocto/dts" -``` - -#### Build image with UEFI Secure Boot support - -From `yocto` directory run: - -```shell -SHELL=/bin/bash kas-container build meta-dts/kas-uefi-sb.yml -``` - -Image build takes time, so be patient and after build's finish you should see -something similar to (the exact tasks numbers may differ): - -```shell -Initialising tasks: 100% |###########################################################################################| Time: 0:00:04 -Checking sstate mirror object availability: 100% |###################################################################| Time: 0:00:03 -Sstate summary: Wanted 892 Local 672 Mirrors 212 Missed 8 Current 1560 (99% match, 99% complete) -NOTE: Executing Tasks -NOTE: Tasks Summary: Attempted 5860 tasks of which 5841 didn't need to be rerun and all succeeded. -``` - -Image created with `kas-uefi-sb.yml` configuration file enable integration of -UEFI Secure Boot into DTS using -[meta-secure-core](https://github.com/jiazhang0/meta-secure-core/). Building the -image allow to prepare a PoC version with [uses sample -keys](https://github.com/jiazhang0/meta-secure-core/tree/master/meta-efi-secure-boot#sample-keys) -which by no mean should used in production. For user keys the script -[create-user-key-store.sh](https://github.com/jiazhang0/meta-secure-core/blob/master/meta-signing-key/scripts/create-user-key-store.sh) -can be used but it was not tested yet. Quick start with instructions on how to -use image are described in -[meta-efi-secure-boot](https://github.com/jiazhang0/meta-secure-core/tree/master/meta-efi-secure-boot#quick-start-for-the-first-boot). - -### Flash - -* Find out your device name. - -```shell -fdisk -l -``` - -output: - -```shell -(...) -Device Boot Start End Sectors Size Id Type -/dev/sdx1 * 8192 131433 123242 60,2M c W95 FAT32 (LBA) -/dev/sdx2 139264 186667 47404 23,2M 83 Linux -``` - -In this case the device name is `/dev/sdx`, **but be aware, in the next steps, -replace `/dev/sdx` with the right device name on your platform, or else you can -damage your system!** - -* From where you ran image build type. - -```shell -sudo umount /dev/sdx* -``` - -```shell -cd build/tmp/deploy/images/genericx86-64 -``` - -Here the file `dts-base-image-genericx86-64.wic.gz` should be available, which -is the image of DTS. To flash image, you can use the same command shown in -[running section](#launching-dts_1). Just change the file name. - -* Boot the platform. - ## Features This section describes the functionality of the Dasharo Tools Suite. These are: diff --git a/docs/dasharo-tools-suite/documentation/running.md b/docs/dasharo-tools-suite/documentation/running.md new file mode 100644 index 0000000000..6794b1a495 --- /dev/null +++ b/docs/dasharo-tools-suite/documentation/running.md @@ -0,0 +1,94 @@ +## Running + +The Dasharo Tools Suite can be started in various ways. Currently, there are +two options: + +* bootable over a network (iPXE), +* bootable USB stick image. + +The first one should always be preferred if possible, as it is the easiest one +to use. + +### Bootable over a network + +This section describes how to boot DTS using iPXE. + +#### Requirements + +Below are the requirements that must be met to run DTS over a network on the +platform: + +* Dasharo device with DTS functionality integrated, +* wired network connection, +* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), +* If device if flashed with Dasharo and support following functionality + + disabled BIOS lock feature, + + disabled SMM BIOS write protection feature. + +#### Launching DTS + +To access Dasharo Tools Suite: + +* attach a wired network cable to the device's Ethernet port, +* power on the device, holding down the Boot Menu entry key, +* in the Boot Menu, select the `iPXE Network Boot` option, +* in the Network Boot menu, select the `Dasharo Tools Suite` option, or enter + iPXE shell and type by hand: + + ```bash + dhcp net0 + chain https://boot.dasharo.com/dts/dts.ipxe + ``` + + !!! warning + + Because of misconfigured iPXE on some firmware releases, booting over + HTTPS is impossible, and the above command will fail. In that case, we + recommend downloading the DTS image to USB. If you feel there is no + risk of an MITM attack, you can proceed with + `http://boot.dasharo.com/dts/dts.ipxe` at your own risk. + +* the DTS menu will now appear. + +### Bootable USB stick + +This section describes how to boot DTS using a USB stick. + +#### Requirements + +Below are the requirements that must be met to run DTS from a USB device on the +platform: + +* USB stick (at least 2GB), +* Latest image from [releases](https://github.com/Dasharo/meta-dts/releases) + section. + with Dasharo). +* Wired network connection, +* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), +* If device if flashed with Dasharo and support following functionality + + disabled BIOS lock feature, + + disabled SMM BIOS write protection feature. + +#### Launching DTS + +To access Dasharo Tools Suite: + +* flash the downloaded image onto USB stick, + + you can use a cross-platform GUI installer - [Etcher](https://www.balena.io/etcher/) + + you can also use `dd` to flash from the command line + +```bash +gzip -cdk dts-base-image-v1.1.0.wic.gz | \ +sudo dd of=/dev/sdX bs=16M status=progress conv=fdatasync +``` + +!!! 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, +* the DTS menu will now appear. diff --git a/docs/dasharo-tools-suite/documentation/supported-hardware.md b/docs/dasharo-tools-suite/documentation/supported-hardware.md new file mode 100644 index 0000000000..bd9b95a282 --- /dev/null +++ b/docs/dasharo-tools-suite/documentation/supported-hardware.md @@ -0,0 +1,17 @@ +## Supported hardware + +Dasharo Tools Suite was prepared to run on x86 platforms, but we can confirm +that it boots on the following platforms: + +* ASUS KGPE-D16, +* Dell OptiPlex 7010/9010, +* MSI PRO Z690-A DDR4, +* MSI PRO Z690-A DDR5, +* MSI PRO Z790-P DDR4, +* MSI PRO Z790-P DDR5, +* NovaCustom NV4x +* NovaCustom NS5x/7x, +* NovaCustom V540TU/TND, +* NovaCustom V560TU/TND/TNE, +* PC Engines apu2/3/4/6. +* ODROID-H4+ \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a3e0376ceb..0085e970f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -438,7 +438,11 @@ nav: - 'Dasharo Tools Suite': - 'Overview': dasharo-tools-suite/overview.md - 'Releases': dasharo-tools-suite/releases.md - - 'Documentation': dasharo-tools-suite/documentation.md + - 'Documentation': + - "Supported Hardware": dasharo-tools-suite/documentation/supported-hardware.md + - "Building": dasharo-tools-suite/documentation/building.md + - "Running": dasharo-tools-suite/documentation/running.md + - "Features": dasharo-tools-suite/documentation/features.md - 'Knowledge base': - 'Glossary': glossary.md - 'Dasharo Product Naming Convention': dasharo-naming-convention.md From 689d3583b5a016b9f35ebd8c3ab63ece566c9831 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Tue, 10 Dec 2024 19:51:29 +0100 Subject: [PATCH 02/15] docs/dasharo-tools-suite/documentation/features.md: Add Available Commands list --- .../documentation/features.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 277b6fe13d..c39822f327 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -2,6 +2,7 @@ This section describes the functionality of the Dasharo Tools Suite. These are: +* [DTS available commands](#available-commands) * [Dasharo zero-touch initial deployment](#dasharo-zero-touch-initial-deployment), * [HCL Report](#hcl-report), * [Firmware update](#firmware-update), @@ -12,6 +13,25 @@ This section describes the functionality of the Dasharo Tools Suite. These are: + [run commands from iPXE shell automatically](#run-commands-from-ipxe-shell-automatically), + [run DTS using VentoyOS](#run-dts-using-ventoyos). +### Available Commands + +When DTS is started, it has following options for the user to choose from: + +- **(1)** Dasharo HCL Report: + + Generate HCL report on the current machine. + Read more: [HCLReport](#hcl-report) + +- **(2)** Update Dasharo Firmware +- **(3)** Restore Firmware from Dasharo HCL Report +- **(4)** Load your DPP keys +- **(R)** Reboot +- **(P)** Poweroff +- **(S)** Enter shell +- **(K)** Launch SSH Server +- **(L)** Enable sending DTS logs +- **(V)** Enable verbose mode + ### Dasharo zero-touch initial deployment DTS can be used to flash Dasharo firmware on your hardware. To achieve this, From 080e27469cda2a0e888ff1a3838fbf23b120f9e2 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Wed, 11 Dec 2024 10:43:01 +0100 Subject: [PATCH 03/15] features.md: Add link to Load your dpp keys command Signed-off-by: Eduard Kaverinskyi --- .../documentation/features.md | 26 +++++++++++-------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index c39822f327..81345f6308 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -17,20 +17,24 @@ This section describes the functionality of the Dasharo Tools Suite. These are: When DTS is started, it has following options for the user to choose from: -- **(1)** Dasharo HCL Report: - +* **(1)** Dasharo HCL Report: + Generate HCL report on the current machine. Read more: [HCLReport](#hcl-report) -- **(2)** Update Dasharo Firmware -- **(3)** Restore Firmware from Dasharo HCL Report -- **(4)** Load your DPP keys -- **(R)** Reboot -- **(P)** Poweroff -- **(S)** Enter shell -- **(K)** Launch SSH Server -- **(L)** Enable sending DTS logs -- **(V)** Enable verbose mode +* **(2)** Update Dasharo Firmware +* **(3)** Restore Firmware from Dasharo HCL Report +* **(4)** Load your DPP keys + + Load your Dasharo Pro Package (DPP) keys. Read mode: + [How can I use my Dasharo Pro Package credentials](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) + +* **(R)** Reboot +* **(P)** Poweroff +* **(S)** Enter shell +* **(K)** Launch SSH Server +* **(L)** Enable sending DTS logs +* **(V)** Enable verbose mode ### Dasharo zero-touch initial deployment From 14a902d5faeb81ab958ef464210a7808e86a7966 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Wed, 11 Dec 2024 10:48:45 +0100 Subject: [PATCH 04/15] dasharo-tools-suite/documentation/: Fix section headers Signed-off-by: Eduard Kaverinskyi --- .../documentation/building.md | 10 +++---- .../documentation/features.md | 28 +++++++++---------- .../documentation/running.md | 14 +++++----- .../documentation/supported-hardware.md | 4 +-- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/building.md b/docs/dasharo-tools-suite/documentation/building.md index 24b4a32d31..e6f77a27c6 100644 --- a/docs/dasharo-tools-suite/documentation/building.md +++ b/docs/dasharo-tools-suite/documentation/building.md @@ -1,4 +1,4 @@ -## Building +# Building We choose [Yocto Project](https://www.yoctoproject.org/) to prepare Dasharo Tools Suite system. DTS image can be built using publicly available sources. @@ -6,7 +6,7 @@ Thanks to publishing the build cache on [cache.dasharo.com](https://cache.dasharo.com/yocto/dts/) the time needed to finish the process should be significantly decreased. -### Prerequisites +## Prerequisites The following must be met to build DTS: @@ -33,7 +33,7 @@ mkdir yocto && cd yocto git clone https://github.com/Dasharo/meta-dts.git ``` -### Build +## Build From `yocto` directory, run: @@ -74,7 +74,7 @@ local_conf_header: PROJECT_NAME ?= "yocto/dts" ``` -#### Build image with UEFI Secure Boot support +### Build image with UEFI Secure Boot support From `yocto` directory run: @@ -104,7 +104,7 @@ can be used but it was not tested yet. Quick start with instructions on how to use image are described in [meta-efi-secure-boot](https://github.com/jiazhang0/meta-secure-core/tree/master/meta-efi-secure-boot#quick-start-for-the-first-boot). -### Flash +## Flash * Find out your device name. diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 81345f6308..7b0f75e1cb 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -1,4 +1,4 @@ -## Features +# Features This section describes the functionality of the Dasharo Tools Suite. These are: @@ -13,7 +13,7 @@ This section describes the functionality of the Dasharo Tools Suite. These are: + [run commands from iPXE shell automatically](#run-commands-from-ipxe-shell-automatically), + [run DTS using VentoyOS](#run-dts-using-ventoyos). -### Available Commands +## Available Commands When DTS is started, it has following options for the user to choose from: @@ -36,7 +36,7 @@ When DTS is started, it has following options for the user to choose from: * **(L)** Enable sending DTS logs * **(V)** Enable verbose mode -### Dasharo zero-touch initial deployment +## Dasharo zero-touch initial deployment DTS can be used to flash Dasharo firmware on your hardware. To achieve this, boot DTS, choose option number `2`. After creating @@ -79,7 +79,7 @@ And partially (only EC firmware flashing) on: * NovaCustom V540TU/TNx, * NovaCustom V560TU/TNx. -### HCL Report +## HCL Report DTS allows the generation of a package with logs containing hardware information. To create one, choose option number 1 and check out the disclaimer. @@ -89,7 +89,7 @@ connecting the ethernet cable. More information can be found in ![](./images/dts-hcl-run.png) -#### HCL Report correctness +### HCL Report correctness Please note DTS HCL Report assumes that your chipset is already supported by flashrom. There are also other false negative errors and unknowns, which we @@ -135,7 +135,7 @@ Legend: Please report all errors experienced while performing a dump to [dasharo-issues](https://github.com/Dasharo/dasharo-issues) repository. -#### BIOS backup +### BIOS backup One of the key components of HCL Report is your BIOS backup. To prepare BIOS backup of your platform, simply run HCL Report and decide if you would like to @@ -157,7 +157,7 @@ Please consider the following options depending on your situation: + **USB Boot** - HCL Report and BIOS backup are saved to USB storage root directory. -### Firmware update +## Firmware update DTS can be used to update Dasharo firmware. To achieve this, boot it on platform with flashed Dasharo and choose option number `2`. You may see additional @@ -274,7 +274,7 @@ Rebooting in 5s: Rebooting ``` -#### Local firmware update +### Local firmware update To flash a local BIOS image (e.g. mounted from a USB stick), you can drop to the shell (option `S`) and use the `flashrom` binary provided inside DTS directly. @@ -301,7 +301,7 @@ New value is 0x8b. SPI Configuration is locked down ``` -#### Update issues +### Update issues If you see the following pop-ups during the first boot after the update: @@ -327,7 +327,7 @@ If you used `flashrom` as described in [Local firmware update](#local-firmware-update), flash the firmware again, but make sure the BIOS lock is turned off this time. -### EC transition +## EC transition DTS allows performing full Embedded Controller firmware transition from the proprietary vendor EC firmware to the Dasharo EC firmware. Currently, this @@ -344,7 +344,7 @@ Starting from DTS v1.2.0 to perform EC transition please run [firmware update](#firmware-update) on the platform with proprietary vendor EC firmware. -### EC update +## EC update !!! note @@ -416,13 +416,13 @@ version. This is how we can achieve that. version: 2022-08-31_cbff21b ``` -### Additional features +## Additional features The section below presents a list of functionalities added to DTS, which were developed at the community's request and which do not necessarily relate strictly to Dasharo. -#### Run commands from iPXE shell automatically +### Run commands from iPXE shell automatically It is possible to automatically execute your chosen commands after iPXE boot. You can use the @@ -483,7 +483,7 @@ different port, for example 9001, then run the script like this: Serving HTTP on 0.0.0.0 port 9000 (http://0.0.0.0:9000/) ... ``` -#### Run DTS using VentoyOS +### Run DTS using VentoyOS VentoyOS allows operating systems to be booted from ISO files. Unfortunately, the ISO-formatted DTS image we've provided so far mounted the main file system diff --git a/docs/dasharo-tools-suite/documentation/running.md b/docs/dasharo-tools-suite/documentation/running.md index 6794b1a495..e68106abb7 100644 --- a/docs/dasharo-tools-suite/documentation/running.md +++ b/docs/dasharo-tools-suite/documentation/running.md @@ -1,4 +1,4 @@ -## Running +# Running The Dasharo Tools Suite can be started in various ways. Currently, there are two options: @@ -9,11 +9,11 @@ two options: The first one should always be preferred if possible, as it is the easiest one to use. -### Bootable over a network +## Bootable over a network This section describes how to boot DTS using iPXE. -#### Requirements +### Requirements Below are the requirements that must be met to run DTS over a network on the platform: @@ -25,7 +25,7 @@ platform: + disabled BIOS lock feature, + disabled SMM BIOS write protection feature. -#### Launching DTS +### Launching DTS To access Dasharo Tools Suite: @@ -50,11 +50,11 @@ To access Dasharo Tools Suite: * the DTS menu will now appear. -### Bootable USB stick +## Bootable USB stick This section describes how to boot DTS using a USB stick. -#### Requirements +### Requirements Below are the requirements that must be met to run DTS from a USB device on the platform: @@ -69,7 +69,7 @@ platform: + disabled BIOS lock feature, + disabled SMM BIOS write protection feature. -#### Launching DTS +### Launching DTS To access Dasharo Tools Suite: diff --git a/docs/dasharo-tools-suite/documentation/supported-hardware.md b/docs/dasharo-tools-suite/documentation/supported-hardware.md index bd9b95a282..a5644e71a5 100644 --- a/docs/dasharo-tools-suite/documentation/supported-hardware.md +++ b/docs/dasharo-tools-suite/documentation/supported-hardware.md @@ -1,4 +1,4 @@ -## Supported hardware +# Supported hardware Dasharo Tools Suite was prepared to run on x86 platforms, but we can confirm that it boots on the following platforms: @@ -14,4 +14,4 @@ that it boots on the following platforms: * NovaCustom V540TU/TND, * NovaCustom V560TU/TND/TNE, * PC Engines apu2/3/4/6. -* ODROID-H4+ \ No newline at end of file +* ODROID-H4+ From 428fd99f23c4d4f735c7581e9c3cb4c0f963cdb3 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Wed, 11 Dec 2024 10:56:46 +0100 Subject: [PATCH 05/15] mkdocs.yml: Fix documentation section indentation Signed-off-by: Eduard Kaverinskyi --- mkdocs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 0085e970f8..6ac69783f5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -438,11 +438,11 @@ nav: - 'Dasharo Tools Suite': - 'Overview': dasharo-tools-suite/overview.md - 'Releases': dasharo-tools-suite/releases.md - - 'Documentation': - - "Supported Hardware": dasharo-tools-suite/documentation/supported-hardware.md - - "Building": dasharo-tools-suite/documentation/building.md - - "Running": dasharo-tools-suite/documentation/running.md - - "Features": dasharo-tools-suite/documentation/features.md + - 'Documentation': + - "Supported Hardware": dasharo-tools-suite/documentation/supported-hardware.md + - "Building": dasharo-tools-suite/documentation/building.md + - "Running": dasharo-tools-suite/documentation/running.md + - "Features": dasharo-tools-suite/documentation/features.md - 'Knowledge base': - 'Glossary': glossary.md - 'Dasharo Product Naming Convention': dasharo-naming-convention.md From 2ef0aeff54bf143afbf55d7ffee0f5e9a638dd5d Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Wed, 11 Dec 2024 13:01:44 +0100 Subject: [PATCH 06/15] Fix mkdocs info's and warnings Signed-off-by: Eduard Kaverinskyi --- docs/dasharo-menu-docs/overview.md | 2 +- .../documentation/features.md | 34 +++++++++---------- .../documentation/running.md | 4 +-- docs/dasharo-tools-suite/overview.md | 6 ++-- docs/index.md | 2 +- docs/osf-trivia-list/dts.md | 2 +- .../dasharo-security/206-secure-boot.md | 5 ++- .../generic-test-setup.md | 4 +-- docs/unified/clevo/post-install.md | 2 +- docs/unified/msi/firmware-update.md | 4 +-- docs/unified/msi/hcl.md | 10 +++--- docs/unified/msi/initial-deployment.md | 2 +- docs/unified/novacustom/firmware-update.md | 8 ++--- docs/unified/novacustom/initial-deployment.md | 4 +-- .../asus_kgpe_d16/initial-deployment.md | 2 +- .../dell_optiplex/initial-deployment.md | 2 +- docs/variants/novacustom_v540tnx/releases.md | 2 +- docs/variants/novacustom_v560tnx/releases.md | 2 +- .../variants/pc_engines/initial-deployment.md | 4 +-- .../supermicro_x11_lga1151_series/recovery.md | 2 +- mkdocs.yml | 2 +- 21 files changed, 53 insertions(+), 52 deletions(-) diff --git a/docs/dasharo-menu-docs/overview.md b/docs/dasharo-menu-docs/overview.md index 6aa748ca9b..139726763b 100644 --- a/docs/dasharo-menu-docs/overview.md +++ b/docs/dasharo-menu-docs/overview.md @@ -129,7 +129,7 @@ possible feature extension of your platform. User Password Management menu allows one to set firmware setup admin password: -![](/images/menus/password_manager.png){ class="center" } +![](../images/menus/password_manager.png){ class="center" } The password requirements are compliant to modern standards. See `Appendix A` at [pages.nist.gov](https://pages.nist.gov/800-63-3/sp800-63b.html). diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 7b0f75e1cb..b1e9ed1d48 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -26,8 +26,8 @@ When DTS is started, it has following options for the user to choose from: * **(3)** Restore Firmware from Dasharo HCL Report * **(4)** Load your DPP keys - Load your Dasharo Pro Package (DPP) keys. Read mode: - [How can I use my Dasharo Pro Package credentials](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) +Load your Dasharo Pro Package (DPP) keys. Read more: +[How can I use my Dasharo Pro Package credentials](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) * **(R)** Reboot * **(P)** Poweroff @@ -40,15 +40,15 @@ When DTS is started, it has following options for the user to choose from: DTS can be used to flash Dasharo firmware on your hardware. To achieve this, boot DTS, choose option number `2`. After creating -[report](../glossary.md#dasharo-hardware-compatibility-list-report) with +[report](../../glossary.md#dasharo-hardware-compatibility-list-report) with firmware dump as backup, type `d` or `c` to confirm the installation of Dasharo firmware. Option `c` stands for community release which is available for anyone using Dasharo Tools Suite, option `d` stands for -[DPP](../ways-you-can-help-us.md#become-a-dasharo-pro-package-subscriber) +[DPP](../../ways-you-can-help-us.md#become-a-dasharo-pro-package-subscriber) release and it is only available to Dasharo Entry Subscription subscribers. If you have DPP subscription then do steps in [How can I use my Dasharo Pro Package credentials]( -../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) +../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) section first. Next you will be asked two questions to confirm flashing. The first will be @@ -85,9 +85,9 @@ DTS allows the generation of a package with logs containing hardware information. To create one, choose option number 1 and check out the disclaimer. 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). +[glossary](../../glossary.md#dasharo-hardware-compatibility-list-report). -![](./images/dts-hcl-run.png) +![](../images/dts-hcl-run.png) ### HCL Report correctness @@ -164,7 +164,7 @@ with flashed Dasharo and choose option number `2`. You may see additional information about available updates if you are not [Dasharo Pro Package](https://docs.dasharo.com/ways-you-can-help-us/#become-a-dasharo-pro-package-subscriber) subscriber. If you have DPP subscription then do steps in [How can I use my Dasharo Pro Package credentials]( -../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) +../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) section first. Next you will be asked two questions to confirm flashing. The first will be @@ -305,8 +305,8 @@ SPI Configuration is locked down If you see the following pop-ups during the first boot after the update: -![error-0x03](./images/error-0x03.png) -![error-0x13](./images/error-0x13.png) +![error-0x03](../images/error-0x03.png) +![error-0x13](../images/error-0x13.png) You probably performed an update using a deprecated version of Dasharo Tools Suite and have not disabled BIOS lock. Do not worry, nothing bad has happened. @@ -314,7 +314,7 @@ If you backed up your old firmware, do the following steps: 1. Reboot your device and turn off BIOS lock (you can find this option in [Dasharo Security -Options](../dasharo-menu-docs/dasharo-system-features.md#dasharo-security-options) +Options](../../dasharo-menu-docs/dasharo-system-features.md#dasharo-security-options) as `BIOS boot medium lock`). 1. Boot the DTS you backed up your old firmware with and choose option 3, which will restore it. @@ -333,12 +333,12 @@ 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: -* [NovaCustom NS5x/NS7x](../variants/novacustom_ns5x_tgl/releases.md), -* [NovaCustom NV4x](../variants/novacustom_nv4x_tgl/releases.md), -* [NovaCustom V540TU](../variants/novacustom_v540tu/releases.md), -* [NovaCustom V540TNx](../variants/novacustom_v540tnx/releases.md), -* [NovaCustom V560TU](../variants/novacustom_v560tu/releases.md) -* [NovaCustom V560TNx](../variants/novacustom_v560tnx/releases.md). +* [NovaCustom NS5x/NS7x](../../variants/novacustom_ns5x_tgl/releases.md), +* [NovaCustom NV4x](../../variants/novacustom_nv4x_tgl/releases.md), +* [NovaCustom V540TU](../../variants/novacustom_v540tu/releases.md), +* [NovaCustom V540TNx](../../variants/novacustom_v540tnx/releases.md), +* [NovaCustom V560TU](../../variants/novacustom_v560tu/releases.md) +* [NovaCustom V560TNx](../../variants/novacustom_v560tnx/releases.md). Starting from DTS v1.2.0 to perform EC transition please run [firmware update](#firmware-update) on the platform with proprietary vendor EC diff --git a/docs/dasharo-tools-suite/documentation/running.md b/docs/dasharo-tools-suite/documentation/running.md index e68106abb7..478061cd39 100644 --- a/docs/dasharo-tools-suite/documentation/running.md +++ b/docs/dasharo-tools-suite/documentation/running.md @@ -20,7 +20,7 @@ platform: * Dasharo device with DTS functionality integrated, * wired network connection, -* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), +* [Secure Boot disabled](../../dasharo-menu-docs/device-manager.md#secure-boot-configuration), * If device if flashed with Dasharo and support following functionality + disabled BIOS lock feature, + disabled SMM BIOS write protection feature. @@ -64,7 +64,7 @@ platform: section. with Dasharo). * Wired network connection, -* [Secure Boot disabled](../dasharo-menu-docs/device-manager.md#secure-boot-configuration), +* [Secure Boot disabled](../../dasharo-menu-docs/device-manager.md#secure-boot-configuration), * If device if flashed with Dasharo and support following functionality + disabled BIOS lock feature, + disabled SMM BIOS write protection feature. diff --git a/docs/dasharo-tools-suite/overview.md b/docs/dasharo-tools-suite/overview.md index 953e1e79fe..910e0c4aad 100644 --- a/docs/dasharo-tools-suite/overview.md +++ b/docs/dasharo-tools-suite/overview.md @@ -15,8 +15,10 @@ the initial deployment, even when no OS is currently installed. latest release and follow the instructions in [Dasharo release signature verification](../guides/signature-verification.md) using [this key](https://raw.githubusercontent.com/3mdeb/3mdeb-secpack/master/dasharo/dasharo_tools_suite/dasharo-tools-suite-open-source-software-release-1.2.x-signing-key-pub.asc) -* [Documentation](documentation.md) - describes DTS functionality and - information on how to run it. +* [Building](documentation/building.md) - describes how to build DTS. +* [Running](documentation/running.md) - describes how to run DTS. +* [Supported Hardware](documentation/running.md) - lists which hardware is supported by DTS. +* [Features](documentation/features.md) - provides more details about DTS features. ## Reporting issues diff --git a/docs/index.md b/docs/index.md index 613afb3658..29a0d37910 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ firmware: - **Seamless Deployment**: Start your journey with Dasharo effortlessly. [Learn how - →](dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) + →](dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) - **Clean & Simple Code**: Our code is readable and maintainable, designed with developers in mind. [Explore our GitHub →](https://github.com/dasharo) - **Long-term Maintenance**: We are committed to supporting Dasharo for years diff --git a/docs/osf-trivia-list/dts.md b/docs/osf-trivia-list/dts.md index 735ae35eb0..99f60a9e99 100644 --- a/docs/osf-trivia-list/dts.md +++ b/docs/osf-trivia-list/dts.md @@ -26,7 +26,7 @@ with keys to use with [Dasharo Tools Suite](../dasharo-tools-suite/overview.md). This section describes how to do it. * Firstly, run DTS from a USB flash drive, documentation on this is included - [here](../dasharo-tools-suite/documentation.md#bootable-usb-stick). + [here](../dasharo-tools-suite/documentation/running.md#bootable-usb-stick). * After booting, you will see a text menu, choose option number 4, `Load your DPP keys`, by pressing `4` and `Enter`. diff --git a/docs/unified-test-documentation/dasharo-security/206-secure-boot.md b/docs/unified-test-documentation/dasharo-security/206-secure-boot.md index 604c7f6535..642062a7b7 100644 --- a/docs/unified-test-documentation/dasharo-security/206-secure-boot.md +++ b/docs/unified-test-documentation/dasharo-security/206-secure-boot.md @@ -1186,7 +1186,7 @@ on DUT. 1. Proceed with the [Generic test setup: OS installation](../generic-test-setup.md#os-installation). 1. Proceed with the [DTS: Build image with UEFI Secure Boot - support](../../dasharo-tools-suite/documentation.md#build-image-with-uefi-secure-boot-support). + support](../../dasharo-tools-suite/documentation/building.md#build-image-with-uefi-secure-boot-support). **Test steps** @@ -1249,8 +1249,7 @@ automatic certificate provisioning is attached and can be booted on DUT. [Generic test setup: OS installer](../generic-test-setup.md#os-installer). 1. Proceed with the [Generic test setup: OS installation](../generic-test-setup.md#os-installation). -1. Proceed with the [DTS: Build image with UEFI Secure Boot - support](../../dasharo-tools-suite/documentation.md#build-image-with-uefi-secure-boot-support). +1. Proceed with the [DTS: Build image with UEFI Secure Boot support](../../dasharo-tools-suite/documentation/building.md#build-image-with-uefi-secure-boot-support). **Test steps** diff --git a/docs/unified-test-documentation/generic-test-setup.md b/docs/unified-test-documentation/generic-test-setup.md index 9a3bd6fd13..13a8873fdd 100644 --- a/docs/unified-test-documentation/generic-test-setup.md +++ b/docs/unified-test-documentation/generic-test-setup.md @@ -14,7 +14,7 @@ need to execute the setup actions before each independent case. 1. you can download it from `Releases` page dedicated for your platform 1. or you can build one yourself as shown in the `Building manual` page dedicated for platform which is used by you. -1. Flash `FIRMWARE` binary to the DUT according to the instructions in [docs.dasharo](../../docs/variants/overview.md) +1. Flash `FIRMWARE` binary to the DUT according to the instructions in [docs.dasharo](../variants/overview.md) for your device. 1. If the device already has Dasharo, see the `Firmware update` page 1. If the device has a different firmware installed, see the @@ -183,7 +183,7 @@ sudo apt install nvidia-driver-560 1. Select `NVIDIA On-demand` and apply. 1. Enter the `OPERATING_SYSTEM` password when prompted. -![](/images/nv4x_nvidia_panel.jpg){ class="center" } +![](../images/nv4x_nvidia_panel.jpg){ class="center" } #### Post installation diff --git a/docs/unified/clevo/post-install.md b/docs/unified/clevo/post-install.md index 6013ea1ade..dc36c253d9 100644 --- a/docs/unified/clevo/post-install.md +++ b/docs/unified/clevo/post-install.md @@ -80,7 +80,7 @@ install additional Nvidia drivers. 1. (Optional) For power saving while the card is not in use, enable On-Demand mode in NVIDIA Control Panel: -![](/images/nv4x_nvidia_panel.jpg){ class="center" } +![](../../images/nv4x_nvidia_panel.jpg){ class="center" } 1. If for some reason dynamic power management for the GPU is not working (causing high power draw, poor sleep time or high temperatures), you may diff --git a/docs/unified/msi/firmware-update.md b/docs/unified/msi/firmware-update.md index ec31d6e743..0720dee1e8 100644 --- a/docs/unified/msi/firmware-update.md +++ b/docs/unified/msi/firmware-update.md @@ -51,9 +51,9 @@ Alternatively, it can be checked in the `BIOS Setup Menu`. The DTS allows performing automatic firmware update process, which is the recommended method. To update your firmware, follow below steps. - 1. Boot [DTS using iPXE](../../dasharo-tools-suite/documentation.md#bootable-over-a-network) + 1. Boot [DTS using iPXE](../../dasharo-tools-suite/documentation/running.md#bootable-over-a-network) on your platform. - 2. Follow [firmware update](../../dasharo-tools-suite/documentation.md#firmware-update) + 2. Follow [firmware update](../../dasharo-tools-suite/documentation/features.md#firmware-update) procedure described in DTS documentation. ### Linux distribution of your choice diff --git a/docs/unified/msi/hcl.md b/docs/unified/msi/hcl.md index 99cba4ce10..872e5837ab 100644 --- a/docs/unified/msi/hcl.md +++ b/docs/unified/msi/hcl.md @@ -29,7 +29,7 @@ hardware. * Source: - Link to report if it is public. - `Dasharo HCL report` if it was [reported using - DTS](../../dasharo-tools-suite/documentation.md#hcl-report). + DTS](../../dasharo-tools-suite/documentation/features.md#hcl-report).
@@ -293,7 +293,7 @@ Maintainer documentation](../../dev-proc/hcl-maintainer.md). ## Contributing === "PRO Z690-A (WIFI) DDR4" - - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation.md#hcl-report) + - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation/features.md#hcl-report) to upload report automatically. - Create new issue in [Dasharo issues repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z690). - Create PR directly to [Dasharo documentation repository](https://github.com/Dasharo/docs). @@ -320,7 +320,7 @@ Maintainer documentation](../../dev-proc/hcl-maintainer.md). ``` === "PRO Z690-A (WIFI)" - - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation.md#hcl-report) + - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation/features.md#hcl-report) to upload report automatically. - Create new issue in [Dasharo issues repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z690). - Create PR directly to [Dasharo documentation repository](https://github.com/Dasharo/docs). @@ -347,7 +347,7 @@ Maintainer documentation](../../dev-proc/hcl-maintainer.md). ``` === "PRO Z790-P (WIFI) DDR4" - - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation.md#hcl-report) + - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation/features.md#hcl-report) to upload report automatically. - Create new issue in [Dasharo issues repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z790). - Create PR directly to [Dasharo documentation repository](https://github.com/Dasharo/docs). @@ -374,7 +374,7 @@ Maintainer documentation](../../dev-proc/hcl-maintainer.md). ``` === "PRO Z790-P (WIFI)" - - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation.md#hcl-report) + - Use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation/features.md#hcl-report) to upload report automatically. - Create new issue in [Dasharo issues repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z790). - Create PR directly to [Dasharo documentation repository](https://github.com/Dasharo/docs). diff --git a/docs/unified/msi/initial-deployment.md b/docs/unified/msi/initial-deployment.md index 9c72acd87d..3651d1f936 100644 --- a/docs/unified/msi/initial-deployment.md +++ b/docs/unified/msi/initial-deployment.md @@ -12,7 +12,7 @@ To ensure a smooth deployment process, it is recommended to use the latest version of DTS available from the [releases page](../../dasharo-tools-suite/releases.md). Once you have obtained it, you can then proceed with following the [Dasharo zero-touch initial deployment -section](../../dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) +section](../../dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) procedure. This will help you set up Dasharo effectively and without manual intervention. diff --git a/docs/unified/novacustom/firmware-update.md b/docs/unified/novacustom/firmware-update.md index ba5145810c..40248a1013 100644 --- a/docs/unified/novacustom/firmware-update.md +++ b/docs/unified/novacustom/firmware-update.md @@ -32,10 +32,10 @@ using the ++f2++ key while booting. ### Updating older versions - 1. First, ensure that [UEFI Secure Boot](../../dasharo-tools-suite/documentation.md#disabling-secure-boot) + 1. First, ensure that [UEFI Secure Boot](../../dasharo-tools-suite/documentation/features.md#disabling-secure-boot) has been disabled. - 1. Boot to the [Dasharo Tools Suite](../../dasharo-tools-suite/documentation.md#bootable-over-a-network). + 1. Boot to the [Dasharo Tools Suite](../../dasharo-tools-suite/documentation/running.md#bootable-over-a-network). We recommend the network boot option. 1. In the main menu of Dasharo Tools Suite, select option `5` to proceed with @@ -43,7 +43,7 @@ using the ++f2++ key while booting. 1. In case you want to know more about the firmware update option in Dasharo Tools Suite, please check out the - [features section](../../dasharo-tools-suite/documentation.md#firmware-update) + [features section](../../dasharo-tools-suite/documentation/features.md#firmware-update) of the dedicated Dasharo Tools Suite documentation page. ### Manual update @@ -64,7 +64,7 @@ using the ++f2++ key while booting. models. You can skip these steps if you are using an older firmware version. Follow the manual update procedure described in the [DTS firmware update - documentation](../../dasharo-tools-suite/documentation.md#local-firmware-update). + documentation](../../dasharo-tools-suite/documentation/features.md#local-firmware-update). > Please make sure you that you update the BIOS firmware and the EC firmware > respectively, as the laptop will power off after the EC firmware flash. diff --git a/docs/unified/novacustom/initial-deployment.md b/docs/unified/novacustom/initial-deployment.md index b7853f063d..b65ba67449 100644 --- a/docs/unified/novacustom/initial-deployment.md +++ b/docs/unified/novacustom/initial-deployment.md @@ -54,7 +54,7 @@ devices. Steps for installing Dasharo Embedded Controller Firmware: 1. On the target laptop, - [boot into Dasharo Tools Suite from a USB stick](../../dasharo-tools-suite/documentation.md#bootable-usb-stick) + [boot into Dasharo Tools Suite from a USB stick](../../dasharo-tools-suite/documentation/running.md#bootable-usb-stick) 1. Ensure power adapter is plugged into the laptop @@ -223,7 +223,7 @@ devices. version of DTS available from the [releases page](../../dasharo-tools-suite/releases.md). Once you have obtained it, you can then proceed with following the [Dasharo zero-touch initial deployment - section](../../dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) + section](../../dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) procedure. This will help you set up Dasharo effectively and without manual intervention. diff --git a/docs/variants/asus_kgpe_d16/initial-deployment.md b/docs/variants/asus_kgpe_d16/initial-deployment.md index fdb1046bc6..fa503a94c7 100644 --- a/docs/variants/asus_kgpe_d16/initial-deployment.md +++ b/docs/variants/asus_kgpe_d16/initial-deployment.md @@ -11,7 +11,7 @@ To ensure a smooth deployment process, it is recommended to use the latest version of DTS available from the [releases page](../../dasharo-tools-suite/releases.md). Once you have obtained it, you can then proceed with following the [Dasharo zero-touch initial deployment -section](../../dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) +section](../../dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) procedure. This will help you set up Dasharo effectively and without manual intervention. diff --git a/docs/variants/dell_optiplex/initial-deployment.md b/docs/variants/dell_optiplex/initial-deployment.md index 80dbdf6d2d..e47d531e0d 100644 --- a/docs/variants/dell_optiplex/initial-deployment.md +++ b/docs/variants/dell_optiplex/initial-deployment.md @@ -74,7 +74,7 @@ To ensure a smooth deployment process, it is recommended to use the latest version of DTS available from the [releases page](../../dasharo-tools-suite/releases.md). Once you have obtained it, you can then proceed with following the [Dasharo zero-touch initial deployment -section](../../dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) +section](../../dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) procedure. This will help you set up Dasharo effectively and without manual intervention. However, if you wish to flash firmware you have built yourself, you will need take an alternate route and go through firmware preparation. diff --git a/docs/variants/novacustom_v540tnx/releases.md b/docs/variants/novacustom_v540tnx/releases.md index b9743d9292..8b1d7f1e06 100644 --- a/docs/variants/novacustom_v540tnx/releases.md +++ b/docs/variants/novacustom_v540tnx/releases.md @@ -74,7 +74,7 @@ Test results for this release can be found [sha256.sig][novacustom_v54x_mtl_v0.9.1_dev_signed.rom_sig]{.md-button} To verify binary integrity with hash and signature please follow the -instructions in [Dasharo release signature verification](/guides/signature-verification) +instructions in [Dasharo release signature verification](../../guides/signature-verification.md) using [this key](https://raw.githubusercontent.com/3mdeb/3mdeb-secpack/master/customer-keys/novacustom/dasharo-release-0.9.x-for-novacustom-signing-key.asc) ### SBOM (Software Bill of Materials) diff --git a/docs/variants/novacustom_v560tnx/releases.md b/docs/variants/novacustom_v560tnx/releases.md index 1915a2b59b..dadd77e322 100644 --- a/docs/variants/novacustom_v560tnx/releases.md +++ b/docs/variants/novacustom_v560tnx/releases.md @@ -74,7 +74,7 @@ Test results for this release can be found [sha256.sig][novacustom_v56x_mtl_v0.9.1_dev_signed.rom_sig]{.md-button} To verify binary integrity with hash and signature please follow the -instructions in [Dasharo release signature verification](/guides/signature-verification) +instructions in [Dasharo release signature verification](../../guides/signature-verification.md) using [this key](https://raw.githubusercontent.com/3mdeb/3mdeb-secpack/master/customer-keys/novacustom/dasharo-release-0.9.x-for-novacustom-signing-key.asc) ### SBOM (Software Bill of Materials) diff --git a/docs/variants/pc_engines/initial-deployment.md b/docs/variants/pc_engines/initial-deployment.md index 83a9db1290..9f41337572 100644 --- a/docs/variants/pc_engines/initial-deployment.md +++ b/docs/variants/pc_engines/initial-deployment.md @@ -27,7 +27,7 @@ with the internal programmer. ## Deploy using Dasharo Tools Suite For simplicity we recommend using [Dasharo Tools -Suite](../../dasharo-tools-suite/documentation.md#dasharo-zero-touch-initial-deployment) +Suite](../../dasharo-tools-suite/documentation/features.md#dasharo-zero-touch-initial-deployment) to omit all manual compilation and flashing steps, and deploy Dasharo seamlessly. @@ -60,7 +60,7 @@ install it from the OS' package manager (minimum supported version is v1.0). Always prepare a backup of the current firmware image. If you are using DTS, the backup will be made automatically with [HCL -report](../../dasharo-tools-suite/documentation.md#hcl-report). When deploying +report](../../dasharo-tools-suite/documentation/features.md#hcl-report). When deploying manually, to read from the flash and save it to a file (`dump.rom`), execute the following command: diff --git a/docs/variants/supermicro_x11_lga1151_series/recovery.md b/docs/variants/supermicro_x11_lga1151_series/recovery.md index 96b4948b69..7bc6d75c40 100644 --- a/docs/variants/supermicro_x11_lga1151_series/recovery.md +++ b/docs/variants/supermicro_x11_lga1151_series/recovery.md @@ -44,7 +44,7 @@ Supermicro proprietary closed source tools: * [Supermicro Update Manager](https://www.supermicro.com/en/solutions/management-software/supermicro-update-manager) please download and unpack archive. -* [Backup](../../dasharo-tools-suite/documentation.md#bios-backup) or +* [Backup](../../dasharo-tools-suite/documentation/features.md#bios-backup) or [Supermicro BIOS update](https://www.supermicro.com/en/support/resources/downloadcenter/firmware/MBD-X11SSH-TF/BIOS) please download and unpack archive. diff --git a/mkdocs.yml b/mkdocs.yml index 6ac69783f5..aaae8951fa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -105,7 +105,7 @@ plugins: - redirects: redirect_maps: 'common-coreboot-docs/dasharo_tools_suite.md': 'dasharo-tools-suite/overview.md' - 'variants/clevo_nv41/ec_update.md': 'dasharo-tools-suite/documentation.md' + 'variants/clevo_nv41/ec_update.md': 'dasharo-tools-suite/documentation/features.md' 'unified/novacustom/fan-profiles.md': 'unified/novacustom/features.md' 'unified/novacustom/fn-lock-hotkey.md': 'unified/novacustom/features.md' 'unified/novacustom/rgb-keyboard.md': 'unified/novacustom/features.md' From 1abf710581f2ade76d1ea00f0357389f46e857eb Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Wed, 11 Dec 2024 13:49:03 +0100 Subject: [PATCH 07/15] dasharo-tools-suite/overview.md: fix line length for line 20 Signed-off-by: Eduard Kaverinskyi --- docs/dasharo-tools-suite/overview.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/dasharo-tools-suite/overview.md b/docs/dasharo-tools-suite/overview.md index 910e0c4aad..8fb4ef5f4e 100644 --- a/docs/dasharo-tools-suite/overview.md +++ b/docs/dasharo-tools-suite/overview.md @@ -17,7 +17,8 @@ the initial deployment, even when no OS is currently installed. * [Building](documentation/building.md) - describes how to build DTS. * [Running](documentation/running.md) - describes how to run DTS. -* [Supported Hardware](documentation/running.md) - lists which hardware is supported by DTS. +* [Supported Hardware](documentation/running.md) - lists which hardware is + supported by DTS. * [Features](documentation/features.md) - provides more details about DTS features. ## Reporting issues From b1aad39b098dd1ec2fef3c24e3375b11fc4d4dd8 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 13:35:42 +0100 Subject: [PATCH 08/15] features.md: Remove parenthesis for available commands list Signed-off-by: Eduard Kaverinskyi --- .../documentation/features.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index b1e9ed1d48..daee68c63f 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -17,24 +17,24 @@ This section describes the functionality of the Dasharo Tools Suite. These are: When DTS is started, it has following options for the user to choose from: -* **(1)** Dasharo HCL Report: +* **1** Dasharo HCL Report: Generate HCL report on the current machine. Read more: [HCLReport](#hcl-report) -* **(2)** Update Dasharo Firmware -* **(3)** Restore Firmware from Dasharo HCL Report -* **(4)** Load your DPP keys +* **2** Update Dasharo Firmware +* **3** Restore Firmware from Dasharo HCL Report +* **4** Load your DPP keys Load your Dasharo Pro Package (DPP) keys. Read more: [How can I use my Dasharo Pro Package credentials](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) -* **(R)** Reboot -* **(P)** Poweroff -* **(S)** Enter shell -* **(K)** Launch SSH Server -* **(L)** Enable sending DTS logs -* **(V)** Enable verbose mode +* **R** Reboot +* **P** Poweroff +* **S** Enter shell +* **K** Launch SSH Server +* **L** Enable sending DTS logs +* **V** Enable verbose mode ## Dasharo zero-touch initial deployment From 81952e54ee578262f5e625211f7dbfa22e1fdfdf Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 13:36:49 +0100 Subject: [PATCH 09/15] dasharo-tools-suite/documentation/running.md: Remove copy/paste typo Signed-off-by: Eduard Kaverinskyi --- docs/dasharo-tools-suite/documentation/running.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/dasharo-tools-suite/documentation/running.md b/docs/dasharo-tools-suite/documentation/running.md index 478061cd39..7cf66fd44a 100644 --- a/docs/dasharo-tools-suite/documentation/running.md +++ b/docs/dasharo-tools-suite/documentation/running.md @@ -62,7 +62,6 @@ platform: * USB stick (at least 2GB), * Latest image from [releases](https://github.com/Dasharo/meta-dts/releases) section. - with Dasharo). * Wired network connection, * [Secure Boot disabled](../../dasharo-menu-docs/device-manager.md#secure-boot-configuration), * If device if flashed with Dasharo and support following functionality From b133540c400db01df4c8bcaf581f2103c23cd870 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 13:46:01 +0100 Subject: [PATCH 10/15] dasharo-tools-suite/documentation/features.md: reformat available commands list Signed-off-by: Eduard Kaverinskyi --- .../documentation/features.md | 26 +++++++++---------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index daee68c63f..5876af4c7d 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -17,24 +17,22 @@ This section describes the functionality of the Dasharo Tools Suite. These are: When DTS is started, it has following options for the user to choose from: -* **1** Dasharo HCL Report: - - Generate HCL report on the current machine. - Read more: [HCLReport](#hcl-report) - -* **2** Update Dasharo Firmware -* **3** Restore Firmware from Dasharo HCL Report -* **4** Load your DPP keys - -Load your Dasharo Pro Package (DPP) keys. Read more: -[How can I use my Dasharo Pro Package credentials](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) - +* **1)** [Dasharo HCL Report](#hcl-report) - generate Hardware + Compatibility List Report +* **2)** [Update Dasharo Firmware](#firmware-update) or [Install Dasharo + Firmware](#dasharo-zero-touch-initial-deployment) +* **3)** [Restore Firmware from Dasharo HCL Report](#update-issues) +* **4)** [Load your DPP + keys](../../osf-trivia-list/dts.md#how-can-i-use-my-dasharo-pro-package-credentials) + \- Load your Dasharo Pro Package (DPP) keys * **R** Reboot * **P** Poweroff * **S** Enter shell * **K** Launch SSH Server -* **L** Enable sending DTS logs -* **V** Enable verbose mode +* **L** [Enable sending DTS + logs](../../osf-trivia-list/dts.md#how-can-i-help-the-support-team-diagnose-my-problem-faster) +* **V** [Enable verbose + mode](../../osf-trivia-list/dts.md#how-can-i-help-the-support-team-diagnose-my-problem-faster) ## Dasharo zero-touch initial deployment From 0c85951587e5d0c33c45b216d33a3608cc0dbea4 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 13:54:33 +0100 Subject: [PATCH 11/15] dasharo-tools-suite/documentation/features.md: fix indent for EC Update Signed-off-by: Eduard Kaverinskyi --- .../documentation/features.md | 86 +++++++++---------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 5876af4c7d..82d4d5e1cd 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -354,65 +354,65 @@ version. This is how we can achieve that. * Retrieve information about your current EC. - ```bash - dasharo_ectool info - ``` +```bash +dasharo_ectool info +``` - The output of the above-described command should contain information about - the version of flashed firmware: +The output of the above-described command should contain information about +the version of flashed firmware: - ```bash - board: clevo/ns50mu - version: 2022-08-16_c12ff1a - ``` +```bash +board: clevo/ns50mu +version: 2022-08-16_c12ff1a +``` * Download the newest version of Embedded Controller firmware. * Plug in power supply, without it, flashing EC is not possible as losing power may cause in damaged firmware. * Flash Embedded Controller firmware internally. - ```bash - dasharo_ectool flash ec_file.rom - ``` - - The output of the above-described command should look as follows: - - ```bash - file board: Ok("clevo/ns50mu") - file version: Ok("2022-08-16_c12ff1a") - ec board: Ok("clevo/ns50mu") - ec version: Ok("2022-08-31_cbff21b") - Waiting 5 seconds for all keys to be released - Sync - SPI Read 128K - Saving ROM to backup.rom - SPI Write 128K - SPI Read 128K - Successfully programmed SPI ROM - Result: Ok(()) - Sync - System will shut off in 5 seconds - Sync - ``` - - > Note: this is example output, versions may differ +```bash +dasharo_ectool flash ec_file.rom +``` + +The output of the above-described command should look as follows: + +```bash +file board: Ok("clevo/ns50mu") +file version: Ok("2022-08-16_c12ff1a") +ec board: Ok("clevo/ns50mu") +ec version: Ok("2022-08-31_cbff21b") +Waiting 5 seconds for all keys to be released +Sync +SPI Read 128K +Saving ROM to backup.rom +SPI Write 128K +SPI Read 128K +Successfully programmed SPI ROM +Result: Ok(()) +Sync +System will shut off in 5 seconds +Sync +``` + +> Note: this is example output, versions may differ * Computer will shut down automatically. * Power on your computer. Booting process may take a while. * After boot, choose option `S` to drop to Shell. * Retrieve information about your updated EC. - ```bash - dasharo_ectool info - ``` +```bash +dasharo_ectool info +``` - The output of the above-described command should contain information about - the version of flashed firmware: +The output of the above-described command should contain information about +the version of flashed firmware: - ```bash - board: clevo/ns50mu - version: 2022-08-31_cbff21b - ``` +```bash +board: clevo/ns50mu +version: 2022-08-31_cbff21b +``` ## Additional features From 4764734f0e55d922f3dddcec5de196139a304470 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 14:18:15 +0100 Subject: [PATCH 12/15] Revert "dasharo-tools-suite/documentation/features.md: fix indent for EC Update" This reverts commit 0c85951587e5d0c33c45b216d33a3608cc0dbea4. --- .../documentation/features.md | 86 +++++++++---------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 82d4d5e1cd..5876af4c7d 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -354,65 +354,65 @@ version. This is how we can achieve that. * Retrieve information about your current EC. -```bash -dasharo_ectool info -``` + ```bash + dasharo_ectool info + ``` -The output of the above-described command should contain information about -the version of flashed firmware: + The output of the above-described command should contain information about + the version of flashed firmware: -```bash -board: clevo/ns50mu -version: 2022-08-16_c12ff1a -``` + ```bash + board: clevo/ns50mu + version: 2022-08-16_c12ff1a + ``` * Download the newest version of Embedded Controller firmware. * Plug in power supply, without it, flashing EC is not possible as losing power may cause in damaged firmware. * Flash Embedded Controller firmware internally. -```bash -dasharo_ectool flash ec_file.rom -``` - -The output of the above-described command should look as follows: - -```bash -file board: Ok("clevo/ns50mu") -file version: Ok("2022-08-16_c12ff1a") -ec board: Ok("clevo/ns50mu") -ec version: Ok("2022-08-31_cbff21b") -Waiting 5 seconds for all keys to be released -Sync -SPI Read 128K -Saving ROM to backup.rom -SPI Write 128K -SPI Read 128K -Successfully programmed SPI ROM -Result: Ok(()) -Sync -System will shut off in 5 seconds -Sync -``` - -> Note: this is example output, versions may differ + ```bash + dasharo_ectool flash ec_file.rom + ``` + + The output of the above-described command should look as follows: + + ```bash + file board: Ok("clevo/ns50mu") + file version: Ok("2022-08-16_c12ff1a") + ec board: Ok("clevo/ns50mu") + ec version: Ok("2022-08-31_cbff21b") + Waiting 5 seconds for all keys to be released + Sync + SPI Read 128K + Saving ROM to backup.rom + SPI Write 128K + SPI Read 128K + Successfully programmed SPI ROM + Result: Ok(()) + Sync + System will shut off in 5 seconds + Sync + ``` + + > Note: this is example output, versions may differ * Computer will shut down automatically. * Power on your computer. Booting process may take a while. * After boot, choose option `S` to drop to Shell. * Retrieve information about your updated EC. -```bash -dasharo_ectool info -``` + ```bash + dasharo_ectool info + ``` -The output of the above-described command should contain information about -the version of flashed firmware: + The output of the above-described command should contain information about + the version of flashed firmware: -```bash -board: clevo/ns50mu -version: 2022-08-31_cbff21b -``` + ```bash + board: clevo/ns50mu + version: 2022-08-31_cbff21b + ``` ## Additional features From 90f9fd4c503a04a984a9016614ed7cef2c6c505a Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 14:24:18 +0100 Subject: [PATCH 13/15] dasharo-tools-suite/documentation/features.md: add indent for EC Update Signed-off-by: Eduard Kaverinskyi --- .../documentation/features.md | 82 +++++++++---------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index 5876af4c7d..b767a12dd4 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -354,46 +354,46 @@ version. This is how we can achieve that. * Retrieve information about your current EC. - ```bash - dasharo_ectool info - ``` + ```bash + dasharo_ectool info + ``` - The output of the above-described command should contain information about - the version of flashed firmware: + The output of the above-described command should contain information about + the version of flashed firmware: - ```bash - board: clevo/ns50mu - version: 2022-08-16_c12ff1a - ``` + ```bash + board: clevo/ns50mu + version: 2022-08-16_c12ff1a + ``` * Download the newest version of Embedded Controller firmware. * Plug in power supply, without it, flashing EC is not possible as losing power may cause in damaged firmware. * Flash Embedded Controller firmware internally. - ```bash - dasharo_ectool flash ec_file.rom - ``` - - The output of the above-described command should look as follows: - - ```bash - file board: Ok("clevo/ns50mu") - file version: Ok("2022-08-16_c12ff1a") - ec board: Ok("clevo/ns50mu") - ec version: Ok("2022-08-31_cbff21b") - Waiting 5 seconds for all keys to be released - Sync - SPI Read 128K - Saving ROM to backup.rom - SPI Write 128K - SPI Read 128K - Successfully programmed SPI ROM - Result: Ok(()) - Sync - System will shut off in 5 seconds - Sync - ``` + ```bash + dasharo_ectool flash ec_file.rom + ``` + + The output of the above-described command should look as follows: + + ```bash + file board: Ok("clevo/ns50mu") + file version: Ok("2022-08-16_c12ff1a") + ec board: Ok("clevo/ns50mu") + ec version: Ok("2022-08-31_cbff21b") + Waiting 5 seconds for all keys to be released + Sync + SPI Read 128K + Saving ROM to backup.rom + SPI Write 128K + SPI Read 128K + Successfully programmed SPI ROM + Result: Ok(()) + Sync + System will shut off in 5 seconds + Sync + ``` > Note: this is example output, versions may differ @@ -402,17 +402,17 @@ version. This is how we can achieve that. * After boot, choose option `S` to drop to Shell. * Retrieve information about your updated EC. - ```bash - dasharo_ectool info - ``` + ```bash + dasharo_ectool info + ``` - The output of the above-described command should contain information about - the version of flashed firmware: + The output of the above-described command should contain information about + the version of flashed firmware: - ```bash - board: clevo/ns50mu - version: 2022-08-31_cbff21b - ``` + ```bash + board: clevo/ns50mu + version: 2022-08-31_cbff21b + ``` ## Additional features From 499b1cf0d4e7b3b7150e604595cac99bd60d4000 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 15:57:31 +0100 Subject: [PATCH 14/15] dasharo-tools-suite/documentation/: move EC transition supported hardware list Signed-off-by: Eduard Kaverinskyi --- docs/dasharo-tools-suite/documentation/features.md | 10 ++-------- .../documentation/supported-hardware.md | 12 ++++++++++++ 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/dasharo-tools-suite/documentation/features.md b/docs/dasharo-tools-suite/documentation/features.md index b767a12dd4..658522b66b 100644 --- a/docs/dasharo-tools-suite/documentation/features.md +++ b/docs/dasharo-tools-suite/documentation/features.md @@ -329,14 +329,8 @@ 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: - -* [NovaCustom NS5x/NS7x](../../variants/novacustom_ns5x_tgl/releases.md), -* [NovaCustom NV4x](../../variants/novacustom_nv4x_tgl/releases.md), -* [NovaCustom V540TU](../../variants/novacustom_v540tu/releases.md), -* [NovaCustom V540TNx](../../variants/novacustom_v540tnx/releases.md), -* [NovaCustom V560TU](../../variants/novacustom_v560tu/releases.md) -* [NovaCustom V560TNx](../../variants/novacustom_v560tnx/releases.md). +functionality is supported on [this +hardware](./supported-hardware.md#supported-hardware-for-firmware-transition-to-dasharo) Starting from DTS v1.2.0 to perform EC transition please run [firmware update](#firmware-update) on the platform with proprietary vendor EC diff --git a/docs/dasharo-tools-suite/documentation/supported-hardware.md b/docs/dasharo-tools-suite/documentation/supported-hardware.md index a5644e71a5..8f1595cd91 100644 --- a/docs/dasharo-tools-suite/documentation/supported-hardware.md +++ b/docs/dasharo-tools-suite/documentation/supported-hardware.md @@ -15,3 +15,15 @@ that it boots on the following platforms: * NovaCustom V560TU/TND/TNE, * PC Engines apu2/3/4/6. * ODROID-H4+ + +## Supported hardware for firmware transition to Dasharo + +DTS allows performing full Embedded Controller firmware transition from the +proprietary vendor EC firmware to the Dasharo EC firmware on this hardware: + +* [NovaCustom NS5x/NS7x](../../variants/novacustom_ns5x_tgl/releases.md) +* [NovaCustom NV4x](../../variants/novacustom_nv4x_tgl/releases.md) +* [NovaCustom V540TU](../../variants/novacustom_v540tu/releases.md) +* [NovaCustom V540TNx](../../variants/novacustom_v540tnx/releases.md) +* [NovaCustom V560TU](../../variants/novacustom_v560tu/releases.md) +* [NovaCustom V560TNx](../../variants/novacustom_v560tnx/releases.md) From db9a619e36317c3f4930693677637f379eb21105 Mon Sep 17 00:00:00 2001 From: Eduard Kaverinskyi Date: Thu, 12 Dec 2024 15:58:17 +0100 Subject: [PATCH 15/15] dasharo-tools-suite/documentation/supported-hardware.md: remove ASUS KGPE-D16 Signed-off-by: Eduard Kaverinskyi --- docs/dasharo-tools-suite/documentation/supported-hardware.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/dasharo-tools-suite/documentation/supported-hardware.md b/docs/dasharo-tools-suite/documentation/supported-hardware.md index 8f1595cd91..31660c4c36 100644 --- a/docs/dasharo-tools-suite/documentation/supported-hardware.md +++ b/docs/dasharo-tools-suite/documentation/supported-hardware.md @@ -3,7 +3,6 @@ Dasharo Tools Suite was prepared to run on x86 platforms, but we can confirm that it boots on the following platforms: -* ASUS KGPE-D16, * Dell OptiPlex 7010/9010, * MSI PRO Z690-A DDR4, * MSI PRO Z690-A DDR5,