blob: 0ddc159114a743f40626f91fa8b64e322c10621d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
# UefiPayloadPkg
Provide UEFI Universal Payload for different bootloader to generate EFI environment
# Spec
- UniversalPayload URL: https://universalscalablefirmware.github.io/documentation/2_universal_payload.html
- UniversalPayload URL: https://universalpayload.github.io/spec/
- ELF Format URL: https://refspecs.linuxfoundation.org/elf/elf.pdf
- FIT Format URL: https://universalpayload.github.io/spec/chapter2-payload-image-format.html
# Uefi UniversalPayload Format
| Binary Format | HandOffPayload - HOB |
|---------------|----------------------|
| ELF | V (Default) |
| FIT | V |
# Binary Format
- ELF
```
+ +-----------------------+
| | UniversalPayloadEntry | <----------- UefiPayloadPkg\UefiPayloadEntry\UniversalPayloadEntry.c:_ModuleEntryPoint (HOB)
| +-----------------------+
| | .upld_info | patch it directly
ELF Format | +-----------------------+
| | .upld.uefi_fv | patch it directly
| +-----------------------+
| | .upld.bds_fv | patch it directly
| +-----------------------+
| | .upld.<afpx>_fv | patch it directly
+ +-----------------------+
```
- FIT
```
+ +-----------------------+
FIT Data | | FIT Header | <----------- Generate by pylibfdt
+ +-----------------------+
PECOFF Format | | UniversalPayloadEntry | <----------- UefiPayloadPkg\UefiPayloadEntry\FitUniversalPayloadEntry.c:_ModuleEntryPoint (HOB)
+ +-----------------------+
Relocate Data | | reloc-start |
+ +-----------------------+
| | uefi_fv | patch it directly
| +-----------------------+
Multi Binary | | bds_fv | patch it directly
| +-----------------------+
| | afp_xxx_fv | patch it directly
| +-----------------------+
| | afp_xxx_fv | patch it directly
+ +-----------------------+
```
# Build Environment
- ELF
```
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
```
Install GCC compiler on linux and MSVC compiler on windows
pip3 install pefile
pip3 install pylibfdt
```
# How to build UEFI UniversalPayload
- Windows
- edksetup Rebuild
- Linux
- make -C BaseTools
- source edksetup.sh
- UniversalPayload.elf
- python UefiPayloadPkg/UniversalPayloadBuild.py -t <TOOL_CHAIN_TAG>
- llvm-objdump -h Build/UefiPayloadPkgX64/UniversalPayload.elf
- UniversalPayload.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
# Edk2boot + UefiUniversalPayload
ELF Edk2boot use below way to support compress and sign.
- ELF Behavior - Edk2boot + UefiUniversalPayload.elf
```
Boot Flow
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------+
| Platform Init | Universal Loader Interface | OS |
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------+
HOBs
SEC -> PEI -> DXE -> DXE IPL -> UefiPayloadPkg\PayloadLoaderPeim\PayloadLoaderPeim.c ------------------------------------------------------------------------------------> Load UniversalPayload.elf -> Operation System
| Platform Initialize - Edk2 | UniversalPayload - Edk2 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------+
Binary Format
+-------------------+
| BIOS.rom |
+-------------------+
| Other Firmware |
+-------------------+
| ... | FMMT UniversalPayloadBuild.py
+-------------------+<----------------+-----------------------+ GenFfs +-----------------------+ Rsa2048Sha256 Sign +-----------------------+ LzmaCompress +----------------------+ GenSec +--------------------------------+
| | | EDK2 FFS Header |<-----------| Rsa2048Sha256 Hash |<--------------------| UniversalPayload.lzma |<--------------| EDK2 SEC Header |<--------| UniversalPayload.elf |
| RAW Data | +-----------------------+ +-----------------------+ +-----------------------+ +----------------------+ +--------------------------------+
| | | Rsa2048Sha256 Hash | | UniversalPayload.lzma | | UniversalPayload.elf | | upld_info |
| | +-----------------------+ +-----------------------+ +----------------------+ +--------------------------------+
| | | UniversalPayload.lzma | | upld_info | | upld.uefi_fv |
+-------------------+<----------------+-----------------------+ +----------------------+ +--------------------------------+
| ... | | upld.uefi_fv | | upld.bds_fv |
+-------------------+ +----------------------+ +--------------------------------+
| Other Firmware | | upld.bds_fv | | upld.AFP1 |
+-------------------+ +----------------------+ +--------------------------------+
| upld.AFP1 | | upld.AFP2 |
+----------------------+ +--------------------------------+
| upld.AFP2 | | ... |
+----------------------+ +--------------------------------+
| ... | | upld.AFPn |
+----------------------+ +--------------------------------+
| upld.AFPn |
+----------------------+
```
FIT Edk2boot use below way to support compress and sign
- FIT Behavior - Edk2boot + UefiUniversalPayload.fit
```
Boot Flow
+-------------------------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+
| Platform Init | Universal Loader Interface | OS |
+-------------------------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+
HOBs
SEC -> PEI -> DXE -> DXE IPL -> *UefiPayloadPkg\PayloadLoaderPeim\PayloadLoaderPeim.c ----------------------------------------------> Load UniversalPayload.fit -> Operation System
Binary Format
| Platform Initialize - Edk2 | UniversalPayload - Edk2 (UniversalPayloadBuild.py --Fit) |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
+-------------------+
| BIOS.rom |
+-------------------+
| Other Firmware |
+-------------------+
| ... | FMMT UniversalPayloadBuild.py --Fit tianocore -> data-offset
+-------------------+<----------------+--------------------------------+ GenFfs +--------------------------------+ GenSec +--------------------------------+ tianocore -> reloc-start +--------------------------+
| | | EDK2 FFS Header |<--------| EDK2 SEC Header |<--------| FIT Header |<-------------------------| UniversalPayload.pecoff |
| | +--------------------------------+ +--------------------------------+ | description = "Uefi Payload"; | +--------------------------+
| | | EDK2 SEC Header | | FIT Header | | ... |
| RAW Data | +--------------------------------+ | | | images { | uefi-fv -> data-offset +--------------------------+
| | | FIT Header | | | | tianocore {...}; |<-------------------------| uefi_fv |
| | | | +--------------------------------+ | uefi-fv {...}; | bds-fv -> data-offset +--------------------------+
| | | | | tianocore -> data | | bds-fv {...}; |<-------------------------| bds_fv |
| | +--------------------------------+ +--------------------------------+ | afp1-fv {...}; | AFP1 -> data-offset +--------------------------+
| | | tianocore -> data | | tianocore -> reloc-start | | ... |<-------------------------| AFP1 |
| | +--------------------------------+ +--------------------------------+ | afpn-fv {...}; | AFP2 -> data-offset +--------------------------+
| | | tianocore -> reloc-start | | uefi-fv -> data | | } |<-------------------------| AFP2 |
| | +--------------------------------+ +--------------------------------+ | configurations { | ... +--------------------------+
| | | uefi-fv -> data | | bds-fv -> data | | conf-1 {...} |<-------------------------| ... |
| | +--------------------------------+ +--------------------------------+ | } | AFPn -> data-offset +--------------------------+
| | | bds-fv -> data | | AFP1-fv -> data | | |<-------------------------| AFPn |
| | +--------------------------------+ +--------------------------------+ | | +--------------------------+
| | | AFP1-fv -> data | | AFP2-fv -> data | | |
| | +--------------------------------+ +--------------------------------+ +--------------------------------+
| | | AFP2-fv -> data | | ... | | tianocore -> data |
| | +--------------------------------+ +--------------------------------+ +--------------------------------+
| | | ... | | AFPn-fv -> data | | tianocore -> reloc-start |
| | +--------------------------------+ +--------------------------------+ +--------------------------------+
| | | AFPn-fv -> data | | uefi-fv -> data |
+-------------------+<----------------+--------------------------------+ +--------------------------------+
| ... | | bds-fv -> data |
+-------------------+ +--------------------------------+
| Other Firmware | | AFP1-fv -> data |
+-------------------+ +--------------------------------+
| AFP2-fv -> data |
+--------------------------------+
| ... |
+--------------------------------+
| AFPn-fv -> data |
+--------------------------------+
```
|
