From 522c4bcbd9a364c8511f640ec15abd009d83d6c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Filip=20Go=C5=82a=C5=9B?= Date: Thu, 25 Jul 2024 07:10:54 +0200 Subject: [PATCH] variants/protectli_vp46xx: Remove whats moved to unified MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Filip Gołaś --- .../protectli_vp46xx/building-manual.md | 88 ------------- .../protectli_vp46xx/firmware-update.md | 79 ------------ .../protectli_vp46xx/initial-deployment.md | 41 ------ docs/variants/protectli_vp46xx/overview.md | 41 ------ docs/variants/protectli_vp46xx/recovery.md | 35 ----- docs/variants/protectli_vp46xx/test-matrix.md | 122 ------------------ 6 files changed, 406 deletions(-) delete mode 100644 docs/variants/protectli_vp46xx/building-manual.md delete mode 100644 docs/variants/protectli_vp46xx/firmware-update.md delete mode 100644 docs/variants/protectli_vp46xx/initial-deployment.md delete mode 100644 docs/variants/protectli_vp46xx/overview.md delete mode 100644 docs/variants/protectli_vp46xx/recovery.md delete mode 100644 docs/variants/protectli_vp46xx/test-matrix.md diff --git a/docs/variants/protectli_vp46xx/building-manual.md b/docs/variants/protectli_vp46xx/building-manual.md deleted file mode 100644 index 7f45629e45..0000000000 --- a/docs/variants/protectli_vp46xx/building-manual.md +++ /dev/null @@ -1,88 +0,0 @@ -# Building manual - -## Intro - -This document describes the procedure for compiling coreboot for Protectli -VP4630, VP4650 and VP4670. - -## Requirements - -- Docker - + follow [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) - + follow [Post-installation steps for Linux](https://docs.docker.com/engine/install/linux-postinstall/) -- Git - -## Build Dasharo BIOS firmware - -> This build procedure produces full firmware binary including blobs such as -> FSP, and ME. Currently, access to them is restricted to the OEM (Protectli) via -> a private repository. - -Since version v1.0.18 VP4630 and VP4650 use different configuration file than -VP4670. Versions v1.0.17 and older do not support VP4650 and VP4670 at all. - -Versions v1.1.1 and newer support all variants with a single binary. - -1. Clone the coreboot repository: - - ```bash - git clone https://github.com/Dasharo/coreboot - ``` - -1. Checkout the desired version, e.g. `v1.1.0`: - - ```bash - cd coreboot - git checkout protectli_vault_cml_v1.1.0 - ``` - -1. Checkout submodules: - - ```bash - git submodule update --init --checkout - ``` - -1. Obtain the Protectli blobs package (only for version v1.1.0 and older): - - > Replace `` with a a proper path to the repository - > in a form of: `git@repo-path.git`. You should checkout to the same tag as - > in case of the coreboot repository. - - ```bash - cd 3rdparty/blobs/mainboard/ - git init - git remote add origin - git fetch origin && git checkout protectli_vault_cml_v1.1.0 - cd - - ``` - -1. Build the firmware: - - === "v1.1.1 or newer" - - ```bash - ./build.sh vp46xx - ``` - - The resulting coreboot image will be placed in the coreboot directory as - `protectli_vault_cml__vp46xx.rom`. - - === "V1.1.0 or older" - - === "VP4630 and VP4650" - - ```bash - ./build.sh vp4630_vp4650 - ``` - - The resulting coreboot image will be placed in the coreboot - directory as `protectli_vault_cml__vp4630_vp4650.rom`. - - === "VP4670" - - ```bash - ./build.sh vp4670 - ``` - - The resulting coreboot image will be placed in the coreboot - directory as `protectli_vault_cml__vp4670.rom`. diff --git a/docs/variants/protectli_vp46xx/firmware-update.md b/docs/variants/protectli_vp46xx/firmware-update.md deleted file mode 100644 index 453c68b928..0000000000 --- a/docs/variants/protectli_vp46xx/firmware-update.md +++ /dev/null @@ -1,79 +0,0 @@ -# Firmware update - -The following documentation describes the process of Dasharo open-source -firmware update. If your device is currently flashed with the proprietary -firmware please refer to the [Initial deployment](initial-deployment.md) -documentation. - -The update process may be different, depending on the currently installed -Dasharo firmware version. - -For simplicity of the update process, we recommend using -[Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/overview). - -Before starting the update procedure be sure to disable Dasharo BIOS Boot medium -lock and Secure Boot: - -1. Power on the device. -1. While the device is booting, hold the `DELETE` key to enter the UEFI Setup - Menu. -1. Enter the `Dasharo System Features` menu using the arrow keys and Enter. -1. Enter the [Dasharo Security Options](https://docs.dasharo.com/dasharo-menu-docs/dasharo-system-features/#dasharo-security-options) - submenu. -1. Verify the state of the `Lock the BIOS boot medium` option - if the option - is chosen, press `Space` and then `F10` to save the changes. -1. Go back to the main menu using the `ESC` key. -1. Enter the `Device Manager` menu. -1. Enter the [Secure Boot Configuration](https://docs.dasharo.com/dasharo-menu-docs/device-manager/#secure-boot-configuration) - submenu. -1. Verify that the `Current Secure Boot State` field says Disabled - if not, - unselect the `Attempt Secure Boot` option below then press `F10` to save the - changes. -1. Reboot the device to properly apply the changes. - -The settings of all the above options can be restored after a firmware update. - -## Updating to Dasharo v1.2.0 - -Due to the major changes, such as ME update, and firmware layout adjustments -(to store the boot logo), flashing of the whole firmware is required: - -```shell -flashrom -p internal -w protectli_vp46xx_v1.2.0.rom -``` - -## Updating to Dasharo v1.0.18 or v1.0.19 or v1.1.0 - -From v1.0.18 Dasharo firmware is rebased on the more up-to-date revision of -coreboot. - -If the current version of the firmware on the device is older than v1.0.18 or -you are migrating from proprietary firmware the whole flash chip should be -flashed as described in [Initial Deployment](initial-deployment.md). - -If the current version of the firmware on the device is v1.0.18 and it should -be updated to v1.0.19 or v1.1.0, only the `WP_RO` and `RW_SECTION_A` should be -flashed. To do this the following command should be used: - -```bash -flashrom -p internal -w protectli_vault_cml_v1.0.19.rom --fmap -i WP_RO -i RW_SECTION_A -``` - -## Updating on Dasharo v1.0.16 or v1.0.17 - -Only the `RW_SECTION_A` partition of the flash needs to be updated. Flash it -using the following command: - -```bash -flashrom -p internal -w protectli_vault_cml_v1.0.16.rom --fmap -i RW_SECTION_A -``` - -This command also preserves Dasharo UEFI settings and the boot order. - -## Updating on older Dasharo versions - -In this case, the whole `bios` region must be updated. - -```bash -flashrom -p internal -w protectli_vault_cml_v1.0.13.rom --ifd -i bios -``` diff --git a/docs/variants/protectli_vp46xx/initial-deployment.md b/docs/variants/protectli_vp46xx/initial-deployment.md deleted file mode 100644 index 97d0294285..0000000000 --- a/docs/variants/protectli_vp46xx/initial-deployment.md +++ /dev/null @@ -1,41 +0,0 @@ -# Initial deployment - -Initial flashing of Dasharo firmware can be done from Linux using flashrom with -the internal programmer. This document describes the process of building, -installing and running flashrom on Ubuntu 22.04. - -## Build flashrom - -Please follow generic guide for [Dasharo flashrom fork](../../osf-trivia-list/deployment.md#how-to-install-dasharo-flashrom-fork). - -## Reading flash contents - -Always prepare a backup of the current firmware image. To read from the flash -and save it to a file (`dump.rom`), execute the following command: - -```bash -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. -`protectli_vault_cml_v1.0.13.rom`. - -```bash -flashrom -p internal -w protectli_vault_cml_v1.0.13.rom -``` - -This will flash the full image, including the Intel ME. The operation requires -a hard reset of the platform. To perform a hard reset: - -1. Power off the platform. Note, it may not power off completely due to flashed - ME. -2. Disconnect power supply from the board when OS finishes all tasks after - power off (the screen goes dark or black). -3. Disconnect the RTC/CMOS battery OR clear the CMOS using the pin header - located near memory slots. Wait about half a minute (unshort the pins). -4. Connect the power supply back. -5. The platform should power on normally now. You can connect the battery back - if it was disconnected. diff --git a/docs/variants/protectli_vp46xx/overview.md b/docs/variants/protectli_vp46xx/overview.md deleted file mode 100644 index 66124ffe4d..0000000000 --- a/docs/variants/protectli_vp46xx/overview.md +++ /dev/null @@ -1,41 +0,0 @@ -# Overview - -The Vault is a small form network appliance built for use as a firewall / -router, virtualization platform, a daily-driven personal computer, and more. -The VP46XX is the second platform of the Vault Pro series with higher -performance and newer technology than the original FW6 series. - -![](/images/VP4630_banner-1.jpg) - -The VP46XX features an Intel 10th Generation CPU, 2x DDR4 DIMM modules, 6x -Intel i225-V 2.5G Ethernet ports, PCIe x4/SATA NVMe storage, LPC TPM, M.2 WIFI -and WWAN slots. - -* VP4630 - Intel Core i3-10110U -* VP4650 - Intel Core i5-10210U -* VP4670 - Intel Core i7-10810U (both v1 and v2 versions, see the - [Intel FSP repo for details](https://github.com/intel/FSP/tree/master/CometLakeFspBinPkg#differentiating-cometlake1-and-cometlake2))) - -For more information please refer to the references below. - -## References - -* [Buy VP4630 in Protectli shop](https://protectli.com/product/vp4630/) - -## Documentation sections - -* [Releases](releases.md) - groups information about all releases. -* [Building manual](building-manual.md) - describes how to build Dasharo for - NovaCustom NV4x. -* [Initial deployment](initial-deployment.md) - describes initial Dasharo - deployment methods (i. e. flashing new firmware) for Protectli VP46xx. -* [Firmware update](firmware-update.md) - explains supported Dasharo - open-source firmware update methods. -* [Recovery](recovery.md) - gathers information on how to recover the platform - from potential failure. -* [Hardware configuration matrix](hardware-matrix.md) - describes the - platform's hardware configuration used during the Dasharo firmware - validation procedure. -* [Test matrix](test-matrix.md) - describes validation scope used during - Dasharo firmware validation procedure. -* [Post-installation setup](../protectli-post-install.md) diff --git a/docs/variants/protectli_vp46xx/recovery.md b/docs/variants/protectli_vp46xx/recovery.md deleted file mode 100644 index 01dfd8fd9f..0000000000 --- a/docs/variants/protectli_vp46xx/recovery.md +++ /dev/null @@ -1,35 +0,0 @@ -# Recovery - -## Intro - -The following documentation describes platform-specific details of setting up -Protectli VP46XX for recovery from brick state with -[RTE](../../transparent-validation/rte/introduction.md) -and Dasharo open-source firmware. - -## Connections - -Set up the connections required for external flashing as described in -[Generic Testing Stand Setup](../../unified-test-documentation/generic-testing-stand-setup.md). -Protectli VP46XX are flashed using the Pomona clip connection variant. Use -the pictures below to easily locate essential components on the mainboard. - -### SPI flash chip location - -![](../../images/protectli_recovery/vp46xx_location_of_flash_chip.jpg) - -### CMOS header location - -![](../../images/protectli_recovery/vp46xx_location_of_CMOS_header.jpg) - -## Firmware flashing - -To flash firmware, follow the steps described in -[Generic Testing Stand Setup](../../unified-test-documentation/generic-testing-stand-setup.md) -, noting that: -* The chip voltage for this platform is **3.3V** -* The proper flashrom parameters for this platform are: - - ```bash - flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000 -c "MX25L12835F/MX25L12845E/MX25L12865E" -w [path_to_binary] - ``` diff --git a/docs/variants/protectli_vp46xx/test-matrix.md b/docs/variants/protectli_vp46xx/test-matrix.md deleted file mode 100644 index af9ec665df..0000000000 --- a/docs/variants/protectli_vp46xx/test-matrix.md +++ /dev/null @@ -1,122 +0,0 @@ -# Test matrix - -## 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. The test scope is the same -for all platforms of the VP46XX family. - -## 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 | All | -| 3. | [Display ports][DSP] | DSP | DSP002.001, DSP002.002, DSP002.003, DSP003.001, DSP003.002, DSP003.003 | -| 4. | [Network boot utilities][NBT] | NBT | All | -| 5. | [NVMe support][NVM] | NVM | All | -| 6. | [Custom logo][CLG] | CLG | All | -| 7. | [Custom boot menu key][CBK] | CBK | All | -| 8. | [USB HID and MSC Support][USB] | USB | USB001.XXX and USB002.XXX | -| 9. | [FreeBSD support][BSD] | BSD | All | -| 10. | [Debian Stable and Ubuntu LTS support][LBT] | LBT | LBT003.001, LBT003.002, LBT004.001, LBT004.002| -| 11. | [USB-C support][UTC] | UTC | UTC004.001, UTC004.002 | -| 12. | [M.2 WiFi/Bluetooth][WLE] | WLE | ALL | -| 13. | [eMMC support][MMC] | MMC | MMC001.001 | -| 14. | [SMBIOS][DMI] | DMI | DMI002.001, DMI003.001, DMI004.001, DMI005.001, DMI006.001 | -| 15. | [Custom network boot entries][CNB] | CNB | CNB001.002 | -| 16. | [M.2 automatic SATA/NVMe switching support][MSS] | MSS | MSS001.001 | -| 17. | [Windows booting][WBT] | WBT | WBT001.001 | -| 18. | [Audio subsystem][AUD] | AUD | AUD001.001, AUD001.002, AUD002.001, AUD002.002, AUD003.001, AUD003.002, AUD004.001, AUD004.002, AUD005.001, AUD005.002, AUD006.001, AUD006.002 | -| 19. | [UEFI Shell][USH] | USH | All | -| 20. | [USB detection][UDT] | UDT | All | -| 21. | [USB booting][UBT] | UBT | All | -| 22. | [pfSense support][PFS] | PFS | All | -| 23. | [OPNsense support][OPN] | OPN | All | -| 24. | [Proxmox support][PVE] | PVE | All | -| 25. | [Ubuntu Server support][USS] | USS | All | - -[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 -[NBT]: ../../unified-test-documentation/dasharo-compatibility/315b-netboot-utilities.md -[NVM]: ../../unified-test-documentation/dasharo-compatibility/312-nvme-support.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 -[MSS]: ../../unified-test-documentation/dasharo-compatibility/31I-nvme-switching.md -[WBT]: ../../unified-test-documentation/dasharo-compatibility/31A-windows-booting.md -[AUD]: ../../unified-test-documentation/dasharo-compatibility/31F-audio-subsystem.md -[USH]: ../../unified-test-documentation/dasharo-compatibility/30P-uefi-shell.md -[UDT]: ../../unified-test-documentation/dasharo-compatibility/31O-usb-detect.md -[UBT]: ../../unified-test-documentation/dasharo-compatibility/31N-usb-boot.md -[PFS]: ../../unified-test-documentation/dasharo-compatibility/341-pfSense-support.md -[OPN]: ../../unified-test-documentation/dasharo-compatibility/342-OPNsense-support.md -[PVE]: ../../unified-test-documentation/dasharo-compatibility/348-proxmox-support.md -[USS]: ../../unified-test-documentation/dasharo-compatibility/349-ubuntu-server-support.md - -## Module: Dasharo security - -| No. | Supported test suite | Test suite ID | Supported test cases | -|:-----|:--------------------------------------|:-------------:|:-------------------------------------| -| 1. | [TPM Support][TPM] | TPM | Without TPM001.001,TPM002.001 and TPM003.001 | -| 2. | [Verified Boot support][VBO] | VBO | Without VBO006.001 and VBO007.001 | -| 3. | [Measured Boot support][MBO] | MBO | All | -| 4. | [Secure Boot support][SBO] | SBO | All | -| 5. | [ME disable/neuter support][MNE] | MNE | MNE004.001 | -| 6. | [BIOS lock support][BLS] | BLS | All | -| 7. | [USB stack enable/disable][USS] | USS | All | -| 8. | [SMM BIOS write protection][SMM] | SMM | All | - -> Note: in Dasharo compatible with Protectli VP46xx ME is soft-disabled by -> default - no additional option for ME disabling is available in the Setup -> Menu. - -[TPM]: ../../unified-test-documentation/dasharo-security/200-tpm-support.md -[VBO]: ../../unified-test-documentation/dasharo-security/201-verified-boot.md -[MBO]: ../../unified-test-documentation/dasharo-security/203-measured-boot.md -[SBO]: ../../unified-test-documentation/dasharo-security/206-secure-boot.md -[MNE]: ../../unified-test-documentation/dasharo-security/20F-me-neuter.md -[BLS]: ../../unified-test-documentation/dasharo-security/20J-bios-lock-support.md -[USS]: ../../unified-test-documentation/dasharo-security/20S-usb-stack.md -[SMM]: ../../unified-test-documentation/dasharo-security/20O-SMM-bios-write-protection.md - -## Module: Dasharo performance - -| No. | Supported test suite | Test suite ID | Supported test cases | -|:-----|:--------------------------------------|:-------------:|:-------------------------------------| -| 1. | [coreboot bring up time measurement][CBMEM] | CBMEM | All | -| 2. | [CPU temperature measure][CPT] | CPT | All | -| 3. | [CPU frequency measure][CPF] | CPF | Without CPU003.XXX and CPU005.XXX | -| 4. | [Platform stability][STB] | STB | All | -| 5. | [Ubuntu booting performance test][BUB] | BUB | All | -| 6. | [Debian booting performance test][BDE] | BDE | All | -| 7. | [FreeBSD booting performance test][BFB] | BFB | All | -| 8. | [Proxmox booting performance test][BPM] | BPM | All | -| 9. | [Ubuntu Server booting performance test][BUS] | BUS | All | -| 10. | [OPNsense (serial output) booting performance test][BOS] | BOS | All | -| 11. | [OPNsense (VGA output) booting performance test][BOV] | BOV | All | -| 12. | [pfSense (serial output) booting performance test][BPS] | BPS | All | -| 13. | [pfSense (VGA output) booting performance test][BPV] | BPV | All | - -[CBMEM]: ../../unified-test-documentation/dasharo-performance/400-coreboot-boot-measure.md -[CPT]: ../../unified-test-documentation/dasharo-performance/401-cpu-temperature.md -[CPF]: ../../unified-test-documentation/dasharo-performance/402-cpu-frequency.md -[STB]: ../../unified-test-documentation/dasharo-performance/404-platform-stability.md -[BUB]: ../../unified-test-documentation/dasharo-performance/407-ubuntu-booting-performance-test.md -[BDE]: ../../unified-test-documentation/dasharo-performance/408-debian-booting-performance-test.md -[BFB]: ../../unified-test-documentation/dasharo-performance/409-freebsd-booting-performance-test.md -[BPM]: ../../unified-test-documentation/dasharo-performance/410-proxmox-booting-performance-test.md -[BUS]: ../../unified-test-documentation/dasharo-performance/411-ubuntu-server-booting-performance-test.md -[BOS]: ../../unified-test-documentation/dasharo-performance/412-opnsense-serial-booting-performance-test.md -[BOV]: ../../unified-test-documentation/dasharo-performance/413-opnsense-vga-booting-performance-test.md -[BPS]: ../../unified-test-documentation/dasharo-performance/414-pfsense-serial-booting-performance-test.md -[BPV]: ../../unified-test-documentation/dasharo-performance/415-pfsense-vga-booting-performance-test.md