Merge pull request #778 from Dasharo/fw_update_doc_revision

Fw update doc revision

Author: macpijan

docs/guides/firmware-update.md

@@ -2,32 +2,18 @@
 
 ## Introduction
 
-This document describes the process for updating firmware on devices running
-Dasharo firmware. Some steps specific to each device will be described in their
-respective documentation, but the generic process outlined here will apply to
-all devices.
+This document is a guide for updating firmware on your Dasharo-powered device.
 
 ## Firmware Update Mode
 
-For enhanced firmware security, Dasharo uses a number of security mechanisms to
-prevent overwriting firmware. Depending on device, these may be some or all of
-the following:
+Newer Dasharo releases support Firmware Update Mode, which performs updates
+automatically over the network.
 
-- SPI flash write-protection - prevents overwriting the initial bootblock and
-  Verified Boot code
-- SMM BIOS write protection - prevents all writes to BIOS flash memory outside
-  of privileged code running in System Management Mode
-- UEFI Secure Boot - in combination with Linux Kernel Lockdown, prevents direct
-  access to the SPI flash controller from the OS
+!!! question "Does my device support Firmware Update Mode?"
 
-If you are interested, see the
-[Dasharo System Features](../dasharo-menu-docs/dasharo-system-features.md)
-section for more details.
-
-To allow updating firmware by the end user, these protections must be disabled
-first. To facilitate this, Dasharo has a Firmware Update Mode option that
-**temporarily** disables firmware security measures for the duration of one
-boot.
+    Not sure if your device supports Firmware Update Mode? Check out the
+    [compatibility table](/kb/firmware-update-mode#supported-devices) in the
+    Knowledge Base section.
 
 To enter Firmware Update Mode:
 
@@ -47,6 +33,13 @@ To enter Firmware Update Mode:
 Once in Firmware Update Mode, proceed with the firmware update steps outlined
 in device-specific documentation.
 
-## Firmware Update Mode flowchart
+!!! tip
+
+    Check out a more detailed explanation and rationale for Firmware Update Mode
+    in the [Knowledge Base](/kb/firmware-update-mode) section.
+
+## Manual update
 
-![](./images/fum_flowchart.png)
+Firmware versions without support for Firmware Update Mode have various update
+procedures. Check out your device's Firmware Update documentation for more
+information.

docs/kb/firmware-update-mode.md

@@ -0,0 +1,75 @@
+# Firmware update
+
+## Introduction
+
+This document describes the operation and rationale for Firmware Update Mode.
+
+!!! tip
+
+    If you are a user looking for a guide for updating firmware, check out the
+    [Guides](/guides/firmware-update) section instead.
+
+## Firmware Update Mode
+
+For enhanced firmware security, Dasharo uses a number of security mechanisms to
+prevent overwriting firmware. Depending on device, these may be some or all of
+the following:
+
+- SPI flash write-protection - prevents overwriting the initial bootblock and
+  Verified Boot code
+- SMM BIOS write protection - prevents all writes to BIOS flash memory outside
+  of privileged code running in System Management Mode
+- UEFI Secure Boot - in combination with Linux Kernel Lockdown, prevents direct
+  access to the SPI flash controller from the OS
+
+If you are interested, see the
+[Dasharo System Features](../dasharo-menu-docs/dasharo-system-features.md)
+section for more details.
+
+To allow updating firmware by the end user, these protections must be disabled
+first. To facilitate this, Dasharo has a Firmware Update Mode option that
+**temporarily** disables firmware security measures for the duration of one
+boot.
+
+## Supported devices
+
+The following table describes which devices support Firmware Update Mode
+and the starting firmware version, if applicable.
+
+!!! note
+
+    Firmware Update Mode is currently only supported in UEFI firmware versions,
+    not in SeaBIOS or Heads-based firmware flavors.
+
+| Manufacturer | Device | FUM supported | Starting with FW version |
+| --- | --- | --- | --- |
+| MSI | Z690-A PRO | Yes | v1.1.2 |
+| MSI | Z790-P PRO | Yes | v0.9.0 |
+| NovaCustom | NS5x/7x ADL | Yes | v1.7.0 |
+| NovaCustom | NS5x/7x TGL | Yes | v1.5.0 |
+| NovaCustom | NV4x ADL | Yes | v1.7.0 |
+| NovaCustom | NV4x TGL | Yes | v1.5.0 |
+
+## How to use Firmware Update Mode
+
+To enter Firmware Update Mode:
+
+1. Enter the Setup Menu and navigate to Dasharo System Features:
+![](./images/setup_menu_dsf.png)
+1. Navigate to `Dasharo Security Options`:
+![](./images/setup_menu_dsc.png)
+1. Select `Firmware Update Mode`:
+![](./images/setup_menu_fum.png)
+1. When prompted, press Enter to accept. The device will reboot in Firmware
+  Update Mode.
+![](./images/setup_menu_fum_confirmation.png)
+1. After reboot, when prompted, press the indicated key on the keyboard.
+  Alternatively, to abort Firmware Update Mode, press Enter instead or simply
+  wait for the timeout to expire.
+
+Once in Firmware Update Mode, proceed with the firmware update steps outlined
+in device-specific documentation.
+
+## Firmware Update Mode flowchart
+
+![](./images/fum_flowchart.png)

docs/guides/images/fum_flowchart.png renamed to docs/kb/images/fum_flowchart.png

@@ -4,37 +4,12 @@ The following documentation describes the process of Dasharo open-source
 firmware update. The update process may be different, depending on which
 firmware version is currently installed on your device.
 
-You can check your current firmware version with the following Linux command.
-
-```bash
-sudo dmidecode -t bios | grep Version
-```
-
-Alternatively, it can be checked in the
-[Dasharo Setup Menu](/dasharo-menu-docs/overview/#dasharo-menu-guides)
-when booting the device.
+Your firmware version can be checked by entering the
+[Dasharo Setup Menu](/dasharo-menu-docs/overview/#dasharo-menu-guides) using the
+++f2++ key while booting.
 
 ## Prerequisites
 
-First, determine your device version with the following Linux command.
-
-```bash
-sudo dmidecode -t system | grep "Product Name"
-```
-
-Alternatively, it can be checked in the
-[Dasharo Setup Menu](/dasharo-menu-docs/overview/#dasharo-menu-guides)
-as well.
-
-Note the `Device name` based on the previous output and the following table.
-
-| Product Name output |  Device name      |
-|---------------------|-------------------|
-| NV4XMB,ME,MZ        | NV4x 11th Gen     |
-| NS50_70MU           | NS5x/7x 11th Gen  |
-| NV41PZ              | NV4x 12th Gen     |
-| NS50_70PU           | NS5x/7x 12th Gen  |
-
 Depending on the firmware version, there may be manual steps required to ensure
 that the firmware can be updated. `11th Gen` devices starting from version v1.5.0
 and `12th Gen` devices starting from version v1.7.0 have support for [Firmware

docs/kb/images/setup_menu_dsc.png

@@ -350,6 +350,7 @@ nav:
           - 'Dasharo APU Configuration': dasharo-menu-docs/dasharo-apu-configuration.md
       - 'Checkbox certification software usage': common-coreboot-docs/checkbox.md
       - 'Dumping logs': common-coreboot-docs/dumping_logs.md
+      - 'Firmware Update Mode': kb/firmware-update-mode.md
     # - 'Trolling Topics List':
     #     - 'Introduction': osf-trolling-list/osf_issues_taxonomy.md
   - 'FAQ':