UniversalPayloadBuild.py 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. ## @file
  2. # This file contains the script to build UniversalPayload
  3. #
  4. # Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
  5. # SPDX-License-Identifier: BSD-2-Clause-Patent
  6. ##
  7. import argparse
  8. import subprocess
  9. import os
  10. import shutil
  11. import sys
  12. from ctypes import *
  13. sys.dont_write_bytecode = True
  14. class UPLD_INFO_HEADER(LittleEndianStructure):
  15. _pack_ = 1
  16. _fields_ = [
  17. ('Identifier', ARRAY(c_char, 4)),
  18. ('HeaderLength', c_uint32),
  19. ('SpecRevision', c_uint16),
  20. ('Reserved', c_uint16),
  21. ('Revision', c_uint32),
  22. ('Attribute', c_uint32),
  23. ('Capability', c_uint32),
  24. ('ProducerId', ARRAY(c_char, 16)),
  25. ('ImageId', ARRAY(c_char, 16)),
  26. ]
  27. def __init__(self):
  28. self.Identifier = b'PLDH'
  29. self.HeaderLength = sizeof(UPLD_INFO_HEADER)
  30. self.SpecRevision = 0x0070
  31. self.Revision = 0x0000010105
  32. self.ImageId = b'UEFI'
  33. self.ProducerId = b'INTEL'
  34. def GenSpecRevision (Argument):
  35. try:
  36. (MajorStr, MinorStr) = Argument.split('.')
  37. except:
  38. raise argparse.ArgumentTypeError ('{} is not a valid SpecRevision format (Major[8-bits].Minor[8-bits]).'.format (Argument))
  39. #
  40. # Spec Revision Bits 15 : 8 - Major Version. Bits 7 : 0 - Minor Version.
  41. #
  42. if len(MinorStr) > 0 and len(MinorStr) < 3:
  43. try:
  44. Minor = int(MinorStr, 16) if len(MinorStr) == 2 else (int(MinorStr, 16) << 4)
  45. except:
  46. raise argparse.ArgumentTypeError ('{} Minor version of SpecRevision is not a valid integer value.'.format (Argument))
  47. else:
  48. raise argparse.ArgumentTypeError ('{} is not a valid SpecRevision format (Major[8-bits].Minor[8-bits]).'.format (Argument))
  49. if len(MajorStr) > 0 and len(MajorStr) < 3:
  50. try:
  51. Major = int(MajorStr, 16)
  52. except:
  53. raise argparse.ArgumentTypeError ('{} Major version of SpecRevision is not a valid integer value.'.format (Argument))
  54. else:
  55. raise argparse.ArgumentTypeError ('{} is not a valid SpecRevision format (Major[8-bits].Minor[8-bits]).'.format (Argument))
  56. return int('0x{0:02x}{1:02x}'.format(Major, Minor), 0)
  57. def Validate32BitInteger (Argument):
  58. try:
  59. Value = int (Argument, 0)
  60. except:
  61. raise argparse.ArgumentTypeError ('{} is not a valid integer value.'.format (Argument))
  62. if Value < 0:
  63. raise argparse.ArgumentTypeError ('{} is a negative value.'.format (Argument))
  64. if Value > 0xffffffff:
  65. raise argparse.ArgumentTypeError ('{} is larger than 32-bits.'.format (Argument))
  66. return Value
  67. def RunCommand(cmd):
  68. print(cmd)
  69. p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,cwd=os.environ['WORKSPACE'])
  70. while True:
  71. line = p.stdout.readline()
  72. if not line:
  73. break
  74. print(line.strip().decode(errors='ignore'))
  75. p.communicate()
  76. if p.returncode != 0:
  77. print("- Failed - error happened when run command: %s"%cmd)
  78. raise Exception("ERROR: when run command: %s"%cmd)
  79. def BuildUniversalPayload(Args, MacroList):
  80. BuildTarget = Args.Target
  81. ToolChain = Args.ToolChain
  82. Quiet = "--quiet" if Args.Quiet else ""
  83. ElfToolChain = 'CLANGDWARF'
  84. BuildDir = os.path.join(os.environ['WORKSPACE'], os.path.normpath("Build/UefiPayloadPkgX64"))
  85. if Args.Arch == 'X64':
  86. BuildArch = "X64"
  87. ObjCopyFlag = "elf64-x86-64"
  88. EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("X64/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))
  89. else:
  90. BuildArch = "IA32 -a X64"
  91. ObjCopyFlag = "elf32-i386"
  92. EntryOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ElfToolChain), os.path.normpath("IA32/UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry/DEBUG/UniversalPayloadEntry.dll"))
  93. EntryModuleInf = os.path.normpath("UefiPayloadPkg/UefiPayloadEntry/UniversalPayloadEntry.inf")
  94. DscPath = os.path.normpath("UefiPayloadPkg/UefiPayloadPkg.dsc")
  95. DxeFvOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ToolChain), os.path.normpath("FV/DXEFV.Fv"))
  96. BdsFvOutputDir = os.path.join(BuildDir, "{}_{}".format (BuildTarget, ToolChain), os.path.normpath("FV/BDSFV.Fv"))
  97. PayloadReportPath = os.path.join(BuildDir, "UefiUniversalPayload.txt")
  98. ModuleReportPath = os.path.join(BuildDir, "UefiUniversalPayloadEntry.txt")
  99. UpldInfoFile = os.path.join(BuildDir, "UniversalPayloadInfo.bin")
  100. if "CLANG_BIN" in os.environ:
  101. LlvmObjcopyPath = os.path.join(os.environ["CLANG_BIN"], "llvm-objcopy")
  102. else:
  103. LlvmObjcopyPath = "llvm-objcopy"
  104. try:
  105. RunCommand('"%s" --version'%LlvmObjcopyPath)
  106. except:
  107. print("- Failed - Please check if LLVM is installed or if CLANG_BIN is set correctly")
  108. sys.exit(1)
  109. Pcds = ""
  110. if (Args.pcd != None):
  111. for PcdItem in Args.pcd:
  112. Pcds += " --pcd {}".format (PcdItem)
  113. Defines = ""
  114. for key in MacroList:
  115. Defines +=" -D {0}={1}".format(key, MacroList[key])
  116. #
  117. # Building DXE core and DXE drivers as DXEFV.
  118. #
  119. BuildPayload = "build -p {} -b {} -a X64 -t {} -y {} {}".format (DscPath, BuildTarget, ToolChain, PayloadReportPath, Quiet)
  120. BuildPayload += Pcds
  121. BuildPayload += Defines
  122. RunCommand(BuildPayload)
  123. #
  124. # Building Universal Payload entry.
  125. #
  126. BuildModule = "build -p {} -b {} -a {} -m {} -t {} -y {} {}".format (DscPath, BuildTarget, BuildArch, EntryModuleInf, ElfToolChain, ModuleReportPath, Quiet)
  127. BuildModule += Pcds
  128. BuildModule += Defines
  129. RunCommand(BuildModule)
  130. #
  131. # Buid Universal Payload Information Section ".upld_info"
  132. #
  133. upld_info_hdr = UPLD_INFO_HEADER()
  134. upld_info_hdr.SpecRevision = Args.SpecRevision
  135. upld_info_hdr.Revision = Args.Revision
  136. upld_info_hdr.ProducerId = Args.ProducerId.encode()[:16]
  137. upld_info_hdr.ImageId = Args.ImageId.encode()[:16]
  138. upld_info_hdr.Attribute |= 1 if BuildTarget == "DEBUG" else 0
  139. fp = open(UpldInfoFile, 'wb')
  140. fp.write(bytearray(upld_info_hdr))
  141. fp.close()
  142. #
  143. # Copy the DXEFV as a section in elf format Universal Payload entry.
  144. #
  145. remove_section = '"{}" -I {} -O {} --remove-section .upld_info --remove-section .upld.uefi_fv --remove-section .upld.bds_fv {}'.format (
  146. LlvmObjcopyPath,
  147. ObjCopyFlag,
  148. ObjCopyFlag,
  149. EntryOutputDir
  150. )
  151. add_section = '"{}" -I {} -O {} --add-section .upld_info={} --add-section .upld.uefi_fv={} --add-section .upld.bds_fv={} {}'.format (
  152. LlvmObjcopyPath,
  153. ObjCopyFlag,
  154. ObjCopyFlag,
  155. UpldInfoFile,
  156. DxeFvOutputDir,
  157. BdsFvOutputDir,
  158. EntryOutputDir
  159. )
  160. set_section = '"{}" -I {} -O {} --set-section-alignment .upld_info=4 --set-section-alignment .upld.uefi_fv=16 --set-section-alignment .upld.bds_fv=16 {}'.format (
  161. LlvmObjcopyPath,
  162. ObjCopyFlag,
  163. ObjCopyFlag,
  164. EntryOutputDir
  165. )
  166. RunCommand(remove_section)
  167. RunCommand(add_section)
  168. RunCommand(set_section)
  169. shutil.copy (EntryOutputDir, os.path.join(BuildDir, 'UniversalPayload.elf'))
  170. def main():
  171. parser = argparse.ArgumentParser(description='For building Universal Payload')
  172. parser.add_argument('-t', '--ToolChain')
  173. parser.add_argument('-b', '--Target', default='DEBUG')
  174. parser.add_argument('-a', '--Arch', choices=['IA32', 'X64'], help='Specify the ARCH for payload entry module. Default build X64 image.', default ='X64')
  175. parser.add_argument("-D", "--Macro", action="append", default=["UNIVERSAL_PAYLOAD=TRUE"])
  176. parser.add_argument('-i', '--ImageId', type=str, help='Specify payload ID (16 bytes maximal).', default ='UEFI')
  177. parser.add_argument('-q', '--Quiet', action='store_true', help='Disable all build messages except FATAL ERRORS.')
  178. parser.add_argument("-p", "--pcd", action="append")
  179. parser.add_argument("-s", "--SpecRevision", type=GenSpecRevision, default ='0.7', help='Indicates compliance with a revision of this specification in the BCD format.')
  180. parser.add_argument("-r", "--Revision", type=Validate32BitInteger, default ='0x0000010105', help='Revision of the Payload binary. Major.Minor.Revision.Build')
  181. parser.add_argument("-o", "--ProducerId", default ='INTEL', help='A null-terminated OEM-supplied string that identifies the payload producer (16 bytes maximal).')
  182. MacroList = {}
  183. args = parser.parse_args()
  184. if args.Macro is not None:
  185. for Argument in args.Macro:
  186. if Argument.count('=') != 1:
  187. print("Unknown variable passed in: %s"%Argument)
  188. raise Exception("ERROR: Unknown variable passed in: %s"%Argument)
  189. tokens = Argument.strip().split('=')
  190. MacroList[tokens[0].upper()] = tokens[1]
  191. BuildUniversalPayload(args, MacroList)
  192. print ("Successfully build Universal Payload")
  193. if __name__ == '__main__':
  194. main()