tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-31 01:24:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

UefiPayloadPkg: Enhance ReadMe.md for ELF and FIT

Browse Source 
Enhance and introduce environment construction and
build step for ELF and FIT format payload

Signed-off-by: Gua Guo <gua.guo@intel.com>
This commit is contained in:
Gua Guo 2024-09-21 17:39:49 +08:00 committed by mergify[bot]
parent 1a89c690a1
commit 4c3bffaeb3
1 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
UefiPayloadPkg/Readme.md
View File

@ -2,10 +2,10 @@
Provide UEFI Universal Payload for different bootloader to generate EFI environment Provide UEFI Universal Payload for different bootloader to generate EFI environment
# Spec # Spec
UniversalPayload URL: https://universalscalablefirmware.github.io/documentation/2_universal_payload.html - UniversalPayload URL: https://universalscalablefirmware.github.io/documentation/2_universal_payload.html
UniversalPayload URL: https://universalpayload.github.io/spec/ - UniversalPayload URL: https://universalpayload.github.io/spec/
ELF Format URL: https://refspecs.linuxfoundation.org/elf/elf.pdf - ELF Format URL: https://refspecs.linuxfoundation.org/elf/elf.pdf
FIT Format URL: https://universalpayload.github.io/spec/chapter2-payload-image-format.html - FIT Format URL: https://universalpayload.github.io/spec/chapter2-payload-image-format.html
# Uefi UniversalPayload Format # Uefi UniversalPayload Format
| Binary Format | HandOffPayload - HOB | | Binary Format | HandOffPayload - HOB |
@ -48,29 +48,19 @@ FIT Format URL: https://universalpayload.github.io/spec/chapter2-payload-image-f
+ +-----------------------+ + +-----------------------+
``` ```
# Environment # Build Environment
- ELF - ELF
``` ```
Download and install https://github.com/llvm/llvm-project/releases/tag/llvmorg-10.0.1 Install GCC compiler on linux and MSVC compiler on windows
Install CLANG compiler https://github.com/llvm/llvm-project/releases/tag/llvmorg-10.0.1 on windows and linux
``` ```
- FIT - FIT
- Windows ```
``` Install GCC compiler on linux and MSVC compiler on windows
Download and install swig by https://swig.org/ and also set install path into environment variable pip3 install pefile
``` pip3 install pylibfdt
```powershell ```
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
choco install dtc-msys2
pip3 install pefile
pip3 install pylibfdt
```
- Ubuntu
```bash
sudo apt install -y u-boot-tools
pip3 install pefile
pip3 install swig
pip3 install pylibfdt
```
# How to build UEFI UniversalPayload # How to build UEFI UniversalPayload
- Windows - Windows
- edksetup Rebuild - edksetup Rebuild
@ -84,6 +74,24 @@ FIT Format URL: https://universalpayload.github.io/spec/chapter2-payload-image-f
- UniversalPayload.fit - UniversalPayload.fit
- python UefiPayloadPkg/UniversalPayloadBuild.py -t <TOOL_CHAIN_TAG> --Fit - python UefiPayloadPkg/UniversalPayloadBuild.py -t <TOOL_CHAIN_TAG> --Fit
# How to dump payload binary data
- UniversalPayload.elf
- Install elf dump tools https://github.com/llvm/llvm-project/releases/tag/llvmorg-10.0.1
- llvm-objdump -h Build/UefiPayloadPkgX64/UniversalPayload.elf
- UniversalPayload.fit
- Install fdtdump tool
- Windows
```powershell
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
choco install dtc-msys2
```
- Linux
```bash
sudo apt install -y u-boot-tools
```
- fdtdump Build/UefiPayloadPkgX64/UniversalPayload.fit - fdtdump Build/UefiPayloadPkgX64/UniversalPayload.fit
# Edk2boot + UefiUniversalPayload # Edk2boot + UefiUniversalPayload