docs/variants/msi_z690/installation-manual.md: add installation manual

Signed-off-by: Michał Żygowski <michal.zygowski@3mdeb.com>
2026-03-06 14:46:22 -08:00 · 2022-04-13 13:24:44 +02:00
parent 79de950c17
commit 54b60cc823
2 changed files with 75 additions and 0 deletions
@@ -0,0 +1,73 @@
+# Dasharo compatible with MSI PRO Z690-A WIFI DDR4 - installation manual
+
+Flashing coreboot can be done from Linux using flashrom with the internal
+programmer. This document describes the process of building, installing and
+running flashrom on Ubuntu 21.04.
+
+## Build flashrom
+
+Currently, the latest flashrom release lacks support for Alder Lake S internal
+flashing. Because of this, we need to build flashrom from source of 3mdeb fork.
+The procedure is based on [Ubuntu 21.04 desktop amd64 ISO](http://www.releases.ubuntu.com/21.04/ubuntu-21.04-desktop-amd64.iso)
+burned on the USB stick.
+
+Boot the Ubuntu live image and select `Try ubuntu` option. Open a terminal and
+proceed with commands below.
+
+Install build dependencies:
+
+```bash
+sudo apt-get install git build-essential pkg-config libpci-dev udev
+```
+
+Obtain source code:
+
+```bash
+$ git clone https://github.com/3mdeb/flashrom.git -b alder_lake_s
+$ cd flashrom
+```
+
+Build and install flashrom:
+
+```bash
+$ sudo make install
+```
+
+## Flashing
+
+All flash operations require UEFI Secure Boot to be disabled. You may download
+the binary using scp or wget command. The binaries can be found on
+[release page](releases.md).
+
+### Reading flash contents
+
+Always prepare a backup of the current firmware image. To read from the flash
+and save them to a file (`dump.rom`), execute the following command:
+
+```bash
+sudo flashrom -p internal -r dump.rom
+```
+
+### Flashing Dasharo
+
+To flash Dasharo on the platform, execute the following command - replace `[path]`
+with the path to the Dasharo image you want to flash, e.g. `msi_ms7d25_v0.1.0.rom`.
+
+```bash
+sudo flashrom -p internal -w msi_ms7d25_v0.1.0.rom --ifd -i bios
+```
+
+After the command succeeds, invoke `poweroff` or click the power off in the GUI
+to shutdown the board. Press `ENTER` when prompted on the screen. Power on the
+board back. Reboot will not work as some memory settings are preserved after
+reboot and FSP fails to train the memory. Poweroff is required.
+
+### Flashing back vendor firmware
+
+```bash
+sudo flashrom -p internal -w dump.rom --ifd -i bios
+```
+
+NOTE: Dasharo version v0.1.0 will not have network connection. Use a different
+USB storage or an USB to Ethernet/USB WiFi adapter to move the binary to the
+live system.
@@ -81,6 +81,8 @@ nav:
          - 'Installation manual': variants/protectli_vp4620/installation-manual.md
          - 'Hardware Configuration Matrix': variants/protectli_vp4620/hardware-matrix.md
      - 'MSI PRO Z690-A WIFI DDR4':
+          - 'Releases': variants/msi_z690/releases.md
+          - 'Installation manual': variants/msi_z690/installation-manual.md
          - 'Hardware Configuration Matrix': variants/msi_z690/hardware-matrix.md
          - 'Test matrix': variants/msi_z690/test-matrix.md
 # - 'Development Environment':