tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

BaseTools: Compile AML bytecode arrays into .obj file 

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 <Pierre.Gondois@arm.com>
Suggested-by: Tomas Pilar <Tomas.Pilar@arm.com>

Reviewed-by: Bob Feng <bob.c.feng@intel.com>
This commit is contained in:
Pierre Gondois 2020-07-01 22:06:03 +08:00 committed by mergify[bot]
parent 88228db38e
commit 0a4aa20e8d
2 changed files with 47 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
BaseTools/Conf/build_rule.template
View File

@ -419,6 +419,7 @@
<OutputFile> <OutputFile>
$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml
$(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.amli
<ExtraDependency> <ExtraDependency>
$(MAKE_FILE) $(MAKE_FILE)
@ -428,14 +429,24 @@
"$(ASLPP)" $(DEPS_FLAGS) $(ASLPP_FLAGS) $(INC) /I${s_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii "$(ASLPP)" $(DEPS_FLAGS) $(ASLPP_FLAGS) $(INC) /I${s_path} $(OUTPUT_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 Trim --source-code -l -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
"$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${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
<Command.GCC> <Command.GCC>
Trim --asl-file --asl-deps -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i -i $(INC_LIST) ${src} 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} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.i > $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii "$(ASLPP)" $(DEPS_FLAGS) $(ASLPP_FLAGS) $(INC) -I${s_path} $(OUTPUT_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 Trim --source-code -l -o $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
"$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${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]
<InputFile>
?.amli
<OutputFile>
${s_path}(+)${s_base}.c
<Command>
-AmlToC ${src}
[C-Code-File.AcpiTable] [C-Code-File.AcpiTable]
<InputFile> <InputFile>

82
BaseTools/Source/Python/AmlToC/AmlToC.py
View File

@ -1,9 +1,9 @@
## @file ## @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. # C array.
# By default, "Tables\Dsdt.aml" will generate "Tables\Dsdt.hex". # By default, "Tables\Dsdt.aml" will generate "Tables\Dsdt.c".
# "Tables\Dsdt.hex" will contain a C array named "dsdt_aml_code" that contains # "Tables\Dsdt.c" will contain a C array named "dsdt_aml_code" that contains
# the AML bytecode. # the AML bytecode.
# #
# Copyright (c) 2020, ARM Limited. All rights reserved.<BR> # Copyright (c) 2020, ARM Limited. All rights reserved.<BR>
@ -17,31 +17,26 @@ from Common.BuildToolError import *
import sys import sys
import os import os
__description__ = """
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. ## Parse the command line arguments.
# #
# @retval A argparse.NameSpace instance, containing parsed values. # @retval A argparse.NameSpace instance, containing parsed values.
# #
def ParseArgs(): def ParseArgs():
# Initialize the parser. # Initialize the parser.
Parser = argparse.ArgumentParser( Parser = argparse.ArgumentParser(description=__description__)
description="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."
)
# Define the possible arguments. # Define the possible arguments.
Parser.add_argument( Parser.add_argument(dest="InputFile",
dest="InputFile", help="Path to an input AML file to generate a .c file from.")
help="Path to an input AML file to generate a .hex file from." Parser.add_argument("-o", "--out-dir", dest="OutDir",
) help="Output directory where the .c file will be generated. Default is the input file's directory.")
Parser.add_argument(
"-o", "--out-dir", dest="OutDir",
help="Output directory where the .hex file will be generated. " + \
"Default is the input file's directory."
)
# Parse the input arguments. # Parse the input arguments.
Args = Parser.parse_args() Args = Parser.parse_args()
@ -55,9 +50,7 @@ def ParseArgs():
with open(Args.InputFile, "rb") as fIn: with open(Args.InputFile, "rb") as fIn:
Signature = str(fIn.read(4)) Signature = str(fIn.read(4))
if ("DSDT" not in Signature) and ("SSDT" not in Signature): if ("DSDT" not in Signature) and ("SSDT" not in Signature):
EdkLogger.info("Invalid file type. " + \ EdkLogger.info("Invalid file type. File does not have a valid DSDT or SSDT signature: {}".format(Args.InputFile))
"File does not have a valid " + \
"DSDT or SSDT signature: %s" % Args.InputFile)
return None return None
# Get the basename of the input file. # Get the basename of the input file.
@ -66,42 +59,39 @@ def ParseArgs():
# If no output directory is specified, output to the input directory. # If no output directory is specified, output to the input directory.
if not Args.OutDir: if not Args.OutDir:
Args.OutputFile = os.path.join( Args.OutputFile = os.path.join(os.path.dirname(Args.InputFile),
os.path.dirname(Args.InputFile), BaseName + ".c")
BaseName + ".hex"
)
else: else:
if not os.path.exists(Args.OutDir): if not os.path.exists(Args.OutDir):
os.mkdir(Args.OutDir) os.mkdir(Args.OutDir)
Args.OutputFile = os.path.join(Args.OutDir, BaseName + ".hex") Args.OutputFile = os.path.join(Args.OutDir, BaseName + ".c")
Args.BaseName = BaseName Args.BaseName = BaseName
return Args return Args
## 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. # in a C array.
# #
# @param InputFile Path to the input AML file. # @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. # @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):
MacroName = "__{}_HEX__".format(BaseName.upper())
ArrayName = BaseName.lower() + "_aml_code" ArrayName = BaseName.lower() + "_aml_code"
FileHeader =\
"""
// This file has been generated from:
// -Python script: {}
// -Input AML file: {}
"""
with open(InputFile, "rb") as fIn, open(OutputFile, "w") as fOut: with open(InputFile, "rb") as fIn, open(OutputFile, "w") as fOut:
# Write header. # Write header.
fOut.write("// This file has been generated from:\n" + \ fOut.write(FileHeader.format(os.path.abspath(InputFile), os.path.abspath(__file__)))
"// \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)
)
# Write the array and its content. # Write the array and its content.
fOut.write("unsigned char {}[] = {{\n ".format(ArrayName)) fOut.write("unsigned char {}[] = {{\n ".format(ArrayName))
@ -115,15 +105,12 @@ def AmlToHex(InputFile, OutputFile, BaseName):
byte = fIn.read(1) byte = fIn.read(1)
fOut.write("\n};\n") fOut.write("\n};\n")
# Write footer.
fOut.write("#endif // {}\n".format(MacroName))
## Main method ## Main method
# #
# This method: # This method:
# 1- Initialize an EdkLogger instance. # 1- Initialize an EdkLogger instance.
# 2- Parses the input arguments. # 2- Parses the input arguments.
# 3- Converts an AML file to a .hex file containing the AML bytecode stored # 3- Converts an AML file to a .c file containing the AML bytecode stored
# in a C array. # in a C array.
# #
# @retval 0 Success. # @retval 0 Success.
@ -139,10 +126,9 @@ def Main():
if not CommandArguments: if not CommandArguments:
return 1 return 1
# 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. # in a C array.
AmlToHex(CommandArguments.InputFile, CommandArguments.OutputFile, AmlToC(CommandArguments.InputFile, CommandArguments.OutputFile, CommandArguments.BaseName)
CommandArguments.BaseName)
except Exception as e: except Exception as e:
print(e) print(e)
return 1 return 1