[edk2-devel] [PATCH v2 1/1] BaseTools: Script for converting .aml to .hex
Liming Gao
liming.gao at intel.com
Mon Feb 3 11:57:57 UTC 2020
Pierre:
Sorry for late response. I have one comment. Why only allows "DSDT" or "SSDT" in Signature?
Thanks
Liming
> -----Original Message-----
> From: Pierre Gondois <Pierre.Gondois at arm.com>
> Sent: Thursday, January 23, 2020 1:32 AM
> To: Pierre Gondois <Pierre.Gondois at arm.com>; devel at edk2.groups.io
> Cc: ard.biesheuvel at linaro.org; Feng, Bob C <bob.c.feng at intel.com>; Gao, Liming <liming.gao at intel.com>; Sami Mujawar
> <Sami.Mujawar at arm.com>; nd <nd at arm.com>
> Subject: RE: [PATCH v2 1/1] BaseTools: Script for converting .aml to .hex
>
> Hello everyone,
> Do you have any input on the patch?
>
> Regards,
> Pierre
>
> -----Original Message-----
> From: PierreGondois <pierre.gondois at arm.com>
> Sent: 17 January 2020 17:18
> To: devel at edk2.groups.io
> Cc: Pierre Gondois <Pierre.Gondois at arm.com>; ard.biesheuvel at linaro.org; bob.c.feng at intel.com; liming.gao at intel.com; Sami
> Mujawar <Sami.Mujawar at arm.com>; nd <nd at arm.com>
> Subject: [PATCH v2 1/1] BaseTools: Script for converting .aml to .hex
>
> From: Pierre Gondois <pierre.gondois at arm.com>
>
> The "-tc" option of the iasl compiler allows to generate a .hex file containing a C array storing AML bytecode.
>
> An online discussion suggested that this "-tc" option was specific to the iasl compiler and it shouldn't be relied on. This conversation is
> available at:
> https://edk2.groups.io/g/devel/topic/39786201#49659
>
> A way to address this issue is to implement a compiler independent script that takes an AML file as input, and generates a .hex file.
>
> This patch implements a Python script that converts an AML file to a .hex file, containing a C array storing AML bytecode.
> This scipt has been tested with the AML output from the following compilers supported by the EDKII implementation:
> * Intel ASL compiler
> * Microsoft ASL compiler
>
> Signed-off-by: Pierre Gondois <pierre.gondois at arm.com>
> ---
>
> The changes can be seen at https://github.com/PierreARM/edk2/commits/718_asl_to_hex_script_converter_2
>
> Notes:
> v2:
> - Script converting AML to .hex file [Pierre]
>
> BaseTools/BinWrappers/PosixLike/AmlToHex | 14 ++
> BaseTools/BinWrappers/WindowsLike/AmlToHex.bat | 3 +
> BaseTools/Conf/build_rule.template | 3 +
> BaseTools/Source/Python/AmlToHex/AmlToHex.py | 155 ++++++++++++++++++++
> 4 files changed, 175 insertions(+)
>
> diff --git a/BaseTools/BinWrappers/PosixLike/AmlToHex b/BaseTools/BinWrappers/PosixLike/AmlToHex
> new file mode 100755
> index 0000000000000000000000000000000000000000..1dd28e966288f6ea4fc52d42e2dc7b1f74226c23
> --- /dev/null
> +++ b/BaseTools/BinWrappers/PosixLike/AmlToHex
> @@ -0,0 +1,14 @@
> +#!/usr/bin/env bash
> +#python `dirname $0`/RunToolFromSource.py `basename $0` $*
> +
> +# If a ${PYTHON_COMMAND} command is available, use it in preference to
> +python if command -v ${PYTHON_COMMAND} >/dev/null 2>&1; then
> + python_exe=${PYTHON_COMMAND}
> +fi
> +
> +full_cmd=${BASH_SOURCE:-$0} # see
> +http://mywiki.wooledge.org/BashFAQ/028 for a discussion of why $0 is
> +not a good choice here dir=$(dirname "$full_cmd") exe=$(basename
> +"$full_cmd")
> +
> +export PYTHONPATH="$dir/../../Source/Python${PYTHONPATH:+:"$PYTHONPATH"}"
> +exec "${python_exe:-python}" "$dir/../../Source/Python/$exe/$exe.py" "$@"
> diff --git a/BaseTools/BinWrappers/WindowsLike/AmlToHex.bat b/BaseTools/BinWrappers/WindowsLike/AmlToHex.bat
> new file mode 100644
> index 0000000000000000000000000000000000000000..9616cd893bec9902451e6d8591f537cc408bd5e5
> --- /dev/null
> +++ b/BaseTools/BinWrappers/WindowsLike/AmlToHex.bat
> @@ -0,0 +1,3 @@
> + at setlocal
> + at set ToolName=%~n0%
> +@%PYTHON_COMMAND%
> +%BASE_TOOLS_PATH%\Source\Python\%ToolName%\%ToolName%.py %*
> diff --git a/BaseTools/Conf/build_rule.template b/BaseTools/Conf/build_rule.template
> index 51748bc0655a5c656258a3007b4db6b2dc941ea0..0822b681fcd9f61c6508e6f93ffc31fa70fd7059 100755
> --- a/BaseTools/Conf/build_rule.template
> +++ b/BaseTools/Conf/build_rule.template
> @@ -1,6 +1,7 @@
> #
> # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR> # Portions copyright (c) 2008 - 2010, Apple Inc. All rights
> reserved.<BR>
> +# Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>
> # SPDX-License-Identifier: BSD-2-Clause-Patent #
>
> @@ -427,12 +428,14 @@
> "$(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
> "$(ASL)" $(ASL_FLAGS) $(ASL_OUTFLAGS)${dst} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iiii
> + -AmlToHex $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml
>
> <Command.GCC>
> 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
> 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
> + -AmlToHex $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.aml
>
> [C-Code-File.AcpiTable]
> <InputFile>
> diff --git a/BaseTools/Source/Python/AmlToHex/AmlToHex.py b/BaseTools/Source/Python/AmlToHex/AmlToHex.py
> new file mode 100644
> index 0000000000000000000000000000000000000000..e8e7ace3a68532bc625afb1e74404c4e4b0205dd
> --- /dev/null
> +++ b/BaseTools/Source/Python/AmlToHex/AmlToHex.py
> @@ -0,0 +1,155 @@
> +## @file
> +#
> +# 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.
> +#
> +# Copyright (c) 2020, ARM Limited. All rights reserved.<BR> # #
> +SPDX-License-Identifier: BSD-2-Clause-Patent #
> +
> +import argparse
> +import Common.EdkLogger as EdkLogger
> +from Common.BuildToolError import *
> +import sys
> +import os
> +
> +## Parse the command line arguments.
> +#
> +# @retval A argparse.NameSpace instance, containing parsed values.
> +#
> +def ParseArgs():
> + # Initialize the parser.
> + Parser = argparse.ArgumentParser(
> + 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.
> + Parser.add_argument(
> + dest="InputFile",
> + 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 .hex file will be generated. " + \
> + "Default is the input file's directory."
> + )
> +
> + # Parse the input arguments.
> + Args = Parser.parse_args()
> + SplitInputName = ""
> +
> + if not os.path.exists(Args.InputFile):
> + EdkLogger.error(__file__, FILE_OPEN_FAILURE,
> + ExtraData=Args.InputFile)
> + return
> + else:
> + with open(Args.InputFile, "rb") as fIn:
> + Signature = str(fIn.read(4))
> + if ("DSDT" not in Signature) and ("SSDT" not in Signature):
> + EdkLogger.error(__file__, PARAMETER_INVALID,
> + ExtraData=Args.InputFile,
> + Message="Error: Invalid file type. " + \
> + "File does not have a valid " + \
> + "DSDT or SSDT signature.")
> +
> + # Get the basename of the input file.
> + SplitInputName = os.path.splitext(Args.InputFile)
> + BaseName = os.path.basename(SplitInputName[0])
> +
> + # If no output directory is specified, output to the input directory.
> + if not Args.OutDir:
> + Args.OutputFile = os.path.join(
> + os.path.dirname(Args.InputFile),
> + BaseName + ".hex"
> + )
> + else:
> + if not os.path.exists(Args.OutDir):
> + os.mkdir(Args.OutDir)
> + Args.OutputFile = os.path.join(Args.OutDir, BaseName + ".hex")
> +
> + Args.BaseName = BaseName
> +
> + return Args
> +
> +## Convert an AML file to a .hex 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 BaseName Base name of the input file.
> +# This is also the name of the generated .hex file.
> +#
> +def AmlToHex(InputFile, OutputFile, BaseName):
> +
> + MacroName = "__{}_HEX__".format(BaseName.upper())
> + ArrayName = BaseName.lower() + "_aml_code"
> +
> + 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)
> + )
> +
> + # Write the array and its content.
> + fOut.write("unsigned char {}[] = {{\n ".format(ArrayName))
> + cnt = 0
> + byte = fIn.read(1)
> + while len(byte) != 0:
> + fOut.write("0x{0:02X}, ".format(ord(byte)))
> + cnt += 1
> + if (cnt % 8) == 0:
> + fOut.write("\n")
> + byte = fIn.read(1)
> + fOut.write("\n};\n")
> +
> + # 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 stored
> +# in a C array.
> +#
> +# @retval 0 Success.
> +# @retval 1 Error.
> +#
> +def Main():
> + # Initialize an EdkLogger instance.
> + EdkLogger.Initialize()
> +
> + try:
> + # Parse the input arguments.
> + CommandArguments = ParseArgs()
> +
> + # Convert an AML file to a .hex file containing the AML bytecode stored
> + # in a C array.
> + AmlToHex(CommandArguments.InputFile, CommandArguments.OutputFile,
> + CommandArguments.BaseName)
> + except Exception as e:
> + print(e)
> + return 1
> +
> + return 0
> +
> +if __name__ == '__main__':
> + r = Main()
> + # 0-127 is a safe return range, and 1 is a standard default error
> + if r < 0 or r > 127: r = 1
> + sys.exit(r)
> --
> 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#53654): https://edk2.groups.io/g/devel/message/53654
Mute This Topic: https://groups.io/mt/69846798/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list