UefiPayloadPkg: Add ".upld_info" in universal payload

V2: Use LittleEndianStructure by review comment.

From the universal scalable firmware payload requirement V0.75,
Payload must have Universal Payload Information Section ".upld_info"
So update the build tool to add this section.

Cc: Ray Ni <ray.ni@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Benjamin You <benjamin.you@intel.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
Signed-off-by: Guo Dong <guo.dong@intel.com>

diff --git a/UefiPayloadPkg/UniversalPayloadBuild.py b/UefiPayloadPkg/UniversalPayloadBuild.py
index b78c6a76200e04ba1f4f2e8347dc13f879e41f72..e624ec5874cf114f387239f3b3f92e49bc25f654 100644 (file)
--- a/UefiPayloadPkg/UniversalPayloadBuild.py
+++ b/UefiPayloadPkg/UniversalPayloadBuild.py
@@ -10,6 +10,31 @@ import subprocess
 import os\r
 import shutil\r
 import sys\r
+from   ctypes import *\r
+\r
+sys.dont_write_bytecode = True\r
+\r
+class UPLD_INFO_HEADER(LittleEndianStructure):\r
+    _pack_ = 1\r
+    _fields_ = [\r
+        ('Identifier',           ARRAY(c_char, 4)),\r
+        ('HeaderLength',         c_uint32),\r
+        ('SpecRevision',         c_uint16),\r
+        ('Reserved',             c_uint16),\r
+        ('Revision',             c_uint32),\r
+        ('Attribute',            c_uint32),\r
+        ('Capability',           c_uint32),\r
+        ('ProducerId',           ARRAY(c_char, 16)),\r
+        ('ImageId',              ARRAY(c_char, 16)),\r
+        ]\r
+\r
+    def __init__(self):\r
+        self.Identifier     =  b'UPLD'\r
+        self.HeaderLength   = sizeof(UPLD_INFO_HEADER)\r
+        self.HeaderRevision = 0x0075\r
+        self.Revision       = 0x0000010105\r
+        self.ImageId        = b'UEFI'\r
+        self.ProducerId     = b'INTEL'\r
 \r
 def RunCommand(cmd):\r
     print(cmd)\r
@@ -37,6 +62,7 @@ def BuildUniversalPayload(Args, MacroList):
     EntryOutputDir = os.path.join(BuildDir, f"{BuildTarget}_{ElfToolChain}", os.path.normpath("X64/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))\r
     PayloadReportPath = os.path.join(BuildDir, "UefiUniversalPayload.txt")\r
     ModuleReportPath = os.path.join(BuildDir, "UefiUniversalPayloadEntry.txt")\r
+    UpldInfoFile = os.path.join(BuildDir, "UniversalPayloadInfo.bin")\r
 \r
     if "CLANG_BIN" in os.environ:\r
         LlvmObjcopyPath = os.path.join(os.environ["CLANG_BIN"], "llvm-objcopy")\r
@@ -65,12 +91,21 @@ def BuildUniversalPayload(Args, MacroList):
     BuildModule += Defines\r
     RunCommand(BuildModule)\r
 \r
+    #\r
+    # Buid Universal Payload Information Section ".upld_info"\r
+    #\r
+    upld_info_hdr = UPLD_INFO_HEADER()\r
+    upld_info_hdr.ImageId = Args.ImageId.encode()[:16]\r
+    fp = open(UpldInfoFile, 'wb')\r
+    fp.write(bytearray(upld_info_hdr))\r
+    fp.close()\r
+\r
     #\r
     # Copy the DXEFV as a section in elf format Universal Payload entry.\r
     #\r
-    remove_section = '"%s" -I elf64-x86-64 -O elf64-x86-64 --remove-section .upld.uefi_fv %s'%(LlvmObjcopyPath, EntryOutputDir)\r
-    add_section = '"%s" -I elf64-x86-64 -O elf64-x86-64 --add-section .upld.uefi_fv=%s %s'%(LlvmObjcopyPath, FvOutputDir, EntryOutputDir)\r
-    set_section = '"%s" -I elf64-x86-64 -O elf64-x86-64 --set-section-alignment .upld.uefi_fv=16 %s'%(LlvmObjcopyPath, EntryOutputDir)\r
+    remove_section = '"%s" -I elf64-x86-64 -O elf64-x86-64 --remove-section .upld_info --remove-section .upld.uefi_fv %s'%(LlvmObjcopyPath, EntryOutputDir)\r
+    add_section    = '"%s" -I elf64-x86-64 -O elf64-x86-64 --add-section .upld_info=%s --add-section .upld.uefi_fv=%s %s'%(LlvmObjcopyPath, UpldInfoFile, FvOutputDir, EntryOutputDir)\r
+    set_section    = '"%s" -I elf64-x86-64 -O elf64-x86-64 --set-section-alignment .upld.upld_info=16 --set-section-alignment .upld.uefi_fv=16 %s'%(LlvmObjcopyPath, EntryOutputDir)\r
     RunCommand(remove_section)\r
     RunCommand(add_section)\r
     RunCommand(set_section)\r
@@ -82,6 +117,7 @@ def main():
     parser.add_argument('-t', '--ToolChain')\r
     parser.add_argument('-b', '--Target', default='DEBUG')\r
     parser.add_argument("-D", "--Macro", action="append", default=["UNIVERSAL_PAYLOAD=TRUE"])\r
+    parser.add_argument('-i', '--ImageId', type=str, help='Specify payload ID (16 bytes maximal).', default ='UEFI')\r
     MacroList = {}\r
     args = parser.parse_args()\r
     if args.Macro is not None:\r