UefiPayloadPkg: Align Attribute value with UPL spec

[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'PLDH'\r
        self.HeaderLength   = sizeof(UPLD_INFO_HEADER)\r
        self.SpecRevision   = 0x0007\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     = "--quiet"  if Args.Quiet else ""\r
    ElfToolChain = 'CLANGDWARF'\r
    BuildDir     = os.path.join(os.environ['WORKSPACE'], os.path.normpath("Build/UefiPayloadPkgX64"))\r
    if Args.Arch == 'X64':\r
        BuildArch      = "X64"\r
        ObjCopyFlag    = "elf64-x86-64"\r
        EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("X64/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))\r
    else:\r
        BuildArch      = "IA32 -a X64"\r
        ObjCopyFlag    = "elf32-i386"\r
        EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("IA32/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))\r
\r
    EntryModuleInf = os.path.normpath("UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.inf")\r
    DscPath = os.path.normpath("UefiPayloadPkg/UefiPayloadPkg.dsc")\r
    FvOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ToolChain), os.path.normpath("FV/DXEFV.Fv"))\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
    Pcds = ""\r
    if (Args.pcd != None):\r
        for PcdItem in Args.pcd:\r
            Pcds += " --pcd {}".format (PcdItem)\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 = "build -p {} -b {} -a X64 -t {} -y {} {}".format (DscPath, BuildTarget, ToolChain, PayloadReportPath, Quiet)\r
    BuildPayload += Pcds\r
    BuildPayload += Defines\r
    RunCommand(BuildPayload)\r
    #\r
    # Building Universal Payload entry.\r
    #\r
    BuildModule = "build -p {} -b {} -a {} -m {} -t {} -y {} {}".format (DscPath, BuildTarget, BuildArch, EntryModuleInf, ElfToolChain, ModuleReportPath, Quiet)\r
    BuildModule += Pcds\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
    upld_info_hdr.Attribute |= 1 if BuildTarget == "DEBUG" else 0\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 = '"{}" -I {} -O {} --remove-section .upld_info --remove-section .upld.uefi_fv {}'.format (\r
                       LlvmObjcopyPath,\r
                       ObjCopyFlag,\r
                       ObjCopyFlag,\r
                       EntryOutputDir\r
                       )\r
    add_section    = '"{}" -I {} -O {} --add-section .upld_info={} --add-section .upld.uefi_fv={} {}'.format (\r
                       LlvmObjcopyPath,\r
                       ObjCopyFlag,\r
                       ObjCopyFlag,\r
                       UpldInfoFile,\r
                       FvOutputDir,\r
                       EntryOutputDir\r
                       )\r
    set_section    = '"{}" -I {} -O {} --set-section-alignment .upld.upld_info=16 --set-section-alignment .upld.uefi_fv=16 {}'.format (\r
                       LlvmObjcopyPath,\r
                       ObjCopyFlag,\r
                       ObjCopyFlag,\r
                       EntryOutputDir\r
                       )\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', action='store_true', help='Disable all build messages except FATAL ERRORS.')\r
    parser.add_argument("-p", "--pcd", action="append")\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