From 0a2a4eecf9dc5bce1b3cc2edfa25046245e41ee2 Mon Sep 17 00:00:00 2001 From: maheshtammisetti Date: Wed, 15 Mar 2023 14:07:38 +0530 Subject: [PATCH] Dasharo/docs: Fixed changes and modified test-matrix Signed-off-by: maheshtammisetti --- docs/variants/qemu_q35/building-manual.md | 11 +++------ docs/variants/qemu_q35/development.md | 18 +++++++------- docs/variants/qemu_q35/hardware-matrix.md | 29 +++++++++++++++++++++++ docs/variants/qemu_q35/overview.md | 12 ++++++++++ docs/variants/qemu_q35/test-matrix.md | 4 ---- mkdocs.yml | 6 ++++- 6 files changed, 58 insertions(+), 22 deletions(-) create mode 100644 docs/variants/qemu_q35/hardware-matrix.md diff --git a/docs/variants/qemu_q35/building-manual.md b/docs/variants/qemu_q35/building-manual.md index 7b2c1a4a..464bf095 100644 --- a/docs/variants/qemu_q35/building-manual.md +++ b/docs/variants/qemu_q35/building-manual.md @@ -50,17 +50,12 @@ Following is an example of SMM feature enabled, Check the following build command: ```bash -build -D DEBUG_ON_SERIAL_PORT -D BOOTLOADER=COREBOOT -a IA32 -a X64 -t GCC5 -b DEBUG -p OvmfPkg/OvmfPkgX64.dsc. +build -a IA32 -a X64 -t GCC5 -b DEBUG -p OvmfPkg/OvmfPkgX64.dsc. ``` -- `DEBUG_ON_SERIAL_PORT` = The following flag must be given for the **DEBUG** build -as the output is redirected to the I/O port **0x402** to qemu monitor. - -- Debug messages are visible on given I/O port. -**0x402** will be later utilized for qemu invocation further in this documentation. - - Once the build is completed, the OVMF firmware image can be found below given path: ```bash -edk2/Build/Ovmf/DEBUG_GCC5/Ovmf.fd +edk2/Build/Ovmf/DEBUG_GCC5/FV/OVMF_CODE.fd +edk2/Build/Ovmf/DEBUG_GCC5/FV/OVMF_VARS.fd ``` diff --git a/docs/variants/qemu_q35/development.md b/docs/variants/qemu_q35/development.md index ceb9bf5f..2aab5a5a 100644 --- a/docs/variants/qemu_q35/development.md +++ b/docs/variants/qemu_q35/development.md @@ -6,10 +6,10 @@ docker instance (host machine) using built OVMF firmware image. + QEMU Installation: - - [Install QEMU on your linux distro]() + - [Install QEMU on your linux distro](https://www.qemu.org/download/#linux) ```bash - qemu-system-x86_64 -drive if=pflash,format=raw,file=Build/OvmfX64/DEBUG_GCC5/FV/OVMF.fd -debugcon file:debug.log -global isa-debugcon.iobase=0x402 -global ICH9-LPC.disable_s3=1 -net none -machine q35,smm=on + qemu-system-x86_64 -drive if=pflash,format=raw,file=Build/OvmfX64/RELEASE_GCC5/FV/OVMF.fd -debugcon file:debug.log -global ICH9-LPC.disable_s3=1 -net none -machine q35,smm=on ``` + `-drive` indicate device is pflash with firmware image of built OVMF.fd image. @@ -31,7 +31,7 @@ only Q35 machines are supported hence the machine type. 1. After executing the above qemu command, qemu boots into UEFI built-in shell and to BIOS selection area. -1. The features which are enabled in `OvmfPkgX64.dsc` can be verified at `BIOS menu`. +1. The features which are enabled in `OvmfPkgX64.dsc` can be verified at `Setup menu`. At `Device Manager section` Dasharo features can be verified in `Dasharo System Features` section. @@ -43,7 +43,7 @@ only Q35 machines are supported hence the machine type. rebuild the OVMF image with the following command. ```bash -build -D DEBUG_ON_SERIAL_PORT -D BOOTLOADER=COREBOOT -a IA32 -a X64 -t GCC5 -b DEBUG -p OvmfPkg/OvmfPkgX64.dsc +build -a IA32 -a X64 -t GCC5 -b RELEASE -p OvmfPkg/OvmfPkgX64.dsc ``` 1. By making some changes in the `OvmfPkgX64.dsc` file, one can add features like @@ -74,7 +74,6 @@ DEFINE OPAL_PASSWORD_ENABLE = TRUE TcgStorageCoreLib|SecurityPkg/Library/TcgStorageCoreLib/TcgStorageCoreLib.inf TcgStorageOpalLib|SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalLib.inf !endif -S3BootScriptLib|MdePkg/Library/BaseS3BootScriptLibNull/BaseS3BootScriptLibNull.inf # # ``` @@ -95,9 +94,10 @@ SecurityPkg/HddPassword/HddPasswordPei.inf ## Dasharo System Features -1. The .FDF file tells about location of source file and options used for build process. +1. The `.fdf` describes about source file location and variables used during +build process. -2. Below code snippet shows about the location of `SATA_PASSWORD` .inf file. +2. Below code snippet shows about the location of `SATA disk password` `.inf` file. ```bash !if $(SATA_PASSWORD_ENABLE) == TRUE @@ -105,8 +105,8 @@ INF SecurityPkg/HddPassword/HddPasswordDxe.inf !endif ``` -+ Include all necessary source file locations -to point at source libraries in .FDF file. ++ Include all necessary source file locations to point at source libraries +in .FDF file. + Below is the snippet of the SATA_PASSWORD support in `Device Manager`. diff --git a/docs/variants/qemu_q35/hardware-matrix.md b/docs/variants/qemu_q35/hardware-matrix.md new file mode 100644 index 00000000..02c52a5a --- /dev/null +++ b/docs/variants/qemu_q35/hardware-matrix.md @@ -0,0 +1,29 @@ +# Hardware configuration matrix + +## Introduction + +This document describes the devices emulated by the QEMU Q35. + +## QEMU Q35 //TBD + +| Component | Description | +|--------------------------------|---------------------------------------------| +| **CPU** | Intel Core i3-10110U | +| **RAM** | Slot 1: Empty | +| | Slot 2: SAMSUNG M471A4G43MB1-CTD | +| **Flash memory** | Macronix KH25L12835F | +| **SSD** | Samsung MZVLB256HBHQ-00000 | +| **MMC drive** | SAMSUNG KLM8G1GETF-B041 (on-board) | +| **USB pendrives** | 1. SanDisk Ultra Flair USB 3.0 16 GB | +| **USB Keyboard** | DELL KB216 | +| **USB Mouse** | DELL MS116p | +| **Wireless card** | Intel Wi-Fi 6 AX200 | +| **Display** | Display 1: HDMI 1920x1080p | +| | Display 2: DP 1920x1080p | +| **Ethernet controller** | 6x intel i225 (on-board) | +| **Internal devices** | Audio subsystem | +| **TPM** | Protectli TPM | +| **Network** | Local network wired connection | +| **Remote Testing Environment** | RTE v1.1.0 | +| **Power Control** | RTE v1.1.0 | +| **Power supply** | Channel Well Technology 12V, 3.33A 40W | diff --git a/docs/variants/qemu_q35/overview.md b/docs/variants/qemu_q35/overview.md index eaa27191..abdf7f6a 100644 --- a/docs/variants/qemu_q35/overview.md +++ b/docs/variants/qemu_q35/overview.md @@ -11,6 +11,18 @@ * [Development](development.md) - describes information for running Dasharo OVMF in QEMU Q35 machine and for Dasharo Developers. +* [Initial deployment](initial-deployment.md) - QEMU is an emulation environment + and not real hardware thus firmware deployment is not applicable. + +* [Firmware update](firmware-update.md) - QEMU is an emulation environment + and not real hardware thus firmware update is not applicable. + +* [Recovery](recovery.md) - QEMU is an emulation environment and not a + real hardware thus firmware recovery is not applicable. + +* [Hardware configuration matrix](hardware-matrix.md) - describes about the + devices emulated by QEMU. + ## Useful documents * [EDK2 OVMF Package Documentation](https://github.com/tianocore/edk2/blob/master/OvmfPkg/README) diff --git a/docs/variants/qemu_q35/test-matrix.md b/docs/variants/qemu_q35/test-matrix.md index 044eb776..a066f8b6 100644 --- a/docs/variants/qemu_q35/test-matrix.md +++ b/docs/variants/qemu_q35/test-matrix.md @@ -40,9 +40,5 @@ Certification Procedure for tested platform: | No. | Supported test suite | Test suite ID | Supported test cases | |:-----|:--------------------------------------------------|:-------------:|:-------------------------------------| | 1. | [Secure Boot support][SBO] | SBO | All | -| 2. | [ME neuter support][MNE] | MNE | All | -| 3. | [BIOS lock support][BLS] | BLS | All | [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 diff --git a/mkdocs.yml b/mkdocs.yml index c50ff44b..9f9cd919 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -148,8 +148,12 @@ nav: - 'Overview': variants/qemu_q35/overview.md - 'Releases': variants/qemu_q35/releases.md - 'Building manual': variants/qemu_q35/building-manual.md - - 'Development': variants/qemu_q35/development.md - 'Test matrix': variants/qemu_q35/test-matrix.md + - 'Development': variants/qemu_q35/development.md + - 'Initial Deployment': variants/qemu_q35/initial-deployment.md + - 'Firmware update': variants/qemu_q35/firmware-update.md + - 'Recovery': variants/qemu_q35/recovery.md + - 'Hardware Configuration Matrix': variants/qemu_q35/hardware-matrix.md - 'MSI PRO Z690-A': - 'Overview': variants/msi_z690/overview.md - 'Releases': variants/msi_z690/releases.md