298da55902
build_edk2() module in scripts/common-aarch64.sh does not produce the UEFI firmware for aarch64 as the commits used to assemble sources for acpica, edk2-platforms and edk2 do not compile after GCC version upgraded from 11.4.0 to 13.3.0 in the developer container (ubuntu 22.04 to 24.04) Apply minimum upgrade to EDK2_REPO and ACPICA_REPO required to compile with GCC 13.3.0 while still assuring guest VM boot for all integration tests BaseTools: Brotli compression submodule that was previously failing has been fixed following commit bump Developers can now produce UEFI firmware for aarch64 using the following commands ``` ./scripts/dev_cli.sh shell source scripts/test-util.sh source scripts/common-aarch64.sh build_edk2 ``` Update docs/uefi.md Fixes #7608 Signed-off-by: Saravanan D <saravanand@crusoe.ai>
97 lines
3.6 KiB
Markdown
97 lines
3.6 KiB
Markdown
# UEFI Boot
|
|
|
|
Cloud Hypervisor supports UEFI boot through the utilization of the EDK II based UEFI firmware.
|
|
|
|
## Building UEFI Firmware for x86-64
|
|
|
|
To avoid any unnecessary issues, it is recommended to use Ubuntu 18.04 and its default toolset. Any other compatible Linux distribution is otherwise suitable, however it is suggested to use a temporary Docker container with Ubuntu 18.04 for a quick build on an existing Linux machine.
|
|
|
|
Please note that nasm-2.15 is required for the build to succeed.
|
|
|
|
The commands below will compile an OVMF firmware suitable for Cloud Hypervisor.
|
|
|
|
```shell
|
|
sudo apt-get update
|
|
sudo apt-get install uuid-dev nasm iasl build-essential python3-distutils git
|
|
|
|
git clone https://github.com/tianocore/edk2
|
|
cd edk2
|
|
. edksetup.sh
|
|
git submodule update --init
|
|
|
|
echo "ACTIVE_PLATFORM=OvmfPkg/CloudHv/CloudHvX64.dsc" >> Conf/target.txt
|
|
echo "TARGET_ARCH=X64" >> Conf/target.txt
|
|
echo "TOOL_CHAIN_TAG=GCC5" >> Conf/target.txt
|
|
|
|
make -C ./BaseTools
|
|
build
|
|
```
|
|
|
|
After the successful build, the resulting firmware binaries are available under `Build/CloudHvX64/DEBUG_GCC5/FV` underneath the edk2 checkout.
|
|
|
|
## Building UEFI Firmware for AArch64
|
|
|
|
```shell
|
|
# On an AArch64 machine:
|
|
$ sudo apt-get update
|
|
$ sudo apt-get install uuid-dev nasm iasl build-essential python3-distutils git
|
|
# Master branches for these repos can be unstable, and newer GCC versions
|
|
# enforce strict warning-as-error policies that break builds
|
|
# These specific commit # are verified to compile cleanly with GCC 13.3.0
|
|
# Shallow clone edk2 repo
|
|
$ mkdir -p edk2 && cd edk2 && \
|
|
git init -q && \
|
|
git remote add origin https://github.com/tianocore/edk2.git && \
|
|
git fetch -q --depth 1 origin 22130dcd98b4d4b76ac8d922adb4a2dbc86fa52c && \
|
|
git checkout -q FETCH_HEAD && \
|
|
git submodule update --init --recursive --depth 1 && \
|
|
cd ..
|
|
# Shallow clone edk2-platforms repo
|
|
$ mkdir -p edk2-platforms && cd edk2-platforms && \
|
|
git init -q && \
|
|
git remote add origin https://github.com/tianocore/edk2-platforms.git && \
|
|
git fetch -q --depth 1 origin 8227e9e9f6a8aefbd772b40138f835121ccb2307 && \
|
|
git checkout -q FETCH_HEAD && \
|
|
cd ..
|
|
# Shallow clone acpica repo
|
|
$ mkdir -p acpica && cd acpica && \
|
|
git init -q && \
|
|
git remote add origin https://github.com/acpica/acpica.git && \
|
|
git fetch -q --depth 1 origin e80cbd7b52de20aa8c75bfba9845e9cb61f2e681 && \
|
|
git checkout -q FETCH_HEAD && \
|
|
cd ..
|
|
# Build tools
|
|
$ export PACKAGES_PATH="$PWD/edk2:$PWD/edk2-platforms"
|
|
$ export IASL_PREFIX="$PWD/acpica/generate/unix/bin/"
|
|
$ make -C acpica
|
|
$ cd edk2/
|
|
$ . edksetup.sh
|
|
$ cd ..
|
|
$ make -C edk2/BaseTools
|
|
|
|
# Build EDK2
|
|
$ build -a AARCH64 -t GCC5 -p ArmVirtPkg/ArmVirtCloudHv.dsc -b RELEASE
|
|
|
|
# Alternate method
|
|
# Launch developer container from AArch64 machine
|
|
$ ./scripts/dev_cli.sh shell
|
|
# Inside the container
|
|
$ source scripts/test-util.sh
|
|
$ source scripts/common-aarch64.sh
|
|
$ build_edk2
|
|
```
|
|
|
|
If the build goes well, the EDK2 binary is available at
|
|
`edk2/Build/ArmVirtCloudHv-AARCH64/RELEASE_GCC5/FV/CLOUDHV_EFI.fd` or `workloads/CLOUDHV_EFI.fd`
|
|
when using developer container to produce firmware.
|
|
|
|
## Using OVMF Binaries
|
|
|
|
Any UEFI capable image can be booted using the Cloud Hypervisor specific firmware. Windows guests under Cloud Hypervisor only support UEFI boot, therefore OVMF is mandatory there.
|
|
|
|
To make Cloud Hypervisor use UEFI boot, pass the `CLOUDHV.fd` (for x86-64) / `CLOUDHV_EFI.fd` (for AArch64) file path as an argument to the `--kernel` option. The firmware file will be opened in read only mode.
|
|
|
|
# Links
|
|
|
|
- [OVMF wiki](https://github.com/tianocore/tianocore.github.io/wiki/OVMF)
|
|
- [Cloud Hypervisor specific tree](https://github.com/cloud-hypervisor/edk2/tree/ch)
|