From nobody Tue Feb 10 05:41:38 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+61742+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+61742+1787277+3901457@groups.io ARC-Seal: i=1; a=rsa-sha256; t=1593171625; cv=none; d=zohomail.com; s=zohoarc; b=fYmKGKc10ZTQzHsIobXmP5zADnfbOBHtMu45D10v+Tku69oCEZMEme5GZOTyggjW2LOcl+IWLgyPEyErqKB8lFc5K1hW+KTITtOwMApRspaI8iaK+ajKLzzMpGddOPBQ2bCqemQgfDBcMu0AffpL0fzTzypptihiJQG6djQDtk4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1593171625; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=XUxmMe7rJTb5vyxI82lQlNhPf8pBiacW/YSL7ePCZSI=; b=nCFNLBxXU+ZBpwttpcAortUvkt4f0qTgeJJGsX8dwZfWnIIYUd8YSP51FIF3Zaf+R5LHVvuz3z/qmHzpgYCdEGlw4z4fTi56xq6AC88yglScjF3zhE5RgWjwV0pw1rjAGEG9/VF2giQDiCfhIcUdnlYZYH+NFEvroK8q/ka6z7Q= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+61742+1787277+3901457@groups.io Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1593171625679948.7929950852737; Fri, 26 Jun 2020 04:40:25 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id h2X0YY1788612xQwGRH1ZK72; Fri, 26 Jun 2020 04:40:25 -0700 X-Received: from cam-smtp0.cambridge.arm.com (cam-smtp0.cambridge.arm.com [217.140.106.51]) by mx.groups.io with SMTP id smtpd.web11.5756.1593171621988986936 for ; Fri, 26 Jun 2020 04:40:22 -0700 X-Received: from E119881.Arm.com (E119881.Arm.com [10.1.197.28]) by cam-smtp0.cambridge.arm.com (8.13.8/8.13.8) with ESMTP id 05QBeI76004773; Fri, 26 Jun 2020 12:40:19 +0100 From: "PierreGondois" To: devel@edk2.groups.io Cc: Pierre Gondois , sami.mujawar@arm.com, tomas.pilar@arm.com, bob.c.feng@intel.com, liming.gao@intel.com, nd@arm.com Subject: [edk2-devel] [PATCH v4 3/4] BaseTools: Compile AML bytecode arrays into .obj file Date: Fri, 26 Jun 2020 12:40:12 +0100 Message-Id: <20200626114013.125524-4-pierre.gondois@arm.com> In-Reply-To: <20200626114013.125524-1-pierre.gondois@arm.com> References: <20200626114013.125524-1-pierre.gondois@arm.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,pierre.gondois@arm.com X-Gm-Message-State: DA4PtfGeoIPPFAkRGl04kJK8x1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1593171625; bh=+2MV32skZsRbV7gOMbkazp8AICUNIdCXYd9K3slI2AE=; h=Cc:Date:From:Reply-To:Subject:To; b=bQ6VHzXgAXV1uejrGQKQ0EkIxWQ3KNvFd5NUllzKj/7KKTz1lfXtG/1SEy4Lbr0whFD ZeMnwRTUbagQ02Rg43WfLktFHTyC2TjeIGpX6HTZ8GsaQvAwNxUOPuXd4SamfKcsX+GZ5 XmB22CNZ/HJ1vm3kMZ1uG//SL9HWt54Xp00= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" From: Pierre Gondois The AmlToHex script and Posix/WindowsLike wrappers convert an AML file to a .hex file, containing a C array storing AML bytecode. This ".hex" file can then be included in a C file, allowing to access the AML bytecode from this C file. The EDK2 build system doesn't allow to a depict dependency orders between files of different languages. For instance, in a module containing a ".c" file and a ".asl", the ".c" file may or may not be built prior to the ".asl" file. This prevents any inclusion of a generated ".hex" in a ".c" file since this later ".hex" file may or may not have been created yet. This patch modifies the AmlToC script to generate a C file instead of a ".hex" file. It also adds the generation of an intermediate ".amli" file when compiling an ASL file, and adds a rule to convert this ".amli" to a C file. This allows to generate a C file containing the AML bytecode from an ASL file. This C file will then be handled by the EDK2 build system to generate an object file. Thus, no file inclusion will be required anymore. The C file requiring the AML bytecode as a C array, and the ASL file, will be compiled independently. The C array must be defined as an external symbol. The linker is resolving the reference to the C array symbol. To summarize, the flow goes as: -1. ASL file is compiled to AML; -2. AML file is copied to a ".amli" intermediate file; -3. EDK2 build system applies the rule relevant to ".amli" files. This is, calling the "AmlToC" script, generating a C file from the ".amli" file; -4. EDK2 build system applies the rule relevant to C files. This is creating an object file. -5. EDK2 build system links the object file containing the AML bytecode with the object file requiring it. Signed-off-by: Pierre Gondois Suggested-by: Tomas Pilar --- The changes can be seen at https://github.com/PierreARM/edk2/commits/803_Co= mpile_AML_bytecode_array_into_OBJ_file_v4 Notes: Notes: v1: - Add a new rule to the build_rule.template file to generate ".obj" files from .asl files, and modify the AmlToC script accordingly. [Pierre] v2: - Restrict the rule to DXE_DRIVER. This allows to build the OvmfPkg, which was not the case in v1. [Pierre] v3: - Changed "Signed-off-by" to "Suggested-by". [Bob] v4: - No modification. Re-sending the patch with base64 encoding to conserve the right line endings. [Bob] BaseTools/Conf/build_rule.template | 15 +++- BaseTools/Source/Python/AmlToC/AmlToC.py | 82 ++++++++------------ 2 files changed, 47 insertions(+), 50 deletions(-) diff --git a/BaseTools/Conf/build_rule.template b/BaseTools/Conf/build_rule= .template index 0822b681fcd9f61c6508e6f93ffc31fa70fd7059..c034869915914936e28f64a6aad= ba08e0169da44 100755 --- a/BaseTools/Conf/build_rule.template +++ b/BaseTools/Conf/build_rule.template @@ -419,6 +419,7 @@ =20 $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml + $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.amli =20 $(MAKE_FILE) @@ -428,14 +429,24 @@ "$(ASLPP)" $(DEPS_FLAGS) $(ASLPP_FLAGS) $(INC) /I${s_path} $(OUTPU= T_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii Trim --source-code -l -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii= $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii=20 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_di= r}(+)${s_base}.iiii - -AmlToHex $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml + $(CP) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml $(OUTPUT_DIR)(+)${s= _dir}(+)${s_base}.amli =20 Trim --asl-file --asl-deps -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}= .i -i $(INC_LIST) ${src} "$(ASLPP)" $(DEPS_FLAGS) $(ASLPP_FLAGS) $(INC) -I${s_path} $(OUTPU= T_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii Trim --source-code -l -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii= $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii=20 "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_di= r}(+)${s_base}.iiii - -AmlToHex $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml + $(CP) $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml $(OUTPUT_DIR)(+)${s= _dir}(+)${s_base}.amli + +[Acpi-Machine-Language-File-to-C.DXE_DRIVER] + + ?.amli + + + ${s_path}(+)${s_base}.c + + + -AmlToC ${src} =20 [C-Code-File.AcpiTable] diff --git a/BaseTools/Source/Python/AmlToC/AmlToC.py b/BaseTools/Source/Py= thon/AmlToC/AmlToC.py index 643db2910e37acfdd80ac18d288c921320a79ce1..346de7159de702d860bbd809ddb= e8175f1493cfb 100644 --- a/BaseTools/Source/Python/AmlToC/AmlToC.py +++ b/BaseTools/Source/Python/AmlToC/AmlToC.py @@ -1,9 +1,9 @@ ## @file # -# Convert an AML file to a .hex file containing the AML bytecode stored in= a +# Convert an AML file to a .c file containing the AML bytecode stored in a # C array. -# By default, "Tables\Dsdt.aml" will generate "Tables\Dsdt.hex". -# "Tables\Dsdt.hex" will contain a C array named "dsdt_aml_code" that cont= ains +# By default, "Tables\Dsdt.aml" will generate "Tables\Dsdt.c". +# "Tables\Dsdt.c" will contain a C array named "dsdt_aml_code" that contai= ns # the AML bytecode. # # Copyright (c) 2020, ARM Limited. All rights reserved.
@@ -17,31 +17,26 @@ from Common.BuildToolError import * import sys import os =20 +__description__ =3D """ +Convert an AML file to a .c file containing the AML bytecode stored in a C +array. By default, Tables\Dsdt.aml will generate Tables\Dsdt.c. +Tables\Dsdt.c will contain a C array named "dsdt_aml_code" that contains +the AML bytecode. +""" + ## Parse the command line arguments. # # @retval A argparse.NameSpace instance, containing parsed values. # def ParseArgs(): # Initialize the parser. - Parser =3D argparse.ArgumentParser( - description=3D"Convert an AML file to a .hex file containing the AML= " + \ - "bytecode stored in a C array. By default, " + \ - "\"Tables\\Dsdt.aml\" will generate" + \ - "\"Tables\\Dsdt.hex\". \"Tables\\Dsdt.hex\" will " + \ - "contain a C array named \"dsdt_aml_code\" that " + \ - "contains the AML bytecode." - ) + Parser =3D argparse.ArgumentParser(description=3D__description__) =20 # Define the possible arguments. - Parser.add_argument( - dest=3D"InputFile", - help=3D"Path to an input AML file to generate a .hex file from." - ) - Parser.add_argument( - "-o", "--out-dir", dest=3D"OutDir", - help=3D"Output directory where the .hex file will be generated. " + \ - "Default is the input file's directory." - ) + Parser.add_argument(dest=3D"InputFile", + help=3D"Path to an input AML file to generate a .c= file from.") + Parser.add_argument("-o", "--out-dir", dest=3D"OutDir", + help=3D"Output directory where the .c file will be= generated. Default is the input file's directory.") =20 # Parse the input arguments. Args =3D Parser.parse_args() @@ -55,9 +50,7 @@ def ParseArgs(): with open(Args.InputFile, "rb") as fIn: Signature =3D str(fIn.read(4)) if ("DSDT" not in Signature) and ("SSDT" not in Signature): - EdkLogger.info("Invalid file type. " + \ - "File does not have a valid " + \ - "DSDT or SSDT signature: %s" % Args.InputF= ile) + EdkLogger.info("Invalid file type. File does not have a va= lid DSDT or SSDT signature: {}".format(Args.InputFile)) return None =20 # Get the basename of the input file. @@ -66,42 +59,39 @@ def ParseArgs(): =20 # If no output directory is specified, output to the input directory. if not Args.OutDir: - Args.OutputFile =3D os.path.join( - os.path.dirname(Args.InputFile), - BaseName + ".hex" - ) + Args.OutputFile =3D os.path.join(os.path.dirname(Args.InputFile), + BaseName + ".c") else: if not os.path.exists(Args.OutDir): os.mkdir(Args.OutDir) - Args.OutputFile =3D os.path.join(Args.OutDir, BaseName + ".hex") + Args.OutputFile =3D os.path.join(Args.OutDir, BaseName + ".c") =20 Args.BaseName =3D BaseName =20 return Args =20 -## Convert an AML file to a .hex file containing the AML bytecode stored +## Convert an AML file to a .c file containing the AML bytecode stored # in a C array. # # @param InputFile Path to the input AML file. -# @param OutputFile Path to the output .hex file to generate. +# @param OutputFile Path to the output .c file to generate. # @param BaseName Base name of the input file. -# This is also the name of the generated .hex file. +# This is also the name of the generated .c file. # -def AmlToHex(InputFile, OutputFile, BaseName): +def AmlToC(InputFile, OutputFile, BaseName): =20 - MacroName =3D "__{}_HEX__".format(BaseName.upper()) ArrayName =3D BaseName.lower() + "_aml_code" + FileHeader =3D\ +""" +// This file has been generated from: +// -Python script: {} +// -Input AML file: {} + +""" =20 with open(InputFile, "rb") as fIn, open(OutputFile, "w") as fOut: # Write header. - fOut.write("// This file has been generated from:\n" + \ - "// \tPython script: " + \ - os.path.abspath(__file__) + "\n" + \ - "// \tInput AML file: " + \ - os.path.abspath(InputFile) + "\n\n" + \ - "#ifndef {}\n".format(MacroName) + \ - "#define {}\n\n".format(MacroName) - ) + fOut.write(FileHeader.format(os.path.abspath(InputFile), os.path.a= bspath(__file__))) =20 # Write the array and its content. fOut.write("unsigned char {}[] =3D {{\n ".format(ArrayName)) @@ -115,15 +105,12 @@ def AmlToHex(InputFile, OutputFile, BaseName): byte =3D fIn.read(1) fOut.write("\n};\n") =20 - # Write footer. - fOut.write("#endif // {}\n".format(MacroName)) - ## Main method # # This method: # 1- Initialize an EdkLogger instance. # 2- Parses the input arguments. -# 3- Converts an AML file to a .hex file containing the AML bytecode st= ored +# 3- Converts an AML file to a .c file containing the AML bytecode stor= ed # in a C array. # # @retval 0 Success. @@ -139,10 +126,9 @@ def Main(): if not CommandArguments: return 1 =20 - # Convert an AML file to a .hex file containing the AML bytecode s= tored + # Convert an AML file to a .c file containing the AML bytecode sto= red # in a C array. - AmlToHex(CommandArguments.InputFile, CommandArguments.OutputFile, - CommandArguments.BaseName) + AmlToC(CommandArguments.InputFile, CommandArguments.OutputFile, Co= mmandArguments.BaseName) except Exception as e: print(e) return 1 --=20 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'