UefiPayloadPkg: Add --quiet argument to Universal Payload build script

[mirror_edk2.git] / UefiPayloadPkg / UniversalPayloadBuild.py

## @file\r
# This file contains the script to build UniversalPayload\r
#\r
# Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
\r
import argparse\r
import subprocess\r
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
    p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,cwd=os.environ['WORKSPACE'])\r
    while True:\r
        line = p.stdout.readline()\r
        if not line:\r
            break\r
        print(line.strip().decode(errors='ignore'))\r
\r
    p.communicate()\r
    if p.returncode != 0:\r
        print("- Failed - error happened when run command: %s"%cmd)\r
        raise Exception("ERROR: when run command: %s"%cmd)\r
\r
def BuildUniversalPayload(Args, MacroList):\r
    BuildTarget = Args.Target\r
    ToolChain = Args.ToolChain\r
    Quiet = Args.Quiet\r
    BuildArch = "X64" if Args.Arch == 'X64' else "IA32 -a X64"\r
    ElfToolChain = 'CLANGDWARF'\r
\r
    EntryModuleInf = os.path.normpath("UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.inf")\r
    DscPath = os.path.normpath("UefiPayloadPkg/UefiPayloadPkg.dsc")\r
    BuildDir = os.path.join(os.environ['WORKSPACE'], os.path.normpath("Build/UefiPayloadPkgX64"))\r
    FvOutputDir = os.path.join(BuildDir, f"{BuildTarget}_{ToolChain}", os.path.normpath("FV/DXEFV.Fv"))\r
    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
    else:\r
        LlvmObjcopyPath = "llvm-objcopy"\r
    try:\r
        RunCommand('"%s" --version'%LlvmObjcopyPath)\r
    except:\r
        print("- Failed - Please check if LLVM is installed or if CLANG_BIN is set correctly")\r
        sys.exit(1)\r
\r
    Defines = ""\r
    for key in MacroList:\r
        Defines +=" -D {0}={1}".format(key, MacroList[key])\r
\r
    #\r
    # Building DXE core and DXE drivers as DXEFV.\r
    #\r
    BuildPayload = f"build -p {DscPath} -b {BuildTarget} -a X64 -t {ToolChain} -y {PayloadReportPath} {Quiet}"\r
    BuildPayload += Defines\r
    RunCommand(BuildPayload)\r
    #\r
    # Building Universal Payload entry.\r
    #\r
    BuildModule = f"build -p {DscPath} -b {BuildTarget} -a {BuildArch} -m {EntryModuleInf} -t {ElfToolChain} -y {ModuleReportPath} {Quiet}"\r
    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_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
\r
    shutil.copy (EntryOutputDir, os.path.join(BuildDir, 'UniversalPayload.elf'))\r
\r
def main():\r
    parser = argparse.ArgumentParser(description='For building Universal Payload')\r
    parser.add_argument('-t', '--ToolChain')\r
    parser.add_argument('-b', '--Target', default='DEBUG')\r
    parser.add_argument('-a', '--Arch', choices=['IA32', 'X64'], help='Specify the ARCH for payload entry module. Default build X64 image.', default ='X64')\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
    parser.add_argument('-q', '--Quiet')\r
    MacroList = {}\r
    args = parser.parse_args()\r
    if args.Macro is not None:\r
        for Argument in args.Macro:\r
            if Argument.count('=') != 1:\r
                print("Unknown variable passed in: %s"%Argument)\r
                raise Exception("ERROR: Unknown variable passed in: %s"%Argument)\r
            tokens = Argument.strip().split('=')\r
            MacroList[tokens[0].upper()] = tokens[1]\r
    BuildUniversalPayload(args, MacroList)\r
    print ("Successfully build Universal Payload")\r
\r
if __name__ == '__main__':\r
    main()\r