ArmVirtPkg - Platform CI¶
This Readme.md describes the Azure DevOps based Platform CI for ArmVirtPkg and how to use the same Pytools based build infrastructure locally.
Supported Configuration Details¶
This solution for building and running ArmVirtPkg has only been validated with Ubuntu 18.04 and the GCC5 toolchain. Two different firmware builds are supported and are described below.
|Configuration name||Architecture||DSC File||Additional Flags|
EDK2 Developer environment¶
- Python 3.8.x - Download & Install
- GIT - Download & Install
- QEMU - Download, Install, and add to your path
- Edk2 Source
- Additional packages found necessary for Ubuntu 18.04
- apt-get install gcc g++ make uuid-dev
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 ArmVirtPkg¶
[Optional] Create a Python Virtual Environment - generally once per workspace
python -m venv <name of virtual environment>
[Optional] Activate Virtual Environment - each time new shell opened
<name of virtual environment>/Scripts/activate.bat
source <name of virtual environment>/bin/activate
Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes
pip install --upgrade -r pip-requirements.txt
Initialize & Update Submodules - only when submodules updated
stuart_setup -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
Initialize & Update Dependencies - only as needed when ext_deps change
stuart_update -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
Compile the basetools if necessary - only when basetools C source files change
python BaseTools/Edk2ToolsBuild.py -t <ToolChainTag>
stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py -hoption to see additional options like
- You can add
--FlashRomto the end of your build command and the emulator will run after the build is complete.
- or use the
--FlashOnlyfeature to just run the emulator.
stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH> --FlashOnly
- You can add
- Including the expected build architecture and toolchain to the stuart_update command is critical. This is because there are extra scopes and tools that will be resolved during the update step that need to match your build step.
- Configuring ACTIVE_PLATFORM and TARGET_ARCH in Conf/target.txt is not required. This
environment is set by PlatformBuild.py based upon the
- 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 TPM2_ENABLE=TRUE", the stuart_build
command-line would be:
stuart_build -c ArmVirtPkg/PlatformCI/PlatformBuild.py BLD_*_TPM2_ENABLE=TRUE