Skip to content

OvmfPkg - Platform CI

This describes the Azure DevOps based Platform CI for OvmfPkg and how to use the same Pytools based build infrastructure locally.

Supported Configuration Details

This solution for building and running OvmfPkg has only been validated with Windows 10 with VS2022 and Ubuntu 18.04 with GCC5 toolchain. Four different firmware builds are supported and are described below.

Configuration name Architectures DSC File Additional Flags
IA32 IA32 OvmfPkgIa32.dsc None
X64 X64 OvmfPkgIa64.dsc None
IA32 X64 PEI-IA32 DXE-X64 OvmfPkgIa32X64.dsc None

EDK2 Developer environment

Note: edksetup, Submodule initialization and manual installation of NASM, iASL, or the required cross-compiler toolchains are not required, this is handled by the Pytools build system.

Building with Pytools for OvmfPkg

  1. [Optional] Create a Python Virtual Environment - generally once per workspace

    python -m venv <name of virtual environment>
  2. [Optional] Activate Virtual Environment - each time new shell opened

    • Linux
    source <name of virtual environment>/bin/activate
    • Windows
    <name of virtual environment>/Scripts/activate.bat
  3. Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes

    pip install --upgrade -r pip-requirements.txt
  4. Initialize & Update Submodules - only when submodules updated

    stuart_setup -c OvmfPkg/PlatformCI/ TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
  5. Initialize & Update Dependencies - only as needed when ext_deps change

    stuart_update -c OvmfPkg/PlatformCI/ TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
  6. Compile the basetools if necessary - only when basetools C source files change

    python BaseTools/ -t <ToolChainTag>
  7. Compile Firmware

    • To build IA32
    stuart_build -c OvmfPkg/PlatformCI/ -a IA32 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>
    • To build X64
    stuart_build -c OvmfPkg/PlatformCI/ -a X64 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>
    • To build IA32 X64
    stuart_build -c OvmfPkg/PlatformCI/ -a IA32,X64 TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>
    • use stuart_build -c OvmfPkg/PlatformCI/ -h option to see additional options like --clean
  8. Running Emulator

    • You can add --FlashRom to the end of your build command and the emulator will run after the build is complete.
    • or use the --FlashOnly feature to just run the emulator.
    stuart_build -c OvmfPkg/PlatformCI/ TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH> --FlashOnly


  1. Configuring ACTIVE_PLATFORM and TARGET_ARCH in Conf/target.txt is not required. This environment is set by based upon the [-a <TARGET_ARCH>] parameter.
  2. QEMU must be on your path. On Windows this is a manual process and not part of the QEMU installer.

NOTE: Logging the execution output will be in the normal stuart log as well as to your console.

Custom Build Options

MAKE_STARTUP_NSH=TRUE will output a startup.nsh file to the location mapped as fs0. This is used in CI in combination with the --FlashOnly feature to run QEMU to the UEFI shell and then execute the contents of startup.nsh.

QEMU_HEADLESS=TRUE Since CI servers run headless QEMU must be told to run with no display otherwise an error occurs. Locally you don't need to set this.

Passing Build Defines

To pass build defines through stuart_build, prepend BLD_*_ to the define name and pass it on the command-line. stuart_build currently requires values to be assigned, so add an=1 suffix for bare defines. For example, to enable the TPM2 support, instead of the traditional "-D E1000_ENABLE", the stuart_build command-line would be:

stuart_build -c OvmfPkg/PlatformCI/ BLD_*_E1000_ENABLE=1