docs/variants/protectli_vp2410: add documentation for VP2410

Signed-off-by: Michał Żygowski <michal.zygowski@3mdeb.com>
2026-06-13 10:16:57 -07:00 · 2022-05-31 17:02:46 +02:00
parent 36b4b3d0f7
commit 353a55681c
7 changed files with 231 additions and 0 deletions
@@ -0,0 +1,23 @@
+# Protectli Dasharo on VP2410 - building manual
+
+To build Dasharo firmware image, follow the steps below:
+
+1. Clone the coreboot repository:
+
+    ```bash
+    $ git clone https://github.com/Dasharo/coreboot.git -b protectli_vault_glk/release
+    ```
+
+2. Check out the desired version e.g. `v1.0.10`:
+
+    ```bash
+    $ cd coreboot
+    $ git checkout protectli_vault_glk_v1.0.10
+    ```
+
+3. Start build process (note it requires certain blobs to proceed):
+
+    ```bash
+    # you will need to put the ZIP with blobs and FSP at this point
+    $ ./build.sh vp2410
+    ```
@@ -0,0 +1,34 @@
+# Hardware configuration matrix - Protectli VP2410
+
+## Introduction
+
+This document describes the hardware configuration used for validation of the
+coreboot port on the Protectli VP2410 firewall.
+
+## Protectli VP2410 Dasharo v1.0.15
+
+| Component              | Description                                              |
+|------------------------|----------------------------------------------------------|
+| **CPU**                | Intel Celeron J4125                                      |
+| **SSD**                | M.2 SSD SATA: Hoodisk SSL032GTTC7-S9A-2S                 |
+|                        | external SATA 2.5 inch: Goodram SSDPR-CL100-240-G2 240GB |
+| **RAM**                | CRUCIAL CT4G4SFS824A                                     |
+|                        | SAMSUNG M471A4G43MB1-CTD                                 |
+|                        | SAMSUNG M471A1K43CB1-CTD                                 |
+|                        | SAMSUNG M471A5244BB0-CRC                                 |
+|                        | KINGSTON KVR24S17S8/8                                    |
+|                        | KINGSTON KVR26S19S8/16                                   |
+| **Wireless card**      | Intel Wi-Fi 6 AX201                                      |
+| **LTE miniPCIe card**  | Quectel EC-20                                            |
+| **Display**            | HDMI 1920x1080p, DP 1920x1080p                           |
+| **Ethernet**           | 4x intel i211 (on-board)                                 |
+| **Attached devices**   | 1. SanDisk USB 3.2Gen1 16 GB                             |
+|                        | 2. SanDisk USB 3.2Gen1 16 GB                             |
+|                        | 4. USB Type-C Hub Pro UCN3286                            |
+| **USB Keyboard**       | DELL KB216                                               |
+| **MMC drive**          | SAMSUNG 8GTF4R (on-board)                                |
+| **TPM**                | PC Engines TPM1A LPC TPM                                 |
+| **Power supply**       | Channel Well Technology 12V, 5.0A 60W                    |
+
+> Note, that in **RAM** section all used during verification procedure
+    modules have been listed. Device has only two RAM mounting slots.
@@ -0,0 +1,60 @@
+# Protectli Dasharo on VP2410 - 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 20.04.
+
+## Build flashrom
+
+Currently, the latest flashrom release lacks support for Comet Lake U internal
+flashing. Because of this, we need to build flashrom from source.
+
+Install build dependencies:
+
+```bash
+apt install git build-essential debhelper pkg-config libpci-dev libusb-1.0-0-dev libftdi1-dev meson
+```
+
+Obtain source code:
+
+```bash
+$ git clone https://github.com/Dasharo/flashrom -b dasharo-release
+$ cd flashrom
+```
+
+Build flashrom:
+
+```bash
+$ sudo make install
+```
+
+## 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
+flashrom -p internal -r dump.rom
+```
+
+Keep the backup for later recovery if needed.
+
+## 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. `protectli_vault_glk_v1.0.15.rom`.
+
+If stock firmware is currently installed:
+
+```bash
+flashrom -p internal -w [path]
+```
+
+If Dasharo is currently installed, only the COREBOOT and IFWI partitions of the
+flash needs to be updated. Flash it using the following command:
+
+```bash
+flashrom -p internal -w protectli_vault_glk_v1.0.15.rom --fmap -i COREBOOT -i IFWI
+```
+
+This command also preserves Dasharo UEFI settings and the boot order.
@@ -0,0 +1,9 @@
+# Overview
+
+* [Releases](releases.md) - list of all releases
+* [Building manual](building-manual.md) - how to build Dasharo for Protectli VP2410
+* [Installation manual](installation-manual.md) - how to install Dasharo
+  for Protectli VP2410
+* [Hardware configuration matrix](hardware-matrix.md) - definition of hardware
+  configuration used during validation
+* [Test matrix](test-matrix.md) - validation scope for the Protectli VP2410
@@ -0,0 +1,48 @@
+# Protectli VP2410 Dasharo Release Notes
+
+Following Release Notes describe status of Open Source Firmware development for
+Protectli VP2410
+
+For details about our release process please read
+[Dasharo Standard Release Process](../../dev-proc/standard-release-process.md).
+
+<center>
+[Subscribe to Protectli VP2410 Dasharo Release Newsletter]
+[newsletter]{.md-button .md-button--primary .center}
+</center>
+
+Test results for this platform can be found
+[here](https://docs.google.com/spreadsheets/d/1wI0qBSLdaluayYsm_lIa9iJ9LnPnCOZ9eNOyrKSc-j4/edit#gid=975611333).
+
+## v1.0.15 - 2022-05-31
+
+### Changed
+
+- Customized Network boot menu and strings
+
+### Fixed
+
+- SMBIOS memory information showing 0 MB DRAM in setup
+
+### Known issues
+
+- [USB 2.0 sticks not detected on VP2410](https://github.com/Dasharo/dasharo-issues/issues/99)
+- [S3 resume does not work in Geminilake FSP](https://github.com/Dasharo/dasharo-issues/issues/27)
+
+### Binaries
+
+[protectli_vault_glk_v1.0.15.rom][v1.0.15_rom]{.md-button}
+[sha256][v1.0.15_hash]{.md-button}
+[sha256.sig][v1.0.15_sig]{.md-button}
+
+See how to verify signatures on [this video](https://asciinema.org/a/388861)
+
+### SBOM (Software Bill of Materials):
+
+- [coreboot based on b77cf229 revision f59b1ec9](https://github.com/Dasharo/coreboot/tree/f59b1ec9)
+- [edk2 based on 7f90b9cd revision 90364638](https://github.com/Dasharo/edk2/tree/90364638)
+
+[newsletter]: https://newsletter.3mdeb.com/subscription/n2EpSxtqL
+[v1.0.15_rom]: https://3mdeb.com/open-source-firmware/Dasharo/protectli_vault_glk/v1.0.15/protectli_vault_glk_v1.0.15.rom
+[v1.0.15_hash]: https://3mdeb.com/open-source-firmware/Dasharo/protectli_vault_glk/v1.0.15/protectli_vault_glk_v1.0.15.rom.sha256
+[v1.0.15_sig]: https://3mdeb.com/open-source-firmware/Dasharo/protectli_vault_glk/v1.0.15/protectli_vault_glk_v1.0.15.rom.sha256.sig
@@ -0,0 +1,50 @@
+# Test matrix - Protectli VP2410
+
+## About
+
+The test matrix is used to determine the scope of tests which the DUT is
+subjected from before the release of the new binary.
+
+## Module: Dasharo compatibility
+
+| No.  | Supported test suite                              | Test suite ID | Supported test cases                 |
+|:----:|:--------------------------------------------------|:-------------:|:-------------------------------------|
+| 1.   | [Memory HCL][HCL]                                 | HCL           | All                                  |
+| 2.   | [UEFI compatible interface][EFI]                  | EFI           | EFI001.001                           |
+| 3.   | [Display ports][DSP]                              | DSP           | DSP002.001, DSP002.003, DSP003.001, DSP003.003 |
+| 4.   | [Network boot][PXE]                               | PXE           | All                                  |
+| 6.   | [Custom logo][CLG]                                | CLG           | All                                  |
+| 7.   | [Custom boot menu key][CBK]                       | CBK           | All                                  |
+| 8.   | [USB HID and MSC Support][USB]                    | USB           | USB001.001, USB001.002, USB002.001, USB002.002 |
+| 9.   | [FreeBSD support][BSD]                            | BSD           | All                                  |
+| 10.  | [Debian Stable and Ubuntu LTS support][LBT]       | LBT           | All                                  |
+| 11.  | [USB-C/Thunderbolt][UTC]                          | UTC           | UTC004.001                           |
+| 12.  | [M.2 WiFi/Bluetooth][WLE]                         | WLE           | WLE001.001, WLE002.001, WLE003.001   |
+| 13.  | [miniPCIe LTE/WiFi/Bluetooth][MWL]                | MWL           | MWL001.001, MWL002.001, MWL003.001, MWL004.001 |
+| 14.  | [eMMC support][MMC]                               | MMC           | MMC001.001                           |
+| 15.  | [SMBIOS][DMI]                                     | DMI           | DMI002.001, DMI003.001, DMI004.001, DMI005.001, DMI006.001 |
+| 16.  | [Custom network boot entries][CNB]                | CNB           | CNB001.002                           |
+
+[HCL]: ../../unified-test-documentation/dasharo-compatibility/301-memory-hcl.md
+[EFI]: ../../unified-test-documentation/dasharo-compatibility/30M-uefi-compatible-interface.md
+[DSP]: ../../unified-test-documentation/dasharo-compatibility/31E-display-ports-and-lcd.md
+[PXE]: ../../unified-test-documentation/dasharo-compatibility/315-network-boot.md
+[CLG]: ../../unified-test-documentation/dasharo-compatibility/304-custom-logo.md
+[CBK]: ../../unified-test-documentation/dasharo-compatibility/303-custom-boot-menu-key.md
+[USB]: ../../unified-test-documentation/dasharo-compatibility/306-usb-hid-and-msc-support.md
+[BSD]: ../../unified-test-documentation/dasharo-compatibility/307-freebsd-support.md
+[LBT]: ../../unified-test-documentation/dasharo-compatibility/308-debian-stable-and-ubuntu-lts-support.md
+[UTC]: ../../unified-test-documentation/dasharo-compatibility/31H-usb-type-c.md
+[WLE]: ../../unified-test-documentation/dasharo-compatibility/318-m2-wifi-bluetooth.md
+[MWL]: ../../unified-test-documentation/dasharo-compatibility/31K-minipcie-verification.md
+[MMC]: ../../unified-test-documentation/dasharo-compatibility/31M-emmc-support.md
+[DMI]: ../../unified-test-documentation/dasharo-compatibility/31L-smbios.md
+[CNB]: ../../unified-test-documentation/dasharo-compatibility/30A-custom-network-boot-entries.md
+
+## Module: Dasharo security
+
+| No.  | Supported test suite                              | Test suite ID | Supported test cases                 |
+|:-----|:--------------------------------------------------|:-------------:|:-------------------------------------|
+| 1.   | [TPM Support][TPM]                                | TPM           | TPM001.001                           |
+
+[TPM]: ../../unified-test-documentation/dasharo-security/200-tpm-support.md
@@ -89,6 +89,13 @@ nav:
          - 'Installation manual': variants/protectli_fw6/installation-manual.md
          - 'Hardware Configuration Matrix': variants/protectli_fw6/hardware-matrix.md
          - 'Test matrix': variants/protectli_fw6/test-matrix.md
+      - 'Protectli VP2410':
+          - 'Overview': variants/protectli_vp2410/overview.md
+          - 'Releases': variants/protectli_vp2410/releases.md
+          - 'Building manual': variants/protectli_vp2410/building-manual.md
+          - 'Installation manual': variants/protectli_vp2410/installation-manual.md
+          - 'Hardware Configuration Matrix': variants/protectli_vp2410/hardware-matrix.md
+          - 'Test matrix': variants/protectli_vp2410/test-matrix.md
      - 'Protectli VP4620':
          - 'Releases': variants/protectli_vp4620/releases.md
          - 'Building manual': variants/protectli_vp4620/building-manual.md