Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 2 additions & 27 deletions docs/guides/capsule-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,8 @@ this compares to other update methods.

## Supported devices

!!! note

Update Capsules are only supported in UEFI/EDK2 firmware versions,
not in SeaBIOS or Heads-based firmware flavors.

The following table describes which devices support Update Capsules
and since which firmware release, if applicable. If a particular device isn't
mentioned, it means that it doesn't support this update method.

| Manufacturer | Device | Starting with FW version | V2 starting with FW version |
| ------------ | --------------- | ------------------------ | --------------------------- |
| Hardkernel | Odroid H4+ | v0.9.1 | — |
| MSI | Z690-A PRO | v1.1.4 | v1.1.7 |
| MSI | Z790-P PRO | v0.9.2 | v0.9.5 |
| NovaCustom | 11th Gen series | v1.6.0 | — |
| NovaCustom | 12th Gen series | v1.8.0 | — |
| NovaCustom | 14th Gen series | v1.0.0 | — |
| NovaCustom | NUC BOX | v0.9.0 | — |
| Protectli | Vault VP66xx | v0.9.3 | — |

!!! note

Enforcing capsule authentication in V2 made newer capsules incompatible
with the older ones. The first release with V2 publishes capsules of the
older kind which can be used to upgrade from prior releases, but starting
with this release **older capsules are no longer accepted** to not
compromise capsule authentication enhancements.
For a table representing the support for different firmware update methods
refer to the [Firmware Update Method Support Table](./firmware-update.md#firmware-update-method-support-table).

## Prerequisites

Expand Down
10 changes: 10 additions & 0 deletions docs/guides/firmware-update-method-support-table.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Manufacturer,Device,[Firmware Update Mode][fum],[Capsule Update V1][cup1],[FWUPD][fwupd],[LVFS][lvfs],[Capsule Update V2][cup2]
Hardkernel,Odroid H4+,-,v0.9.1,v0.9.1,v0.9.1,-
MSI,Z690-A PRO,v1.1.2,v1.1.4,v1.1.4,-,v1.1.7
MSI,Z790-P PRO,v0.9.0,v0.9.2,v0.9.2,-,v0.9.5
NovaCustom,11th Gen,v1.5.0,v1.6.0,v1.6.0,v1.6.0,-
NovaCustom,12th Gen,v1.7.0,v1.8.0,v1.8.0,v1.8.0,-
NovaCustom,14th Gen iGPU,v0.9.0,v1.0.0,v1.0.0,v1.0.0,-
NovaCustom,14th Gen dGPU,v0.9.1,v1.0.0,v1.0.0,v1.0.0,-
NovaCustom,NUC BOX,v0.9.0,v0.9.0,v0.9.0,v0.9.0,-
Protectli,Vault VP66xx,-,v0.9.3,v0.9.3,v0.9.3,-
79 changes: 27 additions & 52 deletions docs/guides/firmware-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,66 +4,41 @@

This document is a guide for updating firmware on your Dasharo-powered device.

!!! tip
## Firmware Update Method Support Table

If your current firmware supports UEFI Update Capsules, there is a dedicated
[guide on their usage](../guides/capsule-update.md). If unsure, check out
[the compatibility table](../guides/capsule-update.md#supported-devices)
there.
The table below shows which firmware update methods are supported
for which devices supporting the Dasharo firmware.

## fwupd / LVFS
- Every device supports manual updates.
- If a device is missing from the table, the only update method supported is
flashing a firmware ROM file manually.
- A hyphen means no support for a given method.
- A version in a column means the method is supported starting from the given
Dasharo version. The update to the first supported version for a given method
needs to be performed using other methods.
- The table might contain upcoming and not yet released versions if the feature
is planned.

Some platforms support updates via fwupd / LVFS starting with the following
firmware versions:
{{ read_csv('./firmware-update-method-support-table.csv') }}

| Vendor | Model | Version |
| ---------- | --------------------------| ------- |
| NovaCustom | NV4x, NS5x, NS7x 11th Gen | 1.6.0 |
| NovaCustom | NV4x, NS5x, NS7x 12th Gen | 1.8.0 |
| NovaCustom | V54x, V56x | 1.0.0 |
| MSI | PRO Z690-A | 1.1.7 |
| MSI | PRO Z790-P | 0.9.5 |
[fum]: ../kb/firmware-update-mode.md
[cup1]: ./capsule-update.md
[fwupd]: ../kb/fwupd.md
[lvfs]: ../kb/fwupd.md
[cup2]: ./capsule-update.md

For instructions on how to perform updates using FWUPD and how to use the tool
in general, refer to the [Dasharo fwupd documentation](../kb/fwupd.md#updating-the-firmware).
!!! note

## Firmware Update Mode
Firmware Update Mode (FUM) and Capsule Updates are only supported in UEFI
firmware, not supported in SeaBIOS or Heads-based firmware flavors.

Newer Dasharo releases support Firmware Update Mode, which performs updates
automatically over the network.
!!! note

!!! question "Does my device support Firmware Update Mode?"

Not sure if your device supports Firmware Update Mode? Check out the
[compatibility table](../kb/firmware-update-mode.md#supported-devices) in the
Knowledge Base section.

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.

After the firmware update is finished, the device will reboot automatically. If
the update includes an Embedded Controller firmware update, it will be applied
automatically after reboot and the device will reboot again.

!!! tip

Check out a more detailed explanation and rationale for Firmware Update Mode
in the [Knowledge Base](../kb/firmware-update-mode.md) section.
Enforcing capsule authentication in V2 made newer capsules incompatible
with the older ones. The first release with V2 publishes capsules of the
older kind which can be used to upgrade from prior releases, but starting
with this release **older capsules are no longer accepted** to not
compromise capsule authentication enhancements.

## Manual update

Expand Down
21 changes: 2 additions & 19 deletions docs/kb/firmware-update-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,8 @@ 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 |
| NovaCustom | V5x0TU MTL | Yes | v0.9.0 |
| NovaCustom | V5x0TNx | Yes | v0.9.1 |
| NovaCustom | NUC BOX | Yes | v0.9.0 |
For a table describing the support for different firmware update methods
refer to the [Firmware Update Method Support Table](../guides/firmware-update.md#firmware-update-method-support-table).

## How to use Firmware Update Mode

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ plugins:
- search
- macros
- mkdocs-video
- table-reader
- include-markdown:
encoding: ascii
preserve_includer_indent: true
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ markdown-grid-tables==0.4.0
mkdocs-macros-plugin==1.3.7
mkdocs-include-markdown-plugin==7.1.5
pytest==8.3.2
mkdocs-table-reader-plugin==3.1.0
Loading